OrgACRN
/
slimbootloader
mirror of https://github.com/slimbootloader/slimbootloader.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Fix comments in for DoHashVerify and DoRsaVerify apis 

Updated param and error code descriptions

Signed-off-by: Subash Lakkimsetti <subash.lakkimsetti@intel.com>
This commit is contained in:
Subash Lakkimsetti 2021-03-30 10:17:46 -07:00 committed by Guo Dong
parent 18988e73fb
commit c05a04a5ce
3 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
BootloaderCommonPkg/Include/Library/SecureBootLib.h
View File

@ -67,15 +67,15 @@ CalculateHash (
@param[in] Data Data buffer pointer. @param[in] Data Data buffer pointer.
@param[in] Length Data buffer size. @param[in] Length Data buffer size.
@param[in] Usage Hash usage. @param[in] Usage Hash component usage.
@param[in] HashAlg Specify hash algorithm. @param[in] HashAlg Specify hash algorithm.
@param[in,out] Hash On input, expected hash value when ComponentType is not used. @param[in,out] Hash On input, expected hash value when hash component usage is 0.
On output, calculated hash value when verification succeeds. On output, calculated hash value when verification succeeds.
@retval RETURN_SUCCESS Hash verification succeeded. @retval RETURN_SUCCESS Hash verification succeeded.
@retval RETRUN_INVALID_PARAMETER Hash parameter is not valid. @retval RETURN_INVALID_PARAMETER Hash parameter is not valid.
@retval RETURN_NOT_FOUND Hash data for ComponentType is not found. @retval RETURN_NOT_FOUND Hash data for hash component usage is not found.
@retval RETURN_UNSUPPORTED Hash component type is not supported. @retval RETURN_UNSUPPORTED HashAlg not supported.
@retval RETURN_SECURITY_VIOLATION Hash verification failed. @retval RETURN_SECURITY_VIOLATION Hash verification failed.
**/ **/
@ -96,16 +96,16 @@ DoHashVerify (
@param[in] Data Data buffer pointer. @param[in] Data Data buffer pointer.
@param[in] Length Data buffer size. @param[in] Length Data buffer size.
@param[in] Usage Hash usage. @param[in] Usage Hash usage.
@param[in] SignatureHdr Signature header for singanture data. @param[in] Signature Signature header for singanture data.
@param[in] PubKeyHdr Public key header for key data @param[in] PubKeyHdr Public key header for key data
@param[in] PubKeyHashAlg Hash Alg for PubKeyHash. @param[in] PubKeyHashAlg Hash Alg for PubKeyHash.
@param[in] PubKeyHash Public key hash value when ComponentType is not used. @param[in] PubKeyHash Public key hash value when hash component usage is 0.
@param[out] OutHash Calculated data hash value. @param[out] OutHash Calculated data hash value.
@retval RETURN_SUCCESS RSA verification succeeded. @retval RETURN_SUCCESS RSA verification succeeded.
@retval RETURN_NOT_FOUND Hash data for ComponentType is not found. @retval RETURN_NOT_FOUND Hash data for hash component usage is not found.
@retval RETURN_UNSUPPORTED Hash component type is not supported. @retval RETURN_UNSUPPORTED Hash alg type is not supported.
@retval RETURN_SECURITY_VIOLATION PubKey or Signature verification failed. @retval RETURN_SECURITY_VIOLATION PubKey or Signature verification failed.
**/ **/

10
BootloaderCommonPkg/Library/SecureBootLib/SecureBootHash.c
View File

@ -138,15 +138,15 @@ CalculateHash (
@param[in] Data Data buffer pointer. @param[in] Data Data buffer pointer.
@param[in] Length Data buffer size. @param[in] Length Data buffer size.
@param[in] Usage Hash usage. @param[in] Usage Hash component usage.
@param[in] ComponentType Component type. @param[in] HashAlg Specify hash algorithm.
@param[in,out] Hash On input, expected hash value when ComponentType is not used. @param[in,out] Hash On input, expected hash value when hash component usage is 0.
On output, calculated hash value when verification succeeds. On output, calculated hash value when verification succeeds.
@retval RETURN_SUCCESS Hash verification succeeded. @retval RETURN_SUCCESS Hash verification succeeded.
@retval RETURN_INVALID_PARAMETER Hash parameter is not valid. @retval RETURN_INVALID_PARAMETER Hash parameter is not valid.
@retval RETURN_NOT_FOUND Hash data for ComponentType is not found. @retval RETURN_NOT_FOUND Hash data for hash component usage is not found.
@retval RETURN_UNSUPPORTED Hash component type is not supported. @retval RETURN_UNSUPPORTED HashAlg not supported.
@retval RETURN_SECURITY_VIOLATION Hash verification failed. @retval RETURN_SECURITY_VIOLATION Hash verification failed.
**/ **/

6
BootloaderCommonPkg/Library/SecureBootLib/SecureBootRsa.c
View File

@ -23,13 +23,13 @@
@param[in] Signature Signature header for singanture data. @param[in] Signature Signature header for singanture data.
@param[in] PubKeyHdr Public key header for key data @param[in] PubKeyHdr Public key header for key data
@param[in] PubKeyHashAlg Hash Alg for PubKeyHash. @param[in] PubKeyHashAlg Hash Alg for PubKeyHash.
@param[in] PubKeyHash Public key hash value when ComponentType is not used. @param[in] PubKeyHash Public key hash value when hash component usage is 0.
@param[out] OutHash Calculated data hash value. @param[out] OutHash Calculated data hash value.
@retval RETURN_SUCCESS RSA verification succeeded. @retval RETURN_SUCCESS RSA verification succeeded.
@retval RETURN_NOT_FOUND Hash data for ComponentType is not found. @retval RETURN_NOT_FOUND Hash data for hash component usage is not found.
@retval RETURN_UNSUPPORTED Hash component type is not supported. @retval RETURN_UNSUPPORTED Hash alg type is not supported.
@retval RETURN_SECURITY_VIOLATION PubKey or Signature verification failed. @retval RETURN_SECURITY_VIOLATION PubKey or Signature verification failed.
**/ **/