mutt_sasl.c

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 2000-5 Brendan Cully <brendan@kublai.com>
   4  *
   5  * This file is part of mutt-ng, see http://www.muttng.org/.
   6  * It's licensed under the GNU General Public License,
   7  * please see the file GPL in the top level source directory.
   8  */
   9
  10 /* common SASL helper routines */
  11
  12 #include <lib-lib/lib-lib.h>
  13
  14 #include <netdb.h>
  15 #include <sasl/sasl.h>
  16 #include <sys/socket.h>
  17 #include <netinet/in.h>
  18
  19 #include <lib-ui/curses.h>
  20 #include <lib-sys/mutt_socket.h>
  21
  22 #include "mutt.h"
  23 #include "account.h"
  24 #include "mutt_sasl.h"
  25
  26 static int getnameinfo_err (int ret)
  27 {
  28   int err;
  29
  30   switch (ret) {
  31   case EAI_AGAIN:
  32     err = SASL_TRYAGAIN;
  33     break;
  34   case EAI_BADFLAGS:
  35     err = SASL_BADPARAM;
  36     break;
  37   case EAI_FAIL:
  38     err = SASL_FAIL;
  39     break;
  40   case EAI_FAMILY:
  41     err = SASL_BADPROT;
  42     break;
  43   case EAI_MEMORY:
  44     err = SASL_NOMEM;
  45     break;
  46   case EAI_NONAME:
  47     err = SASL_FAIL;            /* no real equivalent */
  48     break;
  49   case EAI_SYSTEM:
  50     err = SASL_FAIL;            /* no real equivalent */
  51     break;
  52   default:
  53     err = SASL_FAIL;            /* no real equivalent */
  54     break;
  55   }
  56   return err;
  57 }
  58
  59 /* arbitrary. SASL will probably use a smaller buffer anyway. OTOH it's
  60  * been a while since I've had access to an SASL server which negotiated
  61  * a protection buffer. */
  62 #define M_SASL_MAXBUF 65536
  63
  64 #define IP_PORT_BUFLEN 1024
  65
  66 static sasl_callback_t mutt_sasl_callbacks[5];
  67
  68 static int mutt_sasl_start (void);
  69
  70 /* callbacks */
  71 static int mutt_sasl_cb_authname (void *context, int id, const char **result,
  72                                   unsigned int *len);
  73 static int mutt_sasl_cb_pass (sasl_conn_t * conn, void *context, int id,
  74                               sasl_secret_t ** psecret);
  75
  76 /* socket wrappers for a SASL security layer */
  77 static int mutt_sasl_conn_open (CONNECTION * conn);
  78 static int mutt_sasl_conn_close (CONNECTION * conn);
  79 static int mutt_sasl_conn_read (CONNECTION * conn, char *buf, ssize_t len);
  80 static int mutt_sasl_conn_write (CONNECTION * conn, const char *buf,
  81                                  ssize_t count);
  82
  83 /* utility function, stolen from sasl2 sample code */
  84 static int iptostring (const struct sockaddr *addr, socklen_t addrlen,
  85                        char *out, unsigned outlen)
  86 {
  87   char hbuf[NI_MAXHOST], pbuf[NI_MAXSERV];
  88   int ret;
  89
  90   if (!addr || !out)
  91     return SASL_BADPARAM;
  92
  93   ret = getnameinfo (addr, addrlen, hbuf, sizeof (hbuf), pbuf, sizeof (pbuf),
  94                      NI_NUMERICHOST |
  95 #ifdef NI_WITHSCOPEID
  96                      NI_WITHSCOPEID |
  97 #endif
  98                      NI_NUMERICSERV);
  99   if (ret)
 100     return getnameinfo_err (ret);
 101
 102   if (outlen < m_strlen(hbuf) + m_strlen(pbuf) + 2)
 103     return SASL_BUFOVER;
 104
 105   snprintf (out, outlen, "%s;%s", hbuf, pbuf);
 106
 107   return SASL_OK;
 108 }
 109
 110 /* mutt_sasl_cb_log: callback to log SASL messages */
 111 static int mutt_sasl_cb_log (void *context, int priority, const char *message)
 112 {
 113   return SASL_OK;
 114 }
 115
 116 /* mutt_sasl_start: called before doing a SASL exchange - initialises library
 117  *   (if necessary). */
 118 int mutt_sasl_start (void)
 119 {
 120   static unsigned char sasl_init = 0;
 121
 122   static sasl_callback_t callbacks[2];
 123   int rc;
 124
 125   if (sasl_init)
 126     return SASL_OK;
 127
 128   /* set up default logging callback */
 129   callbacks[0].id = SASL_CB_LOG;
 130   callbacks[0].proc = mutt_sasl_cb_log;
 131   callbacks[0].context = NULL;
 132
 133   callbacks[1].id = SASL_CB_LIST_END;
 134   callbacks[1].proc = NULL;
 135   callbacks[1].context = NULL;
 136
 137   rc = sasl_client_init (callbacks);
 138
 139   if (rc != SASL_OK) {
 140     return SASL_FAIL;
 141   }
 142
 143   sasl_init = 1;
 144
 145   return SASL_OK;
 146 }
 147
 148 /* mutt_sasl_client_new: wrapper for sasl_client_new which also sets various
 149  * security properties. If this turns out to be fine for POP too we can
 150  * probably stop exporting mutt_sasl_get_callbacks(). */
 151 int mutt_sasl_client_new (CONNECTION * conn, sasl_conn_t ** saslconn)
 152 {
 153   sasl_security_properties_t secprops;
 154
 155   struct sockaddr_storage local, remote;
 156   socklen_t size;
 157   char iplocalport[IP_PORT_BUFLEN], ipremoteport[IP_PORT_BUFLEN];
 158   const char *service;
 159   int rc;
 160
 161   if (mutt_sasl_start () != SASL_OK)
 162     return -1;
 163
 164   switch (conn->account.type) {
 165   case M_ACCT_TYPE_IMAP:
 166     service = "imap";
 167     break;
 168   case M_ACCT_TYPE_POP:
 169     service = "pop";
 170     break;
 171   default:
 172     return -1;
 173   }
 174
 175   size = sizeof (local);
 176   if (getsockname (conn->fd, (struct sockaddr *) &local, &size)) {
 177     return -1;
 178   }
 179   else
 180     if (iptostring((struct sockaddr *)&local, size, iplocalport,
 181          IP_PORT_BUFLEN) != SASL_OK) {
 182     return -1;
 183   }
 184
 185   size = sizeof (remote);
 186   if (getpeername (conn->fd, (struct sockaddr *) &remote, &size)) {
 187     return -1;
 188   }
 189   else
 190     if (iptostring
 191         ((struct sockaddr *) &remote, size, ipremoteport,
 192          IP_PORT_BUFLEN) != SASL_OK) {
 193     return -1;
 194   }
 195
 196   rc = sasl_client_new(service, conn->account.host, iplocalport, ipremoteport,
 197                        mutt_sasl_get_callbacks(&conn->account), 0, saslconn);
 198
 199   if (rc != SASL_OK) {
 200     return -1;
 201   }
 202
 203   /*** set sasl IP properties, necessary for use with krb4 ***/
 204   /* Do we need to fail if this fails? I would assume having these unset
 205    * would just disable KRB4. Who wrote this code?
 206    */
 207   {
 208     struct sockaddr_in local, remote;
 209     socklen_t size;
 210
 211     size = sizeof (local);
 212     if (getsockname (conn->fd, (struct sockaddr *) &local, &size))
 213       return -1;
 214
 215     size = sizeof (remote);
 216     if (getpeername (conn->fd, (struct sockaddr *) &remote, &size))
 217       return -1;
 218
 219 #ifdef SASL_IP_LOCAL
 220     if (sasl_setprop (*saslconn, SASL_IP_LOCAL, &local) != SASL_OK) {
 221       return -1;
 222     }
 223 #endif
 224
 225 #ifdef SASL_IP_REMOTE
 226     if (sasl_setprop (*saslconn, SASL_IP_REMOTE, &remote) != SASL_OK) {
 227       return -1;
 228     }
 229 #endif
 230   }
 231
 232   /* set security properties. We use NOPLAINTEXT globally, since we can
 233    * just fall back to LOGIN in the IMAP case anyway. If that doesn't
 234    * work for POP, we can make it a flag or move this code into
 235    * imap/auth_sasl.c */
 236   p_clear(&secprops, 1);
 237   /* Work around a casting bug in the SASL krb4 module */
 238   secprops.max_ssf = 0x7fff;
 239   secprops.maxbufsize = M_SASL_MAXBUF;
 240   secprops.security_flags |= SASL_SEC_NOPLAINTEXT;
 241   if (sasl_setprop (*saslconn, SASL_SEC_PROPS, &secprops) != SASL_OK) {
 242     return -1;
 243   }
 244
 245   if (conn->ssf) {
 246     if (sasl_setprop (*saslconn, SASL_SSF_EXTERNAL, &(conn->ssf)) != SASL_OK)
 247     {
 248       return -1;
 249     }
 250     if (sasl_setprop (*saslconn, SASL_AUTH_EXTERNAL, conn->account.user) !=
 251         SASL_OK) {
 252       return -1;
 253     }
 254   }
 255
 256   return 0;
 257 }
 258
 259 sasl_callback_t *mutt_sasl_get_callbacks (ACCOUNT * account)
 260 {
 261   sasl_callback_t *callback;
 262
 263   callback = mutt_sasl_callbacks;
 264
 265   callback->id = SASL_CB_USER;
 266   callback->proc = mutt_sasl_cb_authname;
 267   callback->context = account;
 268   callback++;
 269
 270   callback->id = SASL_CB_AUTHNAME;
 271   callback->proc = mutt_sasl_cb_authname;
 272   callback->context = account;
 273   callback++;
 274
 275   callback->id = SASL_CB_PASS;
 276   callback->proc = mutt_sasl_cb_pass;
 277   callback->context = account;
 278   callback++;
 279
 280   callback->id = SASL_CB_GETREALM;
 281   callback->proc = NULL;
 282   callback->context = NULL;
 283   callback++;
 284
 285   callback->id = SASL_CB_LIST_END;
 286   callback->proc = NULL;
 287   callback->context = NULL;
 288
 289   return mutt_sasl_callbacks;
 290 }
 291
 292 int mutt_sasl_interact (sasl_interact_t * interaction)
 293 {
 294   char prompt[SHORT_STRING];
 295   char resp[SHORT_STRING];
 296
 297   while (interaction->id != SASL_CB_LIST_END) {
 298     snprintf (prompt, sizeof (prompt), "%s: ", interaction->prompt);
 299     resp[0] = '\0';
 300     if (mutt_get_field (prompt, resp, sizeof (resp), 0))
 301       return SASL_FAIL;
 302
 303     interaction->len = m_strlen(resp) + 1;
 304     interaction->result = p_dupstr(resp, interaction->len - 1);
 305     interaction++;
 306   }
 307
 308   return SASL_OK;
 309 }
 310
 311 /* SASL can stack a protection layer on top of an existing connection.
 312  * To handle this, we store a saslconn_t in conn->sockdata, and write
 313  * wrappers which en/decode the read/write stream, then replace sockdata
 314  * with an embedded copy of the old sockdata and call the underlying
 315  * functions (which we've also preserved). I thought about trying to make
 316  * a general stackable connection system, but it seemed like overkill -
 317  * something is wrong if we have 15 filters on top of a socket. Anyway,
 318  * anything else which wishes to stack can use the same method. The only
 319  * disadvantage is we have to write wrappers for all the socket methods,
 320  * even if we only stack over read and write. Thinking about it, the
 321  * abstraction problem is that there is more in CONNECTION than there
 322  * needs to be. Ideally it would have only (void*)data and methods. */
 323
 324 /* mutt_sasl_setup_conn: replace connection methods, sockdata with
 325  *   SASL wrappers, for protection layers. Also get ssf, as a fastpath
 326  *   for the read/write methods. */
 327 void mutt_sasl_setup_conn (CONNECTION * conn, sasl_conn_t * saslconn)
 328 {
 329   SASL_DATA *sasldata = p_new(SASL_DATA, 1);
 330
 331   sasldata->saslconn = saslconn;
 332   /* get ssf so we know whether we have to (en|de)code read/write */
 333   sasl_getprop (saslconn, SASL_SSF, (const void **)(void *)&sasldata->ssf);
 334
 335   /* Add SASL SSF to transport SSF */
 336   conn->ssf += *sasldata->ssf;
 337   sasl_getprop (saslconn, SASL_MAXOUTBUF,
 338                 (const void **)(void *)&sasldata->pbufsize);
 339
 340   /* clear input buffer */
 341   sasldata->buf = NULL;
 342   sasldata->bpos = 0;
 343   sasldata->blen = 0;
 344
 345   /* preserve old functions */
 346   sasldata->sockdata = conn->sockdata;
 347   sasldata->msasl_open = conn->conn_open;
 348   sasldata->msasl_close = conn->conn_close;
 349   sasldata->msasl_read = conn->conn_read;
 350   sasldata->msasl_write = conn->conn_write;
 351
 352   /* and set up new functions */
 353   conn->sockdata = sasldata;
 354   conn->conn_open = mutt_sasl_conn_open;
 355   conn->conn_close = mutt_sasl_conn_close;
 356   conn->conn_read = mutt_sasl_conn_read;
 357   conn->conn_write = mutt_sasl_conn_write;
 358 }
 359
 360 void mutt_sasl_done (void) {
 361   sasl_done ();
 362 }
 363
 364 /* mutt_sasl_cb_authname: callback to retrieve authname or user from ACCOUNT */
 365 static int mutt_sasl_cb_authname (void *context, int id, const char **result,
 366                                   unsigned *len)
 367 {
 368   ACCOUNT *account = (ACCOUNT *) context;
 369
 370   *result = NULL;
 371   if (len)
 372     *len = 0;
 373
 374   if (!account)
 375     return SASL_BADPARAM;
 376
 377   if (id == SASL_CB_AUTHNAME) {
 378     if (mutt_account_getlogin (account))
 379       return SASL_FAIL;
 380     *result = account->login;
 381   } else {
 382     if (mutt_account_getuser (account))
 383       return SASL_FAIL;
 384     *result = account->user;
 385   }
 386
 387   if (len)
 388     *len = m_strlen(*result);
 389
 390   return SASL_OK;
 391 }
 392
 393 static int mutt_sasl_cb_pass (sasl_conn_t * conn, void *context, int id,
 394                               sasl_secret_t ** psecret)
 395 {
 396   ACCOUNT *account = (ACCOUNT *) context;
 397   int len;
 398
 399   if (!account || !psecret)
 400     return SASL_BADPARAM;
 401
 402   if (mutt_account_getpass (account))
 403     return SASL_FAIL;
 404
 405   len = m_strlen(account->pass);
 406
 407   *psecret = xmalloc(sizeof(sasl_secret_t) + len);
 408   (*psecret)->len = len;
 409   strcpy ((char*) (*psecret)->data, account->pass);     /* __STRCPY_CHECKED__ */
 410
 411   return SASL_OK;
 412 }
 413
 414 /* mutt_sasl_conn_open: empty wrapper for underlying open function. We
 415  *   don't know in advance that a connection will use SASL, so we
 416  *   replace conn's methods with sasl methods when authentication
 417  *   is successful, using mutt_sasl_setup_conn */
 418 static int mutt_sasl_conn_open (CONNECTION * conn)
 419 {
 420   SASL_DATA *sasldata;
 421   int rc;
 422
 423   sasldata = (SASL_DATA *) conn->sockdata;
 424   conn->sockdata = sasldata->sockdata;
 425   rc = (sasldata->msasl_open) (conn);
 426   conn->sockdata = sasldata;
 427
 428   return rc;
 429 }
 430
 431 /* mutt_sasl_conn_close: calls underlying close function and disposes of
 432  *   the sasl_conn_t object, then restores connection to pre-sasl state */
 433 static int mutt_sasl_conn_close (CONNECTION * conn)
 434 {
 435   SASL_DATA *sasldata;
 436   int rc;
 437
 438   sasldata = (SASL_DATA *) conn->sockdata;
 439
 440   /* restore connection's underlying methods */
 441   conn->sockdata = sasldata->sockdata;
 442   conn->conn_open = sasldata->msasl_open;
 443   conn->conn_close = sasldata->msasl_close;
 444   conn->conn_read = sasldata->msasl_read;
 445   conn->conn_write = sasldata->msasl_write;
 446
 447   /* release sasl resources */
 448   sasl_dispose (&sasldata->saslconn);
 449   p_delete(&sasldata->buf);
 450   p_delete(&sasldata);
 451
 452   /* call underlying close */
 453   rc = (conn->conn_close) (conn);
 454
 455   return rc;
 456 }
 457
 458 static int mutt_sasl_conn_read (CONNECTION * conn, char *buf, ssize_t len)
 459 {
 460   SASL_DATA *sasldata;
 461   int rc;
 462
 463   unsigned int olen;
 464
 465   sasldata = (SASL_DATA *) conn->sockdata;
 466
 467   /* if we still have data in our read buffer, copy it into buf */
 468   if (sasldata->blen > sasldata->bpos) {
 469     olen = (sasldata->blen - sasldata->bpos > len) ? len :
 470       sasldata->blen - sasldata->bpos;
 471
 472     memcpy (buf, sasldata->buf + sasldata->bpos, olen);
 473     sasldata->bpos += olen;
 474
 475     return olen;
 476   }
 477
 478   conn->sockdata = sasldata->sockdata;
 479
 480   p_delete(&sasldata->buf);
 481   sasldata->bpos = 0;
 482   sasldata->blen = 0;
 483
 484   /* and decode the result, if necessary */
 485   if (*sasldata->ssf) {
 486     do {
 487       /* call the underlying read function to fill the buffer */
 488       rc = (sasldata->msasl_read) (conn, buf, len);
 489       if (rc <= 0)
 490         goto out;
 491
 492       rc = sasl_decode (sasldata->saslconn, buf, rc, &sasldata->buf,
 493                         &sasldata->blen);
 494       if (rc != SASL_OK) {
 495         goto out;
 496       }
 497     }
 498     while (!sasldata->blen);
 499
 500     olen = (sasldata->blen - sasldata->bpos > len) ? len :
 501       sasldata->blen - sasldata->bpos;
 502
 503     memcpy (buf, sasldata->buf, olen);
 504     sasldata->bpos += olen;
 505
 506     rc = olen;
 507   }
 508   else
 509     rc = (sasldata->msasl_read) (conn, buf, len);
 510
 511 out:
 512   conn->sockdata = sasldata;
 513
 514   return rc;
 515 }
 516
 517 static int mutt_sasl_conn_write (CONNECTION * conn, const char *buf,
 518                                  ssize_t len)
 519 {
 520   SASL_DATA *sasldata;
 521   int rc;
 522
 523   const char *pbuf;
 524   unsigned int olen, plen;
 525
 526   sasldata = (SASL_DATA *) conn->sockdata;
 527   conn->sockdata = sasldata->sockdata;
 528
 529   /* encode data, if necessary */
 530   if (*sasldata->ssf) {
 531     /* handle data larger than MAXOUTBUF */
 532     do {
 533       olen = (len > *sasldata->pbufsize) ? *sasldata->pbufsize : len;
 534
 535       rc = sasl_encode (sasldata->saslconn, buf, olen, &pbuf, &plen);
 536       if (rc != SASL_OK) {
 537         goto fail;
 538       }
 539
 540       rc = (sasldata->msasl_write) (conn, pbuf, plen);
 541       p_delete(&pbuf);
 542       if (rc != plen)
 543         goto fail;
 544
 545       len -= olen;
 546       buf += olen;
 547     }
 548     while (len > *sasldata->pbufsize);
 549   }
 550   else
 551     /* just write using the underlying socket function */
 552     rc = (sasldata->msasl_write) (conn, buf, len);
 553
 554   conn->sockdata = sasldata;
 555
 556   return rc;
 557
 558 fail:
 559   conn->sockdata = sasldata;
 560   return -1;
 561 }