2 * imap.c -- IMAP2bis/IMAP4 protocol methods
4 * Copyright 1997 by Eric S. Raymond
5 * For license terms, see the file COPYING in this directory.
12 #if defined(STDC_HEADERS)
15 #include "fetchmail.h"
20 #include <kerberosIV/des.h>
21 #include <kerberosIV/krb.h>
23 #if defined (__bsdi__)
25 #define krb_get_err_text(e) (krb_err_txt[e])
27 #if defined(__NetBSD__) || (__FreeBSD__) || defined(__linux__)
28 #define krb_get_err_text(e) (krb_err_txt[e])
32 #endif /* KERBEROS_V4 */
38 #ifdef HAVE_GSSAPI_GSSAPI_H
39 #include <gssapi/gssapi.h>
41 #ifdef HAVE_GSSAPI_GSSAPI_GENERIC_H
42 #include <gssapi/gssapi_generic.h>
44 #ifndef HAVE_GSS_C_NT_HOSTBASED_SERVICE
45 #define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
53 #endif /* OPIE_ENABLE */
55 #ifndef strstr /* glibc-2.1 declares this as a macro */
56 extern char *strstr(); /* needed on sysV68 R3V7.1. */
59 /* imap_version values */
60 #define IMAP2 -1 /* IMAP2 or IMAP2BIS, RFC1176 */
61 #define IMAP4 0 /* IMAP4 rev 0, RFC1730 */
62 #define IMAP4rev1 1 /* IMAP4 rev 1, RFC2060 */
64 static int count, unseen, deletions, imap_version, preauth;
65 static int expunged, expunge_period, saved_timeout;
67 static char capabilities[MSGBUFSIZE+1];
68 static unsigned int *unseen_messages;
70 int imap_ok(int sock, char *argbuf)
71 /* parse command response */
73 char buf[MSGBUFSIZE+1];
79 if ((ok = gen_recv(sock, buf, sizeof(buf))))
82 /* all tokens in responses are caseblind */
83 for (cp = buf; *cp; cp++)
87 /* interpret untagged status responses */
88 if (strstr(buf, "* CAPABILITY"))
89 strncpy(capabilities, buf + 12, sizeof(capabilities));
90 else if (strstr(buf, "EXISTS"))
94 * Nasty kluge to handle RFC2177 IDLE. If we know we're idling
95 * we can't wait for the tag matching the IDLE; we have to tell the
96 * server the IDLE is finished by shipping back a DONE when we
97 * see an EXISTS. Only after that will a tagged response be
98 * shipped. The idling flag also gets cleared on a timeout.
100 if (stage == STAGE_IDLE)
102 /* we do our own write and report here to disable tagging */
103 SockWrite(sock, "DONE\r\n", 6);
104 if (outlevel >= O_MONITOR)
105 report(stdout, "IMAP> DONE\n");
107 mytimeout = saved_timeout;
111 else if (strstr(buf, "PREAUTH"))
114 (tag[0] != '\0' && strncmp(buf, tag, strlen(tag)));
127 for (cp = buf; !isspace(*cp); cp++)
132 if (strncmp(cp, "OK", 2) == 0)
138 else if (strncmp(cp, "BAD", 3) == 0)
140 else if (strncmp(cp, "NO", 2) == 0)
142 if (stage == STAGE_GETAUTH)
143 return(PS_AUTHFAIL); /* RFC2060, 6.2.2 */
153 static int do_otp(int sock, struct query *ctl)
157 char challenge[OPIE_CHALLENGE_MAX+1];
158 char response[OPIE_RESPONSE_MAX+1];
160 gen_send(sock, "AUTHENTICATE X-OTP");
162 if (rval = gen_recv(sock, buffer, sizeof(buffer)))
165 if ((i = from64tobits(challenge, buffer)) < 0) {
166 report(stderr, _("Could not decode initial BASE64 challenge\n"));
171 to64frombits(buffer, ctl->remotename, strlen(ctl->remotename));
173 if (outlevel >= O_MONITOR)
174 report(stdout, "IMAP> %s\n", buffer);
176 /* best not to count on the challenge code handling multiple writes */
177 strcat(buffer, "\r\n");
178 SockWrite(sock, buffer, strlen(buffer));
180 if (rval = gen_recv(sock, buffer, sizeof(buffer)))
183 if ((i = from64tobits(challenge, buffer)) < 0) {
184 report(stderr, _("Could not decode OTP challenge\n"));
188 rval = opiegenerator(challenge, !strcmp(ctl->password, "opie") ? "" : ctl->password, response);
189 if ((rval == -2) && !run.poll_interval) {
190 char secret[OPIE_SECRET_MAX+1];
191 fprintf(stderr, _("Secret pass phrase: "));
192 if (opiereadpass(secret, sizeof(secret), 0))
193 rval = opiegenerator(challenge, secret, response);
194 memset(secret, 0, sizeof(secret));
200 to64frombits(buffer, response, strlen(response));
202 if (outlevel >= O_MONITOR)
203 report(stdout, "IMAP> %s\n", buffer);
204 strcat(buffer, "\r\n");
205 SockWrite(sock, buffer, strlen(buffer));
207 if (rval = gen_recv(sock, buffer, sizeof(buffer)))
210 if (strstr(buffer, "OK"))
215 #endif /* OPIE_ENABLE */
220 #elif SIZEOF_SHORT == 4
222 #elif SIZEOF_LONG == 4
225 #error Cannot deduce a 32-bit-type
228 static int do_rfc1731(int sock, char *truename)
229 /* authenticate as per RFC1731 -- note 32-bit integer requirement here */
232 char buf1[4096], buf2[4096];
236 } challenge1, challenge2;
237 char srvinst[INST_SZ];
239 char srvrealm[REALM_SZ];
240 KTEXT_ST authenticator;
241 CREDENTIALS credentials;
242 char tktuser[MAX_K_NAME_SZ+1+INST_SZ+1+REALM_SZ+1];
243 char tktinst[INST_SZ];
244 char tktrealm[REALM_SZ];
246 des_key_schedule schedule;
248 gen_send(sock, "AUTHENTICATE KERBEROS_V4");
250 /* The data encoded in the first ready response contains a random
251 * 32-bit number in network byte order. The client should respond
252 * with a Kerberos ticket and an authenticator for the principal
253 * "imap.hostname@realm", where "hostname" is the first component
254 * of the host name of the server with all letters in lower case
255 * and where "realm" is the Kerberos realm of the server. The
256 * encrypted checksum field included within the Kerberos
257 * authenticator should contain the server provided 32-bit number
258 * in network byte order.
261 if (result = gen_recv(sock, buf1, sizeof buf1)) {
265 len = from64tobits(challenge1.cstr, buf1);
267 report(stderr, _("could not decode initial BASE64 challenge\n"));
271 /* this patch by Dan Root <dar@thekeep.org> solves an endianess
276 *(int *)tmp = ntohl(*(int *) challenge1.cstr);
277 memcpy(challenge1.cstr, tmp, sizeof(tmp));
280 /* Client responds with a Kerberos ticket and an authenticator for
281 * the principal "imap.hostname@realm" where "hostname" is the
282 * first component of the host name of the server with all letters
283 * in lower case and where "realm" is the Kerberos realm of the
284 * server. The encrypted checksum field included within the
285 * Kerberos authenticator should contain the server-provided
286 * 32-bit number in network byte order.
289 strncpy(srvinst, truename, (sizeof srvinst)-1);
290 srvinst[(sizeof srvinst)-1] = '\0';
291 for (p = srvinst; *p; p++) {
297 strncpy(srvrealm, (char *)krb_realmofhost(srvinst), (sizeof srvrealm)-1);
298 srvrealm[(sizeof srvrealm)-1] = '\0';
299 if (p = strchr(srvinst, '.')) {
303 result = krb_mk_req(&authenticator, "imap", srvinst, srvrealm, 0);
305 report(stderr, "krb_mq_req: %s\n", krb_get_err_text(result));
309 result = krb_get_cred("imap", srvinst, srvrealm, &credentials);
311 report(stderr, "krb_get_cred: %s\n", krb_get_err_text(result));
315 memcpy(session, credentials.session, sizeof session);
316 memset(&credentials, 0, sizeof credentials);
317 des_key_sched(session, schedule);
319 result = krb_get_tf_fullname(TKT_FILE, tktuser, tktinst, tktrealm);
321 report(stderr, "krb_get_tf_fullname: %s\n", krb_get_err_text(result));
327 * Andrew H. Chatham <andrew.chatham@duke.edu> alleges that this check
328 * is not necessary and has consistently been messing him up.
330 if (strcmp(tktuser, user) != 0) {
332 _("principal %s in ticket does not match -u %s\n"), tktuser,
336 #endif /* __UNUSED__ */
340 _("non-null instance (%s) might cause strange behavior\n"),
342 strcat(tktuser, ".");
343 strcat(tktuser, tktinst);
346 if (strcmp(tktrealm, srvrealm) != 0) {
347 strcat(tktuser, "@");
348 strcat(tktuser, tktrealm);
351 result = krb_mk_req(&authenticator, "imap", srvinst, srvrealm,
354 report(stderr, "krb_mq_req: %s\n", krb_get_err_text(result));
358 to64frombits(buf1, authenticator.dat, authenticator.length);
359 if (outlevel >= O_MONITOR) {
360 report(stdout, "IMAP> %s\n", buf1);
362 strcat(buf1, "\r\n");
363 SockWrite(sock, buf1, strlen(buf1));
365 /* Upon decrypting and verifying the ticket and authenticator, the
366 * server should verify that the contained checksum field equals
367 * the original server provided random 32-bit number. Should the
368 * verification be successful, the server must add one to the
369 * checksum and construct 8 octets of data, with the first four
370 * octets containing the incremented checksum in network byte
371 * order, the fifth octet containing a bit-mask specifying the
372 * protection mechanisms supported by the server, and the sixth
373 * through eighth octets containing, in network byte order, the
374 * maximum cipher-text buffer size the server is able to receive.
375 * The server must encrypt the 8 octets of data in the session key
376 * and issue that encrypted data in a second ready response. The
377 * client should consider the server authenticated if the first
378 * four octets the un-encrypted data is equal to one plus the
379 * checksum it previously sent.
382 if (result = gen_recv(sock, buf1, sizeof buf1))
385 /* The client must construct data with the first four octets
386 * containing the original server-issued checksum in network byte
387 * order, the fifth octet containing the bit-mask specifying the
388 * selected protection mechanism, the sixth through eighth octets
389 * containing in network byte order the maximum cipher-text buffer
390 * size the client is able to receive, and the following octets
391 * containing a user name string. The client must then append
392 * from one to eight octets so that the length of the data is a
393 * multiple of eight octets. The client must then PCBC encrypt the
394 * data with the session key and respond to the second ready
395 * response with the encrypted data. The server decrypts the data
396 * and verifies the contained checksum. The username field
397 * identifies the user for whom subsequent IMAP operations are to
398 * be performed; the server must verify that the principal
399 * identified in the Kerberos ticket is authorized to connect as
400 * that user. After these verifications, the authentication
401 * process is complete.
404 len = from64tobits(buf2, buf1);
406 report(stderr, _("could not decode BASE64 ready response\n"));
410 des_ecb_encrypt((des_cblock *)buf2, (des_cblock *)buf2, schedule, 0);
411 memcpy(challenge2.cstr, buf2, 4);
412 if (ntohl(challenge2.cint) != challenge1.cint + 1) {
413 report(stderr, _("challenge mismatch\n"));
417 memset(authenticator.dat, 0, sizeof authenticator.dat);
419 result = htonl(challenge1.cint);
420 memcpy(authenticator.dat, &result, sizeof result);
422 /* The protection mechanisms and their corresponding bit-masks are as
425 * 1 No protection mechanism
426 * 2 Integrity (krb_mk_safe) protection
427 * 4 Privacy (krb_mk_priv) protection
429 authenticator.dat[4] = 1;
431 len = strlen(tktuser);
432 strncpy(authenticator.dat+8, tktuser, len);
433 authenticator.length = len + 8 + 1;
434 while (authenticator.length & 7) {
435 authenticator.length++;
437 des_pcbc_encrypt((des_cblock *)authenticator.dat,
438 (des_cblock *)authenticator.dat, authenticator.length, schedule,
441 to64frombits(buf1, authenticator.dat, authenticator.length);
442 if (outlevel >= O_MONITOR) {
443 report(stdout, "IMAP> %s\n", buf1);
446 strcat(buf1, "\r\n");
447 SockWrite(sock, buf1, strlen(buf1));
449 if (result = gen_recv(sock, buf1, sizeof buf1))
452 if (strstr(buf1, "OK")) {
459 #endif /* KERBEROS_V4 */
462 #define GSSAUTH_P_NONE 1
463 #define GSSAUTH_P_INTEGRITY 2
464 #define GSSAUTH_P_PRIVACY 4
466 static int do_gssauth(int sock, char *hostname, char *username)
468 gss_buffer_desc request_buf, send_token;
469 gss_buffer_t sec_token;
470 gss_name_t target_name;
471 gss_ctx_id_t context;
475 OM_uint32 maj_stat, min_stat;
476 char buf1[8192], buf2[8192], server_conf_flags;
477 unsigned long buf_size;
480 /* first things first: get an imap ticket for host */
481 sprintf(buf1, "imap@%s", hostname);
482 request_buf.value = buf1;
483 request_buf.length = strlen(buf1) + 1;
484 maj_stat = gss_import_name(&min_stat, &request_buf, GSS_C_NT_HOSTBASED_SERVICE,
486 if (maj_stat != GSS_S_COMPLETE) {
487 report(stderr, _("Couldn't get service name for [%s]\n"), buf1);
490 else if (outlevel >= O_DEBUG) {
491 maj_stat = gss_display_name(&min_stat, target_name, &request_buf,
493 report(stderr, _("Using service name [%s]\n"),request_buf.value);
494 maj_stat = gss_release_buffer(&min_stat, &request_buf);
497 gen_send(sock, "AUTHENTICATE GSSAPI");
499 /* upon receipt of the GSSAPI authentication request, server returns
500 * null data ready response. */
501 if (result = gen_recv(sock, buf1, sizeof buf1)) {
505 /* now start the security context initialisation loop... */
506 sec_token = GSS_C_NO_BUFFER;
507 context = GSS_C_NO_CONTEXT;
508 if (outlevel >= O_VERBOSE)
509 report(stdout, _("Sending credentials\n"));
511 send_token.length = 0;
512 send_token.value = NULL;
513 maj_stat = gss_init_sec_context(&min_stat,
518 GSS_C_MUTUAL_FLAG | GSS_C_SEQUENCE_FLAG,
520 GSS_C_NO_CHANNEL_BINDINGS,
526 if (maj_stat!=GSS_S_COMPLETE && maj_stat!=GSS_S_CONTINUE_NEEDED) {
527 report(stderr, _("Error exchanging credentials\n"));
528 gss_release_name(&min_stat, &target_name);
529 /* wake up server and await NO response */
530 SockWrite(sock, "\r\n", 2);
531 if (result = gen_recv(sock, buf1, sizeof buf1))
535 to64frombits(buf1, send_token.value, send_token.length);
536 gss_release_buffer(&min_stat, &send_token);
537 strcat(buf1, "\r\n");
538 SockWrite(sock, buf1, strlen(buf1));
539 if (outlevel >= O_MONITOR)
540 report(stdout, "IMAP> %s\n", buf1);
541 if (maj_stat == GSS_S_CONTINUE_NEEDED) {
542 if (result = gen_recv(sock, buf1, sizeof buf1)) {
543 gss_release_name(&min_stat, &target_name);
546 request_buf.length = from64tobits(buf2, buf1 + 2);
547 request_buf.value = buf2;
548 sec_token = &request_buf;
550 } while (maj_stat == GSS_S_CONTINUE_NEEDED);
551 gss_release_name(&min_stat, &target_name);
553 /* get security flags and buffer size */
554 if (result = gen_recv(sock, buf1, sizeof buf1)) {
557 request_buf.length = from64tobits(buf2, buf1 + 2);
558 request_buf.value = buf2;
560 maj_stat = gss_unwrap(&min_stat, context, &request_buf, &send_token,
562 if (maj_stat != GSS_S_COMPLETE) {
563 report(stderr, _("Couldn't unwrap security level data\n"));
564 gss_release_buffer(&min_stat, &send_token);
567 if (outlevel >= O_DEBUG)
568 report(stdout, _("Credential exchange complete\n"));
569 /* first octet is security levels supported. We want none, for now */
570 server_conf_flags = ((char *)send_token.value)[0];
571 if ( !(((char *)send_token.value)[0] & GSSAUTH_P_NONE) ) {
572 report(stderr, _("Server requires integrity and/or privacy\n"));
573 gss_release_buffer(&min_stat, &send_token);
576 ((char *)send_token.value)[0] = 0;
577 buf_size = ntohl(*((long *)send_token.value));
578 /* we don't care about buffer size if we don't wrap data */
579 gss_release_buffer(&min_stat, &send_token);
580 if (outlevel >= O_DEBUG) {
581 report(stdout, _("Unwrapped security level flags: %s%s%s\n"),
582 server_conf_flags & GSSAUTH_P_NONE ? "N" : "-",
583 server_conf_flags & GSSAUTH_P_INTEGRITY ? "I" : "-",
584 server_conf_flags & GSSAUTH_P_PRIVACY ? "C" : "-");
585 report(stdout, _("Maximum GSS token size is %ld\n"),buf_size);
588 /* now respond in kind (hack!!!) */
589 buf_size = htonl(buf_size); /* do as they do... only matters if we do enc */
590 memcpy(buf1, &buf_size, 4);
591 buf1[0] = GSSAUTH_P_NONE;
592 strcpy(buf1+4, username); /* server decides if princ is user */
593 request_buf.length = 4 + strlen(username) + 1;
594 request_buf.value = buf1;
595 maj_stat = gss_wrap(&min_stat, context, 0, GSS_C_QOP_DEFAULT, &request_buf,
596 &cflags, &send_token);
597 if (maj_stat != GSS_S_COMPLETE) {
598 report(stderr, _("Error creating security level request\n"));
601 to64frombits(buf1, send_token.value, send_token.length);
602 if (outlevel >= O_DEBUG) {
603 report(stdout, _("Requesting authorization as %s\n"), username);
604 report(stdout, "IMAP> %s\n",buf1);
606 strcat(buf1, "\r\n");
607 SockWrite(sock, buf1, strlen(buf1));
609 /* we should be done. Get status and finish up */
611 if (result = gen_recv(sock, buf1, sizeof buf1))
613 } while(strncmp(buf1, tag, strlen(tag)) != 0);
614 if (strstr(buf1, "OK")) {
615 /* flush security context */
616 if (outlevel >= O_DEBUG)
617 report(stdout, _("Releasing GSS credentials\n"));
618 maj_stat = gss_delete_sec_context(&min_stat, &context, &send_token);
619 if (maj_stat != GSS_S_COMPLETE) {
620 report(stderr, _("Error releasing credentials\n"));
623 /* send_token may contain a notification to the server to flush
624 * credentials. RFC 1731 doesn't specify what to do, and since this
625 * support is only for authentication, we'll assume the server
626 * knows enough to flush its own credentials */
627 gss_release_buffer(&min_stat, &send_token);
638 static tSmbNtlmAuthRequest request;
639 static tSmbNtlmAuthChallenge challenge;
640 static tSmbNtlmAuthResponse response;
643 * NTLM support by Grant Edwards.
645 * Handle MS-Exchange NTLM authentication method. This is the same
646 * as the NTLM auth used by Samba for SMB related services. We just
647 * encode the packets in base64 instead of sending them out via a
650 * Much source (ntlm.h, smb*.c smb*.h) was borrowed from Samba.
653 static int do_imap_ntlm(int sock, struct query *ctl)
658 gen_send(sock, "AUTHENTICATE NTLM");
660 if ((result = gen_recv(sock, msgbuf, sizeof msgbuf)))
663 if (msgbuf[0] != '+')
666 buildSmbNtlmAuthRequest(&request,ctl->remotename,NULL);
668 if (outlevel >= O_DEBUG)
669 dumpSmbNtlmAuthRequest(stdout, &request);
671 memset(msgbuf,0,sizeof msgbuf);
672 to64frombits (msgbuf, (unsigned char*)&request, SmbLength(&request));
674 if (outlevel >= O_MONITOR)
675 report(stdout, "IMAP> %s\n", msgbuf);
677 strcat(msgbuf,"\r\n");
678 SockWrite (sock, msgbuf, strlen (msgbuf));
680 if ((gen_recv(sock, msgbuf, sizeof msgbuf)))
683 len = from64tobits ((unsigned char*)&challenge, msgbuf);
685 if (outlevel >= O_DEBUG)
686 dumpSmbNtlmAuthChallenge(stdout, &challenge);
688 buildSmbNtlmAuthResponse(&challenge, &response,ctl->remotename,ctl->password);
690 if (outlevel >= O_DEBUG)
691 dumpSmbNtlmAuthResponse(stdout, &response);
693 memset(msgbuf,0,sizeof msgbuf);
694 to64frombits (msgbuf, (unsigned char*)&response, SmbLength(&response));
696 if (outlevel >= O_MONITOR)
697 report(stdout, "IMAP> %s\n", msgbuf);
699 strcat(msgbuf,"\r\n");
701 SockWrite (sock, msgbuf, strlen (msgbuf));
703 if ((result = gen_recv (sock, msgbuf, sizeof msgbuf)))
706 if (strstr (msgbuf, "OK"))
713 int imap_canonicalize(char *result, char *raw, int maxlen)
714 /* encode an IMAP password as per RFC1730's quoting conventions */
719 for (i = 0; i < strlen(raw) && i < maxlen; i++)
721 if ((raw[i] == '\\') || (raw[i] == '"'))
723 result[j++] = raw[i];
730 int imap_getauth(int sock, struct query *ctl, char *greeting)
731 /* apply for connection authorization */
735 /* probe to see if we're running IMAP4 and can use RFC822.PEEK */
736 capabilities[0] = '\0';
737 if ((ok = gen_transact(sock, "CAPABILITY")) == PS_SUCCESS)
739 /* UW-IMAP server 10.173 notifies in all caps */
740 if (strstr(capabilities, "IMAP4REV1"))
742 imap_version = IMAP4rev1;
743 if (outlevel >= O_DEBUG)
744 report(stdout, _("Protocol identified as IMAP4 rev 1\n"));
748 imap_version = IMAP4;
749 if (outlevel >= O_DEBUG)
750 report(stdout, _("Protocol identified as IMAP4 rev 0\n"));
753 else if (ok == PS_ERROR)
755 imap_version = IMAP2;
756 if (outlevel >= O_DEBUG)
757 report(stdout, _("Protocol identified as IMAP2 or IMAP2BIS\n"));
762 peek_capable = (imap_version >= IMAP4);
765 * Assumption: expunges are cheap, so we want to do them
766 * after every message unless user said otherwise.
768 if (NUM_SPECIFIED(ctl->expunge))
769 expunge_period = NUM_VALUE_OUT(ctl->expunge);
774 * Handle idling. We depend on coming through here on startup
775 * and after each timeout (including timeouts during idles).
777 if (strstr(capabilities, "IDLE") && ctl->idle)
780 if (outlevel >= O_VERBOSE)
781 report(stdout, _("will idle after poll\n"));
785 * If either (a) we saw a PREAUTH token in the greeting, or
786 * (b) the user specified ssh preauthentication, then we're done.
788 if (preauth || ctl->server.preauthenticate == A_SSH)
790 preauth = FALSE; /* reset for the next session */
795 if ((ctl->server.protocol == P_IMAP) && strstr(capabilities, "AUTH=X-OTP"))
797 if (outlevel >= O_DEBUG)
798 report(stdout, _("OTP authentication is supported\n"));
799 if (do_otp(sock, ctl) == PS_SUCCESS)
802 #endif /* OPIE_ENABLE */
805 if (strstr(capabilities, "AUTH=GSSAPI"))
807 if (ctl->server.protocol == P_IMAP_GSS)
809 if (outlevel >= O_DEBUG)
810 report(stdout, _("GSS authentication is supported\n"));
811 return do_gssauth(sock, ctl->server.truename, ctl->remotename);
814 else if (ctl->server.protocol == P_IMAP_GSS)
817 _("Required GSS capability not supported by server\n"));
823 if (strstr(capabilities, "AUTH=KERBEROS_V4"))
825 if (outlevel >= O_DEBUG)
826 report(stdout, _("KERBEROS_V4 authentication is supported\n"));
828 if (ctl->server.protocol == P_IMAP_K4)
830 if ((ok = do_rfc1731(sock, ctl->server.truename)))
831 /* SASL cancellation of authentication */
836 /* else fall through to ordinary AUTH=LOGIN case */
838 else if (ctl->server.protocol == P_IMAP_K4)
841 _("Required KERBEROS_V4 capability not supported by server\n"));
844 #endif /* KERBEROS_V4 */
846 if (strstr(capabilities, "AUTH=CRAM-MD5"))
848 if (outlevel >= O_DEBUG)
849 report (stdout, _("CRAM-MD5 authentication is supported\n"));
850 if (ctl->server.protocol != P_IMAP_LOGIN)
852 if ((ok = do_cram_md5 (sock, ctl)))
853 /* SASL cancellation of authentication */
859 else if (ctl->server.protocol == P_IMAP_CRAM_MD5)
862 _("Required CRAM-MD5 capability not supported by server\n"));
867 if (strstr (capabilities, "AUTH=NTLM"))
869 if (outlevel >= O_DEBUG)
870 report (stdout, _("NTLM authentication is supported\n"));
871 return do_imap_ntlm (sock, ctl);
873 #endif /* NTLM_ENABLE */
875 #ifdef __UNUSED__ /* The Cyrus IMAP4rev1 server chokes on this */
876 /* this handles either AUTH=LOGIN or AUTH-LOGIN */
877 if ((imap_version >= IMAP4rev1) && (!strstr(capabilities, "LOGIN"))) {
879 _("Required LOGIN capability not supported by server\n"));
882 #endif /* __UNUSED__ */
885 /* these sizes guarantee no buffer overflow */
886 char remotename[NAMELEN*2+1], password[PASSWORDLEN*2+1];
888 imap_canonicalize(remotename, ctl->remotename, NAMELEN);
889 imap_canonicalize(password, ctl->password, PASSWORDLEN);
890 ok = gen_transact(sock, "LOGIN \"%s\" \"%s\"", remotename, password);
899 static int internal_expunge(int sock)
900 /* ship an expunge, resetting associated counters */
904 if ((ok = gen_transact(sock, "EXPUNGE")))
907 expunged += deletions;
910 #ifdef IMAP_UID /* not used */
912 #endif /* IMAP_UID */
917 static int imap_idle(int sock)
918 /* start an RFC2177 IDLE */
921 saved_timeout = mytimeout;
924 return (gen_transact(sock, "IDLE"));
927 static int imap_getrange(int sock,
930 int *countp, int *newp, int *bytes)
931 /* get range of messages to be fetched */
934 char buf[MSGBUFSIZE+1], *cp;
936 /* find out how many messages are waiting */
942 * We have to have an expunge here, otherwise the re-poll will
943 * infinite-loop picking up un-expunged messages -- unless the
944 * expunge period is one and we've been nuking each message
945 * just after deletion.
948 if (deletions && expunge_period != 1)
949 ok = internal_expunge(sock);
952 ok = imap_idle(sock);
953 if (ok || gen_transact(sock, "NOOP"))
955 report(stderr, _("re-poll failed\n"));
958 else if (count == -1) /* no EXISTS response to NOOP/IDLE */
962 if (outlevel >= O_DEBUG)
963 report(stdout, _("%d messages waiting after re-poll\n"), count);
967 ok = gen_transact(sock,
968 check_only ? "EXAMINE \"%s\"" : "SELECT \"%s\"",
969 folder ? folder : "INBOX");
972 report(stderr, _("mailbox selection failed\n"));
975 else if (outlevel >= O_DEBUG)
976 report(stdout, _("%d messages waiting after first poll\n"), count);
978 /* no messages? then we may need to idle until we get some */
979 if (count == 0 && do_idle)
985 /* OK, now get a count of unseen messages and their indices */
986 if (!ctl->fetchall && count > 0)
989 free(unseen_messages);
990 unseen_messages = xmalloc(count * sizeof(unsigned int));
991 memset(unseen_messages, 0, count * sizeof(unsigned int));
994 gen_send(sock, "SEARCH UNSEEN");
996 ok = gen_recv(sock, buf, sizeof(buf));
999 report(stderr, _("search for unseen messages failed\n"));
1000 return(PS_PROTOCOL);
1002 else if ((cp = strstr(buf, "* SEARCH")))
1006 cp += 8; /* skip "* SEARCH" */
1008 while (*cp && unseen < count)
1010 /* skip whitespace */
1011 while (*cp && isspace(*cp))
1016 * Message numbers are between 1 and 2^32 inclusive,
1017 * so unsigned int is large enough.
1019 unseen_messages[unseen]=(unsigned int)strtol(cp,&ep,10);
1021 if (outlevel >= O_DEBUG)
1023 _("%u is unseen\n"),
1024 unseen_messages[unseen]);
1032 (tag[0] != '\0' && strncmp(buf, tag, strlen(tag)));
1041 static int imap_getsizes(int sock, int count, int *sizes)
1042 /* capture the sizes of all messages */
1044 char buf [MSGBUFSIZE+1];
1047 * Some servers (as in, PMDF5.1-9.1 under OpenVMS 6.1)
1048 * won't accept 1:1 as valid set syntax. Some implementors
1049 * should be taken out and shot for excessive anality.
1051 * Microsoft Exchange (brain-dead piece of crap that it is)
1052 * sometimes gets its knickers in a knot about bodiless messages.
1053 * You may see responses like this:
1055 * fetchmail: IMAP> A0004 FETCH 1:9 RFC822.SIZE
1056 * fetchmail: IMAP< * 2 FETCH (RFC822.SIZE 1187)
1057 * fetchmail: IMAP< * 3 FETCH (RFC822.SIZE 3954)
1058 * fetchmail: IMAP< * 4 FETCH (RFC822.SIZE 1944)
1059 * fetchmail: IMAP< * 5 FETCH (RFC822.SIZE 2933)
1060 * fetchmail: IMAP< * 6 FETCH (RFC822.SIZE 1854)
1061 * fetchmail: IMAP< * 7 FETCH (RFC822.SIZE 34054)
1062 * fetchmail: IMAP< * 8 FETCH (RFC822.SIZE 5561)
1063 * fetchmail: IMAP< * 9 FETCH (RFC822.SIZE 1101)
1064 * fetchmail: IMAP< A0004 NO The requested item could not be found.
1066 * This means message 1 has only headers. For kicks and grins
1067 * you can telnet in and look:
1069 * A003 NO The requested item could not be found.
1070 * A004 fetch 1 rfc822.header
1071 * A004 NO The requested item could not be found.
1073 * * 1 FETCH (BODY ("TEXT" "PLAIN" ("CHARSET" "US-ASCII") NIL NIL "7BIT" 35 3))
1074 * A006 OK FETCH completed.
1076 * To get around this, we terminate the read loop on a NO and count
1077 * on the fact that the sizes array has been preinitialized with a
1078 * known-bad size value.
1081 gen_send(sock, "FETCH 1 RFC822.SIZE", count);
1083 gen_send(sock, "FETCH 1:%d RFC822.SIZE", count);
1088 if ((ok = gen_recv(sock, buf, sizeof(buf))))
1090 else if (strstr(buf, "OK") || strstr(buf, "NO"))
1092 else if (sscanf(buf, "* %d FETCH (RFC822.SIZE %d)", &num, &size) == 2)
1093 sizes[num - 1] = size;
1099 static int imap_is_old(int sock, struct query *ctl, int number)
1100 /* is the given message old? */
1106 * Expunges change the fetch numbers, but unseen_messages contains
1107 * indices from before any expungees were done. So neither the
1108 * argument nor the values in message_sequence need to be decremented.
1112 for (i = 0; i < unseen; i++)
1113 if (unseen_messages[i] == number)
1122 static int imap_fetch_headers(int sock, struct query *ctl,int number,int *lenp)
1123 /* request headers of nth message */
1125 char buf [MSGBUFSIZE+1];
1128 /* expunges change the fetch numbers */
1132 * This is blessed by RFC1176, RFC1730, RFC2060.
1133 * According to the RFCs, it should *not* set the \Seen flag.
1135 gen_send(sock, "FETCH %d RFC822.HEADER", number);
1137 /* looking for FETCH response */
1141 if ((ok = gen_recv(sock, buf, sizeof(buf))))
1144 (sscanf(buf+2, "%d FETCH (%*s {%d}", &num, lenp) != 2);
1152 static int imap_fetch_body(int sock, struct query *ctl, int number, int *lenp)
1153 /* request body of nth message */
1155 char buf [MSGBUFSIZE+1], *cp;
1158 /* expunges change the fetch numbers */
1162 * If we're using IMAP4, we can fetch the message without setting its
1163 * seen flag. This is good! It means that if the protocol exchange
1164 * craps out during the message, it will still be marked `unseen' on
1167 * However...*don't* do this if we're using keep to suppress deletion!
1168 * In that case, marking the seen flag is the only way to prevent the
1169 * message from being re-fetched on subsequent runs (and according
1170 * to RFC2060 p.43 this fetch should set Seen as a side effect).
1172 * According to RFC2060, and Mark Crispin the IMAP maintainer,
1173 * FETCH %d BODY[TEXT] and RFC822.TEXT are "functionally
1174 * equivalent". However, we know of at least one server that
1175 * treats them differently in the presence of MIME attachments;
1176 * the latter form downloads the attachment, the former does not.
1177 * The server is InterChange, and the fool who implemented this
1178 * misfeature ought to be strung up by his thumbs.
1180 * When I tried working around this by disabling use of the 4rev1 form,
1181 * I found that doing this breaks operation with M$ Exchange.
1182 * Annoyingly enough, Exchange's refusal to cope is technically legal
1183 * under RFC2062. Trust Microsoft, the Great Enemy of interoperability
1184 * standards, to find a way to make standards compliance irritating....
1186 switch (imap_version)
1188 case IMAP4rev1: /* RFC 2060 */
1190 gen_send(sock, "FETCH %d BODY.PEEK[TEXT]", number);
1192 gen_send(sock, "FETCH %d BODY[TEXT]", number);
1195 case IMAP4: /* RFC 1730 */
1197 gen_send(sock, "FETCH %d RFC822.TEXT.PEEK", number);
1199 gen_send(sock, "FETCH %d RFC822.TEXT", number);
1202 default: /* RFC 1176 */
1203 gen_send(sock, "FETCH %d RFC822.TEXT", number);
1207 /* looking for FETCH response */
1211 if ((ok = gen_recv(sock, buf, sizeof(buf))))
1214 (!strstr(buf+4, "FETCH") || sscanf(buf+2, "%d", &num) != 1);
1220 * Try to extract a length from the FETCH response. RFC2060 requires
1221 * it to be present, but at least one IMAP server (Novell GroupWise)
1224 if ((cp = strchr(buf, '{')))
1225 *lenp = atoi(cp + 1);
1227 *lenp = -1; /* missing length part in FETCH reponse */
1232 static int imap_trail(int sock, struct query *ctl, int number)
1233 /* discard tail of FETCH response after reading message text */
1235 /* expunges change the fetch numbers */
1236 /* number -= expunged; */
1240 char buf[MSGBUFSIZE+1];
1243 if ((ok = gen_recv(sock, buf, sizeof(buf))))
1246 /* UW IMAP returns "OK FETCH", Cyrus returns "OK Completed" */
1247 if (strstr(buf, "OK"))
1252 * Any IMAP server that fails to set Seen on a BODY[TEXT]
1253 * fetch violates RFC2060 p.43 (top). This becomes an issue
1254 * when keep is on, because seen messages aren't deleted and
1255 * get refetched on each poll. As a workaround, if keep is on
1256 * we can set the Seen flag explicitly.
1258 * This code isn't used yet because we don't know of any IMAP
1259 * servers broken in this way.
1262 if ((ok = gen_transact(sock,
1263 imap_version == IMAP4
1264 ? "STORE %d +FLAGS.SILENT (\\Seen)"
1265 : "STORE %d +FLAGS (\\Seen)",
1268 #endif /* __UNUSED__ */
1274 static int imap_delete(int sock, struct query *ctl, int number)
1275 /* set delete flag for given message */
1279 /* expunges change the fetch numbers */
1283 * Use SILENT if possible as a minor throughput optimization.
1284 * Note: this has been dropped from IMAP4rev1.
1286 * We set Seen because there are some IMAP servers (notably HP
1287 * OpenMail) that do message-receipt DSNs, but only when the seen
1288 * bit is set. This is the appropriate time -- we get here right
1289 * after the local SMTP response that says delivery was
1292 if ((ok = gen_transact(sock,
1293 imap_version == IMAP4
1294 ? "STORE %d +FLAGS.SILENT (\\Seen \\Deleted)"
1295 : "STORE %d +FLAGS (\\Seen \\Deleted)",
1302 * We do an expunge after expunge_period messages, rather than
1303 * just before quit, so that a line hit during a long session
1304 * won't result in lots of messages being fetched again during
1307 if (NUM_NONZERO(expunge_period) && (deletions % expunge_period) == 0)
1308 internal_expunge(sock);
1313 static int imap_logout(int sock, struct query *ctl)
1314 /* send logout command */
1316 /* if any un-expunged deletions remain, ship an expunge now */
1318 internal_expunge(sock);
1321 /* Memory clean-up */
1322 if (unseen_messages)
1323 free(unseen_messages);
1324 #endif /* USE_SEARCH */
1326 return(gen_transact(sock, "LOGOUT"));
1329 const static struct method imap =
1331 "IMAP", /* Internet Message Access Protocol */
1335 #else /* INET6_ENABLE */
1336 143, /* standard IMAP2bis/IMAP4 port */
1337 993, /* ssl IMAP2bis/IMAP4 port */
1338 #endif /* INET6_ENABLE */
1339 TRUE, /* this is a tagged protocol */
1340 FALSE, /* no message delimiter */
1341 imap_ok, /* parse command response */
1342 imap_canonicalize, /* deal with embedded slashes and spaces */
1343 imap_getauth, /* get authorization */
1344 imap_getrange, /* query range of messages */
1345 imap_getsizes, /* get sizes of messages (used for ESMTP SIZE option) */
1346 imap_is_old, /* no UID check */
1347 imap_fetch_headers, /* request given message headers */
1348 imap_fetch_body, /* request given message body */
1349 imap_trail, /* eat message trailer */
1350 imap_delete, /* delete the message */
1351 imap_logout, /* expunge and exit */
1352 TRUE, /* yes, we can re-poll */
1355 int doIMAP(struct query *ctl)
1356 /* retrieve messages using IMAP Version 2bis or Version 4 */
1358 return(do_protocol(ctl, &imap));
1361 /* imap.c ends here */