doc/man3/SSL_CONF_cmd.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CONF_cmd_value_type,
   6 SSL_CONF_cmd - send configuration command
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/ssl.h>
  11
  12  int SSL_CONF_cmd(SSL_CONF_CTX *cctx, const char *cmd, const char *value);
  13  int SSL_CONF_cmd_value_type(SSL_CONF_CTX *cctx, const char *cmd);
  14
  15 =head1 DESCRIPTION
  16
  17 The function SSL_CONF_cmd() performs configuration operation B<cmd> with
  18 optional parameter B<value> on B<ctx>. Its purpose is to simplify application
  19 configuration of B<SSL_CTX> or B<SSL> structures by providing a common
  20 framework for command line options or configuration files.
  21
  22 SSL_CONF_cmd_value_type() returns the type of value that B<cmd> refers to.
  23
  24 =head1 SUPPORTED COMMAND LINE COMMANDS
  25
  26 Currently supported B<cmd> names for command lines (i.e. when the
  27 flag B<SSL_CONF_CMDLINE> is set) are listed below. Note: all B<cmd> names
  28 are case sensitive. Unless otherwise stated commands can be used by
  29 both clients and servers and the B<value> parameter is not used. The default
  30 prefix for command line commands is B<-> and that is reflected below.
  31
  32 =over 4
  33
  34 =item B<-sigalgs>
  35
  36 This sets the supported signature algorithms for TLS v1.2. For clients this
  37 value is used directly for the supported signature algorithms extension. For
  38 servers it is used to determine which signature algorithms to support.
  39
  40 The B<value> argument should be a colon separated list of signature algorithms
  41 in order of decreasing preference of the form B<algorithm+hash>. B<algorithm>
  42 is one of B<RSA>, B<DSA> or B<ECDSA> and B<hash> is a supported algorithm
  43 OID short name such as B<SHA1>, B<SHA224>, B<SHA256>, B<SHA384> of B<SHA512>.
  44 Note: algorithm and hash names are case sensitive.
  45
  46 If this option is not set then all signature algorithms supported by the
  47 OpenSSL library are permissible.
  48
  49 =item B<-client_sigalgs>
  50
  51 This sets the supported signature algorithms associated with client
  52 authentication for TLS v1.2. For servers the value is used in the supported
  53 signature algorithms field of a certificate request. For clients it is
  54 used to determine which signature algorithm to with the client certificate.
  55 If a server does not request a certificate this option has no effect.
  56
  57 The syntax of B<value> is identical to B<-sigalgs>. If not set then
  58 the value set for B<-sigalgs> will be used instead.
  59
  60 =item B<-groups>
  61
  62 This sets the supported groups. For clients, the groups are
  63 sent using the supported groups extension. For servers, it is used
  64 to determine which group to use. This setting affects groups used for both
  65 signatures and key exchange, if applicable. It also affects the preferred
  66 key_share sent by a client in a TLSv1.3 compatible connection.
  67
  68 The B<value> argument is a colon separated list of groups. The group can be
  69 either the B<NIST> name (e.g. B<P-256>), some other commonly used name where
  70 applicable (e.g. B<X25519>) or an OpenSSL OID name (e.g B<prime256v1>). Group
  71 names are case sensitive. The list should be in order of preference with the
  72 most preferred group first. The first listed group will be the one used for a
  73 key_share by a TLSv1.3 client.
  74
  75 =item B<-curves>
  76
  77 This is a synonym for the "-groups" command.
  78
  79
  80 =item B<-named_curve>
  81
  82 This sets the temporary curve used for ephemeral ECDH modes. Only used by
  83 servers
  84
  85 The B<value> argument is a curve name or the special value B<auto> which
  86 picks an appropriate curve based on client and server preferences. The curve
  87 can be either the B<NIST> name (e.g. B<P-256>) or an OpenSSL OID name
  88 (e.g B<prime256v1>). Curve names are case sensitive.
  89
  90 =item B<-cipher>
  91
  92 Sets the TLSv1.2 and below ciphersuite list to B<value>. This list will be
  93 combined with any configured TLSv1.3 ciphersuites. Note: syntax checking
  94 of B<value> is currently not performed unless a B<SSL> or B<SSL_CTX> structure is
  95 associated with B<cctx>.
  96
  97 =item B<-ciphersuites>
  98
  99 Sets the available ciphersuites for TLSv1.3 to value. This is a simple colon
 100 (":") separated list of TLSv1.3 ciphersuite names in order of preference. This
 101 list will be combined any configured TLSv1.2 and below ciphersuites.
 102
 103
 104 =item B<-cert>
 105
 106 Attempts to use the file B<value> as the certificate for the appropriate
 107 context. It currently uses SSL_CTX_use_certificate_chain_file() if an B<SSL_CTX>
 108 structure is set or SSL_use_certificate_file() with filetype PEM if an B<SSL>
 109 structure is set. This option is only supported if certificate operations
 110 are permitted.
 111
 112 =item B<-key>
 113
 114 Attempts to use the file B<value> as the private key for the appropriate
 115 context. This option is only supported if certificate operations
 116 are permitted. Note: if no B<-key> option is set then a private key is
 117 not loaded unless the flag B<SSL_CONF_FLAG_REQUIRE_PRIVATE> is set.
 118
 119 =item B<-dhparam>
 120
 121 Attempts to use the file B<value> as the set of temporary DH parameters for
 122 the appropriate context. This option is only supported if certificate
 123 operations are permitted.
 124
 125 =item B<-record_padding>
 126
 127 Attempts to pad TLS 1.3 records so that they are a multiple of B<value> in
 128 length on send. A B<value> of 0 or 1 turns off padding. Otherwise, the
 129 B<value> must be >1 or <=16384.
 130
 131 =item B<-no_renegotiation>
 132
 133 Disables all attempts at renegotiation in TLSv1.2 and earlier, same as setting
 134 B<SSL_OP_NO_RENEGOTIATION>.
 135
 136 =item B<-min_protocol>, B<-max_protocol>
 137
 138 Sets the minimum and maximum supported protocol.
 139 Currently supported protocol values are B<SSLv3>, B<TLSv1>,
 140 B<TLSv1.1>, B<TLSv1.2> for TLS and B<DTLSv1>, B<DTLSv1.2> for DTLS,
 141 and B<None> for no limit.
 142 If the either bound is not specified then only the other bound applies,
 143 if specified.
 144 To restrict the supported protocol versions use these commands rather
 145 than the deprecated alternative commands below.
 146
 147 =item B<-no_ssl3>, B<-no_tls1>, B<-no_tls1_1>, B<-no_tls1_2>, B<-no_tls1_3>
 148
 149 Disables protocol support for SSLv3, TLSv1.0, TLSv1.1, TLSv1.2 or TLSv1.3 by
 150 setting the corresponding options B<SSL_OP_NO_SSLv3>, B<SSL_OP_NO_TLSv1>,
 151 B<SSL_OP_NO_TLSv1_1>, B<SSL_OP_NO_TLSv1_2> and B<SSL_OP_NO_TLSv1_3>
 152 respectively. These options are deprecated, instead use B<-min_protocol> and
 153 B<-max_protocol>.
 154
 155 =item B<-bugs>
 156
 157 Various bug workarounds are set, same as setting B<SSL_OP_ALL>.
 158
 159 =item B<-comp>
 160
 161 Enables support for SSL/TLS compression, same as clearing
 162 B<SSL_OP_NO_COMPRESSION>.
 163 This command was introduced in OpenSSL 1.1.0.
 164 As of OpenSSL 1.1.0, compression is off by default.
 165
 166 =item B<-no_comp>
 167
 168 Disables support for SSL/TLS compression, same as setting
 169 B<SSL_OP_NO_COMPRESSION>.
 170 As of OpenSSL 1.1.0, compression is off by default.
 171
 172 =item B<-no_ticket>
 173
 174 Disables support for session tickets, same as setting B<SSL_OP_NO_TICKET>.
 175
 176 =item B<-serverpref>
 177
 178 Use server and not client preference order when determining which cipher suite,
 179 signature algorithm or elliptic curve to use for an incoming connection.
 180 Equivalent to B<SSL_OP_CIPHER_SERVER_PREFERENCE>. Only used by servers.
 181
 182 =item B<-prioritize_chacha>
 183
 184 Prioritize ChaCha ciphers when the client has a ChaCha20 cipher at the top of
 185 its preference list. This usually indicates a client without AES hardware
 186 acceleration (e.g. mobile) is in use. Equivalent to B<SSL_OP_PRIORITIZE_CHACHA>.
 187 Only used by servers. Requires B<-serverpref>.
 188
 189 =item B<-no_resumption_on_reneg>
 190
 191 set SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION flag. Only used by servers.
 192
 193 =item B<-legacyrenegotiation>
 194
 195 permits the use of unsafe legacy renegotiation. Equivalent to setting
 196 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION>.
 197
 198 =item B<-legacy_server_connect>, B<-no_legacy_server_connect>
 199
 200 permits or prohibits the use of unsafe legacy renegotiation for OpenSSL
 201 clients only. Equivalent to setting or clearing B<SSL_OP_LEGACY_SERVER_CONNECT>.
 202 Set by default.
 203
 204 =item B<-allow_no_dhe_kex>
 205
 206 In TLSv1.3 allow a non-(ec)dhe based key exchange mode on resumption. This means
 207 that there will be no forward secrecy for the resumed session.
 208
 209 =item B<-strict>
 210
 211 enables strict mode protocol handling. Equivalent to setting
 212 B<SSL_CERT_FLAG_TLS_STRICT>.
 213
 214 =item B<-anti_replay>, B<-no_anti_replay>
 215
 216 Switches replay protection, on or off respectively. With replay protection on,
 217 OpenSSL will automatically detect if a session ticket has been used more than
 218 once, TLSv1.3 has been negotiated, and early data is enabled on the server. A
 219 full handshake is forced if a session ticket is used a second or subsequent
 220 time. Anti-Replay is on by default unless overridden by a configuration file and
 221 is only used by servers. Anti-replay measures are required for compliance with
 222 the TLSv1.3 specification. Some applications may be able to mitigate the replay
 223 risks in other ways and in such cases the built-in OpenSSL functionality is not
 224 required. Switching off anti-replay is equivalent to B<SSL_OP_NO_ANTI_REPLAY>.
 225
 226 =back
 227
 228 =head1 SUPPORTED CONFIGURATION FILE COMMANDS
 229
 230 Currently supported B<cmd> names for configuration files (i.e. when the
 231 flag B<SSL_CONF_FLAG_FILE> is set) are listed below. All configuration file
 232 B<cmd> names are case insensitive so B<signaturealgorithms> is recognised
 233 as well as B<SignatureAlgorithms>. Unless otherwise stated the B<value> names
 234 are also case insensitive.
 235
 236 Note: the command prefix (if set) alters the recognised B<cmd> values.
 237
 238 =over 4
 239
 240 =item B<CipherString>
 241
 242 Sets the ciphersuite list for TLSv1.2 and below to B<value>. This list will be
 243 combined with any configured TLSv1.3 ciphersuites. Note: syntax
 244 checking of B<value> is currently not performed unless an B<SSL> or B<SSL_CTX>
 245 structure is associated with B<cctx>.
 246
 247 =item B<Ciphersuites>
 248
 249 Sets the available ciphersuites for TLSv1.3 to B<value>. This is a simple colon
 250 (":") separated list of TLSv1.3 ciphersuite names in order of preference. This
 251 list will be combined any configured TLSv1.2 and below ciphersuites.
 252
 253 =item B<Certificate>
 254
 255 Attempts to use the file B<value> as the certificate for the appropriate
 256 context. It currently uses SSL_CTX_use_certificate_chain_file() if an B<SSL_CTX>
 257 structure is set or SSL_use_certificate_file() with filetype PEM if an B<SSL>
 258 structure is set. This option is only supported if certificate operations
 259 are permitted.
 260
 261 =item B<PrivateKey>
 262
 263 Attempts to use the file B<value> as the private key for the appropriate
 264 context. This option is only supported if certificate operations
 265 are permitted. Note: if no B<PrivateKey> option is set then a private key is
 266 not loaded unless the B<SSL_CONF_FLAG_REQUIRE_PRIVATE> is set.
 267
 268 =item B<ChainCAFile>, B<ChainCAPath>, B<VerifyCAFile>, B<VerifyCAPath>
 269
 270 These options indicate a file or directory used for building certificate
 271 chains or verifying certificate chains. These options are only supported
 272 if certificate operations are permitted.
 273
 274 =item B<RequestCAFile>
 275
 276 This option indicates a file containing a set of certificates in PEM form.
 277 The subject names of the certificates are sent to the peer in the
 278 B<certificate_authorities> extension for TLS 1.3 (in ClientHello or
 279 CertificateRequest) or in a certificate request for previous versions or
 280 TLS.
 281
 282 =item B<ServerInfoFile>
 283
 284 Attempts to use the file B<value> in the "serverinfo" extension using the
 285 function SSL_CTX_use_serverinfo_file.
 286
 287 =item B<DHParameters>
 288
 289 Attempts to use the file B<value> as the set of temporary DH parameters for
 290 the appropriate context. This option is only supported if certificate
 291 operations are permitted.
 292
 293 =item B<RecordPadding>
 294
 295 Attempts to pad TLS 1.3 records so that they are a multiple of B<value> in
 296 length on send. A B<value> of 0 or 1 turns off padding. Otherwise, the
 297 B<value> must be >1 or <=16384.
 298
 299 =item B<NoRenegotiation>
 300
 301 Disables all attempts at renegotiation in TLSv1.2 and earlier, same as setting
 302 B<SSL_OP_NO_RENEGOTIATION>.
 303
 304 =item B<SignatureAlgorithms>
 305
 306 This sets the supported signature algorithms for TLS v1.2. For clients this
 307 value is used directly for the supported signature algorithms extension. For
 308 servers it is used to determine which signature algorithms to support.
 309
 310 The B<value> argument should be a colon separated list of signature algorithms
 311 in order of decreasing preference of the form B<algorithm+hash>. B<algorithm>
 312 is one of B<RSA>, B<DSA> or B<ECDSA> and B<hash> is a supported algorithm
 313 OID short name such as B<SHA1>, B<SHA224>, B<SHA256>, B<SHA384> of B<SHA512>.
 314 Note: algorithm and hash names are case sensitive.
 315
 316 If this option is not set then all signature algorithms supported by the
 317 OpenSSL library are permissible.
 318
 319 =item B<ClientSignatureAlgorithms>
 320
 321 This sets the supported signature algorithms associated with client
 322 authentication for TLS v1.2. For servers the value is used in the supported
 323 signature algorithms field of a certificate request. For clients it is
 324 used to determine which signature algorithm to with the client certificate.
 325
 326 The syntax of B<value> is identical to B<SignatureAlgorithms>. If not set then
 327 the value set for B<SignatureAlgorithms> will be used instead.
 328
 329 =item B<Groups>
 330
 331 This sets the supported groups. For clients, the groups are
 332 sent using the supported groups extension. For servers, it is used
 333 to determine which group to use. This setting affects groups used for both
 334 signatures and key exchange, if applicable. It also affects the preferred
 335 key_share sent by a client in a TLSv1.3 compatible connection.
 336
 337 The B<value> argument is a colon separated list of groups. The group can be
 338 either the B<NIST> name (e.g. B<P-256>), some other commonly used name where
 339 applicable (e.g. B<X25519>) or an OpenSSL OID name (e.g B<prime256v1>). Group
 340 names are case sensitive. The list should be in order of preference with the
 341 most preferred group first. The first listed group will be the one used for a
 342 key_share by a TLSv1.3 client.
 343
 344 =item B<Curves>
 345
 346 This is a synonym for the "Groups" command.
 347
 348 =item B<MinProtocol>
 349
 350 This sets the minimum supported SSL, TLS or DTLS version.
 351
 352 Currently supported protocol values are B<SSLv3>, B<TLSv1>, B<TLSv1.1>,
 353 B<TLSv1.2>, B<DTLSv1> and B<DTLSv1.2>.
 354 The value B<None> will disable the limit.
 355
 356 =item B<MaxProtocol>
 357
 358 This sets the maximum supported SSL, TLS or DTLS version.
 359
 360 Currently supported protocol values are B<SSLv3>, B<TLSv1>, B<TLSv1.1>,
 361 B<TLSv1.2>, B<DTLSv1> and B<DTLSv1.2>.
 362 The value B<None> will disable the limit.
 363
 364 =item B<Protocol>
 365
 366 This can be used to enable or disable certain versions of the SSL,
 367 TLS or DTLS protocol.
 368
 369 The B<value> argument is a comma separated list of supported protocols
 370 to enable or disable.
 371 If a protocol is preceded by B<-> that version is disabled.
 372
 373 All protocol versions are enabled by default.
 374 You need to disable at least one protocol version for this setting have any
 375 effect.
 376 Only enabling some protocol versions does not disable the other protocol
 377 versions.
 378
 379 Currently supported protocol values are B<SSLv3>, B<TLSv1>, B<TLSv1.1>,
 380 B<TLSv1.2>, B<DTLSv1> and B<DTLSv1.2>.
 381 The special value B<ALL> refers to all supported versions.
 382
 383 This can't enable protocols that are disabled using B<MinProtocol>
 384 or B<MaxProtocol>, but can disable protocols that are still allowed
 385 by them.
 386
 387 The B<Protocol> command is fragile and deprecated; do not use it.
 388 Use B<MinProtocol> and B<MaxProtocol> instead.
 389 If you do use B<Protocol>, make sure that the resulting range of enabled
 390 protocols has no "holes", e.g. if TLS 1.0 and TLS 1.2 are both enabled, make
 391 sure to also leave TLS 1.1 enabled.
 392
 393 =item B<Options>
 394
 395 The B<value> argument is a comma separated list of various flags to set.
 396 If a flag string is preceded B<-> it is disabled.
 397 See the L<SSL_CTX_set_options(3)> function for more details of
 398 individual options.
 399
 400 Each option is listed below. Where an operation is enabled by default
 401 the B<-flag> syntax is needed to disable it.
 402
 403 B<SessionTicket>: session ticket support, enabled by default. Inverse of
 404 B<SSL_OP_NO_TICKET>: that is B<-SessionTicket> is the same as setting
 405 B<SSL_OP_NO_TICKET>.
 406
 407 B<Compression>: SSL/TLS compression support, enabled by default. Inverse
 408 of B<SSL_OP_NO_COMPRESSION>.
 409
 410 B<EmptyFragments>: use empty fragments as a countermeasure against a
 411 SSL 3.0/TLS 1.0 protocol vulnerability affecting CBC ciphers. It
 412 is set by default. Inverse of B<SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS>.
 413
 414 B<Bugs>: enable various bug workarounds. Same as B<SSL_OP_ALL>.
 415
 416 B<DHSingle>: enable single use DH keys, set by default. Inverse of
 417 B<SSL_OP_DH_SINGLE>. Only used by servers.
 418
 419 B<ECDHSingle>: enable single use ECDH keys, set by default. Inverse of
 420 B<SSL_OP_ECDH_SINGLE>. Only used by servers.
 421
 422 B<ServerPreference>: use server and not client preference order when
 423 determining which cipher suite, signature algorithm or elliptic curve
 424 to use for an incoming connection.  Equivalent to
 425 B<SSL_OP_CIPHER_SERVER_PREFERENCE>. Only used by servers.
 426
 427 B<PrioritizeChaCha>: prioritizes ChaCha ciphers when the client has a
 428 ChaCha20 cipher at the top of its preference list. This usually indicates
 429 a mobile client is in use. Equivalent to B<SSL_OP_PRIORITIZE_CHACHA>.
 430 Only used by servers.
 431
 432 B<NoResumptionOnRenegotiation>: set
 433 B<SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION> flag. Only used by servers.
 434
 435 B<UnsafeLegacyRenegotiation>: permits the use of unsafe legacy renegotiation.
 436 Equivalent to B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION>.
 437
 438 B<UnsafeLegacyServerConnect>: permits the use of unsafe legacy renegotiation
 439 for OpenSSL clients only. Equivalent to B<SSL_OP_LEGACY_SERVER_CONNECT>.
 440 Set by default.
 441
 442 B<EncryptThenMac>: use encrypt-then-mac extension, enabled by
 443 default. Inverse of B<SSL_OP_NO_ENCRYPT_THEN_MAC>: that is,
 444 B<-EncryptThenMac> is the same as setting B<SSL_OP_NO_ENCRYPT_THEN_MAC>.
 445
 446 B<AllowNoDHEKEX>: In TLSv1.3 allow a non-(ec)dhe based key exchange mode on
 447 resumption. This means that there will be no forward secrecy for the resumed
 448 session. Equivalent to B<SSL_OP_ALLOW_NO_DHE_KEX>.
 449
 450 B<MiddleboxCompat>: If set then dummy Change Cipher Spec (CCS) messages are sent
 451 in TLSv1.3. This has the effect of making TLSv1.3 look more like TLSv1.2 so that
 452 middleboxes that do not understand TLSv1.3 will not drop the connection. This
 453 option is set by default. A future version of OpenSSL may not set this by
 454 default. Equivalent to B<SSL_OP_ENABLE_MIDDLEBOX_COMPAT>.
 455
 456 B<AntiReplay>: If set then OpenSSL will automatically detect if a session ticket
 457 has been used more than once, TLSv1.3 has been negotiated, and early data is
 458 enabled on the server. A full handshake is forced if a session ticket is used a
 459 second or subsequent time. This option is set by default and is only used by
 460 servers. Anti-replay measures are required to comply with the TLSv1.3
 461 specification. Some applications may be able to mitigate the replay risks in
 462 other ways and in such cases the built-in OpenSSL functionality is not required.
 463 Disabling anti-replay is equivalent to setting B<SSL_OP_NO_ANTI_REPLAY>.
 464
 465 =item B<VerifyMode>
 466
 467 The B<value> argument is a comma separated list of flags to set.
 468
 469 B<Peer> enables peer verification: for clients only.
 470
 471 B<Request> requests but does not require a certificate from the client.
 472 Servers only.
 473
 474 B<Require> requests and requires a certificate from the client: an error
 475 occurs if the client does not present a certificate. Servers only.
 476
 477 B<Once> requests a certificate from a client only on the initial connection:
 478 not when renegotiating. Servers only.
 479
 480 B<RequestPostHandshake> configures the connection to support requests but does
 481 not require a certificate from the client post-handshake. A certificate will
 482 not be requested during the initial handshake. The server application must
 483 provide a mechanism to request a certificate post-handshake. Servers only.
 484 TLSv1.3 only.
 485
 486 B<RequiresPostHandshake> configures the connection to support requests and
 487 requires a certificate from the client post-handshake: an error occurs if the
 488 client does not present a certificate. A certificate will not be requested
 489 during the initial handshake. The server application must provide a mechanism
 490 to request a certificate post-handshake. Servers only. TLSv1.3 only.
 491
 492 =item B<ClientCAFile>, B<ClientCAPath>
 493
 494 A file or directory of certificates in PEM format whose names are used as the
 495 set of acceptable names for client CAs. Servers only. This option is only
 496 supported if certificate operations are permitted.
 497
 498 =back
 499
 500 =head1 SUPPORTED COMMAND TYPES
 501
 502 The function SSL_CONF_cmd_value_type() currently returns one of the following
 503 types:
 504
 505 =over 4
 506
 507 =item B<SSL_CONF_TYPE_UNKNOWN>
 508
 509 The B<cmd> string is unrecognised, this return value can be use to flag
 510 syntax errors.
 511
 512 =item B<SSL_CONF_TYPE_STRING>
 513
 514 The value is a string without any specific structure.
 515
 516 =item B<SSL_CONF_TYPE_FILE>
 517
 518 The value is a file name.
 519
 520 =item B<SSL_CONF_TYPE_DIR>
 521
 522 The value is a directory name.
 523
 524 =item B<SSL_CONF_TYPE_NONE>
 525
 526 The value string is not used e.g. a command line option which doesn't take an
 527 argument.
 528
 529 =back
 530
 531 =head1 NOTES
 532
 533 The order of operations is significant. This can be used to set either defaults
 534 or values which cannot be overridden. For example if an application calls:
 535
 536  SSL_CONF_cmd(ctx, "Protocol", "-SSLv3");
 537  SSL_CONF_cmd(ctx, userparam, uservalue);
 538
 539 it will disable SSLv3 support by default but the user can override it. If
 540 however the call sequence is:
 541
 542  SSL_CONF_cmd(ctx, userparam, uservalue);
 543  SSL_CONF_cmd(ctx, "Protocol", "-SSLv3");
 544
 545 SSLv3 is B<always> disabled and attempt to override this by the user are
 546 ignored.
 547
 548 By checking the return code of SSL_CONF_cmd() it is possible to query if a
 549 given B<cmd> is recognised, this is useful if SSL_CONF_cmd() values are
 550 mixed with additional application specific operations.
 551
 552 For example an application might call SSL_CONF_cmd() and if it returns
 553 -2 (unrecognised command) continue with processing of application specific
 554 commands.
 555
 556 Applications can also use SSL_CONF_cmd() to process command lines though the
 557 utility function SSL_CONF_cmd_argv() is normally used instead. One way
 558 to do this is to set the prefix to an appropriate value using
 559 SSL_CONF_CTX_set1_prefix(), pass the current argument to B<cmd> and the
 560 following argument to B<value> (which may be NULL).
 561
 562 In this case if the return value is positive then it is used to skip that
 563 number of arguments as they have been processed by SSL_CONF_cmd(). If -2 is
 564 returned then B<cmd> is not recognised and application specific arguments
 565 can be checked instead. If -3 is returned a required argument is missing
 566 and an error is indicated. If 0 is returned some other error occurred and
 567 this can be reported back to the user.
 568
 569 The function SSL_CONF_cmd_value_type() can be used by applications to
 570 check for the existence of a command or to perform additional syntax
 571 checking or translation of the command value. For example if the return
 572 value is B<SSL_CONF_TYPE_FILE> an application could translate a relative
 573 pathname to an absolute pathname.
 574
 575 =head1 EXAMPLES
 576
 577 Set supported signature algorithms:
 578
 579  SSL_CONF_cmd(ctx, "SignatureAlgorithms", "ECDSA+SHA256:RSA+SHA256:DSA+SHA256");
 580
 581 There are various ways to select the supported protocols.
 582
 583 This set the minimum protocol version to TLSv1, and so disables SSLv3.
 584 This is the recommended way to disable protocols.
 585
 586  SSL_CONF_cmd(ctx, "MinProtocol", "TLSv1");
 587
 588 The following also disables SSLv3:
 589
 590  SSL_CONF_cmd(ctx, "Protocol", "-SSLv3");
 591
 592 The following will first enable all protocols, and then disable
 593 SSLv3.
 594 If no protocol versions were disabled before this has the same effect as
 595 "-SSLv3", but if some versions were disables this will re-enable them before
 596 disabling SSLv3.
 597
 598  SSL_CONF_cmd(ctx, "Protocol", "ALL,-SSLv3");
 599
 600 Only enable TLSv1.2:
 601
 602  SSL_CONF_cmd(ctx, "MinProtocol", "TLSv1.2");
 603  SSL_CONF_cmd(ctx, "MaxProtocol", "TLSv1.2");
 604
 605 This also only enables TLSv1.2:
 606
 607  SSL_CONF_cmd(ctx, "Protocol", "-ALL,TLSv1.2");
 608
 609 Disable TLS session tickets:
 610
 611  SSL_CONF_cmd(ctx, "Options", "-SessionTicket");
 612
 613 Enable compression:
 614
 615  SSL_CONF_cmd(ctx, "Options", "Compression");
 616
 617 Set supported curves to P-256, P-384:
 618
 619  SSL_CONF_cmd(ctx, "Curves", "P-256:P-384");
 620
 621 =head1 RETURN VALUES
 622
 623 SSL_CONF_cmd() returns 1 if the value of B<cmd> is recognised and B<value> is
 624 B<NOT> used and 2 if both B<cmd> and B<value> are used. In other words it
 625 returns the number of arguments processed. This is useful when processing
 626 command lines.
 627
 628 A return value of -2 means B<cmd> is not recognised.
 629
 630 A return value of -3 means B<cmd> is recognised and the command requires a
 631 value but B<value> is NULL.
 632
 633 A return code of 0 indicates that both B<cmd> and B<value> are valid but an
 634 error occurred attempting to perform the operation: for example due to an
 635 error in the syntax of B<value> in this case the error queue may provide
 636 additional information.
 637
 638 =head1 SEE ALSO
 639
 640 L<SSL_CONF_CTX_new(3)>,
 641 L<SSL_CONF_CTX_set_flags(3)>,
 642 L<SSL_CONF_CTX_set1_prefix(3)>,
 643 L<SSL_CONF_CTX_set_ssl_ctx(3)>,
 644 L<SSL_CONF_cmd_argv(3)>,
 645 L<SSL_CTX_set_options(3)>
 646
 647 =head1 HISTORY
 648
 649 SSL_CONF_cmd() was first added to OpenSSL 1.0.2
 650
 651 B<SSL_OP_NO_SSL2> doesn't have effect since 1.1.0, but the macro is retained
 652 for backwards compatibility.
 653
 654 B<SSL_CONF_TYPE_NONE> was first added to OpenSSL 1.1.0. In earlier versions of
 655 OpenSSL passing a command which didn't take an argument would return
 656 B<SSL_CONF_TYPE_UNKNOWN>.
 657
 658 B<MinProtocol> and B<MaxProtocol> where added in OpenSSL 1.1.0.
 659
 660 B<AllowNoDHEKEX> and B<PrioritizeChaCha> were added in OpenSSL 1.1.1.
 661
 662 =head1 COPYRIGHT
 663
 664 Copyright 2012-2018 The OpenSSL Project Authors. All Rights Reserved.
 665
 666 Licensed under the OpenSSL license (the "License").  You may not use
 667 this file except in compliance with the License.  You can obtain a copy
 668 in the file LICENSE in the source distribution or at
 669 L<https://www.openssl.org/source/license.html>.
 670
 671 =cut