1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* audit -- definition of audit_context structure and supporting types
4 * Copyright 2003-2004 Red Hat, Inc.
5 * Copyright 2005 Hewlett-Packard Development Company, L.P.
6 * Copyright 2005 IBM Corporation
9 #ifndef _KERNEL_AUDIT_H_
10 #define _KERNEL_AUDIT_H_
13 #include <linux/audit.h>
14 #include <linux/skbuff.h>
15 #include <uapi/linux/mqueue.h>
16 #include <linux/tty.h>
18 /* AUDIT_NAMES is the number of slots we reserve in the audit_context
19 * for saving names from getname(). If we get more names we will allocate
20 * a name dynamically and also add those to the list anchored by names_list. */
23 /* At task start time, the audit_state is set in the audit_context using
24 a per-task filter. At syscall entry, the audit_state is augmented by
25 the syscall filter. */
27 AUDIT_STATE_DISABLED, /* Do not create per-task audit_context.
28 * No syscall-specific audit records can
30 AUDIT_STATE_BUILD, /* Create the per-task audit_context,
31 * and fill it in at syscall
32 * entry time. This makes a full
33 * syscall record available if some
34 * other part of the kernel decides it
35 * should be recorded. */
36 AUDIT_STATE_RECORD /* Create the per-task audit_context,
37 * always fill it in at syscall entry
38 * time, and always write out the audit
39 * record at syscall exit time. */
44 struct audit_fsnotify_mark;
49 struct list_head list;
51 struct audit_krule rule;
54 struct audit_cap_data {
55 kernel_cap_t permitted;
56 kernel_cap_t inheritable;
58 unsigned int fE; /* effective bit of file cap */
59 kernel_cap_t effective; /* effective set of process */
65 /* When fs/namei.c:getname() is called, we store the pointer in name and bump
66 * the refcnt in the associated filename struct.
68 * Further, in fs/namei.c:path_lookup() we store the inode and device.
71 struct list_head list; /* audit_context->names_list */
73 struct filename *name;
74 int name_len; /* number of chars to log */
75 bool hidden; /* don't log this record */
84 struct audit_cap_data fcap;
85 unsigned int fcap_ver;
86 unsigned char type; /* record type */
88 * This was an allocated audit_names and not from the array of
89 * names allocated in the task audit context. Thus this name
90 * should be freed on syscall exit.
95 struct audit_proctitle {
96 int len; /* length of the cmdline field. */
97 char *value; /* the cmdline field */
100 /* The per-task audit context. */
101 struct audit_context {
102 int dummy; /* must be the first element */
103 int in_syscall; /* 1 if task is in a syscall */
104 enum audit_state state, current_state;
105 unsigned int serial; /* serial number for record */
106 int major; /* syscall number */
107 struct timespec64 ctime; /* time of syscall entry */
108 unsigned long argv[4]; /* syscall arguments */
109 long return_code;/* syscall return code */
111 int return_valid; /* return code is valid */
113 * The names_list is the list of all audit_names collected during this
114 * syscall. The first AUDIT_NAMES entries in the names_list will
115 * actually be from the preallocated_names array for performance
116 * reasons. Except during allocation they should never be referenced
117 * through the preallocated_names array and should only be found/used
118 * by running the names_list.
120 struct audit_names preallocated_names[AUDIT_NAMES];
121 int name_count; /* total records in names_list */
122 struct list_head names_list; /* struct audit_names->list anchor */
123 char *filterkey; /* key for rule that triggered record */
125 struct audit_aux_data *aux;
126 struct audit_aux_data *aux_pids;
127 struct sockaddr_storage *sockaddr;
129 /* Save things to print about task_struct */
131 kuid_t uid, euid, suid, fsuid;
132 kgid_t gid, egid, sgid, fsgid;
133 unsigned long personality;
139 unsigned int target_sessionid;
141 char target_comm[TASK_COMM_LEN];
143 struct audit_tree_refs *trees, *first_trees;
144 struct list_head killed_trees;
162 unsigned long qbytes;
166 struct mq_attr mqstat;
175 unsigned int msg_prio;
176 struct timespec64 abs_timeout;
185 struct audit_cap_data cap;
198 struct audit_ntp_data ntp_data;
199 struct timespec64 tk_injoffset;
203 struct audit_proctitle proctitle;
206 extern bool audit_ever_enabled;
208 extern void audit_log_session_info(struct audit_buffer *ab);
210 extern int auditd_test_task(struct task_struct *task);
212 #define AUDIT_INODE_BUCKETS 32
213 extern struct list_head audit_inode_hash[AUDIT_INODE_BUCKETS];
215 static inline int audit_hash_ino(u32 ino)
217 return (ino & (AUDIT_INODE_BUCKETS-1));
220 /* Indicates that audit should log the full pathname. */
221 #define AUDIT_NAME_FULL -1
223 extern int audit_match_class(int class, unsigned syscall);
224 extern int audit_comparator(const u32 left, const u32 op, const u32 right);
225 extern int audit_uid_comparator(kuid_t left, u32 op, kuid_t right);
226 extern int audit_gid_comparator(kgid_t left, u32 op, kgid_t right);
227 extern int parent_len(const char *path);
228 extern int audit_compare_dname_path(const struct qstr *dname, const char *path, int plen);
229 extern struct sk_buff *audit_make_reply(int seq, int type, int done, int multi,
230 const void *payload, int size);
231 extern void audit_panic(const char *message);
233 struct audit_netlink_list {
236 struct sk_buff_head q;
239 int audit_send_list_thread(void *_dest);
241 extern int selinux_audit_rule_update(void);
243 extern struct mutex audit_filter_mutex;
244 extern int audit_del_rule(struct audit_entry *entry);
245 extern void audit_free_rule_rcu(struct rcu_head *head);
246 extern struct list_head audit_filter_list[];
248 extern struct audit_entry *audit_dupe_rule(struct audit_krule *old);
250 extern void audit_log_d_path_exe(struct audit_buffer *ab,
251 struct mm_struct *mm);
253 extern struct tty_struct *audit_get_tty(void);
254 extern void audit_put_tty(struct tty_struct *tty);
256 /* audit watch/mark/tree functions */
257 #ifdef CONFIG_AUDITSYSCALL
258 extern unsigned int audit_serial(void);
259 extern int auditsc_get_stamp(struct audit_context *ctx,
260 struct timespec64 *t, unsigned int *serial);
262 extern void audit_put_watch(struct audit_watch *watch);
263 extern void audit_get_watch(struct audit_watch *watch);
264 extern int audit_to_watch(struct audit_krule *krule, char *path, int len,
266 extern int audit_add_watch(struct audit_krule *krule, struct list_head **list);
267 extern void audit_remove_watch_rule(struct audit_krule *krule);
268 extern char *audit_watch_path(struct audit_watch *watch);
269 extern int audit_watch_compare(struct audit_watch *watch, unsigned long ino,
272 extern struct audit_fsnotify_mark *audit_alloc_mark(struct audit_krule *krule,
273 char *pathname, int len);
274 extern char *audit_mark_path(struct audit_fsnotify_mark *mark);
275 extern void audit_remove_mark(struct audit_fsnotify_mark *audit_mark);
276 extern void audit_remove_mark_rule(struct audit_krule *krule);
277 extern int audit_mark_compare(struct audit_fsnotify_mark *mark,
278 unsigned long ino, dev_t dev);
279 extern int audit_dupe_exe(struct audit_krule *new, struct audit_krule *old);
280 extern int audit_exe_compare(struct task_struct *tsk,
281 struct audit_fsnotify_mark *mark);
283 extern struct audit_chunk *audit_tree_lookup(const struct inode *inode);
284 extern void audit_put_chunk(struct audit_chunk *chunk);
285 extern bool audit_tree_match(struct audit_chunk *chunk,
286 struct audit_tree *tree);
287 extern int audit_make_tree(struct audit_krule *rule, char *pathname, u32 op);
288 extern int audit_add_tree_rule(struct audit_krule *rule);
289 extern int audit_remove_tree_rule(struct audit_krule *rule);
290 extern void audit_trim_trees(void);
291 extern int audit_tag_tree(char *old, char *new);
292 extern const char *audit_tree_path(struct audit_tree *tree);
293 extern void audit_put_tree(struct audit_tree *tree);
294 extern void audit_kill_trees(struct audit_context *context);
296 extern int audit_signal_info_syscall(struct task_struct *t);
297 extern void audit_filter_inodes(struct task_struct *tsk,
298 struct audit_context *ctx);
299 extern struct list_head *audit_killed_trees(void);
300 #else /* CONFIG_AUDITSYSCALL */
301 #define auditsc_get_stamp(c, t, s) 0
302 #define audit_put_watch(w) do { } while (0)
303 #define audit_get_watch(w) do { } while (0)
304 #define audit_to_watch(k, p, l, o) (-EINVAL)
305 #define audit_add_watch(k, l) (-EINVAL)
306 #define audit_remove_watch_rule(k) BUG()
307 #define audit_watch_path(w) ""
308 #define audit_watch_compare(w, i, d) 0
310 #define audit_alloc_mark(k, p, l) (ERR_PTR(-EINVAL))
311 #define audit_mark_path(m) ""
312 #define audit_remove_mark(m) do { } while (0)
313 #define audit_remove_mark_rule(k) do { } while (0)
314 #define audit_mark_compare(m, i, d) 0
315 #define audit_exe_compare(t, m) (-EINVAL)
316 #define audit_dupe_exe(n, o) (-EINVAL)
318 #define audit_remove_tree_rule(rule) BUG()
319 #define audit_add_tree_rule(rule) -EINVAL
320 #define audit_make_tree(rule, str, op) -EINVAL
321 #define audit_trim_trees() do { } while (0)
322 #define audit_put_tree(tree) do { } while (0)
323 #define audit_tag_tree(old, new) -EINVAL
324 #define audit_tree_path(rule) "" /* never called */
325 #define audit_kill_trees(context) BUG()
327 static inline int audit_signal_info_syscall(struct task_struct *t)
332 #define audit_filter_inodes(t, c) AUDIT_STATE_DISABLED
333 #endif /* CONFIG_AUDITSYSCALL */
335 extern char *audit_unpack_string(void **bufp, size_t *remain, size_t len);
337 extern int audit_filter(int msgtype, unsigned int listtype);
339 extern void audit_ctl_lock(void);
340 extern void audit_ctl_unlock(void);