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