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