Some fixes to the reference-counting in ENGINE code. First, there were a

[openssl.git] / crypto / engine / engine_int.h

diff --git a/crypto/engine/engine_int.h b/crypto/engine/engine_int.h
index b04067992b9eb70e962fdf9decf4cd7026b2dea7..54cfe47af70f6320204f5700445898d87498cc02 100644 (file)
--- a/crypto/engine/engine_int.h
+++ b/crypto/engine/engine_int.h
@@ -59,13 +59,6 @@
 #ifndef HEADER_ENGINE_INT_H
 #define HEADER_ENGINE_INT_H
 
-#include <openssl/rsa.h>
-#include <openssl/dsa.h>
-#include <openssl/dh.h>
-#include <openssl/rand.h>
-#include <openssl/bn.h>
-#include <openssl/evp.h>
-
 /* Take public definitions from engine.h */
 #include <openssl/engine.h>
 
@@ -73,8 +66,31 @@
 extern "C" {
 #endif
 
-/* Bitwise OR-able values for the "flags" variable in ENGINE. */
-#define ENGINE_FLAGS_MALLOCED  0x0001
+#define ENGINE_REF_COUNT_DEBUG
+
+/* If we compile with this symbol defined, then both reference counts in the
+ * ENGINE structure will be monitored with a line of output on stderr for each
+ * change. This prints the engine's pointer address (truncated to unsigned int),
+ * "struct" or "funct" to indicate the reference type, the before and after
+ * reference count, and the file:line-number pair. The "engine_ref_debug"
+ * statements must come *after* the change. */
+#ifdef ENGINE_REF_COUNT_DEBUG
+
+#define engine_ref_debug(e, isfunct, diff) \
+       fprintf(stderr, "blargle: %08x %s from %d to %d (%s:%d)\n", \
+               (unsigned int)(e), (isfunct ? "funct" : "struct"), \
+               ((isfunct) ? ((e)->funct_ref - (diff)) : ((e)->struct_ref - (diff))), \
+               ((isfunct) ? (e)->funct_ref : (e)->struct_ref), \
+               (__FILE__), (__LINE__));
+
+#else
+
+#define engine_ref_debug(e, isfunct, diff)
+
+#endif
+
+/* NB: Bitwise OR-able values for the "flags" variable in ENGINE are now exposed
+ * in engine.h. */
 
 /* This is a structure for storing implementations of various crypto
  * algorithms and functions. */
@@ -85,14 +101,15 @@ struct engine_st
        const RSA_METHOD *rsa_meth;
        const DSA_METHOD *dsa_meth;
        const DH_METHOD *dh_meth;
-       RAND_METHOD *rand_meth;
+       const RAND_METHOD *rand_meth;
        BN_MOD_EXP bn_mod_exp;
        BN_MOD_EXP_CRT bn_mod_exp_crt;
-       int (*init)(void);
-       int (*finish)(void);
-       int (*ctrl)(int cmd, long i, void *p, void (*f)());
-       EVP_PKEY *(*load_privkey)(const char *key_id, const char *passphrase);
-       EVP_PKEY *(*load_pubkey)(const char *key_id, const char *passphrase);
+       ENGINE_GEN_INT_FUNC_PTR init;
+       ENGINE_GEN_INT_FUNC_PTR finish;
+       ENGINE_CTRL_FUNC_PTR ctrl;
+       ENGINE_LOAD_KEY_PTR load_privkey;
+       ENGINE_LOAD_KEY_PTR load_pubkey;
+       const ENGINE_CMD_DEFN *cmd_defns;
        int flags;
        /* reference count on the structure itself */
        int struct_ref;
@@ -102,6 +119,8 @@ struct engine_st
         * simply to cope with (de)allocation of this structure. Hence,
         * running_ref <= struct_ref at all times. */
        int funct_ref;
+       /* A place to store per-key data */
+       CRYPTO_EX_DATA ex_data;
        /* Used to maintain the linked-list of engines. */
        struct engine_st *prev;
        struct engine_st *next;
@@ -113,29 +132,33 @@ struct engine_st
 /* Returns a structure of software only methods (the default). */
 ENGINE *ENGINE_openssl();
 
-#ifndef NO_HW
+#ifndef OPENSSL_NO_HW
 
-#ifndef NO_HW_CSWIFT
+#ifndef OPENSSL_NO_HW_CSWIFT
 /* Returns a structure of cswift methods ... NB: This can exist and be
  * "used" even on non-cswift systems because the "init" will fail if the
  * card/library are not found. */
 ENGINE *ENGINE_cswift();
-#endif /* !NO_HW_CSWIFT */
+#endif /* !OPENSSL_NO_HW_CSWIFT */
 
-#ifndef NO_HW_NCIPHER
+#ifndef OPENSSL_NO_HW_NCIPHER
 ENGINE *ENGINE_ncipher();
-#endif /* !NO_HW_NCIPHER */
+#endif /* !OPENSSL_NO_HW_NCIPHER */
 
-#ifndef NO_HW_ATALLA
+#ifndef OPENSSL_NO_HW_ATALLA
 /* Returns a structure of atalla methods. */
 ENGINE *ENGINE_atalla();
-#endif /* !NO_HW_ATALLA */
+#endif /* !OPENSSL_NO_HW_ATALLA */
 
-#ifndef NO_HW_NURON
+#ifndef OPENSSL_NO_HW_NURON
 ENGINE *ENGINE_nuron();
-#endif /* !NO_HW_NURON */
+#endif /* !OPENSSL_NO_HW_NURON */
+
+#ifndef OPENSSL_NO_HW_UBSEC
+ENGINE *ENGINE_ubsec();
+#endif /* !OPENSSL_NO_HW_UBSEC */
 
-#endif /* !NO_HW */
+#endif /* !OPENSSL_NO_HW */
 
 #ifdef  __cplusplus
 }