Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix doc for wolfSSL_CTX_EnableOCSP #7567

Merged
merged 1 commit into from
May 22, 2024
Merged

Fix doc for wolfSSL_CTX_EnableOCSP #7567

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 24 additions & 10 deletions doc/dox_comments/header_files/ssl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10197,7 +10197,7 @@ int wolfSSL_CertManagerSetOCSPOverrideURL(WOLFSSL_CERT_MANAGER* cm,
\sa wolfSSL_CertManagerSetOCSPOverrideURL
\sa wolfSSL_CertManagerCheckOCSP
\sa wolfSSL_CertManagerEnableOCSPStapling
\sa wolfSSL_ENableOCSP
\sa wolfSSL_EnableOCSP
\sa wolfSSL_DisableOCSP
\sa wolfSSL_SetOCSP_Cb
*/
Expand Down Expand Up @@ -10356,7 +10356,13 @@ int wolfSSL_LoadCRL(WOLFSSL* ssl, const char* path, int type, int monitor);
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
without errors.
Expand Down Expand Up @@ -10611,10 +10617,13 @@ int wolfSSL_CTX_SetCRL_Cb(WOLFSSL_CTX* ctx, CbMissingCRL cb);
\brief This function sets options to configure behavior of OCSP
functionality in wolfSSL. The value of options if formed by or’ing
one or more of the following options:
WOLFSSL_OCSP_ENABLE - enable OCSP lookups 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. This
function only sets the OCSP options when wolfSSL has been compiled with
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

This function only sets the OCSP options when wolfSSL has been compiled with
OCSP support (--enable-ocsp, #define HAVE_OCSP).

\return SSL_SUCCESS is returned upon success.
Expand All @@ -10627,12 +10636,17 @@ int wolfSSL_CTX_SetCRL_Cb(WOLFSSL_CTX* ctx, CbMissingCRL cb);

_Example_
\code
WOLFSSL_CTX* ctx = 0;
...
wolfSSL_CTX_OCSP_set_options(ctx, WOLFSSL_OCSP_ENABLE);
WOLFSSL_CTX* ctx = wolfSSL_CTX_new( method );
int options; // initialize to option constant
…
int ret = wolfSSL_CTX_EnableOCSP(ctx, options);
if(ret != SSL_SUCCESS){
// OCSP is not enabled
}
\endcode

\sa wolfSSL_CTX_OCSP_set_override_url
\sa wolfSSL_CertManagerEnableOCSP
\sa wolfSSL_EnableOCSP
*/
int wolfSSL_CTX_EnableOCSP(WOLFSSL_CTX* ctx, int options);

Expand Down