Define the two authentication parameter types for passphrase and
[openssl.git] / crypto / store / store.h
index 164165e7b013ef7d83cc3b005f2d1511a59280ce..5dba567c573afa3e61726373ef50d3cf5aab4586 100644 (file)
@@ -135,12 +135,13 @@ const STORE_METHOD *STORE_File(void);
    or fetch */
 typedef enum STORE_object_types
        {
-       STORE_OBJECT_TYPE_X509_CERTIFICATE=     0x01,
-       STORE_OBJECT_TYPE_X509_CRL=             0x02,
-       STORE_OBJECT_TYPE_PRIVATE_KEY=          0x03,
-       STORE_OBJECT_TYPE_PUBLIC_KEY=           0x04,
-       STORE_OBJECT_TYPE_NUMBER=               0x05,
-       STORE_OBJECT_TYPE_NUM=                  0x05  /* The amount of known
+       STORE_OBJECT_TYPE_X509_CERTIFICATE=     0x01, /* X509 * */
+       STORE_OBJECT_TYPE_X509_CRL=             0x02, /* X509_CRL * */
+       STORE_OBJECT_TYPE_PRIVATE_KEY=          0x03, /* EVP_PKEY * */
+       STORE_OBJECT_TYPE_PUBLIC_KEY=           0x04, /* EVP_PKEY * */
+       STORE_OBJECT_TYPE_NUMBER=               0x05, /* BIGNUM * */
+       STORE_OBJECT_TYPE_ARBITRARY=            0x06, /* BUF_MEM * */
+       STORE_OBJECT_TYPE_NUM=                  0x06  /* The amount of known
                                                         object types */
        } STORE_OBJECT_TYPES;
 /* List of text strings corresponding to the object types. */
@@ -154,8 +155,10 @@ typedef enum STORE_params
        STORE_PARAM_EVP_TYPE=                   0x01, /* int */
        STORE_PARAM_BITS=                       0x02, /* size_t */
        STORE_PARAM_KEY_PARAMETERS=             0x03, /* ??? */
-       STORE_PARAM_KEY_NO_PARAMETERS=          0x04,  /* N/A */
-       STORE_PARAM_TYPE_NUM=                   0x04  /* The amount of known
+       STORE_PARAM_KEY_NO_PARAMETERS=          0x04, /* N/A */
+       STORE_PARAM_AUTH_PASSPHRASE=            0x05, /* char * */
+       STORE_PARAM_AUTH_KRB5_TICKET=           0x06, /* void * */
+       STORE_PARAM_TYPE_NUM=                   0x06  /* The amount of known
                                                         parameter types */
        } STORE_PARAM_TYPES;
 /* Parameter value sizes.  -1 means unknown, anything else is the required size. */
@@ -214,6 +217,7 @@ typedef struct STORE_OBJECT_st
                X509_CRL *crl;
                EVP_PKEY *key;
                BIGNUM *number;
+               BUF_MEM *arbitrary;
                } data;
        } STORE_OBJECT;
 DECLARE_STACK_OF(STORE_OBJECT);
@@ -224,58 +228,90 @@ void STORE_OBJECT_free(STORE_OBJECT *data);
 
 /* The following functions handle the storage. They return 0, a negative number
    or NULL on error, anything else on success. */
-X509 *STORE_get_certificate(STORE *e, OPENSSL_ITEM attributes[]);
-int STORE_store_certificate(STORE *e, X509 *data, OPENSSL_ITEM attributes[]);
+X509 *STORE_get_certificate(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+int STORE_store_certificate(STORE *e, X509 *data, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
 int STORE_modify_certificate(STORE *e, OPENSSL_ITEM search_attributes[],
        OPENSSL_ITEM add_attributes[], OPENSSL_ITEM modify_attributes[],
-       OPENSSL_ITEM delete_attributes[]);
-int STORE_revoke_certificate(STORE *e, OPENSSL_ITEM attributes[]);
-int STORE_delete_certificate(STORE *e, OPENSSL_ITEM attributes[]);
-void *STORE_list_certificate_start(STORE *e, OPENSSL_ITEM attributes[]);
+       OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
+int STORE_revoke_certificate(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+int STORE_delete_certificate(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+void *STORE_list_certificate_start(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
 X509 *STORE_list_certificate_next(STORE *e, void *handle);
 int STORE_list_certificate_end(STORE *e, void *handle);
 int STORE_list_certificate_endp(STORE *e, void *handle);
-EVP_PKEY *STORE_generate_key(STORE *e,
-       int evp_type, size_t bits, OPENSSL_ITEM attributes[]);
-EVP_PKEY *STORE_get_private_key(STORE *e, OPENSSL_ITEM attributes[]);
-int STORE_store_private_key(STORE *e, EVP_PKEY *data, OPENSSL_ITEM attributes[]);
+EVP_PKEY *STORE_generate_key(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+EVP_PKEY *STORE_get_private_key(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+int STORE_store_private_key(STORE *e, EVP_PKEY *data,
+       OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
 int STORE_modify_private_key(STORE *e, OPENSSL_ITEM search_attributes[],
        OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
-       OPENSSL_ITEM delete_attributes[]);
-int STORE_revoke_private_key(STORE *e, OPENSSL_ITEM attributes[]);
-int STORE_delete_private_key(STORE *e, OPENSSL_ITEM attributes[]);
-void *STORE_list_private_key_start(STORE *e, OPENSSL_ITEM attributes[]);
+       OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
+int STORE_revoke_private_key(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+int STORE_delete_private_key(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+void *STORE_list_private_key_start(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
 EVP_PKEY *STORE_list_private_key_next(STORE *e, void *handle);
 int STORE_list_private_key_end(STORE *e, void *handle);
 int STORE_list_private_key_endp(STORE *e, void *handle);
-EVP_PKEY *STORE_get_public_key(STORE *e, OPENSSL_ITEM attributes[]);
-int STORE_store_public_key(STORE *e, EVP_PKEY *data, OPENSSL_ITEM attributes[]);
+EVP_PKEY *STORE_get_public_key(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+int STORE_store_public_key(STORE *e, EVP_PKEY *data, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
 int STORE_modify_public_key(STORE *e, OPENSSL_ITEM search_attributes[],
        OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
-       OPENSSL_ITEM delete_attributes[]);
-int STORE_revoke_public_key(STORE *e, OPENSSL_ITEM attributes[]);
-int STORE_delete_public_key(STORE *e, OPENSSL_ITEM attributes[]);
-void *STORE_list_public_key_start(STORE *e, OPENSSL_ITEM attributes[]);
+       OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
+int STORE_revoke_public_key(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+int STORE_delete_public_key(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+void *STORE_list_public_key_start(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
 EVP_PKEY *STORE_list_public_key_next(STORE *e, void *handle);
 int STORE_list_public_key_end(STORE *e, void *handle);
 int STORE_list_public_key_endp(STORE *e, void *handle);
-X509_CRL *STORE_generate_crl(STORE *e, OPENSSL_ITEM attributes[]);
-X509_CRL *STORE_get_crl(STORE *e, OPENSSL_ITEM attributes[]);
-int STORE_store_crl(STORE *e, X509_CRL *data, OPENSSL_ITEM attributes[]);
+X509_CRL *STORE_generate_crl(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+X509_CRL *STORE_get_crl(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+int STORE_store_crl(STORE *e, X509_CRL *data, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
 int STORE_modify_crl(STORE *e, OPENSSL_ITEM search_attributes[],
        OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
-       OPENSSL_ITEM delete_attributes[]);
-int STORE_delete_crl(STORE *e, OPENSSL_ITEM attributes[]);
-void *STORE_list_crl_start(STORE *e, OPENSSL_ITEM attributes[]);
+       OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
+int STORE_delete_crl(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+void *STORE_list_crl_start(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
 X509_CRL *STORE_list_crl_next(STORE *e, void *handle);
 int STORE_list_crl_end(STORE *e, void *handle);
 int STORE_list_crl_endp(STORE *e, void *handle);
-int STORE_store_number(STORE *e, BIGNUM *data, OPENSSL_ITEM attributes[]);
+int STORE_store_number(STORE *e, BIGNUM *data, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
 int STORE_modify_number(STORE *e, OPENSSL_ITEM search_attributes[],
        OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
-       OPENSSL_ITEM delete_attributes[]);
-BIGNUM *STORE_get_number(STORE *e, OPENSSL_ITEM attributes[]);
-int STORE_delete_number(STORE *e, BIGNUM *data, OPENSSL_ITEM attributes[]);
+       OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
+BIGNUM *STORE_get_number(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+int STORE_delete_number(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+int STORE_store_arbitrary(STORE *e, BUF_MEM *data, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+int STORE_modify_arbitrary(STORE *e, OPENSSL_ITEM search_attributes[],
+       OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
+       OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
+BUF_MEM *STORE_get_arbitrary(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
+int STORE_delete_arbitrary(STORE *e, OPENSSL_ITEM attributes[],
+       OPENSSL_ITEM parameters[]);
 
 
 /* Create and manipulate methods */
@@ -285,15 +321,15 @@ void STORE_destroy_method(STORE_METHOD *store_method);
 /* These callback types are use for store handlers */
 typedef int (*STORE_INITIALISE_FUNC_PTR)(STORE *);
 typedef void (*STORE_CLEANUP_FUNC_PTR)(STORE *);
-typedef STORE_OBJECT *(*STORE_GENERATE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM parameters[], OPENSSL_ITEM attributes[]);
-typedef STORE_OBJECT *(*STORE_GET_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[]);
-typedef void *(*STORE_START_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[]);
+typedef STORE_OBJECT *(*STORE_GENERATE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
+typedef STORE_OBJECT *(*STORE_GET_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
+typedef void *(*STORE_START_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
 typedef STORE_OBJECT *(*STORE_NEXT_OBJECT_FUNC_PTR)(STORE *, void *handle);
 typedef int (*STORE_END_OBJECT_FUNC_PTR)(STORE *, void *handle);
-typedef int (*STORE_HANDLE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[]);
-typedef int (*STORE_STORE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, STORE_OBJECT *data, OPENSSL_ITEM attributes[]);
-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[]);
-typedef int (*STORE_GENERIC_FUNC_PTR)(STORE *, OPENSSL_ITEM attributes[]);
+typedef int (*STORE_HANDLE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
+typedef int (*STORE_STORE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, STORE_OBJECT *data, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
+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[]);
+typedef int (*STORE_GENERIC_FUNC_PTR)(STORE *, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
 typedef int (*STORE_CTRL_FUNC_PTR)(STORE *, int cmd, long l, void *p, void (*f)());
 
 int STORE_method_set_initialise_function(STORE_METHOD *sm, STORE_INITIALISE_FUNC_PTR gen_f);
@@ -394,6 +430,7 @@ void ERR_load_STORE_strings(void);
 #define STORE_F_MEM_LIST_NEXT                           136
 #define STORE_F_MEM_LIST_START                          137
 #define STORE_F_MEM_STORE                               138
+#define STORE_F_STORE_ARBITRARY                                 157
 #define STORE_F_STORE_ATTR_INFO_GET0_CSTR               139
 #define STORE_F_STORE_ATTR_INFO_GET0_DN                         140
 #define STORE_F_STORE_ATTR_INFO_GET0_NUMBER             141
@@ -408,6 +445,7 @@ void ERR_load_STORE_strings(void);
 #define STORE_F_STORE_ATTR_INFO_SET_SHA1STR             150
 #define STORE_F_STORE_CERTIFICATE                       100
 #define STORE_F_STORE_CRL                               101
+#define STORE_F_STORE_DELETE_ARBITRARY                  158
 #define STORE_F_STORE_DELETE_CERTIFICATE                102
 #define STORE_F_STORE_DELETE_CRL                        103
 #define STORE_F_STORE_DELETE_NUMBER                     104
@@ -415,6 +453,7 @@ void ERR_load_STORE_strings(void);
 #define STORE_F_STORE_DELETE_PUBLIC_KEY                         106
 #define STORE_F_STORE_GENERATE_CRL                      107
 #define STORE_F_STORE_GENERATE_KEY                      108
+#define STORE_F_STORE_GET_ARBITRARY                     159
 #define STORE_F_STORE_GET_CERTIFICATE                   109
 #define STORE_F_STORE_GET_CRL                           110
 #define STORE_F_STORE_GET_NUMBER                        111
@@ -449,11 +488,13 @@ void ERR_load_STORE_strings(void);
 
 /* Reason codes. */
 #define STORE_R_ALREADY_HAS_A_VALUE                     127
+#define STORE_R_FAILED_DELETING_ARBITRARY               132
 #define STORE_R_FAILED_DELETING_CERTIFICATE             100
 #define STORE_R_FAILED_DELETING_KEY                     101
 #define STORE_R_FAILED_DELETING_NUMBER                  102
 #define STORE_R_FAILED_GENERATING_CRL                   103
 #define STORE_R_FAILED_GENERATING_KEY                   104
+#define STORE_R_FAILED_GETTING_ARBITRARY                133
 #define STORE_R_FAILED_GETTING_CERTIFICATE              105
 #define STORE_R_FAILED_GETTING_KEY                      106
 #define STORE_R_FAILED_GETTING_NUMBER                   107
@@ -461,14 +502,17 @@ void ERR_load_STORE_strings(void);
 #define STORE_R_FAILED_LISTING_KEYS                     109
 #define STORE_R_FAILED_REVOKING_CERTIFICATE             110
 #define STORE_R_FAILED_REVOKING_KEY                     111
+#define STORE_R_FAILED_STORING_ARBITRARY                134
 #define STORE_R_FAILED_STORING_CERTIFICATE              112
 #define STORE_R_FAILED_STORING_KEY                      113
 #define STORE_R_FAILED_STORING_NUMBER                   114
 #define STORE_R_NOT_IMPLEMENTED                                 128
+#define STORE_R_NO_DELETE_ARBITRARY_FUNCTION            135
 #define STORE_R_NO_DELETE_NUMBER_FUNCTION               115
 #define STORE_R_NO_DELETE_OBJECT_FUNCTION               116
 #define STORE_R_NO_GENERATE_CRL_FUNCTION                117
 #define STORE_R_NO_GENERATE_OBJECT_FUNCTION             118
+#define STORE_R_NO_GET_OBJECT_ARBITRARY_FUNCTION        136
 #define STORE_R_NO_GET_OBJECT_FUNCTION                  119
 #define STORE_R_NO_GET_OBJECT_NUMBER_FUNCTION           120
 #define STORE_R_NO_LIST_OBJECT_ENDP_FUNCTION            131
@@ -477,6 +521,7 @@ void ERR_load_STORE_strings(void);
 #define STORE_R_NO_LIST_OBJECT_START_FUNCTION           123
 #define STORE_R_NO_REVOKE_OBJECT_FUNCTION               124
 #define STORE_R_NO_STORE                                129
+#define STORE_R_NO_STORE_OBJECT_ARBITRARY_FUNCTION      137
 #define STORE_R_NO_STORE_OBJECT_FUNCTION                125
 #define STORE_R_NO_STORE_OBJECT_NUMBER_FUNCTION                 126
 #define STORE_R_NO_VALUE                                130