crypto/hmac/hmac.c

   1 /*
   2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /*
  11  * HMAC low level APIs are deprecated for public use, but still ok for internal
  12  * use.
  13  */
  14 #include "internal/deprecated.h"
  15
  16 #include <stdio.h>
  17 #include <stdlib.h>
  18 #include <string.h>
  19 #include "internal/cryptlib.h"
  20 #include <openssl/hmac.h>
  21 #include <openssl/opensslconf.h>
  22 #include "hmac_local.h"
  23
  24 int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int len,
  25                  const EVP_MD *md, ENGINE *impl)
  26 {
  27     int rv = 0, reset = 0;
  28     int i, j;
  29     unsigned char pad[HMAC_MAX_MD_CBLOCK_SIZE];
  30     unsigned int keytmp_length;
  31     unsigned char keytmp[HMAC_MAX_MD_CBLOCK_SIZE];
  32
  33     /* If we are changing MD then we must have a key */
  34     if (md != NULL && md != ctx->md && (key == NULL || len < 0))
  35         return 0;
  36
  37     if (md != NULL) {
  38         ctx->md = md;
  39     } else if (ctx->md) {
  40         md = ctx->md;
  41     } else {
  42         return 0;
  43     }
  44
  45     /*
  46      * The HMAC construction is not allowed to be used with the
  47      * extendable-output functions (XOF) shake128 and shake256.
  48      */
  49     if ((EVP_MD_flags(md) & EVP_MD_FLAG_XOF) != 0)
  50         return 0;
  51
  52     if (key != NULL) {
  53         reset = 1;
  54
  55         j = EVP_MD_block_size(md);
  56         if (!ossl_assert(j <= (int)sizeof(keytmp)))
  57             return 0;
  58         if (j < len) {
  59             if (!EVP_DigestInit_ex(ctx->md_ctx, md, impl)
  60                     || !EVP_DigestUpdate(ctx->md_ctx, key, len)
  61                     || !EVP_DigestFinal_ex(ctx->md_ctx, keytmp,
  62                                            &keytmp_length))
  63                 return 0;
  64         } else {
  65             if (len < 0 || len > (int)sizeof(keytmp))
  66                 return 0;
  67             memcpy(keytmp, key, len);
  68             keytmp_length = len;
  69         }
  70         if (keytmp_length != HMAC_MAX_MD_CBLOCK_SIZE)
  71             memset(&keytmp[keytmp_length], 0,
  72                    HMAC_MAX_MD_CBLOCK_SIZE - keytmp_length);
  73
  74         for (i = 0; i < HMAC_MAX_MD_CBLOCK_SIZE; i++)
  75             pad[i] = 0x36 ^ keytmp[i];
  76         if (!EVP_DigestInit_ex(ctx->i_ctx, md, impl)
  77                 || !EVP_DigestUpdate(ctx->i_ctx, pad, EVP_MD_block_size(md)))
  78             goto err;
  79
  80         for (i = 0; i < HMAC_MAX_MD_CBLOCK_SIZE; i++)
  81             pad[i] = 0x5c ^ keytmp[i];
  82         if (!EVP_DigestInit_ex(ctx->o_ctx, md, impl)
  83                 || !EVP_DigestUpdate(ctx->o_ctx, pad, EVP_MD_block_size(md)))
  84             goto err;
  85     }
  86     if (!EVP_MD_CTX_copy_ex(ctx->md_ctx, ctx->i_ctx))
  87         goto err;
  88     rv = 1;
  89  err:
  90     if (reset) {
  91         OPENSSL_cleanse(keytmp, sizeof(keytmp));
  92         OPENSSL_cleanse(pad, sizeof(pad));
  93     }
  94     return rv;
  95 }
  96
  97 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
  98 int HMAC_Init(HMAC_CTX *ctx, const void *key, int len, const EVP_MD *md)
  99 {
 100     if (key && md)
 101         HMAC_CTX_reset(ctx);
 102     return HMAC_Init_ex(ctx, key, len, md, NULL);
 103 }
 104 #endif
 105
 106 int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, size_t len)
 107 {
 108     if (!ctx->md)
 109         return 0;
 110     return EVP_DigestUpdate(ctx->md_ctx, data, len);
 111 }
 112
 113 int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len)
 114 {
 115     unsigned int i;
 116     unsigned char buf[EVP_MAX_MD_SIZE];
 117
 118     if (!ctx->md)
 119         goto err;
 120
 121     if (!EVP_DigestFinal_ex(ctx->md_ctx, buf, &i))
 122         goto err;
 123     if (!EVP_MD_CTX_copy_ex(ctx->md_ctx, ctx->o_ctx))
 124         goto err;
 125     if (!EVP_DigestUpdate(ctx->md_ctx, buf, i))
 126         goto err;
 127     if (!EVP_DigestFinal_ex(ctx->md_ctx, md, len))
 128         goto err;
 129     return 1;
 130  err:
 131     return 0;
 132 }
 133
 134 size_t HMAC_size(const HMAC_CTX *ctx)
 135 {
 136     int size = EVP_MD_size((ctx)->md);
 137
 138     return (size < 0) ? 0 : size;
 139 }
 140
 141 HMAC_CTX *HMAC_CTX_new(void)
 142 {
 143     HMAC_CTX *ctx = OPENSSL_zalloc(sizeof(HMAC_CTX));
 144
 145     if (ctx != NULL) {
 146         if (!HMAC_CTX_reset(ctx)) {
 147             HMAC_CTX_free(ctx);
 148             return NULL;
 149         }
 150     }
 151     return ctx;
 152 }
 153
 154 static void hmac_ctx_cleanup(HMAC_CTX *ctx)
 155 {
 156     EVP_MD_CTX_reset(ctx->i_ctx);
 157     EVP_MD_CTX_reset(ctx->o_ctx);
 158     EVP_MD_CTX_reset(ctx->md_ctx);
 159     ctx->md = NULL;
 160 }
 161
 162 void HMAC_CTX_free(HMAC_CTX *ctx)
 163 {
 164     if (ctx != NULL) {
 165         hmac_ctx_cleanup(ctx);
 166         EVP_MD_CTX_free(ctx->i_ctx);
 167         EVP_MD_CTX_free(ctx->o_ctx);
 168         EVP_MD_CTX_free(ctx->md_ctx);
 169         OPENSSL_free(ctx);
 170     }
 171 }
 172
 173 static int hmac_ctx_alloc_mds(HMAC_CTX *ctx)
 174 {
 175     if (ctx->i_ctx == NULL)
 176         ctx->i_ctx = EVP_MD_CTX_new();
 177     if (ctx->i_ctx == NULL)
 178         return 0;
 179     if (ctx->o_ctx == NULL)
 180         ctx->o_ctx = EVP_MD_CTX_new();
 181     if (ctx->o_ctx == NULL)
 182         return 0;
 183     if (ctx->md_ctx == NULL)
 184         ctx->md_ctx = EVP_MD_CTX_new();
 185     if (ctx->md_ctx == NULL)
 186         return 0;
 187     return 1;
 188 }
 189
 190 int HMAC_CTX_reset(HMAC_CTX *ctx)
 191 {
 192     hmac_ctx_cleanup(ctx);
 193     if (!hmac_ctx_alloc_mds(ctx)) {
 194         hmac_ctx_cleanup(ctx);
 195         return 0;
 196     }
 197     return 1;
 198 }
 199
 200 int HMAC_CTX_copy(HMAC_CTX *dctx, HMAC_CTX *sctx)
 201 {
 202     if (!hmac_ctx_alloc_mds(dctx))
 203         goto err;
 204     if (!EVP_MD_CTX_copy_ex(dctx->i_ctx, sctx->i_ctx))
 205         goto err;
 206     if (!EVP_MD_CTX_copy_ex(dctx->o_ctx, sctx->o_ctx))
 207         goto err;
 208     if (!EVP_MD_CTX_copy_ex(dctx->md_ctx, sctx->md_ctx))
 209         goto err;
 210     dctx->md = sctx->md;
 211     return 1;
 212  err:
 213     hmac_ctx_cleanup(dctx);
 214     return 0;
 215 }
 216
 217 unsigned char *HMAC(const EVP_MD *evp_md, const void *key, int key_len,
 218                     const unsigned char *d, size_t n, unsigned char *md,
 219                     unsigned int *md_len)
 220 {
 221     HMAC_CTX *c = NULL;
 222     static unsigned char m[EVP_MAX_MD_SIZE];
 223     static const unsigned char dummy_key[1] = {'\0'};
 224
 225     if (md == NULL)
 226         md = m;
 227     if ((c = HMAC_CTX_new()) == NULL)
 228         goto err;
 229
 230     /* For HMAC_Init_ex, NULL key signals reuse. */
 231     if (key == NULL && key_len == 0) {
 232         key = dummy_key;
 233     }
 234
 235     if (!HMAC_Init_ex(c, key, key_len, evp_md, NULL))
 236         goto err;
 237     if (!HMAC_Update(c, d, n))
 238         goto err;
 239     if (!HMAC_Final(c, md, md_len))
 240         goto err;
 241     HMAC_CTX_free(c);
 242     return md;
 243  err:
 244     HMAC_CTX_free(c);
 245     return NULL;
 246 }
 247
 248 void HMAC_CTX_set_flags(HMAC_CTX *ctx, unsigned long flags)
 249 {
 250     EVP_MD_CTX_set_flags(ctx->i_ctx, flags);
 251     EVP_MD_CTX_set_flags(ctx->o_ctx, flags);
 252     EVP_MD_CTX_set_flags(ctx->md_ctx, flags);
 253 }
 254
 255 const EVP_MD *HMAC_CTX_get_md(const HMAC_CTX *ctx)
 256 {
 257     return ctx->md;
 258 }