Annotation of src/usr.bin/ssh/log.c, Revision 1.36
1.36 ! stevesk 1: /* $OpenBSD: log.c,v 1.35 2006/07/22 20:48:23 stevesk Exp $ */
1.1 markus 2: /*
1.9 markus 3: * Author: Tatu Ylonen <ylo@cs.hut.fi>
4: * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5: * All rights reserved
6: *
7: * As far as I am concerned, the code I have written for this software
8: * can be used freely for any purpose. Any derived versions of this
9: * software must be clearly marked as such, and if the derived work is
10: * incompatible with the protocol description in the RFC file, it must be
11: * called by a name other than "ssh" or "Secure Shell".
12: */
13: /*
1.8 deraadt 14: * Copyright (c) 2000 Markus Friedl. All rights reserved.
15: *
16: * Redistribution and use in source and binary forms, with or without
17: * modification, are permitted provided that the following conditions
18: * are met:
19: * 1. Redistributions of source code must retain the above copyright
20: * notice, this list of conditions and the following disclaimer.
21: * 2. Redistributions in binary form must reproduce the above copyright
22: * notice, this list of conditions and the following disclaimer in the
23: * documentation and/or other materials provided with the distribution.
24: *
25: * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26: * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28: * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34: * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.6 markus 35: */
1.1 markus 36:
37: #include "includes.h"
38:
1.33 stevesk 39: #include <stdarg.h>
1.36 ! stevesk 40: #include <stdlib.h>
1.35 stevesk 41: #include <string.h>
1.32 stevesk 42: #include <syslog.h>
1.34 stevesk 43: #include <unistd.h>
1.32 stevesk 44: #include <vis.h>
45:
1.15 markus 46: #include "log.h"
1.1 markus 47: #include "xmalloc.h"
1.16 markus 48:
49: static LogLevel log_level = SYSLOG_LEVEL_INFO;
50: static int log_on_stderr = 1;
51: static int log_facility = LOG_AUTH;
52: static char *argv0;
53:
54: extern char *__progname;
55:
56: /* textual representation of log-facilities/levels */
57:
58: static struct {
59: const char *name;
60: SyslogFacility val;
61: } log_facilities[] = {
62: { "DAEMON", SYSLOG_FACILITY_DAEMON },
63: { "USER", SYSLOG_FACILITY_USER },
64: { "AUTH", SYSLOG_FACILITY_AUTH },
65: { "LOCAL0", SYSLOG_FACILITY_LOCAL0 },
66: { "LOCAL1", SYSLOG_FACILITY_LOCAL1 },
67: { "LOCAL2", SYSLOG_FACILITY_LOCAL2 },
68: { "LOCAL3", SYSLOG_FACILITY_LOCAL3 },
69: { "LOCAL4", SYSLOG_FACILITY_LOCAL4 },
70: { "LOCAL5", SYSLOG_FACILITY_LOCAL5 },
71: { "LOCAL6", SYSLOG_FACILITY_LOCAL6 },
72: { "LOCAL7", SYSLOG_FACILITY_LOCAL7 },
1.21 markus 73: { NULL, SYSLOG_FACILITY_NOT_SET }
1.16 markus 74: };
75:
76: static struct {
77: const char *name;
78: LogLevel val;
79: } log_levels[] =
80: {
81: { "QUIET", SYSLOG_LEVEL_QUIET },
82: { "FATAL", SYSLOG_LEVEL_FATAL },
83: { "ERROR", SYSLOG_LEVEL_ERROR },
84: { "INFO", SYSLOG_LEVEL_INFO },
85: { "VERBOSE", SYSLOG_LEVEL_VERBOSE },
86: { "DEBUG", SYSLOG_LEVEL_DEBUG1 },
87: { "DEBUG1", SYSLOG_LEVEL_DEBUG1 },
88: { "DEBUG2", SYSLOG_LEVEL_DEBUG2 },
89: { "DEBUG3", SYSLOG_LEVEL_DEBUG3 },
1.21 markus 90: { NULL, SYSLOG_LEVEL_NOT_SET }
1.16 markus 91: };
92:
93: SyslogFacility
94: log_facility_number(char *name)
95: {
96: int i;
1.23 deraadt 97:
1.16 markus 98: if (name != NULL)
99: for (i = 0; log_facilities[i].name; i++)
100: if (strcasecmp(log_facilities[i].name, name) == 0)
101: return log_facilities[i].val;
1.21 markus 102: return SYSLOG_FACILITY_NOT_SET;
1.16 markus 103: }
104:
105: LogLevel
106: log_level_number(char *name)
107: {
108: int i;
1.23 deraadt 109:
1.16 markus 110: if (name != NULL)
111: for (i = 0; log_levels[i].name; i++)
112: if (strcasecmp(log_levels[i].name, name) == 0)
113: return log_levels[i].val;
1.21 markus 114: return SYSLOG_LEVEL_NOT_SET;
1.16 markus 115: }
1.1 markus 116:
117: /* Error messages that should be logged. */
118:
119: void
1.4 markus 120: error(const char *fmt,...)
1.1 markus 121: {
1.4 markus 122: va_list args;
1.23 deraadt 123:
1.4 markus 124: va_start(args, fmt);
125: do_log(SYSLOG_LEVEL_ERROR, fmt, args);
126: va_end(args);
1.1 markus 127: }
128:
129: /* Log this message (information that usually should go to the log). */
130:
131: void
1.26 itojun 132: logit(const char *fmt,...)
1.1 markus 133: {
1.4 markus 134: va_list args;
1.23 deraadt 135:
1.4 markus 136: va_start(args, fmt);
1.14 markus 137: do_log(SYSLOG_LEVEL_INFO, fmt, args);
1.4 markus 138: va_end(args);
1.1 markus 139: }
140:
141: /* More detailed messages (information that does not need to go to the log). */
142:
143: void
1.4 markus 144: verbose(const char *fmt,...)
1.1 markus 145: {
1.4 markus 146: va_list args;
1.23 deraadt 147:
1.4 markus 148: va_start(args, fmt);
149: do_log(SYSLOG_LEVEL_VERBOSE, fmt, args);
150: va_end(args);
1.1 markus 151: }
152:
153: /* Debugging messages that should not be logged during normal operation. */
154:
155: void
1.4 markus 156: debug(const char *fmt,...)
1.1 markus 157: {
1.4 markus 158: va_list args;
1.23 deraadt 159:
1.4 markus 160: va_start(args, fmt);
1.10 markus 161: do_log(SYSLOG_LEVEL_DEBUG1, fmt, args);
162: va_end(args);
163: }
164:
165: void
166: debug2(const char *fmt,...)
167: {
168: va_list args;
1.23 deraadt 169:
1.10 markus 170: va_start(args, fmt);
171: do_log(SYSLOG_LEVEL_DEBUG2, fmt, args);
172: va_end(args);
173: }
174:
175: void
176: debug3(const char *fmt,...)
177: {
178: va_list args;
1.23 deraadt 179:
1.10 markus 180: va_start(args, fmt);
181: do_log(SYSLOG_LEVEL_DEBUG3, fmt, args);
1.4 markus 182: va_end(args);
1.1 markus 183: }
1.2 markus 184:
1.16 markus 185: /*
186: * Initialize the log.
187: */
1.2 markus 188:
1.16 markus 189: void
190: log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr)
1.2 markus 191: {
1.16 markus 192: argv0 = av0;
193:
194: switch (level) {
195: case SYSLOG_LEVEL_QUIET:
196: case SYSLOG_LEVEL_FATAL:
197: case SYSLOG_LEVEL_ERROR:
198: case SYSLOG_LEVEL_INFO:
199: case SYSLOG_LEVEL_VERBOSE:
200: case SYSLOG_LEVEL_DEBUG1:
201: case SYSLOG_LEVEL_DEBUG2:
202: case SYSLOG_LEVEL_DEBUG3:
203: log_level = level;
204: break;
205: default:
206: fprintf(stderr, "Unrecognized internal syslog level code %d\n",
207: (int) level);
208: exit(1);
209: }
1.2 markus 210:
1.16 markus 211: log_on_stderr = on_stderr;
212: if (on_stderr)
213: return;
214:
215: switch (facility) {
216: case SYSLOG_FACILITY_DAEMON:
217: log_facility = LOG_DAEMON;
218: break;
219: case SYSLOG_FACILITY_USER:
220: log_facility = LOG_USER;
221: break;
222: case SYSLOG_FACILITY_AUTH:
223: log_facility = LOG_AUTH;
224: break;
225: case SYSLOG_FACILITY_LOCAL0:
226: log_facility = LOG_LOCAL0;
227: break;
228: case SYSLOG_FACILITY_LOCAL1:
229: log_facility = LOG_LOCAL1;
230: break;
231: case SYSLOG_FACILITY_LOCAL2:
232: log_facility = LOG_LOCAL2;
233: break;
234: case SYSLOG_FACILITY_LOCAL3:
235: log_facility = LOG_LOCAL3;
236: break;
237: case SYSLOG_FACILITY_LOCAL4:
238: log_facility = LOG_LOCAL4;
239: break;
240: case SYSLOG_FACILITY_LOCAL5:
241: log_facility = LOG_LOCAL5;
242: break;
243: case SYSLOG_FACILITY_LOCAL6:
244: log_facility = LOG_LOCAL6;
245: break;
246: case SYSLOG_FACILITY_LOCAL7:
247: log_facility = LOG_LOCAL7;
248: break;
249: default:
250: fprintf(stderr,
251: "Unrecognized internal syslog facility code %d\n",
252: (int) facility);
253: exit(1);
254: }
1.2 markus 255: }
256:
1.16 markus 257: #define MSGBUFSIZ 1024
258:
1.22 markus 259: void
1.16 markus 260: do_log(LogLevel level, const char *fmt, va_list args)
1.2 markus 261: {
1.27 deraadt 262: struct syslog_data sdata = SYSLOG_DATA_INIT;
1.16 markus 263: char msgbuf[MSGBUFSIZ];
264: char fmtbuf[MSGBUFSIZ];
265: char *txt = NULL;
266: int pri = LOG_INFO;
267:
268: if (level > log_level)
269: return;
270:
271: switch (level) {
272: case SYSLOG_LEVEL_FATAL:
273: if (!log_on_stderr)
274: txt = "fatal";
275: pri = LOG_CRIT;
276: break;
277: case SYSLOG_LEVEL_ERROR:
278: if (!log_on_stderr)
279: txt = "error";
280: pri = LOG_ERR;
281: break;
282: case SYSLOG_LEVEL_INFO:
283: pri = LOG_INFO;
284: break;
285: case SYSLOG_LEVEL_VERBOSE:
286: pri = LOG_INFO;
287: break;
288: case SYSLOG_LEVEL_DEBUG1:
289: txt = "debug1";
290: pri = LOG_DEBUG;
291: break;
292: case SYSLOG_LEVEL_DEBUG2:
293: txt = "debug2";
294: pri = LOG_DEBUG;
295: break;
296: case SYSLOG_LEVEL_DEBUG3:
297: txt = "debug3";
298: pri = LOG_DEBUG;
299: break;
300: default:
301: txt = "internal error";
302: pri = LOG_ERR;
303: break;
304: }
305: if (txt != NULL) {
306: snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt);
307: vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args);
308: } else {
309: vsnprintf(msgbuf, sizeof(msgbuf), fmt, args);
310: }
1.28 djm 311: strnvis(fmtbuf, msgbuf, sizeof(fmtbuf), VIS_SAFE|VIS_OCTAL);
1.16 markus 312: if (log_on_stderr) {
1.28 djm 313: snprintf(msgbuf, sizeof msgbuf, "%s\r\n", fmtbuf);
314: write(STDERR_FILENO, msgbuf, strlen(msgbuf));
1.16 markus 315: } else {
1.27 deraadt 316: openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
1.28 djm 317: syslog_r(pri, &sdata, "%.500s", fmtbuf);
1.27 deraadt 318: closelog_r(&sdata);
1.16 markus 319: }
1.1 markus 320: }