2013-09-18 07:31:18 +02:00
|
|
|
/** @file
|
2016-10-17 03:26:13 +02:00
|
|
|
This library abstract TPM2 hash calculation.
|
2013-09-18 07:31:18 +02:00
|
|
|
The platform can choose multiply hash, while caller just need invoke these API.
|
|
|
|
Then all hash value will be returned and/or extended.
|
|
|
|
|
2016-10-17 03:26:13 +02:00
|
|
|
Copyright (c) 2013 - 2016, Intel Corporation. All rights reserved. <BR>
|
2019-04-04 01:06:56 +02:00
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
2013-09-18 07:31:18 +02:00
|
|
|
|
|
|
|
**/
|
|
|
|
|
|
|
|
#ifndef _HASH_LIB_H_
|
|
|
|
#define _HASH_LIB_H_
|
|
|
|
|
|
|
|
#include <Uefi.h>
|
|
|
|
#include <Protocol/Hash.h>
|
2018-06-06 05:24:54 +02:00
|
|
|
#include <IndustryStandard/Tpm20.h>
|
2013-09-18 07:31:18 +02:00
|
|
|
typedef UINTN HASH_HANDLE;
|
|
|
|
|
|
|
|
/**
|
|
|
|
Start hash sequence.
|
|
|
|
|
|
|
|
@param HashHandle Hash handle.
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS Hash sequence start and HandleHandle returned.
|
|
|
|
@retval EFI_OUT_OF_RESOURCES No enough resource to start hash.
|
|
|
|
**/
|
|
|
|
EFI_STATUS
|
|
|
|
EFIAPI
|
|
|
|
HashStart (
|
|
|
|
OUT HASH_HANDLE *HashHandle
|
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
|
|
|
Update hash sequence data.
|
|
|
|
|
|
|
|
@param HashHandle Hash handle.
|
|
|
|
@param DataToHash Data to be hashed.
|
|
|
|
@param DataToHashLen Data size.
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS Hash sequence updated.
|
|
|
|
**/
|
|
|
|
EFI_STATUS
|
|
|
|
EFIAPI
|
|
|
|
HashUpdate (
|
|
|
|
IN HASH_HANDLE HashHandle,
|
|
|
|
IN VOID *DataToHash,
|
|
|
|
IN UINTN DataToHashLen
|
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
|
|
|
Hash sequence complete and extend to PCR.
|
|
|
|
|
|
|
|
@param HashHandle Hash handle.
|
|
|
|
@param PcrIndex PCR to be extended.
|
|
|
|
@param DataToHash Data to be hashed.
|
|
|
|
@param DataToHashLen Data size.
|
|
|
|
@param DigestList Digest list.
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS Hash sequence complete and DigestList is returned.
|
|
|
|
**/
|
|
|
|
EFI_STATUS
|
|
|
|
EFIAPI
|
|
|
|
HashCompleteAndExtend (
|
|
|
|
IN HASH_HANDLE HashHandle,
|
|
|
|
IN TPMI_DH_PCR PcrIndex,
|
|
|
|
IN VOID *DataToHash,
|
|
|
|
IN UINTN DataToHashLen,
|
|
|
|
OUT TPML_DIGEST_VALUES *DigestList
|
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
|
|
|
Hash data and extend to PCR.
|
|
|
|
|
|
|
|
@param PcrIndex PCR to be extended.
|
|
|
|
@param DataToHash Data to be hashed.
|
|
|
|
@param DataToHashLen Data size.
|
|
|
|
@param DigestList Digest list.
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS Hash data and DigestList is returned.
|
|
|
|
**/
|
|
|
|
EFI_STATUS
|
|
|
|
EFIAPI
|
|
|
|
HashAndExtend (
|
|
|
|
IN TPMI_DH_PCR PcrIndex,
|
|
|
|
IN VOID *DataToHash,
|
|
|
|
IN UINTN DataToHashLen,
|
|
|
|
OUT TPML_DIGEST_VALUES *DigestList
|
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
|
|
|
Start hash sequence.
|
|
|
|
|
|
|
|
@param HashHandle Hash handle.
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS Hash sequence start and HandleHandle returned.
|
|
|
|
@retval EFI_OUT_OF_RESOURCES No enough resource to start hash.
|
|
|
|
**/
|
|
|
|
typedef
|
|
|
|
EFI_STATUS
|
|
|
|
(EFIAPI *HASH_INIT) (
|
|
|
|
OUT HASH_HANDLE *HashHandle
|
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
|
|
|
Update hash sequence data.
|
|
|
|
|
|
|
|
@param HashHandle Hash handle.
|
|
|
|
@param DataToHash Data to be hashed.
|
|
|
|
@param DataToHashLen Data size.
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS Hash sequence updated.
|
|
|
|
**/
|
|
|
|
typedef
|
|
|
|
EFI_STATUS
|
|
|
|
(EFIAPI *HASH_UPDATE) (
|
|
|
|
IN HASH_HANDLE HashHandle,
|
|
|
|
IN VOID *DataToHash,
|
|
|
|
IN UINTN DataToHashLen
|
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
|
|
|
Complete hash sequence complete.
|
|
|
|
|
|
|
|
@param HashHandle Hash handle.
|
|
|
|
@param DigestList Digest list.
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS Hash sequence complete and DigestList is returned.
|
|
|
|
**/
|
|
|
|
typedef
|
|
|
|
EFI_STATUS
|
|
|
|
(EFIAPI *HASH_FINAL) (
|
|
|
|
IN HASH_HANDLE HashHandle,
|
|
|
|
OUT TPML_DIGEST_VALUES *DigestList
|
|
|
|
);
|
|
|
|
|
|
|
|
#define HASH_ALGORITHM_SHA1_GUID EFI_HASH_ALGORITHM_SHA1_GUID
|
|
|
|
#define HASH_ALGORITHM_SHA256_GUID EFI_HASH_ALGORITHM_SHA256_GUID
|
|
|
|
#define HASH_ALGORITHM_SHA384_GUID EFI_HASH_ALGORITHM_SHA384_GUID
|
|
|
|
#define HASH_ALGORITHM_SHA512_GUID EFI_HASH_ALGORITHM_SHA512_GUID
|
SecurityPkg: introduce the SM3 digest algorithm
BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=1781
GITHUB: https://github.com/idesai/edk2/tree/enable_sm3_measured_boot_v6
EDK2 Support for SM3 digest algorithm is needed to enable TPM with SM3 PCR
banks. This digest algorithm is part of the China Crypto algorithm suite.
This integration has dependency on the openssl_1_1_1b integration into
edk2.
This patch add SM3 algorithm in the hashinstance library.
Delta in v7:
1. Dropped 95a040cff from v6 to address https://edk2.groups.io/g/devel/topic/
32454898?p=,,,20,0,0,0::Created,,sm3,20,2,0,32454898,ct=1&ct=1
2. Relocated SM3 GUID definition from MdePkg to SecurityPkg in 9728b54f4
Cc: Chao Zhang <chao.b.zhang@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Jian Wang <jian.j.wang@intel.com>
Signed-off-by: Imran Desai <imran.desai@intel.com>
Message-Id: <20190718225326.40839-2-imran.desai@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
Reviewed-by: Jian J Wang <jian.j.wang@intel.com>
2019-07-19 00:53:23 +02:00
|
|
|
#define HASH_ALGORITHM_SM3_256_GUID \
|
|
|
|
{ \
|
|
|
|
0x251C7818, 0x0DBF, 0xE619, { 0x7F, 0xC2, 0xD6, 0xAC, 0x43, 0x42, 0x7D, 0xA3 } \
|
|
|
|
}
|
2013-09-18 07:31:18 +02:00
|
|
|
|
|
|
|
typedef struct {
|
|
|
|
EFI_GUID HashGuid;
|
|
|
|
HASH_INIT HashInit;
|
|
|
|
HASH_UPDATE HashUpdate;
|
|
|
|
HASH_FINAL HashFinal;
|
|
|
|
} HASH_INTERFACE;
|
|
|
|
|
|
|
|
/**
|
|
|
|
This service register Hash.
|
|
|
|
|
|
|
|
@param HashInterface Hash interface
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS This hash interface is registered successfully.
|
|
|
|
@retval EFI_UNSUPPORTED System does not support register this interface.
|
|
|
|
@retval EFI_ALREADY_STARTED System already register this interface.
|
|
|
|
**/
|
|
|
|
EFI_STATUS
|
|
|
|
EFIAPI
|
|
|
|
RegisterHashInterfaceLib (
|
|
|
|
IN HASH_INTERFACE *HashInterface
|
|
|
|
);
|
|
|
|
|
|
|
|
#endif
|