log.c

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