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