[PATCH] Minor cosmetic cleanups to the code moved into auditfilter.c
[linux-block.git] / include / linux / audit.h
CommitLineData
85c8721f 1/* audit.h -- Auditing support
1da177e4
LT
2 *
3 * Copyright 2003-2004 Red Hat Inc., Durham, North Carolina.
4 * All Rights Reserved.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 * Written by Rickard E. (Rik) Faith <faith@redhat.com>
21 *
22 */
23
24#ifndef _LINUX_AUDIT_H_
25#define _LINUX_AUDIT_H_
26
2fd6f58b 27#include <linux/sched.h>
28#include <linux/elf.h>
29
c0404993
SG
30/* The netlink messages for the audit system is divided into blocks:
31 * 1000 - 1099 are for commanding the audit system
32 * 1100 - 1199 user space trusted application messages
33 * 1200 - 1299 messages internal to the audit daemon
34 * 1300 - 1399 audit event messages
35 * 1400 - 1499 SE Linux use
90d526c0
SG
36 * 1500 - 1599 kernel LSPP events
37 * 1600 - 1699 kernel crypto events
38 * 1700 - 1999 future kernel use (maybe integrity labels and related events)
39 * 2000 is for otherwise unclassified kernel audit messages (legacy)
40 * 2001 - 2099 unused (kernel)
41 * 2100 - 2199 user space anomaly records
42 * 2200 - 2299 user space actions taken in response to anomalies
43 * 2300 - 2399 user space generated LSPP events
44 * 2400 - 2499 user space crypto events
45 * 2500 - 2999 future user space (maybe integrity labels and related events)
c0404993 46 *
90d526c0
SG
47 * Messages from 1000-1199 are bi-directional. 1200-1299 & 2100 - 2999 are
48 * exclusively user space. 1300-2099 is kernel --> user space
49 * communication.
c0404993 50 */
c2f0c7c3
SG
51#define AUDIT_GET 1000 /* Get status */
52#define AUDIT_SET 1001 /* Set status (enable/disable/auditd) */
c0404993
SG
53#define AUDIT_LIST 1002 /* List syscall filtering rules */
54#define AUDIT_ADD 1003 /* Add syscall filtering rule */
55#define AUDIT_DEL 1004 /* Delete syscall filtering rule */
56#define AUDIT_USER 1005 /* Message from userspace -- deprecated */
c2f0c7c3 57#define AUDIT_LOGIN 1006 /* Define the login id and information */
c0404993
SG
58#define AUDIT_WATCH_INS 1007 /* Insert file/dir watch entry */
59#define AUDIT_WATCH_REM 1008 /* Remove file/dir watch entry */
60#define AUDIT_WATCH_LIST 1009 /* List all file/dir watches */
61#define AUDIT_SIGNAL_INFO 1010 /* Get info about sender of signal to auditd */
62
4a4cd633
DW
63#define AUDIT_FIRST_USER_MSG 1100 /* Userspace messages mostly uninteresting to kernel */
64#define AUDIT_USER_AVC 1107 /* We filter this differently */
209aba03 65#define AUDIT_LAST_USER_MSG 1199
90d526c0
SG
66#define AUDIT_FIRST_USER_MSG2 2100 /* More user space messages */
67#define AUDIT_LAST_USER_MSG2 2999
c0404993
SG
68
69#define AUDIT_DAEMON_START 1200 /* Daemon startup record */
70#define AUDIT_DAEMON_END 1201 /* Daemon normal stop record */
71#define AUDIT_DAEMON_ABORT 1202 /* Daemon error stop record */
72#define AUDIT_DAEMON_CONFIG 1203 /* Daemon config change */
73
74#define AUDIT_SYSCALL 1300 /* Syscall event */
75#define AUDIT_FS_WATCH 1301 /* Filesystem watch event */
8f37d47c 76#define AUDIT_PATH 1302 /* Filename path information */
c0404993 77#define AUDIT_IPC 1303 /* IPC record */
3ec3b2fb 78#define AUDIT_SOCKETCALL 1304 /* sys_socketcall arguments */
c0404993 79#define AUDIT_CONFIG_CHANGE 1305 /* Audit system configuration change */
3ec3b2fb 80#define AUDIT_SOCKADDR 1306 /* sockaddr copied as syscall arg */
8f37d47c 81#define AUDIT_CWD 1307 /* Current working directory */
c0404993
SG
82
83#define AUDIT_AVC 1400 /* SE Linux avc denial or grant */
84#define AUDIT_SELINUX_ERR 1401 /* Internal SE Linux Errors */
01116105 85#define AUDIT_AVC_PATH 1402 /* dentry, vfsmount pair from avc */
c2f0c7c3
SG
86
87#define AUDIT_KERNEL 2000 /* Asynchronous audit record. NOT A REQUEST. */
1da177e4
LT
88
89/* Rule flags */
0f45aa18
DW
90#define AUDIT_FILTER_USER 0x00 /* Apply rule to user-generated messages */
91#define AUDIT_FILTER_TASK 0x01 /* Apply rule at task creation (not syscall) */
92#define AUDIT_FILTER_ENTRY 0x02 /* Apply rule at syscall entry */
93#define AUDIT_FILTER_WATCH 0x03 /* Apply rule to file system watches */
94#define AUDIT_FILTER_EXIT 0x04 /* Apply rule at syscall exit */
c8edc80c 95#define AUDIT_FILTER_TYPE 0x05 /* Apply rule at audit_log_start */
0f45aa18 96
c8edc80c 97#define AUDIT_NR_FILTERS 6
0f45aa18
DW
98
99#define AUDIT_FILTER_PREPEND 0x10 /* Prepend to front of list */
1da177e4
LT
100
101/* Rule actions */
102#define AUDIT_NEVER 0 /* Do not build context if rule matches */
103#define AUDIT_POSSIBLE 1 /* Build context if rule matches */
104#define AUDIT_ALWAYS 2 /* Generate audit record if rule matches */
105
106/* Rule structure sizes -- if these change, different AUDIT_ADD and
107 * AUDIT_LIST commands must be implemented. */
108#define AUDIT_MAX_FIELDS 64
109#define AUDIT_BITMASK_SIZE 64
110#define AUDIT_WORD(nr) ((__u32)((nr)/32))
111#define AUDIT_BIT(nr) (1 << ((nr) - AUDIT_WORD(nr)*32))
112
b63862f4
DK
113/* This bitmask is used to validate user input. It represents all bits that
114 * are currently used in an audit field constant understood by the kernel.
115 * If you are adding a new #define AUDIT_<whatever>, please ensure that
116 * AUDIT_UNUSED_BITS is updated if need be. */
117#define AUDIT_UNUSED_BITS 0x0FFFFC00
118
119
1da177e4
LT
120/* Rule fields */
121 /* These are useful when checking the
122 * task structure at task creation time
123 * (AUDIT_PER_TASK). */
124#define AUDIT_PID 0
125#define AUDIT_UID 1
126#define AUDIT_EUID 2
127#define AUDIT_SUID 3
128#define AUDIT_FSUID 4
129#define AUDIT_GID 5
130#define AUDIT_EGID 6
131#define AUDIT_SGID 7
132#define AUDIT_FSGID 8
133#define AUDIT_LOGINUID 9
134#define AUDIT_PERS 10
2fd6f58b 135#define AUDIT_ARCH 11
c8edc80c 136#define AUDIT_MSGTYPE 12
1da177e4
LT
137
138 /* These are ONLY useful when checking
139 * at syscall exit time (AUDIT_AT_EXIT). */
140#define AUDIT_DEVMAJOR 100
141#define AUDIT_DEVMINOR 101
142#define AUDIT_INODE 102
143#define AUDIT_EXIT 103
144#define AUDIT_SUCCESS 104 /* exit >= 0; value ignored */
145
146#define AUDIT_ARG0 200
147#define AUDIT_ARG1 (AUDIT_ARG0+1)
148#define AUDIT_ARG2 (AUDIT_ARG0+2)
149#define AUDIT_ARG3 (AUDIT_ARG0+3)
150
b63862f4
DK
151#define AUDIT_NEGATE 0x80000000
152
153/* These are the supported operators.
154 * 4 2 1
155 * = > <
156 * -------
157 * 0 0 0 0 nonsense
158 * 0 0 1 1 <
159 * 0 1 0 2 >
160 * 0 1 1 3 !=
161 * 1 0 0 4 =
162 * 1 0 1 5 <=
163 * 1 1 0 6 >=
164 * 1 1 1 7 all operators
165 */
166#define AUDIT_LESS_THAN 0x10000000
167#define AUDIT_GREATER_THAN 0x20000000
168#define AUDIT_NOT_EQUAL 0x30000000
169#define AUDIT_EQUAL 0x40000000
170#define AUDIT_LESS_THAN_OR_EQUAL (AUDIT_LESS_THAN|AUDIT_EQUAL)
171#define AUDIT_GREATER_THAN_OR_EQUAL (AUDIT_GREATER_THAN|AUDIT_EQUAL)
172#define AUDIT_OPERATORS (AUDIT_EQUAL|AUDIT_NOT_EQUAL)
1da177e4
LT
173
174/* Status symbols */
175 /* Mask values */
176#define AUDIT_STATUS_ENABLED 0x0001
177#define AUDIT_STATUS_FAILURE 0x0002
178#define AUDIT_STATUS_PID 0x0004
179#define AUDIT_STATUS_RATE_LIMIT 0x0008
180#define AUDIT_STATUS_BACKLOG_LIMIT 0x0010
181 /* Failure-to-log actions */
182#define AUDIT_FAIL_SILENT 0
183#define AUDIT_FAIL_PRINTK 1
184#define AUDIT_FAIL_PANIC 2
185
2fd6f58b 186/* distinguish syscall tables */
187#define __AUDIT_ARCH_64BIT 0x80000000
188#define __AUDIT_ARCH_LE 0x40000000
189#define AUDIT_ARCH_ALPHA (EM_ALPHA|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
190#define AUDIT_ARCH_ARM (EM_ARM|__AUDIT_ARCH_LE)
191#define AUDIT_ARCH_ARMEB (EM_ARM)
192#define AUDIT_ARCH_CRIS (EM_CRIS|__AUDIT_ARCH_LE)
193#define AUDIT_ARCH_FRV (EM_FRV)
194#define AUDIT_ARCH_H8300 (EM_H8_300)
195#define AUDIT_ARCH_I386 (EM_386|__AUDIT_ARCH_LE)
196#define AUDIT_ARCH_IA64 (EM_IA_64|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
197#define AUDIT_ARCH_M32R (EM_M32R)
198#define AUDIT_ARCH_M68K (EM_68K)
199#define AUDIT_ARCH_MIPS (EM_MIPS)
200#define AUDIT_ARCH_MIPSEL (EM_MIPS|__AUDIT_ARCH_LE)
201#define AUDIT_ARCH_MIPS64 (EM_MIPS|__AUDIT_ARCH_64BIT)
202#define AUDIT_ARCH_MIPSEL64 (EM_MIPS|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
203#define AUDIT_ARCH_PARISC (EM_PARISC)
204#define AUDIT_ARCH_PARISC64 (EM_PARISC|__AUDIT_ARCH_64BIT)
205#define AUDIT_ARCH_PPC (EM_PPC)
206#define AUDIT_ARCH_PPC64 (EM_PPC64|__AUDIT_ARCH_64BIT)
207#define AUDIT_ARCH_S390 (EM_S390)
208#define AUDIT_ARCH_S390X (EM_S390|__AUDIT_ARCH_64BIT)
209#define AUDIT_ARCH_SH (EM_SH)
210#define AUDIT_ARCH_SHEL (EM_SH|__AUDIT_ARCH_LE)
211#define AUDIT_ARCH_SH64 (EM_SH|__AUDIT_ARCH_64BIT)
212#define AUDIT_ARCH_SHEL64 (EM_SH|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
213#define AUDIT_ARCH_SPARC (EM_SPARC)
f7ceba36 214#define AUDIT_ARCH_SPARC64 (EM_SPARCV9|__AUDIT_ARCH_64BIT)
2fd6f58b 215#define AUDIT_ARCH_V850 (EM_V850|__AUDIT_ARCH_LE)
216#define AUDIT_ARCH_X86_64 (EM_X86_64|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
217
1da177e4
LT
218struct audit_status {
219 __u32 mask; /* Bit mask for valid entries */
23f32d18 220 __u32 enabled; /* 1 = enabled, 0 = disabled */
1da177e4
LT
221 __u32 failure; /* Failure-to-log action */
222 __u32 pid; /* pid of auditd process */
223 __u32 rate_limit; /* messages rate limit (per second) */
224 __u32 backlog_limit; /* waiting messages limit */
225 __u32 lost; /* messages lost */
226 __u32 backlog; /* messages waiting in queue */
227};
228
229struct audit_rule { /* for AUDIT_LIST, AUDIT_ADD, and AUDIT_DEL */
230 __u32 flags; /* AUDIT_PER_{TASK,CALL}, AUDIT_PREPEND */
231 __u32 action; /* AUDIT_NEVER, AUDIT_POSSIBLE, AUDIT_ALWAYS */
232 __u32 field_count;
233 __u32 mask[AUDIT_BITMASK_SIZE];
234 __u32 fields[AUDIT_MAX_FIELDS];
235 __u32 values[AUDIT_MAX_FIELDS];
236};
237
238#ifdef __KERNEL__
239
c2f0c7c3
SG
240struct audit_sig_info {
241 uid_t uid;
242 pid_t pid;
243};
244
1da177e4
LT
245struct audit_buffer;
246struct audit_context;
247struct inode;
5bb289b5 248struct netlink_skb_parms;
1da177e4 249
2fd6f58b 250#define AUDITSC_INVALID 0
251#define AUDITSC_SUCCESS 1
252#define AUDITSC_FAILURE 2
253#define AUDITSC_RESULT(x) ( ((long)(x))<0?AUDITSC_FAILURE:AUDITSC_SUCCESS )
1da177e4
LT
254#ifdef CONFIG_AUDITSYSCALL
255/* These are defined in auditsc.c */
256 /* Public API */
257extern int audit_alloc(struct task_struct *task);
258extern void audit_free(struct task_struct *task);
2fd6f58b 259extern void audit_syscall_entry(struct task_struct *task, int arch,
1da177e4
LT
260 int major, unsigned long a0, unsigned long a1,
261 unsigned long a2, unsigned long a3);
2fd6f58b 262extern void audit_syscall_exit(struct task_struct *task, int failed, long return_code);
1da177e4
LT
263extern void audit_getname(const char *name);
264extern void audit_putname(const char *name);
73241ccc
AG
265extern void __audit_inode(const char *name, const struct inode *inode, unsigned flags);
266extern void __audit_inode_child(const char *dname, const struct inode *inode,
267 unsigned long pino);
268static inline void audit_inode(const char *name, const struct inode *inode,
269 unsigned flags) {
270 if (unlikely(current->audit_context))
271 __audit_inode(name, inode, flags);
272}
273static inline void audit_inode_child(const char *dname,
274 const struct inode *inode,
275 unsigned long pino) {
276 if (unlikely(current->audit_context))
277 __audit_inode_child(dname, inode, pino);
278}
1da177e4
LT
279
280 /* Private API (for audit.c only) */
bfb4496e
DW
281extern unsigned int audit_serial(void);
282extern void auditsc_get_stamp(struct audit_context *ctx,
283 struct timespec *t, unsigned int *serial);
456be6cd 284extern int audit_set_loginuid(struct task_struct *task, uid_t loginuid);
1da177e4 285extern uid_t audit_get_loginuid(struct audit_context *ctx);
8c8570fb 286extern int audit_ipc_perms(unsigned long qbytes, uid_t uid, gid_t gid, mode_t mode, struct kern_ipc_perm *ipcp);
3ec3b2fb
DW
287extern int audit_socketcall(int nargs, unsigned long *args);
288extern int audit_sockaddr(int len, void *addr);
01116105 289extern int audit_avc_path(struct dentry *dentry, struct vfsmount *mnt);
c2f0c7c3 290extern void audit_signal_info(int sig, struct task_struct *t);
8c8570fb 291extern int audit_set_macxattr(const char *name);
1da177e4
LT
292#else
293#define audit_alloc(t) ({ 0; })
294#define audit_free(t) do { ; } while (0)
2fd6f58b 295#define audit_syscall_entry(t,ta,a,b,c,d,e) do { ; } while (0)
296#define audit_syscall_exit(t,f,r) do { ; } while (0)
1da177e4
LT
297#define audit_getname(n) do { ; } while (0)
298#define audit_putname(n) do { ; } while (0)
73241ccc
AG
299#define __audit_inode(n,i,f) do { ; } while (0)
300#define __audit_inode_child(d,i,p) do { ; } while (0)
ae7b961b 301#define audit_inode(n,i,f) do { ; } while (0)
73241ccc 302#define audit_inode_child(d,i,p) do { ; } while (0)
bfb4496e 303#define auditsc_get_stamp(c,t,s) do { BUG(); } while (0)
1da177e4 304#define audit_get_loginuid(c) ({ -1; })
8c8570fb 305#define audit_ipc_perms(q,u,g,m,i) ({ 0; })
3ec3b2fb
DW
306#define audit_socketcall(n,a) ({ 0; })
307#define audit_sockaddr(len, addr) ({ 0; })
01116105 308#define audit_avc_path(dentry, mnt) ({ 0; })
c2f0c7c3 309#define audit_signal_info(s,t) do { ; } while (0)
8c8570fb 310#define audit_set_macxattr(n) do { ; } while (0)
1da177e4
LT
311#endif
312
313#ifdef CONFIG_AUDIT
314/* These are defined in audit.c */
315 /* Public API */
9796fdd8 316extern void audit_log(struct audit_context *ctx, gfp_t gfp_mask,
9ad9ad38
DW
317 int type, const char *fmt, ...)
318 __attribute__((format(printf,4,5)));
1da177e4 319
9796fdd8 320extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
1da177e4
LT
321extern void audit_log_format(struct audit_buffer *ab,
322 const char *fmt, ...)
323 __attribute__((format(printf,2,3)));
324extern void audit_log_end(struct audit_buffer *ab);
83c7d091 325extern void audit_log_hex(struct audit_buffer *ab,
326 const unsigned char *buf,
327 size_t len);
328extern void audit_log_untrustedstring(struct audit_buffer *ab,
329 const char *string);
1da177e4
LT
330extern void audit_log_d_path(struct audit_buffer *ab,
331 const char *prefix,
332 struct dentry *dentry,
333 struct vfsmount *vfsmnt);
fe7752ba
DW
334 /* Private API (for audit.c only) */
335extern int audit_filter_user(struct netlink_skb_parms *cb, int type);
336extern int audit_filter_type(int type);
337extern int audit_receive_filter(int type, int pid, int uid, int seq,
338 void *data, uid_t loginuid);
1da177e4 339#else
7b430437 340#define audit_log(c,g,t,f,...) do { ; } while (0)
13774024 341#define audit_log_start(c,g,t) ({ NULL; })
1da177e4
LT
342#define audit_log_vformat(b,f,a) do { ; } while (0)
343#define audit_log_format(b,f,...) do { ; } while (0)
344#define audit_log_end(b) do { ; } while (0)
83c7d091 345#define audit_log_hex(a,b,l) do { ; } while (0)
346#define audit_log_untrustedstring(a,s) do { ; } while (0)
1da177e4 347#define audit_log_d_path(b,p,d,v) do { ; } while (0)
8c8570fb 348#define audit_panic(m) do { ; } while (0)
1da177e4
LT
349#endif
350#endif
351#endif