diff options
| author | Dandan Bi <dandan.bi@intel.com> | 2016-11-11 13:46:04 +0800 |
|---|---|---|
| committer | Qin Long <qin.long@intel.com> | 2016-11-11 13:46:04 +0800 |
| commit | 68ae7cd66bf7edf5abad046183badc41517e444f (patch) | |
| tree | e2cd7f9dcd30b30b172d337e3e43897e6f0e0373 /CryptoPkg | |
| parent | 32d13bc4bcc5fcf580dd153d16b3746f845c81a8 (diff) | |
| download | edk2-platforms-68ae7cd66bf7edf5abad046183badc41517e444f.tar.xz | |
CryptoPkg/BaseCryptLib: Make comments consistent with the function
Correct the unaligned parameter names in comments (BaseCryptLib.h and
HMAC-SHA256 wrapper implementation)
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Qin Long <qin.long@intel.com>
Diffstat (limited to 'CryptoPkg')
| -rw-r--r-- | CryptoPkg/Include/Library/BaseCryptLib.h | 12 | ||||
| -rw-r--r-- | CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c | 4 | ||||
| -rw-r--r-- | CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c | 2 |
3 files changed, 9 insertions, 9 deletions
diff --git a/CryptoPkg/Include/Library/BaseCryptLib.h b/CryptoPkg/Include/Library/BaseCryptLib.h index 45dac3b4c1..9cc4776c30 100644 --- a/CryptoPkg/Include/Library/BaseCryptLib.h +++ b/CryptoPkg/Include/Library/BaseCryptLib.h @@ -994,11 +994,11 @@ HmacMd5Update ( finalized by HmacMd5Final(). Behavior with invalid HMAC-MD5 context is undefined.
If HmacMd5Context is NULL, then return FALSE.
- If HashValue is NULL, then return FALSE.
+ If HmacValue is NULL, then return FALSE.
If this interface is not supported, then return FALSE.
@param[in, out] HmacMd5Context Pointer to the HMAC-MD5 context.
- @param[out] HashValue Pointer to a buffer that receives the HMAC-MD5 digest
+ @param[out] HmacValue Pointer to a buffer that receives the HMAC-MD5 digest
value (16 bytes).
@retval TRUE HMAC-MD5 digest computation succeeded.
@@ -1112,11 +1112,11 @@ HmacSha1Update ( not be finalized by HmacSha1Final(). Behavior with invalid HMAC-SHA1 context is undefined.
If HmacSha1Context is NULL, then return FALSE.
- If HashValue is NULL, then return FALSE.
+ If HmacValue is NULL, then return FALSE.
If this interface is not supported, then return FALSE.
@param[in, out] HmacSha1Context Pointer to the HMAC-SHA1 context.
- @param[out] HashValue Pointer to a buffer that receives the HMAC-SHA1 digest
+ @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA1 digest
value (20 bytes).
@retval TRUE HMAC-SHA1 digest computation succeeded.
@@ -1230,11 +1230,11 @@ HmacSha256Update ( not be finalized by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.
If HmacSha256Context is NULL, then return FALSE.
- If HashValue is NULL, then return FALSE.
+ If HmacValue is NULL, then return FALSE.
If this interface is not supported, then return FALSE.
@param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.
- @param[out] HashValue Pointer to a buffer that receives the HMAC-SHA256 digest
+ @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA256 digest
value (32 bytes).
@retval TRUE HMAC-SHA256 digest computation succeeded.
diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c index 5d349dc085..7726e404f6 100644 --- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c +++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c @@ -161,10 +161,10 @@ HmacSha256Update ( not be finalized by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.
If HmacSha256Context is NULL, then return FALSE.
- If HashValue is NULL, then return FALSE.
+ If HmacValue is NULL, then return FALSE.
@param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.
- @param[out] HashValue Pointer to a buffer that receives the HMAC-SHA256 digest
+ @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA256 digest
value (32 bytes).
@retval TRUE HMAC-SHA256 digest computation succeeded.
diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c index 48704e1091..35abddaa92 100644 --- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c +++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c @@ -109,7 +109,7 @@ HmacSha256Update ( Return FALSE to indicate this interface is not supported.
@param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.
- @param[out] HashValue Pointer to a buffer that receives the HMAC-SHA256 digest
+ @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA256 digest
value (32 bytes).
@retval FALSE This interface is not supported.
|