src/modules/rlm_otp/otp_pw_valid.c

   1 /*
   2  * $Id$
   3  *
   4  * Passcode verification function (otpd client) for rlm_otp.
   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  *
  21  * Copyright 2006 TRI-D Systems, Inc.
  22  */
  23
  24 #include <freeradius-devel/ident.h>
  25 RCSID("$Id$")
  26
  27 #include "autoconf.h"
  28 #include "radiusd.h
  29 #include "modules.h"
  30
  31 #include "extern.h"
  32 #include "otp.h"
  33 #include "otp_pw_valid.h"
  34
  35 #include <errno.h>
  36 #include <pthread.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include <sys/types.h>
  40 #include <sys/socket.h>
  41 #include <sys/un.h>
  42 #include <unistd.h>
  43
  44
  45 /* transform otpd return codes into rlm return codes */
  46 static int
  47 otprc2rlmrc(int rc)
  48 {
  49   switch (rc) {
  50     case OTP_RC_OK:                     return RLM_MODULE_OK;
  51     case OTP_RC_USER_UNKNOWN:           return RLM_MODULE_REJECT;
  52     case OTP_RC_AUTHINFO_UNAVAIL:       return RLM_MODULE_REJECT;
  53     case OTP_RC_AUTH_ERR:               return RLM_MODULE_REJECT;
  54     case OTP_RC_MAXTRIES:               return RLM_MODULE_USERLOCK;
  55     case OTP_RC_SERVICE_ERR:            return RLM_MODULE_FAIL;
  56     default:                            return RLM_MODULE_FAIL;
  57   }
  58 }
  59
  60 static otp_fd_t *otp_fd_head;
  61 static pthread_mutex_t otp_fd_head_mutex = PTHREAD_MUTEX_INITIALIZER;
  62
  63 /*
  64  * Test for passcode validity by asking otpd.
  65  *
  66  * If challenge is supplied, it is used to generate the card response
  67  * against which the passcode will be compared.  If challenge is not
  68  * supplied, or if the comparison fails, synchronous responses are
  69  * generated and tested.  NOTE: for async authentications, sync mode
  70  * responses are still considered valid!  (Assuming module configuration
  71  * allows sync mode.)
  72  *
  73  * Returns one of the RLM_MODULE_* codes.  passcode is filled in.
  74  * NB: The returned passcode will contain the PIN!  DO NOT LOG!
  75  */
  76 int
  77 otp_pw_valid(REQUEST *request, int pwe, const char *challenge,
  78              const otp_option_t *opt, char passcode[OTP_MAX_PASSCODE_LEN + 1])
  79 {
  80   otp_request_t otp_request;
  81   otp_reply_t   otp_reply;
  82   VALUE_PAIR    *cvp, *rvp;
  83   char          *username = request->username->strvalue;
  84   int           rc;
  85
  86   if (request->username->length > OTP_MAX_USERNAME_LEN) {
  87     (void) radlog(L_AUTH, "rlm_otp: username [%s] too long", username);
  88     return RLM_MODULE_REJECT;
  89   }
  90   /* we already know challenge is short enough */
  91
  92   otp_request.version = 2;
  93   (void) strcpy(otp_request.username, username);
  94   (void) strcpy(otp_request.challenge, challenge);
  95   otp_request.pwe.pwe = pwe;
  96
  97   /* otp_pwe_present() (done by caller) guarantees that both of these exist */
  98   cvp = pairfind(request->packet->vps, pwattr[pwe - 1]);
  99   rvp = pairfind(request->packet->vps, pwattr[pwe]);
 100   /* this is just to quiet Coverity */
 101   if (!rvp || !cvp)
 102     return RLM_MODULE_REJECT;
 103
 104   /*
 105    * Validate available vps based on pwe type.
 106    * Unfortunately (?) otpd must do this also.
 107    */
 108   switch (otp_request.pwe.pwe) {
 109   case PWE_PAP:
 110     if (rvp->length > OTP_MAX_PASSCODE_LEN) {
 111       (void) radlog(L_AUTH, "rlm_otp: passcode for [%s] too long", username);
 112       return RLM_MODULE_REJECT;
 113     }
 114     (void) strcpy(otp_request.pwe.u.pap.passcode, rvp->strvalue);
 115     break;
 116
 117   case PWE_CHAP:
 118     if (cvp->length > 16) {
 119       (void) radlog(L_AUTH, "rlm_otp: CHAP challenge for [%s] too long",
 120                     username);
 121       return RLM_MODULE_INVALID;
 122     }
 123     if (rvp->length != 17) {
 124       (void) radlog(L_AUTH, "rlm_otp: CHAP response for [%s] wrong size",
 125                     username);
 126       return RLM_MODULE_INVALID;
 127     }
 128     (void) memcpy(otp_request.pwe.u.chap.challenge, cvp->strvalue,
 129                   cvp->length);
 130     otp_request.pwe.u.chap.clen = cvp->length;
 131     (void) memcpy(otp_request.pwe.u.chap.response, rvp->strvalue,
 132                   rvp->length);
 133     otp_request.pwe.u.chap.rlen = rvp->length;
 134     break;
 135
 136   case PWE_MSCHAP:
 137     if (cvp->length != 8) {
 138       (void) radlog(L_AUTH, "rlm_otp: MS-CHAP challenge for [%s] wrong size",
 139                     username);
 140       return RLM_MODULE_INVALID;
 141     }
 142     if (rvp->length != 50) {
 143       (void) radlog(L_AUTH, "rlm_otp: MS-CHAP response for [%s] wrong size",
 144                     username);
 145       return RLM_MODULE_INVALID;
 146     }
 147     (void) memcpy(otp_request.pwe.u.chap.challenge, cvp->strvalue,
 148                   cvp->length);
 149     otp_request.pwe.u.chap.clen = cvp->length;
 150     (void) memcpy(otp_request.pwe.u.chap.response, rvp->strvalue,
 151                   rvp->length);
 152     otp_request.pwe.u.chap.rlen = rvp->length;
 153     break;
 154
 155   case PWE_MSCHAP2:
 156     if (cvp->length != 16) {
 157       (void) radlog(L_AUTH, "rlm_otp: MS-CHAP2 challenge for [%s] wrong size",
 158                     username);
 159       return RLM_MODULE_INVALID;
 160     }
 161     if (rvp->length != 50) {
 162       (void) radlog(L_AUTH, "rlm_otp: MS-CHAP2 response for [%s] wrong size",
 163                     username);
 164       return RLM_MODULE_INVALID;
 165     }
 166     (void) memcpy(otp_request.pwe.u.chap.challenge, cvp->strvalue,
 167                   cvp->length);
 168     otp_request.pwe.u.chap.clen = cvp->length;
 169     (void) memcpy(otp_request.pwe.u.chap.response, rvp->strvalue,
 170                   rvp->length);
 171     otp_request.pwe.u.chap.rlen = rvp->length;
 172     break;
 173   } /* switch (otp_request.pwe.pwe) */
 174
 175   /* last byte must also be a terminator so otpd can verify length easily */
 176   otp_request.username[OTP_MAX_USERNAME_LEN] = '\0';
 177   otp_request.challenge[OTP_MAX_CHALLENGE_LEN] = '\0';
 178   if (otp_request.pwe.pwe == PWE_PAP)
 179     otp_request.pwe.u.pap.passcode[OTP_MAX_PASSCODE_LEN] = '\0';
 180
 181   otp_request.allow_sync = opt->allow_sync;
 182   otp_request.allow_async = opt->allow_async;
 183   otp_request.challenge_delay = opt->challenge_delay;
 184   otp_request.resync = 1;
 185
 186   rc = otp_verify(opt, &otp_request, &otp_reply);
 187   if (rc == OTP_RC_OK)
 188     (void) strcpy(passcode, otp_reply.passcode);
 189   return otprc2rlmrc(rc);
 190 }
 191
 192 /*
 193  * Verify an otp by asking otpd.
 194  * Returns an OTP_* code, or -1 on system failure.
 195  * Fills in reply.
 196  */
 197 static int
 198 otp_verify(const otp_option_t *opt,
 199            const otp_request_t *request, otp_reply_t *reply)
 200 {
 201   otp_fd_t *fdp;
 202   int rc;
 203   int tryagain = 2;
 204
 205 retry:
 206   if (!tryagain--)
 207     return -1;
 208   fdp = otp_getfd(opt);
 209   if (!fdp || fdp->fd == -1)
 210     return -1;
 211
 212   if ((rc = otp_write(fdp, (const char *) request, sizeof(*request))) != 0) {
 213     if (rc == EPIPE)
 214       goto retry;       /* otpd disconnect */   /*TODO: pause */
 215     else
 216       return -1;
 217   }
 218
 219   if ((rc = otp_read(fdp, (char *) reply, sizeof(*reply))) != sizeof(*reply)) {
 220     if (rc == 0)
 221       goto retry;       /* otpd disconnect */   /*TODO: pause */
 222     else
 223       return -1;
 224   }
 225
 226   /* validate the reply */
 227   if (reply->version != 1) {
 228     (void) radlog(L_AUTH, "rlm_otp: otpd reply for [%s] invalid "
 229                           "(version %d != 1)",
 230                   request->username, reply->version);
 231     otp_putfd(fdp, 1);
 232     return -1;
 233   }
 234
 235   if (reply->passcode[OTP_MAX_PASSCODE_LEN] != '\0') {
 236     (void) radlog(L_AUTH, "rlm_otp: otpd reply for [%s] invalid (passcode)",
 237                   request->username);
 238     otp_putfd(fdp, 1);
 239     return -1;
 240   }
 241
 242   otp_putfd(fdp, 0);
 243   return reply->rc;
 244 }
 245
 246 /*
 247  * Full read with logging, and close on failure.
 248  * Returns nread on success, 0 on EOF, -1 on other failures.
 249  */
 250 static int
 251 otp_read(otp_fd_t *fdp, char *buf, size_t len)
 252 {
 253   ssize_t n;
 254   size_t nread = 0;     /* bytes read into buf */
 255
 256   while (nread < len) {
 257     if ((n = read(fdp->fd, &buf[nread], len - nread)) == -1) {
 258       if (errno == EINTR) {
 259         continue;
 260       } else {
 261         (void) radlog(L_ERR, "rlm_otp: %s: read from otpd: %s",
 262                       __func__, strerror(errno));
 263         otp_putfd(fdp, 1);
 264         return -1;
 265       }
 266     }
 267     if (!n) {
 268       (void) radlog(L_ERR, "rlm_otp: %s: otpd disconnect", __func__);
 269       otp_putfd(fdp, 1);
 270       return 0;
 271     }
 272     nread += n;
 273   } /* while (more to read) */
 274
 275   return nread;
 276 }
 277
 278 /*
 279  * Full write with logging, and close on failure.
 280  * Returns 0 on success, errno on failure.
 281  */
 282 static int
 283 otp_write(otp_fd_t *fdp, const char *buf, size_t len)
 284 {
 285   size_t nleft = len;
 286   ssize_t nwrote;
 287
 288   while (nleft) {
 289     if ((nwrote = write(fdp->fd, &buf[len - nleft], nleft)) == -1) {
 290       if (errno == EINTR || errno == EPIPE) {
 291         continue;
 292       } else {
 293         (void) radlog(L_ERR, "rlm_otp: %s: write to otpd: %s",
 294                       __func__, strerror(errno));
 295         otp_putfd(fdp, 1);
 296         return errno;
 297       }
 298     }
 299     nleft -= nwrote;
 300   }
 301
 302   return 0;
 303 }
 304
 305 /* connect to otpd and return fd */
 306 static int
 307 otp_connect(const char *path)
 308 {
 309   int fd;
 310   struct sockaddr_un sa;
 311   size_t sp_len;                /* sun_path length (strlen) */
 312
 313   /* setup for unix domain socket */
 314   sp_len = strlen(path);
 315   if (sp_len > sizeof(sa.sun_path) - 1) {
 316     (void) radlog(L_ERR, "rlm_otp: %s: rendezvous point name too long",
 317                   __func__);
 318     return -1;
 319   }
 320   sa.sun_family = AF_UNIX;
 321   (void) strcpy(sa.sun_path, path);
 322
 323   /* connect to otpd */
 324   if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1) {
 325     (void) radlog(L_ERR, "rlm_otp: %s: socket: %s", __func__, strerror(errno));
 326     return -1;
 327   }
 328   if (connect(fd, (struct sockaddr *) &sa,
 329               sizeof(sa.sun_family) + sp_len) == -1) {
 330     (void) radlog(L_ERR, "rlm_otp: %s: connect(%s): %s",
 331                   __func__, path, strerror(errno));
 332     (void) close(fd);
 333     return -1;
 334   }
 335   return fd;
 336 }
 337
 338 /*
 339  * Retrieve an fd (from pool) to use for otpd connection.
 340  * It'd be simpler to use TLS but FR can have lots of threads
 341  * and we don't want to waste fd's that way.
 342  * We can't have a global fd because we'd then be pipelining
 343  * requests to otpd and we have no way to demultiplex
 344  * the responses.
 345  */
 346 static otp_fd_t *
 347 otp_getfd(const otp_option_t *opt)
 348 {
 349   int rc;
 350   otp_fd_t *fdp;
 351
 352   /* walk the connection pool looking for an available fd */
 353   for (fdp = otp_fd_head; fdp; fdp = fdp->next) {
 354     rc = otp_pthread_mutex_trylock(&fdp->mutex);
 355     if (!rc)
 356       if (!strcmp(fdp->path, opt->otpd_rp))     /* could just use == */
 357         break;
 358   }
 359
 360   if (!fdp) {
 361     /* no fd was available, add a new one */
 362     fdp = rad_malloc(sizeof(*fdp));
 363     otp_pthread_mutex_init(&fdp->mutex, NULL);
 364     otp_pthread_mutex_lock(&fdp->mutex);
 365     /* insert new fd at head */
 366     otp_pthread_mutex_lock(&otp_fd_head_mutex);
 367     fdp->next = otp_fd_head;
 368     otp_fd_head = fdp;
 369     otp_pthread_mutex_unlock(&otp_fd_head_mutex);
 370     /* initialize */
 371     fdp->path = opt->otpd_rp;
 372     fdp->fd = -1;
 373   }
 374
 375   /* establish connection */
 376   if (fdp->fd == -1)
 377     fdp->fd = otp_connect(fdp->path);
 378
 379   return fdp;
 380 }
 381
 382 /* release fd, and optionally disconnect from otpd */
 383 static void
 384 otp_putfd(otp_fd_t *fdp, int disconnect)
 385 {
 386   if (disconnect) {
 387     (void) close(fdp->fd);
 388     fdp->fd = -1;
 389   }
 390
 391   /* make connection available to another thread */
 392   otp_pthread_mutex_unlock(&fdp->mutex);
 393 }