blob: ad5a10b4785ded01d74d9354ec26e92fd6a3a073 [file] [log] [blame]
Damien Miller8f0bf232011-06-20 14:42:23 +10001/* $OpenBSD: log.c,v 1.42 2011/06/17 21:44:30 djm Exp $ */
Damien Miller5ce662a1999-11-11 17:57:39 +11002/*
Damien Millere4340be2000-09-16 13:29:08 +11003 * Author: Tatu Ylonen <ylo@cs.hut.fi>
4 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 * All rights reserved
6 *
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".
12 */
13/*
Damien Millere4340be2000-09-16 13:29:08 +110014 * Copyright (c) 2000 Markus Friedl. All rights reserved.
15 *
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
18 * are met:
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.
24 *
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.
Damien Miller5428f641999-11-25 11:54:57 +110035 */
Damien Miller5ce662a1999-11-11 17:57:39 +110036
37#include "includes.h"
Damien Miller5ce662a1999-11-11 17:57:39 +110038
Damien Millerd7834352006-08-05 12:39:39 +100039#include <sys/types.h>
40
Darren Tucker5d196262006-07-12 22:15:16 +100041#include <stdarg.h>
Damien Millera7a73ee2006-08-05 11:37:59 +100042#include <stdio.h>
Damien Millere7a1e5c2006-08-05 11:34:19 +100043#include <stdlib.h>
Damien Millere3476ed2006-07-24 14:13:33 +100044#include <string.h>
Ben Lindstrom8a432f52001-03-05 07:24:46 +000045#include <syslog.h>
Damien Millere6b3b612006-07-24 14:01:23 +100046#include <unistd.h>
Darren Tucker36b78002007-05-20 15:08:15 +100047#include <errno.h>
Damien Miller5c3a5582003-09-23 22:12:38 +100048#if defined(HAVE_STRNVIS) && defined(HAVE_VIS_H)
49# include <vis.h>
50#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +000051
Damien Miller194a1cb2006-07-10 21:09:22 +100052#include "xmalloc.h"
Damien Millerd7834352006-08-05 12:39:39 +100053#include "log.h"
Damien Miller194a1cb2006-07-10 21:09:22 +100054
Ben Lindstrom8a432f52001-03-05 07:24:46 +000055static LogLevel log_level = SYSLOG_LEVEL_INFO;
56static int log_on_stderr = 1;
57static int log_facility = LOG_AUTH;
58static char *argv0;
Damien Miller8f0bf232011-06-20 14:42:23 +100059static log_handler_fn *log_handler;
60static void *log_handler_ctx;
Ben Lindstrom8a432f52001-03-05 07:24:46 +000061
62extern char *__progname;
63
Damien Miller23a70272004-07-21 10:52:13 +100064#define LOG_SYSLOG_VIS (VIS_CSTYLE|VIS_NL|VIS_TAB|VIS_OCTAL)
65#define LOG_STDERR_VIS (VIS_SAFE|VIS_OCTAL)
66
Ben Lindstrom8a432f52001-03-05 07:24:46 +000067/* textual representation of log-facilities/levels */
68
69static struct {
70 const char *name;
71 SyslogFacility val;
72} log_facilities[] = {
73 { "DAEMON", SYSLOG_FACILITY_DAEMON },
74 { "USER", SYSLOG_FACILITY_USER },
75 { "AUTH", SYSLOG_FACILITY_AUTH },
Damien Miller30246a82001-03-05 21:23:31 +110076#ifdef LOG_AUTHPRIV
77 { "AUTHPRIV", SYSLOG_FACILITY_AUTHPRIV },
78#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +000079 { "LOCAL0", SYSLOG_FACILITY_LOCAL0 },
80 { "LOCAL1", SYSLOG_FACILITY_LOCAL1 },
81 { "LOCAL2", SYSLOG_FACILITY_LOCAL2 },
82 { "LOCAL3", SYSLOG_FACILITY_LOCAL3 },
83 { "LOCAL4", SYSLOG_FACILITY_LOCAL4 },
84 { "LOCAL5", SYSLOG_FACILITY_LOCAL5 },
85 { "LOCAL6", SYSLOG_FACILITY_LOCAL6 },
86 { "LOCAL7", SYSLOG_FACILITY_LOCAL7 },
Damien Millerfcd93202002-02-05 12:26:34 +110087 { NULL, SYSLOG_FACILITY_NOT_SET }
Ben Lindstrom8a432f52001-03-05 07:24:46 +000088};
89
90static struct {
91 const char *name;
92 LogLevel val;
93} log_levels[] =
94{
95 { "QUIET", SYSLOG_LEVEL_QUIET },
96 { "FATAL", SYSLOG_LEVEL_FATAL },
97 { "ERROR", SYSLOG_LEVEL_ERROR },
98 { "INFO", SYSLOG_LEVEL_INFO },
99 { "VERBOSE", SYSLOG_LEVEL_VERBOSE },
100 { "DEBUG", SYSLOG_LEVEL_DEBUG1 },
101 { "DEBUG1", SYSLOG_LEVEL_DEBUG1 },
102 { "DEBUG2", SYSLOG_LEVEL_DEBUG2 },
103 { "DEBUG3", SYSLOG_LEVEL_DEBUG3 },
Damien Millerfcd93202002-02-05 12:26:34 +1100104 { NULL, SYSLOG_LEVEL_NOT_SET }
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000105};
106
107SyslogFacility
108log_facility_number(char *name)
109{
110 int i;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000111
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000112 if (name != NULL)
113 for (i = 0; log_facilities[i].name; i++)
114 if (strcasecmp(log_facilities[i].name, name) == 0)
115 return log_facilities[i].val;
Damien Millerfcd93202002-02-05 12:26:34 +1100116 return SYSLOG_FACILITY_NOT_SET;
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000117}
118
Darren Tuckere7140f22008-06-10 23:01:51 +1000119const char *
120log_facility_name(SyslogFacility facility)
121{
122 u_int i;
123
124 for (i = 0; log_facilities[i].name; i++)
125 if (log_facilities[i].val == facility)
126 return log_facilities[i].name;
127 return NULL;
128}
129
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000130LogLevel
131log_level_number(char *name)
132{
133 int i;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000134
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000135 if (name != NULL)
136 for (i = 0; log_levels[i].name; i++)
137 if (strcasecmp(log_levels[i].name, name) == 0)
138 return log_levels[i].val;
Damien Millerfcd93202002-02-05 12:26:34 +1100139 return SYSLOG_LEVEL_NOT_SET;
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000140}
Damien Miller5ce662a1999-11-11 17:57:39 +1100141
Darren Tuckere7140f22008-06-10 23:01:51 +1000142const char *
143log_level_name(LogLevel level)
144{
145 u_int i;
146
147 for (i = 0; log_levels[i].name != NULL; i++)
148 if (log_levels[i].val == level)
149 return log_levels[i].name;
150 return NULL;
151}
152
Damien Miller5ce662a1999-11-11 17:57:39 +1100153/* Error messages that should be logged. */
154
155void
Damien Miller95def091999-11-25 00:26:21 +1100156error(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100157{
Damien Miller95def091999-11-25 00:26:21 +1100158 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000159
Damien Miller95def091999-11-25 00:26:21 +1100160 va_start(args, fmt);
161 do_log(SYSLOG_LEVEL_ERROR, fmt, args);
162 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100163}
164
Damien Miller99a648e2006-08-19 00:32:20 +1000165void
166sigdie(const char *fmt,...)
167{
Darren Tuckeraa1517c2006-08-20 17:55:54 +1000168#ifdef DO_LOG_SAFE_IN_SIGHAND
Damien Miller99a648e2006-08-19 00:32:20 +1000169 va_list args;
170
171 va_start(args, fmt);
172 do_log(SYSLOG_LEVEL_FATAL, fmt, args);
173 va_end(args);
Damien Millerbb598142006-08-19 08:38:23 +1000174#endif
Damien Miller99a648e2006-08-19 00:32:20 +1000175 _exit(1);
176}
177
178
Damien Miller5ce662a1999-11-11 17:57:39 +1100179/* Log this message (information that usually should go to the log). */
180
181void
Damien Miller996acd22003-04-09 20:59:48 +1000182logit(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100183{
Damien Miller95def091999-11-25 00:26:21 +1100184 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000185
Damien Miller95def091999-11-25 00:26:21 +1100186 va_start(args, fmt);
Ben Lindstromdb65e8f2001-01-19 04:26:52 +0000187 do_log(SYSLOG_LEVEL_INFO, fmt, args);
Damien Miller95def091999-11-25 00:26:21 +1100188 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100189}
190
191/* More detailed messages (information that does not need to go to the log). */
192
193void
Damien Miller95def091999-11-25 00:26:21 +1100194verbose(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100195{
Damien Miller95def091999-11-25 00:26:21 +1100196 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000197
Damien Miller95def091999-11-25 00:26:21 +1100198 va_start(args, fmt);
199 do_log(SYSLOG_LEVEL_VERBOSE, fmt, args);
200 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100201}
202
203/* Debugging messages that should not be logged during normal operation. */
204
205void
Damien Miller95def091999-11-25 00:26:21 +1100206debug(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100207{
Damien Miller95def091999-11-25 00:26:21 +1100208 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000209
Damien Miller95def091999-11-25 00:26:21 +1100210 va_start(args, fmt);
Damien Millere4340be2000-09-16 13:29:08 +1100211 do_log(SYSLOG_LEVEL_DEBUG1, fmt, args);
212 va_end(args);
213}
214
215void
216debug2(const char *fmt,...)
217{
218 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000219
Damien Millere4340be2000-09-16 13:29:08 +1100220 va_start(args, fmt);
221 do_log(SYSLOG_LEVEL_DEBUG2, fmt, args);
222 va_end(args);
223}
224
225void
226debug3(const char *fmt,...)
227{
228 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000229
Damien Millere4340be2000-09-16 13:29:08 +1100230 va_start(args, fmt);
231 do_log(SYSLOG_LEVEL_DEBUG3, fmt, args);
Damien Miller95def091999-11-25 00:26:21 +1100232 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100233}
234
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000235/*
236 * Initialize the log.
237 */
238
239void
240log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr)
241{
Darren Tucker9b5495d2005-02-01 17:35:09 +1100242#if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
243 struct syslog_data sdata = SYSLOG_DATA_INIT;
244#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000245
Darren Tucker835903d2005-03-09 20:12:47 +1100246 argv0 = av0;
247
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000248 switch (level) {
249 case SYSLOG_LEVEL_QUIET:
250 case SYSLOG_LEVEL_FATAL:
251 case SYSLOG_LEVEL_ERROR:
252 case SYSLOG_LEVEL_INFO:
253 case SYSLOG_LEVEL_VERBOSE:
254 case SYSLOG_LEVEL_DEBUG1:
255 case SYSLOG_LEVEL_DEBUG2:
256 case SYSLOG_LEVEL_DEBUG3:
257 log_level = level;
258 break;
259 default:
Kevin Stevesedcd5762001-04-02 13:45:00 +0000260 fprintf(stderr, "Unrecognized internal syslog level code %d\n",
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000261 (int) level);
262 exit(1);
263 }
264
Damien Miller8f0bf232011-06-20 14:42:23 +1000265 log_handler = NULL;
266 log_handler_ctx = NULL;
267
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000268 log_on_stderr = on_stderr;
269 if (on_stderr)
270 return;
271
272 switch (facility) {
273 case SYSLOG_FACILITY_DAEMON:
274 log_facility = LOG_DAEMON;
275 break;
276 case SYSLOG_FACILITY_USER:
277 log_facility = LOG_USER;
278 break;
279 case SYSLOG_FACILITY_AUTH:
280 log_facility = LOG_AUTH;
281 break;
Damien Miller30246a82001-03-05 21:23:31 +1100282#ifdef LOG_AUTHPRIV
283 case SYSLOG_FACILITY_AUTHPRIV:
284 log_facility = LOG_AUTHPRIV;
285 break;
Ben Lindstrom53f11c62001-03-05 08:18:17 +0000286#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000287 case SYSLOG_FACILITY_LOCAL0:
288 log_facility = LOG_LOCAL0;
289 break;
290 case SYSLOG_FACILITY_LOCAL1:
291 log_facility = LOG_LOCAL1;
292 break;
293 case SYSLOG_FACILITY_LOCAL2:
294 log_facility = LOG_LOCAL2;
295 break;
296 case SYSLOG_FACILITY_LOCAL3:
297 log_facility = LOG_LOCAL3;
298 break;
299 case SYSLOG_FACILITY_LOCAL4:
300 log_facility = LOG_LOCAL4;
301 break;
302 case SYSLOG_FACILITY_LOCAL5:
303 log_facility = LOG_LOCAL5;
304 break;
305 case SYSLOG_FACILITY_LOCAL6:
306 log_facility = LOG_LOCAL6;
307 break;
308 case SYSLOG_FACILITY_LOCAL7:
309 log_facility = LOG_LOCAL7;
310 break;
311 default:
312 fprintf(stderr,
Kevin Stevesedcd5762001-04-02 13:45:00 +0000313 "Unrecognized internal syslog facility code %d\n",
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000314 (int) facility);
315 exit(1);
316 }
Darren Tucker9b5495d2005-02-01 17:35:09 +1100317
318 /*
319 * If an external library (eg libwrap) attempts to use syslog
320 * immediately after reexec, syslog may be pointing to the wrong
321 * facility, so we force an open/close of syslog here.
322 */
323#if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
324 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
325 closelog_r(&sdata);
326#else
327 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
328 closelog();
329#endif
Damien Miller6162d121999-11-21 13:23:52 +1100330}
331
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000332#define MSGBUFSIZ 1024
333
Ben Lindstrom9c8edc92002-02-26 17:52:14 +0000334void
Damien Miller8f0bf232011-06-20 14:42:23 +1000335set_log_handler(log_handler_fn *handler, void *ctx)
336{
337 log_handler = handler;
338 log_handler_ctx = ctx;
339}
340
341void
342do_log2(LogLevel level, const char *fmt,...)
343{
344 va_list args;
345
346 va_start(args, fmt);
347 do_log(level, fmt, args);
348 va_end(args);
349}
350
351void
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000352do_log(LogLevel level, const char *fmt, va_list args)
Damien Miller6162d121999-11-21 13:23:52 +1100353{
Damien Miller051b0ac2004-02-18 22:59:43 +1100354#if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
Damien Miller74a34422003-05-20 09:24:17 +1000355 struct syslog_data sdata = SYSLOG_DATA_INIT;
356#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000357 char msgbuf[MSGBUFSIZ];
358 char fmtbuf[MSGBUFSIZ];
359 char *txt = NULL;
360 int pri = LOG_INFO;
Darren Tucker36b78002007-05-20 15:08:15 +1000361 int saved_errno = errno;
Damien Miller8f0bf232011-06-20 14:42:23 +1000362 log_handler_fn *tmp_handler;
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000363
364 if (level > log_level)
365 return;
366
367 switch (level) {
368 case SYSLOG_LEVEL_FATAL:
369 if (!log_on_stderr)
370 txt = "fatal";
371 pri = LOG_CRIT;
372 break;
373 case SYSLOG_LEVEL_ERROR:
374 if (!log_on_stderr)
375 txt = "error";
376 pri = LOG_ERR;
377 break;
378 case SYSLOG_LEVEL_INFO:
379 pri = LOG_INFO;
380 break;
381 case SYSLOG_LEVEL_VERBOSE:
382 pri = LOG_INFO;
383 break;
384 case SYSLOG_LEVEL_DEBUG1:
385 txt = "debug1";
386 pri = LOG_DEBUG;
387 break;
388 case SYSLOG_LEVEL_DEBUG2:
389 txt = "debug2";
390 pri = LOG_DEBUG;
391 break;
392 case SYSLOG_LEVEL_DEBUG3:
393 txt = "debug3";
394 pri = LOG_DEBUG;
395 break;
396 default:
397 txt = "internal error";
398 pri = LOG_ERR;
399 break;
400 }
Damien Miller8f0bf232011-06-20 14:42:23 +1000401 if (txt != NULL && log_handler == NULL) {
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000402 snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt);
403 vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args);
404 } else {
405 vsnprintf(msgbuf, sizeof(msgbuf), fmt, args);
406 }
Damien Miller23a70272004-07-21 10:52:13 +1000407 strnvis(fmtbuf, msgbuf, sizeof(fmtbuf),
408 log_on_stderr ? LOG_STDERR_VIS : LOG_SYSLOG_VIS);
Damien Miller8f0bf232011-06-20 14:42:23 +1000409 if (log_handler != NULL) {
410 /* Avoid recursion */
411 tmp_handler = log_handler;
412 log_handler = NULL;
413 tmp_handler(level, fmtbuf, log_handler_ctx);
414 log_handler = tmp_handler;
415 } else if (log_on_stderr) {
Damien Millerc11fe252003-05-25 14:38:02 +1000416 snprintf(msgbuf, sizeof msgbuf, "%s\r\n", fmtbuf);
417 write(STDERR_FILENO, msgbuf, strlen(msgbuf));
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000418 } else {
Damien Miller051b0ac2004-02-18 22:59:43 +1100419#if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
Damien Miller74a34422003-05-20 09:24:17 +1000420 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
Damien Millerc11fe252003-05-25 14:38:02 +1000421 syslog_r(pri, &sdata, "%.500s", fmtbuf);
Damien Miller74a34422003-05-20 09:24:17 +1000422 closelog_r(&sdata);
423#else
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000424 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
Damien Millerb93addb2003-01-07 17:04:18 +1100425 syslog(pri, "%.500s", fmtbuf);
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000426 closelog();
Damien Miller74a34422003-05-20 09:24:17 +1000427#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000428 }
Darren Tucker36b78002007-05-20 15:08:15 +1000429 errno = saved_errno;
Damien Miller6162d121999-11-21 13:23:52 +1100430}