include/linux/audit.h

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