1/*- 2 * Copyright (c) 2005-2009 Apple Inc. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. Neither the name of Apple Inc. ("Apple") nor the names of 15 * its contributors may be used to endorse or promote products derived 16 * from this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY 19 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 21 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY 22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 * 29 * $P4: //depot/projects/trustedbsd/openbsm/sys/bsm/audit.h#10 $ 30 */ 31 32#ifndef _BSM_AUDIT_H 33#define _BSM_AUDIT_H 34 35#include <sys/param.h> 36#include <sys/types.h> 37 38#define AUDIT_RECORD_MAGIC 0x828a0f1b 39#define MAX_AUDIT_RECORDS 20 40#define MAXAUDITDATA (0x8000 - 1) 41#define MAX_AUDIT_RECORD_SIZE MAXAUDITDATA 42#define MIN_AUDIT_FILE_SIZE (512 * 1024) 43 44/* 45 * Minimum noumber of free blocks on the filesystem containing the audit 46 * log necessary to avoid a hard log rotation. DO NOT SET THIS VALUE TO 0 47 * as the kernel does an unsigned compare, plus we want to leave a few blocks 48 * free so userspace can terminate the log, etc. 49 */ 50#define AUDIT_HARD_LIMIT_FREE_BLOCKS 4 51 52/* 53 * Triggers for the audit daemon. 54 */ 55#define AUDIT_TRIGGER_MIN 1 56#define AUDIT_TRIGGER_LOW_SPACE 1 /* Below low watermark. */ 57#define AUDIT_TRIGGER_ROTATE_KERNEL 2 /* Kernel requests rotate. */ 58#define AUDIT_TRIGGER_READ_FILE 3 /* Re-read config file. */ 59#define AUDIT_TRIGGER_CLOSE_AND_DIE 4 /* Terminate audit. */ 60#define AUDIT_TRIGGER_NO_SPACE 5 /* Below min free space. */ 61#define AUDIT_TRIGGER_ROTATE_USER 6 /* User requests rotate. */ 62#define AUDIT_TRIGGER_INITIALIZE 7 /* User initialize of auditd. */ 63#define AUDIT_TRIGGER_EXPIRE_TRAILS 8 /* User expiration of trails. */ 64#define AUDIT_TRIGGER_MAX 8 65 66/* 67 * The special device filename (FreeBSD). 68 */ 69#define AUDITDEV_FILENAME "audit" 70#define AUDIT_TRIGGER_FILE ("/dev/" AUDITDEV_FILENAME) 71 72/* 73 * Pre-defined audit IDs 74 */ 75#define AU_DEFAUDITID (uid_t)(-1) 76#define AU_DEFAUDITSID 0 77#define AU_ASSIGN_ASID -1 78 79/* 80 * IPC types. 81 */ 82#define AT_IPC_MSG ((u_char)1) /* Message IPC id. */ 83#define AT_IPC_SEM ((u_char)2) /* Semaphore IPC id. */ 84#define AT_IPC_SHM ((u_char)3) /* Shared mem IPC id. */ 85 86/* 87 * Audit conditions. 88 */ 89#define AUC_UNSET 0 90#define AUC_AUDITING 1 91#define AUC_NOAUDIT 2 92#define AUC_DISABLED -1 93 94/* 95 * auditon(2) commands. 96 */ 97#define A_OLDGETPOLICY 2 98#define A_OLDSETPOLICY 3 99#define A_GETKMASK 4 100#define A_SETKMASK 5 101#define A_OLDGETQCTRL 6 102#define A_OLDSETQCTRL 7 103#define A_GETCWD 8 104#define A_GETCAR 9 105#define A_GETSTAT 12 106#define A_SETSTAT 13 107#define A_SETUMASK 14 108#define A_SETSMASK 15 109#define A_OLDGETCOND 20 110#define A_OLDSETCOND 21 111#define A_GETCLASS 22 112#define A_SETCLASS 23 113#define A_GETPINFO 24 114#define A_SETPMASK 25 115#define A_SETFSIZE 26 116#define A_GETFSIZE 27 117#define A_GETPINFO_ADDR 28 118#define A_GETKAUDIT 29 119#define A_SETKAUDIT 30 120#define A_SENDTRIGGER 31 121#define A_GETSINFO_ADDR 32 122#define A_GETPOLICY 33 123#define A_SETPOLICY 34 124#define A_GETQCTRL 35 125#define A_SETQCTRL 36 126#define A_GETCOND 37 127#define A_SETCOND 38 128#define A_GETSFLAGS 39 129#define A_SETSFLAGS 40 130 131/* 132 * Audit policy controls. 133 */ 134#define AUDIT_CNT 0x0001 135#define AUDIT_AHLT 0x0002 136#define AUDIT_ARGV 0x0004 137#define AUDIT_ARGE 0x0008 138#define AUDIT_SEQ 0x0010 139#define AUDIT_WINDATA 0x0020 140#define AUDIT_USER 0x0040 141#define AUDIT_GROUP 0x0080 142#define AUDIT_TRAIL 0x0100 143#define AUDIT_PATH 0x0200 144#define AUDIT_SCNT 0x0400 145#define AUDIT_PUBLIC 0x0800 146#define AUDIT_ZONENAME 0x1000 147#define AUDIT_PERZONE 0x2000 148 149/* 150 * Default audit queue control parameters. 151 */ 152#define AQ_HIWATER 100 153#define AQ_MAXHIGH 10000 154#define AQ_LOWATER 10 155#define AQ_BUFSZ MAXAUDITDATA 156#define AQ_MAXBUFSZ 1048576 157 158/* 159 * Default minimum percentage free space on file system. 160 */ 161#define AU_FS_MINFREE 20 162 163/* 164 * Type definitions used indicating the length of variable length addresses 165 * in tokens containing addresses, such as header fields. 166 */ 167#define AU_IPv4 4 168#define AU_IPv6 16 169 170__BEGIN_DECLS 171 172typedef uid_t au_id_t; 173typedef pid_t au_asid_t; 174typedef u_int16_t au_event_t; 175typedef u_int16_t au_emod_t; 176typedef u_int32_t au_class_t; 177typedef u_int64_t au_asflgs_t __attribute__ ((aligned (8))); 178 179struct au_tid { 180 dev_t port; 181 u_int32_t machine; 182}; 183typedef struct au_tid au_tid_t; 184 185struct au_tid_addr { 186 dev_t at_port; 187 u_int32_t at_type; 188 u_int32_t at_addr[4]; 189}; 190typedef struct au_tid_addr au_tid_addr_t; 191 192struct au_mask { 193 unsigned int am_success; /* Success bits. */ 194 unsigned int am_failure; /* Failure bits. */ 195}; 196typedef struct au_mask au_mask_t; 197 198struct auditinfo { 199 au_id_t ai_auid; /* Audit user ID. */ 200 au_mask_t ai_mask; /* Audit masks. */ 201 au_tid_t ai_termid; /* Terminal ID. */ 202 au_asid_t ai_asid; /* Audit session ID. */ 203}; 204typedef struct auditinfo auditinfo_t; 205 206struct auditinfo_addr { 207 au_id_t ai_auid; /* Audit user ID. */ 208 au_mask_t ai_mask; /* Audit masks. */ 209 au_tid_addr_t ai_termid; /* Terminal ID. */ 210 au_asid_t ai_asid; /* Audit session ID. */ 211 au_asflgs_t ai_flags; /* Audit session flags. */ 212}; 213typedef struct auditinfo_addr auditinfo_addr_t; 214 215struct auditpinfo { 216 pid_t ap_pid; /* ID of target process. */ 217 au_id_t ap_auid; /* Audit user ID. */ 218 au_mask_t ap_mask; /* Audit masks. */ 219 au_tid_t ap_termid; /* Terminal ID. */ 220 au_asid_t ap_asid; /* Audit session ID. */ 221}; 222typedef struct auditpinfo auditpinfo_t; 223 224struct auditpinfo_addr { 225 pid_t ap_pid; /* ID of target process. */ 226 au_id_t ap_auid; /* Audit user ID. */ 227 au_mask_t ap_mask; /* Audit masks. */ 228 au_tid_addr_t ap_termid; /* Terminal ID. */ 229 au_asid_t ap_asid; /* Audit session ID. */ 230 au_asflgs_t ap_flags; /* Audit session flags. */ 231}; 232typedef struct auditpinfo_addr auditpinfo_addr_t; 233 234struct au_session { 235 auditinfo_addr_t *as_aia_p; /* Ptr to full audit info. */ 236 au_mask_t as_mask; /* Process Audit Masks. */ 237}; 238typedef struct au_session au_session_t; 239 240/* 241 * Contents of token_t are opaque outside of libbsm. 242 */ 243typedef struct au_token token_t; 244 245/* 246 * Kernel audit queue control parameters: 247 * Default: Maximum: 248 * aq_hiwater: AQ_HIWATER (100) AQ_MAXHIGH (10000) 249 * aq_lowater: AQ_LOWATER (10) <aq_hiwater 250 * aq_bufsz: AQ_BUFSZ (32767) AQ_MAXBUFSZ (1048576) 251 * aq_delay: 20 20000 (not used) 252 */ 253struct au_qctrl { 254 int aq_hiwater; /* Max # of audit recs in queue when */ 255 /* threads with new ARs get blocked. */ 256 257 int aq_lowater; /* # of audit recs in queue when */ 258 /* blocked threads get unblocked. */ 259 260 int aq_bufsz; /* Max size of audit record for audit(2). */ 261 int aq_delay; /* Queue delay (not used). */ 262 int aq_minfree; /* Minimum filesystem percent free space. */ 263}; 264typedef struct au_qctrl au_qctrl_t; 265 266/* 267 * Structure for the audit statistics. 268 */ 269struct audit_stat { 270 unsigned int as_version; 271 unsigned int as_numevent; 272 int as_generated; 273 int as_nonattrib; 274 int as_kernel; 275 int as_audit; 276 int as_auditctl; 277 int as_enqueue; 278 int as_written; 279 int as_wblocked; 280 int as_rblocked; 281 int as_dropped; 282 int as_totalsize; 283 unsigned int as_memused; 284}; 285typedef struct audit_stat au_stat_t; 286 287/* 288 * Structure for the audit file statistics. 289 */ 290struct audit_fstat { 291 u_int64_t af_filesz; 292 u_int64_t af_currsz; 293}; 294typedef struct audit_fstat au_fstat_t; 295 296/* 297 * Audit to event class mapping. 298 */ 299struct au_evclass_map { 300 au_event_t ec_number; 301 au_class_t ec_class; 302}; 303typedef struct au_evclass_map au_evclass_map_t; 304 305/* 306 * Audit system calls. 307 */ 308#if !defined(_KERNEL) && !defined(KERNEL) 309int audit(const void *, int); 310int auditon(int, void *, int); 311int auditctl(const char *); 312int getauid(au_id_t *); 313int setauid(const au_id_t *); 314int getaudit_addr(struct auditinfo_addr *, int); 315int setaudit_addr(const struct auditinfo_addr *, int); 316 317#if defined(__APPLE__) 318#include <Availability.h> 319 320/* 321 * getaudit()/setaudit() are deprecated and have been replaced with 322 * wrappers to the getaudit_addr()/setaudit_addr() syscalls above. 323 */ 324 325int getaudit(struct auditinfo *) 326 __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, 327 __IPHONE_2_0, __IPHONE_6_0); 328int setaudit(const struct auditinfo *) 329 __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, 330 __IPHONE_2_0, __IPHONE_6_0); 331#else 332 333int getaudit(struct auditinfo *); 334int setaudit(const struct auditinfo *); 335#endif /* !__APPLE__ */ 336 337#ifdef __APPLE_API_PRIVATE 338#include <mach/port.h> 339mach_port_name_t audit_session_self(void); 340au_asid_t audit_session_join(mach_port_name_t port); 341int audit_session_port(au_asid_t asid, mach_port_name_t *portname); 342#endif /* __APPLE_API_PRIVATE */ 343 344#endif /* defined(_KERNEL) || defined(KERNEL) */ 345 346__END_DECLS 347 348#endif /* !_BSM_AUDIT_H */ 349