src/modules/rlm_eap/types/rlm_eap_tls/rlm_eap_tls.c

   1 /*
   2  * rlm_eap_tls.c  contains the interfaces that are called from eap
   3  *
   4  * Version:     $Id$
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  * Copyright 2001  hereUare Communications, Inc. <raghud@hereuare.com>
  21  * Copyright 2003  Alan DeKok <aland@freeradius.org>
  22  * Copyright 2006  The FreeRADIUS server project
  23  *
  24  */
  25
  26 #include <freeradius-devel/ident.h>
  27 RCSID("$Id$")
  28
  29 #include <freeradius-devel/autoconf.h>
  30
  31 #ifdef HAVE_OPENSSL_RAND_H
  32 #include <openssl/rand.h>
  33 #endif
  34
  35 #include "rlm_eap_tls.h"
  36
  37 static CONF_PARSER module_config[] = {
  38         { "rsa_key_exchange", PW_TYPE_BOOLEAN,
  39           offsetof(EAP_TLS_CONF, rsa_key), NULL, "no" },
  40         { "dh_key_exchange", PW_TYPE_BOOLEAN,
  41           offsetof(EAP_TLS_CONF, dh_key), NULL, "yes" },
  42         { "rsa_key_length", PW_TYPE_INTEGER,
  43           offsetof(EAP_TLS_CONF, rsa_key_length), NULL, "512" },
  44         { "dh_key_length", PW_TYPE_INTEGER,
  45           offsetof(EAP_TLS_CONF, dh_key_length), NULL, "512" },
  46         { "verify_depth", PW_TYPE_INTEGER,
  47           offsetof(EAP_TLS_CONF, verify_depth), NULL, "0" },
  48         { "CA_path", PW_TYPE_FILENAME,
  49           offsetof(EAP_TLS_CONF, ca_path), NULL, NULL },
  50         { "pem_file_type", PW_TYPE_BOOLEAN,
  51           offsetof(EAP_TLS_CONF, file_type), NULL, "yes" },
  52         { "private_key_file", PW_TYPE_FILENAME,
  53           offsetof(EAP_TLS_CONF, private_key_file), NULL, NULL },
  54         { "certificate_file", PW_TYPE_FILENAME,
  55           offsetof(EAP_TLS_CONF, certificate_file), NULL, NULL },
  56         { "CA_file", PW_TYPE_FILENAME,
  57           offsetof(EAP_TLS_CONF, ca_file), NULL, NULL },
  58         { "private_key_password", PW_TYPE_STRING_PTR,
  59           offsetof(EAP_TLS_CONF, private_key_password), NULL, NULL },
  60         { "dh_file", PW_TYPE_STRING_PTR,
  61           offsetof(EAP_TLS_CONF, dh_file), NULL, NULL },
  62         { "random_file", PW_TYPE_STRING_PTR,
  63           offsetof(EAP_TLS_CONF, random_file), NULL, NULL },
  64         { "fragment_size", PW_TYPE_INTEGER,
  65           offsetof(EAP_TLS_CONF, fragment_size), NULL, "1024" },
  66         { "include_length", PW_TYPE_BOOLEAN,
  67           offsetof(EAP_TLS_CONF, include_length), NULL, "yes" },
  68         { "check_crl", PW_TYPE_BOOLEAN,
  69           offsetof(EAP_TLS_CONF, check_crl), NULL, "no"},
  70         { "check_cert_cn", PW_TYPE_STRING_PTR,
  71           offsetof(EAP_TLS_CONF, check_cert_cn), NULL, NULL},
  72         { "cipher_list", PW_TYPE_STRING_PTR,
  73           offsetof(EAP_TLS_CONF, cipher_list), NULL, NULL},
  74         { "check_cert_issuer", PW_TYPE_STRING_PTR,
  75           offsetof(EAP_TLS_CONF, check_cert_issuer), NULL, NULL},
  76
  77         { NULL, -1, 0, NULL, NULL }           /* end the list */
  78 };
  79
  80
  81 /*
  82  *      TODO: Check for the type of key exchange * like conf->dh_key
  83  */
  84 static int load_dh_params(SSL_CTX *ctx, char *file)
  85 {
  86         DH *dh = NULL;
  87         BIO *bio;
  88
  89         if ((bio = BIO_new_file(file, "r")) == NULL) {
  90                 radlog(L_ERR, "rlm_eap_tls: Unable to open DH file - %s", file);
  91                 return -1;
  92         }
  93
  94         dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
  95         BIO_free(bio);
  96         if (SSL_CTX_set_tmp_dh(ctx, dh) < 0) {
  97                 radlog(L_ERR, "rlm_eap_tls: Unable to set DH parameters");
  98                 DH_free(dh);
  99                 return -1;
 100         }
 101
 102         DH_free(dh);
 103         return 0;
 104 }
 105
 106 /*
 107  *      Generte ephemeral RSA keys.
 108  */
 109 static int generate_eph_rsa_key(SSL_CTX *ctx)
 110 {
 111         RSA *rsa;
 112
 113         rsa = RSA_generate_key(512, RSA_F4, NULL, NULL);
 114
 115         if (!SSL_CTX_set_tmp_rsa(ctx, rsa)) {
 116                 radlog(L_ERR, "rlm_eap_tls: Couldn't set RSA key");
 117                 return -1;
 118         }
 119
 120         RSA_free(rsa);
 121         return 0;
 122 }
 123
 124
 125 /*
 126  *      Before trusting a certificate, you must make sure that the
 127  *      certificate is 'valid'. There are several steps that your
 128  *      application can take in determining if a certificate is
 129  *      valid. Commonly used steps are:
 130  *
 131  *      1.Verifying the certificate's signature, and verifying that
 132  *      the certificate has been issued by a trusted Certificate
 133  *      Authority.
 134  *
 135  *      2.Verifying that the certificate is valid for the present date
 136  *      (i.e. it is being presented within its validity dates).
 137  *
 138  *      3.Verifying that the certificate has not been revoked by its
 139  *      issuing Certificate Authority, by checking with respect to a
 140  *      Certificate Revocation List (CRL).
 141  *
 142  *      4.Verifying that the credentials presented by the certificate
 143  *      fulfill additional requirements specific to the application,
 144  *      such as with respect to access control lists or with respect
 145  *      to OCSP (Online Certificate Status Processing).
 146  *
 147  *      NOTE: This callback will be called multiple times based on the
 148  *      depth of the root certificate chain
 149  */
 150 static int cbtls_verify(int ok, X509_STORE_CTX *ctx)
 151 {
 152         char subject[1024]; /* Used for the subject name */
 153         char issuer[1024]; /* Used for the issuer name */
 154         char common_name[1024];
 155         char cn_str[1024];
 156         EAP_HANDLER *handler = NULL;
 157         X509 *client_cert;
 158         SSL *ssl;
 159         int err, depth;
 160         EAP_TLS_CONF *conf;
 161         int my_ok = ok;
 162
 163         client_cert = X509_STORE_CTX_get_current_cert(ctx);
 164         err = X509_STORE_CTX_get_error(ctx);
 165         depth = X509_STORE_CTX_get_error_depth(ctx);
 166
 167         if (!my_ok) {
 168                 radlog(L_ERR,"--> verify error:num=%d:%s\n",err,
 169                         X509_verify_cert_error_string(err));
 170                 return my_ok;
 171         }
 172
 173         /*
 174          * Retrieve the pointer to the SSL of the connection currently treated
 175          * and the application specific data stored into the SSL object.
 176          */
 177         ssl = X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx());
 178         handler = (EAP_HANDLER *)SSL_get_ex_data(ssl, 0);
 179         conf = (EAP_TLS_CONF *)SSL_get_ex_data(ssl, 1);
 180
 181         /*
 182          *      Get the Subject & Issuer
 183          */
 184         subject[0] = issuer[0] = '\0';
 185         X509_NAME_oneline(X509_get_subject_name(client_cert), subject,
 186                           sizeof(subject));
 187         X509_NAME_oneline(X509_get_issuer_name(ctx->current_cert), issuer,
 188                           sizeof(issuer));
 189
 190         subject[sizeof(subject) - 1] = '\0';
 191         issuer[sizeof(issuer) - 1] = '\0';
 192
 193         /*
 194          *      Get the Common Name
 195          */
 196         X509_NAME_get_text_by_NID(X509_get_subject_name(client_cert),
 197                                   NID_commonName, common_name, sizeof(common_name));
 198         common_name[sizeof(common_name) - 1] = '\0';
 199
 200         switch (ctx->error) {
 201
 202         case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
 203                 radlog(L_ERR, "issuer= %s\n", issuer);
 204                 break;
 205         case X509_V_ERR_CERT_NOT_YET_VALID:
 206         case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
 207                 radlog(L_ERR, "notBefore=");
 208 #if 0
 209                 ASN1_TIME_print(bio_err, X509_get_notBefore(ctx->current_cert));
 210 #endif
 211                 break;
 212         case X509_V_ERR_CERT_HAS_EXPIRED:
 213         case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
 214                 radlog(L_ERR, "notAfter=");
 215 #if 0
 216                 ASN1_TIME_print(bio_err, X509_get_notAfter(ctx->current_cert));
 217 #endif
 218                 break;
 219         }
 220
 221         /*
 222          *      If we're at the actual client cert, apply additional
 223          *      checks.
 224          */
 225         if (depth == 0) {
 226                 /*
 227                  *      If the conf tells us to, check cert issuer
 228                  *      against the specified value and fail
 229                  *      verification if they don't match.
 230                  */
 231                 if (conf->check_cert_issuer &&
 232                     (strcmp(issuer, conf->check_cert_issuer) != 0)) {
 233                         radlog(L_AUTH, "rlm_eap_tls: Certificate issuer (%s) does not match specified value (%s)!", issuer, conf->check_cert_issuer);
 234                         my_ok = 0;
 235                 }
 236
 237                 /*
 238                  *      If the conf tells us to, check the CN in the
 239                  *      cert against xlat'ed value, but only if the
 240                  *      previous checks passed.
 241                  */
 242                 if (my_ok && conf->check_cert_cn) {
 243                         if (!radius_xlat(cn_str, sizeof(cn_str), conf->check_cert_cn, handler->request, NULL)) {
 244                                 radlog(L_ERR, "rlm_eap_tls (%s): xlat failed.",
 245                                        conf->check_cert_cn);
 246                                 /* if this fails, fail the verification */
 247                                 my_ok = 0;
 248                         } else {
 249                                 DEBUG2("    rlm_eap_tls: checking certificate CN (%s) with xlat'ed value (%s)", common_name, cn_str);
 250                                 if (strcmp(cn_str, common_name) != 0) {
 251                                         radlog(L_AUTH, "rlm_eap_tls: Certificate CN (%s) does not match specified value (%s)!", common_name, cn_str);
 252                                         my_ok = 0;
 253                                 }
 254                         }
 255                 } /* check_cert_cn */
 256         } /* depth == 0 */
 257
 258         if (debug_flag > 0) {
 259                 radlog(L_INFO, "chain-depth=%d, ", depth);
 260                 radlog(L_INFO, "error=%d", err);
 261
 262                 radlog(L_INFO, "--> User-Name = %s", handler->identity);
 263                 radlog(L_INFO, "--> BUF-Name = %s", common_name);
 264                 radlog(L_INFO, "--> subject = %s", subject);
 265                 radlog(L_INFO, "--> issuer  = %s", issuer);
 266                 radlog(L_INFO, "--> verify return:%d", my_ok);
 267         }
 268         return my_ok;
 269 }
 270
 271
 272 /*
 273  *      Create Global context SSL and use it in every new session
 274  *
 275  *      - Load the trusted CAs
 276  *      - Load the Private key & the certificate
 277  *      - Set the Context options & Verify options
 278  */
 279 static SSL_CTX *init_tls_ctx(EAP_TLS_CONF *conf)
 280 {
 281         SSL_METHOD *meth;
 282         SSL_CTX *ctx;
 283         X509_STORE *certstore;
 284         int verify_mode = SSL_VERIFY_NONE;
 285         int ctx_options = 0;
 286         int type;
 287
 288         /*
 289          *      Add all the default ciphers and message digests
 290          *      Create our context.
 291          */
 292         SSL_library_init();
 293         SSL_load_error_strings();
 294
 295         meth = TLSv1_method();
 296         ctx = SSL_CTX_new(meth);
 297
 298         /*
 299          * Identify the type of certificates that needs to be loaded
 300          */
 301         if (conf->file_type) {
 302                 type = SSL_FILETYPE_PEM;
 303         } else {
 304                 type = SSL_FILETYPE_ASN1;
 305         }
 306
 307         /*
 308          * Set the password to load private key
 309          */
 310         if (conf->private_key_password) {
 311                 SSL_CTX_set_default_passwd_cb_userdata(ctx, conf->private_key_password);
 312                 SSL_CTX_set_default_passwd_cb(ctx, cbtls_password);
 313         }
 314
 315         /*
 316          *      Load our keys and certificates
 317          *
 318          *      If certificates are of type PEM then we can make use
 319          *      of cert chain authentication using openssl api call
 320          *      SSL_CTX_use_certificate_chain_file.  Please see how
 321          *      the cert chain needs to be given in PEM from
 322          *      openSSL.org
 323          */
 324         if (type == SSL_FILETYPE_PEM) {
 325                 radlog(L_INFO, "rlm_eap_tls: Loading the certificate file as a chain");
 326                 if (!(SSL_CTX_use_certificate_chain_file(ctx, conf->certificate_file))) {
 327                         radlog(L_ERR, "rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
 328                         radlog(L_ERR, "rlm_eap_tls: Error reading certificate file");
 329                         return NULL;
 330                 }
 331
 332         } else if (!(SSL_CTX_use_certificate_file(ctx, conf->certificate_file, type))) {
 333                 radlog(L_ERR, "rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
 334                 radlog(L_ERR, "rlm_eap_tls: Error reading certificate file");
 335                 return NULL;
 336         }
 337
 338         /* Load the CAs we trust */
 339         if (!SSL_CTX_load_verify_locations(ctx, conf->ca_file, conf->ca_path)) {
 340                 radlog(L_ERR, "rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
 341                 radlog(L_ERR, "rlm_eap_tls: Error reading Trusted root CA list");
 342                 return NULL;
 343         }
 344         SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(conf->ca_file));
 345         if (!(SSL_CTX_use_PrivateKey_file(ctx, conf->private_key_file, type))) {
 346                 radlog(L_ERR, "rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
 347                 radlog(L_ERR, "rlm_eap_tls: Error reading private key file");
 348                 return NULL;
 349         }
 350
 351         /*
 352          * Check if the loaded private key is the right one
 353          */
 354         if (!SSL_CTX_check_private_key(ctx)) {
 355                 radlog(L_ERR, "rlm_eap_tls: Private key does not match the certificate public key");
 356                 return NULL;
 357         }
 358
 359         /*
 360          *      Set ctx_options
 361          */
 362         ctx_options |= SSL_OP_NO_SSLv2;
 363         ctx_options |= SSL_OP_NO_SSLv3;
 364
 365         /*
 366          *      SSL_OP_SINGLE_DH_USE must be used in order to prevent
 367          *      small subgroup attacks and forward secrecy. Always
 368          *      using
 369          *
 370          *      SSL_OP_SINGLE_DH_USE has an impact on the computer
 371          *      time needed during negotiation, but it is not very
 372          *      large.
 373          */
 374         ctx_options |= SSL_OP_SINGLE_DH_USE;
 375
 376         /*
 377          *      SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS to work around issues
 378          *      in Windows Vista client.
 379          *      http://www.openssl.org/~bodo/tls-cbc.txt
 380          *      http://www.nabble.com/(RADIATOR)-Radiator-Version-3.16-released-t2600070.html
 381          */
 382         ctx_options |= SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
 383
 384         SSL_CTX_set_options(ctx, ctx_options);
 385
 386         /*
 387          *      TODO: Set the RSA & DH
 388          *      SSL_CTX_set_tmp_rsa_callback(ctx, cbtls_rsa);
 389          *      SSL_CTX_set_tmp_dh_callback(ctx, cbtls_dh);
 390          */
 391
 392         /*
 393          *      set the message callback to identify the type of
 394          *      message.  For every new session, there can be a
 395          *      different callback argument.
 396          *
 397          *      SSL_CTX_set_msg_callback(ctx, cbtls_msg);
 398          */
 399
 400         /* Set Info callback */
 401         SSL_CTX_set_info_callback(ctx, cbtls_info);
 402
 403         /*
 404          *      Check the certificates for revocation.
 405          */
 406 #ifdef X509_V_FLAG_CRL_CHECK
 407         if (conf->check_crl) {
 408           certstore = SSL_CTX_get_cert_store(ctx);
 409           if (certstore == NULL) {
 410             radlog(L_ERR, "rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
 411             radlog(L_ERR, "rlm_eap_tls: Error reading Certificate Store");
 412             return NULL;
 413           }
 414           X509_STORE_set_flags(certstore, X509_V_FLAG_CRL_CHECK);
 415         }
 416 #endif
 417
 418         /*
 419          *      Set verify modes
 420          *      Always verify the peer certificate
 421          */
 422         verify_mode |= SSL_VERIFY_PEER;
 423         verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
 424         verify_mode |= SSL_VERIFY_CLIENT_ONCE;
 425         SSL_CTX_set_verify(ctx, verify_mode, cbtls_verify);
 426
 427         if (conf->verify_depth) {
 428                 SSL_CTX_set_verify_depth(ctx, conf->verify_depth);
 429         }
 430
 431         /* Load randomness */
 432         if (!(RAND_load_file(conf->random_file, 1024*1024))) {
 433                 radlog(L_ERR, "rlm_eap: SSL error %s", ERR_error_string(ERR_get_error(), NULL));
 434                 radlog(L_ERR, "rlm_eap_tls: Error loading randomness");
 435                 return NULL;
 436         }
 437
 438         /*
 439          * Set the cipher list if we were told to
 440          */
 441         if (conf->cipher_list) {
 442                 if (!SSL_CTX_set_cipher_list(ctx, conf->cipher_list)) {
 443                         radlog(L_ERR, "rlm_eap_tls: Error setting cipher list");
 444                         return NULL;
 445                 }
 446         }
 447
 448         return ctx;
 449 }
 450
 451
 452 /*
 453  *      Detach the EAP-TLS module.
 454  */
 455 static int eaptls_detach(void *arg)
 456 {
 457         EAP_TLS_CONF     *conf;
 458         eap_tls_t        *inst;
 459
 460         inst = (eap_tls_t *) arg;
 461         conf = inst->conf;
 462
 463         if (conf) {
 464                 free(conf->dh_file);
 465                 free(conf->ca_path);
 466                 free(conf->certificate_file);
 467                 free(conf->private_key_file);
 468                 free(conf->private_key_password);
 469                 free(conf->ca_file);
 470                 free(conf->random_file);
 471
 472                 free(conf->check_cert_cn);
 473                 free(conf->cipher_list);
 474                 free(conf->check_cert_issuer);
 475
 476                 memset(conf, 0, sizeof(*conf));
 477                 free(inst->conf);
 478                 inst->conf = NULL;
 479         }
 480
 481         if (inst->ctx) SSL_CTX_free(inst->ctx);
 482         inst->ctx = NULL;
 483
 484         free(inst);
 485
 486         return 0;
 487 }
 488
 489
 490 /*
 491  *      Attach the EAP-TLS module.
 492  */
 493 static int eaptls_attach(CONF_SECTION *cs, void **instance)
 494 {
 495         EAP_TLS_CONF     *conf;
 496         eap_tls_t        *inst;
 497
 498         /* Store all these values in the data structure for later references */
 499         inst = (eap_tls_t *)malloc(sizeof(*inst));
 500         if (!inst) {
 501                 radlog(L_ERR, "rlm_eap_tls: out of memory");
 502                 return -1;
 503         }
 504         memset(inst, 0, sizeof(*inst));
 505
 506         /*
 507          *      Parse the config file & get all the configured values
 508          */
 509         conf = (EAP_TLS_CONF *)malloc(sizeof(*conf));
 510         if (conf == NULL) {
 511                 radlog(L_ERR, "rlm_eap_tls: out of memory");
 512                 return -1;
 513         }
 514         memset(conf, 0, sizeof(*conf));
 515
 516         inst->conf = conf;
 517         if (cf_section_parse(cs, conf, module_config) < 0) {
 518                 eaptls_detach(inst);
 519                 return -1;
 520         }
 521
 522
 523         /*
 524          *      Initialize TLS
 525          */
 526         inst->ctx = init_tls_ctx(conf);
 527         if (inst->ctx == NULL) {
 528                 eaptls_detach(inst);
 529                 return -1;
 530         }
 531
 532         if (load_dh_params(inst->ctx, conf->dh_file) < 0) {
 533                 eaptls_detach(inst);
 534                 return -1;
 535         }
 536         if (generate_eph_rsa_key(inst->ctx) < 0) {
 537                 eaptls_detach(inst);
 538                 return -1;
 539         }
 540
 541         *instance = inst;
 542
 543         return 0;
 544 }
 545
 546
 547 /*
 548  *      Send an initial eap-tls request to the peer.
 549  *
 550  *      Frame eap reply packet.
 551  *      len = header + type + tls_typedata
 552  *      tls_typedata = flags(Start (S) bit set, and no data)
 553  *
 554  *      Once having received the peer's Identity, the EAP server MUST
 555  *      respond with an EAP-TLS/Start packet, which is an
 556  *      EAP-Request packet with EAP-Type=EAP-TLS, the Start (S) bit
 557  *      set, and no data.  The EAP-TLS conversation will then begin,
 558  *      with the peer sending an EAP-Response packet with
 559  *      EAP-Type = EAP-TLS.  The data field of that packet will
 560  *      be the TLS data.
 561  *
 562  *      Fragment length is Framed-MTU - 4.
 563  *
 564  *      http://mail.frascone.com/pipermail/public/eap/2003-July/001426.html
 565  */
 566 static int eaptls_initiate(void *type_arg, EAP_HANDLER *handler)
 567 {
 568         int             status;
 569         tls_session_t   *ssn;
 570         eap_tls_t       *inst;
 571         VALUE_PAIR      *vp;
 572         int             client_cert = TRUE;
 573         int             verify_mode = 0;
 574
 575         inst = (eap_tls_t *)type_arg;
 576
 577         /*
 578          *      If we're TTLS or PEAP, then do NOT require a client
 579          *      certificate.
 580          *
 581          *      FIXME: This should be more configurable.
 582          */
 583         if (handler->eap_type != PW_EAP_TLS) {
 584                 vp = pairfind(handler->request->config_items,
 585                               PW_EAP_TLS_REQUIRE_CLIENT_CERT);
 586                 if (!vp) {
 587                         client_cert = FALSE;
 588                 } else {
 589                         client_cert = vp->lvalue;
 590                 }
 591         }
 592
 593         /*
 594          *      Every new session is started only from EAP-TLS-START.
 595          *      Before Sending EAP-TLS-START, open a new SSL session.
 596          *      Create all the required data structures & store them
 597          *      in Opaque.  So that we can use these data structures
 598          *      when we get the response
 599          */
 600         ssn = eaptls_new_session(inst->ctx, client_cert);
 601         if (!ssn) {
 602                 return 0;
 603         }
 604
 605         /*
 606          *      Verify the peer certificate, if asked.
 607          */
 608         if (client_cert) {
 609                 DEBUG2(" rlm_eap_tls: Requiring client certificate");
 610                 verify_mode = SSL_VERIFY_PEER;
 611                 verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
 612                 verify_mode |= SSL_VERIFY_CLIENT_ONCE;
 613         }
 614         SSL_set_verify(ssn->ssl, verify_mode, cbtls_verify);
 615
 616         /*
 617          *      Create a structure for all the items required to be
 618          *      verified for each client and set that as opaque data
 619          *      structure.
 620          *
 621          *      NOTE: If we want to set each item sepearately then
 622          *      this index should be global.
 623          */
 624         SSL_set_ex_data(ssn->ssl, 0, (void *)handler);
 625         SSL_set_ex_data(ssn->ssl, 1, (void *)inst->conf);
 626
 627         ssn->length_flag = inst->conf->include_length;
 628
 629         /*
 630          *      We use default fragment size, unless the Framed-MTU
 631          *      tells us it's too big.  Note that we do NOT account
 632          *      for the EAP-TLS headers if conf->fragment_size is
 633          *      large, because that config item looks to be confusing.
 634          *
 635          *      i.e. it should REALLY be called MTU, and the code here
 636          *      should figure out what that means for TLS fragment size.
 637          *      asking the administrator to know the internal details
 638          *      of EAP-TLS in order to calculate fragment sizes is
 639          *      just too much.
 640          */
 641         ssn->offset = inst->conf->fragment_size;
 642         vp = pairfind(handler->request->packet->vps, PW_FRAMED_MTU);
 643         if (vp && ((vp->lvalue - 14) < ssn->offset)) {
 644                 /*
 645                  *      Discount the Framed-MTU by:
 646                  *       4 : EAPOL header
 647                  *       4 : EAP header (code + id + length)
 648                  *       1 : EAP type == EAP-TLS
 649                  *       1 : EAP-TLS Flags
 650                  *       4 : EAP-TLS Message length
 651                  *          (even if conf->include_length == 0,
 652                  *           just to be lazy).
 653                  *      ---
 654                  *      14
 655                  */
 656                 ssn->offset = vp->lvalue - 14;
 657         }
 658
 659         handler->opaque = ((void *)ssn);
 660         handler->free_opaque = session_free;
 661
 662         DEBUG2("  rlm_eap_tls: Initiate");
 663
 664         /*
 665          *      PEAP-specific breakage.
 666          */
 667         if (handler->eap_type == PW_EAP_PEAP) {
 668                 /*
 669                  *      As it is a poorly designed protocol, PEAP uses
 670                  *      bits in the TLS header to indicate PEAP
 671                  *      version numbers.  For now, we only support
 672                  *      PEAP version 0, so it doesn't matter too much.
 673                  *      However, if we support later versions of PEAP,
 674                  *      we will need this flag to indicate which
 675                  *      version we're currently dealing with.
 676                  */
 677                 ssn->peap_flag = 0x00;
 678
 679                 /*
 680                  *      PEAP version 0 requires 'include_length = no',
 681                  *      so rather than hoping the user figures it out,
 682                  *      we force it here.
 683                  */
 684                 ssn->length_flag = 0;
 685         }
 686
 687         /*
 688          *      TLS session initialization is over.  Now handle TLS
 689          *      related handshaking or application data.
 690          */
 691         status = eaptls_start(handler->eap_ds, ssn->peap_flag);
 692         DEBUG2("  rlm_eap_tls: Start returned %d", status);
 693         if (status == 0)
 694                 return 0;
 695
 696         /*
 697          *      The next stage to process the packet.
 698          */
 699         handler->stage = AUTHENTICATE;
 700
 701         return 1;
 702 }
 703
 704 /*
 705  *      Do authentication, by letting EAP-TLS do most of the work.
 706  */
 707 static int eaptls_authenticate(void *arg UNUSED, EAP_HANDLER *handler)
 708 {
 709         eaptls_status_t status;
 710         tls_session_t *tls_session = (tls_session_t *) handler->opaque;
 711
 712         DEBUG2("  rlm_eap_tls: Authenticate");
 713
 714         status = eaptls_process(handler);
 715         DEBUG2("  eaptls_process returned %d\n", status);
 716         switch (status) {
 717                 /*
 718                  *      EAP-TLS handshake was successful, return an
 719                  *      EAP-TLS-Success packet here.
 720                  */
 721         case EAPTLS_SUCCESS:
 722                 break;
 723
 724                 /*
 725                  *      The TLS code is still working on the TLS
 726                  *      exchange, and it's a valid TLS request.
 727                  *      do nothing.
 728                  */
 729         case EAPTLS_HANDLED:
 730                 return 1;
 731
 732                 /*
 733                  *      Handshake is done, proceed with decoding tunneled
 734                  *      data.
 735                  */
 736         case EAPTLS_OK:
 737                 DEBUG2("  rlm_eap_tls: Received unexpected tunneled data after successful handshake.");
 738 #ifndef NDEBUG
 739                 if (debug_flag > 2) {
 740                         unsigned int i;
 741                         unsigned int data_len;
 742                         unsigned char buffer[1024];
 743
 744                         data_len = (tls_session->record_minus)(&tls_session->dirty_in,
 745                                                 buffer, sizeof(buffer));
 746                         log_debug("  Tunneled data (%u bytes)\n", data_len);
 747                         for (i = 0; i < data_len; i++) {
 748                                 if ((i & 0x0f) == 0x00) printf("  %x: ", i);
 749                                 if ((i & 0x0f) == 0x0f) printf("\n");
 750
 751                                 printf("%02x ", buffer[i]);
 752                         }
 753                         printf("\n");
 754                 }
 755 #endif
 756
 757                 eaptls_fail(handler->eap_ds, 0);
 758                 return 0;
 759                 break;
 760
 761                 /*
 762                  *      Anything else: fail.
 763                  */
 764         default:
 765                 return 0;
 766         }
 767
 768         /*
 769          *      Success: Return MPPE keys.
 770          */
 771         eaptls_success(handler->eap_ds, 0);
 772         eaptls_gen_mppe_keys(&handler->request->reply->vps,
 773                              tls_session->ssl,
 774                              "client EAP encryption");
 775         return 1;
 776 }
 777
 778 /*
 779  *      The module name should be the only globally exported symbol.
 780  *      That is, everything else should be 'static'.
 781  */
 782 EAP_TYPE rlm_eap_tls = {
 783         "eap_tls",
 784         eaptls_attach,                  /* attach */
 785         eaptls_initiate,                /* Start the initial request */
 786         NULL,                           /* authorization */
 787         eaptls_authenticate,            /* authentication */
 788         eaptls_detach                   /* detach */
 789 };