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