src/modules/rlm_eap/types/rlm_eap_peap/rlm_eap_peap.c

   1 /*
   2  * rlm_eap_peap.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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  *
  20  * Copyright 2003 Alan DeKok <aland@freeradius.org>
  21  * Copyright 2006 The FreeRADIUS server project
  22  */
  23
  24 #include <freeradius-devel/ident.h>
  25 RCSID("$Id$")
  26
  27 #include <freeradius-devel/autoconf.h>
  28 #include "eap_peap.h"
  29
  30 typedef struct rlm_eap_peap_t {
  31         /*
  32          *      Default tunneled EAP type
  33          */
  34         char    *default_eap_type_name;
  35         int     default_eap_type;
  36
  37         /*
  38          *      Use the reply attributes from the tunneled session in
  39          *      the non-tunneled reply to the client.
  40          */
  41         int     use_tunneled_reply;
  42
  43         /*
  44          *      Use SOME of the request attributes from outside of the
  45          *      tunneled session in the tunneled request
  46          */
  47         int     copy_request_to_tunnel;
  48
  49 #ifdef WITH_PROXY
  50         /*
  51          *      Proxy tunneled session as EAP, or as de-capsulated
  52          *      protocol.
  53          */
  54         int     proxy_tunneled_request_as_eap;
  55 #endif
  56
  57         /*
  58          *      Virtual server for inner tunnel session.
  59          */
  60         char    *virtual_server;
  61 } rlm_eap_peap_t;
  62
  63
  64 static CONF_PARSER module_config[] = {
  65         { "default_eap_type", PW_TYPE_STRING_PTR,
  66           offsetof(rlm_eap_peap_t, default_eap_type_name), NULL, "mschapv2" },
  67
  68         { "copy_request_to_tunnel", PW_TYPE_BOOLEAN,
  69           offsetof(rlm_eap_peap_t, copy_request_to_tunnel), NULL, "no" },
  70
  71         { "use_tunneled_reply", PW_TYPE_BOOLEAN,
  72           offsetof(rlm_eap_peap_t, use_tunneled_reply), NULL, "no" },
  73
  74 #ifdef WITH_PROXY
  75         { "proxy_tunneled_request_as_eap", PW_TYPE_BOOLEAN,
  76           offsetof(rlm_eap_peap_t, proxy_tunneled_request_as_eap), NULL, "yes" },
  77 #endif
  78
  79         { "virtual_server", PW_TYPE_STRING_PTR,
  80           offsetof(rlm_eap_peap_t, virtual_server), NULL, NULL },
  81
  82         { NULL, -1, 0, NULL, NULL }           /* end the list */
  83 };
  84
  85 /*
  86  *      Detach the module.
  87  */
  88 static int eappeap_detach(void *arg)
  89 {
  90         rlm_eap_peap_t *inst = (rlm_eap_peap_t *) arg;
  91
  92
  93         free(inst);
  94
  95         return 0;
  96 }
  97
  98 /*
  99  *      Attach the module.
 100  */
 101 static int eappeap_attach(CONF_SECTION *cs, void **instance)
 102 {
 103         rlm_eap_peap_t *inst;
 104
 105         inst = malloc(sizeof(*inst));
 106         if (!inst) {
 107                 radlog(L_ERR, "rlm_eap_peap: out of memory");
 108                 return -1;
 109         }
 110         memset(inst, 0, sizeof(*inst));
 111
 112         /*
 113          *      Parse the configuration attributes.
 114          */
 115         if (cf_section_parse(cs, inst, module_config) < 0) {
 116                 eappeap_detach(inst);
 117                 return -1;
 118         }
 119
 120         /*
 121          *      Convert the name to an integer, to make it easier to
 122          *      handle.
 123          */
 124         inst->default_eap_type = eaptype_name2type(inst->default_eap_type_name);
 125         if (inst->default_eap_type < 0) {
 126                 radlog(L_ERR, "rlm_eap_peap: Unknown EAP type %s",
 127                        inst->default_eap_type_name);
 128                 eappeap_detach(inst);
 129                 return -1;
 130         }
 131
 132         *instance = inst;
 133
 134         return 0;
 135 }
 136
 137 /*
 138  *      Free the PEAP per-session data
 139  */
 140 static void peap_free(void *p)
 141 {
 142         peap_tunnel_t *t = (peap_tunnel_t *) p;
 143
 144         if (!t) return;
 145
 146         pairfree(&t->username);
 147         pairfree(&t->state);
 148         pairfree(&t->accept_vps);
 149
 150         free(t);
 151 }
 152
 153
 154 /*
 155  *      Free the PEAP per-session data
 156  */
 157 static peap_tunnel_t *peap_alloc(rlm_eap_peap_t *inst)
 158 {
 159         peap_tunnel_t *t;
 160
 161         t = rad_malloc(sizeof(*t));
 162         memset(t, 0, sizeof(*t));
 163
 164         t->default_eap_type = inst->default_eap_type;
 165         t->copy_request_to_tunnel = inst->copy_request_to_tunnel;
 166         t->use_tunneled_reply = inst->use_tunneled_reply;
 167 #ifdef WITH_PROXY
 168         t->proxy_tunneled_request_as_eap = inst->proxy_tunneled_request_as_eap;
 169 #endif
 170         t->virtual_server = inst->virtual_server;
 171         t->session_resumption_state = PEAP_RESUMPTION_MAYBE;
 172
 173         return t;
 174 }
 175
 176 /*
 177  *      Do authentication, by letting EAP-TLS do most of the work.
 178  */
 179 static int eappeap_authenticate(void *arg, EAP_HANDLER *handler)
 180 {
 181         int rcode;
 182         eaptls_status_t status;
 183         rlm_eap_peap_t *inst = (rlm_eap_peap_t *) arg;
 184         tls_session_t *tls_session = (tls_session_t *) handler->opaque;
 185         peap_tunnel_t *peap = tls_session->opaque;
 186         REQUEST *request = handler->request;
 187
 188         /*
 189          *      Session resumption requires the storage of data, so
 190          *      allocate it if it doesn't already exist.
 191          */
 192         if (!tls_session->opaque) {
 193                 peap = tls_session->opaque = peap_alloc(inst);
 194                 tls_session->free_opaque = peap_free;
 195         }
 196
 197         status = eaptls_process(handler);
 198         RDEBUG2("eaptls_process returned %d\n", status);
 199         switch (status) {
 200                 /*
 201                  *      EAP-TLS handshake was successful, tell the
 202                  *      client to keep talking.
 203                  *
 204                  *      If this was EAP-TLS, we would just return
 205                  *      an EAP-TLS-Success packet here.
 206                  */
 207         case EAPTLS_SUCCESS:
 208                 RDEBUG2("EAPTLS_SUCCESS");
 209                 peap->status = PEAP_STATUS_TUNNEL_ESTABLISHED;
 210                 break;
 211
 212                 /*
 213                  *      The TLS code is still working on the TLS
 214                  *      exchange, and it's a valid TLS request.
 215                  *      do nothing.
 216                  */
 217         case EAPTLS_HANDLED:
 218           /*
 219            *    FIXME: If the SSL session is established, grab the state
 220            *    and EAP id from the inner tunnel, and update it with
 221            *    the expected EAP id!
 222            */
 223                 RDEBUG2("EAPTLS_HANDLED");
 224                 return 1;
 225
 226                 /*
 227                  *      Handshake is done, proceed with decoding tunneled
 228                  *      data.
 229                  */
 230         case EAPTLS_OK:
 231                 RDEBUG2("EAPTLS_OK");
 232                 break;
 233
 234                 /*
 235                  *      Anything else: fail.
 236                  */
 237         default:
 238                 RDEBUG2("EAPTLS_OTHERS");
 239                 return 0;
 240         }
 241
 242         /*
 243          *      Session is established, proceed with decoding
 244          *      tunneled data.
 245          */
 246         RDEBUG2("Session established.  Decoding tunneled attributes.");
 247
 248         /*
 249          *      We may need PEAP data associated with the session, so
 250          *      allocate it here, if it wasn't already alloacted.
 251          */
 252         if (!tls_session->opaque) {
 253                 tls_session->opaque = peap_alloc(inst);
 254                 tls_session->free_opaque = peap_free;
 255         }
 256
 257         /*
 258          *      Process the PEAP portion of the request.
 259          */
 260         rcode = eappeap_process(handler, tls_session);
 261         switch (rcode) {
 262         case RLM_MODULE_REJECT:
 263                 eaptls_fail(handler, 0);
 264                 return 0;
 265
 266         case RLM_MODULE_HANDLED:
 267                 eaptls_request(handler->eap_ds, tls_session);
 268                 return 1;
 269
 270         case RLM_MODULE_OK:
 271                 /*
 272                  *      Move the saved VP's from the Access-Accept to
 273                  *      our Access-Accept.
 274                  */
 275                 peap = tls_session->opaque;
 276                 if (peap->accept_vps) {
 277                         RDEBUG2("Using saved attributes from the original Access-Accept");
 278                         debug_pair_list(peap->accept_vps);
 279                         pairadd(&handler->request->reply->vps, peap->accept_vps);
 280                         peap->accept_vps = NULL;
 281                 }
 282
 283                 /*
 284                  *      Success: Automatically return MPPE keys.
 285                  */
 286                 return eaptls_success(handler, 0);
 287
 288                 /*
 289                  *      No response packet, MUST be proxying it.
 290                  *      The main EAP module will take care of discovering
 291                  *      that the request now has a "proxy" packet, and
 292                  *      will proxy it, rather than returning an EAP packet.
 293                  */
 294         case RLM_MODULE_UPDATED:
 295 #ifdef WITH_PROXY
 296                 rad_assert(handler->request->proxy != NULL);
 297 #endif
 298                 return 1;
 299                 break;
 300
 301         default:
 302                 break;
 303         }
 304
 305         eaptls_fail(handler, 0);
 306         return 0;
 307 }
 308
 309
 310 /*
 311  *      The module name should be the only globally exported symbol.
 312  *      That is, everything else should be 'static'.
 313  */
 314 EAP_TYPE rlm_eap_peap = {
 315         "eap_peap",
 316         eappeap_attach,                 /* attach */
 317         /*
 318          *      Note! There is NO eappeap_initate() function, as the
 319          *      main EAP module takes care of calling
 320          *      eaptls_initiate().
 321          *
 322          *      This is because PEAP is a protocol on top of TLS, so
 323          *      before we need to do PEAP, we've got to initiate a TLS
 324          *      session.
 325          */
 326         NULL,                           /* Start the initial request */
 327         NULL,                           /* authorization */
 328         eappeap_authenticate,           /* authentication */
 329         eappeap_detach                  /* detach */
 330 };