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/namei.h> /* LOOKUP_* */
15 #include <uapi/linux/audit.h>
17 #define AUDIT_INO_UNSET ((unsigned long)-1)
18 #define AUDIT_DEV_UNSET ((dev_t)-1)
20 struct audit_sig_info {
29 struct netlink_skb_parms;
43 u32 mask[AUDIT_BITMASK_SIZE];
44 u32 buflen; /* for data alloc on list rules */
46 char *filterkey; /* ties events to rules */
47 struct audit_field *fields;
48 struct audit_field *arch_f; /* quick access to arch field */
49 struct audit_field *inode_f; /* quick access to an inode field */
50 struct audit_watch *watch; /* associated watch */
51 struct audit_tree *tree; /* associated watched tree */
52 struct audit_fsnotify_mark *exe;
53 struct list_head rlist; /* entry in audit_{watch,tree}.rules list */
54 struct list_head list; /* for AUDIT_LIST* purposes only */
58 /* Flag to indicate legacy AUDIT_LOGINUID unset usage */
59 #define AUDIT_LOGINUID_LEGACY 0x1
83 AUDIT_NTP_NVALS /* count */
86 #ifdef CONFIG_AUDITSYSCALL
87 struct audit_ntp_val {
88 long long oldval, newval;
91 struct audit_ntp_data {
92 struct audit_ntp_val vals[AUDIT_NTP_NVALS];
95 struct audit_ntp_data {};
98 extern int is_audit_feature_set(int which);
100 extern int __init audit_register_class(int class, unsigned *list);
101 extern int audit_classify_syscall(int abi, unsigned syscall);
102 extern int audit_classify_arch(int arch);
103 /* only for compat system calls */
104 extern unsigned compat_write_class[];
105 extern unsigned compat_read_class[];
106 extern unsigned compat_dir_class[];
107 extern unsigned compat_chattr_class[];
108 extern unsigned compat_signal_class[];
110 extern int audit_classify_compat_syscall(int abi, unsigned syscall);
112 /* audit_names->type values */
113 #define AUDIT_TYPE_UNKNOWN 0 /* we don't know yet */
114 #define AUDIT_TYPE_NORMAL 1 /* a "normal" audit record */
115 #define AUDIT_TYPE_PARENT 2 /* a parent audit record */
116 #define AUDIT_TYPE_CHILD_DELETE 3 /* a child being deleted */
117 #define AUDIT_TYPE_CHILD_CREATE 4 /* a child being created */
119 /* maximized args number that audit_socketcall can process */
120 #define AUDITSC_ARGS 6
122 /* bit values for ->signal->audit_tty */
123 #define AUDIT_TTY_ENABLE BIT(0)
124 #define AUDIT_TTY_LOG_PASSWD BIT(1)
130 #define AUDIT_LOCKED 2
132 /* These are defined in audit.c */
134 extern __printf(4, 5)
135 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
136 const char *fmt, ...);
138 extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
139 extern __printf(2, 3)
140 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...);
141 extern void audit_log_end(struct audit_buffer *ab);
142 extern bool audit_string_contains_control(const char *string,
144 extern void audit_log_n_hex(struct audit_buffer *ab,
145 const unsigned char *buf,
147 extern void audit_log_n_string(struct audit_buffer *ab,
150 extern void audit_log_n_untrustedstring(struct audit_buffer *ab,
153 extern void audit_log_untrustedstring(struct audit_buffer *ab,
155 extern void audit_log_d_path(struct audit_buffer *ab,
157 const struct path *path);
158 extern void audit_log_key(struct audit_buffer *ab,
160 extern void audit_log_link_denied(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_link_denied(const char *string)
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 #ifdef CONFIG_AUDITSYSCALL
256 #include <asm/syscall.h> /* for syscall_get_arch() */
258 /* These are defined in auditsc.c */
260 extern int audit_alloc(struct task_struct *task);
261 extern void __audit_free(struct task_struct *task);
262 extern void __audit_syscall_entry(int major, unsigned long a0, unsigned long a1,
263 unsigned long a2, unsigned long a3);
264 extern void __audit_syscall_exit(int ret_success, long ret_value);
265 extern struct filename *__audit_reusename(const __user char *uptr);
266 extern void __audit_getname(struct filename *name);
268 #define AUDIT_INODE_PARENT 1 /* dentry represents the parent */
269 #define AUDIT_INODE_HIDDEN 2 /* audit record should be hidden */
270 #define AUDIT_INODE_NOEVAL 4 /* audit record incomplete */
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 flags) {
332 if (unlikely(!audit_dummy_context())) {
333 unsigned int aflags = 0;
335 if (flags & LOOKUP_PARENT)
336 aflags |= AUDIT_INODE_PARENT;
337 if (flags & LOOKUP_NO_EVAL)
338 aflags |= AUDIT_INODE_NOEVAL;
339 __audit_inode(name, dentry, aflags);
342 static inline void audit_file(struct file *file)
344 if (unlikely(!audit_dummy_context()))
347 static inline void audit_inode_parent_hidden(struct filename *name,
348 const struct dentry *dentry)
350 if (unlikely(!audit_dummy_context()))
351 __audit_inode(name, dentry,
352 AUDIT_INODE_PARENT | AUDIT_INODE_HIDDEN);
354 static inline void audit_inode_child(struct inode *parent,
355 const struct dentry *dentry,
356 const unsigned char type) {
357 if (unlikely(!audit_dummy_context()))
358 __audit_inode_child(parent, dentry, type);
360 void audit_core_dumps(long signr);
362 static inline void audit_ptrace(struct task_struct *t)
364 if (unlikely(!audit_dummy_context()))
368 /* Private API (for audit.c only) */
369 extern void __audit_ipc_obj(struct kern_ipc_perm *ipcp);
370 extern void __audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode);
371 extern void __audit_bprm(struct linux_binprm *bprm);
372 extern int __audit_socketcall(int nargs, unsigned long *args);
373 extern int __audit_sockaddr(int len, void *addr);
374 extern void __audit_fd_pair(int fd1, int fd2);
375 extern void __audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr);
376 extern void __audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout);
377 extern void __audit_mq_notify(mqd_t mqdes, const struct sigevent *notification);
378 extern void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat);
379 extern int __audit_log_bprm_fcaps(struct linux_binprm *bprm,
380 const struct cred *new,
381 const struct cred *old);
382 extern void __audit_log_capset(const struct cred *new, const struct cred *old);
383 extern void __audit_mmap_fd(int fd, int flags);
384 extern void __audit_log_kern_module(char *name);
385 extern void __audit_fanotify(unsigned int response);
386 extern void __audit_tk_injoffset(struct timespec64 offset);
387 extern void __audit_ntp_log(const struct audit_ntp_data *ad);
389 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
391 if (unlikely(!audit_dummy_context()))
392 __audit_ipc_obj(ipcp);
394 static inline void audit_fd_pair(int fd1, int fd2)
396 if (unlikely(!audit_dummy_context()))
397 __audit_fd_pair(fd1, fd2);
399 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode)
401 if (unlikely(!audit_dummy_context()))
402 __audit_ipc_set_perm(qbytes, uid, gid, mode);
404 static inline void audit_bprm(struct linux_binprm *bprm)
406 if (unlikely(!audit_dummy_context()))
409 static inline int audit_socketcall(int nargs, unsigned long *args)
411 if (unlikely(!audit_dummy_context()))
412 return __audit_socketcall(nargs, args);
416 static inline int audit_socketcall_compat(int nargs, u32 *args)
418 unsigned long a[AUDITSC_ARGS];
421 if (audit_dummy_context())
424 for (i = 0; i < nargs; i++)
425 a[i] = (unsigned long)args[i];
426 return __audit_socketcall(nargs, a);
429 static inline int audit_sockaddr(int len, void *addr)
431 if (unlikely(!audit_dummy_context()))
432 return __audit_sockaddr(len, addr);
435 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
437 if (unlikely(!audit_dummy_context()))
438 __audit_mq_open(oflag, mode, attr);
440 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout)
442 if (unlikely(!audit_dummy_context()))
443 __audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
445 static inline void audit_mq_notify(mqd_t mqdes, const struct sigevent *notification)
447 if (unlikely(!audit_dummy_context()))
448 __audit_mq_notify(mqdes, notification);
450 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
452 if (unlikely(!audit_dummy_context()))
453 __audit_mq_getsetattr(mqdes, mqstat);
456 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
457 const struct cred *new,
458 const struct cred *old)
460 if (unlikely(!audit_dummy_context()))
461 return __audit_log_bprm_fcaps(bprm, new, old);
465 static inline void audit_log_capset(const struct cred *new,
466 const struct cred *old)
468 if (unlikely(!audit_dummy_context()))
469 __audit_log_capset(new, old);
472 static inline void audit_mmap_fd(int fd, int flags)
474 if (unlikely(!audit_dummy_context()))
475 __audit_mmap_fd(fd, flags);
478 static inline void audit_log_kern_module(char *name)
480 if (!audit_dummy_context())
481 __audit_log_kern_module(name);
484 static inline void audit_fanotify(unsigned int response)
486 if (!audit_dummy_context())
487 __audit_fanotify(response);
490 static inline void audit_tk_injoffset(struct timespec64 offset)
492 /* ignore no-op events */
493 if (offset.tv_sec == 0 && offset.tv_nsec == 0)
496 if (!audit_dummy_context())
497 __audit_tk_injoffset(offset);
500 static inline void audit_ntp_init(struct audit_ntp_data *ad)
502 memset(ad, 0, sizeof(*ad));
505 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
506 enum audit_ntp_type type, long long val)
508 ad->vals[type].oldval = val;
511 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
512 enum audit_ntp_type type, long long val)
514 ad->vals[type].newval = val;
517 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
519 if (!audit_dummy_context())
523 extern int audit_n_rules;
524 extern int audit_signals;
525 #else /* CONFIG_AUDITSYSCALL */
526 static inline int audit_alloc(struct task_struct *task)
530 static inline void audit_free(struct task_struct *task)
532 static inline void audit_syscall_entry(int major, unsigned long a0,
533 unsigned long a1, unsigned long a2,
536 static inline void audit_syscall_exit(void *pt_regs)
538 static inline bool audit_dummy_context(void)
542 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
544 static inline struct audit_context *audit_context(void)
548 static inline struct filename *audit_reusename(const __user char *name)
552 static inline void audit_getname(struct filename *name)
554 static inline void __audit_inode(struct filename *name,
555 const struct dentry *dentry,
558 static inline void __audit_inode_child(struct inode *parent,
559 const struct dentry *dentry,
560 const unsigned char type)
562 static inline void audit_inode(struct filename *name,
563 const struct dentry *dentry,
566 static inline void audit_file(struct file *file)
569 static inline void audit_inode_parent_hidden(struct filename *name,
570 const struct dentry *dentry)
572 static inline void audit_inode_child(struct inode *parent,
573 const struct dentry *dentry,
574 const unsigned char type)
576 static inline void audit_core_dumps(long signr)
578 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
580 static inline void audit_seccomp_actions_logged(const char *names,
581 const char *old_names, int res)
583 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
585 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
586 gid_t gid, umode_t mode)
588 static inline void audit_bprm(struct linux_binprm *bprm)
590 static inline int audit_socketcall(int nargs, unsigned long *args)
595 static inline int audit_socketcall_compat(int nargs, u32 *args)
600 static inline void audit_fd_pair(int fd1, int fd2)
602 static inline int audit_sockaddr(int len, void *addr)
606 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
608 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
609 unsigned int msg_prio,
610 const struct timespec64 *abs_timeout)
612 static inline void audit_mq_notify(mqd_t mqdes,
613 const struct sigevent *notification)
615 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
617 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
618 const struct cred *new,
619 const struct cred *old)
623 static inline void audit_log_capset(const struct cred *new,
624 const struct cred *old)
626 static inline void audit_mmap_fd(int fd, int flags)
629 static inline void audit_log_kern_module(char *name)
633 static inline void audit_fanotify(unsigned int response)
636 static inline void audit_tk_injoffset(struct timespec64 offset)
639 static inline void audit_ntp_init(struct audit_ntp_data *ad)
642 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
643 enum audit_ntp_type type, long long val)
646 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
647 enum audit_ntp_type type, long long val)
650 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
653 static inline void audit_ptrace(struct task_struct *t)
655 #define audit_n_rules 0
656 #define audit_signals 0
657 #endif /* CONFIG_AUDITSYSCALL */
659 static inline bool audit_loginuid_set(struct task_struct *tsk)
661 return uid_valid(audit_get_loginuid(tsk));
664 static inline void audit_log_string(struct audit_buffer *ab, const char *buf)
666 audit_log_n_string(ab, buf, strlen(buf));