store.h revision 280304
117571Sdfuchs/* crypto/store/store.h -*- mode:C; c-file-style: "eay" -*- */ 217571Sdfuchs/* 317571Sdfuchs * Written by Richard Levitte (richard@levitte.org) for the OpenSSL project 417571Sdfuchs * 2003. 517571Sdfuchs */ 617571Sdfuchs/* ==================================================================== 717571Sdfuchs * Copyright (c) 2003 The OpenSSL Project. All rights reserved. 817571Sdfuchs * 917571Sdfuchs * Redistribution and use in source and binary forms, with or without 1017571Sdfuchs * modification, are permitted provided that the following conditions 1117571Sdfuchs * are met: 1217571Sdfuchs * 1317571Sdfuchs * 1. Redistributions of source code must retain the above copyright 1417571Sdfuchs * notice, this list of conditions and the following disclaimer. 1517571Sdfuchs * 1617571Sdfuchs * 2. Redistributions in binary form must reproduce the above copyright 1717571Sdfuchs * notice, this list of conditions and the following disclaimer in 1817571Sdfuchs * the documentation and/or other materials provided with the 1917571Sdfuchs * distribution. 2017571Sdfuchs * 2117571Sdfuchs * 3. All advertising materials mentioning features or use of this 2217571Sdfuchs * software must display the following acknowledgment: 2317571Sdfuchs * "This product includes software developed by the OpenSSL Project 2417571Sdfuchs * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 2517571Sdfuchs * 2617571Sdfuchs * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 2717571Sdfuchs * endorse or promote products derived from this software without 2817571Sdfuchs * prior written permission. For written permission, please contact 2917571Sdfuchs * openssl-core@openssl.org. 3017571Sdfuchs * 3117571Sdfuchs * 5. Products derived from this software may not be called "OpenSSL" 3217571Sdfuchs * nor may "OpenSSL" appear in their names without prior written 3317571Sdfuchs * permission of the OpenSSL Project. 3417571Sdfuchs * 3517571Sdfuchs * 6. Redistributions of any form whatsoever must retain the following 3617571Sdfuchs * acknowledgment: 3717571Sdfuchs * "This product includes software developed by the OpenSSL Project 3817571Sdfuchs * for use in the OpenSSL Toolkit (http://www.openssl.org/)" 3917571Sdfuchs * 4017571Sdfuchs * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 4117571Sdfuchs * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 4217571Sdfuchs * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 4317571Sdfuchs * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 4417571Sdfuchs * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 4517571Sdfuchs * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 4617571Sdfuchs * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 4717571Sdfuchs * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 4817571Sdfuchs * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 4917571Sdfuchs * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 5017571Sdfuchs * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 5117571Sdfuchs * OF THE POSSIBILITY OF SUCH DAMAGE. 5217571Sdfuchs * ==================================================================== 5317571Sdfuchs * 5417571Sdfuchs * This product includes cryptographic software written by Eric Young 5517571Sdfuchs * (eay@cryptsoft.com). This product includes software written by Tim 5617571Sdfuchs * Hudson (tjh@cryptsoft.com). 5717571Sdfuchs * 5817571Sdfuchs */ 5917571Sdfuchs 6017571Sdfuchs#ifndef HEADER_STORE_H 6117571Sdfuchs# define HEADER_STORE_H 6217571Sdfuchs 6317571Sdfuchs# include <openssl/opensslconf.h> 6417571Sdfuchs 6517571Sdfuchs# ifdef OPENSSL_NO_STORE 6617571Sdfuchs# error STORE is disabled. 6717571Sdfuchs# endif 6817571Sdfuchs 6917571Sdfuchs# include <openssl/ossl_typ.h> 7017571Sdfuchs# ifndef OPENSSL_NO_DEPRECATED 7117571Sdfuchs# include <openssl/evp.h> 7217571Sdfuchs# include <openssl/bn.h> 7317571Sdfuchs# include <openssl/x509.h> 7417571Sdfuchs# endif 7517571Sdfuchs 7617571Sdfuchs#ifdef __cplusplus 7717571Sdfuchsextern "C" { 7817571Sdfuchs#endif 7917571Sdfuchs 8017571Sdfuchs/* Already defined in ossl_typ.h */ 8117571Sdfuchs/* typedef struct store_st STORE; */ 8217571Sdfuchs/* typedef struct store_method_st STORE_METHOD; */ 8317571Sdfuchs 8417571Sdfuchs/* 8517571Sdfuchs * All the following functions return 0, a negative number or NULL on error. 8617571Sdfuchs * When everything is fine, they return a positive value or a non-NULL 8717571Sdfuchs * pointer, all depending on their purpose. 8817571Sdfuchs */ 8917571Sdfuchs 9017571Sdfuchs/* Creators and destructor. */ 9117571SdfuchsSTORE *STORE_new_method(const STORE_METHOD *method); 9217571SdfuchsSTORE *STORE_new_engine(ENGINE *engine); 9317571Sdfuchsvoid STORE_free(STORE *ui); 9417571Sdfuchs 9517571Sdfuchs/* 9617571Sdfuchs * Give a user interface parametrised control commands. This can be used to 9717571Sdfuchs * send down an integer, a data pointer or a function pointer, as well as be 9817571Sdfuchs * used to get information from a STORE. 9917571Sdfuchs */ 10017571Sdfuchsint STORE_ctrl(STORE *store, int cmd, long i, void *p, void (*f) (void)); 10117571Sdfuchs 10217571Sdfuchs/* 10317571Sdfuchs * A control to set the directory with keys and certificates. Used by the 10417571Sdfuchs * built-in directory level method. 10517571Sdfuchs */ 10617571Sdfuchs# define STORE_CTRL_SET_DIRECTORY 0x0001 10717571Sdfuchs/* 10817571Sdfuchs * A control to set a file to load. Used by the built-in file level method. 10917571Sdfuchs */ 11017571Sdfuchs# define STORE_CTRL_SET_FILE 0x0002 11117571Sdfuchs/* 11217571Sdfuchs * A control to set a configuration file to load. Can be used by any method 11317571Sdfuchs * that wishes to load a configuration file. 11417571Sdfuchs */ 11517571Sdfuchs# define STORE_CTRL_SET_CONF_FILE 0x0003 11617571Sdfuchs/* 11717571Sdfuchs * A control to set a the section of the loaded configuration file. Can be 11817571Sdfuchs * used by any method that wishes to load a configuration file. 11917571Sdfuchs */ 12017571Sdfuchs# define STORE_CTRL_SET_CONF_SECTION 0x0004 12117571Sdfuchs 12217571Sdfuchs/* Some methods may use extra data */ 12317571Sdfuchs# define STORE_set_app_data(s,arg) STORE_set_ex_data(s,0,arg) 12417571Sdfuchs# define STORE_get_app_data(s) STORE_get_ex_data(s,0) 12517571Sdfuchsint STORE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 12617571Sdfuchs CRYPTO_EX_dup *dup_func, 12717571Sdfuchs CRYPTO_EX_free *free_func); 12817571Sdfuchsint STORE_set_ex_data(STORE *r, int idx, void *arg); 12917571Sdfuchsvoid *STORE_get_ex_data(STORE *r, int idx); 13017571Sdfuchs 13117571Sdfuchs/* Use specific methods instead of the built-in one */ 13217571Sdfuchsconst STORE_METHOD *STORE_get_method(STORE *store); 13317571Sdfuchsconst STORE_METHOD *STORE_set_method(STORE *store, const STORE_METHOD *meth); 13417571Sdfuchs 13517571Sdfuchs/* The standard OpenSSL methods. */ 13617571Sdfuchs/* 13717571Sdfuchs * This is the in-memory method. It does everything except revoking and 13817571Sdfuchs * updating, and is of course volatile. It's used by other methods that have 13917571Sdfuchs * an in-memory cache. 14017571Sdfuchs */ 14117571Sdfuchsconst STORE_METHOD *STORE_Memory(void); 14217571Sdfuchs# if 0 /* Not yet implemented */ 14317571Sdfuchs/* 14417571Sdfuchs * This is the directory store. It does everything except revoking and 14517571Sdfuchs * updating, and uses STORE_Memory() to cache things in memory. 14617571Sdfuchs */ 14717571Sdfuchsconst STORE_METHOD *STORE_Directory(void); 14817571Sdfuchs/* 14917571Sdfuchs * This is the file store. It does everything except revoking and updating, 15017571Sdfuchs * and uses STORE_Memory() to cache things in memory. Certificates are added 15117571Sdfuchs * to it with the store operation, and it will only get cached certificates. 15217571Sdfuchs */ 15317571Sdfuchsconst STORE_METHOD *STORE_File(void); 15417571Sdfuchs# endif 15517571Sdfuchs 15617571Sdfuchs/* 15717571Sdfuchs * Store functions take a type code for the type of data they should store or 15817571Sdfuchs * fetch 15917571Sdfuchs */ 16017571Sdfuchstypedef enum STORE_object_types { 16117571Sdfuchs STORE_OBJECT_TYPE_X509_CERTIFICATE = 0x01, /* X509 * */ 16217571Sdfuchs STORE_OBJECT_TYPE_X509_CRL = 0x02, /* X509_CRL * */ 16317571Sdfuchs STORE_OBJECT_TYPE_PRIVATE_KEY = 0x03, /* EVP_PKEY * */ 16417571Sdfuchs STORE_OBJECT_TYPE_PUBLIC_KEY = 0x04, /* EVP_PKEY * */ 16517571Sdfuchs STORE_OBJECT_TYPE_NUMBER = 0x05, /* BIGNUM * */ 16617571Sdfuchs STORE_OBJECT_TYPE_ARBITRARY = 0x06, /* BUF_MEM * */ 16717571Sdfuchs STORE_OBJECT_TYPE_NUM = 0x06 /* The amount of known object types */ 16817571Sdfuchs} STORE_OBJECT_TYPES; 16917571Sdfuchs/* List of text strings corresponding to the object types. */ 17017571Sdfuchsextern const char *const STORE_object_type_string[STORE_OBJECT_TYPE_NUM + 1]; 17117571Sdfuchs 17217571Sdfuchs/* 17317571Sdfuchs * Some store functions take a parameter list. Those parameters come with 17417571Sdfuchs * one of the following codes. The comments following the codes below 17517571Sdfuchs * indicate what type the value should be a pointer to. 17617571Sdfuchs */ 17717571Sdfuchstypedef enum STORE_params { 17817571Sdfuchs STORE_PARAM_EVP_TYPE = 0x01, /* int */ 17917571Sdfuchs STORE_PARAM_BITS = 0x02, /* size_t */ 18017571Sdfuchs STORE_PARAM_KEY_PARAMETERS = 0x03, /* ??? */ 18117571Sdfuchs STORE_PARAM_KEY_NO_PARAMETERS = 0x04, /* N/A */ 18217571Sdfuchs STORE_PARAM_AUTH_PASSPHRASE = 0x05, /* char * */ 18317571Sdfuchs STORE_PARAM_AUTH_KRB5_TICKET = 0x06, /* void * */ 18417571Sdfuchs STORE_PARAM_TYPE_NUM = 0x06 /* The amount of known parameter types */ 18517571Sdfuchs} STORE_PARAM_TYPES; 18617571Sdfuchs/* 18717571Sdfuchs * Parameter value sizes. -1 means unknown, anything else is the required 18817571Sdfuchs * size. 18917571Sdfuchs */ 19017571Sdfuchsextern const int STORE_param_sizes[STORE_PARAM_TYPE_NUM + 1]; 19117571Sdfuchs 19217571Sdfuchs/* 19317571Sdfuchs * Store functions take attribute lists. Those attributes come with codes. 19417571Sdfuchs * The comments following the codes below indicate what type the value should 19517571Sdfuchs * be a pointer to. 19617571Sdfuchs */ 19717571Sdfuchstypedef enum STORE_attribs { 19817571Sdfuchs STORE_ATTR_END = 0x00, 19917571Sdfuchs STORE_ATTR_FRIENDLYNAME = 0x01, /* C string */ 20017571Sdfuchs STORE_ATTR_KEYID = 0x02, /* 160 bit string (SHA1) */ 20117571Sdfuchs STORE_ATTR_ISSUERKEYID = 0x03, /* 160 bit string (SHA1) */ 20217571Sdfuchs STORE_ATTR_SUBJECTKEYID = 0x04, /* 160 bit string (SHA1) */ 20317571Sdfuchs STORE_ATTR_ISSUERSERIALHASH = 0x05, /* 160 bit string (SHA1) */ 20417571Sdfuchs STORE_ATTR_ISSUER = 0x06, /* X509_NAME * */ 20517571Sdfuchs STORE_ATTR_SERIAL = 0x07, /* BIGNUM * */ 20617571Sdfuchs STORE_ATTR_SUBJECT = 0x08, /* X509_NAME * */ 20717571Sdfuchs STORE_ATTR_CERTHASH = 0x09, /* 160 bit string (SHA1) */ 20817571Sdfuchs STORE_ATTR_EMAIL = 0x0a, /* C string */ 20917571Sdfuchs STORE_ATTR_FILENAME = 0x0b, /* C string */ 21017571Sdfuchs STORE_ATTR_TYPE_NUM = 0x0b, /* The amount of known attribute types */ 21117571Sdfuchs STORE_ATTR_OR = 0xff /* This is a special separator, which 21217571Sdfuchs * expresses the OR operation. */ 21317571Sdfuchs} STORE_ATTR_TYPES; 21417571Sdfuchs/* 21517571Sdfuchs * Attribute value sizes. -1 means unknown, anything else is the required 21617571Sdfuchs * size. 21717571Sdfuchs */ 21817571Sdfuchsextern const int STORE_attr_sizes[STORE_ATTR_TYPE_NUM + 1]; 21917571Sdfuchs 22017571Sdfuchstypedef enum STORE_certificate_status { 22117571Sdfuchs STORE_X509_VALID = 0x00, 22217571Sdfuchs STORE_X509_EXPIRED = 0x01, 22317571Sdfuchs STORE_X509_SUSPENDED = 0x02, 22417571Sdfuchs STORE_X509_REVOKED = 0x03 22517571Sdfuchs} STORE_CERTIFICATE_STATUS; 22617571Sdfuchs 22717571Sdfuchs/* 22817571Sdfuchs * Engine store functions will return a structure that contains all the 22917571Sdfuchs * necessary information, including revokation status for certificates. This 23017571Sdfuchs * is really not needed for application authors, as the ENGINE framework 23117571Sdfuchs * functions will extract the OpenSSL-specific information when at all 23217571Sdfuchs * possible. However, for engine authors, it's crucial to know this 23317571Sdfuchs * structure. 23417571Sdfuchs */ 23517571Sdfuchstypedef struct STORE_OBJECT_st { 23617571Sdfuchs STORE_OBJECT_TYPES type; 23717571Sdfuchs union { 23817571Sdfuchs struct { 23917571Sdfuchs STORE_CERTIFICATE_STATUS status; 24017571Sdfuchs X509 *certificate; 24117571Sdfuchs } x509; 24217571Sdfuchs X509_CRL *crl; 24317571Sdfuchs EVP_PKEY *key; 24417571Sdfuchs BIGNUM *number; 24517571Sdfuchs BUF_MEM *arbitrary; 24617571Sdfuchs } data; 24717571Sdfuchs} STORE_OBJECT; 24817571SdfuchsDECLARE_STACK_OF(STORE_OBJECT) 24917571SdfuchsSTORE_OBJECT *STORE_OBJECT_new(void); 25017571Sdfuchsvoid STORE_OBJECT_free(STORE_OBJECT *data); 25117571Sdfuchs 25217571Sdfuchs/* 25317571Sdfuchs * The following functions handle the storage. They return 0, a negative 25417571Sdfuchs * number or NULL on error, anything else on success. 25517571Sdfuchs */ 25617571SdfuchsX509 *STORE_get_certificate(STORE *e, OPENSSL_ITEM attributes[], 25717571Sdfuchs OPENSSL_ITEM parameters[]); 25817571Sdfuchsint STORE_store_certificate(STORE *e, X509 *data, OPENSSL_ITEM attributes[], 25917571Sdfuchs OPENSSL_ITEM parameters[]); 26017571Sdfuchsint STORE_modify_certificate(STORE *e, OPENSSL_ITEM search_attributes[], 26117571Sdfuchs OPENSSL_ITEM add_attributes[], 26217571Sdfuchs OPENSSL_ITEM modify_attributes[], 26317571Sdfuchs OPENSSL_ITEM delete_attributes[], 26417571Sdfuchs OPENSSL_ITEM parameters[]); 26517571Sdfuchsint STORE_revoke_certificate(STORE *e, OPENSSL_ITEM attributes[], 26617571Sdfuchs OPENSSL_ITEM parameters[]); 26717571Sdfuchsint STORE_delete_certificate(STORE *e, OPENSSL_ITEM attributes[], 26817571Sdfuchs OPENSSL_ITEM parameters[]); 26917571Sdfuchsvoid *STORE_list_certificate_start(STORE *e, OPENSSL_ITEM attributes[], 27017571Sdfuchs OPENSSL_ITEM parameters[]); 27117571SdfuchsX509 *STORE_list_certificate_next(STORE *e, void *handle); 27217571Sdfuchsint STORE_list_certificate_end(STORE *e, void *handle); 27317571Sdfuchsint STORE_list_certificate_endp(STORE *e, void *handle); 27417571SdfuchsEVP_PKEY *STORE_generate_key(STORE *e, OPENSSL_ITEM attributes[], 27517571Sdfuchs OPENSSL_ITEM parameters[]); 27617571SdfuchsEVP_PKEY *STORE_get_private_key(STORE *e, OPENSSL_ITEM attributes[], 27717571Sdfuchs OPENSSL_ITEM parameters[]); 27817571Sdfuchsint STORE_store_private_key(STORE *e, EVP_PKEY *data, 27917571Sdfuchs OPENSSL_ITEM attributes[], 28017571Sdfuchs OPENSSL_ITEM parameters[]); 28117571Sdfuchsint STORE_modify_private_key(STORE *e, OPENSSL_ITEM search_attributes[], 28217571Sdfuchs OPENSSL_ITEM add_sttributes[], 28317571Sdfuchs OPENSSL_ITEM modify_attributes[], 28417571Sdfuchs OPENSSL_ITEM delete_attributes[], 28517571Sdfuchs OPENSSL_ITEM parameters[]); 28617571Sdfuchsint STORE_revoke_private_key(STORE *e, OPENSSL_ITEM attributes[], 28717571Sdfuchs OPENSSL_ITEM parameters[]); 28817571Sdfuchsint STORE_delete_private_key(STORE *e, OPENSSL_ITEM attributes[], 28917571Sdfuchs OPENSSL_ITEM parameters[]); 29017571Sdfuchsvoid *STORE_list_private_key_start(STORE *e, OPENSSL_ITEM attributes[], 29117571Sdfuchs OPENSSL_ITEM parameters[]); 29217571SdfuchsEVP_PKEY *STORE_list_private_key_next(STORE *e, void *handle); 29317571Sdfuchsint STORE_list_private_key_end(STORE *e, void *handle); 29417571Sdfuchsint STORE_list_private_key_endp(STORE *e, void *handle); 29517571SdfuchsEVP_PKEY *STORE_get_public_key(STORE *e, OPENSSL_ITEM attributes[], 29617571Sdfuchs OPENSSL_ITEM parameters[]); 29717571Sdfuchsint STORE_store_public_key(STORE *e, EVP_PKEY *data, 29817571Sdfuchs OPENSSL_ITEM attributes[], 29917571Sdfuchs OPENSSL_ITEM parameters[]); 30017571Sdfuchsint STORE_modify_public_key(STORE *e, OPENSSL_ITEM search_attributes[], 30117571Sdfuchs OPENSSL_ITEM add_sttributes[], 30217571Sdfuchs OPENSSL_ITEM modify_attributes[], 30317571Sdfuchs OPENSSL_ITEM delete_attributes[], 30417571Sdfuchs OPENSSL_ITEM parameters[]); 30517571Sdfuchsint STORE_revoke_public_key(STORE *e, OPENSSL_ITEM attributes[], 30617571Sdfuchs OPENSSL_ITEM parameters[]); 30717571Sdfuchsint STORE_delete_public_key(STORE *e, OPENSSL_ITEM attributes[], 30817571Sdfuchs OPENSSL_ITEM parameters[]); 30917571Sdfuchsvoid *STORE_list_public_key_start(STORE *e, OPENSSL_ITEM attributes[], 31017571Sdfuchs OPENSSL_ITEM parameters[]); 31117571SdfuchsEVP_PKEY *STORE_list_public_key_next(STORE *e, void *handle); 31217571Sdfuchsint STORE_list_public_key_end(STORE *e, void *handle); 31317571Sdfuchsint STORE_list_public_key_endp(STORE *e, void *handle); 31417571SdfuchsX509_CRL *STORE_generate_crl(STORE *e, OPENSSL_ITEM attributes[], 31517571Sdfuchs OPENSSL_ITEM parameters[]); 31617571SdfuchsX509_CRL *STORE_get_crl(STORE *e, OPENSSL_ITEM attributes[], 31717571Sdfuchs OPENSSL_ITEM parameters[]); 31817571Sdfuchsint STORE_store_crl(STORE *e, X509_CRL *data, OPENSSL_ITEM attributes[], 31917571Sdfuchs OPENSSL_ITEM parameters[]); 32017571Sdfuchsint STORE_modify_crl(STORE *e, OPENSSL_ITEM search_attributes[], 32117571Sdfuchs OPENSSL_ITEM add_sttributes[], 32217571Sdfuchs OPENSSL_ITEM modify_attributes[], 32317571Sdfuchs OPENSSL_ITEM delete_attributes[], 324 OPENSSL_ITEM parameters[]); 325int STORE_delete_crl(STORE *e, OPENSSL_ITEM attributes[], 326 OPENSSL_ITEM parameters[]); 327void *STORE_list_crl_start(STORE *e, OPENSSL_ITEM attributes[], 328 OPENSSL_ITEM parameters[]); 329X509_CRL *STORE_list_crl_next(STORE *e, void *handle); 330int STORE_list_crl_end(STORE *e, void *handle); 331int STORE_list_crl_endp(STORE *e, void *handle); 332int STORE_store_number(STORE *e, BIGNUM *data, OPENSSL_ITEM attributes[], 333 OPENSSL_ITEM parameters[]); 334int STORE_modify_number(STORE *e, OPENSSL_ITEM search_attributes[], 335 OPENSSL_ITEM add_sttributes[], 336 OPENSSL_ITEM modify_attributes[], 337 OPENSSL_ITEM delete_attributes[], 338 OPENSSL_ITEM parameters[]); 339BIGNUM *STORE_get_number(STORE *e, OPENSSL_ITEM attributes[], 340 OPENSSL_ITEM parameters[]); 341int STORE_delete_number(STORE *e, OPENSSL_ITEM attributes[], 342 OPENSSL_ITEM parameters[]); 343int STORE_store_arbitrary(STORE *e, BUF_MEM *data, OPENSSL_ITEM attributes[], 344 OPENSSL_ITEM parameters[]); 345int STORE_modify_arbitrary(STORE *e, OPENSSL_ITEM search_attributes[], 346 OPENSSL_ITEM add_sttributes[], 347 OPENSSL_ITEM modify_attributes[], 348 OPENSSL_ITEM delete_attributes[], 349 OPENSSL_ITEM parameters[]); 350BUF_MEM *STORE_get_arbitrary(STORE *e, OPENSSL_ITEM attributes[], 351 OPENSSL_ITEM parameters[]); 352int STORE_delete_arbitrary(STORE *e, OPENSSL_ITEM attributes[], 353 OPENSSL_ITEM parameters[]); 354 355/* Create and manipulate methods */ 356STORE_METHOD *STORE_create_method(char *name); 357void STORE_destroy_method(STORE_METHOD *store_method); 358 359/* These callback types are use for store handlers */ 360typedef int (*STORE_INITIALISE_FUNC_PTR) (STORE *); 361typedef void (*STORE_CLEANUP_FUNC_PTR) (STORE *); 362typedef STORE_OBJECT *(*STORE_GENERATE_OBJECT_FUNC_PTR)(STORE *, 363 STORE_OBJECT_TYPES 364 type, 365 OPENSSL_ITEM 366 attributes[], 367 OPENSSL_ITEM 368 parameters[]); 369typedef STORE_OBJECT *(*STORE_GET_OBJECT_FUNC_PTR)(STORE *, 370 STORE_OBJECT_TYPES type, 371 OPENSSL_ITEM attributes[], 372 OPENSSL_ITEM parameters[]); 373typedef void *(*STORE_START_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, 374 OPENSSL_ITEM attributes[], 375 OPENSSL_ITEM parameters[]); 376typedef STORE_OBJECT *(*STORE_NEXT_OBJECT_FUNC_PTR)(STORE *, void *handle); 377typedef int (*STORE_END_OBJECT_FUNC_PTR) (STORE *, void *handle); 378typedef int (*STORE_HANDLE_OBJECT_FUNC_PTR) (STORE *, STORE_OBJECT_TYPES type, 379 OPENSSL_ITEM attributes[], 380 OPENSSL_ITEM parameters[]); 381typedef int (*STORE_STORE_OBJECT_FUNC_PTR) (STORE *, STORE_OBJECT_TYPES type, 382 STORE_OBJECT *data, 383 OPENSSL_ITEM attributes[], 384 OPENSSL_ITEM parameters[]); 385typedef int (*STORE_MODIFY_OBJECT_FUNC_PTR) (STORE *, STORE_OBJECT_TYPES type, 386 OPENSSL_ITEM search_attributes[], 387 OPENSSL_ITEM add_attributes[], 388 OPENSSL_ITEM modify_attributes[], 389 OPENSSL_ITEM delete_attributes[], 390 OPENSSL_ITEM parameters[]); 391typedef int (*STORE_GENERIC_FUNC_PTR) (STORE *, OPENSSL_ITEM attributes[], 392 OPENSSL_ITEM parameters[]); 393typedef int (*STORE_CTRL_FUNC_PTR) (STORE *, int cmd, long l, void *p, 394 void (*f) (void)); 395 396int STORE_method_set_initialise_function(STORE_METHOD *sm, 397 STORE_INITIALISE_FUNC_PTR init_f); 398int STORE_method_set_cleanup_function(STORE_METHOD *sm, 399 STORE_CLEANUP_FUNC_PTR clean_f); 400int STORE_method_set_generate_function(STORE_METHOD *sm, 401 STORE_GENERATE_OBJECT_FUNC_PTR 402 generate_f); 403int STORE_method_set_get_function(STORE_METHOD *sm, 404 STORE_GET_OBJECT_FUNC_PTR get_f); 405int STORE_method_set_store_function(STORE_METHOD *sm, 406 STORE_STORE_OBJECT_FUNC_PTR store_f); 407int STORE_method_set_modify_function(STORE_METHOD *sm, 408 STORE_MODIFY_OBJECT_FUNC_PTR store_f); 409int STORE_method_set_revoke_function(STORE_METHOD *sm, 410 STORE_HANDLE_OBJECT_FUNC_PTR revoke_f); 411int STORE_method_set_delete_function(STORE_METHOD *sm, 412 STORE_HANDLE_OBJECT_FUNC_PTR delete_f); 413int STORE_method_set_list_start_function(STORE_METHOD *sm, 414 STORE_START_OBJECT_FUNC_PTR 415 list_start_f); 416int STORE_method_set_list_next_function(STORE_METHOD *sm, 417 STORE_NEXT_OBJECT_FUNC_PTR 418 list_next_f); 419int STORE_method_set_list_end_function(STORE_METHOD *sm, 420 STORE_END_OBJECT_FUNC_PTR list_end_f); 421int STORE_method_set_update_store_function(STORE_METHOD *sm, 422 STORE_GENERIC_FUNC_PTR); 423int STORE_method_set_lock_store_function(STORE_METHOD *sm, 424 STORE_GENERIC_FUNC_PTR); 425int STORE_method_set_unlock_store_function(STORE_METHOD *sm, 426 STORE_GENERIC_FUNC_PTR); 427int STORE_method_set_ctrl_function(STORE_METHOD *sm, 428 STORE_CTRL_FUNC_PTR ctrl_f); 429 430STORE_INITIALISE_FUNC_PTR STORE_method_get_initialise_function(STORE_METHOD 431 *sm); 432STORE_CLEANUP_FUNC_PTR STORE_method_get_cleanup_function(STORE_METHOD *sm); 433STORE_GENERATE_OBJECT_FUNC_PTR STORE_method_get_generate_function(STORE_METHOD 434 *sm); 435STORE_GET_OBJECT_FUNC_PTR STORE_method_get_get_function(STORE_METHOD *sm); 436STORE_STORE_OBJECT_FUNC_PTR STORE_method_get_store_function(STORE_METHOD *sm); 437STORE_MODIFY_OBJECT_FUNC_PTR STORE_method_get_modify_function(STORE_METHOD 438 *sm); 439STORE_HANDLE_OBJECT_FUNC_PTR STORE_method_get_revoke_function(STORE_METHOD 440 *sm); 441STORE_HANDLE_OBJECT_FUNC_PTR STORE_method_get_delete_function(STORE_METHOD 442 *sm); 443STORE_START_OBJECT_FUNC_PTR STORE_method_get_list_start_function(STORE_METHOD 444 *sm); 445STORE_NEXT_OBJECT_FUNC_PTR STORE_method_get_list_next_function(STORE_METHOD 446 *sm); 447STORE_END_OBJECT_FUNC_PTR STORE_method_get_list_end_function(STORE_METHOD 448 *sm); 449STORE_GENERIC_FUNC_PTR STORE_method_get_update_store_function(STORE_METHOD 450 *sm); 451STORE_GENERIC_FUNC_PTR STORE_method_get_lock_store_function(STORE_METHOD *sm); 452STORE_GENERIC_FUNC_PTR STORE_method_get_unlock_store_function(STORE_METHOD 453 *sm); 454STORE_CTRL_FUNC_PTR STORE_method_get_ctrl_function(STORE_METHOD *sm); 455 456/* Method helper structures and functions. */ 457 458/* 459 * This structure is the result of parsing through the information in a list 460 * of OPENSSL_ITEMs. It stores all the necessary information in a structured 461 * way. 462 */ 463typedef struct STORE_attr_info_st STORE_ATTR_INFO; 464 465/* 466 * Parse a list of OPENSSL_ITEMs and return a pointer to a STORE_ATTR_INFO. 467 * Note that we do this in the list form, since the list of OPENSSL_ITEMs can 468 * come in blocks separated with STORE_ATTR_OR. Note that the value returned 469 * by STORE_parse_attrs_next() must be freed with STORE_ATTR_INFO_free(). 470 */ 471void *STORE_parse_attrs_start(OPENSSL_ITEM *attributes); 472STORE_ATTR_INFO *STORE_parse_attrs_next(void *handle); 473int STORE_parse_attrs_end(void *handle); 474int STORE_parse_attrs_endp(void *handle); 475 476/* Creator and destructor */ 477STORE_ATTR_INFO *STORE_ATTR_INFO_new(void); 478int STORE_ATTR_INFO_free(STORE_ATTR_INFO *attrs); 479 480/* Manipulators */ 481char *STORE_ATTR_INFO_get0_cstr(STORE_ATTR_INFO *attrs, 482 STORE_ATTR_TYPES code); 483unsigned char *STORE_ATTR_INFO_get0_sha1str(STORE_ATTR_INFO *attrs, 484 STORE_ATTR_TYPES code); 485X509_NAME *STORE_ATTR_INFO_get0_dn(STORE_ATTR_INFO *attrs, 486 STORE_ATTR_TYPES code); 487BIGNUM *STORE_ATTR_INFO_get0_number(STORE_ATTR_INFO *attrs, 488 STORE_ATTR_TYPES code); 489int STORE_ATTR_INFO_set_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code, 490 char *cstr, size_t cstr_size); 491int STORE_ATTR_INFO_set_sha1str(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code, 492 unsigned char *sha1str, size_t sha1str_size); 493int STORE_ATTR_INFO_set_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code, 494 X509_NAME *dn); 495int STORE_ATTR_INFO_set_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code, 496 BIGNUM *number); 497int STORE_ATTR_INFO_modify_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code, 498 char *cstr, size_t cstr_size); 499int STORE_ATTR_INFO_modify_sha1str(STORE_ATTR_INFO *attrs, 500 STORE_ATTR_TYPES code, 501 unsigned char *sha1str, 502 size_t sha1str_size); 503int STORE_ATTR_INFO_modify_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code, 504 X509_NAME *dn); 505int STORE_ATTR_INFO_modify_number(STORE_ATTR_INFO *attrs, 506 STORE_ATTR_TYPES code, BIGNUM *number); 507 508/* 509 * Compare on basis of a bit pattern formed by the STORE_ATTR_TYPES values in 510 * each contained attribute. 511 */ 512int STORE_ATTR_INFO_compare(const STORE_ATTR_INFO *const *a, 513 const STORE_ATTR_INFO *const *b); 514/* 515 * Check if the set of attributes in a is within the range of attributes set 516 * in b. 517 */ 518int STORE_ATTR_INFO_in_range(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b); 519/* Check if the set of attributes in a are also set in b. */ 520int STORE_ATTR_INFO_in(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b); 521/* Same as STORE_ATTR_INFO_in(), but also checks the attribute values. */ 522int STORE_ATTR_INFO_in_ex(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b); 523 524/* BEGIN ERROR CODES */ 525/* 526 * The following lines are auto generated by the script mkerr.pl. Any changes 527 * made after this point may be overwritten when the script is next run. 528 */ 529void ERR_load_STORE_strings(void); 530 531/* Error codes for the STORE functions. */ 532 533/* Function codes. */ 534# define STORE_F_MEM_DELETE 134 535# define STORE_F_MEM_GENERATE 135 536# define STORE_F_MEM_LIST_END 168 537# define STORE_F_MEM_LIST_NEXT 136 538# define STORE_F_MEM_LIST_START 137 539# define STORE_F_MEM_MODIFY 169 540# define STORE_F_MEM_STORE 138 541# define STORE_F_STORE_ATTR_INFO_GET0_CSTR 139 542# define STORE_F_STORE_ATTR_INFO_GET0_DN 140 543# define STORE_F_STORE_ATTR_INFO_GET0_NUMBER 141 544# define STORE_F_STORE_ATTR_INFO_GET0_SHA1STR 142 545# define STORE_F_STORE_ATTR_INFO_MODIFY_CSTR 143 546# define STORE_F_STORE_ATTR_INFO_MODIFY_DN 144 547# define STORE_F_STORE_ATTR_INFO_MODIFY_NUMBER 145 548# define STORE_F_STORE_ATTR_INFO_MODIFY_SHA1STR 146 549# define STORE_F_STORE_ATTR_INFO_SET_CSTR 147 550# define STORE_F_STORE_ATTR_INFO_SET_DN 148 551# define STORE_F_STORE_ATTR_INFO_SET_NUMBER 149 552# define STORE_F_STORE_ATTR_INFO_SET_SHA1STR 150 553# define STORE_F_STORE_CERTIFICATE 170 554# define STORE_F_STORE_CTRL 161 555# define STORE_F_STORE_DELETE_ARBITRARY 158 556# define STORE_F_STORE_DELETE_CERTIFICATE 102 557# define STORE_F_STORE_DELETE_CRL 103 558# define STORE_F_STORE_DELETE_NUMBER 104 559# define STORE_F_STORE_DELETE_PRIVATE_KEY 105 560# define STORE_F_STORE_DELETE_PUBLIC_KEY 106 561# define STORE_F_STORE_GENERATE_CRL 107 562# define STORE_F_STORE_GENERATE_KEY 108 563# define STORE_F_STORE_GET_ARBITRARY 159 564# define STORE_F_STORE_GET_CERTIFICATE 109 565# define STORE_F_STORE_GET_CRL 110 566# define STORE_F_STORE_GET_NUMBER 111 567# define STORE_F_STORE_GET_PRIVATE_KEY 112 568# define STORE_F_STORE_GET_PUBLIC_KEY 113 569# define STORE_F_STORE_LIST_CERTIFICATE_END 114 570# define STORE_F_STORE_LIST_CERTIFICATE_ENDP 153 571# define STORE_F_STORE_LIST_CERTIFICATE_NEXT 115 572# define STORE_F_STORE_LIST_CERTIFICATE_START 116 573# define STORE_F_STORE_LIST_CRL_END 117 574# define STORE_F_STORE_LIST_CRL_ENDP 154 575# define STORE_F_STORE_LIST_CRL_NEXT 118 576# define STORE_F_STORE_LIST_CRL_START 119 577# define STORE_F_STORE_LIST_PRIVATE_KEY_END 120 578# define STORE_F_STORE_LIST_PRIVATE_KEY_ENDP 155 579# define STORE_F_STORE_LIST_PRIVATE_KEY_NEXT 121 580# define STORE_F_STORE_LIST_PRIVATE_KEY_START 122 581# define STORE_F_STORE_LIST_PUBLIC_KEY_END 123 582# define STORE_F_STORE_LIST_PUBLIC_KEY_ENDP 156 583# define STORE_F_STORE_LIST_PUBLIC_KEY_NEXT 124 584# define STORE_F_STORE_LIST_PUBLIC_KEY_START 125 585# define STORE_F_STORE_MODIFY_ARBITRARY 162 586# define STORE_F_STORE_MODIFY_CERTIFICATE 163 587# define STORE_F_STORE_MODIFY_CRL 164 588# define STORE_F_STORE_MODIFY_NUMBER 165 589# define STORE_F_STORE_MODIFY_PRIVATE_KEY 166 590# define STORE_F_STORE_MODIFY_PUBLIC_KEY 167 591# define STORE_F_STORE_NEW_ENGINE 133 592# define STORE_F_STORE_NEW_METHOD 132 593# define STORE_F_STORE_PARSE_ATTRS_END 151 594# define STORE_F_STORE_PARSE_ATTRS_ENDP 172 595# define STORE_F_STORE_PARSE_ATTRS_NEXT 152 596# define STORE_F_STORE_PARSE_ATTRS_START 171 597# define STORE_F_STORE_REVOKE_CERTIFICATE 129 598# define STORE_F_STORE_REVOKE_PRIVATE_KEY 130 599# define STORE_F_STORE_REVOKE_PUBLIC_KEY 131 600# define STORE_F_STORE_STORE_ARBITRARY 157 601# define STORE_F_STORE_STORE_CERTIFICATE 100 602# define STORE_F_STORE_STORE_CRL 101 603# define STORE_F_STORE_STORE_NUMBER 126 604# define STORE_F_STORE_STORE_PRIVATE_KEY 127 605# define STORE_F_STORE_STORE_PUBLIC_KEY 128 606 607/* Reason codes. */ 608# define STORE_R_ALREADY_HAS_A_VALUE 127 609# define STORE_R_FAILED_DELETING_ARBITRARY 132 610# define STORE_R_FAILED_DELETING_CERTIFICATE 100 611# define STORE_R_FAILED_DELETING_KEY 101 612# define STORE_R_FAILED_DELETING_NUMBER 102 613# define STORE_R_FAILED_GENERATING_CRL 103 614# define STORE_R_FAILED_GENERATING_KEY 104 615# define STORE_R_FAILED_GETTING_ARBITRARY 133 616# define STORE_R_FAILED_GETTING_CERTIFICATE 105 617# define STORE_R_FAILED_GETTING_KEY 106 618# define STORE_R_FAILED_GETTING_NUMBER 107 619# define STORE_R_FAILED_LISTING_CERTIFICATES 108 620# define STORE_R_FAILED_LISTING_KEYS 109 621# define STORE_R_FAILED_MODIFYING_ARBITRARY 138 622# define STORE_R_FAILED_MODIFYING_CERTIFICATE 139 623# define STORE_R_FAILED_MODIFYING_CRL 140 624# define STORE_R_FAILED_MODIFYING_NUMBER 141 625# define STORE_R_FAILED_MODIFYING_PRIVATE_KEY 142 626# define STORE_R_FAILED_MODIFYING_PUBLIC_KEY 143 627# define STORE_R_FAILED_REVOKING_CERTIFICATE 110 628# define STORE_R_FAILED_REVOKING_KEY 111 629# define STORE_R_FAILED_STORING_ARBITRARY 134 630# define STORE_R_FAILED_STORING_CERTIFICATE 112 631# define STORE_R_FAILED_STORING_KEY 113 632# define STORE_R_FAILED_STORING_NUMBER 114 633# define STORE_R_NOT_IMPLEMENTED 128 634# define STORE_R_NO_CONTROL_FUNCTION 144 635# define STORE_R_NO_DELETE_ARBITRARY_FUNCTION 135 636# define STORE_R_NO_DELETE_NUMBER_FUNCTION 115 637# define STORE_R_NO_DELETE_OBJECT_FUNCTION 116 638# define STORE_R_NO_GENERATE_CRL_FUNCTION 117 639# define STORE_R_NO_GENERATE_OBJECT_FUNCTION 118 640# define STORE_R_NO_GET_OBJECT_ARBITRARY_FUNCTION 136 641# define STORE_R_NO_GET_OBJECT_FUNCTION 119 642# define STORE_R_NO_GET_OBJECT_NUMBER_FUNCTION 120 643# define STORE_R_NO_LIST_OBJECT_ENDP_FUNCTION 131 644# define STORE_R_NO_LIST_OBJECT_END_FUNCTION 121 645# define STORE_R_NO_LIST_OBJECT_NEXT_FUNCTION 122 646# define STORE_R_NO_LIST_OBJECT_START_FUNCTION 123 647# define STORE_R_NO_MODIFY_OBJECT_FUNCTION 145 648# define STORE_R_NO_REVOKE_OBJECT_FUNCTION 124 649# define STORE_R_NO_STORE 129 650# define STORE_R_NO_STORE_OBJECT_ARBITRARY_FUNCTION 137 651# define STORE_R_NO_STORE_OBJECT_FUNCTION 125 652# define STORE_R_NO_STORE_OBJECT_NUMBER_FUNCTION 126 653# define STORE_R_NO_VALUE 130 654 655#ifdef __cplusplus 656} 657#endif 658#endif 659