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