blob: 7e01384faeef479bc5cab6a40221181f220db61b [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 Miller95def091999-11-25 00:26:21 +110013 * Shared versions of debug(), log(), etc.
Damien Millere4340be2000-09-16 13:29:08 +110014 *
15 * Copyright (c) 2000 Markus Friedl. All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
19 * are met:
20 * 1. Redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer.
22 * 2. Redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Damien Miller5428f641999-11-25 11:54:57 +110036 */
Damien Miller5ce662a1999-11-11 17:57:39 +110037
38#include "includes.h"
Ben Lindstrom226cfa02001-01-22 05:34:40 +000039RCSID("$OpenBSD: log.c,v 1.15 2001/01/21 19:05:51 markus Exp $");
Damien Miller5ce662a1999-11-11 17:57:39 +110040
Ben Lindstrom226cfa02001-01-22 05:34:40 +000041#include "log.h"
Damien Miller5ce662a1999-11-11 17:57:39 +110042#include "xmalloc.h"
43
44/* Fatal messages. This function never returns. */
45
46void
Damien Miller95def091999-11-25 00:26:21 +110047fatal(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +110048{
Damien Miller95def091999-11-25 00:26:21 +110049 va_list args;
50 va_start(args, fmt);
51 do_log(SYSLOG_LEVEL_FATAL, fmt, args);
52 va_end(args);
53 fatal_cleanup();
Damien Miller5ce662a1999-11-11 17:57:39 +110054}
55
56/* Error messages that should be logged. */
57
58void
Damien Miller95def091999-11-25 00:26:21 +110059error(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +110060{
Damien Miller95def091999-11-25 00:26:21 +110061 va_list args;
62 va_start(args, fmt);
63 do_log(SYSLOG_LEVEL_ERROR, fmt, args);
64 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +110065}
66
67/* Log this message (information that usually should go to the log). */
68
69void
Damien Miller95def091999-11-25 00:26:21 +110070log(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +110071{
Damien Miller95def091999-11-25 00:26:21 +110072 va_list args;
73 va_start(args, fmt);
Ben Lindstromdb65e8f2001-01-19 04:26:52 +000074 do_log(SYSLOG_LEVEL_INFO, fmt, args);
Damien Miller95def091999-11-25 00:26:21 +110075 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +110076}
77
78/* More detailed messages (information that does not need to go to the log). */
79
80void
Damien Miller95def091999-11-25 00:26:21 +110081verbose(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +110082{
Damien Miller95def091999-11-25 00:26:21 +110083 va_list args;
84 va_start(args, fmt);
85 do_log(SYSLOG_LEVEL_VERBOSE, fmt, args);
86 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +110087}
88
89/* Debugging messages that should not be logged during normal operation. */
90
91void
Damien Miller95def091999-11-25 00:26:21 +110092debug(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +110093{
Damien Miller95def091999-11-25 00:26:21 +110094 va_list args;
95 va_start(args, fmt);
Damien Millere4340be2000-09-16 13:29:08 +110096 do_log(SYSLOG_LEVEL_DEBUG1, fmt, args);
97 va_end(args);
98}
99
100void
101debug2(const char *fmt,...)
102{
103 va_list args;
104 va_start(args, fmt);
105 do_log(SYSLOG_LEVEL_DEBUG2, fmt, args);
106 va_end(args);
107}
108
109void
110debug3(const char *fmt,...)
111{
112 va_list args;
113 va_start(args, fmt);
114 do_log(SYSLOG_LEVEL_DEBUG3, fmt, args);
Damien Miller95def091999-11-25 00:26:21 +1100115 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100116}
117
118/* Fatal cleanup */
119
Damien Miller95def091999-11-25 00:26:21 +1100120struct fatal_cleanup {
121 struct fatal_cleanup *next;
122 void (*proc) (void *);
123 void *context;
Damien Miller5ce662a1999-11-11 17:57:39 +1100124};
125
126static struct fatal_cleanup *fatal_cleanups = NULL;
127
128/* Registers a cleanup function to be called by fatal() before exiting. */
129
130void
Damien Miller95def091999-11-25 00:26:21 +1100131fatal_add_cleanup(void (*proc) (void *), void *context)
Damien Miller5ce662a1999-11-11 17:57:39 +1100132{
Damien Miller95def091999-11-25 00:26:21 +1100133 struct fatal_cleanup *cu;
Damien Miller5ce662a1999-11-11 17:57:39 +1100134
Damien Miller95def091999-11-25 00:26:21 +1100135 cu = xmalloc(sizeof(*cu));
136 cu->proc = proc;
137 cu->context = context;
138 cu->next = fatal_cleanups;
139 fatal_cleanups = cu;
Damien Miller5ce662a1999-11-11 17:57:39 +1100140}
141
142/* Removes a cleanup frunction to be called at fatal(). */
143
144void
Damien Miller95def091999-11-25 00:26:21 +1100145fatal_remove_cleanup(void (*proc) (void *context), void *context)
Damien Miller5ce662a1999-11-11 17:57:39 +1100146{
Damien Miller95def091999-11-25 00:26:21 +1100147 struct fatal_cleanup **cup, *cu;
148
149 for (cup = &fatal_cleanups; *cup; cup = &cu->next) {
150 cu = *cup;
151 if (cu->proc == proc && cu->context == context) {
152 *cup = cu->next;
153 xfree(cu);
154 return;
155 }
Damien Miller5ce662a1999-11-11 17:57:39 +1100156 }
Damien Miller95def091999-11-25 00:26:21 +1100157 fatal("fatal_remove_cleanup: no such cleanup function: 0x%lx 0x%lx\n",
Ben Lindstrom46c16222000-12-22 01:43:59 +0000158 (u_long) proc, (u_long) context);
Damien Miller5ce662a1999-11-11 17:57:39 +1100159}
160
161/* Cleanup and exit */
162void
163fatal_cleanup(void)
164{
Damien Miller95def091999-11-25 00:26:21 +1100165 struct fatal_cleanup *cu, *next_cu;
166 static int called = 0;
Damien Miller5ce662a1999-11-11 17:57:39 +1100167
Damien Miller95def091999-11-25 00:26:21 +1100168 if (called)
169 exit(255);
170 called = 1;
171 /* Call cleanup functions. */
172 for (cu = fatal_cleanups; cu; cu = next_cu) {
173 next_cu = cu->next;
174 debug("Calling cleanup 0x%lx(0x%lx)",
Ben Lindstrom46c16222000-12-22 01:43:59 +0000175 (u_long) cu->proc, (u_long) cu->context);
Damien Miller95def091999-11-25 00:26:21 +1100176 (*cu->proc) (cu->context);
177 }
178 exit(255);
Damien Miller5ce662a1999-11-11 17:57:39 +1100179}
Damien Miller6162d121999-11-21 13:23:52 +1100180
181/* textual representation of log-facilities/levels */
182
Damien Miller95def091999-11-25 00:26:21 +1100183static struct {
184 const char *name;
185 SyslogFacility val;
186} log_facilities[] = {
187 { "DAEMON", SYSLOG_FACILITY_DAEMON },
188 { "USER", SYSLOG_FACILITY_USER },
189 { "AUTH", SYSLOG_FACILITY_AUTH },
Damien Miller6dbfef62000-11-29 13:51:06 +1100190#ifdef LOG_AUTHPRIV
191 { "AUTHPRIV", SYSLOG_FACILITY_AUTHPRIV },
192#endif
Damien Miller95def091999-11-25 00:26:21 +1100193 { "LOCAL0", SYSLOG_FACILITY_LOCAL0 },
194 { "LOCAL1", SYSLOG_FACILITY_LOCAL1 },
195 { "LOCAL2", SYSLOG_FACILITY_LOCAL2 },
196 { "LOCAL3", SYSLOG_FACILITY_LOCAL3 },
197 { "LOCAL4", SYSLOG_FACILITY_LOCAL4 },
198 { "LOCAL5", SYSLOG_FACILITY_LOCAL5 },
199 { "LOCAL6", SYSLOG_FACILITY_LOCAL6 },
200 { "LOCAL7", SYSLOG_FACILITY_LOCAL7 },
201 { NULL, 0 }
Damien Miller6162d121999-11-21 13:23:52 +1100202};
203
Damien Miller95def091999-11-25 00:26:21 +1100204static struct {
205 const char *name;
206 LogLevel val;
Damien Miller6162d121999-11-21 13:23:52 +1100207} log_levels[] =
208{
Damien Miller95def091999-11-25 00:26:21 +1100209 { "QUIET", SYSLOG_LEVEL_QUIET },
210 { "FATAL", SYSLOG_LEVEL_FATAL },
211 { "ERROR", SYSLOG_LEVEL_ERROR },
Ben Lindstromdb65e8f2001-01-19 04:26:52 +0000212 { "INFO", SYSLOG_LEVEL_INFO },
Damien Miller95def091999-11-25 00:26:21 +1100213 { "VERBOSE", SYSLOG_LEVEL_VERBOSE },
Damien Miller874d77b2000-10-14 16:23:11 +1100214 { "DEBUG", SYSLOG_LEVEL_DEBUG1 },
Damien Millere4340be2000-09-16 13:29:08 +1100215 { "DEBUG1", SYSLOG_LEVEL_DEBUG1 },
216 { "DEBUG2", SYSLOG_LEVEL_DEBUG2 },
217 { "DEBUG3", SYSLOG_LEVEL_DEBUG3 },
Damien Miller95def091999-11-25 00:26:21 +1100218 { NULL, 0 }
Damien Miller6162d121999-11-21 13:23:52 +1100219};
220
221SyslogFacility
222log_facility_number(char *name)
223{
Damien Miller95def091999-11-25 00:26:21 +1100224 int i;
225 if (name != NULL)
226 for (i = 0; log_facilities[i].name; i++)
227 if (strcasecmp(log_facilities[i].name, name) == 0)
228 return log_facilities[i].val;
229 return (SyslogFacility) - 1;
Damien Miller6162d121999-11-21 13:23:52 +1100230}
231
232LogLevel
233log_level_number(char *name)
234{
Damien Miller95def091999-11-25 00:26:21 +1100235 int i;
236 if (name != NULL)
237 for (i = 0; log_levels[i].name; i++)
238 if (strcasecmp(log_levels[i].name, name) == 0)
239 return log_levels[i].val;
240 return (LogLevel) - 1;
Damien Miller6162d121999-11-21 13:23:52 +1100241}