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 #define NURON_R_NOT_LOADED                      110
  97 static ERR_STRING_DATA nuron_str_functs[] =
  98         {
  99         /* This first element is changed to match the dynamic 'lib' number */
 100 {ERR_PACK(0,0,0),                               "nuron engine code"},
 101 {ERR_PACK(0,NURON_F_NURON_INIT,0),              "nuron_init"},
 102 {ERR_PACK(0,NURON_F_NURON_FINISH,0),            "nuron_finish"},
 103 {ERR_PACK(0,NURON_F_NURON_CTRL,0),              "nuron_ctrl"},
 104 {ERR_PACK(0,NURON_F_NURON_MOD_EXP,0),           "nuron_mod_exp"},
 105 /* Error reason codes */
 106 {NURON_R_ALREADY_LOADED                 ,"already loaded"},
 107 {NURON_R_DSO_NOT_FOUND                  ,"DSO not found"},
 108 {NURON_R_DSO_FUNCTION_NOT_FOUND         ,"DSO function not found"},
 109 {NURON_R_NOT_LOADED                     ,"not loaded"},
 110 {NURON_R_DSO_FAILURE                    ,"DSO failure"},
 111 {NURON_R_CTRL_COMMAND_NOT_IMPLEMENTED   ,"ctrl command not implemented"},
 112 {NURON_R_NOT_LOADED                     ,"not loaded"},
 113 {0,NULL}
 114         };
 115 /* The library number we obtain dynamically from the ERR code */
 116 static int nuron_err_lib = -1;
 117 #define NURONerr(f,r) ERR_PUT_error(nuron_err_lib,(f),(r),__FILE__,__LINE__)
 118 static void nuron_load_error_strings(void)
 119         {
 120         if(nuron_err_lib < 0)
 121                 {
 122                 if((nuron_err_lib = ERR_get_next_error_library()) <= 0)
 123                         return;
 124                 nuron_str_functs[0].error = ERR_PACK(nuron_err_lib,0,0);
 125                 ERR_load_strings(nuron_err_lib, nuron_str_functs);
 126                 }
 127         }
 128 #else
 129 #define NURONerr(f,r)                             /* NOP */
 130 static void nuron_load_error_strings(void) { }   /* NOP */
 131 #endif
 132
 133 typedef int tfnModExp(BIGNUM *r,const BIGNUM *a,const BIGNUM *p,const BIGNUM *m);
 134 static tfnModExp *pfnModExp = NULL;
 135
 136 static DSO *pvDSOHandle = NULL;
 137
 138 static int nuron_init(ENGINE *e)
 139         {
 140         if(pvDSOHandle != NULL)
 141                 {
 142                 NURONerr(NURON_F_NURON_INIT,NURON_R_ALREADY_LOADED);
 143                 return 0;
 144                 }
 145
 146         pvDSOHandle = DSO_load(NULL, NURON_LIBNAME, NULL,
 147                 DSO_FLAG_NAME_TRANSLATION_EXT_ONLY);
 148         if(!pvDSOHandle)
 149                 {
 150                 NURONerr(NURON_F_NURON_INIT,NURON_R_DSO_NOT_FOUND);
 151                 return 0;
 152                 }
 153
 154         pfnModExp = (tfnModExp *)DSO_bind_func(pvDSOHandle, NURON_F1);
 155         if(!pfnModExp)
 156                 {
 157                 NURONerr(NURON_F_NURON_INIT,NURON_R_DSO_FUNCTION_NOT_FOUND);
 158                 return 0;
 159                 }
 160
 161         return 1;
 162         }
 163
 164 static int nuron_finish(ENGINE *e)
 165         {
 166         if(pvDSOHandle == NULL)
 167                 {
 168                 NURONerr(NURON_F_NURON_FINISH,NURON_R_NOT_LOADED);
 169                 return 0;
 170                 }
 171         if(!DSO_free(pvDSOHandle))
 172                 {
 173                 NURONerr(NURON_F_NURON_FINISH,NURON_R_DSO_FAILURE);
 174                 return 0;
 175                 }
 176         pvDSOHandle=NULL;
 177         pfnModExp=NULL;
 178         return 1;
 179         }
 180
 181 static int nuron_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)())
 182         {
 183         int initialised = ((pvDSOHandle == NULL) ? 0 : 1);
 184         switch(cmd)
 185                 {
 186         case NURON_CMD_SO_PATH:
 187                 if(p == NULL)
 188                         {
 189                         NURONerr(NURON_F_NURON_CTRL,ERR_R_PASSED_NULL_PARAMETER);
 190                         return 0;
 191                         }
 192                 if(initialised)
 193                         {
 194                         NURONerr(NURON_F_NURON_CTRL,NURON_R_ALREADY_LOADED);
 195                         return 0;
 196                         }
 197                 NURON_LIBNAME = (const char *)p;
 198                 return 1;
 199         default:
 200                 break;
 201                 }
 202         NURONerr(NURON_F_NURON_CTRL,NURON_R_CTRL_COMMAND_NOT_IMPLEMENTED);
 203         return 0;
 204 }
 205
 206 static int nuron_mod_exp(BIGNUM *r,const BIGNUM *a,const BIGNUM *p,
 207                          const BIGNUM *m,BN_CTX *ctx)
 208         {
 209         if(!pvDSOHandle)
 210                 {
 211                 NURONerr(NURON_F_NURON_MOD_EXP,NURON_R_NOT_LOADED);
 212                 return 0;
 213                 }
 214         return pfnModExp(r,a,p,m);
 215         }
 216
 217 #ifndef OPENSSL_NO_RSA
 218 static int nuron_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa)
 219         {
 220         return nuron_mod_exp(r0,I,rsa->d,rsa->n,NULL);
 221         }
 222 #endif
 223
 224 #ifndef OPENSSL_NO_DSA
 225 /* This code was liberated and adapted from the commented-out code in
 226  * dsa_ossl.c. Because of the unoptimised form of the Atalla acceleration
 227  * (it doesn't have a CRT form for RSA), this function means that an
 228  * Atalla system running with a DSA server certificate can handshake
 229  * around 5 or 6 times faster/more than an equivalent system running with
 230  * RSA. Just check out the "signs" statistics from the RSA and DSA parts
 231  * of "openssl speed -engine atalla dsa1024 rsa1024". */
 232 static int nuron_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
 233                              BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
 234                              BN_CTX *ctx, BN_MONT_CTX *in_mont)
 235         {
 236         BIGNUM t;
 237         int to_return = 0;
 238
 239         BN_init(&t);
 240         /* let rr = a1 ^ p1 mod m */
 241         if (!nuron_mod_exp(rr,a1,p1,m,ctx))
 242                 goto end;
 243         /* let t = a2 ^ p2 mod m */
 244         if (!nuron_mod_exp(&t,a2,p2,m,ctx))
 245                 goto end;
 246         /* let rr = rr * t mod m */
 247         if (!BN_mod_mul(rr,rr,&t,m,ctx))
 248                 goto end;
 249         to_return = 1;
 250 end:
 251         BN_free(&t);
 252         return to_return;
 253         }
 254
 255
 256 static int nuron_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
 257                              const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
 258                              BN_MONT_CTX *m_ctx)
 259         {
 260         return nuron_mod_exp(r, a, p, m, ctx);
 261         }
 262 #endif
 263
 264 /* This function is aliased to mod_exp (with the mont stuff dropped). */
 265 static int nuron_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 266                               const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
 267         {
 268         return nuron_mod_exp(r, a, p, m, ctx);
 269         }
 270
 271 #ifndef OPENSSL_NO_DH
 272 /* This function is aliased to mod_exp (with the dh and mont dropped). */
 273 static int nuron_mod_exp_dh(const DH *dh, BIGNUM *r,
 274                 const BIGNUM *a, const BIGNUM *p,
 275                 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
 276         {
 277         return nuron_mod_exp(r, a, p, m, ctx);
 278         }
 279 #endif
 280
 281 #ifndef OPENSSL_NO_RSA
 282 static RSA_METHOD nuron_rsa =
 283         {
 284         "Nuron RSA method",
 285         NULL,
 286         NULL,
 287         NULL,
 288         NULL,
 289         nuron_rsa_mod_exp,
 290         nuron_mod_exp_mont,
 291         NULL,
 292         NULL,
 293         0,
 294         NULL,
 295         NULL,
 296         NULL
 297         };
 298 #endif
 299
 300 #ifndef OPENSSL_NO_DSA
 301 static DSA_METHOD nuron_dsa =
 302         {
 303         "Nuron DSA method",
 304         NULL, /* dsa_do_sign */
 305         NULL, /* dsa_sign_setup */
 306         NULL, /* dsa_do_verify */
 307         nuron_dsa_mod_exp, /* dsa_mod_exp */
 308         nuron_mod_exp_dsa, /* bn_mod_exp */
 309         NULL, /* init */
 310         NULL, /* finish */
 311         0, /* flags */
 312         NULL /* app_data */
 313         };
 314 #endif
 315
 316 #ifndef OPENSSL_NO_DH
 317 static DH_METHOD nuron_dh =
 318         {
 319         "Nuron DH method",
 320         NULL,
 321         NULL,
 322         nuron_mod_exp_dh,
 323         NULL,
 324         NULL,
 325         0,
 326         NULL
 327         };
 328 #endif
 329
 330 /* Constants used when creating the ENGINE */
 331 static const char *engine_nuron_id = "nuron";
 332 static const char *engine_nuron_name = "Nuron hardware engine support";
 333
 334 /* This internal function is used by ENGINE_nuron() and possibly by the
 335  * "dynamic" ENGINE support too */
 336 static int bind_helper(ENGINE *e)
 337         {
 338 #ifndef OPENSSL_NO_RSA
 339         const RSA_METHOD *meth1;
 340 #endif
 341 #ifndef OPENSSL_NO_DSA
 342         const DSA_METHOD *meth2;
 343 #endif
 344 #ifndef OPENSSL_NO_DH
 345         const DH_METHOD *meth3;
 346 #endif
 347         if(!ENGINE_set_id(e, engine_nuron_id) ||
 348                         !ENGINE_set_name(e, engine_nuron_name) ||
 349 #ifndef OPENSSL_NO_RSA
 350                         !ENGINE_set_RSA(e, &nuron_rsa) ||
 351 #endif
 352 #ifndef OPENSSL_NO_DSA
 353                         !ENGINE_set_DSA(e, &nuron_dsa) ||
 354 #endif
 355 #ifndef OPENSSL_NO_DH
 356                         !ENGINE_set_DH(e, &nuron_dh) ||
 357 #endif
 358                         !ENGINE_set_BN_mod_exp(e, nuron_mod_exp) ||
 359                         !ENGINE_set_init_function(e, nuron_init) ||
 360                         !ENGINE_set_finish_function(e, nuron_finish) ||
 361                         !ENGINE_set_ctrl_function(e, nuron_ctrl) ||
 362                         !ENGINE_set_cmd_defns(e, nuron_cmd_defns))
 363                 return 0;
 364
 365 #ifndef OPENSSL_NO_RSA
 366         /* We know that the "PKCS1_SSLeay()" functions hook properly
 367          * to the nuron-specific mod_exp and mod_exp_crt so we use
 368          * those functions. NB: We don't use ENGINE_openssl() or
 369          * anything "more generic" because something like the RSAref
 370          * code may not hook properly, and if you own one of these
 371          * cards then you have the right to do RSA operations on it
 372          * anyway! */
 373         meth1=RSA_PKCS1_SSLeay();
 374         nuron_rsa.rsa_pub_enc=meth1->rsa_pub_enc;
 375         nuron_rsa.rsa_pub_dec=meth1->rsa_pub_dec;
 376         nuron_rsa.rsa_priv_enc=meth1->rsa_priv_enc;
 377         nuron_rsa.rsa_priv_dec=meth1->rsa_priv_dec;
 378 #endif
 379
 380 #ifndef OPENSSL_NO_DSA
 381         /* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
 382          * bits. */
 383         meth2=DSA_OpenSSL();
 384         nuron_dsa.dsa_do_sign=meth2->dsa_do_sign;
 385         nuron_dsa.dsa_sign_setup=meth2->dsa_sign_setup;
 386         nuron_dsa.dsa_do_verify=meth2->dsa_do_verify;
 387 #endif
 388
 389 #ifndef OPENSSL_NO_DH
 390         /* Much the same for Diffie-Hellman */
 391         meth3=DH_OpenSSL();
 392         nuron_dh.generate_key=meth3->generate_key;
 393         nuron_dh.compute_key=meth3->compute_key;
 394 #endif
 395
 396         /* Ensure the nuron error handling is set up */
 397         nuron_load_error_strings();
 398         return 1;
 399         }
 400
 401 /* As this is only ever called once, there's no need for locking
 402  * (indeed - the lock will already be held by our caller!!!) */
 403 ENGINE *ENGINE_nuron(void)
 404         {
 405         ENGINE *ret = ENGINE_new();
 406         if(!ret)
 407                 return NULL;
 408         if(!bind_helper(ret))
 409                 {
 410                 ENGINE_free(ret);
 411                 return NULL;
 412                 }
 413         return ret;
 414         }
 415
 416 /* This stuff is needed if this ENGINE is being compiled into a self-contained
 417  * shared-library. */
 418 #ifdef ENGINE_DYNAMIC_SUPPORT
 419 static int bind_fn(ENGINE *e, const char *id)
 420         {
 421         if(id && (strcmp(id, engine_nuron_id) != 0))
 422                 return 0;
 423         if(!bind_helper(e))
 424                 return 0;
 425         return 1;
 426         }
 427 IMPLEMENT_DYNAMIC_CHECK_FN()
 428 IMPLEMENT_DYNAMIC_BIND_FN(bind_fn)
 429 #endif /* ENGINE_DYNAMIC_SUPPORT */
 430
 431 #endif /* !OPENSSL_NO_HW_NURON */
 432 #endif /* !OPENSSL_NO_HW */