Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* audit.h -- Auditing support
2 *
3 * Copyright 2003-2004 Red Hat Inc., Durham, North Carolina.
4 * All Rights Reserved.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 * Written by Rickard E. (Rik) Faith <faith@redhat.com>
21 *
22 */
23#ifndef _LINUX_AUDIT_H_
24#define _LINUX_AUDIT_H_
25
26#include <linux/sched.h>
27#include <linux/ptrace.h>
28#include <uapi/linux/audit.h>
29
30#define AUDIT_INO_UNSET ((unsigned long)-1)
31#define AUDIT_DEV_UNSET ((dev_t)-1)
32
33struct audit_sig_info {
34 uid_t uid;
35 pid_t pid;
36 char ctx[0];
37};
38
39struct audit_buffer;
40struct audit_context;
41struct inode;
42struct netlink_skb_parms;
43struct path;
44struct linux_binprm;
45struct mq_attr;
46struct mqstat;
47struct audit_watch;
48struct audit_tree;
49struct sk_buff;
50
51struct audit_krule {
52 u32 pflags;
53 u32 flags;
54 u32 listnr;
55 u32 action;
56 u32 mask[AUDIT_BITMASK_SIZE];
57 u32 buflen; /* for data alloc on list rules */
58 u32 field_count;
59 char *filterkey; /* ties events to rules */
60 struct audit_field *fields;
61 struct audit_field *arch_f; /* quick access to arch field */
62 struct audit_field *inode_f; /* quick access to an inode field */
63 struct audit_watch *watch; /* associated watch */
64 struct audit_tree *tree; /* associated watched tree */
65 struct audit_fsnotify_mark *exe;
66 struct list_head rlist; /* entry in audit_{watch,tree}.rules list */
67 struct list_head list; /* for AUDIT_LIST* purposes only */
68 u64 prio;
69};
70
71/* Flag to indicate legacy AUDIT_LOGINUID unset usage */
72#define AUDIT_LOGINUID_LEGACY 0x1
73
74struct audit_field {
75 u32 type;
76 union {
77 u32 val;
78 kuid_t uid;
79 kgid_t gid;
80 struct {
81 char *lsm_str;
82 void *lsm_rule;
83 };
84 };
85 u32 op;
86};
87
88extern int is_audit_feature_set(int which);
89
90extern int __init audit_register_class(int class, unsigned *list);
91extern int audit_classify_syscall(int abi, unsigned syscall);
92extern int audit_classify_arch(int arch);
93/* only for compat system calls */
94extern unsigned compat_write_class[];
95extern unsigned compat_read_class[];
96extern unsigned compat_dir_class[];
97extern unsigned compat_chattr_class[];
98extern unsigned compat_signal_class[];
99
100extern int audit_classify_compat_syscall(int abi, unsigned syscall);
101
102/* audit_names->type values */
103#define AUDIT_TYPE_UNKNOWN 0 /* we don't know yet */
104#define AUDIT_TYPE_NORMAL 1 /* a "normal" audit record */
105#define AUDIT_TYPE_PARENT 2 /* a parent audit record */
106#define AUDIT_TYPE_CHILD_DELETE 3 /* a child being deleted */
107#define AUDIT_TYPE_CHILD_CREATE 4 /* a child being created */
108
109/* maximized args number that audit_socketcall can process */
110#define AUDITSC_ARGS 6
111
112/* bit values for ->signal->audit_tty */
113#define AUDIT_TTY_ENABLE BIT(0)
114#define AUDIT_TTY_LOG_PASSWD BIT(1)
115
116struct filename;
117
118#define AUDIT_OFF 0
119#define AUDIT_ON 1
120#define AUDIT_LOCKED 2
121#ifdef CONFIG_AUDIT
122/* These are defined in audit.c */
123 /* Public API */
124extern __printf(4, 5)
125void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
126 const char *fmt, ...);
127
128extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
129extern __printf(2, 3)
130void audit_log_format(struct audit_buffer *ab, const char *fmt, ...);
131extern void audit_log_end(struct audit_buffer *ab);
132extern bool audit_string_contains_control(const char *string,
133 size_t len);
134extern void audit_log_n_hex(struct audit_buffer *ab,
135 const unsigned char *buf,
136 size_t len);
137extern void audit_log_n_string(struct audit_buffer *ab,
138 const char *buf,
139 size_t n);
140extern void audit_log_n_untrustedstring(struct audit_buffer *ab,
141 const char *string,
142 size_t n);
143extern void audit_log_untrustedstring(struct audit_buffer *ab,
144 const char *string);
145extern void audit_log_d_path(struct audit_buffer *ab,
146 const char *prefix,
147 const struct path *path);
148extern void audit_log_key(struct audit_buffer *ab,
149 char *key);
150extern void audit_log_link_denied(const char *operation);
151extern void audit_log_lost(const char *message);
152
153extern int audit_log_task_context(struct audit_buffer *ab);
154extern void audit_log_task_info(struct audit_buffer *ab);
155
156extern int audit_update_lsm_rules(void);
157
158 /* Private API (for audit.c only) */
159extern int audit_rule_change(int type, int seq, void *data, size_t datasz);
160extern int audit_list_rules_send(struct sk_buff *request_skb, int seq);
161
162extern u32 audit_enabled;
163#else /* CONFIG_AUDIT */
164static inline __printf(4, 5)
165void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
166 const char *fmt, ...)
167{ }
168static inline struct audit_buffer *audit_log_start(struct audit_context *ctx,
169 gfp_t gfp_mask, int type)
170{
171 return NULL;
172}
173static inline __printf(2, 3)
174void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
175{ }
176static inline void audit_log_end(struct audit_buffer *ab)
177{ }
178static inline void audit_log_n_hex(struct audit_buffer *ab,
179 const unsigned char *buf, size_t len)
180{ }
181static inline void audit_log_n_string(struct audit_buffer *ab,
182 const char *buf, size_t n)
183{ }
184static inline void audit_log_n_untrustedstring(struct audit_buffer *ab,
185 const char *string, size_t n)
186{ }
187static inline void audit_log_untrustedstring(struct audit_buffer *ab,
188 const char *string)
189{ }
190static inline void audit_log_d_path(struct audit_buffer *ab,
191 const char *prefix,
192 const struct path *path)
193{ }
194static inline void audit_log_key(struct audit_buffer *ab, char *key)
195{ }
196static inline void audit_log_link_denied(const char *string)
197{ }
198static inline int audit_log_task_context(struct audit_buffer *ab)
199{
200 return 0;
201}
202static inline void audit_log_task_info(struct audit_buffer *ab)
203{ }
204#define audit_enabled AUDIT_OFF
205#endif /* CONFIG_AUDIT */
206
207#ifdef CONFIG_AUDIT_COMPAT_GENERIC
208#define audit_is_compat(arch) (!((arch) & __AUDIT_ARCH_64BIT))
209#else
210#define audit_is_compat(arch) false
211#endif
212
213#ifdef CONFIG_AUDITSYSCALL
214#include <asm/syscall.h> /* for syscall_get_arch() */
215
216/* These are defined in auditsc.c */
217 /* Public API */
218extern int audit_alloc(struct task_struct *task);
219extern void __audit_free(struct task_struct *task);
220extern void __audit_syscall_entry(int major, unsigned long a0, unsigned long a1,
221 unsigned long a2, unsigned long a3);
222extern void __audit_syscall_exit(int ret_success, long ret_value);
223extern struct filename *__audit_reusename(const __user char *uptr);
224extern void __audit_getname(struct filename *name);
225
226#define AUDIT_INODE_PARENT 1 /* dentry represents the parent */
227#define AUDIT_INODE_HIDDEN 2 /* audit record should be hidden */
228extern void __audit_inode(struct filename *name, const struct dentry *dentry,
229 unsigned int flags);
230extern void __audit_file(const struct file *);
231extern void __audit_inode_child(struct inode *parent,
232 const struct dentry *dentry,
233 const unsigned char type);
234extern void audit_seccomp(unsigned long syscall, long signr, int code);
235extern void audit_seccomp_actions_logged(const char *names,
236 const char *old_names, int res);
237extern void __audit_ptrace(struct task_struct *t);
238
239static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
240{
241 task->audit_context = ctx;
242}
243
244static inline struct audit_context *audit_context(void)
245{
246 return current->audit_context;
247}
248
249static inline bool audit_dummy_context(void)
250{
251 void *p = audit_context();
252 return !p || *(int *)p;
253}
254static inline void audit_free(struct task_struct *task)
255{
256 if (unlikely(task->audit_context))
257 __audit_free(task);
258}
259static inline void audit_syscall_entry(int major, unsigned long a0,
260 unsigned long a1, unsigned long a2,
261 unsigned long a3)
262{
263 if (unlikely(audit_context()))
264 __audit_syscall_entry(major, a0, a1, a2, a3);
265}
266static inline void audit_syscall_exit(void *pt_regs)
267{
268 if (unlikely(audit_context())) {
269 int success = is_syscall_success(pt_regs);
270 long return_code = regs_return_value(pt_regs);
271
272 __audit_syscall_exit(success, return_code);
273 }
274}
275static inline struct filename *audit_reusename(const __user char *name)
276{
277 if (unlikely(!audit_dummy_context()))
278 return __audit_reusename(name);
279 return NULL;
280}
281static inline void audit_getname(struct filename *name)
282{
283 if (unlikely(!audit_dummy_context()))
284 __audit_getname(name);
285}
286static inline void audit_inode(struct filename *name,
287 const struct dentry *dentry,
288 unsigned int parent) {
289 if (unlikely(!audit_dummy_context())) {
290 unsigned int flags = 0;
291 if (parent)
292 flags |= AUDIT_INODE_PARENT;
293 __audit_inode(name, dentry, flags);
294 }
295}
296static inline void audit_file(struct file *file)
297{
298 if (unlikely(!audit_dummy_context()))
299 __audit_file(file);
300}
301static inline void audit_inode_parent_hidden(struct filename *name,
302 const struct dentry *dentry)
303{
304 if (unlikely(!audit_dummy_context()))
305 __audit_inode(name, dentry,
306 AUDIT_INODE_PARENT | AUDIT_INODE_HIDDEN);
307}
308static inline void audit_inode_child(struct inode *parent,
309 const struct dentry *dentry,
310 const unsigned char type) {
311 if (unlikely(!audit_dummy_context()))
312 __audit_inode_child(parent, dentry, type);
313}
314void audit_core_dumps(long signr);
315
316static inline void audit_ptrace(struct task_struct *t)
317{
318 if (unlikely(!audit_dummy_context()))
319 __audit_ptrace(t);
320}
321
322 /* Private API (for audit.c only) */
323extern unsigned int audit_serial(void);
324extern int auditsc_get_stamp(struct audit_context *ctx,
325 struct timespec64 *t, unsigned int *serial);
326extern int audit_set_loginuid(kuid_t loginuid);
327
328static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
329{
330 return tsk->loginuid;
331}
332
333static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
334{
335 return tsk->sessionid;
336}
337
338extern void __audit_ipc_obj(struct kern_ipc_perm *ipcp);
339extern void __audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode);
340extern void __audit_bprm(struct linux_binprm *bprm);
341extern int __audit_socketcall(int nargs, unsigned long *args);
342extern int __audit_sockaddr(int len, void *addr);
343extern void __audit_fd_pair(int fd1, int fd2);
344extern void __audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr);
345extern void __audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout);
346extern void __audit_mq_notify(mqd_t mqdes, const struct sigevent *notification);
347extern void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat);
348extern int __audit_log_bprm_fcaps(struct linux_binprm *bprm,
349 const struct cred *new,
350 const struct cred *old);
351extern void __audit_log_capset(const struct cred *new, const struct cred *old);
352extern void __audit_mmap_fd(int fd, int flags);
353extern void __audit_log_kern_module(char *name);
354extern void __audit_fanotify(unsigned int response);
355
356static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
357{
358 if (unlikely(!audit_dummy_context()))
359 __audit_ipc_obj(ipcp);
360}
361static inline void audit_fd_pair(int fd1, int fd2)
362{
363 if (unlikely(!audit_dummy_context()))
364 __audit_fd_pair(fd1, fd2);
365}
366static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode)
367{
368 if (unlikely(!audit_dummy_context()))
369 __audit_ipc_set_perm(qbytes, uid, gid, mode);
370}
371static inline void audit_bprm(struct linux_binprm *bprm)
372{
373 if (unlikely(!audit_dummy_context()))
374 __audit_bprm(bprm);
375}
376static inline int audit_socketcall(int nargs, unsigned long *args)
377{
378 if (unlikely(!audit_dummy_context()))
379 return __audit_socketcall(nargs, args);
380 return 0;
381}
382
383static inline int audit_socketcall_compat(int nargs, u32 *args)
384{
385 unsigned long a[AUDITSC_ARGS];
386 int i;
387
388 if (audit_dummy_context())
389 return 0;
390
391 for (i = 0; i < nargs; i++)
392 a[i] = (unsigned long)args[i];
393 return __audit_socketcall(nargs, a);
394}
395
396static inline int audit_sockaddr(int len, void *addr)
397{
398 if (unlikely(!audit_dummy_context()))
399 return __audit_sockaddr(len, addr);
400 return 0;
401}
402static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
403{
404 if (unlikely(!audit_dummy_context()))
405 __audit_mq_open(oflag, mode, attr);
406}
407static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout)
408{
409 if (unlikely(!audit_dummy_context()))
410 __audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
411}
412static inline void audit_mq_notify(mqd_t mqdes, const struct sigevent *notification)
413{
414 if (unlikely(!audit_dummy_context()))
415 __audit_mq_notify(mqdes, notification);
416}
417static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
418{
419 if (unlikely(!audit_dummy_context()))
420 __audit_mq_getsetattr(mqdes, mqstat);
421}
422
423static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
424 const struct cred *new,
425 const struct cred *old)
426{
427 if (unlikely(!audit_dummy_context()))
428 return __audit_log_bprm_fcaps(bprm, new, old);
429 return 0;
430}
431
432static inline void audit_log_capset(const struct cred *new,
433 const struct cred *old)
434{
435 if (unlikely(!audit_dummy_context()))
436 __audit_log_capset(new, old);
437}
438
439static inline void audit_mmap_fd(int fd, int flags)
440{
441 if (unlikely(!audit_dummy_context()))
442 __audit_mmap_fd(fd, flags);
443}
444
445static inline void audit_log_kern_module(char *name)
446{
447 if (!audit_dummy_context())
448 __audit_log_kern_module(name);
449}
450
451static inline void audit_fanotify(unsigned int response)
452{
453 if (!audit_dummy_context())
454 __audit_fanotify(response);
455}
456
457extern int audit_n_rules;
458extern int audit_signals;
459#else /* CONFIG_AUDITSYSCALL */
460static inline int audit_alloc(struct task_struct *task)
461{
462 return 0;
463}
464static inline void audit_free(struct task_struct *task)
465{ }
466static inline void audit_syscall_entry(int major, unsigned long a0,
467 unsigned long a1, unsigned long a2,
468 unsigned long a3)
469{ }
470static inline void audit_syscall_exit(void *pt_regs)
471{ }
472static inline bool audit_dummy_context(void)
473{
474 return true;
475}
476static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
477{ }
478static inline struct audit_context *audit_context(void)
479{
480 return NULL;
481}
482static inline struct filename *audit_reusename(const __user char *name)
483{
484 return NULL;
485}
486static inline void audit_getname(struct filename *name)
487{ }
488static inline void __audit_inode(struct filename *name,
489 const struct dentry *dentry,
490 unsigned int flags)
491{ }
492static inline void __audit_inode_child(struct inode *parent,
493 const struct dentry *dentry,
494 const unsigned char type)
495{ }
496static inline void audit_inode(struct filename *name,
497 const struct dentry *dentry,
498 unsigned int parent)
499{ }
500static inline void audit_file(struct file *file)
501{
502}
503static inline void audit_inode_parent_hidden(struct filename *name,
504 const struct dentry *dentry)
505{ }
506static inline void audit_inode_child(struct inode *parent,
507 const struct dentry *dentry,
508 const unsigned char type)
509{ }
510static inline void audit_core_dumps(long signr)
511{ }
512static inline void audit_seccomp(unsigned long syscall, long signr, int code)
513{ }
514static inline void audit_seccomp_actions_logged(const char *names,
515 const char *old_names, int res)
516{ }
517static inline int auditsc_get_stamp(struct audit_context *ctx,
518 struct timespec64 *t, unsigned int *serial)
519{
520 return 0;
521}
522static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
523{
524 return INVALID_UID;
525}
526static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
527{
528 return AUDIT_SID_UNSET;
529}
530static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
531{ }
532static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
533 gid_t gid, umode_t mode)
534{ }
535static inline void audit_bprm(struct linux_binprm *bprm)
536{ }
537static inline int audit_socketcall(int nargs, unsigned long *args)
538{
539 return 0;
540}
541
542static inline int audit_socketcall_compat(int nargs, u32 *args)
543{
544 return 0;
545}
546
547static inline void audit_fd_pair(int fd1, int fd2)
548{ }
549static inline int audit_sockaddr(int len, void *addr)
550{
551 return 0;
552}
553static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
554{ }
555static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
556 unsigned int msg_prio,
557 const struct timespec64 *abs_timeout)
558{ }
559static inline void audit_mq_notify(mqd_t mqdes,
560 const struct sigevent *notification)
561{ }
562static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
563{ }
564static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
565 const struct cred *new,
566 const struct cred *old)
567{
568 return 0;
569}
570static inline void audit_log_capset(const struct cred *new,
571 const struct cred *old)
572{ }
573static inline void audit_mmap_fd(int fd, int flags)
574{ }
575
576static inline void audit_log_kern_module(char *name)
577{
578}
579
580static inline void audit_fanotify(unsigned int response)
581{ }
582
583static inline void audit_ptrace(struct task_struct *t)
584{ }
585#define audit_n_rules 0
586#define audit_signals 0
587#endif /* CONFIG_AUDITSYSCALL */
588
589static inline bool audit_loginuid_set(struct task_struct *tsk)
590{
591 return uid_valid(audit_get_loginuid(tsk));
592}
593
594static inline void audit_log_string(struct audit_buffer *ab, const char *buf)
595{
596 audit_log_n_string(ab, buf, strlen(buf));
597}
598
599#endif