blob: 7f8867482d95e55d9cd6ff471cf504163c31d775 [file] [log] [blame]
Damien Miller99a648e2006-08-19 00:32:20 +10001/* $OpenBSD: log.c,v 1.39 2006/08/18 09:13:25 deraadt 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>
Damien Miller5c3a5582003-09-23 22:12:38 +100047#if defined(HAVE_STRNVIS) && defined(HAVE_VIS_H)
48# include <vis.h>
49#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +000050
Damien Miller194a1cb2006-07-10 21:09:22 +100051#include "xmalloc.h"
Damien Millerd7834352006-08-05 12:39:39 +100052#include "log.h"
Damien Miller194a1cb2006-07-10 21:09:22 +100053
Ben Lindstrom8a432f52001-03-05 07:24:46 +000054static LogLevel log_level = SYSLOG_LEVEL_INFO;
55static int log_on_stderr = 1;
56static int log_facility = LOG_AUTH;
57static char *argv0;
58
59extern char *__progname;
60
Damien Miller23a70272004-07-21 10:52:13 +100061#define LOG_SYSLOG_VIS (VIS_CSTYLE|VIS_NL|VIS_TAB|VIS_OCTAL)
62#define LOG_STDERR_VIS (VIS_SAFE|VIS_OCTAL)
63
Ben Lindstrom8a432f52001-03-05 07:24:46 +000064/* textual representation of log-facilities/levels */
65
66static struct {
67 const char *name;
68 SyslogFacility val;
69} log_facilities[] = {
70 { "DAEMON", SYSLOG_FACILITY_DAEMON },
71 { "USER", SYSLOG_FACILITY_USER },
72 { "AUTH", SYSLOG_FACILITY_AUTH },
Damien Miller30246a82001-03-05 21:23:31 +110073#ifdef LOG_AUTHPRIV
74 { "AUTHPRIV", SYSLOG_FACILITY_AUTHPRIV },
75#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +000076 { "LOCAL0", SYSLOG_FACILITY_LOCAL0 },
77 { "LOCAL1", SYSLOG_FACILITY_LOCAL1 },
78 { "LOCAL2", SYSLOG_FACILITY_LOCAL2 },
79 { "LOCAL3", SYSLOG_FACILITY_LOCAL3 },
80 { "LOCAL4", SYSLOG_FACILITY_LOCAL4 },
81 { "LOCAL5", SYSLOG_FACILITY_LOCAL5 },
82 { "LOCAL6", SYSLOG_FACILITY_LOCAL6 },
83 { "LOCAL7", SYSLOG_FACILITY_LOCAL7 },
Damien Millerfcd93202002-02-05 12:26:34 +110084 { NULL, SYSLOG_FACILITY_NOT_SET }
Ben Lindstrom8a432f52001-03-05 07:24:46 +000085};
86
87static struct {
88 const char *name;
89 LogLevel val;
90} log_levels[] =
91{
92 { "QUIET", SYSLOG_LEVEL_QUIET },
93 { "FATAL", SYSLOG_LEVEL_FATAL },
94 { "ERROR", SYSLOG_LEVEL_ERROR },
95 { "INFO", SYSLOG_LEVEL_INFO },
96 { "VERBOSE", SYSLOG_LEVEL_VERBOSE },
97 { "DEBUG", SYSLOG_LEVEL_DEBUG1 },
98 { "DEBUG1", SYSLOG_LEVEL_DEBUG1 },
99 { "DEBUG2", SYSLOG_LEVEL_DEBUG2 },
100 { "DEBUG3", SYSLOG_LEVEL_DEBUG3 },
Damien Millerfcd93202002-02-05 12:26:34 +1100101 { NULL, SYSLOG_LEVEL_NOT_SET }
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000102};
103
104SyslogFacility
105log_facility_number(char *name)
106{
107 int i;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000108
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000109 if (name != NULL)
110 for (i = 0; log_facilities[i].name; i++)
111 if (strcasecmp(log_facilities[i].name, name) == 0)
112 return log_facilities[i].val;
Damien Millerfcd93202002-02-05 12:26:34 +1100113 return SYSLOG_FACILITY_NOT_SET;
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000114}
115
116LogLevel
117log_level_number(char *name)
118{
119 int i;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000120
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000121 if (name != NULL)
122 for (i = 0; log_levels[i].name; i++)
123 if (strcasecmp(log_levels[i].name, name) == 0)
124 return log_levels[i].val;
Damien Millerfcd93202002-02-05 12:26:34 +1100125 return SYSLOG_LEVEL_NOT_SET;
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000126}
Damien Miller5ce662a1999-11-11 17:57:39 +1100127
128/* Error messages that should be logged. */
129
130void
Damien Miller95def091999-11-25 00:26:21 +1100131error(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100132{
Damien Miller95def091999-11-25 00:26:21 +1100133 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000134
Damien Miller95def091999-11-25 00:26:21 +1100135 va_start(args, fmt);
136 do_log(SYSLOG_LEVEL_ERROR, fmt, args);
137 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100138}
139
Damien Miller99a648e2006-08-19 00:32:20 +1000140void
141sigdie(const char *fmt,...)
142{
Darren Tuckeraa1517c2006-08-20 17:55:54 +1000143#ifdef DO_LOG_SAFE_IN_SIGHAND
Damien Miller99a648e2006-08-19 00:32:20 +1000144 va_list args;
145
146 va_start(args, fmt);
147 do_log(SYSLOG_LEVEL_FATAL, fmt, args);
148 va_end(args);
Damien Millerbb598142006-08-19 08:38:23 +1000149#endif
Damien Miller99a648e2006-08-19 00:32:20 +1000150 _exit(1);
151}
152
153
Damien Miller5ce662a1999-11-11 17:57:39 +1100154/* Log this message (information that usually should go to the log). */
155
156void
Damien Miller996acd22003-04-09 20:59:48 +1000157logit(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100158{
Damien Miller95def091999-11-25 00:26:21 +1100159 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000160
Damien Miller95def091999-11-25 00:26:21 +1100161 va_start(args, fmt);
Ben Lindstromdb65e8f2001-01-19 04:26:52 +0000162 do_log(SYSLOG_LEVEL_INFO, fmt, args);
Damien Miller95def091999-11-25 00:26:21 +1100163 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100164}
165
166/* More detailed messages (information that does not need to go to the log). */
167
168void
Damien Miller95def091999-11-25 00:26:21 +1100169verbose(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100170{
Damien Miller95def091999-11-25 00:26:21 +1100171 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000172
Damien Miller95def091999-11-25 00:26:21 +1100173 va_start(args, fmt);
174 do_log(SYSLOG_LEVEL_VERBOSE, fmt, args);
175 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100176}
177
178/* Debugging messages that should not be logged during normal operation. */
179
180void
Damien Miller95def091999-11-25 00:26:21 +1100181debug(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100182{
Damien Miller95def091999-11-25 00:26:21 +1100183 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000184
Damien Miller95def091999-11-25 00:26:21 +1100185 va_start(args, fmt);
Damien Millere4340be2000-09-16 13:29:08 +1100186 do_log(SYSLOG_LEVEL_DEBUG1, fmt, args);
187 va_end(args);
188}
189
190void
191debug2(const char *fmt,...)
192{
193 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000194
Damien Millere4340be2000-09-16 13:29:08 +1100195 va_start(args, fmt);
196 do_log(SYSLOG_LEVEL_DEBUG2, fmt, args);
197 va_end(args);
198}
199
200void
201debug3(const char *fmt,...)
202{
203 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000204
Damien Millere4340be2000-09-16 13:29:08 +1100205 va_start(args, fmt);
206 do_log(SYSLOG_LEVEL_DEBUG3, fmt, args);
Damien Miller95def091999-11-25 00:26:21 +1100207 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100208}
209
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000210/*
211 * Initialize the log.
212 */
213
214void
215log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr)
216{
Darren Tucker9b5495d2005-02-01 17:35:09 +1100217#if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
218 struct syslog_data sdata = SYSLOG_DATA_INIT;
219#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000220
Darren Tucker835903d2005-03-09 20:12:47 +1100221 argv0 = av0;
222
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000223 switch (level) {
224 case SYSLOG_LEVEL_QUIET:
225 case SYSLOG_LEVEL_FATAL:
226 case SYSLOG_LEVEL_ERROR:
227 case SYSLOG_LEVEL_INFO:
228 case SYSLOG_LEVEL_VERBOSE:
229 case SYSLOG_LEVEL_DEBUG1:
230 case SYSLOG_LEVEL_DEBUG2:
231 case SYSLOG_LEVEL_DEBUG3:
232 log_level = level;
233 break;
234 default:
Kevin Stevesedcd5762001-04-02 13:45:00 +0000235 fprintf(stderr, "Unrecognized internal syslog level code %d\n",
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000236 (int) level);
237 exit(1);
238 }
239
240 log_on_stderr = on_stderr;
241 if (on_stderr)
242 return;
243
244 switch (facility) {
245 case SYSLOG_FACILITY_DAEMON:
246 log_facility = LOG_DAEMON;
247 break;
248 case SYSLOG_FACILITY_USER:
249 log_facility = LOG_USER;
250 break;
251 case SYSLOG_FACILITY_AUTH:
252 log_facility = LOG_AUTH;
253 break;
Damien Miller30246a82001-03-05 21:23:31 +1100254#ifdef LOG_AUTHPRIV
255 case SYSLOG_FACILITY_AUTHPRIV:
256 log_facility = LOG_AUTHPRIV;
257 break;
Ben Lindstrom53f11c62001-03-05 08:18:17 +0000258#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000259 case SYSLOG_FACILITY_LOCAL0:
260 log_facility = LOG_LOCAL0;
261 break;
262 case SYSLOG_FACILITY_LOCAL1:
263 log_facility = LOG_LOCAL1;
264 break;
265 case SYSLOG_FACILITY_LOCAL2:
266 log_facility = LOG_LOCAL2;
267 break;
268 case SYSLOG_FACILITY_LOCAL3:
269 log_facility = LOG_LOCAL3;
270 break;
271 case SYSLOG_FACILITY_LOCAL4:
272 log_facility = LOG_LOCAL4;
273 break;
274 case SYSLOG_FACILITY_LOCAL5:
275 log_facility = LOG_LOCAL5;
276 break;
277 case SYSLOG_FACILITY_LOCAL6:
278 log_facility = LOG_LOCAL6;
279 break;
280 case SYSLOG_FACILITY_LOCAL7:
281 log_facility = LOG_LOCAL7;
282 break;
283 default:
284 fprintf(stderr,
Kevin Stevesedcd5762001-04-02 13:45:00 +0000285 "Unrecognized internal syslog facility code %d\n",
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000286 (int) facility);
287 exit(1);
288 }
Darren Tucker9b5495d2005-02-01 17:35:09 +1100289
290 /*
291 * If an external library (eg libwrap) attempts to use syslog
292 * immediately after reexec, syslog may be pointing to the wrong
293 * facility, so we force an open/close of syslog here.
294 */
295#if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
296 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
297 closelog_r(&sdata);
298#else
299 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
300 closelog();
301#endif
Damien Miller6162d121999-11-21 13:23:52 +1100302}
303
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000304#define MSGBUFSIZ 1024
305
Ben Lindstrom9c8edc92002-02-26 17:52:14 +0000306void
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000307do_log(LogLevel level, const char *fmt, va_list args)
Damien Miller6162d121999-11-21 13:23:52 +1100308{
Damien Miller051b0ac2004-02-18 22:59:43 +1100309#if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
Damien Miller74a34422003-05-20 09:24:17 +1000310 struct syslog_data sdata = SYSLOG_DATA_INIT;
311#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000312 char msgbuf[MSGBUFSIZ];
313 char fmtbuf[MSGBUFSIZ];
314 char *txt = NULL;
315 int pri = LOG_INFO;
316
317 if (level > log_level)
318 return;
319
320 switch (level) {
321 case SYSLOG_LEVEL_FATAL:
322 if (!log_on_stderr)
323 txt = "fatal";
324 pri = LOG_CRIT;
325 break;
326 case SYSLOG_LEVEL_ERROR:
327 if (!log_on_stderr)
328 txt = "error";
329 pri = LOG_ERR;
330 break;
331 case SYSLOG_LEVEL_INFO:
332 pri = LOG_INFO;
333 break;
334 case SYSLOG_LEVEL_VERBOSE:
335 pri = LOG_INFO;
336 break;
337 case SYSLOG_LEVEL_DEBUG1:
338 txt = "debug1";
339 pri = LOG_DEBUG;
340 break;
341 case SYSLOG_LEVEL_DEBUG2:
342 txt = "debug2";
343 pri = LOG_DEBUG;
344 break;
345 case SYSLOG_LEVEL_DEBUG3:
346 txt = "debug3";
347 pri = LOG_DEBUG;
348 break;
349 default:
350 txt = "internal error";
351 pri = LOG_ERR;
352 break;
353 }
354 if (txt != NULL) {
355 snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt);
356 vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args);
357 } else {
358 vsnprintf(msgbuf, sizeof(msgbuf), fmt, args);
359 }
Damien Miller23a70272004-07-21 10:52:13 +1000360 strnvis(fmtbuf, msgbuf, sizeof(fmtbuf),
361 log_on_stderr ? LOG_STDERR_VIS : LOG_SYSLOG_VIS);
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000362 if (log_on_stderr) {
Damien Millerc11fe252003-05-25 14:38:02 +1000363 snprintf(msgbuf, sizeof msgbuf, "%s\r\n", fmtbuf);
364 write(STDERR_FILENO, msgbuf, strlen(msgbuf));
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000365 } else {
Damien Miller051b0ac2004-02-18 22:59:43 +1100366#if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
Damien Miller74a34422003-05-20 09:24:17 +1000367 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
Damien Millerc11fe252003-05-25 14:38:02 +1000368 syslog_r(pri, &sdata, "%.500s", fmtbuf);
Damien Miller74a34422003-05-20 09:24:17 +1000369 closelog_r(&sdata);
370#else
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000371 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
Damien Millerb93addb2003-01-07 17:04:18 +1100372 syslog(pri, "%.500s", fmtbuf);
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000373 closelog();
Damien Miller74a34422003-05-20 09:24:17 +1000374#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000375 }
Damien Miller6162d121999-11-21 13:23:52 +1100376}