.\"	$OpenBSD: SSL_CTX_set_ssl_version.3,v 1.5 2021/05/11 19:48:56 tb Exp $
.\"	OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
.\"
.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
.\" Copyright (c) 2000, 2001, 2005 The OpenSSL Project.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\"    software must display the following acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
.\"
.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
.\"    endorse or promote products derived from this software without
.\"    prior written permission. For written permission, please contact
.\"    openssl-core@openssl.org.
.\"
.\" 5. Products derived from this software may not be called "OpenSSL"
.\"    nor may "OpenSSL" appear in their names without prior written
.\"    permission of the OpenSSL Project.
.\"
.\" 6. Redistributions of any form whatsoever must retain the following
.\"    acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd $Mdocdate: May 11 2021 $
.Dt SSL_CTX_SET_SSL_VERSION 3
.Os
.Sh NAME
.Nm SSL_CTX_set_ssl_version ,
.Nm SSL_set_ssl_method ,
.Nm SSL_CTX_get_ssl_method ,
.Nm SSL_get_ssl_method
.Nd choose a new TLS/SSL method
.Sh SYNOPSIS
.In openssl/ssl.h
.Ft int
.Fn SSL_CTX_set_ssl_version "SSL_CTX *ctx" "const SSL_METHOD *method"
.Ft int
.Fn SSL_set_ssl_method "SSL *s" "const SSL_METHOD *method"
.Ft const SSL_METHOD *
.Fn SSL_CTX_get_ssl_method "SSL_CTX *ctx"
.Ft const SSL_METHOD *
.Fn SSL_get_ssl_method "SSL *ssl"
.Sh DESCRIPTION
.Fn SSL_CTX_set_ssl_version
sets a new default TLS/SSL
.Fa method
for
.Vt SSL
objects newly created from this
.Fa ctx .
.Vt SSL
objects already created with
.Xr SSL_new 3
are not affected, except when
.Xr SSL_clear 3
is called.
.Pp
.Fn SSL_set_ssl_method
sets a new TLS/SSL
.Fa method
for a particular
.Vt SSL
object
.Fa s .
It may be reset when
.Xr SSL_clear 3
is called.
.Pp
.Fn SSL_CTX_get_ssl_method
and
.Fn SSL_get_ssl_method
return a function pointer to the TLS/SSL method set in
.Fa ctx
and
.Fa ssl ,
respectively.
.Pp
The available
.Fa method
choices are described in
.Xr SSL_CTX_new 3 .
.Pp
When
.Xr SSL_clear 3
is called and no session is connected to an
.Vt SSL
object, the method of the
.Vt SSL
object is reset to the method currently set in the corresponding
.Vt SSL_CTX
object.
.Sh RETURN VALUES
The following return values can occur for
.Fn SSL_CTX_set_ssl_version
and
.Fn SSL_set_ssl_method :
.Bl -tag -width Ds
.It  0
The new choice failed.
Check the error stack to find out the reason.
.It  1
The operation succeeded.
.El
.Sh SEE ALSO
.Xr ssl 3 ,
.Xr SSL_clear 3 ,
.Xr SSL_CTX_new 3 ,
.Xr SSL_new 3 ,
.Xr SSL_set_connect_state 3
.Sh HISTORY
.Fn SSL_CTX_set_ssl_version ,
.Fn SSL_set_ssl_method ,
and
.Fn SSL_get_ssl_method
first appeared in SSLeay 0.8.0 and have been available since
.Ox 2.4 .
.Fn SSL_CTX_get_ssl_method
first appeared in OpenSSL 1.1.0 and has been available since
.Ox 7.0 .