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