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