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