log.c

   1 /* $OpenBSD: log.c,v 1.42 2011/06/17 21:44:30 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 <stdarg.h>
  42 #include <stdio.h>
  43 #include <stdlib.h>
  44 #include <string.h>
  45 #include <syslog.h>
  46 #include <unistd.h>
  47 #include <errno.h>
  48 #if defined(HAVE_STRNVIS) && defined(HAVE_VIS_H)
  49 # include <vis.h>
  50 #endif
  51
  52 #include "xmalloc.h"
  53 #include "log.h"
  54
  55 static LogLevel log_level = SYSLOG_LEVEL_INFO;
  56 static int log_on_stderr = 1;
  57 static int log_facility = LOG_AUTH;
  58 static char *argv0;
  59 static log_handler_fn *log_handler;
  60 static void *log_handler_ctx;
  61
  62 extern char *__progname;
  63
  64 #define LOG_SYSLOG_VIS  (VIS_CSTYLE|VIS_NL|VIS_TAB|VIS_OCTAL)
  65 #define LOG_STDERR_VIS  (VIS_SAFE|VIS_OCTAL)
  66
  67 /* textual representation of log-facilities/levels */
  68
  69 static struct {
  70         const char *name;
  71         SyslogFacility val;
  72 } log_facilities[] = {
  73         { "DAEMON",     SYSLOG_FACILITY_DAEMON },
  74         { "USER",       SYSLOG_FACILITY_USER },
  75         { "AUTH",       SYSLOG_FACILITY_AUTH },
  76 #ifdef LOG_AUTHPRIV
  77         { "AUTHPRIV",   SYSLOG_FACILITY_AUTHPRIV },
  78 #endif
  79         { "LOCAL0",     SYSLOG_FACILITY_LOCAL0 },
  80         { "LOCAL1",     SYSLOG_FACILITY_LOCAL1 },
  81         { "LOCAL2",     SYSLOG_FACILITY_LOCAL2 },
  82         { "LOCAL3",     SYSLOG_FACILITY_LOCAL3 },
  83         { "LOCAL4",     SYSLOG_FACILITY_LOCAL4 },
  84         { "LOCAL5",     SYSLOG_FACILITY_LOCAL5 },
  85         { "LOCAL6",     SYSLOG_FACILITY_LOCAL6 },
  86         { "LOCAL7",     SYSLOG_FACILITY_LOCAL7 },
  87         { NULL,         SYSLOG_FACILITY_NOT_SET }
  88 };
  89
  90 static struct {
  91         const char *name;
  92         LogLevel val;
  93 } log_levels[] =
  94 {
  95         { "SILENT",     SYSLOG_LEVEL_QUIET }, /* compatibility */
  96         { "QUIET",      SYSLOG_LEVEL_QUIET },
  97         { "FATAL",      SYSLOG_LEVEL_FATAL },
  98         { "ERROR",      SYSLOG_LEVEL_ERROR },
  99         { "INFO",       SYSLOG_LEVEL_INFO },
 100         { "VERBOSE",    SYSLOG_LEVEL_VERBOSE },
 101         { "DEBUG",      SYSLOG_LEVEL_DEBUG1 },
 102         { "DEBUG1",     SYSLOG_LEVEL_DEBUG1 },
 103         { "DEBUG2",     SYSLOG_LEVEL_DEBUG2 },
 104         { "DEBUG3",     SYSLOG_LEVEL_DEBUG3 },
 105         { NULL,         SYSLOG_LEVEL_NOT_SET }
 106 };
 107
 108 SyslogFacility
 109 log_facility_number(char *name)
 110 {
 111         int i;
 112
 113         if (name != NULL)
 114                 for (i = 0; log_facilities[i].name; i++)
 115                         if (strcasecmp(log_facilities[i].name, name) == 0)
 116                                 return log_facilities[i].val;
 117         return SYSLOG_FACILITY_NOT_SET;
 118 }
 119
 120 const char *
 121 log_facility_name(SyslogFacility facility)
 122 {
 123         u_int i;
 124
 125         for (i = 0;  log_facilities[i].name; i++)
 126                 if (log_facilities[i].val == facility)
 127                         return log_facilities[i].name;
 128         return NULL;
 129 }
 130
 131 LogLevel
 132 log_level_number(char *name)
 133 {
 134         int i;
 135
 136         if (name != NULL)
 137                 for (i = 0; log_levels[i].name; i++)
 138                         if (strcasecmp(log_levels[i].name, name) == 0)
 139                                 return log_levels[i].val;
 140         return SYSLOG_LEVEL_NOT_SET;
 141 }
 142
 143 const char *
 144 log_level_name(LogLevel level)
 145 {
 146         u_int i;
 147
 148         for (i = 0; log_levels[i].name != NULL; i++)
 149                 if (log_levels[i].val == level)
 150                         return log_levels[i].name;
 151         return NULL;
 152 }
 153
 154 /* Error messages that should be logged. */
 155
 156 void
 157 error(const char *fmt,...)
 158 {
 159         va_list args;
 160
 161         va_start(args, fmt);
 162         do_log(SYSLOG_LEVEL_ERROR, fmt, args);
 163         va_end(args);
 164 }
 165
 166 void
 167 sigdie(const char *fmt,...)
 168 {
 169 #ifdef DO_LOG_SAFE_IN_SIGHAND
 170         va_list args;
 171
 172         va_start(args, fmt);
 173         do_log(SYSLOG_LEVEL_FATAL, fmt, args);
 174         va_end(args);
 175 #endif
 176         _exit(1);
 177 }
 178
 179
 180 /* Log this message (information that usually should go to the log). */
 181
 182 void
 183 logit(const char *fmt,...)
 184 {
 185         va_list args;
 186
 187         va_start(args, fmt);
 188         do_log(SYSLOG_LEVEL_INFO, fmt, args);
 189         va_end(args);
 190 }
 191
 192 /* More detailed messages (information that does not need to go to the log). */
 193
 194 void
 195 verbose(const char *fmt,...)
 196 {
 197         va_list args;
 198
 199         va_start(args, fmt);
 200         do_log(SYSLOG_LEVEL_VERBOSE, fmt, args);
 201         va_end(args);
 202 }
 203
 204 /* Debugging messages that should not be logged during normal operation. */
 205
 206 void
 207 debug(const char *fmt,...)
 208 {
 209         va_list args;
 210
 211         va_start(args, fmt);
 212         do_log(SYSLOG_LEVEL_DEBUG1, fmt, args);
 213         va_end(args);
 214 }
 215
 216 void
 217 debug2(const char *fmt,...)
 218 {
 219         va_list args;
 220
 221         va_start(args, fmt);
 222         do_log(SYSLOG_LEVEL_DEBUG2, fmt, args);
 223         va_end(args);
 224 }
 225
 226 void
 227 debug3(const char *fmt,...)
 228 {
 229         va_list args;
 230
 231         va_start(args, fmt);
 232         do_log(SYSLOG_LEVEL_DEBUG3, fmt, args);
 233         va_end(args);
 234 }
 235
 236 /*
 237  * Initialize the log.
 238  */
 239
 240 void
 241 log_init(char *av0, LogLevel level, SyslogFacility facility, int on_stderr)
 242 {
 243 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
 244         struct syslog_data sdata = SYSLOG_DATA_INIT;
 245 #endif
 246
 247         argv0 = av0;
 248
 249         switch (level) {
 250         case SYSLOG_LEVEL_QUIET:
 251         case SYSLOG_LEVEL_FATAL:
 252         case SYSLOG_LEVEL_ERROR:
 253         case SYSLOG_LEVEL_INFO:
 254         case SYSLOG_LEVEL_VERBOSE:
 255         case SYSLOG_LEVEL_DEBUG1:
 256         case SYSLOG_LEVEL_DEBUG2:
 257         case SYSLOG_LEVEL_DEBUG3:
 258                 log_level = level;
 259                 break;
 260         default:
 261                 fprintf(stderr, "Unrecognized internal syslog level code %d\n",
 262                     (int) level);
 263                 exit(1);
 264         }
 265
 266         log_handler = NULL;
 267         log_handler_ctx = NULL;
 268
 269         log_on_stderr = on_stderr;
 270         if (on_stderr)
 271                 return;
 272
 273         switch (facility) {
 274         case SYSLOG_FACILITY_DAEMON:
 275                 log_facility = LOG_DAEMON;
 276                 break;
 277         case SYSLOG_FACILITY_USER:
 278                 log_facility = LOG_USER;
 279                 break;
 280         case SYSLOG_FACILITY_AUTH:
 281                 log_facility = LOG_AUTH;
 282                 break;
 283 #ifdef LOG_AUTHPRIV
 284         case SYSLOG_FACILITY_AUTHPRIV:
 285                 log_facility = LOG_AUTHPRIV;
 286                 break;
 287 #endif
 288         case SYSLOG_FACILITY_LOCAL0:
 289                 log_facility = LOG_LOCAL0;
 290                 break;
 291         case SYSLOG_FACILITY_LOCAL1:
 292                 log_facility = LOG_LOCAL1;
 293                 break;
 294         case SYSLOG_FACILITY_LOCAL2:
 295                 log_facility = LOG_LOCAL2;
 296                 break;
 297         case SYSLOG_FACILITY_LOCAL3:
 298                 log_facility = LOG_LOCAL3;
 299                 break;
 300         case SYSLOG_FACILITY_LOCAL4:
 301                 log_facility = LOG_LOCAL4;
 302                 break;
 303         case SYSLOG_FACILITY_LOCAL5:
 304                 log_facility = LOG_LOCAL5;
 305                 break;
 306         case SYSLOG_FACILITY_LOCAL6:
 307                 log_facility = LOG_LOCAL6;
 308                 break;
 309         case SYSLOG_FACILITY_LOCAL7:
 310                 log_facility = LOG_LOCAL7;
 311                 break;
 312         default:
 313                 fprintf(stderr,
 314                     "Unrecognized internal syslog facility code %d\n",
 315                     (int) facility);
 316                 exit(1);
 317         }
 318
 319         /*
 320          * If an external library (eg libwrap) attempts to use syslog
 321          * immediately after reexec, syslog may be pointing to the wrong
 322          * facility, so we force an open/close of syslog here.
 323          */
 324 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
 325         openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
 326         closelog_r(&sdata);
 327 #else
 328         openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
 329         closelog();
 330 #endif
 331 }
 332
 333 #define MSGBUFSIZ 1024
 334
 335 void
 336 set_log_handler(log_handler_fn *handler, void *ctx)
 337 {
 338         log_handler = handler;
 339         log_handler_ctx = ctx;
 340 }
 341
 342 void
 343 do_log2(LogLevel level, const char *fmt,...)
 344 {
 345         va_list args;
 346
 347         va_start(args, fmt);
 348         do_log(level, fmt, args);
 349         va_end(args);
 350 }
 351
 352 void
 353 do_log(LogLevel level, const char *fmt, va_list args)
 354 {
 355 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
 356         struct syslog_data sdata = SYSLOG_DATA_INIT;
 357 #endif
 358         char msgbuf[MSGBUFSIZ];
 359         char fmtbuf[MSGBUFSIZ];
 360         char *txt = NULL;
 361         int pri = LOG_INFO;
 362         int saved_errno = errno;
 363         log_handler_fn *tmp_handler;
 364
 365         if (level > log_level)
 366                 return;
 367
 368         switch (level) {
 369         case SYSLOG_LEVEL_FATAL:
 370                 if (!log_on_stderr)
 371                         txt = "fatal";
 372                 pri = LOG_CRIT;
 373                 break;
 374         case SYSLOG_LEVEL_ERROR:
 375                 if (!log_on_stderr)
 376                         txt = "error";
 377                 pri = LOG_ERR;
 378                 break;
 379         case SYSLOG_LEVEL_INFO:
 380                 pri = LOG_INFO;
 381                 break;
 382         case SYSLOG_LEVEL_VERBOSE:
 383                 pri = LOG_INFO;
 384                 break;
 385         case SYSLOG_LEVEL_DEBUG1:
 386                 txt = "debug1";
 387                 pri = LOG_DEBUG;
 388                 break;
 389         case SYSLOG_LEVEL_DEBUG2:
 390                 txt = "debug2";
 391                 pri = LOG_DEBUG;
 392                 break;
 393         case SYSLOG_LEVEL_DEBUG3:
 394                 txt = "debug3";
 395                 pri = LOG_DEBUG;
 396                 break;
 397         default:
 398                 txt = "internal error";
 399                 pri = LOG_ERR;
 400                 break;
 401         }
 402         if (txt != NULL && log_handler == NULL) {
 403                 snprintf(fmtbuf, sizeof(fmtbuf), "%s: %s", txt, fmt);
 404                 vsnprintf(msgbuf, sizeof(msgbuf), fmtbuf, args);
 405         } else {
 406                 vsnprintf(msgbuf, sizeof(msgbuf), fmt, args);
 407         }
 408         strnvis(fmtbuf, msgbuf, sizeof(fmtbuf),
 409             log_on_stderr ? LOG_STDERR_VIS : LOG_SYSLOG_VIS);
 410         if (log_handler != NULL) {
 411                 /* Avoid recursion */
 412                 tmp_handler = log_handler;
 413                 log_handler = NULL;
 414                 tmp_handler(level, fmtbuf, log_handler_ctx);
 415                 log_handler = tmp_handler;
 416         } else if (log_on_stderr) {
 417                 snprintf(msgbuf, sizeof msgbuf, "%s\r\n", fmtbuf);
 418                 write(STDERR_FILENO, msgbuf, strlen(msgbuf));
 419         } else {
 420 #if defined(HAVE_OPENLOG_R) && defined(SYSLOG_DATA_INIT)
 421                 openlog_r(argv0 ? argv0 : __progname, LOG_PID, log_facility, &sdata);
 422                 syslog_r(pri, &sdata, "%.500s", fmtbuf);
 423                 closelog_r(&sdata);
 424 #else
 425                 openlog(argv0 ? argv0 : __progname, LOG_PID, log_facility);
 426                 syslog(pri, "%.500s", fmtbuf);
 427                 closelog();
 428 #endif
 429         }
 430         errno = saved_errno;
 431 }