blob: f8f6c1c4ad5d0854f985dc1d12ab557c4cb0916c [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"
Ben Lindstrom97271812001-03-05 07:51:52 +000037RCSID("$OpenBSD: log.c,v 1.17 2001/03/04 17:42:28 millert 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 },
71 { NULL, 0 }
72};
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 },
88 { NULL, 0 }
89};
90
91SyslogFacility
92log_facility_number(char *name)
93{
94 int i;
95 if (name != NULL)
96 for (i = 0; log_facilities[i].name; i++)
97 if (strcasecmp(log_facilities[i].name, name) == 0)
98 return log_facilities[i].val;
99 return (SyslogFacility) - 1;
100}
101
102LogLevel
103log_level_number(char *name)
104{
105 int i;
106 if (name != NULL)
107 for (i = 0; log_levels[i].name; i++)
108 if (strcasecmp(log_levels[i].name, name) == 0)
109 return log_levels[i].val;
110 return (LogLevel) - 1;
111}
Damien Miller5ce662a1999-11-11 17:57:39 +1100112/* Fatal messages. This function never returns. */
113
114void
Damien Miller95def091999-11-25 00:26:21 +1100115fatal(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100116{
Damien Miller95def091999-11-25 00:26:21 +1100117 va_list args;
118 va_start(args, fmt);
119 do_log(SYSLOG_LEVEL_FATAL, fmt, args);
120 va_end(args);
121 fatal_cleanup();
Damien Miller5ce662a1999-11-11 17:57:39 +1100122}
123
124/* Error messages that should be logged. */
125
126void
Damien Miller95def091999-11-25 00:26:21 +1100127error(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100128{
Damien Miller95def091999-11-25 00:26:21 +1100129 va_list args;
130 va_start(args, fmt);
131 do_log(SYSLOG_LEVEL_ERROR, fmt, args);
132 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100133}
134
135/* Log this message (information that usually should go to the log). */
136
137void
Damien Miller95def091999-11-25 00:26:21 +1100138log(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100139{
Damien Miller95def091999-11-25 00:26:21 +1100140 va_list args;
141 va_start(args, fmt);
Ben Lindstromdb65e8f2001-01-19 04:26:52 +0000142 do_log(SYSLOG_LEVEL_INFO, fmt, args);
Damien Miller95def091999-11-25 00:26:21 +1100143 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100144}
145
146/* More detailed messages (information that does not need to go to the log). */
147
148void
Damien Miller95def091999-11-25 00:26:21 +1100149verbose(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100150{
Damien Miller95def091999-11-25 00:26:21 +1100151 va_list args;
152 va_start(args, fmt);
153 do_log(SYSLOG_LEVEL_VERBOSE, fmt, args);
154 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100155}
156
157/* Debugging messages that should not be logged during normal operation. */
158
159void
Damien Miller95def091999-11-25 00:26:21 +1100160debug(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100161{
Damien Miller95def091999-11-25 00:26:21 +1100162 va_list args;
163 va_start(args, fmt);
Damien Millere4340be2000-09-16 13:29:08 +1100164 do_log(SYSLOG_LEVEL_DEBUG1, fmt, args);
165 va_end(args);
166}
167
168void
169debug2(const char *fmt,...)
170{
171 va_list args;
172 va_start(args, fmt);
173 do_log(SYSLOG_LEVEL_DEBUG2, fmt, args);
174 va_end(args);
175}
176
177void
178debug3(const char *fmt,...)
179{
180 va_list args;
181 va_start(args, fmt);
182 do_log(SYSLOG_LEVEL_DEBUG3, fmt, args);
Damien Miller95def091999-11-25 00:26:21 +1100183 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100184}
185
186/* Fatal cleanup */
187
Damien Miller95def091999-11-25 00:26:21 +1100188struct fatal_cleanup {
189 struct fatal_cleanup *next;
190 void (*proc) (void *);
191 void *context;
Damien Miller5ce662a1999-11-11 17:57:39 +1100192};
193
194static struct fatal_cleanup *fatal_cleanups = NULL;
195
196/* Registers a cleanup function to be called by fatal() before exiting. */
197
198void
Damien Miller95def091999-11-25 00:26:21 +1100199fatal_add_cleanup(void (*proc) (void *), void *context)
Damien Miller5ce662a1999-11-11 17:57:39 +1100200{
Damien Miller95def091999-11-25 00:26:21 +1100201 struct fatal_cleanup *cu;
Damien Miller5ce662a1999-11-11 17:57:39 +1100202
Damien Miller95def091999-11-25 00:26:21 +1100203 cu = xmalloc(sizeof(*cu));
204 cu->proc = proc;
205 cu->context = context;
206 cu->next = fatal_cleanups;
207 fatal_cleanups = cu;
Damien Miller5ce662a1999-11-11 17:57:39 +1100208}
209
210/* Removes a cleanup frunction to be called at fatal(). */
211
212void
Damien Miller95def091999-11-25 00:26:21 +1100213fatal_remove_cleanup(void (*proc) (void *context), void *context)
Damien Miller5ce662a1999-11-11 17:57:39 +1100214{
Damien Miller95def091999-11-25 00:26:21 +1100215 struct fatal_cleanup **cup, *cu;
216
217 for (cup = &fatal_cleanups; *cup; cup = &cu->next) {
218 cu = *cup;
219 if (cu->proc == proc && cu->context == context) {
220 *cup = cu->next;
221 xfree(cu);
222 return;
223 }
Damien Miller5ce662a1999-11-11 17:57:39 +1100224 }
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000225 fatal("fatal_remove_cleanup: no such cleanup function: 0x%lx 0x%lx",
226 (u_long) proc, (u_long) context);
Damien Miller5ce662a1999-11-11 17:57:39 +1100227}
228
229/* Cleanup and exit */
230void
231fatal_cleanup(void)
232{
Damien Miller95def091999-11-25 00:26:21 +1100233 struct fatal_cleanup *cu, *next_cu;
234 static int called = 0;
Damien Miller5ce662a1999-11-11 17:57:39 +1100235
Damien Miller95def091999-11-25 00:26:21 +1100236 if (called)
237 exit(255);
238 called = 1;
239 /* Call cleanup functions. */
240 for (cu = fatal_cleanups; cu; cu = next_cu) {
241 next_cu = cu->next;
242 debug("Calling cleanup 0x%lx(0x%lx)",
Ben Lindstrom46c16222000-12-22 01:43:59 +0000243 (u_long) cu->proc, (u_long) cu->context);
Damien Miller95def091999-11-25 00:26:21 +1100244 (*cu->proc) (cu->context);
245 }
246 exit(255);
Damien Miller5ce662a1999-11-11 17:57:39 +1100247}
Damien Miller6162d121999-11-21 13:23:52 +1100248
Damien Miller6162d121999-11-21 13:23:52 +1100249
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000250/*
251 * Initialize the log.
252 */
253
254void
255log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr)
256{
257 argv0 = av0;
258
259 switch (level) {
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:
268 log_level = level;
269 break;
270 default:
Kevin Stevesedcd5762001-04-02 13:45:00 +0000271 fprintf(stderr, "Unrecognized internal syslog level code %d\n",
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000272 (int) level);
273 exit(1);
274 }
275
276 log_on_stderr = on_stderr;
277 if (on_stderr)
278 return;
279
280 switch (facility) {
281 case SYSLOG_FACILITY_DAEMON:
282 log_facility = LOG_DAEMON;
283 break;
284 case SYSLOG_FACILITY_USER:
285 log_facility = LOG_USER;
286 break;
287 case SYSLOG_FACILITY_AUTH:
288 log_facility = LOG_AUTH;
289 break;
Damien Miller30246a82001-03-05 21:23:31 +1100290#ifdef LOG_AUTHPRIV
291 case SYSLOG_FACILITY_AUTHPRIV:
292 log_facility = LOG_AUTHPRIV;
293 break;
Ben Lindstrom53f11c62001-03-05 08:18:17 +0000294#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000295 case SYSLOG_FACILITY_LOCAL0:
296 log_facility = LOG_LOCAL0;
297 break;
298 case SYSLOG_FACILITY_LOCAL1:
299 log_facility = LOG_LOCAL1;
300 break;
301 case SYSLOG_FACILITY_LOCAL2:
302 log_facility = LOG_LOCAL2;
303 break;
304 case SYSLOG_FACILITY_LOCAL3:
305 log_facility = LOG_LOCAL3;
306 break;
307 case SYSLOG_FACILITY_LOCAL4:
308 log_facility = LOG_LOCAL4;
309 break;
310 case SYSLOG_FACILITY_LOCAL5:
311 log_facility = LOG_LOCAL5;
312 break;
313 case SYSLOG_FACILITY_LOCAL6:
314 log_facility = LOG_LOCAL6;
315 break;
316 case SYSLOG_FACILITY_LOCAL7:
317 log_facility = LOG_LOCAL7;
318 break;
319 default:
320 fprintf(stderr,
Kevin Stevesedcd5762001-04-02 13:45:00 +0000321 "Unrecognized internal syslog facility code %d\n",
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000322 (int) facility);
323 exit(1);
324 }
Damien Miller6162d121999-11-21 13:23:52 +1100325}
326
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000327#define MSGBUFSIZ 1024
328
329void
330do_log(LogLevel level, const char *fmt, va_list args)
Damien Miller6162d121999-11-21 13:23:52 +1100331{
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000332 char msgbuf[MSGBUFSIZ];
333 char fmtbuf[MSGBUFSIZ];
334 char *txt = NULL;
335 int pri = LOG_INFO;
336
337 if (level > log_level)
338 return;
339
340 switch (level) {
341 case SYSLOG_LEVEL_FATAL:
342 if (!log_on_stderr)
343 txt = "fatal";
344 pri = LOG_CRIT;
345 break;
346 case SYSLOG_LEVEL_ERROR:
347 if (!log_on_stderr)
348 txt = "error";
349 pri = LOG_ERR;
350 break;
351 case SYSLOG_LEVEL_INFO:
352 pri = LOG_INFO;
353 break;
354 case SYSLOG_LEVEL_VERBOSE:
355 pri = LOG_INFO;
356 break;
357 case SYSLOG_LEVEL_DEBUG1:
358 txt = "debug1";
359 pri = LOG_DEBUG;
360 break;
361 case SYSLOG_LEVEL_DEBUG2:
362 txt = "debug2";
363 pri = LOG_DEBUG;
364 break;
365 case SYSLOG_LEVEL_DEBUG3:
366 txt = "debug3";
367 pri = LOG_DEBUG;
368 break;
369 default:
370 txt = "internal error";
371 pri = LOG_ERR;
372 break;
373 }
374 if (txt != NULL) {
375 snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt);
376 vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args);
377 } else {
378 vsnprintf(msgbuf, sizeof(msgbuf), fmt, args);
379 }
380 if (log_on_stderr) {
381 fprintf(stderr, "%s\r\n", msgbuf);
382 } else {
383 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
384 syslog(pri, "%.500s", msgbuf);
385 closelog();
386 }
Damien Miller6162d121999-11-21 13:23:52 +1100387}