]> andersk Git - openssh.git/blame - log.c
- markus@cvs.openbsd.org 2002/07/04 10:41:47
[openssh.git] / log.c
CommitLineData
bcbf86ec 1/*
2 * 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 */
6a17f9c2 12/*
bcbf86ec 13 * 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.
aa3378df 34 */
6a17f9c2 35
36#include "includes.h"
2bae80e9 37RCSID("$OpenBSD: log.c,v 1.22 2002/02/22 12:20:34 markus Exp $");
6a17f9c2 38
42f11eb2 39#include "log.h"
6a17f9c2 40#include "xmalloc.h"
41
20244695 42#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 },
cc3067d6 60#ifdef LOG_AUTHPRIV
61 { "AUTHPRIV", SYSLOG_FACILITY_AUTHPRIV },
62#endif
20244695 63 { "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 },
5eaf8578 71 { NULL, SYSLOG_FACILITY_NOT_SET }
20244695 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 },
5eaf8578 88 { NULL, SYSLOG_LEVEL_NOT_SET }
20244695 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;
5eaf8578 99 return SYSLOG_FACILITY_NOT_SET;
20244695 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;
5eaf8578 110 return SYSLOG_LEVEL_NOT_SET;
20244695 111}
6a17f9c2 112
113/* Error messages that should be logged. */
114
115void
5260325f 116error(const char *fmt,...)
6a17f9c2 117{
5260325f 118 va_list args;
119 va_start(args, fmt);
120 do_log(SYSLOG_LEVEL_ERROR, fmt, args);
121 va_end(args);
6a17f9c2 122}
123
124/* Log this message (information that usually should go to the log). */
125
126void
5260325f 127log(const char *fmt,...)
6a17f9c2 128{
5260325f 129 va_list args;
130 va_start(args, fmt);
59c97189 131 do_log(SYSLOG_LEVEL_INFO, fmt, args);
5260325f 132 va_end(args);
6a17f9c2 133}
134
135/* More detailed messages (information that does not need to go to the log). */
136
137void
5260325f 138verbose(const char *fmt,...)
6a17f9c2 139{
5260325f 140 va_list args;
141 va_start(args, fmt);
142 do_log(SYSLOG_LEVEL_VERBOSE, fmt, args);
143 va_end(args);
6a17f9c2 144}
145
146/* Debugging messages that should not be logged during normal operation. */
147
148void
5260325f 149debug(const char *fmt,...)
6a17f9c2 150{
5260325f 151 va_list args;
152 va_start(args, fmt);
bcbf86ec 153 do_log(SYSLOG_LEVEL_DEBUG1, fmt, args);
154 va_end(args);
155}
156
157void
158debug2(const char *fmt,...)
159{
160 va_list args;
161 va_start(args, fmt);
162 do_log(SYSLOG_LEVEL_DEBUG2, fmt, args);
163 va_end(args);
164}
165
166void
167debug3(const char *fmt,...)
168{
169 va_list args;
170 va_start(args, fmt);
171 do_log(SYSLOG_LEVEL_DEBUG3, fmt, args);
5260325f 172 va_end(args);
6a17f9c2 173}
174
175/* Fatal cleanup */
176
5260325f 177struct fatal_cleanup {
178 struct fatal_cleanup *next;
179 void (*proc) (void *);
180 void *context;
6a17f9c2 181};
182
183static struct fatal_cleanup *fatal_cleanups = NULL;
184
185/* Registers a cleanup function to be called by fatal() before exiting. */
186
187void
5260325f 188fatal_add_cleanup(void (*proc) (void *), void *context)
6a17f9c2 189{
5260325f 190 struct fatal_cleanup *cu;
6a17f9c2 191
5260325f 192 cu = xmalloc(sizeof(*cu));
193 cu->proc = proc;
194 cu->context = context;
195 cu->next = fatal_cleanups;
196 fatal_cleanups = cu;
6a17f9c2 197}
198
199/* Removes a cleanup frunction to be called at fatal(). */
200
201void
5260325f 202fatal_remove_cleanup(void (*proc) (void *context), void *context)
6a17f9c2 203{
5260325f 204 struct fatal_cleanup **cup, *cu;
205
206 for (cup = &fatal_cleanups; *cup; cup = &cu->next) {
207 cu = *cup;
208 if (cu->proc == proc && cu->context == context) {
209 *cup = cu->next;
210 xfree(cu);
211 return;
212 }
6a17f9c2 213 }
20244695 214 fatal("fatal_remove_cleanup: no such cleanup function: 0x%lx 0x%lx",
215 (u_long) proc, (u_long) context);
6a17f9c2 216}
217
218/* Cleanup and exit */
219void
220fatal_cleanup(void)
221{
5260325f 222 struct fatal_cleanup *cu, *next_cu;
223 static int called = 0;
224
225 if (called)
226 exit(255);
227 called = 1;
228 /* Call cleanup functions. */
229 for (cu = fatal_cleanups; cu; cu = next_cu) {
230 next_cu = cu->next;
231 debug("Calling cleanup 0x%lx(0x%lx)",
184eed6a 232 (u_long) cu->proc, (u_long) cu->context);
5260325f 233 (*cu->proc) (cu->context);
234 }
235 exit(255);
6a17f9c2 236}
9d6b7add 237
9d6b7add 238
20244695 239/*
240 * Initialize the log.
241 */
9d6b7add 242
20244695 243void
244log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr)
9d6b7add 245{
20244695 246 argv0 = av0;
9d6b7add 247
20244695 248 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:
0be033ea 260 fprintf(stderr, "Unrecognized internal syslog level code %d\n",
20244695 261 (int) level);
262 exit(1);
263 }
264
265 log_on_stderr = on_stderr;
266 if (on_stderr)
267 return;
268
269 switch (facility) {
270 case SYSLOG_FACILITY_DAEMON:
271 log_facility = LOG_DAEMON;
272 break;
273 case SYSLOG_FACILITY_USER:
274 log_facility = LOG_USER;
275 break;
276 case SYSLOG_FACILITY_AUTH:
277 log_facility = LOG_AUTH;
278 break;
cc3067d6 279#ifdef LOG_AUTHPRIV
280 case SYSLOG_FACILITY_AUTHPRIV:
281 log_facility = LOG_AUTHPRIV;
282 break;
20244695 283#endif
284 case SYSLOG_FACILITY_LOCAL0:
285 log_facility = LOG_LOCAL0;
286 break;
287 case SYSLOG_FACILITY_LOCAL1:
288 log_facility = LOG_LOCAL1;
289 break;
290 case SYSLOG_FACILITY_LOCAL2:
291 log_facility = LOG_LOCAL2;
292 break;
293 case SYSLOG_FACILITY_LOCAL3:
294 log_facility = LOG_LOCAL3;
295 break;
296 case SYSLOG_FACILITY_LOCAL4:
297 log_facility = LOG_LOCAL4;
298 break;
299 case SYSLOG_FACILITY_LOCAL5:
300 log_facility = LOG_LOCAL5;
301 break;
302 case SYSLOG_FACILITY_LOCAL6:
303 log_facility = LOG_LOCAL6;
304 break;
305 case SYSLOG_FACILITY_LOCAL7:
306 log_facility = LOG_LOCAL7;
307 break;
308 default:
309 fprintf(stderr,
0be033ea 310 "Unrecognized internal syslog facility code %d\n",
20244695 311 (int) facility);
312 exit(1);
313 }
9d6b7add 314}
315
20244695 316#define MSGBUFSIZ 1024
317
2bae80e9 318void
20244695 319do_log(LogLevel level, const char *fmt, va_list args)
9d6b7add 320{
20244695 321 char msgbuf[MSGBUFSIZ];
322 char fmtbuf[MSGBUFSIZ];
323 char *txt = NULL;
324 int pri = LOG_INFO;
325
326 if (level > log_level)
327 return;
328
329 switch (level) {
330 case SYSLOG_LEVEL_FATAL:
331 if (!log_on_stderr)
332 txt = "fatal";
333 pri = LOG_CRIT;
334 break;
335 case SYSLOG_LEVEL_ERROR:
336 if (!log_on_stderr)
337 txt = "error";
338 pri = LOG_ERR;
339 break;
340 case SYSLOG_LEVEL_INFO:
341 pri = LOG_INFO;
342 break;
343 case SYSLOG_LEVEL_VERBOSE:
344 pri = LOG_INFO;
345 break;
346 case SYSLOG_LEVEL_DEBUG1:
347 txt = "debug1";
348 pri = LOG_DEBUG;
349 break;
350 case SYSLOG_LEVEL_DEBUG2:
351 txt = "debug2";
352 pri = LOG_DEBUG;
353 break;
354 case SYSLOG_LEVEL_DEBUG3:
355 txt = "debug3";
356 pri = LOG_DEBUG;
357 break;
358 default:
359 txt = "internal error";
360 pri = LOG_ERR;
361 break;
362 }
363 if (txt != NULL) {
364 snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt);
365 vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args);
366 } else {
367 vsnprintf(msgbuf, sizeof(msgbuf), fmt, args);
368 }
369 if (log_on_stderr) {
370 fprintf(stderr, "%s\r\n", msgbuf);
371 } else {
372 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
373 syslog(pri, "%.500s", msgbuf);
374 closelog();
375 }
9d6b7add 376}
This page took 1.10813 seconds and 5 git commands to generate.