feedc0de/wolfssl
1
0
Fork 0
forked from wolfSSL/wolfssl
Code Pull Requests Activity

Merge pull request #4557 from LinuxJedi/doxygen-fixes

Browse Source 
Fix up some Doxygen issues for 1.9
This commit is contained in:
David Garske
2021-11-10 11:29:47 -08:00
committed by GitHub
parent 8e0fdc64be 231546dacc
commit b2ba6f94af
10 changed files with 70 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/dox_comments/header_files/des3.h
View File

@@ -178,7 +178,7 @@ WOLFSSL_API int wc_Des_EcbEncrypt(Des* des, byte* out,
\param sz length of the plaintext to encrypt \param sz length of the plaintext to encrypt
_Example_ _Example_
/code \code
Des3 enc; // Des3 structure used for encryption Des3 enc; // Des3 structure used for encryption
// initialize enc with wc_Des3_SetKey, use mode DES_ENCRYPTION // initialize enc with wc_Des3_SetKey, use mode DES_ENCRYPTION
@@ -188,7 +188,7 @@ WOLFSSL_API int wc_Des_EcbEncrypt(Des* des, byte* out,
if ( wc_Des3_EcbEncrypt(&enc,cipher, plain, sizeof(plain)) != 0) { if ( wc_Des3_EcbEncrypt(&enc,cipher, plain, sizeof(plain)) != 0) {
// error encrypting message // error encrypting message
} }
/endcode \endcode
\sa wc_Des3_SetKey \sa wc_Des3_SetKey
*/ */

12
doc/dox_comments/header_files/dh.h
View File

@@ -240,15 +240,15 @@ WOLFSSL_API int wc_DhSetKey(DhKey* key, const byte* p, word32 pSz, const byte* g
\return BUFFER_E Returned if there is inadequate space in p or g to \return BUFFER_E Returned if there is inadequate space in p or g to
store the parsed parameters store the parsed parameters
\parma input pointer to a buffer containing a DER formatted \param input pointer to a buffer containing a DER formatted
Diffie-Hellman certificate to parse Diffie-Hellman certificate to parse
\parma inSz size of the input buffer \param inSz size of the input buffer
\parma p pointer to a buffer in which to store the parsed prime \param p pointer to a buffer in which to store the parsed prime
\parma pInOutSz pointer to a word32 object containing the available \param pInOutSz pointer to a word32 object containing the available
size in the p buffer. Will be overwritten with the number of bytes size in the p buffer. Will be overwritten with the number of bytes
written to the buffer after completing the function call written to the buffer after completing the function call
\parma g pointer to a buffer in which to store the parsed base \param g pointer to a buffer in which to store the parsed base
\parma gInOutSz pointer to a word32 object containing the available size \param gInOutSz pointer to a word32 object containing the available size
in the g buffer. Will be overwritten with the number of bytes written to in the g buffer. Will be overwritten with the number of bytes written to
the buffer after completing the function call the buffer after completing the function call

29
doc/dox_comments/header_files/rsa.h
View File

@@ -422,9 +422,7 @@ WOLFSSL_API int wc_RsaPSS_Sign(const byte* in, word32 inLen, byte* out,
\ingroup RSA \ingroup RSA
\brief Decrypt input signature to verify that the message was signed by key. \brief Decrypt input signature to verify that the message was signed by key.
The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING is enabled.
The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING
    is enabled.
\return Success Length of text on no error. \return Success Length of text on no error.
\return MEMORY_E memory exception. \return MEMORY_E memory exception.
@@ -476,11 +474,11 @@ WOLFSSL_API int wc_RsaPSS_Verify(byte* in, word32 inLen, byte* out,
/*! /*!
\ingroup RSA \ingroup RSA
\brief Decrypt input signature to verify that the message was signed by RSA key. \brief Decrypt input signature to verify that the message was signed by RSA
key.
The output uses the same byte array as the input. The output uses the same byte array as the input.
The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING
    is enabled. is enabled.
\return >0 Length of text. \return >0 Length of text.
\return <0 An error occurred. \return <0 An error occurred.
@@ -538,9 +536,7 @@ WOLFSSL_API int wc_RsaPSS_VerifyInline(byte* in, word32 inLen, byte** out,
\brief Verify the message signed with RSA-PSS. \brief Verify the message signed with RSA-PSS.
Salt length is equal to hash length. Salt length is equal to hash length.
The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING is enabled.
The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING
    is enabled.
\return the length of the PSS data on success and negative indicates failure. \return the length of the PSS data on success and negative indicates failure.
\return MEMORY_E memory exception. \return MEMORY_E memory exception.
@@ -609,9 +605,7 @@ WOLFSSL_API int wc_RsaPSS_VerifyCheck(byte* in, word32 inLen,
\ingroup RSA \ingroup RSA
\brief Verify the message signed with RSA-PSS. \brief Verify the message signed with RSA-PSS.
The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING is enabled.
The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING
    is enabled.
\return the length of the PSS data on success and negative indicates failure. \return the length of the PSS data on success and negative indicates failure.
\return MEMORY_E memory exception. \return MEMORY_E memory exception.
@@ -687,8 +681,7 @@ WOLFSSL_API int wc_RsaPSS_VerifyCheck_ex(byte* in, word32 inLen,
The input buffer is reused for the output buffer. The input buffer is reused for the output buffer.
Salt length is equal to hash length. Salt length is equal to hash length.
The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING is enabled.
    is enabled.
\return the length of the PSS data on success and negative indicates failure. \return the length of the PSS data on success and negative indicates failure.
@@ -754,9 +747,7 @@ WOLFSSL_API int wc_RsaPSS_VerifyCheckInline(byte* in, word32 inLen, byte** out,
\brief Verify the message signed with RSA-PSS. \brief Verify the message signed with RSA-PSS.
The input buffer is reused for the output buffer. The input buffer is reused for the output buffer.
The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING is enabled.
The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING
    is enabled.
\return the length of the PSS data on success and negative indicates failure. \return the length of the PSS data on success and negative indicates failure.
@@ -826,9 +817,7 @@ WOLFSSL_API int wc_RsaPSS_VerifyCheckInline_ex(byte* in, word32 inLen, byte** o
\brief Checks the PSS data to ensure that the signature matches. \brief Checks the PSS data to ensure that the signature matches.
Salt length is equal to hash length. Salt length is equal to hash length.
The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING is enabled.
The key has to be associated with RNG by wc_RsaSetRNG when WC_RSA_BLINDING
    is enabled.
\return BAD_PADDING_E when the PSS data is invalid, BAD_FUNC_ARG when \return BAD_PADDING_E when the PSS data is invalid, BAD_FUNC_ARG when
NULL is passed in to in or sig or inSz is not the same as the hash NULL is passed in to in or sig or inSz is not the same as the hash

33
doc/dox_comments/header_files/ssl.h
View File

@@ -4389,7 +4389,7 @@ WOLFSSL_API WOLFSSL_X509_NAME* wolfSSL_X509_get_subject_name(WOLFSSL_X509*);
\param ssl a pointer to a WOLFSSL structure, created using wolfSSL_new(). \param ssl a pointer to a WOLFSSL structure, created using wolfSSL_new().
_Example_ _Example_
/code \code
WOLFSSL* ssl; WOLFSSL* ssl;
... ...
WOLFSSL_CTX* ctx = wolfSSL_CTX_new( method ); WOLFSSL_CTX* ctx = wolfSSL_CTX_new( method );
@@ -5226,7 +5226,7 @@ WOLFSSL_API int wolfSSL_CTX_use_psk_identity_hint(WOLFSSL_CTX*, const char*);
\return SSL_FAILURE returned if the WOLFSSL or Arrays structures are NULL. \return SSL_FAILURE returned if the WOLFSSL or Arrays structures are NULL.
\param ssl a pointer to a WOLFSSL structure, created using wolfSSL_new(). \param ssl a pointer to a WOLFSSL structure, created using wolfSSL_new().
\para hint a constant character pointer that holds the hint to be saved \param hint a constant character pointer that holds the hint to be saved
in memory. in memory.
_Example_ _Example_
@@ -12545,13 +12545,32 @@ WOLFSSL_API WOLFSSL_ASN1_TIME* wolfSSL_X509_get_notBefore(WOLFSSL_X509*);
/*! /*!
\ingroup IO \ingroup IO
\brief This function is called on the client side and initiates an SSL/TLS handshake with a server. When this function is called, the underlying communication channel has already been set up. \brief This function is called on the client side and initiates an SSL/TLS
wolfSSL_connect() works with both blocking and non-blocking I/O. When the underlying I/O is non-blocking, wolfSSL_connect() will return when the underlying I/O could not satisfy the needs of wolfSSL_connect to continue the handshake. In this case, a call to wolfSSL_get_error() will yield either SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE. The calling process must then repeat the call to wolfSSL_connect() when the underlying I/O is ready and wolfSSL will pick up where it left off. When using a non-blocking socket, nothing needs to be done, but select() can be used to check for the required condition. handshake with a server. When this function is called, the underlying
If the underlying I/O is blocking, wolfSSL_connect() will only return once the handshake has been finished or an error occurred. communication channel has already been set up.
wolfSSL takes a different approach to certificate verification than OpenSSL does. The default policy for the client is to verify the server, this means that if you don't load CAs to verify the server you'll get a connect error, unable to verify (-155). It you want to mimic OpenSSL behavior of having SSL_connect succeed even if verifying the server fails and reducing security you can do this by calling: SSL_CTX_set_verify(ctx, SSL_VERIFY_NONE, 0); before calling SSL_new(); Though it's not recommended. wolfSSL_connect() works with both blocking and non-blocking I/O. When the
underlying I/O is non-blocking, wolfSSL_connect() will return when the
underlying I/O could not satisfy the needs of wolfSSL_connect to continue
the handshake. In this case, a call to wolfSSL_get_error() will yield
either SSL_ERROR_WANT_READ or SSL_ERROR_WANT_WRITE. The calling process
must then repeat the call to wolfSSL_connect() when the underlying I/O is
ready and wolfSSL will pick up where it left off. When using a non-blocking
socket, nothing needs to be done, but select() can be used to check for the
required condition.
If the underlying I/O is blocking, wolfSSL_connect() will only return once
the handshake has been finished or an error occurred.
wolfSSL takes a different approach to certificate verification than OpenSSL
does. The default policy for the client is to verify the server, this
means that if you don't load CAs to verify the server you'll get a connect
error, unable to verify (-155). It you want to mimic OpenSSL behavior of
having SSL_connect succeed even if verifying the server fails and reducing
security you can do this by calling:
SSL_CTX_set_verify(ctx, SSL_VERIFY_NONE, 0); before calling SSL_new();
Though it's not recommended.
\return SSL_SUCCESS If successful. \return SSL_SUCCESS If successful.
\return SSL_FATAL_ERROR will be returned if an error occurred. To get a more detailed error code, call wolfSSL_get_error(). \return SSL_FATAL_ERROR will be returned if an error occurred. To get a
more detailed error code, call wolfSSL_get_error().
\param ssl a pointer to a WOLFSSL structure, created using wolfSSL_new(). \param ssl a pointer to a WOLFSSL structure, created using wolfSSL_new().

2
doc/dox_comments/header_files/wc_encrypt.h
View File

@@ -141,7 +141,7 @@ WOLFSSL_API int wc_Des_CbcEncryptWithKey(byte* out,
a Des structure. a Des structure.
\return <0 Returned on any error during encryption. \return <0 Returned on any error during encryption.
\parma out Final encrypted data \param out Final encrypted data
\param in Data to be encrypted, must be padded to Des block size. \param in Data to be encrypted, must be padded to Des block size.
\param sz Size of input buffer. \param sz Size of input buffer.
\param key Pointer to the key to use for encryption. \param key Pointer to the key to use for encryption.