diff options
| author | Hugo Landau <hlandau@openssl.org> | 2022-04-04 13:45:44 +0100 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2022-04-07 11:45:23 +0200 |
| commit | eb27a90e41a62d3337c5e21e24ee72f1e49a445c (patch) | |
| tree | ce2878d1c14fcee926948b6dee46d87ac5860b54 /doc | |
| parent | e12bee78d4e64da2176dd9a7ec19ec680dd3bebf (diff) | |
Document {SSL|SSL_CTX}_set_{purpose|trust}()
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/18037)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/SSL_CTX_get0_param.pod | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/doc/man3/SSL_CTX_get0_param.pod b/doc/man3/SSL_CTX_get0_param.pod index 6985517366..7e2be4a404 100644 --- a/doc/man3/SSL_CTX_get0_param.pod +++ b/doc/man3/SSL_CTX_get0_param.pod @@ -2,7 +2,8 @@ =head1 NAME -SSL_CTX_get0_param, SSL_get0_param, SSL_CTX_set1_param, SSL_set1_param - +SSL_CTX_get0_param, SSL_get0_param, SSL_CTX_set1_param, SSL_set1_param, +SSL_CTX_set_purpose, SSL_CTX_set_trust, SSL_set_purpose, SSL_set_trust - get and set verification parameters =head1 SYNOPSIS @@ -14,6 +15,12 @@ get and set verification parameters int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm); int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm); + int SSL_CTX_set_purpose(SSL_CTX *ctx, int purpose); + int SSL_set_purpose(SSL *ssl, int purpose); + + int SSL_CTX_set_trust(SSL_CTX *ctx, int trust); + int SSL_set_trust(SSL *ssl, int trust); + =head1 DESCRIPTION SSL_CTX_get0_param() and SSL_get0_param() retrieve an internal pointer to @@ -23,6 +30,14 @@ pointer must not be freed by the calling application. SSL_CTX_set1_param() and SSL_set1_param() set the verification parameters to B<vpm> for B<ctx> or B<ssl>. +The functions SSL_CTX_set_purpose() and SSL_set_purpose() are shorthands which +set the purpose parameter on the verification parameters object. These functions +are equivalent to calling X509_VERIFY_PARAM_set_purpose() directly. + +The functions SSL_CTX_set_trust() and SSL_set_trust() are similarly shorthands +which set the trust parameter on the verification parameters object. These +functions are equivalent to calling X509_VERIFY_PARAM_set_trust() directly. + =head1 NOTES Typically parameters are retrieved from an B<SSL_CTX> or B<SSL> structure @@ -34,8 +49,9 @@ them to suit its needs: for example to add a hostname check. SSL_CTX_get0_param() and SSL_get0_param() return a pointer to an B<X509_VERIFY_PARAM> structure. -SSL_CTX_set1_param() and SSL_set1_param() return 1 for success and 0 -for failure. +SSL_CTX_set1_param(), SSL_set1_param(), SSL_CTX_set_purpose(), +SSL_set_purpose(), SSL_CTX_set_trust() and SSL_set_trust() return 1 for success +and 0 for failure. =head1 EXAMPLES |