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);
84 * Here's where our POP3 session begins its happy day.
86 void pop3_greeting(void) {
87 strcpy(CC->cs_clientname, "POP3 session");
89 CtdlAllocUserData(SYM_POP3, sizeof(struct citpop3));
93 cprintf("+OK Citadel POP3 server %s\r\n",
99 * Specify user name (implements POP3 "USER" command)
101 void pop3_user(char *argbuf) {
105 cprintf("-ERR You are already logged in.\r\n");
109 strcpy(username, argbuf);
112 lprintf(CTDL_DEBUG, "Trying <%s>\n", username);
113 if (CtdlLoginExistingUser(username) == login_ok) {
114 cprintf("+OK Password required for %s\r\n", username);
117 cprintf("-ERR No such user.\r\n");
124 * Back end for pop3_grab_mailbox()
126 void pop3_add_message(long msgnum, void *userdata) {
128 lprintf(CTDL_DEBUG, "in pop3_add_message()\n");
132 if (POP3->num_msgs < 2) POP3->msgs = malloc(sizeof(struct pop3msg));
133 else POP3->msgs = realloc(POP3->msgs,
134 (POP3->num_msgs * sizeof(struct pop3msg)) ) ;
135 POP3->msgs[POP3->num_msgs-1].msgnum = msgnum;
136 POP3->msgs[POP3->num_msgs-1].deleted = 0;
138 /* We need to know the length of this message when it is printed in
139 * RFC822 format. Perhaps we have cached this length in the message's
140 * metadata record. If so, great; if not, measure it and then cache
143 GetMetaData(&smi, POP3->num_msgs-1);
144 if (smi.meta_rfc822_length <= 0L) {
146 CtdlRedirectOutput(fp, -1);
147 CtdlOutputMsg(msgnum, MT_RFC822, HEADERS_ALL, 0, 1);
148 CtdlRedirectOutput(NULL, -1);
149 smi.meta_rfc822_length = ftell(fp);
153 POP3->msgs[POP3->num_msgs-1].rfc822_length = smi.meta_rfc822_length;
159 * Open the inbox and read its contents.
160 * (This should be called only once, by pop3_pass(), and returns the number
161 * of messages in the inbox, or -1 for error)
163 int pop3_grab_mailbox(void) {
167 if (getroom(&CC->room, MAILROOM) != 0) return(-1);
169 /* Load up the messages */
170 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL,
171 pop3_add_message, NULL);
173 /* Figure out which are old and which are new */
174 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
175 POP3->lastseen = (-1);
176 if (POP3->num_msgs) for (i=0; i<POP3->num_msgs; ++i) {
177 if (is_msg_in_mset(vbuf.v_seen,
178 (POP3->msgs[POP3->num_msgs-1].msgnum) )) {
183 return(POP3->num_msgs);
186 void pop3_login(void)
190 msgs = pop3_grab_mailbox();
192 cprintf("+OK %s is logged in (%d messages)\r\n",
193 CC->user.fullname, msgs);
194 lprintf(CTDL_NOTICE, "POP3 authenticated %s\n", CC->user.fullname);
197 cprintf("-ERR Can't open your mailbox\r\n");
202 void pop3_apop(char *argbuf)
205 char userdigest[MD5_HEXSTRING_SIZE];
206 char realdigest[MD5_HEXSTRING_SIZE];
211 cprintf("-ERR You are already logged in; not in the AUTHORIZATION phase.\r\n");
215 if ((sptr = strchr(argbuf, ' ')) == NULL)
217 cprintf("-ERR Invalid APOP line.\r\n");
223 while ((*sptr) && isspace(*sptr))
226 strncpy(username, argbuf, sizeof(username)-1);
227 username[sizeof(username)-1] = '\0';
229 memset(userdigest, MD5_HEXSTRING_SIZE, 0);
230 strncpy(userdigest, sptr, MD5_HEXSTRING_SIZE-1);
232 if (CtdlLoginExistingUser(username) != login_ok)
234 cprintf("-ERR No such user.\r\n");
238 if (getuser(&CC->user, CC->curr_user))
240 cprintf("-ERR No such user.\r\n");
244 make_apop_string(CC->user.password, CC->cs_nonce, realdigest, sizeof realdigest);
245 if (!strncasecmp(realdigest, userdigest, MD5_HEXSTRING_SIZE-1))
252 cprintf("-ERR That is NOT the password.\r\n");
258 * Authorize with password (implements POP3 "PASS" command)
260 void pop3_pass(char *argbuf) {
263 strcpy(password, argbuf);
266 lprintf(CTDL_DEBUG, "Trying <%s>\n", password);
267 if (CtdlTryPassword(password) == pass_ok) {
271 cprintf("-ERR That is NOT the password.\r\n");
278 * list available msgs
280 void pop3_list(char *argbuf) {
284 which_one = atoi(argbuf);
286 /* "list one" mode */
288 if (which_one > POP3->num_msgs) {
289 cprintf("-ERR no such message, only %d are here\r\n",
293 else if (POP3->msgs[which_one-1].deleted) {
294 cprintf("-ERR Sorry, you deleted that message.\r\n");
298 cprintf("+OK %d %ld\r\n",
300 (long)POP3->msgs[which_one-1].rfc822_length
306 /* "list all" (scan listing) mode */
308 cprintf("+OK Here's your mail:\r\n");
309 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
310 if (! POP3->msgs[i].deleted) {
311 cprintf("%d %ld\r\n",
313 (long)POP3->msgs[i].rfc822_length);
322 * STAT (tally up the total message count and byte count) command
324 void pop3_stat(char *argbuf) {
326 size_t total_octets = 0;
329 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
330 if (! POP3->msgs[i].deleted) {
332 total_octets += POP3->msgs[i].rfc822_length;
336 cprintf("+OK %d %ld\r\n", total_msgs, (long)total_octets);
342 * RETR command (fetch a message)
344 void pop3_retr(char *argbuf) {
347 which_one = atoi(argbuf);
348 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
349 cprintf("-ERR No such message.\r\n");
353 if (POP3->msgs[which_one - 1].deleted) {
354 cprintf("-ERR Sorry, you deleted that message.\r\n");
358 cprintf("+OK Message %d:\r\n", which_one);
359 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum, MT_RFC822, HEADERS_ALL, 0, 1);
365 * TOP command (dumb way of fetching a partial message or headers-only)
367 void pop3_top(char *argbuf) {
369 int lines_requested = 0;
370 int lines_dumped = 0;
377 sscanf(argbuf, "%d %d", &which_one, &lines_requested);
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");
390 cprintf("-ERR Internal error: could not create temp file\r\n");
393 CtdlRedirectOutput(fp, -1);
394 CtdlOutputMsg(POP3->msgs[which_one - 1].msgnum, MT_RFC822, HEADERS_ALL, 0, 1);
395 CtdlRedirectOutput(NULL, -1);
397 cprintf("+OK Message %d:\r\n", which_one);
399 while (ptr = fgets(buf, sizeof buf, fp),
400 ( (ptr!=NULL) && (done == 0))) {
402 if (lines_dumped >= lines_requested) done = 1;
403 if ((in_body == 0) || (done == 0))
404 client_write(buf, strlen(buf));
405 if (in_body) ++lines_dumped;
406 if ((buf[0]==13)||(buf[0]==10)) in_body = 1;
408 if (buf[strlen(buf)-1] != 10) cprintf("\n");
415 * DELE (delete message from mailbox)
417 void pop3_dele(char *argbuf) {
420 which_one = atoi(argbuf);
421 if ( (which_one < 1) || (which_one > POP3->num_msgs) ) {
422 cprintf("-ERR No such message.\r\n");
426 if (POP3->msgs[which_one - 1].deleted) {
427 cprintf("-ERR You already deleted that message.\r\n");
431 /* Flag the message as deleted. Will expunge during QUIT command. */
432 POP3->msgs[which_one - 1].deleted = 1;
433 cprintf("+OK Message %d deleted.\r\n",
438 /* Perform "UPDATE state" stuff
440 void pop3_update(void) {
444 /* Remove messages marked for deletion */
445 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
446 if (POP3->msgs[i].deleted) {
447 CtdlDeleteMessages(MAILROOM,
448 POP3->msgs[i].msgnum, "");
452 /* Set last read pointer */
453 if (POP3->num_msgs > 0) {
454 lgetuser(&CC->user, CC->curr_user);
456 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
457 snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld",
458 POP3->msgs[POP3->num_msgs-1].msgnum);
459 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
468 * RSET (reset, i.e. undelete any deleted messages) command
470 void pop3_rset(char *argbuf) {
473 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
474 if (POP3->msgs[i].deleted) {
475 POP3->msgs[i].deleted = 0;
478 cprintf("+OK Reset completed.\r\n");
484 * LAST (Determine which message is the last unread message)
486 void pop3_last(char *argbuf) {
487 cprintf("+OK %d\r\n", POP3->lastseen + 1);
493 * UIDL (Universal IDentifier Listing) is easy. Our 'unique' message
494 * identifiers are simply the Citadel message numbers in the database.
496 void pop3_uidl(char *argbuf) {
500 which_one = atoi(argbuf);
502 /* "list one" mode */
504 if (which_one > POP3->num_msgs) {
505 cprintf("-ERR no such message, only %d are here\r\n",
509 else if (POP3->msgs[which_one-1].deleted) {
510 cprintf("-ERR Sorry, you deleted that message.\r\n");
514 cprintf("+OK %d %ld\r\n",
516 POP3->msgs[which_one-1].msgnum
522 /* "list all" (scan listing) mode */
524 cprintf("+OK Here's your mail:\r\n");
525 if (POP3->num_msgs > 0) for (i=0; i<POP3->num_msgs; ++i) {
526 if (! POP3->msgs[i].deleted) {
527 cprintf("%d %ld\r\n",
529 POP3->msgs[i].msgnum);
538 * implements the STLS command (Citadel API version)
543 char ok_response[SIZ];
544 char nosup_response[SIZ];
545 char error_response[SIZ];
548 "+OK Begin TLS negotiation now\r\n");
549 sprintf(nosup_response,
550 "-ERR TLS not supported here\r\n");
551 sprintf(error_response,
552 "-ERR Internal error\r\n");
553 CtdlStartTLS(ok_response, nosup_response, error_response);
564 * Main command loop for POP3 sessions.
566 void pop3_command_loop(void) {
570 memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
571 if (client_gets(cmdbuf) < 1) {
572 lprintf(CTDL_ERR, "POP3 socket is broken. Ending session.\r\n");
576 lprintf(CTDL_INFO, "POP3: %s\r\n", cmdbuf);
577 while (strlen(cmdbuf) < 5) strcat(cmdbuf, " ");
579 if (!strncasecmp(cmdbuf, "NOOP", 4)) {
580 cprintf("+OK No operation.\r\n");
583 else if (!strncasecmp(cmdbuf, "QUIT", 4)) {
584 cprintf("+OK Goodbye...\r\n");
590 else if (!strncasecmp(cmdbuf, "USER", 4)) {
591 pop3_user(&cmdbuf[5]);
594 else if (!strncasecmp(cmdbuf, "PASS", 4)) {
595 pop3_pass(&cmdbuf[5]);
598 else if (!strncasecmp(cmdbuf, "APOP", 4))
600 pop3_apop(&cmdbuf[5]);
604 else if (!strncasecmp(cmdbuf, "STLS", 4)) {
609 else if (!CC->logged_in) {
610 cprintf("-ERR Not logged in.\r\n");
613 else if (!strncasecmp(cmdbuf, "LIST", 4)) {
614 pop3_list(&cmdbuf[5]);
617 else if (!strncasecmp(cmdbuf, "STAT", 4)) {
618 pop3_stat(&cmdbuf[5]);
621 else if (!strncasecmp(cmdbuf, "RETR", 4)) {
622 pop3_retr(&cmdbuf[5]);
625 else if (!strncasecmp(cmdbuf, "DELE", 4)) {
626 pop3_dele(&cmdbuf[5]);
629 else if (!strncasecmp(cmdbuf, "RSET", 4)) {
630 pop3_rset(&cmdbuf[5]);
633 else if (!strncasecmp(cmdbuf, "UIDL", 4)) {
634 pop3_uidl(&cmdbuf[5]);
637 else if (!strncasecmp(cmdbuf, "TOP", 3)) {
638 pop3_top(&cmdbuf[4]);
641 else if (!strncasecmp(cmdbuf, "LAST", 4)) {
642 pop3_last(&cmdbuf[4]);
646 cprintf("-ERR I'm afraid I can't do that.\r\n");
653 char *serv_pop3_init(void)
655 CtdlRegisterServiceHook(config.c_pop3_port,
660 CtdlRegisterSessionHook(pop3_cleanup_function, EVT_STOP);