Skip to content

Commit

Permalink
CryptoPkg/BaseHashApiLib: Align BaseHashApiLib with TPM 2.0 Implement…
Browse files Browse the repository at this point in the history 
…ation

Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=2511

This commit aligns the baseHashApiLib with TPM 2.0 Implementation
as follows:
- Remove reference to MD4 and MD5 algorithms as they are deprecated
- Align the enumerations for hashing algoerithms with the one used
  in TPM 2.0 implementation defined in IndustryStandard/Tpm20.h.

Cc: Jiewen Yao <[email protected]>
Cc: Jian J Wang <[email protected]>
Cc: Michael D Kinney <[email protected]>
Signed-off-by: Amol N Sukerkar <[email protected]>
Reviewed-by: Jian J Wang <[email protected]>
  • Loading branch information
@mergify
Amol N Sukerkar authored and mergify[bot] committed Feb 19, 2020
1 parent 0997352 commit c70bdf9
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 114 deletions.
16 changes: 7 additions & 9 deletions CryptoPkg/CryptoPkg.dec
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,16 +74,14 @@
# Based on the value set, the required algorithm is chosen to calculate
# the hash of data.<BR>
# The default hashing algorithm for BaseHashApiLib is set to SHA256.<BR>
# 0x00000001 - MD4.<BR>
# 0x00000002 - MD5.<BR>
# 0x00000003 - SHA1.<BR>
# 0x00000004 - SHA256.<BR>
# 0x00000005 - SHA384.<BR>
# 0x00000006 - SHA512.<BR>
# 0x00000007 - SM3_256.<BR>
# 0x00000001 - HASH_ALG_SHA1.<BR>
# 0x00000002 - HASH_ALG_SHA256.<BR>
# 0x00000004 - HASH_ALG_SHA384.<BR>
# 0x00000008 - HASH_ALG_SHA512.<BR>
# 0x00000010 - HASH_ALG_SM3_256.<BR>
# @Prompt Set policy for hashing unsigned image for Secure Boot.
# @ValidRange 0x80000001 | 0x00000001 - 0x00000007
gEfiCryptoPkgTokenSpaceGuid.PcdHashApiLibPolicy|0x04|UINT8|0x00000001
# @ValidList 0x80000001 | 0x00000001, 0x00000002, 0x00000004, 0x00000008, 0x00000010
gEfiCryptoPkgTokenSpaceGuid.PcdHashApiLibPolicy|0x00000002|UINT32|0x00000001

[UserExtensions.TianoCore."ExtraFiles"]
CryptoPkgExtra.uni
12 changes: 5 additions & 7 deletions CryptoPkg/CryptoPkg.uni
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,11 @@
"Based on the value set, the required algorithm is chosen to calculate\n"
"the hash of data.<BR>\n"
"The default hashing algorithm for BaseHashApiLib is set to SHA256.<BR>\n"
"0x00000001 - MD4.<BR>\n"
"0x00000002 - MD5.<BR>\n"
"0x00000003 - SHA1.<BR>\n"
"0x00000004 - SHA256.<BR>\n"
"0x00000005 - SHA384.<BR>\n"
"0x00000006 - SHA512.<BR>\n"
"0x00000007 - SM3.<BR>"
"0x00000001 - HASH_ALG_SHA1.<BR>\n"
"0x00000002 - HASH_ALG_SHA256.<BR>\n"
"0x00000004 - HASH_ALG_SHA384.<BR>\n"
"0x00000008 - HASH_ALG_SHA512.<BR>\n"
"0x00000010 - HASH_ALG_SM3.<BR>"

#string STR_gEfiCryptoPkgTokenSpaceGuid_PcdCryptoServiceFamilyEnable_PROMPT #language en-US "Enable/Disable EDK II Crypto Protocol/PPI services"

Expand Down
16 changes: 2 additions & 14 deletions CryptoPkg/Include/Library/HashApiLib.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,11 @@
**/

#ifndef __BASEHASHAPILIB_H_
#define __BASEHASHAPILIB_H_
#ifndef __HASH_API_LIB_H_
#define __HASH_API_LIB_H_

typedef VOID *HASH_API_CONTEXT;

//
// Hash Algorithms
//
#define HASH_API_ALGO_INVALID 0x00000000
#define HASH_API_ALGO_MD4 0x00000001
#define HASH_API_ALGO_MD5 0x00000002
#define HASH_API_ALGO_SHA1 0x00000003
#define HASH_API_ALGO_SHA256 0x00000004
#define HASH_API_ALGO_SHA384 0x00000005
#define HASH_API_ALGO_SHA512 0x00000006
#define HASH_API_ALGO_SM3_256 0x00000007

/**
Retrieves the size, in bytes, of the context buffer required for hash operations.
Expand Down
121 changes: 37 additions & 84 deletions CryptoPkg/Library/BaseHashApiLib/BaseHashApiLib.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
**/

#include <Base.h>
#include <IndustryStandard/Tpm20.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
Expand All @@ -31,32 +32,24 @@ HashApiGetContextSize (
VOID
)
{
switch (PcdGet8 (PcdHashApiLibPolicy)) {
case HASH_API_ALGO_MD4:
return Md4GetContextSize ();
break;

case HASH_API_ALGO_MD5:
return Md5GetContextSize ();
break;

case HASH_API_ALGO_SHA1:
switch (PcdGet32 (PcdHashApiLibPolicy)) {
case HASH_ALG_SHA1:
return Sha1GetContextSize ();
break;

case HASH_API_ALGO_SHA256:
case HASH_ALG_SHA256:
return Sha256GetContextSize ();
break;

case HASH_API_ALGO_SHA384:
case HASH_ALG_SHA384:
return Sha384GetContextSize ();
break;

case HASH_API_ALGO_SHA512:
case HASH_ALG_SHA512:
return Sha512GetContextSize ();
break;

case HASH_API_ALGO_SM3_256:
case HASH_ALG_SM3_256:
return Sm3GetContextSize ();
break;

Expand All @@ -81,32 +74,24 @@ HashApiInit (
OUT HASH_API_CONTEXT HashContext
)
{
switch (PcdGet8 (PcdHashApiLibPolicy)) {
case HASH_API_ALGO_MD4:
return Md4Init (HashContext);
break;

case HASH_API_ALGO_MD5:
return Md5Init (HashContext);
break;

case HASH_API_ALGO_SHA1:
switch (PcdGet32 (PcdHashApiLibPolicy)) {
case HASH_ALG_SHA1:
return Sha1Init (HashContext);
break;

case HASH_API_ALGO_SHA256:
case HASH_ALG_SHA256:
return Sha256Init (HashContext);
break;

case HASH_API_ALGO_SHA384:
case HASH_ALG_SHA384:
return Sha384Init (HashContext);
break;

case HASH_API_ALGO_SHA512:
case HASH_ALG_SHA512:
return Sha512Init (HashContext);
break;

case HASH_API_ALGO_SM3_256:
case HASH_ALG_SM3_256:
return Sm3Init (HashContext);
break;

Expand All @@ -133,32 +118,24 @@ HashApiDuplicate (
OUT HASH_API_CONTEXT NewHashContext
)
{
switch (PcdGet8 (PcdHashApiLibPolicy)) {
case HASH_API_ALGO_MD4:
return Md4Duplicate (HashContext, NewHashContext);
break;

case HASH_API_ALGO_MD5:
return Md5Duplicate (HashContext, NewHashContext);
break;

case HASH_API_ALGO_SHA1:
switch (PcdGet32 (PcdHashApiLibPolicy)) {
case HASH_ALG_SHA1:
return Sha1Duplicate (HashContext, NewHashContext);
break;

case HASH_API_ALGO_SHA256:
case HASH_ALG_SHA256:
return Sha256Duplicate (HashContext, NewHashContext);
break;

case HASH_API_ALGO_SHA384:
case HASH_ALG_SHA384:
return Sha384Duplicate (HashContext, NewHashContext);
break;

case HASH_API_ALGO_SHA512:
case HASH_ALG_SHA512:
return Sha512Duplicate (HashContext, NewHashContext);
break;

case HASH_API_ALGO_SM3_256:
case HASH_ALG_SM3_256:
return Sm3Duplicate (HashContext, NewHashContext);
break;

Expand Down Expand Up @@ -187,32 +164,24 @@ HashApiUpdate (
IN UINTN DataToHashLen
)
{
switch (PcdGet8 (PcdHashApiLibPolicy)) {
case HASH_API_ALGO_MD4:
return Md4Update (HashContext, DataToHash, DataToHashLen);
break;

case HASH_API_ALGO_MD5:
return Md5Update (HashContext, DataToHash, DataToHashLen);
break;

case HASH_API_ALGO_SHA1:
switch (PcdGet32 (PcdHashApiLibPolicy)) {
case HASH_ALG_SHA1:
return Sha1Update (HashContext, DataToHash, DataToHashLen);
break;

case HASH_API_ALGO_SHA256:
case HASH_ALG_SHA256:
return Sha256Update (HashContext, DataToHash, DataToHashLen);
break;

case HASH_API_ALGO_SHA384:
case HASH_ALG_SHA384:
return Sha384Update (HashContext, DataToHash, DataToHashLen);
break;

case HASH_API_ALGO_SHA512:
case HASH_ALG_SHA512:
return Sha512Update (HashContext, DataToHash, DataToHashLen);
break;

case HASH_API_ALGO_SM3_256:
case HASH_ALG_SM3_256:
return Sm3Update (HashContext, DataToHash, DataToHashLen);
break;

Expand All @@ -239,32 +208,24 @@ HashApiFinal (
OUT UINT8 *Digest
)
{
switch (PcdGet8 (PcdHashApiLibPolicy)) {
case HASH_API_ALGO_MD4:
return Md4Final (HashContext, Digest);
break;

case HASH_API_ALGO_MD5:
return Md5Final (HashContext, Digest);
break;

case HASH_API_ALGO_SHA1:
switch (PcdGet32 (PcdHashApiLibPolicy)) {
case HASH_ALG_SHA1:
return Sha1Final (HashContext, Digest);
break;

case HASH_API_ALGO_SHA256:
case HASH_ALG_SHA256:
return Sha256Final (HashContext, Digest);
break;

case HASH_API_ALGO_SHA384:
case HASH_ALG_SHA384:
return Sha384Final (HashContext, Digest);
break;

case HASH_API_ALGO_SHA512:
case HASH_ALG_SHA512:
return Sha512Final (HashContext, Digest);
break;

case HASH_API_ALGO_SM3_256:
case HASH_ALG_SM3_256:
return Sm3Final (HashContext, Digest);
break;

Expand Down Expand Up @@ -293,32 +254,24 @@ HashApiHashAll (
OUT UINT8 *Digest
)
{
switch (PcdGet8 (PcdHashApiLibPolicy)) {
case HASH_API_ALGO_MD4:
return Md4HashAll (DataToHash, DataToHashLen, Digest);
break;

case HASH_API_ALGO_MD5:
return Md5HashAll (DataToHash, DataToHashLen, Digest);
break;

case HASH_API_ALGO_SHA1:
switch (PcdGet32 (PcdHashApiLibPolicy)) {
case HASH_ALG_SHA1:
return Sha1HashAll (DataToHash, DataToHashLen, Digest);
break;

case HASH_API_ALGO_SHA256:
case HASH_ALG_SHA256:
return Sha256HashAll (DataToHash, DataToHashLen, Digest);
break;

case HASH_API_ALGO_SHA384:
case HASH_ALG_SHA384:
return Sha384HashAll (DataToHash, DataToHashLen, Digest);
break;

case HASH_API_ALGO_SHA512:
case HASH_ALG_SHA512:
return Sha512HashAll (DataToHash, DataToHashLen, Digest);
break;

case HASH_API_ALGO_SM3_256:
case HASH_ALG_SM3_256:
return Sm3HashAll (DataToHash, DataToHashLen, Digest);
break;

Expand Down

0 comments on commit c70bdf9

Please sign in to comment.