1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Functions for handling an incoming SMTP call. */
15 /* Initialize for TCP wrappers if so configured. It appears that the macro
16 HAVE_IPV6 is used in some versions of the tcpd.h header, so we unset it before
17 including that header, and restore its value afterwards. */
19 #ifdef USE_TCP_WRAPPERS
22 #define EXIM_HAVE_IPV6
28 #define HAVE_IPV6 TRUE
31 int allow_severity
= LOG_INFO
;
32 int deny_severity
= LOG_NOTICE
;
33 uschar
*tcp_wrappers_name
;
37 /* Size of buffer for reading SMTP commands. We used to use 512, as defined
38 by RFC 821. However, RFC 1869 specifies that this must be increased for SMTP
39 commands that accept arguments, and this in particular applies to AUTH, where
40 the data can be quite long. More recently this value was 2048 in Exim;
41 however, RFC 4954 (circa 2007) recommends 12288 bytes to handle AUTH. Clients
42 such as Thunderbird will send an AUTH with an initial-response for GSSAPI.
43 The maximum size of a Kerberos ticket under Windows 2003 is 12000 bytes, and
44 we need room to handle large base64-encoded AUTHs for GSSAPI.
47 #define SMTP_CMD_BUFFER_SIZE 16384
49 /* Size of buffer for reading SMTP incoming packets */
51 #define IN_BUFFER_SIZE 8192
53 /* Structure for SMTP command list */
60 short int is_mail_cmd
;
63 /* Codes for identifying commands. We order them so that those that come first
64 are those for which synchronization is always required. Checking this can help
68 /* These commands are required to be synchronized, i.e. to be the last in a
69 block of commands when pipelining. */
71 HELO_CMD
, EHLO_CMD
, DATA_CMD
, /* These are listed in the pipelining */
72 VRFY_CMD
, EXPN_CMD
, NOOP_CMD
, /* RFC as requiring synchronization */
73 ETRN_CMD
, /* This by analogy with TURN from the RFC */
74 STARTTLS_CMD
, /* Required by the STARTTLS RFC */
75 TLS_AUTH_CMD
, /* auto-command at start of SSL */
77 /* This is a dummy to identify the non-sync commands when pipelining */
79 NON_SYNC_CMD_PIPELINING
,
81 /* These commands need not be synchronized when pipelining */
83 MAIL_CMD
, RCPT_CMD
, RSET_CMD
,
85 /* This is a dummy to identify the non-sync commands when not pipelining */
87 NON_SYNC_CMD_NON_PIPELINING
,
89 /* RFC3030 section 2: "After all MAIL and RCPT responses are collected and
90 processed the message is sent using a series of BDAT commands"
91 implies that BDAT should be synchronized. However, we see Google, at least,
92 sending MAIL,RCPT,BDAT-LAST in a single packet, clearly not waiting for
93 processing of the RCPT response(s). We shall do the same, and not require
94 synch for BDAT. Worse, as the chunk may (very likely will) follow the
95 command-header in the same packet we cannot do the usual "is there any
96 follow-on data after the command line" even for non-pipeline mode.
97 So we'll need an explicit check after reading the expected chunk amount
98 when non-pipe, before sending the ACK. */
102 /* I have been unable to find a statement about the use of pipelining
103 with AUTH, so to be on the safe side it is here, though I kind of feel
104 it should be up there with the synchronized commands. */
108 /* I'm not sure about these, but I don't think they matter. */
113 PROXY_FAIL_IGNORE_CMD
,
116 /* These are specials that don't correspond to actual commands */
118 EOF_CMD
, OTHER_CMD
, BADARG_CMD
, BADCHAR_CMD
, BADSYN_CMD
,
119 TOO_MANY_NONMAIL_CMD
};
122 /* This is a convenience macro for adding the identity of an SMTP command
123 to the circular buffer that holds a list of the last n received. */
126 smtp_connection_had[smtp_ch_index++] = n; \
127 if (smtp_ch_index >= SMTP_HBUFF_SIZE) smtp_ch_index = 0
130 /*************************************************
131 * Local static variables *
132 *************************************************/
135 BOOL auth_advertised
:1;
137 BOOL tls_advertised
:1;
139 BOOL dsn_advertised
:1;
141 BOOL helo_required
:1;
144 BOOL helo_accept_junk
:1;
145 #ifndef DISABLE_PIPE_CONNECT
146 BOOL pipe_connect_acceptable
:1;
148 BOOL rcpt_smtp_response_same
:1;
149 BOOL rcpt_in_progress
:1;
150 BOOL smtp_exit_function_called
:1;
152 BOOL smtputf8_advertised
:1;
155 .helo_required
= FALSE
,
156 .helo_verify
= FALSE
,
157 .smtp_exit_function_called
= FALSE
,
160 static auth_instance
*authenticated_by
;
161 static int count_nonmail
;
162 static int nonmail_command_count
;
163 static int synprot_error_count
;
164 static int unknown_command_count
;
165 static int sync_cmd_limit
;
166 static int smtp_write_error
= 0;
168 static uschar
*rcpt_smtp_response
;
169 static uschar
*smtp_data_buffer
;
170 static uschar
*smtp_cmd_data
;
172 /* We need to know the position of RSET, HELO, EHLO, AUTH, and STARTTLS. Their
173 final fields of all except AUTH are forced TRUE at the start of a new message
174 setup, to allow one of each between messages that is not counted as a nonmail
175 command. (In fact, only one of HELO/EHLO is not counted.) Also, we have to
176 allow a new EHLO after starting up TLS.
178 AUTH is "falsely" labelled as a mail command initially, so that it doesn't get
179 counted. However, the flag is changed when AUTH is received, so that multiple
180 failing AUTHs will eventually hit the limit. After a successful AUTH, another
181 AUTH is already forbidden. After a TLS session is started, AUTH's flag is again
182 forced TRUE, to allow for the re-authentication that can happen at that point.
184 QUIT is also "falsely" labelled as a mail command so that it doesn't up the
185 count of non-mail commands and possibly provoke an error.
187 tls_auth is a pseudo-command, never expected in input. It is activated
188 on TLS startup and looks for a tls authenticator. */
190 static smtp_cmd_list cmd_list
[] = {
191 /* name len cmd has_arg is_mail_cmd */
193 { "rset", sizeof("rset")-1, RSET_CMD
, FALSE
, FALSE
}, /* First */
194 { "helo", sizeof("helo")-1, HELO_CMD
, TRUE
, FALSE
},
195 { "ehlo", sizeof("ehlo")-1, EHLO_CMD
, TRUE
, FALSE
},
196 { "auth", sizeof("auth")-1, AUTH_CMD
, TRUE
, TRUE
},
198 { "starttls", sizeof("starttls")-1, STARTTLS_CMD
, FALSE
, FALSE
},
199 { "tls_auth", 0, TLS_AUTH_CMD
, FALSE
, FALSE
},
202 /* If you change anything above here, also fix the definitions below. */
204 { "mail from:", sizeof("mail from:")-1, MAIL_CMD
, TRUE
, TRUE
},
205 { "rcpt to:", sizeof("rcpt to:")-1, RCPT_CMD
, TRUE
, TRUE
},
206 { "data", sizeof("data")-1, DATA_CMD
, FALSE
, TRUE
},
207 { "bdat", sizeof("bdat")-1, BDAT_CMD
, TRUE
, TRUE
},
208 { "quit", sizeof("quit")-1, QUIT_CMD
, FALSE
, TRUE
},
209 { "noop", sizeof("noop")-1, NOOP_CMD
, TRUE
, FALSE
},
210 { "etrn", sizeof("etrn")-1, ETRN_CMD
, TRUE
, FALSE
},
211 { "vrfy", sizeof("vrfy")-1, VRFY_CMD
, TRUE
, FALSE
},
212 { "expn", sizeof("expn")-1, EXPN_CMD
, TRUE
, FALSE
},
213 { "help", sizeof("help")-1, HELP_CMD
, TRUE
, FALSE
}
216 static smtp_cmd_list
*cmd_list_end
=
217 cmd_list
+ sizeof(cmd_list
)/sizeof(smtp_cmd_list
);
219 #define CMD_LIST_RSET 0
220 #define CMD_LIST_HELO 1
221 #define CMD_LIST_EHLO 2
222 #define CMD_LIST_AUTH 3
223 #define CMD_LIST_STARTTLS 4
224 #define CMD_LIST_TLS_AUTH 5
226 /* This list of names is used for performing the smtp_no_mail logging action.
227 It must be kept in step with the SCH_xxx enumerations. */
229 static uschar
*smtp_names
[] =
231 US
"NONE", US
"AUTH", US
"DATA", US
"BDAT", US
"EHLO", US
"ETRN", US
"EXPN",
232 US
"HELO", US
"HELP", US
"MAIL", US
"NOOP", US
"QUIT", US
"RCPT", US
"RSET",
233 US
"STARTTLS", US
"VRFY" };
235 static uschar
*protocols_local
[] = {
236 US
"local-smtp", /* HELO */
237 US
"local-smtps", /* The rare case EHLO->STARTTLS->HELO */
238 US
"local-esmtp", /* EHLO */
239 US
"local-esmtps", /* EHLO->STARTTLS->EHLO */
240 US
"local-esmtpa", /* EHLO->AUTH */
241 US
"local-esmtpsa" /* EHLO->STARTTLS->EHLO->AUTH */
243 static uschar
*protocols
[] = {
245 US
"smtps", /* The rare case EHLO->STARTTLS->HELO */
246 US
"esmtp", /* EHLO */
247 US
"esmtps", /* EHLO->STARTTLS->EHLO */
248 US
"esmtpa", /* EHLO->AUTH */
249 US
"esmtpsa" /* EHLO->STARTTLS->EHLO->AUTH */
254 #define pcrpted 1 /* added to pextend or pnormal */
255 #define pauthed 2 /* added to pextend */
257 /* Sanity check and validate optional args to MAIL FROM: envelope */
260 ENV_MAIL_OPT_SIZE
, ENV_MAIL_OPT_BODY
, ENV_MAIL_OPT_AUTH
,
264 ENV_MAIL_OPT_RET
, ENV_MAIL_OPT_ENVID
,
270 uschar
* name
; /* option requested during MAIL cmd */
271 int value
; /* enum type */
272 BOOL need_value
; /* TRUE requires value (name=value pair format)
273 FALSE is a singleton */
275 static env_mail_type_t env_mail_type_list
[] = {
276 { US
"SIZE", ENV_MAIL_OPT_SIZE
, TRUE
},
277 { US
"BODY", ENV_MAIL_OPT_BODY
, TRUE
},
278 { US
"AUTH", ENV_MAIL_OPT_AUTH
, TRUE
},
280 { US
"PRDR", ENV_MAIL_OPT_PRDR
, FALSE
},
282 { US
"RET", ENV_MAIL_OPT_RET
, TRUE
},
283 { US
"ENVID", ENV_MAIL_OPT_ENVID
, TRUE
},
285 { US
"SMTPUTF8",ENV_MAIL_OPT_UTF8
, FALSE
}, /* rfc6531 */
287 /* keep this the last entry */
288 { US
"NULL", ENV_MAIL_OPT_NULL
, FALSE
},
291 /* When reading SMTP from a remote host, we have to use our own versions of the
292 C input-reading functions, in order to be able to flush the SMTP output only
293 when about to read more data from the socket. This is the only way to get
294 optimal performance when the client is using pipelining. Flushing for every
295 command causes a separate packet and reply packet each time; saving all the
296 responses up (when pipelining) combines them into one packet and one response.
298 For simplicity, these functions are used for *all* SMTP input, not only when
299 receiving over a socket. However, after setting up a secure socket (SSL), input
300 is read via the OpenSSL library, and another set of functions is used instead
303 These functions are set in the receive_getc etc. variables and called with the
304 same interface as the C functions. However, since there can only ever be
305 one incoming SMTP call, we just use a single buffer and flags. There is no need
306 to implement a complicated private FILE-like structure.*/
308 static uschar
*smtp_inbuffer
;
309 static uschar
*smtp_inptr
;
310 static uschar
*smtp_inend
;
311 static int smtp_had_eof
;
312 static int smtp_had_error
;
315 /* forward declarations */
316 static int smtp_read_command(BOOL check_sync
, unsigned buffer_lim
);
317 static int synprot_error(int type
, int code
, uschar
*data
, uschar
*errmess
);
318 static void smtp_quit_handler(uschar
**, uschar
**);
319 static void smtp_rset_handler(void);
321 /*************************************************
322 * Recheck synchronization *
323 *************************************************/
325 /* Synchronization checks can never be perfect because a packet may be on its
326 way but not arrived when the check is done. Normally, the checks happen when
327 commands are read: Exim ensures that there is no more input in the input buffer.
328 In normal cases, the response to the command will be fast, and there is no
331 However, for some commands an ACL is run, and that can include delays. In those
332 cases, it is useful to do another check on the input just before sending the
333 response. This also applies at the start of a connection. This function does
334 that check by means of the select() function, as long as the facility is not
335 disabled or inappropriate. A failure of select() is ignored.
337 When there is unwanted input, we read it so that it appears in the log of the
341 Returns: TRUE if all is well; FALSE if there is input pending
345 wouldblock_reading(void)
349 struct timeval tzero
;
352 if (tls_in
.active
.sock
>= 0)
353 return !tls_could_read();
356 if (smtp_inptr
< smtp_inend
)
359 fd
= fileno(smtp_in
);
364 rc
= select(fd
+ 1, (SELECT_ARG2_TYPE
*)&fds
, NULL
, NULL
, &tzero
);
366 if (rc
<= 0) return TRUE
; /* Not ready to read */
367 rc
= smtp_getc(GETC_BUFFER_UNLIMITED
);
368 if (rc
< 0) return TRUE
; /* End of file or error */
377 if (!smtp_enforce_sync
|| !sender_host_address
|| f
.sender_host_notsocket
)
380 return wouldblock_reading();
384 /* If there's input waiting (and we're doing pipelineing) then we can pipeline
385 a reponse with the one following. */
388 pipeline_response(void)
390 if ( !smtp_enforce_sync
|| !sender_host_address
391 || f
.sender_host_notsocket
|| !f
.smtp_in_pipelining_advertised
)
394 if (wouldblock_reading()) return FALSE
;
395 f
.smtp_in_pipelining_used
= TRUE
;
400 #ifndef DISABLE_PIPE_CONNECT
402 pipeline_connect_sends(void)
404 if (!sender_host_address
|| f
.sender_host_notsocket
|| !fl
.pipe_connect_acceptable
)
407 if (wouldblock_reading()) return FALSE
;
408 f
.smtp_in_early_pipe_used
= TRUE
;
413 /*************************************************
414 * Log incomplete transactions *
415 *************************************************/
417 /* This function is called after a transaction has been aborted by RSET, QUIT,
418 connection drops or other errors. It logs the envelope information received
419 so far in order to preserve address verification attempts.
421 Argument: string to indicate what aborted the transaction
426 incomplete_transaction_log(uschar
*what
)
428 if (!sender_address
/* No transaction in progress */
429 || !LOGGING(smtp_incomplete_transaction
))
432 /* Build list of recipients for logging */
434 if (recipients_count
> 0)
436 raw_recipients
= store_get(recipients_count
* sizeof(uschar
*), FALSE
);
437 for (int i
= 0; i
< recipients_count
; i
++)
438 raw_recipients
[i
] = recipients_list
[i
].address
;
439 raw_recipients_count
= recipients_count
;
442 log_write(L_smtp_incomplete_transaction
, LOG_MAIN
|LOG_SENDER
|LOG_RECIPIENTS
,
443 "%s incomplete transaction (%s)", host_and_ident(TRUE
), what
);
450 smtp_command_timeout_exit(void)
452 log_write(L_lost_incoming_connection
,
453 LOG_MAIN
, "SMTP command timeout on%s connection from %s",
454 tls_in
.active
.sock
>= 0 ? " TLS" : "", host_and_ident(FALSE
));
455 if (smtp_batched_input
)
456 moan_smtp_batch(NULL
, "421 SMTP command timeout"); /* Does not return */
457 smtp_notquit_exit(US
"command-timeout", US
"421",
458 US
"%s: SMTP command timeout - closing connection",
459 smtp_active_hostname
);
460 exim_exit(EXIT_FAILURE
, US
"receiving");
464 smtp_command_sigterm_exit(void)
466 log_write(0, LOG_MAIN
, "%s closed after SIGTERM", smtp_get_connection_info());
467 if (smtp_batched_input
)
468 moan_smtp_batch(NULL
, "421 SIGTERM received"); /* Does not return */
469 smtp_notquit_exit(US
"signal-exit", US
"421",
470 US
"%s: Service not available - closing connection", smtp_active_hostname
);
471 exim_exit(EXIT_FAILURE
, US
"receiving");
475 smtp_data_timeout_exit(void)
477 log_write(L_lost_incoming_connection
,
478 LOG_MAIN
, "SMTP data timeout (message abandoned) on connection from %s F=<%s>",
479 sender_fullhost
? sender_fullhost
: US
"local process", sender_address
);
480 receive_bomb_out(US
"data-timeout", US
"SMTP incoming data timeout");
481 /* Does not return */
485 smtp_data_sigint_exit(void)
487 log_write(0, LOG_MAIN
, "%s closed after %s",
488 smtp_get_connection_info(), had_data_sigint
== SIGTERM
? "SIGTERM":"SIGINT");
489 receive_bomb_out(US
"signal-exit",
490 US
"Service not available - SIGTERM or SIGINT received");
491 /* Does not return */
496 /* Refill the buffer, and notify DKIM verification code.
497 Return false for error or EOF.
501 smtp_refill(unsigned lim
)
504 if (!smtp_out
) return FALSE
;
506 if (smtp_receive_timeout
> 0) ALARM(smtp_receive_timeout
);
508 /* Limit amount read, so non-message data is not fed to DKIM.
509 Take care to not touch the safety NUL at the end of the buffer. */
511 rc
= read(fileno(smtp_in
), smtp_inbuffer
, MIN(IN_BUFFER_SIZE
-1, lim
));
513 if (smtp_receive_timeout
> 0) ALARM_CLR(0);
516 /* Must put the error text in fixed store, because this might be during
517 header reading, where it releases unused store above the header. */
520 if (had_command_timeout
) /* set by signal handler */
521 smtp_command_timeout_exit(); /* does not return */
522 if (had_command_sigterm
)
523 smtp_command_sigterm_exit();
524 if (had_data_timeout
)
525 smtp_data_timeout_exit();
527 smtp_data_sigint_exit();
529 smtp_had_error
= save_errno
;
530 smtp_read_error
= string_copy_perm(
531 string_sprintf(" (error: %s)", strerror(save_errno
)), FALSE
);
538 dkim_exim_verify_feed(smtp_inbuffer
, rc
);
540 smtp_inend
= smtp_inbuffer
+ rc
;
541 smtp_inptr
= smtp_inbuffer
;
545 /*************************************************
546 * SMTP version of getc() *
547 *************************************************/
549 /* This gets the next byte from the SMTP input buffer. If the buffer is empty,
550 it flushes the output, and refills the buffer, with a timeout. The signal
551 handler is set appropriately by the calling function. This function is not used
552 after a connection has negotiated itself into an TLS/SSL state.
554 Arguments: lim Maximum amount to read/buffer
555 Returns: the next character or EOF
559 smtp_getc(unsigned lim
)
561 if (smtp_inptr
>= smtp_inend
)
562 if (!smtp_refill(lim
))
564 return *smtp_inptr
++;
568 smtp_getbuf(unsigned * len
)
573 if (smtp_inptr
>= smtp_inend
)
574 if (!smtp_refill(*len
))
575 { *len
= 0; return NULL
; }
577 if ((size
= smtp_inend
- smtp_inptr
) > *len
) size
= *len
;
588 int n
= smtp_inend
- smtp_inptr
;
590 dkim_exim_verify_feed(smtp_inptr
, n
);
595 /* Get a byte from the smtp input, in CHUNKING mode. Handle ack of the
596 previous BDAT chunk and getting new ones when we run out. Uses the
597 underlying smtp_getc or tls_getc both for that and for getting the
598 (buffered) data byte. EOD signals (an expected) no further data.
599 ERR signals a protocol error, and EOF a closed input stream.
601 Called from read_bdat_smtp() in receive.c for the message body, but also
602 by the headers read loop in receive_msg(); manipulates chunking_state
603 to handle the BDAT command/response.
604 Placed here due to the correlation with the above smtp_getc(), which it wraps,
605 and also by the need to do smtp command/response handling.
607 Arguments: lim (ignored)
608 Returns: the next character or ERR, EOD or EOF
612 bdat_getc(unsigned lim
)
614 uschar
* user_msg
= NULL
;
623 if (chunking_data_left
> 0)
624 return lwr_receive_getc(chunking_data_left
--);
626 receive_getc
= lwr_receive_getc
;
627 receive_getbuf
= lwr_receive_getbuf
;
628 receive_ungetc
= lwr_receive_ungetc
;
630 dkim_save
= dkim_collect_input
;
631 dkim_collect_input
= 0;
634 /* Unless PIPELINING was offered, there should be no next command
635 until after we ack that chunk */
637 if (!f
.smtp_in_pipelining_advertised
&& !check_sync())
639 unsigned n
= smtp_inend
- smtp_inptr
;
642 incomplete_transaction_log(US
"sync failure");
643 log_write(0, LOG_MAIN
|LOG_REJECT
, "SMTP protocol synchronization error "
644 "(next input sent too soon: pipelining was not advertised): "
645 "rejected \"%s\" %s next input=\"%s\"%s",
646 smtp_cmd_buffer
, host_and_ident(TRUE
),
647 string_printing(string_copyn(smtp_inptr
, n
)),
648 smtp_inend
- smtp_inptr
> n
? "..." : "");
649 (void) synprot_error(L_smtp_protocol_error
, 554, NULL
,
650 US
"SMTP synchronization error");
651 goto repeat_until_rset
;
654 /* If not the last, ack the received chunk. The last response is delayed
655 until after the data ACL decides on it */
657 if (chunking_state
== CHUNKING_LAST
)
660 dkim_exim_verify_feed(NULL
, 0); /* notify EOD */
665 smtp_printf("250 %u byte chunk received\r\n", FALSE
, chunking_datasize
);
666 chunking_state
= CHUNKING_OFFERED
;
667 DEBUG(D_receive
) debug_printf("chunking state %d\n", (int)chunking_state
);
669 /* Expect another BDAT cmd from input. RFC 3030 says nothing about
670 QUIT, RSET or NOOP but handling them seems obvious */
673 switch(smtp_read_command(TRUE
, 1))
676 (void) synprot_error(L_smtp_protocol_error
, 503, NULL
,
677 US
"only BDAT permissible after non-LAST BDAT");
680 switch(smtp_read_command(TRUE
, 1))
682 case QUIT_CMD
: smtp_quit_handler(&user_msg
, &log_msg
); /*FALLTHROUGH */
683 case EOF_CMD
: return EOF
;
684 case RSET_CMD
: smtp_rset_handler(); return ERR
;
685 default: if (synprot_error(L_smtp_protocol_error
, 503, NULL
,
686 US
"only RSET accepted now") > 0)
688 goto repeat_until_rset
;
692 smtp_quit_handler(&user_msg
, &log_msg
);
703 smtp_printf("250 OK\r\n", FALSE
);
710 if (sscanf(CS smtp_cmd_data
, "%u %n", &chunking_datasize
, &n
) < 1)
712 (void) synprot_error(L_smtp_protocol_error
, 501, NULL
,
713 US
"missing size for BDAT command");
716 chunking_state
= strcmpic(smtp_cmd_data
+n
, US
"LAST") == 0
717 ? CHUNKING_LAST
: CHUNKING_ACTIVE
;
718 chunking_data_left
= chunking_datasize
;
719 DEBUG(D_receive
) debug_printf("chunking state %d, %d bytes\n",
720 (int)chunking_state
, chunking_data_left
);
722 if (chunking_datasize
== 0)
723 if (chunking_state
== CHUNKING_LAST
)
727 (void) synprot_error(L_smtp_protocol_error
, 504, NULL
,
728 US
"zero size for BDAT command");
729 goto repeat_until_rset
;
732 receive_getc
= bdat_getc
;
733 receive_getbuf
= bdat_getbuf
; /* r~getbuf is never actually used */
734 receive_ungetc
= bdat_ungetc
;
736 dkim_collect_input
= dkim_save
;
738 break; /* to top of main loop */
745 bdat_getbuf(unsigned * len
)
749 if (chunking_data_left
<= 0)
750 { *len
= 0; return NULL
; }
752 if (*len
> chunking_data_left
) *len
= chunking_data_left
;
753 buf
= lwr_receive_getbuf(len
); /* Either smtp_getbuf or tls_getbuf */
754 chunking_data_left
-= *len
;
759 bdat_flush_data(void)
761 while (chunking_data_left
)
763 unsigned n
= chunking_data_left
;
764 if (!bdat_getbuf(&n
)) break;
767 receive_getc
= lwr_receive_getc
;
768 receive_getbuf
= lwr_receive_getbuf
;
769 receive_ungetc
= lwr_receive_ungetc
;
771 if (chunking_state
!= CHUNKING_LAST
)
773 chunking_state
= CHUNKING_OFFERED
;
774 DEBUG(D_receive
) debug_printf("chunking state %d\n", (int)chunking_state
);
781 /*************************************************
782 * SMTP version of ungetc() *
783 *************************************************/
785 /* Puts a character back in the input buffer. Only ever
791 Returns: the character
805 chunking_data_left
++;
806 return lwr_receive_ungetc(ch
);
811 /*************************************************
812 * SMTP version of feof() *
813 *************************************************/
815 /* Tests for a previous EOF
818 Returns: non-zero if the eof flag is set
830 /*************************************************
831 * SMTP version of ferror() *
832 *************************************************/
834 /* Tests for a previous read error, and returns with errno
835 restored to what it was when the error was detected.
838 Returns: non-zero if the error flag is set
844 errno
= smtp_had_error
;
845 return smtp_had_error
;
850 /*************************************************
851 * Test for characters in the SMTP buffer *
852 *************************************************/
854 /* Used at the end of a message
863 return smtp_inptr
< smtp_inend
;
868 /*************************************************
869 * Write formatted string to SMTP channel *
870 *************************************************/
872 /* This is a separate function so that we don't have to repeat everything for
873 TLS support or debugging. It is global so that the daemon and the
874 authentication functions can use it. It does not return any error indication,
875 because major problems such as dropped connections won't show up till an output
876 flush for non-TLS connections. The smtp_fflush() function is available for
877 checking that: for convenience, TLS output errors are remembered here so that
878 they are also picked up later by smtp_fflush().
882 more further data expected
883 ... optional arguments
889 smtp_printf(const char *format
, BOOL more
, ...)
894 smtp_vprintf(format
, more
, ap
);
898 /* This is split off so that verify.c:respond_printf() can, in effect, call
899 smtp_printf(), bearing in mind that in C a vararg function can't directly
900 call another vararg function, only a function which accepts a va_list. */
901 /*XXX consider passing caller-info in, for string_vformat-onward */
904 smtp_vprintf(const char *format
, BOOL more
, va_list ap
)
906 gstring gs
= { .size
= big_buffer_size
, .ptr
= 0, .s
= big_buffer
};
909 /* Use taint-unchecked routines for writing into big_buffer, trusting
910 that we'll never expand it. */
912 yield
= !! string_vformat(&gs
, SVFMT_TAINT_NOCHK
, format
, ap
);
913 string_from_gstring(&gs
);
917 uschar
*msg_copy
, *cr
, *end
;
918 msg_copy
= string_copy(gs
.s
);
919 end
= msg_copy
+ gs
.ptr
;
920 while ((cr
= Ustrchr(msg_copy
, '\r')) != NULL
) /* lose CRs */
921 memmove(cr
, cr
+ 1, (end
--) - cr
);
922 debug_printf("SMTP>> %s", msg_copy
);
927 log_write(0, LOG_MAIN
|LOG_PANIC
, "string too large in smtp_printf()");
928 smtp_closedown(US
"Unexpected error");
929 exim_exit(EXIT_FAILURE
, NULL
);
932 /* If this is the first output for a (non-batch) RCPT command, see if all RCPTs
933 have had the same. Note: this code is also present in smtp_respond(). It would
934 be tidier to have it only in one place, but when it was added, it was easier to
935 do it that way, so as not to have to mess with the code for the RCPT command,
936 which sometimes uses smtp_printf() and sometimes smtp_respond(). */
938 if (fl
.rcpt_in_progress
)
940 if (rcpt_smtp_response
== NULL
)
941 rcpt_smtp_response
= string_copy(big_buffer
);
942 else if (fl
.rcpt_smtp_response_same
&&
943 Ustrcmp(rcpt_smtp_response
, big_buffer
) != 0)
944 fl
.rcpt_smtp_response_same
= FALSE
;
945 fl
.rcpt_in_progress
= FALSE
;
948 /* Now write the string */
951 if (tls_in
.active
.sock
>= 0)
953 if (tls_write(NULL
, gs
.s
, gs
.ptr
, more
) < 0)
954 smtp_write_error
= -1;
959 if (fprintf(smtp_out
, "%s", gs
.s
) < 0) smtp_write_error
= -1;
964 /*************************************************
965 * Flush SMTP out and check for error *
966 *************************************************/
968 /* This function isn't currently used within Exim (it detects errors when it
969 tries to read the next SMTP input), but is available for use in local_scan().
970 For non-TLS connections, it flushes the output and checks for errors. For
971 TLS-connections, it checks for a previously-detected TLS write error.
974 Returns: 0 for no error; -1 after an error
980 if (tls_in
.active
.sock
< 0 && fflush(smtp_out
) != 0) smtp_write_error
= -1;
981 return smtp_write_error
;
986 /*************************************************
987 * SMTP command read timeout *
988 *************************************************/
990 /* Signal handler for timing out incoming SMTP commands. This attempts to
993 Argument: signal number (SIGALRM)
998 command_timeout_handler(int sig
)
1000 had_command_timeout
= sig
;
1005 /*************************************************
1006 * SIGTERM received *
1007 *************************************************/
1009 /* Signal handler for handling SIGTERM. Again, try to finish tidily.
1011 Argument: signal number (SIGTERM)
1016 command_sigterm_handler(int sig
)
1018 had_command_sigterm
= sig
;
1024 #ifdef SUPPORT_PROXY
1025 /*************************************************
1026 * Restore socket timeout to previous value *
1027 *************************************************/
1028 /* If the previous value was successfully retrieved, restore
1029 it before returning control to the non-proxy routines
1031 Arguments: fd - File descriptor for input
1032 get_ok - Successfully retrieved previous values
1033 tvtmp - Time struct with previous values
1034 vslen - Length of time struct
1038 restore_socket_timeout(int fd
, int get_ok
, struct timeval
* tvtmp
, socklen_t vslen
)
1041 (void) setsockopt(fd
, SOL_SOCKET
, SO_RCVTIMEO
, CS tvtmp
, vslen
);
1044 /*************************************************
1045 * Check if host is required proxy host *
1046 *************************************************/
1047 /* The function determines if inbound host will be a regular smtp host
1048 or if it is configured that it must use Proxy Protocol. A local
1056 check_proxy_protocol_host()
1060 if ( sender_host_address
1061 && (rc
= verify_check_this_host(CUSS
&hosts_proxy
, NULL
, NULL
,
1062 sender_host_address
, NULL
)) == OK
)
1065 debug_printf("Detected proxy protocol configured host\n");
1066 proxy_session
= TRUE
;
1068 return proxy_session
;
1072 /*************************************************
1073 * Read data until newline or end of buffer *
1074 *************************************************/
1075 /* While SMTP is server-speaks-first, TLS is client-speaks-first, so we can't
1076 read an entire buffer and assume there will be nothing past a proxy protocol
1077 header. Our approach normally is to use stdio, but again that relies upon
1078 "STARTTLS\r\n" and a server response before the client starts TLS handshake, or
1079 reading _nothing_ before client TLS handshake. So we don't want to use the
1080 usual buffering reads which may read enough to block TLS starting.
1082 So unfortunately we're down to "read one byte at a time, with a syscall each,
1083 and expect a little overhead", for all proxy-opened connections which are v1,
1084 just to handle the TLS-on-connect case. Since SSL functions wrap the
1085 underlying fd, we can't assume that we can feed them any already-read content.
1087 We need to know where to read to, the max capacity, and we'll read until we
1088 get a CR and one more character. Let the caller scream if it's CR+!LF.
1090 Return the amount read.
1094 swallow_until_crlf(int fd
, uschar
*base
, int already
, int capacity
)
1096 uschar
*to
= base
+ already
;
1102 /* For "PROXY UNKNOWN\r\n" we, at time of writing, expect to have read
1103 up through the \r; for the _normal_ case, we haven't yet seen the \r. */
1105 cr
= memchr(base
, '\r', already
);
1108 if ((cr
- base
) < already
- 1)
1110 /* \r and presumed \n already within what we have; probably not
1111 actually proxy protocol, but abort cleanly. */
1114 /* \r is last character read, just need one more. */
1118 while (capacity
> 0)
1120 do { ret
= recv(fd
, to
, 1, 0); } while (ret
== -1 && errno
== EINTR
);
1132 /* reached end without having room for a final newline, abort */
1137 /*************************************************
1138 * Setup host for proxy protocol *
1139 *************************************************/
1140 /* The function configures the connection based on a header from the
1141 inbound host to use Proxy Protocol. The specification is very exact
1142 so exit with an error if do not find the exact required pieces. This
1143 includes an incorrect number of spaces separating args.
1146 Returns: Boolean success
1150 setup_proxy_protocol_host()
1162 struct { /* TCP/UDP over IPv4, len = 12 */
1168 struct { /* TCP/UDP over IPv6, len = 36 */
1169 uint8_t src_addr
[16];
1170 uint8_t dst_addr
[16];
1174 struct { /* AF_UNIX sockets, len = 216 */
1175 uschar src_addr
[108];
1176 uschar dst_addr
[108];
1182 /* Temp variables used in PPv2 address:port parsing */
1184 char tmpip
[INET_ADDRSTRLEN
];
1185 struct sockaddr_in tmpaddr
;
1186 char tmpip6
[INET6_ADDRSTRLEN
];
1187 struct sockaddr_in6 tmpaddr6
;
1189 /* We can't read "all data until end" because while SMTP is
1190 server-speaks-first, the TLS handshake is client-speaks-first, so for
1191 TLS-on-connect ports the proxy protocol header will usually be immediately
1192 followed by a TLS handshake, and with N TLS libraries, we can't reliably
1193 reinject data for reading by those. So instead we first read "enough to be
1194 safely read within the header, and figure out how much more to read".
1195 For v1 we will later read to the end-of-line, for v2 we will read based upon
1198 The v2 sig is 12 octets, and another 4 gets us the length, so we know how much
1199 data is needed total. For v1, where the line looks like:
1200 PROXY TCPn L3src L3dest SrcPort DestPort \r\n
1202 However, for v1 there's also `PROXY UNKNOWN\r\n` which is only 15 octets.
1203 We seem to support that. So, if we read 14 octets then we can tell if we're
1204 v2 or v1. If we're v1, we can continue reading as normal.
1206 If we're v2, we can't slurp up the entire header. We need the length in the
1207 15th & 16th octets, then to read everything after that.
1209 So to safely handle v1 and v2, with client-sent-first supported correctly,
1210 we have to do a minimum of 3 read calls, not 1. Eww.
1213 #define PROXY_INITIAL_READ 14
1214 #define PROXY_V2_HEADER_SIZE 16
1215 #if PROXY_INITIAL_READ > PROXY_V2_HEADER_SIZE
1216 # error Code bug in sizes of data to read for proxy usage
1221 int fd
= fileno(smtp_in
);
1222 const char v2sig
[12] = "\x0D\x0A\x0D\x0A\x00\x0D\x0A\x51\x55\x49\x54\x0A";
1223 uschar
* iptype
; /* To display debug info */
1225 struct timeval tvtmp
;
1226 socklen_t vslen
= sizeof(struct timeval
);
1229 /* Save current socket timeout values */
1230 get_ok
= getsockopt(fd
, SOL_SOCKET
, SO_RCVTIMEO
, CS
&tvtmp
, &vslen
);
1232 /* Proxy Protocol host must send header within a short time
1233 (default 3 seconds) or it's considered invalid */
1234 tv
.tv_sec
= PROXY_NEGOTIATION_TIMEOUT_SEC
;
1235 tv
.tv_usec
= PROXY_NEGOTIATION_TIMEOUT_USEC
;
1236 if (setsockopt(fd
, SOL_SOCKET
, SO_RCVTIMEO
, CS
&tv
, sizeof(tv
)) < 0)
1241 /* The inbound host was declared to be a Proxy Protocol host, so
1242 don't do a PEEK into the data, actually slurp up enough to be
1243 "safe". Can't take it all because TLS-on-connect clients follow
1244 immediately with TLS handshake. */
1245 ret
= recv(fd
, &hdr
, PROXY_INITIAL_READ
, 0);
1247 while (ret
== -1 && errno
== EINTR
);
1252 /* For v2, handle reading the length, and then the rest. */
1253 if ((ret
== PROXY_INITIAL_READ
) && (memcmp(&hdr
.v2
, v2sig
, sizeof(v2sig
)) == 0))
1258 /* First get the length fields. */
1261 retmore
= recv(fd
, (uschar
*)&hdr
+ ret
, PROXY_V2_HEADER_SIZE
- PROXY_INITIAL_READ
, 0);
1262 } while (retmore
== -1 && errno
== EINTR
);
1267 ver
= (hdr
.v2
.ver_cmd
& 0xf0) >> 4;
1269 /* May 2014: haproxy combined the version and command into one byte to
1270 allow two full bytes for the length field in order to proxy SSL
1271 connections. SSL Proxy is not supported in this version of Exim, but
1272 must still separate values here. */
1276 DEBUG(D_receive
) debug_printf("Invalid Proxy Protocol version: %d\n", ver
);
1280 /* The v2 header will always be 16 bytes per the spec. */
1281 size
= 16 + ntohs(hdr
.v2
.len
);
1282 DEBUG(D_receive
) debug_printf("Detected PROXYv2 header, size %d (limit %d)\n",
1283 size
, (int)sizeof(hdr
));
1285 /* We should now have 16 octets (PROXY_V2_HEADER_SIZE), and we know the total
1286 amount that we need. Double-check that the size is not unreasonable, then
1288 if (size
> sizeof(hdr
))
1290 DEBUG(D_receive
) debug_printf("PROXYv2 header size unreasonably large; security attack?\n");
1298 retmore
= recv(fd
, (uschar
*)&hdr
+ ret
, size
-ret
, 0);
1299 } while (retmore
== -1 && errno
== EINTR
);
1303 DEBUG(D_receive
) debug_printf("PROXYv2: have %d/%d required octets\n", ret
, size
);
1304 } while (ret
< size
);
1306 } /* end scope for getting rest of data for v2 */
1308 /* At this point: if PROXYv2, we've read the exact size required for all data;
1309 if PROXYv1 then we've read "less than required for any valid line" and should
1312 if (ret
>= 16 && memcmp(&hdr
.v2
, v2sig
, 12) == 0)
1314 uint8_t cmd
= (hdr
.v2
.ver_cmd
& 0x0f);
1318 case 0x01: /* PROXY command */
1321 case 0x11: /* TCPv4 address type */
1323 tmpaddr
.sin_addr
.s_addr
= hdr
.v2
.addr
.ip4
.src_addr
;
1324 inet_ntop(AF_INET
, &tmpaddr
.sin_addr
, CS
&tmpip
, sizeof(tmpip
));
1325 if (!string_is_ip_address(US tmpip
, NULL
))
1327 DEBUG(D_receive
) debug_printf("Invalid %s source IP\n", iptype
);
1330 proxy_local_address
= sender_host_address
;
1331 sender_host_address
= string_copy(US tmpip
);
1332 tmpport
= ntohs(hdr
.v2
.addr
.ip4
.src_port
);
1333 proxy_local_port
= sender_host_port
;
1334 sender_host_port
= tmpport
;
1335 /* Save dest ip/port */
1336 tmpaddr
.sin_addr
.s_addr
= hdr
.v2
.addr
.ip4
.dst_addr
;
1337 inet_ntop(AF_INET
, &tmpaddr
.sin_addr
, CS
&tmpip
, sizeof(tmpip
));
1338 if (!string_is_ip_address(US tmpip
, NULL
))
1340 DEBUG(D_receive
) debug_printf("Invalid %s dest port\n", iptype
);
1343 proxy_external_address
= string_copy(US tmpip
);
1344 tmpport
= ntohs(hdr
.v2
.addr
.ip4
.dst_port
);
1345 proxy_external_port
= tmpport
;
1347 case 0x21: /* TCPv6 address type */
1349 memmove(tmpaddr6
.sin6_addr
.s6_addr
, hdr
.v2
.addr
.ip6
.src_addr
, 16);
1350 inet_ntop(AF_INET6
, &tmpaddr6
.sin6_addr
, CS
&tmpip6
, sizeof(tmpip6
));
1351 if (!string_is_ip_address(US tmpip6
, NULL
))
1353 DEBUG(D_receive
) debug_printf("Invalid %s source IP\n", iptype
);
1356 proxy_local_address
= sender_host_address
;
1357 sender_host_address
= string_copy(US tmpip6
);
1358 tmpport
= ntohs(hdr
.v2
.addr
.ip6
.src_port
);
1359 proxy_local_port
= sender_host_port
;
1360 sender_host_port
= tmpport
;
1361 /* Save dest ip/port */
1362 memmove(tmpaddr6
.sin6_addr
.s6_addr
, hdr
.v2
.addr
.ip6
.dst_addr
, 16);
1363 inet_ntop(AF_INET6
, &tmpaddr6
.sin6_addr
, CS
&tmpip6
, sizeof(tmpip6
));
1364 if (!string_is_ip_address(US tmpip6
, NULL
))
1366 DEBUG(D_receive
) debug_printf("Invalid %s dest port\n", iptype
);
1369 proxy_external_address
= string_copy(US tmpip6
);
1370 tmpport
= ntohs(hdr
.v2
.addr
.ip6
.dst_port
);
1371 proxy_external_port
= tmpport
;
1375 debug_printf("Unsupported PROXYv2 connection type: 0x%02x\n",
1379 /* Unsupported protocol, keep local connection address */
1381 case 0x00: /* LOCAL command */
1382 /* Keep local connection address for LOCAL */
1387 debug_printf("Unsupported PROXYv2 command: 0x%x\n", cmd
);
1391 else if (ret
>= 8 && memcmp(hdr
.v1
.line
, "PROXY", 5) == 0)
1395 uschar
*sp
; /* Utility variables follow */
1400 /* get the rest of the line */
1401 r2
= swallow_until_crlf(fd
, (uschar
*)&hdr
, ret
, sizeof(hdr
)-ret
);
1406 p
= string_copy(hdr
.v1
.line
);
1407 end
= memchr(p
, '\r', ret
- 1);
1409 if (!end
|| (end
== (uschar
*)&hdr
+ ret
) || end
[1] != '\n')
1411 DEBUG(D_receive
) debug_printf("Partial or invalid PROXY header\n");
1414 *end
= '\0'; /* Terminate the string */
1415 size
= end
+ 2 - p
; /* Skip header + CRLF */
1416 DEBUG(D_receive
) debug_printf("Detected PROXYv1 header\n");
1417 DEBUG(D_receive
) debug_printf("Bytes read not within PROXY header: %d\n", ret
- size
);
1418 /* Step through the string looking for the required fields. Ensure
1419 strict adherence to required formatting, exit for any error. */
1421 if (!isspace(*(p
++)))
1423 DEBUG(D_receive
) debug_printf("Missing space after PROXY command\n");
1426 if (!Ustrncmp(p
, CCS
"TCP4", 4))
1428 else if (!Ustrncmp(p
,CCS
"TCP6", 4))
1430 else if (!Ustrncmp(p
,CCS
"UNKNOWN", 7))
1432 iptype
= US
"Unknown";
1437 DEBUG(D_receive
) debug_printf("Invalid TCP type\n");
1441 p
+= Ustrlen(iptype
);
1442 if (!isspace(*(p
++)))
1444 DEBUG(D_receive
) debug_printf("Missing space after TCP4/6 command\n");
1447 /* Find the end of the arg */
1448 if ((sp
= Ustrchr(p
, ' ')) == NULL
)
1451 debug_printf("Did not find proxied src %s\n", iptype
);
1455 if(!string_is_ip_address(p
, NULL
))
1458 debug_printf("Proxied src arg is not an %s address\n", iptype
);
1461 proxy_local_address
= sender_host_address
;
1462 sender_host_address
= p
;
1464 if ((sp
= Ustrchr(p
, ' ')) == NULL
)
1467 debug_printf("Did not find proxy dest %s\n", iptype
);
1471 if(!string_is_ip_address(p
, NULL
))
1474 debug_printf("Proxy dest arg is not an %s address\n", iptype
);
1477 proxy_external_address
= p
;
1479 if ((sp
= Ustrchr(p
, ' ')) == NULL
)
1481 DEBUG(D_receive
) debug_printf("Did not find proxied src port\n");
1485 tmp_port
= strtol(CCS p
, &endc
, 10);
1486 if (*endc
|| tmp_port
== 0)
1489 debug_printf("Proxied src port '%s' not an integer\n", p
);
1492 proxy_local_port
= sender_host_port
;
1493 sender_host_port
= tmp_port
;
1495 if ((sp
= Ustrchr(p
, '\0')) == NULL
)
1497 DEBUG(D_receive
) debug_printf("Did not find proxy dest port\n");
1500 tmp_port
= strtol(CCS p
, &endc
, 10);
1501 if (*endc
|| tmp_port
== 0)
1504 debug_printf("Proxy dest port '%s' not an integer\n", p
);
1507 proxy_external_port
= tmp_port
;
1508 /* Already checked for /r /n above. Good V1 header received. */
1512 /* Wrong protocol */
1513 DEBUG(D_receive
) debug_printf("Invalid proxy protocol version negotiation\n");
1514 (void) swallow_until_crlf(fd
, (uschar
*)&hdr
, ret
, sizeof(hdr
)-ret
);
1520 debug_printf("Valid %s sender from Proxy Protocol header\n", iptype
);
1521 yield
= proxy_session
;
1523 /* Don't flush any potential buffer contents. Any input on proxyfail
1524 should cause a synchronization failure */
1527 restore_socket_timeout(fd
, get_ok
, &tvtmp
, vslen
);
1532 sender_host_name
= NULL
;
1533 (void) host_name_lookup();
1534 host_build_sender_fullhost();
1538 f
.proxy_session_failed
= TRUE
;
1540 debug_printf("Failure to extract proxied host, only QUIT allowed\n");
1547 /*************************************************
1548 * Read one command line *
1549 *************************************************/
1551 /* Strictly, SMTP commands coming over the net are supposed to end with CRLF.
1552 There are sites that don't do this, and in any case internal SMTP probably
1553 should check only for LF. Consequently, we check here for LF only. The line
1554 ends up with [CR]LF removed from its end. If we get an overlong line, treat as
1555 an unknown command. The command is read into the global smtp_cmd_buffer so that
1556 it is available via $smtp_command.
1558 The character reading routine sets up a timeout for each block actually read
1559 from the input (which may contain more than one command). We set up a special
1560 signal handler that closes down the session on a timeout. Control does not
1561 return when it runs.
1564 check_sync if TRUE, check synchronization rules if global option is TRUE
1565 buffer_lim maximum to buffer in lower layer
1567 Returns: a code identifying the command (enumerated above)
1571 smtp_read_command(BOOL check_sync
, unsigned buffer_lim
)
1575 BOOL hadnull
= FALSE
;
1577 had_command_timeout
= 0;
1578 os_non_restarting_signal(SIGALRM
, command_timeout_handler
);
1580 while ((c
= (receive_getc
)(buffer_lim
)) != '\n' && c
!= EOF
)
1582 if (ptr
>= SMTP_CMD_BUFFER_SIZE
)
1584 os_non_restarting_signal(SIGALRM
, sigalrm_handler
);
1592 smtp_cmd_buffer
[ptr
++] = c
;
1595 receive_linecount
++; /* For BSMTP errors */
1596 os_non_restarting_signal(SIGALRM
, sigalrm_handler
);
1598 /* If hit end of file, return pseudo EOF command. Whether we have a
1599 part-line already read doesn't matter, since this is an error state. */
1601 if (c
== EOF
) return EOF_CMD
;
1603 /* Remove any CR and white space at the end of the line, and terminate the
1606 while (ptr
> 0 && isspace(smtp_cmd_buffer
[ptr
-1])) ptr
--;
1607 smtp_cmd_buffer
[ptr
] = 0;
1609 DEBUG(D_receive
) debug_printf("SMTP<< %s\n", smtp_cmd_buffer
);
1611 /* NULLs are not allowed in SMTP commands */
1613 if (hadnull
) return BADCHAR_CMD
;
1615 /* Scan command list and return identity, having set the data pointer
1616 to the start of the actual data characters. Check for SMTP synchronization
1619 for (smtp_cmd_list
* p
= cmd_list
; p
< cmd_list_end
; p
++)
1621 #ifdef SUPPORT_PROXY
1622 /* Only allow QUIT command if Proxy Protocol parsing failed */
1623 if (proxy_session
&& f
.proxy_session_failed
&& p
->cmd
!= QUIT_CMD
)
1627 && strncmpic(smtp_cmd_buffer
, US p
->name
, p
->len
) == 0
1628 && ( smtp_cmd_buffer
[p
->len
-1] == ':' /* "mail from:" or "rcpt to:" */
1629 || smtp_cmd_buffer
[p
->len
] == 0
1630 || smtp_cmd_buffer
[p
->len
] == ' '
1633 if (smtp_inptr
< smtp_inend
&& /* Outstanding input */
1634 p
->cmd
< sync_cmd_limit
&& /* Command should sync */
1635 check_sync
&& /* Local flag set */
1636 smtp_enforce_sync
&& /* Global flag set */
1637 sender_host_address
!= NULL
&& /* Not local input */
1638 !f
.sender_host_notsocket
) /* Really is a socket */
1641 /* The variables $smtp_command and $smtp_command_argument point into the
1642 unmodified input buffer. A copy of the latter is taken for actual
1643 processing, so that it can be chopped up into separate parts if necessary,
1644 for example, when processing a MAIL command options such as SIZE that can
1645 follow the sender address. */
1647 smtp_cmd_argument
= smtp_cmd_buffer
+ p
->len
;
1648 while (isspace(*smtp_cmd_argument
)) smtp_cmd_argument
++;
1649 Ustrcpy(smtp_data_buffer
, smtp_cmd_argument
);
1650 smtp_cmd_data
= smtp_data_buffer
;
1652 /* Count non-mail commands from those hosts that are controlled in this
1653 way. The default is all hosts. We don't waste effort checking the list
1654 until we get a non-mail command, but then cache the result to save checking
1655 again. If there's a DEFER while checking the host, assume it's in the list.
1657 Note that one instance of RSET, EHLO/HELO, and STARTTLS is allowed at the
1658 start of each incoming message by fiddling with the value in the table. */
1660 if (!p
->is_mail_cmd
)
1662 if (count_nonmail
== TRUE_UNSET
) count_nonmail
=
1663 verify_check_host(&smtp_accept_max_nonmail_hosts
) != FAIL
;
1664 if (count_nonmail
&& ++nonmail_command_count
> smtp_accept_max_nonmail
)
1665 return TOO_MANY_NONMAIL_CMD
;
1668 /* If there is data for a command that does not expect it, generate the
1671 return (p
->has_arg
|| *smtp_cmd_data
== 0)? p
->cmd
: BADARG_CMD
;
1675 #ifdef SUPPORT_PROXY
1676 /* Only allow QUIT command if Proxy Protocol parsing failed */
1677 if (proxy_session
&& f
.proxy_session_failed
)
1678 return PROXY_FAIL_IGNORE_CMD
;
1681 /* Enforce synchronization for unknown commands */
1683 if ( smtp_inptr
< smtp_inend
/* Outstanding input */
1684 && check_sync
/* Local flag set */
1685 && smtp_enforce_sync
/* Global flag set */
1686 && sender_host_address
/* Not local input */
1687 && !f
.sender_host_notsocket
) /* Really is a socket */
1695 /*************************************************
1696 * Forced closedown of call *
1697 *************************************************/
1699 /* This function is called from log.c when Exim is dying because of a serious
1700 disaster, and also from some other places. If an incoming non-batched SMTP
1701 channel is open, it swallows the rest of the incoming message if in the DATA
1702 phase, sends the reply string, and gives an error to all subsequent commands
1703 except QUIT. The existence of an SMTP call is detected by the non-NULLness of
1707 message SMTP reply string to send, excluding the code
1713 smtp_closedown(uschar
*message
)
1715 if (!smtp_in
|| smtp_batched_input
) return;
1716 receive_swallow_smtp();
1717 smtp_printf("421 %s\r\n", FALSE
, message
);
1719 for (;;) switch(smtp_read_command(FALSE
, GETC_BUFFER_UNLIMITED
))
1725 smtp_printf("221 %s closing connection\r\n", FALSE
, smtp_active_hostname
);
1730 smtp_printf("250 Reset OK\r\n", FALSE
);
1734 smtp_printf("421 %s\r\n", FALSE
, message
);
1742 /*************************************************
1743 * Set up connection info for logging *
1744 *************************************************/
1746 /* This function is called when logging information about an SMTP connection.
1747 It sets up appropriate source information, depending on the type of connection.
1748 If sender_fullhost is NULL, we are at a very early stage of the connection;
1749 just use the IP address.
1752 Returns: a string describing the connection
1756 smtp_get_connection_info(void)
1758 const uschar
* hostname
= sender_fullhost
1759 ? sender_fullhost
: sender_host_address
;
1762 return string_sprintf("SMTP connection from %s", hostname
);
1764 if (f
.sender_host_unknown
|| f
.sender_host_notsocket
)
1765 return string_sprintf("SMTP connection from %s", sender_ident
);
1768 return string_sprintf("SMTP connection from %s (via inetd)", hostname
);
1770 if (LOGGING(incoming_interface
) && interface_address
)
1771 return string_sprintf("SMTP connection from %s I=[%s]:%d", hostname
,
1772 interface_address
, interface_port
);
1774 return string_sprintf("SMTP connection from %s", hostname
);
1780 /* Append TLS-related information to a log line
1783 g String under construction: allocated string to extend, or NULL
1785 Returns: Allocated string or NULL
1788 s_tlslog(gstring
* g
)
1790 if (LOGGING(tls_cipher
) && tls_in
.cipher
)
1792 g
= string_append(g
, 2, US
" X=", tls_in
.cipher
);
1793 #ifdef EXPERIMENTAL_TLS_RESUME
1794 if (LOGGING(tls_resumption
) && tls_in
.resumption
& RESUME_USED
)
1795 g
= string_catn(g
, US
"*", 1);
1798 if (LOGGING(tls_certificate_verified
) && tls_in
.cipher
)
1799 g
= string_append(g
, 2, US
" CV=", tls_in
.certificate_verified
? "yes":"no");
1800 if (LOGGING(tls_peerdn
) && tls_in
.peerdn
)
1801 g
= string_append(g
, 3, US
" DN=\"", string_printing(tls_in
.peerdn
), US
"\"");
1802 if (LOGGING(tls_sni
) && tls_in
.sni
)
1803 g
= string_append(g
, 3, US
" SNI=\"", string_printing(tls_in
.sni
), US
"\"");
1808 /*************************************************
1809 * Log lack of MAIL if so configured *
1810 *************************************************/
1812 /* This function is called when an SMTP session ends. If the log selector
1813 smtp_no_mail is set, write a log line giving some details of what has happened
1814 in the SMTP session.
1821 smtp_log_no_mail(void)
1826 if (smtp_mailcmd_count
> 0 || !LOGGING(smtp_no_mail
))
1829 if (sender_host_authenticated
)
1831 g
= string_append(g
, 2, US
" A=", sender_host_authenticated
);
1832 if (authenticated_id
) g
= string_append(g
, 2, US
":", authenticated_id
);
1839 sep
= smtp_connection_had
[SMTP_HBUFF_SIZE
-1] != SCH_NONE
? US
" C=..." : US
" C=";
1841 for (int i
= smtp_ch_index
; i
< SMTP_HBUFF_SIZE
; i
++)
1842 if (smtp_connection_had
[i
] != SCH_NONE
)
1844 g
= string_append(g
, 2, sep
, smtp_names
[smtp_connection_had
[i
]]);
1848 for (int i
= 0; i
< smtp_ch_index
; i
++)
1850 g
= string_append(g
, 2, sep
, smtp_names
[smtp_connection_had
[i
]]);
1854 if (!(s
= string_from_gstring(g
))) s
= US
"";
1856 log_write(0, LOG_MAIN
, "no MAIL in %sSMTP connection from %s D=%s%s",
1857 f
.tcp_in_fastopen
? f
.tcp_in_fastopen_data
? US
"TFO* " : US
"TFO " : US
"",
1858 host_and_ident(FALSE
), string_timesince(&smtp_connection_start
), s
);
1862 /* Return list of recent smtp commands */
1867 gstring
* list
= NULL
;
1870 for (int i
= smtp_ch_index
; i
< SMTP_HBUFF_SIZE
; i
++)
1871 if (smtp_connection_had
[i
] != SCH_NONE
)
1872 list
= string_append_listele(list
, ',', smtp_names
[smtp_connection_had
[i
]]);
1874 for (int i
= 0; i
< smtp_ch_index
; i
++)
1875 list
= string_append_listele(list
, ',', smtp_names
[smtp_connection_had
[i
]]);
1877 s
= string_from_gstring(list
);
1878 return s
? s
: US
"";
1884 /*************************************************
1885 * Check HELO line and set sender_helo_name *
1886 *************************************************/
1888 /* Check the format of a HELO line. The data for HELO/EHLO is supposed to be
1889 the domain name of the sending host, or an ip literal in square brackets. The
1890 argument is placed in sender_helo_name, which is in malloc store, because it
1891 must persist over multiple incoming messages. If helo_accept_junk is set, this
1892 host is permitted to send any old junk (needed for some broken hosts).
1893 Otherwise, helo_allow_chars can be used for rogue characters in general
1894 (typically people want to let in underscores).
1897 s the data portion of the line (already past any white space)
1899 Returns: TRUE or FALSE
1903 check_helo(uschar
*s
)
1906 uschar
*end
= s
+ Ustrlen(s
);
1907 BOOL yield
= fl
.helo_accept_junk
;
1909 /* Discard any previous helo name */
1911 sender_helo_name
= NULL
;
1913 /* Skip tests if junk is permitted. */
1917 /* Allow the new standard form for IPv6 address literals, namely,
1918 [IPv6:....], and because someone is bound to use it, allow an equivalent
1919 IPv4 form. Allow plain addresses as well. */
1926 if (strncmpic(s
, US
"[IPv6:", 6) == 0)
1927 yield
= (string_is_ip_address(s
+6, NULL
) == 6);
1928 else if (strncmpic(s
, US
"[IPv4:", 6) == 0)
1929 yield
= (string_is_ip_address(s
+6, NULL
) == 4);
1931 yield
= (string_is_ip_address(s
+1, NULL
) != 0);
1936 /* Non-literals must be alpha, dot, hyphen, plus any non-valid chars
1937 that have been configured (usually underscore - sigh). */
1940 for (yield
= TRUE
; *s
; s
++)
1941 if (!isalnum(*s
) && *s
!= '.' && *s
!= '-' &&
1942 Ustrchr(helo_allow_chars
, *s
) == NULL
)
1948 /* Save argument if OK */
1950 if (yield
) sender_helo_name
= string_copy_perm(start
, TRUE
);
1958 /*************************************************
1959 * Extract SMTP command option *
1960 *************************************************/
1962 /* This function picks the next option setting off the end of smtp_cmd_data. It
1963 is called for MAIL FROM and RCPT TO commands, to pick off the optional ESMTP
1964 things that can appear there.
1967 name point this at the name
1968 value point this at the data string
1970 Returns: TRUE if found an option
1974 extract_option(uschar
**name
, uschar
**value
)
1977 uschar
*v
= smtp_cmd_data
+ Ustrlen(smtp_cmd_data
) - 1;
1978 while (isspace(*v
)) v
--;
1980 while (v
> smtp_cmd_data
&& *v
!= '=' && !isspace(*v
))
1982 /* Take care to not stop at a space embedded in a quoted local-part */
1984 if (*v
== '"') do v
--; while (*v
!= '"' && v
> smtp_cmd_data
+1);
1991 while(isalpha(n
[-1])) n
--;
1992 /* RFC says SP, but TAB seen in wild and other major MTAs accept it */
1993 if (!isspace(n
[-1])) return FALSE
;
1999 if (v
== smtp_cmd_data
) return FALSE
;
2011 /*************************************************
2012 * Reset for new message *
2013 *************************************************/
2015 /* This function is called whenever the SMTP session is reset from
2016 within either of the setup functions; also from the daemon loop.
2018 Argument: the stacking pool storage reset point
2023 smtp_reset(void *reset_point
)
2025 recipients_list
= NULL
;
2026 rcpt_count
= rcpt_defer_count
= rcpt_fail_count
=
2027 raw_recipients_count
= recipients_count
= recipients_list_max
= 0;
2028 message_linecount
= 0;
2030 acl_added_headers
= NULL
;
2031 acl_removed_headers
= NULL
;
2032 f
.queue_only_policy
= FALSE
;
2033 rcpt_smtp_response
= NULL
;
2034 fl
.rcpt_smtp_response_same
= TRUE
;
2035 fl
.rcpt_in_progress
= FALSE
;
2036 f
.deliver_freeze
= FALSE
; /* Can be set by ACL */
2037 freeze_tell
= freeze_tell_config
; /* Can be set by ACL */
2038 fake_response
= OK
; /* Can be set by ACL */
2039 #ifdef WITH_CONTENT_SCAN
2040 f
.no_mbox_unspool
= FALSE
; /* Can be set by ACL */
2042 f
.submission_mode
= FALSE
; /* Can be set by ACL */
2043 f
.suppress_local_fixups
= f
.suppress_local_fixups_default
; /* Can be set by ACL */
2044 f
.active_local_from_check
= local_from_check
; /* Can be set by ACL */
2045 f
.active_local_sender_retain
= local_sender_retain
; /* Can be set by ACL */
2046 sending_ip_address
= NULL
;
2047 return_path
= sender_address
= NULL
;
2048 sender_data
= NULL
; /* Can be set by ACL */
2049 deliver_localpart_parent
= deliver_localpart_orig
= NULL
;
2050 deliver_domain_parent
= deliver_domain_orig
= NULL
;
2051 callout_address
= NULL
;
2052 submission_name
= NULL
; /* Can be set by ACL */
2053 raw_sender
= NULL
; /* After SMTP rewrite, before qualifying */
2054 sender_address_unrewritten
= NULL
; /* Set only after verify rewrite */
2055 sender_verified_list
= NULL
; /* No senders verified */
2056 memset(sender_address_cache
, 0, sizeof(sender_address_cache
));
2057 memset(sender_domain_cache
, 0, sizeof(sender_domain_cache
));
2059 authenticated_sender
= NULL
;
2060 #ifdef EXPERIMENTAL_BRIGHTMAIL
2062 bmi_verdicts
= NULL
;
2064 dnslist_domain
= dnslist_matched
= NULL
;
2066 spf_header_comment
= spf_received
= spf_result
= spf_smtp_comment
= NULL
;
2067 spf_result_guessed
= FALSE
;
2069 #ifndef DISABLE_DKIM
2070 dkim_cur_signer
= dkim_signers
=
2071 dkim_signing_domain
= dkim_signing_selector
= dkim_signatures
= NULL
;
2072 dkim_cur_signer
= dkim_signers
= dkim_signing_domain
= dkim_signing_selector
= NULL
;
2073 f
.dkim_disable_verify
= FALSE
;
2074 dkim_collect_input
= 0;
2075 dkim_verify_overall
= dkim_verify_status
= dkim_verify_reason
= NULL
;
2076 dkim_key_length
= 0;
2078 #ifdef SUPPORT_DMARC
2079 f
.dmarc_has_been_checked
= f
.dmarc_disable_verify
= f
.dmarc_enable_forensic
= FALSE
;
2080 dmarc_domain_policy
= dmarc_status
= dmarc_status_text
=
2081 dmarc_used_domain
= NULL
;
2083 #ifdef EXPERIMENTAL_ARC
2084 arc_state
= arc_state_reason
= NULL
;
2088 deliver_host
= deliver_host_address
= NULL
; /* Can be set by ACL */
2089 #ifndef DISABLE_PRDR
2090 prdr_requested
= FALSE
;
2093 message_smtputf8
= FALSE
;
2095 body_linecount
= body_zerocount
= 0;
2097 sender_rate
= sender_rate_limit
= sender_rate_period
= NULL
;
2098 ratelimiters_mail
= NULL
; /* Updated by ratelimit ACL condition */
2099 /* Note that ratelimiters_conn persists across resets. */
2101 /* Reset message ACL variables */
2105 /* The message body variables use malloc store. They may be set if this is
2106 not the first message in an SMTP session and the previous message caused them
2107 to be referenced in an ACL. */
2111 store_free(message_body
);
2112 message_body
= NULL
;
2115 if (message_body_end
)
2117 store_free(message_body_end
);
2118 message_body_end
= NULL
;
2121 /* Warning log messages are also saved in malloc store. They are saved to avoid
2122 repetition in the same message, but it seems right to repeat them for different
2125 while (acl_warn_logged
)
2127 string_item
*this = acl_warn_logged
;
2128 acl_warn_logged
= acl_warn_logged
->next
;
2131 store_reset(reset_point
);
2132 return store_mark();
2139 /*************************************************
2140 * Initialize for incoming batched SMTP message *
2141 *************************************************/
2143 /* This function is called from smtp_setup_msg() in the case when
2144 smtp_batched_input is true. This happens when -bS is used to pass a whole batch
2145 of messages in one file with SMTP commands between them. All errors must be
2146 reported by sending a message, and only MAIL FROM, RCPT TO, and DATA are
2147 relevant. After an error on a sender, or an invalid recipient, the remainder
2148 of the message is skipped. The value of received_protocol is already set.
2151 Returns: > 0 message successfully started (reached DATA)
2152 = 0 QUIT read or end of file reached
2153 < 0 should not occur
2157 smtp_setup_batch_msg(void)
2160 rmark reset_point
= store_mark();
2162 /* Save the line count at the start of each transaction - single commands
2163 like HELO and RSET count as whole transactions. */
2165 bsmtp_transaction_linecount
= receive_linecount
;
2167 if ((receive_feof
)()) return 0; /* Treat EOF as QUIT */
2169 cancel_cutthrough_connection(TRUE
, US
"smtp_setup_batch_msg");
2170 reset_point
= smtp_reset(reset_point
); /* Reset for start of message */
2172 /* Deal with SMTP commands. This loop is exited by setting done to a POSITIVE
2173 value. The values are 2 larger than the required yield of the function. */
2178 uschar
*recipient
= NULL
;
2179 int start
, end
, sender_domain
, recipient_domain
;
2181 switch(smtp_read_command(FALSE
, GETC_BUFFER_UNLIMITED
))
2183 /* The HELO/EHLO commands set sender_address_helo if they have
2184 valid data; otherwise they are ignored, except that they do
2185 a reset of the state. */
2190 check_helo(smtp_cmd_data
);
2194 cancel_cutthrough_connection(TRUE
, US
"RSET received");
2195 reset_point
= smtp_reset(reset_point
);
2196 bsmtp_transaction_linecount
= receive_linecount
;
2200 /* The MAIL FROM command requires an address as an operand. All we
2201 do here is to parse it for syntactic correctness. The form "<>" is
2202 a special case which converts into an empty string. The start/end
2203 pointers in the original are not used further for this address, as
2204 it is the canonical extracted address which is all that is kept. */
2207 smtp_mailcmd_count
++; /* Count for no-mail log */
2208 if (sender_address
!= NULL
)
2209 /* The function moan_smtp_batch() does not return. */
2210 moan_smtp_batch(smtp_cmd_buffer
, "503 Sender already given");
2212 if (smtp_cmd_data
[0] == 0)
2213 /* The function moan_smtp_batch() does not return. */
2214 moan_smtp_batch(smtp_cmd_buffer
, "501 MAIL FROM must have an address operand");
2216 /* Reset to start of message */
2218 cancel_cutthrough_connection(TRUE
, US
"MAIL received");
2219 reset_point
= smtp_reset(reset_point
);
2221 /* Apply SMTP rewrite */
2223 raw_sender
= ((rewrite_existflags
& rewrite_smtp
) != 0)?
2224 rewrite_one(smtp_cmd_data
, rewrite_smtp
|rewrite_smtp_sender
, NULL
, FALSE
,
2225 US
"", global_rewrite_rules
) : smtp_cmd_data
;
2227 /* Extract the address; the TRUE flag allows <> as valid */
2230 parse_extract_address(raw_sender
, &errmess
, &start
, &end
, &sender_domain
,
2234 /* The function moan_smtp_batch() does not return. */
2235 moan_smtp_batch(smtp_cmd_buffer
, "501 %s", errmess
);
2237 sender_address
= string_copy(raw_sender
);
2239 /* Qualify unqualified sender addresses if permitted to do so. */
2242 && sender_address
[0] != 0 && sender_address
[0] != '@')
2243 if (f
.allow_unqualified_sender
)
2245 sender_address
= rewrite_address_qualify(sender_address
, FALSE
);
2246 DEBUG(D_receive
) debug_printf("unqualified address %s accepted "
2247 "and rewritten\n", raw_sender
);
2249 /* The function moan_smtp_batch() does not return. */
2251 moan_smtp_batch(smtp_cmd_buffer
, "501 sender address must contain "
2256 /* The RCPT TO command requires an address as an operand. All we do
2257 here is to parse it for syntactic correctness. There may be any number
2258 of RCPT TO commands, specifying multiple senders. We build them all into
2259 a data structure that is in argc/argv format. The start/end values
2260 given by parse_extract_address are not used, as we keep only the
2261 extracted address. */
2264 if (!sender_address
)
2265 /* The function moan_smtp_batch() does not return. */
2266 moan_smtp_batch(smtp_cmd_buffer
, "503 No sender yet given");
2268 if (smtp_cmd_data
[0] == 0)
2269 /* The function moan_smtp_batch() does not return. */
2270 moan_smtp_batch(smtp_cmd_buffer
,
2271 "501 RCPT TO must have an address operand");
2273 /* Check maximum number allowed */
2275 if (recipients_max
> 0 && recipients_count
+ 1 > recipients_max
)
2276 /* The function moan_smtp_batch() does not return. */
2277 moan_smtp_batch(smtp_cmd_buffer
, "%s too many recipients",
2278 recipients_max_reject
? "552": "452");
2280 /* Apply SMTP rewrite, then extract address. Don't allow "<>" as a
2281 recipient address */
2283 recipient
= rewrite_existflags
& rewrite_smtp
2284 ? rewrite_one(smtp_cmd_data
, rewrite_smtp
, NULL
, FALSE
, US
"",
2285 global_rewrite_rules
)
2288 recipient
= parse_extract_address(recipient
, &errmess
, &start
, &end
,
2289 &recipient_domain
, FALSE
);
2292 /* The function moan_smtp_batch() does not return. */
2293 moan_smtp_batch(smtp_cmd_buffer
, "501 %s", errmess
);
2295 /* If the recipient address is unqualified, qualify it if permitted. Then
2296 add it to the list of recipients. */
2298 if (!recipient_domain
)
2299 if (f
.allow_unqualified_recipient
)
2301 DEBUG(D_receive
) debug_printf("unqualified address %s accepted\n",
2303 recipient
= rewrite_address_qualify(recipient
, TRUE
);
2305 /* The function moan_smtp_batch() does not return. */
2307 moan_smtp_batch(smtp_cmd_buffer
,
2308 "501 recipient address must contain a domain");
2310 receive_add_recipient(recipient
, -1);
2314 /* The DATA command is legal only if it follows successful MAIL FROM
2315 and RCPT TO commands. This function is complete when a valid DATA
2316 command is encountered. */
2319 if (!sender_address
|| recipients_count
<= 0)
2320 /* The function moan_smtp_batch() does not return. */
2321 if (!sender_address
)
2322 moan_smtp_batch(smtp_cmd_buffer
,
2323 "503 MAIL FROM:<sender> command must precede DATA");
2325 moan_smtp_batch(smtp_cmd_buffer
,
2326 "503 RCPT TO:<recipient> must precede DATA");
2329 done
= 3; /* DATA successfully achieved */
2330 message_ended
= END_NOTENDED
; /* Indicate in middle of message */
2335 /* The VRFY, EXPN, HELP, ETRN, and NOOP commands are ignored. */
2342 bsmtp_transaction_linecount
= receive_linecount
;
2353 /* The function moan_smtp_batch() does not return. */
2354 moan_smtp_batch(smtp_cmd_buffer
, "501 Unexpected argument data");
2359 /* The function moan_smtp_batch() does not return. */
2360 moan_smtp_batch(smtp_cmd_buffer
, "501 Unexpected NULL in SMTP command");
2365 /* The function moan_smtp_batch() does not return. */
2366 moan_smtp_batch(smtp_cmd_buffer
, "500 Command unrecognized");
2371 return done
- 2; /* Convert yield values */
2379 smtp_log_tls_fail(uschar
* errstr
)
2381 uschar
* conn_info
= smtp_get_connection_info();
2383 if (Ustrncmp(conn_info
, US
"SMTP ", 5) == 0) conn_info
+= 5;
2384 /* I'd like to get separated H= here, but too hard for now */
2386 log_write(0, LOG_MAIN
, "TLS error on %s %s", conn_info
, errstr
);
2399 struct tcp_info tinfo
;
2400 socklen_t len
= sizeof(tinfo
);
2402 if (getsockopt(fileno(smtp_out
), IPPROTO_TCP
, TCP_INFO
, &tinfo
, &len
) == 0)
2403 #ifdef TCPI_OPT_SYN_DATA /* FreeBSD 11 does not seem to have this yet */
2404 if (tinfo
.tcpi_options
& TCPI_OPT_SYN_DATA
)
2406 DEBUG(D_receive
) debug_printf("TCP_FASTOPEN mode connection (ACKd data-on-SYN)\n");
2407 f
.tcp_in_fastopen_data
= f
.tcp_in_fastopen
= TRUE
;
2411 if (tinfo
.tcpi_state
== TCP_SYN_RECV
)
2413 DEBUG(D_receive
) debug_printf("TCP_FASTOPEN mode connection (state TCP_SYN_RECV)\n");
2414 f
.tcp_in_fastopen
= TRUE
;
2421 /*************************************************
2422 * Start an SMTP session *
2423 *************************************************/
2425 /* This function is called at the start of an SMTP session. Thereafter,
2426 smtp_setup_msg() is called to initiate each separate message. This
2427 function does host-specific testing, and outputs the banner line.
2430 Returns: FALSE if the session can not continue; something has
2431 gone wrong, or the connection to the host is blocked
2435 smtp_start_session(void)
2438 uschar
*user_msg
, *log_msg
;
2443 gettimeofday(&smtp_connection_start
, NULL
);
2444 for (smtp_ch_index
= 0; smtp_ch_index
< SMTP_HBUFF_SIZE
; smtp_ch_index
++)
2445 smtp_connection_had
[smtp_ch_index
] = SCH_NONE
;
2448 /* Default values for certain variables */
2450 fl
.helo_seen
= fl
.esmtp
= fl
.helo_accept_junk
= FALSE
;
2451 smtp_mailcmd_count
= 0;
2452 count_nonmail
= TRUE_UNSET
;
2453 synprot_error_count
= unknown_command_count
= nonmail_command_count
= 0;
2454 smtp_delay_mail
= smtp_rlm_base
;
2455 fl
.auth_advertised
= FALSE
;
2456 f
.smtp_in_pipelining_advertised
= f
.smtp_in_pipelining_used
= FALSE
;
2457 f
.pipelining_enable
= TRUE
;
2458 sync_cmd_limit
= NON_SYNC_CMD_NON_PIPELINING
;
2459 fl
.smtp_exit_function_called
= FALSE
; /* For avoiding loop in not-quit exit */
2461 /* If receiving by -bs from a trusted user, or testing with -bh, we allow
2462 authentication settings from -oMaa to remain in force. */
2464 if (!host_checking
&& !f
.sender_host_notsocket
)
2465 sender_host_auth_pubname
= sender_host_authenticated
= NULL
;
2466 authenticated_by
= NULL
;
2469 tls_in
.cipher
= tls_in
.peerdn
= NULL
;
2470 tls_in
.ourcert
= tls_in
.peercert
= NULL
;
2472 tls_in
.ocsp
= OCSP_NOT_REQ
;
2473 fl
.tls_advertised
= FALSE
;
2475 fl
.dsn_advertised
= FALSE
;
2477 fl
.smtputf8_advertised
= FALSE
;
2480 /* Reset ACL connection variables */
2484 /* Allow for trailing 0 in the command and data buffers. Tainted. */
2486 smtp_cmd_buffer
= store_get_perm(2*SMTP_CMD_BUFFER_SIZE
+ 2, TRUE
);
2488 smtp_cmd_buffer
[0] = 0;
2489 smtp_data_buffer
= smtp_cmd_buffer
+ SMTP_CMD_BUFFER_SIZE
+ 1;
2491 /* For batched input, the protocol setting can be overridden from the
2492 command line by a trusted caller. */
2494 if (smtp_batched_input
)
2496 if (!received_protocol
) received_protocol
= US
"local-bsmtp";
2499 /* For non-batched SMTP input, the protocol setting is forced here. It will be
2500 reset later if any of EHLO/AUTH/STARTTLS are received. */
2504 (sender_host_address
? protocols
: protocols_local
) [pnormal
];
2506 /* Set up the buffer for inputting using direct read() calls, and arrange to
2507 call the local functions instead of the standard C ones. Place a NUL at the
2508 end of the buffer to safety-stop C-string reads from it. */
2510 if (!(smtp_inbuffer
= US
malloc(IN_BUFFER_SIZE
)))
2511 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "malloc() failed for SMTP input buffer");
2512 smtp_inbuffer
[IN_BUFFER_SIZE
-1] = '\0';
2514 receive_getc
= smtp_getc
;
2515 receive_getbuf
= smtp_getbuf
;
2516 receive_get_cache
= smtp_get_cache
;
2517 receive_ungetc
= smtp_ungetc
;
2518 receive_feof
= smtp_feof
;
2519 receive_ferror
= smtp_ferror
;
2520 receive_smtp_buffered
= smtp_buffered
;
2521 smtp_inptr
= smtp_inend
= smtp_inbuffer
;
2522 smtp_had_eof
= smtp_had_error
= 0;
2524 /* Set up the message size limit; this may be host-specific */
2526 thismessage_size_limit
= expand_string_integer(message_size_limit
, TRUE
);
2527 if (expand_string_message
)
2529 if (thismessage_size_limit
== -1)
2530 log_write(0, LOG_MAIN
|LOG_PANIC
, "unable to expand message_size_limit: "
2531 "%s", expand_string_message
);
2533 log_write(0, LOG_MAIN
|LOG_PANIC
, "invalid message_size_limit: "
2534 "%s", expand_string_message
);
2535 smtp_closedown(US
"Temporary local problem - please try later");
2539 /* When a message is input locally via the -bs or -bS options, sender_host_
2540 unknown is set unless -oMa was used to force an IP address, in which case it
2541 is checked like a real remote connection. When -bs is used from inetd, this
2542 flag is not set, causing the sending host to be checked. The code that deals
2543 with IP source routing (if configured) is never required for -bs or -bS and
2544 the flag sender_host_notsocket is used to suppress it.
2546 If smtp_accept_max and smtp_accept_reserve are set, keep some connections in
2547 reserve for certain hosts and/or networks. */
2549 if (!f
.sender_host_unknown
)
2552 BOOL reserved_host
= FALSE
;
2554 /* Look up IP options (source routing info) on the socket if this is not an
2555 -oMa "host", and if any are found, log them and drop the connection.
2557 Linux (and others now, see below) is different to everyone else, so there
2558 has to be some conditional compilation here. Versions of Linux before 2.1.15
2559 used a structure whose name was "options". Somebody finally realized that
2560 this name was silly, and it got changed to "ip_options". I use the
2561 newer name here, but there is a fudge in the script that sets up os.h
2562 to define a macro in older Linux systems.
2564 Sigh. Linux is a fast-moving target. Another generation of Linux uses
2565 glibc 2, which has chosen ip_opts for the structure name. This is now
2566 really a glibc thing rather than a Linux thing, so the condition name
2567 has been changed to reflect this. It is relevant also to GNU/Hurd.
2569 Mac OS 10.x (Darwin) is like the later glibc versions, but without the
2570 setting of the __GLIBC__ macro, so we can't detect it automatically. There's
2571 a special macro defined in the os.h file.
2573 Some DGUX versions on older hardware appear not to support IP options at
2574 all, so there is now a general macro which can be set to cut out this
2577 How to do this properly in IPv6 is not yet known. */
2579 #if !HAVE_IPV6 && !defined(NO_IP_OPTIONS)
2581 #ifdef GLIBC_IP_OPTIONS
2582 #if (!defined __GLIBC__) || (__GLIBC__ < 2)
2587 #elif defined DARWIN_IP_OPTIONS
2593 if (!host_checking
&& !f
.sender_host_notsocket
)
2596 EXIM_SOCKLEN_T optlen
= sizeof(struct ip_options
) + MAX_IPOPTLEN
;
2597 struct ip_options
*ipopt
= store_get(optlen
, FALSE
);
2599 struct ip_opts ipoptblock
;
2600 struct ip_opts
*ipopt
= &ipoptblock
;
2601 EXIM_SOCKLEN_T optlen
= sizeof(ipoptblock
);
2603 struct ipoption ipoptblock
;
2604 struct ipoption
*ipopt
= &ipoptblock
;
2605 EXIM_SOCKLEN_T optlen
= sizeof(ipoptblock
);
2608 /* Occasional genuine failures of getsockopt() have been seen - for
2609 example, "reset by peer". Therefore, just log and give up on this
2610 call, unless the error is ENOPROTOOPT. This error is given by systems
2611 that have the interfaces but not the mechanism - e.g. GNU/Hurd at the time
2612 of writing. So for that error, carry on - we just can't do an IP options
2615 DEBUG(D_receive
) debug_printf("checking for IP options\n");
2617 if (getsockopt(fileno(smtp_out
), IPPROTO_IP
, IP_OPTIONS
, US (ipopt
),
2620 if (errno
!= ENOPROTOOPT
)
2622 log_write(0, LOG_MAIN
, "getsockopt() failed from %s: %s",
2623 host_and_ident(FALSE
), strerror(errno
));
2624 smtp_printf("451 SMTP service not available\r\n", FALSE
);
2629 /* Deal with any IP options that are set. On the systems I have looked at,
2630 the value of MAX_IPOPTLEN has been 40, meaning that there should never be
2631 more logging data than will fit in big_buffer. Nevertheless, after somebody
2632 questioned this code, I've added in some paranoid checking. */
2634 else if (optlen
> 0)
2636 uschar
*p
= big_buffer
;
2637 uschar
*pend
= big_buffer
+ big_buffer_size
;
2640 struct in_addr addr
;
2643 uschar
*optstart
= US (ipopt
->__data
);
2645 uschar
*optstart
= US (ipopt
->ip_opts
);
2647 uschar
*optstart
= US (ipopt
->ipopt_list
);
2650 DEBUG(D_receive
) debug_printf("IP options exist\n");
2652 Ustrcpy(p
, "IP options on incoming call:");
2655 for (uschar
* opt
= optstart
; opt
&& opt
< US (ipopt
) + optlen
; )
2668 if (!string_format(p
, pend
-p
, " %s [@%s",
2669 (*opt
== IPOPT_SSRR
)? "SSRR" : "LSRR",
2671 inet_ntoa(*((struct in_addr
*)(&(ipopt
->faddr
))))))
2673 inet_ntoa(ipopt
->ip_dst
)))
2675 inet_ntoa(ipopt
->ipopt_dst
)))
2683 optcount
= (opt
[1] - 3) / sizeof(struct in_addr
);
2685 while (optcount
-- > 0)
2687 memcpy(&addr
, adptr
, sizeof(addr
));
2688 if (!string_format(p
, pend
- p
- 1, "%s%s",
2689 (optcount
== 0)? ":" : "@", inet_ntoa(addr
)))
2695 adptr
+= sizeof(struct in_addr
);
2703 if (pend
- p
< 4 + 3*opt
[1]) { opt
= NULL
; break; }
2706 for (int i
= 0; i
< opt
[1]; i
++)
2707 p
+= sprintf(CS p
, "%2.2x ", opt
[i
]);
2715 log_write(0, LOG_MAIN
, "%s", big_buffer
);
2717 /* Refuse any call with IP options. This is what tcpwrappers 7.5 does. */
2719 log_write(0, LOG_MAIN
|LOG_REJECT
,
2720 "connection from %s refused (IP options)", host_and_ident(FALSE
));
2722 smtp_printf("554 SMTP service not available\r\n", FALSE
);
2726 /* Length of options = 0 => there are no options */
2728 else DEBUG(D_receive
) debug_printf("no IP options found\n");
2730 #endif /* HAVE_IPV6 && !defined(NO_IP_OPTIONS) */
2732 /* Set keep-alive in socket options. The option is on by default. This
2733 setting is an attempt to get rid of some hanging connections that stick in
2734 read() when the remote end (usually a dialup) goes away. */
2736 if (smtp_accept_keepalive
&& !f
.sender_host_notsocket
)
2737 ip_keepalive(fileno(smtp_out
), sender_host_address
, FALSE
);
2739 /* If the current host matches host_lookup, set the name by doing a
2740 reverse lookup. On failure, sender_host_name will be NULL and
2741 host_lookup_failed will be TRUE. This may or may not be serious - optional
2744 if (verify_check_host(&host_lookup
) == OK
)
2746 (void)host_name_lookup();
2747 host_build_sender_fullhost();
2750 /* Delay this until we have the full name, if it is looked up. */
2752 set_process_info("handling incoming connection from %s",
2753 host_and_ident(FALSE
));
2755 /* Expand smtp_receive_timeout, if needed */
2757 if (smtp_receive_timeout_s
)
2760 if ( !(exp
= expand_string(smtp_receive_timeout_s
))
2762 || (smtp_receive_timeout
= readconf_readtime(exp
, 0, FALSE
)) < 0
2764 log_write(0, LOG_MAIN
|LOG_PANIC
,
2765 "bad value for smtp_receive_timeout: '%s'", exp
? exp
: US
"");
2768 /* Test for explicit connection rejection */
2770 if (verify_check_host(&host_reject_connection
) == OK
)
2772 log_write(L_connection_reject
, LOG_MAIN
|LOG_REJECT
, "refused connection "
2773 "from %s (host_reject_connection)", host_and_ident(FALSE
));
2774 smtp_printf("554 SMTP service not available\r\n", FALSE
);
2778 /* Test with TCP Wrappers if so configured. There is a problem in that
2779 hosts_ctl() returns 0 (deny) under a number of system failure circumstances,
2780 such as disks dying. In these cases, it is desirable to reject with a 4xx
2781 error instead of a 5xx error. There isn't a "right" way to detect such
2782 problems. The following kludge is used: errno is zeroed before calling
2783 hosts_ctl(). If the result is "reject", a 5xx error is given only if the
2784 value of errno is 0 or ENOENT (which happens if /etc/hosts.{allow,deny} does
2787 #ifdef USE_TCP_WRAPPERS
2789 if (!(tcp_wrappers_name
= expand_string(tcp_wrappers_daemon_name
)))
2790 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "Expansion of \"%s\" "
2791 "(tcp_wrappers_name) failed: %s", string_printing(tcp_wrappers_name
),
2792 expand_string_message
);
2794 if (!hosts_ctl(tcp_wrappers_name
,
2795 sender_host_name
? CS sender_host_name
: STRING_UNKNOWN
,
2796 sender_host_address
? CS sender_host_address
: STRING_UNKNOWN
,
2797 sender_ident
? CS sender_ident
: STRING_UNKNOWN
))
2799 if (errno
== 0 || errno
== ENOENT
)
2801 HDEBUG(D_receive
) debug_printf("tcp wrappers rejection\n");
2802 log_write(L_connection_reject
,
2803 LOG_MAIN
|LOG_REJECT
, "refused connection from %s "
2804 "(tcp wrappers)", host_and_ident(FALSE
));
2805 smtp_printf("554 SMTP service not available\r\n", FALSE
);
2809 int save_errno
= errno
;
2810 HDEBUG(D_receive
) debug_printf("tcp wrappers rejected with unexpected "
2811 "errno value %d\n", save_errno
);
2812 log_write(L_connection_reject
,
2813 LOG_MAIN
|LOG_REJECT
, "temporarily refused connection from %s "
2814 "(tcp wrappers errno=%d)", host_and_ident(FALSE
), save_errno
);
2815 smtp_printf("451 Temporary local problem - please try later\r\n", FALSE
);
2821 /* Check for reserved slots. The value of smtp_accept_count has already been
2822 incremented to include this process. */
2824 if (smtp_accept_max
> 0 &&
2825 smtp_accept_count
> smtp_accept_max
- smtp_accept_reserve
)
2827 if ((rc
= verify_check_host(&smtp_reserve_hosts
)) != OK
)
2829 log_write(L_connection_reject
,
2830 LOG_MAIN
, "temporarily refused connection from %s: not in "
2831 "reserve list: connected=%d max=%d reserve=%d%s",
2832 host_and_ident(FALSE
), smtp_accept_count
- 1, smtp_accept_max
,
2833 smtp_accept_reserve
, (rc
== DEFER
)? " (lookup deferred)" : "");
2834 smtp_printf("421 %s: Too many concurrent SMTP connections; "
2835 "please try again later\r\n", FALSE
, smtp_active_hostname
);
2838 reserved_host
= TRUE
;
2841 /* If a load level above which only messages from reserved hosts are
2842 accepted is set, check the load. For incoming calls via the daemon, the
2843 check is done in the superior process if there are no reserved hosts, to
2844 save a fork. In all cases, the load average will already be available
2845 in a global variable at this point. */
2847 if (smtp_load_reserve
>= 0 &&
2848 load_average
> smtp_load_reserve
&&
2850 verify_check_host(&smtp_reserve_hosts
) != OK
)
2852 log_write(L_connection_reject
,
2853 LOG_MAIN
, "temporarily refused connection from %s: not in "
2854 "reserve list and load average = %.2f", host_and_ident(FALSE
),
2855 (double)load_average
/1000.0);
2856 smtp_printf("421 %s: Too much load; please try again later\r\n", FALSE
,
2857 smtp_active_hostname
);
2861 /* Determine whether unqualified senders or recipients are permitted
2862 for this host. Unfortunately, we have to do this every time, in order to
2863 set the flags so that they can be inspected when considering qualifying
2864 addresses in the headers. For a site that permits no qualification, this
2865 won't take long, however. */
2867 f
.allow_unqualified_sender
=
2868 verify_check_host(&sender_unqualified_hosts
) == OK
;
2870 f
.allow_unqualified_recipient
=
2871 verify_check_host(&recipient_unqualified_hosts
) == OK
;
2873 /* Determine whether HELO/EHLO is required for this host. The requirement
2874 can be hard or soft. */
2876 fl
.helo_required
= verify_check_host(&helo_verify_hosts
) == OK
;
2877 if (!fl
.helo_required
)
2878 fl
.helo_verify
= verify_check_host(&helo_try_verify_hosts
) == OK
;
2880 /* Determine whether this hosts is permitted to send syntactic junk
2881 after a HELO or EHLO command. */
2883 fl
.helo_accept_junk
= verify_check_host(&helo_accept_junk_hosts
) == OK
;
2886 /* For batch SMTP input we are now done. */
2888 if (smtp_batched_input
) return TRUE
;
2890 /* If valid Proxy Protocol source is connecting, set up session.
2891 * Failure will not allow any SMTP function other than QUIT. */
2893 #ifdef SUPPORT_PROXY
2894 proxy_session
= FALSE
;
2895 f
.proxy_session_failed
= FALSE
;
2896 if (check_proxy_protocol_host())
2897 setup_proxy_protocol_host();
2900 /* Start up TLS if tls_on_connect is set. This is for supporting the legacy
2901 smtps port for use with older style SSL MTAs. */
2904 if (tls_in
.on_connect
)
2906 if (tls_server_start(tls_require_ciphers
, &user_msg
) != OK
)
2907 return smtp_log_tls_fail(user_msg
);
2908 cmd_list
[CMD_LIST_TLS_AUTH
].is_mail_cmd
= TRUE
;
2912 /* Run the connect ACL if it exists */
2915 if (acl_smtp_connect
)
2918 if ((rc
= acl_check(ACL_WHERE_CONNECT
, NULL
, acl_smtp_connect
, &user_msg
,
2921 (void) smtp_handle_acl_fail(ACL_WHERE_CONNECT
, rc
, user_msg
, log_msg
);
2926 /* Output the initial message for a two-way SMTP connection. It may contain
2927 newlines, which then cause a multi-line response to be given. */
2929 code
= US
"220"; /* Default status code */
2930 esc
= US
""; /* Default extended status code */
2931 esclen
= 0; /* Length of esc */
2935 if (!(s
= expand_string(smtp_banner
)))
2936 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "Expansion of \"%s\" (smtp_banner) "
2937 "failed: %s", smtp_banner
, expand_string_message
);
2943 smtp_message_code(&code
, &codelen
, &s
, NULL
, TRUE
);
2947 esclen
= codelen
- 4;
2951 /* Remove any terminating newlines; might as well remove trailing space too */
2954 while (p
> s
&& isspace(p
[-1])) p
--;
2957 /* It seems that CC:Mail is braindead, and assumes that the greeting message
2958 is all contained in a single IP packet. The original code wrote out the
2959 greeting using several calls to fprint/fputc, and on busy servers this could
2960 cause it to be split over more than one packet - which caused CC:Mail to fall
2961 over when it got the second part of the greeting after sending its first
2962 command. Sigh. To try to avoid this, build the complete greeting message
2963 first, and output it in one fell swoop. This gives a better chance of it
2964 ending up as a single packet. */
2966 ss
= string_get(256);
2969 do /* At least once, in case we have an empty string */
2972 uschar
*linebreak
= Ustrchr(p
, '\n');
2973 ss
= string_catn(ss
, code
, 3);
2977 ss
= string_catn(ss
, US
" ", 1);
2981 len
= linebreak
- p
;
2982 ss
= string_catn(ss
, US
"-", 1);
2984 ss
= string_catn(ss
, esc
, esclen
);
2985 ss
= string_catn(ss
, p
, len
);
2986 ss
= string_catn(ss
, US
"\r\n", 2);
2992 /* Before we write the banner, check that there is no input pending, unless
2993 this synchronisation check is disabled. */
2995 #ifndef DISABLE_PIPE_CONNECT
2996 fl
.pipe_connect_acceptable
=
2997 sender_host_address
&& verify_check_host(&pipe_connect_advertise_hosts
) == OK
;
3000 if (fl
.pipe_connect_acceptable
)
3001 f
.smtp_in_early_pipe_used
= TRUE
;
3007 unsigned n
= smtp_inend
- smtp_inptr
;
3010 log_write(0, LOG_MAIN
|LOG_REJECT
, "SMTP protocol "
3011 "synchronization error (input sent without waiting for greeting): "
3012 "rejected connection from %s input=\"%s\"", host_and_ident(TRUE
),
3013 string_printing(string_copyn(smtp_inptr
, n
)));
3014 smtp_printf("554 SMTP synchronization error\r\n", FALSE
);
3018 /* Now output the banner */
3019 /*XXX the ehlo-resp code does its own tls/nontls bit. Maybe subroutine that? */
3022 #ifndef DISABLE_PIPE_CONNECT
3023 fl
.pipe_connect_acceptable
&& pipeline_connect_sends(),
3027 string_from_gstring(ss
));
3029 /* Attempt to see if we sent the banner before the last ACK of the 3-way
3030 handshake arrived. If so we must have managed a TFO. */
3043 /*************************************************
3044 * Handle SMTP syntax and protocol errors *
3045 *************************************************/
3047 /* Write to the log for SMTP syntax errors in incoming commands, if configured
3048 to do so. Then transmit the error response. The return value depends on the
3049 number of syntax and protocol errors in this SMTP session.
3052 type error type, given as a log flag bit
3053 code response code; <= 0 means don't send a response
3054 data data to reflect in the response (can be NULL)
3055 errmess the error message
3057 Returns: -1 limit of syntax/protocol errors NOT exceeded
3058 +1 limit of syntax/protocol errors IS exceeded
3060 These values fit in with the values of the "done" variable in the main
3061 processing loop in smtp_setup_msg(). */
3064 synprot_error(int type
, int code
, uschar
*data
, uschar
*errmess
)
3068 log_write(type
, LOG_MAIN
, "SMTP %s error in \"%s\" %s %s",
3069 (type
== L_smtp_syntax_error
)? "syntax" : "protocol",
3070 string_printing(smtp_cmd_buffer
), host_and_ident(TRUE
), errmess
);
3072 if (++synprot_error_count
> smtp_max_synprot_errors
)
3075 log_write(0, LOG_MAIN
|LOG_REJECT
, "SMTP call from %s dropped: too many "
3076 "syntax or protocol errors (last command was \"%s\")",
3077 host_and_ident(FALSE
), string_printing(smtp_cmd_buffer
));
3082 smtp_printf("%d%c%s%s%s\r\n", FALSE
, code
, yield
== 1 ? '-' : ' ',
3083 data
? data
: US
"", data
? US
": " : US
"", errmess
);
3085 smtp_printf("%d Too many syntax or protocol errors\r\n", FALSE
, code
);
3094 /*************************************************
3095 * Send SMTP response, possibly multiline *
3096 *************************************************/
3098 /* There are, it seems, broken clients out there that cannot handle multiline
3099 responses. If no_multiline_responses is TRUE (it can be set from an ACL), we
3100 output nothing for non-final calls, and only the first line for anything else.
3103 code SMTP code, may involve extended status codes
3104 codelen length of smtp code; if > 4 there's an ESC
3105 final FALSE if the last line isn't the final line
3106 msg message text, possibly containing newlines
3112 smtp_respond(uschar
* code
, int codelen
, BOOL final
, uschar
*msg
)
3117 if (!final
&& f
.no_multiline_responses
) return;
3122 esclen
= codelen
- 4;
3125 /* If this is the first output for a (non-batch) RCPT command, see if all RCPTs
3126 have had the same. Note: this code is also present in smtp_printf(). It would
3127 be tidier to have it only in one place, but when it was added, it was easier to
3128 do it that way, so as not to have to mess with the code for the RCPT command,
3129 which sometimes uses smtp_printf() and sometimes smtp_respond(). */
3131 if (fl
.rcpt_in_progress
)
3133 if (rcpt_smtp_response
== NULL
)
3134 rcpt_smtp_response
= string_copy(msg
);
3135 else if (fl
.rcpt_smtp_response_same
&&
3136 Ustrcmp(rcpt_smtp_response
, msg
) != 0)
3137 fl
.rcpt_smtp_response_same
= FALSE
;
3138 fl
.rcpt_in_progress
= FALSE
;
3141 /* Now output the message, splitting it up into multiple lines if necessary.
3142 We only handle pipelining these responses as far as nonfinal/final groups,
3143 not the whole MAIL/RCPT/DATA response set. */
3147 uschar
*nl
= Ustrchr(msg
, '\n');
3150 smtp_printf("%.3s%c%.*s%s\r\n", !final
, code
, final
? ' ':'-', esclen
, esc
, msg
);
3153 else if (nl
[1] == 0 || f
.no_multiline_responses
)
3155 smtp_printf("%.3s%c%.*s%.*s\r\n", !final
, code
, final
? ' ':'-', esclen
, esc
,
3156 (int)(nl
- msg
), msg
);
3161 smtp_printf("%.3s-%.*s%.*s\r\n", TRUE
, code
, esclen
, esc
, (int)(nl
- msg
), msg
);
3163 while (isspace(*msg
)) msg
++;
3171 /*************************************************
3172 * Parse user SMTP message *
3173 *************************************************/
3175 /* This function allows for user messages overriding the response code details
3176 by providing a suitable response code string at the start of the message
3177 user_msg. Check the message for starting with a response code and optionally an
3178 extended status code. If found, check that the first digit is valid, and if so,
3179 change the code pointer and length to use the replacement. An invalid code
3180 causes a panic log; in this case, if the log messages is the same as the user
3181 message, we must also adjust the value of the log message to show the code that
3182 is actually going to be used (the original one).
3184 This function is global because it is called from receive.c as well as within
3187 Note that the code length returned includes the terminating whitespace
3188 character, which is always included in the regex match.
3191 code SMTP code, may involve extended status codes
3192 codelen length of smtp code; if > 4 there's an ESC
3194 log_msg optional log message, to be adjusted with the new SMTP code
3195 check_valid if true, verify the response code
3201 smtp_message_code(uschar
**code
, int *codelen
, uschar
**msg
, uschar
**log_msg
,
3207 if (!msg
|| !*msg
) return;
3209 if ((n
= pcre_exec(regex_smtp_code
, NULL
, CS
*msg
, Ustrlen(*msg
), 0,
3210 PCRE_EOPT
, ovector
, sizeof(ovector
)/sizeof(int))) < 0) return;
3212 if (check_valid
&& (*msg
)[0] != (*code
)[0])
3214 log_write(0, LOG_MAIN
|LOG_PANIC
, "configured error code starts with "
3215 "incorrect digit (expected %c) in \"%s\"", (*code
)[0], *msg
);
3216 if (log_msg
!= NULL
&& *log_msg
== *msg
)
3217 *log_msg
= string_sprintf("%s %s", *code
, *log_msg
+ ovector
[1]);
3222 *codelen
= ovector
[1]; /* Includes final space */
3224 *msg
+= ovector
[1]; /* Chop the code off the message */
3231 /*************************************************
3232 * Handle an ACL failure *
3233 *************************************************/
3235 /* This function is called when acl_check() fails. As well as calls from within
3236 this module, it is called from receive.c for an ACL after DATA. It sorts out
3237 logging the incident, and sends the error response. A message containing
3238 newlines is turned into a multiline SMTP response, but for logging, only the
3241 There's a table of default permanent failure response codes to use in
3242 globals.c, along with the table of names. VFRY is special. Despite RFC1123 it
3243 defaults disabled in Exim. However, discussion in connection with RFC 821bis
3244 (aka RFC 2821) has concluded that the response should be 252 in the disabled
3245 state, because there are broken clients that try VRFY before RCPT. A 5xx
3246 response should be given only when the address is positively known to be
3247 undeliverable. Sigh. We return 252 if there is no VRFY ACL or it provides
3248 no explicit code, but if there is one we let it know best.
3249 Also, for ETRN, 458 is given on refusal, and for AUTH, 503.
3251 From Exim 4.63, it is possible to override the response code details by
3252 providing a suitable response code string at the start of the message provided
3253 in user_msg. The code's first digit is checked for validity.
3256 where where the ACL was called from
3258 user_msg a message that can be included in an SMTP response
3259 log_msg a message for logging
3261 Returns: 0 in most cases
3262 2 if the failure code was FAIL_DROP, in which case the
3263 SMTP connection should be dropped (this value fits with the
3264 "done" variable in smtp_setup_msg() below)
3268 smtp_handle_acl_fail(int where
, int rc
, uschar
*user_msg
, uschar
*log_msg
)
3270 BOOL drop
= rc
== FAIL_DROP
;
3274 uschar
*sender_info
= US
"";
3276 #ifdef WITH_CONTENT_SCAN
3277 where
== ACL_WHERE_MIME
? US
"during MIME ACL checks" :
3279 where
== ACL_WHERE_PREDATA
? US
"DATA" :
3280 where
== ACL_WHERE_DATA
? US
"after DATA" :
3281 #ifndef DISABLE_PRDR
3282 where
== ACL_WHERE_PRDR
? US
"after DATA PRDR" :
3285 string_sprintf("%s %s", acl_wherenames
[where
], smtp_cmd_data
) :
3286 string_sprintf("%s in \"connect\" ACL", acl_wherenames
[where
]);
3288 if (drop
) rc
= FAIL
;
3290 /* Set the default SMTP code, and allow a user message to change it. */
3292 smtp_code
= rc
== FAIL
? acl_wherecodes
[where
] : US
"451";
3293 smtp_message_code(&smtp_code
, &codelen
, &user_msg
, &log_msg
,
3294 where
!= ACL_WHERE_VRFY
);
3296 /* We used to have sender_address here; however, there was a bug that was not
3297 updating sender_address after a rewrite during a verify. When this bug was
3298 fixed, sender_address at this point became the rewritten address. I'm not sure
3299 this is what should be logged, so I've changed to logging the unrewritten
3300 address to retain backward compatibility. */
3302 #ifndef WITH_CONTENT_SCAN
3303 if (where
== ACL_WHERE_RCPT
|| where
== ACL_WHERE_DATA
)
3305 if (where
== ACL_WHERE_RCPT
|| where
== ACL_WHERE_DATA
|| where
== ACL_WHERE_MIME
)
3308 sender_info
= string_sprintf("F=<%s>%s%s%s%s ",
3309 sender_address_unrewritten
? sender_address_unrewritten
: sender_address
,
3310 sender_host_authenticated
? US
" A=" : US
"",
3311 sender_host_authenticated
? sender_host_authenticated
: US
"",
3312 sender_host_authenticated
&& authenticated_id
? US
":" : US
"",
3313 sender_host_authenticated
&& authenticated_id
? authenticated_id
: US
""
3317 /* If there's been a sender verification failure with a specific message, and
3318 we have not sent a response about it yet, do so now, as a preliminary line for
3319 failures, but not defers. However, always log it for defer, and log it for fail
3320 unless the sender_verify_fail log selector has been turned off. */
3322 if (sender_verified_failed
&&
3323 !testflag(sender_verified_failed
, af_sverify_told
))
3325 BOOL save_rcpt_in_progress
= fl
.rcpt_in_progress
;
3326 fl
.rcpt_in_progress
= FALSE
; /* So as not to treat these as the error */
3328 setflag(sender_verified_failed
, af_sverify_told
);
3330 if (rc
!= FAIL
|| LOGGING(sender_verify_fail
))
3331 log_write(0, LOG_MAIN
|LOG_REJECT
, "%s sender verify %s for <%s>%s",
3332 host_and_ident(TRUE
),
3333 ((sender_verified_failed
->special_action
& 255) == DEFER
)? "defer":"fail",
3334 sender_verified_failed
->address
,
3335 (sender_verified_failed
->message
== NULL
)? US
"" :
3336 string_sprintf(": %s", sender_verified_failed
->message
));
3338 if (rc
== FAIL
&& sender_verified_failed
->user_message
)
3339 smtp_respond(smtp_code
, codelen
, FALSE
, string_sprintf(
3340 testflag(sender_verified_failed
, af_verify_pmfail
)?
3341 "Postmaster verification failed while checking <%s>\n%s\n"
3342 "Several RFCs state that you are required to have a postmaster\n"
3343 "mailbox for each mail domain. This host does not accept mail\n"
3344 "from domains whose servers reject the postmaster address."
3346 testflag(sender_verified_failed
, af_verify_nsfail
)?
3347 "Callback setup failed while verifying <%s>\n%s\n"
3348 "The initial connection, or a HELO or MAIL FROM:<> command was\n"
3349 "rejected. Refusing MAIL FROM:<> does not help fight spam, disregards\n"
3350 "RFC requirements, and stops you from receiving standard bounce\n"
3351 "messages. This host does not accept mail from domains whose servers\n"
3354 "Verification failed for <%s>\n%s",
3355 sender_verified_failed
->address
,
3356 sender_verified_failed
->user_message
));
3358 fl
.rcpt_in_progress
= save_rcpt_in_progress
;
3361 /* Sort out text for logging */
3363 log_msg
= log_msg
? string_sprintf(": %s", log_msg
) : US
"";
3364 if ((lognl
= Ustrchr(log_msg
, '\n'))) *lognl
= 0;
3366 /* Send permanent failure response to the command, but the code used isn't
3367 always a 5xx one - see comments at the start of this function. If the original
3368 rc was FAIL_DROP we drop the connection and yield 2. */
3371 smtp_respond(smtp_code
, codelen
, TRUE
,
3372 user_msg
? user_msg
: US
"Administrative prohibition");
3374 /* Send temporary failure response to the command. Don't give any details,
3375 unless acl_temp_details is set. This is TRUE for a callout defer, a "defer"
3376 verb, and for a header verify when smtp_return_error_details is set.
3378 This conditional logic is all somewhat of a mess because of the odd
3379 interactions between temp_details and return_error_details. One day it should
3380 be re-implemented in a tidier fashion. */
3383 if (f
.acl_temp_details
&& user_msg
)
3385 if ( smtp_return_error_details
3386 && sender_verified_failed
3387 && sender_verified_failed
->message
3389 smtp_respond(smtp_code
, codelen
, FALSE
, sender_verified_failed
->message
);
3391 smtp_respond(smtp_code
, codelen
, TRUE
, user_msg
);
3394 smtp_respond(smtp_code
, codelen
, TRUE
,
3395 US
"Temporary local problem - please try later");
3397 /* Log the incident to the logs that are specified by log_reject_target
3398 (default main, reject). This can be empty to suppress logging of rejections. If
3399 the connection is not forcibly to be dropped, return 0. Otherwise, log why it
3400 is closing if required and return 2. */
3402 if (log_reject_target
!= 0)
3405 gstring
* g
= s_tlslog(NULL
);
3406 uschar
* tls
= string_from_gstring(g
);
3407 if (!tls
) tls
= US
"";
3409 uschar
* tls
= US
"";
3411 log_write(where
== ACL_WHERE_CONNECT
? L_connection_reject
: 0,
3412 log_reject_target
, "%s%s%s %s%srejected %s%s",
3413 LOGGING(dnssec
) && sender_host_dnssec
? US
" DS" : US
"",
3414 host_and_ident(TRUE
),
3417 rc
== FAIL
? US
"" : US
"temporarily ",
3421 if (!drop
) return 0;
3423 log_write(L_smtp_connection
, LOG_MAIN
, "%s closed by DROP in ACL",
3424 smtp_get_connection_info());
3426 /* Run the not-quit ACL, but without any custom messages. This should not be a
3427 problem, because we get here only if some other ACL has issued "drop", and
3428 in that case, *its* custom messages will have been used above. */
3430 smtp_notquit_exit(US
"acl-drop", NULL
, NULL
);
3437 /*************************************************
3438 * Handle SMTP exit when QUIT is not given *
3439 *************************************************/
3441 /* This function provides a logging/statistics hook for when an SMTP connection
3442 is dropped on the floor or the other end goes away. It's a global function
3443 because it's called from receive.c as well as this module. As well as running
3444 the NOTQUIT ACL, if there is one, this function also outputs a final SMTP
3445 response, either with a custom message from the ACL, or using a default. There
3446 is one case, however, when no message is output - after "drop". In that case,
3447 the ACL that obeyed "drop" has already supplied the custom message, and NULL is
3448 passed to this function.
3450 In case things go wrong while processing this function, causing an error that
3451 may re-enter this function, there is a recursion check.
3454 reason What $smtp_notquit_reason will be set to in the ACL;
3455 if NULL, the ACL is not run
3456 code The error code to return as part of the response
3457 defaultrespond The default message if there's no user_msg
3463 smtp_notquit_exit(uschar
*reason
, uschar
*code
, uschar
*defaultrespond
, ...)
3466 uschar
*user_msg
= NULL
;
3467 uschar
*log_msg
= NULL
;
3469 /* Check for recursive call */
3471 if (fl
.smtp_exit_function_called
)
3473 log_write(0, LOG_PANIC
, "smtp_notquit_exit() called more than once (%s)",
3477 fl
.smtp_exit_function_called
= TRUE
;
3479 /* Call the not-QUIT ACL, if there is one, unless no reason is given. */
3481 if (acl_smtp_notquit
&& reason
)
3483 smtp_notquit_reason
= reason
;
3484 if ((rc
= acl_check(ACL_WHERE_NOTQUIT
, NULL
, acl_smtp_notquit
, &user_msg
,
3485 &log_msg
)) == ERROR
)
3486 log_write(0, LOG_MAIN
|LOG_PANIC
, "ACL for not-QUIT returned ERROR: %s",
3490 /* If the connection was dropped, we certainly are no longer talking TLS */
3491 tls_in
.active
.sock
= -1;
3493 /* Write an SMTP response if we are expected to give one. As the default
3494 responses are all internal, they should be reasonable size. */
3496 if (code
&& defaultrespond
)
3499 smtp_respond(code
, 3, TRUE
, user_msg
);