log.c

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