4 * POP3 service for the Citadel system
5 * Copyright (C) 1998-2001 by Art Cancro and others.
6 * This code is released under the terms of the GNU General Public License.
8 * Current status of standards conformance:
10 * -> All required POP3 commands described in RFC1939 are implemented.
11 * -> All optional POP3 commands described in RFC1939 are also implemented.
12 * -> The deprecated "LAST" command is included in this implementation, because
13 * there exist mail clients which insist on using it (such as Bynari
14 * TradeMail, and certain versions of Eudora).
15 * -> Capability detection via the method described in RFC2449 is implemented.
27 #include <sys/types.h>
29 #if TIME_WITH_SYS_TIME
30 # include <sys/time.h>
34 # include <sys/time.h>
46 #include "sysdep_decls.h"
47 #include "citserver.h"
50 #include "serv_extensions.h"
57 #include "internet_addressing.h"
58 #include "serv_pop3.h"
62 #include "serv_crypto.h"
68 * This cleanup function blows away the temporary memory and files used by
71 void pop3_cleanup_function(void) {
73 /* Don't do this stuff if this is not a POP3 session! */
74 if (CC->h_command_function != pop3_command_loop) return;
76 lprintf(CTDL_DEBUG, "Performing POP3 cleanup hook\n");
77 if (POP3->msgs != NULL) free(POP3->msgs);
85 * Here's where our POP3 session begins its happy day.
87 void pop3_greeting(void) {
88 strcpy(CC->cs_clientname, "POP3 session");
90 POP3 = malloc(sizeof(struct citpop3));
91 memset(POP3, 0, sizeof(struct citpop3));
93 cprintf("+OK Citadel POP3 server %s\r\n",
99 * POP3S is just like POP3, except it goes crypto right away.
102 void pop3s_greeting(void) {
103 CtdlStartTLS(NULL, NULL, NULL);
111 * Specify user name (implements POP3 "USER" command)
113 void pop3_user(char *argbuf) {
117 cprintf("-ERR You are already logged in.\r\n");
121 strcpy(username, argbuf);
124 /* lprintf(CTDL_DEBUG, "Trying <%s>\n", username); */
125 if (CtdlLoginExistingUser(username) == login_ok) {
126 cprintf("+OK Password required for %s\r\n", username);
129 cprintf("-ERR No such user.\r\n");
136 * Back end for pop3_grab_mailbox()
138 void pop3_add_message(long msgnum, void *userdata) {
142 if (POP3->num_msgs < 2) POP3->msgs = malloc(sizeof(struct pop3msg));
143 else POP3->msgs = realloc(POP3->msgs,
144 (POP3->num_msgs * sizeof(struct pop3msg)) ) ;
145 POP3->msgs[POP3->num_msgs-1].msgnum = msgnum;
146 POP3->msgs[POP3->num_msgs-1].deleted = 0;
148 /* We need to know the length of this message when it is printed in
149 * RFC822 format. Perhaps we have cached this length in the message's
150 * metadata record. If so, great; if not, measure it and then cache
153 GetMetaData(&smi, msgnum);
154 if (smi.meta_rfc822_length <= 0L) {
155 CC->redirect_buffer = malloc(SIZ);
156 CC->redirect_len = 0;
157 CC->redirect_alloc = SIZ;
158 CtdlOutputMsg(msgnum, MT_RFC822, HEADERS_ALL, 0, 1, NULL);
159 smi.meta_rfc822_length = CC->redirect_len;
160 free(CC->redirect_buffer);
161 CC->redirect_buffer = NULL;
162 CC->redirect_len = 0;
163 CC->redirect_alloc = 0;
166 POP3->msgs[POP3->num_msgs-1].rfc822_length = smi.meta_rfc822_length;
172 * Open the inbox and read its contents.
173 * (This should be called only once, by pop3_pass(), and returns the number
174 * of messages in the inbox, or -1 for error)
176 int pop3_grab_mailbox(void) {
180 if (getroom(&CC->room, MAILROOM) != 0) return(-1);
182 /* Load up the messages */
183 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
184 pop3_add_message, NULL);
186 /* Figure out which are old and which are new */
187 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
188 POP3->lastseen = (-1);
189 if (POP3->num_msgs) for (i=0; i<POP3->num_msgs; ++i) {
190 if (is_msg_in_sequence_set(vbuf.v_seen,
191 (POP3->msgs[POP3->num_msgs-1].msgnum) )) {
196 return(POP3->num_msgs);
199 void pop3_login(void)
203 msgs = pop3_grab_mailbox();
205 cprintf("+OK %s is logged in (%d messages)\r\n",
206 CC->user.fullname, msgs);
207 lprintf(CTDL_NOTICE, "POP3 authenticated %s\n", CC->user.fullname);
210 cprintf("-ERR Can't open your mailbox\r\n");
215 void pop3_apop(char *argbuf)
218 char userdigest[MD5_HEXSTRING_SIZE];
219 char realdigest[MD5_HEXSTRING_SIZE];
224 cprintf("-ERR You are already logged in; not in the AUTHORIZATION phase.\r\n");
228 if ((sptr = strchr(argbuf, ' ')) == NULL)
230 cprintf("-ERR Invalid APOP line.\r\n");
236 while ((*sptr) && isspace(*sptr))
239 strncpy(username, argbuf, sizeof(username)-1);
240 username[sizeof(username)-1] = '\0';
242 memset(userdigest, MD5_HEXSTRING_SIZE, 0);
243 strncpy(userdigest, sptr, MD5_HEXSTRING_SIZE-1);
245 if (CtdlLoginExistingUser(username) != login_ok)
247 cprintf("-ERR No such user.\r\n");
251 if (getuser(&CC->user, CC->curr_user))
253 cprintf("-ERR No such user.\r\n");
257 make_apop_string(CC->user.password, CC->cs_nonce, realdigest, sizeof realdigest);
258 if (!strncasecmp(realdigest, userdigest, MD5_HEXSTRING_SIZE-1))
265 cprintf("-ERR That is NOT the password.\r\n");
271 * Authorize with password (implements POP3 "PASS" command)
273 void pop3_pass(char *argbuf) {
276 strcpy(password, argbuf);
279 /* lprintf(CTDL_DEBUG, "Trying <%s>\n", password); */
280 if (CtdlTryPassword(password) == pass_ok) {
284 cprintf("-ERR That is NOT the password.\r\n");
291 * list available msgs
293 void pop3_list(char *argbuf) {
297 which_one = atoi(argbuf);
299 /* "list one" mode */
301 if (which_one > POP3->num_msgs) {
302 cprintf("-ERR no such message, only %d are here\r\n",
306 else if (POP3->msgs[which_one-1].deleted) {
307 cprintf("-ERR Sorry, you deleted that message.\r\n");
311 cprintf("+OK %d %ld\r\n",
313 (long)POP3->msgs[which_one-1].rfc822_length
319 /* "list all" (scan listing) mode */
321 cprintf("+OK Here's your mail:\r\n");
322 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
323 if (! POP3->msgs[i].deleted) {
324 cprintf("%d %ld\r\n",
326 (long)POP3->msgs[i].rfc822_length);
335 * STAT (tally up the total message count and byte count) command
337 void pop3_stat(char *argbuf) {
339 size_t total_octets = 0;
342 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
343 if (! POP3->msgs[i].deleted) {
345 total_octets += POP3->msgs[i].rfc822_length;
349 cprintf("+OK %d %ld\r\n", total_msgs, (long)total_octets);
355 * RETR command (fetch a message)
357 void pop3_retr(char *argbuf) {
360 which_one = atoi(argbuf);
361 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
362 cprintf("-ERR No such message.\r\n");
366 if (POP3->msgs[which_one - 1].deleted) {
367 cprintf("-ERR Sorry, you deleted that message.\r\n");
371 cprintf("+OK Message %d:\r\n", which_one);
372 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum, MT_RFC822, HEADERS_ALL, 0, 1, NULL);
378 * TOP command (dumb way of fetching a partial message or headers-only)
380 void pop3_top(char *argbuf) {
382 int lines_requested = 0;
383 int lines_dumped = 0;
390 sscanf(argbuf, "%d %d", &which_one, &lines_requested);
391 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
392 cprintf("-ERR No such message.\r\n");
396 if (POP3->msgs[which_one - 1].deleted) {
397 cprintf("-ERR Sorry, you deleted that message.\r\n");
401 CC->redirect_buffer = malloc(SIZ);
402 CC->redirect_len = 0;
403 CC->redirect_alloc = SIZ;
404 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum,
405 MT_RFC822, HEADERS_ALL, 0, 1, NULL);
406 msgtext = CC->redirect_buffer;
407 CC->redirect_buffer = NULL;
408 CC->redirect_len = 0;
409 CC->redirect_alloc = 0;
411 cprintf("+OK Message %d:\r\n", which_one);
415 while (ptr = memreadline(ptr, buf, (sizeof buf - 2)),
416 ( (*ptr != 0) && (done == 0))) {
419 if (lines_dumped >= lines_requested) {
423 if ((in_body == 0) || (done == 0)) {
424 client_write(buf, strlen(buf));
429 if ((buf[0]==13)||(buf[0]==10)) in_body = 1;
432 if (buf[strlen(buf)-1] != 10) cprintf("\n");
440 * DELE (delete message from mailbox)
442 void pop3_dele(char *argbuf) {
445 which_one = atoi(argbuf);
446 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
447 cprintf("-ERR No such message.\r\n");
451 if (POP3->msgs[which_one - 1].deleted) {
452 cprintf("-ERR You already deleted that message.\r\n");
456 /* Flag the message as deleted. Will expunge during QUIT command. */
457 POP3->msgs[which_one - 1].deleted = 1;
458 cprintf("+OK Message %d deleted.\r\n",
463 /* Perform "UPDATE state" stuff
465 void pop3_update(void) {
469 long *deletemsgs = NULL;
470 int num_deletemsgs = 0;
472 /* Remove messages marked for deletion */
473 if (POP3->num_msgs > 0) {
474 deletemsgs = malloc(POP3->num_msgs * sizeof(long));
475 for (i=0; i<POP3->num_msgs; ++i) {
476 if (POP3->msgs[i].deleted) {
477 deletemsgs[num_deletemsgs++] = POP3->msgs[i].msgnum;
480 if (num_deletemsgs > 0) {
481 CtdlDeleteMessages(MAILROOM, deletemsgs, num_deletemsgs, "");
486 /* Set last read pointer */
487 if (POP3->num_msgs > 0) {
488 lgetuser(&CC->user, CC->curr_user);
490 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
491 snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld",
492 POP3->msgs[POP3->num_msgs-1].msgnum);
493 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
502 * RSET (reset, i.e. undelete any deleted messages) command
504 void pop3_rset(char *argbuf) {
507 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
508 if (POP3->msgs[i].deleted) {
509 POP3->msgs[i].deleted = 0;
512 cprintf("+OK Reset completed.\r\n");
518 * LAST (Determine which message is the last unread message)
520 void pop3_last(char *argbuf) {
521 cprintf("+OK %d\r\n", POP3->lastseen + 1);
526 * CAPA is a command which tells the client which POP3 extensions
529 void pop3_capa(void) {
530 cprintf("+OK Capability list follows\r\n"
534 "IMPLEMENTATION %s\r\n"
544 * UIDL (Universal IDentifier Listing) is easy. Our 'unique' message
545 * identifiers are simply the Citadel message numbers in the database.
547 void pop3_uidl(char *argbuf) {
551 which_one = atoi(argbuf);
553 /* "list one" mode */
555 if (which_one > POP3->num_msgs) {
556 cprintf("-ERR no such message, only %d are here\r\n",
560 else if (POP3->msgs[which_one-1].deleted) {
561 cprintf("-ERR Sorry, you deleted that message.\r\n");
565 cprintf("+OK %d %ld\r\n",
567 POP3->msgs[which_one-1].msgnum
573 /* "list all" (scan listing) mode */
575 cprintf("+OK Here's your mail:\r\n");
576 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
577 if (! POP3->msgs[i].deleted) {
578 cprintf("%d %ld\r\n",
580 POP3->msgs[i].msgnum);
589 * implements the STLS command (Citadel API version)
594 char ok_response[SIZ];
595 char nosup_response[SIZ];
596 char error_response[SIZ];
599 "+OK Begin TLS negotiation now\r\n");
600 sprintf(nosup_response,
601 "-ERR TLS not supported here\r\n");
602 sprintf(error_response,
603 "-ERR Internal error\r\n");
604 CtdlStartTLS(ok_response, nosup_response, error_response);
615 * Main command loop for POP3 sessions.
617 void pop3_command_loop(void) {
621 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
622 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
623 lprintf(CTDL_ERR, "Client disconnected: ending session.\r\n");
627 if (!strncasecmp(cmdbuf, "PASS", 4)) {
628 lprintf(CTDL_INFO, "POP3: PASS...\r\n");
631 lprintf(CTDL_INFO, "POP3: %s\r\n", cmdbuf);
633 while (strlen(cmdbuf) < 5) strcat(cmdbuf, " ");
635 if (!strncasecmp(cmdbuf, "NOOP", 4)) {
636 cprintf("+OK No operation.\r\n");
639 else if (!strncasecmp(cmdbuf, "CAPA", 4)) {
643 else if (!strncasecmp(cmdbuf, "QUIT", 4)) {
644 cprintf("+OK Goodbye...\r\n");
650 else if (!strncasecmp(cmdbuf, "USER", 4)) {
651 pop3_user(&cmdbuf[5]);
654 else if (!strncasecmp(cmdbuf, "PASS", 4)) {
655 pop3_pass(&cmdbuf[5]);
658 else if (!strncasecmp(cmdbuf, "APOP", 4))
660 pop3_apop(&cmdbuf[5]);
664 else if (!strncasecmp(cmdbuf, "STLS", 4)) {
669 else if (!CC->logged_in) {
670 cprintf("-ERR Not logged in.\r\n");
673 else if (!strncasecmp(cmdbuf, "LIST", 4)) {
674 pop3_list(&cmdbuf[5]);
677 else if (!strncasecmp(cmdbuf, "STAT", 4)) {
678 pop3_stat(&cmdbuf[5]);
681 else if (!strncasecmp(cmdbuf, "RETR", 4)) {
682 pop3_retr(&cmdbuf[5]);
685 else if (!strncasecmp(cmdbuf, "DELE", 4)) {
686 pop3_dele(&cmdbuf[5]);
689 else if (!strncasecmp(cmdbuf, "RSET", 4)) {
690 pop3_rset(&cmdbuf[5]);
693 else if (!strncasecmp(cmdbuf, "UIDL", 4)) {
694 pop3_uidl(&cmdbuf[5]);
697 else if (!strncasecmp(cmdbuf, "TOP", 3)) {
698 pop3_top(&cmdbuf[4]);
701 else if (!strncasecmp(cmdbuf, "LAST", 4)) {
702 pop3_last(&cmdbuf[4]);
706 cprintf("-ERR I'm afraid I can't do that.\r\n");
713 char *serv_pop3_init(void)
715 CtdlRegisterServiceHook(config.c_pop3_port,
721 CtdlRegisterServiceHook(config.c_pop3s_port,
727 CtdlRegisterSessionHook(pop3_cleanup_function, EVT_STOP);