1 /* $OpenBSD: log.h,v 1.35 2024/12/07 10:05:37 djm 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 #include <stdarg.h> /* va_list */ 19 #include "ssherr.h" /* ssh_err() */ 20 21 /* Supported syslog facilities and levels. */ 22 typedef enum { 23 SYSLOG_FACILITY_DAEMON, 24 SYSLOG_FACILITY_USER, 25 SYSLOG_FACILITY_AUTH, 26 #ifdef LOG_AUTHPRIV 27 SYSLOG_FACILITY_AUTHPRIV, 28 #endif 29 SYSLOG_FACILITY_LOCAL0, 30 SYSLOG_FACILITY_LOCAL1, 31 SYSLOG_FACILITY_LOCAL2, 32 SYSLOG_FACILITY_LOCAL3, 33 SYSLOG_FACILITY_LOCAL4, 34 SYSLOG_FACILITY_LOCAL5, 35 SYSLOG_FACILITY_LOCAL6, 36 SYSLOG_FACILITY_LOCAL7, 37 SYSLOG_FACILITY_NOT_SET = -1 38 } SyslogFacility; 39 40 typedef enum { 41 SYSLOG_LEVEL_QUIET, 42 SYSLOG_LEVEL_FATAL, 43 SYSLOG_LEVEL_ERROR, 44 SYSLOG_LEVEL_INFO, 45 SYSLOG_LEVEL_VERBOSE, 46 SYSLOG_LEVEL_DEBUG1, 47 SYSLOG_LEVEL_DEBUG2, 48 SYSLOG_LEVEL_DEBUG3, 49 SYSLOG_LEVEL_NOT_SET = -1 50 } LogLevel; 51 52 typedef void (log_handler_fn)(LogLevel, int, const char *, void *); 53 54 void log_init(const char *, LogLevel, SyslogFacility, int); 55 LogLevel log_level_get(void); 56 int log_change_level(LogLevel); 57 int log_is_on_stderr(void); 58 void log_redirect_stderr_to(const char *); 59 void log_verbose_add(const char *); 60 void log_verbose_reset(void); 61 62 SyslogFacility log_facility_number(char *); 63 const char * log_facility_name(SyslogFacility); 64 LogLevel log_level_number(char *); 65 const char * log_level_name(LogLevel); 66 67 void set_log_handler(log_handler_fn *, void *); 68 void cleanup_exit(int) __attribute__((noreturn)); 69 70 void sshlog(const char *, const char *, int, int, 71 LogLevel, const char *, const char *, ...) 72 __attribute__((format(printf, 7, 8))); 73 void sshlogv(const char *, const char *, int, int, 74 LogLevel, const char *, const char *, va_list); 75 void sshlogdie(const char *, const char *, int, int, 76 LogLevel, const char *, const char *, ...) __attribute__((noreturn)) 77 __attribute__((format(printf, 7, 8))); 78 void sshfatal(const char *, const char *, int, int, 79 LogLevel, const char *, const char *, ...) __attribute__((noreturn)) 80 __attribute__((format(printf, 7, 8))); 81 void sshlogdirect(LogLevel, int, const char *, ...) 82 __attribute__((format(printf, 3, 4))); 83 84 struct log_ratelimit_ctx { 85 /* configuration */ 86 u_int threshold; /* events per second */ 87 u_int max_accum; /* max events to accumulate */ 88 u_int hysteresis; /* seconds */ 89 u_int log_every; /* seconds */ 90 91 /* state */ 92 time_t last_event; 93 u_int accumulated_events; /* used for threshold comparisons */ 94 95 /* state while actively rate-limiting */ 96 int ratelimit_active; 97 time_t ratelimit_start; 98 time_t last_log; 99 time_t hysteresis_start; 100 u_int ratelimited_events; 101 }; 102 103 void log_ratelimit_init(struct log_ratelimit_ctx *rl, u_int threshold, 104 u_int max_accum, u_int hysteresis, u_int log_every); 105 int log_ratelimit(struct log_ratelimit_ctx *rl, time_t now, int *active, 106 u_int *events_dropped); 107 108 #define do_log2(level, ...) sshlog(__FILE__, __func__, __LINE__, 0, level, NULL, __VA_ARGS__) 109 #define debug3(...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_DEBUG3, NULL, __VA_ARGS__) 110 #define debug2(...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_DEBUG2, NULL, __VA_ARGS__) 111 #define debug(...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_DEBUG1, NULL, __VA_ARGS__) 112 #define verbose(...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_VERBOSE, NULL, __VA_ARGS__) 113 #define logit(...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_INFO, NULL, __VA_ARGS__) 114 #define error(...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_ERROR, NULL, __VA_ARGS__) 115 #define fatal(...) sshfatal(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_FATAL, NULL, __VA_ARGS__) 116 #define logdie(...) sshlogdie(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_ERROR, NULL, __VA_ARGS__) 117 118 /* Variants that prepend the caller's function */ 119 #define do_log2_f(level, ...) sshlog(__FILE__, __func__, __LINE__, 1, level, NULL, __VA_ARGS__) 120 #define debug3_f(...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_DEBUG3, NULL, __VA_ARGS__) 121 #define debug2_f(...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_DEBUG2, NULL, __VA_ARGS__) 122 #define debug_f(...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_DEBUG1, NULL, __VA_ARGS__) 123 #define verbose_f(...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_VERBOSE, NULL, __VA_ARGS__) 124 #define logit_f(...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_INFO, NULL, __VA_ARGS__) 125 #define error_f(...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_ERROR, NULL, __VA_ARGS__) 126 #define fatal_f(...) sshfatal(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_FATAL, NULL, __VA_ARGS__) 127 #define logdie_f(...) sshlogdie(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_ERROR, NULL, __VA_ARGS__) 128 129 /* Variants that appends a ssh_err message */ 130 #define do_log2_r(r, level, ...) sshlog(__FILE__, __func__, __LINE__, 0, level, ssh_err(r), __VA_ARGS__) 131 #define debug3_r(r, ...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_DEBUG3, ssh_err(r), __VA_ARGS__) 132 #define debug2_r(r, ...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_DEBUG2, ssh_err(r), __VA_ARGS__) 133 #define debug_r(r, ...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_DEBUG1, ssh_err(r), __VA_ARGS__) 134 #define verbose_r(r, ...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_VERBOSE, ssh_err(r), __VA_ARGS__) 135 #define logit_r(r, ...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_INFO, ssh_err(r), __VA_ARGS__) 136 #define error_r(r, ...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_ERROR, ssh_err(r), __VA_ARGS__) 137 #define fatal_r(r, ...) sshfatal(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_FATAL, ssh_err(r), __VA_ARGS__) 138 #define logdie_r(r, ...) sshlogdie(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_ERROR, ssh_err(r), __VA_ARGS__) 139 #define do_log2_fr(r, level, ...) sshlog(__FILE__, __func__, __LINE__, 1, level, ssh_err(r), __VA_ARGS__) 140 #define debug3_fr(r, ...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_DEBUG3, ssh_err(r), __VA_ARGS__) 141 #define debug2_fr(r, ...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_DEBUG2, ssh_err(r), __VA_ARGS__) 142 #define debug_fr(r, ...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_DEBUG1, ssh_err(r), __VA_ARGS__) 143 #define verbose_fr(r, ...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_VERBOSE, ssh_err(r), __VA_ARGS__) 144 #define logit_fr(r, ...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_INFO, ssh_err(r), __VA_ARGS__) 145 #define error_fr(r, ...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_ERROR, ssh_err(r), __VA_ARGS__) 146 #define fatal_fr(r, ...) sshfatal(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_FATAL, ssh_err(r), __VA_ARGS__) 147 #define logdie_fr(r, ...) sshlogdie(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_ERROR, ssh_err(r), __VA_ARGS__) 148 149 #endif 150