Document SSL_CTX_get_ssl_method
authorHugo Landau <hlandau@openssl.org>
Mon, 4 Apr 2022 12:44:31 +0000 (13:44 +0100)
committerTomas Mraz <tomas@openssl.org>
Thu, 7 Apr 2022 09:46:09 +0000 (11:46 +0200)
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/18037)

(cherry picked from commit e12bee78d4e64da2176dd9a7ec19ec680dd3bebf)

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

index ba2b816f3849ea5dc882eb8877930a8c77271179..d1885d0318d7e17d8c1b8ad691e93feea6ab4031 100644 (file)
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-SSL_CTX_set_ssl_version, SSL_set_ssl_method, SSL_get_ssl_method
+SSL_CTX_set_ssl_version, SSL_CTX_get_ssl_method, SSL_set_ssl_method, SSL_get_ssl_method
 - choose a new TLS/SSL method
 
 =head1 SYNOPSIS
@@ -10,6 +10,8 @@ SSL_CTX_set_ssl_version, SSL_set_ssl_method, SSL_get_ssl_method
  #include <openssl/ssl.h>
 
  int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *method);
+ const SSL_METHOD *SSL_CTX_get_ssl_method(const SSL_CTX *ctx);
+
  int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
  const SSL_METHOD *SSL_get_ssl_method(const SSL *ssl);
 
@@ -22,10 +24,13 @@ which are reset to the default values.  SSL objects already created from this
 SSL_CTX with L<SSL_new(3)> are not affected, except when L<SSL_clear(3)> is
 being called, as described below.
 
+SSL_CTX_get_ssl_method() returns the SSL_METHOD which was used to construct the
+SSL_CTX.
+
 SSL_set_ssl_method() sets a new TLS/SSL B<method> for a particular B<ssl>
 object. It may be reset, when SSL_clear() is called.
 
-SSL_get_ssl_method() returns a function pointer to the TLS/SSL method
+SSL_get_ssl_method() returns a pointer to the TLS/SSL method
 set in B<ssl>.
 
 =head1 NOTES
@@ -59,6 +64,9 @@ The operation succeeded.
 
 =back
 
+SSL_CTX_get_ssl_method() and SSL_get_ssl_method() always return non-NULL
+pointers.
+
 =head1 SEE ALSO
 
 L<SSL_CTX_new(3)>, L<SSL_new(3)>,
index 6adf6c511784c582d8de3171834117ede33bae22..8a7e26820336b234871d68506df3e662a3775820 100644 (file)
@@ -9,7 +9,6 @@ SSL_CTX_SRP_CTX_init(3)
 SSL_CTX_get0_certificate(3)
 SSL_CTX_get0_ctlog_store(3)
 SSL_CTX_get0_privatekey(3)
-SSL_CTX_get_ssl_method(3)
 SSL_CTX_set0_ctlog_store(3)
 SSL_CTX_set_client_cert_engine(3)
 SSL_CTX_set_not_resumable_session_callback(3)