1 /* $OpenBSD: log.c,v 1.41 2008/06/10 04:50:25 dtucker 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>
48 #if defined(HAVE_STRNVIS) && defined(HAVE_VIS_H)
55 static LogLevel log_level = SYSLOG_LEVEL_INFO;
56 static int log_on_stderr = 1;
57 static int log_facility = LOG_AUTH;
60 extern char *__progname;
62 #define LOG_SYSLOG_VIS (VIS_CSTYLE|VIS_NL|VIS_TAB|VIS_OCTAL)
63 #define LOG_STDERR_VIS (VIS_SAFE|VIS_OCTAL)
65 /* textual representation of log-facilities/levels */
70 } log_facilities[] = {
71 { "DAEMON", SYSLOG_FACILITY_DAEMON },
72 { "USER", SYSLOG_FACILITY_USER },
73 { "AUTH", SYSLOG_FACILITY_AUTH },
75 { "AUTHPRIV", SYSLOG_FACILITY_AUTHPRIV },
77 { "LOCAL0", SYSLOG_FACILITY_LOCAL0 },
78 { "LOCAL1", SYSLOG_FACILITY_LOCAL1 },
79 { "LOCAL2", SYSLOG_FACILITY_LOCAL2 },
80 { "LOCAL3", SYSLOG_FACILITY_LOCAL3 },
81 { "LOCAL4", SYSLOG_FACILITY_LOCAL4 },
82 { "LOCAL5", SYSLOG_FACILITY_LOCAL5 },
83 { "LOCAL6", SYSLOG_FACILITY_LOCAL6 },
84 { "LOCAL7", SYSLOG_FACILITY_LOCAL7 },
85 { NULL, SYSLOG_FACILITY_NOT_SET }
93 { "QUIET", SYSLOG_LEVEL_QUIET },
94 { "FATAL", SYSLOG_LEVEL_FATAL },
95 { "ERROR", SYSLOG_LEVEL_ERROR },
96 { "INFO", SYSLOG_LEVEL_INFO },
97 { "VERBOSE", SYSLOG_LEVEL_VERBOSE },
98 { "DEBUG", SYSLOG_LEVEL_DEBUG1 },
99 { "DEBUG1", SYSLOG_LEVEL_DEBUG1 },
100 { "DEBUG2", SYSLOG_LEVEL_DEBUG2 },
101 { "DEBUG3", SYSLOG_LEVEL_DEBUG3 },
102 { NULL, SYSLOG_LEVEL_NOT_SET }
106 log_facility_number(char *name)
111 for (i = 0; log_facilities[i].name; i++)
112 if (strcasecmp(log_facilities[i].name, name) == 0)
113 return log_facilities[i].val;
114 return SYSLOG_FACILITY_NOT_SET;
118 log_facility_name(SyslogFacility facility)
122 for (i = 0; log_facilities[i].name; i++)
123 if (log_facilities[i].val == facility)
124 return log_facilities[i].name;
129 log_level_number(char *name)
134 for (i = 0; log_levels[i].name; i++)
135 if (strcasecmp(log_levels[i].name, name) == 0)
136 return log_levels[i].val;
137 return SYSLOG_LEVEL_NOT_SET;
141 log_level_name(LogLevel level)
145 for (i = 0; log_levels[i].name != NULL; i++)
146 if (log_levels[i].val == level)
147 return log_levels[i].name;
151 /* Error messages that should be logged. */
154 error(const char *fmt,...)
159 do_log(SYSLOG_LEVEL_ERROR, fmt, args);
164 sigdie(const char *fmt,...)
166 #ifdef DO_LOG_SAFE_IN_SIGHAND
170 do_log(SYSLOG_LEVEL_FATAL, fmt, args);
177 /* Log this message (information that usually should go to the log). */
180 logit(const char *fmt,...)
185 do_log(SYSLOG_LEVEL_INFO, fmt, args);
189 /* More detailed messages (information that does not need to go to the log). */
192 verbose(const char *fmt,...)
197 do_log(SYSLOG_LEVEL_VERBOSE, fmt, args);
201 /* Debugging messages that should not be logged during normal operation. */
204 debug(const char *fmt,...)
209 do_log(SYSLOG_LEVEL_DEBUG1, fmt, args);
214 debug2(const char *fmt,...)
219 do_log(SYSLOG_LEVEL_DEBUG2, fmt, args);
224 debug3(const char *fmt,...)
229 do_log(SYSLOG_LEVEL_DEBUG3, fmt, args);
234 * Initialize the log.
238 log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr)
240 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
241 struct syslog_data sdata = SYSLOG_DATA_INIT;
247 case SYSLOG_LEVEL_QUIET:
248 case SYSLOG_LEVEL_FATAL:
249 case SYSLOG_LEVEL_ERROR:
250 case SYSLOG_LEVEL_INFO:
251 case SYSLOG_LEVEL_VERBOSE:
252 case SYSLOG_LEVEL_DEBUG1:
253 case SYSLOG_LEVEL_DEBUG2:
254 case SYSLOG_LEVEL_DEBUG3:
258 fprintf(stderr, "Unrecognized internal syslog level code %d\n",
263 log_on_stderr = on_stderr;
268 case SYSLOG_FACILITY_DAEMON:
269 log_facility = LOG_DAEMON;
271 case SYSLOG_FACILITY_USER:
272 log_facility = LOG_USER;
274 case SYSLOG_FACILITY_AUTH:
275 log_facility = LOG_AUTH;
278 case SYSLOG_FACILITY_AUTHPRIV:
279 log_facility = LOG_AUTHPRIV;
282 case SYSLOG_FACILITY_LOCAL0:
283 log_facility = LOG_LOCAL0;
285 case SYSLOG_FACILITY_LOCAL1:
286 log_facility = LOG_LOCAL1;
288 case SYSLOG_FACILITY_LOCAL2:
289 log_facility = LOG_LOCAL2;
291 case SYSLOG_FACILITY_LOCAL3:
292 log_facility = LOG_LOCAL3;
294 case SYSLOG_FACILITY_LOCAL4:
295 log_facility = LOG_LOCAL4;
297 case SYSLOG_FACILITY_LOCAL5:
298 log_facility = LOG_LOCAL5;
300 case SYSLOG_FACILITY_LOCAL6:
301 log_facility = LOG_LOCAL6;
303 case SYSLOG_FACILITY_LOCAL7:
304 log_facility = LOG_LOCAL7;
308 "Unrecognized internal syslog facility code %d\n",
314 * If an external library (eg libwrap) attempts to use syslog
315 * immediately after reexec, syslog may be pointing to the wrong
316 * facility, so we force an open/close of syslog here.
318 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
319 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
322 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
327 #define MSGBUFSIZ 1024
330 do_log(LogLevel level, const char *fmt, va_list args)
332 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
333 struct syslog_data sdata = SYSLOG_DATA_INIT;
335 char msgbuf[MSGBUFSIZ];
336 char fmtbuf[MSGBUFSIZ];
339 int saved_errno = errno;
341 if (level > log_level)
345 case SYSLOG_LEVEL_FATAL:
350 case SYSLOG_LEVEL_ERROR:
355 case SYSLOG_LEVEL_INFO:
358 case SYSLOG_LEVEL_VERBOSE:
361 case SYSLOG_LEVEL_DEBUG1:
365 case SYSLOG_LEVEL_DEBUG2:
369 case SYSLOG_LEVEL_DEBUG3:
374 txt = "internal error";
379 snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt);
380 vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args);
382 vsnprintf(msgbuf, sizeof(msgbuf), fmt, args);
384 strnvis(fmtbuf, msgbuf, sizeof(fmtbuf),
385 log_on_stderr ? LOG_STDERR_VIS : LOG_SYSLOG_VIS);
387 snprintf(msgbuf, sizeof msgbuf, "%s\r\n", fmtbuf);
388 write(STDERR_FILENO, msgbuf, strlen(msgbuf));
390 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
391 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
392 syslog_r(pri, &sdata, "%.500s", fmtbuf);
395 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
396 syslog(pri, "%.500s", fmtbuf);