25RCSID(
"$Id: c55462d29c11ccc251d965b3fb0bb86af0e1beb7 $")
29#define LOG_PREFIX "tls"
34#include <openssl/conf.h>
35#include <openssl/pem.h>
37#include <freeradius-devel/server/module.h>
38#include <freeradius-devel/server/virtual_servers.h>
39#include <freeradius-devel/util/debug.h>
40#include <freeradius-devel/util/syserror.h>
41#include <freeradius-devel/util/rand.h>
42#include <freeradius-devel/util/math.h>
61 {
L(
"ASN1"), SSL_FILETYPE_ASN1 },
62 {
L(
"DER"), SSL_FILETYPE_ASN1 },
63 {
L(
"PEM"), SSL_FILETYPE_PEM }
65static size_t certificate_format_table_len =
NUM_ELEMENTS(certificate_format_table);
68 {
L(
"hard"), FR_TLS_CHAIN_VERIFY_HARD },
69 {
L(
"none"), FR_TLS_CHAIN_VERIFY_NONE },
70 {
L(
"soft"), FR_TLS_CHAIN_VERIFY_SOFT }
72static size_t chain_verify_mode_table_len =
NUM_ELEMENTS(chain_verify_mode_table);
75 {
L(
"auto"), FR_TLS_TICKET_AUTO },
76 {
L(
"disabled"), FR_TLS_TICKET_DISABLED },
77 {
L(
"stateful"), FR_TLS_TICKET_STATEFUL },
78 {
L(
"stateless"), FR_TLS_TICKET_STATELESS }
80static size_t cache_mode_table_len =
NUM_ELEMENTS(cache_mode_table);
83 {
L(
"all"), FR_TLS_VERIFY_MODE_ALL },
84 {
L(
"client"), FR_TLS_VERIFY_MODE_LEAF },
85 {
L(
"client-and-issuer"), FR_TLS_VERIFY_MODE_LEAF | FR_TLS_VERIFY_MODE_ISSUER },
86 {
L(
"disabled"), FR_TLS_VERIFY_MODE_DISABLED },
87 {
L(
"untrusted"), FR_TLS_VERIFY_MODE_UNTRUSTED }
89static size_t verify_mode_table_len =
NUM_ELEMENTS(verify_mode_table);
95#define TLS_TICKET_CONFIG_COMMON \
96 { FR_CONF_OFFSET_HINT_TYPE("name", FR_TYPE_STRING, fr_tls_ticket_conf_t, id_name), \
97 .dflt = "%{EAP-Type}%interpreter('server')", .quote = T_DOUBLE_QUOTED_STRING }, \
98 { FR_CONF_OFFSET("lifetime", fr_tls_ticket_conf_t, lifetime), .func = tls_ticket_lifetime_parse, .dflt = "1d" }, \
99 { FR_CONF_OFFSET_IS_SET("min_lifetime", FR_TYPE_TIME_DELTA, 0, fr_tls_ticket_conf_t, min_lifetime), \
101 { FR_CONF_OFFSET("require_extended_master_secret", fr_tls_ticket_conf_t, require_extms), .dflt = "yes" }, \
102 { FR_CONF_OFFSET("require_perfect_forward_secrecy", fr_tls_ticket_conf_t, require_pfs), .dflt = "no" }, \
103 { FR_CONF_OFFSET("session_ticket_key", fr_tls_ticket_conf_t, session_ticket_key) }, \
104 { FR_CONF_V3_DEPRECATED("enable", fr_tls_ticket_conf_t, NULL) }, \
105 { FR_CONF_V3_DEPRECATED("max_entries", fr_tls_ticket_conf_t, NULL) }, \
106 { FR_CONF_V3_DEPRECATED("persist_dir", fr_tls_ticket_conf_t, NULL) },
110 .
func = tls_conf_parse_server_cache_mode,
112 .table = cache_mode_table,
113 .len = &cache_mode_table_len
115 .dflt =
"disabled" },
116 TLS_TICKET_CONFIG_COMMON
123 .
func = tls_conf_parse_client_cache_mode,
125 .table = cache_mode_table,
126 .len = &cache_mode_table_len
128 .dflt =
"disabled" },
129 TLS_TICKET_CONFIG_COMMON
138 .table = certificate_format_table,
139 .len = &certificate_format_table_len
150 .func = tls_chain_private_key_file_parse },
152 {
FR_CONF_OFFSET(
"verify_mode", fr_tls_chain_conf_t, verify_mode),
155 .table = chain_verify_mode_table,
156 .len = &chain_verify_mode_table_len
159 {
FR_CONF_OFFSET(
"include_root_ca", fr_tls_chain_conf_t, include_root_ca), .dflt =
"no" },
167 .table = verify_mode_table,
168 .len = &verify_mode_table_len
171 {
FR_CONF_OFFSET(
"attribute_mode", fr_tls_verify_conf_t, attribute_mode),
174 .table = verify_mode_table,
175 .len = &verify_mode_table_len
177 .dflt =
"client-and-issuer" },
178 {
FR_CONF_OFFSET(
"der_decode", fr_tls_verify_conf_t, der_decode) },
182#ifdef PSK_MAX_IDENTITY_LEN
194 .subcs_type =
"fr_tls_chain_conf_t", .name2 =
CF_IDENT_ANY },
201 {
FR_CONF_OFFSET(
"verify_depth", fr_tls_conf_t, verify_depth), .dflt =
"0" },
205#ifdef PSK_MAX_IDENTITY_LEN
214 {
FR_CONF_OFFSET(
"fragment_size", fr_tls_conf_t, fragment_size), .func = tls_fragment_size_parse, .dflt =
"1024" },
215 {
FR_CONF_OFFSET(
"padding", fr_tls_conf_t, padding_block_size), .func = tls_padding_parse },
217 {
FR_CONF_OFFSET(
"disable_single_dh_use", fr_tls_conf_t, disable_single_dh_use) },
220 {
FR_CONF_OFFSET(
"cipher_suites", fr_tls_conf_t, cipher_suites) },
222 {
FR_CONF_OFFSET(
"cipher_server_preference", fr_tls_conf_t, cipher_server_preference), .dflt =
"yes" },
223#ifdef SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS
224 {
FR_CONF_OFFSET(
"allow_renegotiation", fr_tls_conf_t, allow_renegotiation), .dflt =
"no" },
227#ifndef OPENSSL_NO_ECDH
228 {
FR_CONF_OFFSET(
"ecdh_curve", fr_tls_conf_t, ecdh_curve), .dflt =
"prime256v1" },
230 {
FR_CONF_OFFSET(
"tls_max_version", fr_tls_conf_t, tls_max_version) },
232 {
FR_CONF_OFFSET(
"tls_min_version", fr_tls_conf_t, tls_min_version), .dflt =
"1.2" },
234 {
FR_CONF_OFFSET(
"client_hello_parse", fr_tls_conf_t, client_hello_parse )},
254 .
func = tls_virtual_server_cf_parse },
257 .subcs_type =
"fr_tls_chain_conf_t" },
268#ifdef PSK_MAX_IDENTITY_LEN
276 {
FR_CONF_OFFSET(
"verify_depth", fr_tls_conf_t, verify_depth), .dflt =
"0" },
282 {
FR_CONF_OFFSET(
"fragment_size", fr_tls_conf_t, fragment_size), .func = tls_fragment_size_parse, .dflt =
"1024" },
285 {
FR_CONF_OFFSET(
"cipher_suites", fr_tls_conf_t, cipher_suites) },
287#ifndef OPENSSL_NO_ECDH
288 {
FR_CONF_OFFSET(
"ecdh_curve", fr_tls_conf_t, ecdh_curve), .dflt =
"prime256v1" },
291 {
FR_CONF_OFFSET(
"tls_max_version", fr_tls_conf_t, tls_max_version) },
293 {
FR_CONF_OFFSET(
"tls_min_version", fr_tls_conf_t, tls_min_version), .dflt =
"1.2" },
303 fr_tls_conf_t *
conf = talloc_get_type_abort(
parent, fr_tls_conf_t);
315#define EXISTS(_x, _y) (cf_section_find(conf->virtual_server, _x, _y) != NULL)
317 conf->verify_certificate = EXISTS(
"verify",
"certificate");
318 conf->new_session = EXISTS(
"new",
"session");
319 conf->establish_session = EXISTS(
"establish",
"session");
320 conf->fail_session = EXISTS(
"fail",
"session");
321 conf->encode_session = EXISTS(
"encode",
"session");
322 conf->decode_session = EXISTS(
"decode",
"session");
323 conf->load_session = EXISTS(
"load",
"session");
324 conf->store_session = EXISTS(
"store",
"session");
325 conf->clear_session = EXISTS(
"clear",
"session");
326#ifdef PSK_MAX_IDENTITY_LEN
327 conf->load_psk = EXISTS(
"load",
"psk");
330 cf_log_err(ci,
"Specified virtual_server has a \"load psk { ... }\" section, "
331 "but OpenSSL was built without PSK support");
341static int tls_conf_cache_mode_set(fr_tls_conf_t *
conf,
int cache_mode,
void *
out)
346 if (cache_mode & FR_TLS_TICKET_STATELESS) {
350 if (!
conf->cache.session_ticket_key) {
353 talloc_array_length(
conf->cache.session_ticket_key));
357 *((
int *)
out) = cache_mode;
362#define CHECK_MODE(_x) \
364 if (!conf->_x ## _session) { \
365 cf_log_err(ci, "Virtual server %s must contain a \"" STRINGIFY(_x) " session { ... }\" section when session.mode = \"%s\"", cf_section_name2(conf->virtual_server), fr_table_str_by_value(cache_mode_table, cache_mode, "disabled")); \
379 fr_tls_conf_t *
conf = talloc_get_type_abort((
uint8_t *)
parent - offsetof(fr_tls_conf_t, cache), fr_tls_conf_t);
384 conf->cache.mode_is_auto = (cache_mode == FR_TLS_TICKET_AUTO);
389 if (cache_mode && !
conf->virtual_server) {
390 cf_log_err(ci,
"A virtual_server must be set when session.mode = \"%s\"",
400 switch (cache_mode) {
401 case FR_TLS_TICKET_DISABLED:
404 case FR_TLS_TICKET_STATELESS:
409 case FR_TLS_TICKET_STATEFUL:
416 case FR_TLS_TICKET_AUTO:
417 if (!
conf->encode_session) {
418 cf_log_warn(ci,
"Virtual server %s is missing an \"encode session { ... }\" section. "
419 "Rewriting session.mode = \"auto\" to \"stateful\"",
421 cache_mode = FR_TLS_TICKET_STATEFUL;
425 if (!
conf->decode_session) {
426 cf_log_warn(ci,
"Virtual server %s is missing a \"decode session { ... }\" section. "
427 "Rewriting session.mode = \"auto\" to \"stateful\"",
429 cache_mode = FR_TLS_TICKET_STATEFUL;
433 if (!
conf->load_session) {
434 cf_log_warn(ci,
"Virtual server %s is missing a \"load session { ... }\" section. "
435 "Rewriting session.mode = \"auto\" to \"stateless\"",
437 cache_mode = FR_TLS_TICKET_STATELESS;
441 if (!
conf->store_session) {
442 cf_log_warn(ci,
"Virtual server %s is missing a \"store session { ... }\" section. "
443 "Rewriting session.mode = \"auto\" to \"stateless\"",
445 cache_mode = FR_TLS_TICKET_STATELESS;
449 if (!
conf->clear_session) {
450 cf_log_warn(ci,
"Virtual server %s is missing a \"clear session { ... }\" section. "
451 "Rewriting session.mode = \"auto\" to \"stateless\"",
453 cache_mode = FR_TLS_TICKET_STATELESS;
459 return tls_conf_cache_mode_set(
conf, cache_mode,
out);
472 fr_tls_conf_t *
conf = talloc_get_type_abort((
uint8_t *)
parent - offsetof(fr_tls_conf_t, cache), fr_tls_conf_t);
480 if (cache_mode && !
conf->virtual_server) {
481 cf_log_err(ci,
"A virtual_server must be set when session.mode = \"%s\"",
486 switch (cache_mode) {
487 case FR_TLS_TICKET_DISABLED:
490 case FR_TLS_TICKET_STATELESS:
491 case FR_TLS_TICKET_AUTO:
492 cf_log_warn(ci,
"A TLS client always uses \"store session { ... }\" and "
493 "\"load session { ... }\" to store tickets. Rewriting session.mode = \"%s\" to \"stateful\"",
494 (cache_mode == FR_TLS_TICKET_AUTO) ?
"auto" :
"stateless");
495 cache_mode = FR_TLS_TICKET_STATEFUL;
498 case FR_TLS_TICKET_STATEFUL:
505 return tls_conf_cache_mode_set(
conf, cache_mode,
out);
520 if (*fragment_size < 100) {
521 cf_log_warn(ci,
"Ignoring \"fragment_size = %u\", forcing to \"fragment_size = 100\"", *fragment_size);
522 *fragment_size = 100;
524 if (*fragment_size > SSL3_RT_MAX_PLAIN_LENGTH) {
525 cf_log_warn(ci,
"Ignoring \"fragment_size = %u\", forcing to \"fragment_size = %u\"",
526 *fragment_size, (
unsigned int)SSL3_RT_MAX_PLAIN_LENGTH);
527 *fragment_size = SSL3_RT_MAX_PLAIN_LENGTH;
549 if (!*padding)
return 0;
551 if (*padding > FR_TLS_MAX_BLOCK_PADDING) {
552 cf_log_warn(ci,
"Ignoring \"padding = %u\", forcing to \"padding = %u\"",
553 *padding, (
unsigned int) FR_TLS_MAX_BLOCK_PADDING);
554 *padding = FR_TLS_MAX_BLOCK_PADDING;
557 *padding =
ROUND_UP_POW2(*padding, FR_TLS_BLOCK_PADDING_MULTIPLE);
573 cf_log_warn(ci,
"Ignoring \"lifetime = %pV\", forcing to \"lifetime = %pV\"",
586static char const *special_string =
"Apple:UsecertAdmin";
596static int tls_chain_password_certadmin(fr_tls_chain_conf_t *chain,
CONF_ITEM *ci)
599 char *password, *buf;
600 long const max_password_len = 128;
603 if (!chain->password)
return 0;
604 if (strncmp(chain->password, special_string, strlen(special_string)) != 0)
return 0;
606 snprintf(cmd,
sizeof(cmd) - 1,
"/usr/sbin/certadmin --get-private-key-passphrase \"%s\"",
607 chain->private_key_file);
609 DEBUG2(
"Getting private key passphrase using command \"%s\"", cmd);
611 cmd_pipe = popen(cmd,
"r");
613 cf_log_err(ci,
"%s command failed: Unable to get private_key_password", cmd);
614 cf_log_err(ci,
"Error reading private_key_file %s", chain->private_key_file);
618 MEM(password = talloc_array(chain,
char, max_password_len));
620 buf = fgets(password, max_password_len, cmd_pipe);
621 if (!buf || ferror(cmd_pipe)) {
624 cf_log_err(ci,
"%s command failed: Unable to get private_key_password", cmd);
625 cf_log_err(ci,
"Error reading private_key_file %s", chain->private_key_file);
631 for (buf = password; buf < (password + max_password_len); buf++) {
632 if ((
unsigned char)*buf <
' ') {
639 cf_log_err(ci,
"%s command failed: Unable to get private_key_password", cmd);
640 cf_log_err(ci,
"Error reading private_key_file %s - password is too long", chain->private_key_file);
644 DEBUG3(
"Password from command = \"%s\"", password);
646 chain->password = password;
654static int _tls_chain_conf_free(fr_tls_chain_conf_t *chain)
656 if (chain->leaf) X509_free(chain->leaf);
658 if (chain->extra) sk_X509_pop_free(chain->extra, X509_free);
660 if (chain->private_key) EVP_PKEY_free(chain->private_key);
676static X509 *tls_chain_cert_read(
CONF_ITEM *ci, FILE *fp,
int format,
bool aux)
681 case SSL_FILETYPE_PEM:
682 cert = aux ? PEM_read_X509_AUX(fp, NULL, NULL, NULL) : PEM_read_X509(fp, NULL, NULL, NULL);
684 unsigned long err = ERR_peek_last_error();
691 if ((ERR_GET_LIB(err) == ERR_LIB_PEM) && (ERR_GET_REASON(err) == PEM_R_NO_START_LINE)) {
698 case SSL_FILETYPE_ASN1:
699 return d2i_X509_fp(fp, NULL);
702 cf_log_err(ci,
"Unknown certificate format %d", format);
720 fr_tls_chain_conf_t *chain = talloc_get_type_abort(
parent, fr_tls_chain_conf_t);
729 if (tls_chain_password_certadmin(chain, ci) < 0)
return -1;
732 talloc_set_destructor(chain, _tls_chain_conf_free);
737 fp = fopen(chain->certificate_file,
"r");
739 cf_log_err(ci,
"Failed opening certificate_file \"%s\": %s", chain->certificate_file,
fr_syserror(errno));
743 chain->leaf = tls_chain_cert_read(ci, fp, chain->file_format,
true);
745 fr_tls_strerror_printf(
"No certificate found");
746 cf_log_perr(ci,
"Failed reading certificate_file \"%s\"", chain->certificate_file);
751 MEM(chain->extra = sk_X509_new_null());
752 while ((cert = tls_chain_cert_read(ci, fp, chain->file_format,
false))) {
753 if (chain->file_format != SSL_FILETYPE_PEM) {
758 MEM(sk_X509_push(chain->extra, cert) > 0);
762 if (ERR_peek_error()) {
763 fr_tls_strerror_printf(NULL);
764 cf_log_perr(ci,
"Failed reading certificate_file \"%s\"", chain->certificate_file);
771 ca_cnt = chain->ca_files ? talloc_array_length(chain->ca_files) : 0;
772 for (i = 0; i < ca_cnt; i++) {
773 fp = fopen(chain->ca_files[i],
"r");
778 cert = tls_chain_cert_read(ci, fp, chain->file_format,
false);
781 fr_tls_strerror_printf(
"No certificate found");
782 cf_log_perr(ci,
"Failed reading ca_file \"%s\"", chain->ca_files[i]);
786 MEM(sk_X509_push(chain->extra, cert) > 0);
794 fp = fopen(chain->private_key_file,
"r");
796 cf_log_err(ci,
"Failed opening private_key_file \"%s\": %s", chain->private_key_file,
fr_syserror(errno));
799 switch (chain->file_format) {
800 case SSL_FILETYPE_PEM:
801 chain->private_key = PEM_read_PrivateKey(fp, NULL, fr_tls_session_password_cb,
802 UNCONST(
char *, chain->password));
805 case SSL_FILETYPE_ASN1:
806 chain->private_key = d2i_PrivateKey_fp(fp, NULL);
814 if (!chain->private_key) {
815 fr_tls_strerror_printf(NULL);
816 cf_log_perr(ci,
"Failed reading private_key_file \"%s\"", chain->private_key_file);
820 if (X509_check_private_key(chain->leaf, chain->private_key) != 1) {
821 fr_tls_strerror_printf(NULL);
822 cf_log_perr(ci,
"Private key does not match the certificate public key");
831 for (
n = -1;
n < sk_X509_num(chain->extra);
n++) {
834 cert = (
n < 0) ? chain->leaf : sk_X509_value(chain->extra,
n);
836 cf_log_perr(ci,
"Failed parsing notAfter time of certificate %d in the chain",
n + 2);
#define store(_store, _var)
#define UNCONST(_type, _ptr)
Remove const qualification from a pointer.
#define USES_APPLE_DEPRECATED_API
#define DIAG_OFF_OPTIONAL(_x)
#define L(_str)
Helper for initialising arrays of string literals.
#define FALL_THROUGH
clang 10 doesn't recognised the FALL-THROUGH comment anymore
#define DIAG_ON_OPTIONAL(_x)
int cf_pair_parse_value(TALLOC_CTX *ctx, void *out, UNUSED void *base, CONF_ITEM *ci, conf_parser_t const *rule)
Parses a CONF_PAIR into a C data type.
#define CONF_PARSER_TERMINATOR
cf_parse_t func
Override default parsing behaviour for the specified type with a custom parsing function.
#define FR_CONF_V3_DEPRECATED(_name, _struct, _field)
conf_parser_t entry which raises an error if a deprecated v3 item is found
#define FR_CONF_OFFSET(_name, _struct, _field)
conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct
#define FR_CONF_SUBSECTION_ALLOC_MULTI(_name, _flags, _struct, _field, _subcs)
conf_parser_t which allocates one struct for each instance of a subsection
int cf_table_parse_int(UNUSED TALLOC_CTX *ctx, void *out, UNUSED void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
@ CONF_FLAG_REQUIRED
Error out if no matching CONF_PAIR is found, and no dflt value is set.
@ CONF_FLAG_MULTI
CONF_PAIR can have multiple copies.
@ CONF_FLAG_V3_DEPRECATED
If a matching CONF_PAIR is found, error out with a deprecated message.
@ CONF_FLAG_SECRET
Only print value if debug level >= 3.
@ CONF_FLAG_FILE_READABLE
File matching value must exist, and must be readable.
@ CONF_FLAG_OK_MISSING
OK if it's missing.
@ CONF_FLAG_FILE_EXISTS
File matching value must exist.
int cf_table_parse_uint8(UNUSED TALLOC_CTX *ctx, void *out, UNUSED void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
#define FR_CONF_OFFSET_FLAGS(_name, _flags, _struct, _field)
conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct
#define FR_CONF_OFFSET_SUBSECTION(_name, _flags, _struct, _field, _subcs)
conf_parser_t which populates a sub-struct using a CONF_SECTION
#define FR_CONF_OFFSET_TYPE_FLAGS(_name, _type, _flags, _struct, _field)
conf_parser_t which parses a single CONF_PAIR, writing the result to a field in a struct
Defines a CONF_PAIR to C data type mapping.
Common header for all CONF_* types.
A section grouping multiple CONF_PAIR.
char const * cf_section_name2(CONF_SECTION const *cs)
Return the second identifier of a CONF_SECTION.
CONF_SECTION * cf_section_find(CONF_SECTION const *cs, char const *name1, char const *name2)
Find a CONF_SECTION with name1 and optionally name2.
#define cf_log_err(_cf, _fmt,...)
#define cf_log_perr(_cf, _fmt,...)
#define cf_log_warn(_cf, _fmt,...)
#define cf_log_debug(_cf, _fmt,...)
#define ROUND_UP_POW2(_num, _mul)
Round up - Only works if _mul is a power of 2 but avoids division.
static fr_radius_decode_fail_t decode(TALLOC_CTX *ctx, fr_pair_list_t *reply, uint8_t *response_code, bio_handle_t *h, request_t *request, bio_request_t *u, uint8_t const request_authenticator[static RADIUS_AUTH_VECTOR_LENGTH], uint8_t *data, size_t data_len)
Decode response packet data, extracting relevant information and validating the packet.
static int encode(bio_handle_t *h, request_t *request, bio_request_t *u, uint8_t id)
void fr_rand_buffer(void *start, size_t length)
PUBLIC int snprintf(char *string, size_t length, char *format, va_alist)
char const * fr_syserror(int num)
Guaranteed to be thread-safe version of strerror.
#define fr_table_str_by_value(_table, _number, _def)
Convert an integer to a string.
An element in a lexicographically sorted array of name to num mappings.
static int talloc_const_free(void const *ptr)
Free const'd memory.
#define fr_unix_time_ispos(_a)
static fr_time_delta_t fr_time_delta_from_sec(int64_t sec)
#define fr_unix_time_gt(_a, _b)
#define fr_unix_time_wrap(_time)
static fr_unix_time_t fr_unix_time_from_time(time_t time)
Convert a time_t into out internal fr_unix_time_t.
#define fr_time_delta_gt(_a, _b)
A time delta, a difference in time measured in nanoseconds.
int fr_tls_utils_asn1time_to_epoch(time_t *out, ASN1_TIME const *asn1)
Convert OpenSSL's ASN1_TIME to an epoch time.
static fr_sbuff_err_t char size_t fr_sbuff_t size_t max
static fr_sbuff_err_t char ** out
#define fr_box_time_delta(_val)
#define fr_box_date(_val)
CONF_SECTION * virtual_server_cs(virtual_server_t const *vs)
Return the configuration section for a virtual server.
int virtual_server_cf_parse(UNUSED TALLOC_CTX *ctx, void *out, UNUSED void *parent, CONF_ITEM *ci, conf_parser_t const *rule)
Wrapper for the config parser to allow pass1 resolution of virtual servers.