]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Update the documentation for SSL_version et al
authorMatt Caswell <matt@openssl.org>
Thu, 30 Mar 2023 07:52:51 +0000 (08:52 +0100)
committerPauli <pauli@openssl.org>
Mon, 3 Apr 2023 23:06:31 +0000 (09:06 +1000)
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20650)

doc/man3/SSL_get_version.pod

index d12927745a5049091d9933e9022fe9868b83e735..d420ab0b6336d149581a13aea09c75461c5ab43b 100644 (file)
@@ -2,8 +2,8 @@
 
 =head1 NAME
 
-SSL_client_version, SSL_get_version, SSL_is_dtls, SSL_version - get the
-protocol information of a connection
+SSL_client_version, SSL_get_version, SSL_is_dtls, SSL_is_tls, SSL_is_quic,
+SSL_version - get the protocol information of a connection
 
 =head1 SYNOPSIS
 
@@ -14,6 +14,8 @@ 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);
 
@@ -28,7 +30,11 @@ 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 one if the connection is using DTLS, zero if not.
+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.
 
 =head1 RETURN VALUES
 
@@ -57,6 +63,22 @@ The connection uses the TLSv1.2 protocol.
 
 The connection uses the TLSv1.3 protocol.
 
+=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.
+
 =item unknown
 
 This indicates an unknown protocol version.
@@ -89,6 +111,23 @@ The connection uses the TLSv1.2 protocol.
 The connection uses the TLSv1.3 protocol (never returned for
 SSL_client_version()).
 
+=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
+
+The connection uses the QUICv1 protocol (never returned for
+SSL_client_version()).
+
 =back
 
 =head1 SEE ALSO
@@ -97,7 +136,8 @@ L<ssl(7)>
 
 =head1 HISTORY
 
-The SSL_is_dtls() function was added in OpenSSL 1.1.0.
+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.
 
 =head1 COPYRIGHT