1 /* 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 /* 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. 34 */ 35 36 #include "includes.h" 37 RCSID("$OpenBSD: log.c,v 1.22 2002/02/22 12:20:34 markus Exp $"); 38 39 #include "log.h" 40 #include "xmalloc.h" 41 42 #include <syslog.h> 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 #ifdef LOG_AUTHPRIV 61 { "AUTHPRIV", SYSLOG_FACILITY_AUTHPRIV }, 62 #endif 63 { "LOCAL0", SYSLOG_FACILITY_LOCAL0 }, 64 { "LOCAL1", SYSLOG_FACILITY_LOCAL1 }, 65 { "LOCAL2", SYSLOG_FACILITY_LOCAL2 }, 66 { "LOCAL3", SYSLOG_FACILITY_LOCAL3 }, 67 { "LOCAL4", SYSLOG_FACILITY_LOCAL4 }, 68 { "LOCAL5", SYSLOG_FACILITY_LOCAL5 }, 69 { "LOCAL6", SYSLOG_FACILITY_LOCAL6 }, 70 { "LOCAL7", SYSLOG_FACILITY_LOCAL7 }, 71 { NULL, SYSLOG_FACILITY_NOT_SET } 72 }; 73 74 static struct { 75 const char *name; 76 LogLevel val; 77 } log_levels[] = 78 { 79 { "QUIET", SYSLOG_LEVEL_QUIET }, 80 { "FATAL", SYSLOG_LEVEL_FATAL }, 81 { "ERROR", SYSLOG_LEVEL_ERROR }, 82 { "INFO", SYSLOG_LEVEL_INFO }, 83 { "VERBOSE", SYSLOG_LEVEL_VERBOSE }, 84 { "DEBUG", SYSLOG_LEVEL_DEBUG1 }, 85 { "DEBUG1", SYSLOG_LEVEL_DEBUG1 }, 86 { "DEBUG2", SYSLOG_LEVEL_DEBUG2 }, 87 { "DEBUG3", SYSLOG_LEVEL_DEBUG3 }, 88 { NULL, SYSLOG_LEVEL_NOT_SET } 89 }; 90 91 SyslogFacility 92 log_facility_number(char *name) 93 { 94 int i; 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; 99 return SYSLOG_FACILITY_NOT_SET; 100 } 101 102 LogLevel 103 log_level_number(char *name) 104 { 105 int i; 106 if (name != NULL) 107 for (i = 0; log_levels[i].name; i++) 108 if (strcasecmp(log_levels[i].name, name) == 0) 109 return log_levels[i].val; 110 return SYSLOG_LEVEL_NOT_SET; 111 } 112 113 /* Error messages that should be logged. */ 114 115 void 116 error(const char *fmt,...) 117 { 118 va_list args; 119 va_start(args, fmt); 120 do_log(SYSLOG_LEVEL_ERROR, fmt, args); 121 va_end(args); 122 } 123 124 /* Log this message (information that usually should go to the log). */ 125 126 void 127 log(const char *fmt,...) 128 { 129 va_list args; 130 va_start(args, fmt); 131 do_log(SYSLOG_LEVEL_INFO, fmt, args); 132 va_end(args); 133 } 134 135 /* More detailed messages (information that does not need to go to the log). */ 136 137 void 138 verbose(const char *fmt,...) 139 { 140 va_list args; 141 va_start(args, fmt); 142 do_log(SYSLOG_LEVEL_VERBOSE, fmt, args); 143 va_end(args); 144 } 145 146 /* Debugging messages that should not be logged during normal operation. */ 147 148 void 149 debug(const char *fmt,...) 150 { 151 va_list args; 152 va_start(args, fmt); 153 do_log(SYSLOG_LEVEL_DEBUG1, fmt, args); 154 va_end(args); 155 } 156 157 void 158 debug2(const char *fmt,...) 159 { 160 va_list args; 161 va_start(args, fmt); 162 do_log(SYSLOG_LEVEL_DEBUG2, fmt, args); 163 va_end(args); 164 } 165 166 void 167 debug3(const char *fmt,...) 168 { 169 va_list args; 170 va_start(args, fmt); 171 do_log(SYSLOG_LEVEL_DEBUG3, fmt, args); 172 va_end(args); 173 } 174 175 /* Fatal cleanup */ 176 177 struct fatal_cleanup { 178 struct fatal_cleanup *next; 179 void (*proc) (void *); 180 void *context; 181 }; 182 183 static struct fatal_cleanup *fatal_cleanups = NULL; 184 185 /* Registers a cleanup function to be called by fatal() before exiting. */ 186 187 void 188 fatal_add_cleanup(void (*proc) (void *), void *context) 189 { 190 struct fatal_cleanup *cu; 191 192 cu = xmalloc(sizeof(*cu)); 193 cu->proc = proc; 194 cu->context = context; 195 cu->next = fatal_cleanups; 196 fatal_cleanups = cu; 197 } 198 199 /* Removes a cleanup frunction to be called at fatal(). */ 200 201 void 202 fatal_remove_cleanup(void (*proc) (void *context), void *context) 203 { 204 struct fatal_cleanup **cup, *cu; 205 206 for (cup = &fatal_cleanups; *cup; cup = &cu->next) { 207 cu = *cup; 208 if (cu->proc == proc && cu->context == context) { 209 *cup = cu->next; 210 xfree(cu); 211 return; 212 } 213 } 214 fatal("fatal_remove_cleanup: no such cleanup function: 0x%lx 0x%lx", 215 (u_long) proc, (u_long) context); 216 } 217 218 /* Cleanup and exit */ 219 void 220 fatal_cleanup(void) 221 { 222 struct fatal_cleanup *cu, *next_cu; 223 static int called = 0; 224 225 if (called) 226 exit(255); 227 called = 1; 228 /* Call cleanup functions. */ 229 for (cu = fatal_cleanups; cu; cu = next_cu) { 230 next_cu = cu->next; 231 debug("Calling cleanup 0x%lx(0x%lx)", 232 (u_long) cu->proc, (u_long) cu->context); 233 (*cu->proc) (cu->context); 234 } 235 exit(255); 236 } 237 238 239 /* 240 * Initialize the log. 241 */ 242 243 void 244 log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr) 245 { 246 argv0 = av0; 247 248 switch (level) { 249 case SYSLOG_LEVEL_QUIET: 250 case SYSLOG_LEVEL_FATAL: 251 case SYSLOG_LEVEL_ERROR: 252 case SYSLOG_LEVEL_INFO: 253 case SYSLOG_LEVEL_VERBOSE: 254 case SYSLOG_LEVEL_DEBUG1: 255 case SYSLOG_LEVEL_DEBUG2: 256 case SYSLOG_LEVEL_DEBUG3: 257 log_level = level; 258 break; 259 default: 260 fprintf(stderr, "Unrecognized internal syslog level code %d\n", 261 (int) level); 262 exit(1); 263 } 264 265 log_on_stderr = on_stderr; 266 if (on_stderr) 267 return; 268 269 switch (facility) { 270 case SYSLOG_FACILITY_DAEMON: 271 log_facility = LOG_DAEMON; 272 break; 273 case SYSLOG_FACILITY_USER: 274 log_facility = LOG_USER; 275 break; 276 case SYSLOG_FACILITY_AUTH: 277 log_facility = LOG_AUTH; 278 break; 279 #ifdef LOG_AUTHPRIV 280 case SYSLOG_FACILITY_AUTHPRIV: 281 log_facility = LOG_AUTHPRIV; 282 break; 283 #endif 284 case SYSLOG_FACILITY_LOCAL0: 285 log_facility = LOG_LOCAL0; 286 break; 287 case SYSLOG_FACILITY_LOCAL1: 288 log_facility = LOG_LOCAL1; 289 break; 290 case SYSLOG_FACILITY_LOCAL2: 291 log_facility = LOG_LOCAL2; 292 break; 293 case SYSLOG_FACILITY_LOCAL3: 294 log_facility = LOG_LOCAL3; 295 break; 296 case SYSLOG_FACILITY_LOCAL4: 297 log_facility = LOG_LOCAL4; 298 break; 299 case SYSLOG_FACILITY_LOCAL5: 300 log_facility = LOG_LOCAL5; 301 break; 302 case SYSLOG_FACILITY_LOCAL6: 303 log_facility = LOG_LOCAL6; 304 break; 305 case SYSLOG_FACILITY_LOCAL7: 306 log_facility = LOG_LOCAL7; 307 break; 308 default: 309 fprintf(stderr, 310 "Unrecognized internal syslog facility code %d\n", 311 (int) facility); 312 exit(1); 313 } 314 } 315 316 #define MSGBUFSIZ 1024 317 318 void 319 do_log(LogLevel level, const char *fmt, va_list args) 320 { 321 char msgbuf[MSGBUFSIZ]; 322 char fmtbuf[MSGBUFSIZ]; 323 char *txt = NULL; 324 int pri = LOG_INFO; 325 326 if (level > log_level) 327 return; 328 329 switch (level) { 330 case SYSLOG_LEVEL_FATAL: 331 if (!log_on_stderr) 332 txt = "fatal"; 333 pri = LOG_CRIT; 334 break; 335 case SYSLOG_LEVEL_ERROR: 336 if (!log_on_stderr) 337 txt = "error"; 338 pri = LOG_ERR; 339 break; 340 case SYSLOG_LEVEL_INFO: 341 pri = LOG_INFO; 342 break; 343 case SYSLOG_LEVEL_VERBOSE: 344 pri = LOG_INFO; 345 break; 346 case SYSLOG_LEVEL_DEBUG1: 347 txt = "debug1"; 348 pri = LOG_DEBUG; 349 break; 350 case SYSLOG_LEVEL_DEBUG2: 351 txt = "debug2"; 352 pri = LOG_DEBUG; 353 break; 354 case SYSLOG_LEVEL_DEBUG3: 355 txt = "debug3"; 356 pri = LOG_DEBUG; 357 break; 358 default: 359 txt = "internal error"; 360 pri = LOG_ERR; 361 break; 362 } 363 if (txt != NULL) { 364 snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt); 365 vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args); 366 } else { 367 vsnprintf(msgbuf, sizeof(msgbuf), fmt, args); 368 } 369 if (log_on_stderr) { 370 fprintf(stderr, "%s\r\n", msgbuf); 371 } else { 372 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility); 373 syslog(pri, "%.500s", msgbuf); 374 closelog(); 375 } 376 } 377