blob: 96ab24b04b43bc1a65275fbbd622cd0aac54c547 [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"
Darren Tucker3e33cec2003-10-02 16:12:36 +100037RCSID("$OpenBSD: log.c,v 1.29 2003/09/23 20:17:11 markus 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>
Damien Miller5c3a5582003-09-23 22:12:38 +100043#if defined(HAVE_STRNVIS) && defined(HAVE_VIS_H)
44# include <vis.h>
45#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +000046
47static LogLevel log_level = SYSLOG_LEVEL_INFO;
48static int log_on_stderr = 1;
49static int log_facility = LOG_AUTH;
50static char *argv0;
51
52extern char *__progname;
53
Damien Miller23a70272004-07-21 10:52:13 +100054#define LOG_SYSLOG_VIS (VIS_CSTYLE|VIS_NL|VIS_TAB|VIS_OCTAL)
55#define LOG_STDERR_VIS (VIS_SAFE|VIS_OCTAL)
56
Ben Lindstrom8a432f52001-03-05 07:24:46 +000057/* textual representation of log-facilities/levels */
58
59static struct {
60 const char *name;
61 SyslogFacility val;
62} log_facilities[] = {
63 { "DAEMON", SYSLOG_FACILITY_DAEMON },
64 { "USER", SYSLOG_FACILITY_USER },
65 { "AUTH", SYSLOG_FACILITY_AUTH },
Damien Miller30246a82001-03-05 21:23:31 +110066#ifdef LOG_AUTHPRIV
67 { "AUTHPRIV", SYSLOG_FACILITY_AUTHPRIV },
68#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +000069 { "LOCAL0", SYSLOG_FACILITY_LOCAL0 },
70 { "LOCAL1", SYSLOG_FACILITY_LOCAL1 },
71 { "LOCAL2", SYSLOG_FACILITY_LOCAL2 },
72 { "LOCAL3", SYSLOG_FACILITY_LOCAL3 },
73 { "LOCAL4", SYSLOG_FACILITY_LOCAL4 },
74 { "LOCAL5", SYSLOG_FACILITY_LOCAL5 },
75 { "LOCAL6", SYSLOG_FACILITY_LOCAL6 },
76 { "LOCAL7", SYSLOG_FACILITY_LOCAL7 },
Damien Millerfcd93202002-02-05 12:26:34 +110077 { NULL, SYSLOG_FACILITY_NOT_SET }
Ben Lindstrom8a432f52001-03-05 07:24:46 +000078};
79
80static struct {
81 const char *name;
82 LogLevel val;
83} log_levels[] =
84{
85 { "QUIET", SYSLOG_LEVEL_QUIET },
86 { "FATAL", SYSLOG_LEVEL_FATAL },
87 { "ERROR", SYSLOG_LEVEL_ERROR },
88 { "INFO", SYSLOG_LEVEL_INFO },
89 { "VERBOSE", SYSLOG_LEVEL_VERBOSE },
90 { "DEBUG", SYSLOG_LEVEL_DEBUG1 },
91 { "DEBUG1", SYSLOG_LEVEL_DEBUG1 },
92 { "DEBUG2", SYSLOG_LEVEL_DEBUG2 },
93 { "DEBUG3", SYSLOG_LEVEL_DEBUG3 },
Damien Millerfcd93202002-02-05 12:26:34 +110094 { NULL, SYSLOG_LEVEL_NOT_SET }
Ben Lindstrom8a432f52001-03-05 07:24:46 +000095};
96
97SyslogFacility
98log_facility_number(char *name)
99{
100 int i;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000101
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000102 if (name != NULL)
103 for (i = 0; log_facilities[i].name; i++)
104 if (strcasecmp(log_facilities[i].name, name) == 0)
105 return log_facilities[i].val;
Damien Millerfcd93202002-02-05 12:26:34 +1100106 return SYSLOG_FACILITY_NOT_SET;
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000107}
108
109LogLevel
110log_level_number(char *name)
111{
112 int i;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000113
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000114 if (name != NULL)
115 for (i = 0; log_levels[i].name; i++)
116 if (strcasecmp(log_levels[i].name, name) == 0)
117 return log_levels[i].val;
Damien Millerfcd93202002-02-05 12:26:34 +1100118 return SYSLOG_LEVEL_NOT_SET;
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000119}
Damien Miller5ce662a1999-11-11 17:57:39 +1100120
121/* Error messages that should be logged. */
122
123void
Damien Miller95def091999-11-25 00:26:21 +1100124error(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100125{
Damien Miller95def091999-11-25 00:26:21 +1100126 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000127
Damien Miller95def091999-11-25 00:26:21 +1100128 va_start(args, fmt);
129 do_log(SYSLOG_LEVEL_ERROR, fmt, args);
130 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100131}
132
133/* Log this message (information that usually should go to the log). */
134
135void
Damien Miller996acd22003-04-09 20:59:48 +1000136logit(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100137{
Damien Miller95def091999-11-25 00:26:21 +1100138 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000139
Damien Miller95def091999-11-25 00:26:21 +1100140 va_start(args, fmt);
Ben Lindstromdb65e8f2001-01-19 04:26:52 +0000141 do_log(SYSLOG_LEVEL_INFO, fmt, args);
Damien Miller95def091999-11-25 00:26:21 +1100142 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100143}
144
145/* More detailed messages (information that does not need to go to the log). */
146
147void
Damien Miller95def091999-11-25 00:26:21 +1100148verbose(const char *fmt,...)
Damien Miller5ce662a1999-11-11 17:57:39 +1100149{
Damien Miller95def091999-11-25 00:26:21 +1100150 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000151
Damien Miller95def091999-11-25 00:26:21 +1100152 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;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000163
Damien Miller95def091999-11-25 00:26:21 +1100164 va_start(args, fmt);
Damien Millere4340be2000-09-16 13:29:08 +1100165 do_log(SYSLOG_LEVEL_DEBUG1, fmt, args);
166 va_end(args);
167}
168
169void
170debug2(const char *fmt,...)
171{
172 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000173
Damien Millere4340be2000-09-16 13:29:08 +1100174 va_start(args, fmt);
175 do_log(SYSLOG_LEVEL_DEBUG2, fmt, args);
176 va_end(args);
177}
178
179void
180debug3(const char *fmt,...)
181{
182 va_list args;
Ben Lindstrom8e8ef2a2002-07-07 22:14:55 +0000183
Damien Millere4340be2000-09-16 13:29:08 +1100184 va_start(args, fmt);
185 do_log(SYSLOG_LEVEL_DEBUG3, fmt, args);
Damien Miller95def091999-11-25 00:26:21 +1100186 va_end(args);
Damien Miller5ce662a1999-11-11 17:57:39 +1100187}
188
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000189/*
190 * Initialize the log.
191 */
192
193void
194log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr)
195{
Darren Tucker9b5495d2005-02-01 17:35:09 +1100196#if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
197 struct syslog_data sdata = SYSLOG_DATA_INIT;
198#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000199
Darren Tucker835903d2005-03-09 20:12:47 +1100200 argv0 = av0;
201
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000202 switch (level) {
203 case SYSLOG_LEVEL_QUIET:
204 case SYSLOG_LEVEL_FATAL:
205 case SYSLOG_LEVEL_ERROR:
206 case SYSLOG_LEVEL_INFO:
207 case SYSLOG_LEVEL_VERBOSE:
208 case SYSLOG_LEVEL_DEBUG1:
209 case SYSLOG_LEVEL_DEBUG2:
210 case SYSLOG_LEVEL_DEBUG3:
211 log_level = level;
212 break;
213 default:
Kevin Stevesedcd5762001-04-02 13:45:00 +0000214 fprintf(stderr, "Unrecognized internal syslog level code %d\n",
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000215 (int) level);
216 exit(1);
217 }
218
219 log_on_stderr = on_stderr;
220 if (on_stderr)
221 return;
222
223 switch (facility) {
224 case SYSLOG_FACILITY_DAEMON:
225 log_facility = LOG_DAEMON;
226 break;
227 case SYSLOG_FACILITY_USER:
228 log_facility = LOG_USER;
229 break;
230 case SYSLOG_FACILITY_AUTH:
231 log_facility = LOG_AUTH;
232 break;
Damien Miller30246a82001-03-05 21:23:31 +1100233#ifdef LOG_AUTHPRIV
234 case SYSLOG_FACILITY_AUTHPRIV:
235 log_facility = LOG_AUTHPRIV;
236 break;
Ben Lindstrom53f11c62001-03-05 08:18:17 +0000237#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000238 case SYSLOG_FACILITY_LOCAL0:
239 log_facility = LOG_LOCAL0;
240 break;
241 case SYSLOG_FACILITY_LOCAL1:
242 log_facility = LOG_LOCAL1;
243 break;
244 case SYSLOG_FACILITY_LOCAL2:
245 log_facility = LOG_LOCAL2;
246 break;
247 case SYSLOG_FACILITY_LOCAL3:
248 log_facility = LOG_LOCAL3;
249 break;
250 case SYSLOG_FACILITY_LOCAL4:
251 log_facility = LOG_LOCAL4;
252 break;
253 case SYSLOG_FACILITY_LOCAL5:
254 log_facility = LOG_LOCAL5;
255 break;
256 case SYSLOG_FACILITY_LOCAL6:
257 log_facility = LOG_LOCAL6;
258 break;
259 case SYSLOG_FACILITY_LOCAL7:
260 log_facility = LOG_LOCAL7;
261 break;
262 default:
263 fprintf(stderr,
Kevin Stevesedcd5762001-04-02 13:45:00 +0000264 "Unrecognized internal syslog facility code %d\n",
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000265 (int) facility);
266 exit(1);
267 }
Darren Tucker9b5495d2005-02-01 17:35:09 +1100268
269 /*
270 * If an external library (eg libwrap) attempts to use syslog
271 * immediately after reexec, syslog may be pointing to the wrong
272 * facility, so we force an open/close of syslog here.
273 */
274#if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
275 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
276 closelog_r(&sdata);
277#else
278 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
279 closelog();
280#endif
Damien Miller6162d121999-11-21 13:23:52 +1100281}
282
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000283#define MSGBUFSIZ 1024
284
Ben Lindstrom9c8edc92002-02-26 17:52:14 +0000285void
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000286do_log(LogLevel level, const char *fmt, va_list args)
Damien Miller6162d121999-11-21 13:23:52 +1100287{
Damien Miller051b0ac2004-02-18 22:59:43 +1100288#if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
Damien Miller74a34422003-05-20 09:24:17 +1000289 struct syslog_data sdata = SYSLOG_DATA_INIT;
290#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000291 char msgbuf[MSGBUFSIZ];
292 char fmtbuf[MSGBUFSIZ];
293 char *txt = NULL;
294 int pri = LOG_INFO;
295
296 if (level > log_level)
297 return;
298
299 switch (level) {
300 case SYSLOG_LEVEL_FATAL:
301 if (!log_on_stderr)
302 txt = "fatal";
303 pri = LOG_CRIT;
304 break;
305 case SYSLOG_LEVEL_ERROR:
306 if (!log_on_stderr)
307 txt = "error";
308 pri = LOG_ERR;
309 break;
310 case SYSLOG_LEVEL_INFO:
311 pri = LOG_INFO;
312 break;
313 case SYSLOG_LEVEL_VERBOSE:
314 pri = LOG_INFO;
315 break;
316 case SYSLOG_LEVEL_DEBUG1:
317 txt = "debug1";
318 pri = LOG_DEBUG;
319 break;
320 case SYSLOG_LEVEL_DEBUG2:
321 txt = "debug2";
322 pri = LOG_DEBUG;
323 break;
324 case SYSLOG_LEVEL_DEBUG3:
325 txt = "debug3";
326 pri = LOG_DEBUG;
327 break;
328 default:
329 txt = "internal error";
330 pri = LOG_ERR;
331 break;
332 }
333 if (txt != NULL) {
334 snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt);
335 vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args);
336 } else {
337 vsnprintf(msgbuf, sizeof(msgbuf), fmt, args);
338 }
Damien Miller23a70272004-07-21 10:52:13 +1000339 strnvis(fmtbuf, msgbuf, sizeof(fmtbuf),
340 log_on_stderr ? LOG_STDERR_VIS : LOG_SYSLOG_VIS);
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000341 if (log_on_stderr) {
Damien Millerc11fe252003-05-25 14:38:02 +1000342 snprintf(msgbuf, sizeof msgbuf, "%s\r\n", fmtbuf);
343 write(STDERR_FILENO, msgbuf, strlen(msgbuf));
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000344 } else {
Damien Miller051b0ac2004-02-18 22:59:43 +1100345#if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
Damien Miller74a34422003-05-20 09:24:17 +1000346 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
Damien Millerc11fe252003-05-25 14:38:02 +1000347 syslog_r(pri, &sdata, "%.500s", fmtbuf);
Damien Miller74a34422003-05-20 09:24:17 +1000348 closelog_r(&sdata);
349#else
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000350 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
Damien Millerb93addb2003-01-07 17:04:18 +1100351 syslog(pri, "%.500s", fmtbuf);
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000352 closelog();
Damien Miller74a34422003-05-20 09:24:17 +1000353#endif
Ben Lindstrom8a432f52001-03-05 07:24:46 +0000354 }
Damien Miller6162d121999-11-21 13:23:52 +1100355}