547893fdd9b3d783037d1c0a7abc059c312b96eb
[openssl.git] / crypto / engine / engine_int.h
1 /* crypto/engine/engine_int.h */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
3  * project 2000.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58
59 #ifndef HEADER_ENGINE_INT_H
60 #define HEADER_ENGINE_INT_H
61
62 #include <openssl/rsa.h>
63 #include <openssl/dsa.h>
64 #include <openssl/dh.h>
65 #include <openssl/rand.h>
66 #include <openssl/bn.h>
67 #include <openssl/evp.h>
68
69 /* Take public definitions from engine.h */
70 #include <openssl/engine.h>
71
72 #ifdef  __cplusplus
73 extern "C" {
74 #endif
75
76 /* Bitwise OR-able values for the "flags" variable in ENGINE. */
77 #define ENGINE_FLAGS_MALLOCED   0x0001
78
79 /* This is a structure for storing implementations of various crypto
80  * algorithms and functions. */
81 struct engine_st
82         {
83         const char *id;
84         const char *name;
85         const RSA_METHOD *rsa_meth;
86         const DSA_METHOD *dsa_meth;
87         DH_METHOD *dh_meth;
88         RAND_METHOD *rand_meth;
89         BN_MOD_EXP bn_mod_exp;
90         BN_MOD_EXP_CRT bn_mod_exp_crt;
91         int (*init)(void);
92         int (*finish)(void);
93         int (*ctrl)(int cmd, long i, void *p, void (*f)());
94         EVP_PKEY *(*load_privkey)(const char *key_id, const char *passphrase);
95         EVP_PKEY *(*load_pubkey)(const char *key_id, const char *passphrase);
96         int flags;
97         /* reference count on the structure itself */
98         int struct_ref;
99         /* reference count on usability of the engine type. NB: This
100          * controls the loading and initialisation of any functionlity
101          * required by this engine, whereas the previous count is
102          * simply to cope with (de)allocation of this structure. Hence,
103          * running_ref <= struct_ref at all times. */
104         int funct_ref;
105         /* Used to maintain the linked-list of engines. */
106         struct engine_st *prev;
107         struct engine_st *next;
108         };
109
110 /* BUILT-IN ENGINES. (these functions are only ever called once and
111  * do not return references - they are purely for bootstrapping). */
112
113 /* Returns a structure of software only methods (the default). */
114 ENGINE *ENGINE_openssl();
115
116 #ifndef NO_HW
117
118 #ifndef NO_HW_CSWIFT
119 /* Returns a structure of cswift methods ... NB: This can exist and be
120  * "used" even on non-cswift systems because the "init" will fail if the
121  * card/library are not found. */
122 ENGINE *ENGINE_cswift();
123 #endif /* !NO_HW_CSWIFT */
124
125 #ifndef NO_HW_NCIPHER
126 ENGINE *ENGINE_ncipher();
127 #endif /* !NO_HW_NCIPHER */
128
129 #ifndef NO_HW_ATALLA
130 /* Returns a structure of atalla methods. */
131 ENGINE *ENGINE_atalla();
132 #endif /* !NO_HW_ATALLA */
133
134 #ifndef NO_HW_NURON
135 ENGINE *ENGINE_nuron();
136 #endif /* !NO_HW_NURON */
137
138 #endif /* !NO_HW */
139
140 #ifdef  __cplusplus
141 }
142 #endif
143
144 #endif /* HEADER_ENGINE_INT_H */