secure/lib/libcrypto/man/SSL_get_version.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_GET_VERSION 3"
 132 .TH SSL_GET_VERSION 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 SSL_client_version, SSL_get_version, SSL_is_dtls, SSL_version \- get the protocol information of a connection
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& int SSL_client_version(const SSL *s);
 145 \&
 146 \& const char *SSL_get_version(const SSL *ssl);
 147 \&
 148 \& int SSL_is_dtls(const SSL *ssl);
 149 \&
 150 \& int SSL_version(const SSL *s);
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 \&\fISSL_client_version()\fR returns the numeric protocol version advertised by the
 155 client in the legacy_version field of the ClientHello when initiating the
 156 connection. Note that, for \s-1TLS,\s0 this value will never indicate a version greater
 157 than TLSv1.2 even if TLSv1.3 is subsequently negotiated. \fISSL_get_version()\fR
 158 returns the name of the protocol used for the connection. \fISSL_version()\fR returns
 159 the numeric protocol version used for the connection. They should only be called
 160 after the initial handshake has been completed. Prior to that the results
 161 returned from these functions may be unreliable.
 162 .PP
 163 \&\fISSL_is_dtls()\fR returns one if the connection is using \s-1DTLS,\s0 zero if not.
 164 .SH "RETURN VALUES"
 165 .IX Header "RETURN VALUES"
 166 \&\fISSL_get_version()\fR returns one of the following strings:
 167 .IP "SSLv3" 4
 168 .IX Item "SSLv3"
 169 The connection uses the SSLv3 protocol.
 170 .IP "TLSv1" 4
 171 .IX Item "TLSv1"
 172 The connection uses the TLSv1.0 protocol.
 173 .IP "TLSv1.1" 4
 174 .IX Item "TLSv1.1"
 175 The connection uses the TLSv1.1 protocol.
 176 .IP "TLSv1.2" 4
 177 .IX Item "TLSv1.2"
 178 The connection uses the TLSv1.2 protocol.
 179 .IP "TLSv1.3" 4
 180 .IX Item "TLSv1.3"
 181 The connection uses the TLSv1.3 protocol.
 182 .IP "unknown" 4
 183 .IX Item "unknown"
 184 This indicates an unknown protocol version.
 185 .PP
 186 \&\fISSL_version()\fR and \fISSL_client_version()\fR return an integer which could include any
 187 of the following:
 188 .IP "\s-1SSL3_VERSION\s0" 4
 189 .IX Item "SSL3_VERSION"
 190 The connection uses the SSLv3 protocol.
 191 .IP "\s-1TLS1_VERSION\s0" 4
 192 .IX Item "TLS1_VERSION"
 193 The connection uses the TLSv1.0 protocol.
 194 .IP "\s-1TLS1_1_VERSION\s0" 4
 195 .IX Item "TLS1_1_VERSION"
 196 The connection uses the TLSv1.1 protocol.
 197 .IP "\s-1TLS1_2_VERSION\s0" 4
 198 .IX Item "TLS1_2_VERSION"
 199 The connection uses the TLSv1.2 protocol.
 200 .IP "\s-1TLS1_3_VERSION\s0" 4
 201 .IX Item "TLS1_3_VERSION"
 202 The connection uses the TLSv1.3 protocol (never returned for
 203 \&\fISSL_client_version()\fR).
 204 .SH "SEE ALSO"
 205 .IX Header "SEE ALSO"
 206 \&\fIssl\fR\|(7)
 207 .SH "HISTORY"
 208 .IX Header "HISTORY"
 209 \&\fISSL_is_dtls()\fR was added in OpenSSL 1.1.0.
 210 .SH "COPYRIGHT"
 211 .IX Header "COPYRIGHT"
 212 Copyright 2001\-2018 The OpenSSL Project Authors. All Rights Reserved.
 213 .PP
 214 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 215 this file except in compliance with the License.  You can obtain a copy
 216 in the file \s-1LICENSE\s0 in the source distribution or at
 217 <https://www.openssl.org/source/license.html>.