2 * ! \file ssl/ssl_conf.c \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>
70 * structure holding name tables. This is used for pemitted elements in lists
71 * 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}
105 * Opaque structure containing SSL configuration context.
108 struct ssl_conf_ctx_st {
110 * Various flags indicating (among other things) which options we will
114 /* Prefix and length of commands */
117 /* SSL_CTX or SSL structure to perform operations on */
120 /* Pointer to SSL or SSL_CTX options field or NULL if none */
121 unsigned long *poptions;
122 /* Certificate filenames for each type */
123 char *cert_filename[SSL_PKEY_NUM];
124 /* Pointer to SSL or SSL_CTX cert_flags or NULL if none */
125 unsigned int *pcert_flags;
126 /* Current flag table being worked on */
127 const ssl_flag_tbl *tbl;
132 static int ssl_match_option(SSL_CONF_CTX *cctx, const ssl_flag_tbl *tbl,
133 const char *name, int namelen, int onoff)
135 /* If name not relevant for context skip */
136 if (!(cctx->flags & tbl->name_flags & SSL_TFLAG_BOTH))
139 if (strcmp(tbl->name, name))
141 } else if (tbl->namelen != namelen
142 || strncasecmp(tbl->name, name, namelen))
144 if (cctx->poptions) {
145 if (tbl->name_flags & SSL_TFLAG_INV)
147 if (tbl->name_flags & SSL_TFLAG_CERT) {
149 *cctx->pcert_flags |= tbl->option_value;
151 *cctx->pcert_flags &= ~tbl->option_value;
154 *cctx->poptions |= tbl->option_value;
156 *cctx->poptions &= ~tbl->option_value;
162 static int ssl_set_option_list(const char *elem, int len, void *usr)
164 SSL_CONF_CTX *cctx = usr;
166 const ssl_flag_tbl *tbl;
169 * len == -1 indicates not being called in list context, just for single
170 * command line switches, so don't allow +, -.
179 } else if (*elem == '-') {
185 for (i = 0, tbl = cctx->tbl; i < cctx->ntbl; i++, tbl++) {
186 if (ssl_match_option(cctx, tbl, elem, len, onoff))
192 /* Single command line switches with no argument e.g. -no_ssl3 */
193 static int ctrl_str_option(SSL_CONF_CTX *cctx, const char *cmd)
195 static const ssl_flag_tbl ssl_option_single[] = {
196 SSL_FLAG_TBL("no_ssl3", SSL_OP_NO_SSLv3),
197 SSL_FLAG_TBL("no_tls1", SSL_OP_NO_TLSv1),
198 SSL_FLAG_TBL("no_tls1_1", SSL_OP_NO_TLSv1_1),
199 SSL_FLAG_TBL("no_tls1_2", SSL_OP_NO_TLSv1_2),
200 SSL_FLAG_TBL("bugs", SSL_OP_ALL),
201 SSL_FLAG_TBL("no_comp", SSL_OP_NO_COMPRESSION),
202 SSL_FLAG_TBL_SRV("ecdh_single", SSL_OP_SINGLE_ECDH_USE),
203 #ifndef OPENSSL_NO_TLSEXT
204 SSL_FLAG_TBL("no_ticket", SSL_OP_NO_TICKET),
206 SSL_FLAG_TBL_SRV("serverpref", SSL_OP_CIPHER_SERVER_PREFERENCE),
207 SSL_FLAG_TBL("legacy_renegotiation",
208 SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION),
209 SSL_FLAG_TBL_SRV("legacy_server_connect",
210 SSL_OP_LEGACY_SERVER_CONNECT),
211 SSL_FLAG_TBL_SRV("no_resumption_on_reneg",
212 SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION),
213 SSL_FLAG_TBL_SRV_INV("no_legacy_server_connect",
214 SSL_OP_LEGACY_SERVER_CONNECT),
215 SSL_FLAG_TBL_CERT("strict", SSL_CERT_FLAG_TLS_STRICT),
216 #ifdef OPENSSL_SSL_DEBUG_BROKEN_PROTOCOL
217 SSL_FLAG_TBL_CERT("debug_broken_protocol",
218 SSL_CERT_FLAG_BROKEN_PROTOCOL),
221 cctx->tbl = ssl_option_single;
222 cctx->ntbl = sizeof(ssl_option_single) / sizeof(ssl_flag_tbl);
223 return ssl_set_option_list(cmd, -1, cctx);
226 /* Set supported signature algorithms */
227 static int cmd_SignatureAlgorithms(SSL_CONF_CTX *cctx, const char *value)
231 rv = SSL_set1_sigalgs_list(cctx->ssl, value);
232 /* NB: ctx == NULL performs syntax checking only */
234 rv = SSL_CTX_set1_sigalgs_list(cctx->ctx, value);
238 /* Set supported client signature algorithms */
239 static int cmd_ClientSignatureAlgorithms(SSL_CONF_CTX *cctx,
244 rv = SSL_set1_client_sigalgs_list(cctx->ssl, value);
245 /* NB: ctx == NULL performs syntax checking only */
247 rv = SSL_CTX_set1_client_sigalgs_list(cctx->ctx, value);
251 static int cmd_Curves(SSL_CONF_CTX *cctx, const char *value)
255 rv = SSL_set1_curves_list(cctx->ssl, value);
256 /* NB: ctx == NULL performs syntax checking only */
258 rv = SSL_CTX_set1_curves_list(cctx->ctx, value);
262 #ifndef OPENSSL_NO_EC
263 /* ECDH temporary parameters */
264 static int cmd_ECDHParameters(SSL_CONF_CTX *cctx, const char *value)
266 int onoff = -1, rv = 1;
267 if (!(cctx->flags & SSL_CONF_FLAG_SERVER))
269 if (cctx->flags & SSL_CONF_FLAG_FILE) {
278 if (!strcasecmp(value, "automatic")) {
281 } else if (onoff != -1)
283 } else if (cctx->flags & SSL_CONF_FLAG_CMDLINE) {
284 if (!strcmp(value, "auto"))
290 rv = SSL_CTX_set_ecdh_auto(cctx->ctx, onoff);
292 rv = SSL_set_ecdh_auto(cctx->ssl, onoff);
296 nid = EC_curve_nist2nid(value);
297 if (nid == NID_undef)
298 nid = OBJ_sn2nid(value);
301 ecdh = EC_KEY_new_by_curve_name(nid);
305 rv = SSL_CTX_set_tmp_ecdh(cctx->ctx, ecdh);
307 rv = SSL_set_tmp_ecdh(cctx->ssl, ecdh);
314 static int cmd_CipherString(SSL_CONF_CTX *cctx, const char *value)
318 rv = SSL_CTX_set_cipher_list(cctx->ctx, value);
320 rv = SSL_set_cipher_list(cctx->ssl, value);
324 static int cmd_Protocol(SSL_CONF_CTX *cctx, const char *value)
326 static const ssl_flag_tbl ssl_protocol_list[] = {
327 SSL_FLAG_TBL_INV("ALL", SSL_OP_NO_SSL_MASK),
328 SSL_FLAG_TBL_INV("SSLv2", SSL_OP_NO_SSLv2),
329 SSL_FLAG_TBL_INV("SSLv3", SSL_OP_NO_SSLv3),
330 SSL_FLAG_TBL_INV("TLSv1", SSL_OP_NO_TLSv1),
331 SSL_FLAG_TBL_INV("TLSv1.1", SSL_OP_NO_TLSv1_1),
332 SSL_FLAG_TBL_INV("TLSv1.2", SSL_OP_NO_TLSv1_2)
334 if (!(cctx->flags & SSL_CONF_FLAG_FILE))
336 cctx->tbl = ssl_protocol_list;
337 cctx->ntbl = sizeof(ssl_protocol_list) / sizeof(ssl_flag_tbl);
338 return CONF_parse_list(value, ',', 1, ssl_set_option_list, cctx);
341 static int cmd_Options(SSL_CONF_CTX *cctx, const char *value)
343 static const ssl_flag_tbl ssl_option_list[] = {
344 SSL_FLAG_TBL_INV("SessionTicket", SSL_OP_NO_TICKET),
345 SSL_FLAG_TBL_INV("EmptyFragments",
346 SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS),
347 SSL_FLAG_TBL("Bugs", SSL_OP_ALL),
348 SSL_FLAG_TBL_INV("Compression", SSL_OP_NO_COMPRESSION),
349 SSL_FLAG_TBL_SRV("ServerPreference", SSL_OP_CIPHER_SERVER_PREFERENCE),
350 SSL_FLAG_TBL_SRV("NoResumptionOnRenegotiation",
351 SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION),
352 SSL_FLAG_TBL_SRV("DHSingle", SSL_OP_SINGLE_DH_USE),
353 SSL_FLAG_TBL_SRV("ECDHSingle", SSL_OP_SINGLE_ECDH_USE),
354 SSL_FLAG_TBL("UnsafeLegacyRenegotiation",
355 SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION),
357 if (!(cctx->flags & SSL_CONF_FLAG_FILE))
361 cctx->tbl = ssl_option_list;
362 cctx->ntbl = sizeof(ssl_option_list) / sizeof(ssl_flag_tbl);
363 return CONF_parse_list(value, ',', 1, ssl_set_option_list, cctx);
366 static int cmd_Certificate(SSL_CONF_CTX *cctx, const char *value)
370 if (!(cctx->flags & SSL_CONF_FLAG_CERTIFICATE))
373 rv = SSL_CTX_use_certificate_chain_file(cctx->ctx, value);
377 rv = SSL_use_certificate_file(cctx->ssl, value, SSL_FILETYPE_PEM);
380 if (rv > 0 && c && cctx->flags & SSL_CONF_FLAG_REQUIRE_PRIVATE) {
381 char **pfilename = &cctx->cert_filename[c->key - c->pkeys];
383 OPENSSL_free(*pfilename);
384 *pfilename = BUF_strdup(value);
392 static int cmd_PrivateKey(SSL_CONF_CTX *cctx, const char *value)
395 if (!(cctx->flags & SSL_CONF_FLAG_CERTIFICATE))
398 rv = SSL_CTX_use_PrivateKey_file(cctx->ctx, value, SSL_FILETYPE_PEM);
400 rv = SSL_use_PrivateKey_file(cctx->ssl, value, SSL_FILETYPE_PEM);
404 static int cmd_ServerInfoFile(SSL_CONF_CTX *cctx, const char *value)
407 if (!(cctx->flags & SSL_CONF_FLAG_CERTIFICATE))
409 if (!(cctx->flags & SSL_CONF_FLAG_SERVER))
412 rv = SSL_CTX_use_serverinfo_file(cctx->ctx, value);
416 #ifndef OPENSSL_NO_DH
417 static int cmd_DHParameters(SSL_CONF_CTX *cctx, const char *value)
422 if (!(cctx->flags & SSL_CONF_FLAG_CERTIFICATE))
424 if (cctx->ctx || cctx->ssl) {
425 in = BIO_new(BIO_s_file_internal());
428 if (BIO_read_filename(in, value) <= 0)
430 dh = PEM_read_bio_DHparams(in, NULL, NULL, NULL);
436 rv = SSL_CTX_set_tmp_dh(cctx->ctx, dh);
438 rv = SSL_set_tmp_dh(cctx->ssl, dh);
446 int (*cmd) (SSL_CONF_CTX *cctx, const char *value);
447 const char *str_file;
448 const char *str_cmdline;
449 unsigned int value_type;
452 /* Table of supported parameters */
454 #define SSL_CONF_CMD(name, cmdopt, type) \
455 {cmd_##name, #name, cmdopt, type}
457 #define SSL_CONF_CMD_STRING(name, cmdopt) \
458 SSL_CONF_CMD(name, cmdopt, SSL_CONF_TYPE_STRING)
460 static const ssl_conf_cmd_tbl ssl_conf_cmds[] = {
461 SSL_CONF_CMD_STRING(SignatureAlgorithms, "sigalgs"),
462 SSL_CONF_CMD_STRING(ClientSignatureAlgorithms, "client_sigalgs"),
463 SSL_CONF_CMD_STRING(Curves, "curves"),
464 #ifndef OPENSSL_NO_EC
465 SSL_CONF_CMD_STRING(ECDHParameters, "named_curve"),
467 SSL_CONF_CMD_STRING(CipherString, "cipher"),
468 SSL_CONF_CMD_STRING(Protocol, NULL),
469 SSL_CONF_CMD_STRING(Options, NULL),
470 SSL_CONF_CMD(Certificate, "cert", SSL_CONF_TYPE_FILE),
471 SSL_CONF_CMD(PrivateKey, "key", SSL_CONF_TYPE_FILE),
472 SSL_CONF_CMD(ServerInfoFile, NULL, SSL_CONF_TYPE_FILE),
473 #ifndef OPENSSL_NO_DH
474 SSL_CONF_CMD(DHParameters, "dhparam", SSL_CONF_TYPE_FILE)
478 static int ssl_conf_cmd_skip_prefix(SSL_CONF_CTX *cctx, const char **pcmd)
482 /* If a prefix is set, check and skip */
484 if (strlen(*pcmd) <= cctx->prefixlen)
486 if (cctx->flags & SSL_CONF_FLAG_CMDLINE &&
487 strncmp(*pcmd, cctx->prefix, cctx->prefixlen))
489 if (cctx->flags & SSL_CONF_FLAG_FILE &&
490 strncasecmp(*pcmd, cctx->prefix, cctx->prefixlen))
492 *pcmd += cctx->prefixlen;
493 } else if (cctx->flags & SSL_CONF_FLAG_CMDLINE) {
494 if (**pcmd != '-' || !(*pcmd)[1])
501 static const ssl_conf_cmd_tbl *ssl_conf_cmd_lookup(SSL_CONF_CTX *cctx,
504 const ssl_conf_cmd_tbl *t;
509 /* Look for matching parameter name in table */
510 for (i = 0, t = ssl_conf_cmds;
511 i < sizeof(ssl_conf_cmds) / sizeof(ssl_conf_cmd_tbl); i++, t++) {
512 if (cctx->flags & SSL_CONF_FLAG_CMDLINE) {
513 if (t->str_cmdline && !strcmp(t->str_cmdline, cmd))
516 if (cctx->flags & SSL_CONF_FLAG_FILE) {
517 if (t->str_file && !strcasecmp(t->str_file, cmd))
524 int SSL_CONF_cmd(SSL_CONF_CTX *cctx, const char *cmd, const char *value)
526 const ssl_conf_cmd_tbl *runcmd;
528 SSLerr(SSL_F_SSL_CONF_CMD, SSL_R_INVALID_NULL_CMD_NAME);
532 if (!ssl_conf_cmd_skip_prefix(cctx, &cmd))
535 runcmd = ssl_conf_cmd_lookup(cctx, cmd);
541 rv = runcmd->cmd(cctx, value);
546 if (cctx->flags & SSL_CONF_FLAG_SHOW_ERRORS) {
547 SSLerr(SSL_F_SSL_CONF_CMD, SSL_R_BAD_VALUE);
548 ERR_add_error_data(4, "cmd=", cmd, ", value=", value);
553 if (cctx->flags & SSL_CONF_FLAG_CMDLINE) {
554 if (ctrl_str_option(cctx, cmd))
558 if (cctx->flags & SSL_CONF_FLAG_SHOW_ERRORS) {
559 SSLerr(SSL_F_SSL_CONF_CMD, SSL_R_UNKNOWN_CMD_NAME);
560 ERR_add_error_data(2, "cmd=", cmd);
566 int SSL_CONF_cmd_argv(SSL_CONF_CTX *cctx, int *pargc, char ***pargv)
569 const char *arg = NULL, *argn;
570 if (pargc && *pargc == 0)
572 if (!pargc || *pargc > 0)
576 if (!pargc || *pargc > 1)
580 cctx->flags &= ~SSL_CONF_FLAG_FILE;
581 cctx->flags |= SSL_CONF_FLAG_CMDLINE;
582 rv = SSL_CONF_cmd(cctx, arg, argn);
584 /* Success: update pargc, pargv */
590 /* Unknown switch: indicate no arguments processed */
593 /* Some error occurred processing command, return fatal error */
599 int SSL_CONF_cmd_value_type(SSL_CONF_CTX *cctx, const char *cmd)
601 if (ssl_conf_cmd_skip_prefix(cctx, &cmd)) {
602 const ssl_conf_cmd_tbl *runcmd;
603 runcmd = ssl_conf_cmd_lookup(cctx, cmd);
605 return runcmd->value_type;
607 return SSL_CONF_TYPE_UNKNOWN;
610 SSL_CONF_CTX *SSL_CONF_CTX_new(void)
614 ret = OPENSSL_malloc(sizeof(SSL_CONF_CTX));
621 ret->poptions = NULL;
622 ret->pcert_flags = NULL;
625 for (i = 0; i < SSL_PKEY_NUM; i++)
626 ret->cert_filename[i] = NULL;
631 int SSL_CONF_CTX_finish(SSL_CONF_CTX *cctx)
633 /* See if any certificates are missing private keys */
640 if (c && cctx->flags & SSL_CONF_FLAG_REQUIRE_PRIVATE) {
641 for (i = 0; i < SSL_PKEY_NUM; i++) {
642 const char *p = cctx->cert_filename[i];
644 * If missing private key try to load one from certificate file
646 if (p && !c->pkeys[i].privatekey) {
647 if (!cmd_PrivateKey(cctx, p))
655 void SSL_CONF_CTX_free(SSL_CONF_CTX *cctx)
659 for (i = 0; i < SSL_PKEY_NUM; i++) {
660 if (cctx->cert_filename[i])
661 OPENSSL_free(cctx->cert_filename[i]);
664 OPENSSL_free(cctx->prefix);
669 unsigned int SSL_CONF_CTX_set_flags(SSL_CONF_CTX *cctx, unsigned int flags)
671 cctx->flags |= flags;
675 unsigned int SSL_CONF_CTX_clear_flags(SSL_CONF_CTX *cctx, unsigned int flags)
677 cctx->flags &= ~flags;
681 int SSL_CONF_CTX_set1_prefix(SSL_CONF_CTX *cctx, const char *pre)
685 tmp = BUF_strdup(pre);
690 OPENSSL_free(cctx->prefix);
693 cctx->prefixlen = strlen(tmp);
699 void SSL_CONF_CTX_set_ssl(SSL_CONF_CTX *cctx, SSL *ssl)
704 cctx->poptions = &ssl->options;
705 cctx->pcert_flags = &ssl->cert->cert_flags;
707 cctx->poptions = NULL;
708 cctx->pcert_flags = NULL;
712 void SSL_CONF_CTX_set_ssl_ctx(SSL_CONF_CTX *cctx, SSL_CTX *ctx)
717 cctx->poptions = &ctx->options;
718 cctx->pcert_flags = &ctx->cert->cert_flags;
720 cctx->poptions = NULL;
721 cctx->pcert_flags = NULL;