SecurityPkg/Pkcs7Verify/Pkcs7VerifyDxe/Pkcs7VerifyDxe.c File Reference


Defines

#define MAX_DIGEST_SIZE   SHA512_DIGEST_SIZE

Functions

BOOLEAN CalculateDataHash (IN VOID *Data, IN UINTN DataSize, IN EFI_GUID *CertGuid, OUT UINT8 *HashValue)
BOOLEAN IsContentHashRevoked (IN UINT8 *Content, IN UINTN ContentSize, IN EFI_SIGNATURE_LIST **RevokedDb)
BOOLEAN IsCertHashRevoked (IN UINT8 *Certificate, IN UINTN CertSize, IN EFI_SIGNATURE_LIST **RevokedDb, OUT EFI_TIME *RevocationTime)
BOOLEAN IsTimeZero (IN EFI_TIME *Time)
BOOLEAN CompareTimestamp (IN EFI_TIME *SigningTime, IN EFI_TIME *RevocationTime)
BOOLEAN IsValidTimestamp (IN UINT8 *SignedData, IN UINTN SignedDataSize, IN EFI_SIGNATURE_LIST **TimeStampDb, IN EFI_TIME *RevocationTime)
EFI_STATUS P7CheckRevocation (IN UINT8 *SignedData, IN UINTN SignedDataSize, IN UINT8 *InData, IN UINTN InDataSize, IN EFI_SIGNATURE_LIST **RevokedDb, IN EFI_SIGNATURE_LIST **TimeStampDb)
EFI_STATUS P7CheckTrust (IN UINT8 *SignedData, IN UINTN SignedDataSize, IN UINT8 *InData, IN UINTN InDataSize, IN EFI_SIGNATURE_LIST **AllowedDb)
EFI_STATUS EFIAPI VerifyBuffer (IN EFI_PKCS7_VERIFY_PROTOCOL *This, IN VOID *SignedData, IN UINTN SignedDataSize, IN VOID *InData, IN UINTN InDataSize, IN EFI_SIGNATURE_LIST **AllowedDb, IN EFI_SIGNATURE_LIST **RevokedDb, IN EFI_SIGNATURE_LIST **TimeStampDb, OUT VOID *Content, IN OUT UINTN *ContentSize)
EFI_STATUS EFIAPI VerifySignature (IN EFI_PKCS7_VERIFY_PROTOCOL *This, IN VOID *Signature, IN UINTN SignatureSize, IN VOID *InHash, IN UINTN InHashSize, IN EFI_SIGNATURE_LIST **AllowedDb, IN EFI_SIGNATURE_LIST **RevokedDb, IN EFI_SIGNATURE_LIST **TimeStampDb)
EFI_STATUS EFIAPI Pkcs7VerifyDriverEntry (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables

EFI_PKCS7_VERIFY_PROTOCOL mPkcs7Verify

Detailed Description

Pkcs7Verify Driver to produce the UEFI PKCS7 Verification Protocol.

The driver will produce the UEFI PKCS7 Verification Protocol which is used to verify data signed using PKCS7 structure. The PKCS7 data to be verified must be ASN.1 (DER) encoded.

Copyright (c) 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which 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.


Define Documentation

#define MAX_DIGEST_SIZE   SHA512_DIGEST_SIZE


Function Documentation

BOOLEAN CalculateDataHash ( IN VOID *  Data,
IN UINTN  DataSize,
IN EFI_GUID *  CertGuid,
OUT UINT8 *  HashValue 
)

Calculates the hash of the given data based on the specified hash GUID.

Parameters:
[in] Data Pointer to the data buffer to be hashed.
[in] DataSize The size of data buffer in bytes.
[in] CertGuid The GUID to identify the hash algorithm to be used.
[out] HashValue Pointer to a buffer that receives the hash result.
Return values:
TRUE Data hash calculation succeeded.
FALSE Data hash calculation failed.

References BOOLEAN(), and UINTN().

Referenced by IsCertHashRevoked(), and IsContentHashRevoked().

BOOLEAN CompareTimestamp ( IN EFI_TIME *  SigningTime,
IN EFI_TIME *  RevocationTime 
)

Check whether the timestamp is valid by comparing the signing time and the revocation time.

Parameters:
SigningTime Pointer to the signing time.
RevocationTime Pointer to the revocation time.
Return values:
TRUE The SigningTime is not later than the RevocationTime.
FALSE The SigningTime is later than the RevocationTime.

References BOOLEAN().

Referenced by IsValidTimestamp().

BOOLEAN IsCertHashRevoked ( IN UINT8 *  Certificate,
IN UINTN  CertSize,
IN EFI_SIGNATURE_LIST **  RevokedDb,
OUT EFI_TIME *  RevocationTime 
)

Check whether the hash of an given certificate is revoked by the revocation database.

Parameters:
[in] Certificate Pointer to the certificate that is searched for.
[in] CertSize Size of certificate in bytes.
[in] RevokedDb Pointer to a list of pointers to EFI_SIGNATURE_LIST structures which contains list of X.509 certificate of revoked signers and revoked content hashes.
[out] RevocationTime Return the time that the certificate was revoked.
Returns:
TRUE The certificate hash is found in the revocation database.

FALSE The certificate hash is not found in the revocation database.

References BOOLEAN(), CalculateDataHash(), MAX_DIGEST_SIZE, TRUE, and UINTN().

Referenced by P7CheckRevocation().

BOOLEAN IsContentHashRevoked ( IN UINT8 *  Content,
IN UINTN  ContentSize,
IN EFI_SIGNATURE_LIST **  RevokedDb 
)

Check whether the hash of data content is revoked by the revocation database.

Parameters:
[in] Content Pointer to the content buffer that is searched for.
[in] ContentSize The size of data content in bytes.
[in] RevokedDb Pointer to a list of pointers to EFI_SIGNATURE_LIST structure which contains list of X.509 certificates of revoked signers and revoked content hashes.
Returns:
TRUE The matched content hash is found in the revocation database.

FALSE The matched content hash is not found in the revocation database.

References BOOLEAN(), CalculateDataHash(), MAX_DIGEST_SIZE, TRUE, and UINTN().

Referenced by P7CheckRevocation().

BOOLEAN IsTimeZero ( IN EFI_TIME *  Time  ) 

Check if the given time value is zero.

Parameters:
[in] Time Pointer of a time value.
Return values:
TRUE The Time is Zero.
FALSE The Time is not Zero.

References TRUE.

BOOLEAN IsValidTimestamp ( IN UINT8 *  SignedData,
IN UINTN  SignedDataSize,
IN EFI_SIGNATURE_LIST **  TimeStampDb,
IN EFI_TIME *  RevocationTime 
)

Check whether the timestamp signature embedded in PKCS7 signedData is valid and the signing time is also earlier than the revocation time.

Parameters:
[in] SignedData Pointer to the PKCS#7 signedData.
[in] SignedDataSize Size of SignedData in bytes.
[in] TimeStampDb Pointer to a list of pointers to EFI_SIGNATURE_LIST structures which is used to pass a list of X.509 certificates of trusted timestamp signers.
[in] RevocationTime The time that the certificate was revoked.
Return values:
TRUE Timestamp signature is valid and the signing time is no later than the revocation time.
FALSE Timestamp signature is not valid or the signing time is later than the revocation time.

References BOOLEAN(), CompareTimestamp(), IsTimeZero(), TRUE, and UINTN().

Referenced by P7CheckRevocation().

EFI_STATUS P7CheckRevocation ( IN UINT8 *  SignedData,
IN UINTN  SignedDataSize,
IN UINT8 *  InData,
IN UINTN  InDataSize,
IN EFI_SIGNATURE_LIST **  RevokedDb,
IN EFI_SIGNATURE_LIST **  TimeStampDb 
)

Check whether the PKCS7 signedData is revoked by verifying with the revoked certificates database, and if the signedData is timestamped, the embedded timestamp couterSignature will be checked with the supplied timestamp database.

Parameters:
[in] SignedData Pointer to buffer containing ASN.1 DER-encoded PKCS7 signature.
[in] SignedDataSize The size of SignedData buffer in bytes.
[in] InData Pointer to the buffer containing the raw message data previously signed and to be verified.
[in] InDataSize The size of InData buffer in bytes.
[in] RevokedDb Pointer to a list of pointers to EFI_SIGNATURE_LIST structure which contains list of X.509 certificates of revoked signers and revoked content hashes.
[in] TimeStampDb Pointer to a list of pointers to EFI_SIGNATURE_LIST structures which is used to pass a list of X.509 certificates of trusted timestamp signers.
Return values:
EFI_SUCCESS The PKCS7 signedData is revoked.
EFI_SECURITY_VIOLATION Fail to verify the signature in PKCS7 signedData.
EFI_INVALID_PARAMETER SignedData is NULL or SignedDataSize is zero. AllowedDb is NULL. Content is not NULL and ContentSize is NULL.
EFI_NOT_FOUND Content not found because InData is NULL and no content embedded in PKCS7 signedData.
EFI_UNSUPPORTED The PKCS7 signedData was not correctly formatted.

References EFI_STATUS(), IsCertHashRevoked(), IsContentHashRevoked(), IsValidTimestamp(), and UINTN().

Referenced by VerifyBuffer().

EFI_STATUS P7CheckTrust ( IN UINT8 *  SignedData,
IN UINTN  SignedDataSize,
IN UINT8 *  InData,
IN UINTN  InDataSize,
IN EFI_SIGNATURE_LIST **  AllowedDb 
)

Check whether the PKCS7 signedData can be verified by the trusted certificates database, and return the content of the signedData if requested.

Parameters:
[in] SignedData Pointer to buffer containing ASN.1 DER-encoded PKCS7 signature.
[in] SignedDataSize The size of SignedData buffer in bytes.
[in] InData Pointer to the buffer containing the raw message data previously signed and to be verified.
[in] InDataSize The size of InData buffer in bytes.
[in] AllowedDb Pointer to a list of pointers to EFI_SIGNATURE_LIST structures which contains lists of X.509 certificates of approved signers.
Return values:
EFI_SUCCESS The PKCS7 signedData is trusted.
EFI_SECURITY_VIOLATION Fail to verify the signature in PKCS7 signedData.
EFI_INVALID_PARAMETER SignedData is NULL or SignedDataSize is zero. AllowedDb is NULL. Content is not NULL and ContentSize is NULL.
EFI_NOT_FOUND Content not found because InData is NULL and no content embedded in PKCS7 signedData.
EFI_UNSUPPORTED The PKCS7 signedData was not correctly formatted.
EFI_BUFFER_TOO_SMALL The size of buffer indicated by ContentSize is too small to hold the content. ContentSize updated to the required size.

References EFI_STATUS(), and UINTN().

Referenced by VerifyBuffer().

EFI_STATUS EFIAPI Pkcs7VerifyDriverEntry ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE *  SystemTable 
)

The user Entry Point for the PKCS7 Verification driver.

Parameters:
[in] ImageHandle The firmware allocated handle for the EFI image.
[in] SystemTable A pointer to the EFI System Table.
Return values:
EFI_SUCCESS The entry point is executed successfully.
EFI_NOT_SUPPORTED Platform does not support PKCS7 Verification.
Other Some error occurs when executing this entry point.

References EFI_STATUS(), and mPkcs7Verify.

EFI_STATUS EFIAPI VerifyBuffer ( IN EFI_PKCS7_VERIFY_PROTOCOL *  This,
IN VOID *  SignedData,
IN UINTN  SignedDataSize,
IN VOID *  InData,
IN UINTN  InDataSize,
IN EFI_SIGNATURE_LIST **  AllowedDb,
IN EFI_SIGNATURE_LIST **  RevokedDb,
IN EFI_SIGNATURE_LIST **  TimeStampDb,
OUT VOID *  Content,
IN OUT UINTN *  ContentSize 
)

Processes a buffer containing binary DER-encoded PKCS7 signature. The signed data content may be embedded within the buffer or separated. Function verifies the signature of the content is valid and signing certificate was not revoked and is contained within a list of trusted signers.

Parameters:
[in] This Pointer to EFI_PKCS7_VERIFY_PROTOCOL instance.
[in] SignedData Points to buffer containing ASN.1 DER-encoded PKCS7 signature.
[in] SignedDataSize The size of SignedData buffer in bytes.
[in] InData In case of detached signature, InData points to buffer containing the raw message data previously signed and to be verified by function. In case of SignedData containing embedded data, InData must be NULL.
[in] InDataSize When InData is used, the size of InData buffer in bytes. When InData is NULL. This parameter must be 0.
[in] AllowedDb Pointer to a list of pointers to EFI_SIGNATURE_LIST structures. The list is terminated by a null pointer. The EFI_SIGNATURE_LIST structures contain lists of X.509 certificates of approved signers. Function recognizes signer certificates of type EFI_CERT_X509_GUID. Any hash certificate in AllowedDb list is ignored by this function. Function returns success if signer of the buffer is within this list (and not within RevokedDb). This parameter is required.
[in] RevokedDb Optional pointer to a list of pointers to EFI_SIGNATURE_LIST structures. The list is terminated by a null pointer. List of X.509 certificates of revoked signers and revoked file hashes. Except as noted in description of TimeStampDb signature verification will always fail if the signer of the file or the hash of the data component of the buffer is in RevokedDb list. This list is optional and caller may pass Null or pointer to NULL if not required.
[in] TimeStampDb Optional pointer to a list of pointers to EFI_SIGNATURE_LIST structures. The list is terminated by a null pointer. This parameter can be used to pass a list of X.509 certificates of trusted time stamp signers. This list is optional and caller must pass Null or pointer to NULL if not required.
[out] Content On input, points to an optional caller-allocated buffer into which the function will copy the content portion of the file after verification succeeds. This parameter is optional and if NULL, no copy of content from file is performed.
[in,out] ContentSize On input, points to the size in bytes of the optional buffer Content previously allocated by caller. On output, if the verification succeeds, the value referenced by ContentSize will contain the actual size of the content from signed file. If ContentSize indicates the caller-allocated buffer is too small to contain content, an error is returned, and ContentSize will be updated with the required size. This parameter must be 0 if Content is Null.
Return values:
EFI_SUCCESS Content signature was verified against hash of content, the signer's certificate was not found in RevokedDb, and was found in AllowedDb or if in signer is found in both AllowedDb and RevokedDb, the signing was allowed by reference to TimeStampDb as described above, and no hash matching content hash was found in RevokedDb.
EFI_SECURITY_VIOLATION The SignedData buffer was correctly formatted but signer was in RevokedDb or not in AllowedDb. Also returned if matching content hash found in RevokedDb.
EFI_COMPROMISED_DATA Calculated hash differs from signed hash.
EFI_INVALID_PARAMETER SignedData is NULL or SignedDataSize is zero. AllowedDb is NULL.
EFI_INVALID_PARAMETER Content is not NULL and ContentSize is NULL.
EFI_ABORTED Unsupported or invalid format in TimeStampDb, RevokedDb or AllowedDb list contents was detected.
EFI_NOT_FOUND Content not found because InData is NULL and no content embedded in SignedData.
EFI_UNSUPPORTED The SignedData buffer was not correctly formatted for processing by the function.
EFI_UNSUPPORTED Signed data embedded in SignedData but InData is not NULL.
EFI_BUFFER_TOO_SMALL The size of buffer indicated by ContentSize is too small to hold the content. ContentSize updated to required size.

References EFI_STATUS(), P7CheckRevocation(), P7CheckTrust(), and UINTN().

EFI_STATUS EFIAPI VerifySignature ( IN EFI_PKCS7_VERIFY_PROTOCOL *  This,
IN VOID *  Signature,
IN UINTN  SignatureSize,
IN VOID *  InHash,
IN UINTN  InHashSize,
IN EFI_SIGNATURE_LIST **  AllowedDb,
IN EFI_SIGNATURE_LIST **  RevokedDb,
IN EFI_SIGNATURE_LIST **  TimeStampDb 
)

Processes a buffer containing binary DER-encoded detached PKCS7 signature. The hash of the signed data content is calculated and passed by the caller. Function verifies the signature of the content is valid and signing certificate was not revoked and is contained within a list of trusted signers.

Parameters:
[in] This Pointer to EFI_PKCS7_VERIFY_PROTOCOL instance.
[in] Signature Points to buffer containing ASN.1 DER-encoded PKCS detached signature.
[in] SignatureSize The size of Signature buffer in bytes.
[in] InHash InHash points to buffer containing the caller calculated hash of the data. The parameter may not be NULL.
[in] InHashSize The size in bytes of InHash buffer.
[in] AllowedDb Pointer to a list of pointers to EFI_SIGNATURE_LIST structures. The list is terminated by a null pointer. The EFI_SIGNATURE_LIST structures contain lists of X.509 certificates of approved signers. Function recognizes signer certificates of type EFI_CERT_X509_GUID. Any hash certificate in AllowedDb list is ignored by this function. Function returns success if signer of the buffer is within this list (and not within RevokedDb). This parameter is required.
[in] RevokedDb Optional pointer to a list of pointers to EFI_SIGNATURE_LIST structures. The list is terminated by a null pointer. List of X.509 certificates of revoked signers and revoked file hashes. Signature verification will always fail if the signer of the file or the hash of the data component of the buffer is in RevokedDb list. This parameter is optional and caller may pass Null if not required.
[in] TimeStampDb Optional pointer to a list of pointers to EFI_SIGNATURE_LIST structures. The list is terminated by a null pointer. This parameter can be used to pass a list of X.509 certificates of trusted time stamp counter-signers.
Return values:
EFI_SUCCESS Signed hash was verified against caller-provided hash of content, the signer's certificate was not found in RevokedDb, and was found in AllowedDb or if in signer is found in both AllowedDb and RevokedDb, the signing was allowed by reference to TimeStampDb as described above, and no hash matching content hash was found in RevokedDb.
EFI_SECURITY_VIOLATION The SignedData buffer was correctly formatted but signer was in RevokedDb or not in AllowedDb. Also returned if matching content hash found in RevokedDb.
EFI_COMPROMISED_DATA Caller provided hash differs from signed hash. Or, caller and encrypted hash are different sizes.
EFI_INVALID_PARAMETER Signature is NULL or SignatureSize is zero. InHash is NULL or InHashSize is zero. AllowedDb is NULL.
EFI_ABORTED Unsupported or invalid format in TimeStampDb, RevokedDb or AllowedDb list contents was detected.
EFI_UNSUPPORTED The Signature buffer was not correctly formatted for processing by the function.


Variable Documentation

EFI_PKCS7_VERIFY_PROTOCOL mPkcs7Verify

Initial value:

Referenced by Pkcs7VerifyDriverEntry().


Generated on Thu Sep 24 23:44:24 2015 for SecurityPkg[ALL] by  doxygen 1.5.7.1