2 * rlm_eap_tls.c contains the interfaces that are called from eap
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Copyright 2001 hereUare Communications, Inc. <raghud@hereuare.com>
21 * Copyright 2003 Alan DeKok <aland@freeradius.org>
22 * Copyright 2006 The FreeRADIUS server project
26 #include <freeradius-devel/ident.h>
29 #include <freeradius-devel/autoconf.h>
31 #ifdef HAVE_OPENSSL_RAND_H
32 #include <openssl/rand.h>
35 #ifdef HAVE_OPENSSL_EVP_H
36 #include <openssl/evp.h>
39 #include "rlm_eap_tls.h"
42 #ifdef HAVE_SYS_STAT_H
46 static CONF_PARSER cache_config[] = {
47 { "enable", PW_TYPE_BOOLEAN,
48 offsetof(EAP_TLS_CONF, session_cache_enable), NULL, "no" },
49 { "lifetime", PW_TYPE_INTEGER,
50 offsetof(EAP_TLS_CONF, session_timeout), NULL, "24" },
51 { "max_entries", PW_TYPE_INTEGER,
52 offsetof(EAP_TLS_CONF, session_cache_size), NULL, "255" },
53 { "name", PW_TYPE_STRING_PTR,
54 offsetof(EAP_TLS_CONF, session_id_name), NULL, NULL},
55 { NULL, -1, 0, NULL, NULL } /* end the list */
58 static CONF_PARSER verify_config[] = {
59 { "tmpdir", PW_TYPE_STRING_PTR,
60 offsetof(EAP_TLS_CONF, verify_tmp_dir), NULL, NULL},
61 { "client", PW_TYPE_STRING_PTR,
62 offsetof(EAP_TLS_CONF, verify_client_cert_cmd), NULL, NULL},
63 { NULL, -1, 0, NULL, NULL } /* end the list */
66 static CONF_PARSER module_config[] = {
67 { "rsa_key_exchange", PW_TYPE_BOOLEAN,
68 offsetof(EAP_TLS_CONF, rsa_key), NULL, "no" },
69 { "dh_key_exchange", PW_TYPE_BOOLEAN,
70 offsetof(EAP_TLS_CONF, dh_key), NULL, "yes" },
71 { "rsa_key_length", PW_TYPE_INTEGER,
72 offsetof(EAP_TLS_CONF, rsa_key_length), NULL, "512" },
73 { "dh_key_length", PW_TYPE_INTEGER,
74 offsetof(EAP_TLS_CONF, dh_key_length), NULL, "512" },
75 { "verify_depth", PW_TYPE_INTEGER,
76 offsetof(EAP_TLS_CONF, verify_depth), NULL, "0" },
77 { "CA_path", PW_TYPE_FILENAME,
78 offsetof(EAP_TLS_CONF, ca_path), NULL, NULL },
79 { "pem_file_type", PW_TYPE_BOOLEAN,
80 offsetof(EAP_TLS_CONF, file_type), NULL, "yes" },
81 { "private_key_file", PW_TYPE_FILENAME,
82 offsetof(EAP_TLS_CONF, private_key_file), NULL, NULL },
83 { "certificate_file", PW_TYPE_FILENAME,
84 offsetof(EAP_TLS_CONF, certificate_file), NULL, NULL },
85 { "CA_file", PW_TYPE_FILENAME,
86 offsetof(EAP_TLS_CONF, ca_file), NULL, NULL },
87 { "private_key_password", PW_TYPE_STRING_PTR,
88 offsetof(EAP_TLS_CONF, private_key_password), NULL, NULL },
89 { "dh_file", PW_TYPE_STRING_PTR,
90 offsetof(EAP_TLS_CONF, dh_file), NULL, NULL },
91 { "random_file", PW_TYPE_STRING_PTR,
92 offsetof(EAP_TLS_CONF, random_file), NULL, NULL },
93 { "fragment_size", PW_TYPE_INTEGER,
94 offsetof(EAP_TLS_CONF, fragment_size), NULL, "1024" },
95 { "include_length", PW_TYPE_BOOLEAN,
96 offsetof(EAP_TLS_CONF, include_length), NULL, "yes" },
97 { "check_crl", PW_TYPE_BOOLEAN,
98 offsetof(EAP_TLS_CONF, check_crl), NULL, "no"},
99 { "check_cert_cn", PW_TYPE_STRING_PTR,
100 offsetof(EAP_TLS_CONF, check_cert_cn), NULL, NULL},
101 { "cipher_list", PW_TYPE_STRING_PTR,
102 offsetof(EAP_TLS_CONF, cipher_list), NULL, NULL},
103 { "check_cert_issuer", PW_TYPE_STRING_PTR,
104 offsetof(EAP_TLS_CONF, check_cert_issuer), NULL, NULL},
105 { "make_cert_command", PW_TYPE_STRING_PTR,
106 offsetof(EAP_TLS_CONF, make_cert_command), NULL, NULL},
108 { "cache", PW_TYPE_SUBSECTION, 0, NULL, (const void *) cache_config },
110 { "verify", PW_TYPE_SUBSECTION, 0, NULL, (const void *) verify_config },
112 { NULL, -1, 0, NULL, NULL } /* end the list */
117 * TODO: Check for the type of key exchange * like conf->dh_key
119 static int load_dh_params(SSL_CTX *ctx, char *file)
124 if ((bio = BIO_new_file(file, "r")) == NULL) {
125 radlog(L_ERR, "rlm_eap_tls: Unable to open DH file - %s", file);
129 dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
132 DEBUG2("WARNING: rlm_eap_tls: Unable to set DH parameters. DH cipher suites may not work!");
133 DEBUG2("WARNING: Fix this by running the OpenSSL command listed in eap.conf");
137 if (SSL_CTX_set_tmp_dh(ctx, dh) < 0) {
138 radlog(L_ERR, "rlm_eap_tls: Unable to set DH parameters");
149 * Generate ephemeral RSA keys.
151 static int generate_eph_rsa_key(SSL_CTX *ctx)
155 rsa = RSA_generate_key(512, RSA_F4, NULL, NULL);
157 if (!SSL_CTX_set_tmp_rsa(ctx, rsa)) {
158 radlog(L_ERR, "rlm_eap_tls: Couldn't set ephemeral RSA key");
168 * These functions don't do anything other than print debugging
171 * FIXME: Write sessions to some long-term storage, so that
172 * session resumption can still occur after the server
175 #define MAX_SESSION_SIZE (256)
177 static void cbtls_remove_session(UNUSED SSL_CTX *ctx, SSL_SESSION *sess)
180 char buffer[2 * MAX_SESSION_SIZE + 1];
182 size = sess->session_id_length;
183 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
185 fr_bin2hex(sess->session_id, buffer, size);
187 DEBUG2(" SSL: Removing session %s from the cache", buffer);
188 SSL_SESSION_free(sess);
193 static int cbtls_new_session(UNUSED SSL *s, SSL_SESSION *sess)
196 char buffer[2 * MAX_SESSION_SIZE + 1];
198 size = sess->session_id_length;
199 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
201 fr_bin2hex(sess->session_id, buffer, size);
203 DEBUG2(" SSL: adding session %s to cache", buffer);
208 static SSL_SESSION *cbtls_get_session(UNUSED SSL *s,
209 unsigned char *data, int len,
213 char buffer[2 * MAX_SESSION_SIZE + 1];
216 if (size > MAX_SESSION_SIZE) size = MAX_SESSION_SIZE;
218 fr_bin2hex(data, buffer, size);
220 DEBUG2(" SSL: Client requested nonexistent cached session %s",
227 * For creating certificate attributes.
229 static const char *cert_attr_names[5][2] = {
230 { "TLS-Client-Cert-Serial", "TLS-Cert-Serial" },
231 { "TLS-Client-Cert-Expiration", "TLS-Cert-Expiration" },
232 { "TLS-Client-Cert-Subject", "TLS-Cert-Subject" },
233 { "TLS-Client-Cert-Issuer", "TLS-Cert-Issuer" },
234 { "TLS-Client-Cert-Common-Name", "TLS-Cert-Common-Name" }
237 #define EAPTLS_SERIAL (0)
238 #define EAPTLS_EXPIRATION (1)
239 #define EAPTLS_SUBJECT (2)
240 #define EAPTLS_ISSUER (3)
241 #define EAPTLS_CN (4)
244 * Before trusting a certificate, you must make sure that the
245 * certificate is 'valid'. There are several steps that your
246 * application can take in determining if a certificate is
247 * valid. Commonly used steps are:
249 * 1.Verifying the certificate's signature, and verifying that
250 * the certificate has been issued by a trusted Certificate
253 * 2.Verifying that the certificate is valid for the present date
254 * (i.e. it is being presented within its validity dates).
256 * 3.Verifying that the certificate has not been revoked by its
257 * issuing Certificate Authority, by checking with respect to a
258 * Certificate Revocation List (CRL).
260 * 4.Verifying that the credentials presented by the certificate
261 * fulfill additional requirements specific to the application,
262 * such as with respect to access control lists or with respect
263 * to OCSP (Online Certificate Status Processing).
265 * NOTE: This callback will be called multiple times based on the
266 * depth of the root certificate chain
268 static int cbtls_verify(int ok, X509_STORE_CTX *ctx)
270 char subject[1024]; /* Used for the subject name */
271 char issuer[1024]; /* Used for the issuer name */
272 char common_name[1024];
275 EAP_HANDLER *handler = NULL;
278 int err, depth, lookup;
282 ASN1_INTEGER *sn = NULL;
283 ASN1_TIME *asn_time = NULL;
285 client_cert = X509_STORE_CTX_get_current_cert(ctx);
286 err = X509_STORE_CTX_get_error(ctx);
287 depth = X509_STORE_CTX_get_error_depth(ctx);
290 if (lookup > 1) lookup = 1;
293 * Retrieve the pointer to the SSL of the connection currently treated
294 * and the application specific data stored into the SSL object.
296 ssl = X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx());
297 handler = (EAP_HANDLER *)SSL_get_ex_data(ssl, 0);
298 request = handler->request;
299 conf = (EAP_TLS_CONF *)SSL_get_ex_data(ssl, 1);
302 * Get the Serial Number
305 sn = X509_get_serialNumber(client_cert);
306 if (sn && (sn->length < (sizeof(buf) / 2))) {
310 for (i = 0; i < sn->length; i++) {
311 sprintf(p, "%02x", (unsigned int)sn->data[i]);
314 pairadd(&handler->certs,
315 pairmake(cert_attr_names[EAPTLS_SERIAL][lookup], buf, T_OP_SET));
320 * Get the Expiration Date
323 asn_time = X509_get_notAfter(client_cert);
324 if (asn_time && (asn_time->length < MAX_STRING_LEN)) {
325 memcpy(buf, (char*) asn_time->data, asn_time->length);
326 buf[asn_time->length] = '\0';
327 pairadd(&handler->certs,
328 pairmake(cert_attr_names[EAPTLS_EXPIRATION][lookup], buf, T_OP_SET));
332 * Get the Subject & Issuer
334 subject[0] = issuer[0] = '\0';
335 X509_NAME_oneline(X509_get_subject_name(client_cert), subject,
337 subject[sizeof(subject) - 1] = '\0';
338 if (subject[0] && (strlen(subject) < MAX_STRING_LEN)) {
339 pairadd(&handler->certs,
340 pairmake(cert_attr_names[EAPTLS_SUBJECT][lookup], subject, T_OP_SET));
343 X509_NAME_oneline(X509_get_issuer_name(ctx->current_cert), issuer,
345 issuer[sizeof(issuer) - 1] = '\0';
346 if (issuer[0] && (strlen(issuer) < MAX_STRING_LEN)) {
347 pairadd(&handler->certs,
348 pairmake(cert_attr_names[EAPTLS_ISSUER][lookup], issuer, T_OP_SET));
352 * Get the Common Name
354 X509_NAME_get_text_by_NID(X509_get_subject_name(client_cert),
355 NID_commonName, common_name, sizeof(common_name));
356 common_name[sizeof(common_name) - 1] = '\0';
357 if (common_name[0] && (strlen(common_name) < MAX_STRING_LEN)) {
358 pairadd(&handler->certs,
359 pairmake(cert_attr_names[EAPTLS_CN][lookup], common_name, T_OP_SET));
363 const char *p = X509_verify_cert_error_string(err);
364 radlog(L_ERR,"--> verify error:num=%d:%s\n",err, p);
365 radius_pairmake(request, &request->packet->vps,
366 "Module-Failure-Message", p, T_OP_SET);
370 switch (ctx->error) {
372 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
373 radlog(L_ERR, "issuer= %s\n", issuer);
375 case X509_V_ERR_CERT_NOT_YET_VALID:
376 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
377 radlog(L_ERR, "notBefore=");
379 ASN1_TIME_print(bio_err, X509_get_notBefore(ctx->current_cert));
382 case X509_V_ERR_CERT_HAS_EXPIRED:
383 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
384 radlog(L_ERR, "notAfter=");
386 ASN1_TIME_print(bio_err, X509_get_notAfter(ctx->current_cert));
392 * If we're at the actual client cert, apply additional
397 * If the conf tells us to, check cert issuer
398 * against the specified value and fail
399 * verification if they don't match.
401 if (conf->check_cert_issuer &&
402 (strcmp(issuer, conf->check_cert_issuer) != 0)) {
403 radlog(L_AUTH, "rlm_eap_tls: Certificate issuer (%s) does not match specified value (%s)!", issuer, conf->check_cert_issuer);
408 * If the conf tells us to, check the CN in the
409 * cert against xlat'ed value, but only if the
410 * previous checks passed.
412 if (my_ok && conf->check_cert_cn) {
413 if (!radius_xlat(cn_str, sizeof(cn_str), conf->check_cert_cn, handler->request, NULL)) {
414 radlog(L_ERR, "rlm_eap_tls (%s): xlat failed.",
415 conf->check_cert_cn);
416 /* if this fails, fail the verification */
419 RDEBUG2("checking certificate CN (%s) with xlat'ed value (%s)", common_name, cn_str);
420 if (strcmp(cn_str, common_name) != 0) {
421 radlog(L_AUTH, "rlm_eap_tls: Certificate CN (%s) does not match specified value (%s)!", common_name, cn_str);
425 } /* check_cert_cn */
427 while (conf->verify_client_cert_cmd) {
431 snprintf(filename, sizeof(filename), "%s/%s.client.XXXXXXXX",
432 conf->verify_tmp_dir, progname);
433 if (mkstemp(filename) < 0) {
434 RDEBUG("Failed creating file in %s: %s",
435 conf->verify_tmp_dir, strerror(errno));
439 fp = fopen(filename, "w");
441 RDEBUG("Failed opening file %s: %s",
442 filename, strerror(errno));
446 if (!PEM_write_X509(fp, client_cert)) {
448 RDEBUG("Failed writing certificate to file");
453 if (!radius_pairmake(request, &request->packet->vps,
454 "TLS-Client-Cert-Filename",
455 filename, T_OP_SET)) {
456 RDEBUG("Failed creating TLS-Client-Cert-Filename");
461 RDEBUG("Verifying client certificate: %s",
462 conf->verify_client_cert_cmd);
463 if (radius_exec_program(conf->verify_client_cert_cmd,
465 request->packet->vps,
467 radlog(L_AUTH, "rlm_eap_tls: Certificate CN (%s) fails external verification!", common_name);
470 RDEBUG("Client certificate CN %s passed external validation", common_name);
481 if (debug_flag > 0) {
482 RDEBUG2("chain-depth=%d, ", depth);
483 RDEBUG2("error=%d", err);
485 RDEBUG2("--> User-Name = %s", handler->identity);
486 RDEBUG2("--> BUF-Name = %s", common_name);
487 RDEBUG2("--> subject = %s", subject);
488 RDEBUG2("--> issuer = %s", issuer);
489 RDEBUG2("--> verify return:%d", my_ok);
496 * Free cached session data, which is always a list of VALUE_PAIRs
498 static void eaptls_session_free(UNUSED void *parent, void *data_ptr,
499 UNUSED CRYPTO_EX_DATA *ad, UNUSED int idx,
500 UNUSED long argl, UNUSED void *argp)
502 VALUE_PAIR *vp = data_ptr;
503 if (!data_ptr) return;
510 * Create Global context SSL and use it in every new session
512 * - Load the trusted CAs
513 * - Load the Private key & the certificate
514 * - Set the Context options & Verify options
516 static SSL_CTX *init_tls_ctx(EAP_TLS_CONF *conf)
520 X509_STORE *certstore;
521 int verify_mode = SSL_VERIFY_NONE;
526 * Add all the default ciphers and message digests
527 * Create our context.
530 SSL_load_error_strings();
533 * SHA256 is in all versions of OpenSSL, but isn't
534 * initialized by default. It's needed for WiMAX
537 #ifdef HAVE_OPENSSL_EVP_SHA256
538 EVP_add_digest(EVP_sha256());
541 meth = TLSv1_method();
542 ctx = SSL_CTX_new(meth);
545 * Identify the type of certificates that needs to be loaded
547 if (conf->file_type) {
548 type = SSL_FILETYPE_PEM;
550 type = SSL_FILETYPE_ASN1;
554 * Set the password to load private key
556 if (conf->private_key_password) {
559 * We don't want to put the private key password in eap.conf, so check
560 * for our special string which indicates we should get the password
563 const char* special_string = "Apple:UseCertAdmin";
564 if (strncmp(conf->private_key_password,
566 strlen(special_string)) == 0)
569 const long max_password_len = 128;
570 snprintf(cmd, sizeof(cmd) - 1,
571 "/usr/sbin/certadmin --get-private-key-passphrase \"%s\"",
572 conf->private_key_file);
574 DEBUG2("rlm_eap: Getting private key passphrase using command \"%s\"", cmd);
576 FILE* cmd_pipe = popen(cmd, "r");
578 radlog(L_ERR, "rlm_eap: %s command failed. Unable to get private_key_password", cmd);
579 radlog(L_ERR, "rlm_eap: Error reading private_key_file %s", conf->private_key_file);
583 free(conf->private_key_password);
584 conf->private_key_password = malloc(max_password_len * sizeof(char));
585 if (!conf->private_key_password) {
586 radlog(L_ERR, "rlm_eap: Can't malloc space for private_key_password");
587 radlog(L_ERR, "rlm_eap: Error reading private_key_file %s", conf->private_key_file);
592 fgets(conf->private_key_password, max_password_len, cmd_pipe);
595 /* Get rid of newline at end of password. */
596 conf->private_key_password[strlen(conf->private_key_password) - 1] = '\0';
597 DEBUG2("rlm_eap: Password from command = \"%s\"", conf->private_key_password);
600 SSL_CTX_set_default_passwd_cb_userdata(ctx, conf->private_key_password);
601 SSL_CTX_set_default_passwd_cb(ctx, cbtls_password);
605 * Load our keys and certificates
607 * If certificates are of type PEM then we can make use
608 * of cert chain authentication using openssl api call
609 * SSL_CTX_use_certificate_chain_file. Please see how
610 * the cert chain needs to be given in PEM from
613 if (type == SSL_FILETYPE_PEM) {
614 if (!(SSL_CTX_use_certificate_chain_file(ctx, conf->certificate_file))) {
615 radlog(L_ERR, "rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
616 radlog(L_ERR, "rlm_eap_tls: Error reading certificate file %s", conf->certificate_file);
620 } else if (!(SSL_CTX_use_certificate_file(ctx, conf->certificate_file, type))) {
621 radlog(L_ERR, "rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
622 radlog(L_ERR, "rlm_eap_tls: Error reading certificate file %s", conf->certificate_file);
626 /* Load the CAs we trust */
627 if (conf->ca_file || conf->ca_path) {
628 if (!SSL_CTX_load_verify_locations(ctx, conf->ca_file, conf->ca_path)) {
629 radlog(L_ERR, "rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
630 radlog(L_ERR, "rlm_eap_tls: Error reading Trusted root CA list %s",conf->ca_file );
634 if (conf->ca_file && *conf->ca_file) SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(conf->ca_file));
635 if (!(SSL_CTX_use_PrivateKey_file(ctx, conf->private_key_file, type))) {
636 radlog(L_ERR, "rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
637 radlog(L_ERR, "rlm_eap_tls: Error reading private key file %s", conf->private_key_file);
642 * Check if the loaded private key is the right one
644 if (!SSL_CTX_check_private_key(ctx)) {
645 radlog(L_ERR, "rlm_eap_tls: Private key does not match the certificate public key");
652 ctx_options |= SSL_OP_NO_SSLv2;
653 ctx_options |= SSL_OP_NO_SSLv3;
654 #ifdef SSL_OP_NO_TICKET
655 ctx_options |= SSL_OP_NO_TICKET ;
659 * SSL_OP_SINGLE_DH_USE must be used in order to prevent
660 * small subgroup attacks and forward secrecy. Always
663 * SSL_OP_SINGLE_DH_USE has an impact on the computer
664 * time needed during negotiation, but it is not very
667 ctx_options |= SSL_OP_SINGLE_DH_USE;
670 * SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS to work around issues
671 * in Windows Vista client.
672 * http://www.openssl.org/~bodo/tls-cbc.txt
673 * http://www.nabble.com/(RADIATOR)-Radiator-Version-3.16-released-t2600070.html
675 ctx_options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
677 SSL_CTX_set_options(ctx, ctx_options);
680 * TODO: Set the RSA & DH
681 * SSL_CTX_set_tmp_rsa_callback(ctx, cbtls_rsa);
682 * SSL_CTX_set_tmp_dh_callback(ctx, cbtls_dh);
686 * set the message callback to identify the type of
687 * message. For every new session, there can be a
688 * different callback argument.
690 * SSL_CTX_set_msg_callback(ctx, cbtls_msg);
693 /* Set Info callback */
694 SSL_CTX_set_info_callback(ctx, cbtls_info);
697 * Callbacks, etc. for session resumption.
699 if (conf->session_cache_enable) {
700 SSL_CTX_sess_set_new_cb(ctx, cbtls_new_session);
701 SSL_CTX_sess_set_get_cb(ctx, cbtls_get_session);
702 SSL_CTX_sess_set_remove_cb(ctx, cbtls_remove_session);
704 SSL_CTX_set_quiet_shutdown(ctx, 1);
708 * Check the certificates for revocation.
710 #ifdef X509_V_FLAG_CRL_CHECK
711 if (conf->check_crl) {
712 certstore = SSL_CTX_get_cert_store(ctx);
713 if (certstore == NULL) {
714 radlog(L_ERR, "rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
715 radlog(L_ERR, "rlm_eap_tls: Error reading Certificate Store");
718 X509_STORE_set_flags(certstore, X509_V_FLAG_CRL_CHECK);
724 * Always verify the peer certificate
726 verify_mode |= SSL_VERIFY_PEER;
727 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
728 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
729 SSL_CTX_set_verify(ctx, verify_mode, cbtls_verify);
731 if (conf->verify_depth) {
732 SSL_CTX_set_verify_depth(ctx, conf->verify_depth);
735 /* Load randomness */
736 if (!(RAND_load_file(conf->random_file, 1024*1024))) {
737 radlog(L_ERR, "rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
738 radlog(L_ERR, "rlm_eap_tls: Error loading randomness");
743 * Set the cipher list if we were told to
745 if (conf->cipher_list) {
746 if (!SSL_CTX_set_cipher_list(ctx, conf->cipher_list)) {
747 radlog(L_ERR, "rlm_eap_tls: Error setting cipher list");
753 * Setup session caching
755 if (conf->session_cache_enable) {
757 * Create a unique context Id per EAP-TLS configuration.
759 if (conf->session_id_name) {
760 snprintf(conf->session_context_id,
761 sizeof(conf->session_context_id),
762 "FreeRADIUS EAP-TLS %s",
763 conf->session_id_name);
765 snprintf(conf->session_context_id,
766 sizeof(conf->session_context_id),
767 "FreeRADIUS EAP-TLS %p", conf);
771 * Cache it, and DON'T auto-clear it.
773 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_SERVER | SSL_SESS_CACHE_NO_AUTO_CLEAR);
775 SSL_CTX_set_session_id_context(ctx,
776 (unsigned char *) conf->session_context_id,
777 (unsigned int) strlen(conf->session_context_id));
780 * Our timeout is in hours, this is in seconds.
782 SSL_CTX_set_timeout(ctx, conf->session_timeout * 3600);
785 * Set the maximum number of entries in the
788 SSL_CTX_sess_set_cache_size(ctx, conf->session_cache_size);
791 SSL_CTX_set_session_cache_mode(ctx, SSL_SESS_CACHE_OFF);
795 * Register the application indices. We can't use
796 * hard-coded "0" and "1" as before, because we need to
797 * set up a "free" handler for the cached session
800 if (eaptls_handle_idx < 0) {
801 eaptls_handle_idx = SSL_get_ex_new_index(0, "eaptls_handle_idx",
805 if (eaptls_conf_idx < 0) {
806 eaptls_conf_idx = SSL_get_ex_new_index(0, "eaptls_conf_idx",
810 if (eaptls_session_idx < 0) {
811 eaptls_session_idx = SSL_get_ex_new_index(0, "eaptls_session_idx",
813 eaptls_session_free);
821 * Detach the EAP-TLS module.
823 static int eaptls_detach(void *arg)
828 inst = (eap_tls_t *) arg;
832 memset(conf, 0, sizeof(*conf));
837 if (inst->ctx) SSL_CTX_free(inst->ctx);
847 * Attach the EAP-TLS module.
849 static int eaptls_attach(CONF_SECTION *cs, void **instance)
854 /* Store all these values in the data structure for later references */
855 inst = (eap_tls_t *)malloc(sizeof(*inst));
857 radlog(L_ERR, "rlm_eap_tls: out of memory");
860 memset(inst, 0, sizeof(*inst));
863 * Parse the config file & get all the configured values
865 conf = (EAP_TLS_CONF *)malloc(sizeof(*conf));
868 radlog(L_ERR, "rlm_eap_tls: out of memory");
871 memset(conf, 0, sizeof(*conf));
874 if (cf_section_parse(cs, conf, module_config) < 0) {
880 * The EAP RFC's say 1020, but we're less picky.
882 if (conf->fragment_size < 100) {
883 radlog(L_ERR, "rlm_eap_tls: Fragment size is too small.");
889 * The maximum size for a RADIUS packet is 4096,
890 * minus the header (20), Message-Authenticator (18),
891 * and State (18), etc. results in about 4000 bytes of data
892 * that can be devoted *solely* to EAP.
894 if (conf->fragment_size > 4000) {
895 radlog(L_ERR, "rlm_eap_tls: Fragment size is too large.");
901 * Account for the EAP header (4), and the EAP-TLS header
902 * (6), as per Section 4.2 of RFC 2716. What's left is
903 * the maximum amount of data we read from a TLS buffer.
905 conf->fragment_size -= 10;
908 * This magic makes the administrators life HUGELY easier
909 * on initial deployments.
911 * If the server starts up in debugging mode, AND the
912 * bootstrap command is configured, AND it exists, AND
913 * there is no server certificate
915 if (conf->make_cert_command && (debug_flag >= 2)) {
918 if ((stat(conf->make_cert_command, &buf) == 0) &&
919 (stat(conf->certificate_file, &buf) < 0) &&
921 (radius_exec_program(conf->make_cert_command, NULL, 1,
922 NULL, 0, NULL, NULL, 0) != 0)) {
932 inst->ctx = init_tls_ctx(conf);
933 if (inst->ctx == NULL) {
938 if (load_dh_params(inst->ctx, conf->dh_file) < 0) {
943 if (generate_eph_rsa_key(inst->ctx) < 0) {
948 if (conf->verify_tmp_dir) {
951 if (chmod(conf->verify_tmp_dir, S_IRWXU) < 0) {
952 radlog(L_ERR, "rlm_eap_tls: Failed changing permissions on %s: %s", conf->verify_tmp_dir, strerror(errno));
958 if (conf->verify_client_cert_cmd && !conf->verify_tmp_dir) {
959 radlog(L_ERR, "rlm_eap_tls: You MUST set the verify directory in order to use verify_client_cmd");
971 * Send an initial eap-tls request to the peer.
973 * Frame eap reply packet.
974 * len = header + type + tls_typedata
975 * tls_typedata = flags(Start (S) bit set, and no data)
977 * Once having received the peer's Identity, the EAP server MUST
978 * respond with an EAP-TLS/Start packet, which is an
979 * EAP-Request packet with EAP-Type=EAP-TLS, the Start (S) bit
980 * set, and no data. The EAP-TLS conversation will then begin,
981 * with the peer sending an EAP-Response packet with
982 * EAP-Type = EAP-TLS. The data field of that packet will
985 * Fragment length is Framed-MTU - 4.
987 * http://mail.frascone.com/pipermail/public/eap/2003-July/001426.html
989 static int eaptls_initiate(void *type_arg, EAP_HANDLER *handler)
995 int client_cert = TRUE;
997 REQUEST *request = handler->request;
999 inst = (eap_tls_t *)type_arg;
1001 handler->tls = TRUE;
1002 handler->finished = FALSE;
1005 * Manually flush the sessions every so often. If HALF
1006 * of the session lifetime has passed since we last
1007 * flushed, then flush it again.
1009 * FIXME: Also do it every N sessions?
1011 if (inst->conf->session_cache_enable &&
1012 ((inst->conf->session_last_flushed + (inst->conf->session_timeout * 1800)) <= request->timestamp)) {
1013 RDEBUG2("Flushing SSL sessions (of #%ld)",
1014 SSL_CTX_sess_number(inst->ctx));
1016 SSL_CTX_flush_sessions(inst->ctx, request->timestamp);
1017 inst->conf->session_last_flushed = request->timestamp;
1021 * If we're TTLS or PEAP, then do NOT require a client
1024 * FIXME: This should be more configurable.
1026 if (handler->eap_type != PW_EAP_TLS) {
1027 vp = pairfind(handler->request->config_items,
1028 PW_EAP_TLS_REQUIRE_CLIENT_CERT, 0);
1030 client_cert = FALSE;
1032 client_cert = vp->vp_integer;
1037 * Every new session is started only from EAP-TLS-START.
1038 * Before Sending EAP-TLS-START, open a new SSL session.
1039 * Create all the required data structures & store them
1040 * in Opaque. So that we can use these data structures
1041 * when we get the response
1043 ssn = eaptls_new_session(inst->ctx, client_cert);
1049 * Verify the peer certificate, if asked.
1052 RDEBUG2("Requiring client certificate");
1053 verify_mode = SSL_VERIFY_PEER;
1054 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
1055 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
1057 SSL_set_verify(ssn->ssl, verify_mode, cbtls_verify);
1060 * Create a structure for all the items required to be
1061 * verified for each client and set that as opaque data
1064 * NOTE: If we want to set each item sepearately then
1065 * this index should be global.
1067 SSL_set_ex_data(ssn->ssl, 0, (void *)handler);
1068 SSL_set_ex_data(ssn->ssl, 1, (void *)inst->conf);
1070 ssn->length_flag = inst->conf->include_length;
1073 * We use default fragment size, unless the Framed-MTU
1074 * tells us it's too big. Note that we do NOT account
1075 * for the EAP-TLS headers if conf->fragment_size is
1076 * large, because that config item looks to be confusing.
1078 * i.e. it should REALLY be called MTU, and the code here
1079 * should figure out what that means for TLS fragment size.
1080 * asking the administrator to know the internal details
1081 * of EAP-TLS in order to calculate fragment sizes is
1084 ssn->offset = inst->conf->fragment_size;
1085 vp = pairfind(handler->request->packet->vps, PW_FRAMED_MTU, 0);
1086 if (vp && ((vp->vp_integer - 14) < ssn->offset)) {
1088 * Discount the Framed-MTU by:
1090 * 4 : EAP header (code + id + length)
1091 * 1 : EAP type == EAP-TLS
1093 * 4 : EAP-TLS Message length
1094 * (even if conf->include_length == 0,
1099 ssn->offset = vp->vp_integer - 14;
1102 handler->opaque = ((void *)ssn);
1103 handler->free_opaque = session_free;
1105 RDEBUG2("Initiate");
1108 * Set up type-specific information.
1110 switch (handler->eap_type) {
1113 ssn->prf_label = "client EAP encryption";
1117 ssn->prf_label = "ttls keying material";
1121 * PEAP-specific breakage.
1125 * As it is a poorly designed protocol, PEAP uses
1126 * bits in the TLS header to indicate PEAP
1127 * version numbers. For now, we only support
1128 * PEAP version 0, so it doesn't matter too much.
1129 * However, if we support later versions of PEAP,
1130 * we will need this flag to indicate which
1131 * version we're currently dealing with.
1133 ssn->peap_flag = 0x00;
1136 * PEAP version 0 requires 'include_length = no',
1137 * so rather than hoping the user figures it out,
1140 ssn->length_flag = 0;
1142 ssn->prf_label = "client EAP encryption";
1146 if (inst->conf->session_cache_enable) {
1147 ssn->allow_session_resumption = 1; /* otherwise it's zero */
1151 * TLS session initialization is over. Now handle TLS
1152 * related handshaking or application data.
1154 status = eaptls_start(handler->eap_ds, ssn->peap_flag);
1155 RDEBUG2("Start returned %d", status);
1160 * The next stage to process the packet.
1162 handler->stage = AUTHENTICATE;
1168 * Do authentication, by letting EAP-TLS do most of the work.
1170 static int eaptls_authenticate(void *arg, EAP_HANDLER *handler)
1172 eaptls_status_t status;
1173 tls_session_t *tls_session = (tls_session_t *) handler->opaque;
1174 REQUEST *request = handler->request;
1175 eap_tls_t *inst = (eap_tls_t *) arg;
1177 RDEBUG2("Authenticate");
1179 status = eaptls_process(handler);
1180 RDEBUG2("eaptls_process returned %d\n", status);
1183 * EAP-TLS handshake was successful, return an
1184 * EAP-TLS-Success packet here.
1186 case EAPTLS_SUCCESS:
1190 * The TLS code is still working on the TLS
1191 * exchange, and it's a valid TLS request.
1194 case EAPTLS_HANDLED:
1198 * Handshake is done, proceed with decoding tunneled
1202 RDEBUG2("Received unexpected tunneled data after successful handshake.");
1204 if ((debug_flag > 2) && fr_log_fp) {
1206 unsigned int data_len;
1207 unsigned char buffer[1024];
1209 data_len = (tls_session->record_minus)(&tls_session->dirty_in,
1210 buffer, sizeof(buffer));
1211 log_debug(" Tunneled data (%u bytes)\n", data_len);
1212 for (i = 0; i < data_len; i++) {
1213 if ((i & 0x0f) == 0x00) fprintf(fr_log_fp, " %x: ", i);
1214 if ((i & 0x0f) == 0x0f) fprintf(fr_log_fp, "\n");
1216 fprintf(fr_log_fp, "%02x ", buffer[i]);
1218 fprintf(fr_log_fp, "\n");
1222 eaptls_fail(handler, 0);
1227 * Anything else: fail.
1229 * Also, remove the session from the cache so that
1230 * the client can't re-use it.
1233 if (inst->conf->session_cache_enable) {
1234 SSL_CTX_remove_session(inst->ctx,
1235 tls_session->ssl->session);
1242 * New sessions cause some additional information to be
1245 if (!SSL_session_reused(tls_session->ssl)) {
1247 * FIXME: Store miscellaneous data.
1249 RDEBUG2("Adding user data to cached session");
1252 SSL_SESSION_set_ex_data(tls_session->ssl->session,
1253 ssl_session_idx_user_session, session_data);
1257 * FIXME: Retrieve miscellaneous data.
1260 data = SSL_SESSION_get_ex_data(tls_session->ssl->session,
1261 ssl_session_idx_user_session);
1263 if (!session_data) {
1264 radlog_request(L_ERR, 0, request,
1265 "No user session data in cached session - "
1271 RDEBUG2("Retrieved session data from cached session");
1275 * Success: Automatically return MPPE keys.
1277 return eaptls_success(handler, 0);
1281 * The module name should be the only globally exported symbol.
1282 * That is, everything else should be 'static'.
1284 EAP_TYPE rlm_eap_tls = {
1286 eaptls_attach, /* attach */
1287 eaptls_initiate, /* Start the initial request */
1288 NULL, /* authorization */
1289 eaptls_authenticate, /* authentication */
1290 eaptls_detach /* detach */