citadel/serv_pop3.c

   1 /*
   2  * $Id$
   3  *
   4  * POP3 service for the Citadel system
   5  * Copyright (C) 1998-2001 by Art Cancro and others.
   6  * This code is released under the terms of the GNU General Public License.
   7  *
   8  * Current status of standards conformance:
   9  *
  10  * -> All required POP3 commands described in RFC1939 are implemented.
  11  *
  12  * -> All optional POP3 commands described in RFC1939 are also implemented.
  13  *
  14  * -> The deprecated "LAST" command is included in this implementation, because
  15  *    there exist mail clients which insist on using it (such as Bynari
  16  *    TradeMail, and certain versions of Eudora).
  17  *
  18  */
  19
  20 #include "sysdep.h"
  21 #include <stdlib.h>
  22 #include <unistd.h>
  23 #include <stdio.h>
  24 #include <fcntl.h>
  25 #include <signal.h>
  26 #include <pwd.h>
  27 #include <errno.h>
  28 #include <sys/types.h>
  29
  30 #if TIME_WITH_SYS_TIME
  31 # include <sys/time.h>
  32 # include <time.h>
  33 #else
  34 # if HAVE_SYS_TIME_H
  35 #  include <sys/time.h>
  36 # else
  37 #  include <time.h>
  38 # endif
  39 #endif
  40
  41 #include <sys/wait.h>
  42 #include <string.h>
  43 #include <limits.h>
  44 #include <ctype.h>
  45 #include "citadel.h"
  46 #include "server.h"
  47 #include "sysdep_decls.h"
  48 #include "citserver.h"
  49 #include "support.h"
  50 #include "config.h"
  51 #include "serv_extensions.h"
  52 #include "room_ops.h"
  53 #include "user_ops.h"
  54 #include "policy.h"
  55 #include "database.h"
  56 #include "msgbase.h"
  57 #include "tools.h"
  58 #include "internet_addressing.h"
  59 #include "serv_pop3.h"
  60 #include "md5.h"
  61
  62 #ifdef HAVE_OPENSSL
  63 #include "serv_crypto.h"
  64 #endif
  65
  66
  67
  68 /*
  69  * This cleanup function blows away the temporary memory and files used by
  70  * the POP3 server.
  71  */
  72 void pop3_cleanup_function(void) {
  73
  74         /* Don't do this stuff if this is not a POP3 session! */
  75         if (CC->h_command_function != pop3_command_loop) return;
  76
  77         lprintf(CTDL_DEBUG, "Performing POP3 cleanup hook\n");
  78         if (POP3->msgs != NULL) free(POP3->msgs);
  79 }
  80
  81
  82
  83 /*
  84  * Here's where our POP3 session begins its happy day.
  85  */
  86 void pop3_greeting(void) {
  87         strcpy(CC->cs_clientname, "POP3 session");
  88         CC->internal_pgm = 1;
  89         CtdlAllocUserData(SYM_POP3, sizeof(struct citpop3));
  90         POP3->msgs = NULL;
  91         POP3->num_msgs = 0;
  92
  93         cprintf("+OK Citadel POP3 server %s\r\n",
  94                 CC->cs_nonce);
  95 }
  96
  97
  98 /*
  99  * POP3S is just like POP3, except it goes crypto right away.
 100  */
 101 #ifdef HAVE_OPENSSL
 102 void pop3s_greeting(void) {
 103         CtdlStartTLS(NULL, NULL, NULL);
 104         pop3_greeting();
 105 }
 106 #endif
 107
 108
 109
 110 /*
 111  * Specify user name (implements POP3 "USER" command)
 112  */
 113 void pop3_user(char *argbuf) {
 114         char username[SIZ];
 115
 116         if (CC->logged_in) {
 117                 cprintf("-ERR You are already logged in.\r\n");
 118                 return;
 119         }
 120
 121         strcpy(username, argbuf);
 122         striplt(username);
 123
 124         lprintf(CTDL_DEBUG, "Trying <%s>\n", username);
 125         if (CtdlLoginExistingUser(username) == login_ok) {
 126                 cprintf("+OK Password required for %s\r\n", username);
 127         }
 128         else {
 129                 cprintf("-ERR No such user.\r\n");
 130         }
 131 }
 132
 133
 134
 135 /*
 136  * Back end for pop3_grab_mailbox()
 137  */
 138 void pop3_add_message(long msgnum, void *userdata) {
 139         struct MetaData smi;
 140
 141         ++POP3->num_msgs;
 142         if (POP3->num_msgs < 2) POP3->msgs = malloc(sizeof(struct pop3msg));
 143         else POP3->msgs = realloc(POP3->msgs,
 144                 (POP3->num_msgs * sizeof(struct pop3msg)) ) ;
 145         POP3->msgs[POP3->num_msgs-1].msgnum = msgnum;
 146         POP3->msgs[POP3->num_msgs-1].deleted = 0;
 147
 148         /* We need to know the length of this message when it is printed in
 149          * RFC822 format.  Perhaps we have cached this length in the message's
 150          * metadata record.  If so, great; if not, measure it and then cache
 151          * it for next time.
 152          */
 153         GetMetaData(&smi, msgnum);
 154         if (smi.meta_rfc822_length <= 0L) {
 155                 CC->redirect_buffer = malloc(SIZ);
 156                 CC->redirect_len = 0;
 157                 CC->redirect_alloc = SIZ;
 158                 CtdlOutputMsg(msgnum, MT_RFC822, HEADERS_ALL, 0, 1);
 159                 smi.meta_rfc822_length = CC->redirect_len;
 160                 free(CC->redirect_buffer);
 161                 CC->redirect_buffer = NULL;
 162                 CC->redirect_len = 0;
 163                 CC->redirect_alloc = 0;
 164                 PutMetaData(&smi);
 165         }
 166         POP3->msgs[POP3->num_msgs-1].rfc822_length = smi.meta_rfc822_length;
 167 }
 168
 169
 170
 171 /*
 172  * Open the inbox and read its contents.
 173  * (This should be called only once, by pop3_pass(), and returns the number
 174  * of messages in the inbox, or -1 for error)
 175  */
 176 int pop3_grab_mailbox(void) {
 177         struct visit vbuf;
 178         int i;
 179
 180         if (getroom(&CC->room, MAILROOM) != 0) return(-1);
 181
 182         /* Load up the messages */
 183         CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL,
 184                 pop3_add_message, NULL);
 185
 186         /* Figure out which are old and which are new */
 187         CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
 188         POP3->lastseen = (-1);
 189         if (POP3->num_msgs) for (i=0; i<POP3->num_msgs; ++i) {
 190                 if (is_msg_in_mset(vbuf.v_seen,
 191                    (POP3->msgs[POP3->num_msgs-1].msgnum) )) {
 192                         POP3->lastseen = i;
 193                 }
 194         }
 195
 196         return(POP3->num_msgs);
 197 }
 198
 199 void pop3_login(void)
 200 {
 201         int msgs;
 202
 203         msgs = pop3_grab_mailbox();
 204         if (msgs >= 0) {
 205                 cprintf("+OK %s is logged in (%d messages)\r\n",
 206                         CC->user.fullname, msgs);
 207                 lprintf(CTDL_NOTICE, "POP3 authenticated %s\n", CC->user.fullname);
 208         }
 209         else {
 210                 cprintf("-ERR Can't open your mailbox\r\n");
 211         }
 212
 213 }
 214
 215 void pop3_apop(char *argbuf)
 216 {
 217    char username[SIZ];
 218    char userdigest[MD5_HEXSTRING_SIZE];
 219    char realdigest[MD5_HEXSTRING_SIZE];
 220    char *sptr;
 221
 222    if (CC->logged_in)
 223    {
 224         cprintf("-ERR You are already logged in; not in the AUTHORIZATION phase.\r\n");
 225         return;
 226    }
 227
 228    if ((sptr = strchr(argbuf, ' ')) == NULL)
 229    {
 230         cprintf("-ERR Invalid APOP line.\r\n");
 231         return;
 232    }
 233
 234    *sptr++ = '\0';
 235
 236    while ((*sptr) && isspace(*sptr))
 237       sptr++;
 238
 239    strncpy(username, argbuf, sizeof(username)-1);
 240    username[sizeof(username)-1] = '\0';
 241
 242    memset(userdigest, MD5_HEXSTRING_SIZE, 0);
 243    strncpy(userdigest, sptr, MD5_HEXSTRING_SIZE-1);
 244
 245    if (CtdlLoginExistingUser(username) != login_ok)
 246    {
 247         cprintf("-ERR No such user.\r\n");
 248         return;
 249    }
 250
 251    if (getuser(&CC->user, CC->curr_user))
 252    {
 253         cprintf("-ERR No such user.\r\n");
 254         return;
 255    }
 256
 257    make_apop_string(CC->user.password, CC->cs_nonce, realdigest, sizeof realdigest);
 258    if (!strncasecmp(realdigest, userdigest, MD5_HEXSTRING_SIZE-1))
 259    {
 260         do_login();
 261         pop3_login();
 262    }
 263    else
 264    {
 265         cprintf("-ERR That is NOT the password.\r\n");
 266    }
 267 }
 268
 269
 270 /*
 271  * Authorize with password (implements POP3 "PASS" command)
 272  */
 273 void pop3_pass(char *argbuf) {
 274         char password[SIZ];
 275
 276         strcpy(password, argbuf);
 277         striplt(password);
 278
 279         lprintf(CTDL_DEBUG, "Trying <%s>\n", password);
 280         if (CtdlTryPassword(password) == pass_ok) {
 281                 pop3_login();
 282         }
 283         else {
 284                 cprintf("-ERR That is NOT the password.\r\n");
 285         }
 286 }
 287
 288
 289
 290 /*
 291  * list available msgs
 292  */
 293 void pop3_list(char *argbuf) {
 294         int i;
 295         int which_one;
 296
 297         which_one = atoi(argbuf);
 298
 299         /* "list one" mode */
 300         if (which_one > 0) {
 301                 if (which_one > POP3->num_msgs) {
 302                         cprintf("-ERR no such message, only %d are here\r\n",
 303                                 POP3->num_msgs);
 304                         return;
 305                 }
 306                 else if (POP3->msgs[which_one-1].deleted) {
 307                         cprintf("-ERR Sorry, you deleted that message.\r\n");
 308                         return;
 309                 }
 310                 else {
 311                         cprintf("+OK %d %ld\r\n",
 312                                 which_one,
 313                                 (long)POP3->msgs[which_one-1].rfc822_length
 314                                 );
 315                         return;
 316                 }
 317         }
 318
 319         /* "list all" (scan listing) mode */
 320         else {
 321                 cprintf("+OK Here's your mail:\r\n");
 322                 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
 323                         if (! POP3->msgs[i].deleted) {
 324                                 cprintf("%d %ld\r\n",
 325                                         i+1,
 326                                         (long)POP3->msgs[i].rfc822_length);
 327                         }
 328                 }
 329                 cprintf(".\r\n");
 330         }
 331 }
 332
 333
 334 /*
 335  * STAT (tally up the total message count and byte count) command
 336  */
 337 void pop3_stat(char *argbuf) {
 338         int total_msgs = 0;
 339         size_t total_octets = 0;
 340         int i;
 341
 342         if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
 343                 if (! POP3->msgs[i].deleted) {
 344                         ++total_msgs;
 345                         total_octets += POP3->msgs[i].rfc822_length;
 346                 }
 347         }
 348
 349         cprintf("+OK %d %ld\r\n", total_msgs, (long)total_octets);
 350 }
 351
 352
 353
 354 /*
 355  * RETR command (fetch a message)
 356  */
 357 void pop3_retr(char *argbuf) {
 358         int which_one;
 359
 360         which_one = atoi(argbuf);
 361         if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
 362                 cprintf("-ERR No such message.\r\n");
 363                 return;
 364         }
 365
 366         if (POP3->msgs[which_one - 1].deleted) {
 367                 cprintf("-ERR Sorry, you deleted that message.\r\n");
 368                 return;
 369         }
 370
 371         cprintf("+OK Message %d:\r\n", which_one);
 372         CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum, MT_RFC822, HEADERS_ALL, 0, 1);
 373         cprintf(".\r\n");
 374 }
 375
 376
 377 /*
 378  * TOP command (dumb way of fetching a partial message or headers-only)
 379  */
 380 void pop3_top(char *argbuf) {
 381         int which_one;
 382         int lines_requested = 0;
 383         int lines_dumped = 0;
 384         char buf[1024];
 385         char *msgtext;
 386         char *ptr;
 387         int in_body = 0;
 388         int done = 0;
 389
 390         sscanf(argbuf, "%d %d", &which_one, &lines_requested);
 391         if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
 392                 cprintf("-ERR No such message.\r\n");
 393                 return;
 394         }
 395
 396         if (POP3->msgs[which_one - 1].deleted) {
 397                 cprintf("-ERR Sorry, you deleted that message.\r\n");
 398                 return;
 399         }
 400
 401         CC->redirect_buffer = malloc(SIZ);
 402         CC->redirect_len = 0;
 403         CC->redirect_alloc = SIZ;
 404         CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum,
 405                         MT_RFC822, HEADERS_ALL, 0, 1);
 406         msgtext = CC->redirect_buffer;
 407         CC->redirect_buffer = NULL;
 408         CC->redirect_len = 0;
 409         CC->redirect_alloc = 0;
 410
 411         cprintf("+OK Message %d:\r\n", which_one);
 412
 413         ptr = msgtext;
 414
 415         while (ptr = memreadline(ptr, buf, (sizeof buf - 2)),
 416               ( (*ptr != 0) && (done == 0))) {
 417                 strcat(buf, "\r\n");
 418                 if (in_body == 1) {
 419                         if (lines_dumped >= lines_requested) {
 420                                 done = 1;
 421                         }
 422                 }
 423                 if ((in_body == 0) || (done == 0)) {
 424                         client_write(buf, strlen(buf));
 425                 }
 426                 if (in_body) {
 427                         ++lines_dumped;
 428                 }
 429                 if ((buf[0]==13)||(buf[0]==10)) in_body = 1;
 430         }
 431
 432         if (buf[strlen(buf)-1] != 10) cprintf("\n");
 433         free(msgtext);
 434
 435         cprintf(".\r\n");
 436 }
 437
 438
 439 /*
 440  * DELE (delete message from mailbox)
 441  */
 442 void pop3_dele(char *argbuf) {
 443         int which_one;
 444
 445         which_one = atoi(argbuf);
 446         if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
 447                 cprintf("-ERR No such message.\r\n");
 448                 return;
 449         }
 450
 451         if (POP3->msgs[which_one - 1].deleted) {
 452                 cprintf("-ERR You already deleted that message.\r\n");
 453                 return;
 454         }
 455
 456         /* Flag the message as deleted.  Will expunge during QUIT command. */
 457         POP3->msgs[which_one - 1].deleted = 1;
 458         cprintf("+OK Message %d deleted.\r\n",
 459                 which_one);
 460 }
 461
 462
 463 /* Perform "UPDATE state" stuff
 464  */
 465 void pop3_update(void) {
 466         int i;
 467         struct visit vbuf;
 468
 469         /* Remove messages marked for deletion */
 470         if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
 471                 if (POP3->msgs[i].deleted) {
 472                         CtdlDeleteMessages(MAILROOM,
 473                                 POP3->msgs[i].msgnum, "");
 474                 }
 475         }
 476
 477         /* Set last read pointer */
 478         if (POP3->num_msgs > 0) {
 479                 lgetuser(&CC->user, CC->curr_user);
 480
 481                 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
 482                 snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld",
 483                         POP3->msgs[POP3->num_msgs-1].msgnum);
 484                 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
 485
 486                 lputuser(&CC->user);
 487         }
 488
 489 }
 490
 491
 492 /*
 493  * RSET (reset, i.e. undelete any deleted messages) command
 494  */
 495 void pop3_rset(char *argbuf) {
 496         int i;
 497
 498         if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
 499                 if (POP3->msgs[i].deleted) {
 500                         POP3->msgs[i].deleted = 0;
 501                 }
 502         }
 503         cprintf("+OK Reset completed.\r\n");
 504 }
 505
 506
 507
 508 /*
 509  * LAST (Determine which message is the last unread message)
 510  */
 511 void pop3_last(char *argbuf) {
 512         cprintf("+OK %d\r\n", POP3->lastseen + 1);
 513 }
 514
 515
 516
 517 /*
 518  * UIDL (Universal IDentifier Listing) is easy.  Our 'unique' message
 519  * identifiers are simply the Citadel message numbers in the database.
 520  */
 521 void pop3_uidl(char *argbuf) {
 522         int i;
 523         int which_one;
 524
 525         which_one = atoi(argbuf);
 526
 527         /* "list one" mode */
 528         if (which_one > 0) {
 529                 if (which_one > POP3->num_msgs) {
 530                         cprintf("-ERR no such message, only %d are here\r\n",
 531                                 POP3->num_msgs);
 532                         return;
 533                 }
 534                 else if (POP3->msgs[which_one-1].deleted) {
 535                         cprintf("-ERR Sorry, you deleted that message.\r\n");
 536                         return;
 537                 }
 538                 else {
 539                         cprintf("+OK %d %ld\r\n",
 540                                 which_one,
 541                                 POP3->msgs[which_one-1].msgnum
 542                                 );
 543                         return;
 544                 }
 545         }
 546
 547         /* "list all" (scan listing) mode */
 548         else {
 549                 cprintf("+OK Here's your mail:\r\n");
 550                 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
 551                         if (! POP3->msgs[i].deleted) {
 552                                 cprintf("%d %ld\r\n",
 553                                         i+1,
 554                                         POP3->msgs[i].msgnum);
 555                         }
 556                 }
 557                 cprintf(".\r\n");
 558         }
 559 }
 560
 561
 562 /*
 563  * implements the STLS command (Citadel API version)
 564  */
 565 #ifdef HAVE_OPENSSL
 566 void pop3_stls(void)
 567 {
 568         char ok_response[SIZ];
 569         char nosup_response[SIZ];
 570         char error_response[SIZ];
 571
 572         sprintf(ok_response,
 573                 "+OK Begin TLS negotiation now\r\n");
 574         sprintf(nosup_response,
 575                 "-ERR TLS not supported here\r\n");
 576         sprintf(error_response,
 577                 "-ERR Internal error\r\n");
 578         CtdlStartTLS(ok_response, nosup_response, error_response);
 579 }
 580 #endif
 581
 582
 583
 584
 585
 586
 587
 588 /*
 589  * Main command loop for POP3 sessions.
 590  */
 591 void pop3_command_loop(void) {
 592         char cmdbuf[SIZ];
 593
 594         time(&CC->lastcmd);
 595         memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
 596         if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
 597                 lprintf(CTDL_ERR, "POP3 socket is broken.  Ending session.\r\n");
 598                 CC->kill_me = 1;
 599                 return;
 600         }
 601         lprintf(CTDL_INFO, "POP3: %s\r\n", cmdbuf);
 602         while (strlen(cmdbuf) < 5) strcat(cmdbuf, " ");
 603
 604         if (!strncasecmp(cmdbuf, "NOOP", 4)) {
 605                 cprintf("+OK No operation.\r\n");
 606         }
 607
 608         else if (!strncasecmp(cmdbuf, "QUIT", 4)) {
 609                 cprintf("+OK Goodbye...\r\n");
 610                 pop3_update();
 611                 CC->kill_me = 1;
 612                 return;
 613         }
 614
 615         else if (!strncasecmp(cmdbuf, "USER", 4)) {
 616                 pop3_user(&cmdbuf[5]);
 617         }
 618
 619         else if (!strncasecmp(cmdbuf, "PASS", 4)) {
 620                 pop3_pass(&cmdbuf[5]);
 621         }
 622
 623         else if (!strncasecmp(cmdbuf, "APOP", 4))
 624         {
 625                 pop3_apop(&cmdbuf[5]);
 626         }
 627
 628 #ifdef HAVE_OPENSSL
 629         else if (!strncasecmp(cmdbuf, "STLS", 4)) {
 630                 pop3_stls();
 631         }
 632 #endif
 633
 634         else if (!CC->logged_in) {
 635                 cprintf("-ERR Not logged in.\r\n");
 636         }
 637
 638         else if (!strncasecmp(cmdbuf, "LIST", 4)) {
 639                 pop3_list(&cmdbuf[5]);
 640         }
 641
 642         else if (!strncasecmp(cmdbuf, "STAT", 4)) {
 643                 pop3_stat(&cmdbuf[5]);
 644         }
 645
 646         else if (!strncasecmp(cmdbuf, "RETR", 4)) {
 647                 pop3_retr(&cmdbuf[5]);
 648         }
 649
 650         else if (!strncasecmp(cmdbuf, "DELE", 4)) {
 651                 pop3_dele(&cmdbuf[5]);
 652         }
 653
 654         else if (!strncasecmp(cmdbuf, "RSET", 4)) {
 655                 pop3_rset(&cmdbuf[5]);
 656         }
 657
 658         else if (!strncasecmp(cmdbuf, "UIDL", 4)) {
 659                 pop3_uidl(&cmdbuf[5]);
 660         }
 661
 662         else if (!strncasecmp(cmdbuf, "TOP", 3)) {
 663                 pop3_top(&cmdbuf[4]);
 664         }
 665
 666         else if (!strncasecmp(cmdbuf, "LAST", 4)) {
 667                 pop3_last(&cmdbuf[4]);
 668         }
 669
 670         else {
 671                 cprintf("-ERR I'm afraid I can't do that.\r\n");
 672         }
 673
 674 }
 675
 676
 677
 678 char *serv_pop3_init(void)
 679 {
 680         CtdlRegisterServiceHook(config.c_pop3_port,
 681                                 NULL,
 682                                 pop3_greeting,
 683                                 pop3_command_loop,
 684                                 NULL);
 685 #ifdef HAVE_OPENSSL
 686         CtdlRegisterServiceHook(config.c_pop3s_port,
 687                                 NULL,
 688                                 pop3s_greeting,
 689                                 pop3_command_loop,
 690                                 NULL);
 691 #endif
 692         CtdlRegisterSessionHook(pop3_cleanup_function, EVT_STOP);
 693         return "$Id$";
 694 }