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