1/* $NetBSD: log.h,v 1.17 2021/04/19 14:40:15 christos Exp $ */ 2/* $OpenBSD: log.h,v 1.33 2021/04/15 16:24:31 markus Exp $ */ 3 4/* 5 * Author: Tatu Ylonen <ylo@cs.hut.fi> 6 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 7 * All rights reserved 8 * 9 * As far as I am concerned, the code I have written for this software 10 * can be used freely for any purpose. Any derived versions of this 11 * software must be clearly marked as such, and if the derived work is 12 * incompatible with the protocol description in the RFC file, it must be 13 * called by a name other than "ssh" or "Secure Shell". 14 */ 15 16#ifndef SSH_LOG_H 17#define SSH_LOG_H 18 19#include <stdarg.h> /* va_list */ 20#include "ssherr.h" /* ssh_err() */ 21 22/* Supported syslog facilities and levels. */ 23typedef enum { 24 SYSLOG_FACILITY_DAEMON, 25 SYSLOG_FACILITY_USER, 26 SYSLOG_FACILITY_AUTH, 27 SYSLOG_FACILITY_LOCAL0, 28 SYSLOG_FACILITY_LOCAL1, 29 SYSLOG_FACILITY_LOCAL2, 30 SYSLOG_FACILITY_LOCAL3, 31 SYSLOG_FACILITY_LOCAL4, 32 SYSLOG_FACILITY_LOCAL5, 33 SYSLOG_FACILITY_LOCAL6, 34 SYSLOG_FACILITY_LOCAL7, 35 SYSLOG_FACILITY_NOT_SET = -1 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 SYSLOG_LEVEL_NOT_SET = -1 48} LogLevel; 49 50typedef void (log_handler_fn)(LogLevel, int, const char *, void *); 51 52void log_init(const char *, LogLevel, SyslogFacility, int); 53LogLevel log_level_get(void); 54int log_change_level(LogLevel); 55int log_is_on_stderr(void); 56void log_redirect_stderr_to(const char *); 57void log_verbose_add(const char *); 58void log_verbose_reset(void); 59 60SyslogFacility log_facility_number(char *); 61const char * log_facility_name(SyslogFacility); 62LogLevel log_level_number(char *); 63const char * log_level_name(LogLevel); 64 65void set_log_handler(log_handler_fn *, void *); 66void cleanup_exit(int) __attribute__((noreturn)); 67 68void sshlog(const char *, const char *, int, int, 69 LogLevel, const char *, const char *, ...) 70 __attribute__((format(printf, 7, 8))); 71void sshlogv(const char *, const char *, int, int, 72 LogLevel, const char *, const char *, va_list); 73void sshsigdie(const char *, const char *, int, int, 74 LogLevel, const char *, const char *, ...) __attribute__((noreturn)) 75 __attribute__((format(printf, 7, 8))); 76void sshlogdie(const char *, const char *, int, int, 77 LogLevel, const char *, const char *, ...) __attribute__((noreturn)) 78 __attribute__((format(printf, 7, 8))); 79void sshfatal(const char *, const char *, int, int, 80 LogLevel, const char *, const char *, ...) __attribute__((noreturn)) 81 __attribute__((format(printf, 7, 8))); 82void sshlogdirect(LogLevel, int, const char *, ...) 83 __attribute__((format(printf, 3, 4))); 84 85#define do_log2(level, ...) sshlog(__FILE__, __func__, __LINE__, 0, level, NULL, __VA_ARGS__) 86#define debug3(...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_DEBUG3, NULL, __VA_ARGS__) 87#define debug2(...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_DEBUG2, NULL, __VA_ARGS__) 88#define debug(...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_DEBUG1, NULL, __VA_ARGS__) 89#define verbose(...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_VERBOSE, NULL, __VA_ARGS__) 90#define logit(...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_INFO, NULL, __VA_ARGS__) 91#define error(...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_ERROR, NULL, __VA_ARGS__) 92#define fatal(...) sshfatal(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_FATAL, NULL, __VA_ARGS__) 93#define logdie(...) sshlogdie(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_ERROR, NULL, __VA_ARGS__) 94#define sigdie(...) sshsigdie(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_ERROR, NULL, __VA_ARGS__) 95 96/* Variants that prepend the caller's function */ 97#define do_log2_f(level, ...) sshlog(__FILE__, __func__, __LINE__, 1, level, NULL, __VA_ARGS__) 98#define debug3_f(...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_DEBUG3, NULL, __VA_ARGS__) 99#define debug2_f(...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_DEBUG2, NULL, __VA_ARGS__) 100#define debug_f(...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_DEBUG1, NULL, __VA_ARGS__) 101#define verbose_f(...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_VERBOSE, NULL, __VA_ARGS__) 102#define logit_f(...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_INFO, NULL, __VA_ARGS__) 103#define error_f(...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_ERROR, NULL, __VA_ARGS__) 104#define fatal_f(...) sshfatal(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_FATAL, NULL, __VA_ARGS__) 105#define logdie_f(...) sshlogdie(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_ERROR, NULL, __VA_ARGS__) 106#define sigdie_f(...) sshsigdie(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_ERROR, NULL, __VA_ARGS__) 107 108/* Variants that appends a ssh_err message */ 109#define do_log2_r(r, level, ...) sshlog(__FILE__, __func__, __LINE__, 0, level, ssh_err(r), __VA_ARGS__) 110#define debug3_r(r, ...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_DEBUG3, ssh_err(r), __VA_ARGS__) 111#define debug2_r(r, ...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_DEBUG2, ssh_err(r), __VA_ARGS__) 112#define debug_r(r, ...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_DEBUG1, ssh_err(r), __VA_ARGS__) 113#define verbose_r(r, ...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_VERBOSE, ssh_err(r), __VA_ARGS__) 114#define logit_r(r, ...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_INFO, ssh_err(r), __VA_ARGS__) 115#define error_r(r, ...) sshlog(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_ERROR, ssh_err(r), __VA_ARGS__) 116#define fatal_r(r, ...) sshfatal(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_FATAL, ssh_err(r), __VA_ARGS__) 117#define logdie_r(r, ...) sshlogdie(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_ERROR, ssh_err(r), __VA_ARGS__) 118#define sigdie_r(r, ...) sshsigdie(__FILE__, __func__, __LINE__, 0, SYSLOG_LEVEL_ERROR, ssh_err(r), __VA_ARGS__) 119#define do_log2_fr(r, level, ...) sshlog(__FILE__, __func__, __LINE__, 1, level, ssh_err(r), __VA_ARGS__) 120#define debug3_fr(r, ...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_DEBUG3, ssh_err(r), __VA_ARGS__) 121#define debug2_fr(r, ...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_DEBUG2, ssh_err(r), __VA_ARGS__) 122#define debug_fr(r, ...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_DEBUG1, ssh_err(r), __VA_ARGS__) 123#define verbose_fr(r, ...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_VERBOSE, ssh_err(r), __VA_ARGS__) 124#define logit_fr(r, ...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_INFO, ssh_err(r), __VA_ARGS__) 125#define error_fr(r, ...) sshlog(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_ERROR, ssh_err(r), __VA_ARGS__) 126#define fatal_fr(r, ...) sshfatal(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_FATAL, ssh_err(r), __VA_ARGS__) 127#define logdie_fr(r, ...) sshlogdie(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_ERROR, ssh_err(r), __VA_ARGS__) 128#define sigdie_fr(r, ...) sshsigdie(__FILE__, __func__, __LINE__, 1, SYSLOG_LEVEL_ERROR, ssh_err(r), __VA_ARGS__) 129 130#endif 131