xref: /openbsd-src/usr.bin/ssh/log.h (revision d1df930ffab53da22f3324c32bed7ac5709915e6)
1 /* $OpenBSD: log.h,v 1.23 2018/07/27 12:03:17 markus Exp $ */
2 
3 /*
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 
18 /* Supported syslog facilities and levels. */
19 typedef enum {
20 	SYSLOG_FACILITY_DAEMON,
21 	SYSLOG_FACILITY_USER,
22 	SYSLOG_FACILITY_AUTH,
23 	SYSLOG_FACILITY_LOCAL0,
24 	SYSLOG_FACILITY_LOCAL1,
25 	SYSLOG_FACILITY_LOCAL2,
26 	SYSLOG_FACILITY_LOCAL3,
27 	SYSLOG_FACILITY_LOCAL4,
28 	SYSLOG_FACILITY_LOCAL5,
29 	SYSLOG_FACILITY_LOCAL6,
30 	SYSLOG_FACILITY_LOCAL7,
31 	SYSLOG_FACILITY_NOT_SET = -1
32 }       SyslogFacility;
33 
34 typedef enum {
35 	SYSLOG_LEVEL_QUIET,
36 	SYSLOG_LEVEL_FATAL,
37 	SYSLOG_LEVEL_ERROR,
38 	SYSLOG_LEVEL_INFO,
39 	SYSLOG_LEVEL_VERBOSE,
40 	SYSLOG_LEVEL_DEBUG1,
41 	SYSLOG_LEVEL_DEBUG2,
42 	SYSLOG_LEVEL_DEBUG3,
43 	SYSLOG_LEVEL_NOT_SET = -1
44 }       LogLevel;
45 
46 typedef void (log_handler_fn)(LogLevel, const char *, void *);
47 
48 void     log_init(char *, LogLevel, SyslogFacility, int);
49 LogLevel log_level_get(void);
50 int      log_change_level(LogLevel);
51 int      log_is_on_stderr(void);
52 void     log_redirect_stderr_to(const char *);
53 
54 SyslogFacility	log_facility_number(char *);
55 const char * 	log_facility_name(SyslogFacility);
56 LogLevel	log_level_number(char *);
57 const char *	log_level_name(LogLevel);
58 
59 void     fatal(const char *, ...) __attribute__((noreturn))
60     __attribute__((format(printf, 1, 2)));
61 void     error(const char *, ...) __attribute__((format(printf, 1, 2)));
62 void     sigdie(const char *, ...)  __attribute__((noreturn))
63     __attribute__((format(printf, 1, 2)));
64 void     logdie(const char *, ...) __attribute__((noreturn))
65     __attribute__((format(printf, 1, 2)));
66 void     logit(const char *, ...) __attribute__((format(printf, 1, 2)));
67 void     verbose(const char *, ...) __attribute__((format(printf, 1, 2)));
68 void     debug(const char *, ...) __attribute__((format(printf, 1, 2)));
69 void     debug2(const char *, ...) __attribute__((format(printf, 1, 2)));
70 void     debug3(const char *, ...) __attribute__((format(printf, 1, 2)));
71 
72 
73 void	 set_log_handler(log_handler_fn *, void *);
74 void	 do_log2(LogLevel, const char *, ...)
75     __attribute__((format(printf, 2, 3)));
76 void	 do_log(LogLevel, const char *, va_list);
77 void	 cleanup_exit(int) __attribute__((noreturn));
78 #endif
79