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