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;
268 if (debug_flag > 0) {
269 printf(" PEAP: Processing from tunneled session code %p %d\n",
272 for (vp = reply->vps; vp != NULL; vp = vp->next) {
273 putchar('\t');vp_print(stdout, vp);putchar('\n');
278 switch (reply->code) {
279 case PW_AUTHENTICATION_ACK:
280 DEBUG2(" PEAP: Tunneled authentication was successful.");
281 t->status = PEAP_STATUS_SENT_TLV_SUCCESS;
282 eappeap_success(handler, tls_session);
283 rcode = RLM_MODULE_HANDLED;
286 * If we've been told to use the attributes from
287 * the reply, then do so.
289 * WARNING: This may leak information about the
292 if (t->use_tunneled_reply) {
294 * Clean up the tunneled reply.
296 pairdelete(&reply->vps, PW_PROXY_STATE);
297 pairdelete(&reply->vps, PW_EAP_MESSAGE);
299 pairadd(&request->reply->vps, reply->vps);
304 case PW_AUTHENTICATION_REJECT:
305 DEBUG2(" PEAP: Tunneled authentication was rejected.");
306 t->status = PEAP_STATUS_SENT_TLV_FAILURE;
307 eappeap_failure(handler, tls_session);
308 rcode = RLM_MODULE_HANDLED;
311 case PW_ACCESS_CHALLENGE:
312 DEBUG2(" PEAP: Got tunneled Access-Challenge");
315 * Keep the State attribute, if necessary.
317 * Get rid of the old State, too.
320 pairmove2(&t->state, &(reply->vps), PW_STATE);
323 * PEAP takes only EAP-Message attributes inside
324 * of the tunnel. Any Reply-Message in the
325 * Access-Challenge is ignored.
328 pairmove2(&vp, &(reply->vps), PW_EAP_MESSAGE);
331 * Handle the ACK, by tunneling any necessary reply
332 * VP's back to the client.
335 vp2eap(tls_session, vp);
339 rcode = RLM_MODULE_HANDLED;
343 DEBUG2(" PEAP: Unknown RADIUS packet type %d: rejecting tunneled user", reply->code);
344 rcode = RLM_MODULE_REJECT;
353 * Do post-proxy processing,
355 static int eappeap_postproxy(EAP_HANDLER *handler, void *data)
358 tls_session_t *tls_session = (tls_session_t *) data;
361 DEBUG2(" PEAP: Passing reply from proxy back into the tunnel.");
364 * If there was a fake request associated with the proxied
365 * request, do more processing of it.
367 fake = (REQUEST *) request_data_get(handler->request,
368 handler->request->proxy,
369 REQUEST_DATA_EAP_MSCHAP_TUNNEL_CALLBACK);
372 * Do the callback, if it exists, and if it was a success.
374 if (fake && (handler->request->proxy_reply->code == PW_AUTHENTICATION_ACK)) {
376 REQUEST *request = handler->request;
381 rad_assert(fake->packet == NULL);
382 fake->packet = request->proxy;
383 request->proxy = NULL;
385 rad_assert(fake->reply == NULL);
386 fake->reply = request->proxy_reply;
387 request->proxy_reply = NULL;
390 * We MAY have deleted the state. If so, add
393 vp = pairfind(fake->packet->vps, PW_STATE);
395 vp = pairmake("State", "0x00", T_OP_EQ);
396 memcpy(vp->strvalue, handler->state,
397 sizeof(handler->state));
398 vp->length = sizeof(handler->state);
399 pairadd(&fake->packet->vps, vp);
403 * The NT Domain may have been removed, too.
406 vp = pairfind(fake->packet->vps, PW_USER_NAME);
408 strNcpy(vp->strvalue, handler->identity,
409 sizeof(vp->strvalue));
410 vp->length = strlen(vp->strvalue);
414 * Perform a post-auth stage, which will get the EAP
417 fake->options &= ~RAD_REQUEST_OPTION_PROXY_EAP;
418 DEBUG2(" PEAP: Passing reply back for EAP-MS-CHAP-V2 %p %d",
419 fake, fake->reply->code);
420 rcode = module_post_proxy(fake);
423 * FIXME: If rcode returns fail, do something
426 DEBUG2(" POST-PROXY %d", rcode);
427 rcode = rad_postauth(fake);
428 DEBUG2(" POST-AUTH %d", rcode);
431 if (debug_flag > 0) {
432 printf(" PEAP: Final reply from tunneled session code %d\n",
435 for (vp = fake->reply->vps; vp != NULL; vp = vp->next) {
436 putchar('\t');vp_print(stdout, vp);putchar('\n');
444 request->proxy = fake->packet;
446 request->proxy_reply = fake->reply;
450 * And we're done with this request.
454 case RLM_MODULE_FAIL:
456 eaptls_fail(handler->eap_ds, 0);
460 default: /* Don't Do Anything */
461 DEBUG2(" PEAP: Got reply %d",
462 request->proxy_reply->code);
466 request_free(&fake); /* robust if fake == NULL */
469 * If there was no EAP-Message in the reply packet, then
470 * we know that we're supposed to re-run the "authenticate"
471 * stage, in order to get the right kind of handling...
475 * Process the reply from the home server.
478 rcode = process_reply(handler, tls_session, handler->request,
479 handler->request->proxy_reply);
482 * The proxy code uses the reply from the home server as
483 * the basis for the reply to the NAS. We don't want that,
484 * so we toss it, after we've had our way with it.
486 pairfree(&handler->request->proxy_reply->vps);
489 case RLM_MODULE_REJECT:
490 DEBUG2(" PEAP: Reply was rejected");
491 eaptls_fail(handler->eap_ds, 0);
494 case RLM_MODULE_HANDLED:
495 DEBUG2(" PEAP: Reply was handled");
496 eaptls_request(handler->eap_ds, tls_session);
500 DEBUG2(" PEAP: Reply was OK");
501 eaptls_success(handler->eap_ds, 0);
502 eaptls_gen_mppe_keys(&handler->request->reply->vps,
504 "client EAP encryption");
508 DEBUG2(" PEAP: Reply was unknown.");
512 eaptls_fail(handler->eap_ds, 0);
519 static void my_request_free(void *data)
521 REQUEST *request = (REQUEST *)data;
523 request_free(&request);
528 * Process the pseudo-EAP contents of the tunneled data.
530 int eappeap_process(EAP_HANDLER *handler, tls_session_t *tls_session)
533 peap_tunnel_t *t = tls_session->opaque;
536 int rcode = RLM_MODULE_REJECT;
538 unsigned int data_len;
539 unsigned char buffer[1024];
544 REQUEST *request = handler->request;
545 EAP_DS *eap_ds = handler->eap_ds;
548 * Grab the dirty data, and copy it to our buffer.
550 * I *really* don't like these 'record_t' things...
552 data_len = record_minus(&tls_session->dirty_in, buffer, sizeof(buffer));
556 * Write the data from the dirty buffer (i.e. packet
557 * data) into the buffer which we will give to SSL for
560 * Some of this code COULD technically go into the TLS
561 * module, in eaptls_process(), where it returns EAPTLS_OK.
563 * Similarly, the writing of data to the SSL context could
566 BIO_write(tls_session->into_ssl, buffer, data_len);
567 record_init(&tls_session->clean_out);
570 * Read (and decrypt) the tunneled data from the SSL session,
571 * and put it into the decrypted data buffer.
573 err = SSL_read(tls_session->ssl, tls_session->clean_out.data,
574 sizeof(tls_session->clean_out.data));
577 * FIXME: Call SSL_get_error() to see what went
580 radlog(L_INFO, "rlm_eap_peap: SSL_read Error");
581 return RLM_MODULE_REJECT;
585 * If there's no data, maybe this is an ACK to an
590 * FIXME: Call SSL_get_error() to see what went
593 radlog(L_INFO, "rlm_eap_peap: No data inside of the tunnel.");
594 return RLM_MODULE_REJECT;
597 data_len = tls_session->clean_out.used = err;
598 data = tls_session->clean_out.data;
601 if (debug_flag > 2) {
602 for (i = 0; i < data_len; i++) {
603 if ((i & 0x0f) == 0) printf(" PEAP tunnel data in %04x: ", i);
605 printf("%02x ", data[i]);
607 if ((i & 0x0f) == 0x0f) printf("\n");
609 if ((data_len & 0x0f) != 0) printf("\n");
613 if (!eapmessage_verify(data, data_len)) {
614 return RLM_MODULE_REJECT;
617 DEBUG2(" rlm_eap_peap: Tunneled data is valid.");
620 * If we authenticated the user, then it's OK.
622 if (t->status == PEAP_STATUS_SENT_TLV_SUCCESS) {
623 if (eappeap_check_tlv(data)) {
624 DEBUG2(" rlm_eap_peap: Success");
625 return RLM_MODULE_OK;
628 return RLM_MODULE_REJECT;
630 } else if (t->status == PEAP_STATUS_SENT_TLV_FAILURE) {
631 DEBUG2(" rlm_eap_peap: Had sent TLV failure, rejecting.");
632 return RLM_MODULE_REJECT;
635 fake = request_alloc_fake(request);
637 rad_assert(fake->packet->vps == NULL);
639 fake->packet->vps = eap2vp(eap_ds, data, data_len);
640 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->strvalue, data + 1, data_len - 1);
677 t->username->length = data_len - 1;
678 t->username->strvalue[t->username->length] = 0;
679 DEBUG2(" PEAP: Got tunneled identity of %s", t->username->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->lvalue = 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->strvalue);
703 * Add the State attribute, too, if it exists.
706 DEBUG2(" PEAP: Adding old state with %02x %02x",
707 t->state->strvalue[0], t->state->strvalue[1]);
708 vp = paircopy(t->state);
709 if (vp) pairadd(&fake->packet->vps, vp);
713 * If this is set, we copy SOME of the request attributes
714 * from outside of the tunnel to inside of the tunnel.
716 * We copy ONLY those attributes which do NOT already
717 * exist in the tunneled request.
719 * This code is copied from ../rlm_eap_ttls/ttls.c
721 if (t->copy_request_to_tunnel) {
724 for (vp = request->packet->vps; vp != NULL; vp = vp->next) {
726 * The attribute is a server-side thingy,
729 if ((vp->attribute > 255) &&
730 (((vp->attribute >> 16) & 0xffff) == 0)) {
735 * The outside attribute is already in the
736 * tunnel, don't copy it.
738 * This works for BOTH attributes which
739 * are originally in the tunneled request,
740 * AND attributes which are copied there
743 if (pairfind(fake->packet->vps, vp->attribute)) {
748 * Some attributes are handled specially.
750 switch (vp->attribute) {
752 * NEVER copy Message-Authenticator,
753 * EAP-Message, or State. They're
754 * only for outside of the tunnel.
757 case PW_USER_PASSWORD:
758 case PW_CHAP_PASSWORD:
759 case PW_CHAP_CHALLENGE:
761 case PW_MESSAGE_AUTHENTICATOR:
768 * By default, copy it over.
775 * Don't copy from the head, we've already
778 copy = paircopy2(vp, vp->attribute);
779 pairadd(&fake->packet->vps, copy);
784 if (debug_flag > 0) {
785 printf(" PEAP: Sending tunneled request\n");
787 for (vp = fake->packet->vps; vp != NULL; vp = vp->next) {
788 putchar('\t');vp_print(stdout, vp);putchar('\n');
794 * Call authentication recursively, which will
795 * do PAP, CHAP, MS-CHAP, etc.
797 rad_authenticate(fake);
800 * Note that we don't do *anything* with the reply
804 if (debug_flag > 0) {
805 printf(" PEAP: Got tunneled reply RADIUS code %d\n",
808 for (vp = fake->reply->vps; vp != NULL; vp = vp->next) {
809 putchar('\t');vp_print(stdout, vp);putchar('\n');
815 * Decide what to do with the reply.
817 switch (fake->reply->code) {
818 case 0: /* No reply code, must be proxied... */
819 vp = pairfind(fake->config_items, PW_PROXY_TO_REALM);
822 eap_tunnel_data_t *tunnel;
825 * The tunneled request was NOT handled,
826 * it has to be proxied. This means that
827 * the "authenticate" stage was never
830 * If we are told to NOT proxy the
831 * tunneled request as EAP, then this
832 * means that we've got to decode it,
833 * which means that we MUST run the
834 * "authenticate" portion by hand, here.
836 * Once the tunneled EAP session is ALMOST
837 * done, THEN we proxy it...
839 if (!t->proxy_tunneled_request_as_eap) {
840 fake->options |= RAD_REQUEST_OPTION_PROXY_EAP;
843 * Hmm... should we check for
844 * Auth-Type & EAP-Message here?
849 * Run the EAP authentication.
851 DEBUG2(" PEAP: Calling authenticate in order to initiate tunneled EAP session.");
852 rcode = module_authenticate(PW_AUTHTYPE_EAP, fake);
853 if (rcode == RLM_MODULE_OK) {
855 * Authentication succeeded! Rah!
857 fake->reply->code = PW_AUTHENTICATION_ACK;
861 if (rcode != RLM_MODULE_HANDLED) {
862 DEBUG2(" PEAP: Can't handle the return code %d", rcode);
863 rcode = RLM_MODULE_REJECT;
868 * The module decided it wasn't
869 * done. Handle it like normal.
871 if ((fake->options & RAD_REQUEST_OPTION_PROXY_EAP) == 0) {
872 DEBUG2(" PEAP: Cancelling proxy to realm %s until the tunneled EAP session has been established", vp->strvalue);
877 * The module has decoded the
878 * EAP-Message into another set
881 pairdelete(&fake->packet->vps,
885 DEBUG2(" PEAP: Tunneled authentication will be proxied to %s", vp->strvalue);
888 * Tell the original request that it's going
891 pairmove2(&(request->config_items),
892 &(fake->config_items),
896 * Seed the proxy packet with the
899 rad_assert(request->proxy == NULL);
900 request->proxy = fake->packet;
902 rad_free(&fake->reply);
906 * Set up the callbacks for the tunnel
908 tunnel = rad_malloc(sizeof(*tunnel));
909 memset(tunnel, 0, sizeof(*tunnel));
911 tunnel->tls_session = tls_session;
912 tunnel->callback = eappeap_postproxy;
915 * Associate the callback with the request.
917 rcode = request_data_add(request,
919 REQUEST_DATA_EAP_TUNNEL_CALLBACK,
921 rad_assert(rcode == 0);
924 * We're not proxying it as EAP, so we've got
925 * to do the callback later.
927 if ((fake->options & RAD_REQUEST_OPTION_PROXY_EAP) != 0) {
928 DEBUG2(" PEAP: Remembering to do EAP-MS-CHAP-V2 post-proxy.");
931 * rlm_eap.c has taken care of associating
932 * the handler with the fake request.
934 * So we associate the fake request with
937 rcode = request_data_add(request,
939 REQUEST_DATA_EAP_MSCHAP_TUNNEL_CALLBACK,
940 fake, my_request_free);
941 rad_assert(rcode == 0);
944 * Do NOT free the fake request!
946 return RLM_MODULE_UPDATED;
950 * Didn't authenticate the packet, but
953 rcode = RLM_MODULE_UPDATED;
956 DEBUG2(" PEAP: Unknown RADIUS packet type %d: rejecting tunneled user", fake->reply->code);
957 rcode = RLM_MODULE_REJECT;
963 rcode = process_reply(handler, tls_session, request,