Add engine table for EVP_PKEY_METHOD. Doesn't do much yet.
authorDr. Stephen Henson <steve@openssl.org>
Thu, 1 Jun 2006 11:38:50 +0000 (11:38 +0000)
committerDr. Stephen Henson <steve@openssl.org>
Thu, 1 Jun 2006 11:38:50 +0000 (11:38 +0000)
CHANGES
crypto/engine/Makefile
crypto/engine/eng_int.h
crypto/engine/engine.h
crypto/engine/tb_pkmeth.c [new file with mode: 0644]

diff --git a/CHANGES b/CHANGES
index a752832..e96dc43 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -4,6 +4,10 @@
 
  Changes between 0.9.8b and 0.9.9  [xx XXX xxxx]
 
+  *) Initial engine support for EVP_PKEY_METHOD. New functions to permit
+     an engine to register a method. 
+     [Steve Henson]
+
   *) New functions EVP_Digest{Sign,Verify)*. These are enchance versions of
      EVP_{Sign,Verify}* which allow an application to customise the signature
      process.
index 13f211a..8ef1b1b 100644 (file)
@@ -20,12 +20,12 @@ LIB=$(TOP)/libcrypto.a
 LIBSRC= eng_err.c eng_lib.c eng_list.c eng_init.c eng_ctrl.c \
        eng_table.c eng_pkey.c eng_fat.c eng_all.c \
        tb_rsa.c tb_dsa.c tb_ecdsa.c tb_dh.c tb_ecdh.c tb_rand.c tb_store.c \
-       tb_cipher.c tb_digest.c \
+       tb_cipher.c tb_digest.c tb_pkmeth.c \
        eng_openssl.c eng_cnf.c eng_dyn.c eng_cryptodev.c eng_padlock.c
 LIBOBJ= eng_err.o eng_lib.o eng_list.o eng_init.o eng_ctrl.o \
        eng_table.o eng_pkey.o eng_fat.o eng_all.o \
        tb_rsa.o tb_dsa.o tb_ecdsa.o tb_dh.o tb_ecdh.o tb_rand.o tb_store.o \
-       tb_cipher.o tb_digest.o \
+       tb_cipher.o tb_digest.o tb_pkmeth.o \
        eng_openssl.o eng_cnf.o eng_dyn.o eng_cryptodev.o eng_padlock.o
 
 SRC= $(LIBSRC)
index a5b1ede..1596bd8 100644 (file)
@@ -160,7 +160,8 @@ struct engine_st
        ENGINE_CIPHERS_PTR ciphers;
        /* Digest handling is via this callback */
        ENGINE_DIGESTS_PTR digests;
-
+       /* Public key handling via this callback */
+       ENGINE_PKEY_METHS_PTR pkey_meths;
 
        ENGINE_GEN_INT_FUNC_PTR destroy;
 
index 3ec5933..e68eafd 100644 (file)
@@ -292,7 +292,7 @@ typedef EVP_PKEY * (*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *,
  * parameter is non-NULL it is set to the size of the returned array. */
 typedef int (*ENGINE_CIPHERS_PTR)(ENGINE *, const EVP_CIPHER **, const int **, int);
 typedef int (*ENGINE_DIGESTS_PTR)(ENGINE *, const EVP_MD **, const int **, int);
-
+typedef int (*ENGINE_PKEY_METHS_PTR)(ENGINE *, const EVP_PKEY_METHOD **, const int **, int);
 /* STRUCTURE functions ... all of these functions deal with pointers to ENGINE
  * structures where the pointers have a "structural reference". This means that
  * their reference is to allowed access to the structure but it does not imply
@@ -384,6 +384,10 @@ int ENGINE_register_digests(ENGINE *e);
 void ENGINE_unregister_digests(ENGINE *e);
 void ENGINE_register_all_digests(void);
 
+int ENGINE_register_pkey_meths(ENGINE *e);
+void ENGINE_unregister_pkey_meths(ENGINE *e);
+void ENGINE_register_all_pkey_meths(void);
+
 /* These functions register all support from the above categories. Note, use of
  * these functions can result in static linkage of code your application may not
  * need. If you only need a subset of functionality, consider using more
@@ -496,8 +500,10 @@ ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e);
 ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e);
 ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e);
 ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e);
+ENGINE_PKEY_METHS_PTR ENGINE_get_pkey_meths(const ENGINE *e);
 const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid);
 const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid);
+const EVP_PKEY_METHOD *ENGINE_get_pkey_meth(ENGINE *e, int nid);
 const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e);
 int ENGINE_get_flags(const ENGINE *e);
 
diff --git a/crypto/engine/tb_pkmeth.c b/crypto/engine/tb_pkmeth.c
new file mode 100644 (file)
index 0000000..dfc7d0f
--- /dev/null
@@ -0,0 +1,143 @@
+/* ====================================================================
+ * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer. 
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. All advertising materials mentioning features or use of this
+ *    software must display the following acknowledgment:
+ *    "This product includes software developed by the OpenSSL Project
+ *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
+ *
+ * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
+ *    endorse or promote products derived from this software without
+ *    prior written permission. For written permission, please contact
+ *    licensing@OpenSSL.org.
+ *
+ * 5. Products derived from this software may not be called "OpenSSL"
+ *    nor may "OpenSSL" appear in their names without prior written
+ *    permission of the OpenSSL Project.
+ *
+ * 6. Redistributions of any form whatsoever must retain the following
+ *    acknowledgment:
+ *    "This product includes software developed by the OpenSSL Project
+ *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
+ * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This product includes cryptographic software written by Eric Young
+ * (eay@cryptsoft.com).  This product includes software written by Tim
+ * Hudson (tjh@cryptsoft.com).
+ *
+ */
+
+#include "eng_int.h"
+
+/* If this symbol is defined then ENGINE_get_pkey_meth_engine(), the function
+ * that is used by EVP to hook in pkey_meth code and cache defaults (etc), will
+ * display brief debugging summaries to stderr with the 'nid'. */
+/* #define ENGINE_PKEY_METH_DEBUG */
+
+static ENGINE_TABLE *pkey_meth_table = NULL;
+
+void ENGINE_unregister_pkey_meths(ENGINE *e)
+       {
+       engine_table_unregister(&pkey_meth_table, e);
+       }
+
+static void engine_unregister_all_pkey_meths(void)
+       {
+       engine_table_cleanup(&pkey_meth_table);
+       }
+
+int ENGINE_register_pkey_meths(ENGINE *e)
+       {
+       if(e->pkey_meths)
+               {
+               const int *nids;
+               int num_nids = e->pkey_meths(e, NULL, &nids, 0);
+               if(num_nids > 0)
+                       return engine_table_register(&pkey_meth_table,
+                               engine_unregister_all_pkey_meths, e, nids,
+                                       num_nids, 0);
+               }
+       return 1;
+       }
+
+void ENGINE_register_all_pkey_meths()
+       {
+       ENGINE *e;
+
+       for(e=ENGINE_get_first() ; e ; e=ENGINE_get_next(e))
+               ENGINE_register_pkey_meths(e);
+       }
+
+int ENGINE_set_default_pkey_meths(ENGINE *e)
+       {
+       if(e->pkey_meths)
+               {
+               const int *nids;
+               int num_nids = e->pkey_meths(e, NULL, &nids, 0);
+               if(num_nids > 0)
+                       return engine_table_register(&pkey_meth_table,
+                               engine_unregister_all_pkey_meths, e, nids,
+                                       num_nids, 1);
+               }
+       return 1;
+       }
+
+/* Exposed API function to get a functional reference from the implementation
+ * table (ie. try to get a functional reference from the tabled structural
+ * references) for a given pkey_meth 'nid' */
+ENGINE *ENGINE_get_pkey_meth_engine(int nid)
+       {
+       return engine_table_select(&pkey_meth_table, nid);
+       }
+
+/* Obtains a pkey_meth implementation from an ENGINE functional reference */
+const EVP_PKEY_METHOD *ENGINE_get_pkey_meth(ENGINE *e, int nid)
+       {
+       const EVP_PKEY_METHOD *ret;
+       ENGINE_PKEY_METHS_PTR fn = ENGINE_get_pkey_meths(e);
+       if(!fn || !fn(e, &ret, NULL, nid))
+               {
+               ENGINEerr(ENGINE_F_ENGINE_GET_CIPHER,
+                               ENGINE_R_UNIMPLEMENTED_CIPHER);
+               return NULL;
+               }
+       return ret;
+       }
+
+/* Gets the pkey_meth callback from an ENGINE structure */
+ENGINE_PKEY_METHS_PTR ENGINE_get_pkey_meths(const ENGINE *e)
+       {
+       return e->pkey_meths;
+       }
+
+/* Sets the pkey_meth callback in an ENGINE structure */
+int ENGINE_set_pkey_meths(ENGINE *e, ENGINE_PKEY_METHS_PTR f)
+       {
+       e->pkey_meths = f;
+       return 1;
+       }