1 /* $OpenBSD: tls_config.c,v 1.65 2022/01/25 21:51:24 eric Exp $ */
3 * Copyright (c) 2014 Joel Sing <jsing@openbsd.org>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
29 #include "tls_internal.h"
31 static const char default_ca_file[] = TLS_DEFAULT_CA_FILE;
34 tls_default_ca_cert_file(void)
36 return default_ca_file;
40 tls_config_load_file(struct tls_error *error, const char *filetype,
41 const char *filename, char **buf, size_t *len)
51 if ((fd = open(filename, O_RDONLY)) == -1) {
52 tls_error_set(error, "failed to open %s file '%s'",
56 if (fstat(fd, &st) != 0) {
57 tls_error_set(error, "failed to stat %s file '%s'",
63 *len = (size_t)st.st_size;
64 if ((*buf = malloc(*len)) == NULL) {
65 tls_error_set(error, "failed to allocate buffer for "
69 n = read(fd, *buf, *len);
70 if (n < 0 || (size_t)n != *len) {
71 tls_error_set(error, "failed to read %s file '%s'",
89 tls_config_new_internal(void)
91 struct tls_config *config;
92 unsigned char sid[TLS_MAX_SESSION_ID_LENGTH];
94 if ((config = calloc(1, sizeof(*config))) == NULL)
97 if (pthread_mutex_init(&config->mutex, NULL) != 0)
100 config->refcount = 1;
101 config->session_fd = -1;
103 if ((config->keypair = tls_keypair_new()) == NULL)
107 * Default configuration.
109 if (tls_config_set_dheparams(config, "none") != 0)
111 if (tls_config_set_ecdhecurves(config, "default") != 0)
113 if (tls_config_set_ciphers(config, "secure") != 0)
116 if (tls_config_set_protocols(config, TLS_PROTOCOLS_DEFAULT) != 0)
118 if (tls_config_set_verify_depth(config, 6) != 0)
122 * Set session ID context to a random value. For the simple case
123 * of a single process server this is good enough. For multiprocess
124 * servers the session ID needs to be set by the caller.
126 arc4random_buf(sid, sizeof(sid));
127 if (tls_config_set_session_id(config, sid, sizeof(sid)) != 0)
129 config->ticket_keyrev = arc4random();
130 config->ticket_autorekey = 1;
132 tls_config_prefer_ciphers_server(config);
134 tls_config_verify(config);
139 tls_config_free(config);
146 if (tls_init() == -1)
149 return tls_config_new_internal();
153 tls_config_free(struct tls_config *config)
155 struct tls_keypair *kp, *nkp;
161 pthread_mutex_lock(&config->mutex);
162 refcount = --config->refcount;
163 pthread_mutex_unlock(&config->mutex);
168 for (kp = config->keypair; kp != NULL; kp = nkp) {
170 tls_keypair_free(kp);
173 free(config->error.msg);
176 free((char *)config->ca_mem);
177 free((char *)config->ca_path);
178 free((char *)config->ciphers);
179 free((char *)config->crl_mem);
180 free(config->ecdhecurves);
182 pthread_mutex_destroy(&config->mutex);
188 tls_config_keypair_add(struct tls_config *config, struct tls_keypair *keypair)
190 struct tls_keypair *kp;
192 kp = config->keypair;
193 while (kp->next != NULL)
200 tls_config_error(struct tls_config *config)
202 return config->error.msg;
206 tls_config_clear_keys(struct tls_config *config)
208 struct tls_keypair *kp;
210 for (kp = config->keypair; kp != NULL; kp = kp->next)
211 tls_keypair_clear_key(kp);
215 tls_config_parse_protocols(uint32_t *protocols, const char *protostr)
217 uint32_t proto, protos = 0;
221 if (protostr == NULL) {
222 *protocols = TLS_PROTOCOLS_DEFAULT;
226 if ((s = strdup(protostr)) == NULL)
230 while ((p = strsep(&q, ",:")) != NULL) {
231 while (*p == ' ' || *p == '\t')
240 if (negate && protos == 0)
241 protos = TLS_PROTOCOLS_ALL;
244 if (strcasecmp(p, "all") == 0 ||
245 strcasecmp(p, "legacy") == 0)
246 proto = TLS_PROTOCOLS_ALL;
247 else if (strcasecmp(p, "default") == 0 ||
248 strcasecmp(p, "secure") == 0)
249 proto = TLS_PROTOCOLS_DEFAULT;
250 if (strcasecmp(p, "tlsv1") == 0)
251 proto = TLS_PROTOCOL_TLSv1;
252 else if (strcasecmp(p, "tlsv1.0") == 0)
253 proto = TLS_PROTOCOL_TLSv1_0;
254 else if (strcasecmp(p, "tlsv1.1") == 0)
255 proto = TLS_PROTOCOL_TLSv1_1;
256 else if (strcasecmp(p, "tlsv1.2") == 0)
257 proto = TLS_PROTOCOL_TLSv1_2;
258 else if (strcasecmp(p, "tlsv1.3") == 0)
259 proto = TLS_PROTOCOL_TLSv1_3;
280 tls_config_parse_alpn(struct tls_config *config, const char *alpn,
281 char **alpn_data, size_t *alpn_len)
283 size_t buf_len, i, len;
292 if ((buf_len = strlen(alpn) + 1) > 65535) {
293 tls_config_set_errorx(config, "alpn too large");
297 if ((buf = malloc(buf_len)) == NULL) {
298 tls_config_set_errorx(config, "out of memory");
302 if ((s = strdup(alpn)) == NULL) {
303 tls_config_set_errorx(config, "out of memory");
309 while ((p = strsep(&q, ",")) != NULL) {
310 if ((len = strlen(p)) == 0) {
311 tls_config_set_errorx(config,
312 "alpn protocol with zero length");
316 tls_config_set_errorx(config,
317 "alpn protocol too long");
320 buf[i++] = len & 0xff;
321 memcpy(&buf[i], p, len);
340 tls_config_set_alpn(struct tls_config *config, const char *alpn)
342 return tls_config_parse_alpn(config, alpn, &config->alpn,
347 tls_config_add_keypair_file_internal(struct tls_config *config,
348 const char *cert_file, const char *key_file, const char *ocsp_file)
350 struct tls_keypair *keypair;
352 if ((keypair = tls_keypair_new()) == NULL)
354 if (tls_keypair_set_cert_file(keypair, &config->error, cert_file) != 0)
356 if (key_file != NULL &&
357 tls_keypair_set_key_file(keypair, &config->error, key_file) != 0)
359 if (ocsp_file != NULL &&
360 tls_keypair_set_ocsp_staple_file(keypair, &config->error,
364 tls_config_keypair_add(config, keypair);
369 tls_keypair_free(keypair);
374 tls_config_add_keypair_mem_internal(struct tls_config *config, const uint8_t *cert,
375 size_t cert_len, const uint8_t *key, size_t key_len,
376 const uint8_t *staple, size_t staple_len)
378 struct tls_keypair *keypair;
380 if ((keypair = tls_keypair_new()) == NULL)
382 if (tls_keypair_set_cert_mem(keypair, &config->error, cert, cert_len) != 0)
385 tls_keypair_set_key_mem(keypair, &config->error, key, key_len) != 0)
387 if (staple != NULL &&
388 tls_keypair_set_ocsp_staple_mem(keypair, &config->error, staple,
392 tls_config_keypair_add(config, keypair);
397 tls_keypair_free(keypair);
402 tls_config_add_keypair_mem(struct tls_config *config, const uint8_t *cert,
403 size_t cert_len, const uint8_t *key, size_t key_len)
405 return tls_config_add_keypair_mem_internal(config, cert, cert_len, key,
410 tls_config_add_keypair_file(struct tls_config *config,
411 const char *cert_file, const char *key_file)
413 return tls_config_add_keypair_file_internal(config, cert_file,
418 tls_config_add_keypair_ocsp_mem(struct tls_config *config, const uint8_t *cert,
419 size_t cert_len, const uint8_t *key, size_t key_len, const uint8_t *staple,
422 return tls_config_add_keypair_mem_internal(config, cert, cert_len, key,
423 key_len, staple, staple_len);
427 tls_config_add_keypair_ocsp_file(struct tls_config *config,
428 const char *cert_file, const char *key_file, const char *ocsp_file)
430 return tls_config_add_keypair_file_internal(config, cert_file,
431 key_file, ocsp_file);
435 tls_config_set_ca_file(struct tls_config *config, const char *ca_file)
437 return tls_config_load_file(&config->error, "CA", ca_file,
438 &config->ca_mem, &config->ca_len);
442 tls_config_set_ca_path(struct tls_config *config, const char *ca_path)
444 return tls_set_string(&config->ca_path, ca_path);
448 tls_config_set_ca_mem(struct tls_config *config, const uint8_t *ca, size_t len)
450 return tls_set_mem(&config->ca_mem, &config->ca_len, ca, len);
454 tls_config_set_cert_file(struct tls_config *config, const char *cert_file)
456 return tls_keypair_set_cert_file(config->keypair, &config->error,
461 tls_config_set_cert_mem(struct tls_config *config, const uint8_t *cert,
464 return tls_keypair_set_cert_mem(config->keypair, &config->error,
469 tls_config_set_ciphers(struct tls_config *config, const char *ciphers)
471 SSL_CTX *ssl_ctx = NULL;
473 if (ciphers == NULL ||
474 strcasecmp(ciphers, "default") == 0 ||
475 strcasecmp(ciphers, "secure") == 0)
476 ciphers = TLS_CIPHERS_DEFAULT;
477 else if (strcasecmp(ciphers, "compat") == 0)
478 ciphers = TLS_CIPHERS_COMPAT;
479 else if (strcasecmp(ciphers, "legacy") == 0)
480 ciphers = TLS_CIPHERS_LEGACY;
481 else if (strcasecmp(ciphers, "all") == 0 ||
482 strcasecmp(ciphers, "insecure") == 0)
483 ciphers = TLS_CIPHERS_ALL;
485 if ((ssl_ctx = SSL_CTX_new(SSLv23_method())) == NULL) {
486 tls_config_set_errorx(config, "out of memory");
489 if (SSL_CTX_set_cipher_list(ssl_ctx, ciphers) != 1) {
490 tls_config_set_errorx(config, "no ciphers for '%s'", ciphers);
494 SSL_CTX_free(ssl_ctx);
495 return tls_set_string(&config->ciphers, ciphers);
498 SSL_CTX_free(ssl_ctx);
503 tls_config_set_crl_file(struct tls_config *config, const char *crl_file)
505 return tls_config_load_file(&config->error, "CRL", crl_file,
506 &config->crl_mem, &config->crl_len);
510 tls_config_set_crl_mem(struct tls_config *config, const uint8_t *crl,
513 return tls_set_mem(&config->crl_mem, &config->crl_len, crl, len);
517 tls_config_set_dheparams(struct tls_config *config, const char *params)
521 if (params == NULL || strcasecmp(params, "none") == 0)
523 else if (strcasecmp(params, "auto") == 0)
525 else if (strcasecmp(params, "legacy") == 0)
528 tls_config_set_errorx(config, "invalid dhe param '%s'", params);
532 config->dheparams = keylen;
538 tls_config_set_ecdhecurve(struct tls_config *config, const char *curve)
541 strcasecmp(curve, "none") == 0 ||
542 strcasecmp(curve, "auto") == 0) {
543 curve = TLS_ECDHE_CURVES;
544 } else if (strchr(curve, ',') != NULL || strchr(curve, ':') != NULL) {
545 tls_config_set_errorx(config, "invalid ecdhe curve '%s'",
550 return tls_config_set_ecdhecurves(config, curve);
554 tls_config_set_ecdhecurves(struct tls_config *config, const char *curves)
556 int *curves_list = NULL, *curves_new;
557 size_t curves_num = 0;
563 free(config->ecdhecurves);
564 config->ecdhecurves = NULL;
565 config->ecdhecurves_len = 0;
567 if (curves == NULL || strcasecmp(curves, "default") == 0)
568 curves = TLS_ECDHE_CURVES;
570 if ((cs = strdup(curves)) == NULL) {
571 tls_config_set_errorx(config, "out of memory");
576 while ((p = strsep(&q, ",:")) != NULL) {
577 while (*p == ' ' || *p == '\t')
581 if (nid == NID_undef)
583 if (nid == NID_undef)
584 nid = EC_curve_nist2nid(p);
585 if (nid == NID_undef) {
586 tls_config_set_errorx(config,
587 "invalid ecdhe curve '%s'", p);
591 if ((curves_new = reallocarray(curves_list, curves_num + 1,
592 sizeof(int))) == NULL) {
593 tls_config_set_errorx(config, "out of memory");
596 curves_list = curves_new;
597 curves_list[curves_num] = nid;
601 config->ecdhecurves = curves_list;
602 config->ecdhecurves_len = curves_num;
615 tls_config_set_key_file(struct tls_config *config, const char *key_file)
617 return tls_keypair_set_key_file(config->keypair, &config->error,
622 tls_config_set_key_mem(struct tls_config *config, const uint8_t *key,
625 return tls_keypair_set_key_mem(config->keypair, &config->error,
630 tls_config_set_keypair_file_internal(struct tls_config *config,
631 const char *cert_file, const char *key_file, const char *ocsp_file)
633 if (tls_config_set_cert_file(config, cert_file) != 0)
635 if (tls_config_set_key_file(config, key_file) != 0)
637 if (ocsp_file != NULL &&
638 tls_config_set_ocsp_staple_file(config, ocsp_file) != 0)
645 tls_config_set_keypair_mem_internal(struct tls_config *config, const uint8_t *cert,
646 size_t cert_len, const uint8_t *key, size_t key_len,
647 const uint8_t *staple, size_t staple_len)
649 if (tls_config_set_cert_mem(config, cert, cert_len) != 0)
651 if (tls_config_set_key_mem(config, key, key_len) != 0)
653 if ((staple != NULL) &&
654 (tls_config_set_ocsp_staple_mem(config, staple, staple_len) != 0))
661 tls_config_set_keypair_file(struct tls_config *config,
662 const char *cert_file, const char *key_file)
664 return tls_config_set_keypair_file_internal(config, cert_file, key_file,
669 tls_config_set_keypair_mem(struct tls_config *config, const uint8_t *cert,
670 size_t cert_len, const uint8_t *key, size_t key_len)
672 return tls_config_set_keypair_mem_internal(config, cert, cert_len,
673 key, key_len, NULL, 0);
677 tls_config_set_keypair_ocsp_file(struct tls_config *config,
678 const char *cert_file, const char *key_file, const char *ocsp_file)
680 return tls_config_set_keypair_file_internal(config, cert_file, key_file,
685 tls_config_set_keypair_ocsp_mem(struct tls_config *config, const uint8_t *cert,
686 size_t cert_len, const uint8_t *key, size_t key_len,
687 const uint8_t *staple, size_t staple_len)
689 return tls_config_set_keypair_mem_internal(config, cert, cert_len,
690 key, key_len, staple, staple_len);
695 tls_config_set_protocols(struct tls_config *config, uint32_t protocols)
697 config->protocols = protocols;
703 tls_config_set_session_fd(struct tls_config *config, int session_fd)
708 if (session_fd == -1) {
709 config->session_fd = session_fd;
713 if (fstat(session_fd, &sb) == -1) {
714 tls_config_set_error(config, "failed to stat session file");
717 if (!S_ISREG(sb.st_mode)) {
718 tls_config_set_errorx(config,
719 "session file is not a regular file");
723 if (sb.st_uid != getuid()) {
724 tls_config_set_errorx(config, "session file has incorrect "
725 "owner (uid %u != %u)", sb.st_uid, getuid());
728 mugo = sb.st_mode & (S_IRWXU|S_IRWXG|S_IRWXO);
729 if (mugo != (S_IRUSR|S_IWUSR)) {
730 tls_config_set_errorx(config, "session file has incorrect "
731 "permissions (%o != 600)", mugo);
735 config->session_fd = session_fd;
741 tls_config_set_sign_cb(struct tls_config *config, tls_sign_cb cb, void *cb_arg)
743 config->use_fake_private_key = 1;
744 config->skip_private_key_check = 1;
745 config->sign_cb = cb;
746 config->sign_cb_arg = cb_arg;
752 tls_config_set_verify_depth(struct tls_config *config, int verify_depth)
754 config->verify_depth = verify_depth;
760 tls_config_prefer_ciphers_client(struct tls_config *config)
762 config->ciphers_server = 0;
766 tls_config_prefer_ciphers_server(struct tls_config *config)
768 config->ciphers_server = 1;
772 tls_config_insecure_noverifycert(struct tls_config *config)
774 config->verify_cert = 0;
778 tls_config_insecure_noverifyname(struct tls_config *config)
780 config->verify_name = 0;
784 tls_config_insecure_noverifytime(struct tls_config *config)
786 config->verify_time = 0;
790 tls_config_verify(struct tls_config *config)
792 config->verify_cert = 1;
793 config->verify_name = 1;
794 config->verify_time = 1;
798 tls_config_ocsp_require_stapling(struct tls_config *config)
800 config->ocsp_require_stapling = 1;
804 tls_config_verify_client(struct tls_config *config)
806 config->verify_client = 1;
810 tls_config_verify_client_optional(struct tls_config *config)
812 config->verify_client = 2;
816 tls_config_skip_private_key_check(struct tls_config *config)
818 config->skip_private_key_check = 1;
822 tls_config_use_fake_private_key(struct tls_config *config)
824 config->use_fake_private_key = 1;
825 config->skip_private_key_check = 1;
829 tls_config_set_ocsp_staple_file(struct tls_config *config, const char *staple_file)
831 return tls_keypair_set_ocsp_staple_file(config->keypair, &config->error,
836 tls_config_set_ocsp_staple_mem(struct tls_config *config, const uint8_t *staple,
839 return tls_keypair_set_ocsp_staple_mem(config->keypair, &config->error,
844 tls_config_set_session_id(struct tls_config *config,
845 const unsigned char *session_id, size_t len)
847 if (len > TLS_MAX_SESSION_ID_LENGTH) {
848 tls_config_set_errorx(config, "session ID too large");
851 memset(config->session_id, 0, sizeof(config->session_id));
852 memcpy(config->session_id, session_id, len);
857 tls_config_set_session_lifetime(struct tls_config *config, int lifetime)
859 if (lifetime > TLS_MAX_SESSION_TIMEOUT) {
860 tls_config_set_errorx(config, "session lifetime too large");
863 if (lifetime != 0 && lifetime < TLS_MIN_SESSION_TIMEOUT) {
864 tls_config_set_errorx(config, "session lifetime too small");
868 config->session_lifetime = lifetime;
873 tls_config_add_ticket_key(struct tls_config *config, uint32_t keyrev,
874 unsigned char *key, size_t keylen)
876 struct tls_ticket_key newkey;
879 if (TLS_TICKET_KEY_SIZE != keylen ||
880 sizeof(newkey.aes_key) + sizeof(newkey.hmac_key) > keylen) {
881 tls_config_set_errorx(config,
882 "wrong amount of ticket key data");
886 keyrev = htonl(keyrev);
887 memset(&newkey, 0, sizeof(newkey));
888 memcpy(newkey.key_name, &keyrev, sizeof(keyrev));
889 memcpy(newkey.aes_key, key, sizeof(newkey.aes_key));
890 memcpy(newkey.hmac_key, key + sizeof(newkey.aes_key),
891 sizeof(newkey.hmac_key));
892 newkey.time = time(NULL);
894 for (i = 0; i < TLS_NUM_TICKETS; i++) {
895 struct tls_ticket_key *tk = &config->ticket_keys[i];
896 if (memcmp(newkey.key_name, tk->key_name,
897 sizeof(tk->key_name)) != 0)
900 /* allow re-entry of most recent key */
901 if (i == 0 && memcmp(newkey.aes_key, tk->aes_key,
902 sizeof(tk->aes_key)) == 0 && memcmp(newkey.hmac_key,
903 tk->hmac_key, sizeof(tk->hmac_key)) == 0)
905 tls_config_set_errorx(config, "ticket key already present");
909 memmove(&config->ticket_keys[1], &config->ticket_keys[0],
910 sizeof(config->ticket_keys) - sizeof(config->ticket_keys[0]));
911 config->ticket_keys[0] = newkey;
913 config->ticket_autorekey = 0;
919 tls_config_ticket_autorekey(struct tls_config *config)
921 unsigned char key[TLS_TICKET_KEY_SIZE];
924 arc4random_buf(key, sizeof(key));
925 rv = tls_config_add_ticket_key(config, config->ticket_keyrev++, key,
927 config->ticket_autorekey = 1;