xref: /linux-6.15/include/linux/audit.h (revision f47a3ca2)
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 #ifndef _LINUX_AUDIT_H_
24 #define _LINUX_AUDIT_H_
25 
26 #include <linux/sched.h>
27 #include <linux/ptrace.h>
28 #include <uapi/linux/audit.h>
29 
30 struct audit_sig_info {
31 	uid_t		uid;
32 	pid_t		pid;
33 	char		ctx[0];
34 };
35 
36 struct audit_buffer;
37 struct audit_context;
38 struct inode;
39 struct netlink_skb_parms;
40 struct path;
41 struct linux_binprm;
42 struct mq_attr;
43 struct mqstat;
44 struct audit_watch;
45 struct audit_tree;
46 
47 struct audit_krule {
48 	int			vers_ops;
49 	u32			flags;
50 	u32			listnr;
51 	u32			action;
52 	u32			mask[AUDIT_BITMASK_SIZE];
53 	u32			buflen; /* for data alloc on list rules */
54 	u32			field_count;
55 	char			*filterkey; /* ties events to rules */
56 	struct audit_field	*fields;
57 	struct audit_field	*arch_f; /* quick access to arch field */
58 	struct audit_field	*inode_f; /* quick access to an inode field */
59 	struct audit_watch	*watch;	/* associated watch */
60 	struct audit_tree	*tree;	/* associated watched tree */
61 	struct list_head	rlist;	/* entry in audit_{watch,tree}.rules list */
62 	struct list_head	list;	/* for AUDIT_LIST* purposes only */
63 	u64			prio;
64 };
65 
66 struct audit_field {
67 	u32				type;
68 	u32				val;
69 	kuid_t				uid;
70 	kgid_t				gid;
71 	u32				op;
72 	char				*lsm_str;
73 	void				*lsm_rule;
74 };
75 
76 extern int __init audit_register_class(int class, unsigned *list);
77 extern int audit_classify_syscall(int abi, unsigned syscall);
78 extern int audit_classify_arch(int arch);
79 
80 /* audit_names->type values */
81 #define	AUDIT_TYPE_UNKNOWN	0	/* we don't know yet */
82 #define	AUDIT_TYPE_NORMAL	1	/* a "normal" audit record */
83 #define	AUDIT_TYPE_PARENT	2	/* a parent audit record */
84 #define	AUDIT_TYPE_CHILD_DELETE 3	/* a child being deleted */
85 #define	AUDIT_TYPE_CHILD_CREATE 4	/* a child being created */
86 
87 /* maximized args number that audit_socketcall can process */
88 #define AUDITSC_ARGS		6
89 
90 struct filename;
91 
92 extern void audit_log_session_info(struct audit_buffer *ab);
93 
94 #ifdef CONFIG_AUDITSYSCALL
95 /* These are defined in auditsc.c */
96 				/* Public API */
97 extern int  audit_alloc(struct task_struct *task);
98 extern void __audit_free(struct task_struct *task);
99 extern void __audit_syscall_entry(int arch,
100 				  int major, unsigned long a0, unsigned long a1,
101 				  unsigned long a2, unsigned long a3);
102 extern void __audit_syscall_exit(int ret_success, long ret_value);
103 extern struct filename *__audit_reusename(const __user char *uptr);
104 extern void __audit_getname(struct filename *name);
105 extern void audit_putname(struct filename *name);
106 extern void __audit_inode(struct filename *name, const struct dentry *dentry,
107 				unsigned int parent);
108 extern void __audit_inode_child(const struct inode *parent,
109 				const struct dentry *dentry,
110 				const unsigned char type);
111 extern void __audit_seccomp(unsigned long syscall, long signr, int code);
112 extern void __audit_ptrace(struct task_struct *t);
113 
114 static inline int audit_dummy_context(void)
115 {
116 	void *p = current->audit_context;
117 	return !p || *(int *)p;
118 }
119 static inline void audit_free(struct task_struct *task)
120 {
121 	if (unlikely(task->audit_context))
122 		__audit_free(task);
123 }
124 static inline void audit_syscall_entry(int arch, int major, unsigned long a0,
125 				       unsigned long a1, unsigned long a2,
126 				       unsigned long a3)
127 {
128 	if (unlikely(current->audit_context))
129 		__audit_syscall_entry(arch, major, a0, a1, a2, a3);
130 }
131 static inline void audit_syscall_exit(void *pt_regs)
132 {
133 	if (unlikely(current->audit_context)) {
134 		int success = is_syscall_success(pt_regs);
135 		int return_code = regs_return_value(pt_regs);
136 
137 		__audit_syscall_exit(success, return_code);
138 	}
139 }
140 static inline struct filename *audit_reusename(const __user char *name)
141 {
142 	if (unlikely(!audit_dummy_context()))
143 		return __audit_reusename(name);
144 	return NULL;
145 }
146 static inline void audit_getname(struct filename *name)
147 {
148 	if (unlikely(!audit_dummy_context()))
149 		__audit_getname(name);
150 }
151 static inline void audit_inode(struct filename *name, const struct dentry *dentry,
152 				unsigned int parent) {
153 	if (unlikely(!audit_dummy_context()))
154 		__audit_inode(name, dentry, parent);
155 }
156 static inline void audit_inode_child(const struct inode *parent,
157 				     const struct dentry *dentry,
158 				     const unsigned char type) {
159 	if (unlikely(!audit_dummy_context()))
160 		__audit_inode_child(parent, dentry, type);
161 }
162 void audit_core_dumps(long signr);
163 
164 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
165 {
166 	/* Force a record to be reported if a signal was delivered. */
167 	if (signr || unlikely(!audit_dummy_context()))
168 		__audit_seccomp(syscall, signr, code);
169 }
170 
171 static inline void audit_ptrace(struct task_struct *t)
172 {
173 	if (unlikely(!audit_dummy_context()))
174 		__audit_ptrace(t);
175 }
176 
177 				/* Private API (for audit.c only) */
178 extern unsigned int audit_serial(void);
179 extern int auditsc_get_stamp(struct audit_context *ctx,
180 			      struct timespec *t, unsigned int *serial);
181 extern int audit_set_loginuid(kuid_t loginuid);
182 
183 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
184 {
185 	return tsk->loginuid;
186 }
187 
188 static inline int audit_get_sessionid(struct task_struct *tsk)
189 {
190 	return tsk->sessionid;
191 }
192 
193 extern void __audit_ipc_obj(struct kern_ipc_perm *ipcp);
194 extern void __audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode);
195 extern int __audit_bprm(struct linux_binprm *bprm);
196 extern int __audit_socketcall(int nargs, unsigned long *args);
197 extern int __audit_sockaddr(int len, void *addr);
198 extern void __audit_fd_pair(int fd1, int fd2);
199 extern void __audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr);
200 extern void __audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec *abs_timeout);
201 extern void __audit_mq_notify(mqd_t mqdes, const struct sigevent *notification);
202 extern void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat);
203 extern int __audit_log_bprm_fcaps(struct linux_binprm *bprm,
204 				  const struct cred *new,
205 				  const struct cred *old);
206 extern void __audit_log_capset(pid_t pid, const struct cred *new, const struct cred *old);
207 extern void __audit_mmap_fd(int fd, int flags);
208 
209 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
210 {
211 	if (unlikely(!audit_dummy_context()))
212 		__audit_ipc_obj(ipcp);
213 }
214 static inline void audit_fd_pair(int fd1, int fd2)
215 {
216 	if (unlikely(!audit_dummy_context()))
217 		__audit_fd_pair(fd1, fd2);
218 }
219 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode)
220 {
221 	if (unlikely(!audit_dummy_context()))
222 		__audit_ipc_set_perm(qbytes, uid, gid, mode);
223 }
224 static inline int audit_bprm(struct linux_binprm *bprm)
225 {
226 	if (unlikely(!audit_dummy_context()))
227 		return __audit_bprm(bprm);
228 	return 0;
229 }
230 static inline int audit_socketcall(int nargs, unsigned long *args)
231 {
232 	if (unlikely(!audit_dummy_context()))
233 		return __audit_socketcall(nargs, args);
234 	return 0;
235 }
236 static inline int audit_sockaddr(int len, void *addr)
237 {
238 	if (unlikely(!audit_dummy_context()))
239 		return __audit_sockaddr(len, addr);
240 	return 0;
241 }
242 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
243 {
244 	if (unlikely(!audit_dummy_context()))
245 		__audit_mq_open(oflag, mode, attr);
246 }
247 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec *abs_timeout)
248 {
249 	if (unlikely(!audit_dummy_context()))
250 		__audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
251 }
252 static inline void audit_mq_notify(mqd_t mqdes, const struct sigevent *notification)
253 {
254 	if (unlikely(!audit_dummy_context()))
255 		__audit_mq_notify(mqdes, notification);
256 }
257 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
258 {
259 	if (unlikely(!audit_dummy_context()))
260 		__audit_mq_getsetattr(mqdes, mqstat);
261 }
262 
263 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
264 				       const struct cred *new,
265 				       const struct cred *old)
266 {
267 	if (unlikely(!audit_dummy_context()))
268 		return __audit_log_bprm_fcaps(bprm, new, old);
269 	return 0;
270 }
271 
272 static inline void audit_log_capset(pid_t pid, const struct cred *new,
273 				   const struct cred *old)
274 {
275 	if (unlikely(!audit_dummy_context()))
276 		__audit_log_capset(pid, new, old);
277 }
278 
279 static inline void audit_mmap_fd(int fd, int flags)
280 {
281 	if (unlikely(!audit_dummy_context()))
282 		__audit_mmap_fd(fd, flags);
283 }
284 
285 extern int audit_n_rules;
286 extern int audit_signals;
287 #else /* CONFIG_AUDITSYSCALL */
288 static inline int audit_alloc(struct task_struct *task)
289 {
290 	return 0;
291 }
292 static inline void audit_free(struct task_struct *task)
293 { }
294 static inline void audit_syscall_entry(int arch, int major, unsigned long a0,
295 				       unsigned long a1, unsigned long a2,
296 				       unsigned long a3)
297 { }
298 static inline void audit_syscall_exit(void *pt_regs)
299 { }
300 static inline int audit_dummy_context(void)
301 {
302 	return 1;
303 }
304 static inline struct filename *audit_reusename(const __user char *name)
305 {
306 	return NULL;
307 }
308 static inline void audit_getname(struct filename *name)
309 { }
310 static inline void audit_putname(struct filename *name)
311 { }
312 static inline void __audit_inode(struct filename *name,
313 					const struct dentry *dentry,
314 					unsigned int parent)
315 { }
316 static inline void __audit_inode_child(const struct inode *parent,
317 					const struct dentry *dentry,
318 					const unsigned char type)
319 { }
320 static inline void audit_inode(struct filename *name,
321 				const struct dentry *dentry,
322 				unsigned int parent)
323 { }
324 static inline void audit_inode_child(const struct inode *parent,
325 				     const struct dentry *dentry,
326 				     const unsigned char type)
327 { }
328 static inline void audit_core_dumps(long signr)
329 { }
330 static inline void __audit_seccomp(unsigned long syscall, long signr, int code)
331 { }
332 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
333 { }
334 static inline int auditsc_get_stamp(struct audit_context *ctx,
335 			      struct timespec *t, unsigned int *serial)
336 {
337 	return 0;
338 }
339 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
340 {
341 	return INVALID_UID;
342 }
343 static inline int audit_get_sessionid(struct task_struct *tsk)
344 {
345 	return -1;
346 }
347 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
348 { }
349 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
350 					gid_t gid, umode_t mode)
351 { }
352 static inline int audit_bprm(struct linux_binprm *bprm)
353 {
354 	return 0;
355 }
356 static inline int audit_socketcall(int nargs, unsigned long *args)
357 {
358 	return 0;
359 }
360 static inline void audit_fd_pair(int fd1, int fd2)
361 { }
362 static inline int audit_sockaddr(int len, void *addr)
363 {
364 	return 0;
365 }
366 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
367 { }
368 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
369 				     unsigned int msg_prio,
370 				     const struct timespec *abs_timeout)
371 { }
372 static inline void audit_mq_notify(mqd_t mqdes,
373 				   const struct sigevent *notification)
374 { }
375 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
376 { }
377 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
378 				       const struct cred *new,
379 				       const struct cred *old)
380 {
381 	return 0;
382 }
383 static inline void audit_log_capset(pid_t pid, const struct cred *new,
384 				   const struct cred *old)
385 { }
386 static inline void audit_mmap_fd(int fd, int flags)
387 { }
388 static inline void audit_ptrace(struct task_struct *t)
389 { }
390 #define audit_n_rules 0
391 #define audit_signals 0
392 #endif /* CONFIG_AUDITSYSCALL */
393 
394 static inline bool audit_loginuid_set(struct task_struct *tsk)
395 {
396 	return uid_valid(audit_get_loginuid(tsk));
397 }
398 
399 #ifdef CONFIG_AUDIT
400 /* These are defined in audit.c */
401 				/* Public API */
402 extern __printf(4, 5)
403 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
404 	       const char *fmt, ...);
405 
406 extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
407 extern __printf(2, 3)
408 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...);
409 extern void		    audit_log_end(struct audit_buffer *ab);
410 extern int		    audit_string_contains_control(const char *string,
411 							  size_t len);
412 extern void		    audit_log_n_hex(struct audit_buffer *ab,
413 					  const unsigned char *buf,
414 					  size_t len);
415 extern void		    audit_log_n_string(struct audit_buffer *ab,
416 					       const char *buf,
417 					       size_t n);
418 extern void		    audit_log_n_untrustedstring(struct audit_buffer *ab,
419 							const char *string,
420 							size_t n);
421 extern void		    audit_log_untrustedstring(struct audit_buffer *ab,
422 						      const char *string);
423 extern void		    audit_log_d_path(struct audit_buffer *ab,
424 					     const char *prefix,
425 					     const struct path *path);
426 extern void		    audit_log_key(struct audit_buffer *ab,
427 					  char *key);
428 extern void		    audit_log_link_denied(const char *operation,
429 						  struct path *link);
430 extern void		    audit_log_lost(const char *message);
431 #ifdef CONFIG_SECURITY
432 extern void 		    audit_log_secctx(struct audit_buffer *ab, u32 secid);
433 #else
434 static inline void	    audit_log_secctx(struct audit_buffer *ab, u32 secid)
435 { }
436 #endif
437 
438 extern int audit_log_task_context(struct audit_buffer *ab);
439 extern void audit_log_task_info(struct audit_buffer *ab,
440 				struct task_struct *tsk);
441 
442 extern int		    audit_update_lsm_rules(void);
443 
444 				/* Private API (for audit.c only) */
445 extern int audit_filter_user(int type);
446 extern int audit_filter_type(int type);
447 extern int  audit_receive_filter(int type, int pid, int seq,
448 				void *data, size_t datasz);
449 extern int audit_enabled;
450 #else /* CONFIG_AUDIT */
451 static inline __printf(4, 5)
452 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
453 	       const char *fmt, ...)
454 { }
455 static inline struct audit_buffer *audit_log_start(struct audit_context *ctx,
456 						   gfp_t gfp_mask, int type)
457 {
458 	return NULL;
459 }
460 static inline __printf(2, 3)
461 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
462 { }
463 static inline void audit_log_end(struct audit_buffer *ab)
464 { }
465 static inline void audit_log_n_hex(struct audit_buffer *ab,
466 				   const unsigned char *buf, size_t len)
467 { }
468 static inline void audit_log_n_string(struct audit_buffer *ab,
469 				      const char *buf, size_t n)
470 { }
471 static inline void  audit_log_n_untrustedstring(struct audit_buffer *ab,
472 						const char *string, size_t n)
473 { }
474 static inline void audit_log_untrustedstring(struct audit_buffer *ab,
475 					     const char *string)
476 { }
477 static inline void audit_log_d_path(struct audit_buffer *ab,
478 				    const char *prefix,
479 				    const struct path *path)
480 { }
481 static inline void audit_log_key(struct audit_buffer *ab, char *key)
482 { }
483 static inline void audit_log_link_denied(const char *string,
484 					 const struct path *link)
485 { }
486 static inline void audit_log_secctx(struct audit_buffer *ab, u32 secid)
487 { }
488 static inline int audit_log_task_context(struct audit_buffer *ab)
489 {
490 	return 0;
491 }
492 static inline void audit_log_task_info(struct audit_buffer *ab,
493 				       struct task_struct *tsk)
494 { }
495 #define audit_enabled 0
496 #endif /* CONFIG_AUDIT */
497 static inline void audit_log_string(struct audit_buffer *ab, const char *buf)
498 {
499 	audit_log_n_string(ab, buf, strlen(buf));
500 }
501 
502 #endif
503