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         EVP_MD_CTX *mctx;       /* Parent EVP_MD_CTX */
  72         ASN1_OCTET_STRING ktmp; /* Temp storage for key */
  73         HMAC_CTX ctx;
  74         } HMAC_PKEY_CTX;
  75
  76 static int pkey_hmac_init(EVP_PKEY_CTX *ctx)
  77         {
  78         HMAC_PKEY_CTX *hctx;
  79         hctx = OPENSSL_malloc(sizeof(HMAC_PKEY_CTX));
  80         if (!hctx)
  81                 return 0;
  82         hctx->md = NULL;
  83         hctx->mctx = NULL;
  84         hctx->ktmp.data = NULL;
  85         HMAC_CTX_init(&hctx->ctx);
  86
  87         ctx->data = hctx;
  88         ctx->keygen_info_count = 0;
  89
  90         return 1;
  91         }
  92
  93 static int pkey_hmac_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
  94         {
  95         HMAC_PKEY_CTX *sctx, *dctx;
  96         if (!pkey_hmac_init(dst))
  97                 return 0;
  98         sctx = src->data;
  99         dctx = dst->data;
 100         dctx->md = sctx->md;
 101         HMAC_CTX_init(&dctx->ctx);
 102         HMAC_CTX_copy(&dctx->ctx, &sctx->ctx);
 103         if (sctx->ktmp.data)
 104                 {
 105                 if (!ASN1_OCTET_STRING_set(&dctx->ktmp,
 106                                         sctx->ktmp.data, sctx->ktmp.length))
 107                         return 0;
 108                 }
 109         return 1;
 110         }
 111
 112 static void pkey_hmac_cleanup(EVP_PKEY_CTX *ctx)
 113         {
 114         HMAC_PKEY_CTX *hctx = ctx->data;
 115         HMAC_CTX_cleanup(&hctx->ctx);
 116         if (hctx->ktmp.data)
 117                 {
 118                 OPENSSL_cleanse(hctx->ktmp.data, hctx->ktmp.length);
 119                 OPENSSL_free(hctx->ktmp.data);
 120                 hctx->ktmp.data = NULL;
 121                 }
 122         OPENSSL_free(hctx);
 123         }
 124
 125 static int pkey_hmac_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
 126         {
 127         ASN1_OCTET_STRING *hkey = NULL;
 128         HMAC_PKEY_CTX *hctx = ctx->data;
 129         if (!hctx->ktmp.data)
 130                 return 0;
 131         hkey = ASN1_OCTET_STRING_dup(&hctx->ktmp);
 132         if (!hkey)
 133                 return 0;
 134         EVP_PKEY_assign(pkey, EVP_PKEY_HMAC, hkey);
 135
 136         return 1;
 137         }
 138
 139 static int int_update(EVP_MD_CTX *ctx,const void *data,size_t count)
 140         {
 141         HMAC_PKEY_CTX *hctx = ctx->pctx->data;
 142         HMAC_Update(&hctx->ctx, data, count);
 143         return 1;
 144         }
 145
 146 static int hmac_signctx_init(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx)
 147         {
 148         HMAC_PKEY_CTX *hctx = ctx->data;
 149         hctx->mctx = mctx;
 150         EVP_MD_CTX_set_flags(mctx, EVP_MD_CTX_FLAG_NO_INIT);
 151         mctx->update = int_update;
 152         return 1;
 153         }
 154
 155 static int hmac_signctx(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
 156                                         EVP_MD_CTX *mctx)
 157         {
 158         unsigned int hlen;
 159         HMAC_PKEY_CTX *hctx = ctx->data;
 160         *siglen = EVP_MD_CTX_size(mctx);
 161         if (!sig)
 162                 return 1;
 163
 164         HMAC_Final(&hctx->ctx, sig, &hlen);
 165         *siglen = (size_t)hlen;
 166         return 1;
 167         }
 168
 169 static int pkey_hmac_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
 170         {
 171         HMAC_PKEY_CTX *hctx = ctx->data;
 172         ASN1_OCTET_STRING *key;
 173         switch (type)
 174                 {
 175
 176                 case EVP_PKEY_CTRL_SET_MAC_KEY:
 177                 if ((!p2 && p1 > 0) || (p1 < -1))
 178                         return 0;
 179                 if (!ASN1_OCTET_STRING_set(&hctx->ktmp, p2, p1))
 180                         return 0;
 181                 break;
 182
 183                 case EVP_PKEY_CTRL_MD:
 184                 hctx->md = p2;
 185                 break;
 186
 187                 case EVP_PKEY_CTRL_DIGESTINIT:
 188                 key = (ASN1_OCTET_STRING *)ctx->pkey->pkey.ptr;
 189                 HMAC_Init_ex(&hctx->ctx, key->data, key->length, hctx->md,
 190                                 ctx->engine);
 191                 break;
 192
 193                 default:
 194                 return -2;
 195
 196                 }
 197         return 1;
 198         }
 199
 200 static int pkey_hmac_ctrl_str(EVP_PKEY_CTX *ctx,
 201                         const char *type, const char *value)
 202         {
 203         if (!value)
 204                 {
 205                 return 0;
 206                 }
 207         if (!strcmp(type, "key"))
 208                 {
 209                 return pkey_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY,
 210                                 -1, (void *)value);
 211                 }
 212         if (!strcmp(type, "hexkey"))
 213                 {
 214                 unsigned char *key;
 215                 int r;
 216                 long keylen;
 217                 key = string_to_hex(value, &keylen);
 218                 if (!key)
 219                         return 0;
 220                 r = pkey_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY, keylen, key);
 221                 OPENSSL_free(key);
 222                 return r;
 223                 }
 224         return -2;
 225         }
 226
 227 const EVP_PKEY_METHOD hmac_pkey_meth =
 228         {
 229         EVP_PKEY_HMAC,
 230         0,
 231         pkey_hmac_init,
 232         pkey_hmac_copy,
 233         pkey_hmac_cleanup,
 234
 235         0, 0,
 236
 237         0,
 238         pkey_hmac_keygen,
 239
 240         0, 0,
 241
 242         0, 0,
 243
 244         0,0,
 245
 246         hmac_signctx_init,
 247         hmac_signctx,
 248
 249         0,0,
 250
 251         0,0,
 252
 253         0,0,
 254
 255         0,0,
 256
 257         pkey_hmac_ctrl,
 258         pkey_hmac_ctrl_str
 259
 260         };