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;
185 #else /* CONFIG_AUDIT */
186 static inline __printf(4, 5)
187 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
188 const char *fmt, ...)
190 static inline struct audit_buffer *audit_log_start(struct audit_context *ctx,
191 gfp_t gfp_mask, int type)
195 static inline __printf(2, 3)
196 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
198 static inline void audit_log_end(struct audit_buffer *ab)
200 static inline void audit_log_n_hex(struct audit_buffer *ab,
201 const unsigned char *buf, size_t len)
203 static inline void audit_log_n_string(struct audit_buffer *ab,
204 const char *buf, size_t n)
206 static inline void audit_log_n_untrustedstring(struct audit_buffer *ab,
207 const char *string, size_t n)
209 static inline void audit_log_untrustedstring(struct audit_buffer *ab,
212 static inline void audit_log_d_path(struct audit_buffer *ab,
214 const struct path *path)
216 static inline void audit_log_key(struct audit_buffer *ab, char *key)
218 static inline void audit_log_link_denied(const char *string)
220 static inline int audit_log_task_context(struct audit_buffer *ab)
224 static inline void audit_log_task_info(struct audit_buffer *ab)
227 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
232 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
234 return AUDIT_SID_UNSET;
237 #define audit_enabled AUDIT_OFF
238 #endif /* CONFIG_AUDIT */
240 #ifdef CONFIG_AUDIT_COMPAT_GENERIC
241 #define audit_is_compat(arch) (!((arch) & __AUDIT_ARCH_64BIT))
243 #define audit_is_compat(arch) false
246 #ifdef CONFIG_AUDITSYSCALL
247 #include <asm/syscall.h> /* for syscall_get_arch() */
249 /* These are defined in auditsc.c */
251 extern int audit_alloc(struct task_struct *task);
252 extern void __audit_free(struct task_struct *task);
253 extern void __audit_syscall_entry(int major, unsigned long a0, unsigned long a1,
254 unsigned long a2, unsigned long a3);
255 extern void __audit_syscall_exit(int ret_success, long ret_value);
256 extern struct filename *__audit_reusename(const __user char *uptr);
257 extern void __audit_getname(struct filename *name);
259 #define AUDIT_INODE_PARENT 1 /* dentry represents the parent */
260 #define AUDIT_INODE_HIDDEN 2 /* audit record should be hidden */
261 #define AUDIT_INODE_NOEVAL 4 /* audit record incomplete */
262 extern void __audit_inode(struct filename *name, const struct dentry *dentry,
264 extern void __audit_file(const struct file *);
265 extern void __audit_inode_child(struct inode *parent,
266 const struct dentry *dentry,
267 const unsigned char type);
268 extern void audit_seccomp(unsigned long syscall, long signr, int code);
269 extern void audit_seccomp_actions_logged(const char *names,
270 const char *old_names, int res);
271 extern void __audit_ptrace(struct task_struct *t);
273 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
275 task->audit_context = ctx;
278 static inline struct audit_context *audit_context(void)
280 return current->audit_context;
283 static inline bool audit_dummy_context(void)
285 void *p = audit_context();
286 return !p || *(int *)p;
288 static inline void audit_free(struct task_struct *task)
290 if (unlikely(task->audit_context))
293 static inline void audit_syscall_entry(int major, unsigned long a0,
294 unsigned long a1, unsigned long a2,
297 if (unlikely(audit_context()))
298 __audit_syscall_entry(major, a0, a1, a2, a3);
300 static inline void audit_syscall_exit(void *pt_regs)
302 if (unlikely(audit_context())) {
303 int success = is_syscall_success(pt_regs);
304 long return_code = regs_return_value(pt_regs);
306 __audit_syscall_exit(success, return_code);
309 static inline struct filename *audit_reusename(const __user char *name)
311 if (unlikely(!audit_dummy_context()))
312 return __audit_reusename(name);
315 static inline void audit_getname(struct filename *name)
317 if (unlikely(!audit_dummy_context()))
318 __audit_getname(name);
320 static inline void audit_inode(struct filename *name,
321 const struct dentry *dentry,
322 unsigned int flags) {
323 if (unlikely(!audit_dummy_context())) {
324 unsigned int aflags = 0;
326 if (flags & LOOKUP_PARENT)
327 aflags |= AUDIT_INODE_PARENT;
328 if (flags & LOOKUP_NO_EVAL)
329 aflags |= AUDIT_INODE_NOEVAL;
330 __audit_inode(name, dentry, aflags);
333 static inline void audit_file(struct file *file)
335 if (unlikely(!audit_dummy_context()))
338 static inline void audit_inode_parent_hidden(struct filename *name,
339 const struct dentry *dentry)
341 if (unlikely(!audit_dummy_context()))
342 __audit_inode(name, dentry,
343 AUDIT_INODE_PARENT | AUDIT_INODE_HIDDEN);
345 static inline void audit_inode_child(struct inode *parent,
346 const struct dentry *dentry,
347 const unsigned char type) {
348 if (unlikely(!audit_dummy_context()))
349 __audit_inode_child(parent, dentry, type);
351 void audit_core_dumps(long signr);
353 static inline void audit_ptrace(struct task_struct *t)
355 if (unlikely(!audit_dummy_context()))
359 /* Private API (for audit.c only) */
360 extern void __audit_ipc_obj(struct kern_ipc_perm *ipcp);
361 extern void __audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode);
362 extern void __audit_bprm(struct linux_binprm *bprm);
363 extern int __audit_socketcall(int nargs, unsigned long *args);
364 extern int __audit_sockaddr(int len, void *addr);
365 extern void __audit_fd_pair(int fd1, int fd2);
366 extern void __audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr);
367 extern void __audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout);
368 extern void __audit_mq_notify(mqd_t mqdes, const struct sigevent *notification);
369 extern void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat);
370 extern int __audit_log_bprm_fcaps(struct linux_binprm *bprm,
371 const struct cred *new,
372 const struct cred *old);
373 extern void __audit_log_capset(const struct cred *new, const struct cred *old);
374 extern void __audit_mmap_fd(int fd, int flags);
375 extern void __audit_log_kern_module(char *name);
376 extern void __audit_fanotify(unsigned int response);
377 extern void __audit_tk_injoffset(struct timespec64 offset);
378 extern void __audit_ntp_log(const struct audit_ntp_data *ad);
380 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
382 if (unlikely(!audit_dummy_context()))
383 __audit_ipc_obj(ipcp);
385 static inline void audit_fd_pair(int fd1, int fd2)
387 if (unlikely(!audit_dummy_context()))
388 __audit_fd_pair(fd1, fd2);
390 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode)
392 if (unlikely(!audit_dummy_context()))
393 __audit_ipc_set_perm(qbytes, uid, gid, mode);
395 static inline void audit_bprm(struct linux_binprm *bprm)
397 if (unlikely(!audit_dummy_context()))
400 static inline int audit_socketcall(int nargs, unsigned long *args)
402 if (unlikely(!audit_dummy_context()))
403 return __audit_socketcall(nargs, args);
407 static inline int audit_socketcall_compat(int nargs, u32 *args)
409 unsigned long a[AUDITSC_ARGS];
412 if (audit_dummy_context())
415 for (i = 0; i < nargs; i++)
416 a[i] = (unsigned long)args[i];
417 return __audit_socketcall(nargs, a);
420 static inline int audit_sockaddr(int len, void *addr)
422 if (unlikely(!audit_dummy_context()))
423 return __audit_sockaddr(len, addr);
426 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
428 if (unlikely(!audit_dummy_context()))
429 __audit_mq_open(oflag, mode, attr);
431 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout)
433 if (unlikely(!audit_dummy_context()))
434 __audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
436 static inline void audit_mq_notify(mqd_t mqdes, const struct sigevent *notification)
438 if (unlikely(!audit_dummy_context()))
439 __audit_mq_notify(mqdes, notification);
441 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
443 if (unlikely(!audit_dummy_context()))
444 __audit_mq_getsetattr(mqdes, mqstat);
447 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
448 const struct cred *new,
449 const struct cred *old)
451 if (unlikely(!audit_dummy_context()))
452 return __audit_log_bprm_fcaps(bprm, new, old);
456 static inline void audit_log_capset(const struct cred *new,
457 const struct cred *old)
459 if (unlikely(!audit_dummy_context()))
460 __audit_log_capset(new, old);
463 static inline void audit_mmap_fd(int fd, int flags)
465 if (unlikely(!audit_dummy_context()))
466 __audit_mmap_fd(fd, flags);
469 static inline void audit_log_kern_module(char *name)
471 if (!audit_dummy_context())
472 __audit_log_kern_module(name);
475 static inline void audit_fanotify(unsigned int response)
477 if (!audit_dummy_context())
478 __audit_fanotify(response);
481 static inline void audit_tk_injoffset(struct timespec64 offset)
483 /* ignore no-op events */
484 if (offset.tv_sec == 0 && offset.tv_nsec == 0)
487 if (!audit_dummy_context())
488 __audit_tk_injoffset(offset);
491 static inline void audit_ntp_init(struct audit_ntp_data *ad)
493 memset(ad, 0, sizeof(*ad));
496 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
497 enum audit_ntp_type type, long long val)
499 ad->vals[type].oldval = val;
502 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
503 enum audit_ntp_type type, long long val)
505 ad->vals[type].newval = val;
508 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
510 if (!audit_dummy_context())
514 extern int audit_n_rules;
515 extern int audit_signals;
516 #else /* CONFIG_AUDITSYSCALL */
517 static inline int audit_alloc(struct task_struct *task)
521 static inline void audit_free(struct task_struct *task)
523 static inline void audit_syscall_entry(int major, unsigned long a0,
524 unsigned long a1, unsigned long a2,
527 static inline void audit_syscall_exit(void *pt_regs)
529 static inline bool audit_dummy_context(void)
533 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
535 static inline struct audit_context *audit_context(void)
539 static inline struct filename *audit_reusename(const __user char *name)
543 static inline void audit_getname(struct filename *name)
545 static inline void __audit_inode(struct filename *name,
546 const struct dentry *dentry,
549 static inline void __audit_inode_child(struct inode *parent,
550 const struct dentry *dentry,
551 const unsigned char type)
553 static inline void audit_inode(struct filename *name,
554 const struct dentry *dentry,
557 static inline void audit_file(struct file *file)
560 static inline void audit_inode_parent_hidden(struct filename *name,
561 const struct dentry *dentry)
563 static inline void audit_inode_child(struct inode *parent,
564 const struct dentry *dentry,
565 const unsigned char type)
567 static inline void audit_core_dumps(long signr)
569 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
571 static inline void audit_seccomp_actions_logged(const char *names,
572 const char *old_names, int res)
574 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
576 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
577 gid_t gid, umode_t mode)
579 static inline void audit_bprm(struct linux_binprm *bprm)
581 static inline int audit_socketcall(int nargs, unsigned long *args)
586 static inline int audit_socketcall_compat(int nargs, u32 *args)
591 static inline void audit_fd_pair(int fd1, int fd2)
593 static inline int audit_sockaddr(int len, void *addr)
597 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
599 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
600 unsigned int msg_prio,
601 const struct timespec64 *abs_timeout)
603 static inline void audit_mq_notify(mqd_t mqdes,
604 const struct sigevent *notification)
606 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
608 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
609 const struct cred *new,
610 const struct cred *old)
614 static inline void audit_log_capset(const struct cred *new,
615 const struct cred *old)
617 static inline void audit_mmap_fd(int fd, int flags)
620 static inline void audit_log_kern_module(char *name)
624 static inline void audit_fanotify(unsigned int response)
627 static inline void audit_tk_injoffset(struct timespec64 offset)
630 static inline void audit_ntp_init(struct audit_ntp_data *ad)
633 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
634 enum audit_ntp_type type, long long val)
637 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
638 enum audit_ntp_type type, long long val)
641 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
644 static inline void audit_ptrace(struct task_struct *t)
646 #define audit_n_rules 0
647 #define audit_signals 0
648 #endif /* CONFIG_AUDITSYSCALL */
650 static inline bool audit_loginuid_set(struct task_struct *tsk)
652 return uid_valid(audit_get_loginuid(tsk));
655 static inline void audit_log_string(struct audit_buffer *ab, const char *buf)
657 audit_log_n_string(ab, buf, strlen(buf));