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 <linux/security.h>
16 #include <uapi/linux/mqueue.h>
17 #include <linux/tty.h>
19 /* AUDIT_NAMES is the number of slots we reserve in the audit_context
20 * for saving names from getname(). If we get more names we will allocate
21 * a name dynamically and also add those to the list anchored by names_list. */
24 /* At task start time, the audit_state is set in the audit_context using
25 a per-task filter. At syscall entry, the audit_state is augmented by
26 the syscall filter. */
28 AUDIT_STATE_DISABLED
, /* Do not create per-task audit_context.
29 * No syscall-specific audit records can
31 AUDIT_STATE_BUILD
, /* Create the per-task audit_context,
32 * and fill it in at syscall
33 * entry time. This makes a full
34 * syscall record available if some
35 * other part of the kernel decides it
36 * should be recorded. */
37 AUDIT_STATE_RECORD
/* Create the per-task audit_context,
38 * always fill it in at syscall entry
39 * time, and always write out the audit
40 * record at syscall exit time. */
45 struct audit_fsnotify_mark
;
50 struct list_head list
;
52 struct audit_krule rule
;
55 struct audit_cap_data
{
56 kernel_cap_t permitted
;
57 kernel_cap_t inheritable
;
59 unsigned int fE
; /* effective bit of file cap */
60 kernel_cap_t effective
; /* effective set of process */
66 /* When fs/namei.c:getname() is called, we store the pointer in name and bump
67 * the refcnt in the associated filename struct.
69 * Further, in fs/namei.c:path_lookup() we store the inode and device.
72 struct list_head list
; /* audit_context->names_list */
74 struct filename
*name
;
75 int name_len
; /* number of chars to log */
76 bool hidden
; /* don't log this record */
85 struct audit_cap_data fcap
;
86 unsigned int fcap_ver
;
87 unsigned char type
; /* record type */
89 * This was an allocated audit_names and not from the array of
90 * names allocated in the task audit context. Thus this name
91 * should be freed on syscall exit.
96 struct audit_proctitle
{
97 int len
; /* length of the cmdline field. */
98 char *value
; /* the cmdline field */
101 /* The per-task audit context. */
102 struct audit_context
{
103 int dummy
; /* must be the first element */
104 int in_syscall
; /* 1 if task is in a syscall */
105 enum audit_state state
, current_state
;
106 unsigned int serial
; /* serial number for record */
107 int major
; /* syscall number */
108 struct timespec64 ctime
; /* time of syscall entry */
109 unsigned long argv
[4]; /* syscall arguments */
110 long return_code
;/* syscall return code */
112 int return_valid
; /* return code is valid */
114 * The names_list is the list of all audit_names collected during this
115 * syscall. The first AUDIT_NAMES entries in the names_list will
116 * actually be from the preallocated_names array for performance
117 * reasons. Except during allocation they should never be referenced
118 * through the preallocated_names array and should only be found/used
119 * by running the names_list.
121 struct audit_names preallocated_names
[AUDIT_NAMES
];
122 int name_count
; /* total records in names_list */
123 struct list_head names_list
; /* struct audit_names->list anchor */
124 char *filterkey
; /* key for rule that triggered record */
126 struct audit_aux_data
*aux
;
127 struct audit_aux_data
*aux_pids
;
128 struct sockaddr_storage
*sockaddr
;
130 /* Save things to print about task_struct */
132 kuid_t uid
, euid
, suid
, fsuid
;
133 kgid_t gid
, egid
, sgid
, fsgid
;
134 unsigned long personality
;
140 unsigned int target_sessionid
;
141 struct lsmblob target_lsm
;
142 char target_comm
[TASK_COMM_LEN
];
144 struct audit_tree_refs
*trees
, *first_trees
;
145 struct list_head killed_trees
;
158 struct lsmblob oblob
;
163 unsigned long qbytes
;
167 struct mq_attr mqstat
;
176 unsigned int msg_prio
;
177 struct timespec64 abs_timeout
;
186 struct audit_cap_data cap
;
199 struct audit_ntp_data ntp_data
;
200 struct timespec64 tk_injoffset
;
204 struct audit_proctitle proctitle
;
207 extern bool audit_ever_enabled
;
209 extern void audit_log_session_info(struct audit_buffer
*ab
);
211 extern int auditd_test_task(struct task_struct
*task
);
213 #define AUDIT_INODE_BUCKETS 32
214 extern struct list_head audit_inode_hash
[AUDIT_INODE_BUCKETS
];
216 static inline int audit_hash_ino(u32 ino
)
218 return (ino
& (AUDIT_INODE_BUCKETS
-1));
221 /* Indicates that audit should log the full pathname. */
222 #define AUDIT_NAME_FULL -1
224 extern int audit_match_class(int class, unsigned syscall
);
225 extern int audit_comparator(const u32 left
, const u32 op
, const u32 right
);
226 extern int audit_uid_comparator(kuid_t left
, u32 op
, kuid_t right
);
227 extern int audit_gid_comparator(kgid_t left
, u32 op
, kgid_t right
);
228 extern int parent_len(const char *path
);
229 extern int audit_compare_dname_path(const struct qstr
*dname
, const char *path
, int plen
);
230 extern struct sk_buff
*audit_make_reply(int seq
, int type
, int done
, int multi
,
231 const void *payload
, int size
);
232 extern void audit_panic(const char *message
);
234 struct audit_netlink_list
{
237 struct sk_buff_head q
;
240 int audit_send_list_thread(void *_dest
);
242 extern int selinux_audit_rule_update(void);
244 extern struct mutex audit_filter_mutex
;
245 extern int audit_del_rule(struct audit_entry
*entry
);
246 extern void audit_free_rule_rcu(struct rcu_head
*head
);
247 extern struct list_head audit_filter_list
[];
249 extern struct audit_entry
*audit_dupe_rule(struct audit_krule
*old
);
251 extern void audit_log_d_path_exe(struct audit_buffer
*ab
,
252 struct mm_struct
*mm
);
254 extern struct tty_struct
*audit_get_tty(void);
255 extern void audit_put_tty(struct tty_struct
*tty
);
257 /* audit watch/mark/tree functions */
258 #ifdef CONFIG_AUDITSYSCALL
259 extern unsigned int audit_serial(void);
260 extern int auditsc_get_stamp(struct audit_context
*ctx
,
261 struct timespec64
*t
, unsigned int *serial
);
263 extern void audit_put_watch(struct audit_watch
*watch
);
264 extern void audit_get_watch(struct audit_watch
*watch
);
265 extern int audit_to_watch(struct audit_krule
*krule
, char *path
, int len
,
267 extern int audit_add_watch(struct audit_krule
*krule
, struct list_head
**list
);
268 extern void audit_remove_watch_rule(struct audit_krule
*krule
);
269 extern char *audit_watch_path(struct audit_watch
*watch
);
270 extern int audit_watch_compare(struct audit_watch
*watch
, unsigned long ino
,
273 extern struct audit_fsnotify_mark
*audit_alloc_mark(struct audit_krule
*krule
,
274 char *pathname
, int len
);
275 extern char *audit_mark_path(struct audit_fsnotify_mark
*mark
);
276 extern void audit_remove_mark(struct audit_fsnotify_mark
*audit_mark
);
277 extern void audit_remove_mark_rule(struct audit_krule
*krule
);
278 extern int audit_mark_compare(struct audit_fsnotify_mark
*mark
,
279 unsigned long ino
, dev_t dev
);
280 extern int audit_dupe_exe(struct audit_krule
*new, struct audit_krule
*old
);
281 extern int audit_exe_compare(struct task_struct
*tsk
,
282 struct audit_fsnotify_mark
*mark
);
284 extern struct audit_chunk
*audit_tree_lookup(const struct inode
*inode
);
285 extern void audit_put_chunk(struct audit_chunk
*chunk
);
286 extern bool audit_tree_match(struct audit_chunk
*chunk
,
287 struct audit_tree
*tree
);
288 extern int audit_make_tree(struct audit_krule
*rule
, char *pathname
, u32 op
);
289 extern int audit_add_tree_rule(struct audit_krule
*rule
);
290 extern int audit_remove_tree_rule(struct audit_krule
*rule
);
291 extern void audit_trim_trees(void);
292 extern int audit_tag_tree(char *old
, char *new);
293 extern const char *audit_tree_path(struct audit_tree
*tree
);
294 extern void audit_put_tree(struct audit_tree
*tree
);
295 extern void audit_kill_trees(struct audit_context
*context
);
297 extern int audit_signal_info_syscall(struct task_struct
*t
);
298 extern void audit_filter_inodes(struct task_struct
*tsk
,
299 struct audit_context
*ctx
);
300 extern struct list_head
*audit_killed_trees(void);
301 #else /* CONFIG_AUDITSYSCALL */
302 #define auditsc_get_stamp(c, t, s) 0
303 #define audit_put_watch(w) do { } while (0)
304 #define audit_get_watch(w) do { } while (0)
305 #define audit_to_watch(k, p, l, o) (-EINVAL)
306 #define audit_add_watch(k, l) (-EINVAL)
307 #define audit_remove_watch_rule(k) BUG()
308 #define audit_watch_path(w) ""
309 #define audit_watch_compare(w, i, d) 0
311 #define audit_alloc_mark(k, p, l) (ERR_PTR(-EINVAL))
312 #define audit_mark_path(m) ""
313 #define audit_remove_mark(m) do { } while (0)
314 #define audit_remove_mark_rule(k) do { } while (0)
315 #define audit_mark_compare(m, i, d) 0
316 #define audit_exe_compare(t, m) (-EINVAL)
317 #define audit_dupe_exe(n, o) (-EINVAL)
319 #define audit_remove_tree_rule(rule) BUG()
320 #define audit_add_tree_rule(rule) -EINVAL
321 #define audit_make_tree(rule, str, op) -EINVAL
322 #define audit_trim_trees() do { } while (0)
323 #define audit_put_tree(tree) do { } while (0)
324 #define audit_tag_tree(old, new) -EINVAL
325 #define audit_tree_path(rule) "" /* never called */
326 #define audit_kill_trees(context) BUG()
328 static inline int audit_signal_info_syscall(struct task_struct
*t
)
333 #define audit_filter_inodes(t, c) AUDIT_STATE_DISABLED
334 #endif /* CONFIG_AUDITSYSCALL */
336 extern char *audit_unpack_string(void **bufp
, size_t *remain
, size_t len
);
338 extern struct lsmblob audit_sig_lsm
;
340 extern int audit_filter(int msgtype
, unsigned int listtype
);
342 extern void audit_ctl_lock(void);
343 extern void audit_ctl_unlock(void);