engines/e_chil.c

   1 /* crypto/engine/e_chil.c -*- mode: C; c-file-style: "eay" -*- */
   2 /*
   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.
   6  */
   7 /* ====================================================================
   8  * Copyright (c) 1999-2001 The OpenSSL Project.  All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  *
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  *
  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
  20  *    distribution.
  21  *
  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/)"
  26  *
  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.
  31  *
  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.
  35  *
  36  * 6. Redistributions of any form whatsoever must retain the following
  37  *    acknowledgment:
  38  *    "This product includes software developed by the OpenSSL Project
  39  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  40  *
  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  * ====================================================================
  54  *
  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).
  58  *
  59  */
  60
  61 #include <stdio.h>
  62 #include <string.h>
  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>
  71 #endif
  72 #ifndef OPENSSL_NO_DH
  73 # include <openssl/dh.h>
  74 #endif
  75 #include <openssl/bn.h>
  76
  77 #ifndef OPENSSL_NO_HW
  78 # ifndef OPENSSL_NO_HW_CHIL
  79
  80 /*-
  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.
  84  * Thanks, nCipher.
  85  *
  86  * The hwcryptohook.h included here is from May 2000.
  87  * [Richard Levitte]
  88  */
  89 #  ifdef FLAT_INC
  90 #   include "hwcryptohook.h"
  91 #  else
  92 #   include "vendor_defns/hwcryptohook.h"
  93 #  endif
  94
  95 #  define HWCRHK_LIB_NAME "CHIL engine"
  96 #  include "e_chil_err.c"
  97
  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));
 102
 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 *);
 109
 110 /* BIGNUM stuff */
 111 static int hwcrhk_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 112                           const BIGNUM *m, BN_CTX *ctx);
 113
 114 #  ifndef OPENSSL_NO_RSA
 115 /* RSA stuff */
 116 static int hwcrhk_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa,
 117                               BN_CTX *ctx);
 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,
 121                                BN_MONT_CTX *m_ctx);
 122 static int hwcrhk_rsa_finish(RSA *rsa);
 123 #  endif
 124
 125 #  ifndef OPENSSL_NO_DH
 126 /* DH stuff */
 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,
 131                              BN_MONT_CTX *m_ctx);
 132 #  endif
 133
 134 /* RAND stuff */
 135 static int hwcrhk_rand_bytes(unsigned char *buf, int num);
 136 static int hwcrhk_rand_status(void);
 137
 138 /* KM stuff */
 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);
 145
 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);
 156
 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[] = {
 164     {HWCRHK_CMD_SO_PATH,
 165      "SO_PATH",
 166      "Specifies the path to the 'hwcrhk' shared library",
 167      ENGINE_CMD_FLAG_STRING},
 168     {HWCRHK_CMD_FORK_CHECK,
 169      "FORK_CHECK",
 170      "Turns fork() checking on (non-zero) or off (zero)",
 171      ENGINE_CMD_FLAG_NUMERIC},
 172     {HWCRHK_CMD_THREAD_LOCKING,
 173      "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,
 181      "SET_CALLBACK_DATA",
 182      "Set the global user interface extra data (internal)",
 183      ENGINE_CMD_FLAG_INTERNAL},
 184     {0, NULL, NULL, 0}
 185 };
 186
 187 #  ifndef OPENSSL_NO_RSA
 188 /* Our internal RSA_METHOD that we provide pointers to */
 189 static RSA_METHOD hwcrhk_rsa = {
 190     "CHIL RSA method",
 191     NULL,
 192     NULL,
 193     NULL,
 194     NULL,
 195     hwcrhk_rsa_mod_exp,
 196     hwcrhk_mod_exp_mont,
 197     NULL,
 198     hwcrhk_rsa_finish,
 199     0,
 200     NULL,
 201     NULL,
 202     NULL,
 203     NULL
 204 };
 205 #  endif
 206
 207 #  ifndef OPENSSL_NO_DH
 208 /* Our internal DH_METHOD that we provide pointers to */
 209 static DH_METHOD hwcrhk_dh = {
 210     "CHIL DH method",
 211     NULL,
 212     NULL,
 213     hwcrhk_mod_exp_dh,
 214     NULL,
 215     NULL,
 216     0,
 217     NULL,
 218     NULL
 219 };
 220 #  endif
 221
 222 static RAND_METHOD hwcrhk_rand = {
 223     /* "CHIL RAND method", */
 224     NULL,
 225     hwcrhk_rand_bytes,
 226     NULL,
 227     NULL,
 228     hwcrhk_rand_bytes,
 229     hwcrhk_rand_status,
 230 };
 231
 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";
 238 #  endif
 239
 240 /* Internal stuff for HWCryptoHook */
 241
 242 /* Some structures needed for proper use of thread locks */
 243 /*
 244  * hwcryptohook.h has some typedefs that turn struct HWCryptoHook_MutexValue
 245  * into HWCryptoHook_Mutex
 246  */
 247 struct HWCryptoHook_MutexValue {
 248     int lockid;
 249 };
 250
 251 /*
 252  * hwcryptohook.h has some typedefs that turn struct
 253  * HWCryptoHook_PassphraseContextValue into HWCryptoHook_PassphraseContext
 254  */
 255 struct HWCryptoHook_PassphraseContextValue {
 256     UI_METHOD *ui_method;
 257     void *callback_data;
 258 };
 259
 260 /*
 261  * hwcryptohook.h has some typedefs that turn struct
 262  * HWCryptoHook_CallerContextValue into HWCryptoHook_CallerContext
 263  */
 264 struct HWCryptoHook_CallerContextValue {
 265     pem_password_cb *password_callback; /* Deprecated! Only present for
 266                                          * backward compatibility! */
 267     UI_METHOD *ui_method;
 268     void *callback_data;
 269 };
 270
 271 /*
 272  * The MPI structure in HWCryptoHook is pretty compatible with OpenSSL
 273  * BIGNUM's, so lets define a couple of conversion macros
 274  */
 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;}
 279
 280 static BIO *logstream = NULL;
 281 static int disable_mutex_callbacks = 0;
 282
 283 /*
 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
 297  * that globally.
 298  */
 299 static HWCryptoHook_CallerContext password_context = { NULL, NULL, NULL };
 300
 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 */
 310
 311     /*
 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).
 319      */
 320     sizeof(HWCryptoHook_Mutex),
 321     0,
 322     0,
 323     0,
 324     0,
 325
 326     /*
 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
 331      * HWCryptoHook.
 332      */
 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, */
 339
 340     hwcrhk_get_pass,            /* pass phrase */
 341     hwcrhk_insert_card,         /* insert a card */
 342     hwcrhk_log_message          /* Log message */
 343 };
 344
 345 /* Now, to our own code */
 346
 347 /*
 348  * This internal function is used by ENGINE_chil() and possibly by the
 349  * "dynamic" ENGINE support too
 350  */
 351 static int bind_helper(ENGINE *e)
 352 {
 353 #  ifndef OPENSSL_NO_RSA
 354     const RSA_METHOD *meth1;
 355 #  endif
 356 #  ifndef OPENSSL_NO_DH
 357     const DH_METHOD *meth2;
 358 #  endif
 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) ||
 363 #  endif
 364 #  ifndef OPENSSL_NO_DH
 365         !ENGINE_set_DH(e, &hwcrhk_dh) ||
 366 #  endif
 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))
 375         return 0;
 376
 377 #  ifndef OPENSSL_NO_RSA
 378     /*
 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
 384      * anyway!
 385      */
 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;
 391 #  endif
 392
 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;
 398 #  endif
 399
 400     /* Ensure the hwcrhk error handling is set up */
 401     ERR_load_HWCRHK_strings();
 402     return 1;
 403 }
 404
 405 #  ifdef OPENSSL_NO_DYNAMIC_ENGINE
 406 static ENGINE *engine_chil(void)
 407 {
 408     ENGINE *ret = ENGINE_new();
 409     if (!ret)
 410         return NULL;
 411     if (!bind_helper(ret)) {
 412         ENGINE_free(ret);
 413         return NULL;
 414     }
 415     return ret;
 416 }
 417
 418 void ENGINE_load_chil(void)
 419 {
 420     /* Copied from eng_[openssl|dyn].c */
 421     ENGINE *toadd = engine_chil();
 422     if (!toadd)
 423         return;
 424     ENGINE_add(toadd);
 425     ENGINE_free(toadd);
 426     ERR_clear_error();
 427 }
 428 #  endif
 429
 430 /*
 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.
 435  */
 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;
 441 #  endif
 442
 443 /*
 444  * These are the function pointers that are (un)set when the library has
 445  * successfully (un)loaded.
 446  */
 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;
 452 #  endif
 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;
 458 #  endif
 459 static HWCryptoHook_ModExpCRT_t *p_hwcrhk_ModExpCRT = NULL;
 460
 461 /* Used in the DSO operations. */
 462 static const char *HWCRHK_LIBNAME = NULL;
 463 static void free_HWCRHK_LIBNAME(void)
 464 {
 465     OPENSSL_free(HWCRHK_LIBNAME);
 466     HWCRHK_LIBNAME = NULL;
 467 }
 468
 469 static const char *get_HWCRHK_LIBNAME(void)
 470 {
 471     if (HWCRHK_LIBNAME)
 472         return HWCRHK_LIBNAME;
 473     return "nfhwcrhk";
 474 }
 475
 476 static long set_HWCRHK_LIBNAME(const char *name)
 477 {
 478     free_HWCRHK_LIBNAME();
 479     return (((HWCRHK_LIBNAME = BUF_strdup(name)) != NULL) ? 1 : 0);
 480 }
 481
 482 static const char *n_hwcrhk_Init = "HWCryptoHook_Init";
 483 static const char *n_hwcrhk_Finish = "HWCryptoHook_Finish";
 484 static const char *n_hwcrhk_ModExp = "HWCryptoHook_ModExp";
 485 #  ifndef OPENSSL_NO_RSA
 486 static const char *n_hwcrhk_RSA = "HWCryptoHook_RSA";
 487 #  endif
 488 static const char *n_hwcrhk_RandomBytes = "HWCryptoHook_RandomBytes";
 489 #  ifndef OPENSSL_NO_RSA
 490 static const char *n_hwcrhk_RSALoadKey = "HWCryptoHook_RSALoadKey";
 491 static const char *n_hwcrhk_RSAGetPublicKey = "HWCryptoHook_RSAGetPublicKey";
 492 static const char *n_hwcrhk_RSAUnloadKey = "HWCryptoHook_RSAUnloadKey";
 493 #  endif
 494 static const char *n_hwcrhk_ModExpCRT = "HWCryptoHook_ModExpCRT";
 495
 496 /*
 497  * HWCryptoHook library functions and mechanics - these are used by the
 498  * higher-level functions further down. NB: As and where there's no error
 499  * checking, take a look lower down where these functions are called, the
 500  * checking and error handling is probably down there.
 501  */
 502
 503 /* utility function to obtain a context */
 504 static int get_context(HWCryptoHook_ContextHandle * hac,
 505                        HWCryptoHook_CallerContext * cac)
 506 {
 507     char tempbuf[1024];
 508     HWCryptoHook_ErrMsgBuf rmsg;
 509
 510     rmsg.buf = tempbuf;
 511     rmsg.size = sizeof(tempbuf);
 512
 513     *hac = p_hwcrhk_Init(&hwcrhk_globals, sizeof(hwcrhk_globals), &rmsg, cac);
 514     if (!*hac)
 515         return 0;
 516     return 1;
 517 }
 518
 519 /* similarly to release one. */
 520 static void release_context(HWCryptoHook_ContextHandle hac)
 521 {
 522     p_hwcrhk_Finish(hac);
 523 }
 524
 525 /* Destructor (complements the "ENGINE_chil()" constructor) */
 526 static int hwcrhk_destroy(ENGINE *e)
 527 {
 528     free_HWCRHK_LIBNAME();
 529     ERR_unload_HWCRHK_strings();
 530     return 1;
 531 }
 532
 533 /* (de)initialisation functions. */
 534 static int hwcrhk_init(ENGINE *e)
 535 {
 536     HWCryptoHook_Init_t *p1;
 537     HWCryptoHook_Finish_t *p2;
 538     HWCryptoHook_ModExp_t *p3;
 539 #  ifndef OPENSSL_NO_RSA
 540     HWCryptoHook_RSA_t *p4;
 541     HWCryptoHook_RSALoadKey_t *p5;
 542     HWCryptoHook_RSAGetPublicKey_t *p6;
 543     HWCryptoHook_RSAUnloadKey_t *p7;
 544 #  endif
 545     HWCryptoHook_RandomBytes_t *p8;
 546     HWCryptoHook_ModExpCRT_t *p9;
 547
 548     if (hwcrhk_dso != NULL) {
 549         HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_ALREADY_LOADED);
 550         goto err;
 551     }
 552     /* Attempt to load libnfhwcrhk.so/nfhwcrhk.dll/whatever. */
 553     hwcrhk_dso = DSO_load(NULL, get_HWCRHK_LIBNAME(), NULL, 0);
 554     if (hwcrhk_dso == NULL) {
 555         HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_DSO_FAILURE);
 556         goto err;
 557     }
 558     if (!(p1 = (HWCryptoHook_Init_t *)
 559           DSO_bind_func(hwcrhk_dso, n_hwcrhk_Init)) ||
 560         !(p2 = (HWCryptoHook_Finish_t *)
 561           DSO_bind_func(hwcrhk_dso, n_hwcrhk_Finish)) ||
 562         !(p3 = (HWCryptoHook_ModExp_t *)
 563           DSO_bind_func(hwcrhk_dso, n_hwcrhk_ModExp)) ||
 564 #  ifndef OPENSSL_NO_RSA
 565         !(p4 = (HWCryptoHook_RSA_t *)
 566           DSO_bind_func(hwcrhk_dso, n_hwcrhk_RSA)) ||
 567         !(p5 = (HWCryptoHook_RSALoadKey_t *)
 568           DSO_bind_func(hwcrhk_dso, n_hwcrhk_RSALoadKey)) ||
 569         !(p6 = (HWCryptoHook_RSAGetPublicKey_t *)
 570           DSO_bind_func(hwcrhk_dso, n_hwcrhk_RSAGetPublicKey)) ||
 571         !(p7 = (HWCryptoHook_RSAUnloadKey_t *)
 572           DSO_bind_func(hwcrhk_dso, n_hwcrhk_RSAUnloadKey)) ||
 573 #  endif
 574         !(p8 = (HWCryptoHook_RandomBytes_t *)
 575           DSO_bind_func(hwcrhk_dso, n_hwcrhk_RandomBytes)) ||
 576         !(p9 = (HWCryptoHook_ModExpCRT_t *)
 577           DSO_bind_func(hwcrhk_dso, n_hwcrhk_ModExpCRT))) {
 578         HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_DSO_FAILURE);
 579         goto err;
 580     }
 581     /* Copy the pointers */
 582     p_hwcrhk_Init = p1;
 583     p_hwcrhk_Finish = p2;
 584     p_hwcrhk_ModExp = p3;
 585 #  ifndef OPENSSL_NO_RSA
 586     p_hwcrhk_RSA = p4;
 587     p_hwcrhk_RSALoadKey = p5;
 588     p_hwcrhk_RSAGetPublicKey = p6;
 589     p_hwcrhk_RSAUnloadKey = p7;
 590 #  endif
 591     p_hwcrhk_RandomBytes = p8;
 592     p_hwcrhk_ModExpCRT = p9;
 593
 594     /*
 595      * Check if the application decided to support dynamic locks, and if it
 596      * does, use them.
 597      */
 598     if (disable_mutex_callbacks == 0) {
 599         if (CRYPTO_get_dynlock_create_callback() != NULL &&
 600             CRYPTO_get_dynlock_lock_callback() != NULL &&
 601             CRYPTO_get_dynlock_destroy_callback() != NULL) {
 602             hwcrhk_globals.mutex_init = hwcrhk_mutex_init;
 603             hwcrhk_globals.mutex_acquire = hwcrhk_mutex_lock;
 604             hwcrhk_globals.mutex_release = hwcrhk_mutex_unlock;
 605             hwcrhk_globals.mutex_destroy = hwcrhk_mutex_destroy;
 606         }
 607     }
 608
 609     /*
 610      * Try and get a context - if not, we may have a DSO but no accelerator!
 611      */
 612     if (!get_context(&hwcrhk_context, &password_context)) {
 613         HWCRHKerr(HWCRHK_F_HWCRHK_INIT, HWCRHK_R_UNIT_FAILURE);
 614         goto err;
 615     }
 616     /* Everything's fine. */
 617 #  ifndef OPENSSL_NO_RSA
 618     if (hndidx_rsa == -1)
 619         hndidx_rsa = RSA_get_ex_new_index(0,
 620                                           "nFast HWCryptoHook RSA key handle",
 621                                           NULL, NULL, NULL);
 622 #  endif
 623     return 1;
 624  err:
 625     if (hwcrhk_dso)
 626         DSO_free(hwcrhk_dso);
 627     hwcrhk_dso = NULL;
 628     p_hwcrhk_Init = NULL;
 629     p_hwcrhk_Finish = NULL;
 630     p_hwcrhk_ModExp = NULL;
 631 #  ifndef OPENSSL_NO_RSA
 632     p_hwcrhk_RSA = NULL;
 633     p_hwcrhk_RSALoadKey = NULL;
 634     p_hwcrhk_RSAGetPublicKey = NULL;
 635     p_hwcrhk_RSAUnloadKey = NULL;
 636 #  endif
 637     p_hwcrhk_ModExpCRT = NULL;
 638     p_hwcrhk_RandomBytes = NULL;
 639     return 0;
 640 }
 641
 642 static int hwcrhk_finish(ENGINE *e)
 643 {
 644     int to_return = 1;
 645     free_HWCRHK_LIBNAME();
 646     if (hwcrhk_dso == NULL) {
 647         HWCRHKerr(HWCRHK_F_HWCRHK_FINISH, HWCRHK_R_NOT_LOADED);
 648         to_return = 0;
 649         goto err;
 650     }
 651     release_context(hwcrhk_context);
 652     if (!DSO_free(hwcrhk_dso)) {
 653         HWCRHKerr(HWCRHK_F_HWCRHK_FINISH, HWCRHK_R_DSO_FAILURE);
 654         to_return = 0;
 655         goto err;
 656     }
 657  err:
 658     BIO_free(logstream);
 659     hwcrhk_dso = NULL;
 660     p_hwcrhk_Init = NULL;
 661     p_hwcrhk_Finish = NULL;
 662     p_hwcrhk_ModExp = NULL;
 663 #  ifndef OPENSSL_NO_RSA
 664     p_hwcrhk_RSA = NULL;
 665     p_hwcrhk_RSALoadKey = NULL;
 666     p_hwcrhk_RSAGetPublicKey = NULL;
 667     p_hwcrhk_RSAUnloadKey = NULL;
 668 #  endif
 669     p_hwcrhk_ModExpCRT = NULL;
 670     p_hwcrhk_RandomBytes = NULL;
 671     return to_return;
 672 }
 673
 674 static int hwcrhk_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
 675 {
 676     int to_return = 1;
 677
 678     switch (cmd) {
 679     case HWCRHK_CMD_SO_PATH:
 680         if (hwcrhk_dso) {
 681             HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, HWCRHK_R_ALREADY_LOADED);
 682             return 0;
 683         }
 684         if (p == NULL) {
 685             HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, ERR_R_PASSED_NULL_PARAMETER);
 686             return 0;
 687         }
 688         return set_HWCRHK_LIBNAME((const char *)p);
 689     case ENGINE_CTRL_SET_LOGSTREAM:
 690         {
 691             BIO *bio = (BIO *)p;
 692
 693             CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 694             BIO_free(logstream);
 695             logstream = NULL;
 696             if (CRYPTO_add(&bio->references, 1, CRYPTO_LOCK_BIO) > 1)
 697                 logstream = bio;
 698             else
 699                 HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, HWCRHK_R_BIO_WAS_FREED);
 700         }
 701         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 702         break;
 703     case ENGINE_CTRL_SET_PASSWORD_CALLBACK:
 704         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 705         password_context.password_callback = (pem_password_cb *)f;
 706         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 707         break;
 708     case ENGINE_CTRL_SET_USER_INTERFACE:
 709     case HWCRHK_CMD_SET_USER_INTERFACE:
 710         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 711         password_context.ui_method = (UI_METHOD *)p;
 712         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 713         break;
 714     case ENGINE_CTRL_SET_CALLBACK_DATA:
 715     case HWCRHK_CMD_SET_CALLBACK_DATA:
 716         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 717         password_context.callback_data = p;
 718         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 719         break;
 720         /*
 721          * this enables or disables the "SimpleForkCheck" flag used in the
 722          * initialisation structure.
 723          */
 724     case ENGINE_CTRL_CHIL_SET_FORKCHECK:
 725     case HWCRHK_CMD_FORK_CHECK:
 726         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 727         if (i)
 728             hwcrhk_globals.flags |= HWCryptoHook_InitFlags_SimpleForkCheck;
 729         else
 730             hwcrhk_globals.flags &= ~HWCryptoHook_InitFlags_SimpleForkCheck;
 731         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 732         break;
 733         /*
 734          * This will prevent the initialisation function from "installing"
 735          * the mutex-handling callbacks, even if they are available from
 736          * within the library (or were provided to the library from the
 737          * calling application). This is to remove any baggage for
 738          * applications not using multithreading.
 739          */
 740     case ENGINE_CTRL_CHIL_NO_LOCKING:
 741         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 742         disable_mutex_callbacks = 1;
 743         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 744         break;
 745     case HWCRHK_CMD_THREAD_LOCKING:
 746         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 747         disable_mutex_callbacks = ((i == 0) ? 0 : 1);
 748         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 749         break;
 750
 751         /* The command isn't understood by this engine */
 752     default:
 753         HWCRHKerr(HWCRHK_F_HWCRHK_CTRL,
 754                   HWCRHK_R_CTRL_COMMAND_NOT_IMPLEMENTED);
 755         to_return = 0;
 756         break;
 757     }
 758
 759     return to_return;
 760 }
 761
 762 static EVP_PKEY *hwcrhk_load_privkey(ENGINE *eng, const char *key_id,
 763                                      UI_METHOD *ui_method,
 764                                      void *callback_data)
 765 {
 766 #  ifndef OPENSSL_NO_RSA
 767     RSA *rtmp = NULL;
 768 #  endif
 769     EVP_PKEY *res = NULL;
 770 #  ifndef OPENSSL_NO_RSA
 771     HWCryptoHook_MPI e, n;
 772     HWCryptoHook_RSAKeyHandle *hptr;
 773 #  endif
 774 #  if !defined(OPENSSL_NO_RSA)
 775     char tempbuf[1024];
 776     HWCryptoHook_ErrMsgBuf rmsg;
 777     HWCryptoHook_PassphraseContext ppctx;
 778 #  endif
 779
 780 #  if !defined(OPENSSL_NO_RSA)
 781     rmsg.buf = tempbuf;
 782     rmsg.size = sizeof(tempbuf);
 783 #  endif
 784
 785     if (!hwcrhk_context) {
 786         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_NOT_INITIALISED);
 787         goto err;
 788     }
 789 #  ifndef OPENSSL_NO_RSA
 790     hptr = OPENSSL_malloc(sizeof(HWCryptoHook_RSAKeyHandle));
 791     if (!hptr) {
 792         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, ERR_R_MALLOC_FAILURE);
 793         goto err;
 794     }
 795     ppctx.ui_method = ui_method;
 796     ppctx.callback_data = callback_data;
 797     if (p_hwcrhk_RSALoadKey(hwcrhk_context, key_id, hptr, &rmsg, &ppctx)) {
 798         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
 799         ERR_add_error_data(1, rmsg.buf);
 800         goto err;
 801     }
 802     if (!*hptr) {
 803         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_NO_KEY);
 804         goto err;
 805     }
 806 #  endif
 807 #  ifndef OPENSSL_NO_RSA
 808     rtmp = RSA_new_method(eng);
 809     RSA_set_ex_data(rtmp, hndidx_rsa, (char *)hptr);
 810     rtmp->e = BN_new();
 811     rtmp->n = BN_new();
 812     rtmp->flags |= RSA_FLAG_EXT_PKEY;
 813     MPI2BN(rtmp->e, e);
 814     MPI2BN(rtmp->n, n);
 815     if (p_hwcrhk_RSAGetPublicKey(*hptr, &n, &e, &rmsg)
 816         != HWCRYPTOHOOK_ERROR_MPISIZE) {
 817         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
 818         ERR_add_error_data(1, rmsg.buf);
 819         goto err;
 820     }
 821
 822     bn_expand2(rtmp->e, e.size / sizeof(BN_ULONG));
 823     bn_expand2(rtmp->n, n.size / sizeof(BN_ULONG));
 824     MPI2BN(rtmp->e, e);
 825     MPI2BN(rtmp->n, n);
 826
 827     if (p_hwcrhk_RSAGetPublicKey(*hptr, &n, &e, &rmsg)) {
 828         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
 829         ERR_add_error_data(1, rmsg.buf);
 830         goto err;
 831     }
 832     rtmp->e->top = e.size / sizeof(BN_ULONG);
 833     bn_fix_top(rtmp->e);
 834     rtmp->n->top = n.size / sizeof(BN_ULONG);
 835     bn_fix_top(rtmp->n);
 836
 837     res = EVP_PKEY_new();
 838     EVP_PKEY_assign_RSA(res, rtmp);
 839 #  endif
 840
 841     if (!res)
 842         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY,
 843                   HWCRHK_R_PRIVATE_KEY_ALGORITHMS_DISABLED);
 844
 845     return res;
 846  err:
 847 #  ifndef OPENSSL_NO_RSA
 848     RSA_free(rtmp);
 849 #  endif
 850     return NULL;
 851 }
 852
 853 static EVP_PKEY *hwcrhk_load_pubkey(ENGINE *eng, const char *key_id,
 854                                     UI_METHOD *ui_method, void *callback_data)
 855 {
 856     EVP_PKEY *res = NULL;
 857
 858 #  ifndef OPENSSL_NO_RSA
 859     res = hwcrhk_load_privkey(eng, key_id, ui_method, callback_data);
 860 #  endif
 861
 862     if (res)
 863         switch (res->type) {
 864 #  ifndef OPENSSL_NO_RSA
 865         case EVP_PKEY_RSA:
 866             {
 867                 RSA *rsa = NULL;
 868
 869                 CRYPTO_w_lock(CRYPTO_LOCK_EVP_PKEY);
 870                 rsa = res->pkey.rsa;
 871                 res->pkey.rsa = RSA_new();
 872                 res->pkey.rsa->n = rsa->n;
 873                 res->pkey.rsa->e = rsa->e;
 874                 rsa->n = NULL;
 875                 rsa->e = NULL;
 876                 CRYPTO_w_unlock(CRYPTO_LOCK_EVP_PKEY);
 877                 RSA_free(rsa);
 878             }
 879             break;
 880 #  endif
 881         default:
 882             HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PUBKEY,
 883                       HWCRHK_R_CTRL_COMMAND_NOT_IMPLEMENTED);
 884             goto err;
 885         }
 886
 887     return res;
 888  err:
 889     EVP_PKEY_free(res);
 890     return NULL;
 891 }
 892
 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)
 896 {
 897     char tempbuf[1024];
 898     HWCryptoHook_ErrMsgBuf rmsg;
 899     /*
 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.
 903      */
 904     HWCryptoHook_MPI m_a, m_p, m_n, m_r;
 905     int to_return, ret;
 906
 907     to_return = 0;              /* expect failure */
 908     rmsg.buf = tempbuf;
 909     rmsg.size = sizeof(tempbuf);
 910
 911     if (!hwcrhk_context) {
 912         HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_NOT_INITIALISED);
 913         goto err;
 914     }
 915     /* Prepare the params */
 916     bn_expand2(r, m->top);      /* Check for error !! */
 917     BN2MPI(m_a, a);
 918     BN2MPI(m_p, p);
 919     BN2MPI(m_n, m);
 920     MPI2BN(r, m_r);
 921
 922     /* Perform the operation */
 923     ret = p_hwcrhk_ModExp(hwcrhk_context, m_a, m_p, m_n, &m_r, &rmsg);
 924
 925     /* Convert the response */
 926     r->top = m_r.size / sizeof(BN_ULONG);
 927     bn_fix_top(r);
 928
 929     if (ret < 0) {
 930         /*
 931          * FIXME: When this error is returned, HWCryptoHook is telling us
 932          * that falling back to software computation might be a good thing.
 933          */
 934         if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
 935             HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_REQUEST_FALLBACK);
 936         } else {
 937             HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_REQUEST_FAILED);
 938         }
 939         ERR_add_error_data(1, rmsg.buf);
 940         goto err;
 941     }
 942
 943     to_return = 1;
 944  err:
 945     return to_return;
 946 }
 947
 948 #  ifndef OPENSSL_NO_RSA
 949 static int hwcrhk_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa,
 950                               BN_CTX *ctx)
 951 {
 952     char tempbuf[1024];
 953     HWCryptoHook_ErrMsgBuf rmsg;
 954     HWCryptoHook_RSAKeyHandle *hptr;
 955     int to_return = 0, ret;
 956
 957     rmsg.buf = tempbuf;
 958     rmsg.size = sizeof(tempbuf);
 959
 960     if (!hwcrhk_context) {
 961         HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP, HWCRHK_R_NOT_INITIALISED);
 962         goto err;
 963     }
 964
 965     /*
 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
 968      * care of the rest.
 969      */
 970     if ((hptr =
 971          (HWCryptoHook_RSAKeyHandle *) RSA_get_ex_data(rsa, hndidx_rsa))
 972         != NULL) {
 973         HWCryptoHook_MPI m_a, m_r;
 974
 975         if (!rsa->n) {
 976             HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
 977                       HWCRHK_R_MISSING_KEY_COMPONENTS);
 978             goto err;
 979         }
 980
 981         /* Prepare the params */
 982         bn_expand2(r, rsa->n->top); /* Check for error !! */
 983         BN2MPI(m_a, I);
 984         MPI2BN(r, m_r);
 985
 986         /* Perform the operation */
 987         ret = p_hwcrhk_RSA(m_a, *hptr, &m_r, &rmsg);
 988
 989         /* Convert the response */
 990         r->top = m_r.size / sizeof(BN_ULONG);
 991         bn_fix_top(r);
 992
 993         if (ret < 0) {
 994             /*
 995              * FIXME: When this error is returned, HWCryptoHook is telling us
 996              * that falling back to software computation might be a good
 997              * thing.
 998              */
 999             if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
1000                 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1001                           HWCRHK_R_REQUEST_FALLBACK);
1002             } else {
1003                 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1004                           HWCRHK_R_REQUEST_FAILED);
1005             }
1006             ERR_add_error_data(1, rmsg.buf);
1007             goto err;
1008         }
1009     } else {
1010         HWCryptoHook_MPI m_a, m_p, m_q, m_dmp1, m_dmq1, m_iqmp, m_r;
1011
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);
1015             goto err;
1016         }
1017
1018         /* Prepare the params */
1019         bn_expand2(r, rsa->n->top); /* Check for error !! */
1020         BN2MPI(m_a, I);
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);
1026         MPI2BN(r, m_r);
1027
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);
1031
1032         /* Convert the response */
1033         r->top = m_r.size / sizeof(BN_ULONG);
1034         bn_fix_top(r);
1035
1036         if (ret < 0) {
1037             /*
1038              * FIXME: When this error is returned, HWCryptoHook is telling us
1039              * that falling back to software computation might be a good
1040              * thing.
1041              */
1042             if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
1043                 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1044                           HWCRHK_R_REQUEST_FALLBACK);
1045             } else {
1046                 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1047                           HWCRHK_R_REQUEST_FAILED);
1048             }
1049             ERR_add_error_data(1, rmsg.buf);
1050             goto err;
1051         }
1052     }
1053     /*
1054      * If we're here, we must be here with some semblance of success :-)
1055      */
1056     to_return = 1;
1057  err:
1058     return to_return;
1059 }
1060 #  endif
1061
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,
1066                                BN_MONT_CTX *m_ctx)
1067 {
1068     return hwcrhk_mod_exp(r, a, p, m, ctx);
1069 }
1070
1071 static int hwcrhk_rsa_finish(RSA *rsa)
1072 {
1073     HWCryptoHook_RSAKeyHandle *hptr;
1074
1075     hptr = RSA_get_ex_data(rsa, hndidx_rsa);
1076     if (hptr) {
1077         p_hwcrhk_RSAUnloadKey(*hptr, NULL);
1078         OPENSSL_free(hptr);
1079         RSA_set_ex_data(rsa, hndidx_rsa, NULL);
1080     }
1081     return 1;
1082 }
1083
1084 #  endif
1085
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)
1091 {
1092     return hwcrhk_mod_exp(r, a, p, m, ctx);
1093 }
1094 #  endif
1095
1096 /* Random bytes are good */
1097 static int hwcrhk_rand_bytes(unsigned char *buf, int num)
1098 {
1099     char tempbuf[1024];
1100     HWCryptoHook_ErrMsgBuf rmsg;
1101     int to_return = 0;          /* assume failure */
1102     int ret;
1103
1104     rmsg.buf = tempbuf;
1105     rmsg.size = sizeof(tempbuf);
1106
1107     if (!hwcrhk_context) {
1108         HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_NOT_INITIALISED);
1109         goto err;
1110     }
1111
1112     ret = p_hwcrhk_RandomBytes(hwcrhk_context, buf, num, &rmsg);
1113     if (ret < 0) {
1114         /*
1115          * FIXME: When this error is returned, HWCryptoHook is telling us
1116          * that falling back to software computation might be a good thing.
1117          */
1118         if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
1119             HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_REQUEST_FALLBACK);
1120         } else {
1121             HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_REQUEST_FAILED);
1122         }
1123         ERR_add_error_data(1, rmsg.buf);
1124         goto err;
1125     }
1126     to_return = 1;
1127  err:
1128     return to_return;
1129 }
1130
1131 static int hwcrhk_rand_status(void)
1132 {
1133     return 1;
1134 }
1135
1136 /*
1137  * Mutex calls: since the HWCryptoHook model closely follows the POSIX model
1138  * these just wrap the POSIX functions and add some logging.
1139  */
1140
1141 static int hwcrhk_mutex_init(HWCryptoHook_Mutex * mt,
1142                              HWCryptoHook_CallerContext * cactx)
1143 {
1144     mt->lockid = CRYPTO_get_new_dynlockid();
1145     if (mt->lockid == 0)
1146         return 1;               /* failure */
1147     return 0;                   /* success */
1148 }
1149
1150 static int hwcrhk_mutex_lock(HWCryptoHook_Mutex * mt)
1151 {
1152     CRYPTO_w_lock(mt->lockid);
1153     return 0;
1154 }
1155
1156 static void hwcrhk_mutex_unlock(HWCryptoHook_Mutex * mt)
1157 {
1158     CRYPTO_w_unlock(mt->lockid);
1159 }
1160
1161 static void hwcrhk_mutex_destroy(HWCryptoHook_Mutex * mt)
1162 {
1163     CRYPTO_destroy_dynlockid(mt->lockid);
1164 }
1165
1166 static int hwcrhk_get_pass(const char *prompt_info,
1167                            int *len_io, char *buf,
1168                            HWCryptoHook_PassphraseContext * ppctx,
1169                            HWCryptoHook_CallerContext * cactx)
1170 {
1171     pem_password_cb *callback = NULL;
1172     void *callback_data = NULL;
1173     UI_METHOD *ui_method = NULL;
1174     /*
1175      * Despite what the documentation says prompt_info can be an empty
1176      * string.
1177      */
1178     if (prompt_info && !*prompt_info)
1179         prompt_info = NULL;
1180
1181     if (cactx) {
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;
1188     }
1189     if (ppctx) {
1190         if (ppctx->ui_method) {
1191             ui_method = ppctx->ui_method;
1192             callback = NULL;
1193         }
1194         if (ppctx->callback_data)
1195             callback_data = ppctx->callback_data;
1196     }
1197     if (callback == NULL && ui_method == NULL) {
1198         HWCRHKerr(HWCRHK_F_HWCRHK_GET_PASS, HWCRHK_R_NO_CALLBACK);
1199         return -1;
1200     }
1201
1202     if (ui_method) {
1203         UI *ui = UI_new_method(ui_method);
1204         if (ui) {
1205             int ok;
1206             char *prompt = UI_construct_prompt(ui,
1207                                                "pass phrase", prompt_info);
1208
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);
1214
1215             if (ok >= 0)
1216                 do {
1217                     ok = UI_process(ui);
1218                 }
1219                 while (ok < 0 && UI_ctrl(ui, UI_CTRL_IS_REDOABLE, 0, 0, 0));
1220
1221             if (ok >= 0)
1222                 *len_io = strlen(buf);
1223
1224             UI_free(ui);
1225             OPENSSL_free(prompt);
1226         }
1227     } else {
1228         *len_io = callback(buf, *len_io, 0, callback_data);
1229     }
1230     if (!*len_io)
1231         return -1;
1232     return 0;
1233 }
1234
1235 static int hwcrhk_insert_card(const char *prompt_info,
1236                               const char *wrong_info,
1237                               HWCryptoHook_PassphraseContext * ppctx,
1238                               HWCryptoHook_CallerContext * cactx)
1239 {
1240     int ok = -1;
1241     UI *ui;
1242     void *callback_data = NULL;
1243     UI_METHOD *ui_method = NULL;
1244
1245     if (cactx) {
1246         if (cactx->ui_method)
1247             ui_method = cactx->ui_method;
1248         if (cactx->callback_data)
1249             callback_data = cactx->callback_data;
1250     }
1251     if (ppctx) {
1252         if (ppctx->ui_method)
1253             ui_method = ppctx->ui_method;
1254         if (ppctx->callback_data)
1255             callback_data = ppctx->callback_data;
1256     }
1257     if (ui_method == NULL) {
1258         HWCRHKerr(HWCRHK_F_HWCRHK_INSERT_CARD, HWCRHK_R_NO_CALLBACK);
1259         return -1;
1260     }
1261
1262     ui = UI_new_method(ui_method);
1263
1264     if (ui) {
1265         char answer;
1266         char buf[BUFSIZ];
1267         /*
1268          * Despite what the documentation says wrong_info can be an empty
1269          * string.
1270          */
1271         if (wrong_info && *wrong_info)
1272             BIO_snprintf(buf, sizeof(buf) - 1,
1273                          "Current card: \"%s\"\n", wrong_info);
1274         else
1275             buf[0] = 0;
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,
1283                                       &answer);
1284         }
1285         UI_add_user_data(ui, callback_data);
1286
1287         if (ok >= 0)
1288             ok = UI_process(ui);
1289         UI_free(ui);
1290
1291         if (ok == -2 || (ok >= 0 && answer == 'C'))
1292             ok = 1;
1293         else if (ok < 0)
1294             ok = -1;
1295         else
1296             ok = 0;
1297     }
1298     return ok;
1299 }
1300
1301 static void hwcrhk_log_message(void *logstr, const char *message)
1302 {
1303     BIO *lstream = NULL;
1304
1305     CRYPTO_w_lock(CRYPTO_LOCK_BIO);
1306     if (logstr)
1307         lstream = *(BIO **)logstr;
1308     if (lstream) {
1309         BIO_printf(lstream, "%s\n", message);
1310     }
1311     CRYPTO_w_unlock(CRYPTO_LOCK_BIO);
1312 }
1313
1314 /*
1315  * This stuff is needed if this ENGINE is being compiled into a
1316  * self-contained shared-library.
1317  */
1318 #  ifndef OPENSSL_NO_DYNAMIC_ENGINE
1319 static int bind_fn(ENGINE *e, const char *id)
1320 {
1321     if (id && (strcmp(id, engine_hwcrhk_id) != 0) &&
1322         (strcmp(id, engine_hwcrhk_id_alt) != 0))
1323         return 0;
1324     if (!bind_helper(e))
1325         return 0;
1326     return 1;
1327 }
1328
1329 IMPLEMENT_DYNAMIC_CHECK_FN()
1330     IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
1331 #  endif                        /* OPENSSL_NO_DYNAMIC_ENGINE */
1332 # endif                         /* !OPENSSL_NO_HW_CHIL */
1333 #endif                          /* !OPENSSL_NO_HW */