secure/lib/libcrypto/man/man3/SSL_get_version.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SSL_GET_VERSION 3"
 136 .TH SSL_GET_VERSION 3 "2020-03-31" "1.1.1f" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 SSL_client_version, SSL_get_version, SSL_is_dtls, SSL_version \- get the protocol information of a connection
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& int SSL_client_version(const SSL *s);
 149 \&
 150 \& const char *SSL_get_version(const SSL *ssl);
 151 \&
 152 \& int SSL_is_dtls(const SSL *ssl);
 153 \&
 154 \& int SSL_version(const SSL *s);
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 \&\fBSSL_client_version()\fR returns the numeric protocol version advertised by the
 159 client in the legacy_version field of the ClientHello when initiating the
 160 connection. Note that, for \s-1TLS,\s0 this value will never indicate a version greater
 161 than TLSv1.2 even if TLSv1.3 is subsequently negotiated. \fBSSL_get_version()\fR
 162 returns the name of the protocol used for the connection. \fBSSL_version()\fR returns
 163 the numeric protocol version used for the connection. They should only be called
 164 after the initial handshake has been completed. Prior to that the results
 165 returned from these functions may be unreliable.
 166 .PP
 167 \&\fBSSL_is_dtls()\fR returns one if the connection is using \s-1DTLS,\s0 zero if not.
 168 .SH "RETURN VALUES"
 169 .IX Header "RETURN VALUES"
 170 \&\fBSSL_get_version()\fR returns one of the following strings:
 171 .IP "SSLv3" 4
 172 .IX Item "SSLv3"
 173 The connection uses the SSLv3 protocol.
 174 .IP "TLSv1" 4
 175 .IX Item "TLSv1"
 176 The connection uses the TLSv1.0 protocol.
 177 .IP "TLSv1.1" 4
 178 .IX Item "TLSv1.1"
 179 The connection uses the TLSv1.1 protocol.
 180 .IP "TLSv1.2" 4
 181 .IX Item "TLSv1.2"
 182 The connection uses the TLSv1.2 protocol.
 183 .IP "TLSv1.3" 4
 184 .IX Item "TLSv1.3"
 185 The connection uses the TLSv1.3 protocol.
 186 .IP "unknown" 4
 187 .IX Item "unknown"
 188 This indicates an unknown protocol version.
 189 .PP
 190 \&\fBSSL_version()\fR and \fBSSL_client_version()\fR return an integer which could include any
 191 of the following:
 192 .IP "\s-1SSL3_VERSION\s0" 4
 193 .IX Item "SSL3_VERSION"
 194 The connection uses the SSLv3 protocol.
 195 .IP "\s-1TLS1_VERSION\s0" 4
 196 .IX Item "TLS1_VERSION"
 197 The connection uses the TLSv1.0 protocol.
 198 .IP "\s-1TLS1_1_VERSION\s0" 4
 199 .IX Item "TLS1_1_VERSION"
 200 The connection uses the TLSv1.1 protocol.
 201 .IP "\s-1TLS1_2_VERSION\s0" 4
 202 .IX Item "TLS1_2_VERSION"
 203 The connection uses the TLSv1.2 protocol.
 204 .IP "\s-1TLS1_3_VERSION\s0" 4
 205 .IX Item "TLS1_3_VERSION"
 206 The connection uses the TLSv1.3 protocol (never returned for
 207 \&\fBSSL_client_version()\fR).
 208 .SH "SEE ALSO"
 209 .IX Header "SEE ALSO"
 210 \&\fBssl\fR\|(7)
 211 .SH "HISTORY"
 212 .IX Header "HISTORY"
 213 The \fBSSL_is_dtls()\fR function was added in OpenSSL 1.1.0.
 214 .SH "COPYRIGHT"
 215 .IX Header "COPYRIGHT"
 216 Copyright 2001\-2018 The OpenSSL Project Authors. All Rights Reserved.
 217 .PP
 218 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 219 this file except in compliance with the License.  You can obtain a copy
 220 in the file \s-1LICENSE\s0 in the source distribution or at
 221 <https://www.openssl.org/source/license.html>.