1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* audit.h -- Auditing support
4 * Copyright 2003-2004 Red Hat Inc., Durham, North Carolina.
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 void __audit_free(struct task_struct *task);
289 extern void __audit_uring_entry(u8 op);
290 extern void __audit_uring_exit(int success, long code);
291 extern void __audit_syscall_entry(int major, unsigned long a0, unsigned long a1,
292 unsigned long a2, unsigned long a3);
293 extern void __audit_syscall_exit(int ret_success, long ret_value);
294 extern struct filename *__audit_reusename(const __user char *uptr);
295 extern void __audit_getname(struct filename *name);
296 extern void __audit_inode(struct filename *name, const struct dentry *dentry,
298 extern void __audit_file(const struct file *);
299 extern void __audit_inode_child(struct inode *parent,
300 const struct dentry *dentry,
301 const unsigned char type);
302 extern void audit_seccomp(unsigned long syscall, long signr, int code);
303 extern void audit_seccomp_actions_logged(const char *names,
304 const char *old_names, int res);
305 extern void __audit_ptrace(struct task_struct *t);
307 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
309 task->audit_context = ctx;
312 static inline struct audit_context *audit_context(void)
314 return current->audit_context;
317 static inline bool audit_dummy_context(void)
319 void *p = audit_context();
320 return !p || *(int *)p;
322 static inline void audit_free(struct task_struct *task)
324 if (unlikely(task->audit_context))
327 static inline void audit_uring_entry(u8 op)
330 * We intentionally check audit_context() before audit_enabled as most
331 * Linux systems (as of ~2021) rely on systemd which forces audit to
332 * be enabled regardless of the user's audit configuration.
334 if (unlikely(audit_context() && audit_enabled))
335 __audit_uring_entry(op);
337 static inline void audit_uring_exit(int success, long code)
339 if (unlikely(audit_context()))
340 __audit_uring_exit(success, code);
342 static inline void audit_syscall_entry(int major, unsigned long a0,
343 unsigned long a1, unsigned long a2,
346 if (unlikely(audit_context()))
347 __audit_syscall_entry(major, a0, a1, a2, a3);
349 static inline void audit_syscall_exit(void *pt_regs)
351 if (unlikely(audit_context())) {
352 int success = is_syscall_success(pt_regs);
353 long return_code = regs_return_value(pt_regs);
355 __audit_syscall_exit(success, return_code);
358 static inline struct filename *audit_reusename(const __user char *name)
360 if (unlikely(!audit_dummy_context()))
361 return __audit_reusename(name);
364 static inline void audit_getname(struct filename *name)
366 if (unlikely(!audit_dummy_context()))
367 __audit_getname(name);
369 static inline void audit_inode(struct filename *name,
370 const struct dentry *dentry,
371 unsigned int aflags) {
372 if (unlikely(!audit_dummy_context()))
373 __audit_inode(name, dentry, aflags);
375 static inline void audit_file(struct file *file)
377 if (unlikely(!audit_dummy_context()))
380 static inline void audit_inode_parent_hidden(struct filename *name,
381 const struct dentry *dentry)
383 if (unlikely(!audit_dummy_context()))
384 __audit_inode(name, dentry,
385 AUDIT_INODE_PARENT | AUDIT_INODE_HIDDEN);
387 static inline void audit_inode_child(struct inode *parent,
388 const struct dentry *dentry,
389 const unsigned char type) {
390 if (unlikely(!audit_dummy_context()))
391 __audit_inode_child(parent, dentry, type);
393 void audit_core_dumps(long signr);
395 static inline void audit_ptrace(struct task_struct *t)
397 if (unlikely(!audit_dummy_context()))
401 /* Private API (for audit.c only) */
402 extern void __audit_ipc_obj(struct kern_ipc_perm *ipcp);
403 extern void __audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode);
404 extern void __audit_bprm(struct linux_binprm *bprm);
405 extern int __audit_socketcall(int nargs, unsigned long *args);
406 extern int __audit_sockaddr(int len, void *addr);
407 extern void __audit_fd_pair(int fd1, int fd2);
408 extern void __audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr);
409 extern void __audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout);
410 extern void __audit_mq_notify(mqd_t mqdes, const struct sigevent *notification);
411 extern void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat);
412 extern int __audit_log_bprm_fcaps(struct linux_binprm *bprm,
413 const struct cred *new,
414 const struct cred *old);
415 extern void __audit_log_capset(const struct cred *new, const struct cred *old);
416 extern void __audit_mmap_fd(int fd, int flags);
417 extern void __audit_openat2_how(struct open_how *how);
418 extern void __audit_log_kern_module(char *name);
419 extern void __audit_fanotify(unsigned int response);
420 extern void __audit_tk_injoffset(struct timespec64 offset);
421 extern void __audit_ntp_log(const struct audit_ntp_data *ad);
422 extern void __audit_log_nfcfg(const char *name, u8 af, unsigned int nentries,
423 enum audit_nfcfgop op, gfp_t gfp);
425 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
427 if (unlikely(!audit_dummy_context()))
428 __audit_ipc_obj(ipcp);
430 static inline void audit_fd_pair(int fd1, int fd2)
432 if (unlikely(!audit_dummy_context()))
433 __audit_fd_pair(fd1, fd2);
435 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode)
437 if (unlikely(!audit_dummy_context()))
438 __audit_ipc_set_perm(qbytes, uid, gid, mode);
440 static inline void audit_bprm(struct linux_binprm *bprm)
442 if (unlikely(!audit_dummy_context()))
445 static inline int audit_socketcall(int nargs, unsigned long *args)
447 if (unlikely(!audit_dummy_context()))
448 return __audit_socketcall(nargs, args);
452 static inline int audit_socketcall_compat(int nargs, u32 *args)
454 unsigned long a[AUDITSC_ARGS];
457 if (audit_dummy_context())
460 for (i = 0; i < nargs; i++)
461 a[i] = (unsigned long)args[i];
462 return __audit_socketcall(nargs, a);
465 static inline int audit_sockaddr(int len, void *addr)
467 if (unlikely(!audit_dummy_context()))
468 return __audit_sockaddr(len, addr);
471 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
473 if (unlikely(!audit_dummy_context()))
474 __audit_mq_open(oflag, mode, attr);
476 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout)
478 if (unlikely(!audit_dummy_context()))
479 __audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
481 static inline void audit_mq_notify(mqd_t mqdes, const struct sigevent *notification)
483 if (unlikely(!audit_dummy_context()))
484 __audit_mq_notify(mqdes, notification);
486 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
488 if (unlikely(!audit_dummy_context()))
489 __audit_mq_getsetattr(mqdes, mqstat);
492 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
493 const struct cred *new,
494 const struct cred *old)
496 if (unlikely(!audit_dummy_context()))
497 return __audit_log_bprm_fcaps(bprm, new, old);
501 static inline void audit_log_capset(const struct cred *new,
502 const struct cred *old)
504 if (unlikely(!audit_dummy_context()))
505 __audit_log_capset(new, old);
508 static inline void audit_mmap_fd(int fd, int flags)
510 if (unlikely(!audit_dummy_context()))
511 __audit_mmap_fd(fd, flags);
514 static inline void audit_openat2_how(struct open_how *how)
516 if (unlikely(!audit_dummy_context()))
517 __audit_openat2_how(how);
520 static inline void audit_log_kern_module(char *name)
522 if (!audit_dummy_context())
523 __audit_log_kern_module(name);
526 static inline void audit_fanotify(unsigned int response)
528 if (!audit_dummy_context())
529 __audit_fanotify(response);
532 static inline void audit_tk_injoffset(struct timespec64 offset)
534 /* ignore no-op events */
535 if (offset.tv_sec == 0 && offset.tv_nsec == 0)
538 if (!audit_dummy_context())
539 __audit_tk_injoffset(offset);
542 static inline void audit_ntp_init(struct audit_ntp_data *ad)
544 memset(ad, 0, sizeof(*ad));
547 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
548 enum audit_ntp_type type, long long val)
550 ad->vals[type].oldval = val;
553 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
554 enum audit_ntp_type type, long long val)
556 ad->vals[type].newval = val;
559 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
561 if (!audit_dummy_context())
565 static inline void audit_log_nfcfg(const char *name, u8 af,
566 unsigned int nentries,
567 enum audit_nfcfgop op, gfp_t gfp)
570 __audit_log_nfcfg(name, af, nentries, op, gfp);
573 extern int audit_n_rules;
574 extern int audit_signals;
575 #else /* CONFIG_AUDITSYSCALL */
576 static inline int audit_alloc(struct task_struct *task)
580 static inline void audit_free(struct task_struct *task)
582 static inline void audit_uring_entry(u8 op)
584 static inline void audit_uring_exit(int success, long code)
586 static inline void audit_syscall_entry(int major, unsigned long a0,
587 unsigned long a1, unsigned long a2,
590 static inline void audit_syscall_exit(void *pt_regs)
592 static inline bool audit_dummy_context(void)
596 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
598 static inline struct audit_context *audit_context(void)
602 static inline struct filename *audit_reusename(const __user char *name)
606 static inline void audit_getname(struct filename *name)
608 static inline void audit_inode(struct filename *name,
609 const struct dentry *dentry,
612 static inline void audit_file(struct file *file)
615 static inline void audit_inode_parent_hidden(struct filename *name,
616 const struct dentry *dentry)
618 static inline void audit_inode_child(struct inode *parent,
619 const struct dentry *dentry,
620 const unsigned char type)
622 static inline void audit_core_dumps(long signr)
624 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
626 static inline void audit_seccomp_actions_logged(const char *names,
627 const char *old_names, int res)
629 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
631 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
632 gid_t gid, umode_t mode)
634 static inline void audit_bprm(struct linux_binprm *bprm)
636 static inline int audit_socketcall(int nargs, unsigned long *args)
641 static inline int audit_socketcall_compat(int nargs, u32 *args)
646 static inline void audit_fd_pair(int fd1, int fd2)
648 static inline int audit_sockaddr(int len, void *addr)
652 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
654 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
655 unsigned int msg_prio,
656 const struct timespec64 *abs_timeout)
658 static inline void audit_mq_notify(mqd_t mqdes,
659 const struct sigevent *notification)
661 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
663 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
664 const struct cred *new,
665 const struct cred *old)
669 static inline void audit_log_capset(const struct cred *new,
670 const struct cred *old)
672 static inline void audit_mmap_fd(int fd, int flags)
675 static inline void audit_openat2_how(struct open_how *how)
678 static inline void audit_log_kern_module(char *name)
682 static inline void audit_fanotify(unsigned int response)
685 static inline void audit_tk_injoffset(struct timespec64 offset)
688 static inline void audit_ntp_init(struct audit_ntp_data *ad)
691 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
692 enum audit_ntp_type type, long long val)
695 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
696 enum audit_ntp_type type, long long val)
699 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
702 static inline void audit_ptrace(struct task_struct *t)
705 static inline void audit_log_nfcfg(const char *name, u8 af,
706 unsigned int nentries,
707 enum audit_nfcfgop op, gfp_t gfp)
710 #define audit_n_rules 0
711 #define audit_signals 0
712 #endif /* CONFIG_AUDITSYSCALL */
714 static inline bool audit_loginuid_set(struct task_struct *tsk)
716 return uid_valid(audit_get_loginuid(tsk));