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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Copyright 2003 Alan DeKok <aland@freeradius.org>
21 * Copyright 2006 The FreeRADIUS server project
24 #include <freeradius-devel/ident.h>
30 * Send protected EAP-Failure
32 * Result-TLV = Failure
34 static int eappeap_failure(EAP_HANDLER *handler, tls_session_t *tls_session)
36 uint8_t tlv_packet[11];
38 DEBUG2(" rlm_eap_peap: FAILURE");
40 tlv_packet[0] = PW_EAP_REQUEST;
41 tlv_packet[1] = handler->eap_ds->response->id +1;
43 tlv_packet[3] = 11; /* length of this packet */
44 tlv_packet[4] = PW_EAP_TLV;
46 tlv_packet[6] = EAP_TLV_ACK_RESULT;
48 tlv_packet[8] = 2; /* length of the data portion */
50 tlv_packet[10] = EAP_TLV_FAILURE;
52 (tls_session->record_plus)(&tls_session->clean_in, tlv_packet, 11);
55 * FIXME: Check the return code.
57 tls_handshake_send(tls_session);
64 * Send protected EAP-Success
66 * Result-TLV = Success
68 static int eappeap_success(EAP_HANDLER *handler, tls_session_t *tls_session)
70 uint8_t tlv_packet[11];
72 DEBUG2(" rlm_eap_peap: SUCCESS");
74 tlv_packet[0] = PW_EAP_REQUEST;
75 tlv_packet[1] = handler->eap_ds->response->id +1;
77 tlv_packet[3] = 11; /* length of this packet */
78 tlv_packet[4] = PW_EAP_TLV;
79 tlv_packet[5] = 0x80; /* mandatory AVP */
80 tlv_packet[6] = EAP_TLV_ACK_RESULT;
82 tlv_packet[8] = 2; /* length of the data portion */
84 tlv_packet[10] = EAP_TLV_SUCCESS;
86 (tls_session->record_plus)(&tls_session->clean_in, tlv_packet, 11);
89 * FIXME: Check the return code.
91 tls_handshake_send(tls_session);
98 * Verify the tunneled EAP message.
100 static int eapmessage_verify(const uint8_t *data, unsigned int data_len)
102 const eap_packet_t *eap_packet = (const eap_packet_t *) data;
106 if (!data || (data_len <= 1)) {
112 case PW_EAP_IDENTITY:
113 DEBUG2(" rlm_eap_peap: Identity - %*s",
114 data_len - 1, data + 1);
119 * If the first byte of the packet is
120 * EAP-Response, and the EAP data is a TLV,
121 * then it looks OK...
123 case PW_EAP_RESPONSE:
124 if (eap_packet->data[0] == PW_EAP_TLV) {
125 DEBUG2(" rlm_eap_peap: Received EAP-TLV response.");
128 DEBUG2(" rlm_eap_peap: Got something weird.");
133 * We normally do Microsoft MS-CHAPv2 (26), versus
134 * Cisco MS-CHAPv2 (29).
136 case PW_EAP_MSCHAPV2:
138 DEBUG2(" rlm_eap_peap: EAP type %s",
139 eaptype_type2name(eap_type,
140 buffer, sizeof(buffer)));
149 * Convert a pseudo-EAP packet to a list of VALUE_PAIR's.
151 static VALUE_PAIR *eap2vp(EAP_DS *eap_ds,
152 const uint8_t *data, size_t data_len)
155 VALUE_PAIR *vp = NULL, *head, **tail;
157 if (data_len > 65535) return NULL; /* paranoia */
159 vp = paircreate(PW_EAP_MESSAGE, PW_TYPE_OCTETS);
161 DEBUG2(" rlm_eap_peap: Failure in creating VP");
166 if (total > 249) total = 249;
169 * Hand-build an EAP packet from the crap in PEAP version 0.
171 vp->vp_octets[0] = PW_EAP_RESPONSE;
172 vp->vp_octets[1] = eap_ds->response->id;
173 vp->vp_octets[2] = (data_len + EAP_HEADER_LEN) >> 8;
174 vp->vp_octets[3] = (data_len + EAP_HEADER_LEN) & 0xff;
176 memcpy(vp->vp_octets + EAP_HEADER_LEN, data, total);
177 vp->length = EAP_HEADER_LEN + total;
181 while (total < data_len) {
185 vp = paircreate(PW_EAP_MESSAGE, PW_TYPE_OCTETS);
187 DEBUG2(" rlm_eap_peap: Failure in creating VP");
191 vp_len = (data_len - total);
192 if (vp_len > 253) vp_len = 253;
194 memcpy(vp->vp_octets, data + total, vp_len);
207 * Convert a list of VALUE_PAIR's to an EAP packet, through the
208 * simple expedient of dumping the EAP message
210 static int vp2eap(tls_session_t *tls_session, VALUE_PAIR *vp)
213 * Skip the id, code, and length. Just write the EAP
214 * type & data to the client.
217 if (debug_flag > 2) {
223 for (this = vp; this != NULL; this = this->next) {
226 if (this == vp) start = EAP_HEADER_LEN;
228 for (i = start; i < vp->length; i++) {
229 if ((total & 0x0f) == 0) printf(" PEAP tunnel data out %04x: ", total);
231 printf("%02x ", vp->vp_octets[i]);
233 if ((total & 0x0f) == 0x0f) printf("\n");
237 if ((total & 0x0f) != 0) printf("\n");
242 * Send the EAP data, WITHOUT the header.
244 (tls_session->record_plus)(&tls_session->clean_in,
245 vp->vp_octets + EAP_HEADER_LEN,
246 vp->length - EAP_HEADER_LEN);
249 * Send the rest of the EAP data.
251 for (vp = vp->next; vp != NULL; vp = vp->next) {
252 (tls_session->record_plus)(&tls_session->clean_in,
253 vp->vp_octets, vp->length);
256 tls_handshake_send(tls_session);
263 * See if there's a TLV in the response.
265 static int eappeap_check_tlv(const uint8_t *data)
267 const eap_packet_t *eap_packet = (const eap_packet_t *) data;
270 * Look for success or failure.
272 if ((eap_packet->code == PW_EAP_RESPONSE) &&
273 (eap_packet->data[0] == PW_EAP_TLV)) {
274 if (data[10] == EAP_TLV_SUCCESS) {
278 if (data[10] == EAP_TLV_FAILURE) {
279 DEBUG2(" rlm_eap_peap: Client rejected our response. The password is probably incorrect.");
289 * Use a reply packet to determine what to do.
291 static int process_reply(EAP_HANDLER *handler, tls_session_t *tls_session,
292 UNUSED REQUEST *request, RADIUS_PACKET *reply)
294 int rcode = RLM_MODULE_REJECT;
296 peap_tunnel_t *t = tls_session->opaque;
299 if (debug_flag > 0) {
300 printf(" PEAP: Processing from tunneled session code %p %d\n",
303 for (vp = reply->vps; vp != NULL; vp = vp->next) {
304 putchar('\t');vp_print(stdout, vp);putchar('\n');
309 switch (reply->code) {
310 case PW_AUTHENTICATION_ACK:
311 DEBUG2(" PEAP: Tunneled authentication was successful.");
312 t->status = PEAP_STATUS_SENT_TLV_SUCCESS;
313 eappeap_success(handler, tls_session);
314 rcode = RLM_MODULE_HANDLED;
317 * If we've been told to use the attributes from
318 * the reply, then do so.
320 * WARNING: This may leak information about the
323 if (t->use_tunneled_reply) {
324 DEBUG2(" Saving tunneled attributes for later");
327 * Clean up the tunneled reply.
329 pairdelete(&reply->vps, PW_PROXY_STATE);
330 pairdelete(&reply->vps, PW_EAP_MESSAGE);
331 pairdelete(&reply->vps, PW_MESSAGE_AUTHENTICATOR);
333 t->accept_vps = reply->vps;
338 case PW_AUTHENTICATION_REJECT:
339 DEBUG2(" PEAP: Tunneled authentication was rejected.");
340 t->status = PEAP_STATUS_SENT_TLV_FAILURE;
341 eappeap_failure(handler, tls_session);
342 rcode = RLM_MODULE_HANDLED;
345 case PW_ACCESS_CHALLENGE:
346 DEBUG2(" PEAP: Got tunneled Access-Challenge");
349 * Keep the State attribute, if necessary.
351 * Get rid of the old State, too.
354 pairmove2(&t->state, &(reply->vps), PW_STATE);
357 * PEAP takes only EAP-Message attributes inside
358 * of the tunnel. Any Reply-Message in the
359 * Access-Challenge is ignored.
362 pairmove2(&vp, &(reply->vps), PW_EAP_MESSAGE);
365 * Handle EAP-MSCHAP-V2, where Access-Accept's
366 * from the home server may contain MS-CHAP-Success,
367 * which the module turns into challenges, so that
368 * the client may respond to the challenge with
371 if (t->home_access_accept && t->use_tunneled_reply) {
372 DEBUG2(" Saving tunneled attributes for later");
375 * Clean up the tunneled reply.
377 pairdelete(&reply->vps, PW_PROXY_STATE);
378 pairdelete(&reply->vps, PW_MESSAGE_AUTHENTICATOR);
380 t->accept_vps = reply->vps;
385 * Handle the ACK, by tunneling any necessary reply
386 * VP's back to the client.
389 vp2eap(tls_session, vp);
393 rcode = RLM_MODULE_HANDLED;
397 DEBUG2(" PEAP: Unknown RADIUS packet type %d: rejecting tunneled user", reply->code);
398 rcode = RLM_MODULE_REJECT;
407 * Do post-proxy processing,
409 static int eappeap_postproxy(EAP_HANDLER *handler, void *data)
412 tls_session_t *tls_session = (tls_session_t *) data;
415 DEBUG2(" PEAP: Passing reply from proxy back into the tunnel.");
418 * If there was a fake request associated with the proxied
419 * request, do more processing of it.
421 fake = (REQUEST *) request_data_get(handler->request,
422 handler->request->proxy,
423 REQUEST_DATA_EAP_MSCHAP_TUNNEL_CALLBACK);
426 * Do the callback, if it exists, and if it was a success.
428 if (fake && (handler->request->proxy_reply->code == PW_AUTHENTICATION_ACK)) {
430 REQUEST *request = handler->request;
431 peap_tunnel_t *t = tls_session->opaque;
433 t->home_access_accept = TRUE;
438 rad_assert(fake->packet == NULL);
439 fake->packet = request->proxy;
440 request->proxy = NULL;
442 rad_assert(fake->reply == NULL);
443 fake->reply = request->proxy_reply;
444 request->proxy_reply = NULL;
447 * Perform a post-auth stage, which will get the EAP
450 fake->options &= ~RAD_REQUEST_OPTION_PROXY_EAP;
451 DEBUG2(" PEAP: Passing reply back for EAP-MS-CHAP-V2 %p %d",
452 fake, fake->reply->code);
453 rcode = module_post_proxy(0, fake);
456 * FIXME: If rcode returns fail, do something
459 DEBUG2(" POST-PROXY %d", rcode);
460 rcode = rad_postauth(fake);
461 DEBUG2(" POST-AUTH %d", rcode);
464 if (debug_flag > 0) {
465 printf(" PEAP: Final reply from tunneled session code %d\n",
468 for (vp = fake->reply->vps; vp != NULL; vp = vp->next) {
469 putchar('\t');vp_print(stdout, vp);putchar('\n');
477 request->proxy = fake->packet;
479 request->proxy_reply = fake->reply;
483 * And we're done with this request.
487 case RLM_MODULE_FAIL:
489 eaptls_fail(handler->eap_ds, 0);
493 default: /* Don't Do Anything */
494 DEBUG2(" PEAP: Got reply %d",
495 request->proxy_reply->code);
499 request_free(&fake); /* robust if fake == NULL */
502 * If there was no EAP-Message in the reply packet, then
503 * we know that we're supposed to re-run the "authenticate"
504 * stage, in order to get the right kind of handling...
508 * Process the reply from the home server.
511 rcode = process_reply(handler, tls_session, handler->request,
512 handler->request->proxy_reply);
515 * The proxy code uses the reply from the home server as
516 * the basis for the reply to the NAS. We don't want that,
517 * so we toss it, after we've had our way with it.
519 pairfree(&handler->request->proxy_reply->vps);
522 case RLM_MODULE_REJECT:
523 DEBUG2(" PEAP: Reply was rejected");
524 eaptls_fail(handler->eap_ds, 0);
527 case RLM_MODULE_HANDLED:
528 DEBUG2(" PEAP: Reply was handled");
529 eaptls_request(handler->eap_ds, tls_session);
533 DEBUG2(" PEAP: Reply was OK");
534 eaptls_success(handler->eap_ds, 0);
535 eaptls_gen_mppe_keys(&handler->request->reply->vps,
537 "client EAP encryption");
541 DEBUG2(" PEAP: Reply was unknown.");
545 eaptls_fail(handler->eap_ds, 0);
552 static void my_request_free(void *data)
554 REQUEST *request = (REQUEST *)data;
556 request_free(&request);
561 * Process the pseudo-EAP contents of the tunneled data.
563 int eappeap_process(EAP_HANDLER *handler, tls_session_t *tls_session)
566 peap_tunnel_t *t = tls_session->opaque;
569 int rcode = RLM_MODULE_REJECT;
571 unsigned int data_len;
576 REQUEST *request = handler->request;
577 EAP_DS *eap_ds = handler->eap_ds;
580 * FIXME: if the SSL session says "want read", or
581 * similar, leave the data in the clean_out buffer. This
582 * lets the application data be sent across multiple
585 err = tls_handshake_recv(tls_session);
587 DEBUG2(" rlm_eap_peap: Failed in SSL");
588 return RLM_MODULE_REJECT;
592 * Just look at the buffer directly, without doing
593 * record_minus. This lets us avoid another data copy.
595 data_len = tls_session->clean_out.used;
596 tls_session->clean_out.used = 0;
597 data = tls_session->clean_out.data;
600 if (debug_flag > 2) {
601 for (i = 0; i < data_len; i++) {
602 if ((i & 0x0f) == 0) printf(" PEAP tunnel data in %04x: ", i);
604 printf("%02x ", data[i]);
606 if ((i & 0x0f) == 0x0f) printf("\n");
608 if ((data_len & 0x0f) != 0) printf("\n");
612 if (!eapmessage_verify(data, data_len)) {
613 DEBUG2(" rlm_eap_peap: Tunneled data is invalid.");
614 return RLM_MODULE_REJECT;
619 * If we authenticated the user, then it's OK.
621 if (t->status == PEAP_STATUS_SENT_TLV_SUCCESS) {
622 if (eappeap_check_tlv(data)) {
623 DEBUG2(" rlm_eap_peap: Success");
624 return RLM_MODULE_OK;
627 return RLM_MODULE_REJECT;
629 } else if (t->status == PEAP_STATUS_SENT_TLV_FAILURE) {
630 DEBUG2(" rlm_eap_peap: Had sent TLV failure. User was rejected earlier in this session.");
631 return RLM_MODULE_REJECT;
634 fake = request_alloc_fake(request);
636 rad_assert(fake->packet->vps == NULL);
638 fake->packet->vps = eap2vp(eap_ds, data, data_len);
639 if (!fake->packet->vps) {
641 DEBUG2(" rlm_eap_peap: Unable to convert tunneled EAP packet to internal server data structures");
642 return PW_AUTHENTICATION_REJECT;
646 if (debug_flag > 0) {
647 printf(" PEAP: Got tunneled EAP-Message\n");
649 for (vp = fake->packet->vps; vp != NULL; vp = vp->next) {
650 putchar('\t');vp_print(stdout, vp);putchar('\n');
656 * Tell the request that it's a fake one.
658 vp = pairmake("Freeradius-Proxied-To", "127.0.0.1", T_OP_EQ);
660 pairadd(&fake->packet->vps, vp);
664 * Update other items in the REQUEST data structure.
668 * There's no User-Name in the tunneled session,
669 * so we add one here, by pulling it out of the
670 * EAP-Identity packet.
672 if ((data[0] == PW_EAP_IDENTITY) && (data_len > 1)) {
673 t->username = pairmake("User-Name", "", T_OP_EQ);
674 rad_assert(t->username != NULL);
676 memcpy(t->username->vp_strvalue, data + 1, data_len - 1);
677 t->username->length = data_len - 1;
678 t->username->vp_strvalue[t->username->length] = 0;
679 DEBUG2(" PEAP: Got tunneled identity of %s", t->username->vp_strvalue);
682 * If there's a default EAP type,
685 if (t->default_eap_type != 0) {
686 DEBUG2(" PEAP: Setting default EAP type for tunneled EAP session.");
687 vp = pairmake("EAP-Type", "0", T_OP_EQ);
688 vp->vp_integer = t->default_eap_type;
689 pairadd(&fake->config_items, vp);
692 } /* else there WAS a t->username */
695 vp = paircopy(t->username);
696 pairadd(&fake->packet->vps, vp);
697 fake->username = pairfind(fake->packet->vps, PW_USER_NAME);
698 DEBUG2(" PEAP: Setting User-Name to %s",
699 fake->username->vp_strvalue);
703 * Add the State attribute, too, if it exists.
706 vp = paircopy(t->state);
707 if (vp) pairadd(&fake->packet->vps, vp);
711 * If this is set, we copy SOME of the request attributes
712 * from outside of the tunnel to inside of the tunnel.
714 * We copy ONLY those attributes which do NOT already
715 * exist in the tunneled request.
717 * This code is copied from ../rlm_eap_ttls/ttls.c
719 if (t->copy_request_to_tunnel) {
722 for (vp = request->packet->vps; vp != NULL; vp = vp->next) {
724 * The attribute is a server-side thingy,
727 if ((vp->attribute > 255) &&
728 (((vp->attribute >> 16) & 0xffff) == 0)) {
733 * The outside attribute is already in the
734 * tunnel, don't copy it.
736 * This works for BOTH attributes which
737 * are originally in the tunneled request,
738 * AND attributes which are copied there
741 if (pairfind(fake->packet->vps, vp->attribute)) {
746 * Some attributes are handled specially.
748 switch (vp->attribute) {
750 * NEVER copy Message-Authenticator,
751 * EAP-Message, or State. They're
752 * only for outside of the tunnel.
755 case PW_USER_PASSWORD:
756 case PW_CHAP_PASSWORD:
757 case PW_CHAP_CHALLENGE:
759 case PW_MESSAGE_AUTHENTICATOR:
766 * By default, copy it over.
773 * Don't copy from the head, we've already
776 copy = paircopy2(vp, vp->attribute);
777 pairadd(&fake->packet->vps, copy);
781 if ((vp = pairfind(request->config_items, PW_VIRTUAL_SERVER)) != NULL) {
782 fake->server = vp->vp_strvalue;
784 } else if (t->virtual_server) {
785 fake->server = t->virtual_server;
787 } /* else fake->server == request->server */
790 if (debug_flag > 0) {
791 printf(" PEAP: Sending tunneled request\n");
793 for (vp = fake->packet->vps; vp != NULL; vp = vp->next) {
794 putchar('\t');vp_print(stdout, vp);putchar('\n');
797 printf("server %s {\n", fake->server);
802 * Call authentication recursively, which will
803 * do PAP, CHAP, MS-CHAP, etc.
805 rad_authenticate(fake);
808 * Note that we don't do *anything* with the reply
812 if (debug_flag > 0) {
813 printf("} # server %s\n", fake->server);
815 printf(" PEAP: Got tunneled reply RADIUS code %d\n",
818 for (vp = fake->reply->vps; vp != NULL; vp = vp->next) {
819 putchar('\t');vp_print(stdout, vp);putchar('\n');
825 * Decide what to do with the reply.
827 switch (fake->reply->code) {
828 case 0: /* No reply code, must be proxied... */
829 vp = pairfind(fake->config_items, PW_PROXY_TO_REALM);
832 eap_tunnel_data_t *tunnel;
835 * The tunneled request was NOT handled,
836 * it has to be proxied. This means that
837 * the "authenticate" stage was never
840 * If we are told to NOT proxy the
841 * tunneled request as EAP, then this
842 * means that we've got to decode it,
843 * which means that we MUST run the
844 * "authenticate" portion by hand, here.
846 * Once the tunneled EAP session is ALMOST
847 * done, THEN we proxy it...
849 if (!t->proxy_tunneled_request_as_eap) {
850 fake->options |= RAD_REQUEST_OPTION_PROXY_EAP;
853 * Hmm... should we check for
854 * Auth-Type & EAP-Message here?
859 * Run the EAP authentication.
861 DEBUG2(" PEAP: Calling authenticate in order to initiate tunneled EAP session.");
862 rcode = module_authenticate(PW_AUTHTYPE_EAP, fake);
863 if (rcode == RLM_MODULE_OK) {
865 * Authentication succeeded! Rah!
867 fake->reply->code = PW_AUTHENTICATION_ACK;
871 if (rcode != RLM_MODULE_HANDLED) {
872 DEBUG2(" PEAP: Can't handle the return code %d", rcode);
873 rcode = RLM_MODULE_REJECT;
878 * The module decided it wasn't
879 * done. Handle it like normal.
881 if ((fake->options & RAD_REQUEST_OPTION_PROXY_EAP) == 0) {
882 DEBUG2(" PEAP: Cancelling proxy to realm %s until the tunneled EAP session has been established", vp->vp_strvalue);
887 * The module has decoded the
888 * EAP-Message into another set
891 pairdelete(&fake->packet->vps,
895 DEBUG2(" PEAP: Tunneled authentication will be proxied to %s", vp->vp_strvalue);
898 * Tell the original request that it's going
901 pairmove2(&(request->config_items),
902 &(fake->config_items),
906 * Seed the proxy packet with the
909 rad_assert(request->proxy == NULL);
910 request->proxy = fake->packet;
912 rad_free(&fake->reply);
916 * Set up the callbacks for the tunnel
918 tunnel = rad_malloc(sizeof(*tunnel));
919 memset(tunnel, 0, sizeof(*tunnel));
921 tunnel->tls_session = tls_session;
922 tunnel->callback = eappeap_postproxy;
925 * Associate the callback with the request.
927 rcode = request_data_add(request,
929 REQUEST_DATA_EAP_TUNNEL_CALLBACK,
931 rad_assert(rcode == 0);
934 * We're not proxying it as EAP, so we've got
935 * to do the callback later.
937 if ((fake->options & RAD_REQUEST_OPTION_PROXY_EAP) != 0) {
938 DEBUG2(" PEAP: Remembering to do EAP-MS-CHAP-V2 post-proxy.");
941 * rlm_eap.c has taken care of associating
942 * the handler with the fake request.
944 * So we associate the fake request with
947 rcode = request_data_add(request,
949 REQUEST_DATA_EAP_MSCHAP_TUNNEL_CALLBACK,
950 fake, my_request_free);
951 rad_assert(rcode == 0);
954 * Do NOT free the fake request!
956 return RLM_MODULE_UPDATED;
960 * Didn't authenticate the packet, but
963 rcode = RLM_MODULE_UPDATED;
966 DEBUG2(" PEAP: Unknown RADIUS packet type %d: rejecting tunneled user", fake->reply->code);
967 rcode = RLM_MODULE_REJECT;
973 rcode = process_reply(handler, tls_session, request,