WolfSSL
/
wolfssl
mirror of https://github.com/wolfSSL/wolfssl.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #7567 from embhorn/gh7564 

Fix doc for wolfSSL_CTX_EnableOCSP
pull/7572/head
David Garske 2024-05-22 08:46:20 -07:00 committed by GitHub
parent 425dd1986b 314afc9e10
commit cb0048dbb1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -10197,7 +10197,7 @@ int wolfSSL_CertManagerSetOCSPOverrideURL(WOLFSSL_CERT_MANAGER* cm,
\sa wolfSSL_CertManagerSetOCSPOverrideURL \sa wolfSSL_CertManagerSetOCSPOverrideURL
\sa wolfSSL_CertManagerCheckOCSP \sa wolfSSL_CertManagerCheckOCSP
\sa wolfSSL_CertManagerEnableOCSPStapling \sa wolfSSL_CertManagerEnableOCSPStapling
\sa wolfSSL_ENableOCSP \sa wolfSSL_EnableOCSP
\sa wolfSSL_DisableOCSP \sa wolfSSL_DisableOCSP
\sa wolfSSL_SetOCSP_Cb \sa wolfSSL_SetOCSP_Cb
*/ */
@ -10356,7 +10356,13 @@ int wolfSSL_LoadCRL(WOLFSSL* ssl, const char* path, int type, int monitor);
int wolfSSL_SetCRL_Cb(WOLFSSL* ssl, CbMissingCRL cb); int wolfSSL_SetCRL_Cb(WOLFSSL* ssl, CbMissingCRL cb);
/*! /*!
\brief This function enables OCSP certificate verification. \brief This function enables OCSP certificate verification. The value of
options if formed by or’ing one or more of the following options:
WOLFSSL_OCSP_URL_OVERRIDE - use the override URL instead of the URL in
certificates. The override URL is specified using the
wolfSSL_CTX_SetOCSP_OverrideURL() function.
WOLFSSL_OCSP_CHECKALL - Set all OCSP checks on
WOLFSSL_OCSP_NO_NONCE - Set nonce option for creating OCSP requests
\return SSL_SUCCESS returned if the function and subroutines executes \return SSL_SUCCESS returned if the function and subroutines executes
without errors. without errors.
@ -10611,10 +10617,13 @@ int wolfSSL_CTX_SetCRL_Cb(WOLFSSL_CTX* ctx, CbMissingCRL cb);
\brief This function sets options to configure behavior of OCSP \brief This function sets options to configure behavior of OCSP
functionality in wolfSSL. The value of options if formed by or’ing functionality in wolfSSL. The value of options if formed by or’ing
one or more of the following options: one or more of the following options:
WOLFSSL_OCSP_ENABLE - enable OCSP lookups WOLFSSL_OCSP_URL_OVERRIDE - WOLFSSL_OCSP_URL_OVERRIDE - use the override URL instead of the URL in
use the override URL instead of the URL in certificates. The override URL certificates. The override URL is specified using the
is specified using the wolfSSL_CTX_SetOCSP_OverrideURL() function. This wolfSSL_CTX_SetOCSP_OverrideURL() function.
function only sets the OCSP options when wolfSSL has been compiled with WOLFSSL_OCSP_CHECKALL - Set all OCSP checks on
WOLFSSL_OCSP_NO_NONCE - Set nonce option for creating OCSP requests
This function only sets the OCSP options when wolfSSL has been compiled with
OCSP support (--enable-ocsp, #define HAVE_OCSP). OCSP support (--enable-ocsp, #define HAVE_OCSP).
\return SSL_SUCCESS is returned upon success. \return SSL_SUCCESS is returned upon success.
@ -10627,12 +10636,17 @@ int wolfSSL_CTX_SetCRL_Cb(WOLFSSL_CTX* ctx, CbMissingCRL cb);
_Example_ _Example_
\code \code
WOLFSSL_CTX* ctx = 0; WOLFSSL_CTX* ctx = wolfSSL_CTX_new( method );
... int options; // initialize to option constant
wolfSSL_CTX_OCSP_set_options(ctx, WOLFSSL_OCSP_ENABLE); …
int ret = wolfSSL_CTX_EnableOCSP(ctx, options);
if(ret != SSL_SUCCESS){
// OCSP is not enabled
}
\endcode \endcode
\sa wolfSSL_CTX_OCSP_set_override_url \sa wolfSSL_CertManagerEnableOCSP
\sa wolfSSL_EnableOCSP
*/ */
int wolfSSL_CTX_EnableOCSP(WOLFSSL_CTX* ctx, int options); int wolfSSL_CTX_EnableOCSP(WOLFSSL_CTX* ctx, int options);