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
  24 #ifndef _LINUX_AUDIT_H_
  25 #define _LINUX_AUDIT_H_
  26
  27 #include <linux/sched.h>
  28 #include <linux/elf.h>
  29
  30 /* The netlink messages for the audit system is divided into blocks:
  31  * 1000 - 1099 are for commanding the audit system
  32  * 1100 - 1199 user space trusted application messages
  33  * 1200 - 1299 messages internal to the audit daemon
  34  * 1300 - 1399 audit event messages
  35  * 1400 - 1499 SE Linux use
  36  * 1500 - 1599 kernel LSPP events
  37  * 1600 - 1699 kernel crypto events
  38  * 1700 - 1799 kernel anomaly records
  39  * 1800 - 1999 future kernel use (maybe integrity labels and related events)
  40  * 2000 is for otherwise unclassified kernel audit messages (legacy)
  41  * 2001 - 2099 unused (kernel)
  42  * 2100 - 2199 user space anomaly records
  43  * 2200 - 2299 user space actions taken in response to anomalies
  44  * 2300 - 2399 user space generated LSPP events
  45  * 2400 - 2499 user space crypto events
  46  * 2500 - 2999 future user space (maybe integrity labels and related events)
  47  *
  48  * Messages from 1000-1199 are bi-directional. 1200-1299 & 2100 - 2999 are
  49  * exclusively user space. 1300-2099 is kernel --> user space
  50  * communication.
  51  */
  52 #define AUDIT_GET               1000    /* Get status */
  53 #define AUDIT_SET               1001    /* Set status (enable/disable/auditd) */
  54 #define AUDIT_LIST              1002    /* List syscall rules -- deprecated */
  55 #define AUDIT_ADD               1003    /* Add syscall rule -- deprecated */
  56 #define AUDIT_DEL               1004    /* Delete syscall rule -- deprecated */
  57 #define AUDIT_USER              1005    /* Message from userspace -- deprecated */
  58 #define AUDIT_LOGIN             1006    /* Define the login id and information */
  59 #define AUDIT_WATCH_INS         1007    /* Insert file/dir watch entry */
  60 #define AUDIT_WATCH_REM         1008    /* Remove file/dir watch entry */
  61 #define AUDIT_WATCH_LIST        1009    /* List all file/dir watches */
  62 #define AUDIT_SIGNAL_INFO       1010    /* Get info about sender of signal to auditd */
  63 #define AUDIT_ADD_RULE          1011    /* Add syscall filtering rule */
  64 #define AUDIT_DEL_RULE          1012    /* Delete syscall filtering rule */
  65 #define AUDIT_LIST_RULES        1013    /* List syscall filtering rules */
  66
  67 #define AUDIT_FIRST_USER_MSG    1100    /* Userspace messages mostly uninteresting to kernel */
  68 #define AUDIT_USER_AVC          1107    /* We filter this differently */
  69 #define AUDIT_LAST_USER_MSG     1199
  70 #define AUDIT_FIRST_USER_MSG2   2100    /* More user space messages */
  71 #define AUDIT_LAST_USER_MSG2    2999
  72
  73 #define AUDIT_DAEMON_START      1200    /* Daemon startup record */
  74 #define AUDIT_DAEMON_END        1201    /* Daemon normal stop record */
  75 #define AUDIT_DAEMON_ABORT      1202    /* Daemon error stop record */
  76 #define AUDIT_DAEMON_CONFIG     1203    /* Daemon config change */
  77
  78 #define AUDIT_SYSCALL           1300    /* Syscall event */
  79 #define AUDIT_FS_WATCH          1301    /* Filesystem watch event */
  80 #define AUDIT_PATH              1302    /* Filename path information */
  81 #define AUDIT_IPC               1303    /* IPC record */
  82 #define AUDIT_SOCKETCALL        1304    /* sys_socketcall arguments */
  83 #define AUDIT_CONFIG_CHANGE     1305    /* Audit system configuration change */
  84 #define AUDIT_SOCKADDR          1306    /* sockaddr copied as syscall arg */
  85 #define AUDIT_CWD               1307    /* Current working directory */
  86
  87 #define AUDIT_AVC               1400    /* SE Linux avc denial or grant */
  88 #define AUDIT_SELINUX_ERR       1401    /* Internal SE Linux Errors */
  89 #define AUDIT_AVC_PATH          1402    /* dentry, vfsmount pair from avc */
  90 #define AUDIT_MAC_POLICY_LOAD   1403    /* Policy file load */
  91 #define AUDIT_MAC_STATUS        1404    /* Changed enforcing,permissive,off */
  92 #define AUDIT_MAC_CONFIG_CHANGE 1405    /* Changes to booleans */
  93
  94 #define AUDIT_FIRST_KERN_ANOM_MSG   1700
  95 #define AUDIT_LAST_KERN_ANOM_MSG    1799
  96 #define AUDIT_ANOM_PROMISCUOUS      1700 /* Device changed promiscuous mode */
  97
  98 #define AUDIT_KERNEL            2000    /* Asynchronous audit record. NOT A REQUEST. */
  99
 100 /* Rule flags */
 101 #define AUDIT_FILTER_USER       0x00    /* Apply rule to user-generated messages */
 102 #define AUDIT_FILTER_TASK       0x01    /* Apply rule at task creation (not syscall) */
 103 #define AUDIT_FILTER_ENTRY      0x02    /* Apply rule at syscall entry */
 104 #define AUDIT_FILTER_WATCH      0x03    /* Apply rule to file system watches */
 105 #define AUDIT_FILTER_EXIT       0x04    /* Apply rule at syscall exit */
 106 #define AUDIT_FILTER_TYPE       0x05    /* Apply rule at audit_log_start */
 107
 108 #define AUDIT_NR_FILTERS        6
 109
 110 #define AUDIT_FILTER_PREPEND    0x10    /* Prepend to front of list */
 111
 112 /* Rule actions */
 113 #define AUDIT_NEVER    0        /* Do not build context if rule matches */
 114 #define AUDIT_POSSIBLE 1        /* Build context if rule matches  */
 115 #define AUDIT_ALWAYS   2        /* Generate audit record if rule matches */
 116
 117 /* Rule structure sizes -- if these change, different AUDIT_ADD and
 118  * AUDIT_LIST commands must be implemented. */
 119 #define AUDIT_MAX_FIELDS   64
 120 #define AUDIT_BITMASK_SIZE 64
 121 #define AUDIT_WORD(nr) ((__u32)((nr)/32))
 122 #define AUDIT_BIT(nr)  (1 << ((nr) - AUDIT_WORD(nr)*32))
 123
 124 /* This bitmask is used to validate user input.  It represents all bits that
 125  * are currently used in an audit field constant understood by the kernel.
 126  * If you are adding a new #define AUDIT_<whatever>, please ensure that
 127  * AUDIT_UNUSED_BITS is updated if need be. */
 128 #define AUDIT_UNUSED_BITS       0x0FFFFC00
 129
 130
 131 /* Rule fields */
 132                                 /* These are useful when checking the
 133                                  * task structure at task creation time
 134                                  * (AUDIT_PER_TASK).  */
 135 #define AUDIT_PID       0
 136 #define AUDIT_UID       1
 137 #define AUDIT_EUID      2
 138 #define AUDIT_SUID      3
 139 #define AUDIT_FSUID     4
 140 #define AUDIT_GID       5
 141 #define AUDIT_EGID      6
 142 #define AUDIT_SGID      7
 143 #define AUDIT_FSGID     8
 144 #define AUDIT_LOGINUID  9
 145 #define AUDIT_PERS      10
 146 #define AUDIT_ARCH      11
 147 #define AUDIT_MSGTYPE   12
 148
 149                                 /* These are ONLY useful when checking
 150                                  * at syscall exit time (AUDIT_AT_EXIT). */
 151 #define AUDIT_DEVMAJOR  100
 152 #define AUDIT_DEVMINOR  101
 153 #define AUDIT_INODE     102
 154 #define AUDIT_EXIT      103
 155 #define AUDIT_SUCCESS   104     /* exit >= 0; value ignored */
 156
 157 #define AUDIT_ARG0      200
 158 #define AUDIT_ARG1      (AUDIT_ARG0+1)
 159 #define AUDIT_ARG2      (AUDIT_ARG0+2)
 160 #define AUDIT_ARG3      (AUDIT_ARG0+3)
 161
 162 #define AUDIT_NEGATE                    0x80000000
 163
 164 /* These are the supported operators.
 165  *      4  2  1
 166  *      =  >  <
 167  *      -------
 168  *      0  0  0         0       nonsense
 169  *      0  0  1         1       <
 170  *      0  1  0         2       >
 171  *      0  1  1         3       !=
 172  *      1  0  0         4       =
 173  *      1  0  1         5       <=
 174  *      1  1  0         6       >=
 175  *      1  1  1         7       all operators
 176  */
 177 #define AUDIT_LESS_THAN                 0x10000000
 178 #define AUDIT_GREATER_THAN              0x20000000
 179 #define AUDIT_NOT_EQUAL                 0x30000000
 180 #define AUDIT_EQUAL                     0x40000000
 181 #define AUDIT_LESS_THAN_OR_EQUAL        (AUDIT_LESS_THAN|AUDIT_EQUAL)
 182 #define AUDIT_GREATER_THAN_OR_EQUAL     (AUDIT_GREATER_THAN|AUDIT_EQUAL)
 183 #define AUDIT_OPERATORS                 (AUDIT_EQUAL|AUDIT_NOT_EQUAL)
 184
 185 /* Status symbols */
 186                                 /* Mask values */
 187 #define AUDIT_STATUS_ENABLED            0x0001
 188 #define AUDIT_STATUS_FAILURE            0x0002
 189 #define AUDIT_STATUS_PID                0x0004
 190 #define AUDIT_STATUS_RATE_LIMIT         0x0008
 191 #define AUDIT_STATUS_BACKLOG_LIMIT      0x0010
 192                                 /* Failure-to-log actions */
 193 #define AUDIT_FAIL_SILENT       0
 194 #define AUDIT_FAIL_PRINTK       1
 195 #define AUDIT_FAIL_PANIC        2
 196
 197 /* distinguish syscall tables */
 198 #define __AUDIT_ARCH_64BIT 0x80000000
 199 #define __AUDIT_ARCH_LE    0x40000000
 200 #define AUDIT_ARCH_ALPHA        (EM_ALPHA|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
 201 #define AUDIT_ARCH_ARM          (EM_ARM|__AUDIT_ARCH_LE)
 202 #define AUDIT_ARCH_ARMEB        (EM_ARM)
 203 #define AUDIT_ARCH_CRIS         (EM_CRIS|__AUDIT_ARCH_LE)
 204 #define AUDIT_ARCH_FRV          (EM_FRV)
 205 #define AUDIT_ARCH_H8300        (EM_H8_300)
 206 #define AUDIT_ARCH_I386         (EM_386|__AUDIT_ARCH_LE)
 207 #define AUDIT_ARCH_IA64         (EM_IA_64|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
 208 #define AUDIT_ARCH_M32R         (EM_M32R)
 209 #define AUDIT_ARCH_M68K         (EM_68K)
 210 #define AUDIT_ARCH_MIPS         (EM_MIPS)
 211 #define AUDIT_ARCH_MIPSEL       (EM_MIPS|__AUDIT_ARCH_LE)
 212 #define AUDIT_ARCH_MIPS64       (EM_MIPS|__AUDIT_ARCH_64BIT)
 213 #define AUDIT_ARCH_MIPSEL64     (EM_MIPS|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
 214 #define AUDIT_ARCH_PARISC       (EM_PARISC)
 215 #define AUDIT_ARCH_PARISC64     (EM_PARISC|__AUDIT_ARCH_64BIT)
 216 #define AUDIT_ARCH_PPC          (EM_PPC)
 217 #define AUDIT_ARCH_PPC64        (EM_PPC64|__AUDIT_ARCH_64BIT)
 218 #define AUDIT_ARCH_S390         (EM_S390)
 219 #define AUDIT_ARCH_S390X        (EM_S390|__AUDIT_ARCH_64BIT)
 220 #define AUDIT_ARCH_SH           (EM_SH)
 221 #define AUDIT_ARCH_SHEL         (EM_SH|__AUDIT_ARCH_LE)
 222 #define AUDIT_ARCH_SH64         (EM_SH|__AUDIT_ARCH_64BIT)
 223 #define AUDIT_ARCH_SHEL64       (EM_SH|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
 224 #define AUDIT_ARCH_SPARC        (EM_SPARC)
 225 #define AUDIT_ARCH_SPARC64      (EM_SPARCV9|__AUDIT_ARCH_64BIT)
 226 #define AUDIT_ARCH_V850         (EM_V850|__AUDIT_ARCH_LE)
 227 #define AUDIT_ARCH_X86_64       (EM_X86_64|__AUDIT_ARCH_64BIT|__AUDIT_ARCH_LE)
 228
 229 struct audit_status {
 230         __u32           mask;           /* Bit mask for valid entries */
 231         __u32           enabled;        /* 1 = enabled, 0 = disabled */
 232         __u32           failure;        /* Failure-to-log action */
 233         __u32           pid;            /* pid of auditd process */
 234         __u32           rate_limit;     /* messages rate limit (per second) */
 235         __u32           backlog_limit;  /* waiting messages limit */
 236         __u32           lost;           /* messages lost */
 237         __u32           backlog;        /* messages waiting in queue */
 238 };
 239
 240 /* audit_rule_data supports filter rules with both integer and string
 241  * fields.  It corresponds with AUDIT_ADD_RULE, AUDIT_DEL_RULE and
 242  * AUDIT_LIST_RULES requests.
 243  */
 244 struct audit_rule_data {
 245         __u32           flags;  /* AUDIT_PER_{TASK,CALL}, AUDIT_PREPEND */
 246         __u32           action; /* AUDIT_NEVER, AUDIT_POSSIBLE, AUDIT_ALWAYS */
 247         __u32           field_count;
 248         __u32           mask[AUDIT_BITMASK_SIZE]; /* syscall(s) affected */
 249         __u32           fields[AUDIT_MAX_FIELDS];
 250         __u32           values[AUDIT_MAX_FIELDS];
 251         __u32           fieldflags[AUDIT_MAX_FIELDS];
 252         __u32           buflen; /* total length of string fields */
 253         char            buf[0]; /* string fields buffer */
 254 };
 255
 256 /* audit_rule is supported to maintain backward compatibility with
 257  * userspace.  It supports integer fields only and corresponds to
 258  * AUDIT_ADD, AUDIT_DEL and AUDIT_LIST requests.
 259  */
 260 struct audit_rule {             /* for AUDIT_LIST, AUDIT_ADD, and AUDIT_DEL */
 261         __u32           flags;  /* AUDIT_PER_{TASK,CALL}, AUDIT_PREPEND */
 262         __u32           action; /* AUDIT_NEVER, AUDIT_POSSIBLE, AUDIT_ALWAYS */
 263         __u32           field_count;
 264         __u32           mask[AUDIT_BITMASK_SIZE];
 265         __u32           fields[AUDIT_MAX_FIELDS];
 266         __u32           values[AUDIT_MAX_FIELDS];
 267 };
 268
 269 #ifdef __KERNEL__
 270
 271 struct audit_sig_info {
 272         uid_t           uid;
 273         pid_t           pid;
 274 };
 275
 276 struct audit_buffer;
 277 struct audit_context;
 278 struct inode;
 279 struct netlink_skb_parms;
 280
 281 #define AUDITSC_INVALID 0
 282 #define AUDITSC_SUCCESS 1
 283 #define AUDITSC_FAILURE 2
 284 #define AUDITSC_RESULT(x) ( ((long)(x))<0?AUDITSC_FAILURE:AUDITSC_SUCCESS )
 285 #ifdef CONFIG_AUDITSYSCALL
 286 /* These are defined in auditsc.c */
 287                                 /* Public API */
 288 extern int  audit_alloc(struct task_struct *task);
 289 extern void audit_free(struct task_struct *task);
 290 extern void audit_syscall_entry(struct task_struct *task, int arch,
 291                                 int major, unsigned long a0, unsigned long a1,
 292                                 unsigned long a2, unsigned long a3);
 293 extern void audit_syscall_exit(struct task_struct *task, int failed, long return_code);
 294 extern void audit_getname(const char *name);
 295 extern void audit_putname(const char *name);
 296 extern void __audit_inode(const char *name, const struct inode *inode, unsigned flags);
 297 extern void __audit_inode_child(const char *dname, const struct inode *inode,
 298                                 unsigned long pino);
 299 static inline void audit_inode(const char *name, const struct inode *inode,
 300                                unsigned flags) {
 301         if (unlikely(current->audit_context))
 302                 __audit_inode(name, inode, flags);
 303 }
 304 static inline void audit_inode_child(const char *dname,
 305                                      const struct inode *inode,
 306                                      unsigned long pino) {
 307         if (unlikely(current->audit_context))
 308                 __audit_inode_child(dname, inode, pino);
 309 }
 310
 311                                 /* Private API (for audit.c only) */
 312 extern unsigned int audit_serial(void);
 313 extern void auditsc_get_stamp(struct audit_context *ctx,
 314                               struct timespec *t, unsigned int *serial);
 315 extern int  audit_set_loginuid(struct task_struct *task, uid_t loginuid);
 316 extern uid_t audit_get_loginuid(struct audit_context *ctx);
 317 extern int audit_ipc_perms(unsigned long qbytes, uid_t uid, gid_t gid, mode_t mode, struct kern_ipc_perm *ipcp);
 318 extern int audit_socketcall(int nargs, unsigned long *args);
 319 extern int audit_sockaddr(int len, void *addr);
 320 extern int audit_avc_path(struct dentry *dentry, struct vfsmount *mnt);
 321 extern void audit_signal_info(int sig, struct task_struct *t);
 322 extern int audit_set_macxattr(const char *name);
 323 #else
 324 #define audit_alloc(t) ({ 0; })
 325 #define audit_free(t) do { ; } while (0)
 326 #define audit_syscall_entry(t,ta,a,b,c,d,e) do { ; } while (0)
 327 #define audit_syscall_exit(t,f,r) do { ; } while (0)
 328 #define audit_getname(n) do { ; } while (0)
 329 #define audit_putname(n) do { ; } while (0)
 330 #define __audit_inode(n,i,f) do { ; } while (0)
 331 #define __audit_inode_child(d,i,p) do { ; } while (0)
 332 #define audit_inode(n,i,f) do { ; } while (0)
 333 #define audit_inode_child(d,i,p) do { ; } while (0)
 334 #define auditsc_get_stamp(c,t,s) do { BUG(); } while (0)
 335 #define audit_get_loginuid(c) ({ -1; })
 336 #define audit_ipc_perms(q,u,g,m,i) ({ 0; })
 337 #define audit_socketcall(n,a) ({ 0; })
 338 #define audit_sockaddr(len, addr) ({ 0; })
 339 #define audit_avc_path(dentry, mnt) ({ 0; })
 340 #define audit_signal_info(s,t) do { ; } while (0)
 341 #define audit_set_macxattr(n) do { ; } while (0)
 342 #endif
 343
 344 #ifdef CONFIG_AUDIT
 345 /* These are defined in audit.c */
 346                                 /* Public API */
 347 extern void                 audit_log(struct audit_context *ctx, gfp_t gfp_mask,
 348                                       int type, const char *fmt, ...)
 349                                       __attribute__((format(printf,4,5)));
 350
 351 extern struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask, int type);
 352 extern void                 audit_log_format(struct audit_buffer *ab,
 353                                              const char *fmt, ...)
 354                             __attribute__((format(printf,2,3)));
 355 extern void                 audit_log_end(struct audit_buffer *ab);
 356 extern void                 audit_log_hex(struct audit_buffer *ab,
 357                                           const unsigned char *buf,
 358                                           size_t len);
 359 extern void                 audit_log_untrustedstring(struct audit_buffer *ab,
 360                                                       const char *string);
 361 extern void                 audit_log_d_path(struct audit_buffer *ab,
 362                                              const char *prefix,
 363                                              struct dentry *dentry,
 364                                              struct vfsmount *vfsmnt);
 365                                 /* Private API (for audit.c only) */
 366 extern int audit_filter_user(struct netlink_skb_parms *cb, int type);
 367 extern int audit_filter_type(int type);
 368 extern int  audit_receive_filter(int type, int pid, int uid, int seq,
 369                                  void *data, size_t datasz, uid_t loginuid);
 370 #else
 371 #define audit_log(c,g,t,f,...) do { ; } while (0)
 372 #define audit_log_start(c,g,t) ({ NULL; })
 373 #define audit_log_vformat(b,f,a) do { ; } while (0)
 374 #define audit_log_format(b,f,...) do { ; } while (0)
 375 #define audit_log_end(b) do { ; } while (0)
 376 #define audit_log_hex(a,b,l) do { ; } while (0)
 377 #define audit_log_untrustedstring(a,s) do { ; } while (0)
 378 #define audit_log_d_path(b,p,d,v) do { ; } while (0)
 379 #define audit_panic(m) do { ; } while (0)
 380 #endif
 381 #endif
 382 #endif