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