Line | Count | Source (jump to first uncovered line) |
1 | | /* $OpenBSD: log.c,v 1.60 2021/09/16 15:11:19 djm Exp $ */ |
2 | | /* |
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 | | /* |
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. |
35 | | */ |
36 | | |
37 | | #include "includes.h" |
38 | | |
39 | | #include <sys/types.h> |
40 | | |
41 | | #include <fcntl.h> |
42 | | #include <stdarg.h> |
43 | | #include <stdio.h> |
44 | | #include <stdlib.h> |
45 | | #include <string.h> |
46 | | #include <syslog.h> |
47 | | #include <unistd.h> |
48 | | #include <errno.h> |
49 | | #if defined(HAVE_STRNVIS) && defined(HAVE_VIS_H) && !defined(BROKEN_STRNVIS) |
50 | | # include <vis.h> |
51 | | #endif |
52 | | |
53 | | #include "log.h" |
54 | | #include "match.h" |
55 | | |
56 | | static LogLevel log_level = SYSLOG_LEVEL_INFO; |
57 | | static int log_on_stderr = 1; |
58 | | static int log_stderr_fd = STDERR_FILENO; |
59 | | static int log_facility = LOG_AUTH; |
60 | | static const char *argv0; |
61 | | static log_handler_fn *log_handler; |
62 | | static void *log_handler_ctx; |
63 | | static char **log_verbose; |
64 | | static size_t nlog_verbose; |
65 | | |
66 | | extern char *__progname; |
67 | | |
68 | 0 | #define LOG_SYSLOG_VIS (VIS_CSTYLE|VIS_NL|VIS_TAB|VIS_OCTAL) |
69 | 0 | #define LOG_STDERR_VIS (VIS_SAFE|VIS_OCTAL) |
70 | | |
71 | | /* textual representation of log-facilities/levels */ |
72 | | |
73 | | static struct { |
74 | | const char *name; |
75 | | SyslogFacility val; |
76 | | } log_facilities[] = { |
77 | | { "DAEMON", SYSLOG_FACILITY_DAEMON }, |
78 | | { "USER", SYSLOG_FACILITY_USER }, |
79 | | { "AUTH", SYSLOG_FACILITY_AUTH }, |
80 | | #ifdef LOG_AUTHPRIV |
81 | | { "AUTHPRIV", SYSLOG_FACILITY_AUTHPRIV }, |
82 | | #endif |
83 | | { "LOCAL0", SYSLOG_FACILITY_LOCAL0 }, |
84 | | { "LOCAL1", SYSLOG_FACILITY_LOCAL1 }, |
85 | | { "LOCAL2", SYSLOG_FACILITY_LOCAL2 }, |
86 | | { "LOCAL3", SYSLOG_FACILITY_LOCAL3 }, |
87 | | { "LOCAL4", SYSLOG_FACILITY_LOCAL4 }, |
88 | | { "LOCAL5", SYSLOG_FACILITY_LOCAL5 }, |
89 | | { "LOCAL6", SYSLOG_FACILITY_LOCAL6 }, |
90 | | { "LOCAL7", SYSLOG_FACILITY_LOCAL7 }, |
91 | | { NULL, SYSLOG_FACILITY_NOT_SET } |
92 | | }; |
93 | | |
94 | | static struct { |
95 | | const char *name; |
96 | | LogLevel val; |
97 | | } log_levels[] = |
98 | | { |
99 | | { "QUIET", SYSLOG_LEVEL_QUIET }, |
100 | | { "FATAL", SYSLOG_LEVEL_FATAL }, |
101 | | { "ERROR", SYSLOG_LEVEL_ERROR }, |
102 | | { "INFO", SYSLOG_LEVEL_INFO }, |
103 | | { "VERBOSE", SYSLOG_LEVEL_VERBOSE }, |
104 | | { "DEBUG", SYSLOG_LEVEL_DEBUG1 }, |
105 | | { "DEBUG1", SYSLOG_LEVEL_DEBUG1 }, |
106 | | { "DEBUG2", SYSLOG_LEVEL_DEBUG2 }, |
107 | | { "DEBUG3", SYSLOG_LEVEL_DEBUG3 }, |
108 | | { NULL, SYSLOG_LEVEL_NOT_SET } |
109 | | }; |
110 | | |
111 | | LogLevel |
112 | | log_level_get(void) |
113 | 0 | { |
114 | 0 | return log_level; |
115 | 0 | } |
116 | | |
117 | | SyslogFacility |
118 | | log_facility_number(char *name) |
119 | 0 | { |
120 | 0 | int i; |
121 | |
|
122 | 0 | if (name != NULL) |
123 | 0 | for (i = 0; log_facilities[i].name; i++) |
124 | 0 | if (strcasecmp(log_facilities[i].name, name) == 0) |
125 | 0 | return log_facilities[i].val; |
126 | 0 | return SYSLOG_FACILITY_NOT_SET; |
127 | 0 | } |
128 | | |
129 | | const char * |
130 | | log_facility_name(SyslogFacility facility) |
131 | 0 | { |
132 | 0 | u_int i; |
133 | |
|
134 | 0 | for (i = 0; log_facilities[i].name; i++) |
135 | 0 | if (log_facilities[i].val == facility) |
136 | 0 | return log_facilities[i].name; |
137 | 0 | return NULL; |
138 | 0 | } |
139 | | |
140 | | LogLevel |
141 | | log_level_number(char *name) |
142 | 0 | { |
143 | 0 | int i; |
144 | |
|
145 | 0 | if (name != NULL) |
146 | 0 | for (i = 0; log_levels[i].name; i++) |
147 | 0 | if (strcasecmp(log_levels[i].name, name) == 0) |
148 | 0 | return log_levels[i].val; |
149 | 0 | return SYSLOG_LEVEL_NOT_SET; |
150 | 0 | } |
151 | | |
152 | | const char * |
153 | | log_level_name(LogLevel level) |
154 | 0 | { |
155 | 0 | u_int i; |
156 | |
|
157 | 0 | for (i = 0; log_levels[i].name != NULL; i++) |
158 | 0 | if (log_levels[i].val == level) |
159 | 0 | return log_levels[i].name; |
160 | 0 | return NULL; |
161 | 0 | } |
162 | | |
163 | | void |
164 | | log_verbose_add(const char *s) |
165 | 0 | { |
166 | 0 | char **tmp; |
167 | | |
168 | | /* Ignore failures here */ |
169 | 0 | if ((tmp = recallocarray(log_verbose, nlog_verbose, nlog_verbose + 1, |
170 | 0 | sizeof(*log_verbose))) != NULL) { |
171 | 0 | log_verbose = tmp; |
172 | 0 | if ((log_verbose[nlog_verbose] = strdup(s)) != NULL) |
173 | 0 | nlog_verbose++; |
174 | 0 | } |
175 | 0 | } |
176 | | |
177 | | void |
178 | | log_verbose_reset(void) |
179 | 0 | { |
180 | 0 | size_t i; |
181 | |
|
182 | 0 | for (i = 0; i < nlog_verbose; i++) |
183 | 0 | free(log_verbose[i]); |
184 | 0 | free(log_verbose); |
185 | 0 | log_verbose = NULL; |
186 | 0 | nlog_verbose = 0; |
187 | 0 | } |
188 | | |
189 | | /* |
190 | | * Initialize the log. |
191 | | */ |
192 | | |
193 | | void |
194 | | log_init(const char *av0, LogLevel level, SyslogFacility facility, |
195 | | int on_stderr) |
196 | 0 | { |
197 | | #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT) |
198 | | struct syslog_data sdata = SYSLOG_DATA_INIT; |
199 | | #endif |
200 | |
|
201 | 0 | argv0 = av0; |
202 | |
|
203 | 0 | if (log_change_level(level) != 0) { |
204 | 0 | fprintf(stderr, "Unrecognized internal syslog level code %d\n", |
205 | 0 | (int) level); |
206 | 0 | exit(1); |
207 | 0 | } |
208 | | |
209 | 0 | log_handler = NULL; |
210 | 0 | log_handler_ctx = NULL; |
211 | |
|
212 | 0 | log_on_stderr = on_stderr; |
213 | 0 | if (on_stderr) |
214 | 0 | return; |
215 | | |
216 | 0 | switch (facility) { |
217 | 0 | case SYSLOG_FACILITY_DAEMON: |
218 | 0 | log_facility = LOG_DAEMON; |
219 | 0 | break; |
220 | 0 | case SYSLOG_FACILITY_USER: |
221 | 0 | log_facility = LOG_USER; |
222 | 0 | break; |
223 | 0 | case SYSLOG_FACILITY_AUTH: |
224 | 0 | log_facility = LOG_AUTH; |
225 | 0 | break; |
226 | 0 | #ifdef LOG_AUTHPRIV |
227 | 0 | case SYSLOG_FACILITY_AUTHPRIV: |
228 | 0 | log_facility = LOG_AUTHPRIV; |
229 | 0 | break; |
230 | 0 | #endif |
231 | 0 | case SYSLOG_FACILITY_LOCAL0: |
232 | 0 | log_facility = LOG_LOCAL0; |
233 | 0 | break; |
234 | 0 | case SYSLOG_FACILITY_LOCAL1: |
235 | 0 | log_facility = LOG_LOCAL1; |
236 | 0 | break; |
237 | 0 | case SYSLOG_FACILITY_LOCAL2: |
238 | 0 | log_facility = LOG_LOCAL2; |
239 | 0 | break; |
240 | 0 | case SYSLOG_FACILITY_LOCAL3: |
241 | 0 | log_facility = LOG_LOCAL3; |
242 | 0 | break; |
243 | 0 | case SYSLOG_FACILITY_LOCAL4: |
244 | 0 | log_facility = LOG_LOCAL4; |
245 | 0 | break; |
246 | 0 | case SYSLOG_FACILITY_LOCAL5: |
247 | 0 | log_facility = LOG_LOCAL5; |
248 | 0 | break; |
249 | 0 | case SYSLOG_FACILITY_LOCAL6: |
250 | 0 | log_facility = LOG_LOCAL6; |
251 | 0 | break; |
252 | 0 | case SYSLOG_FACILITY_LOCAL7: |
253 | 0 | log_facility = LOG_LOCAL7; |
254 | 0 | break; |
255 | 0 | default: |
256 | 0 | fprintf(stderr, |
257 | 0 | "Unrecognized internal syslog facility code %d\n", |
258 | 0 | (int) facility); |
259 | 0 | exit(1); |
260 | 0 | } |
261 | | |
262 | | /* |
263 | | * If an external library (eg libwrap) attempts to use syslog |
264 | | * immediately after reexec, syslog may be pointing to the wrong |
265 | | * facility, so we force an open/close of syslog here. |
266 | | */ |
267 | | #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT) |
268 | | openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata); |
269 | | closelog_r(&sdata); |
270 | | #else |
271 | 0 | openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility); |
272 | 0 | closelog(); |
273 | 0 | #endif |
274 | 0 | } |
275 | | |
276 | | int |
277 | | log_change_level(LogLevel new_log_level) |
278 | 0 | { |
279 | | /* no-op if log_init has not been called */ |
280 | 0 | if (argv0 == NULL) |
281 | 0 | return 0; |
282 | | |
283 | 0 | switch (new_log_level) { |
284 | 0 | case SYSLOG_LEVEL_QUIET: |
285 | 0 | case SYSLOG_LEVEL_FATAL: |
286 | 0 | case SYSLOG_LEVEL_ERROR: |
287 | 0 | case SYSLOG_LEVEL_INFO: |
288 | 0 | case SYSLOG_LEVEL_VERBOSE: |
289 | 0 | case SYSLOG_LEVEL_DEBUG1: |
290 | 0 | case SYSLOG_LEVEL_DEBUG2: |
291 | 0 | case SYSLOG_LEVEL_DEBUG3: |
292 | 0 | log_level = new_log_level; |
293 | 0 | return 0; |
294 | 0 | default: |
295 | 0 | return -1; |
296 | 0 | } |
297 | 0 | } |
298 | | |
299 | | int |
300 | | log_is_on_stderr(void) |
301 | 0 | { |
302 | 0 | return log_on_stderr && log_stderr_fd == STDERR_FILENO; |
303 | 0 | } |
304 | | |
305 | | /* redirect what would usually get written to stderr to specified file */ |
306 | | void |
307 | | log_redirect_stderr_to(const char *logfile) |
308 | 0 | { |
309 | 0 | int fd; |
310 | |
|
311 | 0 | if (logfile == NULL) { |
312 | 0 | if (log_stderr_fd != STDERR_FILENO) { |
313 | 0 | close(log_stderr_fd); |
314 | 0 | log_stderr_fd = STDERR_FILENO; |
315 | 0 | } |
316 | 0 | return; |
317 | 0 | } |
318 | | |
319 | 0 | if ((fd = open(logfile, O_WRONLY|O_CREAT|O_APPEND, 0600)) == -1) { |
320 | 0 | fprintf(stderr, "Couldn't open logfile %s: %s\n", logfile, |
321 | 0 | strerror(errno)); |
322 | 0 | exit(1); |
323 | 0 | } |
324 | 0 | log_stderr_fd = fd; |
325 | 0 | } |
326 | | |
327 | | #define MSGBUFSIZ 1024 |
328 | | |
329 | | void |
330 | | set_log_handler(log_handler_fn *handler, void *ctx) |
331 | 0 | { |
332 | 0 | log_handler = handler; |
333 | 0 | log_handler_ctx = ctx; |
334 | 0 | } |
335 | | |
336 | | static void |
337 | | do_log(LogLevel level, int force, const char *suffix, const char *fmt, |
338 | | va_list args) |
339 | 155 | { |
340 | | #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT) |
341 | | struct syslog_data sdata = SYSLOG_DATA_INIT; |
342 | | #endif |
343 | 155 | char msgbuf[MSGBUFSIZ]; |
344 | 155 | char fmtbuf[MSGBUFSIZ]; |
345 | 155 | char *txt = NULL; |
346 | 155 | int pri = LOG_INFO; |
347 | 155 | int saved_errno = errno; |
348 | 155 | log_handler_fn *tmp_handler; |
349 | 155 | const char *progname = argv0 != NULL ? argv0 : __progname; |
350 | | |
351 | 155 | if (!force && level > log_level) |
352 | 155 | return; |
353 | | |
354 | 0 | switch (level) { |
355 | 0 | case SYSLOG_LEVEL_FATAL: |
356 | 0 | if (!log_on_stderr) |
357 | 0 | txt = "fatal"; |
358 | 0 | pri = LOG_CRIT; |
359 | 0 | break; |
360 | 0 | case SYSLOG_LEVEL_ERROR: |
361 | 0 | if (!log_on_stderr) |
362 | 0 | txt = "error"; |
363 | 0 | pri = LOG_ERR; |
364 | 0 | break; |
365 | 0 | case SYSLOG_LEVEL_INFO: |
366 | 0 | pri = LOG_INFO; |
367 | 0 | break; |
368 | 0 | case SYSLOG_LEVEL_VERBOSE: |
369 | 0 | pri = LOG_INFO; |
370 | 0 | break; |
371 | 0 | case SYSLOG_LEVEL_DEBUG1: |
372 | 0 | txt = "debug1"; |
373 | 0 | pri = LOG_DEBUG; |
374 | 0 | break; |
375 | 0 | case SYSLOG_LEVEL_DEBUG2: |
376 | 0 | txt = "debug2"; |
377 | 0 | pri = LOG_DEBUG; |
378 | 0 | break; |
379 | 0 | case SYSLOG_LEVEL_DEBUG3: |
380 | 0 | txt = "debug3"; |
381 | 0 | pri = LOG_DEBUG; |
382 | 0 | break; |
383 | 0 | default: |
384 | 0 | txt = "internal error"; |
385 | 0 | pri = LOG_ERR; |
386 | 0 | break; |
387 | 0 | } |
388 | 0 | if (txt != NULL && log_handler == NULL) { |
389 | 0 | snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt); |
390 | 0 | vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args); |
391 | 0 | } else { |
392 | 0 | vsnprintf(msgbuf, sizeof(msgbuf), fmt, args); |
393 | 0 | } |
394 | 0 | if (suffix != NULL) { |
395 | 0 | snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", msgbuf, suffix); |
396 | 0 | strlcpy(msgbuf, fmtbuf, sizeof(msgbuf)); |
397 | 0 | } |
398 | 0 | strnvis(fmtbuf, msgbuf, sizeof(fmtbuf), |
399 | 0 | log_on_stderr ? LOG_STDERR_VIS : LOG_SYSLOG_VIS); |
400 | 0 | if (log_handler != NULL) { |
401 | | /* Avoid recursion */ |
402 | 0 | tmp_handler = log_handler; |
403 | 0 | log_handler = NULL; |
404 | 0 | tmp_handler(level, force, fmtbuf, log_handler_ctx); |
405 | 0 | log_handler = tmp_handler; |
406 | 0 | } else if (log_on_stderr) { |
407 | 0 | snprintf(msgbuf, sizeof msgbuf, "%s%s%.*s\r\n", |
408 | 0 | (log_on_stderr > 1) ? progname : "", |
409 | 0 | (log_on_stderr > 1) ? ": " : "", |
410 | 0 | (int)sizeof msgbuf - 3, fmtbuf); |
411 | 0 | (void)write(log_stderr_fd, msgbuf, strlen(msgbuf)); |
412 | 0 | } else { |
413 | | #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT) |
414 | | openlog_r(progname, LOG_PID, log_facility, &sdata); |
415 | | syslog_r(pri, &sdata, "%.500s", fmtbuf); |
416 | | closelog_r(&sdata); |
417 | | #else |
418 | 0 | openlog(progname, LOG_PID, log_facility); |
419 | 0 | syslog(pri, "%.500s", fmtbuf); |
420 | 0 | closelog(); |
421 | 0 | #endif |
422 | 0 | } |
423 | 0 | errno = saved_errno; |
424 | 0 | } |
425 | | |
426 | | void |
427 | | sshlog(const char *file, const char *func, int line, int showfunc, |
428 | | LogLevel level, const char *suffix, const char *fmt, ...) |
429 | 155 | { |
430 | 155 | va_list args; |
431 | | |
432 | 155 | va_start(args, fmt); |
433 | 155 | sshlogv(file, func, line, showfunc, level, suffix, fmt, args); |
434 | 155 | va_end(args); |
435 | 155 | } |
436 | | |
437 | | void |
438 | | sshlogdie(const char *file, const char *func, int line, int showfunc, |
439 | | LogLevel level, const char *suffix, const char *fmt, ...) |
440 | 0 | { |
441 | 0 | va_list args; |
442 | |
|
443 | 0 | va_start(args, fmt); |
444 | 0 | sshlogv(file, func, line, showfunc, SYSLOG_LEVEL_INFO, |
445 | 0 | suffix, fmt, args); |
446 | 0 | va_end(args); |
447 | 0 | cleanup_exit(255); |
448 | 0 | } |
449 | | |
450 | | void |
451 | | sshsigdie(const char *file, const char *func, int line, int showfunc, |
452 | | LogLevel level, const char *suffix, const char *fmt, ...) |
453 | 0 | { |
454 | 0 | va_list args; |
455 | |
|
456 | 0 | va_start(args, fmt); |
457 | 0 | sshlogv(file, func, line, showfunc, SYSLOG_LEVEL_FATAL, |
458 | 0 | suffix, fmt, args); |
459 | 0 | va_end(args); |
460 | 0 | _exit(1); |
461 | 0 | } |
462 | | |
463 | | void |
464 | | sshlogv(const char *file, const char *func, int line, int showfunc, |
465 | | LogLevel level, const char *suffix, const char *fmt, va_list args) |
466 | 155 | { |
467 | 155 | char tag[128], fmt2[MSGBUFSIZ + 128]; |
468 | 155 | int forced = 0; |
469 | 155 | const char *cp; |
470 | 155 | size_t i; |
471 | | |
472 | 155 | snprintf(tag, sizeof(tag), "%.48s:%.48s():%d (pid=%ld)", |
473 | 155 | (cp = strrchr(file, '/')) == NULL ? file : cp + 1, func, line, |
474 | 155 | (long)getpid()); |
475 | 155 | for (i = 0; i < nlog_verbose; i++) { |
476 | 0 | if (match_pattern_list(tag, log_verbose[i], 0) == 1) { |
477 | 0 | forced = 1; |
478 | 0 | break; |
479 | 0 | } |
480 | 0 | } |
481 | | |
482 | 155 | if (forced) |
483 | 0 | snprintf(fmt2, sizeof(fmt2), "%s: %s", tag, fmt); |
484 | 155 | else if (showfunc) |
485 | 155 | snprintf(fmt2, sizeof(fmt2), "%s: %s", func, fmt); |
486 | 0 | else |
487 | 0 | strlcpy(fmt2, fmt, sizeof(fmt2)); |
488 | | |
489 | 155 | do_log(level, forced, suffix, fmt2, args); |
490 | 155 | } |
491 | | |
492 | | void |
493 | | sshlogdirect(LogLevel level, int forced, const char *fmt, ...) |
494 | 0 | { |
495 | 0 | va_list args; |
496 | |
|
497 | 0 | va_start(args, fmt); |
498 | 0 | do_log(level, forced, NULL, fmt, args); |
499 | 0 | va_end(args); |
500 | 0 | } |