src/include/gnunet_identity_provider_service.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2016 GNUnet e.V.
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @author Martin Schanzenbach
  23  *
  24  * @file
  25  * Identity provider service; implements identity provider for GNUnet
  26  *
  27  * @defgroup identity-provider  Identity Provider service
  28  * @{
  29  */
  30 #ifndef GNUNET_IDENTITY_PROVIDER_SERVICE_H
  31 #define GNUNET_IDENTITY_PROVIDER_SERVICE_H
  32
  33 #ifdef __cplusplus
  34 extern "C"
  35 {
  36 #if 0                           /* keep Emacsens' auto-indent happy */
  37 }
  38 #endif
  39 #endif
  40
  41 #include "gnunet_util_lib.h"
  42 #include "gnunet_identity_attribute_lib.h"
  43
  44 /**
  45  * Version number of GNUnet Identity Provider API.
  46  */
  47 #define GNUNET_IDENTITY_PROVIDER_VERSION 0x00000000
  48
  49 /**
  50  * Handle to access the identity service.
  51  */
  52 struct GNUNET_IDENTITY_PROVIDER_Handle;
  53
  54 /**
  55  * Handle for a token.
  56  */
  57 struct GNUNET_IDENTITY_PROVIDER_Token;
  58
  59 /**
  60  * The ticket
  61  */
  62 struct GNUNET_IDENTITY_PROVIDER_Ticket
  63 {
  64   /**
  65    * The ticket issuer
  66    */
  67   struct GNUNET_CRYPTO_EcdsaPublicKey identity;
  68
  69   /**
  70    * The ticket audience
  71    */
  72   struct GNUNET_CRYPTO_EcdsaPublicKey audience;
  73
  74   /**
  75    * The ticket random (NBO)
  76    */
  77   uint64_t rnd;
  78 };
  79
  80 /**
  81  * Handle for an operation with the identity provider service.
  82  */
  83 struct GNUNET_IDENTITY_PROVIDER_Operation;
  84
  85
  86 /**
  87  * Connect to the identity provider service.
  88  *
  89  * @param cfg Configuration to contact the identity provider service.
  90  * @return handle to communicate with identity provider service
  91  */
  92 struct GNUNET_IDENTITY_PROVIDER_Handle *
  93 GNUNET_IDENTITY_PROVIDER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
  94
  95 /**
  96  * Continuation called to notify client about result of the
  97  * operation.
  98  *
  99  * @param cls closure
 100  * @param success #GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate)
 101  *                #GNUNET_NO if content was already there or not found
 102  *                #GNUNET_YES (or other positive value) on success
 103  * @param emsg NULL on success, otherwise an error message
 104  */
 105 typedef void
 106 (*GNUNET_IDENTITY_PROVIDER_ContinuationWithStatus) (void *cls,
 107                                             int32_t success,
 108                                             const char *emsg);
 109
 110
 111 /**
 112  * Store an attribute.  If the attribute is already present,
 113  * it is replaced with the new attribute.
 114  *
 115  * @param h handle to the identity provider
 116  * @param pkey private key of the identity
 117  * @param attr the attribute
 118  * @param cont continuation to call when done
 119  * @param cont_cls closure for @a cont
 120  * @return handle to abort the request
 121  */
 122 struct GNUNET_IDENTITY_PROVIDER_Operation *
 123 GNUNET_IDENTITY_PROVIDER_attribute_store (struct GNUNET_IDENTITY_PROVIDER_Handle *h,
 124                                           const struct GNUNET_CRYPTO_EcdsaPrivateKey *pkey,
 125                                           const struct GNUNET_IDENTITY_ATTRIBUTE_Claim *attr,
 126                                           GNUNET_IDENTITY_PROVIDER_ContinuationWithStatus cont,
 127                                           void *cont_cls);
 128
 129
 130 /**
 131  * Process an attribute that was stored in the idp.
 132  *
 133  * @param cls closure
 134  * @param identity the identity
 135  * @param attr the attribute
 136  */
 137 typedef void
 138 (*GNUNET_IDENTITY_PROVIDER_AttributeResult) (void *cls,
 139                                    const struct GNUNET_CRYPTO_EcdsaPublicKey *identity,
 140                                    const struct GNUNET_IDENTITY_ATTRIBUTE_Claim *attr);
 141
 142
 143
 144 /**
 145  * List all attributes for a local identity.
 146  * This MUST lock the `struct GNUNET_IDENTITY_PROVIDER_Handle`
 147  * for any other calls than #GNUNET_IDENTITY_PROVIDER_get_attributes_next() and
 148  * #GNUNET_IDENTITY_PROVIDER_get_attributes_stop. @a proc will be called once
 149  * immediately, and then again after
 150  * #GNUNET_IDENTITY_PROVIDER_get_attributes_next() is invoked.
 151  *
 152  * On error (disconnect), @a error_cb will be invoked.
 153  * On normal completion, @a finish_cb proc will be
 154  * invoked.
 155  *
 156  * @param h handle to the idp
 157  * @param identity identity to access
 158  * @param error_cb function to call on error (i.e. disconnect),
 159  *        the handle is afterwards invalid
 160  * @param error_cb_cls closure for @a error_cb
 161  * @param proc function to call on each attribute; it
 162  *        will be called repeatedly with a value (if available)
 163  * @param proc_cls closure for @a proc
 164  * @param finish_cb function to call on completion
 165  *        the handle is afterwards invalid
 166  * @param finish_cb_cls closure for @a finish_cb
 167  * @return an iterator handle to use for iteration
 168  */
 169 struct GNUNET_IDENTITY_PROVIDER_AttributeIterator *
 170 GNUNET_IDENTITY_PROVIDER_get_attributes_start (struct GNUNET_IDENTITY_PROVIDER_Handle *h,
 171                                                const struct GNUNET_CRYPTO_EcdsaPrivateKey *identity,
 172                                                GNUNET_SCHEDULER_TaskCallback error_cb,
 173                                                void *error_cb_cls,
 174                                                GNUNET_IDENTITY_PROVIDER_AttributeResult proc,
 175                                                void *proc_cls,
 176                                                GNUNET_SCHEDULER_TaskCallback finish_cb,
 177                                                void *finish_cb_cls);
 178
 179
 180 /**
 181  * Calls the record processor specified in #GNUNET_IDENTITY_PROVIDER_get_attributes_start
 182  * for the next record.
 183  *
 184  * @param it the iterator
 185  */
 186 void
 187 GNUNET_IDENTITY_PROVIDER_get_attributes_next (struct GNUNET_IDENTITY_PROVIDER_AttributeIterator *it);
 188
 189
 190 /**
 191  * Stops iteration and releases the idp handle for further calls.  Must
 192  * be called on any iteration that has not yet completed prior to calling
 193  * #GNUNET_IDENTITY_PROVIDER_disconnect.
 194  *
 195  * @param it the iterator
 196  */
 197 void
 198 GNUNET_IDENTITY_PROVIDER_get_attributes_stop (struct GNUNET_IDENTITY_PROVIDER_AttributeIterator *it);
 199
 200
 201 /**
 202  * Method called when a token has been issued.
 203  * On success returns a ticket that can be given to the audience to retrive the
 204  * token
 205  *
 206  * @param cls closure
 207  * @param ticket the ticket
 208  */
 209 typedef void
 210 (*GNUNET_IDENTITY_PROVIDER_TicketCallback)(void *cls,
 211                             const struct GNUNET_IDENTITY_PROVIDER_Ticket *ticket);
 212
 213 /**
 214  * Issues a ticket to another identity. The identity may use
 215  * GNUNET_IDENTITY_PROVIDER_ticket_consume to consume the ticket
 216  * and retrieve the attributes specified in the AttributeList.
 217  *
 218  * @param h the identity provider to use
 219  * @param iss the issuing identity
 220  * @param rp the subject of the ticket (the relying party)
 221  * @param attrs the attributes that the relying party is given access to
 222  * @param cb the callback
 223  * @param cb_cls the callback closure
 224  * @return handle to abort the operation
 225  */
 226 struct GNUNET_IDENTITY_PROVIDER_Operation *
 227 GNUNET_IDENTITY_PROVIDER_ticket_issue (struct GNUNET_IDENTITY_PROVIDER_Handle *h,
 228                                        const struct GNUNET_CRYPTO_EcdsaPrivateKey *iss,
 229                                        const struct GNUNET_CRYPTO_EcdsaPublicKey *rp,
 230                                        const struct GNUNET_IDENTITY_ATTRIBUTE_ClaimList *attrs,
 231                                        GNUNET_IDENTITY_PROVIDER_TicketCallback cb,
 232                                        void *cb_cls);
 233
 234 /**
 235  * Revoked an issued ticket. The relying party will be unable to retrieve
 236  * updated attributes.
 237  *
 238  * @param h the identity provider to use
 239  * @param identity the issuing identity
 240  * @param ticket the ticket to revoke
 241  * @param cb the callback
 242  * @param cb_cls the callback closure
 243  * @return handle to abort the operation
 244  */
 245 struct GNUNET_IDENTITY_PROVIDER_Operation *
 246 GNUNET_IDENTITY_PROVIDER_ticket_revoke (struct GNUNET_IDENTITY_PROVIDER_Handle *h,
 247                                         const struct GNUNET_CRYPTO_EcdsaPrivateKey *identity,
 248                                         const struct GNUNET_IDENTITY_PROVIDER_Ticket *ticket,
 249                                         GNUNET_IDENTITY_PROVIDER_ContinuationWithStatus cb,
 250                                         void *cb_cls);
 251
 252
 253
 254 /**
 255  * Consumes an issued ticket. The ticket is persisted
 256  * and used to retrieve identity information from the issuer
 257  *
 258  * @param h the identity provider to use
 259  * @param identity the identity that is the subject of the issued ticket (the audience)
 260  * @param ticket the issued ticket to consume
 261  * @param cb the callback to call
 262  * @param cb_cls the callback closure
 263  * @return handle to abort the operation
 264  */
 265 struct GNUNET_IDENTITY_PROVIDER_Operation *
 266 GNUNET_IDENTITY_PROVIDER_ticket_consume (struct GNUNET_IDENTITY_PROVIDER_Handle *h,
 267                                          const struct GNUNET_CRYPTO_EcdsaPrivateKey *identity,
 268                                          const struct GNUNET_IDENTITY_PROVIDER_Ticket *ticket,
 269                                          GNUNET_IDENTITY_PROVIDER_AttributeResult cb,
 270                                          void *cb_cls);
 271
 272 /**
 273  * Lists all tickets that have been issued to remote
 274  * identites (relying parties)
 275  *
 276  * @param h the identity provider to use
 277  * @param identity the issuing identity
 278  * @param error_cb function to call on error (i.e. disconnect),
 279  *        the handle is afterwards invalid
 280  * @param error_cb_cls closure for @a error_cb
 281  * @param proc function to call on each ticket; it
 282  *        will be called repeatedly with a value (if available)
 283  * @param proc_cls closure for @a proc
 284  * @param finish_cb function to call on completion
 285  *        the handle is afterwards invalid
 286  * @param finish_cb_cls closure for @a finish_cb
 287  * @return an iterator handle to use for iteration
 288  */
 289 struct GNUNET_IDENTITY_PROVIDER_TicketIterator *
 290 GNUNET_IDENTITY_PROVIDER_ticket_iteration_start (struct GNUNET_IDENTITY_PROVIDER_Handle *h,
 291                                                  const struct GNUNET_CRYPTO_EcdsaPrivateKey *identity,
 292                                                  GNUNET_SCHEDULER_TaskCallback error_cb,
 293                                                  void *error_cb_cls,
 294                                                  GNUNET_IDENTITY_PROVIDER_TicketCallback proc,
 295                                                  void *proc_cls,
 296                                                  GNUNET_SCHEDULER_TaskCallback finish_cb,
 297                                                  void *finish_cb_cls);
 298
 299 /**
 300  * Lists all tickets that have been issued to remote
 301  * identites (relying parties)
 302  *
 303  * @param h the identity provider to use
 304  * @param identity the issuing identity
 305  * @param error_cb function to call on error (i.e. disconnect),
 306  *        the handle is afterwards invalid
 307  * @param error_cb_cls closure for @a error_cb
 308  * @param proc function to call on each ticket; it
 309  *        will be called repeatedly with a value (if available)
 310  * @param proc_cls closure for @a proc
 311  * @param finish_cb function to call on completion
 312  *        the handle is afterwards invalid
 313  * @param finish_cb_cls closure for @a finish_cb
 314  * @return an iterator handle to use for iteration
 315  */
 316 struct GNUNET_IDENTITY_PROVIDER_TicketIterator *
 317 GNUNET_IDENTITY_PROVIDER_ticket_iteration_start_rp (struct GNUNET_IDENTITY_PROVIDER_Handle *h,
 318                                                     const struct GNUNET_CRYPTO_EcdsaPublicKey *identity,
 319                                                     GNUNET_SCHEDULER_TaskCallback error_cb,
 320                                                     void *error_cb_cls,
 321                                                     GNUNET_IDENTITY_PROVIDER_TicketCallback proc,
 322                                                     void *proc_cls,
 323                                                     GNUNET_SCHEDULER_TaskCallback finish_cb,
 324                                                     void *finish_cb_cls);
 325
 326 /**
 327  * Calls the record processor specified in #GNUNET_IDENTITY_PROVIDER_ticket_iteration_start
 328  * for the next record.
 329  *
 330  * @param it the iterator
 331  */
 332 void
 333 GNUNET_IDENTITY_PROVIDER_ticket_iteration_next (struct GNUNET_IDENTITY_PROVIDER_TicketIterator *it);
 334
 335 /**
 336  * Stops iteration and releases the idp handle for further calls.  Must
 337  * be called on any iteration that has not yet completed prior to calling
 338  * #GNUNET_IDENTITY_PROVIDER_disconnect.
 339  *
 340  * @param it the iterator
 341  */
 342 void
 343 GNUNET_IDENTITY_PROVIDER_ticket_iteration_stop (struct GNUNET_IDENTITY_PROVIDER_TicketIterator *it);
 344
 345 /**
 346  * Disconnect from identity provider service.
 347  *
 348  * @param h identity provider service to disconnect
 349  */
 350 void
 351 GNUNET_IDENTITY_PROVIDER_disconnect (struct GNUNET_IDENTITY_PROVIDER_Handle *h);
 352
 353
 354 /**
 355  * Cancel an identity provider operation.  Note that the operation MAY still
 356  * be executed; this merely cancels the continuation; if the request
 357  * was already transmitted, the service may still choose to complete
 358  * the operation.
 359  *
 360  * @param op operation to cancel
 361  */
 362 void
 363 GNUNET_IDENTITY_PROVIDER_cancel (struct GNUNET_IDENTITY_PROVIDER_Operation *op);
 364
 365 #if 0                           /* keep Emacsens' auto-indent happy */
 366 {
 367 #endif
 368 #ifdef __cplusplus
 369 }
 370 #endif
 371
 372
 373 /* ifndef GNUNET_IDENTITY_PROVIDER_SERVICE_H */
 374 #endif
 375
 376 /** @} */ /* end of group identity */
 377
 378 /* end of gnunet_identity_provider_service.h */