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
118extern void audit_log_session_info(struct audit_buffer *ab);
119
120#ifdef CONFIG_AUDIT
121/* These are defined in audit.c */
122 /* Public API */
123extern __printf(4, 5)
124void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
125 const char *fmt, ...);
126
127extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
128extern __printf(2, 3)
129void audit_log_format(struct audit_buffer *ab, const char *fmt, ...);
130extern void audit_log_end(struct audit_buffer *ab);
131extern bool audit_string_contains_control(const char *string,
132 size_t len);
133extern void audit_log_n_hex(struct audit_buffer *ab,
134 const unsigned char *buf,
135 size_t len);
136extern void audit_log_n_string(struct audit_buffer *ab,
137 const char *buf,
138 size_t n);
139extern void audit_log_n_untrustedstring(struct audit_buffer *ab,
140 const char *string,
141 size_t n);
142extern void audit_log_untrustedstring(struct audit_buffer *ab,
143 const char *string);
144extern void audit_log_d_path(struct audit_buffer *ab,
145 const char *prefix,
146 const struct path *path);
147extern void audit_log_key(struct audit_buffer *ab,
148 char *key);
149extern void audit_log_link_denied(const char *operation);
150extern void audit_log_lost(const char *message);
151
152extern int audit_log_task_context(struct audit_buffer *ab);
153extern void audit_log_task_info(struct audit_buffer *ab,
154 struct task_struct *tsk);
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 struct task_struct *tsk)
204{ }
205#define audit_enabled 0
206#endif /* CONFIG_AUDIT */
207
208#ifdef CONFIG_AUDIT_COMPAT_GENERIC
209#define audit_is_compat(arch) (!((arch) & __AUDIT_ARCH_64BIT))
210#else
211#define audit_is_compat(arch) false
212#endif
213
214#ifdef CONFIG_AUDITSYSCALL
215#include <asm/syscall.h> /* for syscall_get_arch() */
216
217/* These are defined in auditsc.c */
218 /* Public API */
219extern int audit_alloc(struct task_struct *task);
220extern void __audit_free(struct task_struct *task);
221extern void __audit_syscall_entry(int major, unsigned long a0, unsigned long a1,
222 unsigned long a2, unsigned long a3);
223extern void __audit_syscall_exit(int ret_success, long ret_value);
224extern struct filename *__audit_reusename(const __user char *uptr);
225extern void __audit_getname(struct filename *name);
226
227#define AUDIT_INODE_PARENT 1 /* dentry represents the parent */
228#define AUDIT_INODE_HIDDEN 2 /* audit record should be hidden */
229extern void __audit_inode(struct filename *name, const struct dentry *dentry,
230 unsigned int flags);
231extern void __audit_file(const struct file *);
232extern void __audit_inode_child(struct inode *parent,
233 const struct dentry *dentry,
234 const unsigned char type);
235extern void audit_seccomp(unsigned long syscall, long signr, int code);
236extern void audit_seccomp_actions_logged(const char *names,
237 const char *old_names, int res);
238extern void __audit_ptrace(struct task_struct *t);
239
240static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
241{
242 task->audit_context = ctx;
243}
244
245static inline struct audit_context *audit_context(void)
246{
247 return current->audit_context;
248}
249
250static inline bool audit_dummy_context(void)
251{
252 void *p = audit_context();
253 return !p || *(int *)p;
254}
255static inline void audit_free(struct task_struct *task)
256{
257 if (unlikely(task->audit_context))
258 __audit_free(task);
259}
260static inline void audit_syscall_entry(int major, unsigned long a0,
261 unsigned long a1, unsigned long a2,
262 unsigned long a3)
263{
264 if (unlikely(audit_context()))
265 __audit_syscall_entry(major, a0, a1, a2, a3);
266}
267static inline void audit_syscall_exit(void *pt_regs)
268{
269 if (unlikely(audit_context())) {
270 int success = is_syscall_success(pt_regs);
271 long return_code = regs_return_value(pt_regs);
272
273 __audit_syscall_exit(success, return_code);
274 }
275}
276static inline struct filename *audit_reusename(const __user char *name)
277{
278 if (unlikely(!audit_dummy_context()))
279 return __audit_reusename(name);
280 return NULL;
281}
282static inline void audit_getname(struct filename *name)
283{
284 if (unlikely(!audit_dummy_context()))
285 __audit_getname(name);
286}
287static inline void audit_inode(struct filename *name,
288 const struct dentry *dentry,
289 unsigned int parent) {
290 if (unlikely(!audit_dummy_context())) {
291 unsigned int flags = 0;
292 if (parent)
293 flags |= AUDIT_INODE_PARENT;
294 __audit_inode(name, dentry, flags);
295 }
296}
297static inline void audit_file(struct file *file)
298{
299 if (unlikely(!audit_dummy_context()))
300 __audit_file(file);
301}
302static inline void audit_inode_parent_hidden(struct filename *name,
303 const struct dentry *dentry)
304{
305 if (unlikely(!audit_dummy_context()))
306 __audit_inode(name, dentry,
307 AUDIT_INODE_PARENT | AUDIT_INODE_HIDDEN);
308}
309static inline void audit_inode_child(struct inode *parent,
310 const struct dentry *dentry,
311 const unsigned char type) {
312 if (unlikely(!audit_dummy_context()))
313 __audit_inode_child(parent, dentry, type);
314}
315void audit_core_dumps(long signr);
316
317static inline void audit_ptrace(struct task_struct *t)
318{
319 if (unlikely(!audit_dummy_context()))
320 __audit_ptrace(t);
321}
322
323 /* Private API (for audit.c only) */
324extern unsigned int audit_serial(void);
325extern int auditsc_get_stamp(struct audit_context *ctx,
326 struct timespec64 *t, unsigned int *serial);
327extern int audit_set_loginuid(kuid_t loginuid);
328
329static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
330{
331 return tsk->loginuid;
332}
333
334static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
335{
336 return tsk->sessionid;
337}
338
339extern void __audit_ipc_obj(struct kern_ipc_perm *ipcp);
340extern void __audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode);
341extern void __audit_bprm(struct linux_binprm *bprm);
342extern int __audit_socketcall(int nargs, unsigned long *args);
343extern int __audit_sockaddr(int len, void *addr);
344extern void __audit_fd_pair(int fd1, int fd2);
345extern void __audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr);
346extern void __audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout);
347extern void __audit_mq_notify(mqd_t mqdes, const struct sigevent *notification);
348extern void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat);
349extern int __audit_log_bprm_fcaps(struct linux_binprm *bprm,
350 const struct cred *new,
351 const struct cred *old);
352extern void __audit_log_capset(const struct cred *new, const struct cred *old);
353extern void __audit_mmap_fd(int fd, int flags);
354extern void __audit_log_kern_module(char *name);
355extern void __audit_fanotify(unsigned int response);
356
357static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
358{
359 if (unlikely(!audit_dummy_context()))
360 __audit_ipc_obj(ipcp);
361}
362static inline void audit_fd_pair(int fd1, int fd2)
363{
364 if (unlikely(!audit_dummy_context()))
365 __audit_fd_pair(fd1, fd2);
366}
367static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode)
368{
369 if (unlikely(!audit_dummy_context()))
370 __audit_ipc_set_perm(qbytes, uid, gid, mode);
371}
372static inline void audit_bprm(struct linux_binprm *bprm)
373{
374 if (unlikely(!audit_dummy_context()))
375 __audit_bprm(bprm);
376}
377static inline int audit_socketcall(int nargs, unsigned long *args)
378{
379 if (unlikely(!audit_dummy_context()))
380 return __audit_socketcall(nargs, args);
381 return 0;
382}
383
384static inline int audit_socketcall_compat(int nargs, u32 *args)
385{
386 unsigned long a[AUDITSC_ARGS];
387 int i;
388
389 if (audit_dummy_context())
390 return 0;
391
392 for (i = 0; i < nargs; i++)
393 a[i] = (unsigned long)args[i];
394 return __audit_socketcall(nargs, a);
395}
396
397static inline int audit_sockaddr(int len, void *addr)
398{
399 if (unlikely(!audit_dummy_context()))
400 return __audit_sockaddr(len, addr);
401 return 0;
402}
403static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
404{
405 if (unlikely(!audit_dummy_context()))
406 __audit_mq_open(oflag, mode, attr);
407}
408static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec64 *abs_timeout)
409{
410 if (unlikely(!audit_dummy_context()))
411 __audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
412}
413static inline void audit_mq_notify(mqd_t mqdes, const struct sigevent *notification)
414{
415 if (unlikely(!audit_dummy_context()))
416 __audit_mq_notify(mqdes, notification);
417}
418static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
419{
420 if (unlikely(!audit_dummy_context()))
421 __audit_mq_getsetattr(mqdes, mqstat);
422}
423
424static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
425 const struct cred *new,
426 const struct cred *old)
427{
428 if (unlikely(!audit_dummy_context()))
429 return __audit_log_bprm_fcaps(bprm, new, old);
430 return 0;
431}
432
433static inline void audit_log_capset(const struct cred *new,
434 const struct cred *old)
435{
436 if (unlikely(!audit_dummy_context()))
437 __audit_log_capset(new, old);
438}
439
440static inline void audit_mmap_fd(int fd, int flags)
441{
442 if (unlikely(!audit_dummy_context()))
443 __audit_mmap_fd(fd, flags);
444}
445
446static inline void audit_log_kern_module(char *name)
447{
448 if (!audit_dummy_context())
449 __audit_log_kern_module(name);
450}
451
452static inline void audit_fanotify(unsigned int response)
453{
454 if (!audit_dummy_context())
455 __audit_fanotify(response);
456}
457
458extern int audit_n_rules;
459extern int audit_signals;
460#else /* CONFIG_AUDITSYSCALL */
461static inline int audit_alloc(struct task_struct *task)
462{
463 return 0;
464}
465static inline void audit_free(struct task_struct *task)
466{ }
467static inline void audit_syscall_entry(int major, unsigned long a0,
468 unsigned long a1, unsigned long a2,
469 unsigned long a3)
470{ }
471static inline void audit_syscall_exit(void *pt_regs)
472{ }
473static inline bool audit_dummy_context(void)
474{
475 return true;
476}
477static inline void audit_set_context(struct task_struct *task, struct audit_context *ctx)
478{ }
479static inline struct audit_context *audit_context(void)
480{
481 return NULL;
482}
483static inline struct filename *audit_reusename(const __user char *name)
484{
485 return NULL;
486}
487static inline void audit_getname(struct filename *name)
488{ }
489static inline void __audit_inode(struct filename *name,
490 const struct dentry *dentry,
491 unsigned int flags)
492{ }
493static inline void __audit_inode_child(struct inode *parent,
494 const struct dentry *dentry,
495 const unsigned char type)
496{ }
497static inline void audit_inode(struct filename *name,
498 const struct dentry *dentry,
499 unsigned int parent)
500{ }
501static inline void audit_file(struct file *file)
502{
503}
504static inline void audit_inode_parent_hidden(struct filename *name,
505 const struct dentry *dentry)
506{ }
507static inline void audit_inode_child(struct inode *parent,
508 const struct dentry *dentry,
509 const unsigned char type)
510{ }
511static inline void audit_core_dumps(long signr)
512{ }
513static inline void audit_seccomp(unsigned long syscall, long signr, int code)
514{ }
515static inline void audit_seccomp_actions_logged(const char *names,
516 const char *old_names, int res)
517{ }
518static inline int auditsc_get_stamp(struct audit_context *ctx,
519 struct timespec64 *t, unsigned int *serial)
520{
521 return 0;
522}
523static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
524{
525 return INVALID_UID;
526}
527static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
528{
529 return AUDIT_SID_UNSET;
530}
531static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
532{ }
533static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
534 gid_t gid, umode_t mode)
535{ }
536static inline void audit_bprm(struct linux_binprm *bprm)
537{ }
538static inline int audit_socketcall(int nargs, unsigned long *args)
539{
540 return 0;
541}
542
543static inline int audit_socketcall_compat(int nargs, u32 *args)
544{
545 return 0;
546}
547
548static inline void audit_fd_pair(int fd1, int fd2)
549{ }
550static inline int audit_sockaddr(int len, void *addr)
551{
552 return 0;
553}
554static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
555{ }
556static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
557 unsigned int msg_prio,
558 const struct timespec64 *abs_timeout)
559{ }
560static inline void audit_mq_notify(mqd_t mqdes,
561 const struct sigevent *notification)
562{ }
563static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
564{ }
565static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
566 const struct cred *new,
567 const struct cred *old)
568{
569 return 0;
570}
571static inline void audit_log_capset(const struct cred *new,
572 const struct cred *old)
573{ }
574static inline void audit_mmap_fd(int fd, int flags)
575{ }
576
577static inline void audit_log_kern_module(char *name)
578{
579}
580
581static inline void audit_fanotify(unsigned int response)
582{ }
583
584static inline void audit_ptrace(struct task_struct *t)
585{ }
586#define audit_n_rules 0
587#define audit_signals 0
588#endif /* CONFIG_AUDITSYSCALL */
589
590static inline bool audit_loginuid_set(struct task_struct *tsk)
591{
592 return uid_valid(audit_get_loginuid(tsk));
593}
594
595static inline void audit_log_string(struct audit_buffer *ab, const char *buf)
596{
597 audit_log_n_string(ab, buf, strlen(buf));
598}
599
600#endif