williamr@2: /* crypto/store/store.h -*- mode:C; c-file-style: "eay" -*- */
williamr@2: /* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
williamr@2:  * project 2003.
williamr@2:  */
williamr@2: /* ====================================================================
williamr@2:  * Copyright (c) 2003 The OpenSSL Project.  All rights reserved.
williamr@2:  *
williamr@2:  * Redistribution and use in source and binary forms, with or without
williamr@2:  * modification, are permitted provided that the following conditions
williamr@2:  * are met:
williamr@2:  *
williamr@2:  * 1. Redistributions of source code must retain the above copyright
williamr@2:  *    notice, this list of conditions and the following disclaimer. 
williamr@2:  *
williamr@2:  * 2. Redistributions in binary form must reproduce the above copyright
williamr@2:  *    notice, this list of conditions and the following disclaimer in
williamr@2:  *    the documentation and/or other materials provided with the
williamr@2:  *    distribution.
williamr@2:  *
williamr@2:  * 3. All advertising materials mentioning features or use of this
williamr@2:  *    software must display the following acknowledgment:
williamr@2:  *    "This product includes software developed by the OpenSSL Project
williamr@2:  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
williamr@2:  *
williamr@2:  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
williamr@2:  *    endorse or promote products derived from this software without
williamr@2:  *    prior written permission. For written permission, please contact
williamr@2:  *    openssl-core@openssl.org.
williamr@2:  *
williamr@2:  * 5. Products derived from this software may not be called "OpenSSL"
williamr@2:  *    nor may "OpenSSL" appear in their names without prior written
williamr@2:  *    permission of the OpenSSL Project.
williamr@2:  *
williamr@2:  * 6. Redistributions of any form whatsoever must retain the following
williamr@2:  *    acknowledgment:
williamr@2:  *    "This product includes software developed by the OpenSSL Project
williamr@2:  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
williamr@2:  *
williamr@2:  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
williamr@2:  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
williamr@2:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
williamr@2:  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
williamr@2:  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
williamr@2:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
williamr@2:  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
williamr@2:  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
williamr@2:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
williamr@2:  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
williamr@2:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
williamr@2:  * OF THE POSSIBILITY OF SUCH DAMAGE.
williamr@2:  * ====================================================================
williamr@2:  *
williamr@2:  * This product includes cryptographic software written by Eric Young
williamr@2:  * (eay@cryptsoft.com).  This product includes software written by Tim
williamr@2:  * Hudson (tjh@cryptsoft.com).
williamr@2:  *
williamr@2:  */
williamr@2: /*
williamr@2:  © Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
williamr@2:  */
williamr@2: 
williamr@2: #ifndef HEADER_STORE_H
williamr@2: #define HEADER_STORE_H
williamr@2: 
williamr@2: #if (defined(__SYMBIAN32__) && !defined(SYMBIAN))
williamr@2: #define SYMBIAN
williamr@2: #endif
williamr@2: 
williamr@2: #ifdef SYMBIAN
williamr@2: #include <e32def.h>
williamr@2: #endif
williamr@2: #include <openssl/ossl_typ.h>
williamr@2: #ifndef OPENSSL_NO_DEPRECATED
williamr@2: #include <openssl/evp.h>
williamr@2: #include <openssl/bn.h>
williamr@2: #include <openssl/x509.h>
williamr@2: #endif
williamr@2: 
williamr@2: #ifdef  __cplusplus
williamr@2: extern "C" {
williamr@2: #endif
williamr@2: 
williamr@2: /* Already defined in ossl_typ.h */
williamr@2: /* typedef struct store_st STORE; */
williamr@2: /* typedef struct store_method_st STORE_METHOD; */
williamr@2: 
williamr@2: 
williamr@2: /* All the following functions return 0, a negative number or NULL on error.
williamr@2:    When everything is fine, they return a positive value or a non-NULL
williamr@2:    pointer, all depending on their purpose. */
williamr@2: 
williamr@2: /* Creators and destructor.   */
williamr@2: IMPORT_C STORE *STORE_new_method(const STORE_METHOD *method);
williamr@2: IMPORT_C STORE *STORE_new_engine(ENGINE *engine);
williamr@2: IMPORT_C void STORE_free(STORE *ui);
williamr@2: 
williamr@2: 
williamr@2: /* Give a user interface parametrised control commands.  This can be used to
williamr@2:    send down an integer, a data pointer or a function pointer, as well as
williamr@2:    be used to get information from a STORE. */
williamr@2: IMPORT_C int STORE_ctrl(STORE *store, int cmd, long i, void *p, void (*f)(void));
williamr@2: 
williamr@2: /* A control to set the directory with keys and certificates.  Used by the
williamr@2:    built-in directory level method. */
williamr@2: #define STORE_CTRL_SET_DIRECTORY	0x0001
williamr@2: /* A control to set a file to load.  Used by the built-in file level method. */
williamr@2: #define STORE_CTRL_SET_FILE		0x0002
williamr@2: /* A control to set a configuration file to load.  Can be used by any method
williamr@2:    that wishes to load a configuration file. */
williamr@2: #define STORE_CTRL_SET_CONF_FILE	0x0003
williamr@2: /* A control to set a the section of the loaded configuration file.  Can be
williamr@2:    used by any method that wishes to load a configuration file. */
williamr@2: #define STORE_CTRL_SET_CONF_SECTION	0x0004
williamr@2: 
williamr@2: 
williamr@2: /* Some methods may use extra data */
williamr@2: #define STORE_set_app_data(s,arg)	STORE_set_ex_data(s,0,arg)
williamr@2: #define STORE_get_app_data(s)		STORE_get_ex_data(s,0)
williamr@2: IMPORT_C int STORE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
williamr@2: 	CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
williamr@2: IMPORT_C int STORE_set_ex_data(STORE *r,int idx,void *arg);
williamr@2: IMPORT_C void *STORE_get_ex_data(STORE *r, int idx);
williamr@2: 
williamr@2: /* Use specific methods instead of the built-in one */
williamr@2: IMPORT_C const STORE_METHOD *STORE_get_method(STORE *store);
williamr@2: IMPORT_C const STORE_METHOD *STORE_set_method(STORE *store, const STORE_METHOD *meth);
williamr@2: 
williamr@2: /* The standard OpenSSL methods. */
williamr@2: /* This is the in-memory method.  It does everything except revoking and updating,
williamr@2:    and is of course volatile.  It's used by other methods that have an in-memory
williamr@2:    cache. */
williamr@2: IMPORT_C const STORE_METHOD *STORE_Memory(void);
williamr@2: #if 0 /* Not yet implemented */
williamr@2: /* This is the directory store.  It does everything except revoking and updating,
williamr@2:    and uses STORE_Memory() to cache things in memory. */
williamr@2: IMPORT_C const STORE_METHOD *STORE_Directory(void);
williamr@2: /* This is the file store.  It does everything except revoking and updating,
williamr@2:    and uses STORE_Memory() to cache things in memory.  Certificates are added
williamr@2:    to it with the store operation, and it will only get cached certificates. */
williamr@2: IMPORT_C const STORE_METHOD *STORE_File(void);
williamr@2: #endif
williamr@2: 
williamr@2: /* Store functions take a type code for the type of data they should store
williamr@2:    or fetch */
williamr@2: typedef enum STORE_object_types
williamr@2: 	{
williamr@2: 	STORE_OBJECT_TYPE_X509_CERTIFICATE=	0x01, /* X509 * */
williamr@2: 	STORE_OBJECT_TYPE_X509_CRL=		0x02, /* X509_CRL * */
williamr@2: 	STORE_OBJECT_TYPE_PRIVATE_KEY=		0x03, /* EVP_PKEY * */
williamr@2: 	STORE_OBJECT_TYPE_PUBLIC_KEY=		0x04, /* EVP_PKEY * */
williamr@2: 	STORE_OBJECT_TYPE_NUMBER=		0x05, /* BIGNUM * */
williamr@2: 	STORE_OBJECT_TYPE_ARBITRARY=		0x06, /* BUF_MEM * */
williamr@2: 	STORE_OBJECT_TYPE_NUM=			0x06  /* The amount of known
williamr@2: 							 object types */
williamr@2: 	} STORE_OBJECT_TYPES;
williamr@2: /* List of text strings corresponding to the object types. */
williamr@2: extern const char * const STORE_object_type_string[STORE_OBJECT_TYPE_NUM+1];
williamr@2: 
williamr@2: /* Some store functions take a parameter list.  Those parameters come with
williamr@2:    one of the following codes. The comments following the codes below indicate
williamr@2:    what type the value should be a pointer to. */
williamr@2: typedef enum STORE_params
williamr@2: 	{
williamr@2: 	STORE_PARAM_EVP_TYPE=			0x01, /* int */
williamr@2: 	STORE_PARAM_BITS=			0x02, /* size_t */
williamr@2: 	STORE_PARAM_KEY_PARAMETERS=		0x03, /* ??? */
williamr@2: 	STORE_PARAM_KEY_NO_PARAMETERS=		0x04, /* N/A */
williamr@2: 	STORE_PARAM_AUTH_PASSPHRASE=		0x05, /* char * */
williamr@2: 	STORE_PARAM_AUTH_KRB5_TICKET=		0x06, /* void * */
williamr@2: 	STORE_PARAM_TYPE_NUM=			0x06  /* The amount of known
williamr@2: 							 parameter types */
williamr@2: 	} STORE_PARAM_TYPES;
williamr@2: /* Parameter value sizes.  -1 means unknown, anything else is the required size. */
williamr@2: extern const int STORE_param_sizes[STORE_PARAM_TYPE_NUM+1];
williamr@2: 
williamr@2: /* Store functions take attribute lists.  Those attributes come with codes.
williamr@2:    The comments following the codes below indicate what type the value should
williamr@2:    be a pointer to. */
williamr@2: typedef enum STORE_attribs
williamr@2: 	{
williamr@2: 	STORE_ATTR_END=				0x00,
williamr@2: 	STORE_ATTR_FRIENDLYNAME=		0x01, /* C string */
williamr@2: 	STORE_ATTR_KEYID=			0x02, /* 160 bit string (SHA1) */
williamr@2: 	STORE_ATTR_ISSUERKEYID=			0x03, /* 160 bit string (SHA1) */
williamr@2: 	STORE_ATTR_SUBJECTKEYID=		0x04, /* 160 bit string (SHA1) */
williamr@2: 	STORE_ATTR_ISSUERSERIALHASH=		0x05, /* 160 bit string (SHA1) */
williamr@2: 	STORE_ATTR_ISSUER=			0x06, /* X509_NAME * */
williamr@2: 	STORE_ATTR_SERIAL=			0x07, /* BIGNUM * */
williamr@2: 	STORE_ATTR_SUBJECT=			0x08, /* X509_NAME * */
williamr@2: 	STORE_ATTR_CERTHASH=			0x09, /* 160 bit string (SHA1) */
williamr@2: 	STORE_ATTR_EMAIL=			0x0a, /* C string */
williamr@2: 	STORE_ATTR_FILENAME=			0x0b, /* C string */
williamr@2: 	STORE_ATTR_TYPE_NUM=			0x0b, /* The amount of known
williamr@2: 							 attribute types */
williamr@2: 	STORE_ATTR_OR=				0xff  /* This is a special
williamr@2: 							 separator, which
williamr@2: 							 expresses the OR
williamr@2: 							 operation.  */
williamr@2: 	} STORE_ATTR_TYPES;
williamr@2: /* Attribute value sizes.  -1 means unknown, anything else is the required size. */
williamr@2: extern const int STORE_attr_sizes[STORE_ATTR_TYPE_NUM+1];
williamr@2: 
williamr@2: typedef enum STORE_certificate_status
williamr@2: 	{
williamr@2: 	STORE_X509_VALID=			0x00,
williamr@2: 	STORE_X509_EXPIRED=			0x01,
williamr@2: 	STORE_X509_SUSPENDED=			0x02,
williamr@2: 	STORE_X509_REVOKED=			0x03
williamr@2: 	} STORE_CERTIFICATE_STATUS;
williamr@2: 
williamr@2: /* Engine store functions will return a structure that contains all the necessary
williamr@2:  * information, including revokation status for certificates.  This is really not
williamr@2:  * needed for application authors, as the ENGINE framework functions will extract
williamr@2:  * the OpenSSL-specific information when at all possible.  However, for engine
williamr@2:  * authors, it's crucial to know this structure.  */
williamr@2: typedef struct STORE_OBJECT_st
williamr@2: 	{
williamr@2: 	STORE_OBJECT_TYPES type;
williamr@2: 	union
williamr@2: 		{
williamr@2: 		struct
williamr@2: 			{
williamr@2: 			STORE_CERTIFICATE_STATUS status;
williamr@2: 			X509 *certificate;
williamr@2: 			} x509;
williamr@2: 		X509_CRL *crl;
williamr@2: 		EVP_PKEY *key;
williamr@2: 		BIGNUM *number;
williamr@2: 		BUF_MEM *arbitrary;
williamr@2: 		} data;
williamr@2: 	} STORE_OBJECT;
williamr@2: DECLARE_STACK_OF(STORE_OBJECT)
williamr@2: STORE_OBJECT *STORE_OBJECT_new(void);
williamr@2: void STORE_OBJECT_free(STORE_OBJECT *data);
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: /* The following functions handle the storage. They return 0, a negative number
williamr@2:    or NULL on error, anything else on success. */
williamr@2: IMPORT_C X509 *STORE_get_certificate(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_store_certificate(STORE *e, X509 *data, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_modify_certificate(STORE *e, OPENSSL_ITEM search_attributes[],
williamr@2: 	OPENSSL_ITEM add_attributes[], OPENSSL_ITEM modify_attributes[],
williamr@2: 	OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_revoke_certificate(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_delete_certificate(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C void *STORE_list_certificate_start(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C X509 *STORE_list_certificate_next(STORE *e, void *handle);
williamr@2: IMPORT_C int STORE_list_certificate_end(STORE *e, void *handle);
williamr@2: IMPORT_C int STORE_list_certificate_endp(STORE *e, void *handle);
williamr@2: IMPORT_C EVP_PKEY *STORE_generate_key(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C EVP_PKEY *STORE_get_private_key(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_store_private_key(STORE *e, EVP_PKEY *data,
williamr@2: 	OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_modify_private_key(STORE *e, OPENSSL_ITEM search_attributes[],
williamr@2: 	OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
williamr@2: 	OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_revoke_private_key(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_delete_private_key(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C void *STORE_list_private_key_start(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C EVP_PKEY *STORE_list_private_key_next(STORE *e, void *handle);
williamr@2: IMPORT_C int STORE_list_private_key_end(STORE *e, void *handle);
williamr@2: IMPORT_C int STORE_list_private_key_endp(STORE *e, void *handle);
williamr@2: IMPORT_C EVP_PKEY *STORE_get_public_key(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_store_public_key(STORE *e, EVP_PKEY *data, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_modify_public_key(STORE *e, OPENSSL_ITEM search_attributes[],
williamr@2: 	OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
williamr@2: 	OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_revoke_public_key(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_delete_public_key(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C void *STORE_list_public_key_start(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C EVP_PKEY *STORE_list_public_key_next(STORE *e, void *handle);
williamr@2: IMPORT_C int STORE_list_public_key_end(STORE *e, void *handle);
williamr@2: IMPORT_C int STORE_list_public_key_endp(STORE *e, void *handle);
williamr@2: IMPORT_C X509_CRL *STORE_generate_crl(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C X509_CRL *STORE_get_crl(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_store_crl(STORE *e, X509_CRL *data, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_modify_crl(STORE *e, OPENSSL_ITEM search_attributes[],
williamr@2: 	OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
williamr@2: 	OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_delete_crl(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C void *STORE_list_crl_start(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C X509_CRL *STORE_list_crl_next(STORE *e, void *handle);
williamr@2: IMPORT_C int STORE_list_crl_end(STORE *e, void *handle);
williamr@2: IMPORT_C int STORE_list_crl_endp(STORE *e, void *handle);
williamr@2: IMPORT_C int STORE_store_number(STORE *e, BIGNUM *data, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_modify_number(STORE *e, OPENSSL_ITEM search_attributes[],
williamr@2: 	OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
williamr@2: 	OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C BIGNUM *STORE_get_number(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_delete_number(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_store_arbitrary(STORE *e, BUF_MEM *data, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_modify_arbitrary(STORE *e, OPENSSL_ITEM search_attributes[],
williamr@2: 	OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
williamr@2: 	OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C BUF_MEM *STORE_get_arbitrary(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: IMPORT_C int STORE_delete_arbitrary(STORE *e, OPENSSL_ITEM attributes[],
williamr@2: 	OPENSSL_ITEM parameters[]);
williamr@2: 
williamr@2: 
williamr@2: /* Create and manipulate methods */
williamr@2: IMPORT_C STORE_METHOD *STORE_create_method(char *name);
williamr@2: IMPORT_C void STORE_destroy_method(STORE_METHOD *store_method);
williamr@2: 
williamr@2: /* These callback types are use for store handlers */
williamr@2: typedef int (*STORE_INITIALISE_FUNC_PTR)(STORE *);
williamr@2: typedef void (*STORE_CLEANUP_FUNC_PTR)(STORE *);
williamr@2: typedef STORE_OBJECT *(*STORE_GENERATE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
williamr@2: typedef STORE_OBJECT *(*STORE_GET_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
williamr@2: typedef void *(*STORE_START_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
williamr@2: typedef STORE_OBJECT *(*STORE_NEXT_OBJECT_FUNC_PTR)(STORE *, void *handle);
williamr@2: typedef int (*STORE_END_OBJECT_FUNC_PTR)(STORE *, void *handle);
williamr@2: typedef int (*STORE_HANDLE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
williamr@2: typedef int (*STORE_STORE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, STORE_OBJECT *data, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
williamr@2: 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[]);
williamr@2: typedef int (*STORE_GENERIC_FUNC_PTR)(STORE *, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
williamr@2: typedef int (*STORE_CTRL_FUNC_PTR)(STORE *, int cmd, long l, void *p, void (*f)(void));
williamr@2: 
williamr@2: IMPORT_C int STORE_method_set_initialise_function(STORE_METHOD *sm, STORE_INITIALISE_FUNC_PTR init_f);
williamr@2: IMPORT_C int STORE_method_set_cleanup_function(STORE_METHOD *sm, STORE_CLEANUP_FUNC_PTR clean_f);
williamr@2: IMPORT_C int STORE_method_set_generate_function(STORE_METHOD *sm, STORE_GENERATE_OBJECT_FUNC_PTR generate_f);
williamr@2: IMPORT_C int STORE_method_set_get_function(STORE_METHOD *sm, STORE_GET_OBJECT_FUNC_PTR get_f);
williamr@2: IMPORT_C int STORE_method_set_store_function(STORE_METHOD *sm, STORE_STORE_OBJECT_FUNC_PTR store_f);
williamr@2: IMPORT_C int STORE_method_set_modify_function(STORE_METHOD *sm, STORE_MODIFY_OBJECT_FUNC_PTR store_f);
williamr@2: IMPORT_C int STORE_method_set_revoke_function(STORE_METHOD *sm, STORE_HANDLE_OBJECT_FUNC_PTR revoke_f);
williamr@2: IMPORT_C int STORE_method_set_delete_function(STORE_METHOD *sm, STORE_HANDLE_OBJECT_FUNC_PTR delete_f);
williamr@2: IMPORT_C int STORE_method_set_list_start_function(STORE_METHOD *sm, STORE_START_OBJECT_FUNC_PTR list_start_f);
williamr@2: IMPORT_C int STORE_method_set_list_next_function(STORE_METHOD *sm, STORE_NEXT_OBJECT_FUNC_PTR list_next_f);
williamr@2: IMPORT_C int STORE_method_set_list_end_function(STORE_METHOD *sm, STORE_END_OBJECT_FUNC_PTR list_end_f);
williamr@2: IMPORT_C int STORE_method_set_update_store_function(STORE_METHOD *sm, STORE_GENERIC_FUNC_PTR);
williamr@2: IMPORT_C int STORE_method_set_lock_store_function(STORE_METHOD *sm, STORE_GENERIC_FUNC_PTR);
williamr@2: IMPORT_C int STORE_method_set_unlock_store_function(STORE_METHOD *sm, STORE_GENERIC_FUNC_PTR);
williamr@2: IMPORT_C int STORE_method_set_ctrl_function(STORE_METHOD *sm, STORE_CTRL_FUNC_PTR ctrl_f);
williamr@2: 
williamr@2: IMPORT_C STORE_INITIALISE_FUNC_PTR STORE_method_get_initialise_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_CLEANUP_FUNC_PTR STORE_method_get_cleanup_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_GENERATE_OBJECT_FUNC_PTR STORE_method_get_generate_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_GET_OBJECT_FUNC_PTR STORE_method_get_get_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_STORE_OBJECT_FUNC_PTR STORE_method_get_store_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_MODIFY_OBJECT_FUNC_PTR STORE_method_get_modify_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_HANDLE_OBJECT_FUNC_PTR STORE_method_get_revoke_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_HANDLE_OBJECT_FUNC_PTR STORE_method_get_delete_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_START_OBJECT_FUNC_PTR STORE_method_get_list_start_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_NEXT_OBJECT_FUNC_PTR STORE_method_get_list_next_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_END_OBJECT_FUNC_PTR STORE_method_get_list_end_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_GENERIC_FUNC_PTR STORE_method_get_update_store_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_GENERIC_FUNC_PTR STORE_method_get_lock_store_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_GENERIC_FUNC_PTR STORE_method_get_unlock_store_function(STORE_METHOD *sm);
williamr@2: IMPORT_C STORE_CTRL_FUNC_PTR STORE_method_get_ctrl_function(STORE_METHOD *sm);
williamr@2: 
williamr@2: /* Method helper structures and functions. */
williamr@2: 
williamr@2: /* This structure is the result of parsing through the information in a list
williamr@2:    of OPENSSL_ITEMs.  It stores all the necessary information in a structured
williamr@2:    way.*/
williamr@2: typedef struct STORE_attr_info_st STORE_ATTR_INFO;
williamr@2: 
williamr@2: /* Parse a list of OPENSSL_ITEMs and return a pointer to a STORE_ATTR_INFO.
williamr@2:    Note that we do this in the list form, since the list of OPENSSL_ITEMs can
williamr@2:    come in blocks separated with STORE_ATTR_OR.  Note that the value returned
williamr@2:    by STORE_parse_attrs_next() must be freed with STORE_ATTR_INFO_free(). */
williamr@2: IMPORT_C void *STORE_parse_attrs_start(OPENSSL_ITEM *attributes);
williamr@2: IMPORT_C STORE_ATTR_INFO *STORE_parse_attrs_next(void *handle);
williamr@2: IMPORT_C int STORE_parse_attrs_end(void *handle);
williamr@2: IMPORT_C int STORE_parse_attrs_endp(void *handle);
williamr@2: 
williamr@2: /* Creator and destructor */
williamr@2: IMPORT_C STORE_ATTR_INFO *STORE_ATTR_INFO_new(void);
williamr@2: IMPORT_C int STORE_ATTR_INFO_free(STORE_ATTR_INFO *attrs);
williamr@2: 
williamr@2: /* Manipulators */
williamr@2: IMPORT_C char *STORE_ATTR_INFO_get0_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code);
williamr@2: IMPORT_C unsigned char *STORE_ATTR_INFO_get0_sha1str(STORE_ATTR_INFO *attrs,
williamr@2: 	STORE_ATTR_TYPES code);
williamr@2: IMPORT_C X509_NAME *STORE_ATTR_INFO_get0_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code);
williamr@2: IMPORT_C BIGNUM *STORE_ATTR_INFO_get0_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code);
williamr@2: IMPORT_C int STORE_ATTR_INFO_set_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
williamr@2: 	char *cstr, size_t cstr_size);
williamr@2: IMPORT_C int STORE_ATTR_INFO_set_sha1str(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
williamr@2: 	unsigned char *sha1str, size_t sha1str_size);
williamr@2: IMPORT_C int STORE_ATTR_INFO_set_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
williamr@2: 	X509_NAME *dn);
williamr@2: IMPORT_C int STORE_ATTR_INFO_set_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
williamr@2: 	BIGNUM *number);
williamr@2: IMPORT_C int STORE_ATTR_INFO_modify_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
williamr@2: 	char *cstr, size_t cstr_size);
williamr@2: IMPORT_C int STORE_ATTR_INFO_modify_sha1str(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
williamr@2: 	unsigned char *sha1str, size_t sha1str_size);
williamr@2: IMPORT_C int STORE_ATTR_INFO_modify_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
williamr@2: 	X509_NAME *dn);
williamr@2: IMPORT_C int STORE_ATTR_INFO_modify_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
williamr@2: 	BIGNUM *number);
williamr@2: 
williamr@2: /* Compare on basis of a bit pattern formed by the STORE_ATTR_TYPES values
williamr@2:    in each contained attribute. */
williamr@2: IMPORT_C int STORE_ATTR_INFO_compare(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
williamr@2: /* Check if the set of attributes in a is within the range of attributes
williamr@2:    set in b. */
williamr@2: IMPORT_C int STORE_ATTR_INFO_in_range(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
williamr@2: /* Check if the set of attributes in a are also set in b. */
williamr@2: IMPORT_C int STORE_ATTR_INFO_in(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
williamr@2: /* Same as STORE_ATTR_INFO_in(), but also checks the attribute values. */
williamr@2: IMPORT_C int STORE_ATTR_INFO_in_ex(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
williamr@2: 
williamr@2: 
williamr@2: /* BEGIN ERROR CODES */
williamr@2: /* The following lines are auto generated by the script mkerr.pl. Any changes
williamr@2:  * made after this point may be overwritten when the script is next run.
williamr@2:  */
williamr@2: IMPORT_C void ERR_load_STORE_strings(void);
williamr@2: 
williamr@2: /* Error codes for the STORE functions. */
williamr@2: 
williamr@2: /* Function codes. */
williamr@2: #define STORE_F_MEM_DELETE				 134
williamr@2: #define STORE_F_MEM_GENERATE				 135
williamr@2: #define STORE_F_MEM_LIST_END				 168
williamr@2: #define STORE_F_MEM_LIST_NEXT				 136
williamr@2: #define STORE_F_MEM_LIST_START				 137
williamr@2: #define STORE_F_MEM_MODIFY				 169
williamr@2: #define STORE_F_MEM_STORE				 138
williamr@2: #define STORE_F_STORE_ATTR_INFO_GET0_CSTR		 139
williamr@2: #define STORE_F_STORE_ATTR_INFO_GET0_DN			 140
williamr@2: #define STORE_F_STORE_ATTR_INFO_GET0_NUMBER		 141
williamr@2: #define STORE_F_STORE_ATTR_INFO_GET0_SHA1STR		 142
williamr@2: #define STORE_F_STORE_ATTR_INFO_MODIFY_CSTR		 143
williamr@2: #define STORE_F_STORE_ATTR_INFO_MODIFY_DN		 144
williamr@2: #define STORE_F_STORE_ATTR_INFO_MODIFY_NUMBER		 145
williamr@2: #define STORE_F_STORE_ATTR_INFO_MODIFY_SHA1STR		 146
williamr@2: #define STORE_F_STORE_ATTR_INFO_SET_CSTR		 147
williamr@2: #define STORE_F_STORE_ATTR_INFO_SET_DN			 148
williamr@2: #define STORE_F_STORE_ATTR_INFO_SET_NUMBER		 149
williamr@2: #define STORE_F_STORE_ATTR_INFO_SET_SHA1STR		 150
williamr@2: #define STORE_F_STORE_CERTIFICATE			 170
williamr@2: #define STORE_F_STORE_CTRL				 161
williamr@2: #define STORE_F_STORE_DELETE_ARBITRARY			 158
williamr@2: #define STORE_F_STORE_DELETE_CERTIFICATE		 102
williamr@2: #define STORE_F_STORE_DELETE_CRL			 103
williamr@2: #define STORE_F_STORE_DELETE_NUMBER			 104
williamr@2: #define STORE_F_STORE_DELETE_PRIVATE_KEY		 105
williamr@2: #define STORE_F_STORE_DELETE_PUBLIC_KEY			 106
williamr@2: #define STORE_F_STORE_GENERATE_CRL			 107
williamr@2: #define STORE_F_STORE_GENERATE_KEY			 108
williamr@2: #define STORE_F_STORE_GET_ARBITRARY			 159
williamr@2: #define STORE_F_STORE_GET_CERTIFICATE			 109
williamr@2: #define STORE_F_STORE_GET_CRL				 110
williamr@2: #define STORE_F_STORE_GET_NUMBER			 111
williamr@2: #define STORE_F_STORE_GET_PRIVATE_KEY			 112
williamr@2: #define STORE_F_STORE_GET_PUBLIC_KEY			 113
williamr@2: #define STORE_F_STORE_LIST_CERTIFICATE_END		 114
williamr@2: #define STORE_F_STORE_LIST_CERTIFICATE_ENDP		 153
williamr@2: #define STORE_F_STORE_LIST_CERTIFICATE_NEXT		 115
williamr@2: #define STORE_F_STORE_LIST_CERTIFICATE_START		 116
williamr@2: #define STORE_F_STORE_LIST_CRL_END			 117
williamr@2: #define STORE_F_STORE_LIST_CRL_ENDP			 154
williamr@2: #define STORE_F_STORE_LIST_CRL_NEXT			 118
williamr@2: #define STORE_F_STORE_LIST_CRL_START			 119
williamr@2: #define STORE_F_STORE_LIST_PRIVATE_KEY_END		 120
williamr@2: #define STORE_F_STORE_LIST_PRIVATE_KEY_ENDP		 155
williamr@2: #define STORE_F_STORE_LIST_PRIVATE_KEY_NEXT		 121
williamr@2: #define STORE_F_STORE_LIST_PRIVATE_KEY_START		 122
williamr@2: #define STORE_F_STORE_LIST_PUBLIC_KEY_END		 123
williamr@2: #define STORE_F_STORE_LIST_PUBLIC_KEY_ENDP		 156
williamr@2: #define STORE_F_STORE_LIST_PUBLIC_KEY_NEXT		 124
williamr@2: #define STORE_F_STORE_LIST_PUBLIC_KEY_START		 125
williamr@2: #define STORE_F_STORE_MODIFY_ARBITRARY			 162
williamr@2: #define STORE_F_STORE_MODIFY_CERTIFICATE		 163
williamr@2: #define STORE_F_STORE_MODIFY_CRL			 164
williamr@2: #define STORE_F_STORE_MODIFY_NUMBER			 165
williamr@2: #define STORE_F_STORE_MODIFY_PRIVATE_KEY		 166
williamr@2: #define STORE_F_STORE_MODIFY_PUBLIC_KEY			 167
williamr@2: #define STORE_F_STORE_NEW_ENGINE			 133
williamr@2: #define STORE_F_STORE_NEW_METHOD			 132
williamr@2: #define STORE_F_STORE_PARSE_ATTRS_END			 151
williamr@2: #define STORE_F_STORE_PARSE_ATTRS_ENDP			 172
williamr@2: #define STORE_F_STORE_PARSE_ATTRS_NEXT			 152
williamr@2: #define STORE_F_STORE_PARSE_ATTRS_START			 171
williamr@2: #define STORE_F_STORE_REVOKE_CERTIFICATE		 129
williamr@2: #define STORE_F_STORE_REVOKE_PRIVATE_KEY		 130
williamr@2: #define STORE_F_STORE_REVOKE_PUBLIC_KEY			 131
williamr@2: #define STORE_F_STORE_STORE_ARBITRARY			 157
williamr@2: #define STORE_F_STORE_STORE_CERTIFICATE			 100
williamr@2: #define STORE_F_STORE_STORE_CRL				 101
williamr@2: #define STORE_F_STORE_STORE_NUMBER			 126
williamr@2: #define STORE_F_STORE_STORE_PRIVATE_KEY			 127
williamr@2: #define STORE_F_STORE_STORE_PUBLIC_KEY			 128
williamr@2: 
williamr@2: /* Reason codes. */
williamr@2: #define STORE_R_ALREADY_HAS_A_VALUE			 127
williamr@2: #define STORE_R_FAILED_DELETING_ARBITRARY		 132
williamr@2: #define STORE_R_FAILED_DELETING_CERTIFICATE		 100
williamr@2: #define STORE_R_FAILED_DELETING_KEY			 101
williamr@2: #define STORE_R_FAILED_DELETING_NUMBER			 102
williamr@2: #define STORE_R_FAILED_GENERATING_CRL			 103
williamr@2: #define STORE_R_FAILED_GENERATING_KEY			 104
williamr@2: #define STORE_R_FAILED_GETTING_ARBITRARY		 133
williamr@2: #define STORE_R_FAILED_GETTING_CERTIFICATE		 105
williamr@2: #define STORE_R_FAILED_GETTING_KEY			 106
williamr@2: #define STORE_R_FAILED_GETTING_NUMBER			 107
williamr@2: #define STORE_R_FAILED_LISTING_CERTIFICATES		 108
williamr@2: #define STORE_R_FAILED_LISTING_KEYS			 109
williamr@2: #define STORE_R_FAILED_MODIFYING_ARBITRARY		 138
williamr@2: #define STORE_R_FAILED_MODIFYING_CERTIFICATE		 139
williamr@2: #define STORE_R_FAILED_MODIFYING_CRL			 140
williamr@2: #define STORE_R_FAILED_MODIFYING_NUMBER			 141
williamr@2: #define STORE_R_FAILED_MODIFYING_PRIVATE_KEY		 142
williamr@2: #define STORE_R_FAILED_MODIFYING_PUBLIC_KEY		 143
williamr@2: #define STORE_R_FAILED_REVOKING_CERTIFICATE		 110
williamr@2: #define STORE_R_FAILED_REVOKING_KEY			 111
williamr@2: #define STORE_R_FAILED_STORING_ARBITRARY		 134
williamr@2: #define STORE_R_FAILED_STORING_CERTIFICATE		 112
williamr@2: #define STORE_R_FAILED_STORING_KEY			 113
williamr@2: #define STORE_R_FAILED_STORING_NUMBER			 114
williamr@2: #define STORE_R_NOT_IMPLEMENTED				 128
williamr@2: #define STORE_R_NO_CONTROL_FUNCTION			 144
williamr@2: #define STORE_R_NO_DELETE_ARBITRARY_FUNCTION		 135
williamr@2: #define STORE_R_NO_DELETE_NUMBER_FUNCTION		 115
williamr@2: #define STORE_R_NO_DELETE_OBJECT_FUNCTION		 116
williamr@2: #define STORE_R_NO_GENERATE_CRL_FUNCTION		 117
williamr@2: #define STORE_R_NO_GENERATE_OBJECT_FUNCTION		 118
williamr@2: #define STORE_R_NO_GET_OBJECT_ARBITRARY_FUNCTION	 136
williamr@2: #define STORE_R_NO_GET_OBJECT_FUNCTION			 119
williamr@2: #define STORE_R_NO_GET_OBJECT_NUMBER_FUNCTION		 120
williamr@2: #define STORE_R_NO_LIST_OBJECT_ENDP_FUNCTION		 131
williamr@2: #define STORE_R_NO_LIST_OBJECT_END_FUNCTION		 121
williamr@2: #define STORE_R_NO_LIST_OBJECT_NEXT_FUNCTION		 122
williamr@2: #define STORE_R_NO_LIST_OBJECT_START_FUNCTION		 123
williamr@2: #define STORE_R_NO_MODIFY_OBJECT_FUNCTION		 145
williamr@2: #define STORE_R_NO_REVOKE_OBJECT_FUNCTION		 124
williamr@2: #define STORE_R_NO_STORE				 129
williamr@2: #define STORE_R_NO_STORE_OBJECT_ARBITRARY_FUNCTION	 137
williamr@2: #define STORE_R_NO_STORE_OBJECT_FUNCTION		 125
williamr@2: #define STORE_R_NO_STORE_OBJECT_NUMBER_FUNCTION		 126
williamr@2: #define STORE_R_NO_VALUE				 130
williamr@2: 
williamr@2: #ifdef  __cplusplus
williamr@2: }
williamr@2: #endif
williamr@2: #endif