utvpn/utvpn-unix-v101-7101-public/src/Mayaqua/openssl/store.h

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