Annotation of src/usr.bin/ssh/log.c, Revision 1.34
1.34 ! stevesk 1: /* $OpenBSD: log.c,v 1.33 2006/07/10 16:37:36 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.32 stevesk 40: #include <syslog.h>
1.34 ! stevesk 41: #include <unistd.h>
1.32 stevesk 42: #include <vis.h>
43:
1.15 markus 44: #include "log.h"
1.1 markus 45: #include "xmalloc.h"
1.16 markus 46:
47: static LogLevel log_level = SYSLOG_LEVEL_INFO;
48: static int log_on_stderr = 1;
49: static int log_facility = LOG_AUTH;
50: static char *argv0;
51:
52: extern char *__progname;
53:
54: /* textual representation of log-facilities/levels */
55:
56: static struct {
57: const char *name;
58: SyslogFacility val;
59: } log_facilities[] = {
60: { "DAEMON", SYSLOG_FACILITY_DAEMON },
61: { "USER", SYSLOG_FACILITY_USER },
62: { "AUTH", SYSLOG_FACILITY_AUTH },
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 },
1.21 markus 71: { NULL, SYSLOG_FACILITY_NOT_SET }
1.16 markus 72: };
73:
74: static 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 },
1.21 markus 88: { NULL, SYSLOG_LEVEL_NOT_SET }
1.16 markus 89: };
90:
91: SyslogFacility
92: log_facility_number(char *name)
93: {
94: int i;
1.23 deraadt 95:
1.16 markus 96: if (name != NULL)
97: for (i = 0; log_facilities[i].name; i++)
98: if (strcasecmp(log_facilities[i].name, name) == 0)
99: return log_facilities[i].val;
1.21 markus 100: return SYSLOG_FACILITY_NOT_SET;
1.16 markus 101: }
102:
103: LogLevel
104: log_level_number(char *name)
105: {
106: int i;
1.23 deraadt 107:
1.16 markus 108: if (name != NULL)
109: for (i = 0; log_levels[i].name; i++)
110: if (strcasecmp(log_levels[i].name, name) == 0)
111: return log_levels[i].val;
1.21 markus 112: return SYSLOG_LEVEL_NOT_SET;
1.16 markus 113: }
1.1 markus 114:
115: /* Error messages that should be logged. */
116:
117: void
1.4 markus 118: error(const char *fmt,...)
1.1 markus 119: {
1.4 markus 120: va_list args;
1.23 deraadt 121:
1.4 markus 122: va_start(args, fmt);
123: do_log(SYSLOG_LEVEL_ERROR, fmt, args);
124: va_end(args);
1.1 markus 125: }
126:
127: /* Log this message (information that usually should go to the log). */
128:
129: void
1.26 itojun 130: logit(const char *fmt,...)
1.1 markus 131: {
1.4 markus 132: va_list args;
1.23 deraadt 133:
1.4 markus 134: va_start(args, fmt);
1.14 markus 135: do_log(SYSLOG_LEVEL_INFO, fmt, args);
1.4 markus 136: va_end(args);
1.1 markus 137: }
138:
139: /* More detailed messages (information that does not need to go to the log). */
140:
141: void
1.4 markus 142: verbose(const char *fmt,...)
1.1 markus 143: {
1.4 markus 144: va_list args;
1.23 deraadt 145:
1.4 markus 146: va_start(args, fmt);
147: do_log(SYSLOG_LEVEL_VERBOSE, fmt, args);
148: va_end(args);
1.1 markus 149: }
150:
151: /* Debugging messages that should not be logged during normal operation. */
152:
153: void
1.4 markus 154: debug(const char *fmt,...)
1.1 markus 155: {
1.4 markus 156: va_list args;
1.23 deraadt 157:
1.4 markus 158: va_start(args, fmt);
1.10 markus 159: do_log(SYSLOG_LEVEL_DEBUG1, fmt, args);
160: va_end(args);
161: }
162:
163: void
164: debug2(const char *fmt,...)
165: {
166: va_list args;
1.23 deraadt 167:
1.10 markus 168: va_start(args, fmt);
169: do_log(SYSLOG_LEVEL_DEBUG2, fmt, args);
170: va_end(args);
171: }
172:
173: void
174: debug3(const char *fmt,...)
175: {
176: va_list args;
1.23 deraadt 177:
1.10 markus 178: va_start(args, fmt);
179: do_log(SYSLOG_LEVEL_DEBUG3, fmt, args);
1.4 markus 180: va_end(args);
1.1 markus 181: }
1.2 markus 182:
1.16 markus 183: /*
184: * Initialize the log.
185: */
1.2 markus 186:
1.16 markus 187: void
188: log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr)
1.2 markus 189: {
1.16 markus 190: argv0 = av0;
191:
192: switch (level) {
193: case SYSLOG_LEVEL_QUIET:
194: case SYSLOG_LEVEL_FATAL:
195: case SYSLOG_LEVEL_ERROR:
196: case SYSLOG_LEVEL_INFO:
197: case SYSLOG_LEVEL_VERBOSE:
198: case SYSLOG_LEVEL_DEBUG1:
199: case SYSLOG_LEVEL_DEBUG2:
200: case SYSLOG_LEVEL_DEBUG3:
201: log_level = level;
202: break;
203: default:
204: fprintf(stderr, "Unrecognized internal syslog level code %d\n",
205: (int) level);
206: exit(1);
207: }
1.2 markus 208:
1.16 markus 209: log_on_stderr = on_stderr;
210: if (on_stderr)
211: return;
212:
213: switch (facility) {
214: case SYSLOG_FACILITY_DAEMON:
215: log_facility = LOG_DAEMON;
216: break;
217: case SYSLOG_FACILITY_USER:
218: log_facility = LOG_USER;
219: break;
220: case SYSLOG_FACILITY_AUTH:
221: log_facility = LOG_AUTH;
222: break;
223: case SYSLOG_FACILITY_LOCAL0:
224: log_facility = LOG_LOCAL0;
225: break;
226: case SYSLOG_FACILITY_LOCAL1:
227: log_facility = LOG_LOCAL1;
228: break;
229: case SYSLOG_FACILITY_LOCAL2:
230: log_facility = LOG_LOCAL2;
231: break;
232: case SYSLOG_FACILITY_LOCAL3:
233: log_facility = LOG_LOCAL3;
234: break;
235: case SYSLOG_FACILITY_LOCAL4:
236: log_facility = LOG_LOCAL4;
237: break;
238: case SYSLOG_FACILITY_LOCAL5:
239: log_facility = LOG_LOCAL5;
240: break;
241: case SYSLOG_FACILITY_LOCAL6:
242: log_facility = LOG_LOCAL6;
243: break;
244: case SYSLOG_FACILITY_LOCAL7:
245: log_facility = LOG_LOCAL7;
246: break;
247: default:
248: fprintf(stderr,
249: "Unrecognized internal syslog facility code %d\n",
250: (int) facility);
251: exit(1);
252: }
1.2 markus 253: }
254:
1.16 markus 255: #define MSGBUFSIZ 1024
256:
1.22 markus 257: void
1.16 markus 258: do_log(LogLevel level, const char *fmt, va_list args)
1.2 markus 259: {
1.27 deraadt 260: struct syslog_data sdata = SYSLOG_DATA_INIT;
1.16 markus 261: char msgbuf[MSGBUFSIZ];
262: char fmtbuf[MSGBUFSIZ];
263: char *txt = NULL;
264: int pri = LOG_INFO;
265:
266: if (level > log_level)
267: return;
268:
269: switch (level) {
270: case SYSLOG_LEVEL_FATAL:
271: if (!log_on_stderr)
272: txt = "fatal";
273: pri = LOG_CRIT;
274: break;
275: case SYSLOG_LEVEL_ERROR:
276: if (!log_on_stderr)
277: txt = "error";
278: pri = LOG_ERR;
279: break;
280: case SYSLOG_LEVEL_INFO:
281: pri = LOG_INFO;
282: break;
283: case SYSLOG_LEVEL_VERBOSE:
284: pri = LOG_INFO;
285: break;
286: case SYSLOG_LEVEL_DEBUG1:
287: txt = "debug1";
288: pri = LOG_DEBUG;
289: break;
290: case SYSLOG_LEVEL_DEBUG2:
291: txt = "debug2";
292: pri = LOG_DEBUG;
293: break;
294: case SYSLOG_LEVEL_DEBUG3:
295: txt = "debug3";
296: pri = LOG_DEBUG;
297: break;
298: default:
299: txt = "internal error";
300: pri = LOG_ERR;
301: break;
302: }
303: if (txt != NULL) {
304: snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt);
305: vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args);
306: } else {
307: vsnprintf(msgbuf, sizeof(msgbuf), fmt, args);
308: }
1.28 djm 309: strnvis(fmtbuf, msgbuf, sizeof(fmtbuf), VIS_SAFE|VIS_OCTAL);
1.16 markus 310: if (log_on_stderr) {
1.28 djm 311: snprintf(msgbuf, sizeof msgbuf, "%s\r\n", fmtbuf);
312: write(STDERR_FILENO, msgbuf, strlen(msgbuf));
1.16 markus 313: } else {
1.27 deraadt 314: openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
1.28 djm 315: syslog_r(pri, &sdata, "%.500s", fmtbuf);
1.27 deraadt 316: closelog_r(&sdata);
1.16 markus 317: }
1.1 markus 318: }