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"
68 #include "internet_addressing.h"
69 #include "serv_pop3.h"
74 #include "ctdl_module.h"
79 * This cleanup function blows away the temporary memory and files used by
82 void pop3_cleanup_function(void) {
84 /* Don't do this stuff if this is not a POP3 session! */
85 if (CC->h_command_function != pop3_command_loop) return;
87 CtdlLogPrintf(CTDL_DEBUG, "Performing POP3 cleanup hook\n");
88 if (POP3->msgs != NULL) free(POP3->msgs);
96 * Here's where our POP3 session begins its happy day.
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));
104 cprintf("+OK Citadel POP3 server %s\r\n",
110 * POP3S is just like POP3, except it goes crypto right away.
112 void pop3s_greeting(void) {
113 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
115 /* kill session if no crypto */
117 if (!CC->redirect_ssl) CC->kill_me = 1;
128 * Specify user name (implements POP3 "USER" command)
130 void pop3_user(char *argbuf) {
134 cprintf("-ERR You are already logged in.\r\n");
138 strcpy(username, argbuf);
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);
146 cprintf("-ERR No such user.\r\n");
153 * Back end for pop3_grab_mailbox()
155 void pop3_add_message(long msgnum, void *userdata) {
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;
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
170 GetMetaData(&smi, msgnum);
171 if (smi.meta_rfc822_length <= 0L) {
172 CC->redirect_buffer = malloc(SIZ);
173 CC->redirect_len = 0;
174 CC->redirect_alloc = SIZ;
175 CtdlOutputMsg(msgnum, MT_RFC822, HEADERS_ALL, 0, 1, NULL, SUPPRESS_ENV_TO);
176 smi.meta_rfc822_length = CC->redirect_len;
177 free(CC->redirect_buffer);
178 CC->redirect_buffer = NULL;
179 CC->redirect_len = 0;
180 CC->redirect_alloc = 0;
183 POP3->msgs[POP3->num_msgs-1].rfc822_length = smi.meta_rfc822_length;
189 * Open the inbox and read its contents.
190 * (This should be called only once, by pop3_pass(), and returns the number
191 * of messages in the inbox, or -1 for error)
193 int pop3_grab_mailbox(void) {
197 if (CtdlGetRoom(&CC->room, MAILROOM) != 0) return(-1);
199 /* Load up the messages */
200 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
201 pop3_add_message, NULL);
203 /* Figure out which are old and which are new */
204 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
205 POP3->lastseen = (-1);
206 if (POP3->num_msgs) for (i=0; i<POP3->num_msgs; ++i) {
207 if (is_msg_in_sequence_set(vbuf.v_seen,
208 (POP3->msgs[POP3->num_msgs-1].msgnum) )) {
213 return(POP3->num_msgs);
216 void pop3_login(void)
220 msgs = pop3_grab_mailbox();
222 cprintf("+OK %s is logged in (%d messages)\r\n",
223 CC->user.fullname, msgs);
224 CtdlLogPrintf(CTDL_NOTICE, "POP3 authenticated %s\n", CC->user.fullname);
227 cprintf("-ERR Can't open your mailbox\r\n");
232 void pop3_apop(char *argbuf)
235 char userdigest[MD5_HEXSTRING_SIZE];
236 char realdigest[MD5_HEXSTRING_SIZE];
241 cprintf("-ERR You are already logged in; not in the AUTHORIZATION phase.\r\n");
245 if ((sptr = strchr(argbuf, ' ')) == NULL)
247 cprintf("-ERR Invalid APOP line.\r\n");
253 while ((*sptr) && isspace(*sptr))
256 strncpy(username, argbuf, sizeof(username)-1);
257 username[sizeof(username)-1] = '\0';
259 memset(userdigest, MD5_HEXSTRING_SIZE, 0);
260 strncpy(userdigest, sptr, MD5_HEXSTRING_SIZE-1);
262 if (CtdlLoginExistingUser(NULL, username) != login_ok)
264 cprintf("-ERR No such user.\r\n");
268 if (getuser(&CC->user, CC->curr_user))
270 cprintf("-ERR No such user.\r\n");
274 make_apop_string(CC->user.password, CC->cs_nonce, realdigest, sizeof realdigest);
275 if (!strncasecmp(realdigest, userdigest, MD5_HEXSTRING_SIZE-1))
282 cprintf("-ERR That is NOT the password.\r\n");
288 * Authorize with password (implements POP3 "PASS" command)
290 void pop3_pass(char *argbuf) {
293 strcpy(password, argbuf);
296 /* CtdlLogPrintf(CTDL_DEBUG, "Trying <%s>\n", password); */
297 if (CtdlTryPassword(password) == pass_ok) {
301 cprintf("-ERR That is NOT the password.\r\n");
308 * list available msgs
310 void pop3_list(char *argbuf) {
314 which_one = atoi(argbuf);
316 /* "list one" mode */
318 if (which_one > POP3->num_msgs) {
319 cprintf("-ERR no such message, only %d are here\r\n",
323 else if (POP3->msgs[which_one-1].deleted) {
324 cprintf("-ERR Sorry, you deleted that message.\r\n");
328 cprintf("+OK %d %ld\r\n",
330 (long)POP3->msgs[which_one-1].rfc822_length
336 /* "list all" (scan listing) mode */
338 cprintf("+OK Here's your mail:\r\n");
339 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
340 if (! POP3->msgs[i].deleted) {
341 cprintf("%d %ld\r\n",
343 (long)POP3->msgs[i].rfc822_length);
352 * STAT (tally up the total message count and byte count) command
354 void pop3_stat(char *argbuf) {
356 size_t total_octets = 0;
359 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
360 if (! POP3->msgs[i].deleted) {
362 total_octets += POP3->msgs[i].rfc822_length;
366 cprintf("+OK %d %ld\r\n", total_msgs, (long)total_octets);
372 * RETR command (fetch a message)
374 void pop3_retr(char *argbuf) {
377 which_one = atoi(argbuf);
378 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
379 cprintf("-ERR No such message.\r\n");
383 if (POP3->msgs[which_one - 1].deleted) {
384 cprintf("-ERR Sorry, you deleted that message.\r\n");
388 cprintf("+OK Message %d:\r\n", which_one);
389 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum,
390 MT_RFC822, HEADERS_ALL, 0, 1, NULL,
391 (ESC_DOT|SUPPRESS_ENV_TO)
398 * TOP command (dumb way of fetching a partial message or headers-only)
400 void pop3_top(char *argbuf) {
402 int lines_requested = 0;
403 int lines_dumped = 0;
410 sscanf(argbuf, "%d %d", &which_one, &lines_requested);
411 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
412 cprintf("-ERR No such message.\r\n");
416 if (POP3->msgs[which_one - 1].deleted) {
417 cprintf("-ERR Sorry, you deleted that message.\r\n");
421 CC->redirect_buffer = malloc(SIZ);
422 CC->redirect_len = 0;
423 CC->redirect_alloc = SIZ;
424 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum, MT_RFC822, HEADERS_ALL, 0, 1, NULL, SUPPRESS_ENV_TO);
425 msgtext = CC->redirect_buffer;
426 CC->redirect_buffer = NULL;
427 CC->redirect_len = 0;
428 CC->redirect_alloc = 0;
430 cprintf("+OK Message %d:\r\n", which_one);
434 while (ptr = memreadline(ptr, buf, (sizeof buf - 2)),
435 ( (*ptr != 0) && (done == 0))) {
438 if (lines_dumped >= lines_requested) {
442 if ((in_body == 0) || (done == 0)) {
443 client_write(buf, strlen(buf));
448 if ((buf[0]==13)||(buf[0]==10)) in_body = 1;
451 if (buf[strlen(buf)-1] != 10) cprintf("\n");
459 * DELE (delete message from mailbox)
461 void pop3_dele(char *argbuf) {
464 which_one = atoi(argbuf);
465 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
466 cprintf("-ERR No such message.\r\n");
470 if (POP3->msgs[which_one - 1].deleted) {
471 cprintf("-ERR You already deleted that message.\r\n");
475 /* Flag the message as deleted. Will expunge during QUIT command. */
476 POP3->msgs[which_one - 1].deleted = 1;
477 cprintf("+OK Message %d deleted.\r\n",
482 /* Perform "UPDATE state" stuff
484 void pop3_update(void) {
488 long *deletemsgs = NULL;
489 int num_deletemsgs = 0;
491 /* Remove messages marked for deletion */
492 if (POP3->num_msgs > 0) {
493 deletemsgs = malloc(POP3->num_msgs * sizeof(long));
494 for (i=0; i<POP3->num_msgs; ++i) {
495 if (POP3->msgs[i].deleted) {
496 deletemsgs[num_deletemsgs++] = POP3->msgs[i].msgnum;
499 if (num_deletemsgs > 0) {
500 CtdlDeleteMessages(MAILROOM, deletemsgs, num_deletemsgs, "");
505 /* Set last read pointer */
506 if (POP3->num_msgs > 0) {
507 lgetuser(&CC->user, CC->curr_user);
509 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
510 snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld",
511 POP3->msgs[POP3->num_msgs-1].msgnum);
512 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
521 * RSET (reset, i.e. undelete any deleted messages) command
523 void pop3_rset(char *argbuf) {
526 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
527 if (POP3->msgs[i].deleted) {
528 POP3->msgs[i].deleted = 0;
531 cprintf("+OK Reset completed.\r\n");
537 * LAST (Determine which message is the last unread message)
539 void pop3_last(char *argbuf) {
540 cprintf("+OK %d\r\n", POP3->lastseen + 1);
545 * CAPA is a command which tells the client which POP3 extensions
548 void pop3_capa(void) {
549 cprintf("+OK Capability list follows\r\n"
553 "IMPLEMENTATION %s\r\n"
563 * UIDL (Universal IDentifier Listing) is easy. Our 'unique' message
564 * identifiers are simply the Citadel message numbers in the database.
566 void pop3_uidl(char *argbuf) {
570 which_one = atoi(argbuf);
572 /* "list one" mode */
574 if (which_one > POP3->num_msgs) {
575 cprintf("-ERR no such message, only %d are here\r\n",
579 else if (POP3->msgs[which_one-1].deleted) {
580 cprintf("-ERR Sorry, you deleted that message.\r\n");
584 cprintf("+OK %d %ld\r\n",
586 POP3->msgs[which_one-1].msgnum
592 /* "list all" (scan listing) mode */
594 cprintf("+OK Here's your mail:\r\n");
595 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
596 if (! POP3->msgs[i].deleted) {
597 cprintf("%d %ld\r\n",
599 POP3->msgs[i].msgnum);
608 * implements the STLS command (Citadel API version)
612 char ok_response[SIZ];
613 char nosup_response[SIZ];
614 char error_response[SIZ];
617 "+OK Begin TLS negotiation now\r\n");
618 sprintf(nosup_response,
619 "-ERR TLS not supported here\r\n");
620 sprintf(error_response,
621 "-ERR Internal error\r\n");
622 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
632 * Main command loop for POP3 sessions.
634 void pop3_command_loop(void) {
638 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
639 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
640 CtdlLogPrintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
644 if (!strncasecmp(cmdbuf, "PASS", 4)) {
645 CtdlLogPrintf(CTDL_INFO, "POP3: PASS...\r\n");
648 CtdlLogPrintf(CTDL_INFO, "POP3: %s\r\n", cmdbuf);
650 while (strlen(cmdbuf) < 5) strcat(cmdbuf, " ");
652 if (!strncasecmp(cmdbuf, "NOOP", 4)) {
653 cprintf("+OK No operation.\r\n");
656 else if (!strncasecmp(cmdbuf, "CAPA", 4)) {
660 else if (!strncasecmp(cmdbuf, "QUIT", 4)) {
661 cprintf("+OK Goodbye...\r\n");
667 else if (!strncasecmp(cmdbuf, "USER", 4)) {
668 pop3_user(&cmdbuf[5]);
671 else if (!strncasecmp(cmdbuf, "PASS", 4)) {
672 pop3_pass(&cmdbuf[5]);
675 else if (!strncasecmp(cmdbuf, "APOP", 4))
677 pop3_apop(&cmdbuf[5]);
681 else if (!strncasecmp(cmdbuf, "STLS", 4)) {
686 else if (!CC->logged_in) {
687 cprintf("-ERR Not logged in.\r\n");
690 else if (CC->nologin) {
691 cprintf("-ERR System busy, try later.\r\n");
695 else if (!strncasecmp(cmdbuf, "LIST", 4)) {
696 pop3_list(&cmdbuf[5]);
699 else if (!strncasecmp(cmdbuf, "STAT", 4)) {
700 pop3_stat(&cmdbuf[5]);
703 else if (!strncasecmp(cmdbuf, "RETR", 4)) {
704 pop3_retr(&cmdbuf[5]);
707 else if (!strncasecmp(cmdbuf, "DELE", 4)) {
708 pop3_dele(&cmdbuf[5]);
711 else if (!strncasecmp(cmdbuf, "RSET", 4)) {
712 pop3_rset(&cmdbuf[5]);
715 else if (!strncasecmp(cmdbuf, "UIDL", 4)) {
716 pop3_uidl(&cmdbuf[5]);
719 else if (!strncasecmp(cmdbuf, "TOP", 3)) {
720 pop3_top(&cmdbuf[4]);
723 else if (!strncasecmp(cmdbuf, "LAST", 4)) {
724 pop3_last(&cmdbuf[4]);
728 cprintf("-ERR I'm afraid I can't do that.\r\n");
733 const char *CitadelServicePop3="POP3";
734 const char *CitadelServicePop3S="POP3S";
737 CTDL_MODULE_INIT(pop3)
741 CtdlRegisterServiceHook(config.c_pop3_port,
748 CtdlRegisterServiceHook(config.c_pop3s_port,
753 CitadelServicePop3S);
755 CtdlRegisterSessionHook(pop3_cleanup_function, EVT_STOP);
758 /* return our Subversion id for the Log */