crypto/engine/hw_atalla.c

   1 /* crypto/engine/hw_atalla.c */
   2 /* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL
   3  * project 2000.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 1999 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 "engine_int.h"
  64 #include <openssl/engine.h>
  65
  66 #ifndef OPENSSL_NO_HW
  67 #ifndef OPENSSL_NO_HW_ATALLA
  68
  69 #ifdef FLAT_INC
  70 #include "atalla.h"
  71 #else
  72 #include "vendor_defns/atalla.h"
  73 #endif
  74
  75 static int atalla_init(void);
  76 static int atalla_finish(void);
  77
  78 /* BIGNUM stuff */
  79 static int atalla_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
  80                 const BIGNUM *m, BN_CTX *ctx);
  81
  82 /* RSA stuff */
  83 static int atalla_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa);
  84 /* This function is aliased to mod_exp (with the mont stuff dropped). */
  85 static int atalla_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
  86                 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
  87
  88 /* DSA stuff */
  89 static int atalla_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
  90                 BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
  91                 BN_CTX *ctx, BN_MONT_CTX *in_mont);
  92 static int atalla_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
  93                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
  94                 BN_MONT_CTX *m_ctx);
  95
  96 /* DH stuff */
  97 /* This function is alised to mod_exp (with the DH and mont dropped). */
  98 static int atalla_mod_exp_dh(const DH *dh, BIGNUM *r,
  99                 const BIGNUM *a, const BIGNUM *p,
 100                 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 101
 102
 103 /* Our internal RSA_METHOD that we provide pointers to */
 104 static RSA_METHOD atalla_rsa =
 105         {
 106         "Atalla RSA method",
 107         NULL,
 108         NULL,
 109         NULL,
 110         NULL,
 111         atalla_rsa_mod_exp,
 112         atalla_mod_exp_mont,
 113         NULL,
 114         NULL,
 115         0,
 116         NULL,
 117         NULL,
 118         NULL
 119         };
 120
 121 /* Our internal DSA_METHOD that we provide pointers to */
 122 static DSA_METHOD atalla_dsa =
 123         {
 124         "Atalla DSA method",
 125         NULL, /* dsa_do_sign */
 126         NULL, /* dsa_sign_setup */
 127         NULL, /* dsa_do_verify */
 128         atalla_dsa_mod_exp, /* dsa_mod_exp */
 129         atalla_mod_exp_dsa, /* bn_mod_exp */
 130         NULL, /* init */
 131         NULL, /* finish */
 132         0, /* flags */
 133         NULL /* app_data */
 134         };
 135
 136 /* Our internal DH_METHOD that we provide pointers to */
 137 static DH_METHOD atalla_dh =
 138         {
 139         "Atalla DH method",
 140         NULL,
 141         NULL,
 142         atalla_mod_exp_dh,
 143         NULL,
 144         NULL,
 145         0,
 146         NULL
 147         };
 148
 149 /* Our ENGINE structure. */
 150 static ENGINE engine_atalla =
 151         {
 152         "atalla",
 153         "Atalla hardware engine support",
 154         &atalla_rsa,
 155         &atalla_dsa,
 156         &atalla_dh,
 157         NULL,
 158         atalla_mod_exp,
 159         NULL,
 160         atalla_init,
 161         atalla_finish,
 162         NULL, /* no ctrl() */
 163         NULL, /* no load_privkey() */
 164         NULL, /* no load_pubkey() */
 165         0, /* no flags */
 166         0, 0, /* no references */
 167         NULL, NULL /* unlinked */
 168         };
 169
 170 /* As this is only ever called once, there's no need for locking
 171  * (indeed - the lock will already be held by our caller!!!) */
 172 ENGINE *ENGINE_atalla()
 173         {
 174         const RSA_METHOD *meth1;
 175         const DSA_METHOD *meth2;
 176         const DH_METHOD *meth3;
 177
 178         /* We know that the "PKCS1_SSLeay()" functions hook properly
 179          * to the atalla-specific mod_exp and mod_exp_crt so we use
 180          * those functions. NB: We don't use ENGINE_openssl() or
 181          * anything "more generic" because something like the RSAref
 182          * code may not hook properly, and if you own one of these
 183          * cards then you have the right to do RSA operations on it
 184          * anyway! */
 185         meth1 = RSA_PKCS1_SSLeay();
 186         atalla_rsa.rsa_pub_enc = meth1->rsa_pub_enc;
 187         atalla_rsa.rsa_pub_dec = meth1->rsa_pub_dec;
 188         atalla_rsa.rsa_priv_enc = meth1->rsa_priv_enc;
 189         atalla_rsa.rsa_priv_dec = meth1->rsa_priv_dec;
 190
 191         /* Use the DSA_OpenSSL() method and just hook the mod_exp-ish
 192          * bits. */
 193         meth2 = DSA_OpenSSL();
 194         atalla_dsa.dsa_do_sign = meth2->dsa_do_sign;
 195         atalla_dsa.dsa_sign_setup = meth2->dsa_sign_setup;
 196         atalla_dsa.dsa_do_verify = meth2->dsa_do_verify;
 197
 198         /* Much the same for Diffie-Hellman */
 199         meth3 = DH_OpenSSL();
 200         atalla_dh.generate_key = meth3->generate_key;
 201         atalla_dh.compute_key = meth3->compute_key;
 202         return &engine_atalla;
 203         }
 204
 205 /* This is a process-global DSO handle used for loading and unloading
 206  * the Atalla library. NB: This is only set (or unset) during an
 207  * init() or finish() call (reference counts permitting) and they're
 208  * operating with global locks, so this should be thread-safe
 209  * implicitly. */
 210 static DSO *atalla_dso = NULL;
 211
 212 /* These are the function pointers that are (un)set when the library has
 213  * successfully (un)loaded. */
 214 static tfnASI_GetHardwareConfig *p_Atalla_GetHardwareConfig = NULL;
 215 static tfnASI_RSAPrivateKeyOpFn *p_Atalla_RSAPrivateKeyOpFn = NULL;
 216 static tfnASI_GetPerformanceStatistics *p_Atalla_GetPerformanceStatistics = NULL;
 217
 218 /* (de)initialisation functions. */
 219 static int atalla_init(void)
 220         {
 221         tfnASI_GetHardwareConfig *p1;
 222         tfnASI_RSAPrivateKeyOpFn *p2;
 223         tfnASI_GetPerformanceStatistics *p3;
 224         /* Not sure of the origin of this magic value, but Ben's code had it
 225          * and it seemed to have been working for a few people. :-) */
 226         unsigned int config_buf[1024];
 227
 228         if(atalla_dso != NULL)
 229                 {
 230                 ENGINEerr(ENGINE_F_ATALLA_INIT,ENGINE_R_ALREADY_LOADED);
 231                 goto err;
 232                 }
 233         /* Attempt to load libatasi.so/atasi.dll/whatever. Needs to be
 234          * changed unfortunately because the Atalla drivers don't have
 235          * standard library names that can be platform-translated well. */
 236         /* TODO: Work out how to actually map to the names the Atalla
 237          * drivers really use - for now a symbollic link needs to be
 238          * created on the host system from libatasi.so to atasi.so on
 239          * unix variants. */
 240         atalla_dso = DSO_load(NULL, ATALLA_LIBNAME, NULL, 0);
 241         if(atalla_dso == NULL)
 242                 {
 243                 ENGINEerr(ENGINE_F_ATALLA_INIT,ENGINE_R_DSO_FAILURE);
 244                 goto err;
 245                 }
 246         if(!(p1 = (tfnASI_GetHardwareConfig *)DSO_bind_func(
 247                                 atalla_dso, ATALLA_F1)) ||
 248                         !(p2 = (tfnASI_RSAPrivateKeyOpFn *)DSO_bind_func(
 249                                 atalla_dso, ATALLA_F2)) ||
 250                         !(p3 = (tfnASI_GetPerformanceStatistics *)DSO_bind_func(
 251                                 atalla_dso, ATALLA_F3)))
 252                 {
 253                 ENGINEerr(ENGINE_F_ATALLA_INIT,ENGINE_R_DSO_FAILURE);
 254                 goto err;
 255                 }
 256         /* Copy the pointers */
 257         p_Atalla_GetHardwareConfig = p1;
 258         p_Atalla_RSAPrivateKeyOpFn = p2;
 259         p_Atalla_GetPerformanceStatistics = p3;
 260         /* Perform a basic test to see if there's actually any unit
 261          * running. */
 262         if(p1(0L, config_buf) != 0)
 263                 {
 264                 ENGINEerr(ENGINE_F_ATALLA_INIT,ENGINE_R_UNIT_FAILURE);
 265                 goto err;
 266                 }
 267         /* Everything's fine. */
 268         return 1;
 269 err:
 270         if(atalla_dso)
 271                 DSO_free(atalla_dso);
 272         p_Atalla_GetHardwareConfig = NULL;
 273         p_Atalla_RSAPrivateKeyOpFn = NULL;
 274         p_Atalla_GetPerformanceStatistics = NULL;
 275         return 0;
 276         }
 277
 278 static int atalla_finish(void)
 279         {
 280         if(atalla_dso == NULL)
 281                 {
 282                 ENGINEerr(ENGINE_F_ATALLA_FINISH,ENGINE_R_NOT_LOADED);
 283                 return 0;
 284                 }
 285         if(!DSO_free(atalla_dso))
 286                 {
 287                 ENGINEerr(ENGINE_F_ATALLA_FINISH,ENGINE_R_DSO_FAILURE);
 288                 return 0;
 289                 }
 290         atalla_dso = NULL;
 291         p_Atalla_GetHardwareConfig = NULL;
 292         p_Atalla_RSAPrivateKeyOpFn = NULL;
 293         p_Atalla_GetPerformanceStatistics = NULL;
 294         return 1;
 295         }
 296
 297 static int atalla_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 298                         const BIGNUM *m, BN_CTX *ctx)
 299         {
 300         /* I need somewhere to store temporary serialised values for
 301          * use with the Atalla API calls. A neat cheat - I'll use
 302          * BIGNUMs from the BN_CTX but access their arrays directly as
 303          * byte arrays <grin>. This way I don't have to clean anything
 304          * up. */
 305         BIGNUM *modulus;
 306         BIGNUM *exponent;
 307         BIGNUM *argument;
 308         BIGNUM *result;
 309         RSAPrivateKey keydata;
 310         int to_return, numbytes;
 311
 312         modulus = exponent = argument = result = NULL;
 313         to_return = 0; /* expect failure */
 314
 315         if(!atalla_dso)
 316         {
 317                 ENGINEerr(ENGINE_F_ATALLA_MOD_EXP,ENGINE_R_NOT_LOADED);
 318                 goto err;
 319         }
 320         /* Prepare the params */
 321         BN_CTX_start(ctx);
 322         modulus = BN_CTX_get(ctx);
 323         exponent = BN_CTX_get(ctx);
 324         argument = BN_CTX_get(ctx);
 325         result = BN_CTX_get(ctx);
 326         if (!result)
 327         {
 328                 ENGINEerr(ENGINE_F_ATALLA_MOD_EXP,ENGINE_R_BN_CTX_FULL);
 329                 goto err;
 330         }
 331         if(!bn_wexpand(modulus, m->top) || !bn_wexpand(exponent, m->top) ||
 332            !bn_wexpand(argument, m->top) || !bn_wexpand(result, m->top))
 333         {
 334                 ENGINEerr(ENGINE_F_ATALLA_MOD_EXP,ENGINE_R_BN_EXPAND_FAIL);
 335                 goto err;
 336         }
 337         /* Prepare the key-data */
 338         memset(&keydata, 0,sizeof keydata);
 339         numbytes = BN_num_bytes(m);
 340         memset(exponent->d, 0, numbytes);
 341         memset(modulus->d, 0, numbytes);
 342         BN_bn2bin(p, (unsigned char *)exponent->d + numbytes - BN_num_bytes(p));
 343         BN_bn2bin(m, (unsigned char *)modulus->d + numbytes - BN_num_bytes(m));
 344         keydata.privateExponent.data = (unsigned char *)exponent->d;
 345         keydata.privateExponent.len = numbytes;
 346         keydata.modulus.data = (unsigned char *)modulus->d;
 347         keydata.modulus.len = numbytes;
 348         /* Prepare the argument */
 349         memset(argument->d, 0, numbytes);
 350         memset(result->d, 0, numbytes);
 351         BN_bn2bin(a, (unsigned char *)argument->d + numbytes - BN_num_bytes(a));
 352         /* Perform the operation */
 353         if(p_Atalla_RSAPrivateKeyOpFn(&keydata, (unsigned char *)result->d,
 354                         (unsigned char *)argument->d,
 355                         keydata.modulus.len) != 0)
 356         {
 357                 ENGINEerr(ENGINE_F_ATALLA_MOD_EXP,ENGINE_R_REQUEST_FAILED);
 358                 goto err;
 359         }
 360         /* Convert the response */
 361         BN_bin2bn((unsigned char *)result->d, numbytes, r);
 362         to_return = 1;
 363 err:
 364         BN_CTX_end(ctx);
 365         return to_return;
 366         }
 367
 368 static int atalla_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa)
 369         {
 370         BN_CTX *ctx = NULL;
 371         int to_return = 0;
 372
 373         if(!atalla_dso)
 374         {
 375                 ENGINEerr(ENGINE_F_ATALLA_RSA_MOD_EXP,ENGINE_R_NOT_LOADED);
 376                 goto err;
 377         }
 378         if((ctx = BN_CTX_new()) == NULL)
 379                 goto err;
 380         if(!rsa->d || !rsa->n)
 381                 {
 382                 ENGINEerr(ENGINE_F_ATALLA_RSA_MOD_EXP,ENGINE_R_MISSING_KEY_COMPONENTS);
 383                 goto err;
 384                 }
 385         to_return = atalla_mod_exp(r0, I, rsa->d, rsa->n, ctx);
 386 err:
 387         if(ctx)
 388                 BN_CTX_free(ctx);
 389         return to_return;
 390         }
 391
 392 /* This code was liberated and adapted from the commented-out code in
 393  * dsa_ossl.c. Because of the unoptimised form of the Atalla acceleration
 394  * (it doesn't have a CRT form for RSA), this function means that an
 395  * Atalla system running with a DSA server certificate can handshake
 396  * around 5 or 6 times faster/more than an equivalent system running with
 397  * RSA. Just check out the "signs" statistics from the RSA and DSA parts
 398  * of "openssl speed -engine atalla dsa1024 rsa1024". */
 399 static int atalla_dsa_mod_exp(DSA *dsa, BIGNUM *rr, BIGNUM *a1,
 400                 BIGNUM *p1, BIGNUM *a2, BIGNUM *p2, BIGNUM *m,
 401                 BN_CTX *ctx, BN_MONT_CTX *in_mont)
 402         {
 403         BIGNUM t;
 404         int to_return = 0;
 405
 406         BN_init(&t);
 407         /* let rr = a1 ^ p1 mod m */
 408         if (!atalla_mod_exp(rr,a1,p1,m,ctx)) goto end;
 409         /* let t = a2 ^ p2 mod m */
 410         if (!atalla_mod_exp(&t,a2,p2,m,ctx)) goto end;
 411         /* let rr = rr * t mod m */
 412         if (!BN_mod_mul(rr,rr,&t,m,ctx)) goto end;
 413         to_return = 1;
 414 end:
 415         BN_free(&t);
 416         return to_return;
 417         }
 418
 419
 420 static int atalla_mod_exp_dsa(DSA *dsa, BIGNUM *r, BIGNUM *a,
 421                 const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx,
 422                 BN_MONT_CTX *m_ctx)
 423         {
 424         return atalla_mod_exp(r, a, p, m, ctx);
 425         }
 426
 427 /* This function is aliased to mod_exp (with the mont stuff dropped). */
 428 static int atalla_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,
 429                 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
 430         {
 431         return atalla_mod_exp(r, a, p, m, ctx);
 432         }
 433
 434 /* This function is aliased to mod_exp (with the dh and mont dropped). */
 435 static int atalla_mod_exp_dh(const DH *dh, BIGNUM *r,
 436                 const BIGNUM *a, const BIGNUM *p,
 437                 const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx)
 438         {
 439         return atalla_mod_exp(r, a, p, m, ctx);
 440         }
 441
 442 #endif /* !OPENSSL_NO_HW_ATALLA */
 443 #endif /* !OPENSSL_NO_HW */