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