2 * This module is an SMTP and ESMTP implementation for the Citadel system.
3 * It is compliant with all of the following:
5 * RFC 821 - Simple Mail Transfer Protocol
6 * RFC 876 - Survey of SMTP Implementations
7 * RFC 1047 - Duplicate messages and SMTP
8 * RFC 1652 - 8 bit MIME
9 * RFC 1869 - Extended Simple Mail Transfer Protocol
10 * RFC 1870 - SMTP Service Extension for Message Size Declaration
11 * RFC 2033 - Local Mail Transfer Protocol
12 * RFC 2197 - SMTP Service Extension for Command Pipelining
13 * RFC 2476 - Message Submission
14 * RFC 2487 - SMTP Service Extension for Secure SMTP over TLS
15 * RFC 2554 - SMTP Service Extension for Authentication
16 * RFC 2821 - Simple Mail Transfer Protocol
17 * RFC 2822 - Internet Message Format
18 * RFC 2920 - SMTP Service Extension for Command Pipelining
20 * The VRFY and EXPN commands have been removed from this implementation
21 * because nobody uses these commands anymore, except for spammers.
23 * Copyright (c) 1998-2009 by the citadel.org team
25 * This program is free software; you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation; either version 3 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program; if not, write to the Free Software
37 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
49 #include <sys/types.h>
52 #if TIME_WITH_SYS_TIME
53 # include <sys/time.h>
57 # include <sys/time.h>
66 #include <sys/socket.h>
67 #include <netinet/in.h>
68 #include <arpa/inet.h>
69 #include <libcitadel.h>
72 #include "citserver.h"
79 #include "internet_addressing.h"
82 #include "clientsocket.h"
83 #include "locate_host.h"
84 #include "citadel_dirs.h"
86 #include "ctdl_module.h"
88 #include "smtp_util.h"
89 #include "event_client.h"
90 #include "smtpqueue.h"
91 #include "smtp_clienthandlers.h"
93 const unsigned short DefaultMXPort = 25;
94 void DeleteSmtpOutMsg(void *v)
97 AsyncIO *IO = &Msg->IO;
98 EV_syslog(LOG_DEBUG, "SMTP: %s Aborting\n", __FUNCTION__);
100 /* these are kept in our own space and free'd below */
101 Msg->IO.ConnectMe = NULL;
103 ares_free_data(Msg->AllMX);
104 if (Msg->HostLookup.VParsedDNSReply != NULL)
105 Msg->HostLookup.DNSReplyFree(Msg->HostLookup.VParsedDNSReply);
106 FreeURL(&Msg->Relay);
107 FreeStrBuf(&Msg->msgtext);
108 FreeAsyncIOContents(&Msg->IO);
109 /// memset (Msg, 0, sizeof(SmtpOutMsg)); /* just to be shure... */
113 eNextState SMTP_C_Shutdown(AsyncIO *IO);
114 eNextState SMTP_C_Timeout(AsyncIO *IO);
115 eNextState SMTP_C_ConnFail(AsyncIO *IO);
116 eNextState SMTP_C_DispatchReadDone(AsyncIO *IO);
117 eNextState SMTP_C_DispatchWriteDone(AsyncIO *IO);
118 eNextState SMTP_C_DNSFail(AsyncIO *IO);
119 eNextState SMTP_C_Terminate(AsyncIO *IO);
120 eReadState SMTP_C_ReadServerStatus(AsyncIO *IO);
122 eNextState mx_connect_ip(AsyncIO *IO);
123 eNextState get_one_mx_host_ip(AsyncIO *IO);
125 /******************************************************************************
126 * So, we're finished with sending (regardless of success or failure) *
127 * This Message might be referenced by several Queue-Items, if we're the last,*
128 * we need to free the memory and send bounce messages (on terminal failure) *
129 * else we just free our SMTP-Message struct. *
130 ******************************************************************************/
131 void FinalizeMessageSend(SmtpOutMsg *Msg)
133 int IDestructQueItem;
136 AsyncIO *IO = &Msg->IO;
138 IDestructQueItem = DecreaseQReference(Msg->MyQItem);
140 nRemain = CountActiveQueueEntries(Msg->MyQItem);
142 if ((nRemain > 0) || IDestructQueItem)
143 MsgData = SerializeQueueItem(Msg->MyQItem);
148 * Uncompleted delivery instructions remain, so delete the old
149 * instructions and replace with the updated ones.
151 EVS_syslog(LOG_DEBUG, "SMTPQD: %ld", Msg->MyQItem->QueMsgID);
152 CtdlDeleteMessages(SMTP_SPOOLOUT_ROOM, &Msg->MyQItem->QueMsgID, 1, "");
154 if (IDestructQueItem)
155 smtpq_do_bounce(Msg->MyQItem,Msg->msgtext);
159 struct CtdlMessage *msg;
160 msg = malloc(sizeof(struct CtdlMessage));
161 memset(msg, 0, sizeof(struct CtdlMessage));
162 msg->cm_magic = CTDLMESSAGE_MAGIC;
163 msg->cm_anon_type = MES_NORMAL;
164 msg->cm_format_type = FMT_RFC822;
165 msg->cm_fields['M'] = SmashStrBuf(&MsgData);
166 Msg->MyQItem->QueMsgID =
167 CtdlSubmitMsg(msg, NULL, SMTP_SPOOLOUT_ROOM, QP_EADDR);
168 EVS_syslog(LOG_DEBUG, "SMTPQ: %ld", Msg->MyQItem->QueMsgID);
169 CtdlFreeMessage(msg);
172 CtdlDeleteMessages(SMTP_SPOOLOUT_ROOM,
173 &Msg->MyQItem->MessageID,
176 FreeStrBuf(&MsgData);
178 RemoveContext(Msg->IO.CitContext);
179 if (IDestructQueItem)
180 RemoveQItem(Msg->MyQItem);
181 DeleteSmtpOutMsg(Msg);
184 eNextState FailOneAttempt(AsyncIO *IO)
186 SmtpOutMsg *SendMsg = IO->Data;
188 if (SendMsg->MyQEntry->Status == 2)
192 * possible ways here:
193 * - connection timeout
194 * - dns lookup failed
196 StopClientWatchers(IO);
198 if (SendMsg->pCurrRelay != NULL)
199 SendMsg->pCurrRelay = SendMsg->pCurrRelay->Next;
201 if (SendMsg->pCurrRelay == NULL) {
202 EVS_syslog(LOG_DEBUG, "SMTP: %s Aborting\n", __FUNCTION__);
205 if (SendMsg->pCurrRelay->IsIP) {
206 EVS_syslog(LOG_DEBUG, "SMTP: %s connecting IP\n", __FUNCTION__);
207 return mx_connect_ip(IO);
210 EVS_syslog(LOG_DEBUG,
211 "SMTP: %s resolving next MX Record\n",
213 return get_one_mx_host_ip(IO);
218 void SetConnectStatus(AsyncIO *IO)
220 SmtpOutMsg *SendMsg = IO->Data;
226 if (IO->ConnectMe->IPv6) {
227 src = &IO->ConnectMe->Addr.sin6_addr;
230 struct sockaddr_in *addr;
232 addr = (struct sockaddr_in *)&IO->ConnectMe->Addr;
233 src = &addr->sin_addr.s_addr;
236 inet_ntop((IO->ConnectMe->IPv6)?AF_INET6:AF_INET,
241 if (SendMsg->mx_host == NULL)
242 SendMsg->mx_host = "<no MX-Record>";
244 EVS_syslog(LOG_DEBUG,
245 "SMTP client[%ld]: connecting to %s [%s]:%d ...\n",
249 SendMsg->IO.ConnectMe->Port);
251 SendMsg->MyQEntry->Status = 5;
252 StrBufPrintf(SendMsg->MyQEntry->StatusMessage,
253 "Timeout while connecting %s [%s]:%d ",
256 SendMsg->IO.ConnectMe->Port);
257 SendMsg->IO.NextState = eConnect;
260 /*****************************************************************************
261 * So we connect our Relay IP here. *
262 *****************************************************************************/
263 eNextState mx_connect_ip(AsyncIO *IO)
265 SmtpOutMsg *SendMsg = IO->Data;
267 EVS_syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
269 IO->ConnectMe = SendMsg->pCurrRelay;
271 SetConnectStatus(IO);
273 return EvConnectSock(IO,
275 SMTP_C_ReadTimeouts[0],
279 eNextState get_one_mx_host_ip_done(AsyncIO *IO)
281 SmtpOutMsg *SendMsg = IO->Data;
282 struct hostent *hostent;
286 hostent = SendMsg->HostLookup.VParsedDNSReply;
287 if ((SendMsg->HostLookup.DNSStatus == ARES_SUCCESS) &&
288 (hostent != NULL) ) {
289 memset(&SendMsg->pCurrRelay->Addr, 0, sizeof(struct in6_addr));
290 if (SendMsg->pCurrRelay->IPv6) {
291 memcpy(&SendMsg->pCurrRelay->Addr.sin6_addr.s6_addr,
292 &hostent->h_addr_list[0],
293 sizeof(struct in6_addr));
295 SendMsg->pCurrRelay->Addr.sin6_family =
297 SendMsg->pCurrRelay->Addr.sin6_port =
298 htons(DefaultMXPort);
301 struct sockaddr_in *addr;
303 * Bypass the ns lookup result like this:
304 * IO->Addr.sin_addr.s_addr = inet_addr("127.0.0.1");
305 * addr->sin_addr.s_addr =
306 * htonl((uint32_t)&hostent->h_addr_list[0]);
309 addr = (struct sockaddr_in*) &SendMsg->pCurrRelay->Addr;
311 memcpy(&addr->sin_addr.s_addr,
312 hostent->h_addr_list[0],
315 addr->sin_family = hostent->h_addrtype;
316 addr->sin_port = htons(DefaultMXPort);
318 SendMsg->mx_host = SendMsg->pCurrRelay->Host;
319 return mx_connect_ip(IO);
322 return FailOneAttempt(IO);
325 eNextState get_one_mx_host_ip(AsyncIO *IO)
327 SmtpOutMsg * SendMsg = IO->Data;
329 * here we start with the lookup of one host. it might be...
330 * - the relay host *sigh*
331 * - the direct hostname if there was no mx record
337 EVS_syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
339 EVS_syslog(LOG_DEBUG,
340 "SMTP client[%ld]: looking up %s-Record %s : %d ...\n",
342 (SendMsg->pCurrRelay->IPv6)? "aaaa": "a",
343 SendMsg->pCurrRelay->Host,
344 SendMsg->pCurrRelay->Port);
346 if (!QueueQuery((SendMsg->pCurrRelay->IPv6)? ns_t_aaaa : ns_t_a,
347 SendMsg->pCurrRelay->Host,
349 &SendMsg->HostLookup,
350 get_one_mx_host_ip_done))
352 SendMsg->MyQEntry->Status = 5;
353 StrBufPrintf(SendMsg->MyQEntry->StatusMessage,
354 "No MX hosts found for <%s>", SendMsg->node);
355 SendMsg->IO.NextState = eTerminateConnection;
356 return IO->NextState;
358 IO->NextState = eReadDNSReply;
359 return IO->NextState;
363 /*****************************************************************************
364 * here we try to find out about the MX records for our recipients. *
365 *****************************************************************************/
366 eNextState smtp_resolve_mx_record_done(AsyncIO *IO)
368 SmtpOutMsg * SendMsg = IO->Data;
373 EVS_syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
374 pp = &SendMsg->Relay;
375 while ((pp != NULL) && (*pp != NULL) && ((*pp)->Next != NULL))
378 if ((IO->DNS.Query->DNSStatus == ARES_SUCCESS) &&
379 (IO->DNS.Query->VParsedDNSReply != NULL))
380 { /* ok, we found mx records. */
381 SendMsg->IO.ErrMsg = SendMsg->MyQEntry->StatusMessage;
385 = IO->DNS.Query->VParsedDNSReply;
386 while (SendMsg->CurrMX) {
388 for (i = 0; i < 2; i++) {
391 p = (ParsedURL*) malloc(sizeof(ParsedURL));
392 memset(p, 0, sizeof(ParsedURL));
394 p->Port = DefaultMXPort;
396 p->Host = SendMsg->CurrMX->host;
401 SendMsg->CurrMX = SendMsg->CurrMX->next;
403 SendMsg->CXFlags = SendMsg->CXFlags & F_HAVE_MX;
405 else { /* else fall back to the plain hostname */
407 for (i = 0; i < 2; i++) {
410 p = (ParsedURL*) malloc(sizeof(ParsedURL));
411 memset(p, 0, sizeof(ParsedURL));
413 p->Port = DefaultMXPort;
415 p->Host = SendMsg->node;
420 SendMsg->CXFlags = SendMsg->CXFlags & F_DIRECT;
422 *pp = SendMsg->MyQItem->FallBackHost;
423 SendMsg->pCurrRelay = SendMsg->Relay;
424 return get_one_mx_host_ip(IO);
427 eNextState resolve_mx_records(AsyncIO *IO)
429 SmtpOutMsg * SendMsg = IO->Data;
431 EVS_syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
432 /* start resolving MX records here. */
433 if (!QueueQuery(ns_t_mx,
437 smtp_resolve_mx_record_done))
439 SendMsg->MyQEntry->Status = 5;
440 StrBufPrintf(SendMsg->MyQEntry->StatusMessage,
441 "No MX hosts found for <%s>", SendMsg->node);
442 return IO->NextState;
444 SendMsg->IO.NextState = eReadDNSReply;
445 return IO->NextState;
450 /******************************************************************************
451 * so, we're going to start a SMTP delivery. lets get it on. *
452 ******************************************************************************/
454 SmtpOutMsg *new_smtp_outmsg(OneQueItem *MyQItem,
455 MailQEntry *MyQEntry,
458 SmtpOutMsg * SendMsg;
460 SendMsg = (SmtpOutMsg *) malloc(sizeof(SmtpOutMsg));
461 memset(SendMsg, 0, sizeof(SmtpOutMsg));
463 SendMsg->n = MsgCount;
464 SendMsg->MyQEntry = MyQEntry;
465 SendMsg->MyQItem = MyQItem;
466 SendMsg->pCurrRelay = MyQItem->URL;
468 InitIOStruct(&SendMsg->IO,
471 SMTP_C_ReadServerStatus,
473 SMTP_C_DispatchWriteDone,
474 SMTP_C_DispatchReadDone,
483 void smtp_try_one_queue_entry(OneQueItem *MyQItem,
484 MailQEntry *MyQEntry,
486 /*KeepMsgText allows us to use MsgText as ours.*/
492 syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
494 SendMsg = new_smtp_outmsg(MyQItem, MyQEntry, MsgCount);
495 if (KeepMsgText) SendMsg->msgtext = MsgText;
496 else SendMsg->msgtext = NewStrBufDup(MsgText);
498 if (smtp_resolve_recipients(SendMsg)) {
501 ((CitContext *)SendMsg->IO.CitContext)->cs_host,
503 sizeof(((CitContext *)
504 SendMsg->IO.CitContext)->cs_host));
506 syslog(LOG_DEBUG, "SMTP Starting: [%ld] <%s> CC <%d> \n",
507 SendMsg->MyQItem->MessageID,
508 ChrPtr(SendMsg->MyQEntry->Recipient),
509 ((CitContext*)SendMsg->IO.CitContext)->cs_pid);
510 if (SendMsg->pCurrRelay == NULL)
511 QueueEventContext(&SendMsg->IO,
513 else { /* oh... via relay host */
514 if (SendMsg->pCurrRelay->IsIP) {
515 QueueEventContext(&SendMsg->IO,
519 /* uneducated admin has chosen to
520 add DNS to the equation... */
521 QueueEventContext(&SendMsg->IO,
527 /* No recipients? well fail then. */
528 if ((SendMsg==NULL) ||
529 (SendMsg->MyQEntry == NULL)) {
530 SendMsg->MyQEntry->Status = 5;
531 StrBufPlain(SendMsg->MyQEntry->StatusMessage,
532 HKEY("Invalid Recipient!"));
534 FinalizeMessageSend(SendMsg);
543 /*****************************************************************************/
544 /* SMTP CLIENT DISPATCHER */
545 /*****************************************************************************/
547 void SMTPSetTimeout(eNextState NextTCPState, SmtpOutMsg *pMsg)
549 double Timeout = 0.0;
550 AsyncIO *IO = &pMsg->IO;
552 EVS_syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
554 switch (NextTCPState) {
558 Timeout = SMTP_C_SendTimeouts[pMsg->State];
559 if (pMsg->State == eDATABody) {
560 /* if we're sending a huge message,
563 Timeout += StrLength(pMsg->msgtext) / 1024;
567 Timeout = SMTP_C_ReadTimeouts[pMsg->State];
568 if (pMsg->State == eDATATerminateBody) {
570 * some mailservers take a nap before accepting
571 * the message content inspection and such.
573 Timeout += StrLength(pMsg->msgtext) / 1024;
583 case eTerminateConnection:
587 SetNextTimeout(&pMsg->IO, Timeout);
589 eNextState SMTP_C_DispatchReadDone(AsyncIO *IO)
591 EVS_syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
592 SmtpOutMsg *pMsg = IO->Data;
595 rc = ReadHandlers[pMsg->State](pMsg);
599 SMTPSetTimeout(rc, pMsg);
603 eNextState SMTP_C_DispatchWriteDone(AsyncIO *IO)
605 EVS_syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
606 SmtpOutMsg *pMsg = IO->Data;
609 rc = SendHandlers[pMsg->State](pMsg);
610 SMTPSetTimeout(rc, pMsg);
615 /*****************************************************************************/
616 /* SMTP CLIENT ERROR CATCHERS */
617 /*****************************************************************************/
618 eNextState SMTP_C_Terminate(AsyncIO *IO)
620 SmtpOutMsg *pMsg = IO->Data;
622 EVS_syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
623 FinalizeMessageSend(pMsg);
626 eNextState SMTP_C_Timeout(AsyncIO *IO)
628 SmtpOutMsg *pMsg = IO->Data;
630 pMsg->MyQEntry->Status = 4;
631 EVS_syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
632 StrBufPlain(IO->ErrMsg, CKEY(ReadErrors[pMsg->State]));
633 return FailOneAttempt(IO);
635 eNextState SMTP_C_ConnFail(AsyncIO *IO)
637 SmtpOutMsg *pMsg = IO->Data;
639 pMsg->MyQEntry->Status = 4;
640 EVS_syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
641 StrBufPlain(IO->ErrMsg, CKEY(ReadErrors[pMsg->State]));
642 return FailOneAttempt(IO);
644 eNextState SMTP_C_DNSFail(AsyncIO *IO)
646 SmtpOutMsg *pMsg = IO->Data;
647 pMsg->MyQEntry->Status = 4;
648 EVS_syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
649 return FailOneAttempt(IO);
651 eNextState SMTP_C_Shutdown(AsyncIO *IO)
653 EVS_syslog(LOG_DEBUG, "SMTP: %s\n", __FUNCTION__);
654 SmtpOutMsg *pMsg = IO->Data;
656 pMsg->MyQEntry->Status = 3;
657 StrBufPlain(pMsg->MyQEntry->StatusMessage,
658 HKEY("server shutdown during message submit."));
659 FinalizeMessageSend(pMsg);
665 * @brief lineread Handler;
666 * understands when to read more SMTP lines, and when this is a one-lined reply.
668 eReadState SMTP_C_ReadServerStatus(AsyncIO *IO)
670 eReadState Finished = eBufferNotEmpty;
672 while (Finished == eBufferNotEmpty) {
673 Finished = StrBufChunkSipLine(IO->IOBuf, &IO->RecvBuf);
676 case eMustReadMore: /// read new from socket...
679 case eBufferNotEmpty: /* shouldn't happen... */
680 case eReadSuccess: /// done for now...
681 if (StrLength(IO->IOBuf) < 4)
683 if (ChrPtr(IO->IOBuf)[3] == '-')
684 Finished = eBufferNotEmpty;
688 case eReadFail: /// WHUT?
696 CTDL_MODULE_INIT(smtp_eventclient)
698 return "smtpeventclient";