store.h 26 KB

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