engines/e_ubsec.c

   1 /* crypto/engine/hw_ubsec.c */
   2 /*
   3  * Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL project
   4  * 2000. Cloned shamelessly by Joe Tardo.
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 1999-2001 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. All advertising materials mentioning features or use of this
  22  *    software must display the following acknowledgment:
  23  *    "This product includes software developed by the OpenSSL Project
  24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25  *
  26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27  *    endorse or promote products derived from this software without
  28  *    prior written permission. For written permission, please contact
  29  *    licensing@OpenSSL.org.
  30  *
  31  * 5. Products derived from this software may not be called "OpenSSL"
  32  *    nor may "OpenSSL" appear in their names without prior written
  33  *    permission of the OpenSSL Project.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51  * OF THE POSSIBILITY OF SUCH DAMAGE.
  52  * ====================================================================
  53  *
  54  * This product includes cryptographic software written by Eric Young
  55  * (eay@cryptsoft.com).  This product includes software written by Tim
  56  * Hudson (tjh@cryptsoft.com).
  57  *
  58  */
  59
  60 #include <stdio.h>
  61 #include <string.h>
  62 #include <openssl/crypto.h>
  63 #include <openssl/buffer.h>
  64 #include <openssl/dso.h>
  65 #include <openssl/engine.h>
  66 #ifndef OPENSSL_NO_RSA
  67 # include <openssl/rsa.h>
  68 #endif
  69 #ifndef OPENSSL_NO_DSA
  70 # include <openssl/dsa.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_UBSEC
  79
  80 #  ifdef FLAT_INC
  81 #   include "hw_ubsec.h"
  82 #  else
  83 #   include "vendor_defns/hw_ubsec.h"
  84 #  endif
  85
  86 #  define UBSEC_LIB_NAME "ubsec engine"
  87 #  include "e_ubsec_err.c"
  88
  89 #  define FAIL_TO_SOFTWARE -15
  90
  91 static int ubsec_destroy(ENGINE *e);
  92 static int ubsec_init(ENGINE *e);
  93 static int ubsec_finish(ENGINE *e);
  94 static int ubsec_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
  95 static int ubsec_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
  96                          const BIGNUM *m, BN_CTX *ctx);
  97 #  ifndef OPENSSL_NO_RSA
  98 static int ubsec_mod_exp_crt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
  99                              const BIGNUM *q, const BIGNUM *dp,
 100                              const BIGNUM *dq, const BIGNUM *qinv,
 101                              BN_CTX *ctx);
 102 static int ubsec_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa,
 103                              BN_CTX *ctx);
 104 static int ubsec_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 105                               const BIGNUM *m, BN_CTX *ctx,
 106                               BN_MONT_CTX *m_ctx);
 107 #  endif
 108 #  ifndef OPENSSL_NO_DSA
 109 #   ifdef NOT_USED
 110 static int ubsec_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
 111                              BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
 112                              BN_CTX *ctx, BN_MONT_CTX *in_mont);
 113 static int ubsec_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
 114                              const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
 115                              BN_MONT_CTX *m_ctx);
 116 #   endif
 117 static DSA_SIG *ubsec_dsa_do_sign(const unsigned char *dgst, int dlen,
 118                                   DSA *dsa);
 119 static int ubsec_dsa_verify(const unsigned char *dgst, int dgst_len,
 120                             DSA_SIG *sig, DSA *dsa);
 121 #  endif
 122 #  ifndef OPENSSL_NO_DH
 123 static int ubsec_mod_exp_dh(const DH *dh, BIGNUM *r, const BIGNUM *a,
 124                             const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
 125                             BN_MONT_CTX *m_ctx);
 126 static int ubsec_dh_compute_key(unsigned char *key, const BIGNUM *pub_key,
 127                                 DH *dh);
 128 static int ubsec_dh_generate_key(DH *dh);
 129 #  endif
 130
 131 #  ifdef NOT_USED
 132 static int ubsec_rand_bytes(unsigned char *buf, int num);
 133 static int ubsec_rand_status(void);
 134 #  endif
 135
 136 #  define UBSEC_CMD_SO_PATH               ENGINE_CMD_BASE
 137 static const ENGINE_CMD_DEFN ubsec_cmd_defns[] = {
 138     {UBSEC_CMD_SO_PATH,
 139      "SO_PATH",
 140      "Specifies the path to the 'ubsec' shared library",
 141      ENGINE_CMD_FLAG_STRING},
 142     {0, NULL, NULL, 0}
 143 };
 144
 145 #  ifndef OPENSSL_NO_RSA
 146 /* Our internal RSA_METHOD that we provide pointers to */
 147 static RSA_METHOD ubsec_rsa = {
 148     "UBSEC RSA method",
 149     NULL,
 150     NULL,
 151     NULL,
 152     NULL,
 153     ubsec_rsa_mod_exp,
 154     ubsec_mod_exp_mont,
 155     NULL,
 156     NULL,
 157     0,
 158     NULL,
 159     NULL,
 160     NULL,
 161     NULL
 162 };
 163 #  endif
 164
 165 #  ifndef OPENSSL_NO_DSA
 166 /* Our internal DSA_METHOD that we provide pointers to */
 167 static DSA_METHOD ubsec_dsa = {
 168     "UBSEC DSA method",
 169     ubsec_dsa_do_sign,          /* dsa_do_sign */
 170     NULL,                       /* dsa_sign_setup */
 171     ubsec_dsa_verify,           /* dsa_do_verify */
 172     NULL,                       /* ubsec_dsa_mod_exp *//* dsa_mod_exp */
 173     NULL,                       /* ubsec_mod_exp_dsa *//* bn_mod_exp */
 174     NULL,                       /* init */
 175     NULL,                       /* finish */
 176     0,                          /* flags */
 177     NULL,                       /* app_data */
 178     NULL,                       /* dsa_paramgen */
 179     NULL                        /* dsa_keygen */
 180 };
 181 #  endif
 182
 183 #  ifndef OPENSSL_NO_DH
 184 /* Our internal DH_METHOD that we provide pointers to */
 185 static DH_METHOD ubsec_dh = {
 186     "UBSEC DH method",
 187     ubsec_dh_generate_key,
 188     ubsec_dh_compute_key,
 189     ubsec_mod_exp_dh,
 190     NULL,
 191     NULL,
 192     0,
 193     NULL,
 194     NULL
 195 };
 196 #  endif
 197
 198 /* Constants used when creating the ENGINE */
 199 static const char *engine_ubsec_id = "ubsec";
 200 static const char *engine_ubsec_name = "UBSEC hardware engine support";
 201
 202 /*
 203  * This internal function is used by ENGINE_ubsec() and possibly by the
 204  * "dynamic" ENGINE support too
 205  */
 206 static int bind_helper(ENGINE *e)
 207 {
 208 #  ifndef OPENSSL_NO_RSA
 209     const RSA_METHOD *meth1;
 210 #  endif
 211 #  ifndef OPENSSL_NO_DH
 212 #   ifndef HAVE_UBSEC_DH
 213     const DH_METHOD *meth3;
 214 #   endif                       /* HAVE_UBSEC_DH */
 215 #  endif
 216     if (!ENGINE_set_id(e, engine_ubsec_id) ||
 217         !ENGINE_set_name(e, engine_ubsec_name) ||
 218 #  ifndef OPENSSL_NO_RSA
 219         !ENGINE_set_RSA(e, &ubsec_rsa) ||
 220 #  endif
 221 #  ifndef OPENSSL_NO_DSA
 222         !ENGINE_set_DSA(e, &ubsec_dsa) ||
 223 #  endif
 224 #  ifndef OPENSSL_NO_DH
 225         !ENGINE_set_DH(e, &ubsec_dh) ||
 226 #  endif
 227         !ENGINE_set_destroy_function(e, ubsec_destroy) ||
 228         !ENGINE_set_init_function(e, ubsec_init) ||
 229         !ENGINE_set_finish_function(e, ubsec_finish) ||
 230         !ENGINE_set_ctrl_function(e, ubsec_ctrl) ||
 231         !ENGINE_set_cmd_defns(e, ubsec_cmd_defns))
 232         return 0;
 233
 234 #  ifndef OPENSSL_NO_RSA
 235     /*
 236      * We know that the "PKCS1_SSLeay()" functions hook properly to the
 237      * Broadcom-specific mod_exp and mod_exp_crt so we use those functions.
 238      * NB: We don't use ENGINE_openssl() or anything "more generic" because
 239      * something like the RSAref code may not hook properly, and if you own
 240      * one of these cards then you have the right to do RSA operations on it
 241      * anyway!
 242      */
 243     meth1 = RSA_PKCS1_SSLeay();
 244     ubsec_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
 245     ubsec_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
 246     ubsec_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
 247     ubsec_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
 248 #  endif
 249
 250 #  ifndef OPENSSL_NO_DH
 251 #   ifndef HAVE_UBSEC_DH
 252     /* Much the same for Diffie-Hellman */
 253     meth3 = DH_OpenSSL();
 254     ubsec_dh.generate_key = meth3->generate_key;
 255     ubsec_dh.compute_key = meth3->compute_key;
 256 #   endif                       /* HAVE_UBSEC_DH */
 257 #  endif
 258
 259     /* Ensure the ubsec error handling is set up */
 260     ERR_load_UBSEC_strings();
 261     return 1;
 262 }
 263
 264 #  ifdef OPENSSL_NO_DYNAMIC_ENGINE
 265 static ENGINE *engine_ubsec(void)
 266 {
 267     ENGINE *ret = ENGINE_new();
 268     if (!ret)
 269         return NULL;
 270     if (!bind_helper(ret)) {
 271         ENGINE_free(ret);
 272         return NULL;
 273     }
 274     return ret;
 275 }
 276
 277 void ENGINE_load_ubsec(void)
 278 {
 279     /* Copied from eng_[openssl|dyn].c */
 280     ENGINE *toadd = engine_ubsec();
 281     if (!toadd)
 282         return;
 283     ENGINE_add(toadd);
 284     ENGINE_free(toadd);
 285     ERR_clear_error();
 286 }
 287 #  endif
 288
 289 /*
 290  * This is a process-global DSO handle used for loading and unloading the
 291  * UBSEC library. NB: This is only set (or unset) during an init() or
 292  * finish() call (reference counts permitting) and they're operating with
 293  * global locks, so this should be thread-safe implicitly.
 294  */
 295
 296 static DSO *ubsec_dso = NULL;
 297
 298 /*
 299  * These are the function pointers that are (un)set when the library has
 300  * successfully (un)loaded.
 301  */
 302
 303 static t_UBSEC_ubsec_bytes_to_bits *p_UBSEC_ubsec_bytes_to_bits = NULL;
 304 static t_UBSEC_ubsec_bits_to_bytes *p_UBSEC_ubsec_bits_to_bytes = NULL;
 305 static t_UBSEC_ubsec_open *p_UBSEC_ubsec_open = NULL;
 306 static t_UBSEC_ubsec_close *p_UBSEC_ubsec_close = NULL;
 307 #  ifndef OPENSSL_NO_DH
 308 static t_UBSEC_diffie_hellman_generate_ioctl
 309     * p_UBSEC_diffie_hellman_generate_ioctl = NULL;
 310 static t_UBSEC_diffie_hellman_agree_ioctl *p_UBSEC_diffie_hellman_agree_ioctl
 311     = NULL;
 312 #  endif
 313 #  ifndef OPENSSL_NO_RSA
 314 static t_UBSEC_rsa_mod_exp_ioctl *p_UBSEC_rsa_mod_exp_ioctl = NULL;
 315 static t_UBSEC_rsa_mod_exp_crt_ioctl *p_UBSEC_rsa_mod_exp_crt_ioctl = NULL;
 316 #  endif
 317 #  ifndef OPENSSL_NO_DSA
 318 static t_UBSEC_dsa_sign_ioctl *p_UBSEC_dsa_sign_ioctl = NULL;
 319 static t_UBSEC_dsa_verify_ioctl *p_UBSEC_dsa_verify_ioctl = NULL;
 320 #  endif
 321 static t_UBSEC_math_accelerate_ioctl *p_UBSEC_math_accelerate_ioctl = NULL;
 322 static t_UBSEC_rng_ioctl *p_UBSEC_rng_ioctl = NULL;
 323 static t_UBSEC_max_key_len_ioctl *p_UBSEC_max_key_len_ioctl = NULL;
 324
 325 static int max_key_len = 1024;  /* ??? */
 326
 327 /*
 328  * These are the static string constants for the DSO file name and the function
 329  * symbol names to bind to.
 330  */
 331
 332 static const char *UBSEC_LIBNAME = NULL;
 333 static const char *get_UBSEC_LIBNAME(void)
 334 {
 335     if (UBSEC_LIBNAME)
 336         return UBSEC_LIBNAME;
 337     return "ubsec";
 338 }
 339
 340 static void free_UBSEC_LIBNAME(void)
 341 {
 342     OPENSSL_free(UBSEC_LIBNAME);
 343     UBSEC_LIBNAME = NULL;
 344 }
 345
 346 static long set_UBSEC_LIBNAME(const char *name)
 347 {
 348     free_UBSEC_LIBNAME();
 349     return (((UBSEC_LIBNAME = BUF_strdup(name)) != NULL) ? 1 : 0);
 350 }
 351
 352 static const char *UBSEC_F1 = "ubsec_bytes_to_bits";
 353 static const char *UBSEC_F2 = "ubsec_bits_to_bytes";
 354 static const char *UBSEC_F3 = "ubsec_open";
 355 static const char *UBSEC_F4 = "ubsec_close";
 356 #  ifndef OPENSSL_NO_DH
 357 static const char *UBSEC_F5 = "diffie_hellman_generate_ioctl";
 358 static const char *UBSEC_F6 = "diffie_hellman_agree_ioctl";
 359 #  endif
 360 /* #ifndef OPENSSL_NO_RSA */
 361 static const char *UBSEC_F7 = "rsa_mod_exp_ioctl";
 362 static const char *UBSEC_F8 = "rsa_mod_exp_crt_ioctl";
 363 /* #endif */
 364 #  ifndef OPENSSL_NO_DSA
 365 static const char *UBSEC_F9 = "dsa_sign_ioctl";
 366 static const char *UBSEC_F10 = "dsa_verify_ioctl";
 367 #  endif
 368 static const char *UBSEC_F11 = "math_accelerate_ioctl";
 369 static const char *UBSEC_F12 = "rng_ioctl";
 370 static const char *UBSEC_F13 = "ubsec_max_key_len_ioctl";
 371
 372 /* Destructor (complements the "ENGINE_ubsec()" constructor) */
 373 static int ubsec_destroy(ENGINE *e)
 374 {
 375     free_UBSEC_LIBNAME();
 376     ERR_unload_UBSEC_strings();
 377     return 1;
 378 }
 379
 380 /* (de)initialisation functions. */
 381 static int ubsec_init(ENGINE *e)
 382 {
 383     t_UBSEC_ubsec_bytes_to_bits *p1;
 384     t_UBSEC_ubsec_bits_to_bytes *p2;
 385     t_UBSEC_ubsec_open *p3;
 386     t_UBSEC_ubsec_close *p4;
 387 #  ifndef OPENSSL_NO_DH
 388     t_UBSEC_diffie_hellman_generate_ioctl *p5;
 389     t_UBSEC_diffie_hellman_agree_ioctl *p6;
 390 #  endif
 391 /* #ifndef OPENSSL_NO_RSA */
 392     t_UBSEC_rsa_mod_exp_ioctl *p7;
 393     t_UBSEC_rsa_mod_exp_crt_ioctl *p8;
 394 /* #endif */
 395 #  ifndef OPENSSL_NO_DSA
 396     t_UBSEC_dsa_sign_ioctl *p9;
 397     t_UBSEC_dsa_verify_ioctl *p10;
 398 #  endif
 399     t_UBSEC_math_accelerate_ioctl *p11;
 400     t_UBSEC_rng_ioctl *p12;
 401     t_UBSEC_max_key_len_ioctl *p13;
 402     int fd = 0;
 403
 404     if (ubsec_dso != NULL) {
 405         UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_ALREADY_LOADED);
 406         goto err;
 407     }
 408     /*
 409      * Attempt to load libubsec.so/ubsec.dll/whatever.
 410      */
 411     ubsec_dso = DSO_load(NULL, get_UBSEC_LIBNAME(), NULL, 0);
 412     if (ubsec_dso == NULL) {
 413         UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_DSO_FAILURE);
 414         goto err;
 415     }
 416
 417     if (!(p1 = (t_UBSEC_ubsec_bytes_to_bits *)
 418           DSO_bind_func(ubsec_dso, UBSEC_F1))
 419         || !(p2 = (t_UBSEC_ubsec_bits_to_bytes *)
 420              DSO_bind_func(ubsec_dso, UBSEC_F2))
 421         || !(p3 = (t_UBSEC_ubsec_open *)
 422              DSO_bind_func(ubsec_dso, UBSEC_F3))
 423         || !(p4 = (t_UBSEC_ubsec_close *)
 424              DSO_bind_func(ubsec_dso, UBSEC_F4))
 425 #  ifndef OPENSSL_NO_DH
 426         || !(p5 = (t_UBSEC_diffie_hellman_generate_ioctl *)
 427              DSO_bind_func(ubsec_dso, UBSEC_F5))
 428         || !(p6 = (t_UBSEC_diffie_hellman_agree_ioctl *)
 429              DSO_bind_func(ubsec_dso, UBSEC_F6))
 430 #  endif
 431 /* #ifndef OPENSSL_NO_RSA */
 432         || !(p7 = (t_UBSEC_rsa_mod_exp_ioctl *)
 433              DSO_bind_func(ubsec_dso, UBSEC_F7))
 434         || !(p8 = (t_UBSEC_rsa_mod_exp_crt_ioctl *)
 435              DSO_bind_func(ubsec_dso, UBSEC_F8))
 436 /* #endif */
 437 #  ifndef OPENSSL_NO_DSA
 438         || !(p9 = (t_UBSEC_dsa_sign_ioctl *)
 439              DSO_bind_func(ubsec_dso, UBSEC_F9))
 440         || !(p10 = (t_UBSEC_dsa_verify_ioctl *)
 441              DSO_bind_func(ubsec_dso, UBSEC_F10))
 442 #  endif
 443         || !(p11 = (t_UBSEC_math_accelerate_ioctl *)
 444              DSO_bind_func(ubsec_dso, UBSEC_F11))
 445         || !(p12 = (t_UBSEC_rng_ioctl *)
 446              DSO_bind_func(ubsec_dso, UBSEC_F12))
 447         || !(p13 = (t_UBSEC_max_key_len_ioctl *)
 448              DSO_bind_func(ubsec_dso, UBSEC_F13))) {
 449         UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_DSO_FAILURE);
 450         goto err;
 451     }
 452
 453     /* Copy the pointers */
 454     p_UBSEC_ubsec_bytes_to_bits = p1;
 455     p_UBSEC_ubsec_bits_to_bytes = p2;
 456     p_UBSEC_ubsec_open = p3;
 457     p_UBSEC_ubsec_close = p4;
 458 #  ifndef OPENSSL_NO_DH
 459     p_UBSEC_diffie_hellman_generate_ioctl = p5;
 460     p_UBSEC_diffie_hellman_agree_ioctl = p6;
 461 #  endif
 462 #  ifndef OPENSSL_NO_RSA
 463     p_UBSEC_rsa_mod_exp_ioctl = p7;
 464     p_UBSEC_rsa_mod_exp_crt_ioctl = p8;
 465 #  endif
 466 #  ifndef OPENSSL_NO_DSA
 467     p_UBSEC_dsa_sign_ioctl = p9;
 468     p_UBSEC_dsa_verify_ioctl = p10;
 469 #  endif
 470     p_UBSEC_math_accelerate_ioctl = p11;
 471     p_UBSEC_rng_ioctl = p12;
 472     p_UBSEC_max_key_len_ioctl = p13;
 473
 474     /* Perform an open to see if there's actually any unit running. */
 475     if (((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) > 0)
 476         && (p_UBSEC_max_key_len_ioctl(fd, &max_key_len) == 0)) {
 477         p_UBSEC_ubsec_close(fd);
 478         return 1;
 479     } else {
 480         UBSECerr(UBSEC_F_UBSEC_INIT, UBSEC_R_UNIT_FAILURE);
 481     }
 482
 483  err:
 484     if (ubsec_dso)
 485         DSO_free(ubsec_dso);
 486     ubsec_dso = NULL;
 487     p_UBSEC_ubsec_bytes_to_bits = NULL;
 488     p_UBSEC_ubsec_bits_to_bytes = NULL;
 489     p_UBSEC_ubsec_open = NULL;
 490     p_UBSEC_ubsec_close = NULL;
 491 #  ifndef OPENSSL_NO_DH
 492     p_UBSEC_diffie_hellman_generate_ioctl = NULL;
 493     p_UBSEC_diffie_hellman_agree_ioctl = NULL;
 494 #  endif
 495 #  ifndef OPENSSL_NO_RSA
 496     p_UBSEC_rsa_mod_exp_ioctl = NULL;
 497     p_UBSEC_rsa_mod_exp_crt_ioctl = NULL;
 498 #  endif
 499 #  ifndef OPENSSL_NO_DSA
 500     p_UBSEC_dsa_sign_ioctl = NULL;
 501     p_UBSEC_dsa_verify_ioctl = NULL;
 502 #  endif
 503     p_UBSEC_math_accelerate_ioctl = NULL;
 504     p_UBSEC_rng_ioctl = NULL;
 505     p_UBSEC_max_key_len_ioctl = NULL;
 506
 507     return 0;
 508 }
 509
 510 static int ubsec_finish(ENGINE *e)
 511 {
 512     free_UBSEC_LIBNAME();
 513     if (ubsec_dso == NULL) {
 514         UBSECerr(UBSEC_F_UBSEC_FINISH, UBSEC_R_NOT_LOADED);
 515         return 0;
 516     }
 517     if (!DSO_free(ubsec_dso)) {
 518         UBSECerr(UBSEC_F_UBSEC_FINISH, UBSEC_R_DSO_FAILURE);
 519         return 0;
 520     }
 521     ubsec_dso = NULL;
 522     p_UBSEC_ubsec_bytes_to_bits = NULL;
 523     p_UBSEC_ubsec_bits_to_bytes = NULL;
 524     p_UBSEC_ubsec_open = NULL;
 525     p_UBSEC_ubsec_close = NULL;
 526 #  ifndef OPENSSL_NO_DH
 527     p_UBSEC_diffie_hellman_generate_ioctl = NULL;
 528     p_UBSEC_diffie_hellman_agree_ioctl = NULL;
 529 #  endif
 530 #  ifndef OPENSSL_NO_RSA
 531     p_UBSEC_rsa_mod_exp_ioctl = NULL;
 532     p_UBSEC_rsa_mod_exp_crt_ioctl = NULL;
 533 #  endif
 534 #  ifndef OPENSSL_NO_DSA
 535     p_UBSEC_dsa_sign_ioctl = NULL;
 536     p_UBSEC_dsa_verify_ioctl = NULL;
 537 #  endif
 538     p_UBSEC_math_accelerate_ioctl = NULL;
 539     p_UBSEC_rng_ioctl = NULL;
 540     p_UBSEC_max_key_len_ioctl = NULL;
 541     return 1;
 542 }
 543
 544 static int ubsec_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
 545 {
 546     int initialised = ((ubsec_dso == NULL) ? 0 : 1);
 547     switch (cmd) {
 548     case UBSEC_CMD_SO_PATH:
 549         if (p == NULL) {
 550             UBSECerr(UBSEC_F_UBSEC_CTRL, ERR_R_PASSED_NULL_PARAMETER);
 551             return 0;
 552         }
 553         if (initialised) {
 554             UBSECerr(UBSEC_F_UBSEC_CTRL, UBSEC_R_ALREADY_LOADED);
 555             return 0;
 556         }
 557         return set_UBSEC_LIBNAME((const char *)p);
 558     default:
 559         break;
 560     }
 561     UBSECerr(UBSEC_F_UBSEC_CTRL, UBSEC_R_CTRL_COMMAND_NOT_IMPLEMENTED);
 562     return 0;
 563 }
 564
 565 static int ubsec_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 566                          const BIGNUM *m, BN_CTX *ctx)
 567 {
 568     int y_len = 0;
 569     int fd;
 570
 571     if (ubsec_dso == NULL) {
 572         UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_NOT_LOADED);
 573         return 0;
 574     }
 575
 576     /* Check if hardware can't handle this argument. */
 577     y_len = BN_num_bits(m);
 578     if (y_len > max_key_len) {
 579         UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_SIZE_TOO_LARGE_OR_TOO_SMALL);
 580         return BN_mod_exp(r, a, p, m, ctx);
 581     }
 582
 583     if (!bn_wexpand(r, m->top)) {
 584         UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_BN_EXPAND_FAIL);
 585         return 0;
 586     }
 587
 588     if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
 589         fd = 0;
 590         UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_UNIT_FAILURE);
 591         return BN_mod_exp(r, a, p, m, ctx);
 592     }
 593
 594     if (p_UBSEC_rsa_mod_exp_ioctl(fd, (unsigned char *)a->d, BN_num_bits(a),
 595                                   (unsigned char *)m->d, BN_num_bits(m),
 596                                   (unsigned char *)p->d, BN_num_bits(p),
 597                                   (unsigned char *)r->d, &y_len) != 0) {
 598         UBSECerr(UBSEC_F_UBSEC_MOD_EXP, UBSEC_R_REQUEST_FAILED);
 599         p_UBSEC_ubsec_close(fd);
 600
 601         return BN_mod_exp(r, a, p, m, ctx);
 602     }
 603
 604     p_UBSEC_ubsec_close(fd);
 605
 606     r->top = (BN_num_bits(m) + BN_BITS2 - 1) / BN_BITS2;
 607     return 1;
 608 }
 609
 610 #  ifndef OPENSSL_NO_RSA
 611 static int ubsec_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa,
 612                              BN_CTX *ctx)
 613 {
 614     int to_return = 0;
 615
 616     if (!rsa->p || !rsa->q || !rsa->dmp1 || !rsa->dmq1 || !rsa->iqmp) {
 617         UBSECerr(UBSEC_F_UBSEC_RSA_MOD_EXP, UBSEC_R_MISSING_KEY_COMPONENTS);
 618         goto err;
 619     }
 620
 621     to_return = ubsec_mod_exp_crt(r0, I, rsa->p, rsa->q, rsa->dmp1,
 622                                   rsa->dmq1, rsa->iqmp, ctx);
 623     if (to_return == FAIL_TO_SOFTWARE) {
 624         /*
 625          * Do in software as hardware failed.
 626          */
 627         const RSA_METHOD *meth = RSA_PKCS1_SSLeay();
 628         to_return = (*meth->rsa_mod_exp) (r0, I, rsa, ctx);
 629     }
 630  err:
 631     return to_return;
 632 }
 633
 634 static int ubsec_mod_exp_crt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 635                              const BIGNUM *q, const BIGNUM *dp,
 636                              const BIGNUM *dq, const BIGNUM *qinv,
 637                              BN_CTX *ctx)
 638 {
 639     int y_len, fd;
 640
 641     y_len = BN_num_bits(p) + BN_num_bits(q);
 642
 643     /* Check if hardware can't handle this argument. */
 644     if (y_len > max_key_len) {
 645         UBSECerr(UBSEC_F_UBSEC_MOD_EXP_CRT,
 646                  UBSEC_R_SIZE_TOO_LARGE_OR_TOO_SMALL);
 647         return FAIL_TO_SOFTWARE;
 648     }
 649
 650     if (!bn_wexpand(r, p->top + q->top + 1)) {
 651         UBSECerr(UBSEC_F_UBSEC_MOD_EXP_CRT, UBSEC_R_BN_EXPAND_FAIL);
 652         return 0;
 653     }
 654
 655     if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
 656         fd = 0;
 657         UBSECerr(UBSEC_F_UBSEC_MOD_EXP_CRT, UBSEC_R_UNIT_FAILURE);
 658         return FAIL_TO_SOFTWARE;
 659     }
 660
 661     if (p_UBSEC_rsa_mod_exp_crt_ioctl(fd,
 662                                       (unsigned char *)a->d, BN_num_bits(a),
 663                                       (unsigned char *)qinv->d,
 664                                       BN_num_bits(qinv),
 665                                       (unsigned char *)dp->d, BN_num_bits(dp),
 666                                       (unsigned char *)p->d, BN_num_bits(p),
 667                                       (unsigned char *)dq->d, BN_num_bits(dq),
 668                                       (unsigned char *)q->d, BN_num_bits(q),
 669                                       (unsigned char *)r->d, &y_len) != 0) {
 670         UBSECerr(UBSEC_F_UBSEC_MOD_EXP_CRT, UBSEC_R_REQUEST_FAILED);
 671         p_UBSEC_ubsec_close(fd);
 672         return FAIL_TO_SOFTWARE;
 673     }
 674
 675     p_UBSEC_ubsec_close(fd);
 676
 677     r->top = (BN_num_bits(p) + BN_num_bits(q) + BN_BITS2 - 1) / BN_BITS2;
 678     return 1;
 679 }
 680 #  endif
 681
 682 #  ifndef OPENSSL_NO_RSA
 683
 684 /*
 685  * This function is aliased to mod_exp (with the mont stuff dropped).
 686  */
 687 static int ubsec_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 688                               const BIGNUM *m, BN_CTX *ctx,
 689                               BN_MONT_CTX *m_ctx)
 690 {
 691     int ret = 0;
 692
 693     /* Do in software if the key is too large for the hardware. */
 694     if (BN_num_bits(m) > max_key_len) {
 695         const RSA_METHOD *meth = RSA_PKCS1_SSLeay();
 696         ret = (*meth->bn_mod_exp) (r, a, p, m, ctx, m_ctx);
 697     } else {
 698         ret = ubsec_mod_exp(r, a, p, m, ctx);
 699     }
 700
 701     return ret;
 702 }
 703 #  endif
 704
 705 #  ifndef OPENSSL_NO_DH
 706 /* This function is aliased to mod_exp (with the dh and mont dropped). */
 707 static int ubsec_mod_exp_dh(const DH *dh, BIGNUM *r, const BIGNUM *a,
 708                             const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
 709                             BN_MONT_CTX *m_ctx)
 710 {
 711     return ubsec_mod_exp(r, a, p, m, ctx);
 712 }
 713 #  endif
 714
 715 #  ifndef OPENSSL_NO_DSA
 716 static DSA_SIG *ubsec_dsa_do_sign(const unsigned char *dgst, int dlen,
 717                                   DSA *dsa)
 718 {
 719     DSA_SIG *to_return = NULL;
 720     int s_len = 160, r_len = 160, d_len, fd;
 721     BIGNUM m, *r = NULL, *s = NULL;
 722
 723     BN_init(&m);
 724
 725     s = BN_new();
 726     r = BN_new();
 727     if ((s == NULL) || (r == NULL))
 728         goto err;
 729
 730     d_len = p_UBSEC_ubsec_bytes_to_bits((unsigned char *)dgst, dlen);
 731
 732     if (!bn_wexpand(r, (160 + BN_BITS2 - 1) / BN_BITS2) ||
 733         (!bn_wexpand(s, (160 + BN_BITS2 - 1) / BN_BITS2))) {
 734         UBSECerr(UBSEC_F_UBSEC_DSA_DO_SIGN, UBSEC_R_BN_EXPAND_FAIL);
 735         goto err;
 736     }
 737
 738     if (BN_bin2bn(dgst, dlen, &m) == NULL) {
 739         UBSECerr(UBSEC_F_UBSEC_DSA_DO_SIGN, UBSEC_R_BN_EXPAND_FAIL);
 740         goto err;
 741     }
 742
 743     if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
 744         const DSA_METHOD *meth;
 745         fd = 0;
 746         UBSECerr(UBSEC_F_UBSEC_DSA_DO_SIGN, UBSEC_R_UNIT_FAILURE);
 747         meth = DSA_OpenSSL();
 748         to_return = meth->dsa_do_sign(dgst, dlen, dsa);
 749         goto err;
 750     }
 751
 752     if (p_UBSEC_dsa_sign_ioctl(fd,
 753                                /* compute hash before signing */
 754                                0, (unsigned char *)dgst, d_len, NULL,
 755                                /* compute random value */
 756                                0,
 757                                (unsigned char *)dsa->p->d,
 758                                BN_num_bits(dsa->p),
 759                                (unsigned char *)dsa->q->d,
 760                                BN_num_bits(dsa->q),
 761                                (unsigned char *)dsa->g->d,
 762                                BN_num_bits(dsa->g),
 763                                (unsigned char *)dsa->priv_key->d,
 764                                BN_num_bits(dsa->priv_key),
 765                                (unsigned char *)r->d, &r_len,
 766                                (unsigned char *)s->d, &s_len) != 0) {
 767         const DSA_METHOD *meth;
 768
 769         UBSECerr(UBSEC_F_UBSEC_DSA_DO_SIGN, UBSEC_R_REQUEST_FAILED);
 770         p_UBSEC_ubsec_close(fd);
 771         meth = DSA_OpenSSL();
 772         to_return = meth->dsa_do_sign(dgst, dlen, dsa);
 773
 774         goto err;
 775     }
 776
 777     p_UBSEC_ubsec_close(fd);
 778
 779     r->top = (160 + BN_BITS2 - 1) / BN_BITS2;
 780     s->top = (160 + BN_BITS2 - 1) / BN_BITS2;
 781
 782     to_return = DSA_SIG_new();
 783     if (to_return == NULL) {
 784         UBSECerr(UBSEC_F_UBSEC_DSA_DO_SIGN, UBSEC_R_BN_EXPAND_FAIL);
 785         goto err;
 786     }
 787
 788     to_return->r = r;
 789     to_return->s = s;
 790
 791  err:
 792     if (!to_return) {
 793         BN_free(r);
 794         BN_free(s);
 795     }
 796     BN_clear_free(&m);
 797     return to_return;
 798 }
 799
 800 static int ubsec_dsa_verify(const unsigned char *dgst, int dgst_len,
 801                             DSA_SIG *sig, DSA *dsa)
 802 {
 803     int v_len, d_len;
 804     int to_return = 0;
 805     int fd;
 806     BIGNUM v, *pv = &v;
 807
 808     BN_init(&v);
 809
 810     if (!bn_wexpand(pv, dsa->p->top)) {
 811         UBSECerr(UBSEC_F_UBSEC_DSA_VERIFY, UBSEC_R_BN_EXPAND_FAIL);
 812         goto err;
 813     }
 814
 815     v_len = BN_num_bits(dsa->p);
 816
 817     d_len = p_UBSEC_ubsec_bytes_to_bits((unsigned char *)dgst, dgst_len);
 818
 819     if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
 820         const DSA_METHOD *meth;
 821         fd = 0;
 822         UBSECerr(UBSEC_F_UBSEC_DSA_VERIFY, UBSEC_R_UNIT_FAILURE);
 823         meth = DSA_OpenSSL();
 824         to_return = meth->dsa_do_verify(dgst, dgst_len, sig, dsa);
 825         goto err;
 826     }
 827
 828     if (p_UBSEC_dsa_verify_ioctl(fd, 0, /* compute hash before signing */
 829                                  (unsigned char *)dgst, d_len,
 830                                  (unsigned char *)dsa->p->d,
 831                                  BN_num_bits(dsa->p),
 832                                  (unsigned char *)dsa->q->d,
 833                                  BN_num_bits(dsa->q),
 834                                  (unsigned char *)dsa->g->d,
 835                                  BN_num_bits(dsa->g),
 836                                  (unsigned char *)dsa->pub_key->d,
 837                                  BN_num_bits(dsa->pub_key),
 838                                  (unsigned char *)sig->r->d,
 839                                  BN_num_bits(sig->r),
 840                                  (unsigned char *)sig->s->d,
 841                                  BN_num_bits(sig->s), (unsigned char *)v.d,
 842                                  &v_len) != 0) {
 843         const DSA_METHOD *meth;
 844         UBSECerr(UBSEC_F_UBSEC_DSA_VERIFY, UBSEC_R_REQUEST_FAILED);
 845         p_UBSEC_ubsec_close(fd);
 846
 847         meth = DSA_OpenSSL();
 848         to_return = meth->dsa_do_verify(dgst, dgst_len, sig, dsa);
 849
 850         goto err;
 851     }
 852
 853     p_UBSEC_ubsec_close(fd);
 854
 855     to_return = 1;
 856  err:
 857     BN_clear_free(&v);
 858     return to_return;
 859 }
 860 #  endif
 861
 862 #  ifndef OPENSSL_NO_DH
 863 static int ubsec_dh_compute_key(unsigned char *key, const BIGNUM *pub_key,
 864                                 DH *dh)
 865 {
 866     int ret = -1, k_len, fd;
 867
 868     k_len = BN_num_bits(dh->p);
 869
 870     if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
 871         const DH_METHOD *meth;
 872         UBSECerr(UBSEC_F_UBSEC_DH_COMPUTE_KEY, UBSEC_R_UNIT_FAILURE);
 873         meth = DH_OpenSSL();
 874         ret = meth->compute_key(key, pub_key, dh);
 875         goto err;
 876     }
 877
 878     if (p_UBSEC_diffie_hellman_agree_ioctl(fd,
 879                                            (unsigned char *)dh->priv_key->d,
 880                                            BN_num_bits(dh->priv_key),
 881                                            (unsigned char *)pub_key->d,
 882                                            BN_num_bits(pub_key),
 883                                            (unsigned char *)dh->p->d,
 884                                            BN_num_bits(dh->p), key,
 885                                            &k_len) != 0) {
 886         /* Hardware's a no go, failover to software */
 887         const DH_METHOD *meth;
 888         UBSECerr(UBSEC_F_UBSEC_DH_COMPUTE_KEY, UBSEC_R_REQUEST_FAILED);
 889         p_UBSEC_ubsec_close(fd);
 890
 891         meth = DH_OpenSSL();
 892         ret = meth->compute_key(key, pub_key, dh);
 893
 894         goto err;
 895     }
 896
 897     p_UBSEC_ubsec_close(fd);
 898
 899     ret = p_UBSEC_ubsec_bits_to_bytes(k_len);
 900  err:
 901     return ret;
 902 }
 903
 904 static int ubsec_dh_generate_key(DH *dh)
 905 {
 906     int ret = 0, random_bits = 0, pub_key_len = 0, priv_key_len = 0, fd;
 907     BIGNUM *pub_key = NULL;
 908     BIGNUM *priv_key = NULL;
 909
 910     /*
 911      *  How many bits should Random x be? dh_key.c
 912      *  sets the range from 0 to num_bits(modulus) ???
 913      */
 914
 915     if (dh->priv_key == NULL) {
 916         priv_key = BN_new();
 917         if (priv_key == NULL)
 918             goto err;
 919         priv_key_len = BN_num_bits(dh->p);
 920         if (bn_wexpand(priv_key, dh->p->top) == NULL)
 921             goto err;
 922         do
 923             if (!BN_rand_range(priv_key, dh->p))
 924                 goto err;
 925         while (BN_is_zero(priv_key)) ;
 926         random_bits = BN_num_bits(priv_key);
 927     } else {
 928         priv_key = dh->priv_key;
 929     }
 930
 931     if (dh->pub_key == NULL) {
 932         pub_key = BN_new();
 933         if (pub_key == NULL)
 934             goto err;
 935         pub_key_len = BN_num_bits(dh->p);
 936         if (bn_wexpand(pub_key, dh->p->top) == NULL)
 937             goto err;
 938     } else {
 939         pub_key = dh->pub_key;
 940     }
 941
 942     if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
 943         const DH_METHOD *meth;
 944         UBSECerr(UBSEC_F_UBSEC_DH_GENERATE_KEY, UBSEC_R_UNIT_FAILURE);
 945         meth = DH_OpenSSL();
 946         ret = meth->generate_key(dh);
 947         goto err;
 948     }
 949
 950     if (p_UBSEC_diffie_hellman_generate_ioctl(fd,
 951                                               (unsigned char *)priv_key->d,
 952                                               &priv_key_len,
 953                                               (unsigned char *)pub_key->d,
 954                                               &pub_key_len,
 955                                               (unsigned char *)dh->g->d,
 956                                               BN_num_bits(dh->g),
 957                                               (unsigned char *)dh->p->d,
 958                                               BN_num_bits(dh->p), 0, 0,
 959                                               random_bits) != 0) {
 960         /* Hardware's a no go, failover to software */
 961         const DH_METHOD *meth;
 962
 963         UBSECerr(UBSEC_F_UBSEC_DH_GENERATE_KEY, UBSEC_R_REQUEST_FAILED);
 964         p_UBSEC_ubsec_close(fd);
 965
 966         meth = DH_OpenSSL();
 967         ret = meth->generate_key(dh);
 968
 969         goto err;
 970     }
 971
 972     p_UBSEC_ubsec_close(fd);
 973
 974     dh->pub_key = pub_key;
 975     dh->pub_key->top = (pub_key_len + BN_BITS2 - 1) / BN_BITS2;
 976     dh->priv_key = priv_key;
 977     dh->priv_key->top = (priv_key_len + BN_BITS2 - 1) / BN_BITS2;
 978
 979     ret = 1;
 980  err:
 981     return ret;
 982 }
 983 #  endif
 984
 985 #  ifdef NOT_USED
 986 static int ubsec_rand_bytes(unsigned char *buf, int num)
 987 {
 988     int ret = 0, fd;
 989
 990     if ((fd = p_UBSEC_ubsec_open(UBSEC_KEY_DEVICE_NAME)) <= 0) {
 991         const RAND_METHOD *meth;
 992         UBSECerr(UBSEC_F_UBSEC_RAND_BYTES, UBSEC_R_UNIT_FAILURE);
 993         num = p_UBSEC_ubsec_bits_to_bytes(num);
 994         meth = RAND_SSLeay();
 995         meth->seed(buf, num);
 996         ret = meth->bytes(buf, num);
 997         goto err;
 998     }
 999
1000     num *= 8;                   /* bytes to bits */
1001
1002     if (p_UBSEC_rng_ioctl(fd, UBSEC_RNG_DIRECT, buf, &num) != 0) {
1003         /* Hardware's a no go, failover to software */
1004         const RAND_METHOD *meth;
1005
1006         UBSECerr(UBSEC_F_UBSEC_RAND_BYTES, UBSEC_R_REQUEST_FAILED);
1007         p_UBSEC_ubsec_close(fd);
1008
1009         num = p_UBSEC_ubsec_bits_to_bytes(num);
1010         meth = RAND_SSLeay();
1011         meth->seed(buf, num);
1012         ret = meth->bytes(buf, num);
1013
1014         goto err;
1015     }
1016
1017     p_UBSEC_ubsec_close(fd);
1018
1019     ret = 1;
1020  err:
1021     return (ret);
1022 }
1023
1024 static int ubsec_rand_status(void)
1025 {
1026     return 0;
1027 }
1028 #  endif
1029
1030 /*
1031  * This stuff is needed if this ENGINE is being compiled into a
1032  * self-contained shared-library.
1033  */
1034 #  ifndef OPENSSL_NO_DYNAMIC_ENGINE
1035 static int bind_fn(ENGINE *e, const char *id)
1036 {
1037     if (id && (strcmp(id, engine_ubsec_id) != 0))
1038         return 0;
1039     if (!bind_helper(e))
1040         return 0;
1041     return 1;
1042 }
1043
1044 IMPLEMENT_DYNAMIC_CHECK_FN()
1045     IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
1046 #  endif                        /* OPENSSL_NO_DYNAMIC_ENGINE */
1047 # endif                         /* !OPENSSL_NO_HW_UBSEC */
1048 #endif                          /* !OPENSSL_NO_HW */