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             if (opiegenerator(challenge, ctl->password, response))
 144                  PROTOCOL_ERROR
 145
 146             ok = gen_transact(sock, "PASS %s", response);
 147         }
 148         else
 149 #endif /* defined(HAVE_LIBOPIE) && defined(OPIE_ENABLE) */
 150             /* ordinary validation, no one-time password */
 151             ok = gen_transact(sock, "PASS %s", ctl->password);
 152
 153         if (ok != 0)
 154         {
 155             if (ok == PS_LOCKBUSY)
 156                 LOCKBUSY_ERROR
 157             PROTOCOL_ERROR
 158         }
 159
 160         /*
 161          * Empirical experience shows some server/OS combinations
 162          * may need a brief pause even after any lockfiles on the
 163          * server are released, to give the server time to finish
 164          * copying back very large mailfolders from the temp-file...
 165          * this is only ever an issue with extremely large mailboxes.
 166          */
 167         sleep(3); /* to be _really_ safe, probably need sleep(5)! */
 168         break;
 169
 170     case P_APOP:
 171         if ((gen_transact(sock, "APOP %s %s",
 172                           ctl->remotename, ctl->digest)) != 0)
 173             PROTOCOL_ERROR
 174         break;
 175
 176     case P_RPOP:
 177         if ((gen_transact(sock,"USER %s", ctl->remotename)) != 0)
 178             PROTOCOL_ERROR
 179
 180         if ((gen_transact(sock, "RPOP %s", ctl->password)) != 0)
 181             PROTOCOL_ERROR
 182         break;
 183
 184     default:
 185         error(0, 0, "Undefined protocol request in POP3_auth");
 186     }
 187
 188     /* we're approved */
 189     return(0);
 190 }
 191
 192 static int
 193 pop3_gettopid( int sock, int num , char *id)
 194 {
 195     int ok;
 196     int got_it;
 197     char buf [POPBUFSIZE+1];
 198     sprintf( buf, "TOP %d 1", num );
 199     if( (ok = gen_transact(sock, buf ) ) != 0 )
 200        return ok;
 201     got_it = 0;
 202     while((ok = gen_recv(sock, buf, sizeof(buf))) == 0) {
 203         if( buf[0] == '.' )
 204             break;
 205         if( ! got_it && ! strncasecmp("Message-Id:", buf, 11 )) {
 206             got_it = 1;
 207             sscanf( buf+12, "%s", id);
 208         }
 209     }
 210     return 0;
 211 }
 212
 213 static int
 214 pop3_slowuidl( int sock,  struct query *ctl, int *countp, int *newp)
 215 {
 216     /* This approach tries to get the message headers from the
 217      * remote hosts and compares the message-id to the already known
 218      * ones:
 219      *  + if the first message containes a new id, all messages on
 220      *    the server will be new
 221      *  + if the first is known, try to estimate the last known message
 222      *    on the server and check. If this works you know the total number
 223      *    of messages to get.
 224      *  + Otherwise run a binary search to determine the last known message
 225      */
 226     int ok, nolinear = 0;
 227     int first_nr, list_len, try_id, try_nr, hop_id, add_id;
 228     int num;
 229     char id [IDLEN+1];
 230
 231     if( (ok = pop3_gettopid( sock, 1, id )) != 0 )
 232         return ok;
 233
 234     if( ( first_nr = str_nr_in_list(&ctl->oldsaved, id) ) == -1 ) {
 235         /* the first message is unknown -> all messages are new */
 236         *newp = *countp;
 237         return 0;
 238     }
 239
 240     /* check where we expect the latest known message */
 241     list_len = count_list( &ctl->oldsaved );
 242     try_id = list_len  - first_nr; /* -1 + 1 */
 243     if( try_id > 1 ) {
 244         if( try_id <= *countp ) {
 245             if( (ok = pop3_gettopid( sock, try_id, id )) != 0 )
 246                 return ok;
 247
 248             try_nr = str_nr_in_list(&ctl->oldsaved, id);
 249         } else {
 250             try_id = *countp+1;
 251             try_nr = -1;
 252         }
 253         if( try_nr != list_len -1 ) {
 254             /* some messages inbetween have been deleted... */
 255             if( try_nr == -1 ) {
 256                 nolinear = 1;
 257
 258                 for( add_id = 1<<30; add_id > try_id-1; add_id >>= 1 )
 259                     ;
 260                 for( ; add_id; add_id >>= 1 ) {
 261                     if( try_nr == -1 ) {
 262                         if( try_id - add_id <= 1 ) {
 263                             continue;
 264                         }
 265                         try_id -= add_id;
 266                     } else
 267                         try_id += add_id;
 268
 269                     if( (ok = pop3_gettopid( sock, try_id, id )) != 0 )
 270                         return ok;
 271                     try_nr = str_nr_in_list(&ctl->oldsaved, id);
 272                 }
 273                 if( try_nr == -1 ) {
 274                     try_id--;
 275                 }
 276             } else {
 277                 error(0,0,"Messages inserted into list on server. "
 278                       "Cannot handle this.");
 279                 return -1;
 280             }
 281         }
 282     }
 283     /* The first try_id messages are known -> copy them to
 284        the newsaved list */
 285     for( num = first_nr; num < list_len; num++ )
 286         save_str(&ctl->newsaved, num-first_nr + 1,
 287                  str_from_nr_list( &ctl->oldsaved, num ));
 288
 289     if( nolinear ) {
 290         free_str_list(&ctl->oldsaved);
 291         ctl->oldsaved = 0;
 292         last = try_id;
 293     }
 294
 295     *newp = *countp - try_id;
 296     return 0;
 297 }
 298
 299 static int pop3_getrange(int sock,
 300                          struct query *ctl,
 301                          const char *folder,
 302                          int *countp, int *newp)
 303 /* get range of messages to be fetched */
 304 {
 305     int ok;
 306     char buf [POPBUFSIZE+1];
 307
 308     /* Ensure that the new list is properly empty */
 309     ctl->newsaved = (struct idlist *)NULL;
 310
 311 #ifdef MBOX
 312     /* Alain Knaff suggests this, but it's not RFC standard */
 313     if (folder)
 314         if ((ok = gen_transact(sock, "MBOX %s", folder)))
 315             return ok;
 316 #endif /* MBOX */
 317
 318     /* get the total message count */
 319     gen_send(sock, "STAT");
 320     ok = pop3_ok(sock, buf);
 321     if (ok == 0)
 322         sscanf(buf,"%d %*d", countp);
 323     else
 324         return(ok);
 325
 326     /*
 327      * Newer, RFC-1725-conformant POP servers may not have the LAST command.
 328      * We work as hard as possible to hide this ugliness, but it makes
 329      * counting new messages intrinsically quadratic in the worst case.
 330      */
 331     last = 0;
 332     *newp = -1;
 333     if (*countp > 0 && !ctl->fetchall)
 334     {
 335         char id [IDLEN+1];
 336
 337         if (!ctl->server.uidl) {
 338             gen_send(sock, "LAST");
 339             ok = pop3_ok(sock, buf);
 340         } else
 341             ok = 1;
 342         if (ok == 0)
 343         {
 344             if (sscanf(buf, "%d", &last) == 0)
 345                 PROTOCOL_ERROR
 346             *newp = (*countp - last);
 347         }
 348         else
 349         {
 350             /* grab the mailbox's UID list */
 351             if ((ok = gen_transact(sock, "UIDL")) != 0)
 352             {
 353                 /* don't worry, yet! do it the slow way */
 354                 if((ok = pop3_slowuidl( sock, ctl, countp, newp))!=0)
 355                     PROTOCOL_ERROR
 356             }
 357             else
 358             {
 359                 int     num;
 360
 361                 *newp = 0;
 362                 while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
 363                 {
 364                     if (buf[0] == '.')
 365                         break;
 366                     else if (sscanf(buf, "%d %s", &num, id) == 2)
 367                     {
 368                         save_str(&ctl->newsaved, num, id);
 369
 370                         /* note: ID comparison is caseblind */
 371                         if (!str_in_list(&ctl->oldsaved, id))
 372                             (*newp)++;
 373                     }
 374                 }
 375             }
 376         }
 377     }
 378
 379     return(0);
 380 }
 381
 382 static int pop3_getsizes(int sock, int count, int *sizes)
 383 /* capture the sizes of all messages */
 384 {
 385     int ok;
 386
 387     if ((ok = gen_transact(sock, "LIST")) != 0)
 388         return(ok);
 389     else
 390     {
 391         char buf [POPBUFSIZE+1];
 392
 393         while ((ok = gen_recv(sock, buf, sizeof(buf))) == 0)
 394         {
 395             int num, size;
 396
 397             if (buf[0] == '.')
 398                 break;
 399             else if (sscanf(buf, "%d %d", &num, &size) == 2)
 400                 sizes[num - 1] = size;
 401             else
 402                 sizes[num - 1] = -1;
 403         }
 404
 405         return(ok);
 406     }
 407 }
 408
 409 static int pop3_is_old(int sock, struct query *ctl, int num)
 410 /* is the given message old? */
 411 {
 412     if (!ctl->oldsaved)
 413         return (num <= last);
 414     else
 415         /* note: ID comparison is caseblind */
 416         return (str_in_list(&ctl->oldsaved,
 417                             str_find (&ctl->newsaved, num)));
 418 }
 419
 420 static int pop3_fetch(int sock, struct query *ctl, int number, int *lenp)
 421 /* request nth message */
 422 {
 423     int ok;
 424     char buf [POPBUFSIZE+1], *cp;
 425
 426     gen_send(sock, "RETR %d", number);
 427     if ((ok = pop3_ok(sock, buf)) != 0)
 428         return(ok);
 429
 430     *lenp = -1;         /* we got sizes from the LIST response */
 431
 432     return(0);
 433 }
 434
 435 static int pop3_delete(int sock, struct query *ctl, int number)
 436 /* delete a given message */
 437 {
 438     /* actually, mark for deletion -- doesn't happen until QUIT time */
 439     return(gen_transact(sock, "DELE %d", number));
 440 }
 441
 442 const static struct method pop3 =
 443 {
 444     "POP3",             /* Post Office Protocol v3 */
 445     110,                /* standard POP3 port */
 446     FALSE,              /* this is not a tagged protocol */
 447     TRUE,               /* this uses a message delimiter */
 448     pop3_ok,            /* parse command response */
 449     pop3_getauth,       /* get authorization */
 450     pop3_getrange,      /* query range of messages */
 451     pop3_getsizes,      /* we can get a list of sizes */
 452     pop3_is_old,        /* how do we tell a message is old? */
 453     pop3_fetch,         /* request given message */
 454     NULL,               /* no way to fetch body alone */
 455     NULL,               /* no message trailer */
 456     pop3_delete,        /* how to delete a message */
 457     "QUIT",             /* the POP3 exit command */
 458 };
 459
 460 int doPOP3 (struct query *ctl)
 461 /* retrieve messages using POP3 */
 462 {
 463 #ifndef MBOX
 464     if (ctl->mailboxes->id) {
 465         fprintf(stderr,"Option --remote is not supported with POP3\n");
 466         return(PS_SYNTAX);
 467     }
 468 #endif /* MBOX */
 469     peek_capable = FALSE;
 470     return(do_protocol(ctl, &pop3));
 471 }
 472
 473 /* pop3.c ends here */