diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/SSL_get_version.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/SSL_get_version.3 | 179 |
1 files changed, 68 insertions, 111 deletions
diff --git a/secure/lib/libcrypto/man/man3/SSL_get_version.3 b/secure/lib/libcrypto/man/man3/SSL_get_version.3 index b8f813635f21..2b4f087892b6 100644 --- a/secure/lib/libcrypto/man/man3/SSL_get_version.3 +++ b/secure/lib/libcrypto/man/man3/SSL_get_version.3 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .ft R .fi .. -.\" Set up some character translations and predefined strings. \*(-- will -.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. \*(C+ will -.\" give a nicer C++. Capital omega is used to do unbreakable dashes and -.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, -.\" nothing in troff, for use with C<>. -.tr \(*W- -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ -. ds -- \(*W- -. ds PI pi -. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -. ds L" "" -. ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ -. ds -- \|\(em\| -. ds PI \(*p -. ds L" `` -. ds R" '' . ds C` . ds C' 'br\} @@ -68,78 +52,18 @@ . \} .\} .rr rF -.\" Fear. Run. Save yourself. No user-serviceable parts. -. \" fudge factors for nroff and troff -.if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP -.\} -.if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& -.\} -. \" simple accents for nroff and troff -.if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds / -.\} -.if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -.\} -. \" troff and (daisy-wheel) nroff accents -.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' -.ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] -.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' -.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' -.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] -.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] -.ds ae a\h'-(\w'a'u*4/10)'e -.ds Ae A\h'-(\w'A'u*4/10)'E -. \" corrections for vroff -.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' -.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) -.if \n(.H>23 .if \n(.V>19 \ -\{\ -. ds : e -. ds 8 ss -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -.\} -.rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "SSL_GET_VERSION 3ossl" -.TH SSL_GET_VERSION 3ossl "2023-09-19" "3.0.11" "OpenSSL" +.TH SSL_GET_VERSION 3ossl 2025-07-01 3.5.1 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" -SSL_client_version, SSL_get_version, SSL_is_dtls, SSL_version \- get the -protocol information of a connection -.SH "SYNOPSIS" +.SH NAME +SSL_client_version, SSL_get_version, SSL_is_dtls, SSL_is_tls, SSL_is_quic, +SSL_version \- get the protocol information of a connection +.SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/ssl.h> @@ -149,72 +73,105 @@ protocol information of a connection \& const char *SSL_get_version(const SSL *ssl); \& \& int SSL_is_dtls(const SSL *ssl); +\& int SSL_is_tls(const SSL *ssl); +\& int SSL_is_quic(const SSL *ssl); \& \& int SSL_version(const SSL *s); .Ve -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" -\&\fBSSL_client_version()\fR returns the numeric protocol version advertised by the -client in the legacy_version field of the ClientHello when initiating the -connection. Note that, for \s-1TLS,\s0 this value will never indicate a version greater -than TLSv1.2 even if TLSv1.3 is subsequently negotiated. \fBSSL_get_version()\fR -returns the name of the protocol used for the connection. \fBSSL_version()\fR returns -the numeric protocol version used for the connection. They should only be called -after the initial handshake has been completed. Prior to that the results -returned from these functions may be unreliable. +For SSL, TLS and DTLS protocols \fBSSL_client_version()\fR returns the numeric +protocol version advertised by the client in the legacy_version field of the +ClientHello when initiating the connection. Note that, for TLS, this value +will never indicate a version greater than TLSv1.2 even if TLSv1.3 is +subsequently negotiated. For QUIC connections it returns OSSL_QUIC1_VERSION. +.PP +\&\fBSSL_get_version()\fR returns the name of the protocol used for the connection. +\&\fBSSL_version()\fR returns the numeric protocol version used for the connection. +They should only be called after the initial handshake has been completed. +Prior to that the results returned from these functions may be unreliable. +.PP +\&\fBSSL_is_dtls()\fR returns 1 if the connection is using DTLS or 0 if not. +.PP +\&\fBSSL_is_tls()\fR returns 1 if the connection is using SSL/TLS or 0 if not. .PP -\&\fBSSL_is_dtls()\fR returns one if the connection is using \s-1DTLS,\s0 zero if not. +\&\fBSSL_is_quic()\fR returns 1 if the connection is using QUIC or 0 if not. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBSSL_get_version()\fR returns one of the following strings: -.IP "SSLv3" 4 +.IP SSLv3 4 .IX Item "SSLv3" The connection uses the SSLv3 protocol. -.IP "TLSv1" 4 +.IP TLSv1 4 .IX Item "TLSv1" The connection uses the TLSv1.0 protocol. -.IP "TLSv1.1" 4 +.IP TLSv1.1 4 .IX Item "TLSv1.1" The connection uses the TLSv1.1 protocol. -.IP "TLSv1.2" 4 +.IP TLSv1.2 4 .IX Item "TLSv1.2" The connection uses the TLSv1.2 protocol. -.IP "TLSv1.3" 4 +.IP TLSv1.3 4 .IX Item "TLSv1.3" The connection uses the TLSv1.3 protocol. -.IP "unknown" 4 +.IP DTLSv0.9 4 +.IX Item "DTLSv0.9" +The connection uses an obsolete pre-standardisation DTLS protocol +.IP DTLSv1 4 +.IX Item "DTLSv1" +The connection uses the DTLSv1 protocol +.IP DTLSv1.2 4 +.IX Item "DTLSv1.2" +The connection uses the DTLSv1.2 protocol +.IP QUICv1 4 +.IX Item "QUICv1" +The connection uses the QUICv1 protocol. +.IP unknown 4 .IX Item "unknown" This indicates an unknown protocol version. .PP \&\fBSSL_version()\fR and \fBSSL_client_version()\fR return an integer which could include any of the following: -.IP "\s-1SSL3_VERSION\s0" 4 +.IP SSL3_VERSION 4 .IX Item "SSL3_VERSION" The connection uses the SSLv3 protocol. -.IP "\s-1TLS1_VERSION\s0" 4 +.IP TLS1_VERSION 4 .IX Item "TLS1_VERSION" The connection uses the TLSv1.0 protocol. -.IP "\s-1TLS1_1_VERSION\s0" 4 +.IP TLS1_1_VERSION 4 .IX Item "TLS1_1_VERSION" The connection uses the TLSv1.1 protocol. -.IP "\s-1TLS1_2_VERSION\s0" 4 +.IP TLS1_2_VERSION 4 .IX Item "TLS1_2_VERSION" The connection uses the TLSv1.2 protocol. -.IP "\s-1TLS1_3_VERSION\s0" 4 +.IP TLS1_3_VERSION 4 .IX Item "TLS1_3_VERSION" The connection uses the TLSv1.3 protocol (never returned for \&\fBSSL_client_version()\fR). +.IP DTLS1_BAD_VER 4 +.IX Item "DTLS1_BAD_VER" +The connection uses an obsolete pre-standardisation DTLS protocol +.IP DTLS1_VERSION 4 +.IX Item "DTLS1_VERSION" +The connection uses the DTLSv1 protocol +.IP DTLS1_2_VERSION 4 +.IX Item "DTLS1_2_VERSION" +The connection uses the DTLSv1.2 protocol +.IP OSSL_QUIC1_VERSION 4 +.IX Item "OSSL_QUIC1_VERSION" +The connection uses the QUICv1 protocol. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBssl\fR\|(7) -.SH "HISTORY" +.SH HISTORY .IX Header "HISTORY" -The \fBSSL_is_dtls()\fR function was added in OpenSSL 1.1.0. -.SH "COPYRIGHT" +The \fBSSL_is_dtls()\fR function was added in OpenSSL 1.1.0. The \fBSSL_is_tls()\fR and +\&\fBSSL_is_quic()\fR functions were added in OpenSSL 3.2. +.SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2001\-2018 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2001\-2023 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy -in the file \s-1LICENSE\s0 in the source distribution or at +in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>. |