The TlsSetCipherList() function documents its CipherId parameter incorrectly. Document the parameter precisely and use the same documentation in both the lib class header and the lib instance.
Cc: Jiaxin Wu <jiaxin...@intel.com> Cc: Qin Long <qin.l...@intel.com> Cc: Siyuan Fu <siyuan...@intel.com> Cc: Ting Ye <ting...@intel.com> Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=915 Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Laszlo Ersek <ler...@redhat.com> --- CryptoPkg/Include/Library/TlsLib.h | 6 ++++-- CryptoPkg/Library/TlsLib/TlsConfig.c | 5 ++++- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/CryptoPkg/Include/Library/TlsLib.h b/CryptoPkg/Include/Library/TlsLib.h index e19a38a214ce..0ffbcb2b7c2a 100644 --- a/CryptoPkg/Include/Library/TlsLib.h +++ b/CryptoPkg/Include/Library/TlsLib.h @@ -345,14 +345,16 @@ TlsSetConnectionEnd ( /** Set the ciphers list to be used by the TLS object. This function sets the ciphers for use by a specified TLS object. @param[in] Tls Pointer to a TLS object. - @param[in] CipherId Pointer to a string that contains one or more - ciphers separated by a colon. + @param[in] CipherId Array of UINT16 cipher identifiers. Each UINT16 + cipher identifier comes from the TLS Cipher Suite + Registry of the IANA, interpreting Byte1 and Byte2 + in network (big endian) byte order. @param[in] CipherNum The number of cipher in the list. @retval EFI_SUCCESS The ciphers list was set successfully. @retval EFI_INVALID_PARAMETER The parameter is invalid. @retval EFI_UNSUPPORTED Unsupported TLS cipher in the list. diff --git a/CryptoPkg/Library/TlsLib/TlsConfig.c b/CryptoPkg/Library/TlsLib/TlsConfig.c index 9d21e6c1466d..ab786fc23849 100644 --- a/CryptoPkg/Library/TlsLib/TlsConfig.c +++ b/CryptoPkg/Library/TlsLib/TlsConfig.c @@ -401,13 +401,16 @@ TlsSetConnectionEnd ( /** Set the ciphers list to be used by the TLS object. This function sets the ciphers for use by a specified TLS object. @param[in] Tls Pointer to a TLS object. - @param[in] CipherId Pointer to a UINT16 cipher Id. + @param[in] CipherId Array of UINT16 cipher identifiers. Each UINT16 + cipher identifier comes from the TLS Cipher Suite + Registry of the IANA, interpreting Byte1 and Byte2 + in network (big endian) byte order. @param[in] CipherNum The number of cipher in the list. @retval EFI_SUCCESS The ciphers list was set successfully. @retval EFI_INVALID_PARAMETER The parameter is invalid. @retval EFI_UNSUPPORTED Unsupported TLS cipher in the list. -- 2.14.1.3.gb7cf6e02401b _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
