src/modules/rlm_eap/libeap/eap_tls.c

   1 /*
   2  * eap_tls.c
   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  *
  27  *  TLS Packet Format in EAP
  28  *  --- ------ ------ -- ---
  29  * 0                   1                   2                   3
  30  * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  31  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  32  * |     Code      |   Identifier  |            Length             |
  33  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  34  * |     Type      |     Flags     |      TLS Message Length
  35  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  36  * |     TLS Message Length        |       TLS Data...
  37  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  38  *
  39  */
  40
  41 #include <freeradius-devel/ident.h>
  42 RCSID("$Id$")
  43
  44 #include <freeradius-devel/autoconf.h>
  45 #include <assert.h>
  46 #include "eap_tls.h"
  47
  48 /*
  49  *      Allocate a new TLS_PACKET
  50  */
  51 EAPTLS_PACKET *eaptls_alloc(void)
  52 {
  53         EAPTLS_PACKET   *rp;
  54
  55         if ((rp = malloc(sizeof(EAPTLS_PACKET))) == NULL) {
  56                 radlog(L_ERR, "rlm_eap_tls: out of memory");
  57                 return NULL;
  58         }
  59         memset(rp, 0, sizeof(EAPTLS_PACKET));
  60         return rp;
  61 }
  62
  63 /*
  64  *      Free EAPTLS_PACKET
  65  */
  66 void eaptls_free(EAPTLS_PACKET **eaptls_packet_ptr)
  67 {
  68         EAPTLS_PACKET *eaptls_packet;
  69
  70         if (!eaptls_packet_ptr) return;
  71         eaptls_packet = *eaptls_packet_ptr;
  72         if (eaptls_packet == NULL) return;
  73
  74         if (eaptls_packet->data) {
  75                 free(eaptls_packet->data);
  76                 eaptls_packet->data = NULL;
  77         }
  78
  79         free(eaptls_packet);
  80         *eaptls_packet_ptr = NULL;
  81 }
  82
  83 /*
  84    The S flag is set only within the EAP-TLS start message
  85    sent from the EAP server to the peer.
  86 */
  87 int eaptls_start(EAP_DS *eap_ds, int peap_flag)
  88 {
  89         EAPTLS_PACKET   reply;
  90
  91         reply.code = EAPTLS_START;
  92         reply.length = TLS_HEADER_LEN + 1/*flags*/;
  93
  94         reply.flags = peap_flag;
  95         reply.flags = SET_START(reply.flags);
  96
  97         reply.data = NULL;
  98         reply.dlen = 0;
  99
 100         eaptls_compose(eap_ds, &reply);
 101
 102         return 1;
 103 }
 104
 105 int eaptls_success(EAP_DS *eap_ds, int peap_flag)
 106 {
 107         EAPTLS_PACKET   reply;
 108
 109         reply.code = EAPTLS_SUCCESS;
 110         reply.length = TLS_HEADER_LEN;
 111         reply.flags = peap_flag;
 112         reply.data = NULL;
 113         reply.dlen = 0;
 114
 115         eaptls_compose(eap_ds, &reply);
 116
 117         return 1;
 118 }
 119
 120 int eaptls_fail(EAP_DS *eap_ds, int peap_flag)
 121 {
 122         EAPTLS_PACKET   reply;
 123
 124         reply.code = EAPTLS_FAIL;
 125         reply.length = TLS_HEADER_LEN;
 126         reply.flags = peap_flag;
 127         reply.data = NULL;
 128         reply.dlen = 0;
 129
 130         eaptls_compose(eap_ds, &reply);
 131
 132         return 1;
 133 }
 134
 135 /*
 136    A single TLS record may be up to 16384 octets in length, but a TLS
 137    message may span multiple TLS records, and a TLS certificate message
 138    may in principle be as long as 16MB.
 139 */
 140
 141 /*
 142  *      Frame the Dirty data that needs to be send to the client in an
 143  *      EAP-Request.  We always embed the TLS-length in all EAP-TLS
 144  *      packets that we send, for easy reference purpose.  Handle
 145  *      fragmentation and sending the next fragment etc.
 146  */
 147 int eaptls_request(EAP_DS *eap_ds, tls_session_t *ssn)
 148 {
 149         EAPTLS_PACKET   reply;
 150         unsigned int    size;
 151         unsigned int    nlen;
 152         unsigned int    lbit = 0;
 153
 154         /* This value determines whether we set (L)ength flag for
 155                 EVERY packet we send and add corresponding
 156                 "TLS Message Length" field.
 157
 158         length_flag = TRUE;
 159                 This means we include L flag and "TLS Msg Len" in EVERY
 160                 packet we send out.
 161
 162         length_flag = FALSE;
 163                 This means we include L flag and "TLS Msg Len" **ONLY**
 164                 in First packet of a fragment series. We do not use
 165                 it anywhere else.
 166
 167                 Having L flag in every packet is prefered.
 168
 169         */
 170         if (ssn->length_flag) {
 171                 lbit = 4;
 172         }
 173         if (ssn->fragment == 0) {
 174                 ssn->tls_msg_len = ssn->dirty_out.used;
 175         }
 176
 177         reply.code = EAPTLS_REQUEST;
 178         reply.flags = ssn->peap_flag;
 179
 180         /* Send data, NOT more than the FRAGMENT size */
 181         if (ssn->dirty_out.used > ssn->offset) {
 182                 size = ssn->offset;
 183                 reply.flags = SET_MORE_FRAGMENTS(reply.flags);
 184                 /* Length MUST be included if it is the First Fragment */
 185                 if (ssn->fragment == 0) {
 186                         lbit = 4;
 187                 }
 188                 ssn->fragment = 1;
 189         } else {
 190                 size = ssn->dirty_out.used;
 191                 ssn->fragment = 0;
 192         }
 193
 194         reply.dlen = lbit + size;
 195         reply.length = TLS_HEADER_LEN + 1/*flags*/ + reply.dlen;
 196
 197         reply.data = malloc(reply.dlen);
 198         if (lbit) {
 199                 nlen = htonl(ssn->tls_msg_len);
 200                 memcpy(reply.data, &nlen, lbit);
 201                 reply.flags = SET_LENGTH_INCLUDED(reply.flags);
 202         }
 203         (ssn->record_minus)(&ssn->dirty_out, reply.data + lbit, size);
 204
 205         eaptls_compose(eap_ds, &reply);
 206         free(reply.data);
 207         reply.data = NULL;
 208
 209         return 1;
 210 }
 211
 212 /*
 213  * Acknowledge received is for one of the following messages sent earlier
 214  * 1. Handshake completed Message, so now send, EAP-Success
 215  * 2. Alert Message, now send, EAP-Failure
 216  * 3. Fragment Message, now send, next Fragment
 217  */
 218 static eaptls_status_t eaptls_ack_handler(EAP_HANDLER *handler)
 219 {
 220         tls_session_t *tls_session;
 221
 222         tls_session = (tls_session_t *)handler->opaque;
 223         if (tls_session == NULL){
 224                 radlog(L_ERR, "rlm_eap_tls: Unexpected ACK received");
 225                 return EAPTLS_FAIL;
 226         }
 227         if (tls_session->info.initialized == 0) {
 228                 DEBUG("  rlm_eap_tls: No SSL info available. Waiting for more SSL data.");
 229                 return EAPTLS_REQUEST;
 230         }
 231         if (tls_session->info.origin == 0) {
 232                 radlog(L_ERR, "rlm_eap_tls: Unexpected ACK received");
 233                 return EAPTLS_FAIL;
 234         }
 235
 236         switch (tls_session->info.content_type) {
 237         case alert:
 238                 DEBUG2("  rlm_eap_tls: ack alert");
 239                 eaptls_fail(handler->eap_ds, tls_session->peap_flag);
 240                 return EAPTLS_FAIL;
 241
 242         case handshake:
 243                 if (tls_session->info.handshake_type == finished) {
 244                         DEBUG2("  rlm_eap_tls: ack handshake is finished");
 245                         return EAPTLS_SUCCESS;
 246                 }
 247
 248                 DEBUG2("  rlm_eap_tls: ack handshake fragment handler");
 249                 /* Fragmentation handler, send next fragment */
 250                 return EAPTLS_REQUEST;
 251
 252                 /*
 253                  *      For the rest of the conditions, switch over
 254                  *      to the default section below.
 255                  */
 256         default:
 257                 DEBUG2("  rlm_eap_tls: ack default");
 258                 radlog(L_ERR, "rlm_eap_tls: Invalid ACK received: %d",
 259                        tls_session->info.content_type);
 260                 return EAPTLS_FAIL;
 261         }
 262 }
 263
 264 /*
 265  *      Similarly, when the EAP server receives an EAP-Response with
 266  *      the M bit set, it MUST respond with an EAP-Request with
 267  *      EAP-Type=EAP-TLS and no data. This serves as a fragment ACK.
 268  *
 269  *      In order to prevent errors in the processing of fragments, the
 270  *      EAP server MUST use increment the Identifier value for each
 271  *      fragment ACK contained within an EAP-Request, and the peer
 272  *      MUST include this Identifier value in the subsequent fragment
 273  *      contained within an EAP- Reponse.
 274  *
 275  *      EAP server sends an ACK when it determines there are More
 276  *      fragments to receive to make the complete
 277  *      TLS-record/TLS-Message
 278  */
 279 static int eaptls_send_ack(EAP_DS *eap_ds, int peap_flag)
 280 {
 281         EAPTLS_PACKET   reply;
 282
 283         reply.code = EAPTLS_ACK;
 284         reply.length = TLS_HEADER_LEN + 1/*flags*/;
 285         reply.flags = peap_flag;
 286         reply.data = NULL;
 287         reply.dlen = 0;
 288
 289         eaptls_compose(eap_ds, &reply);
 290
 291         return 1;
 292 }
 293
 294 /*
 295  *      The S flag is set only within the EAP-TLS start message sent
 296  *      from the EAP server to the peer.
 297  *
 298  *      Similarly, when the EAP server receives an EAP-Response with
 299  *      the M bit set, it MUST respond with an EAP-Request with
 300  *      EAP-Type=EAP-TLS and no data. This serves as a fragment
 301  *      ACK. The EAP peer MUST wait.
 302  */
 303 static eaptls_status_t eaptls_verify(EAP_HANDLER *handler)
 304 {
 305         EAP_DS *eap_ds = handler->eap_ds;
 306         EAP_DS *prev_eap_ds = handler->prev_eapds;
 307         eaptls_packet_t *eaptls_packet, *eaptls_prev = NULL;
 308
 309         /*
 310          *      We don't check ANY of the input parameters.  It's all
 311          *      code which works together, so if something is wrong,
 312          *      we SHOULD core dump.
 313          *
 314          *      e.g. if eap_ds is NULL, of if eap_ds->response is
 315          *      NULL, of if it's NOT an EAP-Response, or if the packet
 316          *      is too short.  See eap_validation()., in ../../eap.c
 317          *
 318          *      Also, eaptype_select() takes care of selecting the
 319          *      appropriate type, so we don't need to check
 320          *      eap_ds->response->type.type == PW_EAP_TLS, or anything
 321          *      else.
 322          */
 323         eaptls_packet = (eaptls_packet_t *)eap_ds->response->type.data;
 324         if (prev_eap_ds && prev_eap_ds->response)
 325                 eaptls_prev = (eaptls_packet_t *)prev_eap_ds->response->type.data;
 326
 327         /*
 328          *      check for ACK
 329          *
 330          *      If there's no TLS data, or there's 1 byte of TLS data,
 331          *      with the flags set to zero, then it's an ACK.
 332          *
 333          *      Find if this is a reply to the previous request sent
 334          */
 335         if ((eaptls_packet == NULL) ||
 336             ((eap_ds->response->length == EAP_HEADER_LEN + 2) &&
 337              ((eaptls_packet->flags & 0xc0) == 0x00))) {
 338
 339                 if (prev_eap_ds->request->id == eap_ds->response->id) {
 340                         /*
 341                          *      Run the ACK handler directly from here.
 342                          */
 343                         radlog(L_INFO, "rlm_eap_tls: Received EAP-TLS ACK message");
 344                         return eaptls_ack_handler(handler);
 345                 } else {
 346                         radlog(L_ERR, "rlm_eap_tls: Received Invalid EAP-TLS ACK message");
 347                         return EAPTLS_INVALID;
 348                 }
 349         }
 350
 351         /*
 352          *      We send TLS_START, but do not receive it.
 353          */
 354         if (TLS_START(eaptls_packet->flags)) {
 355                 radlog(L_ERR, "rlm_eap_tls:  Received unexpected EAP-TLS Start message");
 356                 return EAPTLS_INVALID;
 357         }
 358
 359         /*
 360          *      The L bit (length included) is set to indicate the
 361          *      presence of the four octet TLS Message Length field,
 362          *      and MUST be set for the first fragment of a fragmented
 363          *      TLS message or set of messages.
 364          *
 365          *      The M bit (more fragments) is set on all but the last
 366          *      fragment.
 367          *
 368          *      The S bit (EAP-TLS start) is set in an EAP-TLS Start
 369          *      message. This differentiates the EAP-TLS Start message
 370          *      from a fragment acknowledgement.
 371          */
 372         if (TLS_LENGTH_INCLUDED(eaptls_packet->flags)) {
 373                 if (TLS_MORE_FRAGMENTS(eaptls_packet->flags)) {
 374                         /*
 375                          * FIRST_FRAGMENT is identified
 376                          * 1. If there is no previous EAP-response received.
 377                          * 2. If EAP-response received, then its M bit not set.
 378                          *      (It is because Last fragment will not have M bit set)
 379                          */
 380                         if ((prev_eap_ds->response == NULL) ||
 381                             (eaptls_prev == NULL) ||
 382                             !TLS_MORE_FRAGMENTS(eaptls_prev->flags)) {
 383
 384                                 radlog(L_INFO, "rlm_eap_tls:  Received EAP-TLS First Fragment of the message");
 385                                 return EAPTLS_FIRST_FRAGMENT;
 386                         } else {
 387
 388                                 radlog(L_INFO, "rlm_eap_tls:  More Fragments with length included");
 389                                 return EAPTLS_MORE_FRAGMENTS_WITH_LENGTH;
 390                         }
 391                 } else {
 392
 393                         radlog(L_INFO, "rlm_eap_tls:  Length Included");
 394                         return EAPTLS_LENGTH_INCLUDED;
 395                 }
 396         }
 397
 398         if (TLS_MORE_FRAGMENTS(eaptls_packet->flags)) {
 399                 radlog(L_INFO, "rlm_eap_tls:  More fragments to follow");
 400                 return EAPTLS_MORE_FRAGMENTS;
 401         }
 402
 403         /*
 404          *      None of the flags are set, but it's still a valid
 405          *      EAPTLS packet.
 406          */
 407         return EAPTLS_OK;
 408 }
 409
 410 /*
 411  * EAPTLS_PACKET
 412  * code   =  EAP-code
 413  * id     =  EAP-id
 414  * length = code + id + length + flags + tlsdata
 415  *        =  1   +  1 +   2    +  1    +  X
 416  * length = EAP-length - 1(EAP-Type = 1 octet)
 417  * flags  = EAP-typedata[0] (1 octet)
 418  * dlen   = EAP-typedata[1-4] (4 octets), if L flag set
 419  *        = length - 5(code+id+length+flags), otherwise
 420  * data   = EAP-typedata[5-n], if L flag set
 421  *        = EAP-typedata[1-n], otherwise
 422  * packet = EAP-typedata (complete typedata)
 423  *
 424  * Points to consider during EAP-TLS data extraction
 425  * 1. In the received packet, No data will be present incase of ACK-NAK
 426  * 2. Incase if more fragments need to be received then ACK after retreiving this fragment.
 427  *
 428  *  RFC 2716 Section 4.2.  PPP EAP TLS Request Packet
 429  *
 430  *  0                   1                   2                   3
 431  *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 432  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 433  *  |     Code      |   Identifier  |            Length             |
 434  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 435  *  |     Type      |     Flags     |      TLS Message Length
 436  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 437  *  |     TLS Message Length        |       TLS Data...
 438  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 439  *
 440  *  The Length field is two octets and indicates the length of the EAP
 441  *  packet including the Code, Identifir, Length, Type, and TLS data
 442  *  fields.
 443  */
 444 static EAPTLS_PACKET *eaptls_extract(EAP_DS *eap_ds, eaptls_status_t status)
 445 {
 446         EAPTLS_PACKET   *tlspacket;
 447         uint32_t        data_len = 0;
 448         uint32_t        len = 0;
 449         uint8_t         *data = NULL;
 450
 451         if (status  == EAPTLS_INVALID)
 452                 return NULL;
 453
 454         /*
 455          *      The main EAP code & eaptls_verify() take care of
 456          *      ensuring that the packet is OK, and that we can
 457          *      extract the various fields we want.
 458          *
 459          *      e.g. a TLS packet with zero data is allowed as an ACK,
 460          *      but we will never see it here, as we will simply
 461          *      send another fragment, instead of trying to extract
 462          *      the data.
 463          *
 464          *      MUST have TLS type octet, followed by flags, followed
 465          *      by data.
 466          */
 467         assert(eap_ds->response->length > 2);
 468
 469         tlspacket = eaptls_alloc();
 470         if (tlspacket == NULL) return NULL;
 471
 472         /*
 473          *      Code & id for EAPTLS & EAP are same
 474          *      but eaptls_length = eap_length - 1(EAP-Type = 1 octet)
 475          *
 476          *      length = code + id + length + type + tlsdata
 477          *             =  1   +  1 +   2    +  1    +  X
 478          */
 479         tlspacket->code = eap_ds->response->code;
 480         tlspacket->id = eap_ds->response->id;
 481         tlspacket->length = eap_ds->response->length - 1; /* EAP type */
 482         tlspacket->flags = eap_ds->response->type.data[0];
 483
 484         /*
 485          *      A quick sanity check of the flags.  If we've been told
 486          *      that there's a length, and there isn't one, then stop.
 487          */
 488         if (TLS_LENGTH_INCLUDED(tlspacket->flags) &&
 489             (tlspacket->length < 5)) { /* flags + TLS message length */
 490                 radlog(L_ERR, "rlm_eap_tls: Invalid EAP-TLS packet received.  (Length bit is set, but no length was found.)");
 491                 eaptls_free(&tlspacket);
 492                 return NULL;
 493         }
 494
 495         /*
 496          *      If the final TLS packet is larger than we can handle, die
 497          *      now.
 498          *
 499          *      Likewise, if the EAP packet says N bytes, and the TLS
 500          *      packet says there's fewer bytes, it's a problem.
 501          *
 502          *      FIXME: Try to ensure that the claimed length is
 503          *      consistent across multiple TLS fragments.
 504          */
 505         if (TLS_LENGTH_INCLUDED(tlspacket->flags)) {
 506                 memcpy(&data_len, &eap_ds->response->type.data[1], 4);
 507                 data_len = ntohl(data_len);
 508                 if (data_len > MAX_RECORD_SIZE) {
 509                         radlog(L_ERR, "rlm_eap_tls: The EAP-TLS packet will contain more data than we can process.");
 510                         eaptls_free(&tlspacket);
 511                         return NULL;
 512                 }
 513
 514 #if 0
 515                 DEBUG2(" TLS: %d %d\n", data_len, tlspacket->length);
 516
 517                 if (data_len < tlspacket->length) {
 518                         radlog(L_ERR, "rlm_eap_tls: EAP-TLS packet claims to be smaller than the encapsulating EAP packet.");
 519                         eaptls_free(&tlspacket);
 520                         return NULL;
 521                 }
 522 #endif
 523         }
 524
 525         switch (status) {
 526         /*
 527          *      The TLS Message Length field is four octets, and
 528          *      provides the total length of the TLS message or set of
 529          *      messages that is being fragmented; this simplifies
 530          *      buffer allocation.
 531          *
 532          *      Dynamic allocation of buffers as & when we know the
 533          *      length should solve the problem.
 534          */
 535         case EAPTLS_FIRST_FRAGMENT:
 536         case EAPTLS_LENGTH_INCLUDED:
 537         case EAPTLS_MORE_FRAGMENTS_WITH_LENGTH:
 538                 if (tlspacket->length < 5) { /* flags + TLS message length */
 539                         radlog(L_ERR, "rlm_eap_tls: Invalid EAP-TLS packet received.  (Expected length, got none.)");
 540                         eaptls_free(&tlspacket);
 541                         return NULL;
 542                 }
 543
 544                 /*
 545                  *      Extract all the TLS fragments from the
 546                  *      previous eap_ds Start appending this
 547                  *      fragment to the above ds
 548                  */
 549                 memcpy(&data_len, &eap_ds->response->type.data[1], sizeof(uint32_t));
 550                 data_len = ntohl(data_len);
 551                 data = (eap_ds->response->type.data + 5/*flags+TLS-Length*/);
 552                 len = eap_ds->response->type.length - 5/*flags+TLS-Length*/;
 553
 554                 /*
 555                  *      Hmm... this should be an error, too.
 556                  */
 557                 if (data_len > len) {
 558                         data_len = len;
 559                 }
 560                 break;
 561
 562                 /*
 563                  *      Data length is implicit, from the EAP header.
 564                  */
 565         case EAPTLS_MORE_FRAGMENTS:
 566         case EAPTLS_OK:
 567                 data_len = eap_ds->response->type.length - 1/*flags*/;
 568                 data = eap_ds->response->type.data + 1/*flags*/;
 569                 break;
 570
 571         default:
 572                 radlog(L_ERR, "rlm_eap_tls: Invalid EAP-TLS packet received");
 573                 eaptls_free(&tlspacket);
 574                 return NULL;
 575         }
 576
 577         tlspacket->dlen = data_len;
 578         if (data_len) {
 579                 tlspacket->data = (unsigned char *)malloc(data_len);
 580                 if (tlspacket->data == NULL) {
 581                         radlog(L_ERR, "rlm_eap_tls: out of memory");
 582                         eaptls_free(&tlspacket);
 583                         return NULL;
 584                 }
 585                 memcpy(tlspacket->data, data, data_len);
 586         }
 587
 588         return tlspacket;
 589 }
 590
 591
 592
 593 /*
 594  * To process the TLS,
 595  *  INCOMING DATA:
 596  *      1. EAP-TLS should get the compelete TLS data from the peer.
 597  *      2. Store that data in a data structure with any other required info
 598  *      3. Handle that data structure to the TLS module.
 599  *      4. TLS module will perform its operations on the data and
 600  *      handle back to EAP-TLS
 601  *
 602  *  OUTGOING DATA:
 603  *      1. EAP-TLS if necessary will fragment it and send it to the
 604  *      destination.
 605  *
 606  *      During EAP-TLS initialization, TLS Context object will be
 607  *      initialized and stored.  For every new authentication
 608  *      requests, TLS will open a new session object and that session
 609  *      object should be maintained even after the session is
 610  *      completed for session resumption. (Probably later as a feature
 611  *      as we donot know who maintains these session objects ie,
 612  *      SSL_CTX (internally) or TLS module(explicitly). If TLS module,
 613  *      then how to let SSL API know about these sessions.)
 614  */
 615 static void eaptls_operation(EAPTLS_PACKET *eaptls_packet UNUSED,
 616                              eaptls_status_t status, EAP_HANDLER *handler)
 617 {
 618         tls_session_t *tls_session;
 619
 620         tls_session = (tls_session_t *)handler->opaque;
 621
 622         if ((status == EAPTLS_MORE_FRAGMENTS) ||
 623             (status == EAPTLS_MORE_FRAGMENTS_WITH_LENGTH) ||
 624             (status == EAPTLS_FIRST_FRAGMENT)) {
 625                 /*
 626                  * Send the ACK.
 627                  */
 628                 eaptls_send_ack(handler->eap_ds, tls_session->peap_flag);
 629         } else {
 630                 /*
 631                  *      We have the complete TLS-data or TLS-message.
 632                  *
 633                  *      Clean the dirty message.
 634                  *
 635                  *      Authenticate the user and send
 636                  *      Success/Failure.
 637                  *
 638                  *      If more info
 639                  *      is required then send another request.  */
 640                 if (tls_handshake_recv(tls_session)) {
 641                         /*
 642                          *      FIXME: return success/fail.
 643                          *
 644                          *      TLS proper can decide what to do, then.
 645                          */
 646                         eaptls_request(handler->eap_ds, tls_session);
 647                 } else {
 648                         eaptls_fail(handler->eap_ds, tls_session->peap_flag);
 649                 }
 650         }
 651         return;
 652 }
 653
 654
 655 /*
 656  * In the actual authentication first verify the packet and then create the data structure
 657  */
 658 /*
 659  * To process the TLS,
 660  *  INCOMING DATA:
 661  *      1. EAP-TLS should get the compelete TLS data from the peer.
 662  *      2. Store that data in a data structure with any other required info
 663  *      3. Hand this data structure to the TLS module.
 664  *      4. TLS module will perform its operations on the data and hands back to EAP-TLS
 665  *  OUTGOING DATA:
 666  *      1. EAP-TLS if necessary will fragment it and send it to the destination.
 667  *
 668  *      During EAP-TLS initialization, TLS Context object will be
 669  *      initialized and stored.  For every new authentication
 670  *      requests, TLS will open a new session object and that
 671  *      session object SHOULD be maintained even after the session
 672  *      is completed, for session resumption. (Probably later as a
 673  *      feature, as we do not know who maintains these session
 674  *      objects ie, SSL_CTX (internally) or TLS module (explicitly). If
 675  *      TLS module, then how to let SSL API know about these
 676  *      sessions.)
 677  */
 678
 679 /*
 680  *      Process an EAP request
 681  */
 682 eaptls_status_t eaptls_process(EAP_HANDLER *handler)
 683 {
 684         tls_session_t *tls_session = (tls_session_t *) handler->opaque;
 685         EAPTLS_PACKET   *tlspacket;
 686         eaptls_status_t status;
 687
 688         DEBUG2("  rlm_eap_tls: processing TLS");
 689
 690         /* This case is when SSL generates Alert then we
 691          * send that alert to the client and then send the EAP-Failure
 692          */
 693         status = eaptls_verify(handler);
 694         DEBUG2("  eaptls_verify returned %d\n", status);
 695
 696         switch (status) {
 697         default:
 698         case EAPTLS_INVALID:
 699         case EAPTLS_FAIL:
 700
 701                 /*
 702                  *      Success means that we're done the initial
 703                  *      handshake.  For TTLS, this means send stuff
 704                  *      back to the client, and the client sends us
 705                  *      more tunneled data.
 706                  */
 707         case EAPTLS_SUCCESS:
 708                 return status;
 709                 break;
 710
 711                 /*
 712                  *      Normal TLS request, continue with the "get rest
 713                  *      of fragments" phase.
 714                  */
 715         case EAPTLS_REQUEST:
 716                 eaptls_request(handler->eap_ds, tls_session);
 717                 return EAPTLS_HANDLED;
 718                 break;
 719
 720                 /*
 721                  *      The handshake is done, and we're in the "tunnel
 722                  *      data" phase.
 723                  */
 724         case EAPTLS_OK:
 725                 DEBUG2("  rlm_eap_tls: Done initial handshake");
 726
 727                 /*
 728                  *      Get the rest of the fragments.
 729                  */
 730         case EAPTLS_FIRST_FRAGMENT:
 731         case EAPTLS_MORE_FRAGMENTS:
 732         case EAPTLS_LENGTH_INCLUDED:
 733         case EAPTLS_MORE_FRAGMENTS_WITH_LENGTH:
 734                 break;
 735         }
 736
 737         /*
 738          *      Extract the TLS packet from the buffer.
 739          */
 740         if ((tlspacket = eaptls_extract(handler->eap_ds, status)) == NULL)
 741                 return EAPTLS_FAIL;
 742
 743         /*
 744          *      Get the session struct from the handler
 745          *
 746          *      update the dirty_in buffer
 747          *
 748          *      NOTE: This buffer will contain partial data when M bit is set.
 749          *
 750          *      CAUTION while reinitializing this buffer, it should be
 751          *      reinitialized only when this M bit is NOT set.
 752          */
 753         if (tlspacket->dlen !=
 754             (tls_session->record_plus)(&tls_session->dirty_in, tlspacket->data, tlspacket->dlen)) {
 755                 eaptls_free(&tlspacket);
 756                 radlog(L_ERR, "rlm_eap_tls: Exceeded maximum record size");
 757                 return EAPTLS_FAIL;
 758         }
 759
 760         /*
 761          *      SSL initalization is done.  Return.
 762          *
 763          *      The TLS data will be in the tls_session structure.
 764          */
 765         if (SSL_is_init_finished(tls_session->ssl)) {
 766                 eaptls_free(&tlspacket);
 767                 return EAPTLS_OK;
 768         }
 769
 770         /*
 771          *      Continue the handshake.
 772          */
 773         eaptls_operation(tlspacket, status, handler);
 774
 775         eaptls_free(&tlspacket);
 776         return EAPTLS_HANDLED;
 777 }
 778
 779
 780 /*
 781  *      compose the TLS reply packet in the EAP reply typedata
 782  */
 783 int eaptls_compose(EAP_DS *eap_ds, EAPTLS_PACKET *reply)
 784 {
 785         uint8_t *ptr;
 786
 787         /*
 788          *      Don't set eap_ds->request->type.type, as the main EAP
 789          *      handler will do that for us.  This allows the TLS
 790          *      module to be called from TTLS & PEAP.
 791          */
 792
 793         /*
 794          *      When the EAP server receives an EAP-Response with the
 795          *      M bit set, it MUST respond with an EAP-Request with
 796          *      EAP-Type=EAP-TLS and no data. This serves as a
 797          *      fragment ACK. The EAP peer MUST wait until it receives
 798          *      the EAP-Request before sending another fragment.
 799          *
 800          *      In order to prevent errors in the processing of
 801          *      fragments, the EAP server MUST use increment the
 802          *      Identifier value for each fragment ACK contained
 803          *      within an EAP-Request, and the peer MUST include this
 804          *      Identifier value in the subsequent fragment contained
 805          *      within an EAP- Reponse.
 806          */
 807         eap_ds->request->type.data = malloc(reply->length - TLS_HEADER_LEN + 1);
 808         if (eap_ds->request->type.data == NULL) {
 809                 radlog(L_ERR, "rlm_eap_tls: out of memory");
 810                 return 0;
 811         }
 812
 813         /* EAPTLS Header length is excluded while computing EAP typelen */
 814         eap_ds->request->type.length = reply->length - TLS_HEADER_LEN;
 815
 816         ptr = eap_ds->request->type.data;
 817         *ptr++ = (uint8_t)(reply->flags & 0xFF);
 818
 819         if (reply->dlen) memcpy(ptr, reply->data, reply->dlen);
 820
 821         switch (reply->code) {
 822         case EAPTLS_ACK:
 823         case EAPTLS_START:
 824         case EAPTLS_REQUEST:
 825                 eap_ds->request->code = PW_EAP_REQUEST;
 826                 break;
 827         case EAPTLS_SUCCESS:
 828                 eap_ds->request->code = PW_EAP_SUCCESS;
 829                 break;
 830         case EAPTLS_FAIL:
 831                 eap_ds->request->code = PW_EAP_FAILURE;
 832                 break;
 833         default:
 834                 /* Should never enter here */
 835                 eap_ds->request->code = PW_EAP_FAILURE;
 836                 break;
 837         }
 838
 839         return 1;
 840 }