From: Frederik Wedel-Heinen Date: Wed, 29 Nov 2023 09:47:31 +0000 (+0100) Subject: Updates SSL_CONF_cmd.pod to be explicit when features are for both TLS and DTLS X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f7553c08cadc6d0db34ad08bc11040d0396758b5;p=thirdparty%2Fopenssl.git Updates SSL_CONF_cmd.pod to be explicit when features are for both TLS and DTLS Reviewed-by: Matt Caswell Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/22363) --- diff --git a/doc/man3/SSL_CONF_cmd.pod b/doc/man3/SSL_CONF_cmd.pod index 5bd78b10ac0..5d18c34bc56 100644 --- a/doc/man3/SSL_CONF_cmd.pod +++ b/doc/man3/SSL_CONF_cmd.pod @@ -74,7 +74,7 @@ B. =item B<-no_renegotiation> -Disables all attempts at renegotiation in TLSv1.2 and earlier, same as setting +Disables all attempts at renegotiation in (D)TLSv1.2 and earlier, same as setting B. =item B<-no_resumption_on_reneg> @@ -95,8 +95,8 @@ Only used by servers. Requires B<-serverpref>. =item B<-allow_no_dhe_kex> -In TLSv1.3 allow a non-(ec)dhe based key exchange mode on resumption. This means -that there will be no forward secrecy for the resumed session. +In (D)TLSv1.3 allow a non-(ec)dhe based key exchange mode on resumption. This +means that there will be no forward secrecy for the resumed session. =item B<-prefer_no_dhe_kex> @@ -111,7 +111,7 @@ B. =item B<-sigalgs> I -This sets the supported signature algorithms for TLSv1.2 and TLSv1.3. +This sets the supported signature algorithms for (D)TLSv1.2 and (D)TLSv1.3. For clients this value is used directly for the supported signature algorithms extension. For servers it is used to determine which signature algorithms to support. @@ -123,7 +123,7 @@ B is one of B, B or B and B is a supported algorithm OID short name such as B, B, B, B or B. Note: algorithm and hash names are case sensitive. B is one of the signature schemes defined in -TLSv1.3, specified using the IETF name, e.g., B, +(D)TLSv1.3, specified using the IETF name, e.g., B, B, or B. Additional providers may make available further algorithms via the TLS-SIGALG capability. See L. @@ -133,12 +133,12 @@ activated providers are permissible. Note: algorithms which specify a PKCS#1 v1.5 signature scheme (either by using B as the B or by using one of the B -identifiers) are ignored in TLSv1.3 and will not be negotiated. +identifiers) are ignored in (D)TLSv1.3 and will not be negotiated. =item B<-client_sigalgs> I This sets the supported signature algorithms associated with client -authentication for TLSv1.2 and TLSv1.3. For servers the B is used +authentication for (D)TLSv1.2 and (D)TLSv1.3. For servers the B is used in the B field of a B message. For clients it is used to determine which signature algorithm to use with the client certificate. If a server does not request a certificate this @@ -151,9 +151,9 @@ value set for B<-sigalgs> will be used instead. This sets the supported groups. For clients, the groups are sent using the supported groups extension. For servers, it is used to determine which -group to use. This setting affects groups used for signatures (in TLSv1.2 +group to use. This setting affects groups used for signatures (in (D)TLSv1.2 and earlier) and key exchange. The first group listed will also be used -for the B sent by a client in a TLSv1.3 B. +for the B sent by a client in a (D)TLSv1.3 B. The B argument is a colon separated list of groups. The group can be either the B name (e.g. B), some other commonly used name @@ -161,7 +161,7 @@ where applicable (e.g. B, B) or an OpenSSL OID name (e.g. B). Group names are case sensitive. The list should be in order of preference with the most preferred group first. -Groups for B in the default provider are B, B, +Groups for B and B in the default provider are B, B, B, B, B, B, B, B, B, B, B, B and B. @@ -179,19 +179,19 @@ by servers. =item B<-tx_cert_comp> -Enables support for sending TLSv1.3 compressed certificates. +Enables support for sending (D)TLSv1.3 compressed certificates. =item B<-no_tx_cert_comp> -Disables support for sending TLSv1.3 compressed certificates. +Disables support for sending (D)TLSv1.3 compressed certificates. =item B<-rx_cert_comp> -Enables support for receiving TLSv1.3 compressed certificates. +Enables support for receiving (D)TLSv1.3 compressed certificates. =item B<-no_rx_cert_comp> -Disables support for receiving TLSv1.3 compressed certificates. +Disables support for receiving (D)TLSv1.3 compressed certificates. =item B<-comp> @@ -202,24 +202,24 @@ curve can be either the B name (e.g. B) or an OpenSSL OID name =item B<-cipher> I -Sets the TLSv1.2 and below ciphersuite list to B. This list will be -combined with any configured TLSv1.3 ciphersuites. Note: syntax checking +Sets the (D)TLSv1.2 and below ciphersuite list to B. This list will be +combined with any configured (D)TLSv1.3 ciphersuites. Note: syntax checking of B is currently not performed unless a B or B structure is associated with B. =item B<-ciphersuites> I<1.3ciphers> -Sets the available ciphersuites for TLSv1.3 to value. This is a -colon-separated list of TLSv1.3 ciphersuite names in order of preference. This -list will be combined any configured TLSv1.2 and below ciphersuites. +Sets the available ciphersuites for (D)TLSv1.3 to value. This is a +colon-separated list of (D)TLSv1.3 ciphersuite names in order of preference. +This list will be combined any configured (D)TLSv1.2 and below ciphersuites. See L for more information. =item B<-min_protocol> I, B<-max_protocol> I Sets the minimum and maximum supported protocol. Currently supported protocol values are B, B, B, -B, B for TLS; B, B for DTLS, and B -for no limit. +B, B for TLS; B, B, B for DTLS, +and B for no limit. If either the lower or upper bound is not specified then only the other bound applies, if specified. If your application supports both TLS and DTLS you can specify any of these @@ -230,15 +230,11 @@ deprecated alternative commands below. =item B<-record_padding> I -Controls use of TLSv1.3 record layer padding. B is a string of the -form "number[,number]" where the (required) first number is the padding block -size (in octets) for application data, and the optional second number is the -padding block size for handshake and alert messages. If the optional second -number is omitted, the same padding will be applied to all messages. - -Padding attempts to pad TLSv1.3 records so that they are a multiple of the set -length on send. A value of 0 or 1 turns off padding as relevant. Otherwise, the -values must be >1 or <=16384. +==== BASE ==== +Attempts to pad TLSv1.3 records so that they are a multiple of B +in length on send. A B of 0 or 1 turns off padding. Otherwise, +the B must be >1 or <=16384. +==== BASE ==== =item B<-debug_broken_protocol> @@ -290,11 +286,11 @@ B<-max_protocol> instead. Switches replay protection, on or off respectively. With replay protection on, OpenSSL will automatically detect if a session ticket has been used more than -once, TLSv1.3 has been negotiated, and early data is enabled on the server. A -full handshake is forced if a session ticket is used a second or subsequent +once, (D)TLSv1.3 has been negotiated, and early data is enabled on the server. +A full handshake is forced if a session ticket is used a second or subsequent time. Anti-Replay is on by default unless overridden by a configuration file and is only used by servers. Anti-replay measures are required for compliance with -the TLSv1.3 specification. Some applications may be able to mitigate the replay +the (D)TLSv1.3 specification. Some applications may be able to mitigate the replay risks in other ways and in such cases the built-in OpenSSL functionality is not required. Switching off anti-replay is equivalent to B. @@ -314,16 +310,16 @@ Note: the command prefix (if set) alters the recognised B