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.
12 * -> All optional POP3 commands described in RFC1939 are also implemented.
14 * -> The deprecated "LAST" command is included in this implementation, because
15 * there exist mail clients which insist on using it (such as Bynari
16 * TradeMail, and certain versions of Eudora).
28 #include <sys/types.h>
30 #if TIME_WITH_SYS_TIME
31 # include <sys/time.h>
35 # include <sys/time.h>
47 #include "sysdep_decls.h"
48 #include "citserver.h"
51 #include "serv_extensions.h"
58 #include "internet_addressing.h"
59 #include "serv_pop3.h"
63 #include "serv_crypto.h"
69 * This cleanup function blows away the temporary memory and files used by
72 void pop3_cleanup_function(void) {
74 /* Don't do this stuff if this is not a POP3 session! */
75 if (CC->h_command_function != pop3_command_loop) return;
77 lprintf(CTDL_DEBUG, "Performing POP3 cleanup hook\n");
78 if (POP3->msgs != NULL) free(POP3->msgs);
86 * Here's where our POP3 session begins its happy day.
88 void pop3_greeting(void) {
89 strcpy(CC->cs_clientname, "POP3 session");
91 POP3 = malloc(sizeof(struct citpop3));
95 cprintf("+OK Citadel POP3 server %s\r\n",
101 * POP3S is just like POP3, except it goes crypto right away.
104 void pop3s_greeting(void) {
105 CtdlStartTLS(NULL, NULL, NULL);
113 * Specify user name (implements POP3 "USER" command)
115 void pop3_user(char *argbuf) {
119 cprintf("-ERR You are already logged in.\r\n");
123 strcpy(username, argbuf);
126 lprintf(CTDL_DEBUG, "Trying <%s>\n", username);
127 if (CtdlLoginExistingUser(username) == login_ok) {
128 cprintf("+OK Password required for %s\r\n", username);
131 cprintf("-ERR No such user.\r\n");
138 * Back end for pop3_grab_mailbox()
140 void pop3_add_message(long msgnum, void *userdata) {
144 if (POP3->num_msgs < 2) POP3->msgs = malloc(sizeof(struct pop3msg));
145 else POP3->msgs = realloc(POP3->msgs,
146 (POP3->num_msgs * sizeof(struct pop3msg)) ) ;
147 POP3->msgs[POP3->num_msgs-1].msgnum = msgnum;
148 POP3->msgs[POP3->num_msgs-1].deleted = 0;
150 /* We need to know the length of this message when it is printed in
151 * RFC822 format. Perhaps we have cached this length in the message's
152 * metadata record. If so, great; if not, measure it and then cache
155 GetMetaData(&smi, msgnum);
156 if (smi.meta_rfc822_length <= 0L) {
157 CC->redirect_buffer = malloc(SIZ);
158 CC->redirect_len = 0;
159 CC->redirect_alloc = SIZ;
160 CtdlOutputMsg(msgnum, MT_RFC822, HEADERS_ALL, 0, 1);
161 smi.meta_rfc822_length = CC->redirect_len;
162 free(CC->redirect_buffer);
163 CC->redirect_buffer = NULL;
164 CC->redirect_len = 0;
165 CC->redirect_alloc = 0;
168 POP3->msgs[POP3->num_msgs-1].rfc822_length = smi.meta_rfc822_length;
174 * Open the inbox and read its contents.
175 * (This should be called only once, by pop3_pass(), and returns the number
176 * of messages in the inbox, or -1 for error)
178 int pop3_grab_mailbox(void) {
182 if (getroom(&CC->room, MAILROOM) != 0) return(-1);
184 /* Load up the messages */
185 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL,
186 pop3_add_message, NULL);
188 /* Figure out which are old and which are new */
189 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
190 POP3->lastseen = (-1);
191 if (POP3->num_msgs) for (i=0; i<POP3->num_msgs; ++i) {
192 if (is_msg_in_mset(vbuf.v_seen,
193 (POP3->msgs[POP3->num_msgs-1].msgnum) )) {
198 return(POP3->num_msgs);
201 void pop3_login(void)
205 msgs = pop3_grab_mailbox();
207 cprintf("+OK %s is logged in (%d messages)\r\n",
208 CC->user.fullname, msgs);
209 lprintf(CTDL_NOTICE, "POP3 authenticated %s\n", CC->user.fullname);
212 cprintf("-ERR Can't open your mailbox\r\n");
217 void pop3_apop(char *argbuf)
220 char userdigest[MD5_HEXSTRING_SIZE];
221 char realdigest[MD5_HEXSTRING_SIZE];
226 cprintf("-ERR You are already logged in; not in the AUTHORIZATION phase.\r\n");
230 if ((sptr = strchr(argbuf, ' ')) == NULL)
232 cprintf("-ERR Invalid APOP line.\r\n");
238 while ((*sptr) && isspace(*sptr))
241 strncpy(username, argbuf, sizeof(username)-1);
242 username[sizeof(username)-1] = '\0';
244 memset(userdigest, MD5_HEXSTRING_SIZE, 0);
245 strncpy(userdigest, sptr, MD5_HEXSTRING_SIZE-1);
247 if (CtdlLoginExistingUser(username) != login_ok)
249 cprintf("-ERR No such user.\r\n");
253 if (getuser(&CC->user, CC->curr_user))
255 cprintf("-ERR No such user.\r\n");
259 make_apop_string(CC->user.password, CC->cs_nonce, realdigest, sizeof realdigest);
260 if (!strncasecmp(realdigest, userdigest, MD5_HEXSTRING_SIZE-1))
267 cprintf("-ERR That is NOT the password.\r\n");
273 * Authorize with password (implements POP3 "PASS" command)
275 void pop3_pass(char *argbuf) {
278 strcpy(password, argbuf);
281 lprintf(CTDL_DEBUG, "Trying <%s>\n", password);
282 if (CtdlTryPassword(password) == pass_ok) {
286 cprintf("-ERR That is NOT the password.\r\n");
293 * list available msgs
295 void pop3_list(char *argbuf) {
299 which_one = atoi(argbuf);
301 /* "list one" mode */
303 if (which_one > POP3->num_msgs) {
304 cprintf("-ERR no such message, only %d are here\r\n",
308 else if (POP3->msgs[which_one-1].deleted) {
309 cprintf("-ERR Sorry, you deleted that message.\r\n");
313 cprintf("+OK %d %ld\r\n",
315 (long)POP3->msgs[which_one-1].rfc822_length
321 /* "list all" (scan listing) mode */
323 cprintf("+OK Here's your mail:\r\n");
324 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
325 if (! POP3->msgs[i].deleted) {
326 cprintf("%d %ld\r\n",
328 (long)POP3->msgs[i].rfc822_length);
337 * STAT (tally up the total message count and byte count) command
339 void pop3_stat(char *argbuf) {
341 size_t total_octets = 0;
344 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
345 if (! POP3->msgs[i].deleted) {
347 total_octets += POP3->msgs[i].rfc822_length;
351 cprintf("+OK %d %ld\r\n", total_msgs, (long)total_octets);
357 * RETR command (fetch a message)
359 void pop3_retr(char *argbuf) {
362 which_one = atoi(argbuf);
363 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
364 cprintf("-ERR No such message.\r\n");
368 if (POP3->msgs[which_one - 1].deleted) {
369 cprintf("-ERR Sorry, you deleted that message.\r\n");
373 cprintf("+OK Message %d:\r\n", which_one);
374 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum, MT_RFC822, HEADERS_ALL, 0, 1);
380 * TOP command (dumb way of fetching a partial message or headers-only)
382 void pop3_top(char *argbuf) {
384 int lines_requested = 0;
385 int lines_dumped = 0;
392 sscanf(argbuf, "%d %d", &which_one, &lines_requested);
393 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
394 cprintf("-ERR No such message.\r\n");
398 if (POP3->msgs[which_one - 1].deleted) {
399 cprintf("-ERR Sorry, you deleted that message.\r\n");
403 CC->redirect_buffer = malloc(SIZ);
404 CC->redirect_len = 0;
405 CC->redirect_alloc = SIZ;
406 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum,
407 MT_RFC822, HEADERS_ALL, 0, 1);
408 msgtext = CC->redirect_buffer;
409 CC->redirect_buffer = NULL;
410 CC->redirect_len = 0;
411 CC->redirect_alloc = 0;
413 cprintf("+OK Message %d:\r\n", which_one);
417 while (ptr = memreadline(ptr, buf, (sizeof buf - 2)),
418 ( (*ptr != 0) && (done == 0))) {
421 if (lines_dumped >= lines_requested) {
425 if ((in_body == 0) || (done == 0)) {
426 client_write(buf, strlen(buf));
431 if ((buf[0]==13)||(buf[0]==10)) in_body = 1;
434 if (buf[strlen(buf)-1] != 10) cprintf("\n");
442 * DELE (delete message from mailbox)
444 void pop3_dele(char *argbuf) {
447 which_one = atoi(argbuf);
448 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
449 cprintf("-ERR No such message.\r\n");
453 if (POP3->msgs[which_one - 1].deleted) {
454 cprintf("-ERR You already deleted that message.\r\n");
458 /* Flag the message as deleted. Will expunge during QUIT command. */
459 POP3->msgs[which_one - 1].deleted = 1;
460 cprintf("+OK Message %d deleted.\r\n",
465 /* Perform "UPDATE state" stuff
467 void pop3_update(void) {
471 /* Remove messages marked for deletion */
472 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
473 if (POP3->msgs[i].deleted) {
474 CtdlDeleteMessages(MAILROOM,
475 POP3->msgs[i].msgnum, "");
479 /* Set last read pointer */
480 if (POP3->num_msgs > 0) {
481 lgetuser(&CC->user, CC->curr_user);
483 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
484 snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld",
485 POP3->msgs[POP3->num_msgs-1].msgnum);
486 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
495 * RSET (reset, i.e. undelete any deleted messages) command
497 void pop3_rset(char *argbuf) {
500 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
501 if (POP3->msgs[i].deleted) {
502 POP3->msgs[i].deleted = 0;
505 cprintf("+OK Reset completed.\r\n");
511 * LAST (Determine which message is the last unread message)
513 void pop3_last(char *argbuf) {
514 cprintf("+OK %d\r\n", POP3->lastseen + 1);
520 * UIDL (Universal IDentifier Listing) is easy. Our 'unique' message
521 * identifiers are simply the Citadel message numbers in the database.
523 void pop3_uidl(char *argbuf) {
527 which_one = atoi(argbuf);
529 /* "list one" mode */
531 if (which_one > POP3->num_msgs) {
532 cprintf("-ERR no such message, only %d are here\r\n",
536 else if (POP3->msgs[which_one-1].deleted) {
537 cprintf("-ERR Sorry, you deleted that message.\r\n");
541 cprintf("+OK %d %ld\r\n",
543 POP3->msgs[which_one-1].msgnum
549 /* "list all" (scan listing) mode */
551 cprintf("+OK Here's your mail:\r\n");
552 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
553 if (! POP3->msgs[i].deleted) {
554 cprintf("%d %ld\r\n",
556 POP3->msgs[i].msgnum);
565 * implements the STLS command (Citadel API version)
570 char ok_response[SIZ];
571 char nosup_response[SIZ];
572 char error_response[SIZ];
575 "+OK Begin TLS negotiation now\r\n");
576 sprintf(nosup_response,
577 "-ERR TLS not supported here\r\n");
578 sprintf(error_response,
579 "-ERR Internal error\r\n");
580 CtdlStartTLS(ok_response, nosup_response, error_response);
591 * Main command loop for POP3 sessions.
593 void pop3_command_loop(void) {
597 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
598 if (client_getln(cmdbuf, sizeof cmdbuf) < 1) {
599 lprintf(CTDL_ERR, "POP3 socket is broken. Ending session.\r\n");
603 lprintf(CTDL_INFO, "POP3: %s\r\n", cmdbuf);
604 while (strlen(cmdbuf) < 5) strcat(cmdbuf, " ");
606 if (!strncasecmp(cmdbuf, "NOOP", 4)) {
607 cprintf("+OK No operation.\r\n");
610 else if (!strncasecmp(cmdbuf, "QUIT", 4)) {
611 cprintf("+OK Goodbye...\r\n");
617 else if (!strncasecmp(cmdbuf, "USER", 4)) {
618 pop3_user(&cmdbuf[5]);
621 else if (!strncasecmp(cmdbuf, "PASS", 4)) {
622 pop3_pass(&cmdbuf[5]);
625 else if (!strncasecmp(cmdbuf, "APOP", 4))
627 pop3_apop(&cmdbuf[5]);
631 else if (!strncasecmp(cmdbuf, "STLS", 4)) {
636 else if (!CC->logged_in) {
637 cprintf("-ERR Not logged in.\r\n");
640 else if (!strncasecmp(cmdbuf, "LIST", 4)) {
641 pop3_list(&cmdbuf[5]);
644 else if (!strncasecmp(cmdbuf, "STAT", 4)) {
645 pop3_stat(&cmdbuf[5]);
648 else if (!strncasecmp(cmdbuf, "RETR", 4)) {
649 pop3_retr(&cmdbuf[5]);
652 else if (!strncasecmp(cmdbuf, "DELE", 4)) {
653 pop3_dele(&cmdbuf[5]);
656 else if (!strncasecmp(cmdbuf, "RSET", 4)) {
657 pop3_rset(&cmdbuf[5]);
660 else if (!strncasecmp(cmdbuf, "UIDL", 4)) {
661 pop3_uidl(&cmdbuf[5]);
664 else if (!strncasecmp(cmdbuf, "TOP", 3)) {
665 pop3_top(&cmdbuf[4]);
668 else if (!strncasecmp(cmdbuf, "LAST", 4)) {
669 pop3_last(&cmdbuf[4]);
673 cprintf("-ERR I'm afraid I can't do that.\r\n");
680 char *serv_pop3_init(void)
682 CtdlRegisterServiceHook(config.c_pop3_port,
688 CtdlRegisterServiceHook(config.c_pop3s_port,
694 CtdlRegisterSessionHook(pop3_cleanup_function, EVT_STOP);