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.29 2003/09/23 20:17:11 markus Exp $"); 38 39 #include "log.h" 40 #include "xmalloc.h" 41 42 #include <syslog.h> 43 #if defined(HAVE_STRNVIS) && defined(HAVE_VIS_H) 44 # include <vis.h> 45 #endif 46 47 static LogLevel log_level = SYSLOG_LEVEL_INFO; 48 static int log_on_stderr = 1; 49 static int log_facility = LOG_AUTH; 50 static char *argv0; 51 52 extern char *__progname; 53 54 /* textual representation of log-facilities/levels */ 55 56 static struct { 57 const char *name; 58 SyslogFacility val; 59 } log_facilities[] = { 60 { "DAEMON", SYSLOG_FACILITY_DAEMON }, 61 { "USER", SYSLOG_FACILITY_USER }, 62 { "AUTH", SYSLOG_FACILITY_AUTH }, 63 #ifdef LOG_AUTHPRIV 64 { "AUTHPRIV", SYSLOG_FACILITY_AUTHPRIV }, 65 #endif 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 }, 74 { NULL, SYSLOG_FACILITY_NOT_SET } 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 }, 91 { NULL, SYSLOG_LEVEL_NOT_SET } 92 }; 93 94 SyslogFacility 95 log_facility_number(char *name) 96 { 97 int i; 98 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; 103 return SYSLOG_FACILITY_NOT_SET; 104 } 105 106 LogLevel 107 log_level_number(char *name) 108 { 109 int i; 110 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; 115 return SYSLOG_LEVEL_NOT_SET; 116 } 117 118 /* Error messages that should be logged. */ 119 120 void 121 error(const char *fmt,...) 122 { 123 va_list args; 124 125 va_start(args, fmt); 126 do_log(SYSLOG_LEVEL_ERROR, fmt, args); 127 va_end(args); 128 } 129 130 /* Log this message (information that usually should go to the log). */ 131 132 void 133 logit(const char *fmt,...) 134 { 135 va_list args; 136 137 va_start(args, fmt); 138 do_log(SYSLOG_LEVEL_INFO, fmt, args); 139 va_end(args); 140 } 141 142 /* More detailed messages (information that does not need to go to the log). */ 143 144 void 145 verbose(const char *fmt,...) 146 { 147 va_list args; 148 149 va_start(args, fmt); 150 do_log(SYSLOG_LEVEL_VERBOSE, fmt, args); 151 va_end(args); 152 } 153 154 /* Debugging messages that should not be logged during normal operation. */ 155 156 void 157 debug(const char *fmt,...) 158 { 159 va_list args; 160 161 va_start(args, fmt); 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; 170 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; 180 181 va_start(args, fmt); 182 do_log(SYSLOG_LEVEL_DEBUG3, fmt, args); 183 va_end(args); 184 } 185 186 /* 187 * Initialize the log. 188 */ 189 190 void 191 log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr) 192 { 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 } 211 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 #ifdef LOG_AUTHPRIV 227 case SYSLOG_FACILITY_AUTHPRIV: 228 log_facility = LOG_AUTHPRIV; 229 break; 230 #endif 231 case SYSLOG_FACILITY_LOCAL0: 232 log_facility = LOG_LOCAL0; 233 break; 234 case SYSLOG_FACILITY_LOCAL1: 235 log_facility = LOG_LOCAL1; 236 break; 237 case SYSLOG_FACILITY_LOCAL2: 238 log_facility = LOG_LOCAL2; 239 break; 240 case SYSLOG_FACILITY_LOCAL3: 241 log_facility = LOG_LOCAL3; 242 break; 243 case SYSLOG_FACILITY_LOCAL4: 244 log_facility = LOG_LOCAL4; 245 break; 246 case SYSLOG_FACILITY_LOCAL5: 247 log_facility = LOG_LOCAL5; 248 break; 249 case SYSLOG_FACILITY_LOCAL6: 250 log_facility = LOG_LOCAL6; 251 break; 252 case SYSLOG_FACILITY_LOCAL7: 253 log_facility = LOG_LOCAL7; 254 break; 255 default: 256 fprintf(stderr, 257 "Unrecognized internal syslog facility code %d\n", 258 (int) facility); 259 exit(1); 260 } 261 } 262 263 #define MSGBUFSIZ 1024 264 265 void 266 do_log(LogLevel level, const char *fmt, va_list args) 267 { 268 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT) 269 struct syslog_data sdata = SYSLOG_DATA_INIT; 270 #endif 271 char msgbuf[MSGBUFSIZ]; 272 char fmtbuf[MSGBUFSIZ]; 273 char *txt = NULL; 274 int pri = LOG_INFO; 275 276 if (level > log_level) 277 return; 278 279 switch (level) { 280 case SYSLOG_LEVEL_FATAL: 281 if (!log_on_stderr) 282 txt = "fatal"; 283 pri = LOG_CRIT; 284 break; 285 case SYSLOG_LEVEL_ERROR: 286 if (!log_on_stderr) 287 txt = "error"; 288 pri = LOG_ERR; 289 break; 290 case SYSLOG_LEVEL_INFO: 291 pri = LOG_INFO; 292 break; 293 case SYSLOG_LEVEL_VERBOSE: 294 pri = LOG_INFO; 295 break; 296 case SYSLOG_LEVEL_DEBUG1: 297 txt = "debug1"; 298 pri = LOG_DEBUG; 299 break; 300 case SYSLOG_LEVEL_DEBUG2: 301 txt = "debug2"; 302 pri = LOG_DEBUG; 303 break; 304 case SYSLOG_LEVEL_DEBUG3: 305 txt = "debug3"; 306 pri = LOG_DEBUG; 307 break; 308 default: 309 txt = "internal error"; 310 pri = LOG_ERR; 311 break; 312 } 313 if (txt != NULL) { 314 snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt); 315 vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args); 316 } else { 317 vsnprintf(msgbuf, sizeof(msgbuf), fmt, args); 318 } 319 strnvis(fmtbuf, msgbuf, sizeof(fmtbuf), VIS_SAFE|VIS_OCTAL); 320 if (log_on_stderr) { 321 snprintf(msgbuf, sizeof msgbuf, "%s\r\n", fmtbuf); 322 write(STDERR_FILENO, msgbuf, strlen(msgbuf)); 323 } else { 324 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT) 325 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata); 326 syslog_r(pri, &sdata, "%.500s", fmtbuf); 327 closelog_r(&sdata); 328 #else 329 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility); 330 syslog(pri, "%.500s", fmtbuf); 331 closelog(); 332 #endif 333 } 334 } 335