1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
10 /* Functions for handling an incoming SMTP call. */
17 /* Initialize for TCP wrappers if so configured. It appears that the macro
18 HAVE_IPV6 is used in some versions of the tcpd.h header, so we unset it before
19 including that header, and restore its value afterwards. */
21 #ifdef USE_TCP_WRAPPERS
24 #define EXIM_HAVE_IPV6
30 #define HAVE_IPV6 TRUE
33 int allow_severity = LOG_INFO;
34 int deny_severity = LOG_NOTICE;
35 uschar *tcp_wrappers_name;
39 /* Size of buffer for reading SMTP commands. We used to use 512, as defined
40 by RFC 821. However, RFC 1869 specifies that this must be increased for SMTP
41 commands that accept arguments, and this in particular applies to AUTH, where
42 the data can be quite long. More recently this value was 2048 in Exim;
43 however, RFC 4954 (circa 2007) recommends 12288 bytes to handle AUTH. Clients
44 such as Thunderbird will send an AUTH with an initial-response for GSSAPI.
45 The maximum size of a Kerberos ticket under Windows 2003 is 12000 bytes, and
46 we need room to handle large base64-encoded AUTHs for GSSAPI.
49 #define SMTP_CMD_BUFFER_SIZE 16384
51 /* Size of buffer for reading SMTP incoming packets */
53 #define IN_BUFFER_SIZE 8192
55 /* Structure for SMTP command list */
62 short int is_mail_cmd;
65 /* Codes for identifying commands. We order them so that those that come first
66 are those for which synchronization is always required. Checking this can help
70 /* These commands are required to be synchronized, i.e. to be the last in a
71 block of commands when pipelining. */
73 HELO_CMD, EHLO_CMD, DATA_CMD, /* These are listed in the pipelining */
74 VRFY_CMD, EXPN_CMD, NOOP_CMD, /* RFC as requiring synchronization */
75 ETRN_CMD, /* This by analogy with TURN from the RFC */
76 STARTTLS_CMD, /* Required by the STARTTLS RFC */
77 TLS_AUTH_CMD, /* auto-command at start of SSL */
79 /* This is a dummy to identify the non-sync commands when pipelining */
81 NON_SYNC_CMD_PIPELINING,
83 /* These commands need not be synchronized when pipelining */
85 MAIL_CMD, RCPT_CMD, RSET_CMD,
87 /* This is a dummy to identify the non-sync commands when not pipelining */
89 NON_SYNC_CMD_NON_PIPELINING,
91 /* RFC3030 section 2: "After all MAIL and RCPT responses are collected and
92 processed the message is sent using a series of BDAT commands"
93 implies that BDAT should be synchronized. However, we see Google, at least,
94 sending MAIL,RCPT,BDAT-LAST in a single packet, clearly not waiting for
95 processing of the RCPT response(s). We shall do the same, and not require
96 synch for BDAT. Worse, as the chunk may (very likely will) follow the
97 command-header in the same packet we cannot do the usual "is there any
98 follow-on data after the command line" even for non-pipeline mode.
99 So we'll need an explicit check after reading the expected chunk amount
100 when non-pipe, before sending the ACK. */
104 /* I have been unable to find a statement about the use of pipelining
105 with AUTH, so to be on the safe side it is here, though I kind of feel
106 it should be up there with the synchronized commands. */
110 /* I'm not sure about these, but I don't think they matter. */
115 PROXY_FAIL_IGNORE_CMD,
118 /* These are specials that don't correspond to actual commands */
120 EOF_CMD, OTHER_CMD, BADARG_CMD, BADCHAR_CMD, BADSYN_CMD,
121 TOO_MANY_NONMAIL_CMD };
124 /* This is a convenience macro for adding the identity of an SMTP command
125 to the circular buffer that holds a list of the last n received. */
128 smtp_connection_had[smtp_ch_index++] = n; \
129 if (smtp_ch_index >= SMTP_HBUFF_SIZE) smtp_ch_index = 0
132 /*************************************************
133 * Local static variables *
134 *************************************************/
137 BOOL auth_advertised :1;
139 BOOL tls_advertised :1;
141 BOOL dsn_advertised :1;
143 BOOL helo_verify_required :1;
146 BOOL helo_accept_junk :1;
147 #ifndef DISABLE_PIPE_CONNECT
148 BOOL pipe_connect_acceptable :1;
150 BOOL rcpt_smtp_response_same :1;
151 BOOL rcpt_in_progress :1;
152 BOOL smtp_exit_function_called :1;
154 BOOL smtputf8_advertised :1;
157 .helo_verify_required = FALSE,
158 .helo_verify = FALSE,
159 .smtp_exit_function_called = FALSE,
162 static auth_instance *authenticated_by;
163 static int count_nonmail;
164 static int nonmail_command_count;
165 static int synprot_error_count;
166 static int unknown_command_count;
167 static int sync_cmd_limit;
168 static int smtp_write_error = 0;
170 static uschar *rcpt_smtp_response;
171 static uschar *smtp_data_buffer;
172 static uschar *smtp_cmd_data;
174 /* We need to know the position of RSET, HELO, EHLO, AUTH, and STARTTLS. Their
175 final fields of all except AUTH are forced TRUE at the start of a new message
176 setup, to allow one of each between messages that is not counted as a nonmail
177 command. (In fact, only one of HELO/EHLO is not counted.) Also, we have to
178 allow a new EHLO after starting up TLS.
180 AUTH is "falsely" labelled as a mail command initially, so that it doesn't get
181 counted. However, the flag is changed when AUTH is received, so that multiple
182 failing AUTHs will eventually hit the limit. After a successful AUTH, another
183 AUTH is already forbidden. After a TLS session is started, AUTH's flag is again
184 forced TRUE, to allow for the re-authentication that can happen at that point.
186 QUIT is also "falsely" labelled as a mail command so that it doesn't up the
187 count of non-mail commands and possibly provoke an error.
189 tls_auth is a pseudo-command, never expected in input. It is activated
190 on TLS startup and looks for a tls authenticator. */
192 static smtp_cmd_list cmd_list[] = {
193 /* name len cmd has_arg is_mail_cmd */
195 { "rset", sizeof("rset")-1, RSET_CMD, FALSE, FALSE }, /* First */
196 { "helo", sizeof("helo")-1, HELO_CMD, TRUE, FALSE },
197 { "ehlo", sizeof("ehlo")-1, EHLO_CMD, TRUE, FALSE },
198 { "auth", sizeof("auth")-1, AUTH_CMD, TRUE, TRUE },
200 { "starttls", sizeof("starttls")-1, STARTTLS_CMD, FALSE, FALSE },
201 { "tls_auth", 0, TLS_AUTH_CMD, FALSE, FALSE },
204 /* If you change anything above here, also fix the definitions below. */
206 { "mail from:", sizeof("mail from:")-1, MAIL_CMD, TRUE, TRUE },
207 { "rcpt to:", sizeof("rcpt to:")-1, RCPT_CMD, TRUE, TRUE },
208 { "data", sizeof("data")-1, DATA_CMD, FALSE, TRUE },
209 { "bdat", sizeof("bdat")-1, BDAT_CMD, TRUE, TRUE },
210 { "quit", sizeof("quit")-1, QUIT_CMD, FALSE, TRUE },
211 { "noop", sizeof("noop")-1, NOOP_CMD, TRUE, FALSE },
212 { "etrn", sizeof("etrn")-1, ETRN_CMD, TRUE, FALSE },
213 { "vrfy", sizeof("vrfy")-1, VRFY_CMD, TRUE, FALSE },
214 { "expn", sizeof("expn")-1, EXPN_CMD, TRUE, FALSE },
215 { "help", sizeof("help")-1, HELP_CMD, TRUE, FALSE }
218 static smtp_cmd_list *cmd_list_end =
219 cmd_list + sizeof(cmd_list)/sizeof(smtp_cmd_list);
221 #define CMD_LIST_RSET 0
222 #define CMD_LIST_HELO 1
223 #define CMD_LIST_EHLO 2
224 #define CMD_LIST_AUTH 3
225 #define CMD_LIST_STARTTLS 4
226 #define CMD_LIST_TLS_AUTH 5
228 /* This list of names is used for performing the smtp_no_mail logging action.
229 It must be kept in step with the SCH_xxx enumerations. */
231 uschar * smtp_names[] =
233 US"NONE", US"AUTH", US"DATA", US"BDAT", US"EHLO", US"ETRN", US"EXPN",
234 US"HELO", US"HELP", US"MAIL", US"NOOP", US"QUIT", US"RCPT", US"RSET",
235 US"STARTTLS", US"VRFY" };
237 static uschar *protocols_local[] = {
238 US"local-smtp", /* HELO */
239 US"local-smtps", /* The rare case EHLO->STARTTLS->HELO */
240 US"local-esmtp", /* EHLO */
241 US"local-esmtps", /* EHLO->STARTTLS->EHLO */
242 US"local-esmtpa", /* EHLO->AUTH */
243 US"local-esmtpsa" /* EHLO->STARTTLS->EHLO->AUTH */
245 static uschar *protocols[] = {
247 US"smtps", /* The rare case EHLO->STARTTLS->HELO */
248 US"esmtp", /* EHLO */
249 US"esmtps", /* EHLO->STARTTLS->EHLO */
250 US"esmtpa", /* EHLO->AUTH */
251 US"esmtpsa" /* EHLO->STARTTLS->EHLO->AUTH */
256 #define pcrpted 1 /* added to pextend or pnormal */
257 #define pauthed 2 /* added to pextend */
259 /* Sanity check and validate optional args to MAIL FROM: envelope */
262 ENV_MAIL_OPT_SIZE, ENV_MAIL_OPT_BODY, ENV_MAIL_OPT_AUTH,
266 ENV_MAIL_OPT_RET, ENV_MAIL_OPT_ENVID,
272 uschar * name; /* option requested during MAIL cmd */
273 int value; /* enum type */
274 BOOL need_value; /* TRUE requires value (name=value pair format)
275 FALSE is a singleton */
277 static env_mail_type_t env_mail_type_list[] = {
278 { US"SIZE", ENV_MAIL_OPT_SIZE, TRUE },
279 { US"BODY", ENV_MAIL_OPT_BODY, TRUE },
280 { US"AUTH", ENV_MAIL_OPT_AUTH, TRUE },
282 { US"PRDR", ENV_MAIL_OPT_PRDR, FALSE },
284 { US"RET", ENV_MAIL_OPT_RET, TRUE },
285 { US"ENVID", ENV_MAIL_OPT_ENVID, TRUE },
287 { US"SMTPUTF8",ENV_MAIL_OPT_UTF8, FALSE }, /* rfc6531 */
289 /* keep this the last entry */
290 { US"NULL", ENV_MAIL_OPT_NULL, FALSE },
293 /* When reading SMTP from a remote host, we have to use our own versions of the
294 C input-reading functions, in order to be able to flush the SMTP output only
295 when about to read more data from the socket. This is the only way to get
296 optimal performance when the client is using pipelining. Flushing for every
297 command causes a separate packet and reply packet each time; saving all the
298 responses up (when pipelining) combines them into one packet and one response.
300 For simplicity, these functions are used for *all* SMTP input, not only when
301 receiving over a socket. However, after setting up a secure socket (SSL), input
302 is read via the OpenSSL library, and another set of functions is used instead
305 These functions are set in the receive_getc etc. variables and called with the
306 same interface as the C functions. However, since there can only ever be
307 one incoming SMTP call, we just use a single buffer and flags. There is no need
308 to implement a complicated private FILE-like structure.*/
310 static uschar *smtp_inbuffer;
311 static uschar *smtp_inptr;
312 static uschar *smtp_inend;
313 static int smtp_had_eof;
314 static int smtp_had_error;
317 /* forward declarations */
318 static int smtp_read_command(BOOL check_sync, unsigned buffer_lim);
319 static int synprot_error(int type, int code, uschar *data, uschar *errmess);
320 static void smtp_quit_handler(uschar **, uschar **);
321 static void smtp_rset_handler(void);
323 /*************************************************
324 * Log incomplete transactions *
325 *************************************************/
327 /* This function is called after a transaction has been aborted by RSET, QUIT,
328 connection drops or other errors. It logs the envelope information received
329 so far in order to preserve address verification attempts.
331 Argument: string to indicate what aborted the transaction
336 incomplete_transaction_log(uschar *what)
338 if (!sender_address /* No transaction in progress */
339 || !LOGGING(smtp_incomplete_transaction))
342 /* Build list of recipients for logging */
344 if (recipients_count > 0)
346 raw_recipients = store_get(recipients_count * sizeof(uschar *), GET_UNTAINTED);
347 for (int i = 0; i < recipients_count; i++)
348 raw_recipients[i] = recipients_list[i].address;
349 raw_recipients_count = recipients_count;
352 log_write(L_smtp_incomplete_transaction, LOG_MAIN|LOG_SENDER|LOG_RECIPIENTS,
353 "%s incomplete transaction (%s)", host_and_ident(TRUE), what);
360 smtp_command_timeout_exit(void)
362 log_write(L_lost_incoming_connection,
363 LOG_MAIN, "SMTP command timeout on%s connection from %s",
364 tls_in.active.sock >= 0 ? " TLS" : "", host_and_ident(FALSE));
365 if (smtp_batched_input)
366 moan_smtp_batch(NULL, "421 SMTP command timeout"); /* Does not return */
367 smtp_notquit_exit(US"command-timeout", US"421",
368 US"%s: SMTP command timeout - closing connection",
369 smtp_active_hostname);
370 exim_exit(EXIT_FAILURE);
374 smtp_command_sigterm_exit(void)
376 log_write(0, LOG_MAIN, "%s closed after SIGTERM", smtp_get_connection_info());
377 if (smtp_batched_input)
378 moan_smtp_batch(NULL, "421 SIGTERM received"); /* Does not return */
379 smtp_notquit_exit(US"signal-exit", US"421",
380 US"%s: Service not available - closing connection", smtp_active_hostname);
381 exim_exit(EXIT_FAILURE);
385 smtp_data_timeout_exit(void)
387 log_write(L_lost_incoming_connection,
388 LOG_MAIN, "SMTP data timeout (message abandoned) on connection from %s F=<%s>",
389 sender_fullhost ? sender_fullhost : US"local process", sender_address);
390 receive_bomb_out(US"data-timeout", US"SMTP incoming data timeout");
391 /* Does not return */
395 smtp_data_sigint_exit(void)
397 log_write(0, LOG_MAIN, "%s closed after %s",
398 smtp_get_connection_info(), had_data_sigint == SIGTERM ? "SIGTERM":"SIGINT");
399 receive_bomb_out(US"signal-exit",
400 US"Service not available - SIGTERM or SIGINT received");
401 /* Does not return */
405 /******************************************************************************/
406 /* SMTP input buffer handling. Most of these are similar to stdio routines. */
411 /* Set up the buffer for inputting using direct read() calls, and arrange to
412 call the local functions instead of the standard C ones. Place a NUL at the
413 end of the buffer to safety-stop C-string reads from it. */
415 if (!(smtp_inbuffer = US malloc(IN_BUFFER_SIZE)))
416 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "malloc() failed for SMTP input buffer");
417 smtp_inbuffer[IN_BUFFER_SIZE-1] = '\0';
419 smtp_inptr = smtp_inend = smtp_inbuffer;
420 smtp_had_eof = smtp_had_error = 0;
425 /* Refill the buffer, and notify DKIM verification code.
426 Return false for error or EOF.
430 smtp_refill(unsigned lim)
434 if (!smtp_out) return FALSE;
436 if (smtp_receive_timeout > 0) ALARM(smtp_receive_timeout);
438 /* Limit amount read, so non-message data is not fed to DKIM.
439 Take care to not touch the safety NUL at the end of the buffer. */
441 rc = read(fileno(smtp_in), smtp_inbuffer, MIN(IN_BUFFER_SIZE-1, lim));
443 if (smtp_receive_timeout > 0) ALARM_CLR(0);
446 /* Must put the error text in fixed store, because this might be during
447 header reading, where it releases unused store above the header. */
450 if (had_command_timeout) /* set by signal handler */
451 smtp_command_timeout_exit(); /* does not return */
452 if (had_command_sigterm)
453 smtp_command_sigterm_exit();
454 if (had_data_timeout)
455 smtp_data_timeout_exit();
457 smtp_data_sigint_exit();
459 smtp_had_error = save_errno;
460 smtp_read_error = string_copy_perm(
461 string_sprintf(" (error: %s)", strerror(save_errno)), FALSE);
468 dkim_exim_verify_feed(smtp_inbuffer, rc);
470 smtp_inend = smtp_inbuffer + rc;
471 smtp_inptr = smtp_inbuffer;
476 /* Check if there is buffered data */
481 return smtp_inptr < smtp_inend;
484 /* SMTP version of getc()
486 This gets the next byte from the SMTP input buffer. If the buffer is empty,
487 it flushes the output, and refills the buffer, with a timeout. The signal
488 handler is set appropriately by the calling function. This function is not used
489 after a connection has negotiated itself into an TLS/SSL state.
491 Arguments: lim Maximum amount to read/buffer
492 Returns: the next character or EOF
496 smtp_getc(unsigned lim)
498 if (!smtp_hasc() && !smtp_refill(lim)) return EOF;
499 return *smtp_inptr++;
502 /* Get many bytes, refilling buffer if needed */
505 smtp_getbuf(unsigned * len)
510 if (!smtp_hasc() && !smtp_refill(*len))
511 { *len = 0; return NULL; }
513 if ((size = smtp_inend - smtp_inptr) > *len) size = *len;
520 /* Copy buffered data to the dkim feed.
521 Called, unless TLS, just before starting to read message headers. */
524 smtp_get_cache(unsigned lim)
527 int n = smtp_inend - smtp_inptr;
531 dkim_exim_verify_feed(smtp_inptr, n);
536 /* SMTP version of ungetc()
537 Puts a character back in the input buffer. Only ever called once.
542 Returns: the character
548 if (smtp_inptr <= smtp_inbuffer) /* NB: NOT smtp_hasc() ! */
549 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "buffer underflow in smtp_ungetc");
556 /* SMTP version of feof()
557 Tests for a previous EOF
560 Returns: non-zero if the eof flag is set
570 /* SMTP version of ferror()
571 Tests for a previous read error, and returns with errno
572 restored to what it was when the error was detected.
575 Returns: non-zero if the error flag is set
581 errno = smtp_had_error;
582 return smtp_had_error;
586 /* Check if a getc will block or not */
589 smtp_could_getc(void)
593 struct timeval tzero = {.tv_sec = 0, .tv_usec = 0};
595 if (smtp_inptr < smtp_inend)
598 fd = fileno(smtp_in);
601 rc = select(fd + 1, (SELECT_ARG2_TYPE *)&fds, NULL, NULL, &tzero);
603 if (rc <= 0) return FALSE; /* Not ready to read */
604 rc = smtp_getc(GETC_BUFFER_UNLIMITED);
605 if (rc < 0) return FALSE; /* End of file or error */
612 /******************************************************************************/
613 /*************************************************
614 * Recheck synchronization *
615 *************************************************/
617 /* Synchronization checks can never be perfect because a packet may be on its
618 way but not arrived when the check is done. Normally, the checks happen when
619 commands are read: Exim ensures that there is no more input in the input buffer.
620 In normal cases, the response to the command will be fast, and there is no
623 However, for some commands an ACL is run, and that can include delays. In those
624 cases, it is useful to do another check on the input just before sending the
625 response. This also applies at the start of a connection. This function does
626 that check by means of the select() function, as long as the facility is not
627 disabled or inappropriate. A failure of select() is ignored.
629 When there is unwanted input, we read it so that it appears in the log of the
633 Returns: TRUE if all is well; FALSE if there is input pending
637 wouldblock_reading(void)
640 if (tls_in.active.sock >= 0)
641 return !tls_could_getc();
644 return !smtp_could_getc();
650 if (!smtp_enforce_sync || !sender_host_address || f.sender_host_notsocket)
653 return wouldblock_reading();
657 /******************************************************************************/
658 /* Variants of the smtp_* input handling functions for use in CHUNKING mode */
660 /* Forward declarations */
661 static inline void bdat_push_receive_functions(void);
662 static inline void bdat_pop_receive_functions(void);
665 /* Get a byte from the smtp input, in CHUNKING mode. Handle ack of the
666 previous BDAT chunk and getting new ones when we run out. Uses the
667 underlying smtp_getc or tls_getc both for that and for getting the
668 (buffered) data byte. EOD signals (an expected) no further data.
669 ERR signals a protocol error, and EOF a closed input stream.
671 Called from read_bdat_smtp() in receive.c for the message body, but also
672 by the headers read loop in receive_msg(); manipulates chunking_state
673 to handle the BDAT command/response.
674 Placed here due to the correlation with the above smtp_getc(), which it wraps,
675 and also by the need to do smtp command/response handling.
677 Arguments: lim (ignored)
678 Returns: the next character or ERR, EOD or EOF
682 bdat_getc(unsigned lim)
684 uschar * user_msg = NULL;
693 if (chunking_data_left > 0)
694 return lwr_receive_getc(chunking_data_left--);
696 bdat_pop_receive_functions();
698 dkim_save = dkim_collect_input;
699 dkim_collect_input = 0;
702 /* Unless PIPELINING was offered, there should be no next command
703 until after we ack that chunk */
705 if (!f.smtp_in_pipelining_advertised && !check_sync())
707 unsigned n = smtp_inend - smtp_inptr;
710 incomplete_transaction_log(US"sync failure");
711 log_write(0, LOG_MAIN|LOG_REJECT, "SMTP protocol synchronization error "
712 "(next input sent too soon: pipelining was not advertised): "
713 "rejected \"%s\" %s next input=\"%s\"%s",
714 smtp_cmd_buffer, host_and_ident(TRUE),
715 string_printing(string_copyn(smtp_inptr, n)),
716 smtp_inend - smtp_inptr > n ? "..." : "");
717 (void) synprot_error(L_smtp_protocol_error, 554, NULL,
718 US"SMTP synchronization error");
719 goto repeat_until_rset;
722 /* If not the last, ack the received chunk. The last response is delayed
723 until after the data ACL decides on it */
725 if (chunking_state == CHUNKING_LAST)
728 dkim_collect_input = dkim_save;
729 dkim_exim_verify_feed(NULL, 0); /* notify EOD */
730 dkim_collect_input = 0;
735 smtp_printf("250 %u byte chunk received\r\n", FALSE, chunking_datasize);
736 chunking_state = CHUNKING_OFFERED;
737 DEBUG(D_receive) debug_printf("chunking state %d\n", (int)chunking_state);
739 /* Expect another BDAT cmd from input. RFC 3030 says nothing about
740 QUIT, RSET or NOOP but handling them seems obvious */
743 switch(smtp_read_command(TRUE, 1))
746 (void) synprot_error(L_smtp_protocol_error, 503, NULL,
747 US"only BDAT permissible after non-LAST BDAT");
750 switch(smtp_read_command(TRUE, 1))
752 case QUIT_CMD: smtp_quit_handler(&user_msg, &log_msg); /*FALLTHROUGH */
753 case EOF_CMD: return EOF;
754 case RSET_CMD: smtp_rset_handler(); return ERR;
755 default: if (synprot_error(L_smtp_protocol_error, 503, NULL,
756 US"only RSET accepted now") > 0)
758 goto repeat_until_rset;
762 smtp_quit_handler(&user_msg, &log_msg);
773 smtp_printf("250 OK\r\n", FALSE);
780 if (sscanf(CS smtp_cmd_data, "%u %n", &chunking_datasize, &n) < 1)
782 (void) synprot_error(L_smtp_protocol_error, 501, NULL,
783 US"missing size for BDAT command");
786 chunking_state = strcmpic(smtp_cmd_data+n, US"LAST") == 0
787 ? CHUNKING_LAST : CHUNKING_ACTIVE;
788 chunking_data_left = chunking_datasize;
789 DEBUG(D_receive) debug_printf("chunking state %d, %d bytes\n",
790 (int)chunking_state, chunking_data_left);
792 if (chunking_datasize == 0)
793 if (chunking_state == CHUNKING_LAST)
797 (void) synprot_error(L_smtp_protocol_error, 504, NULL,
798 US"zero size for BDAT command");
799 goto repeat_until_rset;
802 bdat_push_receive_functions();
804 dkim_collect_input = dkim_save;
806 break; /* to top of main loop */
815 if (chunking_data_left > 0)
816 return lwr_receive_hasc();
821 bdat_getbuf(unsigned * len)
825 if (chunking_data_left <= 0)
826 { *len = 0; return NULL; }
828 if (*len > chunking_data_left) *len = chunking_data_left;
829 buf = lwr_receive_getbuf(len); /* Either smtp_getbuf or tls_getbuf */
830 chunking_data_left -= *len;
835 bdat_flush_data(void)
837 while (chunking_data_left)
839 unsigned n = chunking_data_left;
840 if (!bdat_getbuf(&n)) break;
843 bdat_pop_receive_functions();
844 chunking_state = CHUNKING_OFFERED;
845 DEBUG(D_receive) debug_printf("chunking state %d\n", (int)chunking_state);
850 bdat_push_receive_functions(void)
852 /* push the current receive_* function on the "stack", and
853 replace them by bdat_getc(), which in turn will use the lwr_receive_*
854 functions to do the dirty work. */
855 if (!lwr_receive_getc)
857 lwr_receive_getc = receive_getc;
858 lwr_receive_getbuf = receive_getbuf;
859 lwr_receive_hasc = receive_hasc;
860 lwr_receive_ungetc = receive_ungetc;
864 DEBUG(D_receive) debug_printf("chunking double-push receive functions\n");
867 receive_getc = bdat_getc;
868 receive_getbuf = bdat_getbuf;
869 receive_hasc = bdat_hasc;
870 receive_ungetc = bdat_ungetc;
874 bdat_pop_receive_functions(void)
876 if (!lwr_receive_getc)
878 DEBUG(D_receive) debug_printf("chunking double-pop receive functions\n");
881 receive_getc = lwr_receive_getc;
882 receive_getbuf = lwr_receive_getbuf;
883 receive_hasc = lwr_receive_hasc;
884 receive_ungetc = lwr_receive_ungetc;
886 lwr_receive_getc = NULL;
887 lwr_receive_getbuf = NULL;
888 lwr_receive_hasc = NULL;
889 lwr_receive_ungetc = NULL;
895 chunking_data_left++;
896 bdat_push_receive_functions(); /* we're not done yet, calling push is safe, because it checks the state before pushing anything */
897 return lwr_receive_ungetc(ch);
902 /******************************************************************************/
904 /*************************************************
905 * Write formatted string to SMTP channel *
906 *************************************************/
908 /* This is a separate function so that we don't have to repeat everything for
909 TLS support or debugging. It is global so that the daemon and the
910 authentication functions can use it. It does not return any error indication,
911 because major problems such as dropped connections won't show up till an output
912 flush for non-TLS connections. The smtp_fflush() function is available for
913 checking that: for convenience, TLS output errors are remembered here so that
914 they are also picked up later by smtp_fflush().
916 This function is exposed to the local_scan API; do not change the signature.
920 more further data expected
921 ... optional arguments
927 smtp_printf(const char *format, BOOL more, ...)
932 smtp_vprintf(format, more, ap);
936 /* This is split off so that verify.c:respond_printf() can, in effect, call
937 smtp_printf(), bearing in mind that in C a vararg function can't directly
938 call another vararg function, only a function which accepts a va_list.
940 This function is exposed to the local_scan API; do not change the signature.
942 /*XXX consider passing caller-info in, for string_vformat-onward */
945 smtp_vprintf(const char *format, BOOL more, va_list ap)
947 gstring gs = { .size = big_buffer_size, .ptr = 0, .s = big_buffer };
950 /* Use taint-unchecked routines for writing into big_buffer, trusting
951 that we'll never expand it. */
953 yield = !! string_vformat(&gs, SVFMT_TAINT_NOCHK, format, ap);
954 string_from_gstring(&gs);
956 DEBUG(D_receive) for (const uschar * t, * s = gs.s;
957 s && (t = Ustrchr(s, '\r'));
958 s = t + 2) /* \r\n */
959 debug_printf("%s %.*s\n",
960 s == gs.s ? "SMTP>>" : " ",
965 log_write(0, LOG_MAIN|LOG_PANIC, "string too large in smtp_printf()");
966 smtp_closedown(US"Unexpected error");
967 exim_exit(EXIT_FAILURE);
970 /* If this is the first output for a (non-batch) RCPT command, see if all RCPTs
971 have had the same. Note: this code is also present in smtp_respond(). It would
972 be tidier to have it only in one place, but when it was added, it was easier to
973 do it that way, so as not to have to mess with the code for the RCPT command,
974 which sometimes uses smtp_printf() and sometimes smtp_respond(). */
976 if (fl.rcpt_in_progress)
978 if (!rcpt_smtp_response)
979 rcpt_smtp_response = string_copy(big_buffer);
980 else if (fl.rcpt_smtp_response_same &&
981 Ustrcmp(rcpt_smtp_response, big_buffer) != 0)
982 fl.rcpt_smtp_response_same = FALSE;
983 fl.rcpt_in_progress = FALSE;
986 /* Now write the string */
990 tls_in.active.sock >= 0 ? (tls_write(NULL, gs.s, gs.ptr, more) < 0) :
992 (fwrite(gs.s, gs.ptr, 1, smtp_out) == 0)
994 smtp_write_error = -1;
999 /*************************************************
1000 * Flush SMTP out and check for error *
1001 *************************************************/
1003 /* This function isn't currently used within Exim (it detects errors when it
1004 tries to read the next SMTP input), but is available for use in local_scan().
1005 It flushes the output and checks for errors.
1008 Returns: 0 for no error; -1 after an error
1014 if (tls_in.active.sock < 0 && fflush(smtp_out) != 0) smtp_write_error = -1;
1018 tls_in.active.sock >= 0 ? (tls_write(NULL, NULL, 0, FALSE) < 0) :
1020 (fflush(smtp_out) != 0)
1022 smtp_write_error = -1;
1024 return smtp_write_error;
1029 /* If there's input waiting (and we're doing pipelineing) then we can pipeline
1030 a reponse with the one following. */
1033 pipeline_response(void)
1035 if ( !smtp_enforce_sync || !sender_host_address
1036 || f.sender_host_notsocket || !f.smtp_in_pipelining_advertised)
1039 if (wouldblock_reading()) return FALSE;
1040 f.smtp_in_pipelining_used = TRUE;
1045 #ifndef DISABLE_PIPE_CONNECT
1047 pipeline_connect_sends(void)
1049 if (!sender_host_address || f.sender_host_notsocket || !fl.pipe_connect_acceptable)
1052 if (wouldblock_reading()) return FALSE;
1053 f.smtp_in_early_pipe_used = TRUE;
1058 /*************************************************
1059 * SMTP command read timeout *
1060 *************************************************/
1062 /* Signal handler for timing out incoming SMTP commands. This attempts to
1065 Argument: signal number (SIGALRM)
1070 command_timeout_handler(int sig)
1072 had_command_timeout = sig;
1077 /*************************************************
1078 * SIGTERM received *
1079 *************************************************/
1081 /* Signal handler for handling SIGTERM. Again, try to finish tidily.
1083 Argument: signal number (SIGTERM)
1088 command_sigterm_handler(int sig)
1090 had_command_sigterm = sig;
1096 #ifdef SUPPORT_PROXY
1097 /*************************************************
1098 * Check if host is required proxy host *
1099 *************************************************/
1100 /* The function determines if inbound host will be a regular smtp host
1101 or if it is configured that it must use Proxy Protocol. A local
1109 check_proxy_protocol_host()
1113 if ( sender_host_address
1114 && (rc = verify_check_this_host(CUSS &hosts_proxy, NULL, NULL,
1115 sender_host_address, NULL)) == OK)
1118 debug_printf("Detected proxy protocol configured host\n");
1119 proxy_session = TRUE;
1121 return proxy_session;
1125 /*************************************************
1126 * Read data until newline or end of buffer *
1127 *************************************************/
1128 /* While SMTP is server-speaks-first, TLS is client-speaks-first, so we can't
1129 read an entire buffer and assume there will be nothing past a proxy protocol
1130 header. Our approach normally is to use stdio, but again that relies upon
1131 "STARTTLS\r\n" and a server response before the client starts TLS handshake, or
1132 reading _nothing_ before client TLS handshake. So we don't want to use the
1133 usual buffering reads which may read enough to block TLS starting.
1135 So unfortunately we're down to "read one byte at a time, with a syscall each,
1136 and expect a little overhead", for all proxy-opened connections which are v1,
1137 just to handle the TLS-on-connect case. Since SSL functions wrap the
1138 underlying fd, we can't assume that we can feed them any already-read content.
1140 We need to know where to read to, the max capacity, and we'll read until we
1141 get a CR and one more character. Let the caller scream if it's CR+!LF.
1143 Return the amount read.
1147 swallow_until_crlf(int fd, uschar *base, int already, int capacity)
1149 uschar *to = base + already;
1155 /* For "PROXY UNKNOWN\r\n" we, at time of writing, expect to have read
1156 up through the \r; for the _normal_ case, we haven't yet seen the \r. */
1158 cr = memchr(base, '\r', already);
1161 if ((cr - base) < already - 1)
1163 /* \r and presumed \n already within what we have; probably not
1164 actually proxy protocol, but abort cleanly. */
1167 /* \r is last character read, just need one more. */
1171 while (capacity > 0)
1173 do { ret = read(fd, to, 1); } while (ret == -1 && errno == EINTR && !had_command_timeout);
1185 /* reached end without having room for a final newline, abort */
1190 /*************************************************
1191 * Setup host for proxy protocol *
1192 *************************************************/
1193 /* The function configures the connection based on a header from the
1194 inbound host to use Proxy Protocol. The specification is very exact
1195 so exit with an error if do not find the exact required pieces. This
1196 includes an incorrect number of spaces separating args.
1199 Returns: Boolean success
1203 setup_proxy_protocol_host()
1215 struct { /* TCP/UDP over IPv4, len = 12 */
1221 struct { /* TCP/UDP over IPv6, len = 36 */
1222 uint8_t src_addr[16];
1223 uint8_t dst_addr[16];
1227 struct { /* AF_UNIX sockets, len = 216 */
1228 uschar src_addr[108];
1229 uschar dst_addr[108];
1235 /* Temp variables used in PPv2 address:port parsing */
1237 char tmpip[INET_ADDRSTRLEN];
1238 struct sockaddr_in tmpaddr;
1239 char tmpip6[INET6_ADDRSTRLEN];
1240 struct sockaddr_in6 tmpaddr6;
1242 /* We can't read "all data until end" because while SMTP is
1243 server-speaks-first, the TLS handshake is client-speaks-first, so for
1244 TLS-on-connect ports the proxy protocol header will usually be immediately
1245 followed by a TLS handshake, and with N TLS libraries, we can't reliably
1246 reinject data for reading by those. So instead we first read "enough to be
1247 safely read within the header, and figure out how much more to read".
1248 For v1 we will later read to the end-of-line, for v2 we will read based upon
1251 The v2 sig is 12 octets, and another 4 gets us the length, so we know how much
1252 data is needed total. For v1, where the line looks like:
1253 PROXY TCPn L3src L3dest SrcPort DestPort \r\n
1255 However, for v1 there's also `PROXY UNKNOWN\r\n` which is only 15 octets.
1256 We seem to support that. So, if we read 14 octets then we can tell if we're
1257 v2 or v1. If we're v1, we can continue reading as normal.
1259 If we're v2, we can't slurp up the entire header. We need the length in the
1260 15th & 16th octets, then to read everything after that.
1262 So to safely handle v1 and v2, with client-sent-first supported correctly,
1263 we have to do a minimum of 3 read calls, not 1. Eww.
1266 #define PROXY_INITIAL_READ 14
1267 #define PROXY_V2_HEADER_SIZE 16
1268 #if PROXY_INITIAL_READ > PROXY_V2_HEADER_SIZE
1269 # error Code bug in sizes of data to read for proxy usage
1274 int fd = fileno(smtp_in);
1275 const char v2sig[12] = "\x0D\x0A\x0D\x0A\x00\x0D\x0A\x51\x55\x49\x54\x0A";
1276 uschar * iptype; /* To display debug info */
1277 socklen_t vslen = sizeof(struct timeval);
1280 os_non_restarting_signal(SIGALRM, command_timeout_handler);
1281 ALARM(proxy_protocol_timeout);
1285 /* The inbound host was declared to be a Proxy Protocol host, so
1286 don't do a PEEK into the data, actually slurp up enough to be
1287 "safe". Can't take it all because TLS-on-connect clients follow
1288 immediately with TLS handshake. */
1289 ret = read(fd, &hdr, PROXY_INITIAL_READ);
1291 while (ret == -1 && errno == EINTR && !had_command_timeout);
1296 /* For v2, handle reading the length, and then the rest. */
1297 if ((ret == PROXY_INITIAL_READ) && (memcmp(&hdr.v2, v2sig, sizeof(v2sig)) == 0))
1302 /* First get the length fields. */
1305 retmore = read(fd, (uschar*)&hdr + ret, PROXY_V2_HEADER_SIZE - PROXY_INITIAL_READ);
1306 } while (retmore == -1 && errno == EINTR && !had_command_timeout);
1311 ver = (hdr.v2.ver_cmd & 0xf0) >> 4;
1313 /* May 2014: haproxy combined the version and command into one byte to
1314 allow two full bytes for the length field in order to proxy SSL
1315 connections. SSL Proxy is not supported in this version of Exim, but
1316 must still separate values here. */
1320 DEBUG(D_receive) debug_printf("Invalid Proxy Protocol version: %d\n", ver);
1324 /* The v2 header will always be 16 bytes per the spec. */
1325 size = 16 + ntohs(hdr.v2.len);
1326 DEBUG(D_receive) debug_printf("Detected PROXYv2 header, size %d (limit %d)\n",
1327 size, (int)sizeof(hdr));
1329 /* We should now have 16 octets (PROXY_V2_HEADER_SIZE), and we know the total
1330 amount that we need. Double-check that the size is not unreasonable, then
1332 if (size > sizeof(hdr))
1334 DEBUG(D_receive) debug_printf("PROXYv2 header size unreasonably large; security attack?\n");
1342 retmore = read(fd, (uschar*)&hdr + ret, size-ret);
1343 } while (retmore == -1 && errno == EINTR && !had_command_timeout);
1347 DEBUG(D_receive) debug_printf("PROXYv2: have %d/%d required octets\n", ret, size);
1348 } while (ret < size);
1350 } /* end scope for getting rest of data for v2 */
1352 /* At this point: if PROXYv2, we've read the exact size required for all data;
1353 if PROXYv1 then we've read "less than required for any valid line" and should
1356 if (ret >= 16 && memcmp(&hdr.v2, v2sig, 12) == 0)
1358 uint8_t cmd = (hdr.v2.ver_cmd & 0x0f);
1362 case 0x01: /* PROXY command */
1365 case 0x11: /* TCPv4 address type */
1367 tmpaddr.sin_addr.s_addr = hdr.v2.addr.ip4.src_addr;
1368 inet_ntop(AF_INET, &tmpaddr.sin_addr, CS &tmpip, sizeof(tmpip));
1369 if (!string_is_ip_address(US tmpip, NULL))
1371 DEBUG(D_receive) debug_printf("Invalid %s source IP\n", iptype);
1374 proxy_local_address = sender_host_address;
1375 sender_host_address = string_copy(US tmpip);
1376 tmpport = ntohs(hdr.v2.addr.ip4.src_port);
1377 proxy_local_port = sender_host_port;
1378 sender_host_port = tmpport;
1379 /* Save dest ip/port */
1380 tmpaddr.sin_addr.s_addr = hdr.v2.addr.ip4.dst_addr;
1381 inet_ntop(AF_INET, &tmpaddr.sin_addr, CS &tmpip, sizeof(tmpip));
1382 if (!string_is_ip_address(US tmpip, NULL))
1384 DEBUG(D_receive) debug_printf("Invalid %s dest port\n", iptype);
1387 proxy_external_address = string_copy(US tmpip);
1388 tmpport = ntohs(hdr.v2.addr.ip4.dst_port);
1389 proxy_external_port = tmpport;
1391 case 0x21: /* TCPv6 address type */
1393 memmove(tmpaddr6.sin6_addr.s6_addr, hdr.v2.addr.ip6.src_addr, 16);
1394 inet_ntop(AF_INET6, &tmpaddr6.sin6_addr, CS &tmpip6, sizeof(tmpip6));
1395 if (!string_is_ip_address(US tmpip6, NULL))
1397 DEBUG(D_receive) debug_printf("Invalid %s source IP\n", iptype);
1400 proxy_local_address = sender_host_address;
1401 sender_host_address = string_copy(US tmpip6);
1402 tmpport = ntohs(hdr.v2.addr.ip6.src_port);
1403 proxy_local_port = sender_host_port;
1404 sender_host_port = tmpport;
1405 /* Save dest ip/port */
1406 memmove(tmpaddr6.sin6_addr.s6_addr, hdr.v2.addr.ip6.dst_addr, 16);
1407 inet_ntop(AF_INET6, &tmpaddr6.sin6_addr, CS &tmpip6, sizeof(tmpip6));
1408 if (!string_is_ip_address(US tmpip6, NULL))
1410 DEBUG(D_receive) debug_printf("Invalid %s dest port\n", iptype);
1413 proxy_external_address = string_copy(US tmpip6);
1414 tmpport = ntohs(hdr.v2.addr.ip6.dst_port);
1415 proxy_external_port = tmpport;
1419 debug_printf("Unsupported PROXYv2 connection type: 0x%02x\n",
1423 /* Unsupported protocol, keep local connection address */
1425 case 0x00: /* LOCAL command */
1426 /* Keep local connection address for LOCAL */
1431 debug_printf("Unsupported PROXYv2 command: 0x%x\n", cmd);
1435 else if (ret >= 8 && memcmp(hdr.v1.line, "PROXY", 5) == 0)
1439 uschar *sp; /* Utility variables follow */
1444 /* get the rest of the line */
1445 r2 = swallow_until_crlf(fd, (uschar*)&hdr, ret, sizeof(hdr)-ret);
1450 p = string_copy(hdr.v1.line);
1451 end = memchr(p, '\r', ret - 1);
1453 if (!end || (end == (uschar*)&hdr + ret) || end[1] != '\n')
1455 DEBUG(D_receive) debug_printf("Partial or invalid PROXY header\n");
1458 *end = '\0'; /* Terminate the string */
1459 size = end + 2 - p; /* Skip header + CRLF */
1460 DEBUG(D_receive) debug_printf("Detected PROXYv1 header\n");
1461 DEBUG(D_receive) debug_printf("Bytes read not within PROXY header: %d\n", ret - size);
1462 /* Step through the string looking for the required fields. Ensure
1463 strict adherence to required formatting, exit for any error. */
1465 if (!isspace(*(p++)))
1467 DEBUG(D_receive) debug_printf("Missing space after PROXY command\n");
1470 if (!Ustrncmp(p, CCS"TCP4", 4))
1472 else if (!Ustrncmp(p,CCS"TCP6", 4))
1474 else if (!Ustrncmp(p,CCS"UNKNOWN", 7))
1476 iptype = US"Unknown";
1481 DEBUG(D_receive) debug_printf("Invalid TCP type\n");
1485 p += Ustrlen(iptype);
1486 if (!isspace(*(p++)))
1488 DEBUG(D_receive) debug_printf("Missing space after TCP4/6 command\n");
1491 /* Find the end of the arg */
1492 if ((sp = Ustrchr(p, ' ')) == NULL)
1495 debug_printf("Did not find proxied src %s\n", iptype);
1499 if(!string_is_ip_address(p, NULL))
1502 debug_printf("Proxied src arg is not an %s address\n", iptype);
1505 proxy_local_address = sender_host_address;
1506 sender_host_address = p;
1508 if ((sp = Ustrchr(p, ' ')) == NULL)
1511 debug_printf("Did not find proxy dest %s\n", iptype);
1515 if(!string_is_ip_address(p, NULL))
1518 debug_printf("Proxy dest arg is not an %s address\n", iptype);
1521 proxy_external_address = p;
1523 if ((sp = Ustrchr(p, ' ')) == NULL)
1525 DEBUG(D_receive) debug_printf("Did not find proxied src port\n");
1529 tmp_port = strtol(CCS p, &endc, 10);
1530 if (*endc || tmp_port == 0)
1533 debug_printf("Proxied src port '%s' not an integer\n", p);
1536 proxy_local_port = sender_host_port;
1537 sender_host_port = tmp_port;
1539 if ((sp = Ustrchr(p, '\0')) == NULL)
1541 DEBUG(D_receive) debug_printf("Did not find proxy dest port\n");
1544 tmp_port = strtol(CCS p, &endc, 10);
1545 if (*endc || tmp_port == 0)
1548 debug_printf("Proxy dest port '%s' not an integer\n", p);
1551 proxy_external_port = tmp_port;
1552 /* Already checked for /r /n above. Good V1 header received. */
1556 /* Wrong protocol */
1557 DEBUG(D_receive) debug_printf("Invalid proxy protocol version negotiation\n");
1558 (void) swallow_until_crlf(fd, (uschar*)&hdr, ret, sizeof(hdr)-ret);
1564 debug_printf("Valid %s sender from Proxy Protocol header\n", iptype);
1565 yield = proxy_session;
1567 /* Don't flush any potential buffer contents. Any input on proxyfail
1568 should cause a synchronization failure */
1571 DEBUG(D_receive) if (had_command_timeout)
1572 debug_printf("Timeout while reading proxy header\n");
1577 sender_host_name = NULL;
1578 (void) host_name_lookup();
1579 host_build_sender_fullhost();
1583 f.proxy_session_failed = TRUE;
1585 debug_printf("Failure to extract proxied host, only QUIT allowed\n");
1593 /*************************************************
1594 * Read one command line *
1595 *************************************************/
1597 /* Strictly, SMTP commands coming over the net are supposed to end with CRLF.
1598 There are sites that don't do this, and in any case internal SMTP probably
1599 should check only for LF. Consequently, we check here for LF only. The line
1600 ends up with [CR]LF removed from its end. If we get an overlong line, treat as
1601 an unknown command. The command is read into the global smtp_cmd_buffer so that
1602 it is available via $smtp_command.
1604 The character reading routine sets up a timeout for each block actually read
1605 from the input (which may contain more than one command). We set up a special
1606 signal handler that closes down the session on a timeout. Control does not
1607 return when it runs.
1610 check_sync if TRUE, check synchronization rules if global option is TRUE
1611 buffer_lim maximum to buffer in lower layer
1613 Returns: a code identifying the command (enumerated above)
1617 smtp_read_command(BOOL check_sync, unsigned buffer_lim)
1621 BOOL hadnull = FALSE;
1623 had_command_timeout = 0;
1624 os_non_restarting_signal(SIGALRM, command_timeout_handler);
1626 while ((c = (receive_getc)(buffer_lim)) != '\n' && c != EOF)
1628 if (ptr >= SMTP_CMD_BUFFER_SIZE)
1630 os_non_restarting_signal(SIGALRM, sigalrm_handler);
1638 smtp_cmd_buffer[ptr++] = c;
1641 receive_linecount++; /* For BSMTP errors */
1642 os_non_restarting_signal(SIGALRM, sigalrm_handler);
1644 /* If hit end of file, return pseudo EOF command. Whether we have a
1645 part-line already read doesn't matter, since this is an error state. */
1647 if (c == EOF) return EOF_CMD;
1649 /* Remove any CR and white space at the end of the line, and terminate the
1652 while (ptr > 0 && isspace(smtp_cmd_buffer[ptr-1])) ptr--;
1653 smtp_cmd_buffer[ptr] = 0;
1655 DEBUG(D_receive) debug_printf("SMTP<< %s\n", smtp_cmd_buffer);
1657 /* NULLs are not allowed in SMTP commands */
1659 if (hadnull) return BADCHAR_CMD;
1661 /* Scan command list and return identity, having set the data pointer
1662 to the start of the actual data characters. Check for SMTP synchronization
1665 for (smtp_cmd_list * p = cmd_list; p < cmd_list_end; p++)
1667 #ifdef SUPPORT_PROXY
1668 /* Only allow QUIT command if Proxy Protocol parsing failed */
1669 if (proxy_session && f.proxy_session_failed && p->cmd != QUIT_CMD)
1673 && strncmpic(smtp_cmd_buffer, US p->name, p->len) == 0
1674 && ( smtp_cmd_buffer[p->len-1] == ':' /* "mail from:" or "rcpt to:" */
1675 || smtp_cmd_buffer[p->len] == 0
1676 || smtp_cmd_buffer[p->len] == ' '
1679 if ( smtp_inptr < smtp_inend /* Outstanding input */
1680 && p->cmd < sync_cmd_limit /* Command should sync */
1681 && check_sync /* Local flag set */
1682 && smtp_enforce_sync /* Global flag set */
1683 && sender_host_address != NULL /* Not local input */
1684 && !f.sender_host_notsocket /* Really is a socket */
1688 /* The variables $smtp_command and $smtp_command_argument point into the
1689 unmodified input buffer. A copy of the latter is taken for actual
1690 processing, so that it can be chopped up into separate parts if necessary,
1691 for example, when processing a MAIL command options such as SIZE that can
1692 follow the sender address. */
1694 smtp_cmd_argument = smtp_cmd_buffer + p->len;
1695 while (isspace(*smtp_cmd_argument)) smtp_cmd_argument++;
1696 Ustrcpy(smtp_data_buffer, smtp_cmd_argument);
1697 smtp_cmd_data = smtp_data_buffer;
1699 /* Count non-mail commands from those hosts that are controlled in this
1700 way. The default is all hosts. We don't waste effort checking the list
1701 until we get a non-mail command, but then cache the result to save checking
1702 again. If there's a DEFER while checking the host, assume it's in the list.
1704 Note that one instance of RSET, EHLO/HELO, and STARTTLS is allowed at the
1705 start of each incoming message by fiddling with the value in the table. */
1707 if (!p->is_mail_cmd)
1709 if (count_nonmail == TRUE_UNSET) count_nonmail =
1710 verify_check_host(&smtp_accept_max_nonmail_hosts) != FAIL;
1711 if (count_nonmail && ++nonmail_command_count > smtp_accept_max_nonmail)
1712 return TOO_MANY_NONMAIL_CMD;
1715 /* If there is data for a command that does not expect it, generate the
1718 return (p->has_arg || *smtp_cmd_data == 0)? p->cmd : BADARG_CMD;
1722 #ifdef SUPPORT_PROXY
1723 /* Only allow QUIT command if Proxy Protocol parsing failed */
1724 if (proxy_session && f.proxy_session_failed)
1725 return PROXY_FAIL_IGNORE_CMD;
1728 /* Enforce synchronization for unknown commands */
1730 if ( smtp_inptr < smtp_inend /* Outstanding input */
1731 && check_sync /* Local flag set */
1732 && smtp_enforce_sync /* Global flag set */
1733 && sender_host_address /* Not local input */
1734 && !f.sender_host_notsocket /* Really is a socket */
1743 /*************************************************
1744 * Forced closedown of call *
1745 *************************************************/
1747 /* This function is called from log.c when Exim is dying because of a serious
1748 disaster, and also from some other places. If an incoming non-batched SMTP
1749 channel is open, it swallows the rest of the incoming message if in the DATA
1750 phase, sends the reply string, and gives an error to all subsequent commands
1751 except QUIT. The existence of an SMTP call is detected by the non-NULLness of
1755 message SMTP reply string to send, excluding the code
1761 smtp_closedown(uschar * message)
1763 if (!smtp_in || smtp_batched_input) return;
1764 receive_swallow_smtp();
1765 smtp_printf("421 %s\r\n", FALSE, message);
1767 for (;;) switch(smtp_read_command(FALSE, GETC_BUFFER_UNLIMITED))
1773 f.smtp_in_quit = TRUE;
1774 smtp_printf("221 %s closing connection\r\n", FALSE, smtp_active_hostname);
1779 smtp_printf("250 Reset OK\r\n", FALSE);
1783 smtp_printf("421 %s\r\n", FALSE, message);
1791 /*************************************************
1792 * Set up connection info for logging *
1793 *************************************************/
1795 /* This function is called when logging information about an SMTP connection.
1796 It sets up appropriate source information, depending on the type of connection.
1797 If sender_fullhost is NULL, we are at a very early stage of the connection;
1798 just use the IP address.
1801 Returns: a string describing the connection
1805 smtp_get_connection_info(void)
1807 const uschar * hostname = sender_fullhost
1808 ? sender_fullhost : sender_host_address;
1811 return string_sprintf("SMTP connection from %s", hostname);
1813 if (f.sender_host_unknown || f.sender_host_notsocket)
1814 return string_sprintf("SMTP connection from %s", sender_ident);
1817 return string_sprintf("SMTP connection from %s (via inetd)", hostname);
1819 if (LOGGING(incoming_interface) && interface_address)
1820 return string_sprintf("SMTP connection from %s I=[%s]:%d", hostname,
1821 interface_address, interface_port);
1823 return string_sprintf("SMTP connection from %s", hostname);
1829 /* Append TLS-related information to a log line
1832 g String under construction: allocated string to extend, or NULL
1834 Returns: Allocated string or NULL
1837 s_tlslog(gstring * g)
1839 if (LOGGING(tls_cipher) && tls_in.cipher)
1841 g = string_append(g, 2, US" X=", tls_in.cipher);
1842 #ifndef DISABLE_TLS_RESUME
1843 if (LOGGING(tls_resumption) && tls_in.resumption & RESUME_USED)
1844 g = string_catn(g, US"*", 1);
1847 if (LOGGING(tls_certificate_verified) && tls_in.cipher)
1848 g = string_append(g, 2, US" CV=", tls_in.certificate_verified? "yes":"no");
1849 if (LOGGING(tls_peerdn) && tls_in.peerdn)
1850 g = string_append(g, 3, US" DN=\"", string_printing(tls_in.peerdn), US"\"");
1851 if (LOGGING(tls_sni) && tls_in.sni)
1852 g = string_append(g, 2, US" SNI=", string_printing2(tls_in.sni, SP_TAB|SP_SPACE));
1860 s_connhad_log(gstring * g)
1862 const uschar * sep = smtp_connection_had[SMTP_HBUFF_SIZE-1] != SCH_NONE
1863 ? US" C=..." : US" C=";
1865 for (int i = smtp_ch_index; i < SMTP_HBUFF_SIZE; i++)
1866 if (smtp_connection_had[i] != SCH_NONE)
1868 g = string_append(g, 2, sep, smtp_names[smtp_connection_had[i]]);
1871 for (int i = 0; i < smtp_ch_index; i++, sep = US",")
1872 g = string_append(g, 2, sep, smtp_names[smtp_connection_had[i]]);
1877 /*************************************************
1878 * Log lack of MAIL if so configured *
1879 *************************************************/
1881 /* This function is called when an SMTP session ends. If the log selector
1882 smtp_no_mail is set, write a log line giving some details of what has happened
1883 in the SMTP session.
1890 smtp_log_no_mail(void)
1895 if (smtp_mailcmd_count > 0 || !LOGGING(smtp_no_mail))
1898 if (sender_host_authenticated)
1900 g = string_append(g, 2, US" A=", sender_host_authenticated);
1901 if (authenticated_id) g = string_append(g, 2, US":", authenticated_id);
1908 g = s_connhad_log(g);
1910 if (!(s = string_from_gstring(g))) s = US"";
1912 log_write(0, LOG_MAIN, "no MAIL in %sSMTP connection from %s D=%s%s",
1913 f.tcp_in_fastopen ? f.tcp_in_fastopen_data ? US"TFO* " : US"TFO " : US"",
1914 host_and_ident(FALSE), string_timesince(&smtp_connection_start), s);
1918 /* Return list of recent smtp commands */
1923 gstring * list = NULL;
1926 for (int i = smtp_ch_index; i < SMTP_HBUFF_SIZE; i++)
1927 if (smtp_connection_had[i] != SCH_NONE)
1928 list = string_append_listele(list, ',', smtp_names[smtp_connection_had[i]]);
1930 for (int i = 0; i < smtp_ch_index; i++)
1931 list = string_append_listele(list, ',', smtp_names[smtp_connection_had[i]]);
1933 s = string_from_gstring(list);
1934 return s ? s : US"";
1940 /*************************************************
1941 * Check HELO line and set sender_helo_name *
1942 *************************************************/
1944 /* Check the format of a HELO line. The data for HELO/EHLO is supposed to be
1945 the domain name of the sending host, or an ip literal in square brackets. The
1946 argument is placed in sender_helo_name, which is in malloc store, because it
1947 must persist over multiple incoming messages. If helo_accept_junk is set, this
1948 host is permitted to send any old junk (needed for some broken hosts).
1949 Otherwise, helo_allow_chars can be used for rogue characters in general
1950 (typically people want to let in underscores).
1953 s the data portion of the line (already past any white space)
1955 Returns: TRUE or FALSE
1959 check_helo(uschar *s)
1962 uschar *end = s + Ustrlen(s);
1963 BOOL yield = fl.helo_accept_junk;
1965 /* Discard any previous helo name */
1967 sender_helo_name = NULL;
1969 /* Skip tests if junk is permitted. */
1973 /* Allow the new standard form for IPv6 address literals, namely,
1974 [IPv6:....], and because someone is bound to use it, allow an equivalent
1975 IPv4 form. Allow plain addresses as well. */
1982 if (strncmpic(s, US"[IPv6:", 6) == 0)
1983 yield = (string_is_ip_address(s+6, NULL) == 6);
1984 else if (strncmpic(s, US"[IPv4:", 6) == 0)
1985 yield = (string_is_ip_address(s+6, NULL) == 4);
1987 yield = (string_is_ip_address(s+1, NULL) != 0);
1992 /* Non-literals must be alpha, dot, hyphen, plus any non-valid chars
1993 that have been configured (usually underscore - sigh). */
1996 for (yield = TRUE; *s; s++)
1997 if (!isalnum(*s) && *s != '.' && *s != '-' &&
1998 Ustrchr(helo_allow_chars, *s) == NULL)
2004 /* Save argument if OK */
2006 if (yield) sender_helo_name = string_copy_perm(start, TRUE);
2014 /*************************************************
2015 * Extract SMTP command option *
2016 *************************************************/
2018 /* This function picks the next option setting off the end of smtp_cmd_data. It
2019 is called for MAIL FROM and RCPT TO commands, to pick off the optional ESMTP
2020 things that can appear there.
2023 name point this at the name
2024 value point this at the data string
2026 Returns: TRUE if found an option
2030 extract_option(uschar **name, uschar **value)
2034 if (Ustrlen(smtp_cmd_data) <= 0) return FALSE;
2035 v = smtp_cmd_data + Ustrlen(smtp_cmd_data) - 1;
2036 while (v > smtp_cmd_data && isspace(*v)) v--;
2039 while (v > smtp_cmd_data && *v != '=' && !isspace(*v))
2041 /* Take care to not stop at a space embedded in a quoted local-part */
2044 do v--; while (v > smtp_cmd_data && *v != '"');
2045 if (v <= smtp_cmd_data) return FALSE;
2049 if (v <= smtp_cmd_data) return FALSE;
2054 while (n > smtp_cmd_data && isalpha(n[-1])) n--;
2055 /* RFC says SP, but TAB seen in wild and other major MTAs accept it */
2056 if (n <= smtp_cmd_data || !isspace(n[-1])) return FALSE;
2073 /*************************************************
2074 * Reset for new message *
2075 *************************************************/
2077 /* This function is called whenever the SMTP session is reset from
2078 within either of the setup functions; also from the daemon loop.
2080 Argument: the stacking pool storage reset point
2085 smtp_reset(void *reset_point)
2087 recipients_list = NULL;
2088 rcpt_count = rcpt_defer_count = rcpt_fail_count =
2089 raw_recipients_count = recipients_count = recipients_list_max = 0;
2090 message_linecount = 0;
2092 message_body = message_body_end = NULL;
2093 acl_added_headers = NULL;
2094 acl_removed_headers = NULL;
2095 f.queue_only_policy = FALSE;
2096 rcpt_smtp_response = NULL;
2097 fl.rcpt_smtp_response_same = TRUE;
2098 fl.rcpt_in_progress = FALSE;
2099 f.deliver_freeze = FALSE; /* Can be set by ACL */
2100 freeze_tell = freeze_tell_config; /* Can be set by ACL */
2101 fake_response = OK; /* Can be set by ACL */
2102 #ifdef WITH_CONTENT_SCAN
2103 f.no_mbox_unspool = FALSE; /* Can be set by ACL */
2105 f.submission_mode = FALSE; /* Can be set by ACL */
2106 f.suppress_local_fixups = f.suppress_local_fixups_default; /* Can be set by ACL */
2107 f.active_local_from_check = local_from_check; /* Can be set by ACL */
2108 f.active_local_sender_retain = local_sender_retain; /* Can be set by ACL */
2109 sending_ip_address = NULL;
2110 return_path = sender_address = NULL;
2111 deliver_localpart_data = deliver_domain_data =
2112 recipient_data = sender_data = NULL; /* Can be set by ACL */
2113 recipient_verify_failure = NULL;
2114 deliver_localpart_parent = deliver_localpart_orig = NULL;
2115 deliver_domain_parent = deliver_domain_orig = NULL;
2116 callout_address = NULL;
2117 submission_name = NULL; /* Can be set by ACL */
2118 raw_sender = NULL; /* After SMTP rewrite, before qualifying */
2119 sender_address_unrewritten = NULL; /* Set only after verify rewrite */
2120 sender_verified_list = NULL; /* No senders verified */
2121 memset(sender_address_cache, 0, sizeof(sender_address_cache));
2122 memset(sender_domain_cache, 0, sizeof(sender_domain_cache));
2124 authenticated_sender = NULL;
2125 #ifdef EXPERIMENTAL_BRIGHTMAIL
2127 bmi_verdicts = NULL;
2129 dnslist_domain = dnslist_matched = NULL;
2131 spf_header_comment = spf_received = spf_result = spf_smtp_comment = NULL;
2132 spf_result_guessed = FALSE;
2134 #ifndef DISABLE_DKIM
2135 dkim_cur_signer = dkim_signers =
2136 dkim_signing_domain = dkim_signing_selector = dkim_signatures = NULL;
2137 dkim_cur_signer = dkim_signers = dkim_signing_domain = dkim_signing_selector = NULL;
2138 f.dkim_disable_verify = FALSE;
2139 dkim_collect_input = 0;
2140 dkim_verify_overall = dkim_verify_status = dkim_verify_reason = NULL;
2141 dkim_key_length = 0;
2143 #ifdef SUPPORT_DMARC
2144 f.dmarc_has_been_checked = f.dmarc_disable_verify = f.dmarc_enable_forensic = FALSE;
2145 dmarc_domain_policy = dmarc_status = dmarc_status_text =
2146 dmarc_used_domain = NULL;
2148 #ifdef EXPERIMENTAL_ARC
2149 arc_state = arc_state_reason = NULL;
2150 arc_received_instance = 0;
2154 deliver_host = deliver_host_address = NULL; /* Can be set by ACL */
2155 #ifndef DISABLE_PRDR
2156 prdr_requested = FALSE;
2159 message_smtputf8 = FALSE;
2161 #ifdef WITH_CONTENT_SCAN
2164 body_linecount = body_zerocount = 0;
2166 lookup_value = NULL; /* Can be set by ACL */
2167 sender_rate = sender_rate_limit = sender_rate_period = NULL;
2168 ratelimiters_mail = NULL; /* Updated by ratelimit ACL condition */
2169 /* Note that ratelimiters_conn persists across resets. */
2171 /* Reset message ACL variables */
2175 /* Warning log messages are saved in malloc store. They are saved to avoid
2176 repetition in the same message, but it seems right to repeat them for different
2179 while (acl_warn_logged)
2181 string_item *this = acl_warn_logged;
2182 acl_warn_logged = acl_warn_logged->next;
2187 store_reset(reset_point);
2190 return store_mark();
2197 /*************************************************
2198 * Initialize for incoming batched SMTP message *
2199 *************************************************/
2201 /* This function is called from smtp_setup_msg() in the case when
2202 smtp_batched_input is true. This happens when -bS is used to pass a whole batch
2203 of messages in one file with SMTP commands between them. All errors must be
2204 reported by sending a message, and only MAIL FROM, RCPT TO, and DATA are
2205 relevant. After an error on a sender, or an invalid recipient, the remainder
2206 of the message is skipped. The value of received_protocol is already set.
2209 Returns: > 0 message successfully started (reached DATA)
2210 = 0 QUIT read or end of file reached
2211 < 0 should not occur
2215 smtp_setup_batch_msg(void)
2218 rmark reset_point = store_mark();
2220 /* Save the line count at the start of each transaction - single commands
2221 like HELO and RSET count as whole transactions. */
2223 bsmtp_transaction_linecount = receive_linecount;
2225 if ((receive_feof)()) return 0; /* Treat EOF as QUIT */
2227 cancel_cutthrough_connection(TRUE, US"smtp_setup_batch_msg");
2228 reset_point = smtp_reset(reset_point); /* Reset for start of message */
2230 /* Deal with SMTP commands. This loop is exited by setting done to a POSITIVE
2231 value. The values are 2 larger than the required yield of the function. */
2236 uschar *recipient = NULL;
2237 int start, end, sender_domain, recipient_domain;
2239 switch(smtp_read_command(FALSE, GETC_BUFFER_UNLIMITED))
2241 /* The HELO/EHLO commands set sender_address_helo if they have
2242 valid data; otherwise they are ignored, except that they do
2243 a reset of the state. */
2248 check_helo(smtp_cmd_data);
2252 cancel_cutthrough_connection(TRUE, US"RSET received");
2253 reset_point = smtp_reset(reset_point);
2254 bsmtp_transaction_linecount = receive_linecount;
2258 /* The MAIL FROM command requires an address as an operand. All we
2259 do here is to parse it for syntactic correctness. The form "<>" is
2260 a special case which converts into an empty string. The start/end
2261 pointers in the original are not used further for this address, as
2262 it is the canonical extracted address which is all that is kept. */
2265 smtp_mailcmd_count++; /* Count for no-mail log */
2267 /* The function moan_smtp_batch() does not return. */
2268 moan_smtp_batch(smtp_cmd_buffer, "503 Sender already given");
2270 if (smtp_cmd_data[0] == 0)
2271 /* The function moan_smtp_batch() does not return. */
2272 moan_smtp_batch(smtp_cmd_buffer, "501 MAIL FROM must have an address operand");
2274 /* Reset to start of message */
2276 cancel_cutthrough_connection(TRUE, US"MAIL received");
2277 reset_point = smtp_reset(reset_point);
2279 /* Apply SMTP rewrite */
2281 raw_sender = rewrite_existflags & rewrite_smtp
2282 /* deconst ok as smtp_cmd_data was not const */
2283 ? US rewrite_one(smtp_cmd_data, rewrite_smtp|rewrite_smtp_sender, NULL,
2284 FALSE, US"", global_rewrite_rules)
2287 /* Extract the address; the TRUE flag allows <> as valid */
2290 parse_extract_address(raw_sender, &errmess, &start, &end, &sender_domain,
2294 /* The function moan_smtp_batch() does not return. */
2295 moan_smtp_batch(smtp_cmd_buffer, "501 %s", errmess);
2297 sender_address = string_copy(raw_sender);
2299 /* Qualify unqualified sender addresses if permitted to do so. */
2302 && sender_address[0] != 0 && sender_address[0] != '@')
2303 if (f.allow_unqualified_sender)
2305 /* deconst ok as sender_address was not const */
2306 sender_address = US rewrite_address_qualify(sender_address, FALSE);
2307 DEBUG(D_receive) debug_printf("unqualified address %s accepted "
2308 "and rewritten\n", raw_sender);
2310 /* The function moan_smtp_batch() does not return. */
2312 moan_smtp_batch(smtp_cmd_buffer, "501 sender address must contain "
2317 /* The RCPT TO command requires an address as an operand. All we do
2318 here is to parse it for syntactic correctness. There may be any number
2319 of RCPT TO commands, specifying multiple senders. We build them all into
2320 a data structure that is in argc/argv format. The start/end values
2321 given by parse_extract_address are not used, as we keep only the
2322 extracted address. */
2325 if (!sender_address)
2326 /* The function moan_smtp_batch() does not return. */
2327 moan_smtp_batch(smtp_cmd_buffer, "503 No sender yet given");
2329 if (smtp_cmd_data[0] == 0)
2330 /* The function moan_smtp_batch() does not return. */
2331 moan_smtp_batch(smtp_cmd_buffer,
2332 "501 RCPT TO must have an address operand");
2334 /* Check maximum number allowed */
2336 if (recipients_max > 0 && recipients_count + 1 > recipients_max)
2337 /* The function moan_smtp_batch() does not return. */
2338 moan_smtp_batch(smtp_cmd_buffer, "%s too many recipients",
2339 recipients_max_reject? "552": "452");
2341 /* Apply SMTP rewrite, then extract address. Don't allow "<>" as a
2342 recipient address */
2344 recipient = rewrite_existflags & rewrite_smtp
2345 /* deconst ok as smtp_cmd_data was not const */
2346 ? US rewrite_one(smtp_cmd_data, rewrite_smtp, NULL, FALSE, US"",
2347 global_rewrite_rules)
2350 recipient = parse_extract_address(recipient, &errmess, &start, &end,
2351 &recipient_domain, FALSE);
2354 /* The function moan_smtp_batch() does not return. */
2355 moan_smtp_batch(smtp_cmd_buffer, "501 %s", errmess);
2357 /* If the recipient address is unqualified, qualify it if permitted. Then
2358 add it to the list of recipients. */
2360 if (!recipient_domain)
2361 if (f.allow_unqualified_recipient)
2363 DEBUG(D_receive) debug_printf("unqualified address %s accepted\n",
2365 /* deconst ok as recipient was not const */
2366 recipient = US rewrite_address_qualify(recipient, TRUE);
2368 /* The function moan_smtp_batch() does not return. */
2370 moan_smtp_batch(smtp_cmd_buffer,
2371 "501 recipient address must contain a domain");
2373 receive_add_recipient(recipient, -1);
2377 /* The DATA command is legal only if it follows successful MAIL FROM
2378 and RCPT TO commands. This function is complete when a valid DATA
2379 command is encountered. */
2382 if (!sender_address || recipients_count <= 0)
2383 /* The function moan_smtp_batch() does not return. */
2384 if (!sender_address)
2385 moan_smtp_batch(smtp_cmd_buffer,
2386 "503 MAIL FROM:<sender> command must precede DATA");
2388 moan_smtp_batch(smtp_cmd_buffer,
2389 "503 RCPT TO:<recipient> must precede DATA");
2392 done = 3; /* DATA successfully achieved */
2393 message_ended = END_NOTENDED; /* Indicate in middle of message */
2398 /* The VRFY, EXPN, HELP, ETRN, and NOOP commands are ignored. */
2405 bsmtp_transaction_linecount = receive_linecount;
2410 f.smtp_in_quit = TRUE;
2417 /* The function moan_smtp_batch() does not return. */
2418 moan_smtp_batch(smtp_cmd_buffer, "501 Unexpected argument data");
2423 /* The function moan_smtp_batch() does not return. */
2424 moan_smtp_batch(smtp_cmd_buffer, "501 Unexpected NULL in SMTP command");
2429 /* The function moan_smtp_batch() does not return. */
2430 moan_smtp_batch(smtp_cmd_buffer, "500 Command unrecognized");
2435 return done - 2; /* Convert yield values */
2443 smtp_log_tls_fail(const uschar * errstr)
2445 const uschar * conn_info = smtp_get_connection_info();
2447 if (Ustrncmp(conn_info, US"SMTP ", 5) == 0) conn_info += 5;
2448 /* I'd like to get separated H= here, but too hard for now */
2450 log_write(0, LOG_MAIN, "TLS error on %s %s", conn_info, errstr);
2464 socklen_t len = sizeof(is_fastopen);
2466 /* The tinfo TCPOPT_FAST_OPEN bit seems unreliable, and we don't see state
2467 TCP_SYN_RCV (as of 12.1) so no idea about data-use. */
2469 if (getsockopt(fileno(smtp_out), IPPROTO_TCP, TCP_FASTOPEN, &is_fastopen, &len) == 0)
2474 debug_printf("TFO mode connection (TCP_FASTOPEN getsockopt)\n");
2475 f.tcp_in_fastopen = TRUE;
2478 else DEBUG(D_receive)
2479 debug_printf("TCP_INFO getsockopt: %s\n", strerror(errno));
2481 # elif defined(TCP_INFO)
2482 struct tcp_info tinfo;
2483 socklen_t len = sizeof(tinfo);
2485 if (getsockopt(fileno(smtp_out), IPPROTO_TCP, TCP_INFO, &tinfo, &len) == 0)
2486 # ifdef TCPI_OPT_SYN_DATA /* FreeBSD 11,12 do not seem to have this yet */
2487 if (tinfo.tcpi_options & TCPI_OPT_SYN_DATA)
2490 debug_printf("TFO mode connection (ACKd data-on-SYN)\n");
2491 f.tcp_in_fastopen_data = f.tcp_in_fastopen = TRUE;
2495 if (tinfo.tcpi_state == TCP_SYN_RECV) /* Not seen on FreeBSD 12.1 */
2498 debug_printf("TFO mode connection (state TCP_SYN_RECV)\n");
2499 f.tcp_in_fastopen = TRUE;
2501 else DEBUG(D_receive)
2502 debug_printf("TCP_INFO getsockopt: %s\n", strerror(errno));
2508 /*************************************************
2509 * Start an SMTP session *
2510 *************************************************/
2512 /* This function is called at the start of an SMTP session. Thereafter,
2513 smtp_setup_msg() is called to initiate each separate message. This
2514 function does host-specific testing, and outputs the banner line.
2517 Returns: FALSE if the session can not continue; something has
2518 gone wrong, or the connection to the host is blocked
2522 smtp_start_session(void)
2525 uschar *user_msg, *log_msg;
2530 gettimeofday(&smtp_connection_start, NULL);
2531 for (smtp_ch_index = 0; smtp_ch_index < SMTP_HBUFF_SIZE; smtp_ch_index++)
2532 smtp_connection_had[smtp_ch_index] = SCH_NONE;
2535 /* Default values for certain variables */
2537 fl.helo_seen = fl.esmtp = fl.helo_accept_junk = FALSE;
2538 smtp_mailcmd_count = 0;
2539 count_nonmail = TRUE_UNSET;
2540 synprot_error_count = unknown_command_count = nonmail_command_count = 0;
2541 smtp_delay_mail = smtp_rlm_base;
2542 fl.auth_advertised = FALSE;
2543 f.smtp_in_pipelining_advertised = f.smtp_in_pipelining_used = FALSE;
2544 f.pipelining_enable = TRUE;
2545 sync_cmd_limit = NON_SYNC_CMD_NON_PIPELINING;
2546 fl.smtp_exit_function_called = FALSE; /* For avoiding loop in not-quit exit */
2548 /* If receiving by -bs from a trusted user, or testing with -bh, we allow
2549 authentication settings from -oMaa to remain in force. */
2551 if (!host_checking && !f.sender_host_notsocket)
2552 sender_host_auth_pubname = sender_host_authenticated = NULL;
2553 authenticated_by = NULL;
2556 tls_in.ver = tls_in.cipher = tls_in.peerdn = NULL;
2557 tls_in.ourcert = tls_in.peercert = NULL;
2559 tls_in.ocsp = OCSP_NOT_REQ;
2560 fl.tls_advertised = FALSE;
2562 fl.dsn_advertised = FALSE;
2564 fl.smtputf8_advertised = FALSE;
2567 /* Reset ACL connection variables */
2571 /* Allow for trailing 0 in the command and data buffers. Tainted. */
2573 smtp_cmd_buffer = store_get_perm(2*SMTP_CMD_BUFFER_SIZE + 2, GET_TAINTED);
2575 smtp_cmd_buffer[0] = 0;
2576 smtp_data_buffer = smtp_cmd_buffer + SMTP_CMD_BUFFER_SIZE + 1;
2578 /* For batched input, the protocol setting can be overridden from the
2579 command line by a trusted caller. */
2581 if (smtp_batched_input)
2583 if (!received_protocol) received_protocol = US"local-bsmtp";
2586 /* For non-batched SMTP input, the protocol setting is forced here. It will be
2587 reset later if any of EHLO/AUTH/STARTTLS are received. */
2591 (sender_host_address ? protocols : protocols_local) [pnormal];
2593 /* Set up the buffer for inputting using direct read() calls, and arrange to
2594 call the local functions instead of the standard C ones. */
2598 receive_getc = smtp_getc;
2599 receive_getbuf = smtp_getbuf;
2600 receive_get_cache = smtp_get_cache;
2601 receive_hasc = smtp_hasc;
2602 receive_ungetc = smtp_ungetc;
2603 receive_feof = smtp_feof;
2604 receive_ferror = smtp_ferror;
2605 lwr_receive_getc = NULL;
2606 lwr_receive_getbuf = NULL;
2607 lwr_receive_hasc = NULL;
2608 lwr_receive_ungetc = NULL;
2610 /* Set up the message size limit; this may be host-specific */
2612 thismessage_size_limit = expand_string_integer(message_size_limit, TRUE);
2613 if (expand_string_message)
2615 if (thismessage_size_limit == -1)
2616 log_write(0, LOG_MAIN|LOG_PANIC, "unable to expand message_size_limit: "
2617 "%s", expand_string_message);
2619 log_write(0, LOG_MAIN|LOG_PANIC, "invalid message_size_limit: "
2620 "%s", expand_string_message);
2621 smtp_closedown(US"Temporary local problem - please try later");
2625 /* When a message is input locally via the -bs or -bS options, sender_host_
2626 unknown is set unless -oMa was used to force an IP address, in which case it
2627 is checked like a real remote connection. When -bs is used from inetd, this
2628 flag is not set, causing the sending host to be checked. The code that deals
2629 with IP source routing (if configured) is never required for -bs or -bS and
2630 the flag sender_host_notsocket is used to suppress it.
2632 If smtp_accept_max and smtp_accept_reserve are set, keep some connections in
2633 reserve for certain hosts and/or networks. */
2635 if (!f.sender_host_unknown)
2638 BOOL reserved_host = FALSE;
2640 /* Look up IP options (source routing info) on the socket if this is not an
2641 -oMa "host", and if any are found, log them and drop the connection.
2643 Linux (and others now, see below) is different to everyone else, so there
2644 has to be some conditional compilation here. Versions of Linux before 2.1.15
2645 used a structure whose name was "options". Somebody finally realized that
2646 this name was silly, and it got changed to "ip_options". I use the
2647 newer name here, but there is a fudge in the script that sets up os.h
2648 to define a macro in older Linux systems.
2650 Sigh. Linux is a fast-moving target. Another generation of Linux uses
2651 glibc 2, which has chosen ip_opts for the structure name. This is now
2652 really a glibc thing rather than a Linux thing, so the condition name
2653 has been changed to reflect this. It is relevant also to GNU/Hurd.
2655 Mac OS 10.x (Darwin) is like the later glibc versions, but without the
2656 setting of the __GLIBC__ macro, so we can't detect it automatically. There's
2657 a special macro defined in the os.h file.
2659 Some DGUX versions on older hardware appear not to support IP options at
2660 all, so there is now a general macro which can be set to cut out this
2663 How to do this properly in IPv6 is not yet known. */
2665 #if !HAVE_IPV6 && !defined(NO_IP_OPTIONS)
2667 #ifdef GLIBC_IP_OPTIONS
2668 #if (!defined __GLIBC__) || (__GLIBC__ < 2)
2673 #elif defined DARWIN_IP_OPTIONS
2679 if (!host_checking && !f.sender_host_notsocket)
2682 EXIM_SOCKLEN_T optlen = sizeof(struct ip_options) + MAX_IPOPTLEN;
2683 struct ip_options *ipopt = store_get(optlen, GET_UNTAINTED);
2685 struct ip_opts ipoptblock;
2686 struct ip_opts *ipopt = &ipoptblock;
2687 EXIM_SOCKLEN_T optlen = sizeof(ipoptblock);
2689 struct ipoption ipoptblock;
2690 struct ipoption *ipopt = &ipoptblock;
2691 EXIM_SOCKLEN_T optlen = sizeof(ipoptblock);
2694 /* Occasional genuine failures of getsockopt() have been seen - for
2695 example, "reset by peer". Therefore, just log and give up on this
2696 call, unless the error is ENOPROTOOPT. This error is given by systems
2697 that have the interfaces but not the mechanism - e.g. GNU/Hurd at the time
2698 of writing. So for that error, carry on - we just can't do an IP options
2701 DEBUG(D_receive) debug_printf("checking for IP options\n");
2703 if (getsockopt(fileno(smtp_out), IPPROTO_IP, IP_OPTIONS, US (ipopt),
2706 if (errno != ENOPROTOOPT)
2708 log_write(0, LOG_MAIN, "getsockopt() failed from %s: %s",
2709 host_and_ident(FALSE), strerror(errno));
2710 smtp_printf("451 SMTP service not available\r\n", FALSE);
2715 /* Deal with any IP options that are set. On the systems I have looked at,
2716 the value of MAX_IPOPTLEN has been 40, meaning that there should never be
2717 more logging data than will fit in big_buffer. Nevertheless, after somebody
2718 questioned this code, I've added in some paranoid checking. */
2720 else if (optlen > 0)
2722 uschar *p = big_buffer;
2723 uschar *pend = big_buffer + big_buffer_size;
2726 struct in_addr addr;
2729 uschar *optstart = US (ipopt->__data);
2731 uschar *optstart = US (ipopt->ip_opts);
2733 uschar *optstart = US (ipopt->ipopt_list);
2736 DEBUG(D_receive) debug_printf("IP options exist\n");
2738 Ustrcpy(p, "IP options on incoming call:");
2741 for (uschar * opt = optstart; opt && opt < US (ipopt) + optlen; )
2754 if (!string_format(p, pend-p, " %s [@%s",
2755 (*opt == IPOPT_SSRR)? "SSRR" : "LSRR",
2757 inet_ntoa(*((struct in_addr *)(&(ipopt->faddr))))))
2759 inet_ntoa(ipopt->ip_dst)))
2761 inet_ntoa(ipopt->ipopt_dst)))
2769 optcount = (opt[1] - 3) / sizeof(struct in_addr);
2771 while (optcount-- > 0)
2773 memcpy(&addr, adptr, sizeof(addr));
2774 if (!string_format(p, pend - p - 1, "%s%s",
2775 (optcount == 0)? ":" : "@", inet_ntoa(addr)))
2781 adptr += sizeof(struct in_addr);
2789 if (pend - p < 4 + 3*opt[1]) { opt = NULL; break; }
2792 for (int i = 0; i < opt[1]; i++)
2793 p += sprintf(CS p, "%2.2x ", opt[i]);
2801 log_write(0, LOG_MAIN, "%s", big_buffer);
2803 /* Refuse any call with IP options. This is what tcpwrappers 7.5 does. */
2805 log_write(0, LOG_MAIN|LOG_REJECT,
2806 "connection from %s refused (IP options)", host_and_ident(FALSE));
2808 smtp_printf("554 SMTP service not available\r\n", FALSE);
2812 /* Length of options = 0 => there are no options */
2814 else DEBUG(D_receive) debug_printf("no IP options found\n");
2816 #endif /* HAVE_IPV6 && !defined(NO_IP_OPTIONS) */
2818 /* Set keep-alive in socket options. The option is on by default. This
2819 setting is an attempt to get rid of some hanging connections that stick in
2820 read() when the remote end (usually a dialup) goes away. */
2822 if (smtp_accept_keepalive && !f.sender_host_notsocket)
2823 ip_keepalive(fileno(smtp_out), sender_host_address, FALSE);
2825 /* If the current host matches host_lookup, set the name by doing a
2826 reverse lookup. On failure, sender_host_name will be NULL and
2827 host_lookup_failed will be TRUE. This may or may not be serious - optional
2830 if (verify_check_host(&host_lookup) == OK)
2832 (void)host_name_lookup();
2833 host_build_sender_fullhost();
2836 /* Delay this until we have the full name, if it is looked up. */
2838 set_process_info("handling incoming connection from %s",
2839 host_and_ident(FALSE));
2841 /* Expand smtp_receive_timeout, if needed */
2843 if (smtp_receive_timeout_s)
2846 if ( !(exp = expand_string(smtp_receive_timeout_s))
2848 || (smtp_receive_timeout = readconf_readtime(exp, 0, FALSE)) < 0
2850 log_write(0, LOG_MAIN|LOG_PANIC,
2851 "bad value for smtp_receive_timeout: '%s'", exp ? exp : US"");
2854 /* Test for explicit connection rejection */
2856 if (verify_check_host(&host_reject_connection) == OK)
2858 log_write(L_connection_reject, LOG_MAIN|LOG_REJECT, "refused connection "
2859 "from %s (host_reject_connection)", host_and_ident(FALSE));
2860 smtp_printf("554 SMTP service not available\r\n", FALSE);
2864 /* Test with TCP Wrappers if so configured. There is a problem in that
2865 hosts_ctl() returns 0 (deny) under a number of system failure circumstances,
2866 such as disks dying. In these cases, it is desirable to reject with a 4xx
2867 error instead of a 5xx error. There isn't a "right" way to detect such
2868 problems. The following kludge is used: errno is zeroed before calling
2869 hosts_ctl(). If the result is "reject", a 5xx error is given only if the
2870 value of errno is 0 or ENOENT (which happens if /etc/hosts.{allow,deny} does
2873 #ifdef USE_TCP_WRAPPERS
2875 if (!(tcp_wrappers_name = expand_string(tcp_wrappers_daemon_name)))
2876 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Expansion of \"%s\" "
2877 "(tcp_wrappers_name) failed: %s", string_printing(tcp_wrappers_name),
2878 expand_string_message);
2880 if (!hosts_ctl(tcp_wrappers_name,
2881 sender_host_name ? CS sender_host_name : STRING_UNKNOWN,
2882 sender_host_address ? CS sender_host_address : STRING_UNKNOWN,
2883 sender_ident ? CS sender_ident : STRING_UNKNOWN))
2885 if (errno == 0 || errno == ENOENT)
2887 HDEBUG(D_receive) debug_printf("tcp wrappers rejection\n");
2888 log_write(L_connection_reject,
2889 LOG_MAIN|LOG_REJECT, "refused connection from %s "
2890 "(tcp wrappers)", host_and_ident(FALSE));
2891 smtp_printf("554 SMTP service not available\r\n", FALSE);
2895 int save_errno = errno;
2896 HDEBUG(D_receive) debug_printf("tcp wrappers rejected with unexpected "
2897 "errno value %d\n", save_errno);
2898 log_write(L_connection_reject,
2899 LOG_MAIN|LOG_REJECT, "temporarily refused connection from %s "
2900 "(tcp wrappers errno=%d)", host_and_ident(FALSE), save_errno);
2901 smtp_printf("451 Temporary local problem - please try later\r\n", FALSE);
2907 /* Check for reserved slots. The value of smtp_accept_count has already been
2908 incremented to include this process. */
2910 if (smtp_accept_max > 0 &&
2911 smtp_accept_count > smtp_accept_max - smtp_accept_reserve)
2913 if ((rc = verify_check_host(&smtp_reserve_hosts)) != OK)
2915 log_write(L_connection_reject,
2916 LOG_MAIN, "temporarily refused connection from %s: not in "
2917 "reserve list: connected=%d max=%d reserve=%d%s",
2918 host_and_ident(FALSE), smtp_accept_count - 1, smtp_accept_max,
2919 smtp_accept_reserve, (rc == DEFER)? " (lookup deferred)" : "");
2920 smtp_printf("421 %s: Too many concurrent SMTP connections; "
2921 "please try again later\r\n", FALSE, smtp_active_hostname);
2924 reserved_host = TRUE;
2927 /* If a load level above which only messages from reserved hosts are
2928 accepted is set, check the load. For incoming calls via the daemon, the
2929 check is done in the superior process if there are no reserved hosts, to
2930 save a fork. In all cases, the load average will already be available
2931 in a global variable at this point. */
2933 if (smtp_load_reserve >= 0 &&
2934 load_average > smtp_load_reserve &&
2936 verify_check_host(&smtp_reserve_hosts) != OK)
2938 log_write(L_connection_reject,
2939 LOG_MAIN, "temporarily refused connection from %s: not in "
2940 "reserve list and load average = %.2f", host_and_ident(FALSE),
2941 (double)load_average/1000.0);
2942 smtp_printf("421 %s: Too much load; please try again later\r\n", FALSE,
2943 smtp_active_hostname);
2947 /* Determine whether unqualified senders or recipients are permitted
2948 for this host. Unfortunately, we have to do this every time, in order to
2949 set the flags so that they can be inspected when considering qualifying
2950 addresses in the headers. For a site that permits no qualification, this
2951 won't take long, however. */
2953 f.allow_unqualified_sender =
2954 verify_check_host(&sender_unqualified_hosts) == OK;
2956 f.allow_unqualified_recipient =
2957 verify_check_host(&recipient_unqualified_hosts) == OK;
2959 /* Determine whether HELO/EHLO is required for this host. The requirement
2960 can be hard or soft. */
2962 fl.helo_verify_required = verify_check_host(&helo_verify_hosts) == OK;
2963 if (!fl.helo_verify_required)
2964 fl.helo_verify = verify_check_host(&helo_try_verify_hosts) == OK;
2966 /* Determine whether this hosts is permitted to send syntactic junk
2967 after a HELO or EHLO command. */
2969 fl.helo_accept_junk = verify_check_host(&helo_accept_junk_hosts) == OK;
2972 /* For batch SMTP input we are now done. */
2974 if (smtp_batched_input) return TRUE;
2976 /* If valid Proxy Protocol source is connecting, set up session.
2977 Failure will not allow any SMTP function other than QUIT. */
2979 #ifdef SUPPORT_PROXY
2980 proxy_session = FALSE;
2981 f.proxy_session_failed = FALSE;
2982 if (check_proxy_protocol_host())
2983 setup_proxy_protocol_host();
2986 /* Start up TLS if tls_on_connect is set. This is for supporting the legacy
2987 smtps port for use with older style SSL MTAs. */
2990 if (tls_in.on_connect)
2992 if (tls_server_start(&user_msg) != OK)
2993 return smtp_log_tls_fail(user_msg);
2994 cmd_list[CMD_LIST_TLS_AUTH].is_mail_cmd = TRUE;
2998 /* Run the connect ACL if it exists */
3001 if (acl_smtp_connect)
3004 if ((rc = acl_check(ACL_WHERE_CONNECT, NULL, acl_smtp_connect, &user_msg,
3007 (void) smtp_handle_acl_fail(ACL_WHERE_CONNECT, rc, user_msg, log_msg);
3012 /* Output the initial message for a two-way SMTP connection. It may contain
3013 newlines, which then cause a multi-line response to be given. */
3015 code = US"220"; /* Default status code */
3016 esc = US""; /* Default extended status code */
3017 esclen = 0; /* Length of esc */
3021 if (!(s = expand_string(smtp_banner)))
3022 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Expansion of \"%s\" (smtp_banner) "
3023 "failed: %s", smtp_banner, expand_string_message);
3029 smtp_message_code(&code, &codelen, &s, NULL, TRUE);
3033 esclen = codelen - 4;
3037 /* Remove any terminating newlines; might as well remove trailing space too */
3040 while (p > s && isspace(p[-1])) p--;
3041 s = string_copyn(s, p-s);
3043 /* It seems that CC:Mail is braindead, and assumes that the greeting message
3044 is all contained in a single IP packet. The original code wrote out the
3045 greeting using several calls to fprint/fputc, and on busy servers this could
3046 cause it to be split over more than one packet - which caused CC:Mail to fall
3047 over when it got the second part of the greeting after sending its first
3048 command. Sigh. To try to avoid this, build the complete greeting message
3049 first, and output it in one fell swoop. This gives a better chance of it
3050 ending up as a single packet. */
3052 ss = string_get(256);
3055 do /* At least once, in case we have an empty string */
3058 uschar *linebreak = Ustrchr(p, '\n');
3059 ss = string_catn(ss, code, 3);
3063 ss = string_catn(ss, US" ", 1);
3067 len = linebreak - p;
3068 ss = string_catn(ss, US"-", 1);
3070 ss = string_catn(ss, esc, esclen);
3071 ss = string_catn(ss, p, len);
3072 ss = string_catn(ss, US"\r\n", 2);
3078 /* Before we write the banner, check that there is no input pending, unless
3079 this synchronisation check is disabled. */
3081 #ifndef DISABLE_PIPE_CONNECT
3082 fl.pipe_connect_acceptable =
3083 sender_host_address && verify_check_host(&pipe_connect_advertise_hosts) == OK;
3086 if (fl.pipe_connect_acceptable)
3087 f.smtp_in_early_pipe_used = TRUE;
3093 unsigned n = smtp_inend - smtp_inptr;
3094 if (n > 128) n = 128;
3096 log_write(0, LOG_MAIN|LOG_REJECT, "SMTP protocol "
3097 "synchronization error (input sent without waiting for greeting): "
3098 "rejected connection from %s input=\"%s\"", host_and_ident(TRUE),
3099 string_printing(string_copyn(smtp_inptr, n)));
3100 smtp_printf("554 SMTP synchronization error\r\n", FALSE);
3104 /* Now output the banner */
3105 /*XXX the ehlo-resp code does its own tls/nontls bit. Maybe subroutine that? */
3108 #ifndef DISABLE_PIPE_CONNECT
3109 fl.pipe_connect_acceptable && pipeline_connect_sends(),
3113 string_from_gstring(ss));
3115 /* Attempt to see if we sent the banner before the last ACK of the 3-way
3116 handshake arrived. If so we must have managed a TFO. */
3119 if (sender_host_address && !f.sender_host_notsocket) tfo_in_check();
3129 /*************************************************
3130 * Handle SMTP syntax and protocol errors *
3131 *************************************************/
3133 /* Write to the log for SMTP syntax errors in incoming commands, if configured
3134 to do so. Then transmit the error response. The return value depends on the
3135 number of syntax and protocol errors in this SMTP session.
3138 type error type, given as a log flag bit
3139 code response code; <= 0 means don't send a response
3140 data data to reflect in the response (can be NULL)
3141 errmess the error message
3143 Returns: -1 limit of syntax/protocol errors NOT exceeded
3144 +1 limit of syntax/protocol errors IS exceeded
3146 These values fit in with the values of the "done" variable in the main
3147 processing loop in smtp_setup_msg(). */
3150 synprot_error(int type, int code, uschar *data, uschar *errmess)
3154 log_write(type, LOG_MAIN, "SMTP %s error in \"%s\" %s %s",
3155 type == L_smtp_syntax_error ? "syntax" : "protocol",
3156 string_printing(smtp_cmd_buffer), host_and_ident(TRUE), errmess);
3158 if (++synprot_error_count > smtp_max_synprot_errors)
3161 log_write(0, LOG_MAIN|LOG_REJECT, "SMTP call from %s dropped: too many "
3162 "syntax or protocol errors (last command was \"%s\", %s)",
3163 host_and_ident(FALSE), string_printing(smtp_cmd_buffer),
3164 string_from_gstring(s_connhad_log(NULL))
3170 smtp_printf("%d%c%s%s%s\r\n", FALSE, code, yield == 1 ? '-' : ' ',
3171 data ? data : US"", data ? US": " : US"", errmess);
3173 smtp_printf("%d Too many syntax or protocol errors\r\n", FALSE, code);
3182 /*************************************************
3183 * Send SMTP response, possibly multiline *
3184 *************************************************/
3186 /* There are, it seems, broken clients out there that cannot handle multiline
3187 responses. If no_multiline_responses is TRUE (it can be set from an ACL), we
3188 output nothing for non-final calls, and only the first line for anything else.
3191 code SMTP code, may involve extended status codes
3192 codelen length of smtp code; if > 4 there's an ESC
3193 final FALSE if the last line isn't the final line
3194 msg message text, possibly containing newlines
3200 smtp_respond(uschar* code, int codelen, BOOL final, uschar *msg)
3205 if (!final && f.no_multiline_responses) return;
3210 esclen = codelen - 4;
3213 /* If this is the first output for a (non-batch) RCPT command, see if all RCPTs
3214 have had the same. Note: this code is also present in smtp_printf(). It would
3215 be tidier to have it only in one place, but when it was added, it was easier to
3216 do it that way, so as not to have to mess with the code for the RCPT command,
3217 which sometimes uses smtp_printf() and sometimes smtp_respond(). */
3219 if (fl.rcpt_in_progress)
3221 if (!rcpt_smtp_response)
3222 rcpt_smtp_response = string_copy(msg);
3223 else if (fl.rcpt_smtp_response_same &&
3224 Ustrcmp(rcpt_smtp_response, msg) != 0)
3225 fl.rcpt_smtp_response_same = FALSE;
3226 fl.rcpt_in_progress = FALSE;
3229 /* Now output the message, splitting it up into multiple lines if necessary.
3230 We only handle pipelining these responses as far as nonfinal/final groups,
3231 not the whole MAIL/RCPT/DATA response set. */
3235 uschar *nl = Ustrchr(msg, '\n');
3238 smtp_printf("%.3s%c%.*s%s\r\n", !final, code, final ? ' ':'-', esclen, esc, msg);
3241 else if (nl[1] == 0 || f.no_multiline_responses)
3243 smtp_printf("%.3s%c%.*s%.*s\r\n", !final, code, final ? ' ':'-', esclen, esc,
3244 (int)(nl - msg), msg);
3249 smtp_printf("%.3s-%.*s%.*s\r\n", TRUE, code, esclen, esc, (int)(nl - msg), msg);
3251 Uskip_whitespace(&msg);
3259 /*************************************************
3260 * Parse user SMTP message *
3261 *************************************************/
3263 /* This function allows for user messages overriding the response code details
3264 by providing a suitable response code string at the start of the message
3265 user_msg. Check the message for starting with a response code and optionally an
3266 extended status code. If found, check that the first digit is valid, and if so,
3267 change the code pointer and length to use the replacement. An invalid code
3268 causes a panic log; in this case, if the log messages is the same as the user
3269 message, we must also adjust the value of the log message to show the code that
3270 is actually going to be used (the original one).
3272 This function is global because it is called from receive.c as well as within
3275 Note that the code length returned includes the terminating whitespace
3276 character, which is always included in the regex match.
3279 code SMTP code, may involve extended status codes
3280 codelen length of smtp code; if > 4 there's an ESC
3282 log_msg optional log message, to be adjusted with the new SMTP code
3283 check_valid if true, verify the response code
3289 smtp_message_code(uschar **code, int *codelen, uschar **msg, uschar **log_msg,
3295 if (!msg || !*msg || !regex_match(regex_smtp_code, *msg, -1, &match))
3298 len = Ustrlen(match);
3299 if (check_valid && (*msg)[0] != (*code)[0])
3301 log_write(0, LOG_MAIN|LOG_PANIC, "configured error code starts with "
3302 "incorrect digit (expected %c) in \"%s\"", (*code)[0], *msg);
3303 if (log_msg && *log_msg == *msg)
3304 *log_msg = string_sprintf("%s %s", *code, *log_msg + len);
3309 *codelen = len; /* Includes final space */
3311 *msg += len; /* Chop the code off the message */
3318 /*************************************************
3319 * Handle an ACL failure *
3320 *************************************************/
3322 /* This function is called when acl_check() fails. As well as calls from within
3323 this module, it is called from receive.c for an ACL after DATA. It sorts out
3324 logging the incident, and sends the error response. A message containing
3325 newlines is turned into a multiline SMTP response, but for logging, only the
3328 There's a table of default permanent failure response codes to use in
3329 globals.c, along with the table of names. VFRY is special. Despite RFC1123 it
3330 defaults disabled in Exim. However, discussion in connection with RFC 821bis
3331 (aka RFC 2821) has concluded that the response should be 252 in the disabled
3332 state, because there are broken clients that try VRFY before RCPT. A 5xx
3333 response should be given only when the address is positively known to be
3334 undeliverable. Sigh. We return 252 if there is no VRFY ACL or it provides
3335 no explicit code, but if there is one we let it know best.
3336 Also, for ETRN, 458 is given on refusal, and for AUTH, 503.
3338 From Exim 4.63, it is possible to override the response code details by
3339 providing a suitable response code string at the start of the message provided
3340 in user_msg. The code's first digit is checked for validity.
3343 where where the ACL was called from
3345 user_msg a message that can be included in an SMTP response
3346 log_msg a message for logging
3348 Returns: 0 in most cases
3349 2 if the failure code was FAIL_DROP, in which case the
3350 SMTP connection should be dropped (this value fits with the
3351 "done" variable in smtp_setup_msg() below)
3355 smtp_handle_acl_fail(int where, int rc, uschar *user_msg, uschar *log_msg)
3357 BOOL drop = rc == FAIL_DROP;
3361 uschar *sender_info = US"";
3364 if (drop) rc = FAIL;
3366 /* Set the default SMTP code, and allow a user message to change it. */
3368 smtp_code = rc == FAIL ? acl_wherecodes[where] : US"451";
3369 smtp_message_code(&smtp_code, &codelen, &user_msg, &log_msg,
3370 where != ACL_WHERE_VRFY);
3372 /* We used to have sender_address here; however, there was a bug that was not
3373 updating sender_address after a rewrite during a verify. When this bug was
3374 fixed, sender_address at this point became the rewritten address. I'm not sure
3375 this is what should be logged, so I've changed to logging the unrewritten
3376 address to retain backward compatibility. */
3380 #ifdef WITH_CONTENT_SCAN
3381 case ACL_WHERE_MIME: what = US"during MIME ACL checks"; break;
3383 case ACL_WHERE_PREDATA: what = US"DATA"; break;
3384 case ACL_WHERE_DATA: what = US"after DATA"; break;
3385 #ifndef DISABLE_PRDR
3386 case ACL_WHERE_PRDR: what = US"after DATA PRDR"; break;
3390 uschar * place = smtp_cmd_data ? smtp_cmd_data : US"in \"connect\" ACL";
3393 if (where == ACL_WHERE_AUTH) /* avoid logging auth creds */
3396 for (s = smtp_cmd_data; *s && !isspace(*s); ) s++;
3397 lim = s - smtp_cmd_data; /* atop after method */
3399 what = string_sprintf("%s %.*s", acl_wherenames[where], lim, place);
3404 case ACL_WHERE_RCPT:
3405 case ACL_WHERE_DATA:
3406 #ifdef WITH_CONTENT_SCAN
3407 case ACL_WHERE_MIME:
3409 sender_info = string_sprintf("F=<%s>%s%s%s%s ",
3410 sender_address_unrewritten ? sender_address_unrewritten : sender_address,
3411 sender_host_authenticated ? US" A=" : US"",
3412 sender_host_authenticated ? sender_host_authenticated : US"",
3413 sender_host_authenticated && authenticated_id ? US":" : US"",
3414 sender_host_authenticated && authenticated_id ? authenticated_id : US""
3419 /* If there's been a sender verification failure with a specific message, and
3420 we have not sent a response about it yet, do so now, as a preliminary line for
3421 failures, but not defers. However, always log it for defer, and log it for fail
3422 unless the sender_verify_fail log selector has been turned off. */
3424 if (sender_verified_failed &&
3425 !testflag(sender_verified_failed, af_sverify_told))
3427 BOOL save_rcpt_in_progress = fl.rcpt_in_progress;
3428 fl.rcpt_in_progress = FALSE; /* So as not to treat these as the error */
3430 setflag(sender_verified_failed, af_sverify_told);
3432 if (rc != FAIL || LOGGING(sender_verify_fail))
3433 log_write(0, LOG_MAIN|LOG_REJECT, "%s sender verify %s for <%s>%s",
3434 host_and_ident(TRUE),
3435 ((sender_verified_failed->special_action & 255) == DEFER)? "defer":"fail",
3436 sender_verified_failed->address,
3437 (sender_verified_failed->message == NULL)? US"" :
3438 string_sprintf(": %s", sender_verified_failed->message));
3440 if (rc == FAIL && sender_verified_failed->user_message)
3441 smtp_respond(smtp_code, codelen, FALSE, string_sprintf(
3442 testflag(sender_verified_failed, af_verify_pmfail)?
3443 "Postmaster verification failed while checking <%s>\n%s\n"
3444 "Several RFCs state that you are required to have a postmaster\n"
3445 "mailbox for each mail domain. This host does not accept mail\n"
3446 "from domains whose servers reject the postmaster address."
3448 testflag(sender_verified_failed, af_verify_nsfail)?
3449 "Callback setup failed while verifying <%s>\n%s\n"
3450 "The initial connection, or a HELO or MAIL FROM:<> command was\n"
3451 "rejected. Refusing MAIL FROM:<> does not help fight spam, disregards\n"
3452 "RFC requirements, and stops you from receiving standard bounce\n"
3453 "messages. This host does not accept mail from domains whose servers\n"
3456 "Verification failed for <%s>\n%s",
3457 sender_verified_failed->address,
3458 sender_verified_failed->user_message));
3460 fl.rcpt_in_progress = save_rcpt_in_progress;
3463 /* Sort out text for logging */
3465 log_msg = log_msg ? string_sprintf(": %s", log_msg) : US"";
3466 if ((lognl = Ustrchr(log_msg, '\n'))) *lognl = 0;
3468 /* Send permanent failure response to the command, but the code used isn't
3469 always a 5xx one - see comments at the start of this function. If the original
3470 rc was FAIL_DROP we drop the connection and yield 2. */
3473 smtp_respond(smtp_code, codelen, TRUE,
3474 user_msg ? user_msg : US"Administrative prohibition");
3476 /* Send temporary failure response to the command. Don't give any details,
3477 unless acl_temp_details is set. This is TRUE for a callout defer, a "defer"
3478 verb, and for a header verify when smtp_return_error_details is set.
3480 This conditional logic is all somewhat of a mess because of the odd
3481 interactions between temp_details and return_error_details. One day it should
3482 be re-implemented in a tidier fashion. */
3485 if (f.acl_temp_details && user_msg)
3487 if ( smtp_return_error_details
3488 && sender_verified_failed
3489 && sender_verified_failed->message
3491 smtp_respond(smtp_code, codelen, FALSE, sender_verified_failed->message);
3493 smtp_respond(smtp_code, codelen, TRUE, user_msg);
3496 smtp_respond(smtp_code, codelen, TRUE,
3497 US"Temporary local problem - please try later");
3499 /* Log the incident to the logs that are specified by log_reject_target
3500 (default main, reject). This can be empty to suppress logging of rejections. If
3501 the connection is not forcibly to be dropped, return 0. Otherwise, log why it
3502 is closing if required and return 2. */
3504 if (log_reject_target != 0)
3507 gstring * g = s_tlslog(NULL);
3508 uschar * tls = string_from_gstring(g);
3509 if (!tls) tls = US"";
3511 uschar * tls = US"";
3513 log_write(where == ACL_WHERE_CONNECT ? L_connection_reject : 0,
3514 log_reject_target, "%s%s%s %s%srejected %s%s",
3515 LOGGING(dnssec) && sender_host_dnssec ? US" DS" : US"",
3516 host_and_ident(TRUE),
3519 rc == FAIL ? US"" : US"temporarily ",
3523 if (!drop) return 0;
3525 log_write(L_smtp_connection, LOG_MAIN, "%s closed by DROP in ACL",
3526 smtp_get_connection_info());
3528 /* Run the not-quit ACL, but without any custom messages. This should not be a
3529 problem, because we get here only if some other ACL has issued "drop", and
3530 in that case, *its* custom messages will have been used above. */
3532 smtp_notquit_exit(US"acl-drop", NULL, NULL);
3539 /*************************************************
3540 * Handle SMTP exit when QUIT is not given *
3541 *************************************************/
3543 /* This function provides a logging/statistics hook for when an SMTP connection
3544 is dropped on the floor or the other end goes away. It's a global function
3545 because it's called from receive.c as well as this module. As well as running
3546 the NOTQUIT ACL, if there is one, this function also outputs a final SMTP
3547 response, either with a custom message from the ACL, or using a default. There
3548 is one case, however, when no message is output - after "drop". In that case,
3549 the ACL that obeyed "drop" has already supplied the custom message, and NULL is
3550 passed to this function.
3552 In case things go wrong while processing this function, causing an error that
3553 may re-enter this function, there is a recursion check.
3556 reason What $smtp_notquit_reason will be set to in the ACL;
3557 if NULL, the ACL is not run
3558 code The error code to return as part of the response
3559 defaultrespond The default message if there's no user_msg
3565 smtp_notquit_exit(uschar *reason, uschar *code, uschar *defaultrespond, ...)
3568 uschar *user_msg = NULL;
3569 uschar *log_msg = NULL;
3571 /* Check for recursive call */
3573 if (fl.smtp_exit_function_called)
3575 log_write(0, LOG_PANIC, "smtp_notquit_exit() called more than once (%s)",
3579 fl.smtp_exit_function_called = TRUE;
3581 /* Call the not-QUIT ACL, if there is one, unless no reason is given. */
3583 if (acl_smtp_notquit && reason)
3585 smtp_notquit_reason = reason;
3586 if ((rc = acl_check(ACL_WHERE_NOTQUIT, NULL, acl_smtp_notquit, &user_msg,
3587 &log_msg)) == ERROR)
3588 log_write(0, LOG_MAIN|LOG_PANIC, "ACL for not-QUIT returned ERROR: %s",
3592 /* If the connection was dropped, we certainly are no longer talking TLS */
3593 tls_in.active.sock = -1;
3595 /* Write an SMTP response if we are expected to give one. As the default
3596 responses are all internal, they should be reasonable size. */
3598 if (code && defaultrespond)
3601 smtp_respond(code, 3, TRUE, user_msg);
3607 va_start(ap, defaultrespond);
3608 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS defaultrespond, ap);
3610 smtp_printf("%s %s\r\n", FALSE, code, string_from_gstring(g));
3619 /*************************************************
3620 * Verify HELO argument *
3621 *************************************************/
3623 /* This function is called if helo_verify_hosts or helo_try_verify_hosts is
3624 matched. It is also called from ACL processing if verify = helo is used and
3625 verification was not previously tried (i.e. helo_try_verify_hosts was not
3626 matched). The result of its processing is to set helo_verified and
3627 helo_verify_failed. These variables should both be FALSE for this function to
3630 Note that EHLO/HELO is legitimately allowed to quote an address literal. Allow
3631 for IPv6 ::ffff: literals.
3634 Returns: TRUE if testing was completed;
3635 FALSE on a temporary failure
3639 smtp_verify_helo(void)
3643 HDEBUG(D_receive) debug_printf("verifying EHLO/HELO argument \"%s\"\n",
3646 if (sender_helo_name == NULL)
3648 HDEBUG(D_receive) debug_printf("no EHLO/HELO command was issued\n");
3651 /* Deal with the case of -bs without an IP address */
3653 else if (sender_host_address == NULL)
3655 HDEBUG(D_receive) debug_printf("no client IP address: assume success\n");
3656 f.helo_verified = TRUE;
3659 /* Deal with the more common case when there is a sending IP address */
3661 else if (sender_helo_name[0] == '[')
3663 f.helo_verified = Ustrncmp(sender_helo_name+1, sender_host_address,
3664 Ustrlen(sender_host_address)) == 0;
3667 if (!f.helo_verified)
3669 if (strncmpic(sender_host_address, US"::ffff:", 7) == 0)
3670 f.helo_verified = Ustrncmp(sender_helo_name + 1,
3671 sender_host_address + 7, Ustrlen(sender_host_address) - 7) == 0;
3676 { if (f.helo_verified) debug_printf("matched host address\n"); }
3679 /* Do a reverse lookup if one hasn't already given a positive or negative
3680 response. If that fails, or the name doesn't match, try checking with a forward
3685 if (sender_host_name == NULL && !host_lookup_failed)
3686 yield = host_name_lookup() != DEFER;
3688 /* If a host name is known, check it and all its aliases. */
3690 if (sender_host_name)
3691 if ((f.helo_verified = strcmpic(sender_host_name, sender_helo_name) == 0))
3693 sender_helo_dnssec = sender_host_dnssec;
3694 HDEBUG(D_receive) debug_printf("matched host name\n");
3698 uschar **aliases = sender_host_aliases;
3700 if ((f.helo_verified = strcmpic(*aliases++, sender_helo_name) == 0))
3702 sender_helo_dnssec = sender_host_dnssec;
3706 HDEBUG(D_receive) if (f.helo_verified)
3707 debug_printf("matched alias %s\n", *(--aliases));
3710 /* Final attempt: try a forward lookup of the helo name */
3712 if (!f.helo_verified)
3716 {.name = sender_helo_name, .address = NULL, .mx = MX_NONE, .next = NULL};
3718 {.request = US"*", .require = US""};
3720 HDEBUG(D_receive) debug_printf("getting IP address for %s\n",
3722 rc = host_find_bydns(&h, NULL, HOST_FIND_BY_A | HOST_FIND_BY_AAAA,
3723 NULL, NULL, NULL, &d, NULL, NULL);
3724 if (rc == HOST_FOUND || rc == HOST_FOUND_LOCAL)
3725 for (host_item * hh = &h; hh; hh = hh->next)
3726 if (Ustrcmp(hh->address, sender_host_address) == 0)
3728 f.helo_verified = TRUE;
3729 if (h.dnssec == DS_YES) sender_helo_dnssec = TRUE;
3731 debug_printf("IP address for %s matches calling address\n"
3732 "Forward DNS security status: %sverified\n",
3733 sender_helo_name, sender_helo_dnssec ? "" : "un");
3739 if (!f.helo_verified) f.helo_verify_failed = TRUE; /* We've tried ... */
3746 /*************************************************
3747 * Send user response message *
3748 *************************************************/
3750 /* This function is passed a default response code and a user message. It calls
3751 smtp_message_code() to check and possibly modify the response code, and then
3752 calls smtp_respond() to transmit the response. I put this into a function
3753 just to avoid a lot of repetition.
3756 code the response code
3757 user_msg the user message
3763 smtp_user_msg(uschar *code, uschar *user_msg)
3766 smtp_message_code(&code, &len, &user_msg, NULL, TRUE);
3767 smtp_respond(code, len, TRUE, user_msg);
3773 smtp_in_auth(auth_instance *au, uschar ** smtp_resp, uschar ** errmsg)
3775 const uschar *set_id = NULL;
3778 /* Set up globals for error messages */
3780 authenticator_name = au->name;
3781 driver_srcfile = au->srcfile;
3782 driver_srcline = au->srcline;
3784 /* Run the checking code, passing the remainder of the command line as
3785 data. Initials the $auth<n> variables as empty. Initialize $0 empty and set
3786 it as the only set numerical variable. The authenticator may set $auth<n>
3787 and also set other numeric variables. The $auth<n> variables are preferred
3788 nowadays; the numerical variables remain for backwards compatibility.
3790 Afterwards, have a go at expanding the set_id string, even if
3791 authentication failed - for bad passwords it can be useful to log the
3792 userid. On success, require set_id to expand and exist, and put it in
3793 authenticated_id. Save this in permanent store, as the working store gets
3794 reset at HELO, RSET, etc. */
3796 for (int i = 0; i < AUTH_VARS; i++) auth_vars[i] = NULL;
3798 expand_nlength[0] = 0; /* $0 contains nothing */
3800 rc = (au->info->servercode)(au, smtp_cmd_data);
3801 if (au->set_id) set_id = expand_string(au->set_id);
3802 expand_nmax = -1; /* Reset numeric variables */
3803 for (int i = 0; i < AUTH_VARS; i++) auth_vars[i] = NULL; /* Reset $auth<n> */
3804 driver_srcfile = authenticator_name = NULL; driver_srcline = 0;
3806 /* The value of authenticated_id is stored in the spool file and printed in
3807 log lines. It must not contain binary zeros or newline characters. In
3808 normal use, it never will, but when playing around or testing, this error
3809 can (did) happen. To guard against this, ensure that the id contains only
3810 printing characters. */
3812 if (set_id) set_id = string_printing(set_id);
3814 /* For the non-OK cases, set up additional logging data if set_id
3818 set_id = set_id && *set_id
3819 ? string_sprintf(" (set_id=%s)", set_id) : US"";
3821 /* Switch on the result */
3826 if (!au->set_id || set_id) /* Complete success */
3828 if (set_id) authenticated_id = string_copy_perm(set_id, TRUE);
3829 sender_host_authenticated = au->name;
3830 sender_host_auth_pubname = au->public_name;
3831 authentication_failed = FALSE;
3832 authenticated_fail_id = NULL; /* Impossible to already be set? */
3835 (sender_host_address ? protocols : protocols_local)
3836 [pextend + pauthed + (tls_in.active.sock >= 0 ? pcrpted:0)];
3837 *smtp_resp = *errmsg = US"235 Authentication succeeded";
3838 authenticated_by = au;
3842 /* Authentication succeeded, but we failed to expand the set_id string.
3843 Treat this as a temporary error. */
3845 auth_defer_msg = expand_string_message;
3849 if (set_id) authenticated_fail_id = string_copy_perm(set_id, TRUE);
3850 *smtp_resp = string_sprintf("435 Unable to authenticate at present%s",
3851 auth_defer_user_msg);
3852 *errmsg = string_sprintf("435 Unable to authenticate at present%s: %s",
3853 set_id, auth_defer_msg);
3857 *smtp_resp = *errmsg = US"501 Invalid base64 data";
3861 *smtp_resp = *errmsg = US"501 Authentication cancelled";
3865 *smtp_resp = *errmsg = US"553 Initial data not expected";
3869 if (set_id) authenticated_fail_id = string_copy_perm(set_id, TRUE);
3870 *smtp_resp = US"535 Incorrect authentication data";
3871 *errmsg = string_sprintf("535 Incorrect authentication data%s", set_id);
3875 if (set_id) authenticated_fail_id = string_copy_perm(set_id, TRUE);
3876 *smtp_resp = US"435 Internal error";
3877 *errmsg = string_sprintf("435 Internal error%s: return %d from authentication "
3878 "check", set_id, rc);
3890 qualify_recipient(uschar ** recipient, uschar * smtp_cmd_data, uschar * tag)
3893 if (f.allow_unqualified_recipient || strcmpic(*recipient, US"postmaster") == 0)
3895 DEBUG(D_receive) debug_printf("unqualified address %s accepted\n",
3897 rd = Ustrlen(recipient) + 1;
3898 /* deconst ok as *recipient was not const */
3899 *recipient = US rewrite_address_qualify(*recipient, TRUE);
3902 smtp_printf("501 %s: recipient address must contain a domain\r\n", FALSE,
3904 log_write(L_smtp_syntax_error,
3905 LOG_MAIN|LOG_REJECT, "unqualified %s rejected: <%s> %s%s",
3906 tag, *recipient, host_and_ident(TRUE), host_lookup_msg);
3914 smtp_quit_handler(uschar ** user_msgp, uschar ** log_msgp)
3917 f.smtp_in_quit = TRUE;
3918 incomplete_transaction_log(US"QUIT");
3920 && acl_check(ACL_WHERE_QUIT, NULL, acl_smtp_quit, user_msgp, log_msgp)
3922 log_write(0, LOG_MAIN|LOG_PANIC, "ACL for QUIT returned ERROR: %s",
3925 #ifdef EXIM_TCP_CORK
3926 (void) setsockopt(fileno(smtp_out), IPPROTO_TCP, EXIM_TCP_CORK, US &on, sizeof(on));
3930 smtp_respond(US"221", 3, TRUE, *user_msgp);
3932 smtp_printf("221 %s closing connection\r\n", FALSE, smtp_active_hostname);
3934 #ifdef SERVERSIDE_CLOSE_NOWAIT
3935 # ifndef DISABLE_TLS
3936 tls_close(NULL, TLS_SHUTDOWN_NOWAIT);
3939 log_write(L_smtp_connection, LOG_MAIN, "%s closed by QUIT",
3940 smtp_get_connection_info());
3943 # ifndef DISABLE_TLS
3944 tls_close(NULL, TLS_SHUTDOWN_WAIT);
3947 log_write(L_smtp_connection, LOG_MAIN, "%s closed by QUIT",
3948 smtp_get_connection_info());
3950 /* Pause, hoping client will FIN first so that they get the TIME_WAIT.
3951 The socket should become readble (though with no data) */
3953 (void) poll_one_fd(fileno(smtp_in), POLLIN, 200);
3954 #endif /*!SERVERSIDE_CLOSE_NOWAIT*/
3959 smtp_rset_handler(void)
3962 incomplete_transaction_log(US"RSET");
3963 smtp_printf("250 Reset OK\r\n", FALSE);
3964 cmd_list[CMD_LIST_RSET].is_mail_cmd = FALSE;
3965 if (chunking_state > CHUNKING_OFFERED)
3966 chunking_state = CHUNKING_OFFERED;
3971 expand_mailmax(const uschar * s)
3973 if (!(s = expand_cstring(s)))
3974 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand smtp_accept_max_per_connection");
3975 return *s ? Uatoi(s) : 0;
3978 /*************************************************
3979 * Initialize for SMTP incoming message *
3980 *************************************************/
3982 /* This function conducts the initial dialogue at the start of an incoming SMTP
3983 message, and builds a list of recipients. However, if the incoming message
3984 is part of a batch (-bS option) a separate function is called since it would
3985 be messy having tests splattered about all over this function. This function
3986 therefore handles the case where interaction is occurring. The input and output
3987 files are set up in smtp_in and smtp_out.
3989 The global recipients_list is set to point to a vector of recipient_item
3990 blocks, whose number is given by recipients_count. This is extended by the
3991 receive_add_recipient() function. The global variable sender_address is set to
3992 the sender's address. The yield is +1 if a message has been successfully
3993 started, 0 if a QUIT command was encountered or the connection was refused from
3994 the particular host, or -1 if the connection was lost.
3998 Returns: > 0 message successfully started (reached DATA)
3999 = 0 QUIT read or end of file reached or call refused
4004 smtp_setup_msg(void)
4007 BOOL toomany = FALSE;
4008 BOOL discarded = FALSE;
4009 BOOL last_was_rej_mail = FALSE;
4010 BOOL last_was_rcpt = FALSE;
4011 rmark reset_point = store_mark();
4013 DEBUG(D_receive) debug_printf("smtp_setup_msg entered\n");
4015 /* Reset for start of new message. We allow one RSET not to be counted as a
4016 nonmail command, for those MTAs that insist on sending it between every
4017 message. Ditto for EHLO/HELO and for STARTTLS, to allow for going in and out of
4018 TLS between messages (an Exim client may do this if it has messages queued up
4019 for the host). Note: we do NOT reset AUTH at this point. */
4021 reset_point = smtp_reset(reset_point);
4022 message_ended = END_NOTSTARTED;
4024 chunking_state = f.chunking_offered ? CHUNKING_OFFERED : CHUNKING_NOT_OFFERED;
4026 cmd_list[CMD_LIST_RSET].is_mail_cmd = TRUE;
4027 cmd_list[CMD_LIST_HELO].is_mail_cmd = TRUE;
4028 cmd_list[CMD_LIST_EHLO].is_mail_cmd = TRUE;
4030 cmd_list[CMD_LIST_STARTTLS].is_mail_cmd = TRUE;
4033 if (lwr_receive_getc != NULL)
4035 /* This should have already happened, but if we've gotten confused,
4036 force a reset here. */
4037 DEBUG(D_receive) debug_printf("WARNING: smtp_setup_msg had to restore receive functions to lowers\n");
4038 bdat_pop_receive_functions();
4041 /* Set the local signal handler for SIGTERM - it tries to end off tidily */
4043 had_command_sigterm = 0;
4044 os_non_restarting_signal(SIGTERM, command_sigterm_handler);
4046 /* Batched SMTP is handled in a different function. */
4048 if (smtp_batched_input) return smtp_setup_batch_msg();
4051 if (smtp_in) /* Avoid pure-ACKs while in cmd pingpong phase */
4052 (void) setsockopt(fileno(smtp_in), IPPROTO_TCP, TCP_QUICKACK,
4053 US &off, sizeof(off));
4056 /* Deal with SMTP commands. This loop is exited by setting done to a POSITIVE
4057 value. The values are 2 larger than the required yield of the function. */
4061 const uschar **argv;
4062 uschar *etrn_command;
4063 uschar *etrn_serialize_key;
4065 uschar *log_msg, *smtp_code;
4066 uschar *user_msg = NULL;
4067 uschar *recipient = NULL;
4068 uschar *hello = NULL;
4070 BOOL was_rej_mail = FALSE;
4071 BOOL was_rcpt = FALSE;
4072 void (*oldsignal)(int);
4074 int start, end, sender_domain, recipient_domain;
4077 uschar *orcpt = NULL;
4082 /* Check once per STARTTLS or SSL-on-connect for a TLS AUTH */
4083 if ( tls_in.active.sock >= 0
4085 && tls_in.certificate_verified
4086 && cmd_list[CMD_LIST_TLS_AUTH].is_mail_cmd
4089 cmd_list[CMD_LIST_TLS_AUTH].is_mail_cmd = FALSE;
4091 for (auth_instance * au = auths; au; au = au->next)
4092 if (strcmpic(US"tls", au->driver_name) == 0)
4095 && (rc = acl_check(ACL_WHERE_AUTH, NULL, acl_smtp_auth,
4096 &user_msg, &log_msg)) != OK
4098 done = smtp_handle_acl_fail(ACL_WHERE_AUTH, rc, user_msg, log_msg);
4101 smtp_cmd_data = NULL;
4103 if (smtp_in_auth(au, &s, &ss) == OK)
4104 { DEBUG(D_auth) debug_printf("tls auth succeeded\n"); }
4107 DEBUG(D_auth) debug_printf("tls auth not succeeded\n");
4108 #ifndef DISABLE_EVENT
4110 uschar * save_name = sender_host_authenticated, * logmsg;
4111 sender_host_authenticated = au->name;
4112 if ((logmsg = event_raise(event_action, US"auth:fail", s, NULL)))
4113 log_write(0, LOG_MAIN, "%s", logmsg);
4114 sender_host_authenticated = save_name;
4124 switch(smtp_read_command(
4125 #ifndef DISABLE_PIPE_CONNECT
4126 !fl.pipe_connect_acceptable,
4130 GETC_BUFFER_UNLIMITED))
4132 /* The AUTH command is not permitted to occur inside a transaction, and may
4133 occur successfully only once per connection. Actually, that isn't quite
4134 true. When TLS is started, all previous information about a connection must
4135 be discarded, so a new AUTH is permitted at that time.
4137 AUTH may only be used when it has been advertised. However, it seems that
4138 there are clients that send AUTH when it hasn't been advertised, some of
4139 them even doing this after HELO. And there are MTAs that accept this. Sigh.
4140 So there's a get-out that allows this to happen.
4142 AUTH is initially labelled as a "nonmail command" so that one occurrence
4143 doesn't get counted. We change the label here so that multiple failing
4144 AUTHS will eventually hit the nonmail threshold. */
4148 authentication_failed = TRUE;
4149 cmd_list[CMD_LIST_AUTH].is_mail_cmd = FALSE;
4151 if (!fl.auth_advertised && !f.allow_auth_unadvertised)
4153 done = synprot_error(L_smtp_protocol_error, 503, NULL,
4154 US"AUTH command used when not advertised");
4157 if (sender_host_authenticated)
4159 done = synprot_error(L_smtp_protocol_error, 503, NULL,
4160 US"already authenticated");
4165 done = synprot_error(L_smtp_protocol_error, 503, NULL,
4166 US"not permitted in mail transaction");
4173 && (rc = acl_check(ACL_WHERE_AUTH, NULL, acl_smtp_auth,
4174 &user_msg, &log_msg)) != OK
4177 done = smtp_handle_acl_fail(ACL_WHERE_AUTH, rc, user_msg, log_msg);
4181 /* Find the name of the requested authentication mechanism. */
4184 for (; (c = *smtp_cmd_data) && !isspace(c); smtp_cmd_data++)
4185 if (!isalnum(c) && c != '-' && c != '_')
4187 done = synprot_error(L_smtp_syntax_error, 501, NULL,
4188 US"invalid character in authentication mechanism name");
4192 /* If not at the end of the line, we must be at white space. Terminate the
4193 name and move the pointer on to any data that may be present. */
4197 *smtp_cmd_data++ = 0;
4198 while (isspace(*smtp_cmd_data)) smtp_cmd_data++;
4201 /* Search for an authentication mechanism which is configured for use
4202 as a server and which has been advertised (unless, sigh, allow_auth_
4203 unadvertised is set). */
4207 uschar * smtp_resp, * errmsg;
4209 for (au = auths; au; au = au->next)
4210 if (strcmpic(s, au->public_name) == 0 && au->server &&
4211 (au->advertised || f.allow_auth_unadvertised))
4216 int rc = smtp_in_auth(au, &smtp_resp, &errmsg);
4218 smtp_printf("%s\r\n", FALSE, smtp_resp);
4221 uschar * logmsg = NULL;
4222 #ifndef DISABLE_EVENT
4223 {uschar * save_name = sender_host_authenticated;
4224 sender_host_authenticated = au->name;
4225 logmsg = event_raise(event_action, US"auth:fail", smtp_resp, NULL);
4226 sender_host_authenticated = save_name;
4230 log_write(0, LOG_MAIN|LOG_REJECT, "%s", logmsg);
4232 log_write(0, LOG_MAIN|LOG_REJECT, "%s authenticator failed for %s: %s",
4233 au->name, host_and_ident(FALSE), errmsg);
4237 done = synprot_error(L_smtp_protocol_error, 504, NULL,
4238 string_sprintf("%s authentication mechanism not supported", s));
4241 break; /* AUTH_CMD */
4243 /* The HELO/EHLO commands are permitted to appear in the middle of a
4244 session as well as at the beginning. They have the effect of a reset in
4245 addition to their other functions. Their absence at the start cannot be
4246 taken to be an error.
4250 If the EHLO command is not acceptable to the SMTP server, 501, 500,
4251 or 502 failure replies MUST be returned as appropriate. The SMTP
4252 server MUST stay in the same state after transmitting these replies
4253 that it was in before the EHLO was received.
4255 Therefore, we do not do the reset until after checking the command for
4256 acceptability. This change was made for Exim release 4.11. Previously
4257 it did the reset first. */
4270 HELO_EHLO: /* Common code for HELO and EHLO */
4271 cmd_list[CMD_LIST_HELO].is_mail_cmd = FALSE;
4272 cmd_list[CMD_LIST_EHLO].is_mail_cmd = FALSE;
4274 /* Reject the HELO if its argument was invalid or non-existent. A
4275 successful check causes the argument to be saved in malloc store. */
4277 if (!check_helo(smtp_cmd_data))
4279 smtp_printf("501 Syntactically invalid %s argument(s)\r\n", FALSE, hello);
4281 log_write(0, LOG_MAIN|LOG_REJECT, "rejected %s from %s: syntactically "
4282 "invalid argument(s): %s", hello, host_and_ident(FALSE),
4283 *smtp_cmd_argument == 0 ? US"(no argument given)" :
4284 string_printing(smtp_cmd_argument));
4286 if (++synprot_error_count > smtp_max_synprot_errors)
4288 log_write(0, LOG_MAIN|LOG_REJECT, "SMTP call from %s dropped: too many "
4289 "syntax or protocol errors (last command was \"%s\", %s)",
4290 host_and_ident(FALSE), string_printing(smtp_cmd_buffer),
4291 string_from_gstring(s_connhad_log(NULL))
4299 /* If sender_host_unknown is true, we have got here via the -bs interface,
4300 not called from inetd. Otherwise, we are running an IP connection and the
4301 host address will be set. If the helo name is the primary name of this
4302 host and we haven't done a reverse lookup, force one now. If helo_verify_required
4303 is set, ensure that the HELO name matches the actual host. If helo_verify
4304 is set, do the same check, but softly. */
4306 if (!f.sender_host_unknown)
4308 BOOL old_helo_verified = f.helo_verified;
4309 uschar *p = smtp_cmd_data;
4311 while (*p != 0 && !isspace(*p)) { *p = tolower(*p); p++; }
4314 /* Force a reverse lookup if HELO quoted something in helo_lookup_domains
4315 because otherwise the log can be confusing. */
4317 if ( !sender_host_name
4318 && match_isinlist(sender_helo_name, CUSS &helo_lookup_domains, 0,
4319 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
4320 (void)host_name_lookup();
4322 /* Rebuild the fullhost info to include the HELO name (and the real name
4323 if it was looked up.) */
4325 host_build_sender_fullhost(); /* Rebuild */
4326 set_process_info("handling%s incoming connection from %s",
4327 tls_in.active.sock >= 0 ? " TLS" : "", host_and_ident(FALSE));
4329 /* Verify if configured. This doesn't give much security, but it does
4330 make some people happy to be able to do it. If helo_verify_required is set,
4331 (host matches helo_verify_hosts) failure forces rejection. If helo_verify
4332 is set (host matches helo_try_verify_hosts), it does not. This is perhaps
4333 now obsolescent, since the verification can now be requested selectively
4336 f.helo_verified = f.helo_verify_failed = sender_helo_dnssec = FALSE;
4337 if (fl.helo_verify_required || fl.helo_verify)
4339 BOOL tempfail = !smtp_verify_helo();
4340 if (!f.helo_verified)
4342 if (fl.helo_verify_required)
4344 smtp_printf("%d %s argument does not match calling host\r\n", FALSE,
4345 tempfail? 451 : 550, hello);
4346 log_write(0, LOG_MAIN|LOG_REJECT, "%srejected \"%s %s\" from %s",
4347 tempfail? "temporarily " : "",
4348 hello, sender_helo_name, host_and_ident(FALSE));
4349 f.helo_verified = old_helo_verified;
4350 break; /* End of HELO/EHLO processing */
4352 HDEBUG(D_all) debug_printf("%s verification failed but host is in "
4353 "helo_try_verify_hosts\n", hello);
4359 /* set up SPF context */
4360 spf_conn_init(sender_helo_name, sender_host_address);
4363 /* Apply an ACL check if one is defined; afterwards, recheck
4364 synchronization in case the client started sending in a delay. */
4367 if ((rc = acl_check(ACL_WHERE_HELO, NULL, acl_smtp_helo,
4368 &user_msg, &log_msg)) != OK)
4370 done = smtp_handle_acl_fail(ACL_WHERE_HELO, rc, user_msg, log_msg);
4371 sender_helo_name = NULL;
4372 host_build_sender_fullhost(); /* Rebuild */
4375 #ifndef DISABLE_PIPE_CONNECT
4376 else if (!fl.pipe_connect_acceptable && !check_sync())
4378 else if (!check_sync())
4382 /* Generate an OK reply. The default string includes the ident if present,
4383 and also the IP address if present. Reflecting back the ident is intended
4384 as a deterrent to mail forgers. For maximum efficiency, and also because
4385 some broken systems expect each response to be in a single packet, arrange
4386 that the entire reply is sent in one write(). */
4388 fl.auth_advertised = FALSE;
4389 f.smtp_in_pipelining_advertised = FALSE;
4391 fl.tls_advertised = FALSE;
4393 fl.dsn_advertised = FALSE;
4395 fl.smtputf8_advertised = FALSE;
4398 /* Expand the per-connection message count limit option */
4399 smtp_mailcmd_max = expand_mailmax(smtp_accept_max_per_connection);
4401 smtp_code = US"250 "; /* Default response code plus space*/
4404 /* sender_host_name below will be tainted, so save on copy when we hit it */
4405 g = string_get_tainted(24, GET_TAINTED);
4406 g = string_fmt_append(g, "%.3s %s Hello %s%s%s",
4408 smtp_active_hostname,
4409 sender_ident ? sender_ident : US"",
4410 sender_ident ? US" at " : US"",
4411 sender_host_name ? sender_host_name : sender_helo_name);
4413 if (sender_host_address)
4414 g = string_fmt_append(g, " [%s]", sender_host_address);
4417 /* A user-supplied EHLO greeting may not contain more than one line. Note
4418 that the code returned by smtp_message_code() includes the terminating
4419 whitespace character. */
4425 smtp_message_code(&smtp_code, &codelen, &user_msg, NULL, TRUE);
4426 s = string_sprintf("%.*s%s", codelen, smtp_code, user_msg);
4427 if ((ss = strpbrk(CS s, "\r\n")) != NULL)
4429 log_write(0, LOG_MAIN|LOG_PANIC, "EHLO/HELO response must not contain "
4430 "newlines: message truncated: %s", string_printing(s));
4433 g = string_cat(NULL, s);
4436 g = string_catn(g, US"\r\n", 2);
4438 /* If we received EHLO, we must create a multiline response which includes
4439 the functions supported. */
4445 /* I'm not entirely happy with this, as an MTA is supposed to check
4446 that it has enough room to accept a message of maximum size before
4447 it sends this. However, there seems little point in not sending it.
4448 The actual size check happens later at MAIL FROM time. By postponing it
4449 till then, VRFY and EXPN can be used after EHLO when space is short. */
4451 if (thismessage_size_limit > 0)
4452 g = string_fmt_append(g, "%.3s-SIZE %d\r\n", smtp_code,
4453 thismessage_size_limit);
4456 g = string_catn(g, smtp_code, 3);
4457 g = string_catn(g, US"-SIZE\r\n", 7);
4460 #ifdef EXPERIMENTAL_ESMTP_LIMITS
4461 if ( (smtp_mailcmd_max > 0 || recipients_max)
4462 && verify_check_host(&limits_advertise_hosts) == OK)
4464 g = string_fmt_append(g, "%.3s-LIMITS", smtp_code);
4465 if (smtp_mailcmd_max > 0)
4466 g = string_fmt_append(g, " MAILMAX=%d", smtp_mailcmd_max);
4468 g = string_fmt_append(g, " RCPTMAX=%d", recipients_max);
4469 g = string_catn(g, US"\r\n", 2);
4473 /* Exim does not do protocol conversion or data conversion. It is 8-bit
4474 clean; if it has an 8-bit character in its hand, it just sends it. It
4475 cannot therefore specify 8BITMIME and remain consistent with the RFCs.
4476 However, some users want this option simply in order to stop MUAs
4477 mangling messages that contain top-bit-set characters. It is therefore
4478 provided as an option. */
4480 if (accept_8bitmime)
4482 g = string_catn(g, smtp_code, 3);
4483 g = string_catn(g, US"-8BITMIME\r\n", 11);
4486 /* Advertise DSN support if configured to do so. */
4487 if (verify_check_host(&dsn_advertise_hosts) != FAIL)
4489 g = string_catn(g, smtp_code, 3);
4490 g = string_catn(g, US"-DSN\r\n", 6);
4491 fl.dsn_advertised = TRUE;
4494 /* Advertise ETRN/VRFY/EXPN if there's are ACL checking whether a host is
4495 permitted to issue them; a check is made when any host actually tries. */
4499 g = string_catn(g, smtp_code, 3);
4500 g = string_catn(g, US"-ETRN\r\n", 7);
4504 g = string_catn(g, smtp_code, 3);
4505 g = string_catn(g, US"-VRFY\r\n", 7);
4509 g = string_catn(g, smtp_code, 3);
4510 g = string_catn(g, US"-EXPN\r\n", 7);
4513 /* Exim is quite happy with pipelining, so let the other end know that
4514 it is safe to use it, unless advertising is disabled. */
4516 if ( f.pipelining_enable
4517 && verify_check_host(&pipelining_advertise_hosts) == OK)
4519 g = string_catn(g, smtp_code, 3);
4520 g = string_catn(g, US"-PIPELINING\r\n", 13);
4521 sync_cmd_limit = NON_SYNC_CMD_PIPELINING;
4522 f.smtp_in_pipelining_advertised = TRUE;
4524 #ifndef DISABLE_PIPE_CONNECT
4525 if (fl.pipe_connect_acceptable)
4527 f.smtp_in_early_pipe_advertised = TRUE;
4528 g = string_catn(g, smtp_code, 3);
4529 g = string_catn(g, US"-" EARLY_PIPE_FEATURE_NAME "\r\n", EARLY_PIPE_FEATURE_LEN+3);
4535 /* If any server authentication mechanisms are configured, advertise
4536 them if the current host is in auth_advertise_hosts. The problem with
4537 advertising always is that some clients then require users to
4538 authenticate (and aren't configurable otherwise) even though it may not
4539 be necessary (e.g. if the host is in host_accept_relay).
4541 RFC 2222 states that SASL mechanism names contain only upper case
4542 letters, so output the names in upper case, though we actually recognize
4543 them in either case in the AUTH command. */
4547 && !sender_host_authenticated
4549 && verify_check_host(&auth_advertise_hosts) == OK
4553 for (auth_instance * au = auths; au; au = au->next)
4555 au->advertised = FALSE;
4558 DEBUG(D_auth+D_expand) debug_printf_indent(
4559 "Evaluating advertise_condition for %s %s athenticator\n",
4560 au->name, au->public_name);
4561 if ( !au->advertise_condition
4562 || expand_check_condition(au->advertise_condition, au->name,
4569 g = string_catn(g, smtp_code, 3);
4570 g = string_catn(g, US"-AUTH", 5);
4572 fl.auth_advertised = TRUE;
4575 g = string_catn(g, US" ", 1);
4576 g = string_cat (g, au->public_name);
4577 while (++saveptr < g->ptr) g->s[saveptr] = toupper(g->s[saveptr]);
4578 au->advertised = TRUE;
4583 if (!first) g = string_catn(g, US"\r\n", 2);
4586 /* RFC 3030 CHUNKING */
4588 if (verify_check_host(&chunking_advertise_hosts) != FAIL)
4590 g = string_catn(g, smtp_code, 3);
4591 g = string_catn(g, US"-CHUNKING\r\n", 11);
4592 f.chunking_offered = TRUE;
4593 chunking_state = CHUNKING_OFFERED;
4596 /* Advertise TLS (Transport Level Security) aka SSL (Secure Socket Layer)
4597 if it has been included in the binary, and the host matches
4598 tls_advertise_hosts. We must *not* advertise if we are already in a
4599 secure connection. */
4602 if (tls_in.active.sock < 0 &&
4603 verify_check_host(&tls_advertise_hosts) != FAIL)
4605 g = string_catn(g, smtp_code, 3);
4606 g = string_catn(g, US"-STARTTLS\r\n", 11);
4607 fl.tls_advertised = TRUE;
4611 #ifndef DISABLE_PRDR
4612 /* Per Recipient Data Response, draft by Eric A. Hall extending RFC */
4615 g = string_catn(g, smtp_code, 3);
4616 g = string_catn(g, US"-PRDR\r\n", 7);
4621 if ( accept_8bitmime
4622 && verify_check_host(&smtputf8_advertise_hosts) != FAIL)
4624 g = string_catn(g, smtp_code, 3);
4625 g = string_catn(g, US"-SMTPUTF8\r\n", 11);
4626 fl.smtputf8_advertised = TRUE;
4630 /* Finish off the multiline reply with one that is always available. */
4632 g = string_catn(g, smtp_code, 3);
4633 g = string_catn(g, US" HELP\r\n", 7);
4636 /* Terminate the string (for debug), write it, and note that HELO/EHLO
4640 if (tls_in.active.sock >= 0)
4641 (void)tls_write(NULL, g->s, g->ptr,
4642 # ifndef DISABLE_PIPE_CONNECT
4643 fl.pipe_connect_acceptable && pipeline_connect_sends());
4649 (void) fwrite(g->s, 1, g->ptr, smtp_out);
4651 DEBUG(D_receive) for (const uschar * t, * s = string_from_gstring(g);
4652 s && (t = Ustrchr(s, '\r'));
4653 s = t + 2) /* \r\n */
4654 debug_printf("%s %.*s\n",
4655 s == g->s ? "SMTP>>" : " ",
4657 fl.helo_seen = TRUE;
4659 /* Reset the protocol and the state, abandoning any previous message. */
4661 (sender_host_address ? protocols : protocols_local)
4663 ? pextend + (sender_host_authenticated ? pauthed : 0)
4665 + (tls_in.active.sock >= 0 ? pcrpted : 0)
4667 cancel_cutthrough_connection(TRUE, US"sent EHLO response");
4668 reset_point = smtp_reset(reset_point);
4670 break; /* HELO/EHLO */
4673 /* The MAIL command requires an address as an operand. All we do
4674 here is to parse it for syntactic correctness. The form "<>" is
4675 a special case which converts into an empty string. The start/end
4676 pointers in the original are not used further for this address, as
4677 it is the canonical extracted address which is all that is kept. */
4681 smtp_mailcmd_count++; /* Count for limit and ratelimit */
4683 was_rej_mail = TRUE; /* Reset if accepted */
4684 env_mail_type_t * mail_args; /* Sanity check & validate args */
4687 if ( fl.helo_verify_required
4688 || verify_check_host(&hosts_require_helo) == OK)
4690 smtp_printf("503 HELO or EHLO required\r\n", FALSE);
4691 log_write(0, LOG_MAIN|LOG_REJECT, "rejected MAIL from %s: no "
4692 "HELO/EHLO given", host_and_ident(FALSE));
4695 else if (smtp_mailcmd_max < 0)
4696 smtp_mailcmd_max = expand_mailmax(smtp_accept_max_per_connection);
4700 done = synprot_error(L_smtp_protocol_error, 503, NULL,
4701 US"sender already given");
4705 if (!*smtp_cmd_data)
4707 done = synprot_error(L_smtp_protocol_error, 501, NULL,
4708 US"MAIL must have an address operand");
4712 /* Check to see if the limit for messages per connection would be
4713 exceeded by accepting further messages. */
4715 if (smtp_mailcmd_max > 0 && smtp_mailcmd_count > smtp_mailcmd_max)
4717 smtp_printf("421 too many messages in this connection\r\n", FALSE);
4718 log_write(0, LOG_MAIN|LOG_REJECT, "rejected MAIL command %s: too many "
4719 "messages in one connection", host_and_ident(TRUE));
4723 /* Reset for start of message - even if this is going to fail, we
4724 obviously need to throw away any previous data. */
4726 cancel_cutthrough_connection(TRUE, US"MAIL received");
4727 reset_point = smtp_reset(reset_point);
4729 sender_data = recipient_data = NULL;
4731 /* Loop, checking for ESMTP additions to the MAIL FROM command. */
4733 if (fl.esmtp) for(;;)
4735 uschar *name, *value, *end;
4736 unsigned long int size;
4737 BOOL arg_error = FALSE;
4739 if (!extract_option(&name, &value)) break;
4741 for (mail_args = env_mail_type_list;
4742 mail_args->value != ENV_MAIL_OPT_NULL;
4745 if (strcmpic(name, mail_args->name) == 0)
4747 if (mail_args->need_value && strcmpic(value, US"") == 0)
4750 switch(mail_args->value)
4752 /* Handle SIZE= by reading the value. We don't do the check till later,
4753 in order to be able to log the sender address on failure. */
4754 case ENV_MAIL_OPT_SIZE:
4755 if (((size = Ustrtoul(value, &end, 10)), *end == 0))
4757 if ((size == ULONG_MAX && errno == ERANGE) || size > INT_MAX)
4759 message_size = (int)size;
4765 /* If this session was initiated with EHLO and accept_8bitmime is set,
4766 Exim will have indicated that it supports the BODY=8BITMIME option. In
4767 fact, it does not support this according to the RFCs, in that it does not
4768 take any special action for forwarding messages containing 8-bit
4769 characters. That is why accept_8bitmime is not the default setting, but
4770 some sites want the action that is provided. We recognize both "8BITMIME"
4771 and "7BIT" as body types, but take no action. */
4772 case ENV_MAIL_OPT_BODY:
4773 if (accept_8bitmime) {
4774 if (strcmpic(value, US"8BITMIME") == 0)
4776 else if (strcmpic(value, US"7BIT") == 0)
4781 done = synprot_error(L_smtp_syntax_error, 501, NULL,
4782 US"invalid data for BODY");
4785 DEBUG(D_receive) debug_printf("8BITMIME: %d\n", body_8bitmime);
4791 /* Handle the two DSN options, but only if configured to do so (which
4792 will have caused "DSN" to be given in the EHLO response). The code itself
4793 is included only if configured in at build time. */
4795 case ENV_MAIL_OPT_RET:
4796 if (fl.dsn_advertised)
4798 /* Check if RET has already been set */
4801 done = synprot_error(L_smtp_syntax_error, 501, NULL,
4802 US"RET can be specified once only");
4805 dsn_ret = strcmpic(value, US"HDRS") == 0
4807 : strcmpic(value, US"FULL") == 0
4810 DEBUG(D_receive) debug_printf("DSN_RET: %d\n", dsn_ret);
4811 /* Check for invalid invalid value, and exit with error */
4814 done = synprot_error(L_smtp_syntax_error, 501, NULL,
4815 US"Value for RET is invalid");
4820 case ENV_MAIL_OPT_ENVID:
4821 if (fl.dsn_advertised)
4823 /* Check if the dsn envid has been already set */
4826 done = synprot_error(L_smtp_syntax_error, 501, NULL,
4827 US"ENVID can be specified once only");
4830 dsn_envid = string_copy(value);
4831 DEBUG(D_receive) debug_printf("DSN_ENVID: %s\n", dsn_envid);
4835 /* Handle the AUTH extension. If the value given is not "<>" and either
4836 the ACL says "yes" or there is no ACL but the sending host is
4837 authenticated, we set it up as the authenticated sender. However, if the
4838 authenticator set a condition to be tested, we ignore AUTH on MAIL unless
4839 the condition is met. The value of AUTH is an xtext, which means that +,
4840 = and cntrl chars are coded in hex; however "<>" is unaffected by this
4842 case ENV_MAIL_OPT_AUTH:
4843 if (Ustrcmp(value, "<>") != 0)
4848 if (auth_xtextdecode(value, &authenticated_sender) < 0)
4850 /* Put back terminator overrides for error message */
4853 done = synprot_error(L_smtp_syntax_error, 501, NULL,
4854 US"invalid data for AUTH");
4857 if (!acl_smtp_mailauth)
4859 ignore_msg = US"client not authenticated";
4860 rc = sender_host_authenticated ? OK : FAIL;
4864 ignore_msg = US"rejected by ACL";
4865 rc = acl_check(ACL_WHERE_MAILAUTH, NULL, acl_smtp_mailauth,
4866 &user_msg, &log_msg);
4872 if (authenticated_by == NULL ||
4873 authenticated_by->mail_auth_condition == NULL ||
4874 expand_check_condition(authenticated_by->mail_auth_condition,
4875 authenticated_by->name, US"authenticator"))
4876 break; /* Accept the AUTH */
4878 ignore_msg = US"server_mail_auth_condition failed";
4879 if (authenticated_id != NULL)
4880 ignore_msg = string_sprintf("%s: authenticated ID=\"%s\"",
4881 ignore_msg, authenticated_id);
4886 authenticated_sender = NULL;
4887 log_write(0, LOG_MAIN, "ignoring AUTH=%s from %s (%s)",
4888 value, host_and_ident(TRUE), ignore_msg);
4891 /* Should only get DEFER or ERROR here. Put back terminator
4892 overrides for error message */
4897 (void)smtp_handle_acl_fail(ACL_WHERE_MAILAUTH, rc, user_msg,
4904 #ifndef DISABLE_PRDR
4905 case ENV_MAIL_OPT_PRDR:
4907 prdr_requested = TRUE;
4912 case ENV_MAIL_OPT_UTF8:
4913 if (!fl.smtputf8_advertised)
4915 done = synprot_error(L_smtp_syntax_error, 501, NULL,
4916 US"SMTPUTF8 used when not advertised");
4920 DEBUG(D_receive) debug_printf("smtputf8 requested\n");
4921 message_smtputf8 = allow_utf8_domains = TRUE;
4922 if (Ustrncmp(received_protocol, US"utf8", 4) != 0)
4924 int old_pool = store_pool;
4925 store_pool = POOL_PERM;
4926 received_protocol = string_sprintf("utf8%s", received_protocol);
4927 store_pool = old_pool;
4932 /* No valid option. Stick back the terminator characters and break
4933 the loop. Do the name-terminator second as extract_option sets
4934 value==name when it found no equal-sign.
4935 An error for a malformed address will occur. */
4936 case ENV_MAIL_OPT_NULL:
4944 /* Break out of for loop if switch() had bad argument or
4945 when start of the email address is reached */
4946 if (arg_error) break;
4949 /* If we have passed the threshold for rate limiting, apply the current
4950 delay, and update it for next time, provided this is a limited host. */
4952 if (smtp_mailcmd_count > smtp_rlm_threshold &&
4953 verify_check_host(&smtp_ratelimit_hosts) == OK)
4955 DEBUG(D_receive) debug_printf("rate limit MAIL: delay %.3g sec\n",
4956 smtp_delay_mail/1000.0);
4957 millisleep((int)smtp_delay_mail);
4958 smtp_delay_mail *= smtp_rlm_factor;
4959 if (smtp_delay_mail > (double)smtp_rlm_limit)
4960 smtp_delay_mail = (double)smtp_rlm_limit;
4963 /* Now extract the address, first applying any SMTP-time rewriting. The
4964 TRUE flag allows "<>" as a sender address. */
4966 raw_sender = rewrite_existflags & rewrite_smtp
4967 /* deconst ok as smtp_cmd_data was not const */
4968 ? US rewrite_one(smtp_cmd_data, rewrite_smtp, NULL, FALSE, US"",
4969 global_rewrite_rules)
4973 parse_extract_address(raw_sender, &errmess, &start, &end, &sender_domain,
4978 done = synprot_error(L_smtp_syntax_error, 501, smtp_cmd_data, errmess);
4982 sender_address = raw_sender;
4984 /* If there is a configured size limit for mail, check that this message
4985 doesn't exceed it. The check is postponed to this point so that the sender
4988 if (thismessage_size_limit > 0 && message_size > thismessage_size_limit)
4990 smtp_printf("552 Message size exceeds maximum permitted\r\n", FALSE);
4991 log_write(L_size_reject,
4992 LOG_MAIN|LOG_REJECT, "rejected MAIL FROM:<%s> %s: "
4993 "message too big: size%s=%d max=%d",
4995 host_and_ident(TRUE),
4996 (message_size == INT_MAX)? ">" : "",
4998 thismessage_size_limit);
4999 sender_address = NULL;
5003 /* Check there is enough space on the disk unless configured not to.
5004 When smtp_check_spool_space is set, the check is for thismessage_size_limit
5005 plus the current message - i.e. we accept the message only if it won't
5006 reduce the space below the threshold. Add 5000 to the size to allow for
5007 overheads such as the Received: line and storing of recipients, etc.
5008 By putting the check here, even when SIZE is not given, it allow VRFY
5009 and EXPN etc. to be used when space is short. */
5011 if (!receive_check_fs(
5012 smtp_check_spool_space && message_size >= 0
5013 ? message_size + 5000 : 0))
5015 smtp_printf("452 Space shortage, please try later\r\n", FALSE);
5016 sender_address = NULL;
5020 /* If sender_address is unqualified, reject it, unless this is a locally
5021 generated message, or the sending host or net is permitted to send
5022 unqualified addresses - typically local machines behaving as MUAs -
5023 in which case just qualify the address. The flag is set above at the start
5024 of the SMTP connection. */
5026 if (!sender_domain && *sender_address)
5027 if (f.allow_unqualified_sender)
5029 sender_domain = Ustrlen(sender_address) + 1;
5030 /* deconst ok as sender_address was not const */
5031 sender_address = US rewrite_address_qualify(sender_address, FALSE);
5032 DEBUG(D_receive) debug_printf("unqualified address %s accepted\n",
5037 smtp_printf("501 %s: sender address must contain a domain\r\n", FALSE,
5039 log_write(L_smtp_syntax_error,
5040 LOG_MAIN|LOG_REJECT,
5041 "unqualified sender rejected: <%s> %s%s",
5043 host_and_ident(TRUE),
5045 sender_address = NULL;
5049 /* Apply an ACL check if one is defined, before responding. Afterwards,
5050 when pipelining is not advertised, do another sync check in case the ACL
5051 delayed and the client started sending in the meantime. */
5055 rc = acl_check(ACL_WHERE_MAIL, NULL, acl_smtp_mail, &user_msg, &log_msg);
5056 if (rc == OK && !f.smtp_in_pipelining_advertised && !check_sync())
5062 if (rc == OK || rc == DISCARD)
5064 BOOL more = pipeline_response();
5067 smtp_printf("%s%s%s", more, US"250 OK",
5068 #ifndef DISABLE_PRDR
5069 prdr_requested ? US", PRDR Requested" : US"",
5076 #ifndef DISABLE_PRDR
5078 user_msg = string_sprintf("%s%s", user_msg, US", PRDR Requested");
5080 smtp_user_msg(US"250", user_msg);
5082 smtp_delay_rcpt = smtp_rlr_base;
5083 f.recipients_discarded = (rc == DISCARD);
5084 was_rej_mail = FALSE;
5088 done = smtp_handle_acl_fail(ACL_WHERE_MAIL, rc, user_msg, log_msg);
5089 sender_address = NULL;
5094 /* The RCPT command requires an address as an operand. There may be any
5095 number of RCPT commands, specifying multiple recipients. We build them all
5096 into a data structure. The start/end values given by parse_extract_address
5097 are not used, as we keep only the extracted address. */
5101 /* We got really to many recipients. A check against configured
5102 limits is done later */
5103 if (rcpt_count < 0 || rcpt_count >= INT_MAX/2)
5104 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Too many recipients: %d", rcpt_count);
5106 was_rcpt = fl.rcpt_in_progress = TRUE;
5108 /* There must be a sender address; if the sender was rejected and
5109 pipelining was advertised, we assume the client was pipelining, and do not
5110 count this as a protocol error. Reset was_rej_mail so that further RCPTs
5111 get the same treatment. */
5113 if (!sender_address)
5115 if (f.smtp_in_pipelining_advertised && last_was_rej_mail)
5117 smtp_printf("503 sender not yet given\r\n", FALSE);
5118 was_rej_mail = TRUE;
5122 done = synprot_error(L_smtp_protocol_error, 503, NULL,
5123 US"sender not yet given");
5124 was_rcpt = FALSE; /* Not a valid RCPT */
5130 /* Check for an operand */
5132 if (!smtp_cmd_data[0])
5134 done = synprot_error(L_smtp_syntax_error, 501, NULL,
5135 US"RCPT must have an address operand");
5140 /* Set the DSN flags orcpt and dsn_flags from the session*/
5144 if (fl.esmtp) for(;;)
5146 uschar *name, *value;
5148 if (!extract_option(&name, &value))
5151 if (fl.dsn_advertised && strcmpic(name, US"ORCPT") == 0)
5153 /* Check whether orcpt has been already set */
5156 done = synprot_error(L_smtp_syntax_error, 501, NULL,
5157 US"ORCPT can be specified once only");
5160 orcpt = string_copy(value);
5161 DEBUG(D_receive) debug_printf("DSN orcpt: %s\n", orcpt);
5164 else if (fl.dsn_advertised && strcmpic(name, US"NOTIFY") == 0)
5166 /* Check if the notify flags have been already set */
5169 done = synprot_error(L_smtp_syntax_error, 501, NULL,
5170 US"NOTIFY can be specified once only");
5173 if (strcmpic(value, US"NEVER") == 0)
5174 dsn_flags |= rf_notify_never;
5181 while (*pp != 0 && *pp != ',') pp++;
5182 if (*pp == ',') *pp++ = 0;
5183 if (strcmpic(p, US"SUCCESS") == 0)
5185 DEBUG(D_receive) debug_printf("DSN: Setting notify success\n");
5186 dsn_flags |= rf_notify_success;
5188 else if (strcmpic(p, US"FAILURE") == 0)
5190 DEBUG(D_receive) debug_printf("DSN: Setting notify failure\n");
5191 dsn_flags |= rf_notify_failure;
5193 else if (strcmpic(p, US"DELAY") == 0)
5195 DEBUG(D_receive) debug_printf("DSN: Setting notify delay\n");
5196 dsn_flags |= rf_notify_delay;
5200 /* Catch any strange values */
5201 done = synprot_error(L_smtp_syntax_error, 501, NULL,
5202 US"Invalid value for NOTIFY parameter");
5207 DEBUG(D_receive) debug_printf("DSN Flags: %x\n", dsn_flags);
5211 /* Unknown option. Stick back the terminator characters and break
5212 the loop. An error for a malformed address will occur. */
5216 DEBUG(D_receive) debug_printf("Invalid RCPT option: %s : %s\n", name, value);
5223 /* Apply SMTP rewriting then extract the working address. Don't allow "<>"
5224 as a recipient address */
5226 recipient = rewrite_existflags & rewrite_smtp
5227 /* deconst ok as smtp_cmd_data was not const */
5228 ? US rewrite_one(smtp_cmd_data, rewrite_smtp, NULL, FALSE, US"",
5229 global_rewrite_rules)
5232 if (!(recipient = parse_extract_address(recipient, &errmess, &start, &end,
5233 &recipient_domain, FALSE)))
5235 done = synprot_error(L_smtp_syntax_error, 501, smtp_cmd_data, errmess);
5240 /* If the recipient address is unqualified, reject it, unless this is a
5241 locally generated message. However, unqualified addresses are permitted
5242 from a configured list of hosts and nets - typically when behaving as
5243 MUAs rather than MTAs. Sad that SMTP is used for both types of traffic,
5244 really. The flag is set at the start of the SMTP connection.
5246 RFC 1123 talks about supporting "the reserved mailbox postmaster"; I always
5247 assumed this meant "reserved local part", but the revision of RFC 821 and
5248 friends now makes it absolutely clear that it means *mailbox*. Consequently
5249 we must always qualify this address, regardless. */
5251 if (!recipient_domain)
5252 if (!(recipient_domain = qualify_recipient(&recipient, smtp_cmd_data,
5259 /* Check maximum allowed */
5261 if (rcpt_count+1 < 0 || rcpt_count > recipients_max && recipients_max > 0)
5263 if (recipients_max_reject)
5266 smtp_printf("552 too many recipients\r\n", FALSE);
5268 log_write(0, LOG_MAIN|LOG_REJECT, "too many recipients: message "
5269 "rejected: sender=<%s> %s", sender_address, host_and_ident(TRUE));
5274 smtp_printf("452 too many recipients\r\n", FALSE);
5276 log_write(0, LOG_MAIN|LOG_REJECT, "too many recipients: excess "
5277 "temporarily rejected: sender=<%s> %s", sender_address,
5278 host_and_ident(TRUE));
5285 /* If we have passed the threshold for rate limiting, apply the current
5286 delay, and update it for next time, provided this is a limited host. */
5288 if (rcpt_count > smtp_rlr_threshold &&
5289 verify_check_host(&smtp_ratelimit_hosts) == OK)
5291 DEBUG(D_receive) debug_printf("rate limit RCPT: delay %.3g sec\n",
5292 smtp_delay_rcpt/1000.0);
5293 millisleep((int)smtp_delay_rcpt);
5294 smtp_delay_rcpt *= smtp_rlr_factor;
5295 if (smtp_delay_rcpt > (double)smtp_rlr_limit)
5296 smtp_delay_rcpt = (double)smtp_rlr_limit;
5299 /* If the MAIL ACL discarded all the recipients, we bypass ACL checking
5300 for them. Otherwise, check the access control list for this recipient. As
5301 there may be a delay in this, re-check for a synchronization error
5302 afterwards, unless pipelining was advertised. */
5304 if (f.recipients_discarded)
5307 if ( (rc = acl_check(ACL_WHERE_RCPT, recipient, acl_smtp_rcpt, &user_msg,
5309 && !f.smtp_in_pipelining_advertised && !check_sync())
5312 /* The ACL was happy */
5316 BOOL more = pipeline_response();
5319 smtp_user_msg(US"250", user_msg);
5321 smtp_printf("250 Accepted\r\n", more);
5322 receive_add_recipient(recipient, -1);
5324 /* Set the dsn flags in the recipients_list */
5325 recipients_list[recipients_count-1].orcpt = orcpt;
5326 recipients_list[recipients_count-1].dsn_flags = dsn_flags;
5328 /* DEBUG(D_receive) debug_printf("DSN: orcpt: %s flags: %d\n",
5329 recipients_list[recipients_count-1].orcpt,
5330 recipients_list[recipients_count-1].dsn_flags); */
5333 /* The recipient was discarded */
5335 else if (rc == DISCARD)
5338 smtp_user_msg(US"250", user_msg);
5340 smtp_printf("250 Accepted\r\n", FALSE);
5343 log_write(0, LOG_MAIN|LOG_REJECT, "%s F=<%s> RCPT %s: "
5344 "discarded by %s ACL%s%s", host_and_ident(TRUE),
5345 sender_address_unrewritten ? sender_address_unrewritten : sender_address,
5346 smtp_cmd_argument, f.recipients_discarded ? "MAIL" : "RCPT",
5347 log_msg ? US": " : US"", log_msg ? log_msg : US"");
5350 /* Either the ACL failed the address, or it was deferred. */
5354 if (rc == FAIL) rcpt_fail_count++; else rcpt_defer_count++;
5355 done = smtp_handle_acl_fail(ACL_WHERE_RCPT, rc, user_msg, log_msg);
5360 /* The DATA command is legal only if it follows successful MAIL FROM
5361 and RCPT TO commands. However, if pipelining is advertised, a bad DATA is
5362 not counted as a protocol error if it follows RCPT (which must have been
5363 rejected if there are no recipients.) This function is complete when a
5364 valid DATA command is encountered.
5366 Note concerning the code used: RFC 2821 says this:
5368 - If there was no MAIL, or no RCPT, command, or all such commands
5369 were rejected, the server MAY return a "command out of sequence"
5370 (503) or "no valid recipients" (554) reply in response to the
5373 The example in the pipelining RFC 2920 uses 554, but I use 503 here
5374 because it is the same whether pipelining is in use or not.
5376 If all the RCPT commands that precede DATA provoked the same error message
5377 (often indicating some kind of system error), it is helpful to include it
5378 with the DATA rejection (an idea suggested by Tony Finch). */
5385 if (chunking_state != CHUNKING_OFFERED)
5387 done = synprot_error(L_smtp_protocol_error, 503, NULL,
5388 US"BDAT command used when CHUNKING not advertised");
5392 /* grab size, endmarker */
5394 if (sscanf(CS smtp_cmd_data, "%u %n", &chunking_datasize, &n) < 1)
5396 done = synprot_error(L_smtp_protocol_error, 501, NULL,
5397 US"missing size for BDAT command");
5400 chunking_state = strcmpic(smtp_cmd_data+n, US"LAST") == 0
5401 ? CHUNKING_LAST : CHUNKING_ACTIVE;
5402 chunking_data_left = chunking_datasize;
5403 DEBUG(D_receive) debug_printf("chunking state %d, %d bytes\n",
5404 (int)chunking_state, chunking_data_left);
5406 f.bdat_readers_wanted = TRUE; /* FIXME: redundant vs chunking_state? */
5415 f.bdat_readers_wanted = FALSE;
5417 DATA_BDAT: /* Common code for DATA and BDAT */
5418 #ifndef DISABLE_PIPE_CONNECT
5419 fl.pipe_connect_acceptable = FALSE;
5421 if (!discarded && recipients_count <= 0)
5423 if (fl.rcpt_smtp_response_same && rcpt_smtp_response)
5425 uschar *code = US"503";
5426 int len = Ustrlen(rcpt_smtp_response);
5427 smtp_respond(code, 3, FALSE, US"All RCPT commands were rejected with "
5429 /* Responses from smtp_printf() will have \r\n on the end */
5430 if (len > 2 && rcpt_smtp_response[len-2] == '\r')
5431 rcpt_smtp_response[len-2] = 0;
5432 smtp_respond(code, 3, FALSE, rcpt_smtp_response);
5434 if (f.smtp_in_pipelining_advertised && last_was_rcpt)
5435 smtp_printf("503 Valid RCPT command must precede %s\r\n", FALSE,
5436 smtp_names[smtp_connection_had[SMTP_HBUFF_PREV(smtp_ch_index)]]);
5438 done = synprot_error(L_smtp_protocol_error, 503, NULL,
5439 smtp_connection_had[SMTP_HBUFF_PREV(smtp_ch_index)] == SCH_DATA
5440 ? US"valid RCPT command must precede DATA"
5441 : US"valid RCPT command must precede BDAT");
5443 if (chunking_state > CHUNKING_OFFERED)
5445 bdat_push_receive_functions();
5451 if (toomany && recipients_max_reject)
5453 sender_address = NULL; /* This will allow a new MAIL without RSET */
5454 sender_address_unrewritten = NULL;
5455 smtp_printf("554 Too many recipients\r\n", FALSE);
5457 if (chunking_state > CHUNKING_OFFERED)
5459 bdat_push_receive_functions();
5465 if (chunking_state > CHUNKING_OFFERED)
5466 rc = OK; /* No predata ACL or go-ahead output for BDAT */
5469 /* If there is an ACL, re-check the synchronization afterwards, since the
5470 ACL may have delayed. To handle cutthrough delivery enforce a dummy call
5471 to get the DATA command sent. */
5473 if (!acl_smtp_predata && cutthrough.cctx.sock < 0)
5477 uschar * acl = acl_smtp_predata ? acl_smtp_predata : US"accept";
5478 f.enable_dollar_recipients = TRUE;
5479 rc = acl_check(ACL_WHERE_PREDATA, NULL, acl, &user_msg,
5481 f.enable_dollar_recipients = FALSE;
5482 if (rc == OK && !check_sync())
5486 { /* Either the ACL failed the address, or it was deferred. */
5487 done = smtp_handle_acl_fail(ACL_WHERE_PREDATA, rc, user_msg, log_msg);
5493 smtp_user_msg(US"354", user_msg);
5496 "354 Enter message, ending with \".\" on a line by itself\r\n", FALSE);
5499 if (f.bdat_readers_wanted)
5500 bdat_push_receive_functions();
5503 if (smtp_in) /* all ACKs needed to ramp window up for bulk data */
5504 (void) setsockopt(fileno(smtp_in), IPPROTO_TCP, TCP_QUICKACK,
5505 US &on, sizeof(on));
5508 message_ended = END_NOTENDED; /* Indicate in middle of data */
5519 if (!(address = parse_extract_address(smtp_cmd_data, &errmess,
5520 &start, &end, &recipient_domain, FALSE)))
5522 smtp_printf("501 %s\r\n", FALSE, errmess);
5526 if (!recipient_domain)
5527 if (!(recipient_domain = qualify_recipient(&address, smtp_cmd_data,
5531 if ((rc = acl_check(ACL_WHERE_VRFY, address, acl_smtp_vrfy,
5532 &user_msg, &log_msg)) != OK)
5533 done = smtp_handle_acl_fail(ACL_WHERE_VRFY, rc, user_msg, log_msg);
5537 address_item * addr = deliver_make_addr(address, FALSE);
5539 switch(verify_address(addr, NULL, vopt_is_recipient | vopt_qualify, -1,
5540 -1, -1, NULL, NULL, NULL))
5543 s = string_sprintf("250 <%s> is deliverable", address);
5547 s = (addr->user_message != NULL)?
5548 string_sprintf("451 <%s> %s", address, addr->user_message) :
5549 string_sprintf("451 Cannot resolve <%s> at this time", address);
5553 s = (addr->user_message != NULL)?
5554 string_sprintf("550 <%s> %s", address, addr->user_message) :
5555 string_sprintf("550 <%s> is not deliverable", address);
5556 log_write(0, LOG_MAIN, "VRFY failed for %s %s",
5557 smtp_cmd_argument, host_and_ident(TRUE));
5561 smtp_printf("%s\r\n", FALSE, s);
5569 rc = acl_check(ACL_WHERE_EXPN, NULL, acl_smtp_expn, &user_msg, &log_msg);
5571 done = smtp_handle_acl_fail(ACL_WHERE_EXPN, rc, user_msg, log_msg);
5574 BOOL save_log_testing_mode = f.log_testing_mode;
5575 f.address_test_mode = f.log_testing_mode = TRUE;
5576 (void) verify_address(deliver_make_addr(smtp_cmd_data, FALSE),
5577 smtp_out, vopt_is_recipient | vopt_qualify | vopt_expn, -1, -1, -1,
5579 f.address_test_mode = FALSE;
5580 f.log_testing_mode = save_log_testing_mode; /* true for -bh */
5589 if (!fl.tls_advertised)
5591 done = synprot_error(L_smtp_protocol_error, 503, NULL,
5592 US"STARTTLS command used when not advertised");
5596 /* Apply an ACL check if one is defined */
5598 if ( acl_smtp_starttls
5599 && (rc = acl_check(ACL_WHERE_STARTTLS, NULL, acl_smtp_starttls,
5600 &user_msg, &log_msg)) != OK
5603 done = smtp_handle_acl_fail(ACL_WHERE_STARTTLS, rc, user_msg, log_msg);
5607 /* RFC 2487 is not clear on when this command may be sent, though it
5608 does state that all information previously obtained from the client
5609 must be discarded if a TLS session is started. It seems reasonable to
5610 do an implied RSET when STARTTLS is received. */
5612 incomplete_transaction_log(US"STARTTLS");
5613 cancel_cutthrough_connection(TRUE, US"STARTTLS received");
5614 reset_point = smtp_reset(reset_point);
5616 cmd_list[CMD_LIST_STARTTLS].is_mail_cmd = FALSE;
5618 /* There's an attack where more data is read in past the STARTTLS command
5619 before TLS is negotiated, then assumed to be part of the secure session
5620 when used afterwards; we use segregated input buffers, so are not
5621 vulnerable, but we want to note when it happens and, for sheer paranoia,
5622 ensure that the buffer is "wiped".
5623 Pipelining sync checks will normally have protected us too, unless disabled
5624 by configuration. */
5629 debug_printf("Non-empty input buffer after STARTTLS; naive attack?\n");
5630 if (tls_in.active.sock < 0)
5631 smtp_inend = smtp_inptr = smtp_inbuffer;
5632 /* and if TLS is already active, tls_server_start() should fail */
5635 /* There is nothing we value in the input buffer and if TLS is successfully
5636 negotiated, we won't use this buffer again; if TLS fails, we'll just read
5637 fresh content into it. The buffer contains arbitrary content from an
5638 untrusted remote source; eg: NOOP <shellcode>\r\nSTARTTLS\r\n
5639 It seems safest to just wipe away the content rather than leave it as a
5640 target to jump to. */
5642 memset(smtp_inbuffer, 0, IN_BUFFER_SIZE);
5644 /* Attempt to start up a TLS session, and if successful, discard all
5645 knowledge that was obtained previously. At least, that's what the RFC says,
5646 and that's what happens by default. However, in order to work round YAEB,
5647 there is an option to remember the esmtp state. Sigh.
5649 We must allow for an extra EHLO command and an extra AUTH command after
5650 STARTTLS that don't add to the nonmail command count. */
5653 if ((rc = tls_server_start(&s)) == OK)
5655 if (!tls_remember_esmtp)
5656 fl.helo_seen = fl.esmtp = fl.auth_advertised = f.smtp_in_pipelining_advertised = FALSE;
5657 cmd_list[CMD_LIST_EHLO].is_mail_cmd = TRUE;
5658 cmd_list[CMD_LIST_AUTH].is_mail_cmd = TRUE;
5659 cmd_list[CMD_LIST_TLS_AUTH].is_mail_cmd = TRUE;
5660 if (sender_helo_name)
5662 sender_helo_name = NULL;
5663 host_build_sender_fullhost(); /* Rebuild */
5664 set_process_info("handling incoming TLS connection from %s",
5665 host_and_ident(FALSE));
5668 (sender_host_address ? protocols : protocols_local)
5670 ? pextend + (sender_host_authenticated ? pauthed : 0)
5672 + (tls_in.active.sock >= 0 ? pcrpted : 0)
5675 sender_host_auth_pubname = sender_host_authenticated = NULL;
5676 authenticated_id = NULL;
5677 sync_cmd_limit = NON_SYNC_CMD_NON_PIPELINING;
5678 DEBUG(D_tls) debug_printf("TLS active\n");
5679 break; /* Successful STARTTLS */
5682 (void) smtp_log_tls_fail(s);
5684 /* Some local configuration problem was discovered before actually trying
5685 to do a TLS handshake; give a temporary error. */
5689 smtp_printf("454 TLS currently unavailable\r\n", FALSE);
5693 /* Hard failure. Reject everything except QUIT or closed connection. One
5694 cause for failure is a nested STARTTLS, in which case tls_in.active remains
5695 set, but we must still reject all incoming commands. Another is a handshake
5696 failure - and there may some encrypted data still in the pipe to us, which we
5697 see as garbage commands. */
5699 DEBUG(D_tls) debug_printf("TLS failed to start\n");
5700 while (done <= 0) switch(smtp_read_command(FALSE, GETC_BUFFER_UNLIMITED))
5703 log_write(L_smtp_connection, LOG_MAIN, "%s closed by EOF",
5704 smtp_get_connection_info());
5705 smtp_notquit_exit(US"tls-failed", NULL, NULL);
5709 /* It is perhaps arguable as to which exit ACL should be called here,
5710 but as it is probably a situation that almost never arises, it
5711 probably doesn't matter. We choose to call the real QUIT ACL, which in
5712 some sense is perhaps "right". */
5715 f.smtp_in_quit = TRUE;
5718 && ((rc = acl_check(ACL_WHERE_QUIT, NULL, acl_smtp_quit, &user_msg,
5719 &log_msg)) == ERROR))
5720 log_write(0, LOG_MAIN|LOG_PANIC, "ACL for QUIT returned ERROR: %s",
5723 smtp_respond(US"221", 3, TRUE, user_msg);
5725 smtp_printf("221 %s closing connection\r\n", FALSE, smtp_active_hostname);
5726 log_write(L_smtp_connection, LOG_MAIN, "%s closed by QUIT",
5727 smtp_get_connection_info());
5732 smtp_printf("554 Security failure\r\n", FALSE);
5735 tls_close(NULL, TLS_SHUTDOWN_NOWAIT);
5740 /* The ACL for QUIT is provided for gathering statistical information or
5741 similar; it does not affect the response code, but it can supply a custom
5745 smtp_quit_handler(&user_msg, &log_msg);
5751 smtp_rset_handler();
5752 cancel_cutthrough_connection(TRUE, US"RSET received");
5753 reset_point = smtp_reset(reset_point);
5760 smtp_printf("250 OK\r\n", FALSE);
5764 /* Show ETRN/EXPN/VRFY if there's an ACL for checking hosts; if actually
5765 used, a check will be done for permitted hosts. Show STARTTLS only if not
5766 already in a TLS session and if it would be advertised in the EHLO
5771 smtp_printf("214-Commands supported:\r\n", TRUE);
5775 Ustrcat(buffer, US" AUTH");
5777 if (tls_in.active.sock < 0 &&
5778 verify_check_host(&tls_advertise_hosts) != FAIL)
5779 Ustrcat(buffer, US" STARTTLS");
5781 Ustrcat(buffer, US" HELO EHLO MAIL RCPT DATA BDAT");
5782 Ustrcat(buffer, US" NOOP QUIT RSET HELP");
5783 if (acl_smtp_etrn) Ustrcat(buffer, US" ETRN");
5784 if (acl_smtp_expn) Ustrcat(buffer, US" EXPN");
5785 if (acl_smtp_vrfy) Ustrcat(buffer, US" VRFY");
5786 smtp_printf("214%s\r\n", FALSE, buffer);
5792 incomplete_transaction_log(US"connection lost");
5793 smtp_notquit_exit(US"connection-lost", US"421",
5794 US"%s lost input connection", smtp_active_hostname);
5796 /* Don't log by default unless in the middle of a message, as some mailers
5797 just drop the call rather than sending QUIT, and it clutters up the logs.
5800 if (sender_address || recipients_count > 0)
5801 log_write(L_lost_incoming_connection, LOG_MAIN,
5802 "unexpected %s while reading SMTP command from %s%s%s D=%s",
5803 f.sender_host_unknown ? "EOF" : "disconnection",
5804 f.tcp_in_fastopen_logged
5807 ? f.tcp_in_fastopen_data ? US"TFO* " : US"TFO "
5809 host_and_ident(FALSE), smtp_read_error,
5810 string_timesince(&smtp_connection_start)
5814 log_write(L_smtp_connection, LOG_MAIN, "%s %slost%s D=%s",
5815 smtp_get_connection_info(),
5816 f.tcp_in_fastopen && !f.tcp_in_fastopen_logged ? US"TFO " : US"",
5818 string_timesince(&smtp_connection_start)
5829 done = synprot_error(L_smtp_protocol_error, 503, NULL,
5830 US"ETRN is not permitted inside a transaction");
5834 log_write(L_etrn, LOG_MAIN, "ETRN %s received from %s", smtp_cmd_argument,
5835 host_and_ident(FALSE));
5837 if ((rc = acl_check(ACL_WHERE_ETRN, NULL, acl_smtp_etrn,
5838 &user_msg, &log_msg)) != OK)
5840 done = smtp_handle_acl_fail(ACL_WHERE_ETRN, rc, user_msg, log_msg);
5844 /* Compute the serialization key for this command. */
5846 etrn_serialize_key = string_sprintf("etrn-%s\n", smtp_cmd_data);
5848 /* If a command has been specified for running as a result of ETRN, we
5849 permit any argument to ETRN. If not, only the # standard form is permitted,
5850 since that is strictly the only kind of ETRN that can be implemented
5851 according to the RFC. */
5853 if (smtp_etrn_command)
5857 etrn_command = smtp_etrn_command;
5858 deliver_domain = smtp_cmd_data;
5859 rc = transport_set_up_command(&argv, smtp_etrn_command, TRUE, 0, NULL,
5860 FALSE, US"ETRN processing", &error);
5861 deliver_domain = NULL;
5864 log_write(0, LOG_MAIN|LOG_PANIC, "failed to set up ETRN command: %s",
5866 smtp_printf("458 Internal failure\r\n", FALSE);
5871 /* Else set up to call Exim with the -R option. */
5875 if (*smtp_cmd_data++ != '#')
5877 done = synprot_error(L_smtp_syntax_error, 501, NULL,
5878 US"argument must begin with #");
5881 etrn_command = US"exim -R";
5882 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, NULL, TRUE,
5883 *queue_name ? 4 : 2,
5884 US"-R", smtp_cmd_data,
5885 US"-MCG", queue_name);
5888 /* If we are host-testing, don't actually do anything. */
5894 debug_printf("ETRN command is: %s\n", etrn_command);
5895 debug_printf("ETRN command execution skipped\n");
5897 if (user_msg == NULL) smtp_printf("250 OK\r\n", FALSE);
5898 else smtp_user_msg(US"250", user_msg);
5903 /* If ETRN queue runs are to be serialized, check the database to
5904 ensure one isn't already running. */
5906 if (smtp_etrn_serialize && !enq_start(etrn_serialize_key, 1))
5908 smtp_printf("458 Already processing %s\r\n", FALSE, smtp_cmd_data);
5912 /* Fork a child process and run the command. We don't want to have to
5913 wait for the process at any point, so set SIGCHLD to SIG_IGN before
5914 forking. It should be set that way anyway for external incoming SMTP,
5915 but we save and restore to be tidy. If serialization is required, we
5916 actually run the command in yet another process, so we can wait for it
5917 to complete and then remove the serialization lock. */
5919 oldsignal = signal(SIGCHLD, SIG_IGN);
5921 if ((pid = exim_fork(US"etrn-command")) == 0)
5923 smtp_input = FALSE; /* This process is not associated with the */
5924 (void)fclose(smtp_in); /* SMTP call any more. */
5925 (void)fclose(smtp_out);
5927 signal(SIGCHLD, SIG_DFL); /* Want to catch child */
5929 /* If not serializing, do the exec right away. Otherwise, fork down
5930 into another process. */
5932 if ( !smtp_etrn_serialize
5933 || (pid = exim_fork(US"etrn-serialised-command")) == 0)
5935 DEBUG(D_exec) debug_print_argv(argv);
5936 exim_nullstd(); /* Ensure std{in,out,err} exist */
5937 /* argv[0] should be untainted, from child_exec_exim() */
5938 execv(CS argv[0], (char *const *)argv);
5939 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "exec of \"%s\" (ETRN) failed: %s",
5940 etrn_command, strerror(errno));
5941 _exit(EXIT_FAILURE); /* paranoia */
5944 /* Obey this if smtp_serialize and the 2nd fork yielded non-zero. That
5945 is, we are in the first subprocess, after forking again. All we can do
5946 for a failing fork is to log it. Otherwise, wait for the 2nd process to
5947 complete, before removing the serialization. */
5950 log_write(0, LOG_MAIN|LOG_PANIC, "2nd fork for serialized ETRN "
5951 "failed: %s", strerror(errno));
5955 DEBUG(D_any) debug_printf("waiting for serialized ETRN process %d\n",
5957 (void)wait(&status);
5958 DEBUG(D_any) debug_printf("serialized ETRN process %d ended\n",
5962 enq_end(etrn_serialize_key);
5963 exim_underbar_exit(EXIT_SUCCESS);
5966 /* Back in the top level SMTP process. Check that we started a subprocess
5967 and restore the signal state. */
5971 log_write(0, LOG_MAIN|LOG_PANIC, "fork of process for ETRN failed: %s",
5973 smtp_printf("458 Unable to fork process\r\n", FALSE);
5974 if (smtp_etrn_serialize) enq_end(etrn_serialize_key);
5978 smtp_printf("250 OK\r\n", FALSE);
5980 smtp_user_msg(US"250", user_msg);
5982 signal(SIGCHLD, oldsignal);
5987 done = synprot_error(L_smtp_syntax_error, 501, NULL,
5988 US"unexpected argument data");
5992 /* This currently happens only for NULLs, but could be extended. */
5995 done = synprot_error(L_smtp_syntax_error, 0, NULL, /* Just logs */
5996 US"NUL character(s) present (shown as '?')");
5997 smtp_printf("501 NUL characters are not allowed in SMTP commands\r\n",
6004 if (smtp_inend >= smtp_inbuffer + IN_BUFFER_SIZE)
6005 smtp_inend = smtp_inbuffer + IN_BUFFER_SIZE - 1;
6006 c = smtp_inend - smtp_inptr;
6007 if (c > 150) c = 150; /* limit logged amount */
6009 incomplete_transaction_log(US"sync failure");
6010 log_write(0, LOG_MAIN|LOG_REJECT, "SMTP protocol synchronization error "
6011 "(next input sent too soon: pipelining was%s advertised): "
6012 "rejected \"%s\" %s next input=\"%s\"",
6013 f.smtp_in_pipelining_advertised ? "" : " not",
6014 smtp_cmd_buffer, host_and_ident(TRUE),
6015 string_printing(smtp_inptr));
6016 smtp_notquit_exit(US"synchronization-error", US"554",
6017 US"SMTP synchronization error");
6018 done = 1; /* Pretend eof - drops connection */
6022 case TOO_MANY_NONMAIL_CMD:
6023 s = smtp_cmd_buffer;
6024 while (*s != 0 && !isspace(*s)) s++;
6025 incomplete_transaction_log(US"too many non-mail commands");
6026 log_write(0, LOG_MAIN|LOG_REJECT, "SMTP call from %s dropped: too many "
6027 "nonmail commands (last was \"%.*s\")", host_and_ident(FALSE),
6028 (int)(s - smtp_cmd_buffer), smtp_cmd_buffer);
6029 smtp_notquit_exit(US"bad-commands", US"554", US"Too many nonmail commands");
6030 done = 1; /* Pretend eof - drops connection */
6033 #ifdef SUPPORT_PROXY
6034 case PROXY_FAIL_IGNORE_CMD:
6035 smtp_printf("503 Command refused, required Proxy negotiation failed\r\n", FALSE);
6040 if (unknown_command_count++ >= smtp_max_unknown_commands)
6042 log_write(L_smtp_syntax_error, LOG_MAIN,
6043 "SMTP syntax error in \"%s\" %s %s",
6044 string_printing(smtp_cmd_buffer), host_and_ident(TRUE),
6045 US"unrecognized command");
6046 incomplete_transaction_log(US"unrecognized command");
6047 smtp_notquit_exit(US"bad-commands", US"500",
6048 US"Too many unrecognized commands");
6050 log_write(0, LOG_MAIN|LOG_REJECT, "SMTP call from %s dropped: too many "
6051 "unrecognized commands (last was \"%s\")", host_and_ident(FALSE),
6052 string_printing(smtp_cmd_buffer));
6055 done = synprot_error(L_smtp_syntax_error, 500, NULL,
6056 US"unrecognized command");
6060 /* This label is used by goto's inside loops that want to break out to
6061 the end of the command-processing loop. */
6064 last_was_rej_mail = was_rej_mail; /* Remember some last commands for */
6065 last_was_rcpt = was_rcpt; /* protocol error handling */
6068 return done - 2; /* Convert yield values */
6074 authres_smtpauth(gstring * g)
6076 if (!sender_host_authenticated)
6079 g = string_append(g, 2, US";\n\tauth=pass (", sender_host_auth_pubname);
6081 if (Ustrcmp(sender_host_auth_pubname, "tls") == 0)
6082 g = authenticated_id
6083 ? string_append(g, 2, US") x509.auth=", authenticated_id)
6084 : string_cat(g, US") reason=x509.auth");
6086 g = authenticated_id
6087 ? string_append(g, 2, US") smtp.auth=", authenticated_id)
6088 : string_cat(g, US", no id saved)");
6090 if (authenticated_sender)
6091 g = string_append(g, 2, US" smtp.mailfrom=", authenticated_sender);
6099 /* End of smtp_in.c */