crypto/engine/hw_nuron.c

   1 /* crypto/engine/hw_nuron.c */
   2 /* Written by Ben Laurie for the OpenSSL Project, leaning heavily on Geoff
   3  * Thorpe's Atalla implementation.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgment:
  22  *    "This product includes software developed by the OpenSSL Project
  23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  24  *
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26  *    endorse or promote products derived from this software without
  27  *    prior written permission. For written permission, please contact
  28  *    licensing@OpenSSL.org.
  29  *
  30  * 5. Products derived from this software may not be called "OpenSSL"
  31  *    nor may "OpenSSL" appear in their names without prior written
  32  *    permission of the OpenSSL Project.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  * ====================================================================
  52  *
  53  * This product includes cryptographic software written by Eric Young
  54  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58
  59 #include <stdio.h>
  60 #include <openssl/crypto.h>
  61 #include "cryptlib.h"
  62 #include <openssl/dso.h>
  63 #include <openssl/engine.h>
  64
  65
  66 #ifndef OPENSSL_NO_HW
  67 #ifndef OPENSSL_NO_HW_NURON
  68
  69 static const char def_NURON_LIBNAME[] = "nuronssl";
  70 static const char *NURON_LIBNAME = def_NURON_LIBNAME;
  71 static const char *NURON_F1 = "nuron_mod_exp";
  72
  73 /* The definitions for control commands specific to this engine */
  74 #define NURON_CMD_SO_PATH               ENGINE_CMD_BASE
  75 static const ENGINE_CMD_DEFN nuron_cmd_defns[] = {
  76         {NURON_CMD_SO_PATH,
  77                 "SO_PATH",
  78                 "Specifies the path to the 'nuronssl' shared library",
  79                 ENGINE_CMD_FLAG_STRING},
  80         {0, NULL, NULL, 0}
  81         };
  82
  83 #ifndef OPENSSL_NO_ERR
  84 /* Error function codes for use in nuron operation */
  85 #define NURON_F_NURON_INIT                      100
  86 #define NURON_F_NURON_FINISH                    101
  87 #define NURON_F_NURON_CTRL                      102
  88 #define NURON_F_NURON_MOD_EXP                   103
  89 /* Error reason codes */
  90 #define NURON_R_ALREADY_LOADED                  104
  91 #define NURON_R_DSO_NOT_FOUND                   105
  92 #define NURON_R_DSO_FUNCTION_NOT_FOUND          106
  93 #define NURON_R_NOT_LOADED                      107
  94 #define NURON_R_DSO_FAILURE                     108
  95 #define NURON_R_CTRL_COMMAND_NOT_IMPLEMENTED    109
  96 static ERR_STRING_DATA nuron_str_functs[] =
  97         {
  98         /* This first element is changed to match the dynamic 'lib' number */
  99 {ERR_PACK(0,0,0),                               "nuron engine code"},
 100 {ERR_PACK(0,NURON_F_NURON_INIT,0),              "nuron_init"},
 101 {ERR_PACK(0,NURON_F_NURON_FINISH,0),            "nuron_finish"},
 102 {ERR_PACK(0,NURON_F_NURON_CTRL,0),              "nuron_ctrl"},
 103 {ERR_PACK(0,NURON_F_NURON_MOD_EXP,0),           "nuron_mod_exp"},
 104 /* Error reason codes */
 105 {NURON_R_ALREADY_LOADED                 ,"already loaded"},
 106 {NURON_R_DSO_NOT_FOUND                  ,"DSO not found"},
 107 {NURON_R_DSO_FUNCTION_NOT_FOUND         ,"DSO function not found"},
 108 {NURON_R_NOT_LOADED                     ,"not loaded"},
 109 {NURON_R_DSO_FAILURE                    ,"DSO failure"},
 110 {NURON_R_CTRL_COMMAND_NOT_IMPLEMENTED   ,"ctrl command not implemented"},
 111 {NURON_R_NOT_LOADED                     ,"not loaded"},
 112 {0,NULL}
 113         };
 114 /* The library number we obtain dynamically from the ERR code */
 115 static int nuron_err_lib = -1;
 116 #define NURONerr(f,r) ERR_PUT_error(nuron_err_lib,(f),(r),__FILE__,__LINE__)
 117 static void nuron_load_error_strings(void)
 118         {
 119         if(nuron_err_lib < 0)
 120                 {
 121                 if((nuron_err_lib = ERR_get_next_error_library()) <= 0)
 122                         return;
 123                 nuron_str_functs[0].error = ERR_PACK(nuron_err_lib,0,0);
 124                 ERR_load_strings(nuron_err_lib, nuron_str_functs);
 125                 }
 126         }
 127 static void nuron_unload_error_strings(void)
 128         {
 129         if(nuron_err_lib >= 0)
 130                 {
 131                 ERR_unload_strings(nuron_err_lib, nuron_str_functs);
 132                 nuron_err_lib = -1;
 133                 }
 134         }
 135 #else
 136 #define NURONerr(f,r)                                   /* NOP */
 137 static void nuron_load_error_strings(void) { }          /* NOP */
 138 static void nuron_unload_error_strings(void) { }        /* NOP */
 139 #endif
 140
 141 typedef int tfnModExp(BIGNUM *r,const BIGNUM *a,const BIGNUM *p,const BIGNUM *m);
 142 static tfnModExp *pfnModExp = NULL;
 143
 144 static DSO *pvDSOHandle = NULL;
 145
 146 static int nuron_destroy(ENGINE *e)
 147         {
 148         nuron_unload_error_strings();
 149         return 1;
 150         }
 151
 152 static int nuron_init(ENGINE *e)
 153         {
 154         if(pvDSOHandle != NULL)
 155                 {
 156                 NURONerr(NURON_F_NURON_INIT,NURON_R_ALREADY_LOADED);
 157                 return 0;
 158                 }
 159
 160         pvDSOHandle = DSO_load(NULL, NURON_LIBNAME, NULL,
 161                 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY);
 162         if(!pvDSOHandle)
 163                 {
 164                 NURONerr(NURON_F_NURON_INIT,NURON_R_DSO_NOT_FOUND);
 165                 return 0;
 166                 }
 167
 168         pfnModExp = (tfnModExp *)DSO_bind_func(pvDSOHandle, NURON_F1);
 169         if(!pfnModExp)
 170                 {
 171                 NURONerr(NURON_F_NURON_INIT,NURON_R_DSO_FUNCTION_NOT_FOUND);
 172                 return 0;
 173                 }
 174
 175         return 1;
 176         }
 177
 178 static int nuron_finish(ENGINE *e)
 179         {
 180         if(pvDSOHandle == NULL)
 181                 {
 182                 NURONerr(NURON_F_NURON_FINISH,NURON_R_NOT_LOADED);
 183                 return 0;
 184                 }
 185         if(!DSO_free(pvDSOHandle))
 186                 {
 187                 NURONerr(NURON_F_NURON_FINISH,NURON_R_DSO_FAILURE);
 188                 return 0;
 189                 }
 190         pvDSOHandle=NULL;
 191         pfnModExp=NULL;
 192         return 1;
 193         }
 194
 195 static int nuron_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)())
 196         {
 197         int initialised = ((pvDSOHandle == NULL) ? 0 : 1);
 198         switch(cmd)
 199                 {
 200         case NURON_CMD_SO_PATH:
 201                 if(p == NULL)
 202                         {
 203                         NURONerr(NURON_F_NURON_CTRL,ERR_R_PASSED_NULL_PARAMETER);
 204                         return 0;
 205                         }
 206                 if(initialised)
 207                         {
 208                         NURONerr(NURON_F_NURON_CTRL,NURON_R_ALREADY_LOADED);
 209                         return 0;
 210                         }
 211                 NURON_LIBNAME = (const char *)p;
 212                 return 1;
 213         default:
 214                 break;
 215                 }
 216         NURONerr(NURON_F_NURON_CTRL,NURON_R_CTRL_COMMAND_NOT_IMPLEMENTED);
 217         return 0;
 218 }
 219
 220 static int nuron_mod_exp(BIGNUM *r,const BIGNUM *a,const BIGNUM *p,
 221                          const BIGNUM *m,BN_CTX *ctx)
 222         {
 223         if(!pvDSOHandle)
 224                 {
 225                 NURONerr(NURON_F_NURON_MOD_EXP,NURON_R_NOT_LOADED);
 226                 return 0;
 227                 }
 228         return pfnModExp(r,a,p,m);
 229         }
 230
 231 #ifndef OPENSSL_NO_RSA
 232 static int nuron_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa)
 233         {
 234         return nuron_mod_exp(r0,I,rsa->d,rsa->n,NULL);
 235         }
 236 #endif
 237
 238 #ifndef OPENSSL_NO_DSA
 239 /* This code was liberated and adapted from the commented-out code in
 240  * dsa_ossl.c. Because of the unoptimised form of the Atalla acceleration
 241  * (it doesn't have a CRT form for RSA), this function means that an
 242  * Atalla system running with a DSA server certificate can handshake
 243  * around 5 or 6 times faster/more than an equivalent system running with
 244  * RSA. Just check out the "signs" statistics from the RSA and DSA parts
 245  * of "openssl speed -engine atalla dsa1024 rsa1024". */
 246 static int nuron_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
 247                              BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
 248                              BN_CTX *ctx, BN_MONT_CTX *in_mont)
 249         {
 250         BIGNUM t;
 251         int to_return = 0;
 252
 253         BN_init(&t);
 254         /* let rr = a1 ^ p1 mod m */
 255         if (!nuron_mod_exp(rr,a1,p1,m,ctx))
 256                 goto end;
 257         /* let t = a2 ^ p2 mod m */
 258         if (!nuron_mod_exp(&t,a2,p2,m,ctx))
 259                 goto end;
 260         /* let rr = rr * t mod m */
 261         if (!BN_mod_mul(rr,rr,&t,m,ctx))
 262                 goto end;
 263         to_return = 1;
 264 end:
 265         BN_free(&t);
 266         return to_return;
 267         }
 268
 269
 270 static int nuron_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
 271                              const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
 272                              BN_MONT_CTX *m_ctx)
 273         {
 274         return nuron_mod_exp(r, a, p, m, ctx);
 275         }
 276 #endif
 277
 278 /* This function is aliased to mod_exp (with the mont stuff dropped). */
 279 static int nuron_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 280                               const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
 281         {
 282         return nuron_mod_exp(r, a, p, m, ctx);
 283         }
 284
 285 #ifndef OPENSSL_NO_DH
 286 /* This function is aliased to mod_exp (with the dh and mont dropped). */
 287 static int nuron_mod_exp_dh(const DH *dh, BIGNUM *r,
 288                 const BIGNUM *a, const BIGNUM *p,
 289                 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
 290         {
 291         return nuron_mod_exp(r, a, p, m, ctx);
 292         }
 293 #endif
 294
 295 #ifndef OPENSSL_NO_RSA
 296 static RSA_METHOD nuron_rsa =
 297         {
 298         "Nuron RSA method",
 299         NULL,
 300         NULL,
 301         NULL,
 302         NULL,
 303         nuron_rsa_mod_exp,
 304         nuron_mod_exp_mont,
 305         NULL,
 306         NULL,
 307         0,
 308         NULL,
 309         NULL,
 310         NULL
 311         };
 312 #endif
 313
 314 #ifndef OPENSSL_NO_DSA
 315 static DSA_METHOD nuron_dsa =
 316         {
 317         "Nuron DSA method",
 318         NULL, /* dsa_do_sign */
 319         NULL, /* dsa_sign_setup */
 320         NULL, /* dsa_do_verify */
 321         nuron_dsa_mod_exp, /* dsa_mod_exp */
 322         nuron_mod_exp_dsa, /* bn_mod_exp */
 323         NULL, /* init */
 324         NULL, /* finish */
 325         0, /* flags */
 326         NULL /* app_data */
 327         };
 328 #endif
 329
 330 #ifndef OPENSSL_NO_DH
 331 static DH_METHOD nuron_dh =
 332         {
 333         "Nuron DH method",
 334         NULL,
 335         NULL,
 336         nuron_mod_exp_dh,
 337         NULL,
 338         NULL,
 339         0,
 340         NULL
 341         };
 342 #endif
 343
 344 /* Constants used when creating the ENGINE */
 345 static const char *engine_nuron_id = "nuron";
 346 static const char *engine_nuron_name = "Nuron hardware engine support";
 347
 348 /* This internal function is used by ENGINE_nuron() and possibly by the
 349  * "dynamic" ENGINE support too */
 350 static int bind_helper(ENGINE *e)
 351         {
 352 #ifndef OPENSSL_NO_RSA
 353         const RSA_METHOD *meth1;
 354 #endif
 355 #ifndef OPENSSL_NO_DSA
 356         const DSA_METHOD *meth2;
 357 #endif
 358 #ifndef OPENSSL_NO_DH
 359         const DH_METHOD *meth3;
 360 #endif
 361         if(!ENGINE_set_id(e, engine_nuron_id) ||
 362                         !ENGINE_set_name(e, engine_nuron_name) ||
 363 #ifndef OPENSSL_NO_RSA
 364                         !ENGINE_set_RSA(e, &nuron_rsa) ||
 365 #endif
 366 #ifndef OPENSSL_NO_DSA
 367                         !ENGINE_set_DSA(e, &nuron_dsa) ||
 368 #endif
 369 #ifndef OPENSSL_NO_DH
 370                         !ENGINE_set_DH(e, &nuron_dh) ||
 371 #endif
 372                         !ENGINE_set_BN_mod_exp(e, nuron_mod_exp) ||
 373                         !ENGINE_set_destroy_function(e, nuron_destroy) ||
 374                         !ENGINE_set_init_function(e, nuron_init) ||
 375                         !ENGINE_set_finish_function(e, nuron_finish) ||
 376                         !ENGINE_set_ctrl_function(e, nuron_ctrl) ||
 377                         !ENGINE_set_cmd_defns(e, nuron_cmd_defns))
 378                 return 0;
 379
 380 #ifndef OPENSSL_NO_RSA
 381         /* We know that the "PKCS1_SSLeay()" functions hook properly
 382          * to the nuron-specific mod_exp and mod_exp_crt so we use
 383          * those functions. NB: We don't use ENGINE_openssl() or
 384          * anything "more generic" because something like the RSAref
 385          * code may not hook properly, and if you own one of these
 386          * cards then you have the right to do RSA operations on it
 387          * anyway! */
 388         meth1=RSA_PKCS1_SSLeay();
 389         nuron_rsa.rsa_pub_enc=meth1->rsa_pub_enc;
 390         nuron_rsa.rsa_pub_dec=meth1->rsa_pub_dec;
 391         nuron_rsa.rsa_priv_enc=meth1->rsa_priv_enc;
 392         nuron_rsa.rsa_priv_dec=meth1->rsa_priv_dec;
 393 #endif
 394
 395 #ifndef OPENSSL_NO_DSA
 396         /* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
 397          * bits. */
 398         meth2=DSA_OpenSSL();
 399         nuron_dsa.dsa_do_sign=meth2->dsa_do_sign;
 400         nuron_dsa.dsa_sign_setup=meth2->dsa_sign_setup;
 401         nuron_dsa.dsa_do_verify=meth2->dsa_do_verify;
 402 #endif
 403
 404 #ifndef OPENSSL_NO_DH
 405         /* Much the same for Diffie-Hellman */
 406         meth3=DH_OpenSSL();
 407         nuron_dh.generate_key=meth3->generate_key;
 408         nuron_dh.compute_key=meth3->compute_key;
 409 #endif
 410
 411         /* Ensure the nuron error handling is set up */
 412         nuron_load_error_strings();
 413         return 1;
 414         }
 415
 416 /* As this is only ever called once, there's no need for locking
 417  * (indeed - the lock will already be held by our caller!!!) */
 418 ENGINE *ENGINE_nuron(void)
 419         {
 420         ENGINE *ret = ENGINE_new();
 421         if(!ret)
 422                 return NULL;
 423         if(!bind_helper(ret))
 424                 {
 425                 ENGINE_free(ret);
 426                 return NULL;
 427                 }
 428         return ret;
 429         }
 430
 431 /* This stuff is needed if this ENGINE is being compiled into a self-contained
 432  * shared-library. */
 433 #ifdef ENGINE_DYNAMIC_SUPPORT
 434 static int bind_fn(ENGINE *e, const char *id)
 435         {
 436         if(id && (strcmp(id, engine_nuron_id) != 0))
 437                 return 0;
 438         if(!bind_helper(e))
 439                 return 0;
 440         return 1;
 441         }
 442 IMPLEMENT_DYNAMIC_CHECK_FN()
 443 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
 444 #endif /* ENGINE_DYNAMIC_SUPPORT */
 445
 446 #endif /* !OPENSSL_NO_HW_NURON */
 447 #endif /* !OPENSSL_NO_HW */