blob: 95ec864f323d85d93088f0e53011dba7909a92b5 [file] [log] [blame]
Ben Lindstrom16ae3d02001-07-04 04:02:36 +00001/* $OpenBSD: log.h,v 1.3 2001/06/26 06:32:55 itojun Exp $ */
Ben Lindstrom36579d32001-01-29 07:39:26 +00002
Ben Lindstrom226cfa02001-01-22 05:34:40 +00003/*
4 * Author: Tatu Ylonen <ylo@cs.hut.fi>
5 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * All rights reserved
7 *
8 * As far as I am concerned, the code I have written for this software
9 * can be used freely for any purpose. Any derived versions of this
10 * software must be clearly marked as such, and if the derived work is
11 * incompatible with the protocol description in the RFC file, it must be
12 * called by a name other than "ssh" or "Secure Shell".
13 */
14
15#ifndef SSH_LOG_H
16#define SSH_LOG_H
17
Damien Miller30246a82001-03-05 21:23:31 +110018#include <syslog.h> /* Needed for LOG_AUTHPRIV (if present) */
19
Ben Lindstrom226cfa02001-01-22 05:34:40 +000020/* Supported syslog facilities and levels. */
21typedef enum {
22 SYSLOG_FACILITY_DAEMON,
23 SYSLOG_FACILITY_USER,
24 SYSLOG_FACILITY_AUTH,
25#ifdef LOG_AUTHPRIV
Kevin Stevesef4eea92001-02-05 12:42:17 +000026 SYSLOG_FACILITY_AUTHPRIV,
Ben Lindstrom226cfa02001-01-22 05:34:40 +000027#endif
28 SYSLOG_FACILITY_LOCAL0,
29 SYSLOG_FACILITY_LOCAL1,
30 SYSLOG_FACILITY_LOCAL2,
31 SYSLOG_FACILITY_LOCAL3,
32 SYSLOG_FACILITY_LOCAL4,
33 SYSLOG_FACILITY_LOCAL5,
34 SYSLOG_FACILITY_LOCAL6,
35 SYSLOG_FACILITY_LOCAL7
36} SyslogFacility;
37
38typedef enum {
39 SYSLOG_LEVEL_QUIET,
40 SYSLOG_LEVEL_FATAL,
41 SYSLOG_LEVEL_ERROR,
42 SYSLOG_LEVEL_INFO,
43 SYSLOG_LEVEL_VERBOSE,
44 SYSLOG_LEVEL_DEBUG1,
45 SYSLOG_LEVEL_DEBUG2,
46 SYSLOG_LEVEL_DEBUG3
47} LogLevel;
48/* Initializes logging. */
Ben Lindstrom16ae3d02001-07-04 04:02:36 +000049void log_init(char *, LogLevel, SyslogFacility, int);
Ben Lindstrom226cfa02001-01-22 05:34:40 +000050
51/* Logging implementation, depending on server or client */
Ben Lindstrom16ae3d02001-07-04 04:02:36 +000052void do_log(LogLevel, const char *, va_list);
Ben Lindstrom226cfa02001-01-22 05:34:40 +000053
54/* name to facility/level */
Ben Lindstrom16ae3d02001-07-04 04:02:36 +000055SyslogFacility log_facility_number(char *);
56LogLevel log_level_number(char *);
Ben Lindstrom226cfa02001-01-22 05:34:40 +000057
58/* Output a message to syslog or stderr */
Ben Lindstrom16ae3d02001-07-04 04:02:36 +000059void fatal(const char *, ...) __attribute__((format(printf, 1, 2)));
60void error(const char *, ...) __attribute__((format(printf, 1, 2)));
61void log(const char *, ...) __attribute__((format(printf, 1, 2)));
62void verbose(const char *, ...) __attribute__((format(printf, 1, 2)));
63void debug(const char *, ...) __attribute__((format(printf, 1, 2)));
64void debug2(const char *, ...) __attribute__((format(printf, 1, 2)));
65void debug3(const char *, ...) __attribute__((format(printf, 1, 2)));
Ben Lindstrom226cfa02001-01-22 05:34:40 +000066
67/* same as fatal() but w/o logging */
68void fatal_cleanup(void);
69
70/*
71 * Registers a cleanup function to be called by fatal()/fatal_cleanup()
72 * before exiting. It is permissible to call fatal_remove_cleanup for the
73 * function itself from the function.
74 */
Ben Lindstrom16ae3d02001-07-04 04:02:36 +000075void fatal_add_cleanup(void (*) (void *), void *);
Ben Lindstrom226cfa02001-01-22 05:34:40 +000076
77/* Removes a cleanup function to be called at fatal(). */
Ben Lindstrom16ae3d02001-07-04 04:02:36 +000078void fatal_remove_cleanup(void (*) (void *), void *);
Ben Lindstrom226cfa02001-01-22 05:34:40 +000079
80#endif