deal with unused arguments
[freeradius.git] / src / modules / rlm_eap / types / rlm_eap_tls / rlm_eap_tls.c
index 1c2b15c..56ac645 100644 (file)
  *
  * Copyright 2001  hereUare Communications, Inc. <raghud@hereuare.com>
  * Copyright 2003  Alan DeKok <aland@freeradius.org>
+ * Copyright 2006  The FreeRADIUS server project
+ *
  */
 
+#include <freeradius-devel/ident.h>
+RCSID("$Id$")
+
 #include <freeradius-devel/autoconf.h>
-#include "eap_tls.h"
 
 #ifdef HAVE_OPENSSL_RAND_H
 #include <openssl/rand.h>
 #endif
 
-static CONF_PARSER module_config[] = {
-       { "rsa_key_exchange", PW_TYPE_BOOLEAN,
-         offsetof(EAP_TLS_CONF, rsa_key), NULL, "no" },
-       { "dh_key_exchange", PW_TYPE_BOOLEAN,
-         offsetof(EAP_TLS_CONF, dh_key), NULL, "yes" },
-       { "rsa_key_length", PW_TYPE_INTEGER,
-         offsetof(EAP_TLS_CONF, rsa_key_length), NULL, "512" },
-       { "dh_key_length", PW_TYPE_INTEGER,
-         offsetof(EAP_TLS_CONF, dh_key_length), NULL, "512" },
-       { "verify_depth", PW_TYPE_INTEGER,
-         offsetof(EAP_TLS_CONF, verify_depth), NULL, "0" },
-       { "CA_path", PW_TYPE_FILENAME,
-         offsetof(EAP_TLS_CONF, ca_path), NULL, NULL },
-       { "pem_file_type", PW_TYPE_BOOLEAN,
-         offsetof(EAP_TLS_CONF, file_type), NULL, "yes" },
-       { "private_key_file", PW_TYPE_FILENAME,
-         offsetof(EAP_TLS_CONF, private_key_file), NULL, NULL },
-       { "certificate_file", PW_TYPE_FILENAME,
-         offsetof(EAP_TLS_CONF, certificate_file), NULL, NULL },
-       { "CA_file", PW_TYPE_FILENAME,
-         offsetof(EAP_TLS_CONF, ca_file), NULL, NULL },
-       { "private_key_password", PW_TYPE_STRING_PTR,
-         offsetof(EAP_TLS_CONF, private_key_password), NULL, NULL },
-       { "dh_file", PW_TYPE_STRING_PTR,
-         offsetof(EAP_TLS_CONF, dh_file), NULL, NULL },
-       { "random_file", PW_TYPE_STRING_PTR,
-         offsetof(EAP_TLS_CONF, random_file), NULL, NULL },
-       { "fragment_size", PW_TYPE_INTEGER,
-         offsetof(EAP_TLS_CONF, fragment_size), NULL, "1024" },
-       { "include_length", PW_TYPE_BOOLEAN,
-         offsetof(EAP_TLS_CONF, include_length), NULL, "yes" },
-       { "check_crl", PW_TYPE_BOOLEAN,
-         offsetof(EAP_TLS_CONF, check_crl), NULL, "no"},
-       { "check_cert_cn", PW_TYPE_STRING_PTR,
-         offsetof(EAP_TLS_CONF, check_cert_cn), NULL, NULL},
-       { "cipher_list", PW_TYPE_STRING_PTR,
-         offsetof(EAP_TLS_CONF, cipher_list), NULL, NULL},
-
-       { NULL, -1, 0, NULL, NULL }           /* end the list */
-};
-
-
-/*
- *     TODO: Check for the type of key exchange * like conf->dh_key
- */
-static int load_dh_params(SSL_CTX *ctx, char *file)
-{
-       DH *dh = NULL;
-       BIO *bio;
-
-       if ((bio = BIO_new_file(file, "r")) == NULL) {
-               radlog(L_ERR, "rlm_eap_tls: Unable to open DH file - %s", file);
-               return -1;
-       }
-
-       dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
-       BIO_free(bio);
-       if (SSL_CTX_set_tmp_dh(ctx, dh) < 0) {
-               radlog(L_ERR, "rlm_eap_tls: Unable to set DH parameters");
-               DH_free(dh);
-               return -1;
-       }
-
-       DH_free(dh);
-       return 0;
-}
-
-/*
- *     Generte ephemeral RSA keys.
- */
-static int generate_eph_rsa_key(SSL_CTX *ctx)
-{
-       RSA *rsa;
-
-       rsa = RSA_generate_key(512, RSA_F4, NULL, NULL);
-
-       if (!SSL_CTX_set_tmp_rsa(ctx, rsa)) {
-               radlog(L_ERR, "rlm_eap_tls: Couldn't set RSA key");
-               return -1;
-       }
-
-       RSA_free(rsa);
-       return 0;
-}
-
-
-/*
- *     Create Global context SSL and use it in every new session
- *
- *     - Load the trusted CAs
- *     - Load the Private key & the certificate
- *     - Set the Context options & Verify options
- */
-static SSL_CTX *init_tls_ctx(EAP_TLS_CONF *conf)
-{
-       SSL_METHOD *meth;
-       SSL_CTX *ctx;
-       X509_STORE *certstore;
-       int verify_mode = 0;
-       int ctx_options = 0;
-       int type;
-
-       /*
-        *      Add all the default ciphers and message digests
-        *      Create our context.
-        */
-       SSL_library_init();
-       SSL_load_error_strings();
-
-       meth = TLSv1_method();
-       ctx = SSL_CTX_new(meth);
-
-       /*
-        * Identify the type of certificates that needs to be loaded
-        */
-       if (conf->file_type) {
-               type = SSL_FILETYPE_PEM;
-       } else {
-               type = SSL_FILETYPE_ASN1;
-       }
-
-       /*
-        * Set the password to load private key
-        */
-       if (conf->private_key_password) {
-               SSL_CTX_set_default_passwd_cb_userdata(ctx, conf->private_key_password);
-               SSL_CTX_set_default_passwd_cb(ctx, cbtls_password);
-       }
-
-       /*
-        *      Load our keys and certificates
-        *
-        *      If certificates are of type PEM then we can make use
-        *      of cert chain authentication using openssl api call
-        *      SSL_CTX_use_certificate_chain_file.  Please see how
-        *      the cert chain needs to be given in PEM from
-        *      openSSL.org
-        */
-       if (type == SSL_FILETYPE_PEM) {
-               radlog(L_INFO, "rlm_eap_tls: Loading the certificate file as a chain");
-               if (!(SSL_CTX_use_certificate_chain_file(ctx, conf->certificate_file))) {
-                       ERR_print_errors_fp(stderr);
-                       radlog(L_ERR, "rlm_eap_tls: Error reading certificate file");
-                       return NULL;
-               }
-
-       } else if (!(SSL_CTX_use_certificate_file(ctx, conf->certificate_file, type))) {
-               ERR_print_errors_fp(stderr);
-               radlog(L_ERR, "rlm_eap_tls: Error reading certificate file");
-               return NULL;
-       }
-
-
-       /* Load the CAs we trust */
-       if (!SSL_CTX_load_verify_locations(ctx, conf->ca_file, conf->ca_path)) {
-               ERR_print_errors_fp(stderr);
-               radlog(L_ERR, "rlm_eap_tls: Error reading Trusted root CA list");
-               return NULL;
-       }
-       SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(conf->ca_file));
-       }
-
-       if (!(SSL_CTX_use_PrivateKey_file(ctx, conf->private_key_file, type))) {
-               ERR_print_errors_fp(stderr);
-               radlog(L_ERR, "rlm_eap_tls: Error reading private key file");
-               return NULL;
-       }
-
-       /*
-        * Check if the loaded private key is the right one
-        */
-       if (!SSL_CTX_check_private_key(ctx)) {
-               radlog(L_ERR, "rlm_eap_tls: Private key does not match the certificate public key");
-               return NULL;
-       }
-
-       /*
-        *      Set ctx_options
-        */
-       ctx_options |= SSL_OP_NO_SSLv2;
-       ctx_options |= SSL_OP_NO_SSLv3;
-
-       /*
-        *      SSL_OP_SINGLE_DH_USE must be used in order to prevent
-        *      small subgroup attacks and forward secrecy. Always
-        *      using
-        *
-        *      SSL_OP_SINGLE_DH_USE has an impact on the computer
-        *      time needed during negotiation, but it is not very
-        *      large.
-        */
-       ctx_options |= SSL_OP_SINGLE_DH_USE;
-       SSL_CTX_set_options(ctx, ctx_options);
-
-       /*
-        *      TODO: Set the RSA & DH
-        *      SSL_CTX_set_tmp_rsa_callback(ctx, cbtls_rsa);
-        *      SSL_CTX_set_tmp_dh_callback(ctx, cbtls_dh);
-        */
-
-       /*
-        *      set the message callback to identify the type of
-        *      message.  For every new session, there can be a
-        *      different callback argument.
-        *
-        *      SSL_CTX_set_msg_callback(ctx, cbtls_msg);
-        */
-
-       /* Set Info callback */
-       SSL_CTX_set_info_callback(ctx, cbtls_info);
-
-       /*
-        *      Check the certificates for revocation.
-        */
-#ifdef X509_V_FLAG_CRL_CHECK
-       if (conf->check_crl) {
-         certstore = SSL_CTX_get_cert_store(ctx);
-         if (certstore == NULL) {
-           ERR_print_errors_fp(stderr);
-           radlog(L_ERR, "rlm_eap_tls: Error reading Certificate Store");
-           return NULL;
-         }
-         X509_STORE_set_flags(certstore, X509_V_FLAG_CRL_CHECK);
-       }
+#ifdef HAVE_OPENSSL_EVP_H
+#include <openssl/evp.h>
 #endif
 
-       /*
-        *      Set verify modes
-        *      Always verify the peer certificate
-        */
-       verify_mode |= SSL_VERIFY_PEER;
-       verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
-       verify_mode |= SSL_VERIFY_CLIENT_ONCE;
-       SSL_CTX_set_verify(ctx, verify_mode, cbtls_verify);
-
-       if (conf->verify_depth) {
-               SSL_CTX_set_verify_depth(ctx, conf->verify_depth);
-       }
-
-       /* Load randomness */
-       if (!(RAND_load_file(conf->random_file, 1024*1024))) {
-               ERR_print_errors_fp(stderr);
-               radlog(L_ERR, "rlm_eap_tls: Error loading randomness");
-               return NULL;
-       }
-
-       /*
-        * Set the cipher list if we were told to
-        */
-       if (conf->cipher_list) {
-               if (!SSL_CTX_set_cipher_list(ctx, conf->cipher_list)) {
-                       radlog(L_ERR, "rlm_eap_tls: Error setting cipher list");
-                       return NULL;
-               }
-
-       return ctx;
-}
+#include "rlm_eap_tls.h"
+#include "config.h"
 
+#ifdef HAVE_SYS_STAT_H
+#include <sys/stat.h>
+#endif
 
 /*
  *     Detach the EAP-TLS module.
  */
 static int eaptls_detach(void *arg)
 {
-       EAP_TLS_CONF     *conf;
-       eap_tls_t        *inst;
-
-       inst = (eap_tls_t *) arg;
-       conf = inst->conf;
-
-       if (conf) {
-               if (conf->dh_file) free(conf->dh_file);
-               conf->dh_file = NULL;
-               if (conf->certificate_file) free(conf->certificate_file);
-               conf->certificate_file = NULL;
-               if (conf->private_key_file) free(conf->private_key_file);
-               conf->private_key_file = NULL;
-               if (conf->private_key_password) free(conf->private_key_password);
-               conf->private_key_password = NULL;
-               if (conf->random_file) free(conf->random_file);
-               conf->random_file = NULL;
-
-               free(inst->conf);
-               inst->conf = NULL;
-       }
-
-       if (inst->ctx) SSL_CTX_free(inst->ctx);
-       inst->ctx = NULL;
-
-       free(inst);
-
+       tls_server_conf_free(arg);
        return 0;
 }
 
@@ -328,51 +58,44 @@ static int eaptls_detach(void *arg)
  */
 static int eaptls_attach(CONF_SECTION *cs, void **instance)
 {
-       EAP_TLS_CONF     *conf;
-       eap_tls_t        *inst;
-
-       /* Store all these values in the data structure for later references */
-       inst = (eap_tls_t *)malloc(sizeof(*inst));
-       if (!inst) {
-               radlog(L_ERR, "rlm_eap_tls: out of memory");
-               return -1;
-       }
-       memset(inst, 0, sizeof(*inst));
+       fr_tls_server_conf_t     *inst;
 
        /*
         *      Parse the config file & get all the configured values
         */
-       conf = (EAP_TLS_CONF *)malloc(sizeof(*conf));
-       if (conf == NULL) {
-               radlog(L_ERR, "rlm_eap_tls: out of memory");
+       inst = tls_server_conf_parse(cs);
+       if (!inst) {
+               radlog(L_ERR, "rlm_eap_tls: Failed initializing SSL context");
                return -1;
        }
-       memset(conf, 0, sizeof(*conf));
 
-       inst->conf = conf;
-       if (cf_section_parse(cs, conf, module_config) < 0) {
+       /*
+        *      The EAP RFC's say 1020, but we're less picky.
+        */
+       if (inst->fragment_size < 100) {
+               radlog(L_ERR, "rlm_eap_tls: Fragment size is too small.");
                eaptls_detach(inst);
                return -1;
        }
 
-
        /*
-        *      Initialize TLS
+        *      The maximum size for a RADIUS packet is 4096,
+        *      minus the header (20), Message-Authenticator (18),
+        *      and State (18), etc. results in about 4000 bytes of data
+        *      that can be devoted *solely* to EAP.
         */
-       inst->ctx = init_tls_ctx(conf);
-       if (inst->ctx == NULL) {
+       if (inst->fragment_size > 4000) {
+               radlog(L_ERR, "rlm_eap_tls: Fragment size is too large.");
                eaptls_detach(inst);
                return -1;
        }
 
-       if (load_dh_params(inst->ctx, conf->dh_file) < 0) {
-               eaptls_detach(inst);
-               return -1;
-       }
-       if (generate_eph_rsa_key(inst->ctx) < 0) {
-               eaptls_detach(inst);
-               return -1;
-       }
+       /*
+        *      Account for the EAP header (4), and the EAP-TLS header
+        *      (6), as per Section 4.2 of RFC 2716.  What's left is
+        *      the maximum amount of data we read from a TLS buffer.
+        */
+       inst->fragment_size -= 10;
 
        *instance = inst;
 
@@ -403,11 +126,16 @@ static int eaptls_initiate(void *type_arg, EAP_HANDLER *handler)
 {
        int             status;
        tls_session_t   *ssn;
-       eap_tls_t       *inst;
+       fr_tls_server_conf_t    *inst;
        VALUE_PAIR      *vp;
        int             client_cert = TRUE;
+       int             verify_mode = 0;
+       REQUEST         *request = handler->request;
 
-       inst = (eap_tls_t *)type_arg;
+       inst = type_arg;
+
+       handler->tls = TRUE;
+       handler->finished = FALSE;
 
        /*
         *      If we're TTLS or PEAP, then do NOT require a client
@@ -417,11 +145,11 @@ static int eaptls_initiate(void *type_arg, EAP_HANDLER *handler)
         */
        if (handler->eap_type != PW_EAP_TLS) {
                vp = pairfind(handler->request->config_items,
-                             PW_EAP_TLS_REQUIRE_CLIENT_CERT);
+                             PW_EAP_TLS_REQUIRE_CLIENT_CERT, 0);
                if (!vp) {
                        client_cert = FALSE;
                } else {
-                       client_cert = vp->lvalue;
+                       client_cert = vp->vp_integer;
                }
        }
 
@@ -432,12 +160,23 @@ static int eaptls_initiate(void *type_arg, EAP_HANDLER *handler)
         *      in Opaque.  So that we can use these data structures
         *      when we get the response
         */
-       ssn = eaptls_new_session(inst->ctx, client_cert);
+       ssn = tls_new_session(inst, request, client_cert);
        if (!ssn) {
                return 0;
        }
 
        /*
+        *      Verify the peer certificate, if asked.
+        */
+       if (client_cert) {
+               RDEBUG2("Requiring client certificate");
+               verify_mode = SSL_VERIFY_PEER;
+               verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
+               verify_mode |= SSL_VERIFY_CLIENT_ONCE;
+       }
+       SSL_set_verify(ssn->ssl, verify_mode, cbtls_verify);
+
+       /*
         *      Create a structure for all the items required to be
         *      verified for each client and set that as opaque data
         *      structure.
@@ -445,30 +184,34 @@ static int eaptls_initiate(void *type_arg, EAP_HANDLER *handler)
         *      NOTE: If we want to set each item sepearately then
         *      this index should be global.
         */
-       SSL_set_ex_data(ssn->ssl, 0, (void *)handler);
-       SSL_set_ex_data(ssn->ssl, 1, (void *)inst->conf);
-
-       ssn->length_flag = inst->conf->include_length;
-
-       /*
-        *      We set a default fragment size, unless the Framed-MTU
-        *      tells us it's too big.
-        */
-       ssn->offset = inst->conf->fragment_size;
-       vp = pairfind(handler->request->packet->vps, PW_FRAMED_MTU);
-       if (vp && ((vp->lvalue - 4) < ssn->offset)) {
-               ssn->offset = vp->lvalue - 4;
-       }
+       SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_HANDLER, (void *)handler);
+       SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CONF, (void *)inst);
+       SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_CERTS, (void *)&(handler->certs));
+       SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_IDENTITY, (void *)&(handler->identity));
+#ifdef HAVE_OPENSSL_OCSP_H
+       SSL_set_ex_data(ssn->ssl, FR_TLS_EX_INDEX_STORE, (void *)inst->ocsp_store);
+#endif
 
        handler->opaque = ((void *)ssn);
        handler->free_opaque = session_free;
 
-       DEBUG2("  rlm_eap_tls: Initiate");
-
        /*
-        *      PEAP-specific breakage.
+        *      Set up type-specific information.
         */
-       if (handler->eap_type == PW_EAP_PEAP) {
+       switch (handler->eap_type) {
+       case PW_EAP_TLS:
+       default:
+               ssn->prf_label = "client EAP encryption";
+               break;
+
+       case PW_EAP_TTLS:
+               ssn->prf_label = "ttls keying material";
+               break;
+
+               /*
+                *      PEAP-specific breakage.
+                */
+       case PW_EAP_PEAP:
                /*
                 *      As it is a poorly designed protocol, PEAP uses
                 *      bits in the TLS header to indicate PEAP
@@ -486,6 +229,9 @@ static int eaptls_initiate(void *type_arg, EAP_HANDLER *handler)
                 *      we force it here.
                 */
                ssn->length_flag = 0;
+
+               ssn->prf_label = "client EAP encryption";
+               break;
        }
 
        /*
@@ -493,7 +239,7 @@ static int eaptls_initiate(void *type_arg, EAP_HANDLER *handler)
         *      related handshaking or application data.
         */
        status = eaptls_start(handler->eap_ds, ssn->peap_flag);
-       DEBUG2("  rlm_eap_tls: Start returned %d", status);
+       RDEBUG2("Start returned %d", status);
        if (status == 0)
                return 0;
 
@@ -508,21 +254,22 @@ static int eaptls_initiate(void *type_arg, EAP_HANDLER *handler)
 /*
  *     Do authentication, by letting EAP-TLS do most of the work.
  */
-static int eaptls_authenticate(void *arg UNUSED, EAP_HANDLER *handler)
+static int eaptls_authenticate(UNUSED void *arg, EAP_HANDLER *handler)
 {
-       eaptls_status_t status;
+       fr_tls_status_t status;
        tls_session_t *tls_session = (tls_session_t *) handler->opaque;
+       REQUEST *request = handler->request;
 
-       DEBUG2("  rlm_eap_tls: Authenticate");
+       RDEBUG2("Authenticate");
 
        status = eaptls_process(handler);
-       DEBUG2("  eaptls_process returned %d\n", status);
+       RDEBUG2("eaptls_process returned %d\n", status);
        switch (status) {
                /*
                 *      EAP-TLS handshake was successful, return an
                 *      EAP-TLS-Success packet here.
                 */
-       case EAPTLS_SUCCESS:
+       case FR_TLS_SUCCESS:
                break;
 
                /*
@@ -530,17 +277,17 @@ static int eaptls_authenticate(void *arg UNUSED, EAP_HANDLER *handler)
                 *      exchange, and it's a valid TLS request.
                 *      do nothing.
                 */
-       case EAPTLS_HANDLED:
+       case FR_TLS_HANDLED:
                return 1;
 
                /*
                 *      Handshake is done, proceed with decoding tunneled
                 *      data.
                 */
-       case EAPTLS_OK:
-               DEBUG2("  rlm_eap_tls: Received unexpected tunneled data after successful handshake.");
+       case FR_TLS_OK:
+               RDEBUG2("Received unexpected tunneled data after successful handshake.");
 #ifndef NDEBUG
-               if (debug_flag > 2) {
+               if ((debug_flag > 2) && fr_log_fp) {
                        unsigned int i;
                        unsigned int data_len;
                        unsigned char buffer[1024];
@@ -549,34 +296,35 @@ static int eaptls_authenticate(void *arg UNUSED, EAP_HANDLER *handler)
                                                buffer, sizeof(buffer));
                        log_debug("  Tunneled data (%u bytes)\n", data_len);
                        for (i = 0; i < data_len; i++) {
-                               if ((i & 0x0f) == 0x00) printf("  %x: ", i);
-                               if ((i & 0x0f) == 0x0f) printf("\n");
+                               if ((i & 0x0f) == 0x00) fprintf(fr_log_fp, "  %x: ", i);
+                               if ((i & 0x0f) == 0x0f) fprintf(fr_log_fp, "\n");
 
-                               printf("%02x ", buffer[i]);
+                               fprintf(fr_log_fp, "%02x ", buffer[i]);
                        }
-                       printf("\n");
+                       fprintf(fr_log_fp, "\n");
                }
 #endif
 
-               eaptls_fail(handler->eap_ds, 0);
+               eaptls_fail(handler, 0);
                return 0;
                break;
 
                /*
                 *      Anything else: fail.
+                *
+                *      Also, remove the session from the cache so that
+                *      the client can't re-use it.
                 */
        default:
+               tls_fail(tls_session);
+
                return 0;
        }
 
        /*
-        *      Success: Return MPPE keys.
+        *      Success: Automatically return MPPE keys.
         */
-       eaptls_success(handler->eap_ds, 0);
-       eaptls_gen_mppe_keys(&handler->request->reply->vps,
-                            tls_session->ssl,
-                            "client EAP encryption");
-       return 1;
+       return eaptls_success(handler, 0);
 }
 
 /*