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