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