crypto/store/store.h

   1 /* crypto/store/store.h -*- mode:C; c-file-style: "eay" -*- */
   2 /* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
   3  * project 2003.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 2003 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgment:
  22  *    "This product includes software developed by the OpenSSL Project
  23  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  24  *
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26  *    endorse or promote products derived from this software without
  27  *    prior written permission. For written permission, please contact
  28  *    openssl-core@openssl.org.
  29  *
  30  * 5. Products derived from this software may not be called "OpenSSL"
  31  *    nor may "OpenSSL" appear in their names without prior written
  32  *    permission of the OpenSSL Project.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  * ====================================================================
  52  *
  53  * This product includes cryptographic software written by Eric Young
  54  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58
  59 #ifndef HEADER_STORE_H
  60 #define HEADER_STORE_H
  61
  62 #include <openssl/ossl_typ.h>
  63 #include <openssl/x509.h>
  64 #include <openssl/evp.h>
  65 #include <openssl/bn.h>
  66
  67 #ifdef  __cplusplus
  68 extern "C" {
  69 #endif
  70
  71 /* Already defined in ossl_typ.h */
  72 /* typedef struct store_st STORE; */
  73 /* typedef struct store_method_st STORE_METHOD; */
  74
  75
  76 /* All the following functions return 0, a negative number or NULL on error.
  77    When everything is fine, they return a positive value or a non-NULL
  78    pointer, all depending on their purpose. */
  79
  80 /* Creators and destructor.   */
  81 STORE *STORE_new_method(const STORE_METHOD *method);
  82 STORE *STORE_new_engine(ENGINE *engine);
  83 void STORE_free(STORE *ui);
  84
  85
  86 /* Give a user interface parametrised control commands.  This can be used to
  87    send down an integer, a data pointer or a function pointer, as well as
  88    be used to get information from a STORE. */
  89 int STORE_ctrl(STORE *store, int cmd, long i, void *p, void (*f)(void));
  90
  91 /* A control to set the directory with keys and certificates.  Used by the
  92    built-in directory level method. */
  93 #define STORE_CTRL_SET_DIRECTORY        0x0001
  94 /* A control to set a file to load.  Used by the built-in file level method. */
  95 #define STORE_CTRL_SET_FILE             0x0002
  96 /* A control to set a configuration file to load.  Can be used by any method
  97    that wishes to load a configuration file. */
  98 #define STORE_CTRL_SET_CONF_FILE        0x0003
  99 /* A control to set a the section of the loaded configuration file.  Can be
 100    used by any method that wishes to load a configuration file. */
 101 #define STORE_CTRL_SET_CONF_SECTION     0x0004
 102
 103
 104 /* Some methods may use extra data */
 105 #define STORE_set_app_data(s,arg)       STORE_set_ex_data(s,0,arg)
 106 #define STORE_get_app_data(s)           STORE_get_ex_data(s,0)
 107 int STORE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 108         CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
 109 int STORE_set_ex_data(STORE *r,int idx,void *arg);
 110 void *STORE_get_ex_data(STORE *r, int idx);
 111
 112 /* Use specific methods instead of the built-in one */
 113 const STORE_METHOD *STORE_get_method(STORE *store);
 114 const STORE_METHOD *STORE_set_method(STORE *store, const STORE_METHOD *meth);
 115
 116 /* The standard OpenSSL methods. */
 117 /* This is the in-memory method.  It does everything except revoking and updating,
 118    and is of course volatile.  It's used by other methods that have an in-memory
 119    cache. */
 120 const STORE_METHOD *STORE_Memory(void);
 121 #if 0 /* Not yet implemented */
 122 /* This is the directory store.  It does everything except revoking and updating,
 123    and uses STORE_Memory() to cache things in memory. */
 124 const STORE_METHOD *STORE_Directory(void);
 125 /* This is the file store.  It does everything except revoking and updating,
 126    and uses STORE_Memory() to cache things in memory.  Certificates are added
 127    to it with the store operation, and it will only get cached certificates. */
 128 const STORE_METHOD *STORE_File(void);
 129 #endif
 130
 131 /* Store functions take a type code for the type of data they should store
 132    or fetch */
 133 typedef enum STORE_object_types
 134         {
 135         STORE_OBJECT_TYPE_X509_CERTIFICATE=     0x01, /* X509 * */
 136         STORE_OBJECT_TYPE_X509_CRL=             0x02, /* X509_CRL * */
 137         STORE_OBJECT_TYPE_PRIVATE_KEY=          0x03, /* EVP_PKEY * */
 138         STORE_OBJECT_TYPE_PUBLIC_KEY=           0x04, /* EVP_PKEY * */
 139         STORE_OBJECT_TYPE_NUMBER=               0x05, /* BIGNUM * */
 140         STORE_OBJECT_TYPE_ARBITRARY=            0x06, /* BUF_MEM * */
 141         STORE_OBJECT_TYPE_NUM=                  0x06  /* The amount of known
 142                                                          object types */
 143         } STORE_OBJECT_TYPES;
 144 /* List of text strings corresponding to the object types. */
 145 extern const char * const STORE_object_type_string[STORE_OBJECT_TYPE_NUM+1];
 146
 147 /* Some store functions take a parameter list.  Those parameters come with
 148    one of the following codes. The comments following the codes below indicate
 149    what type the value should be a pointer to. */
 150 typedef enum STORE_params
 151         {
 152         STORE_PARAM_EVP_TYPE=                   0x01, /* int */
 153         STORE_PARAM_BITS=                       0x02, /* size_t */
 154         STORE_PARAM_KEY_PARAMETERS=             0x03, /* ??? */
 155         STORE_PARAM_KEY_NO_PARAMETERS=          0x04, /* N/A */
 156         STORE_PARAM_AUTH_PASSPHRASE=            0x05, /* char * */
 157         STORE_PARAM_AUTH_KRB5_TICKET=           0x06, /* void * */
 158         STORE_PARAM_TYPE_NUM=                   0x06  /* The amount of known
 159                                                          parameter types */
 160         } STORE_PARAM_TYPES;
 161 /* Parameter value sizes.  -1 means unknown, anything else is the required size. */
 162 extern const int STORE_param_sizes[STORE_PARAM_TYPE_NUM+1];
 163
 164 /* Store functions take attribute lists.  Those attributes come with codes.
 165    The comments following the codes below indicate what type the value should
 166    be a pointer to. */
 167 typedef enum STORE_attribs
 168         {
 169         STORE_ATTR_END=                         0x00,
 170         STORE_ATTR_FRIENDLYNAME=                0x01, /* C string */
 171         STORE_ATTR_KEYID=                       0x02, /* 160 bit string (SHA1) */
 172         STORE_ATTR_ISSUERKEYID=                 0x03, /* 160 bit string (SHA1) */
 173         STORE_ATTR_SUBJECTKEYID=                0x04, /* 160 bit string (SHA1) */
 174         STORE_ATTR_ISSUERSERIALHASH=            0x05, /* 160 bit string (SHA1) */
 175         STORE_ATTR_ISSUER=                      0x06, /* X509_NAME * */
 176         STORE_ATTR_SERIAL=                      0x07, /* BIGNUM * */
 177         STORE_ATTR_SUBJECT=                     0x08, /* X509_NAME * */
 178         STORE_ATTR_CERTHASH=                    0x09, /* 160 bit string (SHA1) */
 179         STORE_ATTR_EMAIL=                       0x0a, /* C string */
 180         STORE_ATTR_FILENAME=                    0x0b, /* C string */
 181         STORE_ATTR_TYPE_NUM=                    0x0b, /* The amount of known
 182                                                          attribute types */
 183         STORE_ATTR_OR=                          0xff  /* This is a special
 184                                                          separator, which
 185                                                          expresses the OR
 186                                                          operation.  */
 187         } STORE_ATTR_TYPES;
 188 /* Attribute value sizes.  -1 means unknown, anything else is the required size. */
 189 extern const int STORE_attr_sizes[STORE_ATTR_TYPE_NUM+1];
 190
 191 typedef enum STORE_certificate_status
 192         {
 193         STORE_X509_VALID=                       0x00,
 194         STORE_X509_EXPIRED=                     0x01,
 195         STORE_X509_SUSPENDED=                   0x02,
 196         STORE_X509_REVOKED=                     0x03
 197         } STORE_CERTIFICATE_STATUS;
 198
 199 /* Engine store functions will return a structure that contains all the necessary
 200  * information, including revokation status for certificates.  This is really not
 201  * needed for application authors, as the ENGINE framework functions will extract
 202  * the OpenSSL-specific information when at all possible.  However, for engine
 203  * authors, it's crucial to know this structure.  */
 204 typedef struct STORE_OBJECT_st
 205         {
 206         STORE_OBJECT_TYPES type;
 207         union
 208                 {
 209                 struct
 210                         {
 211                         STORE_CERTIFICATE_STATUS status;
 212                         X509 *certificate;
 213                         } x509;
 214                 X509_CRL *crl;
 215                 EVP_PKEY *key;
 216                 BIGNUM *number;
 217                 BUF_MEM *arbitrary;
 218                 } data;
 219         } STORE_OBJECT;
 220 DECLARE_STACK_OF(STORE_OBJECT)
 221 STORE_OBJECT *STORE_OBJECT_new(void);
 222 void STORE_OBJECT_free(STORE_OBJECT *data);
 223
 224
 225
 226 /* The following functions handle the storage. They return 0, a negative number
 227    or NULL on error, anything else on success. */
 228 X509 *STORE_get_certificate(STORE *e, OPENSSL_ITEM attributes[],
 229         OPENSSL_ITEM parameters[]);
 230 int STORE_store_certificate(STORE *e, X509 *data, OPENSSL_ITEM attributes[],
 231         OPENSSL_ITEM parameters[]);
 232 int STORE_modify_certificate(STORE *e, OPENSSL_ITEM search_attributes[],
 233         OPENSSL_ITEM add_attributes[], OPENSSL_ITEM modify_attributes[],
 234         OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
 235 int STORE_revoke_certificate(STORE *e, OPENSSL_ITEM attributes[],
 236         OPENSSL_ITEM parameters[]);
 237 int STORE_delete_certificate(STORE *e, OPENSSL_ITEM attributes[],
 238         OPENSSL_ITEM parameters[]);
 239 void *STORE_list_certificate_start(STORE *e, OPENSSL_ITEM attributes[],
 240         OPENSSL_ITEM parameters[]);
 241 X509 *STORE_list_certificate_next(STORE *e, void *handle);
 242 int STORE_list_certificate_end(STORE *e, void *handle);
 243 int STORE_list_certificate_endp(STORE *e, void *handle);
 244 EVP_PKEY *STORE_generate_key(STORE *e, OPENSSL_ITEM attributes[],
 245         OPENSSL_ITEM parameters[]);
 246 EVP_PKEY *STORE_get_private_key(STORE *e, OPENSSL_ITEM attributes[],
 247         OPENSSL_ITEM parameters[]);
 248 int STORE_store_private_key(STORE *e, EVP_PKEY *data,
 249         OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
 250 int STORE_modify_private_key(STORE *e, OPENSSL_ITEM search_attributes[],
 251         OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
 252         OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
 253 int STORE_revoke_private_key(STORE *e, OPENSSL_ITEM attributes[],
 254         OPENSSL_ITEM parameters[]);
 255 int STORE_delete_private_key(STORE *e, OPENSSL_ITEM attributes[],
 256         OPENSSL_ITEM parameters[]);
 257 void *STORE_list_private_key_start(STORE *e, OPENSSL_ITEM attributes[],
 258         OPENSSL_ITEM parameters[]);
 259 EVP_PKEY *STORE_list_private_key_next(STORE *e, void *handle);
 260 int STORE_list_private_key_end(STORE *e, void *handle);
 261 int STORE_list_private_key_endp(STORE *e, void *handle);
 262 EVP_PKEY *STORE_get_public_key(STORE *e, OPENSSL_ITEM attributes[],
 263         OPENSSL_ITEM parameters[]);
 264 int STORE_store_public_key(STORE *e, EVP_PKEY *data, OPENSSL_ITEM attributes[],
 265         OPENSSL_ITEM parameters[]);
 266 int STORE_modify_public_key(STORE *e, OPENSSL_ITEM search_attributes[],
 267         OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
 268         OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
 269 int STORE_revoke_public_key(STORE *e, OPENSSL_ITEM attributes[],
 270         OPENSSL_ITEM parameters[]);
 271 int STORE_delete_public_key(STORE *e, OPENSSL_ITEM attributes[],
 272         OPENSSL_ITEM parameters[]);
 273 void *STORE_list_public_key_start(STORE *e, OPENSSL_ITEM attributes[],
 274         OPENSSL_ITEM parameters[]);
 275 EVP_PKEY *STORE_list_public_key_next(STORE *e, void *handle);
 276 int STORE_list_public_key_end(STORE *e, void *handle);
 277 int STORE_list_public_key_endp(STORE *e, void *handle);
 278 X509_CRL *STORE_generate_crl(STORE *e, OPENSSL_ITEM attributes[],
 279         OPENSSL_ITEM parameters[]);
 280 X509_CRL *STORE_get_crl(STORE *e, OPENSSL_ITEM attributes[],
 281         OPENSSL_ITEM parameters[]);
 282 int STORE_store_crl(STORE *e, X509_CRL *data, OPENSSL_ITEM attributes[],
 283         OPENSSL_ITEM parameters[]);
 284 int STORE_modify_crl(STORE *e, OPENSSL_ITEM search_attributes[],
 285         OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
 286         OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
 287 int STORE_delete_crl(STORE *e, OPENSSL_ITEM attributes[],
 288         OPENSSL_ITEM parameters[]);
 289 void *STORE_list_crl_start(STORE *e, OPENSSL_ITEM attributes[],
 290         OPENSSL_ITEM parameters[]);
 291 X509_CRL *STORE_list_crl_next(STORE *e, void *handle);
 292 int STORE_list_crl_end(STORE *e, void *handle);
 293 int STORE_list_crl_endp(STORE *e, void *handle);
 294 int STORE_store_number(STORE *e, BIGNUM *data, OPENSSL_ITEM attributes[],
 295         OPENSSL_ITEM parameters[]);
 296 int STORE_modify_number(STORE *e, OPENSSL_ITEM search_attributes[],
 297         OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
 298         OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
 299 BIGNUM *STORE_get_number(STORE *e, OPENSSL_ITEM attributes[],
 300         OPENSSL_ITEM parameters[]);
 301 int STORE_delete_number(STORE *e, OPENSSL_ITEM attributes[],
 302         OPENSSL_ITEM parameters[]);
 303 int STORE_store_arbitrary(STORE *e, BUF_MEM *data, OPENSSL_ITEM attributes[],
 304         OPENSSL_ITEM parameters[]);
 305 int STORE_modify_arbitrary(STORE *e, OPENSSL_ITEM search_attributes[],
 306         OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
 307         OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
 308 BUF_MEM *STORE_get_arbitrary(STORE *e, OPENSSL_ITEM attributes[],
 309         OPENSSL_ITEM parameters[]);
 310 int STORE_delete_arbitrary(STORE *e, OPENSSL_ITEM attributes[],
 311         OPENSSL_ITEM parameters[]);
 312
 313
 314 /* Create and manipulate methods */
 315 STORE_METHOD *STORE_create_method(char *name);
 316 void STORE_destroy_method(STORE_METHOD *store_method);
 317
 318 /* These callback types are use for store handlers */
 319 typedef int (*STORE_INITIALISE_FUNC_PTR)(STORE *);
 320 typedef void (*STORE_CLEANUP_FUNC_PTR)(STORE *);
 321 typedef STORE_OBJECT *(*STORE_GENERATE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
 322 typedef STORE_OBJECT *(*STORE_GET_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
 323 typedef void *(*STORE_START_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
 324 typedef STORE_OBJECT *(*STORE_NEXT_OBJECT_FUNC_PTR)(STORE *, void *handle);
 325 typedef int (*STORE_END_OBJECT_FUNC_PTR)(STORE *, void *handle);
 326 typedef int (*STORE_HANDLE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
 327 typedef int (*STORE_STORE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, STORE_OBJECT *data, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
 328 typedef int (*STORE_MODIFY_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM search_attributes[], OPENSSL_ITEM add_attributes[], OPENSSL_ITEM modify_attributes[], OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
 329 typedef int (*STORE_GENERIC_FUNC_PTR)(STORE *, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
 330 typedef int (*STORE_CTRL_FUNC_PTR)(STORE *, int cmd, long l, void *p, void (*f)(void));
 331
 332 int STORE_method_set_initialise_function(STORE_METHOD *sm, STORE_INITIALISE_FUNC_PTR init_f);
 333 int STORE_method_set_cleanup_function(STORE_METHOD *sm, STORE_CLEANUP_FUNC_PTR clean_f);
 334 int STORE_method_set_generate_function(STORE_METHOD *sm, STORE_GENERATE_OBJECT_FUNC_PTR generate_f);
 335 int STORE_method_set_get_function(STORE_METHOD *sm, STORE_GET_OBJECT_FUNC_PTR get_f);
 336 int STORE_method_set_store_function(STORE_METHOD *sm, STORE_STORE_OBJECT_FUNC_PTR store_f);
 337 int STORE_method_set_modify_function(STORE_METHOD *sm, STORE_MODIFY_OBJECT_FUNC_PTR store_f);
 338 int STORE_method_set_revoke_function(STORE_METHOD *sm, STORE_HANDLE_OBJECT_FUNC_PTR revoke_f);
 339 int STORE_method_set_delete_function(STORE_METHOD *sm, STORE_HANDLE_OBJECT_FUNC_PTR delete_f);
 340 int STORE_method_set_list_start_function(STORE_METHOD *sm, STORE_START_OBJECT_FUNC_PTR list_start_f);
 341 int STORE_method_set_list_next_function(STORE_METHOD *sm, STORE_NEXT_OBJECT_FUNC_PTR list_next_f);
 342 int STORE_method_set_list_end_function(STORE_METHOD *sm, STORE_END_OBJECT_FUNC_PTR list_end_f);
 343 int STORE_method_set_update_store_function(STORE_METHOD *sm, STORE_GENERIC_FUNC_PTR);
 344 int STORE_method_set_lock_store_function(STORE_METHOD *sm, STORE_GENERIC_FUNC_PTR);
 345 int STORE_method_set_unlock_store_function(STORE_METHOD *sm, STORE_GENERIC_FUNC_PTR);
 346 int STORE_method_set_ctrl_function(STORE_METHOD *sm, STORE_CTRL_FUNC_PTR ctrl_f);
 347
 348 STORE_INITIALISE_FUNC_PTR STORE_method_get_initialise_function(STORE_METHOD *sm);
 349 STORE_CLEANUP_FUNC_PTR STORE_method_get_cleanup_function(STORE_METHOD *sm);
 350 STORE_GENERATE_OBJECT_FUNC_PTR STORE_method_get_generate_function(STORE_METHOD *sm);
 351 STORE_GET_OBJECT_FUNC_PTR STORE_method_get_get_function(STORE_METHOD *sm);
 352 STORE_STORE_OBJECT_FUNC_PTR STORE_method_get_store_function(STORE_METHOD *sm);
 353 STORE_MODIFY_OBJECT_FUNC_PTR STORE_method_get_modify_function(STORE_METHOD *sm);
 354 STORE_HANDLE_OBJECT_FUNC_PTR STORE_method_get_revoke_function(STORE_METHOD *sm);
 355 STORE_HANDLE_OBJECT_FUNC_PTR STORE_method_get_delete_function(STORE_METHOD *sm);
 356 STORE_START_OBJECT_FUNC_PTR STORE_method_get_list_start_function(STORE_METHOD *sm);
 357 STORE_NEXT_OBJECT_FUNC_PTR STORE_method_get_list_next_function(STORE_METHOD *sm);
 358 STORE_END_OBJECT_FUNC_PTR STORE_method_get_list_end_function(STORE_METHOD *sm);
 359 STORE_GENERIC_FUNC_PTR STORE_method_get_update_store_function(STORE_METHOD *sm);
 360 STORE_GENERIC_FUNC_PTR STORE_method_get_lock_store_function(STORE_METHOD *sm);
 361 STORE_GENERIC_FUNC_PTR STORE_method_get_unlock_store_function(STORE_METHOD *sm);
 362 STORE_CTRL_FUNC_PTR STORE_method_get_ctrl_function(STORE_METHOD *sm);
 363
 364 /* Method helper structures and functions. */
 365
 366 /* This structure is the result of parsing through the information in a list
 367    of OPENSSL_ITEMs.  It stores all the necessary information in a structured
 368    way.*/
 369 typedef struct STORE_attr_info_st STORE_ATTR_INFO;
 370
 371 /* Parse a list of OPENSSL_ITEMs and return a pointer to a STORE_ATTR_INFO.
 372    Note that we do this in the list form, since the list of OPENSSL_ITEMs can
 373    come in blocks separated with STORE_ATTR_OR.  Note that the value returned
 374    by STORE_parse_attrs_next() must be freed with STORE_ATTR_INFO_free(). */
 375 void *STORE_parse_attrs_start(OPENSSL_ITEM *attributes);
 376 STORE_ATTR_INFO *STORE_parse_attrs_next(void *handle);
 377 int STORE_parse_attrs_end(void *handle);
 378 int STORE_parse_attrs_endp(void *handle);
 379
 380 /* Creator and destructor */
 381 STORE_ATTR_INFO *STORE_ATTR_INFO_new(void);
 382 int STORE_ATTR_INFO_free(STORE_ATTR_INFO *attrs);
 383
 384 /* Manipulators */
 385 char *STORE_ATTR_INFO_get0_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code);
 386 unsigned char *STORE_ATTR_INFO_get0_sha1str(STORE_ATTR_INFO *attrs,
 387         STORE_ATTR_TYPES code);
 388 X509_NAME *STORE_ATTR_INFO_get0_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code);
 389 BIGNUM *STORE_ATTR_INFO_get0_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code);
 390 int STORE_ATTR_INFO_set_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
 391         char *cstr, size_t cstr_size);
 392 int STORE_ATTR_INFO_set_sha1str(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
 393         unsigned char *sha1str, size_t sha1str_size);
 394 int STORE_ATTR_INFO_set_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
 395         X509_NAME *dn);
 396 int STORE_ATTR_INFO_set_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
 397         BIGNUM *number);
 398 int STORE_ATTR_INFO_modify_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
 399         char *cstr, size_t cstr_size);
 400 int STORE_ATTR_INFO_modify_sha1str(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
 401         unsigned char *sha1str, size_t sha1str_size);
 402 int STORE_ATTR_INFO_modify_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
 403         X509_NAME *dn);
 404 int STORE_ATTR_INFO_modify_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
 405         BIGNUM *number);
 406
 407 /* Compare on basis of a bit pattern formed by the STORE_ATTR_TYPES values
 408    in each contained attribute. */
 409 int STORE_ATTR_INFO_compare(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
 410 /* Check if the set of attributes in a is within the range of attributes
 411    set in b. */
 412 int STORE_ATTR_INFO_in_range(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
 413 /* Check if the set of attributes in a are also set in b. */
 414 int STORE_ATTR_INFO_in(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
 415 /* Same as STORE_ATTR_INFO_in(), but also checks the attribute values. */
 416 int STORE_ATTR_INFO_in_ex(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
 417
 418
 419 /* BEGIN ERROR CODES */
 420 /* The following lines are auto generated by the script mkerr.pl. Any changes
 421  * made after this point may be overwritten when the script is next run.
 422  */
 423 void ERR_load_STORE_strings(void);
 424
 425 /* Error codes for the STORE functions. */
 426
 427 /* Function codes. */
 428 #define STORE_F_CTRL                                     160
 429 #define STORE_F_MEM_DELETE                               134
 430 #define STORE_F_MEM_GENERATE                             135
 431 #define STORE_F_MEM_LIST_NEXT                            136
 432 #define STORE_F_MEM_LIST_START                           137
 433 #define STORE_F_MEM_STORE                                138
 434 #define STORE_F_STORE_ARBITRARY                          157
 435 #define STORE_F_STORE_ATTR_INFO_GET0_CSTR                139
 436 #define STORE_F_STORE_ATTR_INFO_GET0_DN                  140
 437 #define STORE_F_STORE_ATTR_INFO_GET0_NUMBER              141
 438 #define STORE_F_STORE_ATTR_INFO_GET0_SHA1STR             142
 439 #define STORE_F_STORE_ATTR_INFO_MODIFY_CSTR              143
 440 #define STORE_F_STORE_ATTR_INFO_MODIFY_DN                144
 441 #define STORE_F_STORE_ATTR_INFO_MODIFY_NUMBER            145
 442 #define STORE_F_STORE_ATTR_INFO_MODIFY_SHA1STR           146
 443 #define STORE_F_STORE_ATTR_INFO_SET_CSTR                 147
 444 #define STORE_F_STORE_ATTR_INFO_SET_DN                   148
 445 #define STORE_F_STORE_ATTR_INFO_SET_NUMBER               149
 446 #define STORE_F_STORE_ATTR_INFO_SET_SHA1STR              150
 447 #define STORE_F_STORE_CERTIFICATE                        100
 448 #define STORE_F_STORE_CRL                                101
 449 #define STORE_F_STORE_CTRL                               161
 450 #define STORE_F_STORE_DELETE_ARBITRARY                   158
 451 #define STORE_F_STORE_DELETE_CERTIFICATE                 102
 452 #define STORE_F_STORE_DELETE_CRL                         103
 453 #define STORE_F_STORE_DELETE_NUMBER                      104
 454 #define STORE_F_STORE_DELETE_PRIVATE_KEY                 105
 455 #define STORE_F_STORE_DELETE_PUBLIC_KEY                  106
 456 #define STORE_F_STORE_GENERATE_CRL                       107
 457 #define STORE_F_STORE_GENERATE_KEY                       108
 458 #define STORE_F_STORE_GET_ARBITRARY                      159
 459 #define STORE_F_STORE_GET_CERTIFICATE                    109
 460 #define STORE_F_STORE_GET_CRL                            110
 461 #define STORE_F_STORE_GET_NUMBER                         111
 462 #define STORE_F_STORE_GET_PRIVATE_KEY                    112
 463 #define STORE_F_STORE_GET_PUBLIC_KEY                     113
 464 #define STORE_F_STORE_LIST_CERTIFICATE_END               114
 465 #define STORE_F_STORE_LIST_CERTIFICATE_ENDP              153
 466 #define STORE_F_STORE_LIST_CERTIFICATE_NEXT              115
 467 #define STORE_F_STORE_LIST_CERTIFICATE_START             116
 468 #define STORE_F_STORE_LIST_CRL_END                       117
 469 #define STORE_F_STORE_LIST_CRL_ENDP                      154
 470 #define STORE_F_STORE_LIST_CRL_NEXT                      118
 471 #define STORE_F_STORE_LIST_CRL_START                     119
 472 #define STORE_F_STORE_LIST_PRIVATE_KEY_END               120
 473 #define STORE_F_STORE_LIST_PRIVATE_KEY_ENDP              155
 474 #define STORE_F_STORE_LIST_PRIVATE_KEY_NEXT              121
 475 #define STORE_F_STORE_LIST_PRIVATE_KEY_START             122
 476 #define STORE_F_STORE_LIST_PUBLIC_KEY_END                123
 477 #define STORE_F_STORE_LIST_PUBLIC_KEY_ENDP               156
 478 #define STORE_F_STORE_LIST_PUBLIC_KEY_NEXT               124
 479 #define STORE_F_STORE_LIST_PUBLIC_KEY_START              125
 480 #define STORE_F_STORE_MODIFY_ARBITRARY                   162
 481 #define STORE_F_STORE_MODIFY_CERTIFICATE                 163
 482 #define STORE_F_STORE_MODIFY_CRL                         164
 483 #define STORE_F_STORE_MODIFY_NUMBER                      165
 484 #define STORE_F_STORE_MODIFY_PRIVATE_KEY                 166
 485 #define STORE_F_STORE_MODIFY_PUBLIC_KEY                  167
 486 #define STORE_F_STORE_NEW_ENGINE                         133
 487 #define STORE_F_STORE_NEW_METHOD                         132
 488 #define STORE_F_STORE_NUMBER                             126
 489 #define STORE_F_STORE_PARSE_ATTRS_END                    151
 490 #define STORE_F_STORE_PARSE_ATTRS_NEXT                   152
 491 #define STORE_F_STORE_PRIVATE_KEY                        127
 492 #define STORE_F_STORE_PUBLIC_KEY                         128
 493 #define STORE_F_STORE_REVOKE_CERTIFICATE                 129
 494 #define STORE_F_STORE_REVOKE_PRIVATE_KEY                 130
 495 #define STORE_F_STORE_REVOKE_PUBLIC_KEY                  131
 496
 497 /* Reason codes. */
 498 #define STORE_R_ALREADY_HAS_A_VALUE                      127
 499 #define STORE_R_FAILED_DELETING_ARBITRARY                132
 500 #define STORE_R_FAILED_DELETING_CERTIFICATE              100
 501 #define STORE_R_FAILED_DELETING_KEY                      101
 502 #define STORE_R_FAILED_DELETING_NUMBER                   102
 503 #define STORE_R_FAILED_GENERATING_CRL                    103
 504 #define STORE_R_FAILED_GENERATING_KEY                    104
 505 #define STORE_R_FAILED_GETTING_ARBITRARY                 133
 506 #define STORE_R_FAILED_GETTING_CERTIFICATE               105
 507 #define STORE_R_FAILED_GETTING_KEY                       106
 508 #define STORE_R_FAILED_GETTING_NUMBER                    107
 509 #define STORE_R_FAILED_LISTING_CERTIFICATES              108
 510 #define STORE_R_FAILED_LISTING_KEYS                      109
 511 #define STORE_R_FAILED_MODIFYING_ARBITRARY               138
 512 #define STORE_R_FAILED_MODIFYING_CERTIFICATE             139
 513 #define STORE_R_FAILED_MODIFYING_CRL                     140
 514 #define STORE_R_FAILED_MODIFYING_NUMBER                  141
 515 #define STORE_R_FAILED_MODIFYING_PRIVATE_KEY             142
 516 #define STORE_R_FAILED_MODIFYING_PUBLIC_KEY              143
 517 #define STORE_R_FAILED_REVOKING_CERTIFICATE              110
 518 #define STORE_R_FAILED_REVOKING_KEY                      111
 519 #define STORE_R_FAILED_STORING_ARBITRARY                 134
 520 #define STORE_R_FAILED_STORING_CERTIFICATE               112
 521 #define STORE_R_FAILED_STORING_KEY                       113
 522 #define STORE_R_FAILED_STORING_NUMBER                    114
 523 #define STORE_R_NOT_IMPLEMENTED                          128
 524 #define STORE_R_NO_CONTROL_FUNCTION                      144
 525 #define STORE_R_NO_DELETE_ARBITRARY_FUNCTION             135
 526 #define STORE_R_NO_DELETE_NUMBER_FUNCTION                115
 527 #define STORE_R_NO_DELETE_OBJECT_FUNCTION                116
 528 #define STORE_R_NO_GENERATE_CRL_FUNCTION                 117
 529 #define STORE_R_NO_GENERATE_OBJECT_FUNCTION              118
 530 #define STORE_R_NO_GET_OBJECT_ARBITRARY_FUNCTION         136
 531 #define STORE_R_NO_GET_OBJECT_FUNCTION                   119
 532 #define STORE_R_NO_GET_OBJECT_NUMBER_FUNCTION            120
 533 #define STORE_R_NO_LIST_OBJECT_ENDP_FUNCTION             131
 534 #define STORE_R_NO_LIST_OBJECT_END_FUNCTION              121
 535 #define STORE_R_NO_LIST_OBJECT_NEXT_FUNCTION             122
 536 #define STORE_R_NO_LIST_OBJECT_START_FUNCTION            123
 537 #define STORE_R_NO_MODIFY_OBJECT_FUNCTION                145
 538 #define STORE_R_NO_REVOKE_OBJECT_FUNCTION                124
 539 #define STORE_R_NO_STORE                                 129
 540 #define STORE_R_NO_STORE_OBJECT_ARBITRARY_FUNCTION       137
 541 #define STORE_R_NO_STORE_OBJECT_FUNCTION                 125
 542 #define STORE_R_NO_STORE_OBJECT_NUMBER_FUNCTION          126
 543 #define STORE_R_NO_VALUE                                 130
 544
 545 #ifdef  __cplusplus
 546 }
 547 #endif
 548 #endif