Blame doc/man3/SSL_CTX_set_ssl_version.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
SSL_CTX_set_ssl_version, SSL_set_ssl_method, SSL_get_ssl_method
Packit c4476c
- choose a new TLS/SSL method
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/ssl.h>
Packit c4476c
Packit c4476c
 int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *method);
Packit c4476c
 int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
Packit c4476c
 const SSL_METHOD *SSL_get_ssl_method(const SSL *ssl);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
SSL_CTX_set_ssl_version() sets a new default TLS/SSL B<method> for SSL objects
Packit c4476c
newly created from this B<ctx>. SSL objects already created with
Packit c4476c
L<SSL_new(3)> are not affected, except when
Packit c4476c
L<SSL_clear(3)> is being called.
Packit c4476c
Packit c4476c
SSL_set_ssl_method() sets a new TLS/SSL B<method> for a particular B<ssl>
Packit c4476c
object. It may be reset, when SSL_clear() is called.
Packit c4476c
Packit c4476c
SSL_get_ssl_method() returns a function pointer to the TLS/SSL method
Packit c4476c
set in B<ssl>.
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
The available B<method> choices are described in
Packit c4476c
L<SSL_CTX_new(3)>.
Packit c4476c
Packit c4476c
When L<SSL_clear(3)> is called and no session is connected to
Packit c4476c
an SSL object, the method of the SSL object is reset to the method currently
Packit c4476c
set in the corresponding SSL_CTX object.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
The following return values can occur for SSL_CTX_set_ssl_version()
Packit c4476c
and SSL_set_ssl_method():
Packit c4476c
Packit c4476c
=over 4
Packit c4476c
Packit c4476c
=item Z<>0
Packit c4476c
Packit c4476c
The new choice failed, check the error stack to find out the reason.
Packit c4476c
Packit c4476c
=item Z<>1
Packit c4476c
Packit c4476c
The operation succeeded.
Packit c4476c
Packit c4476c
=back
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<SSL_CTX_new(3)>, L<SSL_new(3)>,
Packit c4476c
L<SSL_clear(3)>, L<ssl(7)>,
Packit c4476c
L<SSL_set_connect_state(3)>
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut