citadel/modules/pop3/serv_pop3.c

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