]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Update documentation for DTLS1.3
authorFrederik Wedel-Heinen <frederik.wedel-heinen@dencrypt.dk>
Thu, 12 Oct 2023 12:22:40 +0000 (14:22 +0200)
committerTomas Mraz <tomas@openssl.org>
Thu, 9 Jan 2025 16:02:19 +0000 (17:02 +0100)
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22363)

12 files changed:
doc/man1/openssl-s_client.pod.in
doc/man3/SSL_CIPHER_get_name.pod
doc/man3/SSL_CONF_cmd.pod
doc/man3/SSL_CTX_set0_CA_list.pod
doc/man3/SSL_CTX_set1_sigalgs.pod
doc/man3/SSL_CTX_set_min_proto_version.pod
doc/man3/SSL_CTX_set_num_tickets.pod
doc/man3/SSL_CTX_set_options.pod
doc/man3/SSL_check_chain.pod
doc/man3/SSL_export_keying_material.pod
doc/man3/SSL_get_shared_sigalgs.pod
doc/man3/SSL_get_version.pod

index f79ef608d5b00ca81c7582d3974eed1c092b3f75..cafa9718aecc2c924c8c879abd080802d18c7929 100644 (file)
@@ -365,7 +365,7 @@ See L<ossl_store-file(7)> for more information on the C<file:> scheme.
 
 A file containing a list of certificates whose subject names will be sent
 to the server in the B<certificate_authorities> extension. Only supported
-for TLS 1.3
+for TLS 1.3 and DTLS 1.3
 
 =item B<-dane_tlsa_domain> I<domain>
 
index 09b7280bdd581bf0539a3c89a68ee5ce9db33a1b..cfd7ea5d50309c97aab46a61506392ffa7077b40 100644 (file)
@@ -74,7 +74,7 @@ different to the digest used to calculate the MAC for encrypted records.
 
 SSL_CIPHER_get_kx_nid() returns the key exchange NID corresponding to the method
 used by B<c>. If there is no key exchange, then B<NID_undef> is returned.
-If any appropriate key exchange algorithm can be used (as in the case of TLS 1.3
+If any appropriate key exchange algorithm can be used (as in the case of (D)TLS 1.3
 cipher suites) B<NID_kx_any> is returned. Examples (not comprehensive):
 
  NID_kx_rsa
@@ -85,7 +85,7 @@ cipher suites) B<NID_kx_any> is returned. Examples (not comprehensive):
 SSL_CIPHER_get_auth_nid() returns the authentication NID corresponding to the method
 used by B<c>. If there is no authentication, then B<NID_undef> is returned.
 If any appropriate authentication algorithm can be used (as in the case of
-TLS 1.3 cipher suites) B<NID_auth_any> is returned. Examples (not comprehensive):
+(D)TLS 1.3 cipher suites) B<NID_auth_any> is returned. Examples (not comprehensive):
 
  NID_auth_rsa
  NID_auth_ecdsa
index 32d10c3a5b360bde1dbe140dfd3f1fcdffd2968f..5bd78b10ac0d5a087a9e4f2b4924d1db674bc7ec 100644 (file)
@@ -351,7 +351,7 @@ if certificate operations are permitted.
 
 This option indicates a file containing a set of certificates in PEM form.
 The subject names of the certificates are sent to the peer in the
-B<certificate_authorities> extension for TLS 1.3 (in ClientHello or
+B<certificate_authorities> extension for (D)TLS 1.3 (in ClientHello or
 CertificateRequest) or in a certificate request for previous versions or
 TLS.
 
index 64e8117f923614c7ce34aa825ad8c007a70c035f..ce7ed0e6585cb52fbf8f6c3688c1327b30901a03 100644 (file)
@@ -47,7 +47,7 @@ server to the client when requesting a client certificate. So any list of CA
 names set is never sent from client to server and the list of CA names retrieved
 by SSL_get0_peer_CA_list() is always B<NULL>.
 
-For TLS 1.3 the list of CA names is sent using the B<certificate_authorities>
+For (D)TLS 1.3 the list of CA names is sent using the B<certificate_authorities>
 extension and may be sent by a client (in the ClientHello message) or by
 a server (when requesting a certificate).
 
index c384065bfc7e159fe99245bb9754a77bc2251fa6..468edebf9f6e3cb8a203723e24349946b602dc81 100644 (file)
@@ -32,7 +32,7 @@ SSL_CTX_set1_sigalgs_list() and SSL_set1_sigalgs_list() set the supported
 signature algorithms for B<ctx> or B<ssl>. The B<str> parameter
 must be a null terminated string consisting of a colon separated list of
 elements, where each element is either a combination of a public key
-algorithm and a digest separated by B<+>, or a TLS 1.3-style named
+algorithm and a digest separated by B<+>, or a (D)TLS 1.3-style named
 SignatureScheme such as rsa_pss_pss_sha256. If a list entry is preceded
 with the C<?> character, it will be ignored if an implementation is missing.
 
@@ -80,7 +80,7 @@ The short or long name values for digests can be used in a string (for
 example "MD5", "SHA1", "SHA224", "SHA256", "SHA384", "SHA512") and
 the public key algorithm strings "RSA", "RSA-PSS", "DSA" or "ECDSA".
 
-The TLS 1.3 signature scheme names (such as "rsa_pss_pss_sha256") can also
+The (D)TLS 1.3 signature scheme names (such as "rsa_pss_pss_sha256") can also
 be used with the B<_list> forms of the API.
 
 The use of MD5 as a digest is strongly discouraged due to security weaknesses.
index 9a2da37ab72949d8dd31938606ba7696c5922df1..34b7a40cf3c3966301786d702601cb059574b075 100644 (file)
@@ -40,7 +40,7 @@ automatically use the lowest or highest version supported by the library.
 
 Currently supported versions are B<SSL3_VERSION>, B<TLS1_VERSION>,
 B<TLS1_1_VERSION>, B<TLS1_2_VERSION>, B<TLS1_3_VERSION> for TLS and
-B<DTLS1_VERSION>, B<DTLS1_2_VERSION> for DTLS.
+B<DTLS1_VERSION>, B<DTLS1_2_VERSION>, B<DTLS1_3_VERSION> for DTLS.
 
 In the current version of OpenSSL only QUICv1 is supported in conjunction with
 TLSv1.3. Calling these functions on a QUIC object has no effect.
index 0c7331bc6da94b8ccf5060a2614a75e2bb8f1cdc..e81679e609a050be97d052bd26d51366478b87a6 100644 (file)
@@ -46,7 +46,7 @@ To issue tickets after other events (such as application-layer changes),
 SSL_new_session_ticket() is used by a server application to request that a new
 ticket be sent when it is safe to do so.  New tickets are only allowed to be
 sent in this manner after the initial handshake has completed, and only for
-TLS 1.3 connections.  By default, the ticket generation and transmission are
+(D)TLS 1.3 connections.  By default, the ticket generation and transmission are
 delayed until the server is starting a new write operation, so that it is
 bundled with other application data being written and properly aligned to a
 record boundary.  If the connection was at a record boundary when
index a6c922ecf92cc0013feef06c10623c416308fb42..dfe139065bc0f163c3409a193d43e63c76d60de4 100644 (file)
@@ -296,10 +296,11 @@ When performing renegotiation as a server, always start a new session
 handshake). This option is not needed for clients.
 
 =item SSL_OP_NO_SSLv3, SSL_OP_NO_TLSv1, SSL_OP_NO_TLSv1_1,
-SSL_OP_NO_TLSv1_2, SSL_OP_NO_TLSv1_3, SSL_OP_NO_DTLSv1, SSL_OP_NO_DTLSv1_2
+SSL_OP_NO_TLSv1_2, SSL_OP_NO_TLSv1_3,
+SSL_OP_NO_DTLSv1, SSL_OP_NO_DTLSv1_2, SSL_OP_NO_DTLSv1_3
 
 These options turn off the SSLv3, TLSv1, TLSv1.1, TLSv1.2 or TLSv1.3 protocol
-versions with TLS or the DTLSv1, DTLSv1.2 versions with DTLS,
+versions with TLS or the DTLSv1, DTLSv1.2, DTLSv1.3 versions with DTLS,
 respectively.
 As of OpenSSL 1.1.0, these options are deprecated, use
 L<SSL_CTX_set_min_proto_version(3)> and
index d00badbd753f0560eb9dab0def2a8b74c1cc35f0..e90ab0dd6fa2fd5c5d4389c0f915b67b3a01d1da 100644 (file)
@@ -72,8 +72,8 @@ The validity of a chain is determined by checking if it matches a supported
 signature algorithm, supported curves and in the case of client authentication
 certificate types and issuer names.
 
-Since the supported signature algorithms extension is only used in TLS 1.2,
-TLS 1.3 and DTLS 1.2 the results for earlier versions of TLS and DTLS may not
+Since the supported signature algorithms extension is only used in (D)TLS 1.2
+and (D)TLS 1.3 the results for earlier versions of TLS and DTLS may not
 be very useful. Applications may wish to specify a different "legacy" chain
 for earlier versions of TLS or DTLS.
 
index c7c5320295e6474519b7fef9ee8760475fa9479c..a0b54d70da2e2644c63e60bbb9fdb5f815824973 100644 (file)
@@ -31,7 +31,7 @@ accordance with RFC5705 (for TLSv1.2 and below) or RFC8446 (for TLSv1.3).
 SSL_export_keying_material() derives keying material using
 the F<exporter_master_secret> established in the handshake.
 
-SSL_export_keying_material_early() is only usable with TLSv1.3, and derives
+SSL_export_keying_material_early() is only usable with (D)TLSv1.3, and derives
 keying material using the F<early_exporter_master_secret> (as defined in the
 TLS 1.3 RFC). For the client, the F<early_exporter_master_secret> is only
 available when the client attempts to send 0-RTT data. For the server, it is
index cb9ce025002fed99eee61d1dd8cc556b762930cf..1dbf422652752ca71ce87dc3083e7b02e0657d75 100644 (file)
@@ -54,7 +54,7 @@ signature algorithms: after a client hello (for servers) or a certificate
 request (for clients). They can (for example) be called in the certificate
 callback.
 
-Only TLS 1.2, TLS 1.3 and DTLS 1.2 currently support signature algorithms.
+Only (D)TLS 1.2 and (D)TLS 1.3 currently support signature algorithms.
 If these
 functions are called on an earlier version of TLS or DTLS zero is returned.
 
index b8a0f5e3b15de0250beab3787f534351ec3a92ca..a6f5e7fb84bbcca03115d73a851baec61acfcd1f 100644 (file)
@@ -125,6 +125,10 @@ The connection uses the DTLSv1 protocol
 
 The connection uses the DTLSv1.2 protocol
 
+=item DTLS1_3_VERSION
+
+The connection uses the DTLSv1.3 protocol
+
 =item OSSL_QUIC1_VERSION
 
 The connection uses the QUICv1 protocol.