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