xref: /freebsd/sys/bsm/audit.h (revision 87569f75a91f298c52a71823c04d41cf53c88889)
1 /*
2  * Copyright (c) 2005 Apple Computer, Inc.
3  * All rights reserved.
4  *
5  * @APPLE_BSD_LICENSE_HEADER_START@
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1.  Redistributions of source code must retain the above copyright
12  *     notice, this list of conditions and the following disclaimer.
13  * 2.  Redistributions in binary form must reproduce the above copyright
14  *     notice, this list of conditions and the following disclaimer in the
15  *     documentation and/or other materials provided with the distribution.
16  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
17  *     its contributors may be used to endorse or promote products derived
18  *     from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
21  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
24  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  *
31  * @APPLE_BSD_LICENSE_HEADER_END@
32  *
33  * $P4: //depot/projects/trustedbsd/audit3/sys/bsm/audit.h#24 $
34  * $FreeBSD$
35  */
36 
37 #ifndef _BSM_AUDIT_H
38 #define	_BSM_AUDIT_H
39 
40 #include <sys/param.h>
41 #include <sys/cdefs.h>
42 #include <sys/queue.h>
43 
44 #define	AUDIT_RECORD_MAGIC	0x828a0f1b
45 #define	MAX_AUDIT_RECORDS	20
46 #define	MAX_AUDIT_RECORD_SIZE	4096
47 #define	MIN_AUDIT_FILE_SIZE	(512 * 1024)
48 
49 /*
50  * Minimum noumber of free blocks on the filesystem containing the audit
51  * log necessary to avoid a hard log rotation. DO NOT SET THIS VALUE TO 0
52  * as the kernel does an unsigned compare, plus we want to leave a few blocks
53  * free so userspace can terminate the log, etc.
54  */
55 #define	AUDIT_HARD_LIMIT_FREE_BLOCKS	4
56 
57 /*
58  * Triggers for the audit daemon
59  */
60 #define	AUDIT_TRIGGER_MIN		1
61 #define	AUDIT_TRIGGER_LOW_SPACE		1
62 #define	AUDIT_TRIGGER_OPEN_NEW		2
63 #define	AUDIT_TRIGGER_READ_FILE		3
64 #define	AUDIT_TRIGGER_CLOSE_AND_DIE	4
65 #define	AUDIT_TRIGGER_NO_SPACE		5
66 #define	AUDIT_TRIGGER_MAX		5
67 
68 /*
69  * File that will be read for trigger events from the kernel.
70  */
71 #define	AUDIT_TRIGGER_FILE	"/dev/audit"
72 
73 /*
74  * The special device filename.
75  */
76 #define	AUDITDEV_FILENAME	"audit"
77 
78 /*
79  * Pre-defined audit IDs
80  */
81 #define	AU_DEFAUDITID	-1
82 
83 /*
84  * Define the masks for the classes of audit events.
85  */
86 #define	AU_NULL		0x00000000
87 #define	AU_FREAD	0x00000001
88 #define	AU_FWRITE	0x00000002
89 #define	AU_FACCESS	0x00000004
90 #define	AU_FMODIFY	0x00000008
91 #define	AU_FCREATE	0x00000010
92 #define	AU_FDELETE	0x00000020
93 #define	AU_CLOSE	0x00000040
94 #define	AU_PROCESS	0x00000080
95 #define	AU_NET		0x00000100
96 #define	AU_IPC		0x00000200
97 #define	AU_NONAT	0x00000400
98 #define	AU_ADMIN	0x00000800
99 #define	AU_LOGIN	0x00001000
100 #define	AU_TFM		0x00002000
101 #define	AU_APPL		0x00004000
102 #define	AU_SETL		0x00008000
103 #define	AU_IFLOAT	0x00010000
104 #define	AU_PRIV		0x00020000
105 #define	AU_MAC_RW	0x00040000
106 #define	AU_XCONN	0x00080000
107 #define	AU_XCREATE	0x00100000
108 #define	AU_XDELETE	0x00200000
109 #define	AU_XIFLOAT	0x00400000
110 #define	AU_XPRIVS	0x00800000
111 #define	AU_XPRIVF	0x01000000
112 #define	AU_XMOVE	0x02000000
113 #define	AU_XDACF	0x04000000
114 #define	AU_XMACF	0x08000000
115 #define	AU_XSECATTR	0x10000000
116 #define	AU_IOCTL	0x20000000
117 #define	AU_EXEC		0x40000000
118 #define	AU_OTHER	0x80000000
119 #define	AU_ALL		0xffffffff
120 
121 /*
122  * IPC types
123  */
124 #define	AT_IPC_MSG	((u_char)1)	/* Message IPC id. */
125 #define	AT_IPC_SEM	((u_char)2)	/* Semaphore IPC id. */
126 #define	AT_IPC_SHM	((u_char)3)	/* Shared mem IPC id. */
127 
128 /*
129  * Audit conditions.
130  */
131 #define	AUC_UNSET		0
132 #define	AUC_AUDITING		1
133 #define	AUC_NOAUDIT		2
134 #define	AUC_DISABLED		-1
135 
136 /*
137  * auditon(2) commands.
138  */
139 #define	A_GETPOLICY	2
140 #define	A_SETPOLICY	3
141 #define	A_GETKMASK	4
142 #define	A_SETKMASK	5
143 #define	A_GETQCTRL	6
144 #define	A_SETQCTRL	7
145 #define	A_GETCWD	8
146 #define	A_GETCAR	9
147 #define	A_GETSTAT	12
148 #define	A_SETSTAT	13
149 #define	A_SETUMASK	14
150 #define	A_SETSMASK	15
151 #define	A_GETCOND	20
152 #define	A_SETCOND	21
153 #define	A_GETCLASS	22
154 #define	A_SETCLASS	23
155 #define	A_GETPINFO	24
156 #define	A_SETPMASK	25
157 #define	A_SETFSIZE	26
158 #define	A_GETFSIZE	27
159 #define	A_GETPINFO_ADDR	28
160 #define	A_GETKAUDIT	29
161 #define	A_SETKAUDIT	30
162 #define	A_SENDTRIGGER	31
163 
164 /*
165  * Audit policy controls.
166  */
167 #define	AUDIT_CNT	0x0001
168 #define	AUDIT_AHLT	0x0002
169 #define	AUDIT_ARGV	0x0004
170 #define	AUDIT_ARGE	0x0008
171 #define	AUDIT_PASSWD	0x0010
172 #define	AUDIT_SEQ	0x0020
173 #define	AUDIT_WINDATA	0x0040
174 #define	AUDIT_USER	0x0080
175 #define	AUDIT_GROUP	0x0100
176 #define	AUDIT_TRAIL	0x0200
177 #define	AUDIT_PATH	0x0400
178 
179 /*
180  * Audit queue control parameters
181  */
182 #define	AQ_HIWATER	100
183 #define	AQ_MAXHIGH	10000
184 #define	AQ_LOWATER	10
185 #define	AQ_BUFSZ	1024
186 #define	AQ_MAXBUFSZ	1048576
187 
188 /*
189  * Default minimum percentage free space on file system.
190  */
191 #define	AU_FS_MINFREE	20
192 
193 /*
194  * Type definitions used indicating the length of variable length addresses
195  * in tokens containing addresses, such as header fields.
196  */
197 #define	AU_IPv4		4
198 #define	AU_IPv6		16
199 
200 __BEGIN_DECLS
201 
202 typedef	uid_t		au_id_t;
203 typedef	pid_t		au_asid_t;
204 typedef	u_int16_t	au_event_t;
205 typedef	u_int16_t	au_emod_t;
206 typedef	u_int32_t	au_class_t;
207 
208 struct au_tid {
209 	dev_t		port;
210 	u_int32_t	machine;
211 };
212 typedef	struct au_tid	au_tid_t;
213 
214 struct au_tid_addr {
215 	dev_t		at_port;
216 	u_int32_t	at_type;
217 	u_int32_t	at_addr[4];
218 };
219 typedef	struct au_tid_addr	au_tid_addr_t;
220 
221 struct au_mask {
222 	unsigned int    am_success;     /* Success bits. */
223 	unsigned int    am_failure;     /* Failure bits. */
224 };
225 typedef	struct au_mask	au_mask_t;
226 
227 struct auditinfo {
228 	au_id_t		ai_auid;	/* Audit user ID. */
229 	au_mask_t	ai_mask;	/* Audit masks. */
230 	au_tid_t	ai_termid;	/* Terminal ID. */
231 	au_asid_t	ai_asid;	/* Audit session ID. */
232 };
233 typedef	struct auditinfo	auditinfo_t;
234 
235 struct auditinfo_addr {
236 	au_id_t		ai_auid;	/* Audit user ID. */
237 	au_mask_t	ai_mask;	/* Audit masks. */
238 	au_tid_addr_t	ai_termid;	/* Terminal ID. */
239 	au_asid_t	ai_asid;	/* Audit session ID. */
240 };
241 typedef	struct auditinfo_addr	auditinfo_addr_t;
242 
243 struct auditpinfo {
244 	pid_t		ap_pid;		/* ID of target process. */
245 	au_id_t		ap_auid;	/* Audit user ID. */
246 	au_mask_t	ap_mask;	/* Audit masks. */
247 	au_tid_t	ap_termid;	/* Terminal ID. */
248 	au_asid_t	ap_asid;	/* Audit session ID. */
249 };
250 typedef	struct auditpinfo	auditpinfo_t;
251 
252 struct auditpinfo_addr {
253 	pid_t		ap_pid;		/* ID of target process. */
254 	au_id_t		ap_auid;	/* Audit user ID. */
255 	au_mask_t	ap_mask;	/* Audit masks. */
256 	au_tid_addr_t	ap_termid;	/* Terminal ID. */
257 	au_asid_t	ap_asid;	/* Audit session ID. */
258 };
259 typedef	struct auditpinfo_addr	auditpinfo_addr_t;
260 
261 /*
262  * Contents of token_t are opaque outside of libbsm.
263  */
264 typedef	struct au_token	token_t;
265 
266 /*
267  * Kernel audit queue control parameters.
268  */
269 struct au_qctrl {
270 	size_t	aq_hiwater;
271 	size_t	aq_lowater;
272 	size_t	aq_bufsz;
273 	clock_t	aq_delay;
274 	int	aq_minfree;	/* Minimum filesystem percent free space. */
275 };
276 typedef	struct au_qctrl	au_qctrl_t;
277 
278 /*
279  * Structure for the audit statistics.
280  */
281 struct audit_stat {
282 	unsigned int	as_version;
283 	unsigned int	as_numevent;
284 	int		as_generated;
285 	int		as_nonattring;
286 	int		as_kernel;
287 	int		as_audit;
288 	int		as_auditctl;
289 	int		as_enqueu;
290 	int		as_written;
291 	int		as_wblocked;
292 	int		as_rblocked;
293 	int		as_dropped;
294 	int		as_totalsize;
295 	unsigned int	as_memused;
296 };
297 typedef	struct audit_stat	au_stat_t;
298 
299 /*
300  * Structure for the audit file statistics.
301  */
302 struct audit_fstat {
303 	u_quad_t	af_filesz;
304 	u_quad_t	af_currsz;
305 };
306 typedef	struct audit_fstat	au_fstat_t;
307 
308 /*
309  * Audit to event class mapping.
310  */
311 struct au_evclass_map {
312 	au_event_t	ec_number;
313 	au_class_t	ec_class;
314 };
315 typedef	struct au_evclass_map	au_evclass_map_t;
316 
317 /*
318  * Audit system calls.
319  */
320 #if !defined(_KERNEL) && !defined(KERNEL)
321 int	audit(const void *, int);
322 int	auditon(int, void *, int);
323 int	auditctl(const char *);
324 int	getauid(au_id_t *);
325 int	setauid(const au_id_t *);
326 int	getaudit(struct auditinfo *);
327 int	setaudit(const struct auditinfo *);
328 int	getaudit_addr(struct auditinfo_addr *, int);
329 int	setaudit_addr(const struct auditinfo_addr *, int);
330 #endif /* defined(_KERNEL) || defined(KERNEL) */
331 
332 __END_DECLS
333 
334 #endif /* !_BSM_AUDIT_H */
335