crypto/hmac/hm_pmeth.c

   1 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
   2  * project 2007.
   3  */
   4 /* ====================================================================
   5  * Copyright (c) 2007 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  * This product includes cryptographic software written by Eric Young
  53  * (eay@cryptsoft.com).  This product includes software written by Tim
  54  * Hudson (tjh@cryptsoft.com).
  55  *
  56  */
  57
  58 #include <stdio.h>
  59 #include "cryptlib.h"
  60 #include <openssl/x509.h>
  61 #include <openssl/x509v3.h>
  62 #include <openssl/evp.h>
  63 #include <openssl/hmac.h>
  64 #include "evp_locl.h"
  65
  66 /* HMAC pkey context structure */
  67
  68 typedef struct
  69         {
  70         const EVP_MD *md;       /* MD for HMAC use */
  71         ASN1_OCTET_STRING ktmp; /* Temp storage for key */
  72         HMAC_CTX ctx;
  73         } HMAC_PKEY_CTX;
  74
  75 static int pkey_hmac_init(EVP_PKEY_CTX *ctx)
  76         {
  77         HMAC_PKEY_CTX *hctx;
  78         hctx = OPENSSL_malloc(sizeof(HMAC_PKEY_CTX));
  79         if (!hctx)
  80                 return 0;
  81         hctx->md = NULL;
  82         hctx->ktmp.data = NULL;
  83         HMAC_CTX_init(&hctx->ctx);
  84
  85         ctx->data = hctx;
  86         ctx->keygen_info_count = 0;
  87
  88         return 1;
  89         }
  90
  91 static int pkey_hmac_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
  92         {
  93         HMAC_PKEY_CTX *sctx, *dctx;
  94         if (!pkey_hmac_init(dst))
  95                 return 0;
  96         sctx = src->data;
  97         dctx = dst->data;
  98         dctx->md = sctx->md;
  99         HMAC_CTX_init(&dctx->ctx);
 100         HMAC_CTX_copy(&dctx->ctx, &sctx->ctx);
 101         if (sctx->ktmp.data)
 102                 {
 103                 if (!ASN1_OCTET_STRING_set(&dctx->ktmp,
 104                                         sctx->ktmp.data, sctx->ktmp.length))
 105                         return 0;
 106                 }
 107         return 1;
 108         }
 109
 110 static void pkey_hmac_cleanup(EVP_PKEY_CTX *ctx)
 111         {
 112         HMAC_PKEY_CTX *hctx = ctx->data;
 113         HMAC_CTX_cleanup(&hctx->ctx);
 114         if (hctx->ktmp.data)
 115                 {
 116                 OPENSSL_cleanse(hctx->ktmp.data, hctx->ktmp.length);
 117                 OPENSSL_free(hctx->ktmp.data);
 118                 hctx->ktmp.data = NULL;
 119                 }
 120         OPENSSL_free(hctx);
 121         }
 122
 123 static int pkey_hmac_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
 124         {
 125         ASN1_OCTET_STRING *hkey = NULL;
 126         HMAC_PKEY_CTX *hctx = ctx->data;
 127         if (!hctx->ktmp.data)
 128                 return 0;
 129         hkey = ASN1_OCTET_STRING_dup(&hctx->ktmp);
 130         if (!hkey)
 131                 return 0;
 132         EVP_PKEY_assign(pkey, EVP_PKEY_HMAC, hkey);
 133
 134         return 1;
 135         }
 136
 137 static int int_update(EVP_MD_CTX *ctx,const void *data,size_t count)
 138         {
 139         HMAC_PKEY_CTX *hctx = ctx->pctx->data;
 140         HMAC_Update(&hctx->ctx, data, count);
 141         return 1;
 142         }
 143
 144 static int hmac_signctx_init(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx)
 145         {
 146         EVP_MD_CTX_set_flags(mctx, EVP_MD_CTX_FLAG_NO_INIT);
 147         mctx->update = int_update;
 148         return 1;
 149         }
 150
 151 static int hmac_signctx(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
 152                                         EVP_MD_CTX *mctx)
 153         {
 154         unsigned int hlen;
 155         HMAC_PKEY_CTX *hctx = ctx->data;
 156         *siglen = EVP_MD_CTX_size(mctx);
 157         if (!sig)
 158                 return 1;
 159
 160         HMAC_Final(&hctx->ctx, sig, &hlen);
 161         *siglen = (size_t)hlen;
 162         return 1;
 163         }
 164
 165 static int pkey_hmac_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
 166         {
 167         HMAC_PKEY_CTX *hctx = ctx->data;
 168         ASN1_OCTET_STRING *key;
 169         switch (type)
 170                 {
 171
 172                 case EVP_PKEY_CTRL_SET_MAC_KEY:
 173                 if ((!p2 && p1 > 0) || (p1 < -1))
 174                         return 0;
 175                 if (!ASN1_OCTET_STRING_set(&hctx->ktmp, p2, p1))
 176                         return 0;
 177                 break;
 178
 179                 case EVP_PKEY_CTRL_MD:
 180                 hctx->md = p2;
 181                 break;
 182
 183                 case EVP_PKEY_CTRL_DIGESTINIT:
 184                 key = (ASN1_OCTET_STRING *)ctx->pkey->pkey.ptr;
 185                 HMAC_Init_ex(&hctx->ctx, key->data, key->length, hctx->md,
 186                                 ctx->engine);
 187                 break;
 188
 189                 default:
 190                 return -2;
 191
 192                 }
 193         return 1;
 194         }
 195
 196 static int pkey_hmac_ctrl_str(EVP_PKEY_CTX *ctx,
 197                         const char *type, const char *value)
 198         {
 199         if (!value)
 200                 {
 201                 return 0;
 202                 }
 203         if (!strcmp(type, "key"))
 204                 {
 205                 return pkey_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY,
 206                                 -1, (void *)value);
 207                 }
 208         if (!strcmp(type, "hexkey"))
 209                 {
 210                 unsigned char *key;
 211                 int r;
 212                 long keylen;
 213                 key = string_to_hex(value, &keylen);
 214                 if (!key)
 215                         return 0;
 216                 r = pkey_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY, keylen, key);
 217                 OPENSSL_free(key);
 218                 return r;
 219                 }
 220         return -2;
 221         }
 222
 223 const EVP_PKEY_METHOD hmac_pkey_meth =
 224         {
 225         EVP_PKEY_HMAC,
 226         0,
 227         pkey_hmac_init,
 228         pkey_hmac_copy,
 229         pkey_hmac_cleanup,
 230
 231         0, 0,
 232
 233         0,
 234         pkey_hmac_keygen,
 235
 236         0, 0,
 237
 238         0, 0,
 239
 240         0,0,
 241
 242         hmac_signctx_init,
 243         hmac_signctx,
 244
 245         0,0,
 246
 247         0,0,
 248
 249         0,0,
 250
 251         0,0,
 252
 253         pkey_hmac_ctrl,
 254         pkey_hmac_ctrl_str
 255
 256         };