blob: 58ce8e5dd63784c31ca075f3f645aa530be85e90 [file] [log] [blame]
Damien Miller5ce662a1999-11-11 17:57:39 +11001/*
Damien Millere4340be2000-09-16 13:29:08 +11002 * Author: Tatu Ylonen <ylo@cs.hut.fi>
3 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4 * All rights reserved
5 *
6 * As far as I am concerned, the code I have written for this software
7 * can be used freely for any purpose. Any derived versions of this
8 * software must be clearly marked as such, and if the derived work is
9 * incompatible with the protocol description in the RFC file, it must be
10 * called by a name other than "ssh" or "Secure Shell".
11 */
12/*
Damien Millere4340be2000-09-16 13:29:08 +110013 * Copyright (c) 2000 Markus Friedl. All rights reserved.
14 *
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
17 * are met:
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
28 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
29 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Damien Miller5428f641999-11-25 11:54:57 +110034 */
Damien Miller5ce662a1999-11-11 17:57:39 +110035
36#include "includes.h"
Damien Millerc11fe252003-05-25 14:38:02 +100037RCSID("$OpenBSD: log.c,v 1.28 2003/05/24 09:02:22 djm Exp $");
Damien Miller5ce662a1999-11-11 17:57:39 +110038
Ben Lindstrom226cfa02001-01-22 05:34:40 +000039#include "log.h"
Damien Miller5ce662a1999-11-11 17:57:39 +110040#include "xmalloc.h"
41
Ben Lindstrom8a432f52001-03-05 07:24:46 +000042#include <syslog.h>
43
44static LogLevel log_level = SYSLOG_LEVEL_INFO;
45static int log_on_stderr = 1;
46static int log_facility = LOG_AUTH;
47static char *argv0;
48
49extern char *__progname;
50
51/* textual representation of log-facilities/levels */
52
53static struct {
54 const char *name;
55 SyslogFacility val;
56} log_facilities[] = {
57 { "DAEMON", SYSLOG_FACILITY_DAEMON },
58 { "USER", SYSLOG_FACILITY_USER },
59 { "AUTH", SYSLOG_FACILITY_AUTH },
Damien Miller30246a82001-03-05 21:23:31 +110060#ifdef LOG_AUTHPRIV
61 { "AUTHPRIV", SYSLOG_FACILITY_AUTHPRIV },
62#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +000063 { "LOCAL0", SYSLOG_FACILITY_LOCAL0 },
64 { "LOCAL1", SYSLOG_FACILITY_LOCAL1 },
65 { "LOCAL2", SYSLOG_FACILITY_LOCAL2 },
66 { "LOCAL3", SYSLOG_FACILITY_LOCAL3 },
67 { "LOCAL4", SYSLOG_FACILITY_LOCAL4 },
68 { "LOCAL5", SYSLOG_FACILITY_LOCAL5 },
69 { "LOCAL6", SYSLOG_FACILITY_LOCAL6 },
70 { "LOCAL7", SYSLOG_FACILITY_LOCAL7 },
Damien Millerfcd93202002-02-05 12:26:34 +110071 { NULL, SYSLOG_FACILITY_NOT_SET }
Ben Lindstrom8a432f52001-03-05 07:24:46 +000072};
73
74static struct {
75 const char *name;
76 LogLevel val;
77} log_levels[] =
78{
79 { "QUIET", SYSLOG_LEVEL_QUIET },
80 { "FATAL", SYSLOG_LEVEL_FATAL },
81 { "ERROR", SYSLOG_LEVEL_ERROR },
82 { "INFO", SYSLOG_LEVEL_INFO },
83 { "VERBOSE", SYSLOG_LEVEL_VERBOSE },
84 { "DEBUG", SYSLOG_LEVEL_DEBUG1 },
85 { "DEBUG1", SYSLOG_LEVEL_DEBUG1 },
86 { "DEBUG2", SYSLOG_LEVEL_DEBUG2 },
87 { "DEBUG3", SYSLOG_LEVEL_DEBUG3 },
Damien Millerfcd93202002-02-05 12:26:34 +110088 { NULL, SYSLOG_LEVEL_NOT_SET }
Ben Lindstrom8a432f52001-03-05 07:24:46 +000089};
90
91SyslogFacility
92log_facility_number(char *name)
93{
94 int i;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +000095
Ben Lindstrom8a432f52001-03-05 07:24:46 +000096 if (name != NULL)
97 for (i = 0; log_facilities[i].name; i++)
98 if (strcasecmp(log_facilities[i].name, name) == 0)
99 return log_facilities[i].val;
Damien Millerfcd93202002-02-05 12:26:34 +1100100 return SYSLOG_FACILITY_NOT_SET;
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000101}
102
103LogLevel
104log_level_number(char *name)
105{
106 int i;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000107
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000108 if (name != NULL)
109 for (i = 0; log_levels[i].name; i++)
110 if (strcasecmp(log_levels[i].name, name) == 0)
111 return log_levels[i].val;
Damien Millerfcd93202002-02-05 12:26:34 +1100112 return SYSLOG_LEVEL_NOT_SET;
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000113}
Damien Miller5ce662a1999-11-11 17:57:39 +1100114
115/* Error messages that should be logged. */
116
117void
Damien Miller95def091999-11-25 00:26:21 +1100118error(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100119{
Damien Miller95def091999-11-25 00:26:21 +1100120 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000121
Damien Miller95def091999-11-25 00:26:21 +1100122 va_start(args, fmt);
123 do_log(SYSLOG_LEVEL_ERROR, fmt, args);
124 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100125}
126
127/* Log this message (information that usually should go to the log). */
128
129void
Damien Miller996acd22003-04-09 20:59:48 +1000130logit(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100131{
Damien Miller95def091999-11-25 00:26:21 +1100132 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000133
Damien Miller95def091999-11-25 00:26:21 +1100134 va_start(args, fmt);
Ben Lindstromdb65e8f2001-01-19 04:26:52 +0000135 do_log(SYSLOG_LEVEL_INFO, fmt, args);
Damien Miller95def091999-11-25 00:26:21 +1100136 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100137}
138
139/* More detailed messages (information that does not need to go to the log). */
140
141void
Damien Miller95def091999-11-25 00:26:21 +1100142verbose(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100143{
Damien Miller95def091999-11-25 00:26:21 +1100144 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000145
Damien Miller95def091999-11-25 00:26:21 +1100146 va_start(args, fmt);
147 do_log(SYSLOG_LEVEL_VERBOSE, fmt, args);
148 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100149}
150
151/* Debugging messages that should not be logged during normal operation. */
152
153void
Damien Miller95def091999-11-25 00:26:21 +1100154debug(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100155{
Damien Miller95def091999-11-25 00:26:21 +1100156 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000157
Damien Miller95def091999-11-25 00:26:21 +1100158 va_start(args, fmt);
Damien Millere4340be2000-09-16 13:29:08 +1100159 do_log(SYSLOG_LEVEL_DEBUG1, fmt, args);
160 va_end(args);
161}
162
163void
164debug2(const char *fmt,...)
165{
166 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000167
Damien Millere4340be2000-09-16 13:29:08 +1100168 va_start(args, fmt);
169 do_log(SYSLOG_LEVEL_DEBUG2, fmt, args);
170 va_end(args);
171}
172
173void
174debug3(const char *fmt,...)
175{
176 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000177
Damien Millere4340be2000-09-16 13:29:08 +1100178 va_start(args, fmt);
179 do_log(SYSLOG_LEVEL_DEBUG3, fmt, args);
Damien Miller95def091999-11-25 00:26:21 +1100180 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100181}
182
183/* Fatal cleanup */
184
Damien Miller95def091999-11-25 00:26:21 +1100185struct fatal_cleanup {
186 struct fatal_cleanup *next;
187 void (*proc) (void *);
188 void *context;
Damien Miller5ce662a1999-11-11 17:57:39 +1100189};
190
191static struct fatal_cleanup *fatal_cleanups = NULL;
192
193/* Registers a cleanup function to be called by fatal() before exiting. */
194
195void
Damien Miller95def091999-11-25 00:26:21 +1100196fatal_add_cleanup(void (*proc) (void *), void *context)
Damien Miller5ce662a1999-11-11 17:57:39 +1100197{
Damien Miller95def091999-11-25 00:26:21 +1100198 struct fatal_cleanup *cu;
Damien Miller5ce662a1999-11-11 17:57:39 +1100199
Damien Miller95def091999-11-25 00:26:21 +1100200 cu = xmalloc(sizeof(*cu));
201 cu->proc = proc;
202 cu->context = context;
203 cu->next = fatal_cleanups;
204 fatal_cleanups = cu;
Damien Miller5ce662a1999-11-11 17:57:39 +1100205}
206
207/* Removes a cleanup frunction to be called at fatal(). */
208
209void
Damien Miller95def091999-11-25 00:26:21 +1100210fatal_remove_cleanup(void (*proc) (void *context), void *context)
Damien Miller5ce662a1999-11-11 17:57:39 +1100211{
Damien Miller95def091999-11-25 00:26:21 +1100212 struct fatal_cleanup **cup, *cu;
213
214 for (cup = &fatal_cleanups; *cup; cup = &cu->next) {
215 cu = *cup;
216 if (cu->proc == proc && cu->context == context) {
217 *cup = cu->next;
218 xfree(cu);
219 return;
220 }
Damien Miller5ce662a1999-11-11 17:57:39 +1100221 }
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000222 fatal("fatal_remove_cleanup: no such cleanup function: 0x%lx 0x%lx",
223 (u_long) proc, (u_long) context);
Damien Miller5ce662a1999-11-11 17:57:39 +1100224}
225
Ben Lindstrom264ee302002-07-23 21:01:56 +0000226/* Remove all cleanups, to be called after fork() */
227void
228fatal_remove_all_cleanups(void)
229{
230 struct fatal_cleanup *cu, *next_cu;
231
232 for (cu = fatal_cleanups; cu; cu = next_cu) {
233 next_cu = cu->next;
234 xfree(cu);
235 }
Damien Miller0946d872003-01-14 22:22:43 +1100236 fatal_cleanups = NULL;
Ben Lindstrom264ee302002-07-23 21:01:56 +0000237}
238
Damien Miller5ce662a1999-11-11 17:57:39 +1100239/* Cleanup and exit */
240void
241fatal_cleanup(void)
242{
Damien Miller95def091999-11-25 00:26:21 +1100243 struct fatal_cleanup *cu, *next_cu;
244 static int called = 0;
Damien Miller5ce662a1999-11-11 17:57:39 +1100245
Damien Miller95def091999-11-25 00:26:21 +1100246 if (called)
247 exit(255);
248 called = 1;
249 /* Call cleanup functions. */
250 for (cu = fatal_cleanups; cu; cu = next_cu) {
251 next_cu = cu->next;
252 debug("Calling cleanup 0x%lx(0x%lx)",
Damien Miller9f0f5c62001-12-21 14:45:46 +1100253 (u_long) cu->proc, (u_long) cu->context);
Damien Miller95def091999-11-25 00:26:21 +1100254 (*cu->proc) (cu->context);
255 }
256 exit(255);
Damien Miller5ce662a1999-11-11 17:57:39 +1100257}
Damien Miller6162d121999-11-21 13:23:52 +1100258
Damien Miller6162d121999-11-21 13:23:52 +1100259
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000260/*
261 * Initialize the log.
262 */
263
264void
265log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr)
266{
267 argv0 = av0;
268
269 switch (level) {
270 case SYSLOG_LEVEL_QUIET:
271 case SYSLOG_LEVEL_FATAL:
272 case SYSLOG_LEVEL_ERROR:
273 case SYSLOG_LEVEL_INFO:
274 case SYSLOG_LEVEL_VERBOSE:
275 case SYSLOG_LEVEL_DEBUG1:
276 case SYSLOG_LEVEL_DEBUG2:
277 case SYSLOG_LEVEL_DEBUG3:
278 log_level = level;
279 break;
280 default:
Kevin Stevesedcd5762001-04-02 13:45:00 +0000281 fprintf(stderr, "Unrecognized internal syslog level code %d\n",
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000282 (int) level);
283 exit(1);
284 }
285
286 log_on_stderr = on_stderr;
287 if (on_stderr)
288 return;
289
290 switch (facility) {
291 case SYSLOG_FACILITY_DAEMON:
292 log_facility = LOG_DAEMON;
293 break;
294 case SYSLOG_FACILITY_USER:
295 log_facility = LOG_USER;
296 break;
297 case SYSLOG_FACILITY_AUTH:
298 log_facility = LOG_AUTH;
299 break;
Damien Miller30246a82001-03-05 21:23:31 +1100300#ifdef LOG_AUTHPRIV
301 case SYSLOG_FACILITY_AUTHPRIV:
302 log_facility = LOG_AUTHPRIV;
303 break;
Ben Lindstrom53f11c62001-03-05 08:18:17 +0000304#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000305 case SYSLOG_FACILITY_LOCAL0:
306 log_facility = LOG_LOCAL0;
307 break;
308 case SYSLOG_FACILITY_LOCAL1:
309 log_facility = LOG_LOCAL1;
310 break;
311 case SYSLOG_FACILITY_LOCAL2:
312 log_facility = LOG_LOCAL2;
313 break;
314 case SYSLOG_FACILITY_LOCAL3:
315 log_facility = LOG_LOCAL3;
316 break;
317 case SYSLOG_FACILITY_LOCAL4:
318 log_facility = LOG_LOCAL4;
319 break;
320 case SYSLOG_FACILITY_LOCAL5:
321 log_facility = LOG_LOCAL5;
322 break;
323 case SYSLOG_FACILITY_LOCAL6:
324 log_facility = LOG_LOCAL6;
325 break;
326 case SYSLOG_FACILITY_LOCAL7:
327 log_facility = LOG_LOCAL7;
328 break;
329 default:
330 fprintf(stderr,
Kevin Stevesedcd5762001-04-02 13:45:00 +0000331 "Unrecognized internal syslog facility code %d\n",
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000332 (int) facility);
333 exit(1);
334 }
Damien Miller6162d121999-11-21 13:23:52 +1100335}
336
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000337#define MSGBUFSIZ 1024
338
Ben Lindstrom9c8edc92002-02-26 17:52:14 +0000339void
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000340do_log(LogLevel level, const char *fmt, va_list args)
Damien Miller6162d121999-11-21 13:23:52 +1100341{
Damien Miller74a34422003-05-20 09:24:17 +1000342#ifdef OPENLOG_R
343 struct syslog_data sdata = SYSLOG_DATA_INIT;
344#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000345 char msgbuf[MSGBUFSIZ];
346 char fmtbuf[MSGBUFSIZ];
347 char *txt = NULL;
348 int pri = LOG_INFO;
349
350 if (level > log_level)
351 return;
352
353 switch (level) {
354 case SYSLOG_LEVEL_FATAL:
355 if (!log_on_stderr)
356 txt = "fatal";
357 pri = LOG_CRIT;
358 break;
359 case SYSLOG_LEVEL_ERROR:
360 if (!log_on_stderr)
361 txt = "error";
362 pri = LOG_ERR;
363 break;
364 case SYSLOG_LEVEL_INFO:
365 pri = LOG_INFO;
366 break;
367 case SYSLOG_LEVEL_VERBOSE:
368 pri = LOG_INFO;
369 break;
370 case SYSLOG_LEVEL_DEBUG1:
371 txt = "debug1";
372 pri = LOG_DEBUG;
373 break;
374 case SYSLOG_LEVEL_DEBUG2:
375 txt = "debug2";
376 pri = LOG_DEBUG;
377 break;
378 case SYSLOG_LEVEL_DEBUG3:
379 txt = "debug3";
380 pri = LOG_DEBUG;
381 break;
382 default:
383 txt = "internal error";
384 pri = LOG_ERR;
385 break;
386 }
387 if (txt != NULL) {
388 snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt);
389 vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args);
390 } else {
391 vsnprintf(msgbuf, sizeof(msgbuf), fmt, args);
392 }
Damien Millerd419bda2003-05-23 18:43:40 +1000393 strnvis(fmtbuf, msgbuf, sizeof(fmtbuf), VIS_SAFE|VIS_OCTAL);
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000394 if (log_on_stderr) {
Damien Millerc11fe252003-05-25 14:38:02 +1000395 snprintf(msgbuf, sizeof msgbuf, "%s\r\n", fmtbuf);
396 write(STDERR_FILENO, msgbuf, strlen(msgbuf));
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000397 } else {
Damien Miller74a34422003-05-20 09:24:17 +1000398#ifdef OPENLOG_R
399 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
Damien Millerc11fe252003-05-25 14:38:02 +1000400 syslog_r(pri, &sdata, "%.500s", fmtbuf);
Damien Miller74a34422003-05-20 09:24:17 +1000401 closelog_r(&sdata);
402#else
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000403 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
Damien Millerb93addb2003-01-07 17:04:18 +1100404 syslog(pri, "%.500s", fmtbuf);
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000405 closelog();
Damien Miller74a34422003-05-20 09:24:17 +1000406#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000407 }
Damien Miller6162d121999-11-21 13:23:52 +1100408}