1 /* crypto/engine/e_chil.c */
3 * Written by Richard Levitte (richard@levitte.org), Geoff Thorpe
4 * (geoff@geoffthorpe.net) and Dr Stephen N Henson (steve@openssl.org) for
5 * the OpenSSL project 2000.
7 /* ====================================================================
8 * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in
19 * the documentation and/or other materials provided with the
22 * 3. All advertising materials mentioning features or use of this
23 * software must display the following acknowledgment:
24 * "This product includes software developed by the OpenSSL Project
25 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
27 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
28 * endorse or promote products derived from this software without
29 * prior written permission. For written permission, please contact
30 * licensing@OpenSSL.org.
32 * 5. Products derived from this software may not be called "OpenSSL"
33 * nor may "OpenSSL" appear in their names without prior written
34 * permission of the OpenSSL Project.
36 * 6. Redistributions of any form whatsoever must retain the following
38 * "This product includes software developed by the OpenSSL Project
39 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
41 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
42 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
44 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
47 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
48 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
50 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
51 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
52 * OF THE POSSIBILITY OF SUCH DAMAGE.
53 * ====================================================================
55 * This product includes cryptographic software written by Eric Young
56 * (eay@cryptsoft.com). This product includes software written by Tim
57 * Hudson (tjh@cryptsoft.com).
63 #include <openssl/crypto.h>
64 #include <openssl/pem.h>
65 #include <openssl/dso.h>
66 #include <openssl/engine.h>
67 #include <openssl/ui.h>
68 #include <openssl/rand.h>
69 #ifndef OPENSSL_NO_RSA
70 # include <openssl/rsa.h>
73 # include <openssl/dh.h>
75 #include <openssl/bn.h>
78 # ifndef OPENSSL_NO_HW_CHIL
81 * Attribution notice: nCipher have said several times that it's OK for
82 * us to implement a general interface to their boxes, and recently declared
83 * their HWCryptoHook to be public, and therefore available for us to use.
86 * The hwcryptohook.h included here is from May 2000.
90 # include "hwcryptohook.h"
92 # include "vendor_defns/hwcryptohook.h"
95 # define HWCRHK_LIB_NAME "CHIL engine"
96 # include "e_chil_err.c"
98 static int hwcrhk_destroy(ENGINE *e);
99 static int hwcrhk_init(ENGINE *e);
100 static int hwcrhk_finish(ENGINE *e);
101 static int hwcrhk_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
103 /* Functions to handle mutexes */
104 static int hwcrhk_mutex_init(HWCryptoHook_Mutex *,
105 HWCryptoHook_CallerContext *);
106 static int hwcrhk_mutex_lock(HWCryptoHook_Mutex *);
107 static void hwcrhk_mutex_unlock(HWCryptoHook_Mutex *);
108 static void hwcrhk_mutex_destroy(HWCryptoHook_Mutex *);
111 static int hwcrhk_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
112 const BIGNUM *m, BN_CTX *ctx);
114 # ifndef OPENSSL_NO_RSA
116 static int hwcrhk_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa,
118 /* This function is aliased to mod_exp (with the mont stuff dropped). */
119 static int hwcrhk_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
120 const BIGNUM *m, BN_CTX *ctx,
122 static int hwcrhk_rsa_finish(RSA *rsa);
125 # ifndef OPENSSL_NO_DH
127 /* This function is alised to mod_exp (with the DH and mont dropped). */
128 static int hwcrhk_mod_exp_dh(const DH *dh, BIGNUM *r,
129 const BIGNUM *a, const BIGNUM *p,
130 const BIGNUM *m, BN_CTX *ctx,
135 static int hwcrhk_rand_bytes(unsigned char *buf, int num);
136 static int hwcrhk_rand_status(void);
139 static EVP_PKEY *hwcrhk_load_privkey(ENGINE *eng, const char *key_id,
140 UI_METHOD *ui_method,
141 void *callback_data);
142 static EVP_PKEY *hwcrhk_load_pubkey(ENGINE *eng, const char *key_id,
143 UI_METHOD *ui_method,
144 void *callback_data);
146 /* Interaction stuff */
147 static int hwcrhk_insert_card(const char *prompt_info,
148 const char *wrong_info,
149 HWCryptoHook_PassphraseContext * ppctx,
150 HWCryptoHook_CallerContext * cactx);
151 static int hwcrhk_get_pass(const char *prompt_info,
152 int *len_io, char *buf,
153 HWCryptoHook_PassphraseContext * ppctx,
154 HWCryptoHook_CallerContext * cactx);
155 static void hwcrhk_log_message(void *logstr, const char *message);
157 /* The definitions for control commands specific to this engine */
158 # define HWCRHK_CMD_SO_PATH ENGINE_CMD_BASE
159 # define HWCRHK_CMD_FORK_CHECK (ENGINE_CMD_BASE + 1)
160 # define HWCRHK_CMD_THREAD_LOCKING (ENGINE_CMD_BASE + 2)
161 # define HWCRHK_CMD_SET_USER_INTERFACE (ENGINE_CMD_BASE + 3)
162 # define HWCRHK_CMD_SET_CALLBACK_DATA (ENGINE_CMD_BASE + 4)
163 static const ENGINE_CMD_DEFN hwcrhk_cmd_defns[] = {
166 "Specifies the path to the 'hwcrhk' shared library",
167 ENGINE_CMD_FLAG_STRING},
168 {HWCRHK_CMD_FORK_CHECK,
170 "Turns fork() checking on (non-zero) or off (zero)",
171 ENGINE_CMD_FLAG_NUMERIC},
172 {HWCRHK_CMD_THREAD_LOCKING,
174 "Turns thread-safe locking on (zero) or off (non-zero)",
175 ENGINE_CMD_FLAG_NUMERIC},
176 {HWCRHK_CMD_SET_USER_INTERFACE,
177 "SET_USER_INTERFACE",
178 "Set the global user interface (internal)",
179 ENGINE_CMD_FLAG_INTERNAL},
180 {HWCRHK_CMD_SET_CALLBACK_DATA,
182 "Set the global user interface extra data (internal)",
183 ENGINE_CMD_FLAG_INTERNAL},
187 # ifndef OPENSSL_NO_RSA
188 /* Our internal RSA_METHOD that we provide pointers to */
189 static RSA_METHOD hwcrhk_rsa = {
207 # ifndef OPENSSL_NO_DH
208 /* Our internal DH_METHOD that we provide pointers to */
209 static DH_METHOD hwcrhk_dh = {
222 static RAND_METHOD hwcrhk_rand = {
223 /* "CHIL RAND method", */
232 /* Constants used when creating the ENGINE */
233 static const char *engine_hwcrhk_id = "chil";
234 static const char *engine_hwcrhk_name = "CHIL hardware engine support";
235 # ifndef OPENSSL_NO_DYNAMIC_ENGINE
236 /* Compatibility hack, the dynamic library uses this form in the path */
237 static const char *engine_hwcrhk_id_alt = "ncipher";
240 /* Internal stuff for HWCryptoHook */
242 /* Some structures needed for proper use of thread locks */
244 * hwcryptohook.h has some typedefs that turn struct HWCryptoHook_MutexValue
245 * into HWCryptoHook_Mutex
247 struct HWCryptoHook_MutexValue {
252 * hwcryptohook.h has some typedefs that turn struct
253 * HWCryptoHook_PassphraseContextValue into HWCryptoHook_PassphraseContext
255 struct HWCryptoHook_PassphraseContextValue {
256 UI_METHOD *ui_method;
261 * hwcryptohook.h has some typedefs that turn struct
262 * HWCryptoHook_CallerContextValue into HWCryptoHook_CallerContext
264 struct HWCryptoHook_CallerContextValue {
265 pem_password_cb *password_callback; /* Deprecated! Only present for
266 * backward compatibility! */
267 UI_METHOD *ui_method;
272 * The MPI structure in HWCryptoHook is pretty compatible with OpenSSL
273 * BIGNUM's, so lets define a couple of conversion macros
275 # define BN2MPI(mp, bn) \
276 {mp.size = bn->top * sizeof(BN_ULONG); mp.buf = (unsigned char *)bn->d;}
277 # define MPI2BN(bn, mp) \
278 {mp.size = bn->dmax * sizeof(BN_ULONG); mp.buf = (unsigned char *)bn->d;}
280 static BIO *logstream = NULL;
281 static int disable_mutex_callbacks = 0;
284 * One might wonder why these are needed, since one can pass down at least a
285 * UI_METHOD and a pointer to callback data to the key-loading functions. The
286 * thing is that the ModExp and RSAImmed functions can load keys as well, if
287 * the data they get is in a special, nCipher-defined format (hint: if you
288 * look at the private exponent of the RSA data as a string, you'll see this
289 * string: "nCipher KM tool key id", followed by some bytes, followed a key
290 * identity string, followed by more bytes. This happens when you use
291 * "embed" keys instead of "hwcrhk" keys). Unfortunately, those functions do
292 * not take any passphrase or caller context, and our functions can't really
293 * take any callback data either. Still, the "insert_card" and
294 * "get_passphrase" callbacks may be called down the line, and will need to
295 * know what user interface callbacks to call, and having callback data from
296 * the application may be a nice thing as well, so we need to keep track of
299 static HWCryptoHook_CallerContext password_context = { NULL, NULL, NULL };
301 /* Stuff to pass to the HWCryptoHook library */
302 static HWCryptoHook_InitInfo hwcrhk_globals = {
303 HWCryptoHook_InitFlags_SimpleForkCheck, /* Flags */
304 &logstream, /* logstream */
305 sizeof(BN_ULONG), /* limbsize */
306 0, /* mslimb first: false for BNs */
307 -1, /* msbyte first: use native */
308 0, /* Max mutexes, 0 = no small limit */
309 0, /* Max simultaneous, 0 = default */
312 * The next few are mutex stuff: we write wrapper functions around the OS
313 * mutex functions. We initialise them to 0 here, and change that to
314 * actual function pointers in hwcrhk_init() if dynamic locks are
315 * supported (that is, if the application programmer has made sure of
316 * setting up callbacks bafore starting this engine) *and* if
317 * disable_mutex_callbacks hasn't been set by a call to
318 * ENGINE_ctrl(ENGINE_CTRL_CHIL_NO_LOCKING).
320 sizeof(HWCryptoHook_Mutex),
327 * The next few are condvar stuff: we write wrapper functions round the
328 * OS functions. Currently not implemented and not and absolute
329 * necessity even in threaded programs, therefore 0'ed. Will hopefully
330 * be implemented some day, since it enhances the efficiency of
333 0, /* sizeof(HWCryptoHook_CondVar), */
334 0, /* hwcrhk_cv_init, */
335 0, /* hwcrhk_cv_wait, */
336 0, /* hwcrhk_cv_signal, */
337 0, /* hwcrhk_cv_broadcast, */
338 0, /* hwcrhk_cv_destroy, */
340 hwcrhk_get_pass, /* pass phrase */
341 hwcrhk_insert_card, /* insert a card */
342 hwcrhk_log_message /* Log message */
345 /* Now, to our own code */
348 * This internal function is used by ENGINE_chil() and possibly by the
349 * "dynamic" ENGINE support too
351 static int bind_helper(ENGINE *e)
353 # ifndef OPENSSL_NO_RSA
354 const RSA_METHOD *meth1;
356 # ifndef OPENSSL_NO_DH
357 const DH_METHOD *meth2;
359 if (!ENGINE_set_id(e, engine_hwcrhk_id) ||
360 !ENGINE_set_name(e, engine_hwcrhk_name) ||
361 # ifndef OPENSSL_NO_RSA
362 !ENGINE_set_RSA(e, &hwcrhk_rsa) ||
364 # ifndef OPENSSL_NO_DH
365 !ENGINE_set_DH(e, &hwcrhk_dh) ||
367 !ENGINE_set_RAND(e, &hwcrhk_rand) ||
368 !ENGINE_set_destroy_function(e, hwcrhk_destroy) ||
369 !ENGINE_set_init_function(e, hwcrhk_init) ||
370 !ENGINE_set_finish_function(e, hwcrhk_finish) ||
371 !ENGINE_set_ctrl_function(e, hwcrhk_ctrl) ||
372 !ENGINE_set_load_privkey_function(e, hwcrhk_load_privkey) ||
373 !ENGINE_set_load_pubkey_function(e, hwcrhk_load_pubkey) ||
374 !ENGINE_set_cmd_defns(e, hwcrhk_cmd_defns))
377 # ifndef OPENSSL_NO_RSA
379 * We know that the "PKCS1_SSLeay()" functions hook properly to the
380 * cswift-specific mod_exp and mod_exp_crt so we use those functions. NB:
381 * We don't use ENGINE_openssl() or anything "more generic" because
382 * something like the RSAref code may not hook properly, and if you own
383 * one of these cards then you have the right to do RSA operations on it
386 meth1 = RSA_PKCS1_SSLeay();
387 hwcrhk_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
388 hwcrhk_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
389 hwcrhk_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
390 hwcrhk_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
393 # ifndef OPENSSL_NO_DH
394 /* Much the same for Diffie-Hellman */
395 meth2 = DH_OpenSSL();
396 hwcrhk_dh.generate_key = meth2->generate_key;
397 hwcrhk_dh.compute_key = meth2->compute_key;
400 /* Ensure the hwcrhk error handling is set up */
401 ERR_load_HWCRHK_strings();
405 # ifdef OPENSSL_NO_DYNAMIC_ENGINE
406 static ENGINE *engine_chil(void)
408 ENGINE *ret = ENGINE_new();
411 if (!bind_helper(ret)) {
418 void ENGINE_load_chil(void)
420 /* Copied from eng_[openssl|dyn].c */
421 ENGINE *toadd = engine_chil();
431 * This is a process-global DSO handle used for loading and unloading the
432 * HWCryptoHook library. NB: This is only set (or unset) during an init() or
433 * finish() call (reference counts permitting) and they're operating with
434 * global locks, so this should be thread-safe implicitly.
436 static DSO *hwcrhk_dso = NULL;
437 static HWCryptoHook_ContextHandle hwcrhk_context = 0;
438 # ifndef OPENSSL_NO_RSA
439 /* Index for KM handle. Not really used yet. */
440 static int hndidx_rsa = -1;
444 * These are the function pointers that are (un)set when the library has
445 * successfully (un)loaded.
447 static HWCryptoHook_Init_t *p_hwcrhk_Init = NULL;
448 static HWCryptoHook_Finish_t *p_hwcrhk_Finish = NULL;
449 static HWCryptoHook_ModExp_t *p_hwcrhk_ModExp = NULL;
450 # ifndef OPENSSL_NO_RSA
451 static HWCryptoHook_RSA_t *p_hwcrhk_RSA = NULL;
453 static HWCryptoHook_RandomBytes_t *p_hwcrhk_RandomBytes = NULL;
454 # ifndef OPENSSL_NO_RSA
455 static HWCryptoHook_RSALoadKey_t *p_hwcrhk_RSALoadKey = NULL;
456 static HWCryptoHook_RSAGetPublicKey_t *p_hwcrhk_RSAGetPublicKey = NULL;
457 static HWCryptoHook_RSAUnloadKey_t *p_hwcrhk_RSAUnloadKey = NULL;
459 static HWCryptoHook_ModExpCRT_t *p_hwcrhk_ModExpCRT = NULL;
461 /* Used in the DSO operations. */
462 static const char *HWCRHK_LIBNAME = NULL;
463 static void free_HWCRHK_LIBNAME(void)
466 OPENSSL_free((void *)HWCRHK_LIBNAME);
467 HWCRHK_LIBNAME = NULL;
470 static const char *get_HWCRHK_LIBNAME(void)
473 return HWCRHK_LIBNAME;
477 static long set_HWCRHK_LIBNAME(const char *name)
479 free_HWCRHK_LIBNAME();
480 return (((HWCRHK_LIBNAME = BUF_strdup(name)) != NULL) ? 1 : 0);
483 static const char *n_hwcrhk_Init = "HWCryptoHook_Init";
484 static const char *n_hwcrhk_Finish = "HWCryptoHook_Finish";
485 static const char *n_hwcrhk_ModExp = "HWCryptoHook_ModExp";
486 # ifndef OPENSSL_NO_RSA
487 static const char *n_hwcrhk_RSA = "HWCryptoHook_RSA";
489 static const char *n_hwcrhk_RandomBytes = "HWCryptoHook_RandomBytes";
490 # ifndef OPENSSL_NO_RSA
491 static const char *n_hwcrhk_RSALoadKey = "HWCryptoHook_RSALoadKey";
492 static const char *n_hwcrhk_RSAGetPublicKey = "HWCryptoHook_RSAGetPublicKey";
493 static const char *n_hwcrhk_RSAUnloadKey = "HWCryptoHook_RSAUnloadKey";
495 static const char *n_hwcrhk_ModExpCRT = "HWCryptoHook_ModExpCRT";
498 * HWCryptoHook library functions and mechanics - these are used by the
499 * higher-level functions further down. NB: As and where there's no error
500 * checking, take a look lower down where these functions are called, the
501 * checking and error handling is probably down there.
504 /* utility function to obtain a context */
505 static int get_context(HWCryptoHook_ContextHandle * hac,
506 HWCryptoHook_CallerContext * cac)
509 HWCryptoHook_ErrMsgBuf rmsg;
512 rmsg.size = sizeof(tempbuf);
514 *hac = p_hwcrhk_Init(&hwcrhk_globals, sizeof(hwcrhk_globals), &rmsg, cac);
520 /* similarly to release one. */
521 static void release_context(HWCryptoHook_ContextHandle hac)
523 p_hwcrhk_Finish(hac);
526 /* Destructor (complements the "ENGINE_chil()" constructor) */
527 static int hwcrhk_destroy(ENGINE *e)
529 free_HWCRHK_LIBNAME();
530 ERR_unload_HWCRHK_strings();
534 /* (de)initialisation functions. */
535 static int hwcrhk_init(ENGINE *e)
537 HWCryptoHook_Init_t *p1;
538 HWCryptoHook_Finish_t *p2;
539 HWCryptoHook_ModExp_t *p3;
540 # ifndef OPENSSL_NO_RSA
541 HWCryptoHook_RSA_t *p4;
542 HWCryptoHook_RSALoadKey_t *p5;
543 HWCryptoHook_RSAGetPublicKey_t *p6;
544 HWCryptoHook_RSAUnloadKey_t *p7;
546 HWCryptoHook_RandomBytes_t *p8;
547 HWCryptoHook_ModExpCRT_t *p9;
549 if (hwcrhk_dso != NULL) {
550 HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_ALREADY_LOADED);
553 /* Attempt to load libnfhwcrhk.so/nfhwcrhk.dll/whatever. */
554 hwcrhk_dso = DSO_load(NULL, get_HWCRHK_LIBNAME(), NULL, 0);
555 if (hwcrhk_dso == NULL) {
556 HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_DSO_FAILURE);
559 if (!(p1 = (HWCryptoHook_Init_t *)
560 DSO_bind_func(hwcrhk_dso, n_hwcrhk_Init)) ||
561 !(p2 = (HWCryptoHook_Finish_t *)
562 DSO_bind_func(hwcrhk_dso, n_hwcrhk_Finish)) ||
563 !(p3 = (HWCryptoHook_ModExp_t *)
564 DSO_bind_func(hwcrhk_dso, n_hwcrhk_ModExp)) ||
565 # ifndef OPENSSL_NO_RSA
566 !(p4 = (HWCryptoHook_RSA_t *)
567 DSO_bind_func(hwcrhk_dso, n_hwcrhk_RSA)) ||
568 !(p5 = (HWCryptoHook_RSALoadKey_t *)
569 DSO_bind_func(hwcrhk_dso, n_hwcrhk_RSALoadKey)) ||
570 !(p6 = (HWCryptoHook_RSAGetPublicKey_t *)
571 DSO_bind_func(hwcrhk_dso, n_hwcrhk_RSAGetPublicKey)) ||
572 !(p7 = (HWCryptoHook_RSAUnloadKey_t *)
573 DSO_bind_func(hwcrhk_dso, n_hwcrhk_RSAUnloadKey)) ||
575 !(p8 = (HWCryptoHook_RandomBytes_t *)
576 DSO_bind_func(hwcrhk_dso, n_hwcrhk_RandomBytes)) ||
577 !(p9 = (HWCryptoHook_ModExpCRT_t *)
578 DSO_bind_func(hwcrhk_dso, n_hwcrhk_ModExpCRT))) {
579 HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_DSO_FAILURE);
582 /* Copy the pointers */
584 p_hwcrhk_Finish = p2;
585 p_hwcrhk_ModExp = p3;
586 # ifndef OPENSSL_NO_RSA
588 p_hwcrhk_RSALoadKey = p5;
589 p_hwcrhk_RSAGetPublicKey = p6;
590 p_hwcrhk_RSAUnloadKey = p7;
592 p_hwcrhk_RandomBytes = p8;
593 p_hwcrhk_ModExpCRT = p9;
596 * Check if the application decided to support dynamic locks, and if it
599 if (disable_mutex_callbacks == 0) {
600 if (CRYPTO_get_dynlock_create_callback() != NULL &&
601 CRYPTO_get_dynlock_lock_callback() != NULL &&
602 CRYPTO_get_dynlock_destroy_callback() != NULL) {
603 hwcrhk_globals.mutex_init = hwcrhk_mutex_init;
604 hwcrhk_globals.mutex_acquire = hwcrhk_mutex_lock;
605 hwcrhk_globals.mutex_release = hwcrhk_mutex_unlock;
606 hwcrhk_globals.mutex_destroy = hwcrhk_mutex_destroy;
611 * Try and get a context - if not, we may have a DSO but no accelerator!
613 if (!get_context(&hwcrhk_context, &password_context)) {
614 HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_UNIT_FAILURE);
617 /* Everything's fine. */
618 # ifndef OPENSSL_NO_RSA
619 if (hndidx_rsa == -1)
620 hndidx_rsa = RSA_get_ex_new_index(0,
621 "nFast HWCryptoHook RSA key handle",
627 DSO_free(hwcrhk_dso);
629 p_hwcrhk_Init = NULL;
630 p_hwcrhk_Finish = NULL;
631 p_hwcrhk_ModExp = NULL;
632 # ifndef OPENSSL_NO_RSA
634 p_hwcrhk_RSALoadKey = NULL;
635 p_hwcrhk_RSAGetPublicKey = NULL;
636 p_hwcrhk_RSAUnloadKey = NULL;
638 p_hwcrhk_ModExpCRT = NULL;
639 p_hwcrhk_RandomBytes = NULL;
643 static int hwcrhk_finish(ENGINE *e)
646 free_HWCRHK_LIBNAME();
647 if (hwcrhk_dso == NULL) {
648 HWCRHKerr(HWCRHK_F_HWCRHK_FINISH, HWCRHK_R_NOT_LOADED);
652 release_context(hwcrhk_context);
653 if (!DSO_free(hwcrhk_dso)) {
654 HWCRHKerr(HWCRHK_F_HWCRHK_FINISH, HWCRHK_R_DSO_FAILURE);
662 p_hwcrhk_Init = NULL;
663 p_hwcrhk_Finish = NULL;
664 p_hwcrhk_ModExp = NULL;
665 # ifndef OPENSSL_NO_RSA
667 p_hwcrhk_RSALoadKey = NULL;
668 p_hwcrhk_RSAGetPublicKey = NULL;
669 p_hwcrhk_RSAUnloadKey = NULL;
671 p_hwcrhk_ModExpCRT = NULL;
672 p_hwcrhk_RandomBytes = NULL;
676 static int hwcrhk_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
681 case HWCRHK_CMD_SO_PATH:
683 HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, HWCRHK_R_ALREADY_LOADED);
687 HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, ERR_R_PASSED_NULL_PARAMETER);
690 return set_HWCRHK_LIBNAME((const char *)p);
691 case ENGINE_CTRL_SET_LOGSTREAM:
695 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
700 if (CRYPTO_add(&bio->references, 1, CRYPTO_LOCK_BIO) > 1)
703 HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, HWCRHK_R_BIO_WAS_FREED);
705 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
707 case ENGINE_CTRL_SET_PASSWORD_CALLBACK:
708 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
709 password_context.password_callback = (pem_password_cb *)f;
710 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
712 case ENGINE_CTRL_SET_USER_INTERFACE:
713 case HWCRHK_CMD_SET_USER_INTERFACE:
714 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
715 password_context.ui_method = (UI_METHOD *)p;
716 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
718 case ENGINE_CTRL_SET_CALLBACK_DATA:
719 case HWCRHK_CMD_SET_CALLBACK_DATA:
720 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
721 password_context.callback_data = p;
722 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
725 * this enables or disables the "SimpleForkCheck" flag used in the
726 * initialisation structure.
728 case ENGINE_CTRL_CHIL_SET_FORKCHECK:
729 case HWCRHK_CMD_FORK_CHECK:
730 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
732 hwcrhk_globals.flags |= HWCryptoHook_InitFlags_SimpleForkCheck;
734 hwcrhk_globals.flags &= ~HWCryptoHook_InitFlags_SimpleForkCheck;
735 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
738 * This will prevent the initialisation function from "installing"
739 * the mutex-handling callbacks, even if they are available from
740 * within the library (or were provided to the library from the
741 * calling application). This is to remove any baggage for
742 * applications not using multithreading.
744 case ENGINE_CTRL_CHIL_NO_LOCKING:
745 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
746 disable_mutex_callbacks = 1;
747 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
749 case HWCRHK_CMD_THREAD_LOCKING:
750 CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
751 disable_mutex_callbacks = ((i == 0) ? 0 : 1);
752 CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
755 /* The command isn't understood by this engine */
757 HWCRHKerr(HWCRHK_F_HWCRHK_CTRL,
758 HWCRHK_R_CTRL_COMMAND_NOT_IMPLEMENTED);
766 static EVP_PKEY *hwcrhk_load_privkey(ENGINE *eng, const char *key_id,
767 UI_METHOD *ui_method,
770 # ifndef OPENSSL_NO_RSA
773 EVP_PKEY *res = NULL;
774 # ifndef OPENSSL_NO_RSA
775 HWCryptoHook_MPI e, n;
776 HWCryptoHook_RSAKeyHandle *hptr;
778 # if !defined(OPENSSL_NO_RSA)
780 HWCryptoHook_ErrMsgBuf rmsg;
781 HWCryptoHook_PassphraseContext ppctx;
784 # if !defined(OPENSSL_NO_RSA)
786 rmsg.size = sizeof(tempbuf);
789 if (!hwcrhk_context) {
790 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_NOT_INITIALISED);
793 # ifndef OPENSSL_NO_RSA
794 hptr = OPENSSL_malloc(sizeof(HWCryptoHook_RSAKeyHandle));
796 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, ERR_R_MALLOC_FAILURE);
799 ppctx.ui_method = ui_method;
800 ppctx.callback_data = callback_data;
801 if (p_hwcrhk_RSALoadKey(hwcrhk_context, key_id, hptr, &rmsg, &ppctx)) {
802 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
803 ERR_add_error_data(1, rmsg.buf);
807 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_NO_KEY);
811 # ifndef OPENSSL_NO_RSA
812 rtmp = RSA_new_method(eng);
814 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, ERR_R_MALLOC_FAILURE);
817 RSA_set_ex_data(rtmp, hndidx_rsa, (char *)hptr);
820 if (rtmp->e == NULL || rtmp->n == NULL) {
821 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, ERR_R_MALLOC_FAILURE);
824 rtmp->flags |= RSA_FLAG_EXT_PKEY;
827 if (p_hwcrhk_RSAGetPublicKey(*hptr, &n, &e, &rmsg)
828 != HWCRYPTOHOOK_ERROR_MPISIZE) {
829 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
830 ERR_add_error_data(1, rmsg.buf);
834 if (bn_expand2(rtmp->e, e.size / sizeof(BN_ULONG)) == NULL) {
835 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, ERR_R_MALLOC_FAILURE);
838 if (bn_expand2(rtmp->n, n.size / sizeof(BN_ULONG)) == NULL) {
839 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, ERR_R_MALLOC_FAILURE);
845 if (p_hwcrhk_RSAGetPublicKey(*hptr, &n, &e, &rmsg)) {
846 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
847 ERR_add_error_data(1, rmsg.buf);
850 rtmp->e->top = e.size / sizeof(BN_ULONG);
852 rtmp->n->top = n.size / sizeof(BN_ULONG);
855 res = EVP_PKEY_new();
857 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
860 EVP_PKEY_assign_RSA(res, rtmp);
864 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY,
865 HWCRHK_R_PRIVATE_KEY_ALGORITHMS_DISABLED);
869 # ifndef OPENSSL_NO_RSA
876 static EVP_PKEY *hwcrhk_load_pubkey(ENGINE *eng, const char *key_id,
877 UI_METHOD *ui_method, void *callback_data)
879 EVP_PKEY *res = NULL;
881 # ifndef OPENSSL_NO_RSA
882 res = hwcrhk_load_privkey(eng, key_id, ui_method, callback_data);
887 # ifndef OPENSSL_NO_RSA
892 CRYPTO_w_lock(CRYPTO_LOCK_EVP_PKEY);
894 res->pkey.rsa = RSA_new();
895 res->pkey.rsa->n = rsa->n;
896 res->pkey.rsa->e = rsa->e;
899 CRYPTO_w_unlock(CRYPTO_LOCK_EVP_PKEY);
905 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PUBKEY,
906 HWCRHK_R_CTRL_COMMAND_NOT_IMPLEMENTED);
917 /* A little mod_exp */
918 static int hwcrhk_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
919 const BIGNUM *m, BN_CTX *ctx)
922 HWCryptoHook_ErrMsgBuf rmsg;
924 * Since HWCryptoHook_MPI is pretty compatible with BIGNUM's, we use them
925 * directly, plus a little macro magic. We only thing we need to make
926 * sure of is that enough space is allocated.
928 HWCryptoHook_MPI m_a, m_p, m_n, m_r;
931 to_return = 0; /* expect failure */
933 rmsg.size = sizeof(tempbuf);
935 if (!hwcrhk_context) {
936 HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_NOT_INITIALISED);
939 /* Prepare the params */
940 if (bn_expand2(r, m->top) == NULL) { /* Check for error !! */
941 HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, ERR_R_MALLOC_FAILURE);
949 /* Perform the operation */
950 ret = p_hwcrhk_ModExp(hwcrhk_context, m_a, m_p, m_n, &m_r, &rmsg);
952 /* Convert the response */
953 r->top = m_r.size / sizeof(BN_ULONG);
958 * FIXME: When this error is returned, HWCryptoHook is telling us
959 * that falling back to software computation might be a good thing.
961 if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
962 HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_REQUEST_FALLBACK);
964 HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_REQUEST_FAILED);
966 ERR_add_error_data(1, rmsg.buf);
975 # ifndef OPENSSL_NO_RSA
976 static int hwcrhk_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa,
980 HWCryptoHook_ErrMsgBuf rmsg;
981 HWCryptoHook_RSAKeyHandle *hptr;
982 int to_return = 0, ret;
985 rmsg.size = sizeof(tempbuf);
987 if (!hwcrhk_context) {
988 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP, HWCRHK_R_NOT_INITIALISED);
993 * This provides support for nForce keys. Since that's opaque data all
994 * we do is provide a handle to the proper key and let HWCryptoHook take
998 (HWCryptoHook_RSAKeyHandle *) RSA_get_ex_data(rsa, hndidx_rsa))
1000 HWCryptoHook_MPI m_a, m_r;
1003 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1004 HWCRHK_R_MISSING_KEY_COMPONENTS);
1008 /* Prepare the params */
1009 if (bn_expand2(r, rsa->n->top) == NULL) { /* Check for error !! */
1010 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP, ERR_R_MALLOC_FAILURE);
1016 /* Perform the operation */
1017 ret = p_hwcrhk_RSA(m_a, *hptr, &m_r, &rmsg);
1019 /* Convert the response */
1020 r->top = m_r.size / sizeof(BN_ULONG);
1025 * FIXME: When this error is returned, HWCryptoHook is telling us
1026 * that falling back to software computation might be a good
1029 if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
1030 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1031 HWCRHK_R_REQUEST_FALLBACK);
1033 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1034 HWCRHK_R_REQUEST_FAILED);
1036 ERR_add_error_data(1, rmsg.buf);
1040 HWCryptoHook_MPI m_a, m_p, m_q, m_dmp1, m_dmq1, m_iqmp, m_r;
1042 if (!rsa->p || !rsa->q || !rsa->dmp1 || !rsa->dmq1 || !rsa->iqmp) {
1043 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1044 HWCRHK_R_MISSING_KEY_COMPONENTS);
1048 /* Prepare the params */
1049 if (bn_expand2(r, rsa->n->top) == NULL) { /* Check for error !! */
1050 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP, ERR_R_MALLOC_FAILURE);
1054 BN2MPI(m_p, rsa->p);
1055 BN2MPI(m_q, rsa->q);
1056 BN2MPI(m_dmp1, rsa->dmp1);
1057 BN2MPI(m_dmq1, rsa->dmq1);
1058 BN2MPI(m_iqmp, rsa->iqmp);
1061 /* Perform the operation */
1062 ret = p_hwcrhk_ModExpCRT(hwcrhk_context, m_a, m_p, m_q,
1063 m_dmp1, m_dmq1, m_iqmp, &m_r, &rmsg);
1065 /* Convert the response */
1066 r->top = m_r.size / sizeof(BN_ULONG);
1071 * FIXME: When this error is returned, HWCryptoHook is telling us
1072 * that falling back to software computation might be a good
1075 if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
1076 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1077 HWCRHK_R_REQUEST_FALLBACK);
1079 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1080 HWCRHK_R_REQUEST_FAILED);
1082 ERR_add_error_data(1, rmsg.buf);
1087 * If we're here, we must be here with some semblance of success :-)
1095 # ifndef OPENSSL_NO_RSA
1096 /* This function is aliased to mod_exp (with the mont stuff dropped). */
1097 static int hwcrhk_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
1098 const BIGNUM *m, BN_CTX *ctx,
1101 return hwcrhk_mod_exp(r, a, p, m, ctx);
1104 static int hwcrhk_rsa_finish(RSA *rsa)
1106 HWCryptoHook_RSAKeyHandle *hptr;
1108 hptr = RSA_get_ex_data(rsa, hndidx_rsa);
1110 p_hwcrhk_RSAUnloadKey(*hptr, NULL);
1112 RSA_set_ex_data(rsa, hndidx_rsa, NULL);
1119 # ifndef OPENSSL_NO_DH
1120 /* This function is aliased to mod_exp (with the dh and mont dropped). */
1121 static int hwcrhk_mod_exp_dh(const DH *dh, BIGNUM *r,
1122 const BIGNUM *a, const BIGNUM *p,
1123 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
1125 return hwcrhk_mod_exp(r, a, p, m, ctx);
1129 /* Random bytes are good */
1130 static int hwcrhk_rand_bytes(unsigned char *buf, int num)
1133 HWCryptoHook_ErrMsgBuf rmsg;
1134 int to_return = 0; /* assume failure */
1138 rmsg.size = sizeof(tempbuf);
1140 if (!hwcrhk_context) {
1141 HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_NOT_INITIALISED);
1145 ret = p_hwcrhk_RandomBytes(hwcrhk_context, buf, num, &rmsg);
1148 * FIXME: When this error is returned, HWCryptoHook is telling us
1149 * that falling back to software computation might be a good thing.
1151 if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
1152 HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_REQUEST_FALLBACK);
1154 HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_REQUEST_FAILED);
1156 ERR_add_error_data(1, rmsg.buf);
1164 static int hwcrhk_rand_status(void)
1170 * Mutex calls: since the HWCryptoHook model closely follows the POSIX model
1171 * these just wrap the POSIX functions and add some logging.
1174 static int hwcrhk_mutex_init(HWCryptoHook_Mutex * mt,
1175 HWCryptoHook_CallerContext * cactx)
1177 mt->lockid = CRYPTO_get_new_dynlockid();
1178 if (mt->lockid == 0)
1179 return 1; /* failure */
1180 return 0; /* success */
1183 static int hwcrhk_mutex_lock(HWCryptoHook_Mutex * mt)
1185 CRYPTO_w_lock(mt->lockid);
1189 static void hwcrhk_mutex_unlock(HWCryptoHook_Mutex * mt)
1191 CRYPTO_w_unlock(mt->lockid);
1194 static void hwcrhk_mutex_destroy(HWCryptoHook_Mutex * mt)
1196 CRYPTO_destroy_dynlockid(mt->lockid);
1199 static int hwcrhk_get_pass(const char *prompt_info,
1200 int *len_io, char *buf,
1201 HWCryptoHook_PassphraseContext * ppctx,
1202 HWCryptoHook_CallerContext * cactx)
1204 pem_password_cb *callback = NULL;
1205 void *callback_data = NULL;
1206 UI_METHOD *ui_method = NULL;
1208 * Despite what the documentation says prompt_info can be an empty
1211 if (prompt_info && !*prompt_info)
1215 if (cactx->ui_method)
1216 ui_method = cactx->ui_method;
1217 if (cactx->password_callback)
1218 callback = cactx->password_callback;
1219 if (cactx->callback_data)
1220 callback_data = cactx->callback_data;
1223 if (ppctx->ui_method) {
1224 ui_method = ppctx->ui_method;
1227 if (ppctx->callback_data)
1228 callback_data = ppctx->callback_data;
1230 if (callback == NULL && ui_method == NULL) {
1231 HWCRHKerr(HWCRHK_F_HWCRHK_GET_PASS, HWCRHK_R_NO_CALLBACK);
1236 UI *ui = UI_new_method(ui_method);
1239 char *prompt = UI_construct_prompt(ui,
1240 "pass phrase", prompt_info);
1242 ok = UI_add_input_string(ui, prompt,
1243 UI_INPUT_FLAG_DEFAULT_PWD,
1244 buf, 0, (*len_io) - 1);
1245 UI_add_user_data(ui, callback_data);
1246 UI_ctrl(ui, UI_CTRL_PRINT_ERRORS, 1, 0, 0);
1250 ok = UI_process(ui);
1252 while (ok < 0 && UI_ctrl(ui, UI_CTRL_IS_REDOABLE, 0, 0, 0));
1255 *len_io = strlen(buf);
1258 OPENSSL_free(prompt);
1261 *len_io = callback(buf, *len_io, 0, callback_data);
1268 static int hwcrhk_insert_card(const char *prompt_info,
1269 const char *wrong_info,
1270 HWCryptoHook_PassphraseContext * ppctx,
1271 HWCryptoHook_CallerContext * cactx)
1275 void *callback_data = NULL;
1276 UI_METHOD *ui_method = NULL;
1279 if (cactx->ui_method)
1280 ui_method = cactx->ui_method;
1281 if (cactx->callback_data)
1282 callback_data = cactx->callback_data;
1285 if (ppctx->ui_method)
1286 ui_method = ppctx->ui_method;
1287 if (ppctx->callback_data)
1288 callback_data = ppctx->callback_data;
1290 if (ui_method == NULL) {
1291 HWCRHKerr(HWCRHK_F_HWCRHK_INSERT_CARD, HWCRHK_R_NO_CALLBACK);
1295 ui = UI_new_method(ui_method);
1301 * Despite what the documentation says wrong_info can be an empty
1304 if (wrong_info && *wrong_info)
1305 BIO_snprintf(buf, sizeof(buf) - 1,
1306 "Current card: \"%s\"\n", wrong_info);
1309 ok = UI_dup_info_string(ui, buf);
1310 if (ok >= 0 && prompt_info) {
1311 BIO_snprintf(buf, sizeof(buf) - 1,
1312 "Insert card \"%s\"", prompt_info);
1313 ok = UI_dup_input_boolean(ui, buf,
1314 "\n then hit <enter> or C<enter> to cancel\n",
1315 "\r\n", "Cc", UI_INPUT_FLAG_ECHO,
1318 UI_add_user_data(ui, callback_data);
1321 ok = UI_process(ui);
1324 if (ok == -2 || (ok >= 0 && answer == 'C'))
1334 static void hwcrhk_log_message(void *logstr, const char *message)
1336 BIO *lstream = NULL;
1338 CRYPTO_w_lock(CRYPTO_LOCK_BIO);
1340 lstream = *(BIO **)logstr;
1342 BIO_printf(lstream, "%s\n", message);
1344 CRYPTO_w_unlock(CRYPTO_LOCK_BIO);
1348 * This stuff is needed if this ENGINE is being compiled into a
1349 * self-contained shared-library.
1351 # ifndef OPENSSL_NO_DYNAMIC_ENGINE
1352 static int bind_fn(ENGINE *e, const char *id)
1354 if (id && (strcmp(id, engine_hwcrhk_id) != 0) &&
1355 (strcmp(id, engine_hwcrhk_id_alt) != 0))
1357 if (!bind_helper(e))
1362 IMPLEMENT_DYNAMIC_CHECK_FN()
1363 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
1364 # endif /* OPENSSL_NO_DYNAMIC_ENGINE */
1365 # endif /* !OPENSSL_NO_HW_CHIL */
1366 #endif /* !OPENSSL_NO_HW */