CryptoPkg/Library/BaseCryptLib/Kdf/CryptHkdf.c

   1 /** @file
   2   HMAC-SHA256 KDF Wrapper Implementation over OpenSSL.
   3
   4 Copyright (c) 2018 - 2019, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #include <Library/BaseCryptLib.h>
  10 #include <openssl/evp.h>
  11 #include <openssl/kdf.h>
  12
  13 /**
  14   Derive HMAC-based Extract-and-Expand Key Derivation Function (HKDF).
  15
  16   @param[in]   Key              Pointer to the user-supplied key.
  17   @param[in]   KeySize          Key size in bytes.
  18   @param[in]   Salt             Pointer to the salt(non-secret) value.
  19   @param[in]   SaltSize         Salt size in bytes.
  20   @param[in]   Info             Pointer to the application specific info.
  21   @param[in]   InfoSize         Info size in bytes.
  22   @param[out]  Out              Pointer to buffer to receive hkdf value.
  23   @param[in]   OutSize          Size of hkdf bytes to generate.
  24
  25   @retval TRUE   Hkdf generated successfully.
  26   @retval FALSE  Hkdf generation failed.
  27
  28 **/
  29 BOOLEAN
  30 EFIAPI
  31 HkdfSha256ExtractAndExpand (
  32   IN   CONST UINT8  *Key,
  33   IN   UINTN        KeySize,
  34   IN   CONST UINT8  *Salt,
  35   IN   UINTN        SaltSize,
  36   IN   CONST UINT8  *Info,
  37   IN   UINTN        InfoSize,
  38   OUT  UINT8        *Out,
  39   IN   UINTN        OutSize
  40   )
  41 {
  42   EVP_PKEY_CTX  *pHkdfCtx;
  43   BOOLEAN       Result;
  44
  45   if ((Key == NULL) || (Salt == NULL) || (Info == NULL) || (Out == NULL) ||
  46       (KeySize > INT_MAX) || (SaltSize > INT_MAX) || (InfoSize > INT_MAX) || (OutSize > INT_MAX))
  47   {
  48     return FALSE;
  49   }
  50
  51   pHkdfCtx = EVP_PKEY_CTX_new_id (EVP_PKEY_HKDF, NULL);
  52   if (pHkdfCtx == NULL) {
  53     return FALSE;
  54   }
  55
  56   Result = EVP_PKEY_derive_init (pHkdfCtx) > 0;
  57   if (Result) {
  58     Result = EVP_PKEY_CTX_set_hkdf_md (pHkdfCtx, EVP_sha256 ()) > 0;
  59   }
  60
  61   if (Result) {
  62     Result = EVP_PKEY_CTX_set1_hkdf_salt (pHkdfCtx, Salt, (UINT32)SaltSize) > 0;
  63   }
  64
  65   if (Result) {
  66     Result = EVP_PKEY_CTX_set1_hkdf_key (pHkdfCtx, Key, (UINT32)KeySize) > 0;
  67   }
  68
  69   if (Result) {
  70     Result = EVP_PKEY_CTX_add1_hkdf_info (pHkdfCtx, Info, (UINT32)InfoSize) > 0;
  71   }
  72
  73   if (Result) {
  74     Result = EVP_PKEY_derive (pHkdfCtx, Out, &OutSize) > 0;
  75   }
  76
  77   EVP_PKEY_CTX_free (pHkdfCtx);
  78   pHkdfCtx = NULL;
  79   return Result;
  80 }