imap/auth_cram.c

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1999-2000 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 /* IMAP login/authentication code */
  11
  12 #if HAVE_CONFIG_H
  13 # include "config.h"
  14 #endif
  15
  16 #include "mutt.h"
  17 #include "imap_private.h"
  18 #include "auth.h"
  19
  20 #define MD5_BLOCK_LEN 64
  21 #define MD5_DIGEST_LEN 16
  22
  23 #include <lib-lib/macros.h>
  24 #include <lib-hash/hash.h>
  25
  26 /* forward declarations */
  27 static void hmac_md5 (const char *password, char *challenge,
  28                       unsigned char *response);
  29
  30 /* imap_auth_cram_md5: AUTH=CRAM-MD5 support. */
  31 imap_auth_res_t imap_auth_cram_md5 (IMAP_DATA * idata, const char *method __attribute__ ((unused)))
  32 {
  33   char ibuf[LONG_STRING * 2], obuf[LONG_STRING];
  34   unsigned char hmac_response[MD5_DIGEST_LEN];
  35   int len;
  36   int rc;
  37
  38   if (!mutt_bit_isset (idata->capabilities, ACRAM_MD5))
  39     return IMAP_AUTH_UNAVAIL;
  40
  41   mutt_message _("Authenticating (CRAM-MD5)...");
  42
  43   /* get auth info */
  44   if (mutt_account_getlogin (&idata->conn->account))
  45     return IMAP_AUTH_FAILURE;
  46   if (mutt_account_getpass (&idata->conn->account))
  47     return IMAP_AUTH_FAILURE;
  48
  49   imap_cmd_start (idata, "AUTHENTICATE CRAM-MD5");
  50
  51   /* From RFC 2195:
  52    * The data encoded in the first ready response contains a presumptively
  53    * arbitrary string of random digits, a timestamp, and the fully-qualified
  54    * primary host name of the server. The syntax of the unencoded form must
  55    * correspond to that of an RFC 822 'msg-id' [RFC822] as described in [POP3].
  56    */
  57   do
  58     rc = imap_cmd_step (idata);
  59   while (rc == IMAP_CMD_CONTINUE);
  60
  61   if (rc != IMAP_CMD_RESPOND) {
  62     goto bail;
  63   }
  64
  65   if ((len = mutt_from_base64 (obuf, idata->cmd.buf + 2)) == -1) {
  66     goto bail;
  67   }
  68
  69   obuf[len] = '\0';
  70
  71   /* The client makes note of the data and then responds with a string
  72    * consisting of the user name, a space, and a 'digest'. The latter is
  73    * computed by applying the keyed MD5 algorithm from [KEYED-MD5] where the
  74    * key is a shared secret and the digested text is the timestamp (including
  75    * angle-brackets).
  76    *
  77    * Note: The user name shouldn't be quoted. Since the digest can't contain
  78    *   spaces, there is no ambiguity. Some servers get this wrong, we'll work
  79    *   around them when the bug report comes in. Until then, we'll remain
  80    *   blissfully RFC-compliant.
  81    */
  82   hmac_md5 (idata->conn->account.pass, obuf, hmac_response);
  83   /* dubious optimisation I saw elsewhere: make the whole string in one call */
  84   snprintf (obuf, sizeof (obuf),
  85             "%s %02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
  86             idata->conn->account.user,
  87             hmac_response[0], hmac_response[1], hmac_response[2],
  88             hmac_response[3], hmac_response[4], hmac_response[5],
  89             hmac_response[6], hmac_response[7], hmac_response[8],
  90             hmac_response[9], hmac_response[10], hmac_response[11],
  91             hmac_response[12], hmac_response[13], hmac_response[14],
  92             hmac_response[15]);
  93
  94   /* XXX - ibuf must be long enough to store the base64 encoding of obuf,
  95    * plus the additional debris
  96    */
  97
  98   mutt_to_base64 ((unsigned char *) ibuf, (unsigned char *) obuf,
  99                   m_strlen(obuf), sizeof (ibuf) - 2);
 100   m_strcat(ibuf, sizeof(ibuf), "\r\n");
 101   mutt_socket_write (idata->conn, ibuf);
 102
 103   do
 104     rc = imap_cmd_step (idata);
 105   while (rc == IMAP_CMD_CONTINUE);
 106
 107   if (rc != IMAP_CMD_OK) {
 108     goto bail;
 109   }
 110
 111   if (imap_code (idata->cmd.buf))
 112     return IMAP_AUTH_SUCCESS;
 113
 114 bail:
 115   mutt_error _("CRAM-MD5 authentication failed.");
 116   mutt_sleep (2);
 117   return IMAP_AUTH_FAILURE;
 118 }
 119
 120 /* hmac_md5: produce CRAM-MD5 challenge response. */
 121 static void hmac_md5 (const char *password, char *challenge,
 122                       unsigned char *response)
 123 {
 124   MD5_CTX ctx;
 125   unsigned char ipad[MD5_BLOCK_LEN], opad[MD5_BLOCK_LEN];
 126   unsigned char secret[MD5_BLOCK_LEN + 1];
 127   unsigned char hash_passwd[MD5_DIGEST_LEN];
 128   unsigned int secret_len, chal_len;
 129   int i;
 130
 131   secret_len = m_strlen(password);
 132   chal_len = m_strlen(challenge);
 133
 134   /* passwords longer than MD5_BLOCK_LEN bytes are substituted with their MD5
 135    * digests */
 136   if (secret_len > MD5_BLOCK_LEN) {
 137     MD5Init (&ctx);
 138     MD5Update (&ctx, (unsigned char *) password, secret_len);
 139     MD5Final (hash_passwd, &ctx);
 140     m_strcpy((char *)secret, MD5_DIGEST_LEN, (char *)hash_passwd);
 141     secret_len = MD5_DIGEST_LEN;
 142   }
 143   else
 144     m_strcpy((char *)secret, sizeof(secret), password);
 145
 146   p_clear(ipad, 1);
 147   p_clear(opad, 1);
 148   memcpy (ipad, secret, secret_len);
 149   memcpy (opad, secret, secret_len);
 150
 151   for (i = 0; i < MD5_BLOCK_LEN; i++) {
 152     ipad[i] ^= 0x36;
 153     opad[i] ^= 0x5c;
 154   }
 155
 156   /* inner hash: challenge and ipadded secret */
 157   MD5Init (&ctx);
 158   MD5Update (&ctx, ipad, MD5_BLOCK_LEN);
 159   MD5Update (&ctx, (unsigned char *) challenge, chal_len);
 160   MD5Final (response, &ctx);
 161
 162   /* outer hash: inner hash and opadded secret */
 163   MD5Init (&ctx);
 164   MD5Update (&ctx, opad, MD5_BLOCK_LEN);
 165   MD5Update (&ctx, response, MD5_DIGEST_LEN);
 166   MD5Final (response, &ctx);
 167 }