1 /* $OpenBSD: log.c,v 1.51 2018/07/27 12:03:17 markus Exp $ */
3 * Author: Tatu Ylonen <ylo@cs.hut.fi>
4 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7 * As far as I am concerned, the code I have written for this software
8 * can be used freely for any purpose. Any derived versions of this
9 * software must be clearly marked as such, and if the derived work is
10 * incompatible with the protocol description in the RFC file, it must be
11 * called by a name other than "ssh" or "Secure Shell".
14 * Copyright (c) 2000 Markus Friedl. All rights reserved.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution.
25 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 #include <sys/types.h>
49 #if defined(HAVE_STRNVIS) && defined(HAVE_VIS_H) && !defined(BROKEN_STRNVIS)
55 static LogLevel log_level = SYSLOG_LEVEL_INFO;
56 static int log_on_stderr = 1;
57 static int log_stderr_fd = STDERR_FILENO;
58 static int log_facility = LOG_AUTH;
60 static log_handler_fn *log_handler;
61 static void *log_handler_ctx;
63 extern char *__progname;
65 #define LOG_SYSLOG_VIS (VIS_CSTYLE|VIS_NL|VIS_TAB|VIS_OCTAL)
66 #define LOG_STDERR_VIS (VIS_SAFE|VIS_OCTAL)
68 /* textual representation of log-facilities/levels */
73 } log_facilities[] = {
74 { "DAEMON", SYSLOG_FACILITY_DAEMON },
75 { "USER", SYSLOG_FACILITY_USER },
76 { "AUTH", SYSLOG_FACILITY_AUTH },
78 { "AUTHPRIV", SYSLOG_FACILITY_AUTHPRIV },
80 { "LOCAL0", SYSLOG_FACILITY_LOCAL0 },
81 { "LOCAL1", SYSLOG_FACILITY_LOCAL1 },
82 { "LOCAL2", SYSLOG_FACILITY_LOCAL2 },
83 { "LOCAL3", SYSLOG_FACILITY_LOCAL3 },
84 { "LOCAL4", SYSLOG_FACILITY_LOCAL4 },
85 { "LOCAL5", SYSLOG_FACILITY_LOCAL5 },
86 { "LOCAL6", SYSLOG_FACILITY_LOCAL6 },
87 { "LOCAL7", SYSLOG_FACILITY_LOCAL7 },
88 { NULL, SYSLOG_FACILITY_NOT_SET }
96 { "QUIET", SYSLOG_LEVEL_QUIET },
97 { "FATAL", SYSLOG_LEVEL_FATAL },
98 { "ERROR", SYSLOG_LEVEL_ERROR },
99 { "INFO", SYSLOG_LEVEL_INFO },
100 { "VERBOSE", SYSLOG_LEVEL_VERBOSE },
101 { "DEBUG", SYSLOG_LEVEL_DEBUG1 },
102 { "DEBUG1", SYSLOG_LEVEL_DEBUG1 },
103 { "DEBUG2", SYSLOG_LEVEL_DEBUG2 },
104 { "DEBUG3", SYSLOG_LEVEL_DEBUG3 },
105 { NULL, SYSLOG_LEVEL_NOT_SET }
115 log_facility_number(char *name)
120 for (i = 0; log_facilities[i].name; i++)
121 if (strcasecmp(log_facilities[i].name, name) == 0)
122 return log_facilities[i].val;
123 return SYSLOG_FACILITY_NOT_SET;
127 log_facility_name(SyslogFacility facility)
131 for (i = 0; log_facilities[i].name; i++)
132 if (log_facilities[i].val == facility)
133 return log_facilities[i].name;
138 log_level_number(char *name)
143 for (i = 0; log_levels[i].name; i++)
144 if (strcasecmp(log_levels[i].name, name) == 0)
145 return log_levels[i].val;
146 return SYSLOG_LEVEL_NOT_SET;
150 log_level_name(LogLevel level)
154 for (i = 0; log_levels[i].name != NULL; i++)
155 if (log_levels[i].val == level)
156 return log_levels[i].name;
160 /* Error messages that should be logged. */
163 error(const char *fmt,...)
168 do_log(SYSLOG_LEVEL_ERROR, fmt, args);
173 sigdie(const char *fmt,...)
175 #ifdef DO_LOG_SAFE_IN_SIGHAND
179 do_log(SYSLOG_LEVEL_FATAL, fmt, args);
186 logdie(const char *fmt,...)
191 do_log(SYSLOG_LEVEL_INFO, fmt, args);
196 /* Log this message (information that usually should go to the log). */
199 logit(const char *fmt,...)
204 do_log(SYSLOG_LEVEL_INFO, fmt, args);
208 /* More detailed messages (information that does not need to go to the log). */
211 verbose(const char *fmt,...)
216 do_log(SYSLOG_LEVEL_VERBOSE, fmt, args);
220 /* Debugging messages that should not be logged during normal operation. */
223 debug(const char *fmt,...)
228 do_log(SYSLOG_LEVEL_DEBUG1, fmt, args);
233 debug2(const char *fmt,...)
238 do_log(SYSLOG_LEVEL_DEBUG2, fmt, args);
243 debug3(const char *fmt,...)
248 do_log(SYSLOG_LEVEL_DEBUG3, fmt, args);
253 * Initialize the log.
257 log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr)
259 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
260 struct syslog_data sdata = SYSLOG_DATA_INIT;
265 if (log_change_level(level) != 0) {
266 fprintf(stderr, "Unrecognized internal syslog level code %d\n",
272 log_handler_ctx = NULL;
274 log_on_stderr = on_stderr;
279 case SYSLOG_FACILITY_DAEMON:
280 log_facility = LOG_DAEMON;
282 case SYSLOG_FACILITY_USER:
283 log_facility = LOG_USER;
285 case SYSLOG_FACILITY_AUTH:
286 log_facility = LOG_AUTH;
289 case SYSLOG_FACILITY_AUTHPRIV:
290 log_facility = LOG_AUTHPRIV;
293 case SYSLOG_FACILITY_LOCAL0:
294 log_facility = LOG_LOCAL0;
296 case SYSLOG_FACILITY_LOCAL1:
297 log_facility = LOG_LOCAL1;
299 case SYSLOG_FACILITY_LOCAL2:
300 log_facility = LOG_LOCAL2;
302 case SYSLOG_FACILITY_LOCAL3:
303 log_facility = LOG_LOCAL3;
305 case SYSLOG_FACILITY_LOCAL4:
306 log_facility = LOG_LOCAL4;
308 case SYSLOG_FACILITY_LOCAL5:
309 log_facility = LOG_LOCAL5;
311 case SYSLOG_FACILITY_LOCAL6:
312 log_facility = LOG_LOCAL6;
314 case SYSLOG_FACILITY_LOCAL7:
315 log_facility = LOG_LOCAL7;
319 "Unrecognized internal syslog facility code %d\n",
325 * If an external library (eg libwrap) attempts to use syslog
326 * immediately after reexec, syslog may be pointing to the wrong
327 * facility, so we force an open/close of syslog here.
329 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
330 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
333 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
339 log_change_level(LogLevel new_log_level)
341 /* no-op if log_init has not been called */
345 switch (new_log_level) {
346 case SYSLOG_LEVEL_QUIET:
347 case SYSLOG_LEVEL_FATAL:
348 case SYSLOG_LEVEL_ERROR:
349 case SYSLOG_LEVEL_INFO:
350 case SYSLOG_LEVEL_VERBOSE:
351 case SYSLOG_LEVEL_DEBUG1:
352 case SYSLOG_LEVEL_DEBUG2:
353 case SYSLOG_LEVEL_DEBUG3:
354 log_level = new_log_level;
362 log_is_on_stderr(void)
364 return log_on_stderr && log_stderr_fd == STDERR_FILENO;
367 /* redirect what would usually get written to stderr to specified file */
369 log_redirect_stderr_to(const char *logfile)
373 if ((fd = open(logfile, O_WRONLY|O_CREAT|O_APPEND, 0600)) == -1) {
374 fprintf(stderr, "Couldn't open logfile %s: %s\n", logfile,
381 #define MSGBUFSIZ 1024
384 set_log_handler(log_handler_fn *handler, void *ctx)
386 log_handler = handler;
387 log_handler_ctx = ctx;
391 do_log2(LogLevel level, const char *fmt,...)
396 do_log(level, fmt, args);
401 do_log(LogLevel level, const char *fmt, va_list args)
403 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
404 struct syslog_data sdata = SYSLOG_DATA_INIT;
406 char msgbuf[MSGBUFSIZ];
407 char fmtbuf[MSGBUFSIZ];
410 int saved_errno = errno;
411 log_handler_fn *tmp_handler;
413 if (level > log_level)
417 case SYSLOG_LEVEL_FATAL:
422 case SYSLOG_LEVEL_ERROR:
427 case SYSLOG_LEVEL_INFO:
430 case SYSLOG_LEVEL_VERBOSE:
433 case SYSLOG_LEVEL_DEBUG1:
437 case SYSLOG_LEVEL_DEBUG2:
441 case SYSLOG_LEVEL_DEBUG3:
446 txt = "internal error";
450 if (txt != NULL && log_handler == NULL) {
451 snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt);
452 vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args);
454 vsnprintf(msgbuf, sizeof(msgbuf), fmt, args);
456 strnvis(fmtbuf, msgbuf, sizeof(fmtbuf),
457 log_on_stderr ? LOG_STDERR_VIS : LOG_SYSLOG_VIS);
458 if (log_handler != NULL) {
459 /* Avoid recursion */
460 tmp_handler = log_handler;
462 tmp_handler(level, fmtbuf, log_handler_ctx);
463 log_handler = tmp_handler;
464 } else if (log_on_stderr) {
465 snprintf(msgbuf, sizeof msgbuf, "%.*s\r\n",
466 (int)sizeof msgbuf - 3, fmtbuf);
467 (void)write(log_stderr_fd, msgbuf, strlen(msgbuf));
469 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
470 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
471 syslog_r(pri, &sdata, "%.500s", fmtbuf);
474 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
475 syslog(pri, "%.500s", fmtbuf);