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