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>
17 #include <uapi/linux/fanotify.h>
19 #define AUDIT_INO_UNSET ((unsigned long)-1)
20 #define AUDIT_DEV_UNSET ((dev_t)-1)
22 struct audit_sig_info {
31 struct netlink_skb_parms;
45 u32 mask[AUDIT_BITMASK_SIZE];
46 u32 buflen; /* for data alloc on list rules */
48 char *filterkey; /* ties events to rules */
49 struct audit_field *fields;
50 struct audit_field *arch_f; /* quick access to arch field */
51 struct audit_field *inode_f; /* quick access to an inode field */
52 struct audit_watch *watch; /* associated watch */
53 struct audit_tree *tree; /* associated watched tree */
54 struct audit_fsnotify_mark *exe;
55 struct list_head rlist; /* entry in audit_{watch,tree}.rules list */
56 struct list_head list; /* for AUDIT_LIST* purposes only */
60 /* Flag to indicate legacy AUDIT_LOGINUID unset usage */
61 #define AUDIT_LOGINUID_LEGACY 0x1
85 AUDIT_NTP_NVALS /* count */
88 #ifdef CONFIG_AUDITSYSCALL
89 struct audit_ntp_val {
90 long long oldval, newval;
93 struct audit_ntp_data {
94 struct audit_ntp_val vals[AUDIT_NTP_NVALS];
97 struct audit_ntp_data {};
101 AUDIT_XT_OP_REGISTER,
103 AUDIT_XT_OP_UNREGISTER,
104 AUDIT_NFT_OP_TABLE_REGISTER,
105 AUDIT_NFT_OP_TABLE_UNREGISTER,
106 AUDIT_NFT_OP_CHAIN_REGISTER,
107 AUDIT_NFT_OP_CHAIN_UNREGISTER,
108 AUDIT_NFT_OP_RULE_REGISTER,
109 AUDIT_NFT_OP_RULE_UNREGISTER,
110 AUDIT_NFT_OP_SET_REGISTER,
111 AUDIT_NFT_OP_SET_UNREGISTER,
112 AUDIT_NFT_OP_SETELEM_REGISTER,
113 AUDIT_NFT_OP_SETELEM_UNREGISTER,
114 AUDIT_NFT_OP_GEN_REGISTER,
115 AUDIT_NFT_OP_OBJ_REGISTER,
116 AUDIT_NFT_OP_OBJ_UNREGISTER,
117 AUDIT_NFT_OP_OBJ_RESET,
118 AUDIT_NFT_OP_FLOWTABLE_REGISTER,
119 AUDIT_NFT_OP_FLOWTABLE_UNREGISTER,
120 AUDIT_NFT_OP_INVALID,
123 extern int __init audit_register_class(int class, unsigned *list);
124 extern int audit_classify_syscall(int abi, unsigned syscall);
125 extern int audit_classify_arch(int arch);
126 /* only for compat system calls */
127 extern unsigned compat_write_class[];
128 extern unsigned compat_read_class[];
129 extern unsigned compat_dir_class[];
130 extern unsigned compat_chattr_class[];
131 extern unsigned compat_signal_class[];
133 /* audit_names->type values */
134 #define AUDIT_TYPE_UNKNOWN 0 /* we don't know yet */
135 #define AUDIT_TYPE_NORMAL 1 /* a "normal" audit record */
136 #define AUDIT_TYPE_PARENT 2 /* a parent audit record */
137 #define AUDIT_TYPE_CHILD_DELETE 3 /* a child being deleted */
138 #define AUDIT_TYPE_CHILD_CREATE 4 /* a child being created */
140 /* maximized args number that audit_socketcall can process */
141 #define AUDITSC_ARGS 6
143 /* bit values for ->signal->audit_tty */
144 #define AUDIT_TTY_ENABLE BIT(0)
145 #define AUDIT_TTY_LOG_PASSWD BIT(1)
151 #define AUDIT_LOCKED 2
153 /* These are defined in audit.c */
155 extern __printf(4, 5)
156 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
157 const char *fmt, ...);
159 extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
160 extern __printf(2, 3)
161 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...);
162 extern void audit_log_end(struct audit_buffer *ab);
163 extern bool audit_string_contains_control(const char *string,
165 extern void audit_log_n_hex(struct audit_buffer *ab,
166 const unsigned char *buf,
168 extern void audit_log_n_string(struct audit_buffer *ab,
171 extern void audit_log_n_untrustedstring(struct audit_buffer *ab,
174 extern void audit_log_untrustedstring(struct audit_buffer *ab,
176 extern void audit_log_d_path(struct audit_buffer *ab,
178 const struct path *path);
179 extern void audit_log_key(struct audit_buffer *ab,
181 extern void audit_log_path_denied(int type,
182 const char *operation);
183 extern void audit_log_lost(const char *message);
185 extern int audit_log_task_context(struct audit_buffer *ab);
186 extern void audit_log_task_info(struct audit_buffer *ab);
188 extern int audit_update_lsm_rules(void);
190 /* Private API (for audit.c only) */
191 extern int audit_rule_change(int type, int seq, void *data, size_t datasz);
192 extern int audit_list_rules_send(struct sk_buff *request_skb, int seq);
194 extern int audit_set_loginuid(kuid_t loginuid);
196 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
198 return tsk->loginuid;
201 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
203 return tsk->sessionid;
206 extern u32 audit_enabled;
208 extern int audit_signal_info(int sig, struct task_struct *t);
210 #else /* CONFIG_AUDIT */
211 static inline __printf(4, 5)
212 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
213 const char *fmt, ...)
215 static inline struct audit_buffer *audit_log_start(struct audit_context *ctx,
216 gfp_t gfp_mask, int type)
220 static inline __printf(2, 3)
221 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
223 static inline void audit_log_end(struct audit_buffer *ab)
225 static inline void audit_log_n_hex(struct audit_buffer *ab,
226 const unsigned char *buf, size_t len)
228 static inline void audit_log_n_string(struct audit_buffer *ab,
229 const char *buf, size_t n)
231 static inline void audit_log_n_untrustedstring(struct audit_buffer *ab,
232 const char *string, size_t n)
234 static inline void audit_log_untrustedstring(struct audit_buffer *ab,
237 static inline void audit_log_d_path(struct audit_buffer *ab,
239 const struct path *path)
241 static inline void audit_log_key(struct audit_buffer *ab, char *key)
243 static inline void audit_log_path_denied(int type, const char *operation)
245 static inline int audit_log_task_context(struct audit_buffer *ab)
249 static inline void audit_log_task_info(struct audit_buffer *ab)
252 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
257 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
259 return AUDIT_SID_UNSET;
262 #define audit_enabled AUDIT_OFF
264 static inline int audit_signal_info(int sig, struct task_struct *t)
269 #endif /* CONFIG_AUDIT */
271 #ifdef CONFIG_AUDIT_COMPAT_GENERIC
272 #define audit_is_compat(arch) (!((arch) & __AUDIT_ARCH_64BIT))
274 #define audit_is_compat(arch) false
277 #define AUDIT_INODE_PARENT 1 /* dentry represents the parent */
278 #define AUDIT_INODE_HIDDEN 2 /* audit record should be hidden */
279 #define AUDIT_INODE_NOEVAL 4 /* audit record incomplete */
281 #ifdef CONFIG_AUDITSYSCALL
282 #include <asm/syscall.h> /* for syscall_get_arch() */
284 /* These are defined in auditsc.c */
286 extern int audit_alloc(struct task_struct *task);
287 extern void __audit_free(struct task_struct *task);
288 extern void __audit_uring_entry(u8 op);
289 extern void __audit_uring_exit(int success, long code);
290 extern void __audit_syscall_entry(int major, unsigned long a0, unsigned long a1,
291 unsigned long a2, unsigned long a3);
292 extern void __audit_syscall_exit(int ret_success, long ret_value);
293 extern struct filename *__audit_reusename(const __user char *uptr);
294 extern void __audit_getname(struct filename *name);
295 extern void __audit_inode(struct filename *name, const struct dentry *dentry,
297 extern void __audit_file(const struct file *);
298 extern void __audit_inode_child(struct inode *parent,
299 const struct dentry *dentry,
300 const unsigned char type);
301 extern void audit_seccomp(unsigned long syscall, long signr, int code);
302 extern void audit_seccomp_actions_logged(const char *names,
303 const char *old_names, int res);
304 extern void __audit_ptrace(struct task_struct *t);
306 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
308 task->audit_context = ctx;
311 static inline struct audit_context *audit_context(void)
313 return current->audit_context;
316 static inline bool audit_dummy_context(void)
318 void *p = audit_context();
319 return !p || *(int *)p;
321 static inline void audit_free(struct task_struct *task)
323 if (unlikely(task->audit_context))
326 static inline void audit_uring_entry(u8 op)
329 * We intentionally check audit_context() before audit_enabled as most
330 * Linux systems (as of ~2021) rely on systemd which forces audit to
331 * be enabled regardless of the user's audit configuration.
333 if (unlikely(audit_context() && audit_enabled))
334 __audit_uring_entry(op);
336 static inline void audit_uring_exit(int success, long code)
338 if (unlikely(audit_context()))
339 __audit_uring_exit(success, code);
341 static inline void audit_syscall_entry(int major, unsigned long a0,
342 unsigned long a1, unsigned long a2,
345 if (unlikely(audit_context()))
346 __audit_syscall_entry(major, a0, a1, a2, a3);
348 static inline void audit_syscall_exit(void *pt_regs)
350 if (unlikely(audit_context())) {
351 int success = is_syscall_success(pt_regs);
352 long return_code = regs_return_value(pt_regs);
354 __audit_syscall_exit(success, return_code);
357 static inline struct filename *audit_reusename(const __user char *name)
359 if (unlikely(!audit_dummy_context()))
360 return __audit_reusename(name);
363 static inline void audit_getname(struct filename *name)
365 if (unlikely(!audit_dummy_context()))
366 __audit_getname(name);
368 static inline void audit_inode(struct filename *name,
369 const struct dentry *dentry,
370 unsigned int aflags) {
371 if (unlikely(!audit_dummy_context()))
372 __audit_inode(name, dentry, aflags);
374 static inline void audit_file(struct file *file)
376 if (unlikely(!audit_dummy_context()))
379 static inline void audit_inode_parent_hidden(struct filename *name,
380 const struct dentry *dentry)
382 if (unlikely(!audit_dummy_context()))
383 __audit_inode(name, dentry,
384 AUDIT_INODE_PARENT | AUDIT_INODE_HIDDEN);
386 static inline void audit_inode_child(struct inode *parent,
387 const struct dentry *dentry,
388 const unsigned char type) {
389 if (unlikely(!audit_dummy_context()))
390 __audit_inode_child(parent, dentry, type);
392 void audit_core_dumps(long signr);
394 static inline void audit_ptrace(struct task_struct *t)
396 if (unlikely(!audit_dummy_context()))
400 /* Private API (for audit.c only) */
401 extern void __audit_ipc_obj(struct kern_ipc_perm *ipcp);
402 extern void __audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode);
403 extern void __audit_bprm(struct linux_binprm *bprm);
404 extern int __audit_socketcall(int nargs, unsigned long *args);
405 extern int __audit_sockaddr(int len, void *addr);
406 extern void __audit_fd_pair(int fd1, int fd2);
407 extern void __audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr);
408 extern void __audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout);
409 extern void __audit_mq_notify(mqd_t mqdes, const struct sigevent *notification);
410 extern void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat);
411 extern int __audit_log_bprm_fcaps(struct linux_binprm *bprm,
412 const struct cred *new,
413 const struct cred *old);
414 extern void __audit_log_capset(const struct cred *new, const struct cred *old);
415 extern void __audit_mmap_fd(int fd, int flags);
416 extern void __audit_openat2_how(struct open_how *how);
417 extern void __audit_log_kern_module(char *name);
418 extern void __audit_fanotify(u32 response, struct fanotify_response_info_audit_rule *friar);
419 extern void __audit_tk_injoffset(struct timespec64 offset);
420 extern void __audit_ntp_log(const struct audit_ntp_data *ad);
421 extern void __audit_log_nfcfg(const char *name, u8 af, unsigned int nentries,
422 enum audit_nfcfgop op, gfp_t gfp);
424 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
426 if (unlikely(!audit_dummy_context()))
427 __audit_ipc_obj(ipcp);
429 static inline void audit_fd_pair(int fd1, int fd2)
431 if (unlikely(!audit_dummy_context()))
432 __audit_fd_pair(fd1, fd2);
434 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode)
436 if (unlikely(!audit_dummy_context()))
437 __audit_ipc_set_perm(qbytes, uid, gid, mode);
439 static inline void audit_bprm(struct linux_binprm *bprm)
441 if (unlikely(!audit_dummy_context()))
444 static inline int audit_socketcall(int nargs, unsigned long *args)
446 if (unlikely(!audit_dummy_context()))
447 return __audit_socketcall(nargs, args);
451 static inline int audit_socketcall_compat(int nargs, u32 *args)
453 unsigned long a[AUDITSC_ARGS];
456 if (audit_dummy_context())
459 for (i = 0; i < nargs; i++)
460 a[i] = (unsigned long)args[i];
461 return __audit_socketcall(nargs, a);
464 static inline int audit_sockaddr(int len, void *addr)
466 if (unlikely(!audit_dummy_context()))
467 return __audit_sockaddr(len, addr);
470 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
472 if (unlikely(!audit_dummy_context()))
473 __audit_mq_open(oflag, mode, attr);
475 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout)
477 if (unlikely(!audit_dummy_context()))
478 __audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
480 static inline void audit_mq_notify(mqd_t mqdes, const struct sigevent *notification)
482 if (unlikely(!audit_dummy_context()))
483 __audit_mq_notify(mqdes, notification);
485 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
487 if (unlikely(!audit_dummy_context()))
488 __audit_mq_getsetattr(mqdes, mqstat);
491 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
492 const struct cred *new,
493 const struct cred *old)
495 if (unlikely(!audit_dummy_context()))
496 return __audit_log_bprm_fcaps(bprm, new, old);
500 static inline void audit_log_capset(const struct cred *new,
501 const struct cred *old)
503 if (unlikely(!audit_dummy_context()))
504 __audit_log_capset(new, old);
507 static inline void audit_mmap_fd(int fd, int flags)
509 if (unlikely(!audit_dummy_context()))
510 __audit_mmap_fd(fd, flags);
513 static inline void audit_openat2_how(struct open_how *how)
515 if (unlikely(!audit_dummy_context()))
516 __audit_openat2_how(how);
519 static inline void audit_log_kern_module(char *name)
521 if (!audit_dummy_context())
522 __audit_log_kern_module(name);
525 static inline void audit_fanotify(u32 response, struct fanotify_response_info_audit_rule *friar)
527 if (!audit_dummy_context())
528 __audit_fanotify(response, friar);
531 static inline void audit_tk_injoffset(struct timespec64 offset)
533 /* ignore no-op events */
534 if (offset.tv_sec == 0 && offset.tv_nsec == 0)
537 if (!audit_dummy_context())
538 __audit_tk_injoffset(offset);
541 static inline void audit_ntp_init(struct audit_ntp_data *ad)
543 memset(ad, 0, sizeof(*ad));
546 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
547 enum audit_ntp_type type, long long val)
549 ad->vals[type].oldval = val;
552 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
553 enum audit_ntp_type type, long long val)
555 ad->vals[type].newval = val;
558 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
560 if (!audit_dummy_context())
564 static inline void audit_log_nfcfg(const char *name, u8 af,
565 unsigned int nentries,
566 enum audit_nfcfgop op, gfp_t gfp)
569 __audit_log_nfcfg(name, af, nentries, op, gfp);
572 extern int audit_n_rules;
573 extern int audit_signals;
574 #else /* CONFIG_AUDITSYSCALL */
575 static inline int audit_alloc(struct task_struct *task)
579 static inline void audit_free(struct task_struct *task)
581 static inline void audit_uring_entry(u8 op)
583 static inline void audit_uring_exit(int success, long code)
585 static inline void audit_syscall_entry(int major, unsigned long a0,
586 unsigned long a1, unsigned long a2,
589 static inline void audit_syscall_exit(void *pt_regs)
591 static inline bool audit_dummy_context(void)
595 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
597 static inline struct audit_context *audit_context(void)
601 static inline struct filename *audit_reusename(const __user char *name)
605 static inline void audit_getname(struct filename *name)
607 static inline void audit_inode(struct filename *name,
608 const struct dentry *dentry,
611 static inline void audit_file(struct file *file)
614 static inline void audit_inode_parent_hidden(struct filename *name,
615 const struct dentry *dentry)
617 static inline void audit_inode_child(struct inode *parent,
618 const struct dentry *dentry,
619 const unsigned char type)
621 static inline void audit_core_dumps(long signr)
623 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
625 static inline void audit_seccomp_actions_logged(const char *names,
626 const char *old_names, int res)
628 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
630 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
631 gid_t gid, umode_t mode)
633 static inline void audit_bprm(struct linux_binprm *bprm)
635 static inline int audit_socketcall(int nargs, unsigned long *args)
640 static inline int audit_socketcall_compat(int nargs, u32 *args)
645 static inline void audit_fd_pair(int fd1, int fd2)
647 static inline int audit_sockaddr(int len, void *addr)
651 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
653 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
654 unsigned int msg_prio,
655 const struct timespec64 *abs_timeout)
657 static inline void audit_mq_notify(mqd_t mqdes,
658 const struct sigevent *notification)
660 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
662 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
663 const struct cred *new,
664 const struct cred *old)
668 static inline void audit_log_capset(const struct cred *new,
669 const struct cred *old)
671 static inline void audit_mmap_fd(int fd, int flags)
674 static inline void audit_openat2_how(struct open_how *how)
677 static inline void audit_log_kern_module(char *name)
681 static inline void audit_fanotify(u32 response, struct fanotify_response_info_audit_rule *friar)
684 static inline void audit_tk_injoffset(struct timespec64 offset)
687 static inline void audit_ntp_init(struct audit_ntp_data *ad)
690 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
691 enum audit_ntp_type type, long long val)
694 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
695 enum audit_ntp_type type, long long val)
698 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
701 static inline void audit_ptrace(struct task_struct *t)
704 static inline void audit_log_nfcfg(const char *name, u8 af,
705 unsigned int nentries,
706 enum audit_nfcfgop op, gfp_t gfp)
709 #define audit_n_rules 0
710 #define audit_signals 0
711 #endif /* CONFIG_AUDITSYSCALL */
713 static inline bool audit_loginuid_set(struct task_struct *tsk)
715 return uid_valid(audit_get_loginuid(tsk));