2 * POP3 service for the Citadel system
4 * Copyright (c) 1998-2012 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 3.
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.
20 * Current status of standards conformance:
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.
39 #include <sys/types.h>
41 #if TIME_WITH_SYS_TIME
42 # include <sys/time.h>
46 # include <sys/time.h>
56 #include <libcitadel.h>
59 #include "citserver.h"
65 #include "internet_addressing.h"
66 #include "serv_pop3.h"
71 #include "ctdl_module.h"
76 * This cleanup function blows away the temporary memory and files used by
79 void pop3_cleanup_function(void) {
81 /* Don't do this stuff if this is not a POP3 session! */
82 if (CC->h_command_function != pop3_command_loop) return;
84 syslog(LOG_DEBUG, "Performing POP3 cleanup hook");
85 if (POP3->msgs != NULL) free(POP3->msgs);
93 * Here's where our POP3 session begins its happy day.
95 void pop3_greeting(void) {
96 strcpy(CC->cs_clientname, "POP3 session");
98 CC->session_specific_data = malloc(sizeof(struct citpop3));
99 memset(POP3, 0, sizeof(struct citpop3));
101 cprintf("+OK Citadel POP3 server ready.\r\n");
106 * POP3S is just like POP3, except it goes crypto right away.
108 void pop3s_greeting(void) {
109 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
111 /* kill session if no crypto */
113 if (!CC->redirect_ssl) CC->kill_me = KILLME_NO_CRYPTO;
115 CC->kill_me = KILLME_NO_CRYPTO;
124 * Specify user name (implements POP3 "USER" command)
126 void pop3_user(char *argbuf) {
130 cprintf("-ERR You are already logged in.\r\n");
134 strcpy(username, argbuf);
137 /* syslog(LOG_DEBUG, "Trying <%s>", username); */
138 if (CtdlLoginExistingUser(NULL, username) == login_ok) {
139 cprintf("+OK Password required for %s\r\n", username);
142 cprintf("-ERR No such user.\r\n");
149 * Back end for pop3_grab_mailbox()
151 void pop3_add_message(long msgnum, void *userdata) {
155 if (POP3->num_msgs < 2) POP3->msgs = malloc(sizeof(struct pop3msg));
156 else POP3->msgs = realloc(POP3->msgs,
157 (POP3->num_msgs * sizeof(struct pop3msg)) ) ;
158 POP3->msgs[POP3->num_msgs-1].msgnum = msgnum;
159 POP3->msgs[POP3->num_msgs-1].deleted = 0;
161 /* We need to know the length of this message when it is printed in
162 * RFC822 format. Perhaps we have cached this length in the message's
163 * metadata record. If so, great; if not, measure it and then cache
166 GetMetaData(&smi, msgnum);
167 if (smi.meta_rfc822_length <= 0L) {
168 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
170 CtdlOutputMsg(msgnum,
177 smi.meta_rfc822_length = StrLength(CC->redirect_buffer);
178 FreeStrBuf(&CC->redirect_buffer); /* TODO: WHEW, all this for just knowing the length???? */
181 POP3->msgs[POP3->num_msgs-1].rfc822_length = smi.meta_rfc822_length;
187 * Open the inbox and read its contents.
188 * (This should be called only once, by pop3_pass(), and returns the number
189 * of messages in the inbox, or -1 for error)
191 int pop3_grab_mailbox(void) {
195 if (CtdlGetRoom(&CC->room, MAILROOM) != 0) return(-1);
197 /* Load up the messages */
198 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
199 pop3_add_message, NULL);
201 /* Figure out which are old and which are new */
202 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
203 POP3->lastseen = (-1);
204 if (POP3->num_msgs) for (i=0; i<POP3->num_msgs; ++i) {
205 if (is_msg_in_sequence_set(vbuf.v_seen,
206 (POP3->msgs[POP3->num_msgs-1].msgnum) )) {
211 return(POP3->num_msgs);
214 void pop3_login(void)
218 msgs = pop3_grab_mailbox();
220 cprintf("+OK %s is logged in (%d messages)\r\n",
221 CC->user.fullname, msgs);
222 syslog(LOG_NOTICE, "POP3 authenticated %s", CC->user.fullname);
225 cprintf("-ERR Can't open your mailbox\r\n");
232 * Authorize with password (implements POP3 "PASS" command)
234 void pop3_pass(char *argbuf) {
237 safestrncpy(password, argbuf, sizeof password);
240 /* syslog(LOG_DEBUG, "Trying <%s>", password); */
241 if (CtdlTryPassword(password, strlen(password)) == pass_ok) {
245 cprintf("-ERR That is NOT the password.\r\n");
252 * list available msgs
254 void pop3_list(char *argbuf) {
258 which_one = atoi(argbuf);
260 /* "list one" mode */
262 if (which_one > POP3->num_msgs) {
263 cprintf("-ERR no such message, only %d are here\r\n",
267 else if (POP3->msgs[which_one-1].deleted) {
268 cprintf("-ERR Sorry, you deleted that message.\r\n");
272 cprintf("+OK %d %ld\r\n",
274 (long)POP3->msgs[which_one-1].rfc822_length
280 /* "list all" (scan listing) mode */
282 cprintf("+OK Here's your mail:\r\n");
283 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
284 if (! POP3->msgs[i].deleted) {
285 cprintf("%d %ld\r\n",
287 (long)POP3->msgs[i].rfc822_length);
296 * STAT (tally up the total message count and byte count) command
298 void pop3_stat(char *argbuf) {
300 size_t total_octets = 0;
303 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
304 if (! POP3->msgs[i].deleted) {
306 total_octets += POP3->msgs[i].rfc822_length;
310 cprintf("+OK %d %ld\r\n", total_msgs, (long)total_octets);
316 * RETR command (fetch a message)
318 void pop3_retr(char *argbuf) {
321 which_one = atoi(argbuf);
322 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
323 cprintf("-ERR No such message.\r\n");
327 if (POP3->msgs[which_one - 1].deleted) {
328 cprintf("-ERR Sorry, you deleted that message.\r\n");
332 cprintf("+OK Message %d:\r\n", which_one);
333 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum,
334 MT_RFC822, HEADERS_ALL, 0, 1, NULL,
335 (ESC_DOT|SUPPRESS_ENV_TO),
342 * TOP command (dumb way of fetching a partial message or headers-only)
344 void pop3_top(char *argbuf) {
346 int lines_requested = 0;
347 int lines_dumped = 0;
354 sscanf(argbuf, "%d %d", &which_one, &lines_requested);
355 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
356 cprintf("-ERR No such message.\r\n");
360 if (POP3->msgs[which_one - 1].deleted) {
361 cprintf("-ERR Sorry, you deleted that message.\r\n");
365 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
367 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum,
374 msgtext = CC->redirect_buffer;
375 CC->redirect_buffer = NULL;
377 cprintf("+OK Message %d:\r\n", which_one);
379 ptr = ChrPtr(msgtext);
380 while (ptr = cmemreadline(ptr, buf, (sizeof buf - 2)),
381 ( (*ptr != 0) && (done == 0))) {
384 if (lines_dumped >= lines_requested) {
388 if ((in_body == 0) || (done == 0)) {
389 client_write(buf, strlen(buf));
394 if ((buf[0]==13)||(buf[0]==10)) in_body = 1;
397 if (buf[strlen(buf)-1] != 10) cprintf("\n");
398 FreeStrBuf(&msgtext);
405 * DELE (delete message from mailbox)
407 void pop3_dele(char *argbuf) {
410 which_one = atoi(argbuf);
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 You already deleted that message.\r\n");
421 /* Flag the message as deleted. Will expunge during QUIT command. */
422 POP3->msgs[which_one - 1].deleted = 1;
423 cprintf("+OK Message %d deleted.\r\n",
428 /* Perform "UPDATE state" stuff
430 void pop3_update(void) {
434 long *deletemsgs = NULL;
435 int num_deletemsgs = 0;
437 /* Remove messages marked for deletion */
438 if (POP3->num_msgs > 0) {
439 deletemsgs = malloc(POP3->num_msgs * sizeof(long));
440 for (i=0; i<POP3->num_msgs; ++i) {
441 if (POP3->msgs[i].deleted) {
442 deletemsgs[num_deletemsgs++] = POP3->msgs[i].msgnum;
445 if (num_deletemsgs > 0) {
446 CtdlDeleteMessages(MAILROOM, deletemsgs, num_deletemsgs, "");
451 /* Set last read pointer */
452 if (POP3->num_msgs > 0) {
453 CtdlGetUserLock(&CC->user, CC->curr_user);
455 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
456 snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld",
457 POP3->msgs[POP3->num_msgs-1].msgnum);
458 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
460 CtdlPutUserLock(&CC->user);
467 * RSET (reset, i.e. undelete any deleted messages) command
469 void pop3_rset(char *argbuf) {
472 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
473 if (POP3->msgs[i].deleted) {
474 POP3->msgs[i].deleted = 0;
477 cprintf("+OK Reset completed.\r\n");
483 * LAST (Determine which message is the last unread message)
485 void pop3_last(char *argbuf) {
486 cprintf("+OK %d\r\n", POP3->lastseen + 1);
491 * CAPA is a command which tells the client which POP3 extensions
494 void pop3_capa(void) {
495 cprintf("+OK Capability list follows\r\n"
499 "IMPLEMENTATION %s\r\n"
509 * UIDL (Universal IDentifier Listing) is easy. Our 'unique' message
510 * identifiers are simply the Citadel message numbers in the database.
512 void pop3_uidl(char *argbuf) {
516 which_one = atoi(argbuf);
518 /* "list one" mode */
520 if (which_one > POP3->num_msgs) {
521 cprintf("-ERR no such message, only %d are here\r\n",
525 else if (POP3->msgs[which_one-1].deleted) {
526 cprintf("-ERR Sorry, you deleted that message.\r\n");
530 cprintf("+OK %d %ld\r\n",
532 POP3->msgs[which_one-1].msgnum
538 /* "list all" (scan listing) mode */
540 cprintf("+OK Here's your mail:\r\n");
541 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
542 if (! POP3->msgs[i].deleted) {
543 cprintf("%d %ld\r\n",
545 POP3->msgs[i].msgnum);
554 * implements the STLS command (Citadel API version)
558 char ok_response[SIZ];
559 char nosup_response[SIZ];
560 char error_response[SIZ];
563 "+OK Begin TLS negotiation now\r\n");
564 sprintf(nosup_response,
565 "-ERR TLS not supported here\r\n");
566 sprintf(error_response,
567 "-ERR Internal error\r\n");
568 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
578 * Main command loop for POP3 sessions.
580 void pop3_command_loop(void) {
584 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
585 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
586 syslog(LOG_ERR, "POP3 client disconnected: ending session.");
587 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
590 if (!strncasecmp(cmdbuf, "PASS", 4)) {
591 syslog(LOG_INFO, "POP3: PASS...");
594 syslog(LOG_INFO, "POP3: %s", cmdbuf);
596 while (strlen(cmdbuf) < 5) strcat(cmdbuf, " ");
598 if (!strncasecmp(cmdbuf, "NOOP", 4)) {
599 cprintf("+OK No operation.\r\n");
602 else if (!strncasecmp(cmdbuf, "CAPA", 4)) {
606 else if (!strncasecmp(cmdbuf, "QUIT", 4)) {
607 cprintf("+OK Goodbye...\r\n");
609 CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
613 else if (!strncasecmp(cmdbuf, "USER", 4)) {
614 pop3_user(&cmdbuf[5]);
617 else if (!strncasecmp(cmdbuf, "PASS", 4)) {
618 pop3_pass(&cmdbuf[5]);
622 else if (!strncasecmp(cmdbuf, "STLS", 4)) {
627 else if (!CC->logged_in) {
628 cprintf("-ERR Not logged in.\r\n");
631 else if (CC->nologin) {
632 cprintf("-ERR System busy, try later.\r\n");
633 CC->kill_me = KILLME_NOLOGIN;
636 else if (!strncasecmp(cmdbuf, "LIST", 4)) {
637 pop3_list(&cmdbuf[5]);
640 else if (!strncasecmp(cmdbuf, "STAT", 4)) {
641 pop3_stat(&cmdbuf[5]);
644 else if (!strncasecmp(cmdbuf, "RETR", 4)) {
645 pop3_retr(&cmdbuf[5]);
648 else if (!strncasecmp(cmdbuf, "DELE", 4)) {
649 pop3_dele(&cmdbuf[5]);
652 else if (!strncasecmp(cmdbuf, "RSET", 4)) {
653 pop3_rset(&cmdbuf[5]);
656 else if (!strncasecmp(cmdbuf, "UIDL", 4)) {
657 pop3_uidl(&cmdbuf[5]);
660 else if (!strncasecmp(cmdbuf, "TOP", 3)) {
661 pop3_top(&cmdbuf[4]);
664 else if (!strncasecmp(cmdbuf, "LAST", 4)) {
665 pop3_last(&cmdbuf[4]);
669 cprintf("-ERR I'm afraid I can't do that.\r\n");
674 const char *CitadelServicePop3="POP3";
675 const char *CitadelServicePop3S="POP3S";
678 CTDL_MODULE_INIT(pop3)
682 CtdlRegisterServiceHook(config.c_pop3_port,
689 CtdlRegisterServiceHook(config.c_pop3s_port,
694 CitadelServicePop3S);
696 CtdlRegisterSessionHook(pop3_cleanup_function, EVT_STOP, PRIO_STOP + 30);
699 /* return our module name for the log */