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     DSO_free(hwcrhk_dso);
 626     hwcrhk_dso = NULL;
 627     p_hwcrhk_Init = NULL;
 628     p_hwcrhk_Finish = NULL;
 629     p_hwcrhk_ModExp = NULL;
 630 #  ifndef OPENSSL_NO_RSA
 631     p_hwcrhk_RSA = NULL;
 632     p_hwcrhk_RSALoadKey = NULL;
 633     p_hwcrhk_RSAGetPublicKey = NULL;
 634     p_hwcrhk_RSAUnloadKey = NULL;
 635 #  endif
 636     p_hwcrhk_ModExpCRT = NULL;
 637     p_hwcrhk_RandomBytes = NULL;
 638     return 0;
 639 }
 640
 641 static int hwcrhk_finish(ENGINE *e)
 642 {
 643     int to_return = 1;
 644     free_HWCRHK_LIBNAME();
 645     if (hwcrhk_dso == NULL) {
 646         HWCRHKerr(HWCRHK_F_HWCRHK_FINISH, HWCRHK_R_NOT_LOADED);
 647         to_return = 0;
 648         goto err;
 649     }
 650     release_context(hwcrhk_context);
 651     if (!DSO_free(hwcrhk_dso)) {
 652         HWCRHKerr(HWCRHK_F_HWCRHK_FINISH, HWCRHK_R_DSO_FAILURE);
 653         to_return = 0;
 654         goto err;
 655     }
 656  err:
 657     BIO_free(logstream);
 658     hwcrhk_dso = NULL;
 659     p_hwcrhk_Init = NULL;
 660     p_hwcrhk_Finish = NULL;
 661     p_hwcrhk_ModExp = NULL;
 662 #  ifndef OPENSSL_NO_RSA
 663     p_hwcrhk_RSA = NULL;
 664     p_hwcrhk_RSALoadKey = NULL;
 665     p_hwcrhk_RSAGetPublicKey = NULL;
 666     p_hwcrhk_RSAUnloadKey = NULL;
 667 #  endif
 668     p_hwcrhk_ModExpCRT = NULL;
 669     p_hwcrhk_RandomBytes = NULL;
 670     return to_return;
 671 }
 672
 673 static int hwcrhk_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
 674 {
 675     int to_return = 1;
 676
 677     switch (cmd) {
 678     case HWCRHK_CMD_SO_PATH:
 679         if (hwcrhk_dso) {
 680             HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, HWCRHK_R_ALREADY_LOADED);
 681             return 0;
 682         }
 683         if (p == NULL) {
 684             HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, ERR_R_PASSED_NULL_PARAMETER);
 685             return 0;
 686         }
 687         return set_HWCRHK_LIBNAME((const char *)p);
 688     case ENGINE_CTRL_SET_LOGSTREAM:
 689         {
 690             BIO *bio = (BIO *)p;
 691
 692             CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 693             BIO_free(logstream);
 694             logstream = NULL;
 695             if (CRYPTO_add(&bio->references, 1, CRYPTO_LOCK_BIO) > 1)
 696                 logstream = bio;
 697             else
 698                 HWCRHKerr(HWCRHK_F_HWCRHK_CTRL, HWCRHK_R_BIO_WAS_FREED);
 699         }
 700         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 701         break;
 702     case ENGINE_CTRL_SET_PASSWORD_CALLBACK:
 703         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 704         password_context.password_callback = (pem_password_cb *)f;
 705         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 706         break;
 707     case ENGINE_CTRL_SET_USER_INTERFACE:
 708     case HWCRHK_CMD_SET_USER_INTERFACE:
 709         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 710         password_context.ui_method = (UI_METHOD *)p;
 711         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 712         break;
 713     case ENGINE_CTRL_SET_CALLBACK_DATA:
 714     case HWCRHK_CMD_SET_CALLBACK_DATA:
 715         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 716         password_context.callback_data = p;
 717         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 718         break;
 719         /*
 720          * this enables or disables the "SimpleForkCheck" flag used in the
 721          * initialisation structure.
 722          */
 723     case ENGINE_CTRL_CHIL_SET_FORKCHECK:
 724     case HWCRHK_CMD_FORK_CHECK:
 725         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 726         if (i)
 727             hwcrhk_globals.flags |= HWCryptoHook_InitFlags_SimpleForkCheck;
 728         else
 729             hwcrhk_globals.flags &= ~HWCryptoHook_InitFlags_SimpleForkCheck;
 730         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 731         break;
 732         /*
 733          * This will prevent the initialisation function from "installing"
 734          * the mutex-handling callbacks, even if they are available from
 735          * within the library (or were provided to the library from the
 736          * calling application). This is to remove any baggage for
 737          * applications not using multithreading.
 738          */
 739     case ENGINE_CTRL_CHIL_NO_LOCKING:
 740         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 741         disable_mutex_callbacks = 1;
 742         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 743         break;
 744     case HWCRHK_CMD_THREAD_LOCKING:
 745         CRYPTO_w_lock(CRYPTO_LOCK_ENGINE);
 746         disable_mutex_callbacks = ((i == 0) ? 0 : 1);
 747         CRYPTO_w_unlock(CRYPTO_LOCK_ENGINE);
 748         break;
 749
 750         /* The command isn't understood by this engine */
 751     default:
 752         HWCRHKerr(HWCRHK_F_HWCRHK_CTRL,
 753                   HWCRHK_R_CTRL_COMMAND_NOT_IMPLEMENTED);
 754         to_return = 0;
 755         break;
 756     }
 757
 758     return to_return;
 759 }
 760
 761 static EVP_PKEY *hwcrhk_load_privkey(ENGINE *eng, const char *key_id,
 762                                      UI_METHOD *ui_method,
 763                                      void *callback_data)
 764 {
 765 #  ifndef OPENSSL_NO_RSA
 766     RSA *rtmp = NULL;
 767 #  endif
 768     EVP_PKEY *res = NULL;
 769 #  ifndef OPENSSL_NO_RSA
 770     HWCryptoHook_MPI e, n;
 771     HWCryptoHook_RSAKeyHandle *hptr;
 772 #  endif
 773 #  if !defined(OPENSSL_NO_RSA)
 774     char tempbuf[1024];
 775     HWCryptoHook_ErrMsgBuf rmsg;
 776     HWCryptoHook_PassphraseContext ppctx;
 777 #  endif
 778
 779 #  if !defined(OPENSSL_NO_RSA)
 780     rmsg.buf = tempbuf;
 781     rmsg.size = sizeof(tempbuf);
 782 #  endif
 783
 784     if (!hwcrhk_context) {
 785         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_NOT_INITIALISED);
 786         goto err;
 787     }
 788 #  ifndef OPENSSL_NO_RSA
 789     hptr = OPENSSL_malloc(sizeof(*hptr));
 790     if (!hptr) {
 791         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, ERR_R_MALLOC_FAILURE);
 792         goto err;
 793     }
 794     ppctx.ui_method = ui_method;
 795     ppctx.callback_data = callback_data;
 796     if (p_hwcrhk_RSALoadKey(hwcrhk_context, key_id, hptr, &rmsg, &ppctx)) {
 797         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
 798         ERR_add_error_data(1, rmsg.buf);
 799         goto err;
 800     }
 801     if (!*hptr) {
 802         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_NO_KEY);
 803         goto err;
 804     }
 805 #  endif
 806 #  ifndef OPENSSL_NO_RSA
 807     rtmp = RSA_new_method(eng);
 808     RSA_set_ex_data(rtmp, hndidx_rsa, (char *)hptr);
 809     rtmp->e = BN_new();
 810     rtmp->n = BN_new();
 811     rtmp->flags |= RSA_FLAG_EXT_PKEY;
 812     MPI2BN(rtmp->e, e);
 813     MPI2BN(rtmp->n, n);
 814     if (p_hwcrhk_RSAGetPublicKey(*hptr, &n, &e, &rmsg)
 815         != HWCRYPTOHOOK_ERROR_MPISIZE) {
 816         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
 817         ERR_add_error_data(1, rmsg.buf);
 818         goto err;
 819     }
 820
 821     bn_expand2(rtmp->e, e.size / sizeof(BN_ULONG));
 822     bn_expand2(rtmp->n, n.size / sizeof(BN_ULONG));
 823     MPI2BN(rtmp->e, e);
 824     MPI2BN(rtmp->n, n);
 825
 826     if (p_hwcrhk_RSAGetPublicKey(*hptr, &n, &e, &rmsg)) {
 827         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY, HWCRHK_R_CHIL_ERROR);
 828         ERR_add_error_data(1, rmsg.buf);
 829         goto err;
 830     }
 831     rtmp->e->top = e.size / sizeof(BN_ULONG);
 832     bn_fix_top(rtmp->e);
 833     rtmp->n->top = n.size / sizeof(BN_ULONG);
 834     bn_fix_top(rtmp->n);
 835
 836     res = EVP_PKEY_new();
 837     EVP_PKEY_assign_RSA(res, rtmp);
 838 #  endif
 839
 840     if (!res)
 841         HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PRIVKEY,
 842                   HWCRHK_R_PRIVATE_KEY_ALGORITHMS_DISABLED);
 843
 844     return res;
 845  err:
 846 #  ifndef OPENSSL_NO_RSA
 847     RSA_free(rtmp);
 848 #  endif
 849     return NULL;
 850 }
 851
 852 static EVP_PKEY *hwcrhk_load_pubkey(ENGINE *eng, const char *key_id,
 853                                     UI_METHOD *ui_method, void *callback_data)
 854 {
 855     EVP_PKEY *res = NULL;
 856
 857 #  ifndef OPENSSL_NO_RSA
 858     res = hwcrhk_load_privkey(eng, key_id, ui_method, callback_data);
 859 #  endif
 860
 861     if (res)
 862         switch (res->type) {
 863 #  ifndef OPENSSL_NO_RSA
 864         case EVP_PKEY_RSA:
 865             {
 866                 RSA *rsa = NULL;
 867
 868                 CRYPTO_w_lock(CRYPTO_LOCK_EVP_PKEY);
 869                 rsa = res->pkey.rsa;
 870                 res->pkey.rsa = RSA_new();
 871                 res->pkey.rsa->n = rsa->n;
 872                 res->pkey.rsa->e = rsa->e;
 873                 rsa->n = NULL;
 874                 rsa->e = NULL;
 875                 CRYPTO_w_unlock(CRYPTO_LOCK_EVP_PKEY);
 876                 RSA_free(rsa);
 877             }
 878             break;
 879 #  endif
 880         default:
 881             HWCRHKerr(HWCRHK_F_HWCRHK_LOAD_PUBKEY,
 882                       HWCRHK_R_CTRL_COMMAND_NOT_IMPLEMENTED);
 883             goto err;
 884         }
 885
 886     return res;
 887  err:
 888     EVP_PKEY_free(res);
 889     return NULL;
 890 }
 891
 892 /* A little mod_exp */
 893 static int hwcrhk_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 894                           const BIGNUM *m, BN_CTX *ctx)
 895 {
 896     char tempbuf[1024];
 897     HWCryptoHook_ErrMsgBuf rmsg;
 898     /*
 899      * Since HWCryptoHook_MPI is pretty compatible with BIGNUM's, we use them
 900      * directly, plus a little macro magic.  We only thing we need to make
 901      * sure of is that enough space is allocated.
 902      */
 903     HWCryptoHook_MPI m_a, m_p, m_n, m_r;
 904     int to_return, ret;
 905
 906     to_return = 0;              /* expect failure */
 907     rmsg.buf = tempbuf;
 908     rmsg.size = sizeof(tempbuf);
 909
 910     if (!hwcrhk_context) {
 911         HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_NOT_INITIALISED);
 912         goto err;
 913     }
 914     /* Prepare the params */
 915     bn_expand2(r, m->top);      /* Check for error !! */
 916     BN2MPI(m_a, a);
 917     BN2MPI(m_p, p);
 918     BN2MPI(m_n, m);
 919     MPI2BN(r, m_r);
 920
 921     /* Perform the operation */
 922     ret = p_hwcrhk_ModExp(hwcrhk_context, m_a, m_p, m_n, &m_r, &rmsg);
 923
 924     /* Convert the response */
 925     r->top = m_r.size / sizeof(BN_ULONG);
 926     bn_fix_top(r);
 927
 928     if (ret < 0) {
 929         /*
 930          * FIXME: When this error is returned, HWCryptoHook is telling us
 931          * that falling back to software computation might be a good thing.
 932          */
 933         if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
 934             HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_REQUEST_FALLBACK);
 935         } else {
 936             HWCRHKerr(HWCRHK_F_HWCRHK_MOD_EXP, HWCRHK_R_REQUEST_FAILED);
 937         }
 938         ERR_add_error_data(1, rmsg.buf);
 939         goto err;
 940     }
 941
 942     to_return = 1;
 943  err:
 944     return to_return;
 945 }
 946
 947 #  ifndef OPENSSL_NO_RSA
 948 static int hwcrhk_rsa_mod_exp(BIGNUM *r, const BIGNUM *I, RSA *rsa,
 949                               BN_CTX *ctx)
 950 {
 951     char tempbuf[1024];
 952     HWCryptoHook_ErrMsgBuf rmsg;
 953     HWCryptoHook_RSAKeyHandle *hptr;
 954     int to_return = 0, ret;
 955
 956     rmsg.buf = tempbuf;
 957     rmsg.size = sizeof(tempbuf);
 958
 959     if (!hwcrhk_context) {
 960         HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP, HWCRHK_R_NOT_INITIALISED);
 961         goto err;
 962     }
 963
 964     /*
 965      * This provides support for nForce keys.  Since that's opaque data all
 966      * we do is provide a handle to the proper key and let HWCryptoHook take
 967      * care of the rest.
 968      */
 969     if ((hptr =
 970          (HWCryptoHook_RSAKeyHandle *) RSA_get_ex_data(rsa, hndidx_rsa))
 971         != NULL) {
 972         HWCryptoHook_MPI m_a, m_r;
 973
 974         if (!rsa->n) {
 975             HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
 976                       HWCRHK_R_MISSING_KEY_COMPONENTS);
 977             goto err;
 978         }
 979
 980         /* Prepare the params */
 981         bn_expand2(r, rsa->n->top); /* Check for error !! */
 982         BN2MPI(m_a, I);
 983         MPI2BN(r, m_r);
 984
 985         /* Perform the operation */
 986         ret = p_hwcrhk_RSA(m_a, *hptr, &m_r, &rmsg);
 987
 988         /* Convert the response */
 989         r->top = m_r.size / sizeof(BN_ULONG);
 990         bn_fix_top(r);
 991
 992         if (ret < 0) {
 993             /*
 994              * FIXME: When this error is returned, HWCryptoHook is telling us
 995              * that falling back to software computation might be a good
 996              * thing.
 997              */
 998             if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
 999                 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1000                           HWCRHK_R_REQUEST_FALLBACK);
1001             } else {
1002                 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1003                           HWCRHK_R_REQUEST_FAILED);
1004             }
1005             ERR_add_error_data(1, rmsg.buf);
1006             goto err;
1007         }
1008     } else {
1009         HWCryptoHook_MPI m_a, m_p, m_q, m_dmp1, m_dmq1, m_iqmp, m_r;
1010
1011         if (!rsa->p || !rsa->q || !rsa->dmp1 || !rsa->dmq1 || !rsa->iqmp) {
1012             HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1013                       HWCRHK_R_MISSING_KEY_COMPONENTS);
1014             goto err;
1015         }
1016
1017         /* Prepare the params */
1018         bn_expand2(r, rsa->n->top); /* Check for error !! */
1019         BN2MPI(m_a, I);
1020         BN2MPI(m_p, rsa->p);
1021         BN2MPI(m_q, rsa->q);
1022         BN2MPI(m_dmp1, rsa->dmp1);
1023         BN2MPI(m_dmq1, rsa->dmq1);
1024         BN2MPI(m_iqmp, rsa->iqmp);
1025         MPI2BN(r, m_r);
1026
1027         /* Perform the operation */
1028         ret = p_hwcrhk_ModExpCRT(hwcrhk_context, m_a, m_p, m_q,
1029                                  m_dmp1, m_dmq1, m_iqmp, &m_r, &rmsg);
1030
1031         /* Convert the response */
1032         r->top = m_r.size / sizeof(BN_ULONG);
1033         bn_fix_top(r);
1034
1035         if (ret < 0) {
1036             /*
1037              * FIXME: When this error is returned, HWCryptoHook is telling us
1038              * that falling back to software computation might be a good
1039              * thing.
1040              */
1041             if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
1042                 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1043                           HWCRHK_R_REQUEST_FALLBACK);
1044             } else {
1045                 HWCRHKerr(HWCRHK_F_HWCRHK_RSA_MOD_EXP,
1046                           HWCRHK_R_REQUEST_FAILED);
1047             }
1048             ERR_add_error_data(1, rmsg.buf);
1049             goto err;
1050         }
1051     }
1052     /*
1053      * If we're here, we must be here with some semblance of success :-)
1054      */
1055     to_return = 1;
1056  err:
1057     return to_return;
1058 }
1059 #  endif
1060
1061 #  ifndef OPENSSL_NO_RSA
1062 /* This function is aliased to mod_exp (with the mont stuff dropped). */
1063 static int hwcrhk_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
1064                                const BIGNUM *m, BN_CTX *ctx,
1065                                BN_MONT_CTX *m_ctx)
1066 {
1067     return hwcrhk_mod_exp(r, a, p, m, ctx);
1068 }
1069
1070 static int hwcrhk_rsa_finish(RSA *rsa)
1071 {
1072     HWCryptoHook_RSAKeyHandle *hptr;
1073
1074     hptr = RSA_get_ex_data(rsa, hndidx_rsa);
1075     if (hptr) {
1076         p_hwcrhk_RSAUnloadKey(*hptr, NULL);
1077         OPENSSL_free(hptr);
1078         RSA_set_ex_data(rsa, hndidx_rsa, NULL);
1079     }
1080     return 1;
1081 }
1082
1083 #  endif
1084
1085 #  ifndef OPENSSL_NO_DH
1086 /* This function is aliased to mod_exp (with the dh and mont dropped). */
1087 static int hwcrhk_mod_exp_dh(const DH *dh, BIGNUM *r,
1088                              const BIGNUM *a, const BIGNUM *p,
1089                              const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
1090 {
1091     return hwcrhk_mod_exp(r, a, p, m, ctx);
1092 }
1093 #  endif
1094
1095 /* Random bytes are good */
1096 static int hwcrhk_rand_bytes(unsigned char *buf, int num)
1097 {
1098     char tempbuf[1024];
1099     HWCryptoHook_ErrMsgBuf rmsg;
1100     int to_return = 0;          /* assume failure */
1101     int ret;
1102
1103     rmsg.buf = tempbuf;
1104     rmsg.size = sizeof(tempbuf);
1105
1106     if (!hwcrhk_context) {
1107         HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_NOT_INITIALISED);
1108         goto err;
1109     }
1110
1111     ret = p_hwcrhk_RandomBytes(hwcrhk_context, buf, num, &rmsg);
1112     if (ret < 0) {
1113         /*
1114          * FIXME: When this error is returned, HWCryptoHook is telling us
1115          * that falling back to software computation might be a good thing.
1116          */
1117         if (ret == HWCRYPTOHOOK_ERROR_FALLBACK) {
1118             HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_REQUEST_FALLBACK);
1119         } else {
1120             HWCRHKerr(HWCRHK_F_HWCRHK_RAND_BYTES, HWCRHK_R_REQUEST_FAILED);
1121         }
1122         ERR_add_error_data(1, rmsg.buf);
1123         goto err;
1124     }
1125     to_return = 1;
1126  err:
1127     return to_return;
1128 }
1129
1130 static int hwcrhk_rand_status(void)
1131 {
1132     return 1;
1133 }
1134
1135 /*
1136  * Mutex calls: since the HWCryptoHook model closely follows the POSIX model
1137  * these just wrap the POSIX functions and add some logging.
1138  */
1139
1140 static int hwcrhk_mutex_init(HWCryptoHook_Mutex * mt,
1141                              HWCryptoHook_CallerContext * cactx)
1142 {
1143     mt->lockid = CRYPTO_get_new_dynlockid();
1144     if (mt->lockid == 0)
1145         return 1;               /* failure */
1146     return 0;                   /* success */
1147 }
1148
1149 static int hwcrhk_mutex_lock(HWCryptoHook_Mutex * mt)
1150 {
1151     CRYPTO_w_lock(mt->lockid);
1152     return 0;
1153 }
1154
1155 static void hwcrhk_mutex_unlock(HWCryptoHook_Mutex * mt)
1156 {
1157     CRYPTO_w_unlock(mt->lockid);
1158 }
1159
1160 static void hwcrhk_mutex_destroy(HWCryptoHook_Mutex * mt)
1161 {
1162     CRYPTO_destroy_dynlockid(mt->lockid);
1163 }
1164
1165 static int hwcrhk_get_pass(const char *prompt_info,
1166                            int *len_io, char *buf,
1167                            HWCryptoHook_PassphraseContext * ppctx,
1168                            HWCryptoHook_CallerContext * cactx)
1169 {
1170     pem_password_cb *callback = NULL;
1171     void *callback_data = NULL;
1172     UI_METHOD *ui_method = NULL;
1173     /*
1174      * Despite what the documentation says prompt_info can be an empty
1175      * string.
1176      */
1177     if (prompt_info && !*prompt_info)
1178         prompt_info = NULL;
1179
1180     if (cactx) {
1181         if (cactx->ui_method)
1182             ui_method = cactx->ui_method;
1183         if (cactx->password_callback)
1184             callback = cactx->password_callback;
1185         if (cactx->callback_data)
1186             callback_data = cactx->callback_data;
1187     }
1188     if (ppctx) {
1189         if (ppctx->ui_method) {
1190             ui_method = ppctx->ui_method;
1191             callback = NULL;
1192         }
1193         if (ppctx->callback_data)
1194             callback_data = ppctx->callback_data;
1195     }
1196     if (callback == NULL && ui_method == NULL) {
1197         HWCRHKerr(HWCRHK_F_HWCRHK_GET_PASS, HWCRHK_R_NO_CALLBACK);
1198         return -1;
1199     }
1200
1201     if (ui_method) {
1202         UI *ui = UI_new_method(ui_method);
1203         if (ui) {
1204             int ok;
1205             char *prompt = UI_construct_prompt(ui,
1206                                                "pass phrase", prompt_info);
1207
1208             ok = UI_add_input_string(ui, prompt,
1209                                      UI_INPUT_FLAG_DEFAULT_PWD,
1210                                      buf, 0, (*len_io) - 1);
1211             UI_add_user_data(ui, callback_data);
1212             UI_ctrl(ui, UI_CTRL_PRINT_ERRORS, 1, 0, 0);
1213
1214             if (ok >= 0)
1215                 do {
1216                     ok = UI_process(ui);
1217                 }
1218                 while (ok < 0 && UI_ctrl(ui, UI_CTRL_IS_REDOABLE, 0, 0, 0));
1219
1220             if (ok >= 0)
1221                 *len_io = strlen(buf);
1222
1223             UI_free(ui);
1224             OPENSSL_free(prompt);
1225         }
1226     } else {
1227         *len_io = callback(buf, *len_io, 0, callback_data);
1228     }
1229     if (!*len_io)
1230         return -1;
1231     return 0;
1232 }
1233
1234 static int hwcrhk_insert_card(const char *prompt_info,
1235                               const char *wrong_info,
1236                               HWCryptoHook_PassphraseContext * ppctx,
1237                               HWCryptoHook_CallerContext * cactx)
1238 {
1239     int ok = -1;
1240     UI *ui;
1241     void *callback_data = NULL;
1242     UI_METHOD *ui_method = NULL;
1243
1244     if (cactx) {
1245         if (cactx->ui_method)
1246             ui_method = cactx->ui_method;
1247         if (cactx->callback_data)
1248             callback_data = cactx->callback_data;
1249     }
1250     if (ppctx) {
1251         if (ppctx->ui_method)
1252             ui_method = ppctx->ui_method;
1253         if (ppctx->callback_data)
1254             callback_data = ppctx->callback_data;
1255     }
1256     if (ui_method == NULL) {
1257         HWCRHKerr(HWCRHK_F_HWCRHK_INSERT_CARD, HWCRHK_R_NO_CALLBACK);
1258         return -1;
1259     }
1260
1261     ui = UI_new_method(ui_method);
1262
1263     if (ui) {
1264         char answer;
1265         char buf[BUFSIZ];
1266         /*
1267          * Despite what the documentation says wrong_info can be an empty
1268          * string.
1269          */
1270         if (wrong_info && *wrong_info)
1271             BIO_snprintf(buf, sizeof(buf) - 1,
1272                          "Current card: \"%s\"\n", wrong_info);
1273         else
1274             buf[0] = 0;
1275         ok = UI_dup_info_string(ui, buf);
1276         if (ok >= 0 && prompt_info) {
1277             BIO_snprintf(buf, sizeof(buf) - 1,
1278                          "Insert card \"%s\"", prompt_info);
1279             ok = UI_dup_input_boolean(ui, buf,
1280                                       "\n then hit <enter> or C<enter> to cancel\n",
1281                                       "\r\n", "Cc", UI_INPUT_FLAG_ECHO,
1282                                       &answer);
1283         }
1284         UI_add_user_data(ui, callback_data);
1285
1286         if (ok >= 0)
1287             ok = UI_process(ui);
1288         UI_free(ui);
1289
1290         if (ok == -2 || (ok >= 0 && answer == 'C'))
1291             ok = 1;
1292         else if (ok < 0)
1293             ok = -1;
1294         else
1295             ok = 0;
1296     }
1297     return ok;
1298 }
1299
1300 static void hwcrhk_log_message(void *logstr, const char *message)
1301 {
1302     BIO *lstream = NULL;
1303
1304     CRYPTO_w_lock(CRYPTO_LOCK_BIO);
1305     if (logstr)
1306         lstream = *(BIO **)logstr;
1307     if (lstream) {
1308         BIO_printf(lstream, "%s\n", message);
1309     }
1310     CRYPTO_w_unlock(CRYPTO_LOCK_BIO);
1311 }
1312
1313 /*
1314  * This stuff is needed if this ENGINE is being compiled into a
1315  * self-contained shared-library.
1316  */
1317 #  ifndef OPENSSL_NO_DYNAMIC_ENGINE
1318 static int bind_fn(ENGINE *e, const char *id)
1319 {
1320     if (id && (strcmp(id, engine_hwcrhk_id) != 0) &&
1321         (strcmp(id, engine_hwcrhk_id_alt) != 0))
1322         return 0;
1323     if (!bind_helper(e))
1324         return 0;
1325     return 1;
1326 }
1327
1328 IMPLEMENT_DYNAMIC_CHECK_FN()
1329     IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
1330 #  endif                        /* OPENSSL_NO_DYNAMIC_ENGINE */
1331 # endif                         /* !OPENSSL_NO_HW_CHIL */
1332 #endif                          /* !OPENSSL_NO_HW */