Engine PKCS#11 initial commit
[keystone-linux/engine-pkcs11.git] / src / hw_pkcs11.c
1 /* crypto/engine/hw_pkcs11.c */
2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
3  * project 2000.
4  * Copied/modified by Kevin Stefanik (kstef@mtppi.org) for the OpenSC
5  * project 2003.
6  */
7 /* ====================================================================
8  * Copyright (c) 1999-2001 The OpenSSL Project.  All rights reserved.
9  * Portions Copyright (c) 2003 Kevin Stefanik (kstef@mtppi.org)
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  *
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in
20  *    the documentation and/or other materials provided with the
21  *    distribution.
22  *
23  * 3. All advertising materials mentioning features or use of this
24  *    software must display the following acknowledgment:
25  *    "This product includes software developed by the OpenSSL Project
26  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
27  *
28  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
29  *    endorse or promote products derived from this software without
30  *    prior written permission. For written permission, please contact
31  *    licensing@OpenSSL.org.
32  *
33  * 5. Products derived from this software may not be called "OpenSSL"
34  *    nor may "OpenSSL" appear in their names without prior written
35  *    permission of the OpenSSL Project.
36  *
37  * 6. Redistributions of any form whatsoever must retain the following
38  *    acknowledgment:
39  *    "This product includes software developed by the OpenSSL Project
40  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
41  *
42  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
43  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
45  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
46  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
48  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
49  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
51  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
52  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
53  * OF THE POSSIBILITY OF SUCH DAMAGE.
54  * ====================================================================
55  *
56  * This product includes cryptographic software written by Eric Young
57  * (eay@cryptsoft.com).  This product includes software written by Tim
58  * Hudson (tjh@cryptsoft.com).
59  *
60  */
62 #include <config.h>
63 #include <stdio.h>
64 #include <string.h>
65 #include <openssl/crypto.h>
66 #include <openssl/objects.h>
67 #include <openssl/engine.h>
68 #include <openssl/dso.h>
69 #ifndef ENGINE_CMD_BASE
70 #error did not get engine.h
71 #endif
72 #include <libp11.h>
73 #include "engine_pkcs11.h"
75 #define PKCS11_ENGINE_ID "pkcs11"
76 #define PKCS11_ENGINE_NAME "pkcs11 engine"
78 #define CMD_SO_PATH             ENGINE_CMD_BASE
79 #define CMD_MODULE_PATH         (ENGINE_CMD_BASE+1)
80 #define CMD_PIN         (ENGINE_CMD_BASE+2)
81 #define CMD_VERBOSE             (ENGINE_CMD_BASE+3)
82 #define CMD_QUIET               (ENGINE_CMD_BASE+4)
83 #define CMD_LOAD_CERT_CTRL      (ENGINE_CMD_BASE+5)
84 #define CMD_INIT_ARGS   (ENGINE_CMD_BASE+6)
86 static int pkcs11_engine_destroy(ENGINE * e);
87 static int pkcs11_engine_ctrl(ENGINE * e, int cmd, long i, void *p,
88                               void (*f) ());
90 /* The definitions for control commands specific to this engine */
92 /* need to add function to pass in reader id? or user reader:key as key id string? */
94 static const ENGINE_CMD_DEFN pkcs11_cmd_defns[] = {
95         {CMD_SO_PATH,
96          "SO_PATH",
97          "Specifies the path to the 'pkcs11-engine' shared library",
98          ENGINE_CMD_FLAG_STRING},
99         {CMD_MODULE_PATH,
100          "MODULE_PATH",
101          "Specifies the path to the pkcs11 module shared library",
102          ENGINE_CMD_FLAG_STRING},
103         {CMD_PIN,
104          "PIN",
105          "Specifies the pin code",
106          ENGINE_CMD_FLAG_STRING},
107         {CMD_VERBOSE,
108          "VERBOSE",
109          "Print additional details",
110          ENGINE_CMD_FLAG_NO_INPUT},
111         {CMD_QUIET,
112          "QUIET",
113          "Remove additional details",
114          ENGINE_CMD_FLAG_NO_INPUT},
115         {CMD_LOAD_CERT_CTRL,
116          "LOAD_CERT_CTRL",
117          "Get the certificate from card",
118          ENGINE_CMD_FLAG_INTERNAL},
119         {CMD_INIT_ARGS,
120          "INIT_ARGS",
121          "Specifies additional initialization arguments to the pkcs11 module",
122          ENGINE_CMD_FLAG_STRING},
123         {0, NULL, NULL, 0}
124 };
126 /* Destructor */
127 static int pkcs11_engine_destroy(ENGINE * e)
129         return 1;
132 static int pkcs11_engine_ctrl(ENGINE * e, int cmd, long i, void *p,
133                               void (*f) ())
135         /*int initialised = ((pkcs11_dso == NULL) ? 0 : 1); */
136         switch (cmd) {
137         case CMD_MODULE_PATH:
138                 return set_module((const char *)p);
139         case CMD_PIN:
140                 return set_pin((const char *)p);
141         case CMD_VERBOSE:
142                 return inc_verbose();
143         case CMD_LOAD_CERT_CTRL:
144                 return load_cert_ctrl(e, p);
145         case CMD_INIT_ARGS:
146                 return set_init_args((const char *)p);
147         default:
148                 break;
149         }
150         return 0;
153 #if 0
154 /* set up default rsa_meth_st with overloaded rsa functions */
155 /* the actual implementation needs to be in another object */
157 static int (*orig_finish) (RSA * rsa);
159 static int pkcs11_engine_rsa_finish(RSA * rsa)
162         pkcs11_rsa_finish(rsa);
164         if (orig_finish)
165                 orig_finish(rsa);
166         return 1;
169 #endif
171 /* This internal function is used by ENGINE_pkcs11() and possibly by the
172  * "dynamic" ENGINE support too */
173 static int bind_helper(ENGINE * e)
175         if (!ENGINE_set_id(e, PKCS11_ENGINE_ID) ||
176             !ENGINE_set_destroy_function(e, pkcs11_engine_destroy) ||
177             !ENGINE_set_init_function(e, pkcs11_init) ||
178             !ENGINE_set_finish_function(e, pkcs11_finish) ||
179             !ENGINE_set_ctrl_function(e, pkcs11_engine_ctrl) ||
180             !ENGINE_set_cmd_defns(e, pkcs11_cmd_defns) ||
181             !ENGINE_set_name(e, PKCS11_ENGINE_NAME) ||
182 #ifndef OPENSSL_NO_RSA
183             !ENGINE_set_RSA(e, PKCS11_get_rsa_method()) ||
184 #endif
185 #ifndef OPENSSL_NO_DSA
186             !ENGINE_set_DSA(e, DSA_get_default_method()) ||
187 #endif
188 #ifndef OPENSSL_NO_DH
189             !ENGINE_set_DH(e, DH_get_default_method()) ||
190 #endif
191             !ENGINE_set_RAND(e, RAND_SSLeay()) ||
192 #if 0
193             !ENGINE_set_BN_mod_exp(e, BN_mod_exp) ||
194 #endif
195             !ENGINE_set_load_pubkey_function(e, pkcs11_load_public_key) ||
196             !ENGINE_set_load_privkey_function(e, pkcs11_load_private_key)) {
197                 return 0;
198         } else {
199                 return 1;
200         }
203 static int bind_fn(ENGINE * e, const char *id)
205         if (id && (strcmp(id, PKCS11_ENGINE_ID) != 0)) {
206                 fprintf(stderr, "bad engine id\n");
207                 return 0;
208         }
209         if (!bind_helper(e)) {
210                 fprintf(stderr, "bind failed\n");
211                 return 0;
212         }
213         return 1;
216 IMPLEMENT_DYNAMIC_CHECK_FN();
217 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn);