2 * peap.c contains the interfaces that are called from eap
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Copyright 2003 Alan DeKok <aland@freeradius.org>
26 * Send protected EAP-Failure
28 * Result-TLV = Failure
30 static int eappeap_failure(EAP_HANDLER *handler, tls_session_t *tls_session)
32 uint8_t tlv_packet[11];
34 DEBUG2(" rlm_eap_peap: FAILURE");
36 tlv_packet[0] = PW_EAP_REQUEST;
37 tlv_packet[1] = handler->eap_ds->response->id +1;
39 tlv_packet[3] = 11; /* length of this packet */
40 tlv_packet[4] = PW_EAP_TLV;
42 tlv_packet[6] = EAP_TLV_ACK_RESULT;
44 tlv_packet[8] = 2; /* length of the data portion */
46 tlv_packet[10] = EAP_TLV_FAILURE;
48 record_plus(&tls_session->clean_in, tlv_packet, 11);
51 * FIXME: Check the return code.
53 tls_handshake_send(tls_session);
54 record_init(&tls_session->clean_in);
61 * Send protected EAP-Success
63 * Result-TLV = Success
65 static int eappeap_success(EAP_HANDLER *handler, tls_session_t *tls_session)
67 uint8_t tlv_packet[11];
69 DEBUG2(" rlm_eap_peap: SUCCESS");
71 tlv_packet[0] = PW_EAP_REQUEST;
72 tlv_packet[1] = handler->eap_ds->response->id +1;
74 tlv_packet[3] = 11; /* length of this packet */
75 tlv_packet[4] = PW_EAP_TLV;
76 tlv_packet[5] = 0x80; /* mandatory AVP */
77 tlv_packet[6] = EAP_TLV_ACK_RESULT;
79 tlv_packet[8] = 2; /* length of the data portion */
81 tlv_packet[10] = EAP_TLV_SUCCESS;
83 record_plus(&tls_session->clean_in, tlv_packet, 11);
86 * FIXME: Check the return code.
88 tls_handshake_send(tls_session);
89 record_init(&tls_session->clean_in);
96 * Verify the tunneled EAP message.
98 static int eapmessage_verify(const uint8_t *data, unsigned int data_len)
100 const eap_packet_t *eap_packet = (const eap_packet_t *) data;
104 if (!data || (data_len <= 1)) {
110 case PW_EAP_IDENTITY:
111 memcpy(identity, data + 1, data_len - 1);
112 identity[data_len - 1] = '\0';
113 DEBUG2(" rlm_eap_peap: Identity - %s", identity);
118 * If the first byte of the packet is
119 * EAP-Response, and the EAP data is a TLV,
120 * then it looks OK...
122 case PW_EAP_RESPONSE:
123 if (eap_packet->data[0] == PW_EAP_TLV) {
124 DEBUG2(" rlm_eap_peap: Received EAP-TLV response.");
127 DEBUG2(" rlm_eap_peap: Got something weird.");
132 * We normally do Microsoft MS-CHAPv2 (26), versus
133 * Cisco MS-CHAPv2 (29).
135 case PW_EAP_MSCHAPV2:
137 DEBUG2(" rlm_eap_peap: EAP type %s",
138 eaptype_type2name(eap_type,
139 identity, sizeof(identity)));
148 * Convert a pseudo-EAP packet to a list of VALUE_PAIR's.
150 static VALUE_PAIR *eap2vp(EAP_DS *eap_ds,
151 const uint8_t *data, unsigned int data_len)
153 VALUE_PAIR *vp = NULL;
156 * Sanity check this...
158 if (data_len + EAP_HEADER_LEN > MAX_STRING_LEN) {
159 radlog(L_ERR, "rlm_eap_peap: EAP Response packet is too large. Code must be fixed to handle this.");
163 vp = paircreate(PW_EAP_MESSAGE, PW_TYPE_OCTETS);
165 DEBUG2(" rlm_eap_peap: Failure in creating VP");
170 * Hand-build an EAP packet from the crap in PEAP version 0.
172 vp->strvalue[0] = PW_EAP_RESPONSE;
173 vp->strvalue[1] = eap_ds->response->id;
175 vp->strvalue[3] = EAP_HEADER_LEN + data_len;
177 memcpy(vp->strvalue + EAP_HEADER_LEN, data, data_len);
178 vp->length = EAP_HEADER_LEN + data_len;
185 * Convert a list of VALUE_PAIR's to an EAP packet, through the
186 * simple expedient of dumping the EAP message
188 static int vp2eap(tls_session_t *tls_session, VALUE_PAIR *vp)
190 if (vp->next != NULL) {
191 radlog(L_ERR, "rlm_eap_peap: EAP Request packet is too large. Code must be fixed to handle this.");
196 * Skip the id, code, and length. Just write the EAP
197 * type & data to the client.
200 if (debug_flag > 2) {
202 int total = vp->length - 4;
204 if (debug_flag > 0) for (i = 0; i < total; i++) {
205 if ((i & 0x0f) == 0) printf(" PEAP tunnel data out %04x: ", i);
207 printf("%02x ", vp->strvalue[i + 4]);
209 if ((i & 0x0f) == 0x0f) printf("\n");
211 if ((total & 0x0f) != 0) printf("\n");
216 * Send the EAP data, WITHOUT the header.
219 record_plus(&tls_session->clean_in, vp->strvalue + EAP_HEADER_LEN,
220 vp->length - EAP_HEADER_LEN);
222 record_plus(&tls_session->clean_in, vp->strvalue, vp->length);
224 tls_handshake_send(tls_session);
225 record_init(&tls_session->clean_in);
232 * See if there's a TLV in the response.
234 static int eappeap_check_tlv(const uint8_t *data)
236 const eap_packet_t *eap_packet = (const eap_packet_t *) data;
239 * Look for success or failure.
241 if ((eap_packet->code == PW_EAP_RESPONSE) &&
242 (eap_packet->data[0] == PW_EAP_TLV)) {
243 if (data[10] == EAP_TLV_SUCCESS) {
247 if (data[10] == EAP_TLV_FAILURE) {
248 DEBUG2(" rlm_eap_peap: Client rejected our response. The password is probably incorrect.");
258 * Use a reply packet to determine what to do.
260 static int process_reply(EAP_HANDLER *handler, tls_session_t *tls_session,
261 REQUEST *request, RADIUS_PACKET *reply)
263 int rcode = RLM_MODULE_REJECT;
265 peap_tunnel_t *t = tls_session->opaque;
267 switch (reply->code) {
268 case PW_AUTHENTICATION_ACK:
269 DEBUG2(" PEAP: Tunneled authentication was successful.");
270 t->status = PEAP_STATUS_SENT_TLV_SUCCESS;
271 eappeap_success(handler, tls_session);
272 rcode = RLM_MODULE_HANDLED;
275 * If we've been told to use the attributes from
276 * the reply, then do so.
278 * WARNING: This may leak information about the
281 if (t->use_tunneled_reply) {
283 * Clean up the tunneled reply.
285 pairdelete(&reply->vps, PW_PROXY_STATE);
287 pairadd(&request->reply->vps, reply->vps);
292 case PW_AUTHENTICATION_REJECT:
293 DEBUG2(" PEAP: Tunneled authentication was rejected.");
294 t->status = PEAP_STATUS_SENT_TLV_FAILURE;
295 eappeap_failure(handler, tls_session);
296 rcode = RLM_MODULE_HANDLED;
299 case PW_ACCESS_CHALLENGE:
300 DEBUG2(" PEAP: Got tunneled Access-Challenge");
303 * Keep the State attribute, if necessary.
305 * Get rid of the old State, too.
308 pairmove2(&t->state, &(reply->vps), PW_STATE);
311 * PEAP takes only EAP-Message attributes inside
312 * of the tunnel. Any Reply-Message in the
313 * Access-Challenge is ignored.
316 pairmove2(&vp, &(reply->vps), PW_EAP_MESSAGE);
319 * Handle the ACK, by tunneling any necessary reply
320 * VP's back to the client.
323 vp2eap(tls_session, vp);
327 rcode = RLM_MODULE_HANDLED;
331 DEBUG2(" PEAP: Unknown RADIUS packet type %d: rejecting tunneled user", reply->code);
332 rcode = RLM_MODULE_REJECT;
341 * Do post-proxy processing,
343 static int eappeap_postproxy(EAP_HANDLER *handler, void *data)
346 tls_session_t *tls_session = (tls_session_t *) data;
348 DEBUG2(" PEAP: Passing reply from proxy back into the tunnel.");
351 * If there was no EAP-Message in the reply packet, then
352 * we know that we're supposed to re-run the "authenticate"
353 * stage, in order to get the right kind of handling...
357 * Process the reply from the home server.
359 rcode = process_reply(handler, tls_session, handler->request,
360 handler->request->proxy_reply);
363 * The proxy code uses the reply from the home server as
364 * the basis for the reply to the NAS. We don't want that,
365 * so we toss it, after we've had our way with it.
367 pairfree(&handler->request->proxy_reply->vps);
370 case RLM_MODULE_REJECT:
371 DEBUG2(" PEAP: Reply was rejected");
372 eaptls_fail(handler->eap_ds, 0);
375 case RLM_MODULE_HANDLED:
376 DEBUG2(" PEAP: Reply was handled");
377 eaptls_request(handler->eap_ds, tls_session);
381 DEBUG2(" PEAP: Reply was OK");
382 eaptls_success(handler->eap_ds, 0);
383 eaptls_gen_mppe_keys(&handler->request->reply->vps,
385 "client EAP encryption");
389 DEBUG2(" PEAP: Reply was unknown.");
393 eaptls_fail(handler->eap_ds, 0);
399 * Process the pseudo-EAP contents of the tunneled data.
401 int eappeap_process(EAP_HANDLER *handler, tls_session_t *tls_session)
404 peap_tunnel_t *t = tls_session->opaque;
407 int rcode = RLM_MODULE_REJECT;
409 unsigned int data_len;
410 unsigned char buffer[1024];
415 REQUEST *request = handler->request;
416 EAP_DS *eap_ds = handler->eap_ds;
419 * Grab the dirty data, and copy it to our buffer.
421 * I *really* don't like these 'record_t' things...
423 data_len = record_minus(&tls_session->dirty_in, buffer, sizeof(buffer));
427 * Write the data from the dirty buffer (i.e. packet
428 * data) into the buffer which we will give to SSL for
431 * Some of this code COULD technically go into the TLS
432 * module, in eaptls_process(), where it returns EAPTLS_OK.
434 * Similarly, the writing of data to the SSL context could
437 BIO_write(tls_session->into_ssl, buffer, data_len);
438 record_init(&tls_session->clean_out);
441 * Read (and decrypt) the tunneled data from the SSL session,
442 * and put it into the decrypted data buffer.
444 err = SSL_read(tls_session->ssl, tls_session->clean_out.data,
445 sizeof(tls_session->clean_out.data));
448 * FIXME: Call SSL_get_error() to see what went
451 radlog(L_INFO, "rlm_eap_peap: SSL_read Error");
452 return RLM_MODULE_REJECT;
456 * If there's no data, maybe this is an ACK to an
461 * FIXME: Call SSL_get_error() to see what went
464 radlog(L_INFO, "rlm_eap_peap: No data inside of the tunnel.");
465 return RLM_MODULE_REJECT;
468 data_len = tls_session->clean_out.used = err;
469 data = tls_session->clean_out.data;
472 if (debug_flag > 2) {
473 for (i = 0; i < data_len; i++) {
474 if ((i & 0x0f) == 0) printf(" PEAP tunnel data in %04x: ", i);
476 printf("%02x ", data[i]);
478 if ((i & 0x0f) == 0x0f) printf("\n");
480 if ((data_len & 0x0f) != 0) printf("\n");
484 if (!eapmessage_verify(data, data_len)) {
485 return RLM_MODULE_REJECT;
488 DEBUG2(" rlm_eap_peap: Tunneled data is valid.");
491 * If we authenticated the user, then it's OK.
493 if (t->status == PEAP_STATUS_SENT_TLV_SUCCESS) {
494 if (eappeap_check_tlv(data)) {
495 DEBUG2(" rlm_eap_peap: Success");
496 return RLM_MODULE_OK;
499 return RLM_MODULE_REJECT;
501 } else if (t->status == PEAP_STATUS_SENT_TLV_FAILURE) {
502 DEBUG2(" rlm_eap_peap: Had sent TLV failure, rejecting.");
503 return RLM_MODULE_REJECT;
506 fake = request_alloc_fake(request);
508 rad_assert(fake->packet->vps == NULL);
510 fake->packet->vps = eap2vp(eap_ds, data, data_len);
511 if (!fake->packet->vps) {
512 DEBUG2(" rlm_eap_peap: Unable to convert tunneled EAP packet to internal server data structures");
513 return PW_AUTHENTICATION_REJECT;
517 if (debug_flag > 0) {
518 printf(" PEAP: Got tunneled EAP-Message\n");
520 for (vp = fake->packet->vps; vp != NULL; vp = vp->next) {
521 putchar('\t');vp_print(stdout, vp);putchar('\n');
527 * Tell the request that it's a fake one.
529 vp = pairmake("Freeradius-Proxied-To", "127.0.0.1", T_OP_EQ);
531 pairadd(&fake->packet->vps, vp);
535 * Update other items in the REQUEST data structure.
539 * There's no User-Name in the tunneled session,
540 * so we add one here, by pulling it out of the
541 * EAP-Identity packet.
543 if ((data[0] == PW_EAP_IDENTITY) && (data_len > 1)) {
544 t->username = pairmake("User-Name", "", T_OP_EQ);
545 rad_assert(t->username != NULL);
547 memcpy(t->username->strvalue, data+1, data_len - 1);
548 t->username->length = data_len -1;
549 t->username->strvalue[t->username->length] = 0;
550 DEBUG2(" PEAP: Got tunneled identity of %s", t->username->strvalue);
553 * If there's a default EAP type,
556 if (t->default_eap_type != 0) {
557 DEBUG2(" PEAP: Setting default EAP type for tunneled EAP session.");
558 vp = pairmake("EAP-Type", "0", T_OP_EQ);
559 vp->lvalue = t->default_eap_type;
560 pairadd(&fake->config_items, vp);
563 } /* else there WAS a t->username */
566 vp = paircopy(t->username);
567 pairadd(&fake->packet->vps, vp);
568 fake->username = pairfind(fake->packet->vps, PW_USER_NAME);
572 * Add the State attribute, too, if it exists.
575 DEBUG2(" PEAP: Adding old state with %02x %02x",
576 t->state->strvalue[0], t->state->strvalue[1]);
577 vp = paircopy(t->state);
578 if (vp) pairadd(&fake->packet->vps, vp);
582 * If this is set, we copy SOME of the request attributes
583 * from outside of the tunnel to inside of the tunnel.
585 * We copy ONLY those attributes which do NOT already
586 * exist in the tunneled request.
588 * This code is copied from ../rlm_eap_ttls/ttls.c
590 if (t->copy_request_to_tunnel) {
593 for (vp = request->packet->vps; vp != NULL; vp = vp->next) {
595 * The attribute is a server-side thingy,
598 if ((vp->attribute > 255) &&
599 (((vp->attribute >> 16) & 0xffff) == 0)) {
604 * The outside attribute is already in the
605 * tunnel, don't copy it.
607 * This works for BOTH attributes which
608 * are originally in the tunneled request,
609 * AND attributes which are copied there
612 if (pairfind(fake->packet->vps, vp->attribute)) {
617 * Some attributes are handled specially.
619 switch (vp->attribute) {
621 * NEVER copy Message-Authenticator,
622 * EAP-Message, or State. They're
623 * only for outside of the tunnel.
626 case PW_USER_PASSWORD:
627 case PW_CHAP_PASSWORD:
628 case PW_CHAP_CHALLENGE:
630 case PW_MESSAGE_AUTHENTICATOR:
637 * By default, copy it over.
644 * Don't copy from the head, we've already
647 copy = paircopy2(vp, vp->attribute);
648 pairadd(&fake->packet->vps, copy);
653 if (debug_flag > 0) {
654 printf(" PEAP: Sending tunneled request\n");
656 for (vp = fake->packet->vps; vp != NULL; vp = vp->next) {
657 putchar('\t');vp_print(stdout, vp);putchar('\n');
663 * Call authentication recursively, which will
664 * do PAP, CHAP, MS-CHAP, etc.
666 rad_authenticate(fake);
669 * Note that we don't do *anything* with the reply
673 if (debug_flag > 0) {
674 printf(" PEAP: Got tunneled reply RADIUS code %d\n",
677 for (vp = fake->reply->vps; vp != NULL; vp = vp->next) {
678 putchar('\t');vp_print(stdout, vp);putchar('\n');
684 * Decide what to do with the reply.
686 switch (fake->reply->code) {
687 case 0: /* No reply code, must be proxied... */
688 vp = pairfind(fake->config_items, PW_PROXY_TO_REALM);
691 eap_tunnel_data_t *tunnel;
695 * The tunneled request was NOT handled,
696 * it has to be proxied. This means that
697 * the "authenticate" stage was never
700 * If we are told to NOT proxy the
701 * tunneled request as EAP, then this
702 * means that we've got to decode it,
703 * which means that we MUST run the
704 * "authenticate" portion by hand, here.
706 * Once the tunneled EAP session is ALMOST
707 * done, THEN we proxy it...
709 if (!t->proxy_tunneled_request_as_eap) {
710 fake->options |= RAD_REQUEST_OPTION_PROXY_EAP;
713 * Hmm... should we check for
714 * Auth-Type & EAP-Message here?
719 * Run the EAP authentication.
721 DEBUG2(" PEAP: Calling authenticate in order to initiate tunneled EAP session.");
722 rcode = module_authenticate(PW_AUTHTYPE_EAP, fake);
723 if (rcode != RLM_MODULE_HANDLED) {
724 DEBUG2(" PEAP: Can't handle the return code %d", rcode);
725 rcode = RLM_MODULE_REJECT;
730 * The module decided it wasn't
731 * done. Handle it like normal.
733 if ((fake->options & RAD_REQUEST_OPTION_PROXY_EAP) == 0) {
734 DEBUG2(" PEAP: Cancelling proxy to realm %s until the tunneled EAP session has been established", vp->strvalue);
739 * The module has decoded the
740 * EAP-Message into another set
743 pairdelete(&fake->packet->vps,
747 DEBUG2(" PEAP: Tunneled authentication will be proxied to %s", vp->strvalue);
750 * Tell the original request that it's going
753 pairmove2(&(request->config_items),
754 &(fake->config_items),
758 * Seed the proxy packet with the
761 rad_assert(request->proxy == NULL);
762 request->proxy = fake->packet;
766 * Set up the callbacks for the tunnel
768 tunnel = rad_malloc(sizeof(*tunnel));
769 memset(tunnel, 0, sizeof(*tunnel));
771 tunnel->tls_session = tls_session;
772 tunnel->callback = eappeap_postproxy;
775 * Associate the callback with the request.
777 rcode = request_data_add(request,
779 REQUEST_DATA_EAP_TUNNEL_CALLBACK,
781 rad_assert(rcode == 0);
784 * Didn't authenticate the packet, but
787 rcode = RLM_MODULE_UPDATED;
790 DEBUG2(" PEAP: Unknown RADIUS packet type %d: rejecting tunneled user", fake->reply->code);
791 rcode = RLM_MODULE_REJECT;
797 rcode = process_reply(handler, tls_session, request,