4 * POP3 service for the Citadel system
6 * Copyright (c) 1998-2009 by the citadel.org team
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.
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.
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
22 * Current status of standards conformance:
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.
41 #include <sys/types.h>
43 #if TIME_WITH_SYS_TIME
44 # include <sys/time.h>
48 # include <sys/time.h>
58 #include <libcitadel.h>
61 #include "citserver.h"
69 #include "internet_addressing.h"
70 #include "serv_pop3.h"
75 #include "ctdl_module.h"
80 * This cleanup function blows away the temporary memory and files used by
83 void pop3_cleanup_function(void) {
85 /* Don't do this stuff if this is not a POP3 session! */
86 if (CC->h_command_function != pop3_command_loop) return;
88 CtdlLogPrintf(CTDL_DEBUG, "Performing POP3 cleanup hook\n");
89 if (POP3->msgs != NULL) free(POP3->msgs);
97 * Here's where our POP3 session begins its happy day.
99 void pop3_greeting(void) {
100 strcpy(CC->cs_clientname, "POP3 session");
101 CC->internal_pgm = 1;
102 CC->session_specific_data = malloc(sizeof(struct citpop3));
103 memset(POP3, 0, sizeof(struct citpop3));
105 cprintf("+OK Citadel POP3 server %s\r\n",
111 * POP3S is just like POP3, except it goes crypto right away.
113 void pop3s_greeting(void) {
114 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
116 /* kill session if no crypto */
118 if (!CC->redirect_ssl) CC->kill_me = 1;
129 * Specify user name (implements POP3 "USER" command)
131 void pop3_user(char *argbuf) {
135 cprintf("-ERR You are already logged in.\r\n");
139 strcpy(username, argbuf);
142 /* CtdlLogPrintf(CTDL_DEBUG, "Trying <%s>\n", username); */
143 if (CtdlLoginExistingUser(NULL, username) == login_ok) {
144 cprintf("+OK Password required for %s\r\n", username);
147 cprintf("-ERR No such user.\r\n");
154 * Back end for pop3_grab_mailbox()
156 void pop3_add_message(long msgnum, void *userdata) {
160 if (POP3->num_msgs < 2) POP3->msgs = malloc(sizeof(struct pop3msg));
161 else POP3->msgs = realloc(POP3->msgs,
162 (POP3->num_msgs * sizeof(struct pop3msg)) ) ;
163 POP3->msgs[POP3->num_msgs-1].msgnum = msgnum;
164 POP3->msgs[POP3->num_msgs-1].deleted = 0;
166 /* We need to know the length of this message when it is printed in
167 * RFC822 format. Perhaps we have cached this length in the message's
168 * metadata record. If so, great; if not, measure it and then cache
171 GetMetaData(&smi, msgnum);
172 if (smi.meta_rfc822_length <= 0L) {
173 CC->redirect_buffer = malloc(SIZ);
174 CC->redirect_len = 0;
175 CC->redirect_alloc = SIZ;
176 CtdlOutputMsg(msgnum, MT_RFC822, HEADERS_ALL, 0, 1, NULL, SUPPRESS_ENV_TO);
177 smi.meta_rfc822_length = CC->redirect_len;
178 free(CC->redirect_buffer);
179 CC->redirect_buffer = NULL;
180 CC->redirect_len = 0;
181 CC->redirect_alloc = 0;
184 POP3->msgs[POP3->num_msgs-1].rfc822_length = smi.meta_rfc822_length;
190 * Open the inbox and read its contents.
191 * (This should be called only once, by pop3_pass(), and returns the number
192 * of messages in the inbox, or -1 for error)
194 int pop3_grab_mailbox(void) {
198 if (getroom(&CC->room, MAILROOM) != 0) return(-1);
200 /* Load up the messages */
201 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
202 pop3_add_message, NULL);
204 /* Figure out which are old and which are new */
205 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
206 POP3->lastseen = (-1);
207 if (POP3->num_msgs) for (i=0; i<POP3->num_msgs; ++i) {
208 if (is_msg_in_sequence_set(vbuf.v_seen,
209 (POP3->msgs[POP3->num_msgs-1].msgnum) )) {
214 return(POP3->num_msgs);
217 void pop3_login(void)
221 msgs = pop3_grab_mailbox();
223 cprintf("+OK %s is logged in (%d messages)\r\n",
224 CC->user.fullname, msgs);
225 CtdlLogPrintf(CTDL_NOTICE, "POP3 authenticated %s\n", CC->user.fullname);
228 cprintf("-ERR Can't open your mailbox\r\n");
233 void pop3_apop(char *argbuf)
236 char userdigest[MD5_HEXSTRING_SIZE];
237 char realdigest[MD5_HEXSTRING_SIZE];
242 cprintf("-ERR You are already logged in; not in the AUTHORIZATION phase.\r\n");
246 if ((sptr = strchr(argbuf, ' ')) == NULL)
248 cprintf("-ERR Invalid APOP line.\r\n");
254 while ((*sptr) && isspace(*sptr))
257 strncpy(username, argbuf, sizeof(username)-1);
258 username[sizeof(username)-1] = '\0';
260 memset(userdigest, MD5_HEXSTRING_SIZE, 0);
261 strncpy(userdigest, sptr, MD5_HEXSTRING_SIZE-1);
263 if (CtdlLoginExistingUser(NULL, username) != login_ok)
265 cprintf("-ERR No such user.\r\n");
269 if (getuser(&CC->user, CC->curr_user))
271 cprintf("-ERR No such user.\r\n");
275 make_apop_string(CC->user.password, CC->cs_nonce, realdigest, sizeof realdigest);
276 if (!strncasecmp(realdigest, userdigest, MD5_HEXSTRING_SIZE-1))
283 cprintf("-ERR That is NOT the password.\r\n");
289 * Authorize with password (implements POP3 "PASS" command)
291 void pop3_pass(char *argbuf) {
294 strcpy(password, argbuf);
297 /* CtdlLogPrintf(CTDL_DEBUG, "Trying <%s>\n", password); */
298 if (CtdlTryPassword(password) == pass_ok) {
302 cprintf("-ERR That is NOT the password.\r\n");
309 * list available msgs
311 void pop3_list(char *argbuf) {
315 which_one = atoi(argbuf);
317 /* "list one" mode */
319 if (which_one > POP3->num_msgs) {
320 cprintf("-ERR no such message, only %d are here\r\n",
324 else if (POP3->msgs[which_one-1].deleted) {
325 cprintf("-ERR Sorry, you deleted that message.\r\n");
329 cprintf("+OK %d %ld\r\n",
331 (long)POP3->msgs[which_one-1].rfc822_length
337 /* "list all" (scan listing) mode */
339 cprintf("+OK Here's your mail:\r\n");
340 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
341 if (! POP3->msgs[i].deleted) {
342 cprintf("%d %ld\r\n",
344 (long)POP3->msgs[i].rfc822_length);
353 * STAT (tally up the total message count and byte count) command
355 void pop3_stat(char *argbuf) {
357 size_t total_octets = 0;
360 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
361 if (! POP3->msgs[i].deleted) {
363 total_octets += POP3->msgs[i].rfc822_length;
367 cprintf("+OK %d %ld\r\n", total_msgs, (long)total_octets);
373 * RETR command (fetch a message)
375 void pop3_retr(char *argbuf) {
378 which_one = atoi(argbuf);
379 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
380 cprintf("-ERR No such message.\r\n");
384 if (POP3->msgs[which_one - 1].deleted) {
385 cprintf("-ERR Sorry, you deleted that message.\r\n");
389 cprintf("+OK Message %d:\r\n", which_one);
390 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum,
391 MT_RFC822, HEADERS_ALL, 0, 1, NULL,
392 (ESC_DOT|SUPPRESS_ENV_TO)
399 * TOP command (dumb way of fetching a partial message or headers-only)
401 void pop3_top(char *argbuf) {
403 int lines_requested = 0;
404 int lines_dumped = 0;
411 sscanf(argbuf, "%d %d", &which_one, &lines_requested);
412 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
413 cprintf("-ERR No such message.\r\n");
417 if (POP3->msgs[which_one - 1].deleted) {
418 cprintf("-ERR Sorry, you deleted that message.\r\n");
422 CC->redirect_buffer = malloc(SIZ);
423 CC->redirect_len = 0;
424 CC->redirect_alloc = SIZ;
425 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum, MT_RFC822, HEADERS_ALL, 0, 1, NULL, SUPPRESS_ENV_TO);
426 msgtext = CC->redirect_buffer;
427 CC->redirect_buffer = NULL;
428 CC->redirect_len = 0;
429 CC->redirect_alloc = 0;
431 cprintf("+OK Message %d:\r\n", which_one);
435 while (ptr = memreadline(ptr, buf, (sizeof buf - 2)),
436 ( (*ptr != 0) && (done == 0))) {
439 if (lines_dumped >= lines_requested) {
443 if ((in_body == 0) || (done == 0)) {
444 client_write(buf, strlen(buf));
449 if ((buf[0]==13)||(buf[0]==10)) in_body = 1;
452 if (buf[strlen(buf)-1] != 10) cprintf("\n");
460 * DELE (delete message from mailbox)
462 void pop3_dele(char *argbuf) {
465 which_one = atoi(argbuf);
466 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
467 cprintf("-ERR No such message.\r\n");
471 if (POP3->msgs[which_one - 1].deleted) {
472 cprintf("-ERR You already deleted that message.\r\n");
476 /* Flag the message as deleted. Will expunge during QUIT command. */
477 POP3->msgs[which_one - 1].deleted = 1;
478 cprintf("+OK Message %d deleted.\r\n",
483 /* Perform "UPDATE state" stuff
485 void pop3_update(void) {
489 long *deletemsgs = NULL;
490 int num_deletemsgs = 0;
492 /* Remove messages marked for deletion */
493 if (POP3->num_msgs > 0) {
494 deletemsgs = malloc(POP3->num_msgs * sizeof(long));
495 for (i=0; i<POP3->num_msgs; ++i) {
496 if (POP3->msgs[i].deleted) {
497 deletemsgs[num_deletemsgs++] = POP3->msgs[i].msgnum;
500 if (num_deletemsgs > 0) {
501 CtdlDeleteMessages(MAILROOM, deletemsgs, num_deletemsgs, "");
506 /* Set last read pointer */
507 if (POP3->num_msgs > 0) {
508 lgetuser(&CC->user, CC->curr_user);
510 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
511 snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld",
512 POP3->msgs[POP3->num_msgs-1].msgnum);
513 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
522 * RSET (reset, i.e. undelete any deleted messages) command
524 void pop3_rset(char *argbuf) {
527 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
528 if (POP3->msgs[i].deleted) {
529 POP3->msgs[i].deleted = 0;
532 cprintf("+OK Reset completed.\r\n");
538 * LAST (Determine which message is the last unread message)
540 void pop3_last(char *argbuf) {
541 cprintf("+OK %d\r\n", POP3->lastseen + 1);
546 * CAPA is a command which tells the client which POP3 extensions
549 void pop3_capa(void) {
550 cprintf("+OK Capability list follows\r\n"
554 "IMPLEMENTATION %s\r\n"
564 * UIDL (Universal IDentifier Listing) is easy. Our 'unique' message
565 * identifiers are simply the Citadel message numbers in the database.
567 void pop3_uidl(char *argbuf) {
571 which_one = atoi(argbuf);
573 /* "list one" mode */
575 if (which_one > POP3->num_msgs) {
576 cprintf("-ERR no such message, only %d are here\r\n",
580 else if (POP3->msgs[which_one-1].deleted) {
581 cprintf("-ERR Sorry, you deleted that message.\r\n");
585 cprintf("+OK %d %ld\r\n",
587 POP3->msgs[which_one-1].msgnum
593 /* "list all" (scan listing) mode */
595 cprintf("+OK Here's your mail:\r\n");
596 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
597 if (! POP3->msgs[i].deleted) {
598 cprintf("%d %ld\r\n",
600 POP3->msgs[i].msgnum);
609 * implements the STLS command (Citadel API version)
613 char ok_response[SIZ];
614 char nosup_response[SIZ];
615 char error_response[SIZ];
618 "+OK Begin TLS negotiation now\r\n");
619 sprintf(nosup_response,
620 "-ERR TLS not supported here\r\n");
621 sprintf(error_response,
622 "-ERR Internal error\r\n");
623 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
633 * Main command loop for POP3 sessions.
635 void pop3_command_loop(void) {
639 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
640 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
641 CtdlLogPrintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
645 if (!strncasecmp(cmdbuf, "PASS", 4)) {
646 CtdlLogPrintf(CTDL_INFO, "POP3: PASS...\r\n");
649 CtdlLogPrintf(CTDL_INFO, "POP3: %s\r\n", cmdbuf);
651 while (strlen(cmdbuf) < 5) strcat(cmdbuf, " ");
653 if (!strncasecmp(cmdbuf, "NOOP", 4)) {
654 cprintf("+OK No operation.\r\n");
657 else if (!strncasecmp(cmdbuf, "CAPA", 4)) {
661 else if (!strncasecmp(cmdbuf, "QUIT", 4)) {
662 cprintf("+OK Goodbye...\r\n");
668 else if (!strncasecmp(cmdbuf, "USER", 4)) {
669 pop3_user(&cmdbuf[5]);
672 else if (!strncasecmp(cmdbuf, "PASS", 4)) {
673 pop3_pass(&cmdbuf[5]);
676 else if (!strncasecmp(cmdbuf, "APOP", 4))
678 pop3_apop(&cmdbuf[5]);
682 else if (!strncasecmp(cmdbuf, "STLS", 4)) {
687 else if (!CC->logged_in) {
688 cprintf("-ERR Not logged in.\r\n");
691 else if (CC->nologin) {
692 cprintf("-ERR System busy, try later.\r\n");
696 else if (!strncasecmp(cmdbuf, "LIST", 4)) {
697 pop3_list(&cmdbuf[5]);
700 else if (!strncasecmp(cmdbuf, "STAT", 4)) {
701 pop3_stat(&cmdbuf[5]);
704 else if (!strncasecmp(cmdbuf, "RETR", 4)) {
705 pop3_retr(&cmdbuf[5]);
708 else if (!strncasecmp(cmdbuf, "DELE", 4)) {
709 pop3_dele(&cmdbuf[5]);
712 else if (!strncasecmp(cmdbuf, "RSET", 4)) {
713 pop3_rset(&cmdbuf[5]);
716 else if (!strncasecmp(cmdbuf, "UIDL", 4)) {
717 pop3_uidl(&cmdbuf[5]);
720 else if (!strncasecmp(cmdbuf, "TOP", 3)) {
721 pop3_top(&cmdbuf[4]);
724 else if (!strncasecmp(cmdbuf, "LAST", 4)) {
725 pop3_last(&cmdbuf[4]);
729 cprintf("-ERR I'm afraid I can't do that.\r\n");
734 const char *CitadelServicePop3="POP3";
735 const char *CitadelServicePop3S="POP3S";
738 CTDL_MODULE_INIT(pop3)
742 CtdlRegisterServiceHook(config.c_pop3_port,
749 CtdlRegisterServiceHook(config.c_pop3s_port,
754 CitadelServicePop3S);
756 CtdlRegisterSessionHook(pop3_cleanup_function, EVT_STOP);
759 /* return our Subversion id for the Log */