bsd/bsm/audit.h

   1 /*
   2  * @APPLE_LICENSE_HEADER_START@
   3  *
   4  * Copyright (c) 1999-2004 Apple Computer, Inc.  All Rights Reserved.
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef _BSM_AUDIT_H
  25 #define _BSM_AUDIT_H
  26
  27 #include <sys/queue.h>
  28 #include <sys/ucred.h>
  29 #include <sys/param.h>
  30 #include <sys/ipc.h>
  31 #include <sys/socket.h>
  32 #include <sys/cdefs.h>
  33
  34 #define AUDIT_RECORD_MAGIC      0x828a0f1b
  35 #define MAX_AUDIT_RECORDS       20
  36 #define MAX_AUDIT_RECORD_SIZE   4096
  37 #define MIN_AUDIT_FILE_SIZE     512 * 1024
  38
  39 /*
  40  * Triggers for the audit daemon
  41  */
  42 #define AUDIT_TRIGGER_LOW_SPACE 1
  43 #define AUDIT_TRIGGER_FILE_FULL 2
  44
  45 /*
  46  * Pre-defined audit IDs
  47  */
  48 #define AU_DEFAUDITID   -1
  49
  50 /*
  51  * Define the masks for the classes of audit events.
  52  */
  53 #define AU_NULL         0x00000000
  54 #define AU_FREAD        0x00000001
  55 #define AU_FWRITE       0x00000002
  56 #define AU_FACCESS      0x00000004
  57 #define AU_FMODIFY      0x00000008
  58 #define AU_FCREATE      0x00000010
  59 #define AU_FDELETE      0x00000020
  60 #define AU_CLOSE        0x00000040
  61 #define AU_PROCESS      0x00000080
  62 #define AU_NET          0x00000100
  63 #define AU_IPC          0x00000200
  64 #define AU_NONAT        0x00000400
  65 #define AU_ADMIN        0x00000800
  66 #define AU_LOGIN        0x00001000
  67 #define AU_TFM          0x00002000
  68 #define AU_APPL         0x00004000
  69 #define AU_SETL         0x00008000
  70 #define AU_IFLOAT       0x00010000
  71 #define AU_PRIV         0x00020000
  72 #define AU_MAC_RW       0x00040000
  73 #define AU_XCONN        0x00080000
  74 #define AU_XCREATE      0x00100000
  75 #define AU_XDELETE      0x00200000
  76 #define AU_XIFLOAT      0x00400000
  77 #define AU_XPRIVS       0x00800000
  78 #define AU_XPRIVF       0x01000000
  79 #define AU_XMOVE        0x02000000
  80 #define AU_XDACF        0x04000000
  81 #define AU_XMACF        0x08000000
  82 #define AU_XSECATTR     0x10000000
  83 #define AU_IOCTL        0x20000000
  84 #define AU_EXEC         0x40000000
  85 #define AU_OTHER        0x80000000
  86 #define AU_ALL          0xffffffff
  87
  88 /*
  89  * IPC types
  90  */
  91 #define AT_IPC_MSG      ((u_char)1) /* message IPC id */
  92 #define AT_IPC_SEM      ((u_char)2) /* semaphore IPC id */
  93 #define AT_IPC_SHM      ((u_char)3) /* shared mem IPC id */
  94
  95 /*
  96  * Audit conditions.
  97  */
  98 #define AUC_UNSET               0
  99 #define AUC_AUDITING            1
 100 #define AUC_NOAUDIT             2
 101 #define AUC_DISABLED            -1
 102
 103 /*
 104  * auditon(2) commands.
 105  */
 106 #define A_GETPOLICY     2
 107 #define A_SETPOLICY     3
 108 #define A_GETKMASK      4
 109 #define A_SETKMASK      5
 110 #define A_GETQCTRL      6
 111 #define A_SETQCTRL      7
 112 #define A_GETCWD        8
 113 #define A_GETCAR        9
 114 #define A_GETSTAT       12
 115 #define A_SETSTAT       13
 116 #define A_SETUMASK      14
 117 #define A_SETSMASK      15
 118 #define A_GETCOND       20
 119 #define A_SETCOND       21
 120 #define A_GETCLASS      22
 121 #define A_SETCLASS      23
 122 #define A_GETPINFO      24
 123 #define A_SETPMASK      25
 124 #define A_SETFSIZE      26
 125 #define A_GETFSIZE      27
 126 #define A_GETPINFO_ADDR 28
 127 #define A_GETKAUDIT     29
 128 #define A_SETKAUDIT     30
 129
 130 /*
 131  * Audit policy controls.
 132  */
 133 #define AUDIT_CNT       0x0001
 134 #define AUDIT_AHLT      0x0002
 135 #define AUDIT_ARGV      0x0004
 136 #define AUDIT_ARGE      0x0008
 137 #define AUDIT_PASSWD    0x0010
 138 #define AUDIT_SEQ       0x0020
 139 #define AUDIT_WINDATA   0x0040
 140 #define AUDIT_USER      0x0080
 141 #define AUDIT_GROUP     0x0100
 142 #define AUDIT_TRAIL     0x0200
 143 #define AUDIT_PATH      0x0400
 144
 145 /*
 146  * Audit queue control parameters
 147  */
 148 #define AQ_HIWATER      100
 149 #define AQ_MAXHIGH      10000
 150 #define AQ_LOWATER      10
 151 #define AQ_BUFSZ        1024
 152 #define AQ_MAXBUFSZ     1048576
 153
 154 #define AU_FS_MINFREE   20   /* default min filesystem freespace, in percent */
 155
 156 __BEGIN_DECLS
 157
 158 typedef uid_t au_id_t;
 159 typedef pid_t au_asid_t;
 160 typedef u_int16_t au_event_t;
 161 typedef u_int16_t au_emod_t;
 162 typedef u_int32_t au_class_t;
 163
 164 struct au_tid {
 165         dev_t port;
 166         u_int32_t machine;
 167 };
 168 typedef struct au_tid au_tid_t;
 169
 170 struct au_tid_addr {
 171         dev_t  at_port;
 172         u_int32_t at_type;
 173         u_int32_t at_addr[4];
 174 };
 175 typedef struct au_tid_addr au_tid_addr_t;
 176
 177 struct au_mask {
 178         unsigned int    am_success;     /* success bits */
 179         unsigned int    am_failure;     /* failure bits */
 180 };
 181 typedef struct au_mask au_mask_t;
 182
 183 struct auditinfo {
 184         au_id_t                 ai_auid;        /* Audit user ID */
 185         au_mask_t               ai_mask;        /* Audit masks */
 186         au_tid_t                ai_termid;      /* Terminal ID */
 187         au_asid_t               ai_asid;        /* Audit session ID */
 188 };
 189 typedef struct auditinfo auditinfo_t;
 190
 191 struct auditinfo_addr {
 192         au_id_t                 ai_auid;        /* Audit user ID */
 193         au_mask_t               ai_mask;        /* Audit masks */
 194         au_tid_addr_t           ai_termid;      /* Terminal ID */
 195         au_asid_t               ai_asid;        /* Audit session ID */
 196 };
 197 typedef struct auditinfo_addr auditinfo_addr_t;
 198
 199 struct auditpinfo {
 200         pid_t                   ap_pid;         /* ID of target process */
 201         au_id_t                 ap_auid;        /* Audit user ID */
 202         au_mask_t               ap_mask;        /* Audit masks */
 203         au_tid_t                ap_termid;      /* Terminal ID */
 204         au_asid_t               ap_asid;        /* Audit session ID */
 205 };
 206 typedef struct auditpinfo auditpinfo_t;
 207
 208 struct auditpinfo_addr {
 209         pid_t                   ap_pid;         /* ID of target process */
 210         au_id_t                 ap_auid;        /* Audit user ID */
 211         au_mask_t               ap_mask;        /* Audit masks */
 212         au_tid_addr_t           ap_termid;      /* Terminal ID */
 213         au_asid_t               ap_asid;        /* Audit session ID */
 214 };
 215 typedef struct auditpinfo_addr auditpinfo_addr_t;
 216
 217 /* Token and record structures */
 218
 219 struct au_token {
 220         u_char *t_data;
 221         size_t len;
 222         TAILQ_ENTRY(au_token) tokens;
 223 };
 224 typedef struct au_token token_t;
 225
 226 struct au_record {
 227         char used; /* Is this record currently being used */
 228         int desc; /* The descriptor associated with this record */
 229         TAILQ_HEAD(, au_token) token_q; /* queue of BSM tokens */
 230         u_char *data;
 231         size_t len;
 232         LIST_ENTRY(au_record) au_rec_q;
 233 };
 234 typedef struct au_record au_record_t;
 235
 236 /*
 237  * Kernel audit queue control parameters.
 238  */
 239 struct au_qctrl {
 240         size_t  aq_hiwater;
 241         size_t  aq_lowater;
 242         size_t  aq_bufsz;
 243         clock_t aq_delay;
 244         int     aq_minfree;     /* minimum filesystem percent free space */
 245 };
 246 typedef struct au_qctrl au_qctrl_t;
 247
 248 /*
 249  * Structure for the audit statistics.
 250  */
 251 struct audit_stat {
 252         unsigned int as_version;
 253         unsigned int as_numevent;
 254         int as_generated;
 255         int as_nonattring;
 256         int as_kernel;
 257         int as_audit;
 258         int as_auditctl;
 259         int as_enqueu;
 260         int as_written;
 261         int as_wblocked;
 262         int as_rblocked;
 263         int as_dropped;
 264         int as_totalsize;
 265         unsigned int as_memused;
 266 };
 267 typedef struct audit_stat au_stat_t;
 268
 269 /*
 270  * Structure for the audit file statistics.
 271  */
 272 struct audit_fstat {
 273         u_quad_t af_filesz;
 274         u_quad_t af_currsz;
 275 };
 276 typedef struct audit_fstat au_fstat_t;
 277
 278 /*
 279  * Audit to event class mapping.
 280  */
 281 struct au_evclass_map {
 282         au_event_t ec_number;
 283         au_class_t ec_class;
 284 };
 285 typedef struct au_evclass_map au_evclass_map_t;
 286
 287 #ifndef KERNEL
 288
 289 int audit (const void *, int);
 290 int auditon (int, void *, int);
 291 int auditctl (const char *);
 292 int getauid (au_id_t *);
 293 int setauid (const au_id_t *);
 294 int getaudit (struct auditinfo *);
 295 int setaudit (const struct auditinfo *);
 296 int getaudit_addr (struct auditinfo_addr *, int);
 297 int setaudit_addr (const struct auditinfo_addr *, int);
 298 #endif /* !KERNEL */
 299
 300 __END_DECLS
 301
 302 #endif /* !_BSM_AUDIT_H */