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