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 <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_link_denied(const char *operation);
160 extern void audit_log_lost(const char *message);
162 extern int audit_log_task_context(struct audit_buffer *ab);
163 extern void audit_log_task_info(struct audit_buffer *ab);
165 extern int audit_update_lsm_rules(void);
167 /* Private API (for audit.c only) */
168 extern int audit_rule_change(int type, int seq, void *data, size_t datasz);
169 extern int audit_list_rules_send(struct sk_buff *request_skb, int seq);
171 extern int audit_set_loginuid(kuid_t loginuid);
173 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
175 return tsk->loginuid;
178 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
180 return tsk->sessionid;
183 extern u32 audit_enabled;
185 extern int audit_signal_info(int sig, struct task_struct *t);
187 #else /* CONFIG_AUDIT */
188 static inline __printf(4, 5)
189 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
190 const char *fmt, ...)
192 static inline struct audit_buffer *audit_log_start(struct audit_context *ctx,
193 gfp_t gfp_mask, int type)
197 static inline __printf(2, 3)
198 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
200 static inline void audit_log_end(struct audit_buffer *ab)
202 static inline void audit_log_n_hex(struct audit_buffer *ab,
203 const unsigned char *buf, size_t len)
205 static inline void audit_log_n_string(struct audit_buffer *ab,
206 const char *buf, size_t n)
208 static inline void audit_log_n_untrustedstring(struct audit_buffer *ab,
209 const char *string, size_t n)
211 static inline void audit_log_untrustedstring(struct audit_buffer *ab,
214 static inline void audit_log_d_path(struct audit_buffer *ab,
216 const struct path *path)
218 static inline void audit_log_key(struct audit_buffer *ab, char *key)
220 static inline void audit_log_link_denied(const char *string)
222 static inline int audit_log_task_context(struct audit_buffer *ab)
226 static inline void audit_log_task_info(struct audit_buffer *ab)
229 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
234 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
236 return AUDIT_SID_UNSET;
239 #define audit_enabled AUDIT_OFF
241 static inline int audit_signal_info(int sig, struct task_struct *t)
246 #endif /* CONFIG_AUDIT */
248 #ifdef CONFIG_AUDIT_COMPAT_GENERIC
249 #define audit_is_compat(arch) (!((arch) & __AUDIT_ARCH_64BIT))
251 #define audit_is_compat(arch) false
254 #define AUDIT_INODE_PARENT 1 /* dentry represents the parent */
255 #define AUDIT_INODE_HIDDEN 2 /* audit record should be hidden */
256 #define AUDIT_INODE_NOEVAL 4 /* audit record incomplete */
258 #ifdef CONFIG_AUDITSYSCALL
259 #include <asm/syscall.h> /* for syscall_get_arch() */
261 /* These are defined in auditsc.c */
263 extern int audit_alloc(struct task_struct *task);
264 extern void __audit_free(struct task_struct *task);
265 extern void __audit_syscall_entry(int major, unsigned long a0, unsigned long a1,
266 unsigned long a2, unsigned long a3);
267 extern void __audit_syscall_exit(int ret_success, long ret_value);
268 extern struct filename *__audit_reusename(const __user char *uptr);
269 extern void __audit_getname(struct filename *name);
271 extern void __audit_inode(struct filename *name, const struct dentry *dentry,
273 extern void __audit_file(const struct file *);
274 extern void __audit_inode_child(struct inode *parent,
275 const struct dentry *dentry,
276 const unsigned char type);
277 extern void audit_seccomp(unsigned long syscall, long signr, int code);
278 extern void audit_seccomp_actions_logged(const char *names,
279 const char *old_names, int res);
280 extern void __audit_ptrace(struct task_struct *t);
282 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
284 task->audit_context = ctx;
287 static inline struct audit_context *audit_context(void)
289 return current->audit_context;
292 static inline bool audit_dummy_context(void)
294 void *p = audit_context();
295 return !p || *(int *)p;
297 static inline void audit_free(struct task_struct *task)
299 if (unlikely(task->audit_context))
302 static inline void audit_syscall_entry(int major, unsigned long a0,
303 unsigned long a1, unsigned long a2,
306 if (unlikely(audit_context()))
307 __audit_syscall_entry(major, a0, a1, a2, a3);
309 static inline void audit_syscall_exit(void *pt_regs)
311 if (unlikely(audit_context())) {
312 int success = is_syscall_success(pt_regs);
313 long return_code = regs_return_value(pt_regs);
315 __audit_syscall_exit(success, return_code);
318 static inline struct filename *audit_reusename(const __user char *name)
320 if (unlikely(!audit_dummy_context()))
321 return __audit_reusename(name);
324 static inline void audit_getname(struct filename *name)
326 if (unlikely(!audit_dummy_context()))
327 __audit_getname(name);
329 static inline void audit_inode(struct filename *name,
330 const struct dentry *dentry,
331 unsigned int aflags) {
332 if (unlikely(!audit_dummy_context()))
333 __audit_inode(name, dentry, aflags);
335 static inline void audit_file(struct file *file)
337 if (unlikely(!audit_dummy_context()))
340 static inline void audit_inode_parent_hidden(struct filename *name,
341 const struct dentry *dentry)
343 if (unlikely(!audit_dummy_context()))
344 __audit_inode(name, dentry,
345 AUDIT_INODE_PARENT | AUDIT_INODE_HIDDEN);
347 static inline void audit_inode_child(struct inode *parent,
348 const struct dentry *dentry,
349 const unsigned char type) {
350 if (unlikely(!audit_dummy_context()))
351 __audit_inode_child(parent, dentry, type);
353 void audit_core_dumps(long signr);
355 static inline void audit_ptrace(struct task_struct *t)
357 if (unlikely(!audit_dummy_context()))
361 extern void audit_log_task(struct audit_buffer *ab);
363 /* Private API (for audit.c only) */
364 extern void __audit_ipc_obj(struct kern_ipc_perm *ipcp);
365 extern void __audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode);
366 extern void __audit_bprm(struct linux_binprm *bprm);
367 extern int __audit_socketcall(int nargs, unsigned long *args);
368 extern int __audit_sockaddr(int len, void *addr);
369 extern void __audit_fd_pair(int fd1, int fd2);
370 extern void __audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr);
371 extern void __audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout);
372 extern void __audit_mq_notify(mqd_t mqdes, const struct sigevent *notification);
373 extern void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat);
374 extern int __audit_log_bprm_fcaps(struct linux_binprm *bprm,
375 const struct cred *new,
376 const struct cred *old);
377 extern void __audit_log_capset(const struct cred *new, const struct cred *old);
378 extern void __audit_mmap_fd(int fd, int flags);
379 extern void __audit_log_kern_module(char *name);
380 extern void __audit_fanotify(unsigned int response);
381 extern void __audit_tk_injoffset(struct timespec64 offset);
382 extern void __audit_ntp_log(const struct audit_ntp_data *ad);
384 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
386 if (unlikely(!audit_dummy_context()))
387 __audit_ipc_obj(ipcp);
389 static inline void audit_fd_pair(int fd1, int fd2)
391 if (unlikely(!audit_dummy_context()))
392 __audit_fd_pair(fd1, fd2);
394 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode)
396 if (unlikely(!audit_dummy_context()))
397 __audit_ipc_set_perm(qbytes, uid, gid, mode);
399 static inline void audit_bprm(struct linux_binprm *bprm)
401 if (unlikely(!audit_dummy_context()))
404 static inline int audit_socketcall(int nargs, unsigned long *args)
406 if (unlikely(!audit_dummy_context()))
407 return __audit_socketcall(nargs, args);
411 static inline int audit_socketcall_compat(int nargs, u32 *args)
413 unsigned long a[AUDITSC_ARGS];
416 if (audit_dummy_context())
419 for (i = 0; i < nargs; i++)
420 a[i] = (unsigned long)args[i];
421 return __audit_socketcall(nargs, a);
424 static inline int audit_sockaddr(int len, void *addr)
426 if (unlikely(!audit_dummy_context()))
427 return __audit_sockaddr(len, addr);
430 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
432 if (unlikely(!audit_dummy_context()))
433 __audit_mq_open(oflag, mode, attr);
435 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout)
437 if (unlikely(!audit_dummy_context()))
438 __audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
440 static inline void audit_mq_notify(mqd_t mqdes, const struct sigevent *notification)
442 if (unlikely(!audit_dummy_context()))
443 __audit_mq_notify(mqdes, notification);
445 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
447 if (unlikely(!audit_dummy_context()))
448 __audit_mq_getsetattr(mqdes, mqstat);
451 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
452 const struct cred *new,
453 const struct cred *old)
455 if (unlikely(!audit_dummy_context()))
456 return __audit_log_bprm_fcaps(bprm, new, old);
460 static inline void audit_log_capset(const struct cred *new,
461 const struct cred *old)
463 if (unlikely(!audit_dummy_context()))
464 __audit_log_capset(new, old);
467 static inline void audit_mmap_fd(int fd, int flags)
469 if (unlikely(!audit_dummy_context()))
470 __audit_mmap_fd(fd, flags);
473 static inline void audit_log_kern_module(char *name)
475 if (!audit_dummy_context())
476 __audit_log_kern_module(name);
479 static inline void audit_fanotify(unsigned int response)
481 if (!audit_dummy_context())
482 __audit_fanotify(response);
485 static inline void audit_tk_injoffset(struct timespec64 offset)
487 /* ignore no-op events */
488 if (offset.tv_sec == 0 && offset.tv_nsec == 0)
491 if (!audit_dummy_context())
492 __audit_tk_injoffset(offset);
495 static inline void audit_ntp_init(struct audit_ntp_data *ad)
497 memset(ad, 0, sizeof(*ad));
500 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
501 enum audit_ntp_type type, long long val)
503 ad->vals[type].oldval = val;
506 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
507 enum audit_ntp_type type, long long val)
509 ad->vals[type].newval = val;
512 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
514 if (!audit_dummy_context())
518 extern int audit_n_rules;
519 extern int audit_signals;
520 #else /* CONFIG_AUDITSYSCALL */
521 static inline int audit_alloc(struct task_struct *task)
525 static inline void audit_free(struct task_struct *task)
527 static inline void audit_syscall_entry(int major, unsigned long a0,
528 unsigned long a1, unsigned long a2,
531 static inline void audit_syscall_exit(void *pt_regs)
533 static inline bool audit_dummy_context(void)
537 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
539 static inline struct audit_context *audit_context(void)
543 static inline struct filename *audit_reusename(const __user char *name)
547 static inline void audit_getname(struct filename *name)
549 static inline void __audit_inode(struct filename *name,
550 const struct dentry *dentry,
553 static inline void __audit_inode_child(struct inode *parent,
554 const struct dentry *dentry,
555 const unsigned char type)
557 static inline void audit_inode(struct filename *name,
558 const struct dentry *dentry,
561 static inline void audit_file(struct file *file)
564 static inline void audit_inode_parent_hidden(struct filename *name,
565 const struct dentry *dentry)
567 static inline void audit_inode_child(struct inode *parent,
568 const struct dentry *dentry,
569 const unsigned char type)
571 static inline void audit_core_dumps(long signr)
573 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
575 static inline void audit_seccomp_actions_logged(const char *names,
576 const char *old_names, int res)
578 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
580 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
581 gid_t gid, umode_t mode)
583 static inline void audit_bprm(struct linux_binprm *bprm)
585 static inline int audit_socketcall(int nargs, unsigned long *args)
590 static inline int audit_socketcall_compat(int nargs, u32 *args)
595 static inline void audit_fd_pair(int fd1, int fd2)
597 static inline int audit_sockaddr(int len, void *addr)
601 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
603 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
604 unsigned int msg_prio,
605 const struct timespec64 *abs_timeout)
607 static inline void audit_mq_notify(mqd_t mqdes,
608 const struct sigevent *notification)
610 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
612 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
613 const struct cred *new,
614 const struct cred *old)
618 static inline void audit_log_capset(const struct cred *new,
619 const struct cred *old)
621 static inline void audit_mmap_fd(int fd, int flags)
624 static inline void audit_log_kern_module(char *name)
628 static inline void audit_fanotify(unsigned int response)
631 static inline void audit_tk_injoffset(struct timespec64 offset)
634 static inline void audit_ntp_init(struct audit_ntp_data *ad)
637 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
638 enum audit_ntp_type type, long long val)
641 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
642 enum audit_ntp_type type, long long val)
645 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
648 static inline void audit_ptrace(struct task_struct *t)
651 static inline void audit_log_task(struct audit_buffer *ab)
653 #define audit_n_rules 0
654 #define audit_signals 0
655 #endif /* CONFIG_AUDITSYSCALL */
657 static inline bool audit_loginuid_set(struct task_struct *tsk)
659 return uid_valid(audit_get_loginuid(tsk));
662 static inline void audit_log_string(struct audit_buffer *ab, const char *buf)
664 audit_log_n_string(ab, buf, strlen(buf));