1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* audit.h -- Auditing support
4 * Copyright 2003-2004 Red Hat Inc., Durham, North Carolina.
7 * Written by Rickard E. (Rik) Faith <faith@redhat.com>
9 #ifndef _LINUX_AUDIT_H_
10 #define _LINUX_AUDIT_H_
12 #include <linux/sched.h>
13 #include <linux/ptrace.h>
14 #include <linux/audit_arch.h>
15 #include <uapi/linux/audit.h>
16 #include <uapi/linux/netfilter/nf_tables.h>
18 #define AUDIT_INO_UNSET ((unsigned long)-1)
19 #define AUDIT_DEV_UNSET ((dev_t)-1)
21 struct audit_sig_info {
30 struct netlink_skb_parms;
44 u32 mask[AUDIT_BITMASK_SIZE];
45 u32 buflen; /* for data alloc on list rules */
47 char *filterkey; /* ties events to rules */
48 struct audit_field *fields;
49 struct audit_field *arch_f; /* quick access to arch field */
50 struct audit_field *inode_f; /* quick access to an inode field */
51 struct audit_watch *watch; /* associated watch */
52 struct audit_tree *tree; /* associated watched tree */
53 struct audit_fsnotify_mark *exe;
54 struct list_head rlist; /* entry in audit_{watch,tree}.rules list */
55 struct list_head list; /* for AUDIT_LIST* purposes only */
59 /* Flag to indicate legacy AUDIT_LOGINUID unset usage */
60 #define AUDIT_LOGINUID_LEGACY 0x1
84 AUDIT_NTP_NVALS /* count */
87 #ifdef CONFIG_AUDITSYSCALL
88 struct audit_ntp_val {
89 long long oldval, newval;
92 struct audit_ntp_data {
93 struct audit_ntp_val vals[AUDIT_NTP_NVALS];
96 struct audit_ntp_data {};
100 AUDIT_XT_OP_REGISTER,
102 AUDIT_XT_OP_UNREGISTER,
103 AUDIT_NFT_OP_TABLE_REGISTER,
104 AUDIT_NFT_OP_TABLE_UNREGISTER,
105 AUDIT_NFT_OP_CHAIN_REGISTER,
106 AUDIT_NFT_OP_CHAIN_UNREGISTER,
107 AUDIT_NFT_OP_RULE_REGISTER,
108 AUDIT_NFT_OP_RULE_UNREGISTER,
109 AUDIT_NFT_OP_SET_REGISTER,
110 AUDIT_NFT_OP_SET_UNREGISTER,
111 AUDIT_NFT_OP_SETELEM_REGISTER,
112 AUDIT_NFT_OP_SETELEM_UNREGISTER,
113 AUDIT_NFT_OP_GEN_REGISTER,
114 AUDIT_NFT_OP_OBJ_REGISTER,
115 AUDIT_NFT_OP_OBJ_UNREGISTER,
116 AUDIT_NFT_OP_OBJ_RESET,
117 AUDIT_NFT_OP_FLOWTABLE_REGISTER,
118 AUDIT_NFT_OP_FLOWTABLE_UNREGISTER,
119 AUDIT_NFT_OP_INVALID,
122 extern int __init audit_register_class(int class, unsigned *list);
123 extern int audit_classify_syscall(int abi, unsigned syscall);
124 extern int audit_classify_arch(int arch);
125 /* only for compat system calls */
126 extern unsigned compat_write_class[];
127 extern unsigned compat_read_class[];
128 extern unsigned compat_dir_class[];
129 extern unsigned compat_chattr_class[];
130 extern unsigned compat_signal_class[];
132 extern int audit_classify_compat_syscall(int abi, unsigned syscall);
134 /* audit_names->type values */
135 #define AUDIT_TYPE_UNKNOWN 0 /* we don't know yet */
136 #define AUDIT_TYPE_NORMAL 1 /* a "normal" audit record */
137 #define AUDIT_TYPE_PARENT 2 /* a parent audit record */
138 #define AUDIT_TYPE_CHILD_DELETE 3 /* a child being deleted */
139 #define AUDIT_TYPE_CHILD_CREATE 4 /* a child being created */
141 /* maximized args number that audit_socketcall can process */
142 #define AUDITSC_ARGS 6
144 /* bit values for ->signal->audit_tty */
145 #define AUDIT_TTY_ENABLE BIT(0)
146 #define AUDIT_TTY_LOG_PASSWD BIT(1)
152 #define AUDIT_LOCKED 2
154 /* These are defined in audit.c */
156 extern __printf(4, 5)
157 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
158 const char *fmt, ...);
160 extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
161 extern __printf(2, 3)
162 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...);
163 extern void audit_log_end(struct audit_buffer *ab);
164 extern bool audit_string_contains_control(const char *string,
166 extern void audit_log_n_hex(struct audit_buffer *ab,
167 const unsigned char *buf,
169 extern void audit_log_n_string(struct audit_buffer *ab,
172 extern void audit_log_n_untrustedstring(struct audit_buffer *ab,
175 extern void audit_log_untrustedstring(struct audit_buffer *ab,
177 extern void audit_log_d_path(struct audit_buffer *ab,
179 const struct path *path);
180 extern void audit_log_key(struct audit_buffer *ab,
182 extern void audit_log_path_denied(int type,
183 const char *operation);
184 extern void audit_log_lost(const char *message);
186 extern int audit_log_task_context(struct audit_buffer *ab);
187 extern void audit_log_task_info(struct audit_buffer *ab);
189 extern int audit_update_lsm_rules(void);
191 /* Private API (for audit.c only) */
192 extern int audit_rule_change(int type, int seq, void *data, size_t datasz);
193 extern int audit_list_rules_send(struct sk_buff *request_skb, int seq);
195 extern int audit_set_loginuid(kuid_t loginuid);
197 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
199 return tsk->loginuid;
202 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
204 return tsk->sessionid;
207 extern u32 audit_enabled;
209 extern int audit_signal_info(int sig, struct task_struct *t);
211 #else /* CONFIG_AUDIT */
212 static inline __printf(4, 5)
213 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
214 const char *fmt, ...)
216 static inline struct audit_buffer *audit_log_start(struct audit_context *ctx,
217 gfp_t gfp_mask, int type)
221 static inline __printf(2, 3)
222 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
224 static inline void audit_log_end(struct audit_buffer *ab)
226 static inline void audit_log_n_hex(struct audit_buffer *ab,
227 const unsigned char *buf, size_t len)
229 static inline void audit_log_n_string(struct audit_buffer *ab,
230 const char *buf, size_t n)
232 static inline void audit_log_n_untrustedstring(struct audit_buffer *ab,
233 const char *string, size_t n)
235 static inline void audit_log_untrustedstring(struct audit_buffer *ab,
238 static inline void audit_log_d_path(struct audit_buffer *ab,
240 const struct path *path)
242 static inline void audit_log_key(struct audit_buffer *ab, char *key)
244 static inline void audit_log_path_denied(int type, const char *operation)
246 static inline int audit_log_task_context(struct audit_buffer *ab)
250 static inline void audit_log_task_info(struct audit_buffer *ab)
253 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
258 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
260 return AUDIT_SID_UNSET;
263 #define audit_enabled AUDIT_OFF
265 static inline int audit_signal_info(int sig, struct task_struct *t)
270 #endif /* CONFIG_AUDIT */
272 #ifdef CONFIG_AUDIT_COMPAT_GENERIC
273 #define audit_is_compat(arch) (!((arch) & __AUDIT_ARCH_64BIT))
275 #define audit_is_compat(arch) false
278 #define AUDIT_INODE_PARENT 1 /* dentry represents the parent */
279 #define AUDIT_INODE_HIDDEN 2 /* audit record should be hidden */
280 #define AUDIT_INODE_NOEVAL 4 /* audit record incomplete */
282 #ifdef CONFIG_AUDITSYSCALL
283 #include <asm/syscall.h> /* for syscall_get_arch() */
285 /* These are defined in auditsc.c */
287 extern int audit_alloc(struct task_struct *task);
288 extern int audit_alloc_kernel(struct task_struct *task);
289 extern void __audit_free(struct task_struct *task);
290 extern void __audit_uring_entry(u8 op);
291 extern void __audit_uring_exit(int success, long code);
292 extern void __audit_syscall_entry(int major, unsigned long a0, unsigned long a1,
293 unsigned long a2, unsigned long a3);
294 extern void __audit_syscall_exit(int ret_success, long ret_value);
295 extern struct filename *__audit_reusename(const __user char *uptr);
296 extern void __audit_getname(struct filename *name);
297 extern void __audit_inode(struct filename *name, const struct dentry *dentry,
299 extern void __audit_file(const struct file *);
300 extern void __audit_inode_child(struct inode *parent,
301 const struct dentry *dentry,
302 const unsigned char type);
303 extern void audit_seccomp(unsigned long syscall, long signr, int code);
304 extern void audit_seccomp_actions_logged(const char *names,
305 const char *old_names, int res);
306 extern void __audit_ptrace(struct task_struct *t);
308 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
310 task->audit_context = ctx;
313 static inline struct audit_context *audit_context(void)
315 return current->audit_context;
318 static inline bool audit_dummy_context(void)
320 void *p = audit_context();
321 return !p || *(int *)p;
323 static inline void audit_free(struct task_struct *task)
325 if (unlikely(task->audit_context))
328 static inline void audit_uring_entry(u8 op)
331 * We intentionally check audit_context() before audit_enabled as most
332 * Linux systems (as of ~2021) rely on systemd which forces audit to
333 * be enabled regardless of the user's audit configuration.
335 if (unlikely(audit_context() && audit_enabled))
336 __audit_uring_entry(op);
338 static inline void audit_uring_exit(int success, long code)
340 if (unlikely(audit_context()))
341 __audit_uring_exit(success, code);
343 static inline void audit_syscall_entry(int major, unsigned long a0,
344 unsigned long a1, unsigned long a2,
347 if (unlikely(audit_context()))
348 __audit_syscall_entry(major, a0, a1, a2, a3);
350 static inline void audit_syscall_exit(void *pt_regs)
352 if (unlikely(audit_context())) {
353 int success = is_syscall_success(pt_regs);
354 long return_code = regs_return_value(pt_regs);
356 __audit_syscall_exit(success, return_code);
359 static inline struct filename *audit_reusename(const __user char *name)
361 if (unlikely(!audit_dummy_context()))
362 return __audit_reusename(name);
365 static inline void audit_getname(struct filename *name)
367 if (unlikely(!audit_dummy_context()))
368 __audit_getname(name);
370 static inline void audit_inode(struct filename *name,
371 const struct dentry *dentry,
372 unsigned int aflags) {
373 if (unlikely(!audit_dummy_context()))
374 __audit_inode(name, dentry, aflags);
376 static inline void audit_file(struct file *file)
378 if (unlikely(!audit_dummy_context()))
381 static inline void audit_inode_parent_hidden(struct filename *name,
382 const struct dentry *dentry)
384 if (unlikely(!audit_dummy_context()))
385 __audit_inode(name, dentry,
386 AUDIT_INODE_PARENT | AUDIT_INODE_HIDDEN);
388 static inline void audit_inode_child(struct inode *parent,
389 const struct dentry *dentry,
390 const unsigned char type) {
391 if (unlikely(!audit_dummy_context()))
392 __audit_inode_child(parent, dentry, type);
394 void audit_core_dumps(long signr);
396 static inline void audit_ptrace(struct task_struct *t)
398 if (unlikely(!audit_dummy_context()))
402 /* Private API (for audit.c only) */
403 extern void __audit_ipc_obj(struct kern_ipc_perm *ipcp);
404 extern void __audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode);
405 extern void __audit_bprm(struct linux_binprm *bprm);
406 extern int __audit_socketcall(int nargs, unsigned long *args);
407 extern int __audit_sockaddr(int len, void *addr);
408 extern void __audit_fd_pair(int fd1, int fd2);
409 extern void __audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr);
410 extern void __audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout);
411 extern void __audit_mq_notify(mqd_t mqdes, const struct sigevent *notification);
412 extern void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat);
413 extern int __audit_log_bprm_fcaps(struct linux_binprm *bprm,
414 const struct cred *new,
415 const struct cred *old);
416 extern void __audit_log_capset(const struct cred *new, const struct cred *old);
417 extern void __audit_mmap_fd(int fd, int flags);
418 extern void __audit_openat2_how(struct open_how *how);
419 extern void __audit_log_kern_module(char *name);
420 extern void __audit_fanotify(unsigned int response);
421 extern void __audit_tk_injoffset(struct timespec64 offset);
422 extern void __audit_ntp_log(const struct audit_ntp_data *ad);
423 extern void __audit_log_nfcfg(const char *name, u8 af, unsigned int nentries,
424 enum audit_nfcfgop op, gfp_t gfp);
426 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
428 if (unlikely(!audit_dummy_context()))
429 __audit_ipc_obj(ipcp);
431 static inline void audit_fd_pair(int fd1, int fd2)
433 if (unlikely(!audit_dummy_context()))
434 __audit_fd_pair(fd1, fd2);
436 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode)
438 if (unlikely(!audit_dummy_context()))
439 __audit_ipc_set_perm(qbytes, uid, gid, mode);
441 static inline void audit_bprm(struct linux_binprm *bprm)
443 if (unlikely(!audit_dummy_context()))
446 static inline int audit_socketcall(int nargs, unsigned long *args)
448 if (unlikely(!audit_dummy_context()))
449 return __audit_socketcall(nargs, args);
453 static inline int audit_socketcall_compat(int nargs, u32 *args)
455 unsigned long a[AUDITSC_ARGS];
458 if (audit_dummy_context())
461 for (i = 0; i < nargs; i++)
462 a[i] = (unsigned long)args[i];
463 return __audit_socketcall(nargs, a);
466 static inline int audit_sockaddr(int len, void *addr)
468 if (unlikely(!audit_dummy_context()))
469 return __audit_sockaddr(len, addr);
472 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
474 if (unlikely(!audit_dummy_context()))
475 __audit_mq_open(oflag, mode, attr);
477 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout)
479 if (unlikely(!audit_dummy_context()))
480 __audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
482 static inline void audit_mq_notify(mqd_t mqdes, const struct sigevent *notification)
484 if (unlikely(!audit_dummy_context()))
485 __audit_mq_notify(mqdes, notification);
487 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
489 if (unlikely(!audit_dummy_context()))
490 __audit_mq_getsetattr(mqdes, mqstat);
493 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
494 const struct cred *new,
495 const struct cred *old)
497 if (unlikely(!audit_dummy_context()))
498 return __audit_log_bprm_fcaps(bprm, new, old);
502 static inline void audit_log_capset(const struct cred *new,
503 const struct cred *old)
505 if (unlikely(!audit_dummy_context()))
506 __audit_log_capset(new, old);
509 static inline void audit_mmap_fd(int fd, int flags)
511 if (unlikely(!audit_dummy_context()))
512 __audit_mmap_fd(fd, flags);
515 static inline void audit_openat2_how(struct open_how *how)
517 if (unlikely(!audit_dummy_context()))
518 __audit_openat2_how(how);
521 static inline void audit_log_kern_module(char *name)
523 if (!audit_dummy_context())
524 __audit_log_kern_module(name);
527 static inline void audit_fanotify(unsigned int response)
529 if (!audit_dummy_context())
530 __audit_fanotify(response);
533 static inline void audit_tk_injoffset(struct timespec64 offset)
535 /* ignore no-op events */
536 if (offset.tv_sec == 0 && offset.tv_nsec == 0)
539 if (!audit_dummy_context())
540 __audit_tk_injoffset(offset);
543 static inline void audit_ntp_init(struct audit_ntp_data *ad)
545 memset(ad, 0, sizeof(*ad));
548 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
549 enum audit_ntp_type type, long long val)
551 ad->vals[type].oldval = val;
554 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
555 enum audit_ntp_type type, long long val)
557 ad->vals[type].newval = val;
560 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
562 if (!audit_dummy_context())
566 static inline void audit_log_nfcfg(const char *name, u8 af,
567 unsigned int nentries,
568 enum audit_nfcfgop op, gfp_t gfp)
571 __audit_log_nfcfg(name, af, nentries, op, gfp);
574 extern int audit_n_rules;
575 extern int audit_signals;
576 #else /* CONFIG_AUDITSYSCALL */
577 static inline int audit_alloc(struct task_struct *task)
581 static inline int audit_alloc_kernel(struct task_struct *task)
585 static inline void audit_free(struct task_struct *task)
587 static inline void audit_uring_entry(u8 op)
589 static inline void audit_uring_exit(int success, long code)
591 static inline void audit_syscall_entry(int major, unsigned long a0,
592 unsigned long a1, unsigned long a2,
595 static inline void audit_syscall_exit(void *pt_regs)
597 static inline bool audit_dummy_context(void)
601 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
603 static inline struct audit_context *audit_context(void)
607 static inline struct filename *audit_reusename(const __user char *name)
611 static inline void audit_getname(struct filename *name)
613 static inline void audit_inode(struct filename *name,
614 const struct dentry *dentry,
617 static inline void audit_file(struct file *file)
620 static inline void audit_inode_parent_hidden(struct filename *name,
621 const struct dentry *dentry)
623 static inline void audit_inode_child(struct inode *parent,
624 const struct dentry *dentry,
625 const unsigned char type)
627 static inline void audit_core_dumps(long signr)
629 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
631 static inline void audit_seccomp_actions_logged(const char *names,
632 const char *old_names, int res)
634 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
636 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
637 gid_t gid, umode_t mode)
639 static inline void audit_bprm(struct linux_binprm *bprm)
641 static inline int audit_socketcall(int nargs, unsigned long *args)
646 static inline int audit_socketcall_compat(int nargs, u32 *args)
651 static inline void audit_fd_pair(int fd1, int fd2)
653 static inline int audit_sockaddr(int len, void *addr)
657 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
659 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
660 unsigned int msg_prio,
661 const struct timespec64 *abs_timeout)
663 static inline void audit_mq_notify(mqd_t mqdes,
664 const struct sigevent *notification)
666 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
668 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
669 const struct cred *new,
670 const struct cred *old)
674 static inline void audit_log_capset(const struct cred *new,
675 const struct cred *old)
677 static inline void audit_mmap_fd(int fd, int flags)
680 static inline void audit_openat2_how(struct open_how *how)
683 static inline void audit_log_kern_module(char *name)
687 static inline void audit_fanotify(unsigned int response)
690 static inline void audit_tk_injoffset(struct timespec64 offset)
693 static inline void audit_ntp_init(struct audit_ntp_data *ad)
696 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
697 enum audit_ntp_type type, long long val)
700 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
701 enum audit_ntp_type type, long long val)
704 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
707 static inline void audit_ptrace(struct task_struct *t)
710 static inline void audit_log_nfcfg(const char *name, u8 af,
711 unsigned int nentries,
712 enum audit_nfcfgop op, gfp_t gfp)
715 #define audit_n_rules 0
716 #define audit_signals 0
717 #endif /* CONFIG_AUDITSYSCALL */
719 static inline bool audit_loginuid_set(struct task_struct *tsk)
721 return uid_valid(audit_get_loginuid(tsk));