src/include/gnunet_credential_service.h

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2012-2014 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  * @author Adnan Husain
  24  *
  25  * @file
  26  * API to the Credential service
  27  *
  28  * @defgroup credential  Credential service
  29  * Credentials
  30  *
  31  * @{
  32  */
  33 #ifndef GNUNET_CREDENTIAL_SERVICE_H
  34 #define GNUNET_CREDENTIAL_SERVICE_H
  35
  36 #include "gnunet_util_lib.h"
  37 #include "gnunet_gns_service.h"
  38 #include "gnunet_identity_service.h"
  39
  40 #ifdef __cplusplus
  41 extern "C"
  42 {
  43 #if 0                           /* keep Emacsens' auto-indent happy */
  44 }
  45 #endif
  46 #endif
  47
  48
  49 /**
  50  * Connection to the Credential service.
  51  */
  52 struct GNUNET_CREDENTIAL_Handle;
  53
  54 /**
  55  * Handle to control a lookup operation.
  56  */
  57 struct GNUNET_CREDENTIAL_Request;
  58
  59 /*
  60 * Enum used for checking whether the issuer has the authority to issue credentials or is just a subject
  61 */
  62 enum GNUNET_CREDENTIAL_CredentialFlags {
  63
  64   //Subject had credentials before, but have been revoked now
  65   GNUNET_CREDENTIAL_FLAG_REVOKED=0,
  66
  67   //Subject flag indicates that the subject is a holder of this credential and may present it as such
  68   GNUNET_CREDENTIAL_FLAG_SUBJECT=1,
  69
  70   //Issuer flag is used to signify that the subject is allowed to issue this credential and delegate issuance
  71   GNUNET_CREDENTIAL_FLAG_ISSUER=2
  72
  73 };
  74
  75 GNUNET_NETWORK_STRUCT_BEGIN
  76 /**
  77  * The credential record
  78  */
  79 struct GNUNET_CREDENTIAL_CredentialRecordData {
  80
  81   /**
  82    * The signature for this credential by the issuer
  83    */
  84   struct GNUNET_CRYPTO_EcdsaSignature sig;
  85
  86
  87   /**
  88    * Public key of the issuer
  89    */
  90   struct GNUNET_CRYPTO_EcdsaPublicKey issuer_key;
  91
  92   /**
  93    * Public key of the subject this credential was issued to
  94    */
  95   struct GNUNET_CRYPTO_EcdsaPublicKey subject_key;
  96
  97   /**
  98    * Expiration time of this credential
  99    */
 100   uint64_t expiration GNUNET_PACKED;
 101
 102     /**
 103    * Followed by the attribute string
 104    */
 105 };
 106
 107
 108 /**
 109  * The attribute delegation record
 110 */
 111 struct GNUNET_CREDENTIAL_AttributeRecordData {
 112
 113   /**
 114    * Public key of the subject this attribute was delegated to
 115    */
 116   struct GNUNET_CRYPTO_EcdsaPublicKey subject_key;
 117
 118   /**
 119    * Followed by the attribute that was delegated to as string
 120    * May be empty
 121    */
 122 };
 123
 124
 125
 126 GNUNET_NETWORK_STRUCT_END
 127
 128
 129
 130 /**
 131  * Initialize the connection with the Credential service.
 132  *
 133  * @param cfg configuration to use
 134  * @return handle to the Credential service, or NULL on error
 135  */
 136 struct GNUNET_CREDENTIAL_Handle *
 137 GNUNET_CREDENTIAL_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 138
 139
 140 /**
 141  * Shutdown connection with the Credentail service.
 142  *
 143  * @param handle connection to shut down
 144  */
 145 void
 146 GNUNET_CREDENTIAL_disconnect (struct GNUNET_CREDENTIAL_Handle *handle);
 147
 148
 149 /**
 150  * Iterator called on obtained result for an attribute verification.
 151  *
 152  * @param cls closure
 153  * @param issuer the issuer of the attribute NULL if verification failed
 154  * @param result the result of the verification
 155  * @param rd the records in reply
 156  */
 157 typedef void (*GNUNET_CREDENTIAL_VerifyResultProcessor) (void *cls,
 158                                                   struct GNUNET_CRYPTO_EcdsaPublicKey *issuer,
 159               uint32_t result);
 160
 161 /**
 162  * Iterator called on obtained result for an attribute delegation.
 163  *
 164  * @param cls closure
 165  * @param success GNUNET_YES if successful
 166  * @param result the record data that can be handed to the subject
 167  */
 168 typedef void (*GNUNET_CREDENTIAL_DelegateResultProcessor) (void *cls,
 169                                                   uint32_t success);
 170
 171 /**
 172  * Iterator called on obtained result for an attribute delegation removal.
 173  *
 174  * @param cls closure
 175  * @param success GNUNET_YES if successful
 176  * @param result the record data that can be handed to the subject
 177  */
 178 typedef void (*GNUNET_CREDENTIAL_RemoveDelegateResultProcessor) (void *cls,
 179                                                   uint32_t success);
 180
 181
 182
 183
 184 /**
 185  * Performs attribute verification.
 186  * Checks if there is a delegation chain from
 187  * attribute ``issuer_attribute'' issued by the issuer
 188  * with public key ``issuer_key'' maps to the attribute
 189  * ``subject_attribute'' claimed by the subject with key
 190  * ``subject_key''
 191  *
 192  * @param handle handle to the Credential service
 193  * @param issuer_key the issuer public key
 194  * @param issuer_attribute the issuer attribute
 195  * @param subject_key the subject public key
 196  * @param subject_attribute the attribute claimed by the subject
 197  * @param proc function to call on result
 198  * @param proc_cls closure for processor
 199  * @return handle to the queued request
 200  */
 201 struct GNUNET_CREDENTIAL_Request*
 202 GNUNET_CREDENTIAL_verify (struct GNUNET_CREDENTIAL_Handle *handle,
 203                           const struct GNUNET_CRYPTO_EcdsaPublicKey *issuer_key,
 204                           const char *issuer_attribute,
 205                           const struct GNUNET_CRYPTO_EcdsaPublicKey *subject_key,
 206                           const char *subject_attribute,
 207                           GNUNET_CREDENTIAL_VerifyResultProcessor proc,
 208                           void *proc_cls);
 209
 210 /**
 211  * Delegate an attribute
 212  *
 213  * @param handle handle to the Credential service
 214  * @param issuer the ego that should be used to delegate the attribute
 215  * @param attribute the name of the attribute to delegate
 216  * @param subject the subject of the delegation
 217  * @param delegated_attribute the name of the attribute that is delegated to
 218  * @return handle to the queued request
 219  */
 220 struct GNUNET_CREDENTIAL_Request *
 221 GNUNET_CREDENTIAL_add_delegation (struct GNUNET_CREDENTIAL_Handle *handle,
 222                                   struct GNUNET_IDENTITY_Ego *issuer,
 223                                   const char *attribute,
 224                                   struct GNUNET_CRYPTO_EcdsaPublicKey *subject,
 225                                   const char *delegated_attribute,
 226                                   GNUNET_CREDENTIAL_DelegateResultProcessor proc,
 227                                   void *proc_cls);
 228
 229 /**
 230  * Remove a delegation
 231  *
 232  * @param handle handle to the Credential service
 233  * @param issuer the ego that was used to delegate the attribute
 234  * @param attribute the name of the attribute that is delegated
 235  * @return handle to the queued request
 236  */
 237 struct GNUNET_CREDENTIAL_Request *
 238 GNUNET_CREDENTIAL_remove_delegation (struct GNUNET_CREDENTIAL_Handle *handle,
 239                                   struct GNUNET_IDENTITY_Ego *issuer,
 240                                   const char *attribute,
 241                                   GNUNET_CREDENTIAL_RemoveDelegateResultProcessor proc,
 242                                   void *proc_cls);
 243
 244
 245
 246 /**
 247  * Issue an attribute to a subject
 248  *
 249  * @param handle handle to the Credential service
 250  * @param issuer the ego that should be used to issue the attribute
 251  * @param subject the subject of the attribute
 252  * @param attribute the name of the attribute
 253  * @return handle to the queued request
 254  */
 255 struct GNUNET_CREDENTIAL_CredentialRecordData *
 256 GNUNET_CREDENTIAL_issue (struct GNUNET_CREDENTIAL_Handle *handle,
 257                          const struct GNUNET_CRYPTO_EcdsaPrivateKey *issuer,
 258                          struct GNUNET_CRYPTO_EcdsaPublicKey *subject,
 259                          const char *attribute);
 260
 261
 262 /**
 263  * Remove a credential
 264  *
 265  * @param handle handle to the Credential service
 266  * @param issuer the identity that issued the credential
 267  * @param subject the subject of the credential
 268  * @param credential the name of the credential
 269  * @return handle to the queued request
 270  */
 271 /**
 272   struct GNUNET_CREDENTIAL_IssueRequest *
 273   GNUNET_CREDENTIAL_remove (struct GNUNET_CREDENTIAL_Handle *handle,
 274   struct GNUNET_IDENTITY_Ego *issuer,
 275   struct GNUNET_IDENTITY_Ego *subject,
 276   const char *credential,
 277   GNUNET_CREDENTIAL_IssueResultProcessor proc,
 278   void *proc_cls);
 279   */
 280
 281
 282 /**
 283  * Cancel pending lookup request
 284  *
 285  * @param lr the lookup request to cancel
 286  */
 287 void
 288 GNUNET_CREDENTIAL_verify_cancel (struct GNUNET_CREDENTIAL_Request *vr);
 289
 290
 291 #if 0                           /* keep Emacsens' auto-indent happy */
 292 {
 293 #endif
 294 #ifdef __cplusplus
 295 }
 296 #endif
 297
 298 #endif
 299
 300 /** @} */  /* end of group */