mirror of https://github.com/wolfSSL/wolfssl.git
Add dox for new API
parent
aa19d8221e
commit
09de233fc0
|
@ -7599,18 +7599,49 @@ int wolfSSL_writev(WOLFSSL* ssl, const struct iovec* iov,
|
||||||
WOLFSSL_METHOD method = wolfTLSv1_2_client_method();
|
WOLFSSL_METHOD method = wolfTLSv1_2_client_method();
|
||||||
WOLFSSL_CTX* ctx = WOLFSSL_CTX_new(method);
|
WOLFSSL_CTX* ctx = WOLFSSL_CTX_new(method);
|
||||||
…
|
…
|
||||||
if(!wolfSSL_CTX_UnloadCAs(ctx)){
|
if(wolfSSL_CTX_UnloadCAs(ctx) != SSL_SUCCESS){
|
||||||
// The function did not unload CAs
|
// The function did not unload CAs
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
\sa wolfSSL_CertManagerUnloadCAs
|
\sa wolfSSL_CertManagerUnloadCAs
|
||||||
\sa LockMutex
|
\sa LockMutex
|
||||||
\sa FreeSignerTable
|
|
||||||
\sa UnlockMutex
|
\sa UnlockMutex
|
||||||
*/
|
*/
|
||||||
int wolfSSL_CTX_UnloadCAs(WOLFSSL_CTX*);
|
int wolfSSL_CTX_UnloadCAs(WOLFSSL_CTX*);
|
||||||
|
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\ingroup Setup
|
||||||
|
|
||||||
|
\brief This function unloads intermediate certificates added to the CA
|
||||||
|
signer list and frees them.
|
||||||
|
|
||||||
|
\return SSL_SUCCESS returned on successful execution of the function.
|
||||||
|
\return BAD_FUNC_ARG returned if the WOLFSSL_CTX struct is NULL or there
|
||||||
|
are otherwise unpermitted argument values passed in a subroutine.
|
||||||
|
\return BAD_STATE_E returned if the WOLFSSL_CTX has a reference count > 1.
|
||||||
|
\return BAD_MUTEX_E returned if there was a mutex error. The LockMutex()
|
||||||
|
did not return 0.
|
||||||
|
|
||||||
|
\param ctx a pointer to a WOLFSSL_CTX structure, created using
|
||||||
|
wolfSSL_CTX_new().
|
||||||
|
|
||||||
|
_Example_
|
||||||
|
\code
|
||||||
|
WOLFSSL_METHOD method = wolfTLSv1_2_client_method();
|
||||||
|
WOLFSSL_CTX* ctx = WOLFSSL_CTX_new(method);
|
||||||
|
…
|
||||||
|
if(wolfSSL_CTX_UnloadIntermediateCerts(ctx) != NULL){
|
||||||
|
// The function did not unload CAs
|
||||||
|
}
|
||||||
|
\endcode
|
||||||
|
|
||||||
|
\sa wolfSSL_CTX_UnloadCAs
|
||||||
|
\sa wolfSSL_CertManagerUnloadIntermediateCerts
|
||||||
|
*/
|
||||||
|
int wolfSSL_CTX_UnloadIntermediateCerts(WOLFSSL_CTX* ctx);
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\ingroup Setup
|
\ingroup Setup
|
||||||
|
|
||||||
|
@ -9551,17 +9582,44 @@ int wolfSSL_CertManagerLoadCABuffer(WOLFSSL_CERT_MANAGER* cm,
|
||||||
#include <wolfssl/ssl.h>
|
#include <wolfssl/ssl.h>
|
||||||
|
|
||||||
WOLFSSL_CTX* ctx = wolfSSL_CTX_new(protocol method);
|
WOLFSSL_CTX* ctx = wolfSSL_CTX_new(protocol method);
|
||||||
WOLFSSL_CERT_MANAGER* cm = wolfSSL_CertManagerNew();
|
WOLFSSL_CERT_MANAGER* cm = wolfSSL_CTX_GetCertManager(ctx);
|
||||||
...
|
...
|
||||||
if(wolfSSL_CertManagerUnloadCAs(ctx->cm) != SSL_SUCCESS){
|
if(wolfSSL_CertManagerUnloadCAs(cm) != SSL_SUCCESS){
|
||||||
|
Failure case.
|
||||||
|
}
|
||||||
|
\endcode
|
||||||
|
|
||||||
|
\sa UnlockMutex
|
||||||
|
*/
|
||||||
|
int wolfSSL_CertManagerUnloadCAs(WOLFSSL_CERT_MANAGER* cm);
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\ingroup CertManager
|
||||||
|
\brief This function unloads intermediate certificates add to the CA
|
||||||
|
signer list.
|
||||||
|
|
||||||
|
\return SSL_SUCCESS returned on successful execution of the function.
|
||||||
|
\return BAD_FUNC_ARG returned if the WOLFSSL_CERT_MANAGER is NULL.
|
||||||
|
\return BAD_MUTEX_E returned if there was a mutex error.
|
||||||
|
|
||||||
|
\param cm a pointer to a WOLFSSL_CERT_MANAGER structure,
|
||||||
|
created using wolfSSL_CertManagerNew().
|
||||||
|
|
||||||
|
_Example_
|
||||||
|
\code
|
||||||
|
#include <wolfssl/ssl.h>
|
||||||
|
|
||||||
|
WOLFSSL_CTX* ctx = wolfSSL_CTX_new(protocol method);
|
||||||
|
WOLFSSL_CERT_MANAGER* cm = wolfSSL_CTX_GetCertManager(ctx);
|
||||||
|
...
|
||||||
|
if(wolfSSL_CertManagerUnloadIntermediateCerts(cm) != SSL_SUCCESS){
|
||||||
Failure case.
|
Failure case.
|
||||||
}
|
}
|
||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
\sa FreeSignerTable
|
|
||||||
\sa UnlockMutex
|
\sa UnlockMutex
|
||||||
*/
|
*/
|
||||||
int wolfSSL_CertManagerUnloadCAs(WOLFSSL_CERT_MANAGER* cm);
|
int wolfSSL_CertManagerUnloadIntermediateCerts(WOLFSSL_CERT_MANAGER* cm);
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\ingroup CertManager
|
\ingroup CertManager
|
||||||
|
|
Loading…
Reference in New Issue