1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
9 /* Functions for writing log files. The code for maintaining datestamped
10 log files was originally contributed by Tony Sheen. */
15 #define LOG_NAME_SIZE 256
16 #define MAX_SYSLOG_LEN 870
18 #define LOG_MODE_FILE 1
19 #define LOG_MODE_SYSLOG 2
21 enum { lt_main, lt_reject, lt_panic, lt_debug };
23 static uschar *log_names[] = { US"main", US"reject", US"panic", US"debug" };
27 /*************************************************
28 * Local static variables *
29 *************************************************/
31 static uschar mainlog_name[LOG_NAME_SIZE];
32 static uschar rejectlog_name[LOG_NAME_SIZE];
33 static uschar debuglog_name[LOG_NAME_SIZE];
35 static uschar *mainlog_datestamp = NULL;
36 static uschar *rejectlog_datestamp = NULL;
38 static int mainlogfd = -1;
39 static int rejectlogfd = -1;
40 static ino_t mainlog_inode = 0;
41 static ino_t rejectlog_inode = 0;
43 static uschar *panic_save_buffer = NULL;
44 static BOOL panic_recurseflag = FALSE;
46 static BOOL syslog_open = FALSE;
47 static BOOL path_inspected = FALSE;
48 static int logging_mode = LOG_MODE_FILE;
49 static uschar *file_path = US"";
51 static size_t pid_position[2];
54 /* These should be kept in-step with the private delivery error
55 number definitions in macros.h */
57 static const uschar * exim_errstrings[] = {
80 US"Exim-imposed quota",
82 US"Delivery filter process failure",
83 US"Delivery add/remove header failure",
84 US"Delivery write incomplete error",
85 US"Some expansion failed",
86 US"Failed to get gid",
87 US"Failed to get uid",
88 US"Unset or non-existent transport",
89 US"MBX length mismatch",
90 US"Lookup failed routing or in smtp tpt",
91 US"Can't match format in appendfile",
92 US"Creation outside home in appendfile",
93 US"Can't check a list; lookup defer",
95 US"Failed to start TLS session",
96 US"Mandatory TLS session not started",
97 US"Failed to chown a file",
98 US"Failed to create a pipe",
100 US"When required by client",
101 US"Used internally in smtp transport",
102 US"RCPT gave 4xx error",
103 US"MAIL gave 4xx error",
104 US"DATA gave 4xx error",
105 US"Negotiation failed for proxy configured host",
106 US"Authenticator 'other' failure",
107 US"target not supporting SMTPUTF8",
109 US"tainted filename",
111 US"Not time for routing",
112 US"Not time for local delivery",
113 US"Not time for any remote host",
114 US"Local-only delivery",
115 US"Domain in queue_domains",
116 US"Transport concurrency limit",
117 US"Event requests alternate response",
121 /************************************************/
125 return err < 0 ? exim_errstrings[-err] : CUS strerror(err);
128 /*************************************************
130 *************************************************/
132 /* The given string is split into sections according to length, or at embedded
133 newlines, and syslogged as a numbered sequence if it is overlong or if there is
134 more than one line. However, if we are running in the test harness, do not do
135 anything. (The test harness doesn't use syslog - for obvious reasons - but we
136 can get here if there is a failure to open the panic log.)
139 priority syslog priority
140 s the string to be written
146 write_syslog(int priority, const uschar *s)
151 if (!syslog_pid && LOGGING(pid))
152 s = string_sprintf("%.*s%s", (int)pid_position[0], s, s + pid_position[1]);
153 if (!syslog_timestamp)
155 len = log_timezone ? 26 : 20;
156 if (LOGGING(millisec)) len += 4;
163 if (!syslog_open && !f.running_in_test_harness)
165 # ifdef SYSLOG_LOG_PID
166 openlog(CS syslog_processname, LOG_PID|LOG_CONS, syslog_facility);
168 openlog(CS syslog_processname, LOG_CONS, syslog_facility);
174 /* First do a scan through the message in order to determine how many lines
175 it is going to end up as. Then rescan to output it. */
177 for (int pass = 0; pass < 2; pass++)
179 const uschar * ss = s;
180 for (int i = 1, tlen = len; tlen > 0; i++)
183 uschar *nlptr = Ustrchr(ss, '\n');
184 if (nlptr != NULL) plen = nlptr - ss;
185 #ifndef SYSLOG_LONG_LINES
186 if (plen > MAX_SYSLOG_LEN) plen = MAX_SYSLOG_LEN;
189 if (ss[plen] == '\n') tlen--; /* chars left */
193 else if (f.running_in_test_harness)
195 fprintf(stderr, "SYSLOG: '%.*s'\n", plen, ss);
197 fprintf(stderr, "SYSLOG: '[%d%c%d] %.*s'\n", i,
198 ss[plen] == '\n' && tlen != 0 ? '\\' : '/',
199 linecount, plen, ss);
202 syslog(priority, "%.*s", plen, ss);
204 syslog(priority, "[%d%c%d] %.*s", i,
205 ss[plen] == '\n' && tlen != 0 ? '\\' : '/',
206 linecount, plen, ss);
209 if (*ss == '\n') ss++;
216 /*************************************************
218 *************************************************/
220 /* This is called when Exim is dying as a result of something going wrong in
221 the logging, or after a log call with LOG_PANIC_DIE set. Optionally write a
222 message to debug_file or a stderr file, if they exist. Then, if in the middle
223 of accepting a message, throw it away tidily by calling receive_bomb_out();
224 this will attempt to send an SMTP response if appropriate. Passing NULL as the
225 first argument stops it trying to run the NOTQUIT ACL (which might try further
226 logging and thus cause problems). Otherwise, try to close down an outstanding
230 s1 Error message to write to debug_file and/or stderr and syslog
231 s2 Error message for any SMTP call that is in progress
232 Returns: The function does not return
236 die(uschar *s1, uschar *s2)
240 write_syslog(LOG_CRIT, s1);
241 if (debug_file) debug_printf("%s\n", s1);
242 if (log_stderr && log_stderr != debug_file)
243 fprintf(log_stderr, "%s\n", s1);
245 if (f.receive_call_bombout) receive_bomb_out(NULL, s2); /* does not return */
246 if (smtp_input) smtp_closedown(s2);
247 exim_exit(EXIT_FAILURE);
252 /*************************************************
253 * Create a log file *
254 *************************************************/
256 /* This function is called to create and open a log file. It may be called in a
257 subprocess when the original process is root.
262 The file name has been build in a working buffer, so it is permissible to
263 overwrite it temporarily if it is necessary to create the directory.
265 Returns: a file descriptor, or < 0 on failure (errno set)
269 log_open_already_exim(uschar * const name)
272 const int flags = O_WRONLY | O_APPEND | O_CREAT | O_NONBLOCK;
274 if (geteuid() != exim_uid)
280 fd = Uopen(name, flags, LOG_MODE);
282 /* If creation failed, attempt to build a log directory in case that is the
285 if (fd < 0 && errno == ENOENT)
288 uschar *lastslash = Ustrrchr(name, '/');
290 created = directory_make(NULL, name, LOG_DIRECTORY_MODE, FALSE);
293 debug_printf("created log directory %s\n", name);
295 debug_printf("failed to create log directory %s: %s\n", name, strerror(errno));
297 if (created) fd = Uopen(name, flags, LOG_MODE);
305 /* Inspired by OpenSSH's mm_send_fd(). Thanks!
306 Send fd over socketpair.
307 Return: true iff good.
311 log_send_fd(const int sock, const int fd)
316 char buf[CMSG_SPACE(sizeof(int))];
318 struct cmsghdr *cmsg;
320 struct iovec vec = {.iov_base = &ch, .iov_len = 1};
323 memset(&msg, 0, sizeof(msg));
324 memset(&cmsgbuf, 0, sizeof(cmsgbuf));
325 msg.msg_control = &cmsgbuf.buf;
326 msg.msg_controllen = sizeof(cmsgbuf.buf);
328 cmsg = CMSG_FIRSTHDR(&msg);
329 cmsg->cmsg_len = CMSG_LEN(sizeof(int));
330 cmsg->cmsg_level = SOL_SOCKET;
331 cmsg->cmsg_type = SCM_RIGHTS;
332 *(int *)CMSG_DATA(cmsg) = fd;
337 while ((n = sendmsg(sock, &msg, 0)) == -1 && errno == EINTR);
341 /* Inspired by OpenSSH's mm_receive_fd(). Thanks!
342 Return fd passed over socketpair, or -1 on error.
346 log_recv_fd(const int sock)
351 char buf[CMSG_SPACE(sizeof(int))];
353 struct cmsghdr *cmsg;
355 struct iovec vec = {.iov_base = &ch, .iov_len = 1};
359 memset(&msg, 0, sizeof(msg));
363 memset(&cmsgbuf, 0, sizeof(cmsgbuf));
364 msg.msg_control = &cmsgbuf.buf;
365 msg.msg_controllen = sizeof(cmsgbuf.buf);
367 while ((n = recvmsg(sock, &msg, 0)) == -1 && errno == EINTR) ;
368 if (n != 1 || ch != 'A') return -1;
370 if (!(cmsg = CMSG_FIRSTHDR(&msg))) return -1;
371 if (cmsg->cmsg_type != SCM_RIGHTS) return -1;
372 if ((fd = *(const int *)CMSG_DATA(cmsg)) < 0) return -1;
378 /*************************************************
379 * Create a log file as the exim user *
380 *************************************************/
382 /* This function is called when we are root to spawn an exim:exim subprocess
383 in which we can create a log file. It must be signal-safe since it is called
384 by the usr1_handler().
389 Returns: a file descriptor, or < 0 on failure (errno set)
393 log_open_as_exim(uschar * const name)
396 const uid_t euid = geteuid();
398 if (euid == exim_uid)
399 fd = log_open_already_exim(name);
400 else if (euid == root_uid)
403 if (socketpair(AF_UNIX, SOCK_STREAM, 0, sock) == 0)
405 const pid_t pid = fork();
408 (void)close(sock[0]);
409 if ( setgroups(1, &exim_gid) != 0
410 || setgid(exim_gid) != 0
411 || setuid(exim_uid) != 0
413 || getuid() != exim_uid || geteuid() != exim_uid
414 || getgid() != exim_gid || getegid() != exim_gid
416 || (fd = log_open_already_exim(name)) < 0
417 || !log_send_fd(sock[1], fd)
418 ) _exit(EXIT_FAILURE);
419 (void)close(sock[1]);
423 (void)close(sock[1]);
426 fd = log_recv_fd(sock[0]);
427 while (waitpid(pid, NULL, 0) == -1 && errno == EINTR);
429 (void)close(sock[0]);
436 flags = fcntl(fd, F_GETFD);
437 if (flags != -1) (void)fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
438 flags = fcntl(fd, F_GETFL);
439 if (flags != -1) (void)fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
450 /*************************************************
452 *************************************************/
454 /* This function opens one of a number of logs, creating the log directory if
455 it does not exist. This may be called recursively on failure, in order to open
458 The directory is in the static variable file_path. This is static so that it
459 the work of sorting out the path is done just once per Exim process.
461 Exim is normally configured to avoid running as root wherever possible, the log
462 files must be owned by the non-privileged exim user. To ensure this, first try
463 an open without O_CREAT - most of the time this will succeed. If it fails, try
464 to create the file; if running as root, this must be done in a subprocess to
468 fd where to return the resulting file descriptor
469 type lt_main, lt_reject, lt_panic, or lt_debug
470 tag optional tag to include in the name (only hooked up for debug)
476 open_log(int *fd, int type, uschar *tag)
480 uschar buffer[LOG_NAME_SIZE];
482 /* The names of the log files are controlled by file_path. The panic log is
483 written to the same directory as the main and reject logs, but its name does
484 not have a datestamp. The use of datestamps is indicated by %D/%M in file_path.
485 When opening the panic log, if %D or %M is present, we remove the datestamp
486 from the generated name; if it is at the start, remove a following
487 non-alphanumeric character as well; otherwise, remove a preceding
488 non-alphanumeric character. This is definitely kludgy, but it sort of does what
489 people want, I hope. */
491 ok = string_format(buffer, sizeof(buffer), CS file_path, log_names[type]);
496 /* Save the name of the mainlog for rollover processing. Without a datestamp,
497 it gets statted to see if it has been cycled. With a datestamp, the datestamp
498 will be compared. The static slot for saving it is the same size as buffer,
499 and the text has been checked above to fit, so this use of strcpy() is OK. */
501 Ustrcpy(mainlog_name, buffer);
502 if (string_datestamp_offset > 0)
503 mainlog_datestamp = mainlog_name + string_datestamp_offset;
507 /* Ditto for the reject log */
509 Ustrcpy(rejectlog_name, buffer);
510 if (string_datestamp_offset > 0)
511 rejectlog_datestamp = rejectlog_name + string_datestamp_offset;
515 /* and deal with the debug log (which keeps the datestamp, but does not
518 Ustrcpy(debuglog_name, buffer);
521 /* this won't change the offset of the datestamp */
522 ok2 = string_format(buffer, sizeof(buffer), "%s%s",
525 Ustrcpy(debuglog_name, buffer);
530 /* Remove any datestamp if this is the panic log. This is rare, so there's no
531 need to optimize getting the datestamp length. We remove one non-alphanumeric
532 char afterwards if at the start, otherwise one before. */
534 if (string_datestamp_offset >= 0)
536 uschar * from = buffer + string_datestamp_offset;
537 uschar * to = from + string_datestamp_length;
539 if (from == buffer || from[-1] == '/')
541 if (!isalnum(*to)) to++;
544 if (!isalnum(from[-1])) from--;
546 /* This copy is ok, because we know that to is a substring of from. But
547 due to overlap we must use memmove() not Ustrcpy(). */
548 memmove(from, to, Ustrlen(to)+1);
553 /* If the file name is too long, it is an unrecoverable disaster */
556 die(US"exim: log file path too long: aborting",
557 US"Logging failure; please try later");
559 /* We now have the file name. After a successful open, return. */
561 *fd = log_open_as_exim(buffer);
568 /* Creation failed. There are some circumstances in which we get here when
569 the effective uid is not root or exim, which is the problem. (For example, a
570 non-setuid binary with log_arguments set, called in certain ways.) Rather than
571 just bombing out, force the log to stderr and carry on if stderr is available.
574 if (euid != root_uid && euid != exim_uid && log_stderr)
576 *fd = fileno(log_stderr);
580 /* Otherwise this is a disaster. This call is deliberately ONLY to the panic
581 log. If possible, save a copy of the original line that was being logged. If we
582 are recursing (can't open the panic log either), the pointer will already be
583 set. Also, when we had to use a subprocess for the create we didn't retrieve
584 errno from it, so get the error from the open attempt above (which is often
585 meaningful enough, so leave it). */
587 if (!panic_save_buffer)
588 if ((panic_save_buffer = US malloc(LOG_BUFFER_SIZE)))
589 memcpy(panic_save_buffer, log_buffer, LOG_BUFFER_SIZE);
591 log_write(0, LOG_PANIC_DIE, "Cannot open %s log file \"%s\": %s: "
592 "euid=%d egid=%d", log_names[type], buffer, strerror(errno), euid, getegid());
600 if (type == lt_debug) unlink(CS debuglog_name);
605 /*************************************************
606 * Add configuration file info to log line *
607 *************************************************/
609 /* This is put in a function because it's needed twice (once for debugging,
613 ptr pointer to the end of the line we are building
616 Returns: updated pointer
620 log_config_info(gstring * g, int flags)
622 g = string_cat(g, US"Exim configuration error");
624 if (flags & (LOG_CONFIG_FOR & ~LOG_CONFIG))
625 return string_cat(g, US" for ");
627 if (flags & (LOG_CONFIG_IN & ~LOG_CONFIG))
628 g = string_fmt_append(g, " in line %d of %s", config_lineno, config_filename);
630 return string_catn(g, US":\n ", 4);
634 /*************************************************
635 * A write() operation failed *
636 *************************************************/
638 /* This function is called when write() fails on anything other than the panic
639 log, which can happen if a disk gets full or a file gets too large or whatever.
640 We try to save the relevant message in the panic_save buffer before crashing
643 The potential invoker should probably not call us for EINTR -1 writes. But
644 otherwise, short writes are bad as we don't do non-blocking writes to fds
645 subject to flow control. (If we do, that's new and the logic of this should
649 name the name of the log being written
650 length the string length being written
651 rc the return value from write()
653 Returns: does not return
657 log_write_failed(uschar *name, int length, int rc)
659 int save_errno = errno;
661 if (!panic_save_buffer)
662 if ((panic_save_buffer = US malloc(LOG_BUFFER_SIZE)))
663 memcpy(panic_save_buffer, log_buffer, LOG_BUFFER_SIZE);
665 log_write(0, LOG_PANIC_DIE, "failed to write to %s: length=%d result=%d "
666 "errno=%d (%s)", name, length, rc, save_errno,
667 (save_errno == 0)? "write incomplete" : strerror(save_errno));
673 /*************************************************
674 * Write to an fd, retrying after signals *
675 *************************************************/
677 /* Basic write to fd for logs, handling EINTR.
680 fd the fd to write to
681 buf the string to write
682 length the string length being written
685 length actually written, persisting an errno from write()
688 write_to_fd_buf(int fd, const uschar *buf, size_t length)
691 size_t total_written = 0;
692 const uschar *p = buf;
693 size_t left = length;
697 wrote = write(fd, p, left);
698 if (wrote == (ssize_t)-1)
700 if (errno == EINTR) continue;
703 total_written += wrote;
712 return total_written;
716 /* Pull the file out of the configured or the compiled-in list.
717 Called for an empty log_file_path element, for debug logging activation
718 when file_path has not previously been set, and from the appenfile transport setup. */
721 set_file_path(BOOL *multiple)
724 int sep = ':'; /* Fixed separator - outside use */
725 const uschar *ss = *log_file_path ? log_file_path : US LOG_FILE_PATH;
728 for (logging_mode = 0;
729 s = string_nextinlist(&ss, &sep, log_buffer, LOG_BUFFER_SIZE); )
731 if (Ustrcmp(s, "syslog") == 0)
732 logging_mode |= LOG_MODE_SYSLOG;
733 else if (!(logging_mode & LOG_MODE_FILE)) /* no file yet */
735 /* If a non-empty path is given, use it */
738 file_path = string_copy(s);
740 /* If handling the config option, and the element is empty, we want to use
741 the first non-empty, non-syslog item in LOG_FILE_PATH, if there is one,
742 since the value of log_file_path may have been set at runtime. If there is
743 no such item, use the ultimate default in the spool directory. */
745 else if (*log_file_path && LOG_FILE_PATH[0])
747 ss = US LOG_FILE_PATH;
751 logging_mode |= LOG_MODE_FILE;
754 if (multiple) *multiple = TRUE;
757 logging_mode = LOG_MODE_FILE;
759 /* Set up the ultimate default if necessary. */
761 if (logging_mode & LOG_MODE_FILE && !*file_path)
762 file_path = string_sprintf("%s/log/%%slog", spool_directory);
769 /* avoid closing it if it is closed already or if we do not see a chance
770 to open the file mainlog later again */
771 if (mainlogfd < 0 /* already closed */
772 || !(geteuid() == 0 || geteuid() == exim_uid))
774 (void)close(mainlogfd);
779 /*************************************************
780 * Write message to log file *
781 *************************************************/
783 /* Exim can be configured to log to local files, or use syslog, or both. This
784 is controlled by the setting of log_file_path. The following cases are
787 log_file_path = "" write files in the spool/log directory
788 log_file_path = "xxx" write files in the xxx directory
789 log_file_path = "syslog" write to syslog
790 log_file_path = "syslog : xxx" write to syslog and to files (any order)
792 The message always gets '\n' added on the end of it, since more than one
793 process may be writing to the log at once and we don't want intermingling to
794 happen in the middle of lines. To be absolutely sure of this we write the data
795 into a private buffer and then put it out in a single write() call.
797 The flags determine which log(s) the message is written to, or for syslogging,
798 which priority to use, and in the case of the panic log, whether the process
799 should die afterwards.
801 The variable really_exim is TRUE only when exim is running in privileged state
802 (i.e. not with a changed configuration or with testing options such as -brw).
803 If it is not, don't try to write to the log because permission will probably be
806 Avoid actually writing to the logs when exim is called with -bv or -bt to
807 test an address, but take other actions, such as panicking.
809 In Exim proper, the buffer for building the message is got at start-up, so that
810 nothing gets done if it can't be got. However, some functions that are also
811 used in utilities occasionally obey log_write calls in error situations, and it
812 is simplest to put a single malloc() here rather than put one in each utility.
813 Malloc is used directly because the store functions may call log_write().
815 If a message_id exists, we include it after the timestamp.
818 selector write to main log or LOG_INFO only if this value is zero, or if
819 its bit is set in log_selector[0]
820 flags each bit indicates some independent action:
821 LOG_SENDER add raw sender to the message
822 LOG_RECIPIENTS add raw recipients list to message
823 LOG_CONFIG add "Exim configuration error"
824 LOG_CONFIG_FOR add " for " instead of ":\n "
825 LOG_CONFIG_IN add " in line x[ of file y]"
826 LOG_MAIN write to main log or syslog LOG_INFO
827 LOG_REJECT write to reject log or syslog LOG_NOTICE
828 LOG_PANIC write to panic log or syslog LOG_ALERT
829 LOG_PANIC_DIE write to panic log or LOG_ALERT and then crash
830 format a printf() format
831 ... arguments for format
837 log_write(unsigned int selector, int flags, const char *format, ...)
841 gstring gs = { .size = LOG_BUFFER_SIZE-1, .ptr = 0, .s = log_buffer };
845 /* If panic_recurseflag is set, we have failed to open the panic log. This is
846 the ultimate disaster. First try to write the message to a debug file and/or
847 stderr and also to syslog. If panic_save_buffer is not NULL, it contains the
848 original log line that caused the problem. Afterwards, expire. */
850 if (panic_recurseflag)
852 uschar *extra = panic_save_buffer ? panic_save_buffer : US"";
853 if (debug_file) debug_printf("%s%s", extra, log_buffer);
854 if (log_stderr && log_stderr != debug_file)
855 fprintf(log_stderr, "%s%s", extra, log_buffer);
856 if (*extra) write_syslog(LOG_CRIT, extra);
857 write_syslog(LOG_CRIT, log_buffer);
858 die(US"exim: could not open panic log - aborting: see message(s) above",
859 US"Unexpected log failure, please try later");
862 /* Ensure we have a buffer (see comment above); this should never be obeyed
863 when running Exim proper, only when running utilities. */
866 if (!(log_buffer = US malloc(LOG_BUFFER_SIZE)))
868 fprintf(stderr, "exim: failed to get store for log buffer\n");
869 exim_exit(EXIT_FAILURE);
872 /* If we haven't already done so, inspect the setting of log_file_path to
873 determine whether to log to files and/or to syslog. Bits in logging_mode
874 control this, and for file logging, the path must end up in file_path. This
875 variable must be in permanent store because it may be required again later in
880 BOOL multiple = FALSE;
881 int old_pool = store_pool;
883 store_pool = POOL_PERM;
885 /* If nothing has been set, don't waste effort... the default values for the
886 statics are file_path="" and logging_mode = LOG_MODE_FILE. */
888 if (*log_file_path) set_file_path(&multiple);
890 /* If no modes have been selected, it is a major disaster */
892 if (logging_mode == 0)
893 die(US"Neither syslog nor file logging set in log_file_path",
894 US"Unexpected logging failure");
896 /* Revert to the old store pool, and record that we've sorted out the path. */
898 store_pool = old_pool;
899 path_inspected = TRUE;
901 /* If more than one file path was given, log a complaint. This recursive call
902 should work since we have now set up the routing. */
905 log_write(0, LOG_MAIN|LOG_PANIC,
906 "More than one path given in log_file_path: using %s", file_path);
909 /* If debugging, show all log entries, but don't show headers. Do it all
910 in one go so that it doesn't get split when multi-processing. */
916 g = string_catn(&gs, US"LOG:", 4);
918 /* Show the selector that was passed into the call. */
920 for (i = 0; i < log_options_count; i++)
922 unsigned int bitnum = log_options[i].bit;
923 if (bitnum < BITWORDSIZE && selector == BIT(bitnum))
924 g = string_fmt_append(g, " %s", log_options[i].name);
927 g = string_fmt_append(g, "%s%s%s%s\n ",
928 flags & LOG_MAIN ? " MAIN" : "",
929 flags & LOG_PANIC ? " PANIC" : "",
930 (flags & LOG_PANIC_DIE) == LOG_PANIC_DIE ? " DIE" : "",
931 flags & LOG_REJECT ? " REJECT" : "");
933 if (flags & LOG_CONFIG) g = log_config_info(g, flags);
935 /* We want to be able to log tainted info, but log_buffer is directly
936 malloc'd. So use deliberately taint-nonchecking routines to build into
937 it, trusting that we will never expand the results. */
939 va_start(ap, format);
941 if (!string_vformat(g, SVFMT_TAINT_NOCHK, format, ap))
944 g = string_cat(g, US"**** log string overflowed log buffer ****");
948 g->size = LOG_BUFFER_SIZE;
949 g = string_catn(g, US"\n", 1);
950 debug_printf("%s", string_from_gstring(g));
952 gs.size = LOG_BUFFER_SIZE-1; /* Having used the buffer for debug output, */
953 gs.ptr = 0; /* reset it for the real use. */
956 /* If no log file is specified, we are in a mess. */
958 if (!(flags & (LOG_MAIN|LOG_PANIC|LOG_REJECT)))
959 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "log_write called with no log "
962 /* There are some weird circumstances in which logging is disabled. */
964 if (f.disable_logging)
966 DEBUG(D_any) debug_printf("log writing disabled\n");
967 if ((flags & LOG_PANIC_DIE) == LOG_PANIC_DIE) exim_exit(EXIT_FAILURE);
971 /* Handle disabled reject log */
973 if (!write_rejectlog) flags &= ~LOG_REJECT;
975 /* Create the main message in the log buffer. Do not include the message id
976 when called by a utility. */
978 g = string_fmt_append(&gs, "%s ", tod_stamp(tod_log));
982 if (!syslog_pid) pid_position[0] = g->ptr; /* remember begin … */
983 g = string_fmt_append(g, "[%d] ", (int)getpid());
984 if (!syslog_pid) pid_position[1] = g->ptr; /* … and end+1 of the PID */
987 if (f.really_exim && message_id[0] != 0)
988 g = string_fmt_append(g, "%s ", message_id);
990 if (flags & LOG_CONFIG)
991 g = log_config_info(g, flags);
993 va_start(ap, format);
997 /* We want to be able to log tainted info, but log_buffer is directly
998 malloc'd. So use deliberately taint-nonchecking routines to build into
999 it, trusting that we will never expand the results. */
1001 if (!string_vformat(g, SVFMT_TAINT_NOCHK, format, ap))
1004 g = string_cat(g, US"**** log string overflowed log buffer ****\n");
1009 /* Add the raw, unrewritten, sender to the message if required. This is done
1010 this way because it kind of fits with LOG_RECIPIENTS. */
1012 if ( flags & LOG_SENDER
1013 && g->ptr < LOG_BUFFER_SIZE - 10 - Ustrlen(raw_sender))
1014 g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, " from <%s>", raw_sender);
1016 /* Add list of recipients to the message if required; the raw list,
1017 before rewriting, was saved in raw_recipients. There may be none, if an ACL
1018 discarded them all. */
1020 if ( flags & LOG_RECIPIENTS
1021 && g->ptr < LOG_BUFFER_SIZE - 6
1022 && raw_recipients_count > 0)
1025 g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, " for", NULL);
1026 for (i = 0; i < raw_recipients_count; i++)
1028 uschar * s = raw_recipients[i];
1029 if (LOG_BUFFER_SIZE - g->ptr < Ustrlen(s) + 3) break;
1030 g = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, " %s", s);
1034 g = string_catn(g, US"\n", 1);
1035 string_from_gstring(g);
1037 /* Handle loggable errors when running a utility, or when address testing.
1038 Write to log_stderr unless debugging (when it will already have been written),
1039 or unless there is no log_stderr (expn called from daemon, for example). */
1041 if (!f.really_exim || f.log_testing_mode)
1043 if ( !debug_selector
1045 && (selector == 0 || (selector & log_selector[0]) != 0)
1048 fprintf(log_stderr, "LOG: %s", CS(log_buffer + 20)); /* no timestamp */
1050 fprintf(log_stderr, "%s", CS log_buffer);
1052 if ((flags & LOG_PANIC_DIE) == LOG_PANIC_DIE) exim_exit(EXIT_FAILURE);
1056 /* Handle the main log. We know that either syslog or file logging (or both) is
1057 set up. A real file gets left open during reception or delivery once it has
1058 been opened, but we don't want to keep on writing to it for too long after it
1059 has been renamed. Therefore, do a stat() and see if the inode has changed, and
1062 if ( flags & LOG_MAIN
1063 && (!selector || selector & log_selector[0]))
1065 if ( logging_mode & LOG_MODE_SYSLOG
1066 && (syslog_duplication || !(flags & (LOG_REJECT|LOG_PANIC))))
1067 write_syslog(LOG_INFO, log_buffer);
1069 if (logging_mode & LOG_MODE_FILE)
1071 struct stat statbuf;
1073 /* Check for a change to the mainlog file name when datestamping is in
1074 operation. This happens at midnight, at which point we want to roll over
1075 the file. Closing it has the desired effect. */
1077 if (mainlog_datestamp)
1079 uschar *nowstamp = tod_stamp(string_datestamp_type);
1080 if (Ustrncmp (mainlog_datestamp, nowstamp, Ustrlen(nowstamp)) != 0)
1082 (void)close(mainlogfd); /* Close the file */
1083 mainlogfd = -1; /* Clear the file descriptor */
1084 mainlog_inode = 0; /* Unset the inode */
1085 mainlog_datestamp = NULL; /* Clear the datestamp */
1089 /* Otherwise, we want to check whether the file has been renamed by a
1090 cycling script. This could be "if else", but for safety's sake, leave it as
1091 "if" so that renaming the log starts a new file even when datestamping is
1095 if (Ustat(mainlog_name, &statbuf) < 0 || statbuf.st_ino != mainlog_inode)
1098 /* If the log is closed, open it. Then write the line. */
1102 open_log(&mainlogfd, lt_main, NULL); /* No return on error */
1103 if (fstat(mainlogfd, &statbuf) >= 0) mainlog_inode = statbuf.st_ino;
1106 /* Failing to write to the log is disastrous */
1108 written_len = write_to_fd_buf(mainlogfd, g->s, g->ptr);
1109 if (written_len != g->ptr)
1111 log_write_failed(US"main log", g->ptr, written_len);
1112 /* That function does not return */
1117 /* Handle the log for rejected messages. This can be globally disabled, in
1118 which case the flags are altered above. If there are any header lines (i.e. if
1119 the rejection is happening after the DATA phase), log the recipients and the
1122 if (flags & LOG_REJECT)
1124 if (header_list && LOGGING(rejected_header))
1129 if (recipients_count > 0)
1131 /* List the sender */
1133 g2 = string_fmt_append_f(g, SVFMT_TAINT_NOCHK,
1134 "Envelope-from: <%s>\n", sender_address);
1137 /* List up to 5 recipients */
1139 g2 = string_fmt_append_f(g, SVFMT_TAINT_NOCHK,
1140 "Envelope-to: <%s>\n", recipients_list[0].address);
1143 for (i = 1; i < recipients_count && i < 5; i++)
1145 g2 = string_fmt_append_f(g, SVFMT_TAINT_NOCHK,
1146 " <%s>\n", recipients_list[i].address);
1150 if (i < recipients_count)
1152 g2 = string_fmt_append_f(g, SVFMT_TAINT_NOCHK, " ...\n", NULL);
1157 /* A header with a NULL text is an unfilled in Received: header */
1159 for (header_line * h = header_list; h; h = h->next) if (h->text)
1161 g2 = string_fmt_append_f(g, SVFMT_TAINT_NOCHK,
1162 "%c %s", h->type, h->text);
1165 else /* Buffer is full; truncate */
1167 g->ptr -= 100; /* For message and separator */
1168 if (g->s[g->ptr-1] == '\n') g->ptr--;
1169 g = string_cat(g, US"\n*** truncated ***\n");
1175 /* Write to syslog or to a log file */
1177 if ( logging_mode & LOG_MODE_SYSLOG
1178 && (syslog_duplication || !(flags & LOG_PANIC)))
1179 write_syslog(LOG_NOTICE, string_from_gstring(g));
1181 /* Check for a change to the rejectlog file name when datestamping is in
1182 operation. This happens at midnight, at which point we want to roll over
1183 the file. Closing it has the desired effect. */
1185 if (logging_mode & LOG_MODE_FILE)
1187 struct stat statbuf;
1189 if (rejectlog_datestamp)
1191 uschar *nowstamp = tod_stamp(string_datestamp_type);
1192 if (Ustrncmp (rejectlog_datestamp, nowstamp, Ustrlen(nowstamp)) != 0)
1194 (void)close(rejectlogfd); /* Close the file */
1195 rejectlogfd = -1; /* Clear the file descriptor */
1196 rejectlog_inode = 0; /* Unset the inode */
1197 rejectlog_datestamp = NULL; /* Clear the datestamp */
1201 /* Otherwise, we want to check whether the file has been renamed by a
1202 cycling script. This could be "if else", but for safety's sake, leave it as
1203 "if" so that renaming the log starts a new file even when datestamping is
1206 if (rejectlogfd >= 0)
1207 if (Ustat(rejectlog_name, &statbuf) < 0 ||
1208 statbuf.st_ino != rejectlog_inode)
1210 (void)close(rejectlogfd);
1212 rejectlog_inode = 0;
1215 /* Open the file if necessary, and write the data */
1217 if (rejectlogfd < 0)
1219 open_log(&rejectlogfd, lt_reject, NULL); /* No return on error */
1220 if (fstat(rejectlogfd, &statbuf) >= 0) rejectlog_inode = statbuf.st_ino;
1223 written_len = write_to_fd_buf(rejectlogfd, g->s, g->ptr);
1224 if (written_len != g->ptr)
1226 log_write_failed(US"reject log", g->ptr, written_len);
1227 /* That function does not return */
1233 /* Handle the panic log, which is not kept open like the others. If it fails to
1234 open, there will be a recursive call to log_write(). We detect this above and
1235 attempt to write to the system log as a last-ditch try at telling somebody. In
1236 all cases except mua_wrapper, try to write to log_stderr. */
1238 if (flags & LOG_PANIC)
1240 if (log_stderr && log_stderr != debug_file && !mua_wrapper)
1241 fprintf(log_stderr, "%s", CS string_from_gstring(g));
1243 if (logging_mode & LOG_MODE_SYSLOG)
1244 write_syslog(LOG_ALERT, log_buffer);
1246 /* If this panic logging was caused by a failure to open the main log,
1247 the original log line is in panic_save_buffer. Make an attempt to write it. */
1249 if (logging_mode & LOG_MODE_FILE)
1251 if (!*file_path) set_file_path(NULL);
1252 panic_recurseflag = TRUE;
1253 open_log(&paniclogfd, lt_panic, NULL); /* Won't return on failure */
1254 panic_recurseflag = FALSE;
1256 if (panic_save_buffer)
1257 (void) write(paniclogfd, panic_save_buffer, Ustrlen(panic_save_buffer));
1259 written_len = write_to_fd_buf(paniclogfd, g->s, g->ptr);
1260 if (written_len != g->ptr)
1262 int save_errno = errno;
1263 write_syslog(LOG_CRIT, log_buffer);
1264 sprintf(CS log_buffer, "write failed on panic log: length=%d result=%d "
1265 "errno=%d (%s)", g->ptr, (int)written_len, save_errno, strerror(save_errno));
1266 write_syslog(LOG_CRIT, string_from_gstring(g));
1267 flags |= LOG_PANIC_DIE;
1270 (void)close(paniclogfd);
1273 /* Give up if the DIE flag is set */
1275 if ((flags & LOG_PANIC_DIE) != LOG_PANIC)
1276 die(NULL, US"Unexpected failure, please try later");
1282 /*************************************************
1283 * Close any open log files *
1284 *************************************************/
1290 { (void)close(mainlogfd); mainlogfd = -1; }
1291 if (rejectlogfd >= 0)
1292 { (void)close(rejectlogfd); rejectlogfd = -1; }
1294 syslog_open = FALSE;
1299 /*************************************************
1300 * Multi-bit set or clear *
1301 *************************************************/
1303 /* These functions take a list of bit indexes (terminated by -1) and
1304 clear or set the corresponding bits in the selector.
1307 selector address of the bit string
1308 selsize number of words in the bit string
1309 bits list of bits to set
1313 bits_clear(unsigned int *selector, size_t selsize, int *bits)
1315 for(; *bits != -1; ++bits)
1316 BIT_CLEAR(selector, selsize, *bits);
1320 bits_set(unsigned int *selector, size_t selsize, int *bits)
1322 for(; *bits != -1; ++bits)
1323 BIT_SET(selector, selsize, *bits);
1328 /*************************************************
1329 * Decode bit settings for log/debug *
1330 *************************************************/
1332 /* This function decodes a string containing bit settings in the form of +name
1333 and/or -name sequences, and sets/unsets bits in a bit string accordingly. It
1334 also recognizes a numeric setting of the form =<number>, but this is not
1335 intended for user use. It's an easy way for Exim to pass the debug settings
1336 when it is re-exec'ed.
1338 The option table is a list of names and bit indexes. The index -1
1339 means "set all bits, except for those listed in notall". The notall
1340 list is terminated by -1.
1342 The action taken for bad values varies depending upon why we're here.
1343 For log messages, or if the debugging is triggered from config, then we write
1344 to the log on the way out. For debug setting triggered from the command-line,
1345 we treat it as an unknown option: error message to stderr and die.
1348 selector address of the bit string
1349 selsize number of words in the bit string
1350 notall list of bits to exclude from "all"
1351 string the configured string
1352 options the table of option names
1354 which "log" or "debug"
1355 flags DEBUG_FROM_CONFIG
1357 Returns: nothing on success - bomb out on failure
1361 decode_bits(unsigned int *selector, size_t selsize, int *notall,
1362 uschar *string, bit_table *options, int count, uschar *which, int flags)
1365 if (!string) return;
1369 char *end; /* Not uschar */
1370 memset(selector, 0, sizeof(*selector)*selsize);
1371 *selector = strtoul(CS string+1, &end, 0);
1373 errmsg = string_sprintf("malformed numeric %s_selector setting: %s", which,
1378 /* Handle symbolic setting */
1385 bit_table *start, *end;
1387 Uskip_whitespace(&string);
1388 if (!*string) return;
1390 if (*string != '+' && *string != '-')
1392 errmsg = string_sprintf("malformed %s_selector setting: "
1393 "+ or - expected but found \"%s\"", which, string);
1397 adding = *string++ == '+';
1399 while (isalnum(*string) || *string == '_') string++;
1403 end = options + count;
1407 bit_table *middle = start + (end - start)/2;
1408 int c = Ustrncmp(s, middle->name, len);
1410 if (middle->name[len] != 0) c = -1; else
1412 unsigned int bit = middle->bit;
1418 memset(selector, -1, sizeof(*selector)*selsize);
1419 bits_clear(selector, selsize, notall);
1422 memset(selector, 0, sizeof(*selector)*selsize);
1425 BIT_SET(selector, selsize, bit);
1427 BIT_CLEAR(selector, selsize, bit);
1429 break; /* Out of loop to match selector name */
1431 if (c < 0) end = middle; else start = middle + 1;
1432 } /* Loop to match selector name */
1436 errmsg = string_sprintf("unknown %s_selector setting: %c%.*s", which,
1437 adding? '+' : '-', len, s);
1440 } /* Loop for selector names */
1442 /* Handle disasters */
1445 if (Ustrcmp(which, "debug") == 0)
1447 if (flags & DEBUG_FROM_CONFIG)
1449 log_write(0, LOG_CONFIG|LOG_PANIC, "%s", errmsg);
1452 fprintf(stderr, "exim: %s\n", errmsg);
1455 else log_write(0, LOG_CONFIG|LOG_PANIC_DIE, "%s", errmsg);
1460 /*************************************************
1461 * Activate a debug logfile (late) *
1462 *************************************************/
1464 /* Normally, debugging is activated from the command-line; it may be useful
1465 within the configuration to activate debugging later, based on certain
1466 conditions. If debugging is already in progress, we return early, no action
1467 taken (besides debug-logging that we wanted debug-logging).
1469 Failures in options are not fatal but will result in paniclog entries for the
1472 The first use of this is in ACL logic, "control = debug/tag=foo/opts=+expand"
1473 which can be combined with conditions, etc, to activate extra logging only
1474 for certain sources. The second use is inetd wait mode debug preservation. */
1477 debug_logging_activate(uschar *tag_name, uschar *opts)
1483 debug_printf("DEBUGGING ACTIVATED FROM WITHIN CONFIG.\n"
1484 "DEBUG: Tag=\"%s\" opts=\"%s\"\n", tag_name, opts ? opts : US"");
1488 if (tag_name != NULL && (Ustrchr(tag_name, '/') != NULL))
1490 log_write(0, LOG_MAIN|LOG_PANIC, "debug tag may not contain a '/' in: %s",
1495 debug_selector = D_default;
1497 decode_bits(&debug_selector, 1, debug_notall, opts,
1498 debug_options, debug_options_count, US"debug", DEBUG_FROM_CONFIG);
1500 /* When activating from a transport process we may never have logged at all
1501 resulting in certain setup not having been done. Hack this for now so we
1502 do not segfault; note that nondefault log locations will not work */
1504 if (!*file_path) set_file_path(NULL);
1506 open_log(&fd, lt_debug, tag_name);
1509 debug_file = fdopen(fd, "w");
1511 log_write(0, LOG_MAIN|LOG_PANIC, "unable to open debug log");
1516 debug_logging_stop(void)
1518 if (!debug_file || !debuglog_name[0]) return;
1523 unlink_log(lt_debug);
1526 /* Called from the appendfile transport setup. */
1530 set_file_path(NULL);
1531 if (!(logging_mode & LOG_MODE_FILE)) return;
1532 open_log(&mainlogfd, lt_main, 0);
1533 open_log(&rejectlogfd, lt_reject, 0);