mirror of https://github.com/acidanthera/audk.git
Add UEFI2.5 HASH protocol definition.
Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: "Yao, Jiewen" <Jiewen.Yao@intel.com> Reviewed-by: "Long, Qin" <Qin.Long@intel.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17287 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Yao, Jiewen
jyao1
parent
d6c5598941
commit
6e9eca81a9
|
|
@ -0,0 +1,202 @@
|
|||
/** @file
|
||||
EFI_HASH2_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.5.
|
||||
EFI_HASH2_PROTOCOL as defined in UEFI 2.5.
|
||||
The EFI Hash2 Service Binding Protocol is used to locate hashing services support
|
||||
provided by a driver and to create and destroy instances of the EFI Hash2 Protocol
|
||||
so that a multiple drivers can use the underlying hashing services.
|
||||
EFI_HASH2_PROTOCOL describes hashing functions for which the algorithm-required
|
||||
message padding and finalization are performed by the supporting driver.
|
||||
|
||||
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
|
||||
This program and the accompanying materials are licensed and made available under
|
||||
the terms and conditions of the BSD License that accompanies this distribution.
|
||||
The full text of the license may be found at
|
||||
http://opensource.org/licenses/bsd-license.php.
|
||||
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
**/
|
||||
|
||||
#ifndef __EFI_HASH2_PROTOCOL_H__
|
||||
#define __EFI_HASH2_PROTOCOL_H__
|
||||
|
||||
#define EFI_HASH2_SERVICE_BINDING_PROTOCOL_GUID \
|
||||
{ \
|
||||
0xda836f8d, 0x217f, 0x4ca0, { 0x99, 0xc2, 0x1c, 0xa4, 0xe1, 0x60, 0x77, 0xea } \
|
||||
}
|
||||
|
||||
#define EFI_HASH2_PROTOCOL_GUID \
|
||||
{ \
|
||||
0x55b1d734, 0xc5e1, 0x49db, { 0x96, 0x47, 0xb1, 0x6a, 0xfb, 0xe, 0x30, 0x5b } \
|
||||
}
|
||||
|
||||
#include <Protocol/Hash.h>
|
||||
|
||||
//
|
||||
// NOTE:
|
||||
// Algorithms EFI_HASH_ALGORITHM_SHA1_NOPAD and
|
||||
// EFI_HASH_ALGORITHM_SHA256_NOPAD_GUID are not compatible with
|
||||
// EFI_HASH2_PROTOCOL and will return EFI_UNSUPPORTED if used with any
|
||||
// EFI_HASH2_PROTOCOL function.
|
||||
//
|
||||
|
||||
//
|
||||
// Note: SHA-1 and MD5 are included for backwards compatibility.
|
||||
// New driver implementations are encouraged to consider stronger algorithms.
|
||||
//
|
||||
|
||||
typedef struct _EFI_HASH2_PROTOCOL EFI_HASH2_PROTOCOL;
|
||||
|
||||
typedef UINT8 EFI_MD5_HASH2[16];
|
||||
typedef UINT8 EFI_SHA1_HASH2[20];
|
||||
typedef UINT8 EFI_SHA224_HASH2[28];
|
||||
typedef UINT8 EFI_SHA256_HASH2[32];
|
||||
typedef UINT8 EFI_SHA384_HASH2[48];
|
||||
typedef UINT8 EFI_SHA512_HASH2[64];
|
||||
|
||||
typedef union {
|
||||
EFI_MD5_HASH2 Md5Hash;
|
||||
EFI_SHA1_HASH2 Sha1Hash;
|
||||
EFI_SHA224_HASH2 Sha224Hash;
|
||||
EFI_SHA256_HASH2 Sha256Hash;
|
||||
EFI_SHA384_HASH2 Sha384Hash;
|
||||
EFI_SHA512_HASH2 Sha512Hash;
|
||||
} EFI_HASH2_OUTPUT;
|
||||
|
||||
/**
|
||||
Returns the size of the hash which results from a specific algorithm.
|
||||
|
||||
@param[in] This Points to this instance of EFI_HASH2_PROTOCOL.
|
||||
@param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.
|
||||
@param[out] HashSize Holds the returned size of the algorithm's hash.
|
||||
|
||||
@retval EFI_SUCCESS Hash size returned successfully.
|
||||
@retval EFI_INVALID_PARAMETER This or HashSize is NULL.
|
||||
@retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this driver
|
||||
or HashAlgorithm is null.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_HASH2_GET_HASH_SIZE)(
|
||||
IN CONST EFI_HASH2_PROTOCOL *This,
|
||||
IN CONST EFI_GUID *HashAlgorithm,
|
||||
OUT UINTN *HashSize
|
||||
);
|
||||
|
||||
/**
|
||||
Creates a hash for the specified message text. The hash is not extendable.
|
||||
The output is final with any algorithm-required padding added by the function.
|
||||
|
||||
@param[in] This Points to this instance of EFI_HASH2_PROTOCOL.
|
||||
@param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.
|
||||
@param[in] Message Points to the start of the message.
|
||||
@param[in] MessageSize The size of Message, in bytes.
|
||||
@param[in,out] Hash On input, points to a caller-allocated buffer of the size
|
||||
returned by GetHashSize() for the specified HashAlgorithm.
|
||||
On output, the buffer holds the resulting hash computed from the message.
|
||||
|
||||
@retval EFI_SUCCESS Hash returned successfully.
|
||||
@retval EFI_INVALID_PARAMETER This or Hash is NULL.
|
||||
@retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this driver
|
||||
or HashAlgorithm is Null.
|
||||
@retval EFI_OUT_OF_RESOURCES Some resource required by the function is not available
|
||||
or MessageSize is greater than platform maximum.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_HASH2_HASH)(
|
||||
IN CONST EFI_HASH2_PROTOCOL *This,
|
||||
IN CONST EFI_GUID *HashAlgorithm,
|
||||
IN CONST UINT8 *Message,
|
||||
IN UINTN MessageSize,
|
||||
IN OUT EFI_HASH2_OUTPUT *Hash
|
||||
);
|
||||
|
||||
/**
|
||||
This function must be called to initialize a digest calculation to be subsequently performed using the
|
||||
EFI_HASH2_PROTOCOL functions HashUpdate() and HashFinal().
|
||||
|
||||
@param[in] This Points to this instance of EFI_HASH2_PROTOCOL.
|
||||
@param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.
|
||||
|
||||
@retval EFI_SUCCESS Initialized successfully.
|
||||
@retval EFI_INVALID_PARAMETER This is NULL.
|
||||
@retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this driver
|
||||
or HashAlgorithm is Null.
|
||||
@retval EFI_OUT_OF_RESOURCES Process failed due to lack of required resource.
|
||||
@retval EFI_ALREADY_STARTED This function is called when the operation in progress is still in processing Hash(),
|
||||
or HashInit() is already called before and not terminated by HashFinal() yet on the same instance.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_HASH2_HASH_INIT)(
|
||||
IN CONST EFI_HASH2_PROTOCOL *This,
|
||||
IN CONST EFI_GUID *HashAlgorithm
|
||||
);
|
||||
|
||||
/**
|
||||
Updates the hash of a computation in progress by adding a message text.
|
||||
|
||||
@param[in] This Points to this instance of EFI_HASH2_PROTOCOL.
|
||||
@param[in] Message Points to the start of the message.
|
||||
@param[in] MessageSize The size of Message, in bytes.
|
||||
|
||||
@retval EFI_SUCCESS Digest in progress updated successfully.
|
||||
@retval EFI_INVALID_PARAMETER This or Hash is NULL.
|
||||
@retval EFI_OUT_OF_RESOURCES Some resource required by the function is not available
|
||||
or MessageSize is greater than platform maximum.
|
||||
@retval EFI_NOT_READY This call was not preceded by a valid call to HashInit(),
|
||||
or the operation in progress was terminated by a call to Hash() or HashFinal() on the same instance.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_HASH2_HASH_UPDATE)(
|
||||
IN CONST EFI_HASH2_PROTOCOL *This,
|
||||
IN CONST UINT8 *Message,
|
||||
IN UINTN MessageSize
|
||||
);
|
||||
|
||||
/**
|
||||
Finalizes a hash operation in progress and returns calculation result.
|
||||
The output is final with any necessary padding added by the function.
|
||||
The hash may not be further updated or extended after HashFinal().
|
||||
|
||||
@param[in] This Points to this instance of EFI_HASH2_PROTOCOL.
|
||||
@param[in,out] Hash On input, points to a caller-allocated buffer of the size
|
||||
returned by GetHashSize() for the specified HashAlgorithm specified in preceding HashInit().
|
||||
On output, the buffer holds the resulting hash computed from the message.
|
||||
|
||||
@retval EFI_SUCCESS Hash returned successfully.
|
||||
@retval EFI_INVALID_PARAMETER This or Hash is NULL.
|
||||
@retval EFI_NOT_READY This call was not preceded by a valid call to HashInit() and at least one call to HashUpdate(),
|
||||
or the operation in progress was canceled by a call to Hash() on the same instance.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_HASH2_HASH_FINAL)(
|
||||
IN CONST EFI_HASH2_PROTOCOL *This,
|
||||
IN OUT EFI_HASH2_OUTPUT *Hash
|
||||
);
|
||||
|
||||
///
|
||||
/// This protocol describes hashing functions for which the algorithm-required message padding and
|
||||
/// finalization are performed by the supporting driver.
|
||||
///
|
||||
struct _EFI_HASH2_PROTOCOL {
|
||||
EFI_HASH2_GET_HASH_SIZE GetHashSize;
|
||||
EFI_HASH2_HASH Hash;
|
||||
EFI_HASH2_HASH_INIT HashInit;
|
||||
EFI_HASH2_HASH_UPDATE HashUpdate;
|
||||
EFI_HASH2_HASH_FINAL HashFinal;
|
||||
};
|
||||
|
||||
extern EFI_GUID gEfiHash2ServiceBindingProtocolGuid;
|
||||
extern EFI_GUID gEfiHash2ProtocolGuid;
|
||||
|
||||
#endif
|
||||
|
|
@ -1429,6 +1429,12 @@
|
|||
## Include/Protocol/NvmExpressPassthru.h
|
||||
gEfiNvmExpressPassThruProtocolGuid = { 0x52c78312, 0x8edc, 0x4233, { 0x98, 0xf2, 0x1a, 0x1a, 0xa5, 0xe3, 0x88, 0xa5 }}
|
||||
|
||||
## Include/Protocol/Hash2.h
|
||||
gEfiHash2ServiceBindingProtocolGuid = { 0xda836f8d, 0x217f, 0x4ca0, { 0x99, 0xc2, 0x1c, 0xa4, 0xe1, 0x60, 0x77, 0xea }}
|
||||
|
||||
## Include/Protocol/Hash2.h
|
||||
gEfiHash2ProtocolGuid = { 0x55b1d734, 0xc5e1, 0x49db, { 0x96, 0x47, 0xb1, 0x6a, 0xfb, 0xe, 0x30, 0x5b }}
|
||||
|
||||
#
|
||||
# [Error.gEfiMdePkgTokenSpaceGuid]
|
||||
# 0x80000001 | Invalid value provided.
|
||||
|
|
|
|||
Loading…
Reference in New Issue