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

   1 /*
   2  * pop3.c -- POP3 protocol methods
   3  *
   4  * For license terms, see the file COPYING in this directory.
   5  */
   6
   7 #include  "config.h"
   8
   9 #include  <stdio.h>
  10 #include  <string.h>
  11 #include  <ctype.h>
  12 #if defined(HAVE_UNISTD_H)
  13 #include <unistd.h>
  14 #endif
  15 #if defined(STDC_HEADERS)
  16 #include  <stdlib.h>
  17 #endif
  18
  19 #include  "fetchmail.h"
  20 #include  "socket.h"
  21
  22 #if HAVE_LIBOPIE
  23 #include  <opie.h>
  24 #endif /* HAVE_LIBOPIE */
  25
  26 #define PROTOCOL_ERROR  {error(0, 0, "protocol error"); return(PS_ERROR);}
  27
  28 #define LOCKBUSY_ERROR  {error(0, 0, "lock busy!  Is another session active?"); return(PS_LOCKBUSY);}
  29
  30 extern char *strstr();  /* needed on sysV68 R3V7.1. */
  31
  32 static int last;
  33
  34 #if HAVE_LIBOPIE
  35 static char lastok[POPBUFSIZE+1];
  36 #endif /* HAVE_LIBOPIE */
  37
  38 int pop3_ok (int sock, char *argbuf)
  39 /* parse command response */
  40 {
  41     int ok;
  42     char buf [POPBUFSIZE+1];
  43     char *bufp;
  44
  45     if ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
  46     {
  47         bufp = buf;
  48         if (*bufp == '+' || *bufp == '-')
  49             bufp++;
  50         else
  51             return(PS_PROTOCOL);
  52
  53         while (isalpha(*bufp))
  54             bufp++;
  55         *(bufp++) = '\0';
  56
  57         if (strcmp(buf,"+OK") == 0)
  58         {
  59 #if HAVE_LIBOPIE
  60             strcpy(lastok, bufp);
  61 #endif /* HAVE_LIBOPIE */
  62             ok = 0;
  63         }
  64         else if (strcmp(buf,"-ERR") == 0)
  65         {
  66             /*
  67              * We're checking for "lock busy", "unable to lock",
  68              * "already locked" etc. here.  This indicates that we
  69              * have to wait for the server to clean up before we
  70              * can poll again.
  71              *
  72              * PS_LOCKBUSY check empirically verified with two recent
  73              * versions the Berkeley popper;    QPOP (version 2.2)  and
  74              * QUALCOMM Pop server derived from UCB (version 2.1.4-R3)
  75              */
  76             if (strstr(bufp,"lock")||strstr(bufp,"Lock")||strstr(bufp,"LOCK"))
  77                 ok = PS_LOCKBUSY;
  78             else
  79                 ok = PS_ERROR;
  80         }
  81         else
  82             ok = PS_PROTOCOL;
  83
  84         if (argbuf != NULL)
  85             strcpy(argbuf,bufp);
  86     }
  87
  88     return(ok);
  89 }
  90
  91 int pop3_getauth(int sock, struct query *ctl, char *greeting)
  92 /* apply for connection authorization */
  93 {
  94     int ok;
  95 #if HAVE_LIBOPIE
  96     char *challenge;
  97 #endif /* HAVE_LIBOPIE */
  98
  99     /* build MD5 digest from greeting timestamp + password */
 100     if (ctl->server.protocol == P_APOP)
 101     {
 102         char *start,*end;
 103         char *msg;
 104
 105         /* find start of timestamp */
 106         for (start = greeting;  *start != 0 && *start != '<';  start++)
 107             continue;
 108         if (*start == 0) {
 109             error(0, -1, "Required APOP timestamp not found in greeting");
 110             return(PS_AUTHFAIL);
 111         }
 112
 113         /* find end of timestamp */
 114         for (end = start;  *end != 0  && *end != '>';  end++)
 115             continue;
 116         if (*end == 0 || end == start + 1) {
 117             error(0, -1, "Timestamp syntax error in greeting");
 118             return(PS_AUTHFAIL);
 119         }
 120         else
 121             *++end = '\0';
 122
 123         /* copy timestamp and password into digestion buffer */
 124         msg = (char *)xmalloc((end-start+1) + strlen(ctl->password) + 1);
 125         strcpy(msg,start);
 126         strcat(msg,ctl->password);
 127
 128         strcpy(ctl->digest, MD5Digest(msg));
 129         free(msg);
 130     }
 131
 132     switch (ctl->server.protocol) {
 133     case P_POP3:
 134         if ((gen_transact(sock, "USER %s", ctl->remotename)) != 0)
 135             PROTOCOL_ERROR
 136
 137 #if defined(HAVE_LIBOPIE) && defined(OPIE_ENABLE)
 138         /* see RFC1938: A One-Time Password System */
 139         if (challenge = strstr(lastok, "otp-"))
 140         {
 141             char response[OPIE_RESPONSE_MAX+1];
 142
 143             /*
 144              * Special case in case we're running Craig Metz's
 145              * OPIE daemon.  Code in opiegenerator() will detect this.
 146              */
 147             if (strcmp(ctl->password, "opie") == 0)
 148             {
 149                 if (ok = opiegenerator(challenge, "", response))
 150                     if (ok != 2)
 151                         PROTOCOL_ERROR
 152             }
 153
 154             /*
 155              * Otherwise, generate a challenge from whatever secret we
 156              * have previously collected.
 157              */
 158             else if (opiegenerator(challenge, ctl->password, response))
 159                  PROTOCOL_ERROR
 160
 161             ok = gen_transact(sock, "PASS %s", response);
 162         }
 163         else
 164 #endif /* defined(HAVE_LIBOPIE) && defined(OPIE_ENABLE) */
 165             /* ordinary validation, no one-time password */
 166             ok = gen_transact(sock, "PASS %s", ctl->password);
 167
 168         if (ok != 0)
 169         {
 170             if (ok == PS_LOCKBUSY)
 171                 LOCKBUSY_ERROR
 172             PROTOCOL_ERROR
 173         }
 174
 175         /*
 176          * Empirical experience shows some server/OS combinations
 177          * may need a brief pause even after any lockfiles on the
 178          * server are released, to give the server time to finish
 179          * copying back very large mailfolders from the temp-file...
 180          * this is only ever an issue with extremely large mailboxes.
 181          */
 182         sleep(3); /* to be _really_ safe, probably need sleep(5)! */
 183         break;
 184
 185     case P_APOP:
 186         if ((gen_transact(sock, "APOP %s %s",
 187                           ctl->remotename, ctl->digest)) != 0)
 188             PROTOCOL_ERROR
 189         break;
 190
 191     case P_RPOP:
 192         if ((gen_transact(sock,"USER %s", ctl->remotename)) != 0)
 193             PROTOCOL_ERROR
 194
 195         if ((gen_transact(sock, "RPOP %s", ctl->password)) != 0)
 196             PROTOCOL_ERROR
 197         break;
 198
 199     default:
 200         error(0, 0, "Undefined protocol request in POP3_auth");
 201     }
 202
 203     /* we're approved */
 204     return(0);
 205 }
 206
 207 static int
 208 pop3_gettopid( int sock, int num , char *id)
 209 {
 210     int ok;
 211     int got_it;
 212     char buf [POPBUFSIZE+1];
 213     sprintf( buf, "TOP %d 1", num );
 214     if( (ok = gen_transact(sock, buf ) ) != 0 )
 215        return ok;
 216     got_it = 0;
 217     while((ok = gen_recv(sock, buf, sizeof(buf))) == 0) {
 218         if( buf[0] == '.' )
 219             break;
 220         if( ! got_it && ! strncasecmp("Message-Id:", buf, 11 )) {
 221             got_it = 1;
 222             sscanf( buf+12, "%s", id);
 223         }
 224     }
 225     return 0;
 226 }
 227
 228 static int
 229 pop3_slowuidl( int sock,  struct query *ctl, int *countp, int *newp)
 230 {
 231     /* This approach tries to get the message headers from the
 232      * remote hosts and compares the message-id to the already known
 233      * ones:
 234      *  + if the first message containes a new id, all messages on
 235      *    the server will be new
 236      *  + if the first is known, try to estimate the last known message
 237      *    on the server and check. If this works you know the total number
 238      *    of messages to get.
 239      *  + Otherwise run a binary search to determine the last known message
 240      */
 241     int ok, nolinear = 0;
 242     int first_nr, list_len, try_id, try_nr, hop_id, add_id;
 243     int num;
 244     char id [IDLEN+1];
 245
 246     if( (ok = pop3_gettopid( sock, 1, id )) != 0 )
 247         return ok;
 248
 249     if( ( first_nr = str_nr_in_list(&ctl->oldsaved, id) ) == -1 ) {
 250         /* the first message is unknown -> all messages are new */
 251         *newp = *countp;
 252         return 0;
 253     }
 254
 255     /* check where we expect the latest known message */
 256     list_len = count_list( &ctl->oldsaved );
 257     try_id = list_len  - first_nr; /* -1 + 1 */
 258     if( try_id > 1 ) {
 259         if( try_id <= *countp ) {
 260             if( (ok = pop3_gettopid( sock, try_id, id )) != 0 )
 261                 return ok;
 262
 263             try_nr = str_nr_in_list(&ctl->oldsaved, id);
 264         } else {
 265             try_id = *countp+1;
 266             try_nr = -1;
 267         }
 268         if( try_nr != list_len -1 ) {
 269             /* some messages inbetween have been deleted... */
 270             if( try_nr == -1 ) {
 271                 nolinear = 1;
 272
 273                 for( add_id = 1<<30; add_id > try_id-1; add_id >>= 1 )
 274                     ;
 275                 for( ; add_id; add_id >>= 1 ) {
 276                     if( try_nr == -1 ) {
 277                         if( try_id - add_id <= 1 ) {
 278                             continue;
 279                         }
 280                         try_id -= add_id;
 281                     } else
 282                         try_id += add_id;
 283
 284                     if( (ok = pop3_gettopid( sock, try_id, id )) != 0 )
 285                         return ok;
 286                     try_nr = str_nr_in_list(&ctl->oldsaved, id);
 287                 }
 288                 if( try_nr == -1 ) {
 289                     try_id--;
 290                 }
 291             } else {
 292                 error(0,0,"Messages inserted into list on server. "
 293                       "Cannot handle this.");
 294                 return -1;
 295             }
 296         }
 297     }
 298     /* The first try_id messages are known -> copy them to
 299        the newsaved list */
 300     for( num = first_nr; num < list_len; num++ )
 301         save_str(&ctl->newsaved, num-first_nr + 1,
 302                  str_from_nr_list( &ctl->oldsaved, num ));
 303
 304     if( nolinear ) {
 305         free_str_list(&ctl->oldsaved);
 306         ctl->oldsaved = 0;
 307         last = try_id;
 308     }
 309
 310     *newp = *countp - try_id;
 311     return 0;
 312 }
 313
 314 static int pop3_getrange(int sock,
 315                          struct query *ctl,
 316                          const char *folder,
 317                          int *countp, int *newp)
 318 /* get range of messages to be fetched */
 319 {
 320     int ok;
 321     char buf [POPBUFSIZE+1];
 322
 323     /* Ensure that the new list is properly empty */
 324     ctl->newsaved = (struct idlist *)NULL;
 325
 326 #ifdef MBOX
 327     /* Alain Knaff suggests this, but it's not RFC standard */
 328     if (folder)
 329         if ((ok = gen_transact(sock, "MBOX %s", folder)))
 330             return ok;
 331 #endif /* MBOX */
 332
 333     /* get the total message count */
 334     gen_send(sock, "STAT");
 335     ok = pop3_ok(sock, buf);
 336     if (ok == 0)
 337         sscanf(buf,"%d %*d", countp);
 338     else
 339         return(ok);
 340
 341     /*
 342      * Newer, RFC-1725-conformant POP servers may not have the LAST command.
 343      * We work as hard as possible to hide this ugliness, but it makes
 344      * counting new messages intrinsically quadratic in the worst case.
 345      */
 346     last = 0;
 347     *newp = -1;
 348     if (*countp > 0 && !ctl->fetchall)
 349     {
 350         char id [IDLEN+1];
 351
 352         if (!ctl->server.uidl) {
 353             gen_send(sock, "LAST");
 354             ok = pop3_ok(sock, buf);
 355         } else
 356             ok = 1;
 357         if (ok == 0)
 358         {
 359             if (sscanf(buf, "%d", &last) == 0)
 360                 PROTOCOL_ERROR
 361             *newp = (*countp - last);
 362         }
 363         else
 364         {
 365             /* grab the mailbox's UID list */
 366             if ((ok = gen_transact(sock, "UIDL")) != 0)
 367             {
 368                 /* don't worry, yet! do it the slow way */
 369                 if((ok = pop3_slowuidl( sock, ctl, countp, newp))!=0)
 370                     PROTOCOL_ERROR
 371             }
 372             else
 373             {
 374                 int     num;
 375
 376                 *newp = 0;
 377                 while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
 378                 {
 379                     if (buf[0] == '.')
 380                         break;
 381                     else if (sscanf(buf, "%d %s", &num, id) == 2)
 382                     {
 383                         save_str(&ctl->newsaved, num, id);
 384
 385                         /* note: ID comparison is caseblind */
 386                         if (!str_in_list(&ctl->oldsaved, id))
 387                             (*newp)++;
 388                     }
 389                 }
 390             }
 391         }
 392     }
 393
 394     return(0);
 395 }
 396
 397 static int pop3_getsizes(int sock, int count, int *sizes)
 398 /* capture the sizes of all messages */
 399 {
 400     int ok;
 401
 402     if ((ok = gen_transact(sock, "LIST")) != 0)
 403         return(ok);
 404     else
 405     {
 406         char buf [POPBUFSIZE+1];
 407
 408         while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
 409         {
 410             int num, size;
 411
 412             if (buf[0] == '.')
 413                 break;
 414             else if (sscanf(buf, "%d %d", &num, &size) == 2)
 415                 sizes[num - 1] = size;
 416             else
 417                 sizes[num - 1] = -1;
 418         }
 419
 420         return(ok);
 421     }
 422 }
 423
 424 static int pop3_is_old(int sock, struct query *ctl, int num)
 425 /* is the given message old? */
 426 {
 427     if (!ctl->oldsaved)
 428         return (num <= last);
 429     else
 430         /* note: ID comparison is caseblind */
 431         return (str_in_list(&ctl->oldsaved,
 432                             str_find (&ctl->newsaved, num)));
 433 }
 434
 435 static int pop3_fetch(int sock, struct query *ctl, int number, int *lenp)
 436 /* request nth message */
 437 {
 438     int ok;
 439     char buf [POPBUFSIZE+1], *cp;
 440
 441     gen_send(sock, "RETR %d", number);
 442     if ((ok = pop3_ok(sock, buf)) != 0)
 443         return(ok);
 444
 445     *lenp = -1;         /* we got sizes from the LIST response */
 446
 447     return(0);
 448 }
 449
 450 static int pop3_delete(int sock, struct query *ctl, int number)
 451 /* delete a given message */
 452 {
 453     /* actually, mark for deletion -- doesn't happen until QUIT time */
 454     return(gen_transact(sock, "DELE %d", number));
 455 }
 456
 457 const static struct method pop3 =
 458 {
 459     "POP3",             /* Post Office Protocol v3 */
 460     110,                /* standard POP3 port */
 461     FALSE,              /* this is not a tagged protocol */
 462     TRUE,               /* this uses a message delimiter */
 463     pop3_ok,            /* parse command response */
 464     pop3_getauth,       /* get authorization */
 465     pop3_getrange,      /* query range of messages */
 466     pop3_getsizes,      /* we can get a list of sizes */
 467     pop3_is_old,        /* how do we tell a message is old? */
 468     pop3_fetch,         /* request given message */
 469     NULL,               /* no way to fetch body alone */
 470     NULL,               /* no message trailer */
 471     pop3_delete,        /* how to delete a message */
 472     "QUIT",             /* the POP3 exit command */
 473 };
 474
 475 int doPOP3 (struct query *ctl)
 476 /* retrieve messages using POP3 */
 477 {
 478 #ifndef MBOX
 479     if (ctl->mailboxes->id) {
 480         fprintf(stderr,"Option --remote is not supported with POP3\n");
 481         return(PS_SYNTAX);
 482     }
 483 #endif /* MBOX */
 484     peek_capable = FALSE;
 485     return(do_protocol(ctl, &pop3));
 486 }
 487
 488 /* pop3.c ends here */