Reduce header interdependencies, initially in engine.h (the rest of the
[openssl.git] / crypto / store / store.h
index c1cbb399f9db999f708bba320c4a51a751f1e95f..40fb38fc43932f13a81332a6fb55c145d7460b72 100644 (file)
@@ -59,6 +59,7 @@
 #ifndef HEADER_STORE_H
 #define HEADER_STORE_H
 
+#include <openssl/ossl_typ.h>
 #include <openssl/x509.h>
 #include <openssl/evp.h>
 #include <openssl/bn.h>
 extern "C" {
 #endif
 
-/* The STORE type is a per-store context that holds all the necessary data
-   to perform all the supported storage operations. */
-typedef struct store_st STORE;
-
-/* All instances of STORE have a reference to a method structure, which is a
-   ordered vector of functions that implement the lower level things to do.
-   There is an instruction on the implementation further down, in the section
-   for method implementors. */
-typedef struct store_method_st STORE_METHOD;
+/* Already defined in ossl_typ.h */
+/* typedef struct store_st STORE; */
+/* typedef struct store_method_st STORE_METHOD; */
 
 
 /* All the following functions return 0, a negative number or NULL on error.
@@ -91,7 +86,7 @@ void STORE_free(STORE *ui);
 /* Give a user interface parametrised control commands.  This can be used to
    send down an integer, a data pointer or a function pointer, as well as
    be used to get information from a STORE. */
-int STORE_ctrl(STORE *store, int cmd, long i, void *p, void (*f)());
+int STORE_ctrl(STORE *store, int cmd, long i, void *p, void (*f)(void));
 
 /* A control to set the directory with keys and certificates.  Used by the
    built-in directory level method. */
@@ -123,6 +118,7 @@ const STORE_METHOD *STORE_set_method(STORE *store, const STORE_METHOD *meth);
    and is of course volatile.  It's used by other methods that have an in-memory
    cache. */
 const STORE_METHOD *STORE_Memory(void);
+#if 0 /* Not yet implemented */
 /* This is the directory store.  It does everything except revoking and updating,
    and uses STORE_Memory() to cache things in memory. */
 const STORE_METHOD *STORE_Directory(void);
@@ -130,7 +126,7 @@ const STORE_METHOD *STORE_Directory(void);
    and uses STORE_Memory() to cache things in memory.  Certificates are added
    to it with the store operation, and it will only get cached certificates. */
 const STORE_METHOD *STORE_File(void);
-
+#endif
 
 /* Store functions take a type code for the type of data they should store
    or fetch */
@@ -331,11 +327,11 @@ typedef int (*STORE_HANDLE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OP
 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)());
+typedef int (*STORE_CTRL_FUNC_PTR)(STORE *, int cmd, long l, void *p, void (*f)(void));
 
-int STORE_method_set_initialise_function(STORE_METHOD *sm, STORE_INITIALISE_FUNC_PTR gen_f);
-int STORE_method_set_cleanup_function(STORE_METHOD *sm, STORE_CLEANUP_FUNC_PTR gen_f);
-int STORE_method_set_generate_function(STORE_METHOD *sm, STORE_GENERATE_OBJECT_FUNC_PTR gen_f);
+int STORE_method_set_initialise_function(STORE_METHOD *sm, STORE_INITIALISE_FUNC_PTR init_f);
+int STORE_method_set_cleanup_function(STORE_METHOD *sm, STORE_CLEANUP_FUNC_PTR clean_f);
+int STORE_method_set_generate_function(STORE_METHOD *sm, STORE_GENERATE_OBJECT_FUNC_PTR generate_f);
 int STORE_method_set_get_function(STORE_METHOD *sm, STORE_GET_OBJECT_FUNC_PTR get_f);
 int STORE_method_set_store_function(STORE_METHOD *sm, STORE_STORE_OBJECT_FUNC_PTR store_f);
 int STORE_method_set_modify_function(STORE_METHOD *sm, STORE_MODIFY_OBJECT_FUNC_PTR store_f);
@@ -411,6 +407,9 @@ int STORE_ATTR_INFO_modify_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
 /* Compare on basis of a bit pattern formed by the STORE_ATTR_TYPES values
    in each contained attribute. */
 int STORE_ATTR_INFO_compare(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
+/* Check if the set of attributes in a is within the range of attributes
+   set in b. */
+int STORE_ATTR_INFO_in_range(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
 /* Check if the set of attributes in a are also set in b. */
 int STORE_ATTR_INFO_in(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
 /* Same as STORE_ATTR_INFO_in(), but also checks the attribute values. */
@@ -426,6 +425,7 @@ void ERR_load_STORE_strings(void);
 /* Error codes for the STORE functions. */
 
 /* Function codes. */
+#define STORE_F_CTRL                                    160
 #define STORE_F_MEM_DELETE                              134
 #define STORE_F_MEM_GENERATE                            135
 #define STORE_F_MEM_LIST_NEXT                           136
@@ -446,6 +446,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_CTRL                              161
 #define STORE_F_STORE_DELETE_ARBITRARY                  158
 #define STORE_F_STORE_DELETE_CERTIFICATE                102
 #define STORE_F_STORE_DELETE_CRL                        103
@@ -476,6 +477,12 @@ void ERR_load_STORE_strings(void);
 #define STORE_F_STORE_LIST_PUBLIC_KEY_ENDP              156
 #define STORE_F_STORE_LIST_PUBLIC_KEY_NEXT              124
 #define STORE_F_STORE_LIST_PUBLIC_KEY_START             125
+#define STORE_F_STORE_MODIFY_ARBITRARY                  162
+#define STORE_F_STORE_MODIFY_CERTIFICATE                163
+#define STORE_F_STORE_MODIFY_CRL                        164
+#define STORE_F_STORE_MODIFY_NUMBER                     165
+#define STORE_F_STORE_MODIFY_PRIVATE_KEY                166
+#define STORE_F_STORE_MODIFY_PUBLIC_KEY                         167
 #define STORE_F_STORE_NEW_ENGINE                        133
 #define STORE_F_STORE_NEW_METHOD                        132
 #define STORE_F_STORE_NUMBER                            126
@@ -501,6 +508,12 @@ void ERR_load_STORE_strings(void);
 #define STORE_R_FAILED_GETTING_NUMBER                   107
 #define STORE_R_FAILED_LISTING_CERTIFICATES             108
 #define STORE_R_FAILED_LISTING_KEYS                     109
+#define STORE_R_FAILED_MODIFYING_ARBITRARY              138
+#define STORE_R_FAILED_MODIFYING_CERTIFICATE            139
+#define STORE_R_FAILED_MODIFYING_CRL                    140
+#define STORE_R_FAILED_MODIFYING_NUMBER                         141
+#define STORE_R_FAILED_MODIFYING_PRIVATE_KEY            142
+#define STORE_R_FAILED_MODIFYING_PUBLIC_KEY             143
 #define STORE_R_FAILED_REVOKING_CERTIFICATE             110
 #define STORE_R_FAILED_REVOKING_KEY                     111
 #define STORE_R_FAILED_STORING_ARBITRARY                134
@@ -508,6 +521,7 @@ void ERR_load_STORE_strings(void);
 #define STORE_R_FAILED_STORING_KEY                      113
 #define STORE_R_FAILED_STORING_NUMBER                   114
 #define STORE_R_NOT_IMPLEMENTED                                 128
+#define STORE_R_NO_CONTROL_FUNCTION                     144
 #define STORE_R_NO_DELETE_ARBITRARY_FUNCTION            135
 #define STORE_R_NO_DELETE_NUMBER_FUNCTION               115
 #define STORE_R_NO_DELETE_OBJECT_FUNCTION               116
@@ -520,6 +534,7 @@ void ERR_load_STORE_strings(void);
 #define STORE_R_NO_LIST_OBJECT_END_FUNCTION             121
 #define STORE_R_NO_LIST_OBJECT_NEXT_FUNCTION            122
 #define STORE_R_NO_LIST_OBJECT_START_FUNCTION           123
+#define STORE_R_NO_MODIFY_OBJECT_FUNCTION               145
 #define STORE_R_NO_REVOKE_OBJECT_FUNCTION               124
 #define STORE_R_NO_STORE                                129
 #define STORE_R_NO_STORE_OBJECT_ARBITRARY_FUNCTION      137