xref: /linux-6.15/include/linux/audit.h (revision 4e57b681)
1 /* audit.h -- Auditing support
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 <[email protected]>
21  *
22  */
23 
24 #ifndef _LINUX_AUDIT_H_
25 #define _LINUX_AUDIT_H_
26 
27 #include <linux/sched.h>
28 #include <linux/elf.h>
29 
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
36  * 1500 - 1999 future use
37  * 2000 is for otherwise unclassified kernel audit messages
38  *
39  * Messages from 1000-1199 are bi-directional. 1200-1299 are exclusively user
40  * space. Anything over that is kernel --> user space communication.
41  */
42 #define AUDIT_GET		1000	/* Get status */
43 #define AUDIT_SET		1001	/* Set status (enable/disable/auditd) */
44 #define AUDIT_LIST		1002	/* List syscall filtering rules */
45 #define AUDIT_ADD		1003	/* Add syscall filtering rule */
46 #define AUDIT_DEL		1004	/* Delete syscall filtering rule */
47 #define AUDIT_USER		1005	/* Message from userspace -- deprecated */
48 #define AUDIT_LOGIN		1006	/* Define the login id and information */
49 #define AUDIT_WATCH_INS		1007	/* Insert file/dir watch entry */
50 #define AUDIT_WATCH_REM		1008	/* Remove file/dir watch entry */
51 #define AUDIT_WATCH_LIST	1009	/* List all file/dir watches */
52 #define AUDIT_SIGNAL_INFO	1010	/* Get info about sender of signal to auditd */
53 
54 #define AUDIT_FIRST_USER_MSG	1100	/* Userspace messages mostly uninteresting to kernel */
55 #define AUDIT_USER_AVC		1107	/* We filter this differently */
56 #define AUDIT_LAST_USER_MSG	1199
57 
58 #define AUDIT_DAEMON_START      1200    /* Daemon startup record */
59 #define AUDIT_DAEMON_END        1201    /* Daemon normal stop record */
60 #define AUDIT_DAEMON_ABORT      1202    /* Daemon error stop record */
61 #define AUDIT_DAEMON_CONFIG     1203    /* Daemon config change */
62 
63 #define AUDIT_SYSCALL		1300	/* Syscall event */
64 #define AUDIT_FS_WATCH		1301	/* Filesystem watch event */
65 #define AUDIT_PATH		1302	/* Filename path information */
66 #define AUDIT_IPC		1303	/* IPC record */
67 #define AUDIT_SOCKETCALL	1304	/* sys_socketcall arguments */
68 #define AUDIT_CONFIG_CHANGE	1305	/* Audit system configuration change */
69 #define AUDIT_SOCKADDR		1306	/* sockaddr copied as syscall arg */
70 #define AUDIT_CWD		1307	/* Current working directory */
71 
72 #define AUDIT_AVC		1400	/* SE Linux avc denial or grant */
73 #define AUDIT_SELINUX_ERR	1401	/* Internal SE Linux Errors */
74 #define AUDIT_AVC_PATH		1402	/* dentry, vfsmount pair from avc */
75 
76 #define AUDIT_KERNEL		2000	/* Asynchronous audit record. NOT A REQUEST. */
77 
78 /* Rule flags */
79 #define AUDIT_FILTER_USER	0x00	/* Apply rule to user-generated messages */
80 #define AUDIT_FILTER_TASK	0x01	/* Apply rule at task creation (not syscall) */
81 #define AUDIT_FILTER_ENTRY	0x02	/* Apply rule at syscall entry */
82 #define AUDIT_FILTER_WATCH	0x03	/* Apply rule to file system watches */
83 #define AUDIT_FILTER_EXIT	0x04	/* Apply rule at syscall exit */
84 
85 #define AUDIT_NR_FILTERS	5
86 
87 #define AUDIT_FILTER_PREPEND	0x10	/* Prepend to front of list */
88 
89 /* Rule actions */
90 #define AUDIT_NEVER    0	/* Do not build context if rule matches */
91 #define AUDIT_POSSIBLE 1	/* Build context if rule matches  */
92 #define AUDIT_ALWAYS   2	/* Generate audit record if rule matches */
93 
94 /* Rule structure sizes -- if these change, different AUDIT_ADD and
95  * AUDIT_LIST commands must be implemented. */
96 #define AUDIT_MAX_FIELDS   64
97 #define AUDIT_BITMASK_SIZE 64
98 #define AUDIT_WORD(nr) ((__u32)((nr)/32))
99 #define AUDIT_BIT(nr)  (1 << ((nr) - AUDIT_WORD(nr)*32))
100 
101 /* Rule fields */
102 				/* These are useful when checking the
103 				 * task structure at task creation time
104 				 * (AUDIT_PER_TASK).  */
105 #define AUDIT_PID	0
106 #define AUDIT_UID	1
107 #define AUDIT_EUID	2
108 #define AUDIT_SUID	3
109 #define AUDIT_FSUID	4
110 #define AUDIT_GID	5
111 #define AUDIT_EGID	6
112 #define AUDIT_SGID	7
113 #define AUDIT_FSGID	8
114 #define AUDIT_LOGINUID	9
115 #define AUDIT_PERS	10
116 #define AUDIT_ARCH	11
117 
118 				/* These are ONLY useful when checking
119 				 * at syscall exit time (AUDIT_AT_EXIT). */
120 #define AUDIT_DEVMAJOR	100
121 #define AUDIT_DEVMINOR	101
122 #define AUDIT_INODE	102
123 #define AUDIT_EXIT	103
124 #define AUDIT_SUCCESS   104	/* exit >= 0; value ignored */
125 
126 #define AUDIT_ARG0      200
127 #define AUDIT_ARG1      (AUDIT_ARG0+1)
128 #define AUDIT_ARG2      (AUDIT_ARG0+2)
129 #define AUDIT_ARG3      (AUDIT_ARG0+3)
130 
131 #define AUDIT_NEGATE    0x80000000
132 
133 
134 /* Status symbols */
135 				/* Mask values */
136 #define AUDIT_STATUS_ENABLED		0x0001
137 #define AUDIT_STATUS_FAILURE		0x0002
138 #define AUDIT_STATUS_PID		0x0004
139 #define AUDIT_STATUS_RATE_LIMIT		0x0008
140 #define AUDIT_STATUS_BACKLOG_LIMIT	0x0010
141 				/* Failure-to-log actions */
142 #define AUDIT_FAIL_SILENT	0
143 #define AUDIT_FAIL_PRINTK	1
144 #define AUDIT_FAIL_PANIC	2
145 
146 /* distinguish syscall tables */
147 #define __AUDIT_ARCH_64BIT 0x80000000
148 #define __AUDIT_ARCH_LE	   0x40000000
149 #define AUDIT_ARCH_ALPHA	(EM_ALPHA|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
150 #define AUDIT_ARCH_ARM		(EM_ARM|__AUDIT_ARCH_LE)
151 #define AUDIT_ARCH_ARMEB	(EM_ARM)
152 #define AUDIT_ARCH_CRIS		(EM_CRIS|__AUDIT_ARCH_LE)
153 #define AUDIT_ARCH_FRV		(EM_FRV)
154 #define AUDIT_ARCH_H8300	(EM_H8_300)
155 #define AUDIT_ARCH_I386		(EM_386|__AUDIT_ARCH_LE)
156 #define AUDIT_ARCH_IA64		(EM_IA_64|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
157 #define AUDIT_ARCH_M32R		(EM_M32R)
158 #define AUDIT_ARCH_M68K		(EM_68K)
159 #define AUDIT_ARCH_MIPS		(EM_MIPS)
160 #define AUDIT_ARCH_MIPSEL	(EM_MIPS|__AUDIT_ARCH_LE)
161 #define AUDIT_ARCH_MIPS64	(EM_MIPS|__AUDIT_ARCH_64BIT)
162 #define AUDIT_ARCH_MIPSEL64	(EM_MIPS|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
163 #define AUDIT_ARCH_PARISC	(EM_PARISC)
164 #define AUDIT_ARCH_PARISC64	(EM_PARISC|__AUDIT_ARCH_64BIT)
165 #define AUDIT_ARCH_PPC		(EM_PPC)
166 #define AUDIT_ARCH_PPC64	(EM_PPC64|__AUDIT_ARCH_64BIT)
167 #define AUDIT_ARCH_S390		(EM_S390)
168 #define AUDIT_ARCH_S390X	(EM_S390|__AUDIT_ARCH_64BIT)
169 #define AUDIT_ARCH_SH		(EM_SH)
170 #define AUDIT_ARCH_SHEL		(EM_SH|__AUDIT_ARCH_LE)
171 #define AUDIT_ARCH_SH64		(EM_SH|__AUDIT_ARCH_64BIT)
172 #define AUDIT_ARCH_SHEL64	(EM_SH|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
173 #define AUDIT_ARCH_SPARC	(EM_SPARC)
174 #define AUDIT_ARCH_SPARC64	(EM_SPARCV9|__AUDIT_ARCH_64BIT)
175 #define AUDIT_ARCH_V850		(EM_V850|__AUDIT_ARCH_LE)
176 #define AUDIT_ARCH_X86_64	(EM_X86_64|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
177 
178 struct audit_status {
179 	__u32		mask;		/* Bit mask for valid entries */
180 	__u32		enabled;	/* 1 = enabled, 0 = disabled */
181 	__u32		failure;	/* Failure-to-log action */
182 	__u32		pid;		/* pid of auditd process */
183 	__u32		rate_limit;	/* messages rate limit (per second) */
184 	__u32		backlog_limit;	/* waiting messages limit */
185 	__u32		lost;		/* messages lost */
186 	__u32		backlog;	/* messages waiting in queue */
187 };
188 
189 struct audit_rule {		/* for AUDIT_LIST, AUDIT_ADD, and AUDIT_DEL */
190 	__u32		flags;	/* AUDIT_PER_{TASK,CALL}, AUDIT_PREPEND */
191 	__u32		action;	/* AUDIT_NEVER, AUDIT_POSSIBLE, AUDIT_ALWAYS */
192 	__u32		field_count;
193 	__u32		mask[AUDIT_BITMASK_SIZE];
194 	__u32		fields[AUDIT_MAX_FIELDS];
195 	__u32		values[AUDIT_MAX_FIELDS];
196 };
197 
198 #ifdef __KERNEL__
199 
200 struct audit_sig_info {
201 	uid_t		uid;
202 	pid_t		pid;
203 };
204 
205 struct audit_buffer;
206 struct audit_context;
207 struct inode;
208 struct netlink_skb_parms;
209 
210 #define AUDITSC_INVALID 0
211 #define AUDITSC_SUCCESS 1
212 #define AUDITSC_FAILURE 2
213 #define AUDITSC_RESULT(x) ( ((long)(x))<0?AUDITSC_FAILURE:AUDITSC_SUCCESS )
214 #ifdef CONFIG_AUDITSYSCALL
215 /* These are defined in auditsc.c */
216 				/* Public API */
217 extern int  audit_alloc(struct task_struct *task);
218 extern void audit_free(struct task_struct *task);
219 extern void audit_syscall_entry(struct task_struct *task, int arch,
220 				int major, unsigned long a0, unsigned long a1,
221 				unsigned long a2, unsigned long a3);
222 extern void audit_syscall_exit(struct task_struct *task, int failed, long return_code);
223 extern void audit_getname(const char *name);
224 extern void audit_putname(const char *name);
225 extern void audit_inode(const char *name, const struct inode *inode, unsigned flags);
226 
227 				/* Private API (for audit.c only) */
228 extern int  audit_receive_filter(int type, int pid, int uid, int seq,
229 				 void *data, uid_t loginuid);
230 extern unsigned int audit_serial(void);
231 extern void auditsc_get_stamp(struct audit_context *ctx,
232 			      struct timespec *t, unsigned int *serial);
233 extern int  audit_set_loginuid(struct task_struct *task, uid_t loginuid);
234 extern uid_t audit_get_loginuid(struct audit_context *ctx);
235 extern int audit_ipc_perms(unsigned long qbytes, uid_t uid, gid_t gid, mode_t mode);
236 extern int audit_socketcall(int nargs, unsigned long *args);
237 extern int audit_sockaddr(int len, void *addr);
238 extern int audit_avc_path(struct dentry *dentry, struct vfsmount *mnt);
239 extern void audit_signal_info(int sig, struct task_struct *t);
240 extern int audit_filter_user(struct netlink_skb_parms *cb, int type);
241 #else
242 #define audit_alloc(t) ({ 0; })
243 #define audit_free(t) do { ; } while (0)
244 #define audit_syscall_entry(t,ta,a,b,c,d,e) do { ; } while (0)
245 #define audit_syscall_exit(t,f,r) do { ; } while (0)
246 #define audit_getname(n) do { ; } while (0)
247 #define audit_putname(n) do { ; } while (0)
248 #define audit_inode(n,i,f) do { ; } while (0)
249 #define audit_receive_filter(t,p,u,s,d,l) ({ -EOPNOTSUPP; })
250 #define auditsc_get_stamp(c,t,s) do { BUG(); } while (0)
251 #define audit_get_loginuid(c) ({ -1; })
252 #define audit_ipc_perms(q,u,g,m) ({ 0; })
253 #define audit_socketcall(n,a) ({ 0; })
254 #define audit_sockaddr(len, addr) ({ 0; })
255 #define audit_avc_path(dentry, mnt) ({ 0; })
256 #define audit_signal_info(s,t) do { ; } while (0)
257 #define audit_filter_user(cb,t) ({ 1; })
258 #endif
259 
260 #ifdef CONFIG_AUDIT
261 /* These are defined in audit.c */
262 				/* Public API */
263 extern void		    audit_log(struct audit_context *ctx, gfp_t gfp_mask,
264 				      int type, const char *fmt, ...)
265 				      __attribute__((format(printf,4,5)));
266 
267 extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
268 extern void		    audit_log_format(struct audit_buffer *ab,
269 					     const char *fmt, ...)
270 			    __attribute__((format(printf,2,3)));
271 extern void		    audit_log_end(struct audit_buffer *ab);
272 extern void		    audit_log_hex(struct audit_buffer *ab,
273 					  const unsigned char *buf,
274 					  size_t len);
275 extern void		    audit_log_untrustedstring(struct audit_buffer *ab,
276 						      const char *string);
277 extern void		    audit_log_d_path(struct audit_buffer *ab,
278 					     const char *prefix,
279 					     struct dentry *dentry,
280 					     struct vfsmount *vfsmnt);
281 				/* Private API (for auditsc.c only) */
282 extern void		    audit_send_reply(int pid, int seq, int type,
283 					     int done, int multi,
284 					     void *payload, int size);
285 extern void		    audit_log_lost(const char *message);
286 extern struct semaphore audit_netlink_sem;
287 #else
288 #define audit_log(c,g,t,f,...) do { ; } while (0)
289 #define audit_log_start(c,g,t) ({ NULL; })
290 #define audit_log_vformat(b,f,a) do { ; } while (0)
291 #define audit_log_format(b,f,...) do { ; } while (0)
292 #define audit_log_end(b) do { ; } while (0)
293 #define audit_log_hex(a,b,l) do { ; } while (0)
294 #define audit_log_untrustedstring(a,s) do { ; } while (0)
295 #define audit_log_d_path(b,p,d,v) do { ; } while (0)
296 #endif
297 #endif
298 #endif
299