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>
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
;
46 u32 mask
[AUDIT_BITMASK_SIZE
];
47 u32 buflen
; /* for data alloc on list rules */
49 char *filterkey
; /* ties events to rules */
50 struct audit_field
*fields
;
51 struct audit_field
*arch_f
; /* quick access to arch field */
52 struct audit_field
*inode_f
; /* quick access to an inode field */
53 struct audit_watch
*watch
; /* associated watch */
54 struct audit_tree
*tree
; /* associated watched tree */
55 struct audit_fsnotify_mark
*exe
;
56 struct list_head rlist
; /* entry in audit_{watch,tree}.rules list */
57 struct list_head list
; /* for AUDIT_LIST* purposes only */
61 /* Flag to indicate legacy AUDIT_LOGINUID unset usage */
62 #define AUDIT_LOGINUID_LEGACY 0x1
86 AUDIT_NTP_NVALS
/* count */
89 #ifdef CONFIG_AUDITSYSCALL
90 struct audit_ntp_val
{
91 long long oldval
, newval
;
94 struct audit_ntp_data
{
95 struct audit_ntp_val vals
[AUDIT_NTP_NVALS
];
98 struct audit_ntp_data
{};
102 AUDIT_XT_OP_REGISTER
,
104 AUDIT_XT_OP_UNREGISTER
,
105 AUDIT_NFT_OP_TABLE_REGISTER
,
106 AUDIT_NFT_OP_TABLE_UNREGISTER
,
107 AUDIT_NFT_OP_CHAIN_REGISTER
,
108 AUDIT_NFT_OP_CHAIN_UNREGISTER
,
109 AUDIT_NFT_OP_RULE_REGISTER
,
110 AUDIT_NFT_OP_RULE_UNREGISTER
,
111 AUDIT_NFT_OP_SET_REGISTER
,
112 AUDIT_NFT_OP_SET_UNREGISTER
,
113 AUDIT_NFT_OP_SETELEM_REGISTER
,
114 AUDIT_NFT_OP_SETELEM_UNREGISTER
,
115 AUDIT_NFT_OP_GEN_REGISTER
,
116 AUDIT_NFT_OP_OBJ_REGISTER
,
117 AUDIT_NFT_OP_OBJ_UNREGISTER
,
118 AUDIT_NFT_OP_OBJ_RESET
,
119 AUDIT_NFT_OP_FLOWTABLE_REGISTER
,
120 AUDIT_NFT_OP_FLOWTABLE_UNREGISTER
,
121 AUDIT_NFT_OP_SETELEM_RESET
,
122 AUDIT_NFT_OP_RULE_RESET
,
123 AUDIT_NFT_OP_INVALID
,
126 extern int __init
audit_register_class(int class, unsigned *list
);
127 extern int audit_classify_syscall(int abi
, unsigned syscall
);
128 extern int audit_classify_arch(int arch
);
129 /* only for compat system calls */
130 extern unsigned compat_write_class
[];
131 extern unsigned compat_read_class
[];
132 extern unsigned compat_dir_class
[];
133 extern unsigned compat_chattr_class
[];
134 extern unsigned compat_signal_class
[];
136 /* audit_names->type values */
137 #define AUDIT_TYPE_UNKNOWN 0 /* we don't know yet */
138 #define AUDIT_TYPE_NORMAL 1 /* a "normal" audit record */
139 #define AUDIT_TYPE_PARENT 2 /* a parent audit record */
140 #define AUDIT_TYPE_CHILD_DELETE 3 /* a child being deleted */
141 #define AUDIT_TYPE_CHILD_CREATE 4 /* a child being created */
143 /* maximized args number that audit_socketcall can process */
144 #define AUDITSC_ARGS 6
146 /* bit values for ->signal->audit_tty */
147 #define AUDIT_TTY_ENABLE BIT(0)
148 #define AUDIT_TTY_LOG_PASSWD BIT(1)
154 #define AUDIT_LOCKED 2
156 /* These are defined in audit.c */
158 extern __printf(4, 5)
159 void audit_log(struct audit_context
*ctx
, gfp_t gfp_mask
, int type
,
160 const char *fmt
, ...);
162 extern struct audit_buffer
*audit_log_start(struct audit_context
*ctx
, gfp_t gfp_mask
, int type
);
163 extern __printf(2, 3)
164 void audit_log_format(struct audit_buffer
*ab
, const char *fmt
, ...);
165 extern void audit_log_end(struct audit_buffer
*ab
);
166 extern bool audit_string_contains_control(const char *string
,
168 extern void audit_log_n_hex(struct audit_buffer
*ab
,
169 const unsigned char *buf
,
171 extern void audit_log_n_string(struct audit_buffer
*ab
,
174 extern void audit_log_n_untrustedstring(struct audit_buffer
*ab
,
177 extern void audit_log_untrustedstring(struct audit_buffer
*ab
,
179 extern void audit_log_d_path(struct audit_buffer
*ab
,
181 const struct path
*path
);
182 extern void audit_log_key(struct audit_buffer
*ab
,
184 extern void audit_log_path_denied(int type
,
185 const char *operation
);
186 extern void audit_log_lost(const char *message
);
188 extern int audit_log_task_context(struct audit_buffer
*ab
);
189 extern void audit_log_task_info(struct audit_buffer
*ab
);
191 extern int audit_update_lsm_rules(void);
193 /* Private API (for audit.c only) */
194 extern int audit_rule_change(int type
, int seq
, void *data
, size_t datasz
);
195 extern int audit_list_rules_send(struct sk_buff
*request_skb
, int seq
);
197 extern int audit_set_loginuid(kuid_t loginuid
);
199 static inline kuid_t
audit_get_loginuid(struct task_struct
*tsk
)
201 return tsk
->loginuid
;
204 static inline unsigned int audit_get_sessionid(struct task_struct
*tsk
)
206 return tsk
->sessionid
;
209 extern u32 audit_enabled
;
211 extern int audit_signal_info(int sig
, struct task_struct
*t
);
213 #else /* CONFIG_AUDIT */
214 static inline __printf(4, 5)
215 void audit_log(struct audit_context
*ctx
, gfp_t gfp_mask
, int type
,
216 const char *fmt
, ...)
218 static inline struct audit_buffer
*audit_log_start(struct audit_context
*ctx
,
219 gfp_t gfp_mask
, int type
)
223 static inline __printf(2, 3)
224 void audit_log_format(struct audit_buffer
*ab
, const char *fmt
, ...)
226 static inline void audit_log_end(struct audit_buffer
*ab
)
228 static inline void audit_log_n_hex(struct audit_buffer
*ab
,
229 const unsigned char *buf
, size_t len
)
231 static inline void audit_log_n_string(struct audit_buffer
*ab
,
232 const char *buf
, size_t n
)
234 static inline void audit_log_n_untrustedstring(struct audit_buffer
*ab
,
235 const char *string
, size_t n
)
237 static inline void audit_log_untrustedstring(struct audit_buffer
*ab
,
240 static inline void audit_log_d_path(struct audit_buffer
*ab
,
242 const struct path
*path
)
244 static inline void audit_log_key(struct audit_buffer
*ab
, char *key
)
246 static inline void audit_log_path_denied(int type
, const char *operation
)
248 static inline int audit_log_task_context(struct audit_buffer
*ab
)
252 static inline void audit_log_task_info(struct audit_buffer
*ab
)
255 static inline kuid_t
audit_get_loginuid(struct task_struct
*tsk
)
260 static inline unsigned int audit_get_sessionid(struct task_struct
*tsk
)
262 return AUDIT_SID_UNSET
;
265 #define audit_enabled AUDIT_OFF
267 static inline int audit_signal_info(int sig
, struct task_struct
*t
)
272 #endif /* CONFIG_AUDIT */
274 #ifdef CONFIG_AUDIT_COMPAT_GENERIC
275 #define audit_is_compat(arch) (!((arch) & __AUDIT_ARCH_64BIT))
277 #define audit_is_compat(arch) false
280 #define AUDIT_INODE_PARENT 1 /* dentry represents the parent */
281 #define AUDIT_INODE_HIDDEN 2 /* audit record should be hidden */
282 #define AUDIT_INODE_NOEVAL 4 /* audit record incomplete */
284 #ifdef CONFIG_AUDITSYSCALL
285 #include <asm/syscall.h> /* for syscall_get_arch() */
287 /* These are defined in auditsc.c */
289 extern int audit_alloc(struct task_struct
*task
);
290 extern void __audit_free(struct task_struct
*task
);
291 extern void __audit_uring_entry(u8 op
);
292 extern void __audit_uring_exit(int success
, long code
);
293 extern void __audit_syscall_entry(int major
, unsigned long a0
, unsigned long a1
,
294 unsigned long a2
, unsigned long a3
);
295 extern void __audit_syscall_exit(int ret_success
, long ret_value
);
296 extern struct filename
*__audit_reusename(const __user
char *uptr
);
297 extern void __audit_getname(struct filename
*name
);
298 extern void __audit_inode(struct filename
*name
, const struct dentry
*dentry
,
300 extern void __audit_file(const struct file
*);
301 extern void __audit_inode_child(struct inode
*parent
,
302 const struct dentry
*dentry
,
303 const unsigned char type
);
304 extern void audit_seccomp(unsigned long syscall
, long signr
, int code
);
305 extern void audit_seccomp_actions_logged(const char *names
,
306 const char *old_names
, int res
);
307 extern void __audit_ptrace(struct task_struct
*t
);
309 static inline void audit_set_context(struct task_struct
*task
, struct audit_context
*ctx
)
311 task
->audit_context
= ctx
;
314 static inline struct audit_context
*audit_context(void)
316 return current
->audit_context
;
319 static inline bool audit_dummy_context(void)
321 void *p
= audit_context();
322 return !p
|| *(int *)p
;
324 static inline void audit_free(struct task_struct
*task
)
326 if (unlikely(task
->audit_context
))
329 static inline void audit_uring_entry(u8 op
)
332 * We intentionally check audit_context() before audit_enabled as most
333 * Linux systems (as of ~2021) rely on systemd which forces audit to
334 * be enabled regardless of the user's audit configuration.
336 if (unlikely(audit_context() && audit_enabled
))
337 __audit_uring_entry(op
);
339 static inline void audit_uring_exit(int success
, long code
)
341 if (unlikely(audit_context()))
342 __audit_uring_exit(success
, code
);
344 static inline void audit_syscall_entry(int major
, unsigned long a0
,
345 unsigned long a1
, unsigned long a2
,
348 if (unlikely(audit_context()))
349 __audit_syscall_entry(major
, a0
, a1
, a2
, a3
);
351 static inline void audit_syscall_exit(void *pt_regs
)
353 if (unlikely(audit_context())) {
354 int success
= is_syscall_success(pt_regs
);
355 long return_code
= regs_return_value(pt_regs
);
357 __audit_syscall_exit(success
, return_code
);
360 static inline struct filename
*audit_reusename(const __user
char *name
)
362 if (unlikely(!audit_dummy_context()))
363 return __audit_reusename(name
);
366 static inline void audit_getname(struct filename
*name
)
368 if (unlikely(!audit_dummy_context()))
369 __audit_getname(name
);
371 static inline void audit_inode(struct filename
*name
,
372 const struct dentry
*dentry
,
373 unsigned int aflags
) {
374 if (unlikely(!audit_dummy_context()))
375 __audit_inode(name
, dentry
, aflags
);
377 static inline void audit_file(struct file
*file
)
379 if (unlikely(!audit_dummy_context()))
382 static inline void audit_inode_parent_hidden(struct filename
*name
,
383 const struct dentry
*dentry
)
385 if (unlikely(!audit_dummy_context()))
386 __audit_inode(name
, dentry
,
387 AUDIT_INODE_PARENT
| AUDIT_INODE_HIDDEN
);
389 static inline void audit_inode_child(struct inode
*parent
,
390 const struct dentry
*dentry
,
391 const unsigned char type
) {
392 if (unlikely(!audit_dummy_context()))
393 __audit_inode_child(parent
, dentry
, type
);
395 void audit_core_dumps(long signr
);
397 static inline void audit_ptrace(struct task_struct
*t
)
399 if (unlikely(!audit_dummy_context()))
403 /* Private API (for audit.c only) */
404 extern void __audit_ipc_obj(struct kern_ipc_perm
*ipcp
);
405 extern void __audit_ipc_set_perm(unsigned long qbytes
, uid_t uid
, gid_t gid
, umode_t mode
);
406 extern void __audit_bprm(struct linux_binprm
*bprm
);
407 extern int __audit_socketcall(int nargs
, unsigned long *args
);
408 extern int __audit_sockaddr(int len
, void *addr
);
409 extern void __audit_fd_pair(int fd1
, int fd2
);
410 extern void __audit_mq_open(int oflag
, umode_t mode
, struct mq_attr
*attr
);
411 extern void __audit_mq_sendrecv(mqd_t mqdes
, size_t msg_len
, unsigned int msg_prio
, const struct timespec64
*abs_timeout
);
412 extern void __audit_mq_notify(mqd_t mqdes
, const struct sigevent
*notification
);
413 extern void __audit_mq_getsetattr(mqd_t mqdes
, struct mq_attr
*mqstat
);
414 extern int __audit_log_bprm_fcaps(struct linux_binprm
*bprm
,
415 const struct cred
*new,
416 const struct cred
*old
);
417 extern void __audit_log_capset(const struct cred
*new, const struct cred
*old
);
418 extern void __audit_mmap_fd(int fd
, int flags
);
419 extern void __audit_openat2_how(struct open_how
*how
);
420 extern void __audit_log_kern_module(char *name
);
421 extern void __audit_fanotify(u32 response
, struct fanotify_response_info_audit_rule
*friar
);
422 extern void __audit_tk_injoffset(struct timespec64 offset
);
423 extern void __audit_ntp_log(const struct audit_ntp_data
*ad
);
424 extern void __audit_log_nfcfg(const char *name
, u8 af
, unsigned int nentries
,
425 enum audit_nfcfgop op
, gfp_t gfp
);
427 static inline void audit_ipc_obj(struct kern_ipc_perm
*ipcp
)
429 if (unlikely(!audit_dummy_context()))
430 __audit_ipc_obj(ipcp
);
432 static inline void audit_fd_pair(int fd1
, int fd2
)
434 if (unlikely(!audit_dummy_context()))
435 __audit_fd_pair(fd1
, fd2
);
437 static inline void audit_ipc_set_perm(unsigned long qbytes
, uid_t uid
, gid_t gid
, umode_t mode
)
439 if (unlikely(!audit_dummy_context()))
440 __audit_ipc_set_perm(qbytes
, uid
, gid
, mode
);
442 static inline void audit_bprm(struct linux_binprm
*bprm
)
444 if (unlikely(!audit_dummy_context()))
447 static inline int audit_socketcall(int nargs
, unsigned long *args
)
449 if (unlikely(!audit_dummy_context()))
450 return __audit_socketcall(nargs
, args
);
454 static inline int audit_socketcall_compat(int nargs
, u32
*args
)
456 unsigned long a
[AUDITSC_ARGS
];
459 if (audit_dummy_context())
462 for (i
= 0; i
< nargs
; i
++)
463 a
[i
] = (unsigned long)args
[i
];
464 return __audit_socketcall(nargs
, a
);
467 static inline int audit_sockaddr(int len
, void *addr
)
469 if (unlikely(!audit_dummy_context()))
470 return __audit_sockaddr(len
, addr
);
473 static inline void audit_mq_open(int oflag
, umode_t mode
, struct mq_attr
*attr
)
475 if (unlikely(!audit_dummy_context()))
476 __audit_mq_open(oflag
, mode
, attr
);
478 static inline void audit_mq_sendrecv(mqd_t mqdes
, size_t msg_len
, unsigned int msg_prio
, const struct timespec64
*abs_timeout
)
480 if (unlikely(!audit_dummy_context()))
481 __audit_mq_sendrecv(mqdes
, msg_len
, msg_prio
, abs_timeout
);
483 static inline void audit_mq_notify(mqd_t mqdes
, const struct sigevent
*notification
)
485 if (unlikely(!audit_dummy_context()))
486 __audit_mq_notify(mqdes
, notification
);
488 static inline void audit_mq_getsetattr(mqd_t mqdes
, struct mq_attr
*mqstat
)
490 if (unlikely(!audit_dummy_context()))
491 __audit_mq_getsetattr(mqdes
, mqstat
);
494 static inline int audit_log_bprm_fcaps(struct linux_binprm
*bprm
,
495 const struct cred
*new,
496 const struct cred
*old
)
498 if (unlikely(!audit_dummy_context()))
499 return __audit_log_bprm_fcaps(bprm
, new, old
);
503 static inline void audit_log_capset(const struct cred
*new,
504 const struct cred
*old
)
506 if (unlikely(!audit_dummy_context()))
507 __audit_log_capset(new, old
);
510 static inline void audit_mmap_fd(int fd
, int flags
)
512 if (unlikely(!audit_dummy_context()))
513 __audit_mmap_fd(fd
, flags
);
516 static inline void audit_openat2_how(struct open_how
*how
)
518 if (unlikely(!audit_dummy_context()))
519 __audit_openat2_how(how
);
522 static inline void audit_log_kern_module(char *name
)
524 if (!audit_dummy_context())
525 __audit_log_kern_module(name
);
528 static inline void audit_fanotify(u32 response
, struct fanotify_response_info_audit_rule
*friar
)
530 if (!audit_dummy_context())
531 __audit_fanotify(response
, friar
);
534 static inline void audit_tk_injoffset(struct timespec64 offset
)
536 /* ignore no-op events */
537 if (offset
.tv_sec
== 0 && offset
.tv_nsec
== 0)
540 if (!audit_dummy_context())
541 __audit_tk_injoffset(offset
);
544 static inline void audit_ntp_init(struct audit_ntp_data
*ad
)
546 memset(ad
, 0, sizeof(*ad
));
549 static inline void audit_ntp_set_old(struct audit_ntp_data
*ad
,
550 enum audit_ntp_type type
, long long val
)
552 ad
->vals
[type
].oldval
= val
;
555 static inline void audit_ntp_set_new(struct audit_ntp_data
*ad
,
556 enum audit_ntp_type type
, long long val
)
558 ad
->vals
[type
].newval
= val
;
561 static inline void audit_ntp_log(const struct audit_ntp_data
*ad
)
563 if (!audit_dummy_context())
567 static inline void audit_log_nfcfg(const char *name
, u8 af
,
568 unsigned int nentries
,
569 enum audit_nfcfgop op
, gfp_t gfp
)
572 __audit_log_nfcfg(name
, af
, nentries
, op
, gfp
);
575 extern int audit_n_rules
;
576 extern int audit_signals
;
577 #else /* CONFIG_AUDITSYSCALL */
578 static inline int audit_alloc(struct task_struct
*task
)
582 static inline void audit_free(struct task_struct
*task
)
584 static inline void audit_uring_entry(u8 op
)
586 static inline void audit_uring_exit(int success
, long code
)
588 static inline void audit_syscall_entry(int major
, unsigned long a0
,
589 unsigned long a1
, unsigned long a2
,
592 static inline void audit_syscall_exit(void *pt_regs
)
594 static inline bool audit_dummy_context(void)
598 static inline void audit_set_context(struct task_struct
*task
, struct audit_context
*ctx
)
600 static inline struct audit_context
*audit_context(void)
604 static inline struct filename
*audit_reusename(const __user
char *name
)
608 static inline void audit_getname(struct filename
*name
)
610 static inline void audit_inode(struct filename
*name
,
611 const struct dentry
*dentry
,
614 static inline void audit_file(struct file
*file
)
617 static inline void audit_inode_parent_hidden(struct filename
*name
,
618 const struct dentry
*dentry
)
620 static inline void audit_inode_child(struct inode
*parent
,
621 const struct dentry
*dentry
,
622 const unsigned char type
)
624 static inline void audit_core_dumps(long signr
)
626 static inline void audit_seccomp(unsigned long syscall
, long signr
, int code
)
628 static inline void audit_seccomp_actions_logged(const char *names
,
629 const char *old_names
, int res
)
631 static inline void audit_ipc_obj(struct kern_ipc_perm
*ipcp
)
633 static inline void audit_ipc_set_perm(unsigned long qbytes
, uid_t uid
,
634 gid_t gid
, umode_t mode
)
636 static inline void audit_bprm(struct linux_binprm
*bprm
)
638 static inline int audit_socketcall(int nargs
, unsigned long *args
)
643 static inline int audit_socketcall_compat(int nargs
, u32
*args
)
648 static inline void audit_fd_pair(int fd1
, int fd2
)
650 static inline int audit_sockaddr(int len
, void *addr
)
654 static inline void audit_mq_open(int oflag
, umode_t mode
, struct mq_attr
*attr
)
656 static inline void audit_mq_sendrecv(mqd_t mqdes
, size_t msg_len
,
657 unsigned int msg_prio
,
658 const struct timespec64
*abs_timeout
)
660 static inline void audit_mq_notify(mqd_t mqdes
,
661 const struct sigevent
*notification
)
663 static inline void audit_mq_getsetattr(mqd_t mqdes
, struct mq_attr
*mqstat
)
665 static inline int audit_log_bprm_fcaps(struct linux_binprm
*bprm
,
666 const struct cred
*new,
667 const struct cred
*old
)
671 static inline void audit_log_capset(const struct cred
*new,
672 const struct cred
*old
)
674 static inline void audit_mmap_fd(int fd
, int flags
)
677 static inline void audit_openat2_how(struct open_how
*how
)
680 static inline void audit_log_kern_module(char *name
)
684 static inline void audit_fanotify(u32 response
, struct fanotify_response_info_audit_rule
*friar
)
687 static inline void audit_tk_injoffset(struct timespec64 offset
)
690 static inline void audit_ntp_init(struct audit_ntp_data
*ad
)
693 static inline void audit_ntp_set_old(struct audit_ntp_data
*ad
,
694 enum audit_ntp_type type
, long long val
)
697 static inline void audit_ntp_set_new(struct audit_ntp_data
*ad
,
698 enum audit_ntp_type type
, long long val
)
701 static inline void audit_ntp_log(const struct audit_ntp_data
*ad
)
704 static inline void audit_ptrace(struct task_struct
*t
)
707 static inline void audit_log_nfcfg(const char *name
, u8 af
,
708 unsigned int nentries
,
709 enum audit_nfcfgop op
, gfp_t gfp
)
712 #define audit_n_rules 0
713 #define audit_signals 0
714 #endif /* CONFIG_AUDITSYSCALL */
716 static inline bool audit_loginuid_set(struct task_struct
*tsk
)
718 return uid_valid(audit_get_loginuid(tsk
));