doc/ssl/SSL_CONF_cmd.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CONF_cmd - send configuration command
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  int SSL_CONF_cmd(SSL_CONF_CTX *cctx, const char *cmd, const char *value);
  12  int SSL_CONF_cmd_value_type(SSL_CONF_CTX *cctx, const char *cmd);
  13  int SSL_CONF_finish(SSL_CONF_CTX *cctx);
  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 The function SSL_CONF_finish() must be called after all configuration
  25 operations have been completed. It is used to finalise any operations
  26 or to process defaults.
  27
  28 =head1 SUPPORTED COMMAND LINE COMMANDS
  29
  30 Currently supported B<cmd> names for command lines (i.e. when the
  31 flag B<SSL_CONF_CMDLINE> is set) are listed below. Note: all B<cmd> names
  32 are case sensitive. Unless otherwise stated commands can be used by
  33 both clients and servers and the B<value> parameter is not used. The default
  34 prefix for command line commands is B<-> and that is reflected below.
  35
  36 =over 4
  37
  38 =item B<-sigalgs>
  39
  40 This sets the supported signature algorithms for TLS v1.2. For clients this
  41 value is used directly for the supported signature algorithms extension. For
  42 servers it is used to determine which signature algorithms to support.
  43
  44 The B<value> argument should be a colon separated list of signature algorithms
  45 in order of decreasing preference of the form B<algorithm+hash>. B<algorithm>
  46 is one of B<RSA>, B<DSA> or B<ECDSA> and B<hash> is a supported algorithm
  47 OID short name such as B<SHA1>, B<SHA224>, B<SHA256>, B<SHA384> of B<SHA512>.
  48 Note: algorithm and hash names are case sensitive.
  49
  50 If this option is not set then all signature algorithms supported by the
  51 OpenSSL library are permissible.
  52
  53 =item B<-client_sigalgs>
  54
  55 This sets the supported signature algorithms associated with client
  56 authentication for TLS v1.2. For servers the value is used in the supported
  57 signature algorithms field of a certificate request. For clients it is
  58 used to determine which signature algorithm to with the client certificate.
  59 If a server does not request a certificate this option has no effect.
  60
  61 The syntax of B<value> is identical to B<-sigalgs>. If not set then
  62 the value set for B<-sigalgs> will be used instead.
  63
  64 =item B<-curves>
  65
  66 This sets the supported elliptic curves. For clients the curves are
  67 sent using the supported curves extension. For servers it is used
  68 to determine which curve to use. This setting affects curves used for both
  69 signatures and key exchange, if applicable.
  70
  71 The B<value> argument is a colon separated list of curves. The curve can be
  72 either the B<NIST> name (e.g. B<P-256>) or an OpenSSL OID name (e.g
  73 B<prime256v1>). Curve names are case sensitive.
  74
  75 =item B<-named_curve>
  76
  77 This sets the temporary curve used for ephemeral ECDH modes. Only used by
  78 servers
  79
  80 The B<value> argument is a curve name or the special value B<auto> which
  81 picks an appropriate curve based on client and server preferences. The curve
  82 can be either the B<NIST> name (e.g. B<P-256>) or an OpenSSL OID name
  83 (e.g B<prime256v1>). Curve names are case sensitive.
  84
  85 =item B<-cipher>
  86
  87 Sets the cipher suite list to B<value>. Note: syntax checking of B<value> is
  88 currently not performed unless a B<SSL> or B<SSL_CTX> structure is
  89 associated with B<cctx>.
  90
  91 =item B<-cert>
  92
  93 Attempts to use the file B<value> as the certificate for the appropriate
  94 context. It currently uses SSL_CTX_use_certificate_chain_file() if an B<SSL_CTX>
  95 structure is set or SSL_use_certificate_file() with filetype PEM if an B<SSL>
  96 structure is set. This option is only supported if certificate operations
  97 are permitted.
  98
  99 =item B<-key>
 100
 101 Attempts to use the file B<value> as the private key for the appropriate
 102 context. This option is only supported if certificate operations
 103 are permitted. Note: if no B<-key> option is set then a private key is
 104 not loaded unless the flag B<SSL_CONF_FLAG_REQUIRE_PRIVATE> is set.
 105
 106 =item B<-dhparam>
 107
 108 Attempts to use the file B<value> as the set of temporary DH parameters for
 109 the appropriate context. This option is only supported if certificate
 110 operations are permitted.
 111
 112 =item B<-min_protocol>, B<-max_protocol>
 113
 114 Sets the minimum and maximum supported protocol.
 115 Currently supported protocol values are B<SSLv3>, B<TLSv1>,
 116 B<TLSv1.1>, B<TLSv1.2> for TLS and B<DTLSv1>, B<DTLSv1.2> for DTLS.
 117 If the either bound is not specified then only the other bound applies,
 118 if specified.
 119 To restrict the supported protocol versions use these commands rather
 120 than the deprecated alternative commands below.
 121
 122 =item B<-no_ssl3>, B<-no_tls1>, B<-no_tls1_1>, B<-no_tls1_2>
 123
 124 Disables protocol support for SSLv3, TLS 1.0, TLS 1.1 or TLS 1.2
 125 by setting the corresponding options B<SSL_OP_NO_SSL3>, B<SSL_OP_NO_TLS1>,
 126 B<SSL_OP_NO_TLS1_1> and B<SSL_OP_NO_TLS1_2> respectively.
 127 These options are deprecated, instead use B<-min_protocol> and B<-max_protocol>.
 128
 129 =item B<-bugs>
 130
 131 Various bug workarounds are set, same as setting B<SSL_OP_ALL>.
 132
 133 =item B<-no_comp>
 134
 135 Disables support for SSL/TLS compression, same as setting B<SSL_OP_NO_COMPRESS>.
 136
 137 =item B<-no_ticket>
 138
 139 Disables support for session tickets, same as setting B<SSL_OP_NO_TICKET>.
 140
 141 =item B<-serverpref>
 142
 143 Use server and not client preference order when determining which cipher suite,
 144 signature algorithm or elliptic curve to use for an incoming connection.
 145 Equivalent to B<SSL_OP_CIPHER_SERVER_PREFERENCE>. Only used by servers.
 146
 147 =item B<-no_resumption_on_reneg>
 148
 149 set SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION flag. Only used by servers.
 150
 151 =item B<-legacyrenegotiation>
 152
 153 permits the use of unsafe legacy renegotiation. Equivalent to setting
 154 B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION>.
 155
 156 =item B<-legacy_server_connect>, B<-no_legacy_server_connect>
 157
 158 permits or prohibits the use of unsafe legacy renegotiation for OpenSSL
 159 clients only. Equivalent to setting or clearing B<SSL_OP_LEGACY_SERVER_CONNECT>.
 160 Set by default.
 161
 162 =item B<-strict>
 163
 164 enables strict mode protocol handling. Equivalent to setting
 165 B<SSL_CERT_FLAG_TLS_STRICT>.
 166
 167 =item B<-debug_broken_protocol>
 168
 169 disables various checks and permits several kinds of broken protocol behaviour
 170 for testing purposes: it should B<NEVER> be used in anything other than a test
 171 environment. Only supported if OpenSSL is configured with
 172 B<-DOPENSSL_SSL_DEBUG_BROKEN_PROTOCOL>.
 173
 174 =back
 175
 176 =head1 SUPPORTED CONFIGURATION FILE COMMANDS
 177
 178 Currently supported B<cmd> names for configuration files (i.e. when the
 179 flag B<SSL_CONF_FLAG_FILE> is set) are listed below. All configuration file
 180 B<cmd> names are case insensitive so B<signaturealgorithms> is recognised
 181 as well as B<SignatureAlgorithms>. Unless otherwise stated the B<value> names
 182 are also case insensitive.
 183
 184 Note: the command prefix (if set) alters the recognised B<cmd> values.
 185
 186 =over 4
 187
 188 =item B<CipherString>
 189
 190 Sets the cipher suite list to B<value>. Note: syntax checking of B<value> is
 191 currently not performed unless an B<SSL> or B<SSL_CTX> structure is
 192 associated with B<cctx>.
 193
 194 =item B<Certificate>
 195
 196 Attempts to use the file B<value> as the certificate for the appropriate
 197 context. It currently uses SSL_CTX_use_certificate_chain_file() if an B<SSL_CTX>
 198 structure is set or SSL_use_certificate_file() with filetype PEM if an B<SSL>
 199 structure is set. This option is only supported if certificate operations
 200 are permitted.
 201
 202 =item B<PrivateKey>
 203
 204 Attempts to use the file B<value> as the private key for the appropriate
 205 context. This option is only supported if certificate operations
 206 are permitted. Note: if no B<PrivateKey> option is set then a private key is
 207 not loaded unless the B<SSL_CONF_FLAG_REQUIRE_PRIVATE> is set.
 208
 209 =item B<ChainCAFile>, B<ChainCAPath>, B<VerifyCAFile>, B<VerifyCAPath>
 210
 211 These options indicate a file or directory used for building certificate
 212 chains or verifying certificate chains. These options are only supported
 213 if certificate operations are permitted.
 214
 215 =item B<ServerInfoFile>
 216
 217 Attempts to use the file B<value> in the "serverinfo" extension using the
 218 function SSL_CTX_use_serverinfo_file.
 219
 220 =item B<DHParameters>
 221
 222 Attempts to use the file B<value> as the set of temporary DH parameters for
 223 the appropriate context. This option is only supported if certificate
 224 operations are permitted.
 225
 226 =item B<SignatureAlgorithms>
 227
 228 This sets the supported signature algorithms for TLS v1.2. For clients this
 229 value is used directly for the supported signature algorithms extension. For
 230 servers it is used to determine which signature algorithms to support.
 231
 232 The B<value> argument should be a colon separated list of signature algorithms
 233 in order of decreasing preference of the form B<algorithm+hash>. B<algorithm>
 234 is one of B<RSA>, B<DSA> or B<ECDSA> and B<hash> is a supported algorithm
 235 OID short name such as B<SHA1>, B<SHA224>, B<SHA256>, B<SHA384> of B<SHA512>.
 236 Note: algorithm and hash names are case sensitive.
 237
 238 If this option is not set then all signature algorithms supported by the
 239 OpenSSL library are permissible.
 240
 241 =item B<ClientSignatureAlgorithms>
 242
 243 This sets the supported signature algorithms associated with client
 244 authentication for TLS v1.2. For servers the value is used in the supported
 245 signature algorithms field of a certificate request. For clients it is
 246 used to determine which signature algorithm to with the client certificate.
 247
 248 The syntax of B<value> is identical to B<SignatureAlgorithms>. If not set then
 249 the value set for B<SignatureAlgorithms> will be used instead.
 250
 251 =item B<Curves>
 252
 253 This sets the supported elliptic curves. For clients the curves are
 254 sent using the supported curves extension. For servers it is used
 255 to determine which curve to use. This setting affects curves used for both
 256 signatures and key exchange, if applicable.
 257
 258 The B<value> argument is a colon separated list of curves. The curve can be
 259 either the B<NIST> name (e.g. B<P-256>) or an OpenSSL OID name (e.g
 260 B<prime256v1>). Curve names are case sensitive.
 261
 262 =item B<ECDHParameters>
 263
 264 This sets the temporary curve used for ephemeral ECDH modes. Only used by
 265 servers
 266
 267 The B<value> argument is a curve name or the special value B<Automatic> which
 268 picks an appropriate curve based on client and server preferences. The curve
 269 can be either the B<NIST> name (e.g. B<P-256>) or an OpenSSL OID name
 270 (e.g B<prime256v1>). Curve names are case sensitive.
 271
 272 =item B<MinProtocol>
 273
 274 This sets the minimum supported SSL, TLS or DTLS version.
 275
 276 Currently supported protocol values are B<SSLv3>, B<TLSv1>, B<TLSv1.1>,
 277 B<TLSv1.2>, B<DTLSv1> and B<DTLSv1.2>.
 278
 279 =item B<MaxProtocol>
 280
 281 This sets the maximum supported SSL, TLS or DTLS version.
 282
 283 Currently supported protocol values are B<SSLv3>, B<TLSv1>, B<TLSv1.1>,
 284 B<TLSv1.2>, B<DTLSv1> and B<DTLSv1.2>.
 285
 286 =item B<Protocol>
 287
 288 This can be used to enable or disable certain versions of the SSL,
 289 TLS or DTLS protocol.
 290
 291 The B<value> argument is a comma separated list of supported protocols
 292 to enable or disable.
 293 If a protocol is preceded by B<-> that version is disabled.
 294
 295 All protocol versions are enabled by default.
 296 You need to disable at least one protocol version for this setting have any
 297 effect.
 298 Only enabling some protocol versions does not disable the other protocol
 299 versions.
 300
 301 Currently supported protocol values are B<SSLv3>, B<TLSv1>, B<TLSv1.1>,
 302 B<TLSv1.2>, B<DTLSv1> and B<DTLSv1.2>.
 303 The special value B<ALL> refers to all supported versions.
 304
 305 This can't enable protocols that are disabled using B<MinProtocol>
 306 or B<MaxProtocol>, but can disable protocols that are still allowed
 307 by them.
 308
 309 The B<Protocol> command is fragile and deprecated; do not use it.
 310 Use B<MinProtocol> and B<MaxProtocol> instead.
 311 If you do use B<Protocol>, make sure that the resulting range of enabled
 312 protocols has no "holes", e.g. if TLS 1.0 and TLS 1.2 are both enabled, make
 313 sure to also leave TLS 1.1 enabled.
 314
 315 =item B<Options>
 316
 317 The B<value> argument is a comma separated list of various flags to set.
 318 If a flag string is preceded B<-> it is disabled. See the
 319 B<SSL_CTX_set_options> function for more details of individual options.
 320
 321 Each option is listed below. Where an operation is enabled by default
 322 the B<-flag> syntax is needed to disable it.
 323
 324 B<SessionTicket>: session ticket support, enabled by default. Inverse of
 325 B<SSL_OP_NO_TICKET>: that is B<-SessionTicket> is the same as setting
 326 B<SSL_OP_NO_TICKET>.
 327
 328 B<Compression>: SSL/TLS compression support, enabled by default. Inverse
 329 of B<SSL_OP_NO_COMPRESSION>.
 330
 331 B<EmptyFragments>: use empty fragments as a countermeasure against a
 332 SSL 3.0/TLS 1.0 protocol vulnerability affecting CBC ciphers. It
 333 is set by default. Inverse of B<SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS>.
 334
 335 B<Bugs>: enable various bug workarounds. Same as B<SSL_OP_ALL>.
 336
 337 B<DHSingle>: enable single use DH keys, set by default. Inverse of
 338 B<SSL_OP_DH_SINGLE>. Only used by servers.
 339
 340 B<ECDHSingle> enable single use ECDH keys, set by default. Inverse of
 341 B<SSL_OP_ECDH_SINGLE>. Only used by servers.
 342
 343 B<ServerPreference> use server and not client preference order when
 344 determining which cipher suite, signature algorithm or elliptic curve
 345 to use for an incoming connection.  Equivalent to
 346 B<SSL_OP_CIPHER_SERVER_PREFERENCE>. Only used by servers.
 347
 348 B<NoResumptionOnRenegotiation> set
 349 B<SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION> flag. Only used by servers.
 350
 351 B<UnsafeLegacyRenegotiation> permits the use of unsafe legacy renegotiation.
 352 Equivalent to B<SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION>.
 353
 354 B<UnsafeLegacyServerConnect> permits the use of unsafe legacy renegotiation
 355 for OpenSSL clients only. Equivalent to B<SSL_OP_LEGACY_SERVER_CONNECT>.
 356 Set by default.
 357
 358 =item B<VerifyMode>
 359
 360 The B<value> argument is a comma separated list of flags to set.
 361
 362 B<Peer> enables peer verification: for clients only.
 363
 364 B<Request> requests but does not require a certificate from the client.
 365 Servers only.
 366
 367 B<Require> requests and requires a certificate from the client: an error
 368 occurs if the client does not present a certificate. Servers only.
 369
 370 B<Once> requests a certificate from a client only on the initial connection:
 371 not when renegotiating. Servers only.
 372
 373 =item B<ClientCAFile>, B<ClientCAPath>
 374
 375 A file or directory of certificates in PEM format whose names are used as the
 376 set of acceptable names for client CAs. Servers only. This option is only
 377 supported if certificate operations are permitted.
 378
 379 =back
 380
 381 =head1 SUPPORTED COMMAND TYPES
 382
 383 The function SSL_CONF_cmd_value_type() currently returns one of the following
 384 types:
 385
 386 =over 4
 387
 388 =item B<SSL_CONF_TYPE_UNKNOWN>
 389
 390 The B<cmd> string is unrecognised, this return value can be use to flag
 391 syntax errors.
 392
 393 =item B<SSL_CONF_TYPE_STRING>
 394
 395 The value is a string without any specific structure.
 396
 397 =item B<SSL_CONF_TYPE_FILE>
 398
 399 The value is a file name.
 400
 401 =item B<SSL_CONF_TYPE_DIR>
 402
 403 The value is a directory name.
 404
 405 =item B<SSL_CONF_TYPE_NONE>
 406
 407 The value string is not used e.g. a command line option which doesn't take an
 408 argument.
 409
 410 =back
 411
 412 =head1 NOTES
 413
 414 The order of operations is significant. This can be used to set either defaults
 415 or values which cannot be overridden. For example if an application calls:
 416
 417  SSL_CONF_cmd(ctx, "Protocol", "-SSLv3");
 418  SSL_CONF_cmd(ctx, userparam, uservalue);
 419
 420 it will disable SSLv3 support by default but the user can override it. If
 421 however the call sequence is:
 422
 423  SSL_CONF_cmd(ctx, userparam, uservalue);
 424  SSL_CONF_cmd(ctx, "Protocol", "-SSLv3");
 425
 426 SSLv3 is B<always> disabled and attempt to override this by the user are
 427 ignored.
 428
 429 By checking the return code of SSL_CTX_cmd() it is possible to query if a
 430 given B<cmd> is recognised, this is useful is SSL_CTX_cmd() values are
 431 mixed with additional application specific operations.
 432
 433 For example an application might call SSL_CTX_cmd() and if it returns
 434 -2 (unrecognised command) continue with processing of application specific
 435 commands.
 436
 437 Applications can also use SSL_CTX_cmd() to process command lines though the
 438 utility function SSL_CTX_cmd_argv() is normally used instead. One way
 439 to do this is to set the prefix to an appropriate value using
 440 SSL_CONF_CTX_set1_prefix(), pass the current argument to B<cmd> and the
 441 following argument to B<value> (which may be NULL).
 442
 443 In this case if the return value is positive then it is used to skip that
 444 number of arguments as they have been processed by SSL_CTX_cmd(). If -2 is
 445 returned then B<cmd> is not recognised and application specific arguments
 446 can be checked instead. If -3 is returned a required argument is missing
 447 and an error is indicated. If 0 is returned some other error occurred and
 448 this can be reported back to the user.
 449
 450 The function SSL_CONF_cmd_value_type() can be used by applications to
 451 check for the existence of a command or to perform additional syntax
 452 checking or translation of the command value. For example if the return
 453 value is B<SSL_CONF_TYPE_FILE> an application could translate a relative
 454 pathname to an absolute pathname.
 455
 456 =head1 EXAMPLES
 457
 458 Set supported signature algorithms:
 459
 460  SSL_CONF_cmd(ctx, "SignatureAlgorithms", "ECDSA+SHA256:RSA+SHA256:DSA+SHA256");
 461
 462 There are various ways to select the supported procotols.
 463
 464 This set the minimum protocol version to TLSv1, and so disables SSLv3.
 465 This is the recommended way to disable protocols.
 466
 467  SSL_CONF_cmd(ctx, "MinProtocol", "TLSv1");
 468
 469 The following also disables SSLv3:
 470
 471  SSL_CONF_cmd(ctx, "Protocol", "-SSLv3");
 472
 473 The following will first enable all protocols, and then disable
 474 SSLv3.
 475 If no protocol versions were disabled before this has the same effect as
 476 "-SSLv3", but if some versions were disables this will re-enable them before
 477 disabling SSLv3.
 478
 479  SSL_CONF_cmd(ctx, "Protocol", "ALL,-SSLv3");
 480
 481 Only enable TLSv1.2:
 482
 483  SSL_CONF_cmd(ctx, "MinProtocol", "TLSv1.2");
 484  SSL_CONF_cmd(ctx, "MaxProtocol", "TLSv1.2");
 485
 486 This also only enables TLSv1.2:
 487
 488  SSL_CONF_cmd(ctx, "Protocol", "-ALL,TLSv1.2");
 489
 490 Disable TLS session tickets:
 491
 492  SSL_CONF_cmd(ctx, "Options", "-SessionTicket");
 493
 494 Set supported curves to P-256, P-384:
 495
 496  SSL_CONF_cmd(ctx, "Curves", "P-256:P-384");
 497
 498 Set automatic support for any elliptic curve for key exchange:
 499
 500  SSL_CONF_cmd(ctx, "ECDHParameters", "Automatic");
 501
 502 =head1 RETURN VALUES
 503
 504 SSL_CONF_cmd() returns 1 if the value of B<cmd> is recognised and B<value> is
 505 B<NOT> used and 2 if both B<cmd> and B<value> are used. In other words it
 506 returns the number of arguments processed. This is useful when processing
 507 command lines.
 508
 509 A return value of -2 means B<cmd> is not recognised.
 510
 511 A return value of -3 means B<cmd> is recognised and the command requires a
 512 value but B<value> is NULL.
 513
 514 A return code of 0 indicates that both B<cmd> and B<value> are valid but an
 515 error occurred attempting to perform the operation: for example due to an
 516 error in the syntax of B<value> in this case the error queue may provide
 517 additional information.
 518
 519 SSL_CONF_finish() returns 1 for success and 0 for failure.
 520
 521 =head1 SEE ALSO
 522
 523 L<SSL_CONF_CTX_new(3)>,
 524 L<SSL_CONF_CTX_set_flags(3)>,
 525 L<SSL_CONF_CTX_set1_prefix(3)>,
 526 L<SSL_CONF_CTX_set_ssl_ctx(3)>,
 527 L<SSL_CONF_cmd_argv(3)>
 528
 529 =head1 HISTORY
 530
 531 SSL_CONF_cmd() was first added to OpenSSL 1.0.2
 532
 533 B<SSL_OP_NO_SSL2> doesn't have effect since 1.1.0, but the macro is retained
 534 for backwards compatibility.
 535
 536 B<SSL_CONF_TYPE_NONE> was first added to OpenSSL 1.1.0. In earlier versions of
 537 OpenSSL passing a command which didn't take an argument would return
 538 B<SSL_CONF_TYPE_UNKNOWN>.
 539
 540 B<MinProtocol> and B<MaxProtocol> where added in OpenSSL 1.1.0.
 541
 542 =cut