X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FBis.h;h=03cae05907c2ceab265ad68d30a69e3c16f4fd33;hb=b88df76120d228a5d27f48577f629671682475eb;hp=194a0b526c1599a95734f75838a081ce288ddb11;hpb=f1004231ee519fc24c3ad5e90289f5d9445ac9d2;p=mirror_edk2.git diff --git a/MdePkg/Include/Protocol/Bis.h b/MdePkg/Include/Protocol/Bis.h index 194a0b526c..03cae05907 100644 --- a/MdePkg/Include/Protocol/Bis.h +++ b/MdePkg/Include/Protocol/Bis.h @@ -1,16 +1,18 @@ /** @file - BIS protocol are defined in the UEFI specification. The EFI_BIS_PROTOCOL is used to check a digital signature of a data block against a digital certificate for the purpose of an integrity and authorization check. - Copyright (c) 2006 - 2008, 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 +Copyright (c) 2006 - 2010, 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 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. - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + @par Revision Reference: + This Protocol is introduced in EFI Specification 1.10. **/ @@ -49,7 +51,7 @@ typedef UINT32 BIS_CERT_ID; /// EFI_BIS_DATA instances obtained from BIS must be freed by calling Free( ). /// typedef struct { - UINT32 Length; ///< Length of Data in 8 bit bytes. + UINT32 Length; ///< The length of Data in 8 bit bytes. UINT8 *Data; ///< 32 Bit Flat Address of data. } EFI_BIS_DATA; @@ -57,8 +59,8 @@ typedef struct { /// EFI_BIS_VERSION type. /// typedef struct { - UINT32 Major; ///< the major BIS version number. - UINT32 Minor; ///< a minor BIS version number. + UINT32 Major; ///< The major BIS version number. + UINT32 Minor; ///< A minor BIS version number. } EFI_BIS_VERSION; // @@ -76,12 +78,12 @@ typedef struct { typedef struct { BIS_CERT_ID CertificateID; ///< Truncated hash of platform Boot Object BIS_ALG_ID AlgorithmID; ///< A signature algorithm number. - UINT16 KeyLength; ///< Length of alg. keys in bits. + UINT16 KeyLength; ///< The length of alg. keys in bits. } EFI_BIS_SIGNATURE_INFO; /// /// values for EFI_BIS_SIGNATURE_INFO.AlgorithmID. -/// The exact numeric values come from +/// The exact numeric values come from the /// "Common Data Security Architecture (CDSA) Specification". /// #define BIS_ALG_DSA (41) // CSSM_ALGID_DSA @@ -92,7 +94,7 @@ typedef struct { #define BIS_CERT_ID_DSA BIS_ALG_DSA // CSSM_ALGID_DSA #define BIS_CERT_ID_RSA_MD5 BIS_ALG_RSA_MD5 // CSSM_ALGID_MD5_WITH_RSA /// -/// the mask value that gets applied to the truncated hash of a +/// The mask value that gets applied to the truncated hash of a /// platform Boot Object Authorization Certificate to create the certificateID. /// A certificateID must not have any bits set to the value 1 other than bits in /// this mask. @@ -101,7 +103,7 @@ typedef struct { /// /// Macros for dealing with the EFI_BIS_DATA object obtained -/// from BIS_GetSignatureInfo() +/// from BIS_GetSignatureInfo(). /// BIS_GET_SIGINFO_COUNT - tells how many EFI_BIS_SIGNATURE_INFO /// elements are contained in a EFI_BIS_DATA struct pointed to /// by the provided EFI_BIS_DATA*. @@ -115,7 +117,7 @@ typedef struct { #define BIS_GET_SIGINFO_ARRAY(BisDataPtr) ((EFI_BIS_SIGNATURE_INFO *) (BisDataPtr)->Data) /// -/// Support old name for backward compatible +/// Support an old name for backward compatibility. /// #define BOOT_OBJECT_AUTHORIZATION_PARMSET_GUIDVALUE \ BOOT_OBJECT_AUTHORIZATION_PARMSET_GUID @@ -146,18 +148,18 @@ typedef struct { TargetAddress.Data was any other value that was not supported by the implementation. @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. - @retval EFI_DEVICE_ERROR The function encountered an unexpected internal failure while - initializing a cryptographic software module, or - No cryptographic software module with compatible version was - found, or A resource limitation was encountered while using a - cryptographic software module. + @retval EFI_DEVICE_ERROR One of the following device errors: + * The function encountered an unexpected internal failure while initializing a cryptographic software module + * No cryptographic software module with compatible version was found + found + * A resource limitation was encountered while using a cryptographic software module. @retval EFI_INVALID_PARAMETER The This parameter supplied by the caller is NULL or does not - reference a valid EFI_BIS_PROTOCOL object, or - The AppHandle parameter supplied by the caller is NULL or - an invalid memory reference, or - The InterfaceVersion parameter supplied by the caller - is NULL or an invalid memory reference, or - The TargetAddress parameter supplied by the caller is + reference a valid EFI_BIS_PROTOCOL object. Or, + the AppHandle parameter supplied by the caller is NULL or + an invalid memory reference. Or, + the InterfaceVersion parameter supplied by the caller + is NULL or an invalid memory reference. Or, + the TargetAddress parameter supplied by the caller is NULL or an invalid memory reference. **/ @@ -201,7 +203,7 @@ EFI_STATUS of the BIS service. @retval EFI_SUCCESS The function completed successfully. - @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid + @retval EFI_NO_MAPPING The AppHandle parameter is not, or is no longer, a valid application instance handle associated with the EFI_BIS protocol. @retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. @retval EFI_DEVICE_ERROR The function encountered an unexpected internal failure while @@ -299,11 +301,12 @@ EFI_STATUS Retrieves a unique token value to be included in the request credential for the next update of any parameter in the Boot Object Authorization set - @param AppHandle An opaque handle that identifies the caller's instance of initialization - of the BIS service. - @param UpdateToken The function writes an allocated EFI_BIS_DATA* containing the new - unique update token value. The caller must - eventually free the memory allocated by this function using the function Free(). + @param AppHandle An opaque handle that identifies the caller's + instance of initialization of the BIS service. + @param UpdateToken The function writes an allocated EFI_BIS_DATA* + containing the newunique update token value. + The caller musteventually free the memory allocated + by this function using the function Free(). @retval EFI_SUCCESS The function completed successfully. @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid @@ -324,13 +327,14 @@ EFI_STATUS /** Updates one of the configurable parameters of the Boot Object Authorization set. - @param AppHandle An opaque handle that identifies the caller's instance of initialization - of the BIS service. - @param RequestCredential This is a Signed Manifest with embedded attributes that carry the details - of the requested update. - @param NewUpdateToken The function writes an allocated EFI_BIS_DATA* containing the new - unique update token value. The caller must - eventually free the memory allocated by this function using the function Free(). + @param AppHandle An opaque handle that identifies the caller's + instance of initialization of the BIS service. + @param RequestCredential This is a Signed Manifest with embedded attributes + that carry the details of the requested update. + @param NewUpdateToken The function writes an allocated EFI_BIS_DATA* + containing the new unique update token value. + The caller must eventually free the memory allocated + by this function using the function Free(). @retval EFI_SUCCESS The function completed successfully. @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid @@ -362,7 +366,7 @@ EFI_STATUS @param Credentials A Signed Manifest containing verification information for the indicated data object. @param DataObject An in-memory copy of the raw data object to be verified. - @param SectionName An ASCII (not Unicode) string giving the section name in the + @param SectionName An ASCII string giving the section name in the manifest holding the verification information (in other words, hash value) that corresponds to DataObject. @param AuthorityCertificate A digital certificate whose public key must match the signer's @@ -380,7 +384,7 @@ EFI_STATUS invalid (could not be parsed), or Platform-specific authorization failed, etc. @retval EFI_DEVICE_ERROR An unexpected internal error occurred while attempting to retrieve - the public key algorithm of the manifest¡¯s signer¡¯s certificate, + the public key algorithm of the manifest's signer's certificate, or An unexpected internal error occurred in a cryptographic software module. **/ typedef