more constness.
[apps/madmutt.git] / mutt_sasl.c
index 757f316..6b6f0ea 100644 (file)
@@ -1,19 +1,10 @@
 /*
+ * Copyright notice from original mutt:
  * Copyright (C) 2000-5 Brendan Cully <brendan@kublai.com>
- * 
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- * 
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- * 
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ *
+ * This file is part of mutt-ng, see http://www.muttng.org/.
+ * It's licensed under the GNU General Public License,
+ * please see the file GPL in the top level source directory.
  */
 
 /* common SASL helper routines */
 #include "mutt_sasl.h"
 #include "mutt_socket.h"
 
-#ifdef USE_SASL2
+#include "lib/mem.h"
+#include "lib/debug.h"
+
 #include <errno.h>
 #include <netdb.h>
 #include <sasl/sasl.h>
-#else
-#include <sasl.h>
-#endif
+
 #include <sys/socket.h>
 #include <netinet/in.h>
 
-#ifdef USE_SASL2
 static int getnameinfo_err (int ret)
 {
   int err;
 
-  dprint (1, (debugfile, "getnameinfo: "));
   switch (ret) {
   case EAI_AGAIN:
-    dprint (1,
-            (debugfile,
-             "The name could not be resolved at this time.  Future attempts may succeed.\n"));
+    debug_print (1, ("The name could not be resolved at this time. Future attempts may succeed.\n"));
     err = SASL_TRYAGAIN;
     break;
   case EAI_BADFLAGS:
-    dprint (1, (debugfile, "The flags had an invalid value.\n"));
+    debug_print (1, ("The flags had an invalid value.\n"));
     err = SASL_BADPARAM;
     break;
   case EAI_FAIL:
-    dprint (1, (debugfile, "A non-recoverable error occurred.\n"));
+    debug_print (1, ("A non-recoverable error occurred.\n"));
     err = SASL_FAIL;
     break;
   case EAI_FAMILY:
-    dprint (1,
-            (debugfile,
-             "The address family was not recognized or the address length was invalid for the specified family.\n"));
+    debug_print (1, ("The address family was not recognized or the address length was invalid for the specified family.\n"));
     err = SASL_BADPROT;
     break;
   case EAI_MEMORY:
-    dprint (1, (debugfile, "There was a memory allocation failure.\n"));
+    debug_print (1, ("There was a memory allocation failure.\n"));
     err = SASL_NOMEM;
     break;
   case EAI_NONAME:
-    dprint (1,
-            (debugfile,
-             "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"));
+    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"));
     err = SASL_FAIL;            /* no real equivalent */
     break;
   case EAI_SYSTEM:
-    dprint (1,
-            (debugfile,
-             "A system error occurred.  The error code can be found in errno(%d,%s)).\n",
-             errno, strerror (errno)));
+    debug_print (1, ("A system error occurred.  The error code can be found in errno(%d,%s)).\n", 
+                errno, strerror (errno)));
     err = SASL_FAIL;            /* no real equivalent */
     break;
   default:
-    dprint (1, (debugfile, "Unknown error %d\n", ret));
+    debug_print (1, ("Unknown error %d\n", ret));
     err = SASL_FAIL;            /* no real equivalent */
     break;
   }
   return err;
 }
-#endif
 
 /* arbitrary. SASL will probably use a smaller buffer anyway. OTOH it's
  * been a while since I've had access to an SASL server which negotiated
  * a protection buffer. */
 #define M_SASL_MAXBUF 65536
 
-#ifdef USE_SASL2
 #define IP_PORT_BUFLEN 1024
-#endif
 
 static sasl_callback_t mutt_sasl_callbacks[5];
 
@@ -118,7 +96,6 @@ static int mutt_sasl_conn_read (CONNECTION * conn, char *buf, size_t len);
 static int mutt_sasl_conn_write (CONNECTION * conn, const char *buf,
                                  size_t count);
 
-#ifdef USE_SASL2
 /* utility function, stolen from sasl2 sample code */
 static int iptostring (const struct sockaddr *addr, socklen_t addrlen,
                        char *out, unsigned outlen)
@@ -138,17 +115,16 @@ static int iptostring (const struct sockaddr *addr, socklen_t addrlen,
   if (ret)
     return getnameinfo_err (ret);
 
-  if (outlen < strlen (hbuf) + strlen (pbuf) + 2)
+  if (outlen < str_len (hbuf) + str_len (pbuf) + 2)
     return SASL_BUFOVER;
 
   snprintf (out, outlen, "%s;%s", hbuf, pbuf);
 
   return SASL_OK;
 }
-#endif
 
 /* mutt_sasl_start: called before doing a SASL exchange - initialises library
- *   (if neccessary). */
+ *   (if necessary). */
 int mutt_sasl_start (void)
 {
   static unsigned char sasl_init = 0;
@@ -171,8 +147,7 @@ int mutt_sasl_start (void)
   rc = sasl_client_init (callbacks);
 
   if (rc != SASL_OK) {
-    dprint (1,
-            (debugfile, "mutt_sasl_start: libsasl initialisation failed.\n"));
+    debug_print (1, ("libsasl initialisation failed.\n"));
     return SASL_FAIL;
   }
 
@@ -188,13 +163,9 @@ int mutt_sasl_client_new (CONNECTION * conn, sasl_conn_t ** saslconn)
 {
   sasl_security_properties_t secprops;
 
-#ifdef USE_SASL2
   struct sockaddr_storage local, remote;
   socklen_t size;
   char iplocalport[IP_PORT_BUFLEN], ipremoteport[IP_PORT_BUFLEN];
-#else
-  sasl_external_properties_t extprops;
-#endif
   const char *service;
   int rc;
 
@@ -209,70 +180,51 @@ int mutt_sasl_client_new (CONNECTION * conn, sasl_conn_t ** saslconn)
     service = "pop";
     break;
   default:
-    dprint (1, (debugfile, "mutt_sasl_client_new: account type unset\n"));
+    debug_print (1, ("account type unset\n"));
     return -1;
   }
 
-#ifdef USE_SASL2
   size = sizeof (local);
   if (getsockname (conn->fd, (struct sockaddr *) &local, &size)) {
-    dprint (1,
-            (debugfile,
-             "mutt_sasl_client_new: getsockname for local failed\n"));
+    debug_print (1, ("getsockname for local failed\n"));
     return -1;
   }
   else
     if (iptostring
         ((struct sockaddr *) &local, size, iplocalport,
          IP_PORT_BUFLEN) != SASL_OK) {
-    dprint (1,
-            (debugfile,
-             "mutt_sasl_client_new: iptostring for local failed\n"));
+    debug_print (1, ("iptostring for local failed\n"));
     return -1;
   }
 
   size = sizeof (remote);
   if (getpeername (conn->fd, (struct sockaddr *) &remote, &size)) {
-    dprint (1,
-            (debugfile,
-             "mutt_sasl_client_new: getsockname for remote failed\n"));
+    debug_print (1, ("getsockname for remote failed\n"));
     return -1;
   }
   else
     if (iptostring
         ((struct sockaddr *) &remote, size, ipremoteport,
          IP_PORT_BUFLEN) != SASL_OK) {
-    dprint (1,
-            (debugfile,
-             "mutt_sasl_client_new: iptostring for remote failed\n"));
+    debug_print (1, ("iptostring for remote failed\n"));
     return -1;
   }
 
-  dprint (1,
-          (debugfile, "local ip: %s, remote ip:%s\n", iplocalport,
-           ipremoteport));
+  debug_print (1, ("local ip: %s, remote ip:%s\n", iplocalport, ipremoteport));
 
   rc =
     sasl_client_new (service, conn->account.host, iplocalport, ipremoteport,
                      mutt_sasl_get_callbacks (&conn->account), 0, saslconn);
 
-#else
-  rc = sasl_client_new (service, conn->account.host,
-                        mutt_sasl_get_callbacks (&conn->account),
-                        SASL_SECURITY_LAYER, saslconn);
-#endif
-
   if (rc != SASL_OK) {
-    dprint (1, (debugfile,
-                "mutt_sasl_client_new: Error allocating SASL connection\n"));
+    debug_print (1, ("Error allocating SASL connection\n"));
     return -1;
   }
 
   /*** set sasl IP properties, necessary for use with krb4 ***/
   /* Do we need to fail if this fails? I would assume having these unset
-   * would just disable KRB4. Who wrote this code? I'm not sure how this
-   * interacts with the NSS code either, since that mucks with the fd. */
-#ifndef USE_SASL2               /* with SASLv2 this all happens in sasl_client_new */
+   * would just disable KRB4. Who wrote this code?
+   */
   {
     struct sockaddr_in local, remote;
     socklen_t size;
@@ -287,21 +239,18 @@ int mutt_sasl_client_new (CONNECTION * conn, sasl_conn_t ** saslconn)
 
 #ifdef SASL_IP_LOCAL
     if (sasl_setprop (*saslconn, SASL_IP_LOCAL, &local) != SASL_OK) {
-      dprint (1, (debugfile,
-                  "mutt_sasl_client_new: Error setting local IP address\n"));
+      debug_print (1, ("Error setting local IP address\n"));
       return -1;
     }
 #endif
 
 #ifdef SASL_IP_REMOTE
     if (sasl_setprop (*saslconn, SASL_IP_REMOTE, &remote) != SASL_OK) {
-      dprint (1, (debugfile,
-                  "mutt_sasl_client_new: Error setting remote IP address\n"));
+      debug_print (1, ("Error setting remote IP address\n"));
       return -1;
     }
 #endif
   }
-#endif
 
   /* set security properties. We use NOPLAINTEXT globally, since we can
    * just fall back to LOGIN in the IMAP case anyway. If that doesn't
@@ -313,46 +262,24 @@ int mutt_sasl_client_new (CONNECTION * conn, sasl_conn_t ** saslconn)
   secprops.maxbufsize = M_SASL_MAXBUF;
   secprops.security_flags |= SASL_SEC_NOPLAINTEXT;
   if (sasl_setprop (*saslconn, SASL_SEC_PROPS, &secprops) != SASL_OK) {
-    dprint (1, (debugfile,
-                "mutt_sasl_client_new: Error setting security properties\n"));
+    debug_print (1, ("Error setting security properties\n"));
     return -1;
   }
 
-  /* we currently don't have an SSF finder for NSS (I don't know the API).
-   * If someone does it'd probably be trivial to write mutt_nss_get_ssf().
-   * I have a feeling more SSL code could be shared between those two files,
-   * but I haven't looked into it yet, since I still don't know the APIs. */
-#if (defined(USE_SSL) || defined(USE_GNUTLS) && !defined(USE_NSS))
-  if (conn->account.flags & M_ACCT_SSL) {
-#ifdef USE_SASL2                /* I'm not sure this actually has an effect, at least with SASLv2 */
-    dprint (2, (debugfile, "External SSF: %d\n", conn->ssf));
+  if (conn->ssf) {
+    debug_print (2, ("External SSF: %d\n", conn->ssf));
     if (sasl_setprop (*saslconn, SASL_SSF_EXTERNAL, &(conn->ssf)) != SASL_OK)
-#else
-    memset (&extprops, 0, sizeof (extprops));
-    extprops.ssf = conn->ssf;
-    dprint (2, (debugfile, "External SSF: %d\n", extprops.ssf));
-    if (sasl_setprop (*saslconn, SASL_SSF_EXTERNAL, &extprops) != SASL_OK)
-#endif
     {
-      dprint (1,
-              (debugfile,
-               "mutt_sasl_client_new: Error setting external properties\n"));
+      debug_print (1, ("Error setting external properties\n"));
       return -1;
     }
-#ifdef USE_SASL2
-    dprint (2,
-            (debugfile, "External authentication name: %s\n",
-             conn->account.user));
+    debug_print (2, ("External authentication name: %s\n", conn->account.user));
     if (sasl_setprop (*saslconn, SASL_AUTH_EXTERNAL, conn->account.user) !=
         SASL_OK) {
-      dprint (1,
-              (debugfile,
-               "mutt_sasl_client_new: Error setting external properties\n"));
+      debug_print (1, ("Error setting external properties\n"));
       return -1;
     }
-#endif
   }
-#endif
 
   return 0;
 }
@@ -363,12 +290,12 @@ sasl_callback_t *mutt_sasl_get_callbacks (ACCOUNT * account)
 
   callback = mutt_sasl_callbacks;
 
-  callback->id = SASL_CB_AUTHNAME;
+  callback->id = SASL_CB_USER;
   callback->proc = mutt_sasl_cb_authname;
   callback->context = account;
   callback++;
 
-  callback->id = SASL_CB_USER;
+  callback->id = SASL_CB_AUTHNAME;
   callback->proc = mutt_sasl_cb_authname;
   callback->context = account;
   callback++;
@@ -396,19 +323,16 @@ int mutt_sasl_interact (sasl_interact_t * interaction)
   char resp[SHORT_STRING];
 
   while (interaction->id != SASL_CB_LIST_END) {
-    dprint (2,
-            (debugfile,
-             "mutt_sasl_interact: filling in SASL interaction %ld.\n",
-             interaction->id));
+    debug_print (2, ("filling in SASL interaction %ld.\n", interaction->id));
 
     snprintf (prompt, sizeof (prompt), "%s: ", interaction->prompt);
     resp[0] = '\0';
     if (mutt_get_field (prompt, resp, sizeof (resp), 0))
       return SASL_FAIL;
 
-    interaction->len = mutt_strlen (resp) + 1;
-    interaction->result = safe_malloc (interaction->len);
-    memcpy (interaction->result, resp, interaction->len);
+    interaction->len = str_len (resp) + 1;
+    interaction->result = mem_malloc (interaction->len);
+    memcpy ((char*) interaction->result, resp, interaction->len);
 
     interaction++;
   }
@@ -434,27 +358,17 @@ int mutt_sasl_interact (sasl_interact_t * interaction)
  *   for the read/write methods. */
 void mutt_sasl_setup_conn (CONNECTION * conn, sasl_conn_t * saslconn)
 {
-  SASL_DATA *sasldata = (SASL_DATA *) safe_malloc (sizeof (SASL_DATA));
+  SASL_DATA *sasldata = (SASL_DATA *) mem_malloc (sizeof (SASL_DATA));
 
   sasldata->saslconn = saslconn;
   /* get ssf so we know whether we have to (en|de)code read/write */
-#ifdef USE_SASL2
-  sasl_getprop (saslconn, SASL_SSF, (const void **) &sasldata->ssf);
-#else
-  sasl_getprop (saslconn, SASL_SSF, (void **) &sasldata->ssf);
-#endif
-  dprint (3, (debugfile, "SASL protection strength: %u\n", *sasldata->ssf));
+  sasl_getprop (saslconn, SASL_SSF, (const void **)(void *)&sasldata->ssf);
+  debug_print (3, ("SASL protection strength: %u\n", *sasldata->ssf));
   /* Add SASL SSF to transport SSF */
   conn->ssf += *sasldata->ssf;
-#ifdef USE_SASL2
   sasl_getprop (saslconn, SASL_MAXOUTBUF,
-                (const void **) &sasldata->pbufsize);
-#else
-  sasl_getprop (saslconn, SASL_MAXOUTBUF, (void **) &sasldata->pbufsize);
-#endif
-  dprint (3,
-          (debugfile, "SASL protection buffer size: %u\n",
-           *sasldata->pbufsize));
+                (const void **)(void *)&sasldata->pbufsize);
+  debug_print (3, ("SASL protection buffer size: %u\n", *sasldata->pbufsize));
 
   /* clear input buffer */
   sasldata->buf = NULL;
@@ -476,16 +390,19 @@ void mutt_sasl_setup_conn (CONNECTION * conn, sasl_conn_t * saslconn)
   conn->conn_write = mutt_sasl_conn_write;
 }
 
+void mutt_sasl_done (void) {
+  sasl_done ();
+}
+
 /* mutt_sasl_cb_log: callback to log SASL messages */
 static int mutt_sasl_cb_log (void *context, int priority, const char *message)
 {
-  dprint (priority, (debugfile, "SASL: %s\n", message));
+  debug_print (priority, ("SASL: %s\n", message));
 
   return SASL_OK;
 }
 
-/* mutt_sasl_cb_authname: callback to retrieve authname or user (mutt
- *   doesn't distinguish, even if some SASL plugins do) from ACCOUNT */
+/* mutt_sasl_cb_authname: callback to retrieve authname or user from ACCOUNT */
 static int mutt_sasl_cb_authname (void *context, int id, const char **result,
                                   unsigned *len)
 {
@@ -498,17 +415,22 @@ static int mutt_sasl_cb_authname (void *context, int id, const char **result,
   if (!account)
     return SASL_BADPARAM;
 
-  dprint (2, (debugfile, "mutt_sasl_cb_authname: getting %s for %s:%u\n",
+  debug_print (2, ("getting %s for %s:%u\n",
               id == SASL_CB_AUTHNAME ? "authname" : "user",
               account->host, account->port));
 
-  if (mutt_account_getuser (account))
-    return SASL_FAIL;
-
-  *result = account->user;
+  if (id == SASL_CB_AUTHNAME) {
+    if (mutt_account_getlogin (account))
+      return SASL_FAIL;
+    *result = account->login;
+  } else {
+    if (mutt_account_getuser (account))
+      return SASL_FAIL;
+    *result = account->user;
+  }
 
   if (len)
-    *len = strlen (*result);
+    *len = str_len (*result);
 
   return SASL_OK;
 }
@@ -522,18 +444,17 @@ static int mutt_sasl_cb_pass (sasl_conn_t * conn, void *context, int id,
   if (!account || !psecret)
     return SASL_BADPARAM;
 
-  dprint (2, (debugfile,
-              "mutt_sasl_cb_pass: getting password for %s@%s:%u\n",
-              account->user, account->host, account->port));
+  debug_print (2, ("getting password for %s@%s:%u\n",
+              account->login, account->host, account->port));
 
   if (mutt_account_getpass (account))
     return SASL_FAIL;
 
-  len = strlen (account->pass);
+  len = str_len (account->pass);
 
-  *psecret = (sasl_secret_t *) safe_malloc (sizeof (sasl_secret_t) + len);
+  *psecret = (sasl_secret_t *) mem_malloc (sizeof (sasl_secret_t) + len);
   (*psecret)->len = len;
-  strcpy ((*psecret)->data, account->pass);     /* __STRCPY_CHECKED__ */
+  strcpy ((char*) (*psecret)->data, account->pass);     /* __STRCPY_CHECKED__ */
 
   return SASL_OK;
 }
@@ -573,10 +494,8 @@ static int mutt_sasl_conn_close (CONNECTION * conn)
 
   /* release sasl resources */
   sasl_dispose (&sasldata->saslconn);
-#ifndef USE_SASL2
-  FREE (&sasldata->buf);
-#endif
-  FREE (&sasldata);
+  mem_free (&sasldata->buf);
+  mem_free (&sasldata);
 
   /* call underlying close */
   rc = (conn->conn_close) (conn);
@@ -606,9 +525,7 @@ static int mutt_sasl_conn_read (CONNECTION * conn, char *buf, size_t len)
 
   conn->sockdata = sasldata->sockdata;
 
-#ifndef USE_SASL2
-  FREE (&sasldata->buf);
-#endif
+  mem_free (&sasldata->buf);
   sasldata->bpos = 0;
   sasldata->blen = 0;
 
@@ -623,7 +540,7 @@ static int mutt_sasl_conn_read (CONNECTION * conn, char *buf, size_t len)
       rc = sasl_decode (sasldata->saslconn, buf, rc, &sasldata->buf,
                         &sasldata->blen);
       if (rc != SASL_OK) {
-        dprint (1, (debugfile, "SASL decode failed: %s\n",
+        debug_print (1, ("SASL decode failed: %s\n",
                     sasl_errstring (rc, NULL, NULL)));
         goto out;
       }
@@ -653,11 +570,7 @@ static int mutt_sasl_conn_write (CONNECTION * conn, const char *buf,
   SASL_DATA *sasldata;
   int rc;
 
-#ifdef USE_SASL2
   const char *pbuf;
-#else
-  char *pbuf;
-#endif
   unsigned int olen, plen;
 
   sasldata = (SASL_DATA *) conn->sockdata;
@@ -671,15 +584,13 @@ static int mutt_sasl_conn_write (CONNECTION * conn, const char *buf,
 
       rc = sasl_encode (sasldata->saslconn, buf, olen, &pbuf, &plen);
       if (rc != SASL_OK) {
-        dprint (1, (debugfile, "SASL encoding failed: %s\n",
+        debug_print (1, ("SASL encoding failed: %s\n",
                     sasl_errstring (rc, NULL, NULL)));
         goto fail;
       }
 
       rc = (sasldata->msasl_write) (conn, pbuf, plen);
-#ifndef USE_SASL2
-      FREE (&pbuf);
-#endif
+      mem_free (&pbuf);
       if (rc != plen)
         goto fail;