1 /*! \file ssl/ssl_conf.c
2 * \brief SSL configuration functions
4 /* ====================================================================
5 * Copyright (c) 2012 The OpenSSL Project. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. All advertising materials mentioning features or use of this
20 * software must display the following acknowledgment:
21 * "This product includes software developed by the OpenSSL Project
22 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
24 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25 * endorse or promote products derived from this software without
26 * prior written permission. For written permission, please contact
27 * openssl-core@openssl.org.
29 * 5. Products derived from this software may not be called "OpenSSL"
30 * nor may "OpenSSL" appear in their names without prior written
31 * permission of the OpenSSL Project.
33 * 6. Redistributions of any form whatsoever must retain the following
35 * "This product includes software developed by the OpenSSL Project
36 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49 * OF THE POSSIBILITY OF SUCH DAMAGE.
50 * ====================================================================
52 * This product includes cryptographic software written by Eric Young
53 * (eay@cryptsoft.com). This product includes software written by Tim
54 * Hudson (tjh@cryptsoft.com).
63 #include <openssl/conf.h>
64 #include <openssl/objects.h>
66 #include <openssl/dh.h>
69 /* structure holding name tables. This is used for pemitted elements in
70 * lists such as TLSv1 and single command line switches such as no_tls1
77 unsigned int name_flags;
78 unsigned long option_value;
81 /* Sense of name is inverted e.g. "TLSv1" will clear SSL_OP_NO_TLSv1 */
82 #define SSL_TFLAG_INV 0x1
83 /* Flags refers to cert_flags not options */
84 #define SSL_TFLAG_CERT 0x2
85 /* Option can only be used for clients */
86 #define SSL_TFLAG_CLIENT SSL_CONF_FLAG_CLIENT
87 /* Option can only be used for servers */
88 #define SSL_TFLAG_SERVER SSL_CONF_FLAG_SERVER
89 #define SSL_TFLAG_BOTH (SSL_TFLAG_CLIENT|SSL_TFLAG_SERVER)
91 #define SSL_FLAG_TBL(str, flag) \
92 {str, (int)(sizeof(str) - 1), SSL_TFLAG_BOTH, flag}
93 #define SSL_FLAG_TBL_SRV(str, flag) \
94 {str, (int)(sizeof(str) - 1), SSL_TFLAG_SERVER, flag}
95 #define SSL_FLAG_TBL_CLI(str, flag) \
96 {str, (int)(sizeof(str) - 1), SSL_TFLAG_CLIENT, flag}
97 #define SSL_FLAG_TBL_INV(str, flag) \
98 {str, (int)(sizeof(str) - 1), SSL_TFLAG_INV|SSL_TFLAG_BOTH, flag}
99 #define SSL_FLAG_TBL_SRV_INV(str, flag) \
100 {str, (int)(sizeof(str) - 1), SSL_TFLAG_INV|SSL_TFLAG_SERVER, flag}
101 #define SSL_FLAG_TBL_CERT(str, flag) \
102 {str, (int)(sizeof(str) - 1), SSL_TFLAG_CERT|SSL_TFLAG_BOTH, flag}
104 /* Opaque structure containing SSL configuration context.
107 struct ssl_conf_ctx_st
109 /* Various flags indicating (among other things) which options we
113 /* Prefix and length of commands */
116 /* SSL_CTX or SSL structure to perform operations on */
119 /* Pointer to SSL or SSL_CTX options field or NULL if none */
120 unsigned long *poptions;
121 /* Pointer to SSL or SSL_CTX cert_flags or NULL if none */
122 unsigned int *pcert_flags;
123 /* Current flag table being worked on */
124 const ssl_flag_tbl *tbl;
129 static int ssl_match_option(SSL_CONF_CTX *cctx, const ssl_flag_tbl *tbl,
130 const char *name, int namelen, int onoff)
132 /* If name not relevant for context skip */
133 if (!(cctx->flags & tbl->name_flags & SSL_TFLAG_BOTH))
137 if (strcmp(tbl->name, name))
140 else if (tbl->namelen != namelen || strncasecmp(tbl->name, name, namelen))
144 if (tbl->name_flags & SSL_TFLAG_INV)
146 if (tbl->name_flags & SSL_TFLAG_CERT)
149 *cctx->pcert_flags |= tbl->option_value;
151 *cctx->pcert_flags &= ~tbl->option_value;
156 *cctx->poptions |= tbl->option_value;
158 *cctx->poptions &= ~tbl->option_value;
164 static int ssl_set_option_list(const char *elem, int len, void *usr)
166 SSL_CONF_CTX *cctx = usr;
168 const ssl_flag_tbl *tbl;
170 /* len == -1 indicates not being called in list context, just for
171 * single command line switches, so don't allow +, -.
181 else if (*elem == '-')
188 for (i = 0, tbl = cctx->tbl; i < cctx->ntbl; i++, tbl++)
190 if (ssl_match_option(cctx, tbl, elem, len, onoff))
196 /* Single command line switches with no argument e.g. -no_ssl3 */
197 static int ctrl_str_option(SSL_CONF_CTX *cctx, const char *cmd)
199 static const ssl_flag_tbl ssl_option_single[] =
201 SSL_FLAG_TBL("no_ssl2", SSL_OP_NO_SSLv2),
202 SSL_FLAG_TBL("no_ssl3", SSL_OP_NO_SSLv3),
203 SSL_FLAG_TBL("no_tls1", SSL_OP_NO_TLSv1),
204 SSL_FLAG_TBL("no_tls1_1", SSL_OP_NO_TLSv1_1),
205 SSL_FLAG_TBL("no_tls1_2", SSL_OP_NO_TLSv1_2),
206 SSL_FLAG_TBL("no_tls1_2", SSL_OP_NO_TLSv1_2),
207 SSL_FLAG_TBL("bugs", SSL_OP_ALL),
208 SSL_FLAG_TBL("no_comp", SSL_OP_NO_COMPRESSION),
209 SSL_FLAG_TBL_SRV("ecdh_single", SSL_OP_SINGLE_ECDH_USE),
210 #ifndef OPENSSL_NO_TLSEXT
211 SSL_FLAG_TBL("no_ticket", SSL_OP_NO_TICKET),
213 SSL_FLAG_TBL_SRV("serverpref", SSL_OP_CIPHER_SERVER_PREFERENCE),
214 SSL_FLAG_TBL("legacy_renegotiation", SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION),
215 SSL_FLAG_TBL_SRV("legacy_server_connect", SSL_OP_LEGACY_SERVER_CONNECT),
216 SSL_FLAG_TBL_SRV_INV("no_legacy_server_connect", SSL_OP_LEGACY_SERVER_CONNECT),
217 SSL_FLAG_TBL_CERT("strict", SSL_CERT_FLAG_TLS_STRICT),
218 #ifdef OPENSSL_SSL_DEBUG_BROKEN_PROTOCOL
219 SSL_FLAG_TBL_CERT("debug_broken_protocol", SSL_CERT_FLAG_BROKEN_PROTOCOL),
222 cctx->tbl = ssl_option_single;
223 cctx->ntbl = sizeof(ssl_option_single)/sizeof(ssl_flag_tbl);
224 return ssl_set_option_list(cmd, -1, cctx);
227 /* Set supported signature algorithms */
228 static int cmd_SignatureAlgorithms(SSL_CONF_CTX *cctx, const char *value)
232 rv = SSL_set1_sigalgs_list(cctx->ssl, value);
233 /* NB: ctx == NULL performs syntax checking only */
235 rv = SSL_CTX_set1_sigalgs_list(cctx->ctx, value);
238 /* Set supported client signature algorithms */
239 static int cmd_ClientSignatureAlgorithms(SSL_CONF_CTX *cctx, const char *value)
243 rv = SSL_set1_client_sigalgs_list(cctx->ssl, value);
244 /* NB: ctx == NULL performs syntax checking only */
246 rv = SSL_CTX_set1_client_sigalgs_list(cctx->ctx, value);
250 static int cmd_Curves(SSL_CONF_CTX *cctx, const char *value)
254 rv = SSL_set1_curves_list(cctx->ssl, value);
255 /* NB: ctx == NULL performs syntax checking only */
257 rv = SSL_CTX_set1_curves_list(cctx->ctx, value);
260 #ifndef OPENSSL_NO_ECDH
261 /* ECDH temporary parameters */
262 static int cmd_ECDHParameters(SSL_CONF_CTX *cctx, const char *value)
264 int onoff = -1, rv = 1;
265 if (!(cctx->flags & SSL_CONF_FLAG_SERVER))
267 if (cctx->flags & SSL_CONF_FLAG_FILE)
279 if (!strcasecmp(value, "automatic"))
284 else if (onoff != -1)
287 else if (cctx->flags & SSL_CONF_FLAG_CMDLINE)
289 if (!strcmp(value, "auto"))
296 rv = SSL_CTX_set_ecdh_auto(cctx->ctx, onoff);
298 rv = SSL_set_ecdh_auto(cctx->ssl, onoff);
304 nid = EC_curve_nist2nid(value);
305 if (nid == NID_undef)
306 nid = OBJ_sn2nid(value);
309 ecdh = EC_KEY_new_by_curve_name(nid);
313 rv = SSL_CTX_set_tmp_ecdh(cctx->ctx, ecdh);
315 rv = SSL_set_tmp_ecdh(cctx->ssl, ecdh);
322 static int cmd_CipherString(SSL_CONF_CTX *cctx, const char *value)
326 rv = SSL_CTX_set_cipher_list(cctx->ctx, value);
328 rv = SSL_set_cipher_list(cctx->ssl, value);
332 static int cmd_Protocol(SSL_CONF_CTX *cctx, const char *value)
334 static const ssl_flag_tbl ssl_protocol_list[] =
336 SSL_FLAG_TBL_INV("ALL", SSL_OP_NO_SSL_MASK),
337 SSL_FLAG_TBL_INV("SSLv2", SSL_OP_NO_SSLv2),
338 SSL_FLAG_TBL_INV("SSLv3", SSL_OP_NO_SSLv3),
339 SSL_FLAG_TBL_INV("TLSv1", SSL_OP_NO_TLSv1),
340 SSL_FLAG_TBL_INV("TLSv1.1", SSL_OP_NO_TLSv1_1),
341 SSL_FLAG_TBL_INV("TLSv1.2", SSL_OP_NO_TLSv1_2)
343 if (!(cctx->flags & SSL_CONF_FLAG_FILE))
345 cctx->tbl = ssl_protocol_list;
346 cctx->ntbl = sizeof(ssl_protocol_list)/sizeof(ssl_flag_tbl);
347 return CONF_parse_list(value, ',', 1, ssl_set_option_list, cctx);
350 static int cmd_Options(SSL_CONF_CTX *cctx, const char *value)
352 static const ssl_flag_tbl ssl_option_list[] =
354 SSL_FLAG_TBL_INV("SessionTicket", SSL_OP_NO_TICKET),
355 SSL_FLAG_TBL_INV("EmptyFragments", SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS),
356 SSL_FLAG_TBL("Bugs", SSL_OP_ALL),
357 SSL_FLAG_TBL_INV("Compression", SSL_OP_NO_COMPRESSION),
358 SSL_FLAG_TBL_SRV("ServerPreference", SSL_OP_CIPHER_SERVER_PREFERENCE),
359 SSL_FLAG_TBL_SRV("DHSingle", SSL_OP_SINGLE_DH_USE),
360 SSL_FLAG_TBL_SRV("ECDHSingle", SSL_OP_SINGLE_ECDH_USE),
361 SSL_FLAG_TBL("UnsafeLegacyRenegotiation", SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION),
363 if (!(cctx->flags & SSL_CONF_FLAG_FILE))
367 cctx->tbl = ssl_option_list;
368 cctx->ntbl = sizeof(ssl_option_list)/sizeof(ssl_flag_tbl);
369 return CONF_parse_list(value, ',', 1, ssl_set_option_list, cctx);
372 static int cmd_Certificate(SSL_CONF_CTX *cctx, const char *value)
375 if (!(cctx->flags & SSL_CONF_FLAG_CERTIFICATE))
378 rv = SSL_CTX_use_certificate_chain_file(cctx->ctx, value);
380 rv = SSL_use_certificate_file(cctx->ssl, value, SSL_FILETYPE_PEM);
384 static int cmd_PrivateKey(SSL_CONF_CTX *cctx, const char *value)
387 if (!(cctx->flags & SSL_CONF_FLAG_CERTIFICATE))
390 rv = SSL_CTX_use_PrivateKey_file(cctx->ctx, value, SSL_FILETYPE_PEM);
392 rv = SSL_use_PrivateKey_file(cctx->ssl, value, SSL_FILETYPE_PEM);
395 #ifndef OPENSSL_NO_DH
396 static int cmd_DHParameters(SSL_CONF_CTX *cctx, const char *value)
401 if (!(cctx->flags & SSL_CONF_FLAG_CERTIFICATE))
403 if (cctx->ctx || cctx->ssl)
405 in = BIO_new(BIO_s_file_internal());
408 if (BIO_read_filename(in, value) <= 0)
410 dh = PEM_read_bio_DHparams(in, NULL, NULL, NULL);
417 rv = SSL_CTX_set_tmp_dh(cctx->ctx, dh);
419 rv = SSL_set_tmp_dh(cctx->ssl, dh);
430 int (*cmd)(SSL_CONF_CTX *cctx, const char *value);
431 const char *str_file;
432 const char *str_cmdline;
433 unsigned int value_type;
436 /* Table of supported parameters */
438 #define SSL_CONF_CMD(name, cmdopt, type) \
439 {cmd_##name, #name, cmdopt, type}
441 #define SSL_CONF_CMD_STRING(name, cmdopt) \
442 SSL_CONF_CMD(name, cmdopt, SSL_CONF_TYPE_STRING)
444 static const ssl_conf_cmd_tbl ssl_conf_cmds[] = {
445 SSL_CONF_CMD_STRING(SignatureAlgorithms, "sigalgs"),
446 SSL_CONF_CMD_STRING(ClientSignatureAlgorithms, "client_sigalgs"),
447 SSL_CONF_CMD_STRING(Curves, "curves"),
448 #ifndef OPENSSL_NO_ECDH
449 SSL_CONF_CMD_STRING(ECDHParameters, "named_curve"),
451 SSL_CONF_CMD_STRING(CipherString, "cipher"),
452 SSL_CONF_CMD_STRING(Protocol, NULL),
453 SSL_CONF_CMD_STRING(Options, NULL),
454 SSL_CONF_CMD(Certificate, "cert", SSL_CONF_TYPE_FILE),
455 SSL_CONF_CMD(PrivateKey, "key", SSL_CONF_TYPE_FILE),
456 #ifndef OPENSSL_NO_DH
457 SSL_CONF_CMD(DHParameters, "dhparam", SSL_CONF_TYPE_FILE)
461 static int ssl_conf_cmd_skip_prefix(SSL_CONF_CTX *cctx, const char **pcmd)
465 /* If a prefix is set, check and skip */
468 if (strlen(*pcmd) <= cctx->prefixlen)
470 if (cctx->flags & SSL_CONF_FLAG_CMDLINE &&
471 strncmp(*pcmd, cctx->prefix, cctx->prefixlen))
473 if (cctx->flags & SSL_CONF_FLAG_FILE &&
474 strncasecmp(*pcmd, cctx->prefix, cctx->prefixlen))
476 *pcmd += cctx->prefixlen;
478 else if (cctx->flags & SSL_CONF_FLAG_CMDLINE)
480 if (**pcmd != '-' || !(*pcmd)[1])
487 static const ssl_conf_cmd_tbl *ssl_conf_cmd_lookup(SSL_CONF_CTX *cctx, const char *cmd)
489 const ssl_conf_cmd_tbl *t;
494 /* Look for matching parameter name in table */
495 for (i = 0, t = ssl_conf_cmds;
496 i < sizeof(ssl_conf_cmds)/sizeof(ssl_conf_cmd_tbl); i++, t++)
498 if (cctx->flags & SSL_CONF_FLAG_CMDLINE)
500 if (t->str_cmdline && !strcmp(t->str_cmdline, cmd))
503 if (cctx->flags & SSL_CONF_FLAG_FILE)
505 if (t->str_file && !strcasecmp(t->str_file, cmd))
512 int SSL_CONF_cmd(SSL_CONF_CTX *cctx, const char *cmd, const char *value)
514 const ssl_conf_cmd_tbl *runcmd;
517 SSLerr(SSL_F_SSL_CONF_CMD, SSL_R_INVALID_NULL_CMD_NAME);
521 if (!ssl_conf_cmd_skip_prefix(cctx, &cmd))
524 runcmd = ssl_conf_cmd_lookup(cctx, cmd);
531 rv = runcmd->cmd(cctx, value);
536 if (cctx->flags & SSL_CONF_FLAG_SHOW_ERRORS)
538 SSLerr(SSL_F_SSL_CONF_CMD, SSL_R_BAD_VALUE);
539 ERR_add_error_data(4, "cmd=", cmd, ", value=", value);
544 if (cctx->flags & SSL_CONF_FLAG_CMDLINE)
546 if (ctrl_str_option(cctx, cmd))
550 if (cctx->flags & SSL_CONF_FLAG_SHOW_ERRORS)
552 SSLerr(SSL_F_SSL_CONF_CMD, SSL_R_UNKNOWN_CMD_NAME);
553 ERR_add_error_data(2, "cmd=", cmd);
559 int SSL_CONF_cmd_argv(SSL_CONF_CTX *cctx, int *pargc, char ***pargv)
562 const char *arg = NULL, *argn;
563 if (pargc && *pargc == 0)
565 if (!pargc || *pargc > 0)
569 if (!pargc || *pargc > 1)
573 cctx->flags &= ~SSL_CONF_FLAG_FILE;
574 cctx->flags |= SSL_CONF_FLAG_CMDLINE;
575 rv = SSL_CONF_cmd(cctx, arg, argn);
578 /* Success: update pargc, pargv */
584 /* Unknown switch: indicate no arguments processed */
587 /* Some error occurred processing command, return fatal error */
593 int SSL_CONF_cmd_value_type(SSL_CONF_CTX *cctx, const char *cmd)
595 if (ssl_conf_cmd_skip_prefix(cctx, &cmd))
597 const ssl_conf_cmd_tbl *runcmd;
598 runcmd = ssl_conf_cmd_lookup(cctx, cmd);
600 return runcmd->value_type;
602 return SSL_CONF_TYPE_UNKNOWN;
605 SSL_CONF_CTX *SSL_CONF_CTX_new(void)
608 ret = OPENSSL_malloc(sizeof(SSL_CONF_CTX));
616 ret->poptions = NULL;
617 ret->pcert_flags = NULL;
624 int SSL_CONF_CTX_finish(SSL_CONF_CTX *cctx)
629 void SSL_CONF_CTX_free(SSL_CONF_CTX *cctx)
634 OPENSSL_free(cctx->prefix);
639 unsigned int SSL_CONF_CTX_set_flags(SSL_CONF_CTX *cctx, unsigned int flags)
641 cctx->flags |= flags;
645 unsigned int SSL_CONF_CTX_clear_flags(SSL_CONF_CTX *cctx, unsigned int flags)
647 cctx->flags &= ~flags;
651 int SSL_CONF_CTX_set1_prefix(SSL_CONF_CTX *cctx, const char *pre)
656 tmp = BUF_strdup(pre);
661 OPENSSL_free(cctx->prefix);
664 cctx->prefixlen = strlen(tmp);
670 void SSL_CONF_CTX_set_ssl(SSL_CONF_CTX *cctx, SSL *ssl)
676 cctx->poptions = &ssl->options;
677 cctx->pcert_flags = &ssl->cert->cert_flags;
681 cctx->poptions = NULL;
682 cctx->pcert_flags = NULL;
686 void SSL_CONF_CTX_set_ssl_ctx(SSL_CONF_CTX *cctx, SSL_CTX *ctx)
692 cctx->poptions = &ctx->options;
693 cctx->pcert_flags = &ctx->cert->cert_flags;
697 cctx->poptions = NULL;
698 cctx->pcert_flags = NULL;