lib/libssl/man/SSL_CTX_set_min_proto_version.3

   1 .\"     $OpenBSD: SSL_CTX_set_min_proto_version.3,v 1.1 2017/08/19 23:45:10 schwarze Exp $
   2 .\"     OpenSSL e9b77246 Jan 20 19:58:49 2017 +0100
   3 .\"
   4 .\" This file was written by Kurt Roeckx <kurt@roeckx.be>.
   5 .\" Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: August 19 2017 $
  52 .Dt SSL_CTX_SET_MIN_PROTO_VERSION 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_CTX_set_min_proto_version ,
  56 .Nm SSL_CTX_set_max_proto_version ,
  57 .Nm SSL_set_min_proto_version ,
  58 .Nm SSL_set_max_proto_version
  59 .Nd set minimum and maximum supported protocol version
  60 .Sh SYNOPSIS
  61 .In openssl/ssl.h
  62 .Ft int
  63 .Fo SSL_CTX_set_min_proto_version
  64 .Fa "SSL_CTX *ctx"
  65 .Fa "uint16_t version"
  66 .Fc
  67 .Ft int
  68 .Fo SSL_CTX_set_max_proto_version
  69 .Fa "SSL_CTX *ctx"
  70 .Fa "uint16_t version"
  71 .Fc
  72 .Ft int
  73 .Fo SSL_set_min_proto_version
  74 .Fa "SSL *ssl"
  75 .Fa "uint16_t version"
  76 .Fc
  77 .Ft int
  78 .Fo SSL_set_max_proto_version
  79 .Fa "SSL *ssl"
  80 .Fa "uint16_t version"
  81 .Fc
  82 .Sh DESCRIPTION
  83 These functions set the minimum and maximum supported protocol
  84 versions for
  85 .Fa ctx
  86 or
  87 .Fa ssl .
  88 This works in combination with the options set via
  89 .Xr SSL_CTX_set_options 3
  90 that also make it possible to disable specific protocol versions.
  91 Use these functions instead of disabling specific protocol versions.
  92 .Pp
  93 Setting the minimum or maximum version to 0 will enable protocol
  94 versions down to the lowest or up to the highest version supported
  95 by the library, respectively.
  96 .Pp
  97 Currently supported versions are
  98 .Sy TLS1_VERSION ,
  99 .Sy TLS1_1_VERSION ,
 100 and
 101 .Sy TLS1_2_VERSION
 102 for TLS and
 103 .Sy DTLS1_VERSION
 104 for DTLS.
 105 .Sh RETURN VALUES
 106 These functions return 1 on success or 0 on failure.
 107 .Sh SEE ALSO
 108 .Xr ssl 3 ,
 109 .Xr SSL_CTX_new 3 ,
 110 .Xr SSL_CTX_set_options 3
 111 .Sh HISTORY
 112 These functions first appeared in OpenSSL 1.1.0
 113 and have been available since
 114 .Ox 6.2 .