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