]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Add documentation for the function SSL_CONF_CTX_finish.
authorSumitra Sharma <sumitraartsy@gmail.com>
Mon, 18 Sep 2023 11:08:11 +0000 (16:38 +0530)
committerPauli <pauli@openssl.org>
Wed, 20 Sep 2023 00:25:51 +0000 (10:25 +1000)
Add documentation for the function SSL_CONF_CTX_finish() in man3.

Fixes #22084

Signed-off-by: Sumitra Sharma <sumitraartsy@gmail.com>
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22128)

doc/man3/SSL_CONF_CTX_set_ssl_ctx.pod
util/missingssl.txt

index 06cc1e4ec539d23d9d3588efc1d76e7748da1f47..b74c869b83d2dc99df397e9ef00a8f85ac00dc96 100644 (file)
@@ -2,6 +2,7 @@
 
 =head1 NAME
 
+SSL_CONF_CTX_finish,
 SSL_CONF_CTX_set_ssl_ctx, SSL_CONF_CTX_set_ssl - set context to configure
 
 =head1 SYNOPSIS
@@ -10,6 +11,7 @@ SSL_CONF_CTX_set_ssl_ctx, SSL_CONF_CTX_set_ssl - set context to configure
 
  void SSL_CONF_CTX_set_ssl_ctx(SSL_CONF_CTX *cctx, SSL_CTX *ctx);
  void SSL_CONF_CTX_set_ssl(SSL_CONF_CTX *cctx, SSL *ssl);
+ int SSL_CONF_CTX_finish(SSL_CONF_CTX *cctx);
 
 =head1 DESCRIPTION
 
@@ -23,6 +25,10 @@ B<SSL> structure B<ssl>. Any previous B<SSL> or B<SSL_CTX> associated with
 B<cctx> is cleared. Subsequent calls to SSL_CONF_cmd() will be sent to
 B<ssl>.
 
+The function SSL_CONF_CTX_finish() must be called after all configuration
+operations have been completed. It is used to finalise any operations
+or to process defaults.
+
 =head1 NOTES
 
 The context need not be set or it can be set to B<NULL> in which case only
@@ -32,6 +38,8 @@ syntax checking of commands is performed, where possible.
 
 SSL_CONF_CTX_set_ssl_ctx() and SSL_CTX_set_ssl() do not return a value.
 
+SSL_CONF_CTX_finish() returns 1 for success and 0 for failure.
+
 =head1 SEE ALSO
 
 L<ssl(7)>,
index 224eb84899f5bd265ba4d807b6c2758a8cccc275..1338feed71188983b0d60c4206a58aaff31a234d 100644 (file)
@@ -3,7 +3,6 @@ ERR_load_SSL_strings(3)
 SRP_Calc_A_param(3)
 SSL_COMP_get_name(3)
 SSL_COMP_set0_compression_methods(3)
-SSL_CONF_CTX_finish(3)
 SSL_CTX_SRP_CTX_free(3)
 SSL_CTX_SRP_CTX_init(3)
 SSL_CTX_get0_certificate(3)