2 * Copyright 2012-2023 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 #include "ssl_local.h"
12 #include <openssl/conf.h>
13 #include <openssl/objects.h>
14 #include <openssl/decoder.h>
15 #include <openssl/core_dispatch.h>
16 #include "internal/nelem.h"
19 * structure holding name tables. This is used for permitted elements in lists
26 unsigned int name_flags
;
27 uint64_t option_value
;
30 /* Switch table: use for single command line switches like no_tls2 */
32 uint64_t option_value
;
33 unsigned int name_flags
;
36 /* Sense of name is inverted e.g. "TLSv1" will clear SSL_OP_NO_TLSv1 */
37 #define SSL_TFLAG_INV 0x1
38 /* Mask for type of flag referred to */
39 #define SSL_TFLAG_TYPE_MASK 0xf00
40 /* Flag is for options */
41 #define SSL_TFLAG_OPTION 0x000
42 /* Flag is for cert_flags */
43 #define SSL_TFLAG_CERT 0x100
44 /* Flag is for verify mode */
45 #define SSL_TFLAG_VFY 0x200
46 /* Option can only be used for clients */
47 #define SSL_TFLAG_CLIENT SSL_CONF_FLAG_CLIENT
48 /* Option can only be used for servers */
49 #define SSL_TFLAG_SERVER SSL_CONF_FLAG_SERVER
50 #define SSL_TFLAG_BOTH (SSL_TFLAG_CLIENT|SSL_TFLAG_SERVER)
52 #define SSL_FLAG_TBL(str, flag) \
53 {str, (int)(sizeof(str) - 1), SSL_TFLAG_BOTH, flag}
54 #define SSL_FLAG_TBL_SRV(str, flag) \
55 {str, (int)(sizeof(str) - 1), SSL_TFLAG_SERVER, flag}
56 #define SSL_FLAG_TBL_CLI(str, flag) \
57 {str, (int)(sizeof(str) - 1), SSL_TFLAG_CLIENT, flag}
58 #define SSL_FLAG_TBL_INV(str, flag) \
59 {str, (int)(sizeof(str) - 1), SSL_TFLAG_INV|SSL_TFLAG_BOTH, flag}
60 #define SSL_FLAG_TBL_SRV_INV(str, flag) \
61 {str, (int)(sizeof(str) - 1), SSL_TFLAG_INV|SSL_TFLAG_SERVER, flag}
62 #define SSL_FLAG_TBL_CERT(str, flag) \
63 {str, (int)(sizeof(str) - 1), SSL_TFLAG_CERT|SSL_TFLAG_BOTH, flag}
65 #define SSL_FLAG_VFY_CLI(str, flag) \
66 {str, (int)(sizeof(str) - 1), SSL_TFLAG_VFY | SSL_TFLAG_CLIENT, flag}
67 #define SSL_FLAG_VFY_SRV(str, flag) \
68 {str, (int)(sizeof(str) - 1), SSL_TFLAG_VFY | SSL_TFLAG_SERVER, flag}
71 * Opaque structure containing SSL configuration context.
74 struct ssl_conf_ctx_st
{
76 * Various flags indicating (among other things) which options we will
80 /* Prefix and length of commands */
83 /* SSL_CTX or SSL structure to perform operations on */
86 /* Pointer to SSL or SSL_CTX options field or NULL if none */
88 /* Certificate filenames for each type */
89 char *cert_filename
[SSL_PKEY_NUM
];
90 /* Pointer to SSL or SSL_CTX cert_flags or NULL if none */
91 uint32_t *pcert_flags
;
92 /* Pointer to SSL or SSL_CTX verify_mode or NULL if none */
94 /* Pointer to SSL or SSL_CTX min_version field or NULL if none */
96 /* Pointer to SSL or SSL_CTX max_version field or NULL if none */
98 /* Current flag table being worked on */
99 const ssl_flag_tbl
*tbl
;
102 /* Client CA names */
103 STACK_OF(X509_NAME
) *canames
;
106 static void ssl_set_option(SSL_CONF_CTX
*cctx
, unsigned int name_flags
,
107 uint64_t option_value
, int onoff
)
111 if (cctx
->poptions
== NULL
)
113 if (name_flags
& SSL_TFLAG_INV
)
115 switch (name_flags
& SSL_TFLAG_TYPE_MASK
) {
118 pflags
= cctx
->pcert_flags
;
122 pflags
= cctx
->pvfy_flags
;
125 case SSL_TFLAG_OPTION
:
127 *cctx
->poptions
|= option_value
;
129 *cctx
->poptions
&= ~option_value
;
137 *pflags
|= option_value
;
139 *pflags
&= ~option_value
;
142 static int ssl_match_option(SSL_CONF_CTX
*cctx
, const ssl_flag_tbl
*tbl
,
143 const char *name
, int namelen
, int onoff
)
145 /* If name not relevant for context skip */
146 if (!(cctx
->flags
& tbl
->name_flags
& SSL_TFLAG_BOTH
))
149 if (strcmp(tbl
->name
, name
))
151 } else if (tbl
->namelen
!= namelen
152 || OPENSSL_strncasecmp(tbl
->name
, name
, namelen
))
154 ssl_set_option(cctx
, tbl
->name_flags
, tbl
->option_value
, onoff
);
158 static int ssl_set_option_list(const char *elem
, int len
, void *usr
)
160 SSL_CONF_CTX
*cctx
= usr
;
162 const ssl_flag_tbl
*tbl
;
165 * len == -1 indicates not being called in list context, just for single
166 * command line switches, so don't allow +, -.
175 } else if (*elem
== '-') {
181 for (i
= 0, tbl
= cctx
->tbl
; i
< cctx
->ntbl
; i
++, tbl
++) {
182 if (ssl_match_option(cctx
, tbl
, elem
, len
, onoff
))
188 /* Set supported signature algorithms */
189 static int cmd_SignatureAlgorithms(SSL_CONF_CTX
*cctx
, const char *value
)
193 rv
= SSL_set1_sigalgs_list(cctx
->ssl
, value
);
194 /* NB: ctx == NULL performs syntax checking only */
196 rv
= SSL_CTX_set1_sigalgs_list(cctx
->ctx
, value
);
200 /* Set supported client signature algorithms */
201 static int cmd_ClientSignatureAlgorithms(SSL_CONF_CTX
*cctx
, const char *value
)
205 rv
= SSL_set1_client_sigalgs_list(cctx
->ssl
, value
);
206 /* NB: ctx == NULL performs syntax checking only */
208 rv
= SSL_CTX_set1_client_sigalgs_list(cctx
->ctx
, value
);
212 static int cmd_Groups(SSL_CONF_CTX
*cctx
, const char *value
)
216 rv
= SSL_set1_groups_list(cctx
->ssl
, value
);
217 /* NB: ctx == NULL performs syntax checking only */
219 rv
= SSL_CTX_set1_groups_list(cctx
->ctx
, value
);
223 /* This is the old name for cmd_Groups - retained for backwards compatibility */
224 static int cmd_Curves(SSL_CONF_CTX
*cctx
, const char *value
)
226 return cmd_Groups(cctx
, value
);
229 /* ECDH temporary parameters */
230 static int cmd_ECDHParameters(SSL_CONF_CTX
*cctx
, const char *value
)
234 /* Ignore values supported by 1.0.2 for the automatic selection */
235 if ((cctx
->flags
& SSL_CONF_FLAG_FILE
)
236 && (OPENSSL_strcasecmp(value
, "+automatic") == 0
237 || OPENSSL_strcasecmp(value
, "automatic") == 0))
239 if ((cctx
->flags
& SSL_CONF_FLAG_CMDLINE
) &&
240 strcmp(value
, "auto") == 0)
243 /* ECDHParameters accepts a single group name */
244 if (strstr(value
, ":") != NULL
)
248 rv
= SSL_CTX_set1_groups_list(cctx
->ctx
, value
);
250 rv
= SSL_set1_groups_list(cctx
->ssl
, value
);
255 static int cmd_CipherString(SSL_CONF_CTX
*cctx
, const char *value
)
260 rv
= SSL_CTX_set_cipher_list(cctx
->ctx
, value
);
262 rv
= SSL_set_cipher_list(cctx
->ssl
, value
);
266 static int cmd_Ciphersuites(SSL_CONF_CTX
*cctx
, const char *value
)
271 rv
= SSL_CTX_set_ciphersuites(cctx
->ctx
, value
);
273 rv
= SSL_set_ciphersuites(cctx
->ssl
, value
);
277 static int cmd_Protocol(SSL_CONF_CTX
*cctx
, const char *value
)
279 static const ssl_flag_tbl ssl_protocol_list
[] = {
280 SSL_FLAG_TBL_INV("ALL", SSL_OP_NO_SSL_MASK
),
281 SSL_FLAG_TBL_INV("SSLv2", SSL_OP_NO_SSLv2
),
282 SSL_FLAG_TBL_INV("SSLv3", SSL_OP_NO_SSLv3
),
283 SSL_FLAG_TBL_INV("TLSv1", SSL_OP_NO_TLSv1
),
284 SSL_FLAG_TBL_INV("TLSv1.1", SSL_OP_NO_TLSv1_1
),
285 SSL_FLAG_TBL_INV("TLSv1.2", SSL_OP_NO_TLSv1_2
),
286 SSL_FLAG_TBL_INV("TLSv1.3", SSL_OP_NO_TLSv1_3
),
287 SSL_FLAG_TBL_INV("DTLSv1", SSL_OP_NO_DTLSv1
),
288 SSL_FLAG_TBL_INV("DTLSv1.2", SSL_OP_NO_DTLSv1_2
)
290 cctx
->tbl
= ssl_protocol_list
;
291 cctx
->ntbl
= OSSL_NELEM(ssl_protocol_list
);
292 return CONF_parse_list(value
, ',', 1, ssl_set_option_list
, cctx
);
296 * protocol_from_string - converts a protocol version string to a number
298 * Returns -1 on failure or the version on success
300 static int protocol_from_string(const char *value
)
302 struct protocol_versions
{
307 * Note: To avoid breaking previously valid configurations, we must retain
308 * legacy entries in this table even if the underlying protocol is no
309 * longer supported. This also means that the constants SSL3_VERSION, ...
310 * need to be retained indefinitely. This table can only grow, never
313 static const struct protocol_versions versions
[] = {
315 {"SSLv3", SSL3_VERSION
},
316 {"TLSv1", TLS1_VERSION
},
317 {"TLSv1.1", TLS1_1_VERSION
},
318 {"TLSv1.2", TLS1_2_VERSION
},
319 {"TLSv1.3", TLS1_3_VERSION
},
320 {"DTLSv1", DTLS1_VERSION
},
321 {"DTLSv1.2", DTLS1_2_VERSION
}
324 size_t n
= OSSL_NELEM(versions
);
326 for (i
= 0; i
< n
; i
++)
327 if (strcmp(versions
[i
].name
, value
) == 0)
328 return versions
[i
].version
;
332 static int min_max_proto(SSL_CONF_CTX
*cctx
, const char *value
, int *bound
)
337 if (cctx
->ctx
!= NULL
)
338 method_version
= cctx
->ctx
->method
->version
;
339 else if (cctx
->ssl
!= NULL
)
340 method_version
= cctx
->ssl
->defltmeth
->version
;
343 if ((new_version
= protocol_from_string(value
)) < 0)
345 return ssl_set_version_bound(method_version
, new_version
, bound
);
349 * cmd_MinProtocol - Set min protocol version
350 * @cctx: config structure to save settings in
351 * @value: The min protocol version in string form
353 * Returns 1 on success and 0 on failure.
355 static int cmd_MinProtocol(SSL_CONF_CTX
*cctx
, const char *value
)
357 return min_max_proto(cctx
, value
, cctx
->min_version
);
361 * cmd_MaxProtocol - Set max protocol version
362 * @cctx: config structure to save settings in
363 * @value: The max protocol version in string form
365 * Returns 1 on success and 0 on failure.
367 static int cmd_MaxProtocol(SSL_CONF_CTX
*cctx
, const char *value
)
369 return min_max_proto(cctx
, value
, cctx
->max_version
);
372 static int cmd_Options(SSL_CONF_CTX
*cctx
, const char *value
)
374 static const ssl_flag_tbl ssl_option_list
[] = {
375 SSL_FLAG_TBL_INV("SessionTicket", SSL_OP_NO_TICKET
),
376 SSL_FLAG_TBL_INV("EmptyFragments",
377 SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS
),
378 SSL_FLAG_TBL("Bugs", SSL_OP_ALL
),
379 SSL_FLAG_TBL_INV("Compression", SSL_OP_NO_COMPRESSION
),
380 SSL_FLAG_TBL_SRV("ServerPreference", SSL_OP_CIPHER_SERVER_PREFERENCE
),
381 SSL_FLAG_TBL_SRV("NoResumptionOnRenegotiation",
382 SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
),
383 SSL_FLAG_TBL_SRV("DHSingle", SSL_OP_SINGLE_DH_USE
),
384 SSL_FLAG_TBL_SRV("ECDHSingle", SSL_OP_SINGLE_ECDH_USE
),
385 SSL_FLAG_TBL("UnsafeLegacyRenegotiation",
386 SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION
),
387 SSL_FLAG_TBL("UnsafeLegacyServerConnect",
388 SSL_OP_LEGACY_SERVER_CONNECT
),
389 SSL_FLAG_TBL("ClientRenegotiation",
390 SSL_OP_ALLOW_CLIENT_RENEGOTIATION
),
391 SSL_FLAG_TBL_INV("EncryptThenMac", SSL_OP_NO_ENCRYPT_THEN_MAC
),
392 SSL_FLAG_TBL("NoRenegotiation", SSL_OP_NO_RENEGOTIATION
),
393 SSL_FLAG_TBL("AllowNoDHEKEX", SSL_OP_ALLOW_NO_DHE_KEX
),
394 SSL_FLAG_TBL("PrioritizeChaCha", SSL_OP_PRIORITIZE_CHACHA
),
395 SSL_FLAG_TBL("MiddleboxCompat", SSL_OP_ENABLE_MIDDLEBOX_COMPAT
),
396 SSL_FLAG_TBL_INV("AntiReplay", SSL_OP_NO_ANTI_REPLAY
),
397 SSL_FLAG_TBL_INV("ExtendedMasterSecret", SSL_OP_NO_EXTENDED_MASTER_SECRET
),
398 SSL_FLAG_TBL_INV("CANames", SSL_OP_DISABLE_TLSEXT_CA_NAMES
),
399 SSL_FLAG_TBL("KTLS", SSL_OP_ENABLE_KTLS
),
400 SSL_FLAG_TBL_CERT("StrictCertCheck", SSL_CERT_FLAG_TLS_STRICT
),
401 SSL_FLAG_TBL_INV("TxCertificateCompression", SSL_OP_NO_TX_CERTIFICATE_COMPRESSION
),
402 SSL_FLAG_TBL_INV("RxCertificateCompression", SSL_OP_NO_RX_CERTIFICATE_COMPRESSION
),
403 SSL_FLAG_TBL("KTLSTxZerocopySendfile", SSL_OP_ENABLE_KTLS_TX_ZEROCOPY_SENDFILE
),
404 SSL_FLAG_TBL("IgnoreUnexpectedEOF", SSL_OP_IGNORE_UNEXPECTED_EOF
),
408 cctx
->tbl
= ssl_option_list
;
409 cctx
->ntbl
= OSSL_NELEM(ssl_option_list
);
410 return CONF_parse_list(value
, ',', 1, ssl_set_option_list
, cctx
);
413 static int cmd_VerifyMode(SSL_CONF_CTX
*cctx
, const char *value
)
415 static const ssl_flag_tbl ssl_vfy_list
[] = {
416 SSL_FLAG_VFY_CLI("Peer", SSL_VERIFY_PEER
),
417 SSL_FLAG_VFY_SRV("Request", SSL_VERIFY_PEER
),
418 SSL_FLAG_VFY_SRV("Require",
419 SSL_VERIFY_PEER
| SSL_VERIFY_FAIL_IF_NO_PEER_CERT
),
420 SSL_FLAG_VFY_SRV("Once", SSL_VERIFY_PEER
| SSL_VERIFY_CLIENT_ONCE
),
421 SSL_FLAG_VFY_SRV("RequestPostHandshake",
422 SSL_VERIFY_PEER
| SSL_VERIFY_POST_HANDSHAKE
),
423 SSL_FLAG_VFY_SRV("RequirePostHandshake",
424 SSL_VERIFY_PEER
| SSL_VERIFY_POST_HANDSHAKE
|
425 SSL_VERIFY_FAIL_IF_NO_PEER_CERT
),
429 cctx
->tbl
= ssl_vfy_list
;
430 cctx
->ntbl
= OSSL_NELEM(ssl_vfy_list
);
431 return CONF_parse_list(value
, ',', 1, ssl_set_option_list
, cctx
);
434 static int cmd_Certificate(SSL_CONF_CTX
*cctx
, const char *value
)
438 if (cctx
->ctx
!= NULL
) {
439 rv
= SSL_CTX_use_certificate_chain_file(cctx
->ctx
, value
);
442 if (cctx
->ssl
!= NULL
) {
443 SSL_CONNECTION
*sc
= SSL_CONNECTION_FROM_SSL(cctx
->ssl
);
446 rv
= SSL_use_certificate_chain_file(cctx
->ssl
, value
);
452 if (rv
> 0 && c
!= NULL
&& cctx
->flags
& SSL_CONF_FLAG_REQUIRE_PRIVATE
) {
453 char **pfilename
= &cctx
->cert_filename
[c
->key
- c
->pkeys
];
455 OPENSSL_free(*pfilename
);
456 *pfilename
= OPENSSL_strdup(value
);
457 if (*pfilename
== NULL
)
464 static int cmd_PrivateKey(SSL_CONF_CTX
*cctx
, const char *value
)
467 if (!(cctx
->flags
& SSL_CONF_FLAG_CERTIFICATE
))
470 rv
= SSL_CTX_use_PrivateKey_file(cctx
->ctx
, value
, SSL_FILETYPE_PEM
);
472 rv
= SSL_use_PrivateKey_file(cctx
->ssl
, value
, SSL_FILETYPE_PEM
);
476 static int cmd_ServerInfoFile(SSL_CONF_CTX
*cctx
, const char *value
)
480 rv
= SSL_CTX_use_serverinfo_file(cctx
->ctx
, value
);
484 static int do_store(SSL_CONF_CTX
*cctx
,
485 const char *CAfile
, const char *CApath
, const char *CAstore
,
491 OSSL_LIB_CTX
*libctx
= NULL
;
492 const char *propq
= NULL
;
494 if (cctx
->ctx
!= NULL
) {
495 cert
= cctx
->ctx
->cert
;
497 } else if (cctx
->ssl
!= NULL
) {
498 SSL_CONNECTION
*sc
= SSL_CONNECTION_FROM_SSL(cctx
->ssl
);
504 ctx
= cctx
->ssl
->ctx
;
509 libctx
= ctx
->libctx
;
512 st
= verify_store
? &cert
->verify_store
: &cert
->chain_store
;
514 *st
= X509_STORE_new();
519 if (CAfile
!= NULL
&& !X509_STORE_load_file_ex(*st
, CAfile
, libctx
, propq
))
521 if (CApath
!= NULL
&& !X509_STORE_load_path(*st
, CApath
))
523 if (CAstore
!= NULL
&& !X509_STORE_load_store_ex(*st
, CAstore
, libctx
,
529 static int cmd_ChainCAPath(SSL_CONF_CTX
*cctx
, const char *value
)
531 return do_store(cctx
, NULL
, value
, NULL
, 0);
534 static int cmd_ChainCAFile(SSL_CONF_CTX
*cctx
, const char *value
)
536 return do_store(cctx
, value
, NULL
, NULL
, 0);
539 static int cmd_ChainCAStore(SSL_CONF_CTX
*cctx
, const char *value
)
541 return do_store(cctx
, NULL
, NULL
, value
, 0);
544 static int cmd_VerifyCAPath(SSL_CONF_CTX
*cctx
, const char *value
)
546 return do_store(cctx
, NULL
, value
, NULL
, 1);
549 static int cmd_VerifyCAFile(SSL_CONF_CTX
*cctx
, const char *value
)
551 return do_store(cctx
, value
, NULL
, NULL
, 1);
554 static int cmd_VerifyCAStore(SSL_CONF_CTX
*cctx
, const char *value
)
556 return do_store(cctx
, NULL
, NULL
, value
, 1);
559 static int cmd_RequestCAFile(SSL_CONF_CTX
*cctx
, const char *value
)
561 if (cctx
->canames
== NULL
)
562 cctx
->canames
= sk_X509_NAME_new_null();
563 if (cctx
->canames
== NULL
)
565 return SSL_add_file_cert_subjects_to_stack(cctx
->canames
, value
);
568 static int cmd_ClientCAFile(SSL_CONF_CTX
*cctx
, const char *value
)
570 return cmd_RequestCAFile(cctx
, value
);
573 static int cmd_RequestCAPath(SSL_CONF_CTX
*cctx
, const char *value
)
575 if (cctx
->canames
== NULL
)
576 cctx
->canames
= sk_X509_NAME_new_null();
577 if (cctx
->canames
== NULL
)
579 return SSL_add_dir_cert_subjects_to_stack(cctx
->canames
, value
);
582 static int cmd_ClientCAPath(SSL_CONF_CTX
*cctx
, const char *value
)
584 return cmd_RequestCAPath(cctx
, value
);
587 static int cmd_RequestCAStore(SSL_CONF_CTX
*cctx
, const char *value
)
589 if (cctx
->canames
== NULL
)
590 cctx
->canames
= sk_X509_NAME_new_null();
591 if (cctx
->canames
== NULL
)
593 return SSL_add_store_cert_subjects_to_stack(cctx
->canames
, value
);
596 static int cmd_ClientCAStore(SSL_CONF_CTX
*cctx
, const char *value
)
598 return cmd_RequestCAStore(cctx
, value
);
601 static int cmd_DHParameters(SSL_CONF_CTX
*cctx
, const char *value
)
604 EVP_PKEY
*dhpkey
= NULL
;
606 SSL_CTX
*sslctx
= (cctx
->ssl
!= NULL
) ? cctx
->ssl
->ctx
: cctx
->ctx
;
607 OSSL_DECODER_CTX
*decoderctx
= NULL
;
609 if (cctx
->ctx
!= NULL
|| cctx
->ssl
!= NULL
) {
610 in
= BIO_new(BIO_s_file());
613 if (BIO_read_filename(in
, value
) <= 0)
617 = OSSL_DECODER_CTX_new_for_pkey(&dhpkey
, "PEM", NULL
, "DH",
618 OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS
,
619 sslctx
->libctx
, sslctx
->propq
);
620 if (decoderctx
== NULL
)
623 while (!OSSL_DECODER_from_bio(decoderctx
, in
)
626 OSSL_DECODER_CTX_free(decoderctx
);
628 if (dhpkey
== NULL
) {
629 ERR_clear_last_mark();
637 if (cctx
->ctx
!= NULL
) {
638 if ((rv
= SSL_CTX_set0_tmp_dh_pkey(cctx
->ctx
, dhpkey
)) > 0)
641 if (cctx
->ssl
!= NULL
) {
642 if ((rv
= SSL_set0_tmp_dh_pkey(cctx
->ssl
, dhpkey
)) > 0)
646 EVP_PKEY_free(dhpkey
);
651 static int cmd_RecordPadding(SSL_CONF_CTX
*cctx
, const char *value
)
654 int block_size
= atoi(value
);
657 * All we care about is a non-negative value,
658 * the setters check the range
660 if (block_size
>= 0) {
662 rv
= SSL_CTX_set_block_padding(cctx
->ctx
, block_size
);
664 rv
= SSL_set_block_padding(cctx
->ssl
, block_size
);
670 static int cmd_NumTickets(SSL_CONF_CTX
*cctx
, const char *value
)
673 int num_tickets
= atoi(value
);
675 if (num_tickets
>= 0) {
677 rv
= SSL_CTX_set_num_tickets(cctx
->ctx
, num_tickets
);
679 rv
= SSL_set_num_tickets(cctx
->ssl
, num_tickets
);
685 int (*cmd
) (SSL_CONF_CTX
*cctx
, const char *value
);
686 const char *str_file
;
687 const char *str_cmdline
;
688 unsigned short flags
;
689 unsigned short value_type
;
692 /* Table of supported parameters */
694 #define SSL_CONF_CMD(name, cmdopt, flags, type) \
695 {cmd_##name, #name, cmdopt, flags, type}
697 #define SSL_CONF_CMD_STRING(name, cmdopt, flags) \
698 SSL_CONF_CMD(name, cmdopt, flags, SSL_CONF_TYPE_STRING)
700 #define SSL_CONF_CMD_SWITCH(name, flags) \
701 {0, NULL, name, flags, SSL_CONF_TYPE_NONE}
703 /* See apps/include/opt.h if you change this table. */
704 /* The SSL_CONF_CMD_SWITCH should be the same order as ssl_cmd_switches */
705 static const ssl_conf_cmd_tbl ssl_conf_cmds
[] = {
706 SSL_CONF_CMD_SWITCH("no_ssl3", 0),
707 SSL_CONF_CMD_SWITCH("no_tls1", 0),
708 SSL_CONF_CMD_SWITCH("no_tls1_1", 0),
709 SSL_CONF_CMD_SWITCH("no_tls1_2", 0),
710 SSL_CONF_CMD_SWITCH("no_tls1_3", 0),
711 SSL_CONF_CMD_SWITCH("bugs", 0),
712 SSL_CONF_CMD_SWITCH("no_comp", 0),
713 SSL_CONF_CMD_SWITCH("comp", 0),
714 SSL_CONF_CMD_SWITCH("no_tx_cert_comp", 0),
715 SSL_CONF_CMD_SWITCH("tx_cert_comp", 0),
716 SSL_CONF_CMD_SWITCH("no_rx_cert_comp", 0),
717 SSL_CONF_CMD_SWITCH("rx_cert_comp", 0),
718 SSL_CONF_CMD_SWITCH("ecdh_single", SSL_CONF_FLAG_SERVER
),
719 SSL_CONF_CMD_SWITCH("no_ticket", 0),
720 SSL_CONF_CMD_SWITCH("serverpref", SSL_CONF_FLAG_SERVER
),
721 SSL_CONF_CMD_SWITCH("legacy_renegotiation", 0),
722 SSL_CONF_CMD_SWITCH("client_renegotiation", SSL_CONF_FLAG_SERVER
),
723 SSL_CONF_CMD_SWITCH("legacy_server_connect", SSL_CONF_FLAG_CLIENT
),
724 SSL_CONF_CMD_SWITCH("no_renegotiation", 0),
725 SSL_CONF_CMD_SWITCH("no_resumption_on_reneg", SSL_CONF_FLAG_SERVER
),
726 SSL_CONF_CMD_SWITCH("no_legacy_server_connect", SSL_CONF_FLAG_CLIENT
),
727 SSL_CONF_CMD_SWITCH("allow_no_dhe_kex", 0),
728 SSL_CONF_CMD_SWITCH("prioritize_chacha", SSL_CONF_FLAG_SERVER
),
729 SSL_CONF_CMD_SWITCH("strict", 0),
730 SSL_CONF_CMD_SWITCH("no_middlebox", 0),
731 SSL_CONF_CMD_SWITCH("anti_replay", SSL_CONF_FLAG_SERVER
),
732 SSL_CONF_CMD_SWITCH("no_anti_replay", SSL_CONF_FLAG_SERVER
),
733 SSL_CONF_CMD_SWITCH("no_etm", 0),
734 SSL_CONF_CMD_SWITCH("no_ems", 0),
735 SSL_CONF_CMD_STRING(SignatureAlgorithms
, "sigalgs", 0),
736 SSL_CONF_CMD_STRING(ClientSignatureAlgorithms
, "client_sigalgs", 0),
737 SSL_CONF_CMD_STRING(Curves
, "curves", 0),
738 SSL_CONF_CMD_STRING(Groups
, "groups", 0),
739 SSL_CONF_CMD_STRING(ECDHParameters
, "named_curve", SSL_CONF_FLAG_SERVER
),
740 SSL_CONF_CMD_STRING(CipherString
, "cipher", 0),
741 SSL_CONF_CMD_STRING(Ciphersuites
, "ciphersuites", 0),
742 SSL_CONF_CMD_STRING(Protocol
, NULL
, 0),
743 SSL_CONF_CMD_STRING(MinProtocol
, "min_protocol", 0),
744 SSL_CONF_CMD_STRING(MaxProtocol
, "max_protocol", 0),
745 SSL_CONF_CMD_STRING(Options
, NULL
, 0),
746 SSL_CONF_CMD_STRING(VerifyMode
, NULL
, 0),
747 SSL_CONF_CMD(Certificate
, "cert", SSL_CONF_FLAG_CERTIFICATE
,
749 SSL_CONF_CMD(PrivateKey
, "key", SSL_CONF_FLAG_CERTIFICATE
,
751 SSL_CONF_CMD(ServerInfoFile
, NULL
,
752 SSL_CONF_FLAG_SERVER
| SSL_CONF_FLAG_CERTIFICATE
,
754 SSL_CONF_CMD(ChainCAPath
, "chainCApath", SSL_CONF_FLAG_CERTIFICATE
,
756 SSL_CONF_CMD(ChainCAFile
, "chainCAfile", SSL_CONF_FLAG_CERTIFICATE
,
758 SSL_CONF_CMD(ChainCAStore
, "chainCAstore", SSL_CONF_FLAG_CERTIFICATE
,
759 SSL_CONF_TYPE_STORE
),
760 SSL_CONF_CMD(VerifyCAPath
, "verifyCApath", SSL_CONF_FLAG_CERTIFICATE
,
762 SSL_CONF_CMD(VerifyCAFile
, "verifyCAfile", SSL_CONF_FLAG_CERTIFICATE
,
764 SSL_CONF_CMD(VerifyCAStore
, "verifyCAstore", SSL_CONF_FLAG_CERTIFICATE
,
765 SSL_CONF_TYPE_STORE
),
766 SSL_CONF_CMD(RequestCAFile
, "requestCAFile", SSL_CONF_FLAG_CERTIFICATE
,
768 SSL_CONF_CMD(ClientCAFile
, NULL
,
769 SSL_CONF_FLAG_SERVER
| SSL_CONF_FLAG_CERTIFICATE
,
771 SSL_CONF_CMD(RequestCAPath
, NULL
, SSL_CONF_FLAG_CERTIFICATE
,
773 SSL_CONF_CMD(ClientCAPath
, NULL
,
774 SSL_CONF_FLAG_SERVER
| SSL_CONF_FLAG_CERTIFICATE
,
776 SSL_CONF_CMD(RequestCAStore
, "requestCAStore", SSL_CONF_FLAG_CERTIFICATE
,
777 SSL_CONF_TYPE_STORE
),
778 SSL_CONF_CMD(ClientCAStore
, NULL
,
779 SSL_CONF_FLAG_SERVER
| SSL_CONF_FLAG_CERTIFICATE
,
780 SSL_CONF_TYPE_STORE
),
781 SSL_CONF_CMD(DHParameters
, "dhparam",
782 SSL_CONF_FLAG_SERVER
| SSL_CONF_FLAG_CERTIFICATE
,
784 SSL_CONF_CMD_STRING(RecordPadding
, "record_padding", 0),
785 SSL_CONF_CMD_STRING(NumTickets
, "num_tickets", SSL_CONF_FLAG_SERVER
),
788 /* Supported switches: must match order of switches in ssl_conf_cmds */
789 static const ssl_switch_tbl ssl_cmd_switches
[] = {
790 {SSL_OP_NO_SSLv3
, 0}, /* no_ssl3 */
791 {SSL_OP_NO_TLSv1
, 0}, /* no_tls1 */
792 {SSL_OP_NO_TLSv1_1
, 0}, /* no_tls1_1 */
793 {SSL_OP_NO_TLSv1_2
, 0}, /* no_tls1_2 */
794 {SSL_OP_NO_TLSv1_3
, 0}, /* no_tls1_3 */
795 {SSL_OP_ALL
, 0}, /* bugs */
796 {SSL_OP_NO_COMPRESSION
, 0}, /* no_comp */
797 {SSL_OP_NO_COMPRESSION
, SSL_TFLAG_INV
}, /* comp */
798 {SSL_OP_NO_TX_CERTIFICATE_COMPRESSION
, 0}, /* no_tx_cert_comp */
799 {SSL_OP_NO_TX_CERTIFICATE_COMPRESSION
, SSL_TFLAG_INV
}, /* tx_cert_comp */
800 {SSL_OP_NO_RX_CERTIFICATE_COMPRESSION
, 0}, /* no_rx_cert_comp */
801 {SSL_OP_NO_RX_CERTIFICATE_COMPRESSION
, SSL_TFLAG_INV
}, /* rx_cert_comp */
802 {SSL_OP_SINGLE_ECDH_USE
, 0}, /* ecdh_single */
803 {SSL_OP_NO_TICKET
, 0}, /* no_ticket */
804 {SSL_OP_CIPHER_SERVER_PREFERENCE
, 0}, /* serverpref */
805 /* legacy_renegotiation */
806 {SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION
, 0},
807 /* Allow client renegotiation */
808 {SSL_OP_ALLOW_CLIENT_RENEGOTIATION
, 0},
809 /* legacy_server_connect */
810 {SSL_OP_LEGACY_SERVER_CONNECT
, 0},
811 /* no_renegotiation */
812 {SSL_OP_NO_RENEGOTIATION
, 0},
813 /* no_resumption_on_reneg */
814 {SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
, 0},
815 /* no_legacy_server_connect */
816 {SSL_OP_LEGACY_SERVER_CONNECT
, SSL_TFLAG_INV
},
817 /* allow_no_dhe_kex */
818 {SSL_OP_ALLOW_NO_DHE_KEX
, 0},
819 /* chacha reprioritization */
820 {SSL_OP_PRIORITIZE_CHACHA
, 0},
821 {SSL_CERT_FLAG_TLS_STRICT
, SSL_TFLAG_CERT
}, /* strict */
823 {SSL_OP_ENABLE_MIDDLEBOX_COMPAT
, SSL_TFLAG_INV
},
825 {SSL_OP_NO_ANTI_REPLAY
, SSL_TFLAG_INV
},
827 {SSL_OP_NO_ANTI_REPLAY
, 0},
828 /* no Encrypt-then-Mac */
829 {SSL_OP_NO_ENCRYPT_THEN_MAC
, 0},
830 /* no Extended master secret */
831 {SSL_OP_NO_EXTENDED_MASTER_SECRET
, 0},
834 static int ssl_conf_cmd_skip_prefix(SSL_CONF_CTX
*cctx
, const char **pcmd
)
836 if (pcmd
== NULL
|| *pcmd
== NULL
)
838 /* If a prefix is set, check and skip */
840 if (strlen(*pcmd
) <= cctx
->prefixlen
)
842 if (cctx
->flags
& SSL_CONF_FLAG_CMDLINE
&&
843 strncmp(*pcmd
, cctx
->prefix
, cctx
->prefixlen
))
845 if (cctx
->flags
& SSL_CONF_FLAG_FILE
&&
846 OPENSSL_strncasecmp(*pcmd
, cctx
->prefix
, cctx
->prefixlen
))
848 *pcmd
+= cctx
->prefixlen
;
849 } else if (cctx
->flags
& SSL_CONF_FLAG_CMDLINE
) {
850 if (**pcmd
!= '-' || !(*pcmd
)[1])
857 /* Determine if a command is allowed according to cctx flags */
858 static int ssl_conf_cmd_allowed(SSL_CONF_CTX
*cctx
, const ssl_conf_cmd_tbl
* t
)
860 unsigned int tfl
= t
->flags
;
861 unsigned int cfl
= cctx
->flags
;
862 if ((tfl
& SSL_CONF_FLAG_SERVER
) && !(cfl
& SSL_CONF_FLAG_SERVER
))
864 if ((tfl
& SSL_CONF_FLAG_CLIENT
) && !(cfl
& SSL_CONF_FLAG_CLIENT
))
866 if ((tfl
& SSL_CONF_FLAG_CERTIFICATE
)
867 && !(cfl
& SSL_CONF_FLAG_CERTIFICATE
))
872 static const ssl_conf_cmd_tbl
*ssl_conf_cmd_lookup(SSL_CONF_CTX
*cctx
,
875 const ssl_conf_cmd_tbl
*t
;
880 /* Look for matching parameter name in table */
881 for (i
= 0, t
= ssl_conf_cmds
; i
< OSSL_NELEM(ssl_conf_cmds
); i
++, t
++) {
882 if (ssl_conf_cmd_allowed(cctx
, t
)) {
883 if (cctx
->flags
& SSL_CONF_FLAG_CMDLINE
) {
884 if (t
->str_cmdline
&& strcmp(t
->str_cmdline
, cmd
) == 0)
887 if (cctx
->flags
& SSL_CONF_FLAG_FILE
) {
888 if (t
->str_file
&& OPENSSL_strcasecmp(t
->str_file
, cmd
) == 0)
896 static int ctrl_switch_option(SSL_CONF_CTX
*cctx
, const ssl_conf_cmd_tbl
* cmd
)
898 /* Find index of command in table */
899 size_t idx
= cmd
- ssl_conf_cmds
;
900 const ssl_switch_tbl
*scmd
;
901 /* Sanity check index */
902 if (idx
>= OSSL_NELEM(ssl_cmd_switches
))
904 /* Obtain switches entry with same index */
905 scmd
= ssl_cmd_switches
+ idx
;
906 ssl_set_option(cctx
, scmd
->name_flags
, scmd
->option_value
, 1);
910 int SSL_CONF_cmd(SSL_CONF_CTX
*cctx
, const char *cmd
, const char *value
)
912 const ssl_conf_cmd_tbl
*runcmd
;
914 ERR_raise(ERR_LIB_SSL
, SSL_R_INVALID_NULL_CMD_NAME
);
918 if (!ssl_conf_cmd_skip_prefix(cctx
, &cmd
))
921 runcmd
= ssl_conf_cmd_lookup(cctx
, cmd
);
925 if (runcmd
->value_type
== SSL_CONF_TYPE_NONE
) {
926 return ctrl_switch_option(cctx
, runcmd
);
930 rv
= runcmd
->cmd(cctx
, value
);
935 if (cctx
->flags
& SSL_CONF_FLAG_SHOW_ERRORS
)
936 ERR_raise_data(ERR_LIB_SSL
, SSL_R_BAD_VALUE
,
937 "cmd=%s, value=%s", cmd
, value
);
941 if (cctx
->flags
& SSL_CONF_FLAG_SHOW_ERRORS
)
942 ERR_raise_data(ERR_LIB_SSL
, SSL_R_UNKNOWN_CMD_NAME
, "cmd=%s", cmd
);
947 int SSL_CONF_cmd_argv(SSL_CONF_CTX
*cctx
, int *pargc
, char ***pargv
)
950 const char *arg
= NULL
, *argn
;
952 if (pargc
!= NULL
&& *pargc
== 0)
954 if (pargc
== NULL
|| *pargc
> 0)
958 if (pargc
== NULL
|| *pargc
> 1)
962 cctx
->flags
&= ~SSL_CONF_FLAG_FILE
;
963 cctx
->flags
|= SSL_CONF_FLAG_CMDLINE
;
964 rv
= SSL_CONF_cmd(cctx
, arg
, argn
);
966 /* Success: update pargc, pargv */
972 /* Unknown switch: indicate no arguments processed */
975 /* Some error occurred processing command, return fatal error */
981 int SSL_CONF_cmd_value_type(SSL_CONF_CTX
*cctx
, const char *cmd
)
983 if (ssl_conf_cmd_skip_prefix(cctx
, &cmd
)) {
984 const ssl_conf_cmd_tbl
*runcmd
;
985 runcmd
= ssl_conf_cmd_lookup(cctx
, cmd
);
987 return runcmd
->value_type
;
989 return SSL_CONF_TYPE_UNKNOWN
;
992 SSL_CONF_CTX
*SSL_CONF_CTX_new(void)
994 SSL_CONF_CTX
*ret
= OPENSSL_zalloc(sizeof(*ret
));
999 int SSL_CONF_CTX_finish(SSL_CONF_CTX
*cctx
)
1001 /* See if any certificates are missing private keys */
1005 if (cctx
->ctx
!= NULL
) {
1006 c
= cctx
->ctx
->cert
;
1007 } else if (cctx
->ssl
!= NULL
) {
1008 SSL_CONNECTION
*sc
= SSL_CONNECTION_FROM_SSL(cctx
->ssl
);
1013 if (c
!= NULL
&& cctx
->flags
& SSL_CONF_FLAG_REQUIRE_PRIVATE
) {
1014 for (i
= 0; i
< SSL_PKEY_NUM
; i
++) {
1015 const char *p
= cctx
->cert_filename
[i
];
1017 * If missing private key try to load one from certificate file
1019 if (p
&& !c
->pkeys
[i
].privatekey
) {
1020 if (!cmd_PrivateKey(cctx
, p
))
1025 if (cctx
->canames
) {
1027 SSL_set0_CA_list(cctx
->ssl
, cctx
->canames
);
1029 SSL_CTX_set0_CA_list(cctx
->ctx
, cctx
->canames
);
1031 sk_X509_NAME_pop_free(cctx
->canames
, X509_NAME_free
);
1032 cctx
->canames
= NULL
;
1037 void SSL_CONF_CTX_free(SSL_CONF_CTX
*cctx
)
1041 for (i
= 0; i
< SSL_PKEY_NUM
; i
++)
1042 OPENSSL_free(cctx
->cert_filename
[i
]);
1043 OPENSSL_free(cctx
->prefix
);
1044 sk_X509_NAME_pop_free(cctx
->canames
, X509_NAME_free
);
1049 unsigned int SSL_CONF_CTX_set_flags(SSL_CONF_CTX
*cctx
, unsigned int flags
)
1051 cctx
->flags
|= flags
;
1055 unsigned int SSL_CONF_CTX_clear_flags(SSL_CONF_CTX
*cctx
, unsigned int flags
)
1057 cctx
->flags
&= ~flags
;
1061 int SSL_CONF_CTX_set1_prefix(SSL_CONF_CTX
*cctx
, const char *pre
)
1065 tmp
= OPENSSL_strdup(pre
);
1069 OPENSSL_free(cctx
->prefix
);
1072 cctx
->prefixlen
= strlen(tmp
);
1074 cctx
->prefixlen
= 0;
1078 void SSL_CONF_CTX_set_ssl(SSL_CONF_CTX
*cctx
, SSL
*ssl
)
1083 SSL_CONNECTION
*sc
= SSL_CONNECTION_FROM_SSL(ssl
);
1087 cctx
->poptions
= &sc
->options
;
1088 cctx
->min_version
= &sc
->min_proto_version
;
1089 cctx
->max_version
= &sc
->max_proto_version
;
1090 cctx
->pcert_flags
= &sc
->cert
->cert_flags
;
1091 cctx
->pvfy_flags
= &sc
->verify_mode
;
1093 cctx
->poptions
= NULL
;
1094 cctx
->min_version
= NULL
;
1095 cctx
->max_version
= NULL
;
1096 cctx
->pcert_flags
= NULL
;
1097 cctx
->pvfy_flags
= NULL
;
1101 void SSL_CONF_CTX_set_ssl_ctx(SSL_CONF_CTX
*cctx
, SSL_CTX
*ctx
)
1106 cctx
->poptions
= &ctx
->options
;
1107 cctx
->min_version
= &ctx
->min_proto_version
;
1108 cctx
->max_version
= &ctx
->max_proto_version
;
1109 cctx
->pcert_flags
= &ctx
->cert
->cert_flags
;
1110 cctx
->pvfy_flags
= &ctx
->verify_mode
;
1112 cctx
->poptions
= NULL
;
1113 cctx
->min_version
= NULL
;
1114 cctx
->max_version
= NULL
;
1115 cctx
->pcert_flags
= NULL
;
1116 cctx
->pvfy_flags
= NULL
;