Pileus Git - ~andy/fetchmail/blob - imap.c

   1 /*
   2  * imap.c -- IMAP2bis/IMAP4 protocol methods
   3  *
   4  * Copyright 1997 by Eric S. Raymond
   5  * For license terms, see the file COPYING in this directory.
   6  */
   7
   8 #include  "config.h"
   9 #include  <stdio.h>
  10 #include  <string.h>
  11 #include  <ctype.h>
  12 #if defined(STDC_HEADERS)
  13 #include  <stdlib.h>
  14 #include  <limits.h>
  15 #include  <errno.h>
  16 #endif
  17 #include  "fetchmail.h"
  18 #include  "socket.h"
  19
  20 #include  "i18n.h"
  21
  22 /* imap_version values */
  23 #define IMAP2           -1      /* IMAP2 or IMAP2BIS, RFC1176 */
  24 #define IMAP4           0       /* IMAP4 rev 0, RFC1730 */
  25 #define IMAP4rev1       1       /* IMAP4 rev 1, RFC2060 */
  26
  27 /* global variables: please reinitialize them explicitly for proper
  28  * working in daemon mode */
  29
  30 /* TODO: session variables to be initialized before server greeting */
  31 static int preauth = FALSE;
  32
  33 /* session variables initialized in capa_probe() or imap_getauth() */
  34 static char capabilities[MSGBUFSIZE+1];
  35 static int imap_version = IMAP4;
  36 static flag do_idle = FALSE, has_idle = FALSE;
  37 static int expunge_period = 1;
  38
  39 /* mailbox variables initialized in imap_getrange() */
  40 static int count = 0, oldcount = 0, recentcount = 0, unseen = 0, deletions = 0;
  41 static unsigned int startcount = 1;
  42 static int expunged = 0;
  43 static unsigned int *unseen_messages;
  44
  45 /* for "IMAP> EXPUNGE" */
  46 static int actual_deletions = 0;
  47
  48 /* for "IMAP> IDLE" */
  49 static int saved_timeout = 0;
  50
  51 static int imap_ok(int sock, char *argbuf)
  52 /* parse command response */
  53 {
  54     char buf[MSGBUFSIZE+1];
  55
  56     do {
  57         int     ok;
  58         char    *cp;
  59
  60         if ((ok = gen_recv(sock, buf, sizeof(buf))))
  61             return(ok);
  62
  63         /* all tokens in responses are caseblind */
  64         for (cp = buf; *cp; cp++)
  65             if (islower((unsigned char)*cp))
  66                 *cp = toupper((unsigned char)*cp);
  67
  68         /* interpret untagged status responses
  69          * First check if we really have an untagged response, starting
  70          * with "*" SPACE. Then, for each individual check, use a BLANK
  71          * before the word to avoid confusion with the \Recent flag or
  72          * similar */
  73         if (buf[0] == '*' && buf[1] == ' ') {
  74             if (strstr(buf, " CAPABILITY")) {
  75                 strlcpy(capabilities, buf + 12, sizeof(capabilities));
  76             }
  77             else if (strstr(buf, " EXISTS"))
  78             {
  79                 count = atoi(buf+2);
  80                 /*
  81                  * Don't trust the message count passed by the server.
  82                  * Without this check, it might be possible to do a
  83                  * DNS-spoofing attack that would pass back a ridiculous
  84                  * count, and allocate a malloc area that would overlap
  85                  * a portion of the stack.
  86                  */
  87                 if ((unsigned)count > INT_MAX/sizeof(int))
  88                 {
  89                     report(stderr, GT_("bogus message count!"));
  90                     return(PS_PROTOCOL);
  91                 }
  92                 if ((recentcount = count - oldcount) < 0)
  93                     recentcount = 0;
  94
  95                 /*
  96                  * Nasty kluge to handle RFC2177 IDLE.  If we know we're idling
  97                  * we can't wait for the tag matching the IDLE; we have to tell the
  98                  * server the IDLE is finished by shipping back a DONE when we
  99                  * see an EXISTS.  Only after that will a tagged response be
 100                  * shipped.  The idling flag also gets cleared on a timeout.
 101                  */
 102                 if (stage == STAGE_IDLE)
 103                 {
 104                     /* If IDLE isn't supported, we were only sending NOOPs anyway. */
 105                     if (has_idle)
 106                     {
 107                         /* we do our own write and report here to disable tagging */
 108                         SockWrite(sock, "DONE\r\n", 6);
 109                         if (outlevel >= O_MONITOR)
 110                             report(stdout, "IMAP> DONE\n");
 111                     }
 112
 113                     mytimeout = saved_timeout;
 114                     stage = STAGE_FETCH;
 115                 }
 116             }
 117             /* we now compute recentcount as a difference between
 118              * new and old EXISTS, hence disable RECENT check */
 119 # if 0
 120             else if (strstr(buf, " RECENT"))
 121             {
 122                 recentcount = atoi(buf+2);
 123             }
 124 # endif
 125             else if (strstr(buf, " EXPUNGE"))
 126             {
 127                 /* the response "* 10 EXPUNGE" means that the currently
 128                  * tenth (i.e. only one) message has been deleted */
 129                 if (atoi(buf+2) > 0)
 130                 {
 131                     if (count > 0)
 132                         count--;
 133                     if (oldcount > 0)
 134                         oldcount--;
 135                     /* We do expect an EXISTS response immediately
 136                      * after this, so this updation of recentcount is
 137                      * just a precaution! */
 138                     if (recentcount > 0)
 139                         recentcount--;
 140                     actual_deletions++;
 141                 }
 142             }
 143             else if (strstr(buf, " PREAUTH"))
 144             {
 145                 preauth = TRUE;
 146             }
 147                 /*
 148                  * The server may decide to make the mailbox read-only,
 149                  * which causes fetchmail to go into a endless loop
 150                  * fetching the same message over and over again.
 151                  *
 152                  * However, for check_only, we use EXAMINE which will
 153                  * mark the mailbox read-only as per the RFC.
 154                  *
 155                  * This checks for the condition and aborts if
 156                  * the mailbox is read-only.
 157                  *
 158                  * See RFC 2060 section 6.3.1 (SELECT).
 159                  * See RFC 2060 section 6.3.2 (EXAMINE).
 160                  */
 161             else if (!check_only && strstr(buf, "[READ-ONLY]"))
 162             {
 163                 return(PS_LOCKBUSY);
 164             }
 165         }
 166     } while
 167         (tag[0] != '\0' && strncmp(buf, tag, strlen(tag)));
 168
 169     if (tag[0] == '\0')
 170     {
 171         if (argbuf)
 172             strcpy(argbuf, buf);
 173         return(PS_SUCCESS);
 174     }
 175     else
 176     {
 177         char    *cp;
 178
 179         /* skip the tag */
 180         for (cp = buf; !isspace((unsigned char)*cp); cp++)
 181             continue;
 182         while (isspace((unsigned char)*cp))
 183             cp++;
 184
 185         if (strncasecmp(cp, "OK", 2) == 0)
 186         {
 187             if (argbuf)
 188                 strcpy(argbuf, cp);
 189             return(PS_SUCCESS);
 190         }
 191         else if (strncasecmp(cp, "BAD", 3) == 0)
 192             return(PS_ERROR);
 193         else if (strncasecmp(cp, "NO", 2) == 0)
 194         {
 195             if (stage == STAGE_GETAUTH)
 196                 return(PS_AUTHFAIL);    /* RFC2060, 6.2.2 */
 197             else
 198                 return(PS_ERROR);
 199         }
 200         else
 201             return(PS_PROTOCOL);
 202     }
 203 }
 204
 205 #ifdef NTLM_ENABLE
 206 #include "ntlm.h"
 207
 208 /*
 209  * NTLM support by Grant Edwards.
 210  *
 211  * Handle MS-Exchange NTLM authentication method.  This is the same
 212  * as the NTLM auth used by Samba for SMB related services. We just
 213  * encode the packets in base64 instead of sending them out via a
 214  * network interface.
 215  *
 216  * Much source (ntlm.h, smb*.c smb*.h) was borrowed from Samba.
 217  */
 218
 219 static int do_imap_ntlm(int sock, struct query *ctl)
 220 {
 221     tSmbNtlmAuthRequest request;
 222     tSmbNtlmAuthChallenge challenge;
 223     tSmbNtlmAuthResponse response;
 224
 225     char msgbuf[2048];
 226     int result,len;
 227
 228     gen_send(sock, "AUTHENTICATE NTLM");
 229
 230     if ((result = gen_recv(sock, msgbuf, sizeof msgbuf)))
 231         return result;
 232
 233     if (msgbuf[0] != '+')
 234         return PS_AUTHFAIL;
 235
 236     buildSmbNtlmAuthRequest(&request,ctl->remotename,NULL);
 237
 238     if (outlevel >= O_DEBUG)
 239         dumpSmbNtlmAuthRequest(stdout, &request);
 240
 241     memset(msgbuf,0,sizeof msgbuf);
 242     to64frombits (msgbuf, &request, SmbLength(&request));
 243
 244     if (outlevel >= O_MONITOR)
 245         report(stdout, "IMAP> %s\n", msgbuf);
 246
 247     strcat(msgbuf,"\r\n");
 248     SockWrite (sock, msgbuf, strlen (msgbuf));
 249
 250     if ((gen_recv(sock, msgbuf, sizeof msgbuf)))
 251         return result;
 252
 253     len = from64tobits (&challenge, msgbuf, sizeof(challenge));
 254
 255     if (outlevel >= O_DEBUG)
 256         dumpSmbNtlmAuthChallenge(stdout, &challenge);
 257
 258     buildSmbNtlmAuthResponse(&challenge, &response,ctl->remotename,ctl->password);
 259
 260     if (outlevel >= O_DEBUG)
 261         dumpSmbNtlmAuthResponse(stdout, &response);
 262
 263     memset(msgbuf,0,sizeof msgbuf);
 264     to64frombits (msgbuf, &response, SmbLength(&response));
 265
 266     if (outlevel >= O_MONITOR)
 267         report(stdout, "IMAP> %s\n", msgbuf);
 268
 269     strcat(msgbuf,"\r\n");
 270     SockWrite (sock, msgbuf, strlen (msgbuf));
 271
 272     result = imap_ok (sock, NULL);
 273     if (result == PS_SUCCESS)
 274         return PS_SUCCESS;
 275     else
 276         return PS_AUTHFAIL;
 277 }
 278 #endif /* NTLM */
 279
 280 static void imap_canonicalize(char *result, char *raw, size_t maxlen)
 281 /* encode an IMAP password as per RFC1730's quoting conventions */
 282 {
 283     size_t i, j;
 284
 285     j = 0;
 286     for (i = 0; i < strlen(raw) && i < maxlen; i++)
 287     {
 288         if ((raw[i] == '\\') || (raw[i] == '"'))
 289             result[j++] = '\\';
 290         result[j++] = raw[i];
 291     }
 292     result[j] = '\0';
 293 }
 294
 295 static void capa_probe(int sock, struct query *ctl)
 296 /* set capability variables from a CAPA probe */
 297 {
 298     int ok;
 299
 300     /* probe to see if we're running IMAP4 and can use RFC822.PEEK */
 301     capabilities[0] = '\0';
 302     if ((ok = gen_transact(sock, "CAPABILITY")) == PS_SUCCESS)
 303     {
 304         char    *cp;
 305
 306         /* capability checks are supposed to be caseblind */
 307         for (cp = capabilities; *cp; cp++)
 308             *cp = toupper((unsigned char)*cp);
 309
 310         /* UW-IMAP server 10.173 notifies in all caps, but RFC2060 says we
 311            should expect a response in mixed-case */
 312         if (strstr(capabilities, "IMAP4REV1"))
 313         {
 314             imap_version = IMAP4rev1;
 315             if (outlevel >= O_DEBUG)
 316                 report(stdout, GT_("Protocol identified as IMAP4 rev 1\n"));
 317         }
 318         else
 319         {
 320             imap_version = IMAP4;
 321             if (outlevel >= O_DEBUG)
 322                 report(stdout, GT_("Protocol identified as IMAP4 rev 0\n"));
 323         }
 324     }
 325     else if (ok == PS_ERROR)
 326     {
 327         imap_version = IMAP2;
 328         if (outlevel >= O_DEBUG)
 329             report(stdout, GT_("Protocol identified as IMAP2 or IMAP2BIS\n"));
 330     }
 331
 332     /*
 333      * Handle idling.  We depend on coming through here on startup
 334      * and after each timeout (including timeouts during idles).
 335      */
 336     do_idle = ctl->idle;
 337     if (ctl->idle)
 338     {
 339         if (strstr(capabilities, "IDLE"))
 340             has_idle = TRUE;
 341         else
 342             has_idle = FALSE;
 343         if (outlevel >= O_VERBOSE)
 344             report(stdout, GT_("will idle after poll\n"));
 345     }
 346
 347     peek_capable = (imap_version >= IMAP4);
 348 }
 349
 350 static int imap_getauth(int sock, struct query *ctl, char *greeting)
 351 /* apply for connection authorization */
 352 {
 353     int ok = 0;
 354 #ifdef SSL_ENABLE
 355     flag did_stls = FALSE;
 356 #endif /* SSL_ENABLE */
 357
 358     (void)greeting;
 359     /*
 360      * Assumption: expunges are cheap, so we want to do them
 361      * after every message unless user said otherwise.
 362      */
 363     if (NUM_SPECIFIED(ctl->expunge))
 364         expunge_period = NUM_VALUE_OUT(ctl->expunge);
 365     else
 366         expunge_period = 1;
 367
 368     capa_probe(sock, ctl);
 369
 370     /*
 371      * If either (a) we saw a PREAUTH token in the greeting, or
 372      * (b) the user specified ssh preauthentication, then we're done.
 373      */
 374     if (preauth || ctl->server.authenticate == A_SSH)
 375     {
 376         preauth = FALSE;  /* reset for the next session */
 377         return(PS_SUCCESS);
 378     }
 379
 380 #ifdef SSL_ENABLE
 381     if ((!ctl->sslproto || !strcmp(ctl->sslproto,"tls1"))
 382         && !ctl->use_ssl
 383         && strstr(capabilities, "STARTTLS"))
 384     {
 385            char *realhost;
 386
 387            realhost = ctl->server.via ? ctl->server.via : ctl->server.pollname;
 388            ok = gen_transact(sock, "STARTTLS");
 389
 390            /* We use "tls1" instead of ctl->sslproto, as we want STARTTLS,
 391             * not other SSL protocols
 392             */
 393            if (ok == PS_SUCCESS &&
 394                SSLOpen(sock,ctl->sslcert,ctl->sslkey,"tls1",ctl->sslcertck,
 395                    ctl->sslcertpath,ctl->sslfingerprint,
 396                    realhost,ctl->server.pollname) == -1)
 397            {
 398                if (!ctl->sslproto && !ctl->wehaveauthed)
 399                {
 400                    ctl->sslproto = xstrdup("");
 401                    /* repoll immediately */
 402                    return(PS_REPOLL);
 403                }
 404                report(stderr,
 405                       GT_("SSL connection failed.\n"));
 406                return PS_SOCKET;
 407            } else {
 408                if (outlevel >= O_VERBOSE && !ctl->sslproto)
 409                    report(stdout, GT_("%s: opportunistic upgrade to TLS.\n"), realhost);
 410            }
 411            did_stls = TRUE;
 412
 413            /*
 414             * RFC 2595 says this:
 415             *
 416             * "Once TLS has been started, the client MUST discard cached
 417             * information about server capabilities and SHOULD re-issue the
 418             * CAPABILITY command.  This is necessary to protect against
 419             * man-in-the-middle attacks which alter the capabilities list prior
 420             * to STARTTLS.  The server MAY advertise different capabilities
 421             * after STARTTLS."
 422             */
 423            capa_probe(sock, ctl);
 424     }
 425 #endif /* SSL_ENABLE */
 426
 427     /*
 428      * Time to authenticate the user.
 429      * Try the protocol variants that don't require passwords first.
 430      */
 431     ok = PS_AUTHFAIL;
 432
 433 #ifdef GSSAPI
 434     if ((ctl->server.authenticate == A_ANY
 435          || ctl->server.authenticate == A_GSSAPI)
 436         && strstr(capabilities, "AUTH=GSSAPI"))
 437     {
 438         if ((ok = do_gssauth(sock, "AUTHENTICATE", "imap",
 439                         ctl->server.truename, ctl->remotename)))
 440         {
 441             /* SASL cancellation of authentication */
 442             gen_send(sock, "*");
 443             if (ctl->server.authenticate != A_ANY)
 444                 return ok;
 445         } else  {
 446             return ok;
 447         }
 448     }
 449 #endif /* GSSAPI */
 450
 451 #ifdef KERBEROS_V4
 452     if ((ctl->server.authenticate == A_ANY
 453          || ctl->server.authenticate == A_KERBEROS_V4
 454          || ctl->server.authenticate == A_KERBEROS_V5)
 455         && strstr(capabilities, "AUTH=KERBEROS_V4"))
 456     {
 457         if ((ok = do_rfc1731(sock, "AUTHENTICATE", ctl->server.truename)))
 458         {
 459             /* SASL cancellation of authentication */
 460             gen_send(sock, "*");
 461             if(ctl->server.authenticate != A_ANY)
 462                 return ok;
 463         }
 464         else
 465             return ok;
 466     }
 467 #endif /* KERBEROS_V4 */
 468
 469     /*
 470      * No such luck.  OK, now try the variants that mask your password
 471      * in a challenge-response.
 472      */
 473
 474     if ((ctl->server.authenticate == A_ANY && strstr(capabilities, "AUTH=CRAM-MD5"))
 475         || ctl->server.authenticate == A_CRAM_MD5)
 476     {
 477         if ((ok = do_cram_md5 (sock, "AUTHENTICATE", ctl, NULL)))
 478         {
 479             /* SASL cancellation of authentication */
 480             gen_send(sock, "*");
 481             if(ctl->server.authenticate != A_ANY)
 482                 return ok;
 483         }
 484         else
 485             return ok;
 486     }
 487
 488 #ifdef OPIE_ENABLE
 489     if ((ctl->server.authenticate == A_ANY
 490          || ctl->server.authenticate == A_OTP)
 491         && strstr(capabilities, "AUTH=X-OTP")) {
 492         if ((ok = do_otp(sock, "AUTHENTICATE", ctl)))
 493         {
 494             /* SASL cancellation of authentication */
 495             gen_send(sock, "*");
 496             if(ctl->server.authenticate != A_ANY)
 497                 return ok;
 498         } else {
 499             return ok;
 500         }
 501     }
 502 #else
 503     if (ctl->server.authenticate == A_OTP)
 504     {
 505         report(stderr,
 506            GT_("Required OTP capability not compiled into fetchmail\n"));
 507     }
 508 #endif /* OPIE_ENABLE */
 509
 510 #ifdef NTLM_ENABLE
 511     if ((ctl->server.authenticate == A_ANY
 512          || ctl->server.authenticate == A_NTLM)
 513         && strstr (capabilities, "AUTH=NTLM")) {
 514         if ((ok = do_imap_ntlm(sock, ctl)))
 515         {
 516             /* SASL cancellation of authentication */
 517             gen_send(sock, "*");
 518             if(ctl->server.authenticate != A_ANY)
 519                 return ok;
 520         }
 521         else
 522             return(ok);
 523     }
 524 #else
 525     if (ctl->server.authenticate == A_NTLM)
 526     {
 527         report(stderr,
 528            GT_("Required NTLM capability not compiled into fetchmail\n"));
 529     }
 530 #endif /* NTLM_ENABLE */
 531
 532 #ifdef __UNUSED__       /* The Cyrus IMAP4rev1 server chokes on this */
 533     /* this handles either AUTH=LOGIN or AUTH-LOGIN */
 534     if ((imap_version >= IMAP4rev1) && (!strstr(capabilities, "LOGIN")))
 535     {
 536         report(stderr,
 537                GT_("Required LOGIN capability not supported by server\n"));
 538     }
 539 #endif /* __UNUSED__ */
 540
 541     /*
 542      * We're stuck with sending the password en clair.
 543      * The reason for this odd-looking logic is that some
 544      * servers return LOGINDISABLED even though login
 545      * actually works.  So arrange things in such a way that
 546      * setting auth passwd makes it ignore this capability.
 547      */
 548     if((ctl->server.authenticate==A_ANY&&!strstr(capabilities,"LOGINDISABLED"))
 549         || ctl->server.authenticate == A_PASSWORD)
 550     {
 551         /* these sizes guarantee no buffer overflow */
 552         char *remotename, *password;
 553         size_t rnl, pwl;
 554         rnl = 2 * strlen(ctl->remotename) + 1;
 555         pwl = 2 * strlen(ctl->password) + 1;
 556         remotename = xmalloc(rnl);
 557         password = xmalloc(pwl);
 558
 559         imap_canonicalize(remotename, ctl->remotename, rnl);
 560         imap_canonicalize(password, ctl->password, pwl);
 561
 562         snprintf(shroud, sizeof (shroud), "\"%s\"", password);
 563         ok = gen_transact(sock, "LOGIN \"%s\" \"%s\"", remotename, password);
 564         shroud[0] = '\0';
 565         free(password);
 566         free(remotename);
 567 #ifdef SSL_ENABLE
 568         /* this is for servers which claim to support TLS, but actually
 569          * don't! */
 570         if (did_stls && ok == PS_SOCKET && !ctl->sslproto && !ctl->wehaveauthed)
 571         {
 572             ctl->sslproto = xstrdup("");
 573             /* repoll immediately */
 574             ok = PS_REPOLL;
 575         }
 576 #endif
 577         if (ok)
 578         {
 579             /* SASL cancellation of authentication */
 580             gen_send(sock, "*");
 581             if(ctl->server.authenticate != A_ANY)
 582                 return ok;
 583         }
 584         else
 585             return(ok);
 586     }
 587
 588     return(ok);
 589 }
 590
 591 static int internal_expunge(int sock)
 592 /* ship an expunge, resetting associated counters */
 593 {
 594     int ok;
 595
 596     actual_deletions = 0;
 597
 598     if ((ok = gen_transact(sock, "EXPUNGE")))
 599         return(ok);
 600
 601     /* if there is a mismatch between the number of mails which should
 602      * have been expunged and the number of mails actually expunged,
 603      * another email client may be deleting mails. Quit here,
 604      * otherwise fetchmail gets out-of-sync with the imap server,
 605      * reports the wrong size to the SMTP server on MAIL FROM: and
 606      * triggers a "message ... was not the expected length" error on
 607      * every subsequent mail */
 608     if (deletions > 0 && deletions != actual_deletions)
 609     {
 610         report(stderr,
 611                 GT_("mail expunge mismatch (%d actual != %d expected)\n"),
 612                 actual_deletions, deletions);
 613         deletions = 0;
 614         return(PS_ERROR);
 615     }
 616
 617     expunged += deletions;
 618     deletions = 0;
 619
 620 #ifdef IMAP_UID /* not used */
 621     expunge_uids(ctl);
 622 #endif /* IMAP_UID */
 623
 624     return(PS_SUCCESS);
 625 }
 626
 627 static int imap_idle(int sock)
 628 /* start an RFC2177 IDLE, or fake one if unsupported */
 629 {
 630     int ok;
 631
 632     saved_timeout = mytimeout;
 633
 634     if (has_idle) {
 635         /* special timeout to terminate the IDLE and re-issue it
 636          * at least every 28 minutes:
 637          * (the server may have an inactivity timeout) */
 638         mytimeout = 1680; /* 28 min */
 639         stage = STAGE_IDLE;
 640         /* enter IDLE mode */
 641         ok = gen_transact(sock, "IDLE");
 642
 643         if (ok == PS_IDLETIMEOUT) {
 644             /* send "DONE" continuation */
 645             SockWrite(sock, "DONE\r\n", 6);
 646             if (outlevel >= O_MONITOR)
 647                 report(stdout, "IMAP> DONE\n");
 648             /* reset stage and timeout here: we are not idling any more */
 649             mytimeout = saved_timeout;
 650             stage = STAGE_FETCH;
 651             /* get OK IDLE message */
 652             ok = imap_ok(sock, NULL);
 653         }
 654     } else {  /* no idle support, fake it */
 655         /* Note: stage and timeout have not been changed here as NOOP
 656          * does not idle */
 657         ok = gen_transact(sock, "NOOP");
 658
 659         /* no error, but no new mail either */
 660         if (ok == PS_SUCCESS && recentcount == 0)
 661         {
 662             /* There are some servers who do send new mail
 663              * notification out of the blue. This is in compliance
 664              * with RFC 2060 section 5.3. Wait for that with a low
 665              * timeout */
 666             mytimeout = 28;
 667             stage = STAGE_IDLE;
 668             /* We are waiting for notification; no tag needed */
 669             tag[0] = '\0';
 670             /* wait (briefly) for an unsolicited status update */
 671             ok = imap_ok(sock, NULL);
 672             if (ok == PS_IDLETIMEOUT) {
 673                 /* no notification came; ok */
 674                 ok = PS_SUCCESS;
 675             }
 676         }
 677     }
 678
 679     /* restore normal timeout value */
 680     set_timeout(0);
 681     mytimeout = saved_timeout;
 682     stage = STAGE_FETCH;
 683
 684     return(ok);
 685 }
 686
 687 static int imap_getrange(int sock,
 688                          struct query *ctl,
 689                          const char *folder,
 690                          int *countp, int *newp, int *bytes)
 691 /* get range of messages to be fetched */
 692 {
 693     int ok;
 694     char buf[MSGBUFSIZE+1], *cp;
 695
 696     /* find out how many messages are waiting */
 697     *bytes = -1;
 698
 699     if (pass > 1)
 700     {
 701         /* deleted mails have already been expunged by
 702          * end_mailbox_poll().
 703          *
 704          * recentcount is already set here by the last imap command which
 705          * returned EXISTS on detecting new mail. if recentcount is 0, wait
 706          * for new mail.
 707          *
 708          * this is a while loop because imap_idle() might return on other
 709          * mailbox changes also */
 710         while (recentcount == 0 && do_idle) {
 711             smtp_close(ctl, 1);
 712             ok = imap_idle(sock);
 713             if (ok)
 714             {
 715                 report(stderr, GT_("re-poll failed\n"));
 716                 return(ok);
 717             }
 718         }
 719         /* if recentcount is 0, return no mail */
 720         if (recentcount == 0)
 721                 count = 0;
 722         if (outlevel >= O_DEBUG)
 723             report(stdout, ngettext("%d message waiting after re-poll\n",
 724                                     "%d messages waiting after re-poll\n",
 725                                     count), count);
 726     }
 727     else
 728     {
 729         oldcount = count = 0;
 730         ok = gen_transact(sock,
 731                           check_only ? "EXAMINE \"%s\"" : "SELECT \"%s\"",
 732                           folder ? folder : "INBOX");
 733         /* imap_ok returns PS_LOCKBUSY for READ-ONLY folders,
 734          * which we can safely use in fetchall keep only */
 735         if (ok == PS_LOCKBUSY && ctl->fetchall && ctl-> keep)
 736             ok = 0;
 737
 738         if (ok != 0)
 739         {
 740             report(stderr, GT_("mailbox selection failed\n"));
 741             return(ok);
 742         }
 743         else if (outlevel >= O_DEBUG)
 744             report(stdout, ngettext("%d message waiting after first poll\n",
 745                                     "%d messages waiting after first poll\n",
 746                                     count), count);
 747
 748         /*
 749          * We should have an expunge here to
 750          * a) avoid fetching deleted mails during 'fetchall'
 751          * b) getting a wrong count of mails during 'no fetchall'
 752          */
 753         if (!check_only && !ctl->keep && count > 0)
 754         {
 755             ok = internal_expunge(sock);
 756             if (ok)
 757             {
 758                 report(stderr, GT_("expunge failed\n"));
 759                 return(ok);
 760             }
 761             if (outlevel >= O_DEBUG)
 762                 report(stdout, ngettext("%d message waiting after expunge\n",
 763                                         "%d messages waiting after expunge\n",
 764                                         count), count);
 765         }
 766
 767         if (count == 0 && do_idle)
 768         {
 769             /* no messages?  then we may need to idle until we get some */
 770             while (count == 0) {
 771                 ok = imap_idle(sock);
 772                 if (ok)
 773                 {
 774                     report(stderr, GT_("re-poll failed\n"));
 775                     return(ok);
 776                 }
 777             }
 778             if (outlevel >= O_DEBUG)
 779                 report(stdout, ngettext("%d message waiting after re-poll\n",
 780                                         "%d messages waiting after re-poll\n",
 781                                         count), count);
 782         }
 783     }
 784
 785     *countp = oldcount = count;
 786     recentcount = 0;
 787     startcount = 1;
 788
 789     /* OK, now get a count of unseen messages and their indices */
 790     if (!ctl->fetchall && count > 0)
 791     {
 792         if (unseen_messages)
 793             free(unseen_messages);
 794         unseen_messages = (unsigned int *)xmalloc(count * sizeof(unsigned int));
 795         memset(unseen_messages, 0, count * sizeof(unsigned int));
 796         unseen = 0;
 797
 798         /* don't count deleted messages, in case user enabled keep last time */
 799         gen_send(sock, "SEARCH UNSEEN NOT DELETED");
 800         do {
 801             ok = gen_recv(sock, buf, sizeof(buf));
 802             if (ok != 0)
 803             {
 804                 report(stderr, GT_("search for unseen messages failed\n"));
 805                 return(PS_PROTOCOL);
 806             }
 807             else if ((cp = strstr(buf, "* SEARCH")))
 808             {
 809                 char    *ep;
 810
 811                 cp += 8;        /* skip "* SEARCH" */
 812                 /* startcount is higher than count so that if there are no
 813                  * unseen messages, imap_getsizes() will not need to do
 814                  * anything! */
 815                 startcount = count + 1;
 816
 817                 while (*cp && unseen < count)
 818                 {
 819                     /* skip whitespace */
 820                     while (*cp && isspace((unsigned char)*cp))
 821                         cp++;
 822                     if (*cp)
 823                     {
 824                         unsigned long um;
 825
 826                         errno = 0;
 827                         um = strtoul(cp,&ep,10);
 828                         if (errno == 0 && um <= UINT_MAX && um <= (unsigned)count)
 829                         {
 830                             unseen_messages[unseen++] = um;
 831                             if (outlevel >= O_DEBUG)
 832                                 report(stdout, GT_("%lu is unseen\n"), um);
 833                             if (startcount > um)
 834                                 startcount = um;
 835                         }
 836                         cp = ep;
 837                     }
 838                 }
 839             }
 840         } while
 841             (tag[0] != '\0' && strncmp(buf, tag, strlen(tag)));
 842
 843         if (outlevel >= O_DEBUG && unseen > 0)
 844             report(stdout, GT_("%u is first unseen\n"), startcount);
 845     } else
 846         unseen = -1;
 847
 848     *newp = unseen;
 849     expunged = 0;
 850     deletions = 0;
 851
 852     return(PS_SUCCESS);
 853 }
 854
 855 static int imap_getpartialsizes(int sock, int first, int last, int *sizes)
 856 /* capture the sizes of messages #first-#last */
 857 {
 858     char buf [MSGBUFSIZE+1];
 859
 860     /*
 861      * Some servers (as in, PMDF5.1-9.1 under OpenVMS 6.1)
 862      * won't accept 1:1 as valid set syntax.  Some implementors
 863      * should be taken out and shot for excessive anality.
 864      *
 865      * Microsoft Exchange (brain-dead piece of crap that it is)
 866      * sometimes gets its knickers in a knot about bodiless messages.
 867      * You may see responses like this:
 868      *
 869      *  fetchmail: IMAP> A0004 FETCH 1:9 RFC822.SIZE
 870      *  fetchmail: IMAP< * 2 FETCH (RFC822.SIZE 1187)
 871      *  fetchmail: IMAP< * 3 FETCH (RFC822.SIZE 3954)
 872      *  fetchmail: IMAP< * 4 FETCH (RFC822.SIZE 1944)
 873      *  fetchmail: IMAP< * 5 FETCH (RFC822.SIZE 2933)
 874      *  fetchmail: IMAP< * 6 FETCH (RFC822.SIZE 1854)
 875      *  fetchmail: IMAP< * 7 FETCH (RFC822.SIZE 34054)
 876      *  fetchmail: IMAP< * 8 FETCH (RFC822.SIZE 5561)
 877      *  fetchmail: IMAP< * 9 FETCH (RFC822.SIZE 1101)
 878      *  fetchmail: IMAP< A0004 NO The requested item could not be found.
 879      *
 880      * This means message 1 has only headers.  For kicks and grins
 881      * you can telnet in and look:
 882      *  A003 FETCH 1 FULL
 883      *  A003 NO The requested item could not be found.
 884      *  A004 fetch 1 rfc822.header
 885      *  A004 NO The requested item could not be found.
 886      *  A006 FETCH 1 BODY
 887      *  * 1 FETCH (BODY ("TEXT" "PLAIN" ("CHARSET" "US-ASCII") NIL NIL "7BIT" 35 3))
 888      *  A006 OK FETCH completed.
 889      *
 890      * To get around this, we terminate the read loop on a NO and count
 891      * on the fact that the sizes array has been preinitialized with a
 892      * known-bad size value.
 893      */
 894
 895     /* expunges change the fetch numbers */
 896     first -= expunged;
 897     last -= expunged;
 898
 899     if (last == first)
 900         gen_send(sock, "FETCH %d RFC822.SIZE", last);
 901     else if (last > first)
 902         gen_send(sock, "FETCH %d:%d RFC822.SIZE", first, last);
 903     else /* no unseen messages! */
 904         return(PS_SUCCESS);
 905     for (;;)
 906     {
 907         unsigned int size;
 908         int ok, num;
 909         char *cp;
 910
 911         if ((ok = gen_recv(sock, buf, sizeof(buf))))
 912             return(ok);
 913         /* we want response matching to be case-insensitive */
 914         for (cp = buf; *cp; cp++)
 915             *cp = toupper((unsigned char)*cp);
 916         /* an untagged NO means that a message was not readable */
 917         if (strstr(buf, "* NO"))
 918             ;
 919         else if (strstr(buf, "OK") || strstr(buf, "NO"))
 920             break;
 921         else if (sscanf(buf, "* %d FETCH (RFC822.SIZE %u)", &num, &size) == 2
 922         /* some servers (like mail.internode.on.net bld-mail04) return UID information here
 923          *
 924          * IMAP> A0005 FETCH 1 RFC822.SIZE
 925          * IMAP< * 1 FETCH (UID 16 RFC822.SIZE 1447)
 926          * IMAP< A0005 OK FETCH completed
 927          *
 928          */
 929                 || sscanf(buf, "* %d FETCH (UID %*s RFC822.SIZE %u)", &num, &size) == 2)
 930         {
 931             if (num >= first && num <= last)
 932                 sizes[num - first] = size;
 933             else
 934                 report(stderr,
 935                         GT_("Warning: ignoring bogus data for message sizes returned by the server.\n"));
 936         }
 937     }
 938
 939     return(PS_SUCCESS);
 940 }
 941
 942 static int imap_getsizes(int sock, int count, int *sizes)
 943 /* capture the sizes of all messages */
 944 {
 945     return imap_getpartialsizes(sock, 1, count, sizes);
 946 }
 947
 948 static int imap_is_old(int sock, struct query *ctl, int number)
 949 /* is the given message old? */
 950 {
 951     flag seen = TRUE;
 952     int i;
 953
 954     (void)sock;
 955     (void)ctl;
 956     /*
 957      * Expunges change the fetch numbers, but unseen_messages contains
 958      * indices from before any expungees were done.  So neither the
 959      * argument nor the values in message_sequence need to be decremented.
 960      */
 961
 962     seen = TRUE;
 963     for (i = 0; i < unseen; i++)
 964         if (unseen_messages[i] == (unsigned)number)
 965         {
 966             seen = FALSE;
 967             break;
 968         }
 969
 970     return(seen);
 971 }
 972
 973 static char *skip_token(char *ptr)
 974 {
 975     while(isspace((unsigned char)*ptr)) ptr++;
 976     while(!isspace((unsigned char)*ptr) && !iscntrl((unsigned char)*ptr)) ptr++;
 977     while(isspace((unsigned char)*ptr)) ptr++;
 978     return(ptr);
 979 }
 980
 981 static int imap_fetch_headers(int sock, struct query *ctl,int number,int *lenp)
 982 /* request headers of nth message */
 983 {
 984     char buf [MSGBUFSIZE+1];
 985     int num;
 986
 987     (void)ctl;
 988     /* expunges change the fetch numbers */
 989     number -= expunged;
 990
 991     /*
 992      * This is blessed by RFC1176, RFC1730, RFC2060.
 993      * According to the RFCs, it should *not* set the \Seen flag.
 994      */
 995     gen_send(sock, "FETCH %d RFC822.HEADER", number);
 996
 997     /* looking for FETCH response */
 998     for (;;)
 999     {
1000         int     ok;
1001         char    *ptr;
1002
1003         if ((ok = gen_recv(sock, buf, sizeof(buf))))
1004             return(ok);
1005         ptr = skip_token(buf);  /* either "* " or "AXXXX " */
1006         if (sscanf(ptr, "%d FETCH (RFC822.HEADER {%d}", &num, lenp) == 2
1007         /* some servers (like mail.internode.on.net bld-mail04) return UID information here
1008          *
1009          * IMAP> A0006 FETCH 1 RFC822.HEADER
1010          * IMAP< * 1 FETCH (UID 16 RFC822.HEADER {1360}
1011          * ...
1012          * IMAP< )
1013          * IMAP< A0006 OK FETCH completed
1014          *
1015          */
1016                 || sscanf(ptr, "%d FETCH (UID %*s RFC822.HEADER {%d}", &num, lenp) == 2)
1017             break;
1018         /* try to recover from chronically fucked-up M$ Exchange servers */
1019         else if (!strncmp(ptr, "NO", 2))
1020         {
1021             /* wait for a tagged response */
1022             if (strstr (buf, "* NO"))
1023                 imap_ok (sock, 0);
1024             return(PS_TRANSIENT);
1025         }
1026         else if (!strncmp(ptr, "BAD", 3))
1027         {
1028             /* wait for a tagged response */
1029             if (strstr (buf, "* BAD"))
1030                 imap_ok (sock, 0);
1031             return(PS_TRANSIENT);
1032         }
1033     }
1034
1035     if (num != number)
1036         return(PS_ERROR);
1037     else
1038         return(PS_SUCCESS);
1039 }
1040
1041 static int imap_fetch_body(int sock, struct query *ctl, int number, int *lenp)
1042 /* request body of nth message */
1043 {
1044     char buf [MSGBUFSIZE+1], *cp;
1045     int num;
1046
1047     (void)ctl;
1048     /* expunges change the fetch numbers */
1049     number -= expunged;
1050
1051     /*
1052      * If we're using IMAP4, we can fetch the message without setting its
1053      * seen flag.  This is good!  It means that if the protocol exchange
1054      * craps out during the message, it will still be marked `unseen' on
1055      * the server.
1056      *
1057      * According to RFC2060, and Mark Crispin the IMAP maintainer,
1058      * FETCH %d BODY[TEXT] and RFC822.TEXT are "functionally
1059      * equivalent".  However, we know of at least one server that
1060      * treats them differently in the presence of MIME attachments;
1061      * the latter form downloads the attachment, the former does not.
1062      * The server is InterChange, and the fool who implemented this
1063      * misfeature ought to be strung up by his thumbs.
1064      *
1065      * When I tried working around this by disabling use of the 4rev1 form,
1066      * I found that doing this breaks operation with M$ Exchange.
1067      * Annoyingly enough, Exchange's refusal to cope is technically legal
1068      * under RFC2062.  Trust Microsoft, the Great Enemy of interoperability
1069      * standards, to find a way to make standards compliance irritating....
1070      */
1071     switch (imap_version)
1072     {
1073     case IMAP4rev1:     /* RFC 2060 */
1074         gen_send(sock, "FETCH %d BODY.PEEK[TEXT]", number);
1075         break;
1076
1077     case IMAP4:         /* RFC 1730 */
1078         gen_send(sock, "FETCH %d RFC822.TEXT.PEEK", number);
1079         break;
1080
1081     default:            /* RFC 1176 */
1082         gen_send(sock, "FETCH %d RFC822.TEXT", number);
1083         break;
1084     }
1085
1086     /* looking for FETCH response */
1087     do {
1088         int     ok;
1089
1090         if ((ok = gen_recv(sock, buf, sizeof(buf))))
1091             return(ok);
1092     } while
1093         (!strstr(buf+4, "FETCH") || sscanf(buf+2, "%d", &num) != 1);
1094
1095     if (num != number)
1096         return(PS_ERROR);
1097
1098     /*
1099      * Try to extract a length from the FETCH response.  RFC2060 requires
1100      * it to be present, but at least one IMAP server (Novell GroupWise)
1101      * botches this.  The overflow check is needed because of a broken
1102      * server called dbmail that returns huge garbage lengths.
1103      */
1104     if ((cp = strchr(buf, '{'))) {
1105         errno = 0;
1106         *lenp = (int)strtol(cp + 1, (char **)NULL, 10);
1107         if (errno == ERANGE || *lenp < 0)
1108             *lenp = -1;    /* length is too big/small for us to handle */
1109     }
1110     else
1111         *lenp = -1;     /* missing length part in FETCH reponse */
1112
1113     return(PS_SUCCESS);
1114 }
1115
1116 static int imap_trail(int sock, struct query *ctl, const char *tag)
1117 /* discard tail of FETCH response after reading message text */
1118 {
1119     /* expunges change the fetch numbers */
1120     /* number -= expunged; */
1121
1122     (void)ctl;
1123     for (;;)
1124     {
1125         char buf[MSGBUFSIZE+1], *t;
1126         int ok;
1127
1128         if ((ok = gen_recv(sock, buf, sizeof(buf))))
1129             return(ok);
1130
1131         /* UW IMAP returns "OK FETCH", Cyrus returns "OK Completed" */
1132         if (strncmp(buf, tag, strlen(tag)) == 0) {
1133             t = buf + strlen(tag);
1134             t += strspn(t, " \t");
1135             if (strncmp(t, "OK", 2) == 0)
1136                 break;
1137         }
1138     }
1139
1140     return(PS_SUCCESS);
1141 }
1142
1143 static int imap_delete(int sock, struct query *ctl, int number)
1144 /* set delete flag for given message */
1145 {
1146     int ok;
1147
1148     (void)ctl;
1149     /* expunges change the fetch numbers */
1150     number -= expunged;
1151
1152     /*
1153      * Use SILENT if possible as a minor throughput optimization.
1154      * Note: this has been dropped from IMAP4rev1.
1155      *
1156      * We set Seen because there are some IMAP servers (notably HP
1157      * OpenMail) that do message-receipt DSNs, but only when the seen
1158      * bit is set.  This is the appropriate time -- we get here right
1159      * after the local SMTP response that says delivery was
1160      * successful.
1161      */
1162     if ((ok = gen_transact(sock,
1163                         imap_version == IMAP4
1164                                 ? "STORE %d +FLAGS.SILENT (\\Seen \\Deleted)"
1165                                 : "STORE %d +FLAGS (\\Seen \\Deleted)",
1166                         number)))
1167         return(ok);
1168     else
1169         deletions++;
1170
1171     /*
1172      * We do an expunge after expunge_period messages, rather than
1173      * just before quit, so that a line hit during a long session
1174      * won't result in lots of messages being fetched again during
1175      * the next session.
1176      */
1177     if (NUM_NONZERO(expunge_period) && (deletions % expunge_period) == 0)
1178     {
1179         if ((ok = internal_expunge(sock)))
1180             return(ok);
1181     }
1182
1183     return(PS_SUCCESS);
1184 }
1185
1186 static int imap_mark_seen(int sock, struct query *ctl, int number)
1187 /* mark the given message as seen */
1188 {
1189     (void)ctl;
1190     return(gen_transact(sock,
1191         imap_version == IMAP4
1192         ? "STORE %d +FLAGS.SILENT (\\Seen)"
1193         : "STORE %d +FLAGS (\\Seen)",
1194         number));
1195 }
1196
1197 static int imap_end_mailbox_poll(int sock, struct query *ctl)
1198 /* cleanup mailbox before we idle or switch to another one */
1199 {
1200     (void)ctl;
1201     if (deletions)
1202         internal_expunge(sock);
1203     return(PS_SUCCESS);
1204 }
1205
1206 static int imap_logout(int sock, struct query *ctl)
1207 /* send logout command */
1208 {
1209     (void)ctl;
1210     /* if any un-expunged deletions remain, ship an expunge now */
1211     if (deletions)
1212         internal_expunge(sock);
1213
1214 #ifdef USE_SEARCH
1215     /* Memory clean-up */
1216     if (unseen_messages)
1217         free(unseen_messages);
1218 #endif /* USE_SEARCH */
1219
1220     return(gen_transact(sock, "LOGOUT"));
1221 }
1222
1223 static const struct method imap =
1224 {
1225     "IMAP",             /* Internet Message Access Protocol */
1226     "imap",             /* service (plain and TLS) */
1227     "imaps",            /* service (SSL) */
1228     TRUE,               /* this is a tagged protocol */
1229     FALSE,              /* no message delimiter */
1230     imap_ok,            /* parse command response */
1231     imap_getauth,       /* get authorization */
1232     imap_getrange,      /* query range of messages */
1233     imap_getsizes,      /* get sizes of messages (used for ESMTP SIZE option) */
1234     imap_getpartialsizes,       /* get sizes of subset of messages (used for ESMTP SIZE option) */
1235     imap_is_old,        /* no UID check */
1236     imap_fetch_headers, /* request given message headers */
1237     imap_fetch_body,    /* request given message body */
1238     imap_trail,         /* eat message trailer */
1239     imap_delete,        /* delete the message */
1240     imap_mark_seen,     /* how to mark a message as seen */
1241     imap_end_mailbox_poll,      /* end-of-mailbox processing */
1242     imap_logout,        /* expunge and exit */
1243     TRUE,               /* yes, we can re-poll */
1244 };
1245
1246 int doIMAP(struct query *ctl)
1247 /* retrieve messages using IMAP Version 2bis or Version 4 */
1248 {
1249     return(do_protocol(ctl, &imap));
1250 }
1251
1252 /* imap.c ends here */