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