2 * Copyright notice from original mutt:
3 * Copyright (C) 1999-2000 Brendan Cully <brendan@kublai.com>
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.
10 /* IMAP login/authentication code */
17 #include "imap_private.h"
21 #define MD5_BLOCK_LEN 64
22 #define MD5_DIGEST_LEN 16
24 #include <lib-lib/macros.h>
25 #include "lib/debug.h"
27 /* forward declarations */
28 static void hmac_md5 (const char *password, char *challenge,
29 unsigned char *response);
31 /* imap_auth_cram_md5: AUTH=CRAM-MD5 support. */
32 imap_auth_res_t imap_auth_cram_md5 (IMAP_DATA * idata, const char *method)
34 char ibuf[LONG_STRING * 2], obuf[LONG_STRING];
35 unsigned char hmac_response[MD5_DIGEST_LEN];
39 if (!mutt_bit_isset (idata->capabilities, ACRAM_MD5))
40 return IMAP_AUTH_UNAVAIL;
42 mutt_message _("Authenticating (CRAM-MD5)...");
45 if (mutt_account_getlogin (&idata->conn->account))
46 return IMAP_AUTH_FAILURE;
47 if (mutt_account_getpass (&idata->conn->account))
48 return IMAP_AUTH_FAILURE;
50 imap_cmd_start (idata, "AUTHENTICATE CRAM-MD5");
53 * The data encoded in the first ready response contains a presumptively
54 * arbitrary string of random digits, a timestamp, and the fully-qualified
55 * primary host name of the server. The syntax of the unencoded form must
56 * correspond to that of an RFC 822 'msg-id' [RFC822] as described in [POP3].
59 rc = imap_cmd_step (idata);
60 while (rc == IMAP_CMD_CONTINUE);
62 if (rc != IMAP_CMD_RESPOND) {
63 debug_print (1, ("Invalid response from server: %s\n", ibuf));
67 if ((len = mutt_from_base64 (obuf, idata->cmd.buf + 2)) == -1) {
68 debug_print (1, ("Error decoding base64 response.\n"));
73 debug_print (2, ("CRAM challenge: %s\n", obuf));
75 /* The client makes note of the data and then responds with a string
76 * consisting of the user name, a space, and a 'digest'. The latter is
77 * computed by applying the keyed MD5 algorithm from [KEYED-MD5] where the
78 * key is a shared secret and the digested text is the timestamp (including
81 * Note: The user name shouldn't be quoted. Since the digest can't contain
82 * spaces, there is no ambiguity. Some servers get this wrong, we'll work
83 * around them when the bug report comes in. Until then, we'll remain
84 * blissfully RFC-compliant.
86 hmac_md5 (idata->conn->account.pass, obuf, hmac_response);
87 /* dubious optimisation I saw elsewhere: make the whole string in one call */
88 snprintf (obuf, sizeof (obuf),
89 "%s %02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
90 idata->conn->account.user,
91 hmac_response[0], hmac_response[1], hmac_response[2],
92 hmac_response[3], hmac_response[4], hmac_response[5],
93 hmac_response[6], hmac_response[7], hmac_response[8],
94 hmac_response[9], hmac_response[10], hmac_response[11],
95 hmac_response[12], hmac_response[13], hmac_response[14],
97 debug_print (2, ("CRAM response: %s\n", obuf));
99 /* XXX - ibuf must be long enough to store the base64 encoding of obuf,
100 * plus the additional debris
103 mutt_to_base64 ((unsigned char *) ibuf, (unsigned char *) obuf,
104 m_strlen(obuf), sizeof (ibuf) - 2);
105 str_cat (ibuf, sizeof (ibuf), "\r\n");
106 mutt_socket_write (idata->conn, ibuf);
109 rc = imap_cmd_step (idata);
110 while (rc == IMAP_CMD_CONTINUE);
112 if (rc != IMAP_CMD_OK) {
113 debug_print (1, ("Error receiving server response.\n"));
117 if (imap_code (idata->cmd.buf))
118 return IMAP_AUTH_SUCCESS;
121 mutt_error _("CRAM-MD5 authentication failed.");
123 return IMAP_AUTH_FAILURE;
126 /* hmac_md5: produce CRAM-MD5 challenge response. */
127 static void hmac_md5 (const char *password, char *challenge,
128 unsigned char *response)
131 unsigned char ipad[MD5_BLOCK_LEN], opad[MD5_BLOCK_LEN];
132 unsigned char secret[MD5_BLOCK_LEN + 1];
133 unsigned char hash_passwd[MD5_DIGEST_LEN];
134 unsigned int secret_len, chal_len;
137 secret_len = m_strlen(password);
138 chal_len = m_strlen(challenge);
140 /* passwords longer than MD5_BLOCK_LEN bytes are substituted with their MD5
142 if (secret_len > MD5_BLOCK_LEN) {
144 MD5Update (&ctx, (unsigned char *) password, secret_len);
145 MD5Final (hash_passwd, &ctx);
146 strfcpy ((char *) secret, (char *) hash_passwd, MD5_DIGEST_LEN);
147 secret_len = MD5_DIGEST_LEN;
150 strfcpy ((char *) secret, password, sizeof (secret));
152 memset (ipad, 0, sizeof (ipad));
153 memset (opad, 0, sizeof (opad));
154 memcpy (ipad, secret, secret_len);
155 memcpy (opad, secret, secret_len);
157 for (i = 0; i < MD5_BLOCK_LEN; i++) {
162 /* inner hash: challenge and ipadded secret */
164 MD5Update (&ctx, ipad, MD5_BLOCK_LEN);
165 MD5Update (&ctx, (unsigned char *) challenge, chal_len);
166 MD5Final (response, &ctx);
168 /* outer hash: inner hash and opadded secret */
170 MD5Update (&ctx, opad, MD5_BLOCK_LEN);
171 MD5Update (&ctx, response, MD5_DIGEST_LEN);
172 MD5Final (response, &ctx);