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 struct audit_sig_info {
  31         uid_t           uid;
  32         pid_t           pid;
  33         char            ctx[0];
  34 };
  35
  36 struct audit_buffer;
  37 struct audit_context;
  38 struct inode;
  39 struct netlink_skb_parms;
  40 struct path;
  41 struct linux_binprm;
  42 struct mq_attr;
  43 struct mqstat;
  44 struct audit_watch;
  45 struct audit_tree;
  46 struct sk_buff;
  47
  48 struct audit_krule {
  49         int                     vers_ops;
  50         u32                     flags;
  51         u32                     listnr;
  52         u32                     action;
  53         u32                     mask[AUDIT_BITMASK_SIZE];
  54         u32                     buflen; /* for data alloc on list rules */
  55         u32                     field_count;
  56         char                    *filterkey; /* ties events to rules */
  57         struct audit_field      *fields;
  58         struct audit_field      *arch_f; /* quick access to arch field */
  59         struct audit_field      *inode_f; /* quick access to an inode field */
  60         struct audit_watch      *watch; /* associated watch */
  61         struct audit_tree       *tree;  /* associated watched tree */
  62         struct list_head        rlist;  /* entry in audit_{watch,tree}.rules list */
  63         struct list_head        list;   /* for AUDIT_LIST* purposes only */
  64         u64                     prio;
  65 };
  66
  67 struct audit_field {
  68         u32                             type;
  69         u32                             val;
  70         kuid_t                          uid;
  71         kgid_t                          gid;
  72         u32                             op;
  73         char                            *lsm_str;
  74         void                            *lsm_rule;
  75 };
  76
  77 extern int is_audit_feature_set(int which);
  78
  79 extern int __init audit_register_class(int class, unsigned *list);
  80 extern int audit_classify_syscall(int abi, unsigned syscall);
  81 extern int audit_classify_arch(int arch);
  82 /* only for compat system calls */
  83 extern unsigned compat_write_class[];
  84 extern unsigned compat_read_class[];
  85 extern unsigned compat_dir_class[];
  86 extern unsigned compat_chattr_class[];
  87 extern unsigned compat_signal_class[];
  88
  89 extern int __weak audit_classify_compat_syscall(int abi, unsigned syscall);
  90
  91 /* audit_names->type values */
  92 #define AUDIT_TYPE_UNKNOWN      0       /* we don't know yet */
  93 #define AUDIT_TYPE_NORMAL       1       /* a "normal" audit record */
  94 #define AUDIT_TYPE_PARENT       2       /* a parent audit record */
  95 #define AUDIT_TYPE_CHILD_DELETE 3       /* a child being deleted */
  96 #define AUDIT_TYPE_CHILD_CREATE 4       /* a child being created */
  97
  98 /* maximized args number that audit_socketcall can process */
  99 #define AUDITSC_ARGS            6
 100
 101 struct filename;
 102
 103 extern void audit_log_session_info(struct audit_buffer *ab);
 104
 105 #ifdef CONFIG_AUDIT_COMPAT_GENERIC
 106 #define audit_is_compat(arch)  (!((arch) & __AUDIT_ARCH_64BIT))
 107 #else
 108 #define audit_is_compat(arch)  false
 109 #endif
 110
 111 #ifdef CONFIG_AUDITSYSCALL
 112 #include <asm/syscall.h> /* for syscall_get_arch() */
 113
 114 /* These are defined in auditsc.c */
 115                                 /* Public API */
 116 extern int  audit_alloc(struct task_struct *task);
 117 extern void __audit_free(struct task_struct *task);
 118 extern void __audit_syscall_entry(int arch,
 119                                   int major, unsigned long a0, unsigned long a1,
 120                                   unsigned long a2, unsigned long a3);
 121 extern void __audit_syscall_exit(int ret_success, long ret_value);
 122 extern struct filename *__audit_reusename(const __user char *uptr);
 123 extern void __audit_getname(struct filename *name);
 124 extern void audit_putname(struct filename *name);
 125
 126 #define AUDIT_INODE_PARENT      1       /* dentry represents the parent */
 127 #define AUDIT_INODE_HIDDEN      2       /* audit record should be hidden */
 128 extern void __audit_inode(struct filename *name, const struct dentry *dentry,
 129                                 unsigned int flags);
 130 extern void __audit_inode_child(const struct inode *parent,
 131                                 const struct dentry *dentry,
 132                                 const unsigned char type);
 133 extern void __audit_seccomp(unsigned long syscall, long signr, int code);
 134 extern void __audit_ptrace(struct task_struct *t);
 135
 136 static inline int audit_dummy_context(void)
 137 {
 138         void *p = current->audit_context;
 139         return !p || *(int *)p;
 140 }
 141 static inline void audit_free(struct task_struct *task)
 142 {
 143         if (unlikely(task->audit_context))
 144                 __audit_free(task);
 145 }
 146 static inline void audit_syscall_entry(int major, unsigned long a0,
 147                                        unsigned long a1, unsigned long a2,
 148                                        unsigned long a3)
 149 {
 150         if (unlikely(current->audit_context))
 151                 __audit_syscall_entry(syscall_get_arch(), major, a0, a1, a2, a3);
 152 }
 153 static inline void audit_syscall_exit(void *pt_regs)
 154 {
 155         if (unlikely(current->audit_context)) {
 156                 int success = is_syscall_success(pt_regs);
 157                 long return_code = regs_return_value(pt_regs);
 158
 159                 __audit_syscall_exit(success, return_code);
 160         }
 161 }
 162 static inline struct filename *audit_reusename(const __user char *name)
 163 {
 164         if (unlikely(!audit_dummy_context()))
 165                 return __audit_reusename(name);
 166         return NULL;
 167 }
 168 static inline void audit_getname(struct filename *name)
 169 {
 170         if (unlikely(!audit_dummy_context()))
 171                 __audit_getname(name);
 172 }
 173 static inline void audit_inode(struct filename *name,
 174                                 const struct dentry *dentry,
 175                                 unsigned int parent) {
 176         if (unlikely(!audit_dummy_context())) {
 177                 unsigned int flags = 0;
 178                 if (parent)
 179                         flags |= AUDIT_INODE_PARENT;
 180                 __audit_inode(name, dentry, flags);
 181         }
 182 }
 183 static inline void audit_inode_parent_hidden(struct filename *name,
 184                                                 const struct dentry *dentry)
 185 {
 186         if (unlikely(!audit_dummy_context()))
 187                 __audit_inode(name, dentry,
 188                                 AUDIT_INODE_PARENT | AUDIT_INODE_HIDDEN);
 189 }
 190 static inline void audit_inode_child(const struct inode *parent,
 191                                      const struct dentry *dentry,
 192                                      const unsigned char type) {
 193         if (unlikely(!audit_dummy_context()))
 194                 __audit_inode_child(parent, dentry, type);
 195 }
 196 void audit_core_dumps(long signr);
 197
 198 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
 199 {
 200         /* Force a record to be reported if a signal was delivered. */
 201         if (signr || unlikely(!audit_dummy_context()))
 202                 __audit_seccomp(syscall, signr, code);
 203 }
 204
 205 static inline void audit_ptrace(struct task_struct *t)
 206 {
 207         if (unlikely(!audit_dummy_context()))
 208                 __audit_ptrace(t);
 209 }
 210
 211                                 /* Private API (for audit.c only) */
 212 extern unsigned int audit_serial(void);
 213 extern int auditsc_get_stamp(struct audit_context *ctx,
 214                               struct timespec *t, unsigned int *serial);
 215 extern int audit_set_loginuid(kuid_t loginuid);
 216
 217 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
 218 {
 219         return tsk->loginuid;
 220 }
 221
 222 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
 223 {
 224         return tsk->sessionid;
 225 }
 226
 227 extern void __audit_ipc_obj(struct kern_ipc_perm *ipcp);
 228 extern void __audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode);
 229 extern void __audit_bprm(struct linux_binprm *bprm);
 230 extern int __audit_socketcall(int nargs, unsigned long *args);
 231 extern int __audit_sockaddr(int len, void *addr);
 232 extern void __audit_fd_pair(int fd1, int fd2);
 233 extern void __audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr);
 234 extern void __audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec *abs_timeout);
 235 extern void __audit_mq_notify(mqd_t mqdes, const struct sigevent *notification);
 236 extern void __audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat);
 237 extern int __audit_log_bprm_fcaps(struct linux_binprm *bprm,
 238                                   const struct cred *new,
 239                                   const struct cred *old);
 240 extern void __audit_log_capset(const struct cred *new, const struct cred *old);
 241 extern void __audit_mmap_fd(int fd, int flags);
 242
 243 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
 244 {
 245         if (unlikely(!audit_dummy_context()))
 246                 __audit_ipc_obj(ipcp);
 247 }
 248 static inline void audit_fd_pair(int fd1, int fd2)
 249 {
 250         if (unlikely(!audit_dummy_context()))
 251                 __audit_fd_pair(fd1, fd2);
 252 }
 253 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid, gid_t gid, umode_t mode)
 254 {
 255         if (unlikely(!audit_dummy_context()))
 256                 __audit_ipc_set_perm(qbytes, uid, gid, mode);
 257 }
 258 static inline void audit_bprm(struct linux_binprm *bprm)
 259 {
 260         if (unlikely(!audit_dummy_context()))
 261                 __audit_bprm(bprm);
 262 }
 263 static inline int audit_socketcall(int nargs, unsigned long *args)
 264 {
 265         if (unlikely(!audit_dummy_context()))
 266                 return __audit_socketcall(nargs, args);
 267         return 0;
 268 }
 269 static inline int audit_sockaddr(int len, void *addr)
 270 {
 271         if (unlikely(!audit_dummy_context()))
 272                 return __audit_sockaddr(len, addr);
 273         return 0;
 274 }
 275 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
 276 {
 277         if (unlikely(!audit_dummy_context()))
 278                 __audit_mq_open(oflag, mode, attr);
 279 }
 280 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len, unsigned int msg_prio, const struct timespec *abs_timeout)
 281 {
 282         if (unlikely(!audit_dummy_context()))
 283                 __audit_mq_sendrecv(mqdes, msg_len, msg_prio, abs_timeout);
 284 }
 285 static inline void audit_mq_notify(mqd_t mqdes, const struct sigevent *notification)
 286 {
 287         if (unlikely(!audit_dummy_context()))
 288                 __audit_mq_notify(mqdes, notification);
 289 }
 290 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
 291 {
 292         if (unlikely(!audit_dummy_context()))
 293                 __audit_mq_getsetattr(mqdes, mqstat);
 294 }
 295
 296 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
 297                                        const struct cred *new,
 298                                        const struct cred *old)
 299 {
 300         if (unlikely(!audit_dummy_context()))
 301                 return __audit_log_bprm_fcaps(bprm, new, old);
 302         return 0;
 303 }
 304
 305 static inline void audit_log_capset(const struct cred *new,
 306                                    const struct cred *old)
 307 {
 308         if (unlikely(!audit_dummy_context()))
 309                 __audit_log_capset(new, old);
 310 }
 311
 312 static inline void audit_mmap_fd(int fd, int flags)
 313 {
 314         if (unlikely(!audit_dummy_context()))
 315                 __audit_mmap_fd(fd, flags);
 316 }
 317
 318 extern int audit_n_rules;
 319 extern int audit_signals;
 320 #else /* CONFIG_AUDITSYSCALL */
 321 static inline int audit_alloc(struct task_struct *task)
 322 {
 323         return 0;
 324 }
 325 static inline void audit_free(struct task_struct *task)
 326 { }
 327 static inline void audit_syscall_entry(int major, unsigned long a0,
 328                                        unsigned long a1, unsigned long a2,
 329                                        unsigned long a3)
 330 { }
 331 static inline void audit_syscall_exit(void *pt_regs)
 332 { }
 333 static inline int audit_dummy_context(void)
 334 {
 335         return 1;
 336 }
 337 static inline struct filename *audit_reusename(const __user char *name)
 338 {
 339         return NULL;
 340 }
 341 static inline void audit_getname(struct filename *name)
 342 { }
 343 static inline void audit_putname(struct filename *name)
 344 { }
 345 static inline void __audit_inode(struct filename *name,
 346                                         const struct dentry *dentry,
 347                                         unsigned int flags)
 348 { }
 349 static inline void __audit_inode_child(const struct inode *parent,
 350                                         const struct dentry *dentry,
 351                                         const unsigned char type)
 352 { }
 353 static inline void audit_inode(struct filename *name,
 354                                 const struct dentry *dentry,
 355                                 unsigned int parent)
 356 { }
 357 static inline void audit_inode_parent_hidden(struct filename *name,
 358                                 const struct dentry *dentry)
 359 { }
 360 static inline void audit_inode_child(const struct inode *parent,
 361                                      const struct dentry *dentry,
 362                                      const unsigned char type)
 363 { }
 364 static inline void audit_core_dumps(long signr)
 365 { }
 366 static inline void __audit_seccomp(unsigned long syscall, long signr, int code)
 367 { }
 368 static inline void audit_seccomp(unsigned long syscall, long signr, int code)
 369 { }
 370 static inline int auditsc_get_stamp(struct audit_context *ctx,
 371                               struct timespec *t, unsigned int *serial)
 372 {
 373         return 0;
 374 }
 375 static inline kuid_t audit_get_loginuid(struct task_struct *tsk)
 376 {
 377         return INVALID_UID;
 378 }
 379 static inline unsigned int audit_get_sessionid(struct task_struct *tsk)
 380 {
 381         return -1;
 382 }
 383 static inline void audit_ipc_obj(struct kern_ipc_perm *ipcp)
 384 { }
 385 static inline void audit_ipc_set_perm(unsigned long qbytes, uid_t uid,
 386                                         gid_t gid, umode_t mode)
 387 { }
 388 static inline void audit_bprm(struct linux_binprm *bprm)
 389 { }
 390 static inline int audit_socketcall(int nargs, unsigned long *args)
 391 {
 392         return 0;
 393 }
 394 static inline void audit_fd_pair(int fd1, int fd2)
 395 { }
 396 static inline int audit_sockaddr(int len, void *addr)
 397 {
 398         return 0;
 399 }
 400 static inline void audit_mq_open(int oflag, umode_t mode, struct mq_attr *attr)
 401 { }
 402 static inline void audit_mq_sendrecv(mqd_t mqdes, size_t msg_len,
 403                                      unsigned int msg_prio,
 404                                      const struct timespec *abs_timeout)
 405 { }
 406 static inline void audit_mq_notify(mqd_t mqdes,
 407                                    const struct sigevent *notification)
 408 { }
 409 static inline void audit_mq_getsetattr(mqd_t mqdes, struct mq_attr *mqstat)
 410 { }
 411 static inline int audit_log_bprm_fcaps(struct linux_binprm *bprm,
 412                                        const struct cred *new,
 413                                        const struct cred *old)
 414 {
 415         return 0;
 416 }
 417 static inline void audit_log_capset(const struct cred *new,
 418                                     const struct cred *old)
 419 { }
 420 static inline void audit_mmap_fd(int fd, int flags)
 421 { }
 422 static inline void audit_ptrace(struct task_struct *t)
 423 { }
 424 #define audit_n_rules 0
 425 #define audit_signals 0
 426 #endif /* CONFIG_AUDITSYSCALL */
 427
 428 static inline bool audit_loginuid_set(struct task_struct *tsk)
 429 {
 430         return uid_valid(audit_get_loginuid(tsk));
 431 }
 432
 433 #ifdef CONFIG_AUDIT
 434 /* These are defined in audit.c */
 435                                 /* Public API */
 436 extern __printf(4, 5)
 437 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
 438                const char *fmt, ...);
 439
 440 extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
 441 extern __printf(2, 3)
 442 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...);
 443 extern void                 audit_log_end(struct audit_buffer *ab);
 444 extern int                  audit_string_contains_control(const char *string,
 445                                                           size_t len);
 446 extern void                 audit_log_n_hex(struct audit_buffer *ab,
 447                                           const unsigned char *buf,
 448                                           size_t len);
 449 extern void                 audit_log_n_string(struct audit_buffer *ab,
 450                                                const char *buf,
 451                                                size_t n);
 452 extern void                 audit_log_n_untrustedstring(struct audit_buffer *ab,
 453                                                         const char *string,
 454                                                         size_t n);
 455 extern void                 audit_log_untrustedstring(struct audit_buffer *ab,
 456                                                       const char *string);
 457 extern void                 audit_log_d_path(struct audit_buffer *ab,
 458                                              const char *prefix,
 459                                              const struct path *path);
 460 extern void                 audit_log_key(struct audit_buffer *ab,
 461                                           char *key);
 462 extern void                 audit_log_link_denied(const char *operation,
 463                                                   struct path *link);
 464 extern void                 audit_log_lost(const char *message);
 465 #ifdef CONFIG_SECURITY
 466 extern void                 audit_log_secctx(struct audit_buffer *ab, u32 secid);
 467 #else
 468 static inline void          audit_log_secctx(struct audit_buffer *ab, u32 secid)
 469 { }
 470 #endif
 471
 472 extern int audit_log_task_context(struct audit_buffer *ab);
 473 extern void audit_log_task_info(struct audit_buffer *ab,
 474                                 struct task_struct *tsk);
 475
 476 extern int                  audit_update_lsm_rules(void);
 477
 478                                 /* Private API (for audit.c only) */
 479 extern int audit_filter_user(int type);
 480 extern int audit_filter_type(int type);
 481 extern int audit_rule_change(int type, __u32 portid, int seq,
 482                                 void *data, size_t datasz);
 483 extern int audit_list_rules_send(struct sk_buff *request_skb, int seq);
 484
 485 extern u32 audit_enabled;
 486 #else /* CONFIG_AUDIT */
 487 static inline __printf(4, 5)
 488 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
 489                const char *fmt, ...)
 490 { }
 491 static inline struct audit_buffer *audit_log_start(struct audit_context *ctx,
 492                                                    gfp_t gfp_mask, int type)
 493 {
 494         return NULL;
 495 }
 496 static inline __printf(2, 3)
 497 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
 498 { }
 499 static inline void audit_log_end(struct audit_buffer *ab)
 500 { }
 501 static inline void audit_log_n_hex(struct audit_buffer *ab,
 502                                    const unsigned char *buf, size_t len)
 503 { }
 504 static inline void audit_log_n_string(struct audit_buffer *ab,
 505                                       const char *buf, size_t n)
 506 { }
 507 static inline void  audit_log_n_untrustedstring(struct audit_buffer *ab,
 508                                                 const char *string, size_t n)
 509 { }
 510 static inline void audit_log_untrustedstring(struct audit_buffer *ab,
 511                                              const char *string)
 512 { }
 513 static inline void audit_log_d_path(struct audit_buffer *ab,
 514                                     const char *prefix,
 515                                     const struct path *path)
 516 { }
 517 static inline void audit_log_key(struct audit_buffer *ab, char *key)
 518 { }
 519 static inline void audit_log_link_denied(const char *string,
 520                                          const struct path *link)
 521 { }
 522 static inline void audit_log_secctx(struct audit_buffer *ab, u32 secid)
 523 { }
 524 static inline int audit_log_task_context(struct audit_buffer *ab)
 525 {
 526         return 0;
 527 }
 528 static inline void audit_log_task_info(struct audit_buffer *ab,
 529                                        struct task_struct *tsk)
 530 { }
 531 #define audit_enabled 0
 532 #endif /* CONFIG_AUDIT */
 533 static inline void audit_log_string(struct audit_buffer *ab, const char *buf)
 534 {
 535         audit_log_n_string(ab, buf, strlen(buf));
 536 }
 537
 538 #endif