xref: /freebsd/crypto/openssh/log.h (revision 09d325677d53a12c79a43664ff29871e92247629)
1 /* $OpenBSD: log.h,v 1.20 2013/04/07 02:10:33 dtucker 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 #ifdef LOG_AUTHPRIV
24 	SYSLOG_FACILITY_AUTHPRIV,
25 #endif
26 	SYSLOG_FACILITY_LOCAL0,
27 	SYSLOG_FACILITY_LOCAL1,
28 	SYSLOG_FACILITY_LOCAL2,
29 	SYSLOG_FACILITY_LOCAL3,
30 	SYSLOG_FACILITY_LOCAL4,
31 	SYSLOG_FACILITY_LOCAL5,
32 	SYSLOG_FACILITY_LOCAL6,
33 	SYSLOG_FACILITY_LOCAL7,
34 	SYSLOG_FACILITY_NOT_SET = -1
35 }       SyslogFacility;
36 
37 typedef enum {
38 	SYSLOG_LEVEL_QUIET,
39 	SYSLOG_LEVEL_FATAL,
40 	SYSLOG_LEVEL_ERROR,
41 	SYSLOG_LEVEL_INFO,
42 	SYSLOG_LEVEL_VERBOSE,
43 	SYSLOG_LEVEL_DEBUG1,
44 	SYSLOG_LEVEL_DEBUG2,
45 	SYSLOG_LEVEL_DEBUG3,
46 	SYSLOG_LEVEL_NOT_SET = -1
47 }       LogLevel;
48 
49 typedef void (log_handler_fn)(LogLevel, const char *, void *);
50 
51 void     log_init(char *, LogLevel, SyslogFacility, int);
52 void     log_change_level(LogLevel);
53 int      log_is_on_stderr(void);
54 void     log_redirect_stderr_to(const char *);
55 
56 SyslogFacility	log_facility_number(char *);
57 const char * 	log_facility_name(SyslogFacility);
58 LogLevel	log_level_number(char *);
59 const char *	log_level_name(LogLevel);
60 
61 void     fatal(const char *, ...) __attribute__((noreturn))
62     __attribute__((format(printf, 1, 2)));
63 void     error(const char *, ...) __attribute__((format(printf, 1, 2)));
64 void     sigdie(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