2001-09-15 02:31:57 +08:00
|
|
|
/* crypto/engine/eng_int.h */
|
2000-10-27 05:07:28 +08:00
|
|
|
/* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
|
|
|
|
* project 2000.
|
|
|
|
*/
|
|
|
|
/* ====================================================================
|
2001-09-15 02:31:57 +08:00
|
|
|
* Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
|
2000-10-27 05:07:28 +08:00
|
|
|
*
|
|
|
|
* 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).
|
|
|
|
*
|
|
|
|
*/
|
2002-08-09 16:43:04 +08:00
|
|
|
/* ====================================================================
|
|
|
|
* Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
|
|
|
|
* ECDH support in OpenSSL originally developed by
|
|
|
|
* SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
|
|
|
|
*/
|
2000-10-27 05:07:28 +08:00
|
|
|
|
|
|
|
#ifndef HEADER_ENGINE_INT_H
|
|
|
|
#define HEADER_ENGINE_INT_H
|
|
|
|
|
2004-04-20 02:09:28 +08:00
|
|
|
#include "cryptlib.h"
|
2000-11-03 04:33:04 +08:00
|
|
|
/* Take public definitions from engine.h */
|
|
|
|
#include <openssl/engine.h>
|
|
|
|
|
2000-10-27 05:07:28 +08:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2001-04-27 07:04:30 +08:00
|
|
|
/* 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) \
|
2001-04-27 08:31:21 +08:00
|
|
|
fprintf(stderr, "engine: %08x %s from %d to %d (%s:%d)\n", \
|
2001-04-27 07:04:30 +08:00
|
|
|
(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
|
|
|
|
|
2001-09-26 04:00:51 +08:00
|
|
|
/* Any code that will need cleanup operations should use these functions to
|
|
|
|
* register callbacks. ENGINE_cleanup() will call all registered callbacks in
|
|
|
|
* order. NB: both the "add" functions assume CRYPTO_LOCK_ENGINE to already be
|
|
|
|
* held (in "write" mode). */
|
|
|
|
typedef void (ENGINE_CLEANUP_CB)(void);
|
2001-10-02 00:26:00 +08:00
|
|
|
typedef struct st_engine_cleanup_item
|
|
|
|
{
|
|
|
|
ENGINE_CLEANUP_CB *cb;
|
|
|
|
} ENGINE_CLEANUP_ITEM;
|
|
|
|
DECLARE_STACK_OF(ENGINE_CLEANUP_ITEM)
|
2001-09-26 04:00:51 +08:00
|
|
|
void engine_cleanup_add_first(ENGINE_CLEANUP_CB *cb);
|
|
|
|
void engine_cleanup_add_last(ENGINE_CLEANUP_CB *cb);
|
|
|
|
|
|
|
|
/* We need stacks of ENGINEs for use in eng_table.c */
|
|
|
|
DECLARE_STACK_OF(ENGINE)
|
|
|
|
|
|
|
|
/* If this symbol is defined then engine_table_select(), the function that is
|
|
|
|
* used by RSA, DSA (etc) code to select registered ENGINEs, cache defaults and
|
|
|
|
* functional references (etc), will display debugging summaries to stderr. */
|
|
|
|
/* #define ENGINE_TABLE_DEBUG */
|
|
|
|
|
|
|
|
/* This represents an implementation table. Dependent code should instantiate it
|
|
|
|
* as a (ENGINE_TABLE *) pointer value set initially to NULL. */
|
|
|
|
typedef struct st_engine_table ENGINE_TABLE;
|
|
|
|
int engine_table_register(ENGINE_TABLE **table, ENGINE_CLEANUP_CB *cleanup,
|
|
|
|
ENGINE *e, const int *nids, int num_nids, int setdefault);
|
|
|
|
void engine_table_unregister(ENGINE_TABLE **table, ENGINE *e);
|
|
|
|
void engine_table_cleanup(ENGINE_TABLE **table);
|
|
|
|
#ifndef ENGINE_TABLE_DEBUG
|
|
|
|
ENGINE *engine_table_select(ENGINE_TABLE **table, int nid);
|
|
|
|
#else
|
|
|
|
ENGINE *engine_table_select_tmp(ENGINE_TABLE **table, int nid, const char *f, int l);
|
|
|
|
#define engine_table_select(t,n) engine_table_select_tmp(t,n,__FILE__,__LINE__)
|
|
|
|
#endif
|
2007-11-22 01:25:58 +08:00
|
|
|
typedef void (engine_table_doall_cb)(int nid, STACK_OF(ENGINE) *sk, ENGINE *def, void *arg);
|
|
|
|
void engine_table_doall(ENGINE_TABLE *table, engine_table_doall_cb *cb, void *arg);
|
2001-08-18 18:22:54 +08:00
|
|
|
|
2001-09-26 04:00:51 +08:00
|
|
|
/* Internal versions of API functions that have control over locking. These are
|
|
|
|
* used between C files when functionality needs to be shared but the caller may
|
|
|
|
* already be controlling of the CRYPTO_LOCK_ENGINE lock. */
|
|
|
|
int engine_unlocked_init(ENGINE *e);
|
|
|
|
int engine_unlocked_finish(ENGINE *e, int unlock_for_handlers);
|
|
|
|
int engine_free_util(ENGINE *e, int locked);
|
2001-08-18 18:22:54 +08:00
|
|
|
|
2001-11-22 17:13:18 +08:00
|
|
|
/* This function will reset all "set"able values in an ENGINE to NULL. This
|
|
|
|
* won't touch reference counts or ex_data, but is equivalent to calling all the
|
|
|
|
* ENGINE_set_***() functions with a NULL value. */
|
|
|
|
void engine_set_all_null(ENGINE *e);
|
|
|
|
|
2001-04-18 11:03:16 +08:00
|
|
|
/* NB: Bitwise OR-able values for the "flags" variable in ENGINE are now exposed
|
|
|
|
* in engine.h. */
|
2000-10-27 05:07:28 +08:00
|
|
|
|
2006-06-03 01:09:17 +08:00
|
|
|
/* Free up dynamically allocated public key methods associated with ENGINE */
|
|
|
|
|
|
|
|
void engine_pkey_meths_free(ENGINE *e);
|
2006-06-05 19:52:46 +08:00
|
|
|
void engine_pkey_asn1_meths_free(ENGINE *e);
|
2006-06-03 01:09:17 +08:00
|
|
|
|
2000-10-27 05:07:28 +08:00
|
|
|
/* This is a structure for storing implementations of various crypto
|
|
|
|
* algorithms and functions. */
|
2000-11-03 04:33:04 +08:00
|
|
|
struct engine_st
|
2000-10-27 05:07:28 +08:00
|
|
|
{
|
|
|
|
const char *id;
|
|
|
|
const char *name;
|
2000-11-07 06:15:50 +08:00
|
|
|
const RSA_METHOD *rsa_meth;
|
2000-11-07 21:54:39 +08:00
|
|
|
const DSA_METHOD *dsa_meth;
|
2000-11-07 22:30:37 +08:00
|
|
|
const DH_METHOD *dh_meth;
|
2002-08-09 16:43:04 +08:00
|
|
|
const ECDH_METHOD *ecdh_meth;
|
2002-02-14 02:21:51 +08:00
|
|
|
const ECDSA_METHOD *ecdsa_meth;
|
2001-04-18 10:01:36 +08:00
|
|
|
const RAND_METHOD *rand_meth;
|
2003-05-01 11:57:46 +08:00
|
|
|
const STORE_METHOD *store_meth;
|
2001-09-26 05:28:40 +08:00
|
|
|
/* Cipher handling is via this callback */
|
|
|
|
ENGINE_CIPHERS_PTR ciphers;
|
|
|
|
/* Digest handling is via this callback */
|
|
|
|
ENGINE_DIGESTS_PTR digests;
|
2006-06-01 19:38:50 +08:00
|
|
|
/* Public key handling via this callback */
|
|
|
|
ENGINE_PKEY_METHS_PTR pkey_meths;
|
2006-06-03 01:52:27 +08:00
|
|
|
/* ASN1 public key handling via this callback */
|
|
|
|
ENGINE_PKEY_ASN1_METHS_PTR pkey_asn1_meths;
|
2001-08-18 18:22:54 +08:00
|
|
|
|
2001-09-06 02:32:23 +08:00
|
|
|
ENGINE_GEN_INT_FUNC_PTR destroy;
|
2001-09-26 04:00:51 +08:00
|
|
|
|
2001-04-18 11:57:05 +08:00
|
|
|
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;
|
2001-08-18 18:22:54 +08:00
|
|
|
|
2008-06-02 05:10:30 +08:00
|
|
|
ENGINE_SSL_CLIENT_CERT_PTR load_ssl_client_cert;
|
|
|
|
|
Some BIG tweaks to ENGINE code.
This change adds some new functionality to the ENGINE code and API to
make it possible for ENGINEs to describe and implement their own control
commands that can be interrogated and used by calling applications at
run-time. The source code includes numerous comments explaining how it all
works and some of the finer details. But basically, an ENGINE will normally
declare an array of ENGINE_CMD_DEFN entries in its ENGINE - and the various
new ENGINE_CTRL_*** command types take care of iterating through this list
of definitions, converting command numbers to names, command names to
numbers, getting descriptions, getting input flags, etc. These
administrative commands are handled directly in the base ENGINE code rather
than in each ENGINE's ctrl() handler, unless they specify the
ENGINE_FLAGS_MANUAL_CMD_CTRL flag (ie. if they're doing something clever or
dynamic with the command definitions).
There is also a new function, ENGINE_cmd_is_executable(), that will
determine if an ENGINE control command is of an "executable" type that
can be used in another new function, ENGINE_ctrl_cmd_string(). If not, the
control command is not supposed to be exposed out to user/config level
access - eg. it could involve the exchange of binary data, returning
results to calling code, etc etc. If the command is executable then
ENGINE_ctrl_cmd_string() can be called using a name/arg string pair. The
control command's input flags will be used to determine necessary
conversions before the control command is called, and commands of this
form will always return zero or one (failure or success, respectively).
This is set up so that arbitrary applications can support control commands
in a consistent way so that tweaking particular ENGINE behaviour is
specific to the ENGINE and the host environment, and independant of the
application or OpenSSL.
Some code demonstrating this stuff in action will applied shortly to the
various ENGINE implementations, as well as "openssl engine" support for
executing arbitrary control commands before and/or after initialising
various ENGINEs.
2001-04-19 08:41:55 +08:00
|
|
|
const ENGINE_CMD_DEFN *cmd_defns;
|
2000-10-27 05:07:28 +08:00
|
|
|
int flags;
|
|
|
|
/* reference count on the structure itself */
|
|
|
|
int struct_ref;
|
|
|
|
/* reference count on usability of the engine type. NB: This
|
|
|
|
* controls the loading and initialisation of any functionlity
|
|
|
|
* required by this engine, whereas the previous count is
|
|
|
|
* simply to cope with (de)allocation of this structure. Hence,
|
|
|
|
* running_ref <= struct_ref at all times. */
|
|
|
|
int funct_ref;
|
2001-09-26 05:28:40 +08:00
|
|
|
/* A place to store per-ENGINE data */
|
This adds 2 things to the ENGINE code.
* "ex_data" - a CRYPTO_EX_DATA structure in the ENGINE structure itself
that allows an ENGINE to store its own information there rather than in
global variables. It follows the declarations and implementations used
in RSA code, for better or worse. However there's a problem when storing
state with ENGINEs because, unlike related structure types in OpenSSL,
there is no ENGINE-vs-ENGINE_METHOD separation. Because of what ENGINE
is, it has method pointers as its structure elements ... which leads
to;
* ENGINE_FLAGS_BY_ID_COPY - if an ENGINE should not be used just as a
reference to an "implementation" (eg. to get to a hardware device), but
should also be able to maintain state, then this flag can be set by the
ENGINE implementation. The result is that any call to ENGINE_by_id()
will not result in the existing ENGINE being returned (with its
structural reference count incremented) but instead a new copy of the
ENGINE will be returned that can maintain its own state independantly of
any other copies returned in the past or future. Eg. key-generation
might involve a series of ENGINE-specific control commands to set
algorithms, sizes, module-keys, ids, ACLs, etc. A final command could
generate the key. An ENGINE doing this would *have* to declare
ENGINE_FLAGS_BY_ID_COPY so that the state of that process can be
maintained "per-handle" and unaffected by other code having a reference
to the same ENGINE structure.
2001-04-27 03:35:44 +08:00
|
|
|
CRYPTO_EX_DATA ex_data;
|
2000-10-27 05:07:28 +08:00
|
|
|
/* Used to maintain the linked-list of engines. */
|
|
|
|
struct engine_st *prev;
|
|
|
|
struct engine_st *next;
|
2000-11-03 04:33:04 +08:00
|
|
|
};
|
2000-10-27 05:07:28 +08:00
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* HEADER_ENGINE_INT_H */
|