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