1 /* $OpenBSD: log.c,v 1.48 2016/07/15 05:01:58 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>
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
}
109 log_facility_number(char *name
)
114 for (i
= 0; log_facilities
[i
].name
; i
++)
115 if (strcasecmp(log_facilities
[i
].name
, name
) == 0)
116 return log_facilities
[i
].val
;
117 return SYSLOG_FACILITY_NOT_SET
;
121 log_facility_name(SyslogFacility facility
)
125 for (i
= 0; log_facilities
[i
].name
; i
++)
126 if (log_facilities
[i
].val
== facility
)
127 return log_facilities
[i
].name
;
132 log_level_number(char *name
)
137 for (i
= 0; log_levels
[i
].name
; i
++)
138 if (strcasecmp(log_levels
[i
].name
, name
) == 0)
139 return log_levels
[i
].val
;
140 return SYSLOG_LEVEL_NOT_SET
;
144 log_level_name(LogLevel level
)
148 for (i
= 0; log_levels
[i
].name
!= NULL
; i
++)
149 if (log_levels
[i
].val
== level
)
150 return log_levels
[i
].name
;
154 /* Error messages that should be logged. */
157 error(const char *fmt
,...)
162 do_log(SYSLOG_LEVEL_ERROR
, fmt
, args
);
167 sigdie(const char *fmt
,...)
169 #ifdef DO_LOG_SAFE_IN_SIGHAND
173 do_log(SYSLOG_LEVEL_FATAL
, fmt
, args
);
180 logdie(const char *fmt
,...)
185 do_log(SYSLOG_LEVEL_INFO
, fmt
, args
);
190 /* Log this message (information that usually should go to the log). */
193 logit(const char *fmt
,...)
198 do_log(SYSLOG_LEVEL_INFO
, fmt
, args
);
202 /* More detailed messages (information that does not need to go to the log). */
205 verbose(const char *fmt
,...)
210 do_log(SYSLOG_LEVEL_VERBOSE
, fmt
, args
);
214 /* Debugging messages that should not be logged during normal operation. */
217 debug(const char *fmt
,...)
222 do_log(SYSLOG_LEVEL_DEBUG1
, fmt
, args
);
227 debug2(const char *fmt
,...)
232 do_log(SYSLOG_LEVEL_DEBUG2
, fmt
, args
);
237 debug3(const char *fmt
,...)
242 do_log(SYSLOG_LEVEL_DEBUG3
, fmt
, args
);
247 * Initialize the log.
251 log_init(char *av0
, LogLevel level
, SyslogFacility facility
, int on_stderr
)
253 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
254 struct syslog_data sdata
= SYSLOG_DATA_INIT
;
260 case SYSLOG_LEVEL_QUIET
:
261 case SYSLOG_LEVEL_FATAL
:
262 case SYSLOG_LEVEL_ERROR
:
263 case SYSLOG_LEVEL_INFO
:
264 case SYSLOG_LEVEL_VERBOSE
:
265 case SYSLOG_LEVEL_DEBUG1
:
266 case SYSLOG_LEVEL_DEBUG2
:
267 case SYSLOG_LEVEL_DEBUG3
:
271 fprintf(stderr
, "Unrecognized internal syslog level code %d\n",
277 log_handler_ctx
= NULL
;
279 log_on_stderr
= on_stderr
;
284 case SYSLOG_FACILITY_DAEMON
:
285 log_facility
= LOG_DAEMON
;
287 case SYSLOG_FACILITY_USER
:
288 log_facility
= LOG_USER
;
290 case SYSLOG_FACILITY_AUTH
:
291 log_facility
= LOG_AUTH
;
294 case SYSLOG_FACILITY_AUTHPRIV
:
295 log_facility
= LOG_AUTHPRIV
;
298 case SYSLOG_FACILITY_LOCAL0
:
299 log_facility
= LOG_LOCAL0
;
301 case SYSLOG_FACILITY_LOCAL1
:
302 log_facility
= LOG_LOCAL1
;
304 case SYSLOG_FACILITY_LOCAL2
:
305 log_facility
= LOG_LOCAL2
;
307 case SYSLOG_FACILITY_LOCAL3
:
308 log_facility
= LOG_LOCAL3
;
310 case SYSLOG_FACILITY_LOCAL4
:
311 log_facility
= LOG_LOCAL4
;
313 case SYSLOG_FACILITY_LOCAL5
:
314 log_facility
= LOG_LOCAL5
;
316 case SYSLOG_FACILITY_LOCAL6
:
317 log_facility
= LOG_LOCAL6
;
319 case SYSLOG_FACILITY_LOCAL7
:
320 log_facility
= LOG_LOCAL7
;
324 "Unrecognized internal syslog facility code %d\n",
330 * If an external library (eg libwrap) attempts to use syslog
331 * immediately after reexec, syslog may be pointing to the wrong
332 * facility, so we force an open/close of syslog here.
334 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
335 openlog_r(argv0
? argv0
: __progname
, LOG_PID
, log_facility
, &sdata
);
338 openlog(argv0
? argv0
: __progname
, LOG_PID
, log_facility
);
344 log_change_level(LogLevel new_log_level
)
346 /* no-op if log_init has not been called */
349 log_init(argv0
, new_log_level
, log_facility
, log_on_stderr
);
353 log_is_on_stderr(void)
355 return log_on_stderr
&& log_stderr_fd
== STDERR_FILENO
;
358 /* redirect what would usually get written to stderr to specified file */
360 log_redirect_stderr_to(const char *logfile
)
364 if ((fd
= open(logfile
, O_WRONLY
|O_CREAT
|O_APPEND
, 0600)) == -1) {
365 fprintf(stderr
, "Couldn't open logfile %s: %s\n", logfile
,
372 #define MSGBUFSIZ 1024
375 set_log_handler(log_handler_fn
*handler
, void *ctx
)
377 log_handler
= handler
;
378 log_handler_ctx
= ctx
;
382 do_log2(LogLevel level
, const char *fmt
,...)
387 do_log(level
, fmt
, args
);
392 do_log(LogLevel level
, const char *fmt
, va_list args
)
394 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
395 struct syslog_data sdata
= SYSLOG_DATA_INIT
;
397 char msgbuf
[MSGBUFSIZ
];
398 char fmtbuf
[MSGBUFSIZ
];
401 int saved_errno
= errno
;
402 log_handler_fn
*tmp_handler
;
404 if (level
> log_level
)
408 case SYSLOG_LEVEL_FATAL
:
413 case SYSLOG_LEVEL_ERROR
:
418 case SYSLOG_LEVEL_INFO
:
421 case SYSLOG_LEVEL_VERBOSE
:
424 case SYSLOG_LEVEL_DEBUG1
:
428 case SYSLOG_LEVEL_DEBUG2
:
432 case SYSLOG_LEVEL_DEBUG3
:
437 txt
= "internal error";
441 if (txt
!= NULL
&& log_handler
== NULL
) {
442 snprintf(fmtbuf
, sizeof(fmtbuf
), "%s: %s", txt
, fmt
);
443 vsnprintf(msgbuf
, sizeof(msgbuf
), fmtbuf
, args
);
445 vsnprintf(msgbuf
, sizeof(msgbuf
), fmt
, args
);
447 strnvis(fmtbuf
, msgbuf
, sizeof(fmtbuf
),
448 log_on_stderr
? LOG_STDERR_VIS
: LOG_SYSLOG_VIS
);
449 if (log_handler
!= NULL
) {
450 /* Avoid recursion */
451 tmp_handler
= log_handler
;
453 tmp_handler(level
, fmtbuf
, log_handler_ctx
);
454 log_handler
= tmp_handler
;
455 } else if (log_on_stderr
) {
456 snprintf(msgbuf
, sizeof msgbuf
, "%s\r\n", fmtbuf
);
457 (void)write(log_stderr_fd
, msgbuf
, strlen(msgbuf
));
459 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
460 openlog_r(argv0
? argv0
: __progname
, LOG_PID
, log_facility
, &sdata
);
461 syslog_r(pri
, &sdata
, "%.500s", fmtbuf
);
464 openlog(argv0
? argv0
: __progname
, LOG_PID
, log_facility
);
465 syslog(pri
, "%.500s", fmtbuf
);