fa1b068d911d9ca6899c1c0176c80dc4fce59345
[muen/linux.git] / include / linux / audit.h
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
33 struct audit_sig_info {
34         uid_t           uid;
35         pid_t           pid;
36         char            ctx[0];
37 };
38
39 struct audit_buffer;
40 struct audit_context;
41 struct inode;
42 struct netlink_skb_parms;
43 struct path;
44 struct linux_binprm;
45 struct mq_attr;
46 struct mqstat;
47 struct audit_watch;
48 struct audit_tree;
49 struct sk_buff;
50
51 struct 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
74 struct 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
88 extern int is_audit_feature_set(int which);
89
90 extern int __init audit_register_class(int class, unsigned *list);
91 extern int audit_classify_syscall(int abi, unsigned syscall);
92 extern int audit_classify_arch(int arch);
93 /* only for compat system calls */
94 extern unsigned compat_write_class[];
95 extern unsigned compat_read_class[];
96 extern unsigned compat_dir_class[];
97 extern unsigned compat_chattr_class[];
98 extern unsigned compat_signal_class[];
99
100 extern 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
116 struct filename;
117
118 extern void audit_log_session_info(struct audit_buffer *ab);
119
120 #ifdef CONFIG_AUDIT
121 /* These are defined in audit.c */
122                                 /* Public API */
123 extern __printf(4, 5)
124 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
125                const char *fmt, ...);
126
127 extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
128 extern __printf(2, 3)
129 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...);
130 extern void                 audit_log_end(struct audit_buffer *ab);
131 extern bool                 audit_string_contains_control(const char *string,
132                                                           size_t len);
133 extern void                 audit_log_n_hex(struct audit_buffer *ab,
134                                           const unsigned char *buf,
135                                           size_t len);
136 extern void                 audit_log_n_string(struct audit_buffer *ab,
137                                                const char *buf,
138                                                size_t n);
139 extern void                 audit_log_n_untrustedstring(struct audit_buffer *ab,
140                                                         const char *string,
141                                                         size_t n);
142 extern void                 audit_log_untrustedstring(struct audit_buffer *ab,
143                                                       const char *string);
144 extern void                 audit_log_d_path(struct audit_buffer *ab,
145                                              const char *prefix,
146                                              const struct path *path);
147 extern void                 audit_log_key(struct audit_buffer *ab,
148                                           char *key);
149 extern void                 audit_log_link_denied(const char *operation,
150                                                   const struct path *link);
151 extern void                 audit_log_lost(const char *message);
152
153 extern int audit_log_task_context(struct audit_buffer *ab);
154 extern void audit_log_task_info(struct audit_buffer *ab,
155                                 struct task_struct *tsk);
156
157 extern int                  audit_update_lsm_rules(void);
158
159                                 /* Private API (for audit.c only) */
160 extern int audit_rule_change(int type, int seq, void *data, size_t datasz);
161 extern int audit_list_rules_send(struct sk_buff *request_skb, int seq);
162
163 extern u32 audit_enabled;
164 #else /* CONFIG_AUDIT */
165 static inline __printf(4, 5)
166 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
167                const char *fmt, ...)
168 { }
169 static inline struct audit_buffer *audit_log_start(struct audit_context *ctx,
170                                                    gfp_t gfp_mask, int type)
171 {
172         return NULL;
173 }
174 static inline __printf(2, 3)
175 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
176 { }
177 static inline void audit_log_end(struct audit_buffer *ab)
178 { }
179 static inline void audit_log_n_hex(struct audit_buffer *ab,
180                                    const unsigned char *buf, size_t len)
181 { }
182 static inline void audit_log_n_string(struct audit_buffer *ab,
183                                       const char *buf, size_t n)
184 { }
185 static inline void  audit_log_n_untrustedstring(struct audit_buffer *ab,
186                                                 const char *string, size_t n)
187 { }
188 static inline void audit_log_untrustedstring(struct audit_buffer *ab,
189                                              const char *string)
190 { }
191 static inline void audit_log_d_path(struct audit_buffer *ab,
192                                     const char *prefix,
193                                     const struct path *path)
194 { }
195 static inline void audit_log_key(struct audit_buffer *ab, char *key)
196 { }
197 static inline void audit_log_link_denied(const char *string,
198                                          const struct path *link)
199 { }
200 static inline int audit_log_task_context(struct audit_buffer *ab)
201 {
202         return 0;
203 }
204 static inline void audit_log_task_info(struct audit_buffer *ab,
205                                        struct task_struct *tsk)
206 { }
207 #define audit_enabled 0
208 #endif /* CONFIG_AUDIT */
209
210 #ifdef CONFIG_AUDIT_COMPAT_GENERIC
211 #define audit_is_compat(arch)  (!((arch) & __AUDIT_ARCH_64BIT))
212 #else
213 #define audit_is_compat(arch)  false
214 #endif
215
216 #ifdef CONFIG_AUDITSYSCALL
217 #include <asm/syscall.h> /* for syscall_get_arch() */
218
219 /* These are defined in auditsc.c */
220                                 /* Public API */
221 extern int  audit_alloc(struct task_struct *task);
222 extern void __audit_free(struct task_struct *task);
223 extern void __audit_syscall_entry(int major, unsigned long a0, unsigned long a1,
224                                   unsigned long a2, unsigned long a3);
225 extern void __audit_syscall_exit(int ret_success, long ret_value);
226 extern struct filename *__audit_reusename(const __user char *uptr);
227 extern void __audit_getname(struct filename *name);
228
229 #define AUDIT_INODE_PARENT      1       /* dentry represents the parent */
230 #define AUDIT_INODE_HIDDEN      2       /* audit record should be hidden */
231 extern void __audit_inode(struct filename *name, const struct dentry *dentry,
232                                 unsigned int flags);
233 extern void __audit_file(const struct file *);
234 extern void __audit_inode_child(struct inode *parent,
235                                 const struct dentry *dentry,
236                                 const unsigned char type);
237 extern void __audit_seccomp(unsigned long syscall, long signr, int code);
238 extern void __audit_ptrace(struct task_struct *t);
239
240 static inline bool audit_dummy_context(void)
241 {
242         void *p = current->audit_context;
243         return !p || *(int *)p;
244 }
245 static inline void audit_free(struct task_struct *task)
246 {
247         if (unlikely(task->audit_context))
248                 __audit_free(task);
249 }
250 static inline void audit_syscall_entry(int major, unsigned long a0,
251                                        unsigned long a1, unsigned long a2,
252                                        unsigned long a3)
253 {
254         if (unlikely(current->audit_context))
255                 __audit_syscall_entry(major, a0, a1, a2, a3);
256 }
257 static inline void audit_syscall_exit(void *pt_regs)
258 {
259         if (unlikely(current->audit_context)) {
260                 int success = is_syscall_success(pt_regs);
261                 long return_code = regs_return_value(pt_regs);
262
263                 __audit_syscall_exit(success, return_code);
264         }
265 }
266 static inline struct filename *audit_reusename(const __user char *name)
267 {
268         if (unlikely(!audit_dummy_context()))
269                 return __audit_reusename(name);
270         return NULL;
271 }
272 static inline void audit_getname(struct filename *name)
273 {
274         if (unlikely(!audit_dummy_context()))
275                 __audit_getname(name);
276 }
277 static inline void audit_inode(struct filename *name,
278                                 const struct dentry *dentry,
279                                 unsigned int parent) {
280         if (unlikely(!audit_dummy_context())) {
281                 unsigned int flags = 0;
282                 if (parent)
283                         flags |= AUDIT_INODE_PARENT;
284                 __audit_inode(name, dentry, flags);
285         }
286 }
287 static inline void audit_file(struct file *file)
288 {
289         if (unlikely(!audit_dummy_context()))
290                 __audit_file(file);
291 }
292 static inline void audit_inode_parent_hidden(struct filename *name,
293                                                 const struct dentry *dentry)
294 {
295         if (unlikely(!audit_dummy_context()))
296                 __audit_inode(name, dentry,
297                                 AUDIT_INODE_PARENT | AUDIT_INODE_HIDDEN);
298 }
299 static inline void audit_inode_child(struct inode *parent,
300                                      const struct dentry *dentry,
301                                      const unsigned char type) {
302         if (unlikely(!audit_dummy_context()))
303                 __audit_inode_child(parent, dentry, type);
304 }
305 void audit_core_dumps(long signr);
306
307 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
308 {
309         if (!audit_enabled)
310                 return;
311
312         /* Force a record to be reported if a signal was delivered. */
313         if (signr || unlikely(!audit_dummy_context()))
314                 __audit_seccomp(syscall, signr, code);
315 }
316
317 static 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) */
324 extern unsigned int audit_serial(void);
325 extern int auditsc_get_stamp(struct audit_context *ctx,
326                               struct timespec64 *t, unsigned int *serial);
327 extern int audit_set_loginuid(kuid_t loginuid);
328
329 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
330 {
331         return tsk->loginuid;
332 }
333
334 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
335 {
336         return tsk->sessionid;
337 }
338
339 extern void __audit_ipc_obj(struct kern_ipc_perm *ipcp);
340 extern void __audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode);
341 extern void __audit_bprm(struct linux_binprm *bprm);
342 extern int __audit_socketcall(int nargs, unsigned long *args);
343 extern int __audit_sockaddr(int len, void *addr);
344 extern void __audit_fd_pair(int fd1, int fd2);
345 extern void __audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr);
346 extern void __audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec *abs_timeout);
347 extern void __audit_mq_notify(mqd_t mqdes, const struct sigevent *notification);
348 extern void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat);
349 extern int __audit_log_bprm_fcaps(struct linux_binprm *bprm,
350                                   const struct cred *new,
351                                   const struct cred *old);
352 extern void __audit_log_capset(const struct cred *new, const struct cred *old);
353 extern void __audit_mmap_fd(int fd, int flags);
354 extern void __audit_log_kern_module(char *name);
355
356 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
357 {
358         if (unlikely(!audit_dummy_context()))
359                 __audit_ipc_obj(ipcp);
360 }
361 static inline void audit_fd_pair(int fd1, int fd2)
362 {
363         if (unlikely(!audit_dummy_context()))
364                 __audit_fd_pair(fd1, fd2);
365 }
366 static 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 }
371 static inline void audit_bprm(struct linux_binprm *bprm)
372 {
373         if (unlikely(!audit_dummy_context()))
374                 __audit_bprm(bprm);
375 }
376 static 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
383 static 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
396 static 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 }
402 static 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 }
407 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec *abs_timeout)
408 {
409         if (unlikely(!audit_dummy_context()))
410                 __audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
411 }
412 static 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 }
417 static 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
423 static 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
432 static 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
439 static inline void audit_mmap_fd(int fd, int flags)
440 {
441         if (unlikely(!audit_dummy_context()))
442                 __audit_mmap_fd(fd, flags);
443 }
444
445 static inline void audit_log_kern_module(char *name)
446 {
447         if (!audit_dummy_context())
448                 __audit_log_kern_module(name);
449 }
450
451 extern int audit_n_rules;
452 extern int audit_signals;
453 #else /* CONFIG_AUDITSYSCALL */
454 static inline int audit_alloc(struct task_struct *task)
455 {
456         return 0;
457 }
458 static inline void audit_free(struct task_struct *task)
459 { }
460 static inline void audit_syscall_entry(int major, unsigned long a0,
461                                        unsigned long a1, unsigned long a2,
462                                        unsigned long a3)
463 { }
464 static inline void audit_syscall_exit(void *pt_regs)
465 { }
466 static inline bool audit_dummy_context(void)
467 {
468         return true;
469 }
470 static inline struct filename *audit_reusename(const __user char *name)
471 {
472         return NULL;
473 }
474 static inline void audit_getname(struct filename *name)
475 { }
476 static inline void __audit_inode(struct filename *name,
477                                         const struct dentry *dentry,
478                                         unsigned int flags)
479 { }
480 static inline void __audit_inode_child(struct inode *parent,
481                                         const struct dentry *dentry,
482                                         const unsigned char type)
483 { }
484 static inline void audit_inode(struct filename *name,
485                                 const struct dentry *dentry,
486                                 unsigned int parent)
487 { }
488 static inline void audit_file(struct file *file)
489 {
490 }
491 static inline void audit_inode_parent_hidden(struct filename *name,
492                                 const struct dentry *dentry)
493 { }
494 static inline void audit_inode_child(struct inode *parent,
495                                      const struct dentry *dentry,
496                                      const unsigned char type)
497 { }
498 static inline void audit_core_dumps(long signr)
499 { }
500 static inline void __audit_seccomp(unsigned long syscall, long signr, int code)
501 { }
502 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
503 { }
504 static inline int auditsc_get_stamp(struct audit_context *ctx,
505                               struct timespec64 *t, unsigned int *serial)
506 {
507         return 0;
508 }
509 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
510 {
511         return INVALID_UID;
512 }
513 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
514 {
515         return -1;
516 }
517 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
518 { }
519 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
520                                         gid_t gid, umode_t mode)
521 { }
522 static inline void audit_bprm(struct linux_binprm *bprm)
523 { }
524 static inline int audit_socketcall(int nargs, unsigned long *args)
525 {
526         return 0;
527 }
528
529 static inline int audit_socketcall_compat(int nargs, u32 *args)
530 {
531         return 0;
532 }
533
534 static inline void audit_fd_pair(int fd1, int fd2)
535 { }
536 static inline int audit_sockaddr(int len, void *addr)
537 {
538         return 0;
539 }
540 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
541 { }
542 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
543                                      unsigned int msg_prio,
544                                      const struct timespec *abs_timeout)
545 { }
546 static inline void audit_mq_notify(mqd_t mqdes,
547                                    const struct sigevent *notification)
548 { }
549 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
550 { }
551 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
552                                        const struct cred *new,
553                                        const struct cred *old)
554 {
555         return 0;
556 }
557 static inline void audit_log_capset(const struct cred *new,
558                                     const struct cred *old)
559 { }
560 static inline void audit_mmap_fd(int fd, int flags)
561 { }
562
563 static inline void audit_log_kern_module(char *name)
564 {
565 }
566
567 static inline void audit_ptrace(struct task_struct *t)
568 { }
569 #define audit_n_rules 0
570 #define audit_signals 0
571 #endif /* CONFIG_AUDITSYSCALL */
572
573 static inline bool audit_loginuid_set(struct task_struct *tsk)
574 {
575         return uid_valid(audit_get_loginuid(tsk));
576 }
577
578 static inline void audit_log_string(struct audit_buffer *ab, const char *buf)
579 {
580         audit_log_n_string(ab, buf, strlen(buf));
581 }
582
583 #endif