c1cbb399f9db999f708bba320c4a51a751f1e95f
[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 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 <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 STORE *STORE_new_engine(ENGINE *engine);
88 void STORE_free(STORE *ui);
89
90
91 /* Give a user interface parametrised control commands.  This can be used to
92    send down an integer, a data pointer or a function pointer, as well as
93    be used to get information from a STORE. */
94 int STORE_ctrl(STORE *store, int cmd, long i, void *p, void (*f)());
95
96 /* A control to set the directory with keys and certificates.  Used by the
97    built-in directory level method. */
98 #define STORE_CTRL_SET_DIRECTORY        0x0001
99 /* A control to set a file to load.  Used by the built-in file level method. */
100 #define STORE_CTRL_SET_FILE             0x0002
101 /* A control to set a configuration file to load.  Can be used by any method
102    that wishes to load a configuration file. */
103 #define STORE_CTRL_SET_CONF_FILE        0x0003
104 /* A control to set a the section of the loaded configuration file.  Can be
105    used by any method that wishes to load a configuration file. */
106 #define STORE_CTRL_SET_CONF_SECTION     0x0004
107
108
109 /* Some methods may use extra data */
110 #define STORE_set_app_data(s,arg)       STORE_set_ex_data(s,0,arg)
111 #define STORE_get_app_data(s)           STORE_get_ex_data(s,0)
112 int STORE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
113         CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
114 int STORE_set_ex_data(STORE *r,int idx,void *arg);
115 void *STORE_get_ex_data(STORE *r, int idx);
116
117 /* Use specific methods instead of the built-in one */
118 const STORE_METHOD *STORE_get_method(STORE *store);
119 const STORE_METHOD *STORE_set_method(STORE *store, const STORE_METHOD *meth);
120
121 /* The standard OpenSSL methods. */
122 /* This is the in-memory method.  It does everything except revoking and updating,
123    and is of course volatile.  It's used by other methods that have an in-memory
124    cache. */
125 const STORE_METHOD *STORE_Memory(void);
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);
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);
133
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);
226 void STORE_OBJECT_free(STORE_OBJECT *data);
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[]);
234 int STORE_store_certificate(STORE *e, X509 *data, OPENSSL_ITEM attributes[],
235         OPENSSL_ITEM parameters[]);
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[]);
239 int STORE_revoke_certificate(STORE *e, OPENSSL_ITEM attributes[],
240         OPENSSL_ITEM parameters[]);
241 int STORE_delete_certificate(STORE *e, OPENSSL_ITEM attributes[],
242         OPENSSL_ITEM parameters[]);
243 void *STORE_list_certificate_start(STORE *e, OPENSSL_ITEM attributes[],
244         OPENSSL_ITEM parameters[]);
245 X509 *STORE_list_certificate_next(STORE *e, void *handle);
246 int STORE_list_certificate_end(STORE *e, void *handle);
247 int STORE_list_certificate_endp(STORE *e, void *handle);
248 EVP_PKEY *STORE_generate_key(STORE *e, OPENSSL_ITEM attributes[],
249         OPENSSL_ITEM parameters[]);
250 EVP_PKEY *STORE_get_private_key(STORE *e, OPENSSL_ITEM attributes[],
251         OPENSSL_ITEM parameters[]);
252 int STORE_store_private_key(STORE *e, EVP_PKEY *data,
253         OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
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[]);
257 int STORE_revoke_private_key(STORE *e, OPENSSL_ITEM attributes[],
258         OPENSSL_ITEM parameters[]);
259 int STORE_delete_private_key(STORE *e, OPENSSL_ITEM attributes[],
260         OPENSSL_ITEM parameters[]);
261 void *STORE_list_private_key_start(STORE *e, OPENSSL_ITEM attributes[],
262         OPENSSL_ITEM parameters[]);
263 EVP_PKEY *STORE_list_private_key_next(STORE *e, void *handle);
264 int STORE_list_private_key_end(STORE *e, void *handle);
265 int STORE_list_private_key_endp(STORE *e, void *handle);
266 EVP_PKEY *STORE_get_public_key(STORE *e, OPENSSL_ITEM attributes[],
267         OPENSSL_ITEM parameters[]);
268 int STORE_store_public_key(STORE *e, EVP_PKEY *data, OPENSSL_ITEM attributes[],
269         OPENSSL_ITEM parameters[]);
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[]);
273 int STORE_revoke_public_key(STORE *e, OPENSSL_ITEM attributes[],
274         OPENSSL_ITEM parameters[]);
275 int STORE_delete_public_key(STORE *e, OPENSSL_ITEM attributes[],
276         OPENSSL_ITEM parameters[]);
277 void *STORE_list_public_key_start(STORE *e, OPENSSL_ITEM attributes[],
278         OPENSSL_ITEM parameters[]);
279 EVP_PKEY *STORE_list_public_key_next(STORE *e, void *handle);
280 int STORE_list_public_key_end(STORE *e, void *handle);
281 int STORE_list_public_key_endp(STORE *e, void *handle);
282 X509_CRL *STORE_generate_crl(STORE *e, OPENSSL_ITEM attributes[],
283         OPENSSL_ITEM parameters[]);
284 X509_CRL *STORE_get_crl(STORE *e, OPENSSL_ITEM attributes[],
285         OPENSSL_ITEM parameters[]);
286 int STORE_store_crl(STORE *e, X509_CRL *data, OPENSSL_ITEM attributes[],
287         OPENSSL_ITEM parameters[]);
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[]);
291 int STORE_delete_crl(STORE *e, OPENSSL_ITEM attributes[],
292         OPENSSL_ITEM parameters[]);
293 void *STORE_list_crl_start(STORE *e, OPENSSL_ITEM attributes[],
294         OPENSSL_ITEM parameters[]);
295 X509_CRL *STORE_list_crl_next(STORE *e, void *handle);
296 int STORE_list_crl_end(STORE *e, void *handle);
297 int STORE_list_crl_endp(STORE *e, void *handle);
298 int STORE_store_number(STORE *e, BIGNUM *data, OPENSSL_ITEM attributes[],
299         OPENSSL_ITEM parameters[]);
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[]);
303 BIGNUM *STORE_get_number(STORE *e, OPENSSL_ITEM attributes[],
304         OPENSSL_ITEM parameters[]);
305 int STORE_delete_number(STORE *e, OPENSSL_ITEM attributes[],
306         OPENSSL_ITEM parameters[]);
307 int STORE_store_arbitrary(STORE *e, BUF_MEM *data, OPENSSL_ITEM attributes[],
308         OPENSSL_ITEM parameters[]);
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[]);
312 BUF_MEM *STORE_get_arbitrary(STORE *e, OPENSSL_ITEM attributes[],
313         OPENSSL_ITEM parameters[]);
314 int STORE_delete_arbitrary(STORE *e, OPENSSL_ITEM attributes[],
315         OPENSSL_ITEM parameters[]);
316
317
318 /* Create and manipulate methods */
319 STORE_METHOD *STORE_create_method(char *name);
320 void STORE_destroy_method(STORE_METHOD *store_method);
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)());
335
336 int STORE_method_set_initialise_function(STORE_METHOD *sm, STORE_INITIALISE_FUNC_PTR gen_f);
337 int STORE_method_set_cleanup_function(STORE_METHOD *sm, STORE_CLEANUP_FUNC_PTR gen_f);
338 int STORE_method_set_generate_function(STORE_METHOD *sm, STORE_GENERATE_OBJECT_FUNC_PTR gen_f);
339 int STORE_method_set_get_function(STORE_METHOD *sm, STORE_GET_OBJECT_FUNC_PTR get_f);
340 int STORE_method_set_store_function(STORE_METHOD *sm, STORE_STORE_OBJECT_FUNC_PTR store_f);
341 int STORE_method_set_modify_function(STORE_METHOD *sm, STORE_MODIFY_OBJECT_FUNC_PTR store_f);
342 int STORE_method_set_revoke_function(STORE_METHOD *sm, STORE_HANDLE_OBJECT_FUNC_PTR revoke_f);
343 int STORE_method_set_delete_function(STORE_METHOD *sm, STORE_HANDLE_OBJECT_FUNC_PTR delete_f);
344 int STORE_method_set_list_start_function(STORE_METHOD *sm, STORE_START_OBJECT_FUNC_PTR list_start_f);
345 int STORE_method_set_list_next_function(STORE_METHOD *sm, STORE_NEXT_OBJECT_FUNC_PTR list_next_f);
346 int STORE_method_set_list_end_function(STORE_METHOD *sm, STORE_END_OBJECT_FUNC_PTR list_end_f);
347 int STORE_method_set_update_store_function(STORE_METHOD *sm, STORE_GENERIC_FUNC_PTR);
348 int STORE_method_set_lock_store_function(STORE_METHOD *sm, STORE_GENERIC_FUNC_PTR);
349 int STORE_method_set_unlock_store_function(STORE_METHOD *sm, STORE_GENERIC_FUNC_PTR);
350 int STORE_method_set_ctrl_function(STORE_METHOD *sm, STORE_CTRL_FUNC_PTR ctrl_f);
351
352 STORE_INITIALISE_FUNC_PTR STORE_method_get_initialise_function(STORE_METHOD *sm);
353 STORE_CLEANUP_FUNC_PTR STORE_method_get_cleanup_function(STORE_METHOD *sm);
354 STORE_GENERATE_OBJECT_FUNC_PTR STORE_method_get_generate_function(STORE_METHOD *sm);
355 STORE_GET_OBJECT_FUNC_PTR STORE_method_get_get_function(STORE_METHOD *sm);
356 STORE_STORE_OBJECT_FUNC_PTR STORE_method_get_store_function(STORE_METHOD *sm);
357 STORE_MODIFY_OBJECT_FUNC_PTR STORE_method_get_modify_function(STORE_METHOD *sm);
358 STORE_HANDLE_OBJECT_FUNC_PTR STORE_method_get_revoke_function(STORE_METHOD *sm);
359 STORE_HANDLE_OBJECT_FUNC_PTR STORE_method_get_delete_function(STORE_METHOD *sm);
360 STORE_START_OBJECT_FUNC_PTR STORE_method_get_list_start_function(STORE_METHOD *sm);
361 STORE_NEXT_OBJECT_FUNC_PTR STORE_method_get_list_next_function(STORE_METHOD *sm);
362 STORE_END_OBJECT_FUNC_PTR STORE_method_get_list_end_function(STORE_METHOD *sm);
363 STORE_GENERIC_FUNC_PTR STORE_method_get_update_store_function(STORE_METHOD *sm);
364 STORE_GENERIC_FUNC_PTR STORE_method_get_lock_store_function(STORE_METHOD *sm);
365 STORE_GENERIC_FUNC_PTR STORE_method_get_unlock_store_function(STORE_METHOD *sm);
366 STORE_CTRL_FUNC_PTR STORE_method_get_ctrl_function(STORE_METHOD *sm);
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);
380 STORE_ATTR_INFO *STORE_parse_attrs_next(void *handle);
381 int STORE_parse_attrs_end(void *handle);
382 int STORE_parse_attrs_endp(void *handle);
383
384 /* Creator and destructor */
385 STORE_ATTR_INFO *STORE_ATTR_INFO_new(void);
386 int STORE_ATTR_INFO_free(STORE_ATTR_INFO *attrs);
387
388 /* Manipulators */
389 char *STORE_ATTR_INFO_get0_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code);
390 unsigned char *STORE_ATTR_INFO_get0_sha1str(STORE_ATTR_INFO *attrs,
391         STORE_ATTR_TYPES code);
392 X509_NAME *STORE_ATTR_INFO_get0_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code);
393 BIGNUM *STORE_ATTR_INFO_get0_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code);
394 int STORE_ATTR_INFO_set_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
395         char *cstr, size_t cstr_size);
396 int STORE_ATTR_INFO_set_sha1str(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
397         unsigned char *sha1str, size_t sha1str_size);
398 int STORE_ATTR_INFO_set_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
399         X509_NAME *dn);
400 int STORE_ATTR_INFO_set_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
401         BIGNUM *number);
402 int STORE_ATTR_INFO_modify_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
403         char *cstr, size_t cstr_size);
404 int STORE_ATTR_INFO_modify_sha1str(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
405         unsigned char *sha1str, size_t sha1str_size);
406 int STORE_ATTR_INFO_modify_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
407         X509_NAME *dn);
408 int STORE_ATTR_INFO_modify_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
409         BIGNUM *number);
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);
414 /* Check if the set of attributes in a are also set in b. */
415 int STORE_ATTR_INFO_in(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
416 /* Same as STORE_ATTR_INFO_in(), but also checks the attribute values. */
417 int STORE_ATTR_INFO_in_ex(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
418
419
420 /* BEGIN ERROR CODES */
421 /* The following lines are auto generated by the script mkerr.pl. Any changes
422  * made after this point may be overwritten when the script is next run.
423  */
424 void ERR_load_STORE_strings(void);
425
426 /* Error codes for the STORE functions. */
427
428 /* Function codes. */
429 #define STORE_F_MEM_DELETE                               134
430 #define STORE_F_MEM_GENERATE                             135
431 #define STORE_F_MEM_LIST_NEXT                            136
432 #define STORE_F_MEM_LIST_START                           137
433 #define STORE_F_MEM_STORE                                138
434 #define STORE_F_STORE_ARBITRARY                          157
435 #define STORE_F_STORE_ATTR_INFO_GET0_CSTR                139
436 #define STORE_F_STORE_ATTR_INFO_GET0_DN                  140
437 #define STORE_F_STORE_ATTR_INFO_GET0_NUMBER              141
438 #define STORE_F_STORE_ATTR_INFO_GET0_SHA1STR             142
439 #define STORE_F_STORE_ATTR_INFO_MODIFY_CSTR              143
440 #define STORE_F_STORE_ATTR_INFO_MODIFY_DN                144
441 #define STORE_F_STORE_ATTR_INFO_MODIFY_NUMBER            145
442 #define STORE_F_STORE_ATTR_INFO_MODIFY_SHA1STR           146
443 #define STORE_F_STORE_ATTR_INFO_SET_CSTR                 147
444 #define STORE_F_STORE_ATTR_INFO_SET_DN                   148
445 #define STORE_F_STORE_ATTR_INFO_SET_NUMBER               149
446 #define STORE_F_STORE_ATTR_INFO_SET_SHA1STR              150
447 #define STORE_F_STORE_CERTIFICATE                        100
448 #define STORE_F_STORE_CRL                                101
449 #define STORE_F_STORE_DELETE_ARBITRARY                   158
450 #define STORE_F_STORE_DELETE_CERTIFICATE                 102
451 #define STORE_F_STORE_DELETE_CRL                         103
452 #define STORE_F_STORE_DELETE_NUMBER                      104
453 #define STORE_F_STORE_DELETE_PRIVATE_KEY                 105
454 #define STORE_F_STORE_DELETE_PUBLIC_KEY                  106
455 #define STORE_F_STORE_GENERATE_CRL                       107
456 #define STORE_F_STORE_GENERATE_KEY                       108
457 #define STORE_F_STORE_GET_ARBITRARY                      159
458 #define STORE_F_STORE_GET_CERTIFICATE                    109
459 #define STORE_F_STORE_GET_CRL                            110
460 #define STORE_F_STORE_GET_NUMBER                         111
461 #define STORE_F_STORE_GET_PRIVATE_KEY                    112
462 #define STORE_F_STORE_GET_PUBLIC_KEY                     113
463 #define STORE_F_STORE_LIST_CERTIFICATE_END               114
464 #define STORE_F_STORE_LIST_CERTIFICATE_ENDP              153
465 #define STORE_F_STORE_LIST_CERTIFICATE_NEXT              115
466 #define STORE_F_STORE_LIST_CERTIFICATE_START             116
467 #define STORE_F_STORE_LIST_CRL_END                       117
468 #define STORE_F_STORE_LIST_CRL_ENDP                      154
469 #define STORE_F_STORE_LIST_CRL_NEXT                      118
470 #define STORE_F_STORE_LIST_CRL_START                     119
471 #define STORE_F_STORE_LIST_PRIVATE_KEY_END               120
472 #define STORE_F_STORE_LIST_PRIVATE_KEY_ENDP              155
473 #define STORE_F_STORE_LIST_PRIVATE_KEY_NEXT              121
474 #define STORE_F_STORE_LIST_PRIVATE_KEY_START             122
475 #define STORE_F_STORE_LIST_PUBLIC_KEY_END                123
476 #define STORE_F_STORE_LIST_PUBLIC_KEY_ENDP               156
477 #define STORE_F_STORE_LIST_PUBLIC_KEY_NEXT               124
478 #define STORE_F_STORE_LIST_PUBLIC_KEY_START              125
479 #define STORE_F_STORE_NEW_ENGINE                         133
480 #define STORE_F_STORE_NEW_METHOD                         132
481 #define STORE_F_STORE_NUMBER                             126
482 #define STORE_F_STORE_PARSE_ATTRS_END                    151
483 #define STORE_F_STORE_PARSE_ATTRS_NEXT                   152
484 #define STORE_F_STORE_PRIVATE_KEY                        127
485 #define STORE_F_STORE_PUBLIC_KEY                         128
486 #define STORE_F_STORE_REVOKE_CERTIFICATE                 129
487 #define STORE_F_STORE_REVOKE_PRIVATE_KEY                 130
488 #define STORE_F_STORE_REVOKE_PUBLIC_KEY                  131
489
490 /* Reason codes. */
491 #define STORE_R_ALREADY_HAS_A_VALUE                      127
492 #define STORE_R_FAILED_DELETING_ARBITRARY                132
493 #define STORE_R_FAILED_DELETING_CERTIFICATE              100
494 #define STORE_R_FAILED_DELETING_KEY                      101
495 #define STORE_R_FAILED_DELETING_NUMBER                   102
496 #define STORE_R_FAILED_GENERATING_CRL                    103
497 #define STORE_R_FAILED_GENERATING_KEY                    104
498 #define STORE_R_FAILED_GETTING_ARBITRARY                 133
499 #define STORE_R_FAILED_GETTING_CERTIFICATE               105
500 #define STORE_R_FAILED_GETTING_KEY                       106
501 #define STORE_R_FAILED_GETTING_NUMBER                    107
502 #define STORE_R_FAILED_LISTING_CERTIFICATES              108
503 #define STORE_R_FAILED_LISTING_KEYS                      109
504 #define STORE_R_FAILED_REVOKING_CERTIFICATE              110
505 #define STORE_R_FAILED_REVOKING_KEY                      111
506 #define STORE_R_FAILED_STORING_ARBITRARY                 134
507 #define STORE_R_FAILED_STORING_CERTIFICATE               112
508 #define STORE_R_FAILED_STORING_KEY                       113
509 #define STORE_R_FAILED_STORING_NUMBER                    114
510 #define STORE_R_NOT_IMPLEMENTED                          128
511 #define STORE_R_NO_DELETE_ARBITRARY_FUNCTION             135
512 #define STORE_R_NO_DELETE_NUMBER_FUNCTION                115
513 #define STORE_R_NO_DELETE_OBJECT_FUNCTION                116
514 #define STORE_R_NO_GENERATE_CRL_FUNCTION                 117
515 #define STORE_R_NO_GENERATE_OBJECT_FUNCTION              118
516 #define STORE_R_NO_GET_OBJECT_ARBITRARY_FUNCTION         136
517 #define STORE_R_NO_GET_OBJECT_FUNCTION                   119
518 #define STORE_R_NO_GET_OBJECT_NUMBER_FUNCTION            120
519 #define STORE_R_NO_LIST_OBJECT_ENDP_FUNCTION             131
520 #define STORE_R_NO_LIST_OBJECT_END_FUNCTION              121
521 #define STORE_R_NO_LIST_OBJECT_NEXT_FUNCTION             122
522 #define STORE_R_NO_LIST_OBJECT_START_FUNCTION            123
523 #define STORE_R_NO_REVOKE_OBJECT_FUNCTION                124
524 #define STORE_R_NO_STORE                                 129
525 #define STORE_R_NO_STORE_OBJECT_ARBITRARY_FUNCTION       137
526 #define STORE_R_NO_STORE_OBJECT_FUNCTION                 125
527 #define STORE_R_NO_STORE_OBJECT_NUMBER_FUNCTION          126
528 #define STORE_R_NO_VALUE                                 130
529
530 #ifdef  __cplusplus
531 }
532 #endif
533 #endif