2 * Written by Richard Levitte (richard@levitte.org), Geoff Thorpe
3 * (geoff@geoffthorpe.net) and Dr Stephen N Henson (steve@openssl.org) for
4 * the OpenSSL project 2000.
6 /* ====================================================================
7 * Copyright (c) 1999-2001 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
62 #include <openssl/crypto.h>
63 #include <openssl/pem.h>
64 #include "internal/dso.h"
65 #include <openssl/engine.h>
66 #include <openssl/ui.h>
67 #include <openssl/rand.h>
68 #ifndef OPENSSL_NO_RSA
69 # include <openssl/rsa.h>
72 # include <openssl/dh.h>
74 #include <openssl/bn.h>
77 # ifndef OPENSSL_NO_HW_CHIL
80 * Attribution notice: nCipher have said several times that it's OK for
81 * us to implement a general interface to their boxes, and recently declared
82 * their HWCryptoHook to be public, and therefore available for us to use.
85 * The hwcryptohook.h included here is from May 2000.
89 # include "hwcryptohook.h"
91 # include "vendor_defns/hwcryptohook.h"
94 # define HWCRHK_LIB_NAME "CHIL engine"
95 # include "e_chil_err.c"
97 static CRYPTO_RWLOCK *chil_lock;
99 static int hwcrhk_destroy(ENGINE *e);
100 static int hwcrhk_init(ENGINE *e);
101 static int hwcrhk_finish(ENGINE *e);
102 static int hwcrhk_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
104 /* Functions to handle mutexes */
105 static int hwcrhk_mutex_init(HWCryptoHook_Mutex *,
106 HWCryptoHook_CallerContext *);
107 static int hwcrhk_mutex_lock(HWCryptoHook_Mutex *);
108 static void hwcrhk_mutex_unlock(HWCryptoHook_Mutex *);
109 static void hwcrhk_mutex_destroy(HWCryptoHook_Mutex *);
112 static int hwcrhk_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
113 const BIGNUM *m, BN_CTX *ctx);
115 # ifndef OPENSSL_NO_RSA
117 static int hwcrhk_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa,
119 /* This function is aliased to mod_exp (with the mont stuff dropped). */
120 static int hwcrhk_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
121 const BIGNUM *m, BN_CTX *ctx,
123 static int hwcrhk_rsa_finish(RSA *rsa);
126 # ifndef OPENSSL_NO_DH
128 /* This function is alised to mod_exp (with the DH and mont dropped). */
129 static int hwcrhk_mod_exp_dh(const DH *dh, BIGNUM *r,
130 const BIGNUM *a, const BIGNUM *p,
131 const BIGNUM *m, BN_CTX *ctx,
136 static int hwcrhk_rand_bytes(unsigned char *buf, int num);
137 static int hwcrhk_rand_status(void);
140 static EVP_PKEY *hwcrhk_load_privkey(ENGINE *eng, const char *key_id,
141 UI_METHOD *ui_method,
142 void *callback_data);
143 static EVP_PKEY *hwcrhk_load_pubkey(ENGINE *eng, const char *key_id,
144 UI_METHOD *ui_method,
145 void *callback_data);
147 /* Interaction stuff */
148 static int hwcrhk_insert_card(const char *prompt_info,
149 const char *wrong_info,
150 HWCryptoHook_PassphraseContext * ppctx,
151 HWCryptoHook_CallerContext * cactx);
152 static int hwcrhk_get_pass(const char *prompt_info,
153 int *len_io, char *buf,
154 HWCryptoHook_PassphraseContext * ppctx,
155 HWCryptoHook_CallerContext * cactx);
156 static void hwcrhk_log_message(void *logstr, const char *message);
158 /* The definitions for control commands specific to this engine */
159 # define HWCRHK_CMD_SO_PATH ENGINE_CMD_BASE
160 # define HWCRHK_CMD_FORK_CHECK (ENGINE_CMD_BASE + 1)
161 # define HWCRHK_CMD_THREAD_LOCKING (ENGINE_CMD_BASE + 2)
162 # define HWCRHK_CMD_SET_USER_INTERFACE (ENGINE_CMD_BASE + 3)
163 # define HWCRHK_CMD_SET_CALLBACK_DATA (ENGINE_CMD_BASE + 4)
164 static const ENGINE_CMD_DEFN hwcrhk_cmd_defns[] = {
167 "Specifies the path to the 'hwcrhk' shared library",
168 ENGINE_CMD_FLAG_STRING},
169 {HWCRHK_CMD_FORK_CHECK,
171 "Turns fork() checking on (non-zero) or off (zero)",
172 ENGINE_CMD_FLAG_NUMERIC},
173 {HWCRHK_CMD_THREAD_LOCKING,
175 "Turns thread-safe locking on (zero) or off (non-zero)",
176 ENGINE_CMD_FLAG_NUMERIC},
177 {HWCRHK_CMD_SET_USER_INTERFACE,
178 "SET_USER_INTERFACE",
179 "Set the global user interface (internal)",
180 ENGINE_CMD_FLAG_INTERNAL},
181 {HWCRHK_CMD_SET_CALLBACK_DATA,
183 "Set the global user interface extra data (internal)",
184 ENGINE_CMD_FLAG_INTERNAL},
188 # ifndef OPENSSL_NO_RSA
189 /* Our internal RSA_METHOD that we provide pointers to */
190 static RSA_METHOD hwcrhk_rsa = {
208 # ifndef OPENSSL_NO_DH
209 /* Our internal DH_METHOD that we provide pointers to */
210 static DH_METHOD hwcrhk_dh = {
223 static RAND_METHOD hwcrhk_rand = {
224 /* "CHIL RAND method", */
233 /* Constants used when creating the ENGINE */
234 static const char *engine_hwcrhk_id = "chil";
235 static const char *engine_hwcrhk_name = "CHIL hardware engine support";
236 # ifndef OPENSSL_NO_DYNAMIC_ENGINE
237 /* Compatibility hack, the dynamic library uses this form in the path */
238 static const char *engine_hwcrhk_id_alt = "ncipher";
241 /* Internal stuff for HWCryptoHook */
243 /* Some structures needed for proper use of thread locks */
245 * hwcryptohook.h has some typedefs that turn struct HWCryptoHook_MutexValue
246 * into HWCryptoHook_Mutex
248 struct HWCryptoHook_MutexValue {
253 * hwcryptohook.h has some typedefs that turn struct
254 * HWCryptoHook_PassphraseContextValue into HWCryptoHook_PassphraseContext
256 struct HWCryptoHook_PassphraseContextValue {
257 UI_METHOD *ui_method;
262 * hwcryptohook.h has some typedefs that turn struct
263 * HWCryptoHook_CallerContextValue into HWCryptoHook_CallerContext
265 struct HWCryptoHook_CallerContextValue {
266 pem_password_cb *password_callback; /* Deprecated! Only present for
267 * backward compatibility! */
268 UI_METHOD *ui_method;
273 * The MPI structure in HWCryptoHook is pretty compatible with OpenSSL
274 * BIGNUM's, so lets define a couple of conversion macros
276 # define BN2MPI(mp, bn) \
277 {mp.size = bn->top * sizeof(BN_ULONG); mp.buf = (unsigned char *)bn->d;}
278 # define MPI2BN(bn, mp) \
279 {mp.size = bn->dmax * sizeof(BN_ULONG); mp.buf = (unsigned char *)bn->d;}
281 static BIO *logstream = NULL;
282 static int disable_mutex_callbacks = 0;
285 * One might wonder why these are needed, since one can pass down at least a
286 * UI_METHOD and a pointer to callback data to the key-loading functions. The
287 * thing is that the ModExp and RSAImmed functions can load keys as well, if
288 * the data they get is in a special, nCipher-defined format (hint: if you
289 * look at the private exponent of the RSA data as a string, you'll see this
290 * string: "nCipher KM tool key id", followed by some bytes, followed a key
291 * identity string, followed by more bytes. This happens when you use
292 * "embed" keys instead of "hwcrhk" keys). Unfortunately, those functions do
293 * not take any passphrase or caller context, and our functions can't really
294 * take any callback data either. Still, the "insert_card" and
295 * "get_passphrase" callbacks may be called down the line, and will need to
296 * know what user interface callbacks to call, and having callback data from
297 * the application may be a nice thing as well, so we need to keep track of
300 static HWCryptoHook_CallerContext password_context = { NULL, NULL, NULL };
302 /* Stuff to pass to the HWCryptoHook library */
303 static HWCryptoHook_InitInfo hwcrhk_globals = {
304 HWCryptoHook_InitFlags_SimpleForkCheck, /* Flags */
305 &logstream, /* logstream */
306 sizeof(BN_ULONG), /* limbsize */
307 0, /* mslimb first: false for BNs */
308 -1, /* msbyte first: use native */
309 0, /* Max mutexes, 0 = no small limit */
310 0, /* Max simultaneous, 0 = default */
313 * The next few are mutex stuff: we write wrapper functions around the OS
314 * mutex functions. We initialise them to 0 here, and change that to
315 * actual function pointers in hwcrhk_init() if dynamic locks are
316 * supported (that is, if the application programmer has made sure of
317 * setting up callbacks bafore starting this engine) *and* if
318 * disable_mutex_callbacks hasn't been set by a call to
319 * ENGINE_ctrl(ENGINE_CTRL_CHIL_NO_LOCKING).
321 sizeof(HWCryptoHook_Mutex),
328 * The next few are condvar stuff: we write wrapper functions round the
329 * OS functions. Currently not implemented and not and absolute
330 * necessity even in threaded programs, therefore 0'ed. Will hopefully
331 * be implemented some day, since it enhances the efficiency of
334 0, /* sizeof(HWCryptoHook_CondVar), */
335 0, /* hwcrhk_cv_init, */
336 0, /* hwcrhk_cv_wait, */
337 0, /* hwcrhk_cv_signal, */
338 0, /* hwcrhk_cv_broadcast, */
339 0, /* hwcrhk_cv_destroy, */
341 hwcrhk_get_pass, /* pass phrase */
342 hwcrhk_insert_card, /* insert a card */
343 hwcrhk_log_message /* Log message */
346 /* Now, to our own code */
349 * This internal function is used by ENGINE_chil() and possibly by the
350 * "dynamic" ENGINE support too
352 static int bind_helper(ENGINE *e)
354 # ifndef OPENSSL_NO_RSA
355 const RSA_METHOD *meth1;
357 # ifndef OPENSSL_NO_DH
358 const DH_METHOD *meth2;
361 chil_lock = CRYPTO_THREAD_lock_new();
362 if (chil_lock == NULL)
365 if (!ENGINE_set_id(e, engine_hwcrhk_id) ||
366 !ENGINE_set_name(e, engine_hwcrhk_name) ||
367 # ifndef OPENSSL_NO_RSA
368 !ENGINE_set_RSA(e, &hwcrhk_rsa) ||
370 # ifndef OPENSSL_NO_DH
371 !ENGINE_set_DH(e, &hwcrhk_dh) ||
373 !ENGINE_set_RAND(e, &hwcrhk_rand) ||
374 !ENGINE_set_destroy_function(e, hwcrhk_destroy) ||
375 !ENGINE_set_init_function(e, hwcrhk_init) ||
376 !ENGINE_set_finish_function(e, hwcrhk_finish) ||
377 !ENGINE_set_ctrl_function(e, hwcrhk_ctrl) ||
378 !ENGINE_set_load_privkey_function(e, hwcrhk_load_privkey) ||
379 !ENGINE_set_load_pubkey_function(e, hwcrhk_load_pubkey) ||
380 !ENGINE_set_cmd_defns(e, hwcrhk_cmd_defns))
383 # ifndef OPENSSL_NO_RSA
385 * We know that the "PKCS1_OpenSSL()" functions hook properly to the
386 * cswift-specific mod_exp and mod_exp_crt so we use those functions. NB:
387 * We don't use ENGINE_openssl() or anything "more generic" because
388 * something like the RSAref code may not hook properly, and if you own
389 * one of these cards then you have the right to do RSA operations on it
392 meth1 = RSA_PKCS1_OpenSSL();
393 hwcrhk_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
394 hwcrhk_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
395 hwcrhk_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
396 hwcrhk_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
399 # ifndef OPENSSL_NO_DH
400 /* Much the same for Diffie-Hellman */
401 meth2 = DH_OpenSSL();
402 hwcrhk_dh.generate_key = meth2->generate_key;
403 hwcrhk_dh.compute_key = meth2->compute_key;
406 /* Ensure the hwcrhk error handling is set up */
407 ERR_load_HWCRHK_strings();
412 # ifdef OPENSSL_NO_DYNAMIC_ENGINE
413 static ENGINE *engine_chil(void)
415 ENGINE *ret = ENGINE_new();
418 if (!bind_helper(ret)) {
425 void ENGINE_load_chil(void)
427 /* Copied from eng_[openssl|dyn].c */
428 ENGINE *toadd = engine_chil();
438 * This is a process-global DSO handle used for loading and unloading the
439 * HWCryptoHook library. NB: This is only set (or unset) during an init() or
440 * finish() call (reference counts permitting) and they're operating with
441 * global locks, so this should be thread-safe implicitly.
443 static DSO *hwcrhk_dso = NULL;
444 static HWCryptoHook_ContextHandle hwcrhk_context = 0;
445 # ifndef OPENSSL_NO_RSA
446 /* Index for KM handle. Not really used yet. */
447 static int hndidx_rsa = -1;
451 * These are the function pointers that are (un)set when the library has
452 * successfully (un)loaded.
454 static HWCryptoHook_Init_t *p_hwcrhk_Init = NULL;
455 static HWCryptoHook_Finish_t *p_hwcrhk_Finish = NULL;
456 static HWCryptoHook_ModExp_t *p_hwcrhk_ModExp = NULL;
457 # ifndef OPENSSL_NO_RSA
458 static HWCryptoHook_RSA_t *p_hwcrhk_RSA = NULL;
460 static HWCryptoHook_RandomBytes_t *p_hwcrhk_RandomBytes = NULL;
461 # ifndef OPENSSL_NO_RSA
462 static HWCryptoHook_RSALoadKey_t *p_hwcrhk_RSALoadKey = NULL;
463 static HWCryptoHook_RSAGetPublicKey_t *p_hwcrhk_RSAGetPublicKey = NULL;
464 static HWCryptoHook_RSAUnloadKey_t *p_hwcrhk_RSAUnloadKey = NULL;
466 static HWCryptoHook_ModExpCRT_t *p_hwcrhk_ModExpCRT = NULL;
468 /* Used in the DSO operations. */
469 static const char *HWCRHK_LIBNAME = NULL;
470 static void free_HWCRHK_LIBNAME(void)
472 OPENSSL_free(HWCRHK_LIBNAME);
473 HWCRHK_LIBNAME = NULL;
476 static const char *get_HWCRHK_LIBNAME(void)
479 return HWCRHK_LIBNAME;
483 static long set_HWCRHK_LIBNAME(const char *name)
485 free_HWCRHK_LIBNAME();
486 return (((HWCRHK_LIBNAME = OPENSSL_strdup(name)) != NULL) ? 1 : 0);
489 static const char *n_hwcrhk_Init = "HWCryptoHook_Init";
490 static const char *n_hwcrhk_Finish = "HWCryptoHook_Finish";
491 static const char *n_hwcrhk_ModExp = "HWCryptoHook_ModExp";
492 # ifndef OPENSSL_NO_RSA
493 static const char *n_hwcrhk_RSA = "HWCryptoHook_RSA";
495 static const char *n_hwcrhk_RandomBytes = "HWCryptoHook_RandomBytes";
496 # ifndef OPENSSL_NO_RSA
497 static const char *n_hwcrhk_RSALoadKey = "HWCryptoHook_RSALoadKey";
498 static const char *n_hwcrhk_RSAGetPublicKey = "HWCryptoHook_RSAGetPublicKey";
499 static const char *n_hwcrhk_RSAUnloadKey = "HWCryptoHook_RSAUnloadKey";
501 static const char *n_hwcrhk_ModExpCRT = "HWCryptoHook_ModExpCRT";
504 * HWCryptoHook library functions and mechanics - these are used by the
505 * higher-level functions further down. NB: As and where there's no error
506 * checking, take a look lower down where these functions are called, the
507 * checking and error handling is probably down there.
510 /* utility function to obtain a context */
511 static int get_context(HWCryptoHook_ContextHandle * hac,
512 HWCryptoHook_CallerContext * cac)
515 HWCryptoHook_ErrMsgBuf rmsg;
518 rmsg.size = sizeof(tempbuf);
520 *hac = p_hwcrhk_Init(&hwcrhk_globals, sizeof(hwcrhk_globals), &rmsg, cac);
526 /* similarly to release one. */
527 static void release_context(HWCryptoHook_ContextHandle hac)
529 p_hwcrhk_Finish(hac);
532 /* Destructor (complements the "ENGINE_chil()" constructor) */
533 static int hwcrhk_destroy(ENGINE *e)
535 free_HWCRHK_LIBNAME();
536 ERR_unload_HWCRHK_strings();
537 CRYPTO_THREAD_lock_free(chil_lock);
541 /* (de)initialisation functions. */
542 static int hwcrhk_init(ENGINE *e)
544 HWCryptoHook_Init_t *p1;
545 HWCryptoHook_Finish_t *p2;
546 HWCryptoHook_ModExp_t *p3;
547 # ifndef OPENSSL_NO_RSA
548 HWCryptoHook_RSA_t *p4;
549 HWCryptoHook_RSALoadKey_t *p5;
550 HWCryptoHook_RSAGetPublicKey_t *p6;
551 HWCryptoHook_RSAUnloadKey_t *p7;
553 HWCryptoHook_RandomBytes_t *p8;
554 HWCryptoHook_ModExpCRT_t *p9;
556 if (hwcrhk_dso != NULL) {
557 HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_ALREADY_LOADED);
560 /* Attempt to load libnfhwcrhk.so/nfhwcrhk.dll/whatever. */
561 hwcrhk_dso = DSO_load(NULL, get_HWCRHK_LIBNAME(), NULL, 0);
562 if (hwcrhk_dso == NULL) {
563 HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_DSO_FAILURE);
567 #define BINDIT(t, name) (t *)DSO_bind_func(hwcrhk_dso, name)
568 if ((p1 = BINDIT(HWCryptoHook_Init_t, n_hwcrhk_Init)) == NULL
569 || (p2 = BINDIT(HWCryptoHook_Finish_t, n_hwcrhk_Finish)) == NULL
570 || (p3 = BINDIT(HWCryptoHook_ModExp_t, n_hwcrhk_ModExp)) == NULL
571 # ifndef OPENSSL_NO_RSA
572 || (p4 = BINDIT(HWCryptoHook_RSA_t, n_hwcrhk_RSA)) == NULL
573 || (p5 = BINDIT(HWCryptoHook_RSALoadKey_t, n_hwcrhk_RSALoadKey)) == NULL
574 || (p6 = BINDIT(HWCryptoHook_RSAGetPublicKey_t, n_hwcrhk_RSAGetPublicKey)) == NULL
575 || (p7 = BINDIT(HWCryptoHook_RSAUnloadKey_t, n_hwcrhk_RSAUnloadKey)) == NULL
577 || (p8 = BINDIT(HWCryptoHook_RandomBytes_t, n_hwcrhk_RandomBytes)) == NULL
578 || (p9 = BINDIT(HWCryptoHook_ModExpCRT_t, n_hwcrhk_ModExpCRT)) == NULL) {
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 hwcrhk_globals.mutex_init = hwcrhk_mutex_init;
601 hwcrhk_globals.mutex_acquire = hwcrhk_mutex_lock;
602 hwcrhk_globals.mutex_release = hwcrhk_mutex_unlock;
603 hwcrhk_globals.mutex_destroy = hwcrhk_mutex_destroy;
607 * Try and get a context - if not, we may have a DSO but no accelerator!
609 if (!get_context(&hwcrhk_context, &password_context)) {
610 HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_UNIT_FAILURE);
613 /* Everything's fine. */
614 # ifndef OPENSSL_NO_RSA
615 if (hndidx_rsa == -1)
616 hndidx_rsa = RSA_get_ex_new_index(0,
617 "nFast HWCryptoHook RSA key handle",
622 DSO_free(hwcrhk_dso);
624 p_hwcrhk_Init = NULL;
625 p_hwcrhk_Finish = NULL;
626 p_hwcrhk_ModExp = NULL;
627 # ifndef OPENSSL_NO_RSA
629 p_hwcrhk_RSALoadKey = NULL;
630 p_hwcrhk_RSAGetPublicKey = NULL;
631 p_hwcrhk_RSAUnloadKey = NULL;
633 p_hwcrhk_ModExpCRT = NULL;
634 p_hwcrhk_RandomBytes = NULL;
638 static int hwcrhk_finish(ENGINE *e)
641 free_HWCRHK_LIBNAME();
642 if (hwcrhk_dso == NULL) {
643 HWCRHKerr(HWCRHK_F_HWCRHK_FINISH, HWCRHK_R_NOT_LOADED);
647 release_context(hwcrhk_context);
648 if (!DSO_free(hwcrhk_dso)) {
649 HWCRHKerr(HWCRHK_F_HWCRHK_FINISH, HWCRHK_R_DSO_FAILURE);
656 p_hwcrhk_Init = NULL;
657 p_hwcrhk_Finish = NULL;
658 p_hwcrhk_ModExp = NULL;
659 # ifndef OPENSSL_NO_RSA
661 p_hwcrhk_RSALoadKey = NULL;
662 p_hwcrhk_RSAGetPublicKey = NULL;
663 p_hwcrhk_RSAUnloadKey = NULL;
665 p_hwcrhk_ModExpCRT = NULL;
666 p_hwcrhk_RandomBytes = NULL;
670 static int hwcrhk_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
675 case HWCRHK_CMD_SO_PATH:
677 HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, HWCRHK_R_ALREADY_LOADED);
681 HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, ERR_R_PASSED_NULL_PARAMETER);
684 return set_HWCRHK_LIBNAME((const char *)p);
685 case ENGINE_CTRL_SET_LOGSTREAM:
689 CRYPTO_THREAD_write_lock(chil_lock);
695 HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, HWCRHK_R_BIO_WAS_FREED);
697 CRYPTO_THREAD_unlock(chil_lock);
699 case ENGINE_CTRL_SET_PASSWORD_CALLBACK:
700 CRYPTO_THREAD_write_lock(chil_lock);
701 password_context.password_callback = (pem_password_cb *)f;
702 CRYPTO_THREAD_unlock(chil_lock);
704 case ENGINE_CTRL_SET_USER_INTERFACE:
705 case HWCRHK_CMD_SET_USER_INTERFACE:
706 CRYPTO_THREAD_write_lock(chil_lock);
707 password_context.ui_method = (UI_METHOD *)p;
708 CRYPTO_THREAD_unlock(chil_lock);
710 case ENGINE_CTRL_SET_CALLBACK_DATA:
711 case HWCRHK_CMD_SET_CALLBACK_DATA:
712 CRYPTO_THREAD_write_lock(chil_lock);
713 password_context.callback_data = p;
714 CRYPTO_THREAD_unlock(chil_lock);
717 * this enables or disables the "SimpleForkCheck" flag used in the
718 * initialisation structure.
720 case ENGINE_CTRL_CHIL_SET_FORKCHECK:
721 case HWCRHK_CMD_FORK_CHECK:
722 CRYPTO_THREAD_write_lock(chil_lock);
724 hwcrhk_globals.flags |= HWCryptoHook_InitFlags_SimpleForkCheck;
726 hwcrhk_globals.flags &= ~HWCryptoHook_InitFlags_SimpleForkCheck;
727 CRYPTO_THREAD_unlock(chil_lock);
730 * This will prevent the initialisation function from "installing"
731 * the mutex-handling callbacks, even if they are available from
732 * within the library (or were provided to the library from the
733 * calling application). This is to remove any baggage for
734 * applications not using multithreading.
736 case ENGINE_CTRL_CHIL_NO_LOCKING:
737 CRYPTO_THREAD_write_lock(chil_lock);
738 disable_mutex_callbacks = 1;
739 CRYPTO_THREAD_unlock(chil_lock);
741 case HWCRHK_CMD_THREAD_LOCKING:
742 CRYPTO_THREAD_write_lock(chil_lock);
743 disable_mutex_callbacks = ((i == 0) ? 0 : 1);
744 CRYPTO_THREAD_unlock(chil_lock);
747 /* The command isn't understood by this engine */
749 HWCRHKerr(HWCRHK_F_HWCRHK_CTRL,
750 HWCRHK_R_CTRL_COMMAND_NOT_IMPLEMENTED);
758 static EVP_PKEY *hwcrhk_load_privkey(ENGINE *eng, const char *key_id,
759 UI_METHOD *ui_method,
762 # ifndef OPENSSL_NO_RSA
765 EVP_PKEY *res = NULL;
766 # ifndef OPENSSL_NO_RSA
767 HWCryptoHook_MPI e, n;
768 HWCryptoHook_RSAKeyHandle *hptr;
770 # if !defined(OPENSSL_NO_RSA)
772 HWCryptoHook_ErrMsgBuf rmsg;
773 HWCryptoHook_PassphraseContext ppctx;
776 # if !defined(OPENSSL_NO_RSA)
778 rmsg.size = sizeof(tempbuf);
781 if (!hwcrhk_context) {
782 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_NOT_INITIALISED);
785 # ifndef OPENSSL_NO_RSA
786 hptr = OPENSSL_malloc(sizeof(*hptr));
788 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, ERR_R_MALLOC_FAILURE);
791 ppctx.ui_method = ui_method;
792 ppctx.callback_data = callback_data;
793 if (p_hwcrhk_RSALoadKey(hwcrhk_context, key_id, hptr, &rmsg, &ppctx)) {
794 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
795 ERR_add_error_data(1, rmsg.buf);
799 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_NO_KEY);
803 # ifndef OPENSSL_NO_RSA
804 rtmp = RSA_new_method(eng);
805 RSA_set_ex_data(rtmp, hndidx_rsa, (char *)hptr);
808 rtmp->flags |= RSA_FLAG_EXT_PKEY;
811 if (p_hwcrhk_RSAGetPublicKey(*hptr, &n, &e, &rmsg)
812 != HWCRYPTOHOOK_ERROR_MPISIZE) {
813 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
814 ERR_add_error_data(1, rmsg.buf);
818 bn_expand2(rtmp->e, e.size / sizeof(BN_ULONG));
819 bn_expand2(rtmp->n, n.size / sizeof(BN_ULONG));
823 if (p_hwcrhk_RSAGetPublicKey(*hptr, &n, &e, &rmsg)) {
824 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
825 ERR_add_error_data(1, rmsg.buf);
828 rtmp->e->top = e.size / sizeof(BN_ULONG);
830 rtmp->n->top = n.size / sizeof(BN_ULONG);
833 res = EVP_PKEY_new();
835 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
838 EVP_PKEY_assign_RSA(res, rtmp);
842 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY,
843 HWCRHK_R_PRIVATE_KEY_ALGORITHMS_DISABLED);
847 # ifndef OPENSSL_NO_RSA
853 static EVP_PKEY *hwcrhk_load_pubkey(ENGINE *eng, const char *key_id,
854 UI_METHOD *ui_method, void *callback_data)
856 EVP_PKEY *res = NULL;
858 # ifndef OPENSSL_NO_RSA
859 res = hwcrhk_load_privkey(eng, key_id, ui_method, callback_data);
864 # ifndef OPENSSL_NO_RSA
869 CRYPTO_THREAD_write_lock(chil_lock);
871 res->pkey.rsa = RSA_new();
872 res->pkey.rsa->n = rsa->n;
873 res->pkey.rsa->e = rsa->e;
876 CRYPTO_THREAD_unlock(chil_lock);
882 HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PUBKEY,
883 HWCRHK_R_CTRL_COMMAND_NOT_IMPLEMENTED);
893 /* A little mod_exp */
894 static int hwcrhk_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
895 const BIGNUM *m, BN_CTX *ctx)
898 HWCryptoHook_ErrMsgBuf rmsg;
900 * Since HWCryptoHook_MPI is pretty compatible with BIGNUM's, we use them
901 * directly, plus a little macro magic. We only thing we need to make
902 * sure of is that enough space is allocated.
904 HWCryptoHook_MPI m_a, m_p, m_n, m_r;
907 to_return = 0; /* expect failure */
909 rmsg.size = sizeof(tempbuf);
911 if (!hwcrhk_context) {
912 HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_NOT_INITIALISED);
915 /* Prepare the params */
916 bn_expand2(r, m->top); /* Check for error !! */
922 /* Perform the operation */
923 ret = p_hwcrhk_ModExp(hwcrhk_context, m_a, m_p, m_n, &m_r, &rmsg);
925 /* Convert the response */
926 r->top = m_r.size / sizeof(BN_ULONG);
931 * FIXME: When this error is returned, HWCryptoHook is telling us
932 * that falling back to software computation might be a good thing.
934 if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
935 HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_REQUEST_FALLBACK);
937 HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_REQUEST_FAILED);
939 ERR_add_error_data(1, rmsg.buf);
948 # ifndef OPENSSL_NO_RSA
949 static int hwcrhk_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa,
953 HWCryptoHook_ErrMsgBuf rmsg;
954 HWCryptoHook_RSAKeyHandle *hptr;
955 int to_return = 0, ret;
958 rmsg.size = sizeof(tempbuf);
960 if (!hwcrhk_context) {
961 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP, HWCRHK_R_NOT_INITIALISED);
966 * This provides support for nForce keys. Since that's opaque data all
967 * we do is provide a handle to the proper key and let HWCryptoHook take
971 (HWCryptoHook_RSAKeyHandle *) RSA_get_ex_data(rsa, hndidx_rsa))
973 HWCryptoHook_MPI m_a, m_r;
976 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
977 HWCRHK_R_MISSING_KEY_COMPONENTS);
981 /* Prepare the params */
982 bn_expand2(r, rsa->n->top); /* Check for error !! */
986 /* Perform the operation */
987 ret = p_hwcrhk_RSA(m_a, *hptr, &m_r, &rmsg);
989 /* Convert the response */
990 r->top = m_r.size / sizeof(BN_ULONG);
995 * FIXME: When this error is returned, HWCryptoHook is telling us
996 * that falling back to software computation might be a good
999 if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
1000 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1001 HWCRHK_R_REQUEST_FALLBACK);
1003 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1004 HWCRHK_R_REQUEST_FAILED);
1006 ERR_add_error_data(1, rmsg.buf);
1010 HWCryptoHook_MPI m_a, m_p, m_q, m_dmp1, m_dmq1, m_iqmp, m_r;
1012 if (!rsa->p || !rsa->q || !rsa->dmp1 || !rsa->dmq1 || !rsa->iqmp) {
1013 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1014 HWCRHK_R_MISSING_KEY_COMPONENTS);
1018 /* Prepare the params */
1019 bn_expand2(r, rsa->n->top); /* Check for error !! */
1021 BN2MPI(m_p, rsa->p);
1022 BN2MPI(m_q, rsa->q);
1023 BN2MPI(m_dmp1, rsa->dmp1);
1024 BN2MPI(m_dmq1, rsa->dmq1);
1025 BN2MPI(m_iqmp, rsa->iqmp);
1028 /* Perform the operation */
1029 ret = p_hwcrhk_ModExpCRT(hwcrhk_context, m_a, m_p, m_q,
1030 m_dmp1, m_dmq1, m_iqmp, &m_r, &rmsg);
1032 /* Convert the response */
1033 r->top = m_r.size / sizeof(BN_ULONG);
1038 * FIXME: When this error is returned, HWCryptoHook is telling us
1039 * that falling back to software computation might be a good
1042 if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
1043 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1044 HWCRHK_R_REQUEST_FALLBACK);
1046 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1047 HWCRHK_R_REQUEST_FAILED);
1049 ERR_add_error_data(1, rmsg.buf);
1054 * If we're here, we must be here with some semblance of success :-)
1062 # ifndef OPENSSL_NO_RSA
1063 /* This function is aliased to mod_exp (with the mont stuff dropped). */
1064 static int hwcrhk_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
1065 const BIGNUM *m, BN_CTX *ctx,
1068 return hwcrhk_mod_exp(r, a, p, m, ctx);
1071 static int hwcrhk_rsa_finish(RSA *rsa)
1073 HWCryptoHook_RSAKeyHandle *hptr;
1075 hptr = RSA_get_ex_data(rsa, hndidx_rsa);
1077 p_hwcrhk_RSAUnloadKey(*hptr, NULL);
1079 RSA_set_ex_data(rsa, hndidx_rsa, NULL);
1086 # ifndef OPENSSL_NO_DH
1087 /* This function is aliased to mod_exp (with the dh and mont dropped). */
1088 static int hwcrhk_mod_exp_dh(const DH *dh, BIGNUM *r,
1089 const BIGNUM *a, const BIGNUM *p,
1090 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
1092 return hwcrhk_mod_exp(r, a, p, m, ctx);
1096 /* Random bytes are good */
1097 static int hwcrhk_rand_bytes(unsigned char *buf, int num)
1100 HWCryptoHook_ErrMsgBuf rmsg;
1101 int to_return = 0; /* assume failure */
1105 rmsg.size = sizeof(tempbuf);
1107 if (!hwcrhk_context) {
1108 HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_NOT_INITIALISED);
1112 ret = p_hwcrhk_RandomBytes(hwcrhk_context, buf, num, &rmsg);
1115 * FIXME: When this error is returned, HWCryptoHook is telling us
1116 * that falling back to software computation might be a good thing.
1118 if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
1119 HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_REQUEST_FALLBACK);
1121 HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_REQUEST_FAILED);
1123 ERR_add_error_data(1, rmsg.buf);
1131 static int hwcrhk_rand_status(void)
1137 * Mutex calls: since the HWCryptoHook model closely follows the POSIX model
1138 * these just wrap the POSIX functions and add some logging.
1141 static int hwcrhk_mutex_init(HWCryptoHook_Mutex * mt,
1142 HWCryptoHook_CallerContext * cactx)
1144 mt->lock = CRYPTO_THREAD_lock_new();
1145 if (mt->lock == NULL)
1146 return 1; /* failure */
1147 return 0; /* success */
1150 static int hwcrhk_mutex_lock(HWCryptoHook_Mutex * mt)
1152 CRYPTO_THREAD_write_lock(mt->lock);
1156 static void hwcrhk_mutex_unlock(HWCryptoHook_Mutex * mt)
1158 CRYPTO_THREAD_unlock(mt->lock);
1161 static void hwcrhk_mutex_destroy(HWCryptoHook_Mutex * mt)
1163 CRYPTO_THREAD_lock_free(mt->lock);
1166 static int hwcrhk_get_pass(const char *prompt_info,
1167 int *len_io, char *buf,
1168 HWCryptoHook_PassphraseContext * ppctx,
1169 HWCryptoHook_CallerContext * cactx)
1171 pem_password_cb *callback = NULL;
1172 void *callback_data = NULL;
1173 UI_METHOD *ui_method = NULL;
1175 * Despite what the documentation says prompt_info can be an empty
1178 if (prompt_info && !*prompt_info)
1182 if (cactx->ui_method)
1183 ui_method = cactx->ui_method;
1184 if (cactx->password_callback)
1185 callback = cactx->password_callback;
1186 if (cactx->callback_data)
1187 callback_data = cactx->callback_data;
1190 if (ppctx->ui_method) {
1191 ui_method = ppctx->ui_method;
1194 if (ppctx->callback_data)
1195 callback_data = ppctx->callback_data;
1197 if (callback == NULL && ui_method == NULL) {
1198 HWCRHKerr(HWCRHK_F_HWCRHK_GET_PASS, HWCRHK_R_NO_CALLBACK);
1203 UI *ui = UI_new_method(ui_method);
1206 char *prompt = UI_construct_prompt(ui,
1207 "pass phrase", prompt_info);
1209 ok = UI_add_input_string(ui, prompt,
1210 UI_INPUT_FLAG_DEFAULT_PWD,
1211 buf, 0, (*len_io) - 1);
1212 UI_add_user_data(ui, callback_data);
1213 UI_ctrl(ui, UI_CTRL_PRINT_ERRORS, 1, 0, 0);
1217 ok = UI_process(ui);
1219 while (ok < 0 && UI_ctrl(ui, UI_CTRL_IS_REDOABLE, 0, 0, 0));
1222 *len_io = strlen(buf);
1225 OPENSSL_free(prompt);
1228 *len_io = callback(buf, *len_io, 0, callback_data);
1235 static int hwcrhk_insert_card(const char *prompt_info,
1236 const char *wrong_info,
1237 HWCryptoHook_PassphraseContext * ppctx,
1238 HWCryptoHook_CallerContext * cactx)
1242 void *callback_data = NULL;
1243 UI_METHOD *ui_method = NULL;
1246 if (cactx->ui_method)
1247 ui_method = cactx->ui_method;
1248 if (cactx->callback_data)
1249 callback_data = cactx->callback_data;
1252 if (ppctx->ui_method)
1253 ui_method = ppctx->ui_method;
1254 if (ppctx->callback_data)
1255 callback_data = ppctx->callback_data;
1257 if (ui_method == NULL) {
1258 HWCRHKerr(HWCRHK_F_HWCRHK_INSERT_CARD, HWCRHK_R_NO_CALLBACK);
1262 ui = UI_new_method(ui_method);
1268 * Despite what the documentation says wrong_info can be an empty
1271 if (wrong_info && *wrong_info)
1272 BIO_snprintf(buf, sizeof(buf) - 1,
1273 "Current card: \"%s\"\n", wrong_info);
1276 ok = UI_dup_info_string(ui, buf);
1277 if (ok >= 0 && prompt_info) {
1278 BIO_snprintf(buf, sizeof(buf) - 1,
1279 "Insert card \"%s\"", prompt_info);
1280 ok = UI_dup_input_boolean(ui, buf,
1281 "\n then hit <enter> or C<enter> to cancel\n",
1282 "\r\n", "Cc", UI_INPUT_FLAG_ECHO,
1285 UI_add_user_data(ui, callback_data);
1288 ok = UI_process(ui);
1291 if (ok == -2 || (ok >= 0 && answer == 'C'))
1301 static void hwcrhk_log_message(void *logstr, const char *message)
1303 BIO *lstream = NULL;
1306 lstream = *(BIO **)logstr;
1308 BIO_printf(lstream, "%s\n", message);
1313 * This stuff is needed if this ENGINE is being compiled into a
1314 * self-contained shared-library.
1316 # ifndef OPENSSL_NO_DYNAMIC_ENGINE
1317 static int bind_fn(ENGINE *e, const char *id)
1319 if (id && (strcmp(id, engine_hwcrhk_id) != 0) &&
1320 (strcmp(id, engine_hwcrhk_id_alt) != 0))
1322 if (!bind_helper(e))
1327 IMPLEMENT_DYNAMIC_CHECK_FN()
1328 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
1329 # endif /* OPENSSL_NO_DYNAMIC_ENGINE */
1330 # endif /* !OPENSSL_NO_HW_CHIL */
1331 #endif /* !OPENSSL_NO_HW */