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