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