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 {};
100 AUDIT_XT_OP_UNREGISTER,
103 extern int is_audit_feature_set(int which);
105 extern int __init audit_register_class(int class, unsigned *list);
106 extern int audit_classify_syscall(int abi, unsigned syscall);
107 extern int audit_classify_arch(int arch);
108 /* only for compat system calls */
109 extern unsigned compat_write_class[];
110 extern unsigned compat_read_class[];
111 extern unsigned compat_dir_class[];
112 extern unsigned compat_chattr_class[];
113 extern unsigned compat_signal_class[];
115 extern int audit_classify_compat_syscall(int abi, unsigned syscall);
117 /* audit_names->type values */
118 #define AUDIT_TYPE_UNKNOWN 0 /* we don't know yet */
119 #define AUDIT_TYPE_NORMAL 1 /* a "normal" audit record */
120 #define AUDIT_TYPE_PARENT 2 /* a parent audit record */
121 #define AUDIT_TYPE_CHILD_DELETE 3 /* a child being deleted */
122 #define AUDIT_TYPE_CHILD_CREATE 4 /* a child being created */
124 /* maximized args number that audit_socketcall can process */
125 #define AUDITSC_ARGS 6
127 /* bit values for ->signal->audit_tty */
128 #define AUDIT_TTY_ENABLE BIT(0)
129 #define AUDIT_TTY_LOG_PASSWD BIT(1)
135 #define AUDIT_LOCKED 2
137 /* These are defined in audit.c */
139 extern __printf(4, 5)
140 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
141 const char *fmt, ...);
143 extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
144 extern __printf(2, 3)
145 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...);
146 extern void audit_log_end(struct audit_buffer *ab);
147 extern bool audit_string_contains_control(const char *string,
149 extern void audit_log_n_hex(struct audit_buffer *ab,
150 const unsigned char *buf,
152 extern void audit_log_n_string(struct audit_buffer *ab,
155 extern void audit_log_n_untrustedstring(struct audit_buffer *ab,
158 extern void audit_log_untrustedstring(struct audit_buffer *ab,
160 extern void audit_log_d_path(struct audit_buffer *ab,
162 const struct path *path);
163 extern void audit_log_key(struct audit_buffer *ab,
165 extern void audit_log_path_denied(int type,
166 const char *operation);
167 extern void audit_log_lost(const char *message);
169 extern int audit_log_task_context(struct audit_buffer *ab);
170 extern void audit_log_task_info(struct audit_buffer *ab);
172 extern int audit_update_lsm_rules(void);
174 /* Private API (for audit.c only) */
175 extern int audit_rule_change(int type, int seq, void *data, size_t datasz);
176 extern int audit_list_rules_send(struct sk_buff *request_skb, int seq);
178 extern int audit_set_loginuid(kuid_t loginuid);
180 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
182 return tsk->loginuid;
185 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
187 return tsk->sessionid;
190 extern u32 audit_enabled;
192 extern int audit_signal_info(int sig, struct task_struct *t);
194 #else /* CONFIG_AUDIT */
195 static inline __printf(4, 5)
196 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
197 const char *fmt, ...)
199 static inline struct audit_buffer *audit_log_start(struct audit_context *ctx,
200 gfp_t gfp_mask, int type)
204 static inline __printf(2, 3)
205 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
207 static inline void audit_log_end(struct audit_buffer *ab)
209 static inline void audit_log_n_hex(struct audit_buffer *ab,
210 const unsigned char *buf, size_t len)
212 static inline void audit_log_n_string(struct audit_buffer *ab,
213 const char *buf, size_t n)
215 static inline void audit_log_n_untrustedstring(struct audit_buffer *ab,
216 const char *string, size_t n)
218 static inline void audit_log_untrustedstring(struct audit_buffer *ab,
221 static inline void audit_log_d_path(struct audit_buffer *ab,
223 const struct path *path)
225 static inline void audit_log_key(struct audit_buffer *ab, char *key)
227 static inline void audit_log_path_denied(int type, const char *operation)
229 static inline int audit_log_task_context(struct audit_buffer *ab)
233 static inline void audit_log_task_info(struct audit_buffer *ab)
236 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
241 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
243 return AUDIT_SID_UNSET;
246 #define audit_enabled AUDIT_OFF
248 static inline int audit_signal_info(int sig, struct task_struct *t)
253 #endif /* CONFIG_AUDIT */
255 #ifdef CONFIG_AUDIT_COMPAT_GENERIC
256 #define audit_is_compat(arch) (!((arch) & __AUDIT_ARCH_64BIT))
258 #define audit_is_compat(arch) false
261 #define AUDIT_INODE_PARENT 1 /* dentry represents the parent */
262 #define AUDIT_INODE_HIDDEN 2 /* audit record should be hidden */
263 #define AUDIT_INODE_NOEVAL 4 /* audit record incomplete */
265 #ifdef CONFIG_AUDITSYSCALL
266 #include <asm/syscall.h> /* for syscall_get_arch() */
268 /* These are defined in auditsc.c */
270 extern int audit_alloc(struct task_struct *task);
271 extern void __audit_free(struct task_struct *task);
272 extern void __audit_syscall_entry(int major, unsigned long a0, unsigned long a1,
273 unsigned long a2, unsigned long a3);
274 extern void __audit_syscall_exit(int ret_success, long ret_value);
275 extern struct filename *__audit_reusename(const __user char *uptr);
276 extern void __audit_getname(struct filename *name);
278 extern void __audit_inode(struct filename *name, const struct dentry *dentry,
280 extern void __audit_file(const struct file *);
281 extern void __audit_inode_child(struct inode *parent,
282 const struct dentry *dentry,
283 const unsigned char type);
284 extern void audit_seccomp(unsigned long syscall, long signr, int code);
285 extern void audit_seccomp_actions_logged(const char *names,
286 const char *old_names, int res);
287 extern void __audit_ptrace(struct task_struct *t);
289 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
291 task->audit_context = ctx;
294 static inline struct audit_context *audit_context(void)
296 return current->audit_context;
299 static inline bool audit_dummy_context(void)
301 void *p = audit_context();
302 return !p || *(int *)p;
304 static inline void audit_free(struct task_struct *task)
306 if (unlikely(task->audit_context))
309 static inline void audit_syscall_entry(int major, unsigned long a0,
310 unsigned long a1, unsigned long a2,
313 if (unlikely(audit_context()))
314 __audit_syscall_entry(major, a0, a1, a2, a3);
316 static inline void audit_syscall_exit(void *pt_regs)
318 if (unlikely(audit_context())) {
319 int success = is_syscall_success(pt_regs);
320 long return_code = regs_return_value(pt_regs);
322 __audit_syscall_exit(success, return_code);
325 static inline struct filename *audit_reusename(const __user char *name)
327 if (unlikely(!audit_dummy_context()))
328 return __audit_reusename(name);
331 static inline void audit_getname(struct filename *name)
333 if (unlikely(!audit_dummy_context()))
334 __audit_getname(name);
336 static inline void audit_inode(struct filename *name,
337 const struct dentry *dentry,
338 unsigned int aflags) {
339 if (unlikely(!audit_dummy_context()))
340 __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);
388 extern void __audit_log_nfcfg(const char *name, u8 af, unsigned int nentries,
389 enum audit_nfcfgop op);
391 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
393 if (unlikely(!audit_dummy_context()))
394 __audit_ipc_obj(ipcp);
396 static inline void audit_fd_pair(int fd1, int fd2)
398 if (unlikely(!audit_dummy_context()))
399 __audit_fd_pair(fd1, fd2);
401 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode)
403 if (unlikely(!audit_dummy_context()))
404 __audit_ipc_set_perm(qbytes, uid, gid, mode);
406 static inline void audit_bprm(struct linux_binprm *bprm)
408 if (unlikely(!audit_dummy_context()))
411 static inline int audit_socketcall(int nargs, unsigned long *args)
413 if (unlikely(!audit_dummy_context()))
414 return __audit_socketcall(nargs, args);
418 static inline int audit_socketcall_compat(int nargs, u32 *args)
420 unsigned long a[AUDITSC_ARGS];
423 if (audit_dummy_context())
426 for (i = 0; i < nargs; i++)
427 a[i] = (unsigned long)args[i];
428 return __audit_socketcall(nargs, a);
431 static inline int audit_sockaddr(int len, void *addr)
433 if (unlikely(!audit_dummy_context()))
434 return __audit_sockaddr(len, addr);
437 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
439 if (unlikely(!audit_dummy_context()))
440 __audit_mq_open(oflag, mode, attr);
442 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout)
444 if (unlikely(!audit_dummy_context()))
445 __audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
447 static inline void audit_mq_notify(mqd_t mqdes, const struct sigevent *notification)
449 if (unlikely(!audit_dummy_context()))
450 __audit_mq_notify(mqdes, notification);
452 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
454 if (unlikely(!audit_dummy_context()))
455 __audit_mq_getsetattr(mqdes, mqstat);
458 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
459 const struct cred *new,
460 const struct cred *old)
462 if (unlikely(!audit_dummy_context()))
463 return __audit_log_bprm_fcaps(bprm, new, old);
467 static inline void audit_log_capset(const struct cred *new,
468 const struct cred *old)
470 if (unlikely(!audit_dummy_context()))
471 __audit_log_capset(new, old);
474 static inline void audit_mmap_fd(int fd, int flags)
476 if (unlikely(!audit_dummy_context()))
477 __audit_mmap_fd(fd, flags);
480 static inline void audit_log_kern_module(char *name)
482 if (!audit_dummy_context())
483 __audit_log_kern_module(name);
486 static inline void audit_fanotify(unsigned int response)
488 if (!audit_dummy_context())
489 __audit_fanotify(response);
492 static inline void audit_tk_injoffset(struct timespec64 offset)
494 /* ignore no-op events */
495 if (offset.tv_sec == 0 && offset.tv_nsec == 0)
498 if (!audit_dummy_context())
499 __audit_tk_injoffset(offset);
502 static inline void audit_ntp_init(struct audit_ntp_data *ad)
504 memset(ad, 0, sizeof(*ad));
507 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
508 enum audit_ntp_type type, long long val)
510 ad->vals[type].oldval = val;
513 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
514 enum audit_ntp_type type, long long val)
516 ad->vals[type].newval = val;
519 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
521 if (!audit_dummy_context())
525 static inline void audit_log_nfcfg(const char *name, u8 af,
526 unsigned int nentries,
527 enum audit_nfcfgop op)
530 __audit_log_nfcfg(name, af, nentries, op);
533 extern int audit_n_rules;
534 extern int audit_signals;
535 #else /* CONFIG_AUDITSYSCALL */
536 static inline int audit_alloc(struct task_struct *task)
540 static inline void audit_free(struct task_struct *task)
542 static inline void audit_syscall_entry(int major, unsigned long a0,
543 unsigned long a1, unsigned long a2,
546 static inline void audit_syscall_exit(void *pt_regs)
548 static inline bool audit_dummy_context(void)
552 static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
554 static inline struct audit_context *audit_context(void)
558 static inline struct filename *audit_reusename(const __user char *name)
562 static inline void audit_getname(struct filename *name)
564 static inline void __audit_inode(struct filename *name,
565 const struct dentry *dentry,
568 static inline void __audit_inode_child(struct inode *parent,
569 const struct dentry *dentry,
570 const unsigned char type)
572 static inline void audit_inode(struct filename *name,
573 const struct dentry *dentry,
576 static inline void audit_file(struct file *file)
579 static inline void audit_inode_parent_hidden(struct filename *name,
580 const struct dentry *dentry)
582 static inline void audit_inode_child(struct inode *parent,
583 const struct dentry *dentry,
584 const unsigned char type)
586 static inline void audit_core_dumps(long signr)
588 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
590 static inline void audit_seccomp_actions_logged(const char *names,
591 const char *old_names, int res)
593 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
595 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
596 gid_t gid, umode_t mode)
598 static inline void audit_bprm(struct linux_binprm *bprm)
600 static inline int audit_socketcall(int nargs, unsigned long *args)
605 static inline int audit_socketcall_compat(int nargs, u32 *args)
610 static inline void audit_fd_pair(int fd1, int fd2)
612 static inline int audit_sockaddr(int len, void *addr)
616 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
618 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
619 unsigned int msg_prio,
620 const struct timespec64 *abs_timeout)
622 static inline void audit_mq_notify(mqd_t mqdes,
623 const struct sigevent *notification)
625 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
627 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
628 const struct cred *new,
629 const struct cred *old)
633 static inline void audit_log_capset(const struct cred *new,
634 const struct cred *old)
636 static inline void audit_mmap_fd(int fd, int flags)
639 static inline void audit_log_kern_module(char *name)
643 static inline void audit_fanotify(unsigned int response)
646 static inline void audit_tk_injoffset(struct timespec64 offset)
649 static inline void audit_ntp_init(struct audit_ntp_data *ad)
652 static inline void audit_ntp_set_old(struct audit_ntp_data *ad,
653 enum audit_ntp_type type, long long val)
656 static inline void audit_ntp_set_new(struct audit_ntp_data *ad,
657 enum audit_ntp_type type, long long val)
660 static inline void audit_ntp_log(const struct audit_ntp_data *ad)
663 static inline void audit_ptrace(struct task_struct *t)
666 static inline void audit_log_nfcfg(const char *name, u8 af,
667 unsigned int nentries,
668 enum audit_nfcfgop op)
671 #define audit_n_rules 0
672 #define audit_signals 0
673 #endif /* CONFIG_AUDITSYSCALL */
675 static inline bool audit_loginuid_set(struct task_struct *tsk)
677 return uid_valid(audit_get_loginuid(tsk));
680 static inline void audit_log_string(struct audit_buffer *ab, const char *buf)
682 audit_log_n_string(ab, buf, strlen(buf));