Resolve some of the TODO(QUIC) items
[openssl.git] / doc / man3 / SSL_get_version.pod
index d420ab0b6336d149581a13aea09c75461c5ab43b..04b8eea61d4e465fd06d6163be67cd72121f04b8 100644 (file)
@@ -21,14 +21,16 @@ SSL_version - get the protocol information of a connection
 
 =head1 DESCRIPTION
 
-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. 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.
+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_is_dtls() returns 1 if the connection is using DTLS or 0 if not.
 
@@ -125,8 +127,7 @@ The connection uses the DTLSv1.2 protocol
 
 =item OSSL_QUIC1_VERSION
 
-The connection uses the QUICv1 protocol (never returned for
-SSL_client_version()).
+The connection uses the QUICv1 protocol.
 
 =back