Skip to content

Commit 314afc9

Browse files
committed
Fix doc for wolfSSL_CTX_EnableOCSP
1 parent 7782f8e commit 314afc9

1 file changed

Lines changed: 24 additions & 10 deletions

File tree

  • doc/dox_comments/header_files

doc/dox_comments/header_files/ssl.h

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10197,7 +10197,7 @@ int wolfSSL_CertManagerSetOCSPOverrideURL(WOLFSSL_CERT_MANAGER* cm,
1019710197
\sa wolfSSL_CertManagerSetOCSPOverrideURL
1019810198
\sa wolfSSL_CertManagerCheckOCSP
1019910199
\sa wolfSSL_CertManagerEnableOCSPStapling
10200-
\sa wolfSSL_ENableOCSP
10200+
\sa wolfSSL_EnableOCSP
1020110201
\sa wolfSSL_DisableOCSP
1020210202
\sa wolfSSL_SetOCSP_Cb
1020310203
*/
@@ -10356,7 +10356,13 @@ int wolfSSL_LoadCRL(WOLFSSL* ssl, const char* path, int type, int monitor);
1035610356
int wolfSSL_SetCRL_Cb(WOLFSSL* ssl, CbMissingCRL cb);
1035710357

1035810358
/*!
10359-
\brief This function enables OCSP certificate verification.
10359+
\brief This function enables OCSP certificate verification. The value of
10360+
options if formed by or’ing one or more of the following options:
10361+
WOLFSSL_OCSP_URL_OVERRIDE - use the override URL instead of the URL in
10362+
certificates. The override URL is specified using the
10363+
wolfSSL_CTX_SetOCSP_OverrideURL() function.
10364+
WOLFSSL_OCSP_CHECKALL - Set all OCSP checks on
10365+
WOLFSSL_OCSP_NO_NONCE - Set nonce option for creating OCSP requests
1036010366
1036110367
\return SSL_SUCCESS returned if the function and subroutines executes
1036210368
without errors.
@@ -10611,10 +10617,13 @@ int wolfSSL_CTX_SetCRL_Cb(WOLFSSL_CTX* ctx, CbMissingCRL cb);
1061110617
\brief This function sets options to configure behavior of OCSP
1061210618
functionality in wolfSSL. The value of options if formed by or’ing
1061310619
one or more of the following options:
10614-
WOLFSSL_OCSP_ENABLE - enable OCSP lookups WOLFSSL_OCSP_URL_OVERRIDE -
10615-
use the override URL instead of the URL in certificates. The override URL
10616-
is specified using the wolfSSL_CTX_SetOCSP_OverrideURL() function. This
10617-
function only sets the OCSP options when wolfSSL has been compiled with
10620+
WOLFSSL_OCSP_URL_OVERRIDE - use the override URL instead of the URL in
10621+
certificates. The override URL is specified using the
10622+
wolfSSL_CTX_SetOCSP_OverrideURL() function.
10623+
WOLFSSL_OCSP_CHECKALL - Set all OCSP checks on
10624+
WOLFSSL_OCSP_NO_NONCE - Set nonce option for creating OCSP requests
10625+
10626+
This function only sets the OCSP options when wolfSSL has been compiled with
1061810627
OCSP support (--enable-ocsp, #define HAVE_OCSP).
1061910628
1062010629
\return SSL_SUCCESS is returned upon success.
@@ -10627,12 +10636,17 @@ int wolfSSL_CTX_SetCRL_Cb(WOLFSSL_CTX* ctx, CbMissingCRL cb);
1062710636
1062810637
_Example_
1062910638
\code
10630-
WOLFSSL_CTX* ctx = 0;
10631-
...
10632-
wolfSSL_CTX_OCSP_set_options(ctx, WOLFSSL_OCSP_ENABLE);
10639+
WOLFSSL_CTX* ctx = wolfSSL_CTX_new( method );
10640+
int options; // initialize to option constant
10641+
10642+
int ret = wolfSSL_CTX_EnableOCSP(ctx, options);
10643+
if(ret != SSL_SUCCESS){
10644+
// OCSP is not enabled
10645+
}
1063310646
\endcode
1063410647
10635-
\sa wolfSSL_CTX_OCSP_set_override_url
10648+
\sa wolfSSL_CertManagerEnableOCSP
10649+
\sa wolfSSL_EnableOCSP
1063610650
*/
1063710651
int wolfSSL_CTX_EnableOCSP(WOLFSSL_CTX* ctx, int options);
1063810652

0 commit comments

Comments
 (0)