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 #endif
  15 #include  "fetchmail.h"
  16 #include  "socket.h"
  17
  18 #ifdef KERBEROS_V4
  19 #ifdef KERBEROS_V5
  20 #include <kerberosIV/des.h>
  21 #include <kerberosIV/krb.h>
  22 #else
  23 #if defined (__bsdi__)
  24 #include <des.h>
  25 #define krb_get_err_text(e) (krb_err_txt[e])
  26 #endif
  27 #if defined(__NetBSD__) || (__FreeBSD__) || defined(__linux__)
  28 #define krb_get_err_text(e) (krb_err_txt[e])
  29 #endif
  30 #include <krb.h>
  31 #endif
  32 #endif /* KERBEROS_V4 */
  33 #include  "i18n.h"
  34
  35 #ifdef GSSAPI
  36 #ifdef HAVE_GSSAPI_H
  37 #include <gssapi.h>
  38 #endif
  39 #ifdef HAVE_GSSAPI_GSSAPI_H
  40 #include <gssapi/gssapi.h>
  41 #endif
  42 #ifdef HAVE_GSSAPI_GSSAPI_GENERIC_H
  43 #include <gssapi/gssapi_generic.h>
  44 #endif
  45 #ifndef HAVE_GSS_C_NT_HOSTBASED_SERVICE
  46 #define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
  47 #endif
  48 #endif
  49
  50 #include "md5.h"
  51
  52 #if OPIE_ENABLE
  53 #include <opie.h>
  54 #endif /* OPIE_ENABLE */
  55
  56 #ifndef strstr          /* glibc-2.1 declares this as a macro */
  57 extern char *strstr();  /* needed on sysV68 R3V7.1. */
  58 #endif /* strstr */
  59
  60 /* imap_version values */
  61 #define IMAP2           -1      /* IMAP2 or IMAP2BIS, RFC1176 */
  62 #define IMAP4           0       /* IMAP4 rev 0, RFC1730 */
  63 #define IMAP4rev1       1       /* IMAP4 rev 1, RFC2060 */
  64
  65 static int count, seen, recent, unseen, deletions, imap_version, preauth;
  66 static int expunged, expunge_period;
  67 static flag do_idle, idling;
  68 static char capabilities[MSGBUFSIZE+1];
  69
  70 int imap_ok(int sock, char *argbuf)
  71 /* parse command response */
  72 {
  73     char buf [MSGBUFSIZE+1];
  74
  75     seen = 0;
  76     do {
  77         int     ok;
  78         char    *cp;
  79
  80         if ((ok = gen_recv(sock, buf, sizeof(buf))))
  81             return(ok);
  82
  83         /* all tokens in responses are caseblind */
  84         for (cp = buf; *cp; cp++)
  85             if (islower(*cp))
  86                 *cp = toupper(*cp);
  87
  88         /* interpret untagged status responses */
  89         if (strstr(buf, "* CAPABILITY"))
  90             strncpy(capabilities, buf + 12, sizeof(capabilities));
  91         if (strstr(buf, "EXISTS"))
  92         {
  93             count = atoi(buf+2);
  94             /*
  95              * Nasty kluge to handle RFC2177 IDLE.  If we know we're idling
  96              * we can't wait for the tag matching the IDLE; we have to tell the
  97              * server the IDLE is finished by shipping back a DONE when we
  98              * see an EXISTS.  Only after that will a tagged response be
  99              * shipped.  The idling flag also gets cleared on a timeout.
 100              */
 101             if (idling)
 102             {
 103                 /* we do our own write and report here to disable tagging */
 104                 SockWrite(sock, "DONE\r\n", 6);
 105                 if (outlevel >= O_MONITOR)
 106                     report(stdout, "IMAP> DONE\n");
 107
 108                 idling = FALSE;
 109             }
 110         }
 111         if (strstr(buf, "RECENT"))
 112             recent = atoi(buf+2);
 113         if (strstr(buf, "UNSEEN"))
 114         {
 115             char        *cp;
 116
 117             /*
 118              * Handle both "* 42 UNSEEN" (if tha ever happens) and
 119              * "* OK [UNSEEN 42] 42". Note that what this gets us is
 120              * a minimum index, not a count.
 121              */
 122             unseen = 0;
 123             for (cp = buf; *cp && !isdigit(*cp); cp++)
 124                 continue;
 125             unseen = atoi(cp);
 126         }
 127         if (strstr(buf, "FLAGS"))
 128             seen = (strstr(buf, "SEEN") != (char *)NULL);
 129         if (strstr(buf, "PREAUTH"))
 130             preauth = TRUE;
 131     } while
 132         (tag[0] != '\0' && strncmp(buf, tag, strlen(tag)));
 133
 134     if (tag[0] == '\0')
 135     {
 136         if (argbuf)
 137             strcpy(argbuf, buf);
 138         return(PS_SUCCESS);
 139     }
 140     else
 141     {
 142         char    *cp;
 143
 144         /* skip the tag */
 145         for (cp = buf; !isspace(*cp); cp++)
 146             continue;
 147         while (isspace(*cp))
 148             cp++;
 149
 150         if (strncmp(cp, "PREAUTH", 2) == 0)
 151         {
 152             if (argbuf)
 153                 strcpy(argbuf, cp);
 154             preauth = TRUE;
 155             return(PS_SUCCESS);
 156         }
 157         else if (strncmp(cp, "OK", 2) == 0)
 158         {
 159             if (argbuf)
 160                 strcpy(argbuf, cp);
 161             return(PS_SUCCESS);
 162         }
 163         else if (strncmp(cp, "BAD", 3) == 0)
 164             return(PS_ERROR);
 165         else if (strncmp(cp, "NO", 2) == 0)
 166         {
 167             if (stage == STAGE_GETAUTH)
 168                 return(PS_AUTHFAIL);    /* RFC2060, 6.2.2 */
 169             else
 170                 return(PS_ERROR);
 171         }
 172         else
 173             return(PS_PROTOCOL);
 174     }
 175 }
 176
 177 #if OPIE_ENABLE
 178 static int do_otp(int sock, struct query *ctl)
 179 {
 180     int i, rval;
 181     char buffer[128];
 182     char challenge[OPIE_CHALLENGE_MAX+1];
 183     char response[OPIE_RESPONSE_MAX+1];
 184
 185     gen_send(sock, "AUTHENTICATE X-OTP");
 186
 187     if (rval = gen_recv(sock, buffer, sizeof(buffer)))
 188         return rval;
 189
 190     if ((i = from64tobits(challenge, buffer)) < 0) {
 191         report(stderr, _("Could not decode initial BASE64 challenge\n"));
 192         return PS_AUTHFAIL;
 193     };
 194
 195
 196     to64frombits(buffer, ctl->remotename, strlen(ctl->remotename));
 197
 198     if (outlevel >= O_MONITOR)
 199         report(stdout, "IMAP> %s\n", buffer);
 200
 201     /* best not to count on the challenge code handling multiple writes */
 202     strcat(buffer, "\r\n");
 203     SockWrite(sock, buffer, strlen(buffer));
 204
 205     if (rval = gen_recv(sock, buffer, sizeof(buffer)))
 206         return rval;
 207
 208     if ((i = from64tobits(challenge, buffer)) < 0) {
 209         report(stderr, _("Could not decode OTP challenge\n"));
 210         return PS_AUTHFAIL;
 211     };
 212
 213     rval = opiegenerator(challenge, !strcmp(ctl->password, "opie") ? "" : ctl->password, response);
 214     if ((rval == -2) && !run.poll_interval) {
 215         char secret[OPIE_SECRET_MAX+1];
 216         fprintf(stderr, _("Secret pass phrase: "));
 217         if (opiereadpass(secret, sizeof(secret), 0))
 218             rval = opiegenerator(challenge, secret, response);
 219         memset(secret, 0, sizeof(secret));
 220     };
 221
 222     if (rval)
 223         return(PS_AUTHFAIL);
 224
 225     to64frombits(buffer, response, strlen(response));
 226
 227     if (outlevel >= O_MONITOR)
 228         report(stdout, "IMAP> %s\n", buffer);
 229     strcat(buffer, "\r\n");
 230     SockWrite(sock, buffer, strlen(buffer));
 231
 232     if (rval = gen_recv(sock, buffer, sizeof(buffer)))
 233         return rval;
 234
 235     if (strstr(buffer, "OK"))
 236         return PS_SUCCESS;
 237     else
 238         return PS_AUTHFAIL;
 239 };
 240 #endif /* OPIE_ENABLE */
 241
 242 #ifdef KERBEROS_V4
 243 #if SIZEOF_INT == 4
 244 typedef int     int32;
 245 #elif SIZEOF_SHORT == 4
 246 typedef short   int32;
 247 #elif SIZEOF_LONG == 4
 248 typedef long    int32;
 249 #else
 250 #error Cannot deduce a 32-bit-type
 251 #endif
 252
 253 static int do_rfc1731(int sock, char *truename)
 254 /* authenticate as per RFC1731 -- note 32-bit integer requirement here */
 255 {
 256     int result = 0, len;
 257     char buf1[4096], buf2[4096];
 258     union {
 259       int32 cint;
 260       char cstr[4];
 261     } challenge1, challenge2;
 262     char srvinst[INST_SZ];
 263     char *p;
 264     char srvrealm[REALM_SZ];
 265     KTEXT_ST authenticator;
 266     CREDENTIALS credentials;
 267     char tktuser[MAX_K_NAME_SZ+1+INST_SZ+1+REALM_SZ+1];
 268     char tktinst[INST_SZ];
 269     char tktrealm[REALM_SZ];
 270     des_cblock session;
 271     des_key_schedule schedule;
 272
 273     gen_send(sock, "AUTHENTICATE KERBEROS_V4");
 274
 275     /* The data encoded in the first ready response contains a random
 276      * 32-bit number in network byte order.  The client should respond
 277      * with a Kerberos ticket and an authenticator for the principal
 278      * "imap.hostname@realm", where "hostname" is the first component
 279      * of the host name of the server with all letters in lower case
 280      * and where "realm" is the Kerberos realm of the server.  The
 281      * encrypted checksum field included within the Kerberos
 282      * authenticator should contain the server provided 32-bit number
 283      * in network byte order.
 284      */
 285
 286     if (result = gen_recv(sock, buf1, sizeof buf1)) {
 287         return result;
 288     }
 289
 290     len = from64tobits(challenge1.cstr, buf1);
 291     if (len < 0) {
 292         report(stderr, _("could not decode initial BASE64 challenge\n"));
 293         return PS_AUTHFAIL;
 294     }
 295
 296     /* this patch by Dan Root <dar@thekeep.org> solves an endianess
 297      * problem. */
 298     {
 299         char tmp[4];
 300
 301         *(int *)tmp = ntohl(*(int *) challenge1.cstr);
 302         memcpy(challenge1.cstr, tmp, sizeof(tmp));
 303     }
 304
 305     /* Client responds with a Kerberos ticket and an authenticator for
 306      * the principal "imap.hostname@realm" where "hostname" is the
 307      * first component of the host name of the server with all letters
 308      * in lower case and where "realm" is the Kerberos realm of the
 309      * server.  The encrypted checksum field included within the
 310      * Kerberos authenticator should contain the server-provided
 311      * 32-bit number in network byte order.
 312      */
 313
 314     strncpy(srvinst, truename, (sizeof srvinst)-1);
 315     srvinst[(sizeof srvinst)-1] = '\0';
 316     for (p = srvinst; *p; p++) {
 317       if (isupper(*p)) {
 318         *p = tolower(*p);
 319       }
 320     }
 321
 322     strncpy(srvrealm, (char *)krb_realmofhost(srvinst), (sizeof srvrealm)-1);
 323     srvrealm[(sizeof srvrealm)-1] = '\0';
 324     if (p = strchr(srvinst, '.')) {
 325       *p = '\0';
 326     }
 327
 328     result = krb_mk_req(&authenticator, "imap", srvinst, srvrealm, 0);
 329     if (result) {
 330         report(stderr, "krb_mq_req: %s\n", krb_get_err_text(result));
 331         return PS_AUTHFAIL;
 332     }
 333
 334     result = krb_get_cred("imap", srvinst, srvrealm, &credentials);
 335     if (result) {
 336         report(stderr, "krb_get_cred: %s\n", krb_get_err_text(result));
 337         return PS_AUTHFAIL;
 338     }
 339
 340     memcpy(session, credentials.session, sizeof session);
 341     memset(&credentials, 0, sizeof credentials);
 342     des_key_sched(&session, schedule);
 343
 344     result = krb_get_tf_fullname(TKT_FILE, tktuser, tktinst, tktrealm);
 345     if (result) {
 346         report(stderr, "krb_get_tf_fullname: %s\n", krb_get_err_text(result));
 347         return PS_AUTHFAIL;
 348     }
 349
 350     if (strcmp(tktuser, user) != 0) {
 351         report(stderr,
 352                _("principal %s in ticket does not match -u %s\n"), tktuser,
 353                 user);
 354         return PS_AUTHFAIL;
 355     }
 356
 357     if (tktinst[0]) {
 358         report(stderr,
 359                _("non-null instance (%s) might cause strange behavior\n"),
 360                 tktinst);
 361         strcat(tktuser, ".");
 362         strcat(tktuser, tktinst);
 363     }
 364
 365     if (strcmp(tktrealm, srvrealm) != 0) {
 366         strcat(tktuser, "@");
 367         strcat(tktuser, tktrealm);
 368     }
 369
 370     result = krb_mk_req(&authenticator, "imap", srvinst, srvrealm,
 371             challenge1.cint);
 372     if (result) {
 373         report(stderr, "krb_mq_req: %s\n", krb_get_err_text(result));
 374         return PS_AUTHFAIL;
 375     }
 376
 377     to64frombits(buf1, authenticator.dat, authenticator.length);
 378     if (outlevel >= O_MONITOR) {
 379         report(stdout, "IMAP> %s\n", buf1);
 380     }
 381     strcat(buf1, "\r\n");
 382     SockWrite(sock, buf1, strlen(buf1));
 383
 384     /* Upon decrypting and verifying the ticket and authenticator, the
 385      * server should verify that the contained checksum field equals
 386      * the original server provided random 32-bit number.  Should the
 387      * verification be successful, the server must add one to the
 388      * checksum and construct 8 octets of data, with the first four
 389      * octets containing the incremented checksum in network byte
 390      * order, the fifth octet containing a bit-mask specifying the
 391      * protection mechanisms supported by the server, and the sixth
 392      * through eighth octets containing, in network byte order, the
 393      * maximum cipher-text buffer size the server is able to receive.
 394      * The server must encrypt the 8 octets of data in the session key
 395      * and issue that encrypted data in a second ready response.  The
 396      * client should consider the server authenticated if the first
 397      * four octets the un-encrypted data is equal to one plus the
 398      * checksum it previously sent.
 399      */
 400
 401     if (result = gen_recv(sock, buf1, sizeof buf1))
 402         return result;
 403
 404     /* The client must construct data with the first four octets
 405      * containing the original server-issued checksum in network byte
 406      * order, the fifth octet containing the bit-mask specifying the
 407      * selected protection mechanism, the sixth through eighth octets
 408      * containing in network byte order the maximum cipher-text buffer
 409      * size the client is able to receive, and the following octets
 410      * containing a user name string.  The client must then append
 411      * from one to eight octets so that the length of the data is a
 412      * multiple of eight octets. The client must then PCBC encrypt the
 413      * data with the session key and respond to the second ready
 414      * response with the encrypted data.  The server decrypts the data
 415      * and verifies the contained checksum.  The username field
 416      * identifies the user for whom subsequent IMAP operations are to
 417      * be performed; the server must verify that the principal
 418      * identified in the Kerberos ticket is authorized to connect as
 419      * that user.  After these verifications, the authentication
 420      * process is complete.
 421      */
 422
 423     len = from64tobits(buf2, buf1);
 424     if (len < 0) {
 425         report(stderr, _("could not decode BASE64 ready response\n"));
 426         return PS_AUTHFAIL;
 427     }
 428
 429     des_ecb_encrypt((des_cblock *)buf2, (des_cblock *)buf2, schedule, 0);
 430     memcpy(challenge2.cstr, buf2, 4);
 431     if (ntohl(challenge2.cint) != challenge1.cint + 1) {
 432         report(stderr, _("challenge mismatch\n"));
 433         return PS_AUTHFAIL;
 434     }
 435
 436     memset(authenticator.dat, 0, sizeof authenticator.dat);
 437
 438     result = htonl(challenge1.cint);
 439     memcpy(authenticator.dat, &result, sizeof result);
 440
 441     /* The protection mechanisms and their corresponding bit-masks are as
 442      * follows:
 443      *
 444      * 1 No protection mechanism
 445      * 2 Integrity (krb_mk_safe) protection
 446      * 4 Privacy (krb_mk_priv) protection
 447      */
 448     authenticator.dat[4] = 1;
 449
 450     len = strlen(tktuser);
 451     strncpy(authenticator.dat+8, tktuser, len);
 452     authenticator.length = len + 8 + 1;
 453     while (authenticator.length & 7) {
 454         authenticator.length++;
 455     }
 456     des_pcbc_encrypt((des_cblock *)authenticator.dat,
 457             (des_cblock *)authenticator.dat, authenticator.length, schedule,
 458             &session, 1);
 459
 460     to64frombits(buf1, authenticator.dat, authenticator.length);
 461     if (outlevel >= O_MONITOR) {
 462         report(stdout, "IMAP> %s\n", buf1);
 463     }
 464
 465     strcat(buf1, "\r\n");
 466     SockWrite(sock, buf1, strlen(buf1));
 467
 468     if (result = gen_recv(sock, buf1, sizeof buf1))
 469         return result;
 470
 471     if (strstr(buf1, "OK")) {
 472         return PS_SUCCESS;
 473     }
 474     else {
 475         return PS_AUTHFAIL;
 476     }
 477 }
 478 #endif /* KERBEROS_V4 */
 479
 480 #ifdef GSSAPI
 481 #define GSSAUTH_P_NONE      1
 482 #define GSSAUTH_P_INTEGRITY 2
 483 #define GSSAUTH_P_PRIVACY   4
 484
 485 static int do_gssauth(int sock, char *hostname, char *username)
 486 {
 487     gss_buffer_desc request_buf, send_token;
 488     gss_buffer_t sec_token;
 489     gss_name_t target_name;
 490     gss_ctx_id_t context;
 491     gss_OID mech_name;
 492     gss_qop_t quality;
 493     int cflags;
 494     OM_uint32 maj_stat, min_stat;
 495     char buf1[8192], buf2[8192], server_conf_flags;
 496     unsigned long buf_size;
 497     int result;
 498
 499     /* first things first: get an imap ticket for host */
 500     sprintf(buf1, "imap@%s", hostname);
 501     request_buf.value = buf1;
 502     request_buf.length = strlen(buf1) + 1;
 503     maj_stat = gss_import_name(&min_stat, &request_buf, GSS_C_NT_HOSTBASED_SERVICE,
 504         &target_name);
 505     if (maj_stat != GSS_S_COMPLETE) {
 506         report(stderr, _("Couldn't get service name for [%s]\n"), buf1);
 507         return PS_AUTHFAIL;
 508     }
 509     else if (outlevel >= O_DEBUG) {
 510         maj_stat = gss_display_name(&min_stat, target_name, &request_buf,
 511             &mech_name);
 512         report(stderr, _("Using service name [%s]\n"),request_buf.value);
 513         maj_stat = gss_release_buffer(&min_stat, &request_buf);
 514     }
 515
 516     gen_send(sock, "AUTHENTICATE GSSAPI");
 517
 518     /* upon receipt of the GSSAPI authentication request, server returns
 519      * null data ready response. */
 520     if (result = gen_recv(sock, buf1, sizeof buf1)) {
 521         return result;
 522     }
 523
 524     /* now start the security context initialisation loop... */
 525     sec_token = GSS_C_NO_BUFFER;
 526     context = GSS_C_NO_CONTEXT;
 527     if (outlevel >= O_VERBOSE)
 528         report(stdout, _("Sending credentials\n"));
 529     do {
 530         send_token.length = 0;
 531         send_token.value = NULL;
 532         maj_stat = gss_init_sec_context(&min_stat,
 533                                         GSS_C_NO_CREDENTIAL,
 534                                         &context,
 535                                         target_name,
 536                                         GSS_C_NO_OID,
 537                                         GSS_C_MUTUAL_FLAG | GSS_C_SEQUENCE_FLAG,
 538                                         0,
 539                                         GSS_C_NO_CHANNEL_BINDINGS,
 540                                         sec_token,
 541                                         NULL,
 542                                         &send_token,
 543                                         NULL,
 544                                         NULL);
 545         if (maj_stat!=GSS_S_COMPLETE && maj_stat!=GSS_S_CONTINUE_NEEDED) {
 546             report(stderr, _("Error exchanging credentials\n"));
 547             gss_release_name(&min_stat, &target_name);
 548             /* wake up server and await NO response */
 549             SockWrite(sock, "\r\n", 2);
 550             if (result = gen_recv(sock, buf1, sizeof buf1))
 551                 return result;
 552             return PS_AUTHFAIL;
 553         }
 554         to64frombits(buf1, send_token.value, send_token.length);
 555         gss_release_buffer(&min_stat, &send_token);
 556         strcat(buf1, "\r\n");
 557         SockWrite(sock, buf1, strlen(buf1));
 558         if (outlevel >= O_MONITOR)
 559             report(stdout, "IMAP> %s\n", buf1);
 560         if (maj_stat == GSS_S_CONTINUE_NEEDED) {
 561             if (result = gen_recv(sock, buf1, sizeof buf1)) {
 562                 gss_release_name(&min_stat, &target_name);
 563                 return result;
 564             }
 565             request_buf.length = from64tobits(buf2, buf1 + 2);
 566             request_buf.value = buf2;
 567             sec_token = &request_buf;
 568         }
 569     } while (maj_stat == GSS_S_CONTINUE_NEEDED);
 570     gss_release_name(&min_stat, &target_name);
 571
 572     /* get security flags and buffer size */
 573     if (result = gen_recv(sock, buf1, sizeof buf1)) {
 574         return result;
 575     }
 576     request_buf.length = from64tobits(buf2, buf1 + 2);
 577     request_buf.value = buf2;
 578
 579     maj_stat = gss_unwrap(&min_stat, context, &request_buf, &send_token,
 580         &cflags, &quality);
 581     if (maj_stat != GSS_S_COMPLETE) {
 582         report(stderr, _("Couldn't unwrap security level data\n"));
 583         gss_release_buffer(&min_stat, &send_token);
 584         return PS_AUTHFAIL;
 585     }
 586     if (outlevel >= O_DEBUG)
 587         report(stdout, _("Credential exchange complete\n"));
 588     /* first octet is security levels supported. We want none, for now */
 589     server_conf_flags = ((char *)send_token.value)[0];
 590     if ( !(((char *)send_token.value)[0] & GSSAUTH_P_NONE) ) {
 591         report(stderr, _("Server requires integrity and/or privacy\n"));
 592         gss_release_buffer(&min_stat, &send_token);
 593         return PS_AUTHFAIL;
 594     }
 595     ((char *)send_token.value)[0] = 0;
 596     buf_size = ntohl(*((long *)send_token.value));
 597     /* we don't care about buffer size if we don't wrap data */
 598     gss_release_buffer(&min_stat, &send_token);
 599     if (outlevel >= O_DEBUG) {
 600         report(stdout, _("Unwrapped security level flags: %s%s%s\n"),
 601             server_conf_flags & GSSAUTH_P_NONE ? "N" : "-",
 602             server_conf_flags & GSSAUTH_P_INTEGRITY ? "I" : "-",
 603             server_conf_flags & GSSAUTH_P_PRIVACY ? "C" : "-");
 604         report(stdout, _("Maximum GSS token size is %ld\n"),buf_size);
 605     }
 606
 607     /* now respond in kind (hack!!!) */
 608     buf_size = htonl(buf_size); /* do as they do... only matters if we do enc */
 609     memcpy(buf1, &buf_size, 4);
 610     buf1[0] = GSSAUTH_P_NONE;
 611     strcpy(buf1+4, username); /* server decides if princ is user */
 612     request_buf.length = 4 + strlen(username) + 1;
 613     request_buf.value = buf1;
 614     maj_stat = gss_wrap(&min_stat, context, 0, GSS_C_QOP_DEFAULT, &request_buf,
 615         &cflags, &send_token);
 616     if (maj_stat != GSS_S_COMPLETE) {
 617         report(stderr, _("Error creating security level request\n"));
 618         return PS_AUTHFAIL;
 619     }
 620     to64frombits(buf1, send_token.value, send_token.length);
 621     if (outlevel >= O_DEBUG) {
 622         report(stdout, _("Requesting authorization as %s\n"), username);
 623         report(stdout, "IMAP> %s\n",buf1);
 624     }
 625     strcat(buf1, "\r\n");
 626     SockWrite(sock, buf1, strlen(buf1));
 627
 628     /* we should be done. Get status and finish up */
 629     if (result = gen_recv(sock, buf1, sizeof buf1))
 630         return result;
 631     if (strstr(buf1, "OK")) {
 632         /* flush security context */
 633         if (outlevel >= O_DEBUG)
 634             report(stdout, _("Releasing GSS credentials\n"));
 635         maj_stat = gss_delete_sec_context(&min_stat, &context, &send_token);
 636         if (maj_stat != GSS_S_COMPLETE) {
 637             report(stderr, _("Error releasing credentials\n"));
 638             return PS_AUTHFAIL;
 639         }
 640         /* send_token may contain a notification to the server to flush
 641          * credentials. RFC 1731 doesn't specify what to do, and since this
 642          * support is only for authentication, we'll assume the server
 643          * knows enough to flush its own credentials */
 644         gss_release_buffer(&min_stat, &send_token);
 645         return PS_SUCCESS;
 646     }
 647
 648     return PS_AUTHFAIL;
 649 }
 650 #endif /* GSSAPI */
 651
 652 static void hmac_md5 (unsigned char *password,  size_t pass_len,
 653                       unsigned char *challenge, size_t chal_len,
 654                       unsigned char *response,  size_t resp_len)
 655 {
 656     int i;
 657     unsigned char ipad[64];
 658     unsigned char opad[64];
 659     unsigned char hash_passwd[16];
 660
 661     MD5_CTX ctx;
 662
 663     if (resp_len != 16)
 664         return;
 665
 666     if (pass_len > sizeof (ipad))
 667     {
 668         MD5Init (&ctx);
 669         MD5Update (&ctx, password, pass_len);
 670         MD5Final (hash_passwd, &ctx);
 671         password = hash_passwd; pass_len = sizeof (hash_passwd);
 672     }
 673
 674     memset (ipad, 0, sizeof (ipad));
 675     memset (opad, 0, sizeof (opad));
 676     memcpy (ipad, password, pass_len);
 677     memcpy (opad, password, pass_len);
 678
 679     for (i=0; i<64; i++) {
 680         ipad[i] ^= 0x36;
 681         opad[i] ^= 0x5c;
 682     }
 683
 684     MD5Init (&ctx);
 685     MD5Update (&ctx, ipad, sizeof (ipad));
 686     MD5Update (&ctx, challenge, chal_len);
 687     MD5Final (response, &ctx);
 688
 689     MD5Init (&ctx);
 690     MD5Update (&ctx, opad, sizeof (opad));
 691     MD5Update (&ctx, response, resp_len);
 692     MD5Final (response, &ctx);
 693 }
 694
 695 #if NTLM_ENABLE
 696 #include "ntlm.h"
 697
 698 static tSmbNtlmAuthRequest   request;
 699 static tSmbNtlmAuthChallenge challenge;
 700 static tSmbNtlmAuthResponse  response;
 701
 702 /*
 703  * NTLM support by Grant Edwards.
 704  *
 705  * Handle MS-Exchange NTLM authentication method.  This is the same
 706  * as the NTLM auth used by Samba for SMB related services. We just
 707  * encode the packets in base64 instead of sending them out via a
 708  * network interface.
 709  *
 710  * Much source (ntlm.h, smb*.c smb*.h) was borrowed from Samba.
 711  */
 712
 713 static int do_imap_ntlm(int sock, struct query *ctl)
 714 {
 715     char msgbuf[2048];
 716     int result,len;
 717
 718     gen_send(sock, "AUTHENTICATE NTLM");
 719
 720     if ((result = gen_recv(sock, msgbuf, sizeof msgbuf)))
 721         return result;
 722
 723     if (msgbuf[0] != '+')
 724         return PS_AUTHFAIL;
 725
 726     buildSmbNtlmAuthRequest(&request,ctl->remotename,NULL);
 727
 728     if (outlevel >= O_DEBUG)
 729         dumpSmbNtlmAuthRequest(stdout, &request);
 730
 731     memset(msgbuf,0,sizeof msgbuf);
 732     to64frombits (msgbuf, (unsigned char*)&request, SmbLength(&request));
 733
 734     if (outlevel >= O_MONITOR)
 735         report(stdout, "IMAP> %s\n", msgbuf);
 736
 737     strcat(msgbuf,"\r\n");
 738     SockWrite (sock, msgbuf, strlen (msgbuf));
 739
 740     if ((gen_recv(sock, msgbuf, sizeof msgbuf)))
 741         return result;
 742
 743     len = from64tobits ((unsigned char*)&challenge, msgbuf);
 744
 745     if (outlevel >= O_DEBUG)
 746         dumpSmbNtlmAuthChallenge(stdout, &challenge);
 747
 748     buildSmbNtlmAuthResponse(&challenge, &response,ctl->remotename,ctl->password);
 749
 750     if (outlevel >= O_DEBUG)
 751         dumpSmbNtlmAuthResponse(stdout, &response);
 752
 753     memset(msgbuf,0,sizeof msgbuf);
 754     to64frombits (msgbuf, (unsigned char*)&response, SmbLength(&response));
 755
 756     if (outlevel >= O_MONITOR)
 757         report(stdout, "IMAP> %s\n", msgbuf);
 758
 759     strcat(msgbuf,"\r\n");
 760
 761     SockWrite (sock, msgbuf, strlen (msgbuf));
 762
 763     if ((result = gen_recv (sock, msgbuf, sizeof msgbuf)))
 764         return result;
 765
 766     if (strstr (msgbuf, "OK"))
 767         return PS_SUCCESS;
 768     else
 769         return PS_AUTHFAIL;
 770 }
 771 #endif /* NTLM */
 772
 773 static int do_cram_md5 (int sock, struct query *ctl)
 774 /* authenticate as per RFC2195 */
 775 {
 776     int result;
 777     int len;
 778     unsigned char buf1[1024];
 779     unsigned char msg_id[768];
 780     unsigned char response[16];
 781     unsigned char reply[1024];
 782
 783     gen_send (sock, "AUTHENTICATE CRAM-MD5");
 784
 785     /* From RFC2195:
 786      * The data encoded in the first ready response contains an
 787      * presumptively arbitrary string of random digits, a timestamp, and the
 788      * fully-qualified primary host name of the server.  The syntax of the
 789      * unencoded form must correspond to that of an RFC 822 'msg-id'
 790      * [RFC822] as described in [POP3].
 791      */
 792
 793     if ((result = gen_recv (sock, buf1, sizeof (buf1)))) {
 794         return result;
 795     }
 796
 797     len = from64tobits (msg_id, buf1);
 798     if (len < 0) {
 799         report (stderr, _("could not decode BASE64 challenge\n"));
 800         return PS_AUTHFAIL;
 801     } else if (len < sizeof (msg_id)) {
 802         msg_id[len] = 0;
 803     } else {
 804         msg_id[sizeof (msg_id)-1] = 0;
 805     }
 806     if (outlevel >= O_DEBUG) {
 807         report (stdout, "decoded as %s\n", msg_id);
 808     }
 809
 810     /* The client makes note of the data and then responds with a string
 811      * consisting of the user name, a space, and a 'digest'.  The latter is
 812      * computed by applying the keyed MD5 algorithm from [KEYED-MD5] where
 813      * the key is a shared secret and the digested text is the timestamp
 814      * (including angle-brackets).
 815      */
 816
 817     hmac_md5 (ctl->password, strlen (ctl->password),
 818               msg_id, strlen (msg_id),
 819               response, sizeof (response));
 820
 821 #ifdef HAVE_SNPRINTF
 822     snprintf (reply, sizeof (reply),
 823 #else
 824     sprintf(reply,
 825 #endif
 826               "%s %02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
 827               ctl->remotename,
 828               response[0], response[1], response[2], response[3],
 829               response[4], response[5], response[6], response[7],
 830               response[8], response[9], response[10], response[11],
 831               response[12], response[13], response[14], response[15]);
 832
 833     if (outlevel >= O_DEBUG) {
 834         report (stdout, "replying with %s\n", reply);
 835     }
 836
 837     to64frombits (buf1, reply, strlen (reply));
 838     if (outlevel >= O_MONITOR) {
 839         report (stdout, "IMAP> %s\n", buf1);
 840     }
 841
 842     /* PMDF5.2 IMAP has a bug that requires this to be a single write */
 843     strcat (buf1, "\r\n");
 844     SockWrite (sock, buf1, strlen (buf1));
 845
 846     if ((result = gen_recv (sock, buf1, sizeof (buf1))))
 847         return result;
 848
 849     if (strstr (buf1, "OK")) {
 850         return PS_SUCCESS;
 851     } else {
 852         return PS_AUTHFAIL;
 853     }
 854 }
 855
 856 int imap_canonicalize(char *result, char *raw, int maxlen)
 857 /* encode an IMAP password as per RFC1730's quoting conventions */
 858 {
 859     int i, j;
 860
 861     j = 0;
 862     for (i = 0; i < strlen(raw) && i < maxlen; i++)
 863     {
 864         if ((raw[i] == '\\') || (raw[i] == '"'))
 865             result[j++] = '\\';
 866         result[j++] = raw[i];
 867     }
 868     result[j] = '\0';
 869
 870     return(i);
 871 }
 872
 873 int imap_getauth(int sock, struct query *ctl, char *greeting)
 874 /* apply for connection authorization */
 875 {
 876     int ok = 0;
 877
 878     /* probe to see if we're running IMAP4 and can use RFC822.PEEK */
 879     capabilities[0] = '\0';
 880     preauth = FALSE;
 881     if ((ok = gen_transact(sock, "CAPABILITY")) == PS_SUCCESS)
 882     {
 883         /* UW-IMAP server 10.173 notifies in all caps */
 884         if (strstr(capabilities, "IMAP4REV1"))
 885         {
 886             imap_version = IMAP4rev1;
 887             if (outlevel >= O_DEBUG)
 888                 report(stdout, _("Protocol identified as IMAP4 rev 1\n"));
 889         }
 890         else
 891         {
 892             imap_version = IMAP4;
 893             if (outlevel >= O_DEBUG)
 894                 report(stdout, _("Protocol identified as IMAP4 rev 0\n"));
 895         }
 896     }
 897     else if (ok == PS_ERROR)
 898     {
 899         imap_version = IMAP2;
 900         if (outlevel >= O_DEBUG)
 901             report(stdout, _("Protocol identified as IMAP2 or IMAP2BIS\n"));
 902     }
 903     else
 904         return(ok);
 905
 906     peek_capable = (imap_version >= IMAP4);
 907
 908     /*
 909      * Assumption: expunges are cheap, so we want to do them
 910      * after every message unless user said otherwise.
 911      */
 912     if (NUM_SPECIFIED(ctl->expunge))
 913         expunge_period = NUM_VALUE_OUT(ctl->expunge);
 914     else
 915         expunge_period = 1;
 916
 917     /*
 918      * If either (a) we saw a PREAUTH token in the capability response, or
 919      * (b) the user specified ssh preauthentication, then we're done.
 920      */
 921     if (preauth || ctl->server.preauthenticate == A_SSH)
 922         return(PS_SUCCESS);
 923
 924     /*
 925      * Handle idling.  We depend on coming through here on startup
 926      * and after each timeout (including timeouts during idles).
 927      */
 928     idling = FALSE;
 929     if (strstr(capabilities, "IDLE") && ctl->idle)
 930     {
 931         do_idle = TRUE;
 932         if (outlevel >= O_VERBOSE)
 933             report(stdout, "will idle after poll\n");
 934     }
 935
 936 #if OPIE_ENABLE
 937     if ((ctl->server.protocol == P_IMAP) && strstr(capabilities, "AUTH=X-OTP"))
 938     {
 939         if (outlevel >= O_DEBUG)
 940             report(stdout, _("OTP authentication is supported\n"));
 941         if (do_otp(sock, ctl) == PS_SUCCESS)
 942             return(PS_SUCCESS);
 943     };
 944 #endif /* OPIE_ENABLE */
 945
 946 #ifdef GSSAPI
 947     if (strstr(capabilities, "AUTH=GSSAPI"))
 948     {
 949         if (ctl->server.protocol == P_IMAP_GSS)
 950         {
 951             if (outlevel >= O_DEBUG)
 952                 report(stdout, _("GSS authentication is supported\n"));
 953             return do_gssauth(sock, ctl->server.truename, ctl->remotename);
 954         }
 955     }
 956     else if (ctl->server.protocol == P_IMAP_GSS)
 957     {
 958         report(stderr,
 959                _("Required GSS capability not supported by server\n"));
 960         return(PS_AUTHFAIL);
 961     }
 962 #endif /* GSSAPI */
 963
 964 #ifdef KERBEROS_V4
 965     if (strstr(capabilities, "AUTH=KERBEROS_V4"))
 966     {
 967         if (outlevel >= O_DEBUG)
 968             report(stdout, _("KERBEROS_V4 authentication is supported\n"));
 969
 970         if (ctl->server.protocol == P_IMAP_K4)
 971         {
 972             if ((ok = do_rfc1731(sock, ctl->server.truename)))
 973             {
 974                 if (outlevel >= O_MONITOR)
 975                     report(stdout, "IMAP> *\n");
 976                 SockWrite(sock, "*\r\n", 3);
 977             }
 978
 979             return(ok);
 980         }
 981         /* else fall through to ordinary AUTH=LOGIN case */
 982     }
 983     else if (ctl->server.protocol == P_IMAP_K4)
 984     {
 985         report(stderr,
 986                _("Required KERBEROS_V4 capability not supported by server\n"));
 987         return(PS_AUTHFAIL);
 988     }
 989 #endif /* KERBEROS_V4 */
 990
 991     if (strstr(capabilities, "AUTH=CRAM-MD5"))
 992     {
 993         if (outlevel >= O_DEBUG)
 994             report (stdout, _("CRAM-MD5 authentication is supported\n"));
 995         if (ctl->server.protocol != P_IMAP_LOGIN)
 996         {
 997             if ((ok = do_cram_md5 (sock, ctl)))
 998             {
 999                 if (outlevel >= O_MONITOR)
1000                     report (stdout, "IMAP> *\n");
1001                 SockWrite (sock, "*\r\n", 3);
1002             }
1003             return ok;
1004         }
1005     }
1006     else if (ctl->server.protocol == P_IMAP_CRAM_MD5)
1007     {
1008         report(stderr,
1009                _("Required CRAM-MD5 capability not supported by server\n"));
1010         return(PS_AUTHFAIL);
1011     }
1012
1013 #ifdef NTLM_ENABLE
1014     if (strstr (capabilities, "AUTH=NTLM"))
1015     {
1016         if (outlevel >= O_DEBUG)
1017             report (stdout, _("NTLM authentication is supported\n"));
1018         return do_imap_ntlm (sock, ctl);
1019     }
1020 #endif /* NTLM_ENABLE */
1021
1022 #ifdef __UNUSED__       /* The Cyrus IMAP4rev1 server chokes on this */
1023     /* this handles either AUTH=LOGIN or AUTH-LOGIN */
1024     if ((imap_version >= IMAP4rev1) && (!strstr(capabilities, "LOGIN"))) {
1025       report(stderr,
1026              _("Required LOGIN capability not supported by server\n"));
1027       return PS_AUTHFAIL;
1028     };
1029 #endif /* __UNUSED__ */
1030
1031     {
1032         /* these sizes guarantee no buffer overflow */
1033         char    remotename[NAMELEN*2+1], password[PASSWORDLEN*2+1];
1034
1035         imap_canonicalize(remotename, ctl->remotename, NAMELEN);
1036         imap_canonicalize(password, ctl->password, PASSWORDLEN);
1037         ok = gen_transact(sock, "LOGIN \"%s\" \"%s\"", remotename, password);
1038     }
1039
1040     if (ok)
1041         return(ok);
1042
1043     return(PS_SUCCESS);
1044 }
1045
1046 static int internal_expunge(int sock)
1047 /* ship an expunge, resetting associated counters */
1048 {
1049     int ok;
1050
1051     if ((ok = gen_transact(sock, "EXPUNGE")))
1052         return(ok);
1053
1054     expunged += deletions;
1055     deletions = 0;
1056
1057 #ifdef IMAP_UID /* not used */
1058     expunge_uids(ctl);
1059 #endif /* IMAP_UID */
1060
1061     return(PS_SUCCESS);
1062 }
1063
1064 static int imap_getrange(int sock,
1065                          struct query *ctl,
1066                          const char *folder,
1067                          int *countp, int *newp, int *bytes)
1068 /* get range of messages to be fetched */
1069 {
1070     int ok;
1071
1072     /* find out how many messages are waiting */
1073     *bytes = recent = unseen = -1;
1074
1075     if (pass > 1)
1076     {
1077         /*
1078          * We have to have an expunge here, otherwise the re-poll will
1079          * infinite-loop picking up un-expunged messages -- unless the
1080          * expunge period is one and we've been nuking each message
1081          * just after deletion.
1082          */
1083         ok = 0;
1084         if (deletions && expunge_period != 1)
1085             ok = internal_expunge(sock);
1086         count = -1;
1087         idling = do_idle;
1088         if (idling)
1089             /* this is the RFC2177-recommended timeout for an IDLE */
1090             mytimeout = 29 * 60;
1091         if (ok || gen_transact(sock, do_idle ? "IDLE" : "NOOP"))
1092         {
1093             report(stderr, _("re-poll failed\n"));
1094             return(ok);
1095         }
1096         else if (count == -1)   /* no EXISTS response to NOOP/IDLE */
1097         {
1098             count = recent = 0;
1099             unseen = -1;
1100         }
1101     }
1102     else
1103     {
1104         ok = gen_transact(sock,
1105                           check_only ? "EXAMINE \"%s\"" : "SELECT \"%s\"",
1106                           folder ? folder : "INBOX");
1107         if (ok != 0)
1108         {
1109             report(stderr, _("mailbox selection failed\n"));
1110             return(ok);
1111         }
1112     }
1113
1114     *countp = count;
1115
1116     /*
1117      * Note: because IMAP has an is_old method, this number is used
1118      * only for the "X messages (Y unseen)" notification.  Accordingly
1119      * it doesn't matter much that it can be wrong (e.g. if we see an
1120      * UNSEEN response but not all messages above the first UNSEEN one
1121      * are likewise).
1122      */
1123     if (unseen >= 0)            /* optional, but better if we see it */
1124         *newp = count - unseen + 1;
1125     else if (recent >= 0)       /* mandatory */
1126         *newp = recent;
1127     else
1128         *newp = -1;             /* should never happen, RECENT is mandatory */
1129
1130     expunged = 0;
1131
1132     return(PS_SUCCESS);
1133 }
1134
1135 static int imap_getsizes(int sock, int count, int *sizes)
1136 /* capture the sizes of all messages */
1137 {
1138     char buf [MSGBUFSIZE+1];
1139
1140     /*
1141      * Some servers (as in, PMDF5.1-9.1 under OpenVMS 6.1)
1142      * won't accept 1:1 as valid set syntax.  Some implementors
1143      * should be taken out and shot for excessive anality.
1144      *
1145      * Microsoft Exchange (brain-dead piece of crap that it is)
1146      * sometimes gets its knickers in a knot about bodiless messages.
1147      * You may see responses like this:
1148      *
1149      *  fetchmail: IMAP> A0004 FETCH 1:9 RFC822.SIZE
1150      *  fetchmail: IMAP< * 2 FETCH (RFC822.SIZE 1187)
1151      *  fetchmail: IMAP< * 3 FETCH (RFC822.SIZE 3954)
1152      *  fetchmail: IMAP< * 4 FETCH (RFC822.SIZE 1944)
1153      *  fetchmail: IMAP< * 5 FETCH (RFC822.SIZE 2933)
1154      *  fetchmail: IMAP< * 6 FETCH (RFC822.SIZE 1854)
1155      *  fetchmail: IMAP< * 7 FETCH (RFC822.SIZE 34054)
1156      *  fetchmail: IMAP< * 8 FETCH (RFC822.SIZE 5561)
1157      *  fetchmail: IMAP< * 9 FETCH (RFC822.SIZE 1101)
1158      *  fetchmail: IMAP< A0004 NO The requested item could not be found.
1159      *
1160      * This means message 1 has only headers.  For kicks and grins
1161      * you can telnet in and look:
1162      *  A003 FETCH 1 FULL
1163      *  A003 NO The requested item could not be found.
1164      *  A004 fetch 1 rfc822.header
1165      *  A004 NO The requested item could not be found.
1166      *  A006 FETCH 1 BODY
1167      *  * 1 FETCH (BODY ("TEXT" "PLAIN" ("CHARSET" "US-ASCII") NIL NIL "7BIT" 35 3))
1168      *  A006 OK FETCH completed.
1169      *
1170      * To get around this, we terminate the read loop on a NO and count
1171      * on the fact that the sizes array has been preinitialized with a
1172      * known-bad size value.
1173      */
1174     if (count == 1)
1175         gen_send(sock, "FETCH 1 RFC822.SIZE", count);
1176     else
1177         gen_send(sock, "FETCH 1:%d RFC822.SIZE", count);
1178     for (;;)
1179     {
1180         int num, size, ok;
1181
1182         if ((ok = gen_recv(sock, buf, sizeof(buf))))
1183             return(ok);
1184         else if (strstr(buf, "OK") || strstr(buf, "NO"))
1185             break;
1186         else if (sscanf(buf, "* %d FETCH (RFC822.SIZE %d)", &num, &size) == 2)
1187             sizes[num - 1] = size;
1188     }
1189
1190     return(PS_SUCCESS);
1191 }
1192
1193 static int imap_is_old(int sock, struct query *ctl, int number)
1194 /* is the given message old? */
1195 {
1196     int ok;
1197
1198     /* expunges change the fetch numbers */
1199     number -= expunged;
1200
1201     if ((ok = gen_transact(sock, "FETCH %d FLAGS", number)) != 0)
1202         return(PS_ERROR);
1203
1204     return(seen);
1205 }
1206
1207 static int imap_fetch_headers(int sock, struct query *ctl,int number,int *lenp)
1208 /* request headers of nth message */
1209 {
1210     char buf [MSGBUFSIZE+1];
1211     int num;
1212
1213     /* expunges change the fetch numbers */
1214     number -= expunged;
1215
1216     /*
1217      * This is blessed by RFC1176, RFC1730, RFC2060.
1218      * According to the RFCs, it should *not* set the \Seen flag.
1219      */
1220     gen_send(sock, "FETCH %d RFC822.HEADER", number);
1221
1222     /* looking for FETCH response */
1223     do {
1224         int     ok;
1225
1226         if ((ok = gen_recv(sock, buf, sizeof(buf))))
1227             return(ok);
1228     } while
1229         (sscanf(buf+2, "%d FETCH (%*s {%d}", &num, lenp) != 2);
1230
1231     if (num != number)
1232         return(PS_ERROR);
1233     else
1234         return(PS_SUCCESS);
1235 }
1236
1237 static int imap_fetch_body(int sock, struct query *ctl, int number, int *lenp)
1238 /* request body of nth message */
1239 {
1240     char buf [MSGBUFSIZE+1], *cp;
1241     int num;
1242
1243     /* expunges change the fetch numbers */
1244     number -= expunged;
1245
1246     /*
1247      * If we're using IMAP4, we can fetch the message without setting its
1248      * seen flag.  This is good!  It means that if the protocol exchange
1249      * craps out during the message, it will still be marked `unseen' on
1250      * the server.
1251      *
1252      * However...*don't* do this if we're using keep to suppress deletion!
1253      * In that case, marking the seen flag is the only way to prevent the
1254      * message from being re-fetched on subsequent runs (and according
1255      * to RFC2060 p.43 this fetch should set Seen as a side effect).
1256      *
1257      * According to RFC2060, and Mark Crispin the IMAP maintainer,
1258      * FETCH %d BODY[TEXT] and RFC822.TEXT are "functionally
1259      * equivalent".  However, we know of at least one server that
1260      * treats them differently in the presence of MIME attachments;
1261      * the latter form downloads the attachment, the former does not.
1262      * The server is InterChange, and the fool who implemented this
1263      * misfeature ought to be strung up by his thumbs.
1264      *
1265      * When I tried working around this by disable use of the 4rev1 form,
1266      * I found that doing this breaks operation with M$ Exchange.
1267      * Annoyingly enough, Exchange's refusal to cope is technically legal
1268      * under RFC2062.  Trust Microsoft, the Great Enemy of interoperability
1269      * standards, to find a way to make standards compliance irritating....
1270      */
1271     switch (imap_version)
1272     {
1273     case IMAP4rev1:     /* RFC 2060 */
1274         if (!ctl->keep)
1275             gen_send(sock, "FETCH %d BODY.PEEK[TEXT]", number);
1276         else
1277             gen_send(sock, "FETCH %d BODY[TEXT]", number);
1278         break;
1279
1280     case IMAP4:         /* RFC 1730 */
1281         if (!ctl->keep)
1282             gen_send(sock, "FETCH %d RFC822.TEXT.PEEK", number);
1283         else
1284             gen_send(sock, "FETCH %d RFC822.TEXT", number);
1285         break;
1286
1287     default:            /* RFC 1176 */
1288         gen_send(sock, "FETCH %d RFC822.TEXT", number);
1289         break;
1290     }
1291
1292     /* looking for FETCH response */
1293     do {
1294         int     ok;
1295
1296         if ((ok = gen_recv(sock, buf, sizeof(buf))))
1297             return(ok);
1298     } while
1299         (!strstr(buf+4, "FETCH") || sscanf(buf+2, "%d", &num) != 1);
1300
1301     if (num != number)
1302         return(PS_ERROR);
1303
1304     /*
1305      * Try to extract a length from the FETCH response.  RFC2060 requires
1306      * it to be present, but at least one IMAP server (Novell GroupWise)
1307      * botches this.
1308      */
1309     if ((cp = strchr(buf, '{')))
1310         *lenp = atoi(cp + 1);
1311     else
1312         *lenp = -1;     /* missing length part in FETCH reponse */
1313
1314     return(PS_SUCCESS);
1315 }
1316
1317 static int imap_trail(int sock, struct query *ctl, int number)
1318 /* discard tail of FETCH response after reading message text */
1319 {
1320     /* expunges change the fetch numbers */
1321     /* number -= expunged; */
1322
1323     for (;;)
1324     {
1325         char buf[MSGBUFSIZE+1];
1326         int ok;
1327
1328         if ((ok = gen_recv(sock, buf, sizeof(buf))))
1329             return(ok);
1330
1331         /* UW IMAP returns "OK FETCH", Cyrus returns "OK Completed" */
1332         if (strstr(buf, "OK"))
1333             break;
1334
1335 #ifdef __UNUSED__
1336         /*
1337          * Any IMAP server that fails to set Seen on a BODY[TEXT]
1338          * fetch violates RFC2060 p.43 (top).  This becomes an issue
1339          * when keep is on, because seen messages aren't deleted and
1340          * get refetched on each poll.  As a workaround, if keep is on
1341          * we can set the Seen flag explicitly.
1342          *
1343          * This code isn't used yet because we don't know of any IMAP
1344          * servers broken in this way.
1345          */
1346         if (ctl->keep)
1347             if ((ok = gen_transact(sock,
1348                         imap_version == IMAP4
1349                                 ? "STORE %d +FLAGS.SILENT (\\Seen)"
1350                                 : "STORE %d +FLAGS (\\Seen)",
1351                         number)))
1352                 return(ok);
1353 #endif /* __UNUSED__ */
1354     }
1355
1356     return(PS_SUCCESS);
1357 }
1358
1359 static int imap_delete(int sock, struct query *ctl, int number)
1360 /* set delete flag for given message */
1361 {
1362     int ok;
1363
1364     /* expunges change the fetch numbers */
1365     number -= expunged;
1366
1367     /*
1368      * Use SILENT if possible as a minor throughput optimization.
1369      * Note: this has been dropped from IMAP4rev1.
1370      *
1371      * We set Seen because there are some IMAP servers (notably HP
1372      * OpenMail) that do message-receipt DSNs, but only when the seen
1373      * bit is set.  This is the appropriate time -- we get here right
1374      * after the local SMTP response that says delivery was
1375      * successful.
1376      */
1377     if ((ok = gen_transact(sock,
1378                         imap_version == IMAP4
1379                                 ? "STORE %d +FLAGS.SILENT (\\Seen \\Deleted)"
1380                                 : "STORE %d +FLAGS (\\Seen \\Deleted)",
1381                         number)))
1382         return(ok);
1383     else
1384         deletions++;
1385
1386     /*
1387      * We do an expunge after expunge_period messages, rather than
1388      * just before quit, so that a line hit during a long session
1389      * won't result in lots of messages being fetched again during
1390      * the next session.
1391      */
1392     if (NUM_NONZERO(expunge_period) && (deletions % expunge_period) == 0)
1393         internal_expunge(sock);
1394
1395     return(PS_SUCCESS);
1396 }
1397
1398 static int imap_logout(int sock, struct query *ctl)
1399 /* send logout command */
1400 {
1401     /* if any un-expunged deletions remain, ship an expunge now */
1402     if (deletions)
1403         internal_expunge(sock);
1404
1405     return(gen_transact(sock, "LOGOUT"));
1406 }
1407
1408 const static struct method imap =
1409 {
1410     "IMAP",             /* Internet Message Access Protocol */
1411 #if INET6_ENABLE
1412     "imap",
1413     "imaps",
1414 #else /* INET6_ENABLE */
1415     143,                /* standard IMAP2bis/IMAP4 port */
1416     993,                /* ssl IMAP2bis/IMAP4 port */
1417 #endif /* INET6_ENABLE */
1418     TRUE,               /* this is a tagged protocol */
1419     FALSE,              /* no message delimiter */
1420     imap_ok,            /* parse command response */
1421     imap_canonicalize,  /* deal with embedded slashes and spaces */
1422     imap_getauth,       /* get authorization */
1423     imap_getrange,      /* query range of messages */
1424     imap_getsizes,      /* get sizes of messages (used for ESMTP SIZE option) */
1425     imap_is_old,        /* no UID check */
1426     imap_fetch_headers, /* request given message headers */
1427     imap_fetch_body,    /* request given message body */
1428     imap_trail,         /* eat message trailer */
1429     imap_delete,        /* delete the message */
1430     imap_logout,        /* expunge and exit */
1431     TRUE,               /* yes, we can re-poll */
1432 };
1433
1434 int doIMAP(struct query *ctl)
1435 /* retrieve messages using IMAP Version 2bis or Version 4 */
1436 {
1437     return(do_protocol(ctl, &imap));
1438 }
1439
1440 /* imap.c ends here */