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"
67 #include "internet_addressing.h"
68 #include "serv_pop3.h"
73 #include "ctdl_module.h"
78 * This cleanup function blows away the temporary memory and files used by
81 void pop3_cleanup_function(void) {
83 /* Don't do this stuff if this is not a POP3 session! */
84 if (CC->h_command_function != pop3_command_loop) return;
86 CtdlLogPrintf(CTDL_DEBUG, "Performing POP3 cleanup hook\n");
87 if (POP3->msgs != NULL) free(POP3->msgs);
95 * Here's where our POP3 session begins its happy day.
97 void pop3_greeting(void) {
98 strcpy(CC->cs_clientname, "POP3 session");
100 CC->session_specific_data = malloc(sizeof(struct citpop3));
101 memset(POP3, 0, sizeof(struct citpop3));
103 cprintf("+OK Citadel POP3 server %s\r\n",
109 * POP3S is just like POP3, except it goes crypto right away.
111 void pop3s_greeting(void) {
112 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
114 /* kill session if no crypto */
116 if (!CC->redirect_ssl) CC->kill_me = 1;
127 * Specify user name (implements POP3 "USER" command)
129 void pop3_user(char *argbuf) {
133 cprintf("-ERR You are already logged in.\r\n");
137 strcpy(username, argbuf);
140 /* CtdlLogPrintf(CTDL_DEBUG, "Trying <%s>\n", username); */
141 if (CtdlLoginExistingUser(NULL, username) == login_ok) {
142 cprintf("+OK Password required for %s\r\n", username);
145 cprintf("-ERR No such user.\r\n");
152 * Back end for pop3_grab_mailbox()
154 void pop3_add_message(long msgnum, void *userdata) {
158 if (POP3->num_msgs < 2) POP3->msgs = malloc(sizeof(struct pop3msg));
159 else POP3->msgs = realloc(POP3->msgs,
160 (POP3->num_msgs * sizeof(struct pop3msg)) ) ;
161 POP3->msgs[POP3->num_msgs-1].msgnum = msgnum;
162 POP3->msgs[POP3->num_msgs-1].deleted = 0;
164 /* We need to know the length of this message when it is printed in
165 * RFC822 format. Perhaps we have cached this length in the message's
166 * metadata record. If so, great; if not, measure it and then cache
169 GetMetaData(&smi, msgnum);
170 if (smi.meta_rfc822_length <= 0L) {
171 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
172 CtdlOutputMsg(msgnum, MT_RFC822, HEADERS_ALL, 0, 1, NULL, SUPPRESS_ENV_TO);
173 smi.meta_rfc822_length = StrLength(CC->redirect_buffer);
174 FreeStrBuf(&CC->redirect_buffer); /* TODO: WHEW, all this for just knowing the length???? */
177 POP3->msgs[POP3->num_msgs-1].rfc822_length = smi.meta_rfc822_length;
183 * Open the inbox and read its contents.
184 * (This should be called only once, by pop3_pass(), and returns the number
185 * of messages in the inbox, or -1 for error)
187 int pop3_grab_mailbox(void) {
191 if (CtdlGetRoom(&CC->room, MAILROOM) != 0) return(-1);
193 /* Load up the messages */
194 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
195 pop3_add_message, NULL);
197 /* Figure out which are old and which are new */
198 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
199 POP3->lastseen = (-1);
200 if (POP3->num_msgs) for (i=0; i<POP3->num_msgs; ++i) {
201 if (is_msg_in_sequence_set(vbuf.v_seen,
202 (POP3->msgs[POP3->num_msgs-1].msgnum) )) {
207 return(POP3->num_msgs);
210 void pop3_login(void)
214 msgs = pop3_grab_mailbox();
216 cprintf("+OK %s is logged in (%d messages)\r\n",
217 CC->user.fullname, msgs);
218 CtdlLogPrintf(CTDL_NOTICE, "POP3 authenticated %s\n", CC->user.fullname);
221 cprintf("-ERR Can't open your mailbox\r\n");
226 void pop3_apop(char *argbuf)
229 char userdigest[MD5_HEXSTRING_SIZE];
230 char realdigest[MD5_HEXSTRING_SIZE];
235 cprintf("-ERR You are already logged in; not in the AUTHORIZATION phase.\r\n");
239 if ((sptr = strchr(argbuf, ' ')) == NULL)
241 cprintf("-ERR Invalid APOP line.\r\n");
247 while ((*sptr) && isspace(*sptr))
250 strncpy(username, argbuf, sizeof(username)-1);
251 username[sizeof(username)-1] = '\0';
253 memset(userdigest, 0, MD5_HEXSTRING_SIZE);
254 strncpy(userdigest, sptr, MD5_HEXSTRING_SIZE-1);
256 if (CtdlLoginExistingUser(NULL, username) != login_ok)
258 cprintf("-ERR No such user.\r\n");
262 if (CtdlGetUser(&CC->user, CC->curr_user))
264 cprintf("-ERR No such user.\r\n");
268 make_apop_string(CC->user.password, CC->cs_nonce, realdigest, sizeof realdigest);
269 if (!strncasecmp(realdigest, userdigest, MD5_HEXSTRING_SIZE-1))
276 cprintf("-ERR That is NOT the password.\r\n");
282 * Authorize with password (implements POP3 "PASS" command)
284 void pop3_pass(char *argbuf) {
287 safestrncpy(password, argbuf, sizeof password);
290 /* CtdlLogPrintf(CTDL_DEBUG, "Trying <%s>\n", password); */
291 if (CtdlTryPassword(password, strlen(password)) == pass_ok) {
295 cprintf("-ERR That is NOT the password.\r\n");
302 * list available msgs
304 void pop3_list(char *argbuf) {
308 which_one = atoi(argbuf);
310 /* "list one" mode */
312 if (which_one > POP3->num_msgs) {
313 cprintf("-ERR no such message, only %d are here\r\n",
317 else if (POP3->msgs[which_one-1].deleted) {
318 cprintf("-ERR Sorry, you deleted that message.\r\n");
322 cprintf("+OK %d %ld\r\n",
324 (long)POP3->msgs[which_one-1].rfc822_length
330 /* "list all" (scan listing) mode */
332 cprintf("+OK Here's your mail:\r\n");
333 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
334 if (! POP3->msgs[i].deleted) {
335 cprintf("%d %ld\r\n",
337 (long)POP3->msgs[i].rfc822_length);
346 * STAT (tally up the total message count and byte count) command
348 void pop3_stat(char *argbuf) {
350 size_t total_octets = 0;
353 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
354 if (! POP3->msgs[i].deleted) {
356 total_octets += POP3->msgs[i].rfc822_length;
360 cprintf("+OK %d %ld\r\n", total_msgs, (long)total_octets);
366 * RETR command (fetch a message)
368 void pop3_retr(char *argbuf) {
371 which_one = atoi(argbuf);
372 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
373 cprintf("-ERR No such message.\r\n");
377 if (POP3->msgs[which_one - 1].deleted) {
378 cprintf("-ERR Sorry, you deleted that message.\r\n");
382 cprintf("+OK Message %d:\r\n", which_one);
383 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum,
384 MT_RFC822, HEADERS_ALL, 0, 1, NULL,
385 (ESC_DOT|SUPPRESS_ENV_TO)
392 * TOP command (dumb way of fetching a partial message or headers-only)
394 void pop3_top(char *argbuf) {
396 int lines_requested = 0;
397 int lines_dumped = 0;
404 sscanf(argbuf, "%d %d", &which_one, &lines_requested);
405 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
406 cprintf("-ERR No such message.\r\n");
410 if (POP3->msgs[which_one - 1].deleted) {
411 cprintf("-ERR Sorry, you deleted that message.\r\n");
415 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
416 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum, MT_RFC822, HEADERS_ALL, 0, 1, NULL, SUPPRESS_ENV_TO);
417 msgtext = CC->redirect_buffer;
418 CC->redirect_buffer = NULL;
420 cprintf("+OK Message %d:\r\n", which_one);
422 ptr = ChrPtr(msgtext);
423 while (ptr = cmemreadline(ptr, buf, (sizeof buf - 2)),
424 ( (*ptr != 0) && (done == 0))) {
427 if (lines_dumped >= lines_requested) {
431 if ((in_body == 0) || (done == 0)) {
432 client_write(buf, strlen(buf));
437 if ((buf[0]==13)||(buf[0]==10)) in_body = 1;
440 if (buf[strlen(buf)-1] != 10) cprintf("\n");
441 FreeStrBuf(&msgtext);
448 * DELE (delete message from mailbox)
450 void pop3_dele(char *argbuf) {
453 which_one = atoi(argbuf);
454 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
455 cprintf("-ERR No such message.\r\n");
459 if (POP3->msgs[which_one - 1].deleted) {
460 cprintf("-ERR You already deleted that message.\r\n");
464 /* Flag the message as deleted. Will expunge during QUIT command. */
465 POP3->msgs[which_one - 1].deleted = 1;
466 cprintf("+OK Message %d deleted.\r\n",
471 /* Perform "UPDATE state" stuff
473 void pop3_update(void) {
477 long *deletemsgs = NULL;
478 int num_deletemsgs = 0;
480 /* Remove messages marked for deletion */
481 if (POP3->num_msgs > 0) {
482 deletemsgs = malloc(POP3->num_msgs * sizeof(long));
483 for (i=0; i<POP3->num_msgs; ++i) {
484 if (POP3->msgs[i].deleted) {
485 deletemsgs[num_deletemsgs++] = POP3->msgs[i].msgnum;
488 if (num_deletemsgs > 0) {
489 CtdlDeleteMessages(MAILROOM, deletemsgs, num_deletemsgs, "");
494 /* Set last read pointer */
495 if (POP3->num_msgs > 0) {
496 CtdlGetUserLock(&CC->user, CC->curr_user);
498 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
499 snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld",
500 POP3->msgs[POP3->num_msgs-1].msgnum);
501 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
503 CtdlPutUserLock(&CC->user);
510 * RSET (reset, i.e. undelete any deleted messages) command
512 void pop3_rset(char *argbuf) {
515 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
516 if (POP3->msgs[i].deleted) {
517 POP3->msgs[i].deleted = 0;
520 cprintf("+OK Reset completed.\r\n");
526 * LAST (Determine which message is the last unread message)
528 void pop3_last(char *argbuf) {
529 cprintf("+OK %d\r\n", POP3->lastseen + 1);
534 * CAPA is a command which tells the client which POP3 extensions
537 void pop3_capa(void) {
538 cprintf("+OK Capability list follows\r\n"
542 "IMPLEMENTATION %s\r\n"
552 * UIDL (Universal IDentifier Listing) is easy. Our 'unique' message
553 * identifiers are simply the Citadel message numbers in the database.
555 void pop3_uidl(char *argbuf) {
559 which_one = atoi(argbuf);
561 /* "list one" mode */
563 if (which_one > POP3->num_msgs) {
564 cprintf("-ERR no such message, only %d are here\r\n",
568 else if (POP3->msgs[which_one-1].deleted) {
569 cprintf("-ERR Sorry, you deleted that message.\r\n");
573 cprintf("+OK %d %ld\r\n",
575 POP3->msgs[which_one-1].msgnum
581 /* "list all" (scan listing) mode */
583 cprintf("+OK Here's your mail:\r\n");
584 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
585 if (! POP3->msgs[i].deleted) {
586 cprintf("%d %ld\r\n",
588 POP3->msgs[i].msgnum);
597 * implements the STLS command (Citadel API version)
601 char ok_response[SIZ];
602 char nosup_response[SIZ];
603 char error_response[SIZ];
606 "+OK Begin TLS negotiation now\r\n");
607 sprintf(nosup_response,
608 "-ERR TLS not supported here\r\n");
609 sprintf(error_response,
610 "-ERR Internal error\r\n");
611 CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
621 * Main command loop for POP3 sessions.
623 void pop3_command_loop(void) {
627 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
628 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
629 CtdlLogPrintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
633 if (!strncasecmp(cmdbuf, "PASS", 4)) {
634 CtdlLogPrintf(CTDL_INFO, "POP3: PASS...\r\n");
637 CtdlLogPrintf(CTDL_INFO, "POP3: %s\r\n", cmdbuf);
639 while (strlen(cmdbuf) < 5) strcat(cmdbuf, " ");
641 if (!strncasecmp(cmdbuf, "NOOP", 4)) {
642 cprintf("+OK No operation.\r\n");
645 else if (!strncasecmp(cmdbuf, "CAPA", 4)) {
649 else if (!strncasecmp(cmdbuf, "QUIT", 4)) {
650 cprintf("+OK Goodbye...\r\n");
656 else if (!strncasecmp(cmdbuf, "USER", 4)) {
657 pop3_user(&cmdbuf[5]);
660 else if (!strncasecmp(cmdbuf, "PASS", 4)) {
661 pop3_pass(&cmdbuf[5]);
664 else if (!strncasecmp(cmdbuf, "APOP", 4))
666 pop3_apop(&cmdbuf[5]);
670 else if (!strncasecmp(cmdbuf, "STLS", 4)) {
675 else if (!CC->logged_in) {
676 cprintf("-ERR Not logged in.\r\n");
679 else if (CC->nologin) {
680 cprintf("-ERR System busy, try later.\r\n");
684 else if (!strncasecmp(cmdbuf, "LIST", 4)) {
685 pop3_list(&cmdbuf[5]);
688 else if (!strncasecmp(cmdbuf, "STAT", 4)) {
689 pop3_stat(&cmdbuf[5]);
692 else if (!strncasecmp(cmdbuf, "RETR", 4)) {
693 pop3_retr(&cmdbuf[5]);
696 else if (!strncasecmp(cmdbuf, "DELE", 4)) {
697 pop3_dele(&cmdbuf[5]);
700 else if (!strncasecmp(cmdbuf, "RSET", 4)) {
701 pop3_rset(&cmdbuf[5]);
704 else if (!strncasecmp(cmdbuf, "UIDL", 4)) {
705 pop3_uidl(&cmdbuf[5]);
708 else if (!strncasecmp(cmdbuf, "TOP", 3)) {
709 pop3_top(&cmdbuf[4]);
712 else if (!strncasecmp(cmdbuf, "LAST", 4)) {
713 pop3_last(&cmdbuf[4]);
717 cprintf("-ERR I'm afraid I can't do that.\r\n");
722 const char *CitadelServicePop3="POP3";
723 const char *CitadelServicePop3S="POP3S";
726 CTDL_MODULE_INIT(pop3)
730 CtdlRegisterServiceHook(config.c_pop3_port,
737 CtdlRegisterServiceHook(config.c_pop3s_port,
742 CitadelServicePop3S);
744 CtdlRegisterSessionHook(pop3_cleanup_function, EVT_STOP);
747 /* return our Subversion id for the Log */