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