engines/e_dasync.c

   1 /*
   2  * Written by Matt Caswell (matt@openssl.org) for the OpenSSL project.
   3  */
   4 /* ====================================================================
   5  * Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  *
  19  * 3. All advertising materials mentioning features or use of this
  20  *    software must display the following acknowledgment:
  21  *    "This product includes software developed by the OpenSSL Project
  22  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  23  *
  24  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25  *    endorse or promote products derived from this software without
  26  *    prior written permission. For written permission, please contact
  27  *    licensing@OpenSSL.org.
  28  *
  29  * 5. Products derived from this software may not be called "OpenSSL"
  30  *    nor may "OpenSSL" appear in their names without prior written
  31  *    permission of the OpenSSL Project.
  32  *
  33  * 6. Redistributions of any form whatsoever must retain the following
  34  *    acknowledgment:
  35  *    "This product includes software developed by the OpenSSL Project
  36  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  37  *
  38  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49  * OF THE POSSIBILITY OF SUCH DAMAGE.
  50  * ====================================================================
  51  */
  52
  53 #include <stdio.h>
  54 #include <string.h>
  55
  56 #include <openssl/engine.h>
  57 #include <openssl/sha.h>
  58 #include <openssl/rsa.h>
  59 #include <openssl/evp.h>
  60 #include <openssl/async.h>
  61 #include <openssl/bn.h>
  62
  63 #define DASYNC_LIB_NAME "DASYNC"
  64 #include "e_dasync_err.c"
  65
  66 /* Engine Id and Name */
  67 static const char *engine_dasync_id = "dasync";
  68 static const char *engine_dasync_name = "Dummy Async engine support";
  69
  70
  71 /* Engine Lifetime functions */
  72 static int dasync_destroy(ENGINE *e);
  73 static int dasync_init(ENGINE *e);
  74 static int dasync_finish(ENGINE *e);
  75 void ENGINE_load_dasync(void);
  76
  77
  78 /* Set up digests. Just SHA1 for now */
  79 static int dasync_digests(ENGINE *e, const EVP_MD **digest,
  80                           const int **nids, int nid);
  81
  82 static void dummy_pause_job(void);
  83
  84 /* SHA1 */
  85 static int dasync_sha1_init(EVP_MD_CTX *ctx);
  86 static int dasync_sha1_update(EVP_MD_CTX *ctx, const void *data,
  87                              size_t count);
  88 static int dasync_sha1_final(EVP_MD_CTX *ctx, unsigned char *md);
  89
  90 static EVP_MD *_hidden_sha1_md = NULL;
  91 static const EVP_MD *dasync_sha1(void)
  92 {
  93     if (_hidden_sha1_md == NULL) {
  94         EVP_MD *md;
  95
  96         if ((md = EVP_MD_meth_new(NID_sha1, NID_sha1WithRSAEncryption)) == NULL
  97             || !EVP_MD_meth_set_result_size(md, SHA_DIGEST_LENGTH)
  98             || !EVP_MD_meth_set_input_blocksize(md, SHA_CBLOCK)
  99             || !EVP_MD_meth_set_app_datasize(md,
 100                                              sizeof(EVP_MD *) + sizeof(SHA_CTX))
 101             || !EVP_MD_meth_set_flags(md, EVP_MD_FLAG_DIGALGID_ABSENT)
 102             || !EVP_MD_meth_set_init(md, dasync_sha1_init)
 103             || !EVP_MD_meth_set_update(md, dasync_sha1_update)
 104             || !EVP_MD_meth_set_final(md, dasync_sha1_final)) {
 105             EVP_MD_meth_free(md);
 106             md = NULL;
 107         }
 108         _hidden_sha1_md = md;
 109     }
 110     return _hidden_sha1_md;
 111 }
 112 static void destroy_digests(void)
 113 {
 114     EVP_MD_meth_free(_hidden_sha1_md);
 115     _hidden_sha1_md = NULL;
 116 }
 117 static int dasync_digest_nids(const int **nids)
 118 {
 119     static int digest_nids[2] = { 0, 0 };
 120     static int pos = 0;
 121     static int init = 0;
 122
 123     if (!init) {
 124         const EVP_MD *md;
 125         if ((md = dasync_sha1()) != NULL)
 126             digest_nids[pos++] = EVP_MD_type(md);
 127         digest_nids[pos] = 0;
 128         init = 1;
 129     }
 130     *nids = digest_nids;
 131     return pos;
 132 }
 133
 134 /* RSA */
 135
 136 static int dasync_pub_enc(int flen, const unsigned char *from,
 137                     unsigned char *to, RSA *rsa, int padding);
 138 static int dasync_pub_dec(int flen, const unsigned char *from,
 139                     unsigned char *to, RSA *rsa, int padding);
 140 static int dasync_rsa_priv_enc(int flen, const unsigned char *from,
 141                       unsigned char *to, RSA *rsa, int padding);
 142 static int dasync_rsa_priv_dec(int flen, const unsigned char *from,
 143                       unsigned char *to, RSA *rsa, int padding);
 144 static int dasync_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa,
 145                               BN_CTX *ctx);
 146
 147 static int dasync_rsa_init(RSA *rsa);
 148 static int dasync_rsa_finish(RSA *rsa);
 149
 150 static RSA_METHOD dasync_rsa_method = {
 151     "Dummy Async RSA method",
 152     dasync_pub_enc,             /* pub_enc */
 153     dasync_pub_dec,             /* pub_dec */
 154     dasync_rsa_priv_enc,        /* priv_enc */
 155     dasync_rsa_priv_dec,        /* priv_dec */
 156     dasync_rsa_mod_exp,         /* rsa_mod_exp */
 157     BN_mod_exp_mont,            /* bn_mod_exp */
 158     dasync_rsa_init,            /* init */
 159     dasync_rsa_finish,          /* finish */
 160     0,                          /* flags */
 161     NULL,                       /* app_data */
 162     0,                          /* rsa_sign */
 163     0,                          /* rsa_verify */
 164     NULL                        /* rsa_keygen */
 165 };
 166
 167
 168 static int bind_dasync(ENGINE *e)
 169 {
 170     /* Ensure the dasync error handling is set up */
 171     ERR_load_DASYNC_strings();
 172
 173     if (!ENGINE_set_id(e, engine_dasync_id)
 174         || !ENGINE_set_name(e, engine_dasync_name)
 175         || !ENGINE_set_RSA(e, &dasync_rsa_method)
 176         || !ENGINE_set_digests(e, dasync_digests)
 177         || !ENGINE_set_destroy_function(e, dasync_destroy)
 178         || !ENGINE_set_init_function(e, dasync_init)
 179         || !ENGINE_set_finish_function(e, dasync_finish)) {
 180         DASYNCerr(DASYNC_F_BIND_DASYNC, DASYNC_R_INIT_FAILED);
 181         return 0;
 182     }
 183
 184     return 1;
 185 }
 186
 187 # ifndef OPENSSL_NO_DYNAMIC_ENGINE
 188 static int bind_helper(ENGINE *e, const char *id)
 189 {
 190     if (id && (strcmp(id, engine_dasync_id) != 0))
 191         return 0;
 192     if (!bind_dasync(e))
 193         return 0;
 194     return 1;
 195 }
 196
 197 IMPLEMENT_DYNAMIC_CHECK_FN()
 198     IMPLEMENT_DYNAMIC_BIND_FN(bind_helper)
 199 # endif
 200
 201 static ENGINE *engine_dasync(void)
 202 {
 203     ENGINE *ret = ENGINE_new();
 204     if (!ret)
 205         return NULL;
 206     if (!bind_dasync(ret)) {
 207         ENGINE_free(ret);
 208         return NULL;
 209     }
 210     return ret;
 211 }
 212
 213 void ENGINE_load_dasync(void)
 214 {
 215     ENGINE *toadd = engine_dasync();
 216     if (!toadd)
 217         return;
 218     ENGINE_add(toadd);
 219     ENGINE_free(toadd);
 220     ERR_clear_error();
 221 }
 222
 223 static int dasync_init(ENGINE *e)
 224 {
 225     return 1;
 226 }
 227
 228
 229 static int dasync_finish(ENGINE *e)
 230 {
 231     return 1;
 232 }
 233
 234
 235 static int dasync_destroy(ENGINE *e)
 236 {
 237     destroy_digests();
 238     ERR_unload_DASYNC_strings();
 239     return 1;
 240 }
 241
 242 static int dasync_digests(ENGINE *e, const EVP_MD **digest,
 243                           const int **nids, int nid)
 244 {
 245     int ok = 1;
 246     if (!digest) {
 247         /* We are returning a list of supported nids */
 248         return dasync_digest_nids(nids);
 249     }
 250     /* We are being asked for a specific digest */
 251     switch (nid) {
 252     case NID_sha1:
 253         *digest = dasync_sha1();
 254         break;
 255     default:
 256         ok = 0;
 257         *digest = NULL;
 258         break;
 259     }
 260     return ok;
 261 }
 262
 263 static void dummy_pause_job(void) {
 264     ASYNC_JOB *job;
 265
 266     if ((job = ASYNC_get_current_job()) == NULL)
 267         return;
 268
 269     /*
 270      * In the Dummy async engine we are cheating. We signal that the job
 271      * is complete by waking it before the call to ASYNC_pause_job(). A real
 272      * async engine would only wake when the job was actually complete
 273      */
 274     ASYNC_wake(job);
 275
 276     /* Ignore errors - we carry on anyway */
 277     ASYNC_pause_job();
 278
 279     ASYNC_clear_wake(job);
 280 }
 281
 282
 283 /*
 284  * SHA1 implementation. At the moment we just defer to the standard
 285  * implementation
 286  */
 287 #undef data
 288 #define data(ctx) ((SHA_CTX *)EVP_MD_CTX_md_data(ctx))
 289 static int dasync_sha1_init(EVP_MD_CTX *ctx)
 290 {
 291     dummy_pause_job();
 292
 293     return SHA1_Init(data(ctx));
 294 }
 295
 296 static int dasync_sha1_update(EVP_MD_CTX *ctx, const void *data,
 297                              size_t count)
 298 {
 299     dummy_pause_job();
 300
 301     return SHA1_Update(data(ctx), data, (size_t)count);
 302 }
 303
 304 static int dasync_sha1_final(EVP_MD_CTX *ctx, unsigned char *md)
 305 {
 306     dummy_pause_job();
 307
 308     return SHA1_Final(md, data(ctx));
 309 }
 310
 311 /*
 312  * RSA implementation
 313  */
 314
 315 static int dasync_pub_enc(int flen, const unsigned char *from,
 316                     unsigned char *to, RSA *rsa, int padding) {
 317     /* Ignore errors - we carry on anyway */
 318     dummy_pause_job();
 319     return RSA_PKCS1_OpenSSL()->rsa_pub_enc(flen, from, to, rsa, padding);
 320 }
 321
 322 static int dasync_pub_dec(int flen, const unsigned char *from,
 323                     unsigned char *to, RSA *rsa, int padding) {
 324     /* Ignore errors - we carry on anyway */
 325     dummy_pause_job();
 326     return RSA_PKCS1_OpenSSL()->rsa_pub_dec(flen, from, to, rsa, padding);
 327 }
 328
 329 static int dasync_rsa_priv_enc(int flen, const unsigned char *from,
 330                       unsigned char *to, RSA *rsa, int padding)
 331 {
 332     /* Ignore errors - we carry on anyway */
 333     dummy_pause_job();
 334     return RSA_PKCS1_OpenSSL()->rsa_priv_enc(flen, from, to, rsa, padding);
 335 }
 336
 337 static int dasync_rsa_priv_dec(int flen, const unsigned char *from,
 338                       unsigned char *to, RSA *rsa, int padding)
 339 {
 340     /* Ignore errors - we carry on anyway */
 341     dummy_pause_job();
 342     return RSA_PKCS1_OpenSSL()->rsa_priv_dec(flen, from, to, rsa, padding);
 343 }
 344
 345 static int dasync_rsa_mod_exp(BIGNUM *r0, const BIGNUM *I, RSA *rsa, BN_CTX *ctx)
 346 {
 347     /* Ignore errors - we carry on anyway */
 348     dummy_pause_job();
 349     return RSA_PKCS1_OpenSSL()->rsa_mod_exp(r0, I, rsa, ctx);
 350 }
 351
 352 static int dasync_rsa_init(RSA *rsa)
 353 {
 354     return RSA_PKCS1_OpenSSL()->init(rsa);
 355 }
 356 static int dasync_rsa_finish(RSA *rsa)
 357 {
 358     return RSA_PKCS1_OpenSSL()->finish(rsa);
 359 }