audit: add OPENAT2 record to list "how" info
[linux-block.git] / kernel / audit.h
CommitLineData
1a59d1b8 1/* SPDX-License-Identifier: GPL-2.0-or-later */
6ddb5680 2/* audit -- definition of audit_context structure and supporting types
fe7752ba
DW
3 *
4 * Copyright 2003-2004 Red Hat, Inc.
5 * Copyright 2005 Hewlett-Packard Development Company, L.P.
6 * Copyright 2005 IBM Corporation
fe7752ba
DW
7 */
8
d97e9938
M
9#ifndef _KERNEL_AUDIT_H_
10#define _KERNEL_AUDIT_H_
11
fe7752ba
DW
12#include <linux/fs.h>
13#include <linux/audit.h>
9044e6bc 14#include <linux/skbuff.h>
b24a30a7 15#include <uapi/linux/mqueue.h>
3f5be2da 16#include <linux/tty.h>
571e5c0e 17#include <uapi/linux/openat2.h> // struct open_how
fe7752ba 18
b24a30a7
EP
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. */
22#define AUDIT_NAMES 5
23
fe7752ba
DW
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. */
27enum audit_state {
619ed58a 28 AUDIT_STATE_DISABLED, /* Do not create per-task audit_context.
fe7752ba
DW
29 * No syscall-specific audit records can
30 * be generated. */
619ed58a 31 AUDIT_STATE_BUILD, /* Create the per-task audit_context,
997f5b64 32 * and fill it in at syscall
fe7752ba
DW
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. */
619ed58a 37 AUDIT_STATE_RECORD /* Create the per-task audit_context,
fe7752ba
DW
38 * always fill it in at syscall entry
39 * time, and always write out the audit
40 * record at syscall exit time. */
41};
42
43/* Rule lists */
cfcad62c 44struct audit_watch;
7f492942 45struct audit_fsnotify_mark;
74c3cbe3
AV
46struct audit_tree;
47struct audit_chunk;
48
fe7752ba 49struct audit_entry {
93315ed6
AG
50 struct list_head list;
51 struct rcu_head rcu;
52 struct audit_krule rule;
fe7752ba
DW
53};
54
b24a30a7
EP
55struct audit_cap_data {
56 kernel_cap_t permitted;
57 kernel_cap_t inheritable;
58 union {
59 unsigned int fE; /* effective bit of file cap */
60 kernel_cap_t effective; /* effective set of process */
61 };
7786f6b6 62 kernel_cap_t ambient;
2fec30e2 63 kuid_t rootid;
b24a30a7
EP
64};
65
55422d0b
PM
66/* When fs/namei.c:getname() is called, we store the pointer in name and bump
67 * the refcnt in the associated filename struct.
b24a30a7
EP
68 *
69 * Further, in fs/namei.c:path_lookup() we store the inode and device.
70 */
71struct audit_names {
72 struct list_head list; /* audit_context->names_list */
73
74 struct filename *name;
75 int name_len; /* number of chars to log */
79f6530c 76 bool hidden; /* don't log this record */
b24a30a7
EP
77
78 unsigned long ino;
79 dev_t dev;
80 umode_t mode;
81 kuid_t uid;
82 kgid_t gid;
83 dev_t rdev;
84 u32 osid;
85 struct audit_cap_data fcap;
86 unsigned int fcap_ver;
87 unsigned char type; /* record type */
88 /*
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.
92 */
93 bool should_free;
94};
95
3f1c8250
WR
96struct audit_proctitle {
97 int len; /* length of the cmdline field. */
98 char *value; /* the cmdline field */
99};
100
b24a30a7
EP
101/* The per-task audit context. */
102struct 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 */
2115bb25 108 struct timespec64 ctime; /* time of syscall entry */
b24a30a7
EP
109 unsigned long argv[4]; /* syscall arguments */
110 long return_code;/* syscall return code */
111 u64 prio;
112 int return_valid; /* return code is valid */
113 /*
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.
120 */
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 */
125 struct path pwd;
126 struct audit_aux_data *aux;
127 struct audit_aux_data *aux_pids;
128 struct sockaddr_storage *sockaddr;
129 size_t sockaddr_len;
130 /* Save things to print about task_struct */
131 pid_t pid, ppid;
132 kuid_t uid, euid, suid, fsuid;
133 kgid_t gid, egid, sgid, fsgid;
134 unsigned long personality;
135 int arch;
136
137 pid_t target_pid;
138 kuid_t target_auid;
139 kuid_t target_uid;
140 unsigned int target_sessionid;
141 u32 target_sid;
142 char target_comm[TASK_COMM_LEN];
143
144 struct audit_tree_refs *trees, *first_trees;
145 struct list_head killed_trees;
146 int tree_count;
147
148 int type;
149 union {
150 struct {
151 int nargs;
152 long args[6];
153 } socketcall;
154 struct {
155 kuid_t uid;
156 kgid_t gid;
157 umode_t mode;
158 u32 osid;
159 int has_perm;
160 uid_t perm_uid;
161 gid_t perm_gid;
162 umode_t perm_mode;
163 unsigned long qbytes;
164 } ipc;
165 struct {
166 mqd_t mqdes;
167 struct mq_attr mqstat;
168 } mq_getsetattr;
169 struct {
170 mqd_t mqdes;
171 int sigev_signo;
172 } mq_notify;
173 struct {
174 mqd_t mqdes;
175 size_t msg_len;
176 unsigned int msg_prio;
b9047726 177 struct timespec64 abs_timeout;
b24a30a7
EP
178 } mq_sendrecv;
179 struct {
180 int oflag;
181 umode_t mode;
182 struct mq_attr attr;
183 } mq_open;
184 struct {
185 pid_t pid;
186 struct audit_cap_data cap;
187 } capset;
188 struct {
189 int fd;
190 int flags;
191 } mmap;
571e5c0e 192 struct open_how openat2;
d9cfea91
RGB
193 struct {
194 int argc;
d9cfea91 195 } execve;
ca86cad7
RGB
196 struct {
197 char *name;
198 } module;
b24a30a7
EP
199 };
200 int fds[2];
3f1c8250 201 struct audit_proctitle proctitle;
b24a30a7
EP
202};
203
b3b4fdf6 204extern bool audit_ever_enabled;
c782f242 205
0fe3c7fc
RGB
206extern void audit_log_session_info(struct audit_buffer *ab);
207
b6c7c115 208extern int auditd_test_task(struct task_struct *task);
fe7752ba 209
f368c07d
AG
210#define AUDIT_INODE_BUCKETS 32
211extern struct list_head audit_inode_hash[AUDIT_INODE_BUCKETS];
212
213static inline int audit_hash_ino(u32 ino)
214{
215 return (ino & (AUDIT_INODE_BUCKETS-1));
216}
217
e3d6b07b
JL
218/* Indicates that audit should log the full pathname. */
219#define AUDIT_NAME_FULL -1
220
55669bfa 221extern int audit_match_class(int class, unsigned syscall);
f368c07d 222extern int audit_comparator(const u32 left, const u32 op, const u32 right);
ca57ec0f
EB
223extern int audit_uid_comparator(kuid_t left, u32 op, kuid_t right);
224extern int audit_gid_comparator(kgid_t left, u32 op, kgid_t right);
bfcec708 225extern int parent_len(const char *path);
795d673a 226extern int audit_compare_dname_path(const struct qstr *dname, const char *path, int plen);
45a0642b 227extern struct sk_buff *audit_make_reply(int seq, int type, int done, int multi,
f9441639 228 const void *payload, int size);
fe7752ba 229extern void audit_panic(const char *message);
3dc7e315 230
9044e6bc 231struct audit_netlink_list {
f9441639 232 __u32 portid;
638a0fd2 233 struct net *net;
9044e6bc
AV
234 struct sk_buff_head q;
235};
236
3054d067 237int audit_send_list_thread(void *_dest);
9044e6bc 238
3dc7e315 239extern int selinux_audit_rule_update(void);
e1396065 240
74c3cbe3 241extern struct mutex audit_filter_mutex;
e4c1a0d1
DR
242extern int audit_del_rule(struct audit_entry *entry);
243extern void audit_free_rule_rcu(struct rcu_head *head);
c782f242 244extern struct list_head audit_filter_list[];
74c3cbe3 245
939a67fc
EP
246extern struct audit_entry *audit_dupe_rule(struct audit_krule *old);
247
4766b199
DB
248extern void audit_log_d_path_exe(struct audit_buffer *ab,
249 struct mm_struct *mm);
250
2a1fe215 251extern struct tty_struct *audit_get_tty(void);
3f5be2da
RGB
252extern void audit_put_tty(struct tty_struct *tty);
253
05c7a9cb 254/* audit watch/mark/tree functions */
c8fc5d49 255#ifdef CONFIG_AUDITSYSCALL
cd108b5c
RGB
256extern unsigned int audit_serial(void);
257extern int auditsc_get_stamp(struct audit_context *ctx,
258 struct timespec64 *t, unsigned int *serial);
259
cfcad62c
EP
260extern void audit_put_watch(struct audit_watch *watch);
261extern void audit_get_watch(struct audit_watch *watch);
05c7a9cb
RGB
262extern int audit_to_watch(struct audit_krule *krule, char *path, int len,
263 u32 op);
ae7b8f41 264extern int audit_add_watch(struct audit_krule *krule, struct list_head **list);
a05fb6cc 265extern void audit_remove_watch_rule(struct audit_krule *krule);
cfcad62c 266extern char *audit_watch_path(struct audit_watch *watch);
05c7a9cb
RGB
267extern int audit_watch_compare(struct audit_watch *watch, unsigned long ino,
268 dev_t dev);
7f492942 269
05c7a9cb
RGB
270extern struct audit_fsnotify_mark *audit_alloc_mark(struct audit_krule *krule,
271 char *pathname, int len);
7f492942
RGB
272extern char *audit_mark_path(struct audit_fsnotify_mark *mark);
273extern void audit_remove_mark(struct audit_fsnotify_mark *audit_mark);
274extern void audit_remove_mark_rule(struct audit_krule *krule);
05c7a9cb
RGB
275extern int audit_mark_compare(struct audit_fsnotify_mark *mark,
276 unsigned long ino, dev_t dev);
34d99af5 277extern int audit_dupe_exe(struct audit_krule *new, struct audit_krule *old);
05c7a9cb
RGB
278extern int audit_exe_compare(struct task_struct *tsk,
279 struct audit_fsnotify_mark *mark);
7f492942 280
05c7a9cb
RGB
281extern struct audit_chunk *audit_tree_lookup(const struct inode *inode);
282extern void audit_put_chunk(struct audit_chunk *chunk);
283extern bool audit_tree_match(struct audit_chunk *chunk,
284 struct audit_tree *tree);
285extern int audit_make_tree(struct audit_krule *rule, char *pathname, u32 op);
286extern int audit_add_tree_rule(struct audit_krule *rule);
287extern int audit_remove_tree_rule(struct audit_krule *rule);
288extern void audit_trim_trees(void);
289extern int audit_tag_tree(char *old, char *new);
290extern const char *audit_tree_path(struct audit_tree *tree);
291extern void audit_put_tree(struct audit_tree *tree);
292extern void audit_kill_trees(struct audit_context *context);
293
b48345aa 294extern int audit_signal_info_syscall(struct task_struct *t);
05c7a9cb
RGB
295extern void audit_filter_inodes(struct task_struct *tsk,
296 struct audit_context *ctx);
297extern struct list_head *audit_killed_trees(void);
298#else /* CONFIG_AUDITSYSCALL */
cd108b5c 299#define auditsc_get_stamp(c, t, s) 0
d4ceb1d6
AB
300#define audit_put_watch(w) do { } while (0)
301#define audit_get_watch(w) do { } while (0)
939a67fc
EP
302#define audit_to_watch(k, p, l, o) (-EINVAL)
303#define audit_add_watch(k, l) (-EINVAL)
304#define audit_remove_watch_rule(k) BUG()
305#define audit_watch_path(w) ""
306#define audit_watch_compare(w, i, d) 0
307
7f492942
RGB
308#define audit_alloc_mark(k, p, l) (ERR_PTR(-EINVAL))
309#define audit_mark_path(m) ""
d4ceb1d6
AB
310#define audit_remove_mark(m) do { } while (0)
311#define audit_remove_mark_rule(k) do { } while (0)
7f492942 312#define audit_mark_compare(m, i, d) 0
34d99af5
RGB
313#define audit_exe_compare(t, m) (-EINVAL)
314#define audit_dupe_exe(n, o) (-EINVAL)
cfcad62c 315
74c3cbe3
AV
316#define audit_remove_tree_rule(rule) BUG()
317#define audit_add_tree_rule(rule) -EINVAL
318#define audit_make_tree(rule, str, op) -EINVAL
d4ceb1d6
AB
319#define audit_trim_trees() do { } while (0)
320#define audit_put_tree(tree) do { } while (0)
74c3cbe3
AV
321#define audit_tag_tree(old, new) -EINVAL
322#define audit_tree_path(rule) "" /* never called */
9e36a5d4 323#define audit_kill_trees(context) BUG()
05c7a9cb 324
b48345aa
RGB
325static inline int audit_signal_info_syscall(struct task_struct *t)
326{
327 return 0;
328}
329
619ed58a 330#define audit_filter_inodes(t, c) AUDIT_STATE_DISABLED
05c7a9cb 331#endif /* CONFIG_AUDITSYSCALL */
74c3cbe3 332
e4c1a0d1 333extern char *audit_unpack_string(void **bufp, size_t *remain, size_t len);
74c3cbe3 334
86b2efbe
RGB
335extern int audit_filter(int msgtype, unsigned int listtype);
336
ce423631
PM
337extern void audit_ctl_lock(void);
338extern void audit_ctl_unlock(void);
d97e9938
M
339
340#endif