store.h
上传用户:yisoukefu
上传日期:2020-08-09
资源大小:39506k
文件大小:26k
源码类别:

其他游戏

开发平台:

Visual C++

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