More removal of $Id$ tags
[citadel.git] / citadel / modules / pop3 / serv_pop3.c
1 /*
2  * POP3 service for the Citadel system
3  *
4  * Copyright (c) 1998-2009 by the citadel.org team
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 3 of the License, or
9  *  (at your option) any later version.
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  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
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         CtdlLogPrintf(CTDL_DEBUG, "Performing POP3 cleanup hook\n");
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 %s\r\n",
102                 CC->cs_nonce);
103 }
104
105
106 /*
107  * POP3S is just like POP3, except it goes crypto right away.
108  */
109 void pop3s_greeting(void) {
110         CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
111
112 /* kill session if no crypto */
113 #ifdef HAVE_OPENSSL
114         if (!CC->redirect_ssl) CC->kill_me = 1;
115 #else
116         CC->kill_me = 1;
117 #endif
118
119         pop3_greeting();
120 }
121
122
123
124 /*
125  * Specify user name (implements POP3 "USER" command)
126  */
127 void pop3_user(char *argbuf) {
128         char username[SIZ];
129
130         if (CC->logged_in) {
131                 cprintf("-ERR You are already logged in.\r\n");
132                 return;
133         }
134
135         strcpy(username, argbuf);
136         striplt(username);
137
138         /* CtdlLogPrintf(CTDL_DEBUG, "Trying <%s>\n", username); */
139         if (CtdlLoginExistingUser(NULL, username) == login_ok) {
140                 cprintf("+OK Password required for %s\r\n", username);
141         }
142         else {
143                 cprintf("-ERR No such user.\r\n");
144         }
145 }
146
147
148
149 /*
150  * Back end for pop3_grab_mailbox()
151  */
152 void pop3_add_message(long msgnum, void *userdata) {
153         struct MetaData smi;
154
155         ++POP3->num_msgs;
156         if (POP3->num_msgs < 2) POP3->msgs = malloc(sizeof(struct pop3msg));
157         else POP3->msgs = realloc(POP3->msgs, 
158                 (POP3->num_msgs * sizeof(struct pop3msg)) ) ;
159         POP3->msgs[POP3->num_msgs-1].msgnum = msgnum;
160         POP3->msgs[POP3->num_msgs-1].deleted = 0;
161
162         /* We need to know the length of this message when it is printed in
163          * RFC822 format.  Perhaps we have cached this length in the message's
164          * metadata record.  If so, great; if not, measure it and then cache
165          * it for next time.
166          */
167         GetMetaData(&smi, msgnum);
168         if (smi.meta_rfc822_length <= 0L) {
169                 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
170                 CtdlOutputMsg(msgnum, MT_RFC822, HEADERS_ALL, 0, 1, NULL, SUPPRESS_ENV_TO);
171                 smi.meta_rfc822_length = StrLength(CC->redirect_buffer);
172                 FreeStrBuf(&CC->redirect_buffer); /* TODO: WHEW, all this for just knowing the length???? */
173                 PutMetaData(&smi);
174         }
175         POP3->msgs[POP3->num_msgs-1].rfc822_length = smi.meta_rfc822_length;
176 }
177
178
179
180 /*
181  * Open the inbox and read its contents.
182  * (This should be called only once, by pop3_pass(), and returns the number
183  * of messages in the inbox, or -1 for error)
184  */
185 int pop3_grab_mailbox(void) {
186         visit vbuf;
187         int i;
188
189         if (CtdlGetRoom(&CC->room, MAILROOM) != 0) return(-1);
190
191         /* Load up the messages */
192         CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
193                 pop3_add_message, NULL);
194
195         /* Figure out which are old and which are new */
196         CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
197         POP3->lastseen = (-1);
198         if (POP3->num_msgs) for (i=0; i<POP3->num_msgs; ++i) {
199                 if (is_msg_in_sequence_set(vbuf.v_seen,
200                    (POP3->msgs[POP3->num_msgs-1].msgnum) )) {
201                         POP3->lastseen = i;
202                 }
203         }
204
205         return(POP3->num_msgs);
206 }
207
208 void pop3_login(void)
209 {
210         int msgs;
211         
212         msgs = pop3_grab_mailbox();
213         if (msgs >= 0) {
214                 cprintf("+OK %s is logged in (%d messages)\r\n",
215                         CC->user.fullname, msgs);
216                 CtdlLogPrintf(CTDL_NOTICE, "POP3 authenticated %s\n", CC->user.fullname);
217         }
218         else {
219                 cprintf("-ERR Can't open your mailbox\r\n");
220         }
221         
222 }
223
224 void pop3_apop(char *argbuf)
225 {
226    char username[SIZ];
227    char userdigest[MD5_HEXSTRING_SIZE];
228    char realdigest[MD5_HEXSTRING_SIZE];
229    char *sptr;
230    
231    if (CC->logged_in)
232    {
233         cprintf("-ERR You are already logged in; not in the AUTHORIZATION phase.\r\n");
234         return;
235    }
236    
237    if ((sptr = strchr(argbuf, ' ')) == NULL)
238    {
239         cprintf("-ERR Invalid APOP line.\r\n");
240         return;
241    }
242    
243    *sptr++ = '\0';
244    
245    while ((*sptr) && isspace(*sptr))
246       sptr++;
247    
248    strncpy(username, argbuf, sizeof(username)-1);
249    username[sizeof(username)-1] = '\0';
250    
251    memset(userdigest, MD5_HEXSTRING_SIZE, 0);
252    strncpy(userdigest, sptr, MD5_HEXSTRING_SIZE-1);
253    
254    if (CtdlLoginExistingUser(NULL, username) != login_ok)
255    {
256         cprintf("-ERR No such user.\r\n");
257         return;
258    }
259    
260    if (CtdlGetUser(&CC->user, CC->curr_user))
261    {
262         cprintf("-ERR No such user.\r\n");
263         return;
264    }
265    
266    make_apop_string(CC->user.password, CC->cs_nonce, realdigest, sizeof realdigest);
267    if (!strncasecmp(realdigest, userdigest, MD5_HEXSTRING_SIZE-1))
268    {
269         do_login();
270         pop3_login();
271    }
272    else
273    {
274         cprintf("-ERR That is NOT the password.\r\n");
275    }
276 }
277
278
279 /*
280  * Authorize with password (implements POP3 "PASS" command)
281  */
282 void pop3_pass(char *argbuf) {
283         char password[SIZ];
284
285         safestrncpy(password, argbuf, sizeof password);
286         striplt(password);
287
288         /* CtdlLogPrintf(CTDL_DEBUG, "Trying <%s>\n", password); */
289         if (CtdlTryPassword(password, strlen(password)) == pass_ok) {
290                 pop3_login();
291         }
292         else {
293                 cprintf("-ERR That is NOT the password.\r\n");
294         }
295 }
296
297
298
299 /*
300  * list available msgs
301  */
302 void pop3_list(char *argbuf) {
303         int i;
304         int which_one;
305
306         which_one = atoi(argbuf);
307
308         /* "list one" mode */
309         if (which_one > 0) {
310                 if (which_one > POP3->num_msgs) {
311                         cprintf("-ERR no such message, only %d are here\r\n",
312                                 POP3->num_msgs);
313                         return;
314                 }
315                 else if (POP3->msgs[which_one-1].deleted) {
316                         cprintf("-ERR Sorry, you deleted that message.\r\n");
317                         return;
318                 }
319                 else {
320                         cprintf("+OK %d %ld\r\n",
321                                 which_one,
322                                 (long)POP3->msgs[which_one-1].rfc822_length
323                                 );
324                         return;
325                 }
326         }
327
328         /* "list all" (scan listing) mode */
329         else {
330                 cprintf("+OK Here's your mail:\r\n");
331                 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
332                         if (! POP3->msgs[i].deleted) {
333                                 cprintf("%d %ld\r\n",
334                                         i+1,
335                                         (long)POP3->msgs[i].rfc822_length);
336                         }
337                 }
338                 cprintf(".\r\n");
339         }
340 }
341
342
343 /*
344  * STAT (tally up the total message count and byte count) command
345  */
346 void pop3_stat(char *argbuf) {
347         int total_msgs = 0;
348         size_t total_octets = 0;
349         int i;
350         
351         if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
352                 if (! POP3->msgs[i].deleted) {
353                         ++total_msgs;
354                         total_octets += POP3->msgs[i].rfc822_length;
355                 }
356         }
357
358         cprintf("+OK %d %ld\r\n", total_msgs, (long)total_octets);
359 }
360
361
362
363 /*
364  * RETR command (fetch a message)
365  */
366 void pop3_retr(char *argbuf) {
367         int which_one;
368
369         which_one = atoi(argbuf);
370         if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
371                 cprintf("-ERR No such message.\r\n");
372                 return;
373         }
374
375         if (POP3->msgs[which_one - 1].deleted) {
376                 cprintf("-ERR Sorry, you deleted that message.\r\n");
377                 return;
378         }
379
380         cprintf("+OK Message %d:\r\n", which_one);
381         CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum,
382                 MT_RFC822, HEADERS_ALL, 0, 1, NULL,
383                 (ESC_DOT|SUPPRESS_ENV_TO)
384         );
385         cprintf(".\r\n");
386 }
387
388
389 /*
390  * TOP command (dumb way of fetching a partial message or headers-only)
391  */
392 void pop3_top(char *argbuf) {
393         int which_one;
394         int lines_requested = 0;
395         int lines_dumped = 0;
396         char buf[1024];
397         StrBuf *msgtext;
398         const char *ptr;
399         int in_body = 0;
400         int done = 0;
401
402         sscanf(argbuf, "%d %d", &which_one, &lines_requested);
403         if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
404                 cprintf("-ERR No such message.\r\n");
405                 return;
406         }
407
408         if (POP3->msgs[which_one - 1].deleted) {
409                 cprintf("-ERR Sorry, you deleted that message.\r\n");
410                 return;
411         }
412
413         CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
414         CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum, MT_RFC822, HEADERS_ALL, 0, 1, NULL, SUPPRESS_ENV_TO);
415         msgtext = CC->redirect_buffer;
416         CC->redirect_buffer = NULL;
417
418         cprintf("+OK Message %d:\r\n", which_one);
419         
420         ptr = ChrPtr(msgtext);
421         while (ptr = cmemreadline(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         FreeStrBuf(&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         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                 CtdlGetUserLock(&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                 CtdlPutUserLock(&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 "pop3";
747 }