mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2024-12-27 06:21:43 +08:00
Code Issues Packages Projects Releases Wiki Activity
6f22bcd631
openssl/doc/man3/SSL_get_version.pod

153 lines
3.2 KiB
Plaintext
Raw Normal View History

SSL_get_version() was an easy one :-)
2001-02-24 05:05:56 +08:00
=pod
=head1 NAME
Update the documentation for SSL_version et al Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20650)
2023-03-30 15:52:51 +08:00
SSL_client_version, SSL_get_version, SSL_is_dtls, SSL_is_tls, SSL_is_quic,
SSL_version - get the protocol information of a connection
SSL_get_version() was an easy one :-)
2001-02-24 05:05:56 +08:00
=head1 SYNOPSIS
#include <openssl/ssl.h>
Add documentation for SSL version methods [skip ci] Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3049)
2017-03-28 13:33:54 +08:00
int SSL_client_version(const SSL *s);
update docs (recent constification)
2005-03-30 19:50:14 +08:00
const char *SSL_get_version(const SSL *ssl);
SSL_get_version() was an easy one :-)
2001-02-24 05:05:56 +08:00
Add some accessor API's GH1098: Add X509_get_pathlen() (and a test) GH1097: Add SSL_is_dtls() function. Documented. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-06-08 23:37:06 +08:00
int SSL_is_dtls(const SSL *ssl);
Update the documentation for SSL_version et al Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20650)
2023-03-30 15:52:51 +08:00
int SSL_is_tls(const SSL *ssl);
int SSL_is_quic(const SSL *ssl);
Add some accessor API's GH1098: Add X509_get_pathlen() (and a test) GH1097: Add SSL_is_dtls() function. Documented. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-06-08 23:37:06 +08:00
Add documentation for SSL version methods [skip ci] Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3049)
2017-03-28 13:33:54 +08:00
int SSL_version(const SSL *s);
SSL_get_version() was an easy one :-)
2001-02-24 05:05:56 +08:00
=head1 DESCRIPTION
Resolve some of the TODO(QUIC) items For some of the items we add FUTURE/SERVER/TESTING/MULTIPATH designation to indicate these do not need to be resolved in QUIC MVP release. Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Hugo Landau <hlandau@openssl.org> (Merged from https://github.com/openssl/openssl/pull/21539)
2023-07-25 00:05:47 +08:00
For SSL, TLS and DTLS protocols SSL_client_version() 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.
SSL_get_version() returns the name of the protocol used for the connection.
SSL_version() 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.
SSL_get_version() was an easy one :-)
2001-02-24 05:05:56 +08:00
Update the documentation for SSL_version et al Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20650)
2023-03-30 15:52:51 +08:00
SSL_is_dtls() returns 1 if the connection is using DTLS or 0 if not.
SSL_is_tls() returns 1 if the connection is using SSL/TLS or 0 if not.
SSL_is_quic() returns 1 if the connection is using QUIC or 0 if not.
Add some accessor API's GH1098: Add X509_get_pathlen() (and a test) GH1097: Add SSL_is_dtls() function. Documented. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-06-08 23:37:06 +08:00
SSL_get_version() was an easy one :-)
2001-02-24 05:05:56 +08:00
=head1 RETURN VALUES
Clarify the return value of SSL_client_version() The SSL_client_version() function returns the value held in the legacy_version field of the ClientHello. This is never greater than TLSv1.2, even if TLSv1.3 later gets negotiated. Fixes #7079 Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/7095)
2018-09-03 18:57:33 +08:00
More API docs; small changes. Also fix typo noted on GitHub. Suppport typedef and #define to find-doc-nits Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-06-10 05:02:59 +08:00
SSL_get_version() returns one of the following strings:
SSL_get_version() was an easy one :-)
2001-02-24 05:05:56 +08:00
=over 4
=item SSLv3
The connection uses the SSLv3 protocol.
=item TLSv1
Close a whole bunch of documentation-related tickets: 298 424 656 882 939 1630 1807 2263 2294 2311 2424 2623 2637 2686 2697 2921 2922 2940 3055 3112 3156 3177 3277
2014-07-03 10:42:40 +08:00
The connection uses the TLSv1.0 protocol.
=item TLSv1.1
The connection uses the TLSv1.1 protocol.
=item TLSv1.2
The connection uses the TLSv1.2 protocol.
SSL_get_version() was an easy one :-)
2001-02-24 05:05:56 +08:00
Add documentation for SSL version methods [skip ci] Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3049)
2017-03-28 13:33:54 +08:00
=item TLSv1.3
The connection uses the TLSv1.3 protocol.
Update the documentation for SSL_version et al Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20650)
2023-03-30 15:52:51 +08:00
=item DTLSv0.9
The connection uses an obsolete pre-standardisation DTLS protocol
=item DTLSv1
The connection uses the DTLSv1 protocol
=item DTLSv1.2
The connection uses the DTLSv1.2 protocol
=item QUICv1
The connection uses the QUICv1 protocol.
SSL_get_version() was an easy one :-)
2001-02-24 05:05:56 +08:00
=item unknown
Update version docs Make it clear that you should not attempt to get the version before the first handshake is complete. Fixes #2893 Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/6013)
2018-04-19 20:32:45 +08:00
This indicates an unknown protocol version.
SSL_get_version() was an easy one :-)
2001-02-24 05:05:56 +08:00
=back
Clarify the return value of SSL_client_version() The SSL_client_version() function returns the value held in the legacy_version field of the ClientHello. This is never greater than TLSv1.2, even if TLSv1.3 later gets negotiated. Fixes #7079 Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/7095)
2018-09-03 18:57:33 +08:00
SSL_version() and SSL_client_version() return an integer which could include any
of the following:
Add documentation for SSL version methods [skip ci] Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3049)
2017-03-28 13:33:54 +08:00
Standardize on =over 4 and check for it. Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3117)
2017-04-04 03:39:09 +08:00
=over 4
Add documentation for SSL version methods [skip ci] Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3049)
2017-03-28 13:33:54 +08:00
=item SSL3_VERSION
The connection uses the SSLv3 protocol.
=item TLS1_VERSION
The connection uses the TLSv1.0 protocol.
=item TLS1_1_VERSION
The connection uses the TLSv1.1 protocol.
=item TLS1_2_VERSION
The connection uses the TLSv1.2 protocol.
=item TLS1_3_VERSION
Clarify the return value of SSL_client_version() The SSL_client_version() function returns the value held in the legacy_version field of the ClientHello. This is never greater than TLSv1.2, even if TLSv1.3 later gets negotiated. Fixes #7079 Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/7095)
2018-09-03 18:57:33 +08:00
The connection uses the TLSv1.3 protocol (never returned for
SSL_client_version()).
Add documentation for SSL version methods [skip ci] Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3049)
2017-03-28 13:33:54 +08:00
Update the documentation for SSL_version et al Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20650)
2023-03-30 15:52:51 +08:00
=item DTLS1_BAD_VER
The connection uses an obsolete pre-standardisation DTLS protocol
=item DTLS1_VERSION
The connection uses the DTLSv1 protocol
=item DTLS1_2_VERSION
The connection uses the DTLSv1.2 protocol
=item OSSL_QUIC1_VERSION
Resolve some of the TODO(QUIC) items For some of the items we add FUTURE/SERVER/TESTING/MULTIPATH designation to indicate these do not need to be resolved in QUIC MVP release. Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Hugo Landau <hlandau@openssl.org> (Merged from https://github.com/openssl/openssl/pull/21539)
2023-07-25 00:05:47 +08:00
The connection uses the QUICv1 protocol.
Update the documentation for SSL_version et al Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20650)
2023-03-30 15:52:51 +08:00
Add missing =back Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3117)
2017-04-04 03:30:20 +08:00
=back
SSL_get_version() was an easy one :-)
2001-02-24 05:05:56 +08:00
=head1 SEE ALSO
Fix referenses in section 3 manuals Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1900)
2016-11-11 16:33:09 +08:00
L<ssl(7)>
SSL_get_version() was an easy one :-)
2001-02-24 05:05:56 +08:00
Add some accessor API's GH1098: Add X509_get_pathlen() (and a test) GH1097: Add SSL_is_dtls() function. Documented. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-06-08 23:37:06 +08:00
=head1 HISTORY
Update the documentation for SSL_version et al Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/20650)
2023-03-30 15:52:51 +08:00
The SSL_is_dtls() function was added in OpenSSL 1.1.0. The SSL_is_tls() and
SSL_is_quic() functions were added in OpenSSL 3.2.
Add some accessor API's GH1098: Add X509_get_pathlen() (and a test) GH1097: Add SSL_is_dtls() function. Documented. Reviewed-by: Matt Caswell <matt@openssl.org>
2016-06-08 23:37:06 +08:00
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
=head1 COPYRIGHT
Copyright year updates Reviewed-by: Richard Levitte <levitte@openssl.org> Release: yes
2023-09-07 16:59:15 +08:00
Copyright 2001-2023 The OpenSSL Project Authors. All Rights Reserved.
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
Following the license change, modify the boilerplates in doc/man3/ [skip ci] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7829)
2018-12-06 21:04:44 +08:00
Licensed under the Apache License 2.0 (the "License"). You may not use
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 23:44:05 +08:00
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut
Reference in New Issue Copy Permalink