summaryrefslogtreecommitdiff
path: root/usr.sbin/syslogd/syslogd.h
blob: 5644dcaf2671db7c344005173aa4b2dff50d4715 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/*-
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 1983, 1988, 1993, 1994
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2018 Prodrive Technologies, https://prodrive-technologies.com/
 * Author: Ed Schouten <ed@FreeBSD.org>
 * Copyright (c) 2023 The FreeBSD Foundation
 *
 * This software was developed by Jake Freeland <jfree@FreeBSD.org>
 * under sponsorship from the FreeBSD Foundation.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _SYSLOGD_H_
#define _SYSLOGD_H_

#include <sys/param.h>
#include <sys/nv.h>
#include <sys/queue.h>
#include <sys/time.h>
#include <sys/uio.h>

#define SYSLOG_NAMES
#include <sys/syslog.h>

#include <regex.h>
#include <stdbool.h>
#include <stdio.h>

#include "ttymsg.h"

#define	MAXLINE		8192		/* maximum line length */
#define	MAXSVLINE	MAXLINE		/* maximum saved line length */
#define	MAXUNAMES	20		/* maximum number of user names */

/* Timestamps of log entries. */
struct logtime {
	struct tm	tm;
	suseconds_t	usec;
};

enum filt_proptype {
	FILT_PROP_NOOP,
	FILT_PROP_MSG,
	FILT_PROP_HOSTNAME,
	FILT_PROP_PROGNAME,
};

enum filt_cmptype {
	FILT_CMP_CONTAINS,
	FILT_CMP_EQUAL,
	FILT_CMP_STARTS,
	FILT_CMP_REGEX,
};

/*
 * This structure holds a property-based filter
 */
struct prop_filter {
	enum filt_proptype prop_type;
	enum filt_cmptype cmp_type;
	uint8_t cmp_flags;
#define	FILT_FLAG_EXCLUDE	(1 << 0)
#define	FILT_FLAG_EXTENDED	(1 << 1)
#define	FILT_FLAG_ICASE		(1 << 2)
	char *pflt_strval;
	regex_t *pflt_re;
};

enum f_type {
	F_UNUSED,	/* unused entry */
	F_FILE,		/* regular file */
	F_TTY,		/* terminal */
	F_CONSOLE,	/* console terminal */
	F_FORW,		/* remote machine */
	F_USERS,	/* list of users */
	F_WALL,		/* everyone logged on */
	F_PIPE,		/* pipe to program */
};

struct forw_addr {
	struct sockaddr_storage laddr;
	struct sockaddr_storage raddr;
};

/*
 * This structure represents the files that will have log
 * copies printed.
 * We require f_file to be valid if f_type is F_FILE, F_CONSOLE, F_TTY
 * or if f_type is F_PIPE and f_pid > 0.
 */
struct filed {
	enum f_type f_type;

	/* Used for filtering. */
	char	f_host[MAXHOSTNAMELEN];		/* host from which to recd. */
	char	f_program[MAXPATHLEN];		/* program this applies to */
	struct prop_filter *f_prop_filter;	/* property-based filter */
	u_char	f_pmask[LOG_NFACILITIES+1];	/* priority mask */
	u_char	f_pcmp[LOG_NFACILITIES+1];	/* compare priority */
#define PRI_LT	0x1
#define PRI_EQ	0x2
#define PRI_GT	0x4

	/* Logging destinations. */
	int	f_file;				/* file descriptor */
	int	f_flags;			/* file-specific flags */
#define	FFLAG_SYNC	0x01
#define	FFLAG_NEEDSYNC	0x02
	union {
		char	f_uname[MAXUNAMES][MAXLOGNAME];	/* F_WALL, F_USERS */
		char	f_fname[MAXPATHLEN];	/* F_FILE, F_CONSOLE, F_TTY */
		struct {
			char	f_hname[MAXHOSTNAMELEN];
			int	*f_addr_fds;
			size_t	f_num_addr_fds;
			struct forw_addr *f_addrs;
		};				/* F_FORW */
		struct {
			char	f_pname[MAXPATHLEN];
			int	f_procdesc;
			struct deadq_entry *f_dq;
		};				/* F_PIPE */
	};

	/* Book-keeping. */
	char	f_prevline[MAXSVLINE];		/* last message logged */
	time_t	f_time;				/* time this was last written */
	struct logtime f_lasttime;		/* time of last occurrence */
	int	f_prevpri;			/* pri of f_prevline */
	size_t	f_prevlen;			/* length of f_prevline */
	int	f_prevcount;			/* repetition cnt of prevline */
	u_int	f_repeatcount;			/* number of "repeated" msgs */
	STAILQ_ENTRY(filed) next;		/* next in linked list */
};

/*
 * List of iovecs to which entries can be appended.
 * Used for constructing the message to be logged.
 */
struct iovlist {
	struct iovec	iov[TTYMSG_IOV_MAX];
	size_t		iovcnt;
	size_t		totalsize;
};

extern const char *ConfFile;
extern char LocalHostName[MAXHOSTNAMELEN];

void closelogfiles(void);
void logerror(const char *);
int p_open(const char *, pid_t *);
nvlist_t *readconfigfile(const char *);
void wallmsg(const struct filed *, struct iovec *, const int);

#endif /* !_SYSLOGD_H_ */