[BACK]Return to log.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/log.c, Revision 1.27

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