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 <uapi/linux/audit.h>
16 #define AUDIT_INO_UNSET ((unsigned long)-1)
17 #define AUDIT_DEV_UNSET ((dev_t)-1)
19 struct audit_sig_info {
28 struct netlink_skb_parms;
42 u32 mask[AUDIT_BITMASK_SIZE];
43 u32 buflen; /* for data alloc on list rules */
45 char *filterkey; /* ties events to rules */
46 struct audit_field *fields;
47 struct audit_field *arch_f; /* quick access to arch field */
48 struct audit_field *inode_f; /* quick access to an inode field */
49 struct audit_watch *watch; /* associated watch */
50 struct audit_tree *tree; /* associated watched tree */
51 struct audit_fsnotify_mark *exe;
52 struct list_head rlist; /* entry in audit_{watch,tree}.rules list */
53 struct list_head list; /* for AUDIT_LIST* purposes only */
57 /* Flag to indicate legacy AUDIT_LOGINUID unset usage */
58 #define AUDIT_LOGINUID_LEGACY 0x1
82 AUDIT_NTP_NVALS /* count */
85 #ifdef CONFIG_AUDITSYSCALL
86 struct audit_ntp_val {
87 long long oldval, newval;
90 struct audit_ntp_data {
91 struct audit_ntp_val vals[AUDIT_NTP_NVALS];
94 struct audit_ntp_data {};
97 extern int is_audit_feature_set(int which);
99 extern int __init audit_register_class(int class, unsigned *list);
100 extern int audit_classify_syscall(int abi, unsigned syscall);
101 extern int audit_classify_arch(int arch);
102 /* only for compat system calls */
103 extern unsigned compat_write_class[];
104 extern unsigned compat_read_class[];
105 extern unsigned compat_dir_class[];
106 extern unsigned compat_chattr_class[];
107 extern unsigned compat_signal_class[];
109 extern int audit_classify_compat_syscall(int abi, unsigned syscall);
111 /* audit_names->type values */
112 #define AUDIT_TYPE_UNKNOWN 0 /* we don't know yet */
113 #define AUDIT_TYPE_NORMAL 1 /* a "normal" audit record */
114 #define AUDIT_TYPE_PARENT 2 /* a parent audit record */
115 #define AUDIT_TYPE_CHILD_DELETE 3 /* a child being deleted */
116 #define AUDIT_TYPE_CHILD_CREATE 4 /* a child being created */
118 /* maximized args number that audit_socketcall can process */
119 #define AUDITSC_ARGS 6
121 /* bit values for ->signal->audit_tty */
122 #define AUDIT_TTY_ENABLE BIT(0)
123 #define AUDIT_TTY_LOG_PASSWD BIT(1)
129 #define AUDIT_LOCKED 2
131 /* These are defined in audit.c */
133 extern __printf(4, 5)
134 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
135 const char *fmt, ...);
137 extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
138 extern __printf(2, 3)
139 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...);
140 extern void audit_log_end(struct audit_buffer *ab);
141 extern bool audit_string_contains_control(const char *string,
143 extern void audit_log_n_hex(struct audit_buffer *ab,
144 const unsigned char *buf,
146 extern void audit_log_n_string(struct audit_buffer *ab,
149 extern void audit_log_n_untrustedstring(struct audit_buffer *ab,
152 extern void audit_log_untrustedstring(struct audit_buffer *ab,
154 extern void audit_log_d_path(struct audit_buffer *ab,
156 const struct path *path);
157 extern void audit_log_key(struct audit_buffer *ab,
159 extern void audit_log_path_denied(int type,
160 const char *operation);
161 extern void audit_log_lost(const char *message);
163 extern int audit_log_task_context(struct audit_buffer *ab);
164 extern void audit_log_task_info(struct audit_buffer *ab);
166 extern int audit_update_lsm_rules(void);
168 /* Private API (for audit.c only) */
169 extern int audit_rule_change(int type, int seq, void *data, size_t datasz);
170 extern int audit_list_rules_send(struct sk_buff *request_skb, int seq);
172 extern int audit_set_loginuid(kuid_t loginuid);
174 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
176 return tsk->loginuid;
179 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
181 return tsk->sessionid;
184 extern u32 audit_enabled;
186 extern int audit_signal_info(int sig, struct task_struct *t);
188 #else /* CONFIG_AUDIT */
189 static inline __printf(4, 5)
190 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
191 const char *fmt, ...)
193 static inline struct audit_buffer *audit_log_start(struct audit_context *ctx,
194 gfp_t gfp_mask, int type)
198 static inline __printf(2, 3)
199 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
201 static inline void audit_log_end(struct audit_buffer *ab)
203 static inline void audit_log_n_hex(struct audit_buffer *ab,
204 const unsigned char *buf, size_t len)
206 static inline void audit_log_n_string(struct audit_buffer *ab,
207 const char *buf, size_t n)
209 static inline void audit_log_n_untrustedstring(struct audit_buffer *ab,
210 const char *string, size_t n)
212 static inline void audit_log_untrustedstring(struct audit_buffer *ab,
215 static inline void audit_log_d_path(struct audit_buffer *ab,
217 const struct path *path)
219 static inline void audit_log_key(struct audit_buffer *ab, char *key)
221 static inline void audit_log_path_denied(int type, const char *operation)
223 static inline int audit_log_task_context(struct audit_buffer *ab)
227 static inline void audit_log_task_info(struct audit_buffer *ab)
230 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
235 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
237 return AUDIT_SID_UNSET;
240 #define audit_enabled AUDIT_OFF
242 static inline int audit_signal_info(int sig, struct task_struct *t)
247 #endif /* CONFIG_AUDIT */
249 #ifdef CONFIG_AUDIT_COMPAT_GENERIC
250 #define audit_is_compat(arch) (!((arch) & __AUDIT_ARCH_64BIT))
252 #define audit_is_compat(arch) false
255 #define AUDIT_INODE_PARENT 1 /* dentry represents the parent */
256 #define AUDIT_INODE_HIDDEN 2 /* audit record should be hidden */
257 #define AUDIT_INODE_NOEVAL 4 /* audit record incomplete */
259 #ifdef CONFIG_AUDITSYSCALL
260 #include <asm/syscall.h> /* for syscall_get_arch() */
262 /* These are defined in auditsc.c */
264 extern int audit_alloc(struct task_struct *task);
265 extern void __audit_free(struct task_struct *task);
266 extern void __audit_syscall_entry(int major, unsigned long a0, unsigned long a1,
267 unsigned long a2, unsigned long a3);
268 extern void __audit_syscall_exit(int ret_success, long ret_value);
269 extern struct filename *__audit_reusename(const __user char *uptr);
270 extern void __audit_getname(struct filename *name);
272 extern void __audit_inode(struct filename *name, const struct dentry *dentry,
274 extern void __audit_file(const struct file *);
275 extern void __audit_inode_child(struct inode *parent,
276 const struct dentry *dentry,
277 const unsigned char type);
278 extern void audit_seccomp(unsigned long syscall, long signr, int code);
279 extern void audit_seccomp_actions_logged(const char *names,
280 const char *old_names, int res);
281 extern void __audit_ptrace(struct task_struct *t);
283 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
285 task->audit_context = ctx;
288 static inline struct audit_context *audit_context(void)
290 return current->audit_context;
293 static inline bool audit_dummy_context(void)
295 void *p = audit_context();
296 return !p || *(int *)p;
298 static inline void audit_free(struct task_struct *task)
300 if (unlikely(task->audit_context))
303 static inline void audit_syscall_entry(int major, unsigned long a0,
304 unsigned long a1, unsigned long a2,
307 if (unlikely(audit_context()))
308 __audit_syscall_entry(major, a0, a1, a2, a3);
310 static inline void audit_syscall_exit(void *pt_regs)
312 if (unlikely(audit_context())) {
313 int success = is_syscall_success(pt_regs);
314 long return_code = regs_return_value(pt_regs);
316 __audit_syscall_exit(success, return_code);
319 static inline struct filename *audit_reusename(const __user char *name)
321 if (unlikely(!audit_dummy_context()))
322 return __audit_reusename(name);
325 static inline void audit_getname(struct filename *name)
327 if (unlikely(!audit_dummy_context()))
328 __audit_getname(name);
330 static inline void audit_inode(struct filename *name,
331 const struct dentry *dentry,
332 unsigned int aflags) {
333 if (unlikely(!audit_dummy_context()))
334 __audit_inode(name, dentry, aflags);
336 static inline void audit_file(struct file *file)
338 if (unlikely(!audit_dummy_context()))
341 static inline void audit_inode_parent_hidden(struct filename *name,
342 const struct dentry *dentry)
344 if (unlikely(!audit_dummy_context()))
345 __audit_inode(name, dentry,
346 AUDIT_INODE_PARENT | AUDIT_INODE_HIDDEN);
348 static inline void audit_inode_child(struct inode *parent,
349 const struct dentry *dentry,
350 const unsigned char type) {
351 if (unlikely(!audit_dummy_context()))
352 __audit_inode_child(parent, dentry, type);
354 void audit_core_dumps(long signr);
356 static inline void audit_ptrace(struct task_struct *t)
358 if (unlikely(!audit_dummy_context()))
362 /* Private API (for audit.c only) */
363 extern void __audit_ipc_obj(struct kern_ipc_perm *ipcp);
364 extern void __audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode);
365 extern void __audit_bprm(struct linux_binprm *bprm);
366 extern int __audit_socketcall(int nargs, unsigned long *args);
367 extern int __audit_sockaddr(int len, void *addr);
368 extern void __audit_fd_pair(int fd1, int fd2);
369 extern void __audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr);
370 extern void __audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout);
371 extern void __audit_mq_notify(mqd_t mqdes, const struct sigevent *notification);
372 extern void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat);
373 extern int __audit_log_bprm_fcaps(struct linux_binprm *bprm,
374 const struct cred *new,
375 const struct cred *old);
376 extern void __audit_log_capset(const struct cred *new, const struct cred *old);
377 extern void __audit_mmap_fd(int fd, int flags);
378 extern void __audit_log_kern_module(char *name);
379 extern void __audit_fanotify(unsigned int response);
380 extern void __audit_tk_injoffset(struct timespec64 offset);
381 extern void __audit_ntp_log(const struct audit_ntp_data *ad);
383 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
385 if (unlikely(!audit_dummy_context()))
386 __audit_ipc_obj(ipcp);
388 static inline void audit_fd_pair(int fd1, int fd2)
390 if (unlikely(!audit_dummy_context()))
391 __audit_fd_pair(fd1, fd2);
393 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode)
395 if (unlikely(!audit_dummy_context()))
396 __audit_ipc_set_perm(qbytes, uid, gid, mode);
398 static inline void audit_bprm(struct linux_binprm *bprm)
400 if (unlikely(!audit_dummy_context()))
403 static inline int audit_socketcall(int nargs, unsigned long *args)
405 if (unlikely(!audit_dummy_context()))
406 return __audit_socketcall(nargs, args);
410 static inline int audit_socketcall_compat(int nargs, u32 *args)
412 unsigned long a[AUDITSC_ARGS];
415 if (audit_dummy_context())
418 for (i = 0; i < nargs; i++)
419 a[i] = (unsigned long)args[i];
420 return __audit_socketcall(nargs, a);
423 static inline int audit_sockaddr(int len, void *addr)
425 if (unlikely(!audit_dummy_context()))
426 return __audit_sockaddr(len, addr);
429 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
431 if (unlikely(!audit_dummy_context()))
432 __audit_mq_open(oflag, mode, attr);
434 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout)
436 if (unlikely(!audit_dummy_context()))
437 __audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
439 static inline void audit_mq_notify(mqd_t mqdes, const struct sigevent *notification)
441 if (unlikely(!audit_dummy_context()))
442 __audit_mq_notify(mqdes, notification);
444 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
446 if (unlikely(!audit_dummy_context()))
447 __audit_mq_getsetattr(mqdes, mqstat);
450 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
451 const struct cred *new,
452 const struct cred *old)
454 if (unlikely(!audit_dummy_context()))
455 return __audit_log_bprm_fcaps(bprm, new, old);
459 static inline void audit_log_capset(const struct cred *new,
460 const struct cred *old)
462 if (unlikely(!audit_dummy_context()))
463 __audit_log_capset(new, old);
466 static inline void audit_mmap_fd(int fd, int flags)
468 if (unlikely(!audit_dummy_context()))
469 __audit_mmap_fd(fd, flags);
472 static inline void audit_log_kern_module(char *name)
474 if (!audit_dummy_context())
475 __audit_log_kern_module(name);
478 static inline void audit_fanotify(unsigned int response)
480 if (!audit_dummy_context())
481 __audit_fanotify(response);
484 static inline void audit_tk_injoffset(struct timespec64 offset)
486 /* ignore no-op events */
487 if (offset.tv_sec == 0 && offset.tv_nsec == 0)
490 if (!audit_dummy_context())
491 __audit_tk_injoffset(offset);
494 static inline void audit_ntp_init(struct audit_ntp_data *ad)
496 memset(ad, 0, sizeof(*ad));
499 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
500 enum audit_ntp_type type, long long val)
502 ad->vals[type].oldval = val;
505 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
506 enum audit_ntp_type type, long long val)
508 ad->vals[type].newval = val;
511 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
513 if (!audit_dummy_context())
517 extern int audit_n_rules;
518 extern int audit_signals;
519 #else /* CONFIG_AUDITSYSCALL */
520 static inline int audit_alloc(struct task_struct *task)
524 static inline void audit_free(struct task_struct *task)
526 static inline void audit_syscall_entry(int major, unsigned long a0,
527 unsigned long a1, unsigned long a2,
530 static inline void audit_syscall_exit(void *pt_regs)
532 static inline bool audit_dummy_context(void)
536 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
538 static inline struct audit_context *audit_context(void)
542 static inline struct filename *audit_reusename(const __user char *name)
546 static inline void audit_getname(struct filename *name)
548 static inline void __audit_inode(struct filename *name,
549 const struct dentry *dentry,
552 static inline void __audit_inode_child(struct inode *parent,
553 const struct dentry *dentry,
554 const unsigned char type)
556 static inline void audit_inode(struct filename *name,
557 const struct dentry *dentry,
560 static inline void audit_file(struct file *file)
563 static inline void audit_inode_parent_hidden(struct filename *name,
564 const struct dentry *dentry)
566 static inline void audit_inode_child(struct inode *parent,
567 const struct dentry *dentry,
568 const unsigned char type)
570 static inline void audit_core_dumps(long signr)
572 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
574 static inline void audit_seccomp_actions_logged(const char *names,
575 const char *old_names, int res)
577 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
579 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
580 gid_t gid, umode_t mode)
582 static inline void audit_bprm(struct linux_binprm *bprm)
584 static inline int audit_socketcall(int nargs, unsigned long *args)
589 static inline int audit_socketcall_compat(int nargs, u32 *args)
594 static inline void audit_fd_pair(int fd1, int fd2)
596 static inline int audit_sockaddr(int len, void *addr)
600 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
602 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
603 unsigned int msg_prio,
604 const struct timespec64 *abs_timeout)
606 static inline void audit_mq_notify(mqd_t mqdes,
607 const struct sigevent *notification)
609 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
611 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
612 const struct cred *new,
613 const struct cred *old)
617 static inline void audit_log_capset(const struct cred *new,
618 const struct cred *old)
620 static inline void audit_mmap_fd(int fd, int flags)
623 static inline void audit_log_kern_module(char *name)
627 static inline void audit_fanotify(unsigned int response)
630 static inline void audit_tk_injoffset(struct timespec64 offset)
633 static inline void audit_ntp_init(struct audit_ntp_data *ad)
636 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
637 enum audit_ntp_type type, long long val)
640 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
641 enum audit_ntp_type type, long long val)
644 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
647 static inline void audit_ptrace(struct task_struct *t)
649 #define audit_n_rules 0
650 #define audit_signals 0
651 #endif /* CONFIG_AUDITSYSCALL */
653 static inline bool audit_loginuid_set(struct task_struct *tsk)
655 return uid_valid(audit_get_loginuid(tsk));
658 static inline void audit_log_string(struct audit_buffer *ab, const char *buf)
660 audit_log_n_string(ab, buf, strlen(buf));