audit_record.h revision 293161
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 30#ifndef _BSM_AUDIT_RECORD_H_ 31#define _BSM_AUDIT_RECORD_H_ 32 33#include <sys/time.h> /* struct timeval */ 34 35/* 36 * Token type identifiers. 37 */ 38#define AUT_INVALID 0x00 39#define AUT_OTHER_FILE32 0x11 40#define AUT_OHEADER 0x12 41#define AUT_TRAILER 0x13 42#define AUT_HEADER32 0x14 43#define AUT_HEADER32_EX 0x15 44#define AUT_DATA 0x21 45#define AUT_IPC 0x22 46#define AUT_PATH 0x23 47#define AUT_SUBJECT32 0x24 48#define AUT_XATPATH 0x25 49#define AUT_PROCESS32 0x26 50#define AUT_RETURN32 0x27 51#define AUT_TEXT 0x28 52#define AUT_OPAQUE 0x29 53#define AUT_IN_ADDR 0x2a 54#define AUT_IP 0x2b 55#define AUT_IPORT 0x2c 56#define AUT_ARG32 0x2d 57#define AUT_SOCKET 0x2e 58#define AUT_SEQ 0x2f 59#define AUT_ACL 0x30 60#define AUT_ATTR 0x31 61#define AUT_IPC_PERM 0x32 62#define AUT_LABEL 0x33 63#define AUT_GROUPS 0x34 64#define AUT_ACE 0x35 65#define AUT_PRIV 0x38 66#define AUT_UPRIV 0x39 67#define AUT_LIAISON 0x3a 68#define AUT_NEWGROUPS 0x3b 69#define AUT_EXEC_ARGS 0x3c 70#define AUT_EXEC_ENV 0x3d 71#define AUT_ATTR32 0x3e 72#define AUT_UNAUTH 0x3f 73#define AUT_XATOM 0x40 74#define AUT_XOBJ 0x41 75#define AUT_XPROTO 0x42 76#define AUT_XSELECT 0x43 77#define AUT_XCOLORMAP 0x44 78#define AUT_XCURSOR 0x45 79#define AUT_XFONT 0x46 80#define AUT_XGC 0x47 81#define AUT_XPIXMAP 0x48 82#define AUT_XPROPERTY 0x49 83#define AUT_XWINDOW 0x4a 84#define AUT_XCLIENT 0x4b 85#define AUT_CMD 0x51 86#define AUT_EXIT 0x52 87#define AUT_ZONENAME 0x60 88#define AUT_HOST 0x70 89#define AUT_ARG64 0x71 90#define AUT_RETURN64 0x72 91#define AUT_ATTR64 0x73 92#define AUT_HEADER64 0x74 93#define AUT_SUBJECT64 0x75 94#define AUT_PROCESS64 0x77 95#define AUT_OTHER_FILE64 0x78 96#define AUT_HEADER64_EX 0x79 97#define AUT_SUBJECT32_EX 0x7a 98#define AUT_PROCESS32_EX 0x7b 99#define AUT_SUBJECT64_EX 0x7c 100#define AUT_PROCESS64_EX 0x7d 101#define AUT_IN_ADDR_EX 0x7e 102#define AUT_SOCKET_EX 0x7f 103 104/* 105 * Pre-64-bit BSM, 32-bit tokens weren't explicitly named as '32'. We have 106 * compatibility defines. 107 */ 108#define AUT_HEADER AUT_HEADER32 109#define AUT_ARG AUT_ARG32 110#define AUT_RETURN AUT_RETURN32 111#define AUT_SUBJECT AUT_SUBJECT32 112#define AUT_PROCESS AUT_PROCESS32 113#define AUT_OTHER_FILE AUT_OTHER_FILE32 114 115/* 116 * The values for the following token ids are not defined by BSM. 117 * 118 * XXXRW: Not sure how to handle these in OpenBSM yet, but I'll give them 119 * names more consistent with Sun's BSM. These originally came from Apple's 120 * BSM. 121 */ 122#define AUT_SOCKINET32 0x80 /* XXX */ 123#define AUT_SOCKINET128 0x81 /* XXX */ 124#define AUT_SOCKUNIX 0x82 /* XXX */ 125 126/* print values for the arbitrary token */ 127#define AUP_BINARY 0 128#define AUP_OCTAL 1 129#define AUP_DECIMAL 2 130#define AUP_HEX 3 131#define AUP_STRING 4 132 133/* data-types for the arbitrary token */ 134#define AUR_BYTE 0 135#define AUR_CHAR AUR_BYTE 136#define AUR_SHORT 1 137#define AUR_INT32 2 138#define AUR_INT AUR_INT32 139#define AUR_INT64 3 140 141/* ... and their sizes */ 142#define AUR_BYTE_SIZE sizeof(u_char) 143#define AUR_CHAR_SIZE AUR_BYTE_SIZE 144#define AUR_SHORT_SIZE sizeof(uint16_t) 145#define AUR_INT32_SIZE sizeof(uint32_t) 146#define AUR_INT_SIZE AUR_INT32_SIZE 147#define AUR_INT64_SIZE sizeof(uint64_t) 148 149/* Modifiers for the header token */ 150#define PAD_NOTATTR 0x4000 /* nonattributable event */ 151#define PAD_FAILURE 0x8000 /* fail audit event */ 152 153#define AUDIT_MAX_GROUPS 16 154 155/* 156 * A number of BSM versions are floating around and defined. Here are 157 * constants for them. OpenBSM uses the same token types, etc, used in the 158 * Solaris BSM version, but has a separate version number in order to 159 * identify a potentially different event identifier name space. 160 */ 161#define AUDIT_HEADER_VERSION_OLDDARWIN 1 /* In retrospect, a mistake. */ 162#define AUDIT_HEADER_VERSION_SOLARIS 2 163#define AUDIT_HEADER_VERSION_TSOL25 3 164#define AUDIT_HEADER_VERSION_TSOL 4 165#define AUDIT_HEADER_VERSION_OPENBSM10 10 166#define AUDIT_HEADER_VERSION_OPENBSM11 11 167#define AUDIT_HEADER_VERSION_OPENBSM AUDIT_HEADER_VERSION_OPENBSM11 168 169#define AUT_TRAILER_MAGIC 0xb105 170 171/* BSM library calls */ 172 173__BEGIN_DECLS 174 175struct in_addr; 176struct in6_addr; 177struct ip; 178struct ipc_perm; 179struct kevent; 180struct sockaddr; 181struct sockaddr_in; 182struct sockaddr_in6; 183struct sockaddr_un; 184#if defined(_KERNEL) || defined(KERNEL) 185struct vnode_au_info; 186#endif 187 188int au_open(void); 189int au_write(int d, token_t *m); 190int au_close(int d, int keep, short event); 191int au_close_buffer(int d, short event, u_char *buffer, size_t *buflen); 192int au_close_token(token_t *tok, u_char *buffer, size_t *buflen); 193 194token_t *au_to_file(const char *file, struct timeval tm); 195 196token_t *au_to_header32_tm(int rec_size, au_event_t e_type, au_emod_t e_mod, 197 struct timeval tm); 198token_t *au_to_header32_ex_tm(int rec_size, au_event_t e_type, au_emod_t e_mod, 199 struct timeval tm, struct auditinfo_addr *aia); 200token_t *au_to_header64_tm(int rec_size, au_event_t e_type, au_emod_t e_mod, 201 struct timeval tm); 202#if !defined(KERNEL) && !defined(_KERNEL) 203token_t *au_to_header(int rec_size, au_event_t e_type, au_emod_t e_mod); 204token_t *au_to_header_ex(int rec_size, au_event_t e_type, au_emod_t e_mod); 205token_t *au_to_header32(int rec_size, au_event_t e_type, au_emod_t e_mod); 206token_t *au_to_header64(int rec_size, au_event_t e_type, au_emod_t e_mod); 207token_t *au_to_header32_ex(int rec_size, au_event_t e_type, au_emod_t e_mod); 208#endif 209 210token_t *au_to_me(void); 211token_t *au_to_arg(char n, const char *text, uint32_t v); 212token_t *au_to_arg32(char n, const char *text, uint32_t v); 213token_t *au_to_arg64(char n, const char *text, uint64_t v); 214 215#if defined(_KERNEL) || defined(KERNEL) 216token_t *au_to_attr(struct vnode_au_info *vni); 217token_t *au_to_attr32(struct vnode_au_info *vni); 218token_t *au_to_attr64(struct vnode_au_info *vni); 219#endif 220 221token_t *au_to_data(char unit_print, char unit_type, char unit_count, 222 const char *p); 223token_t *au_to_exit(int retval, int err); 224token_t *au_to_groups(int *groups); 225token_t *au_to_newgroups(uint16_t n, gid_t *groups); 226token_t *au_to_in_addr(struct in_addr *internet_addr); 227token_t *au_to_in_addr_ex(struct in6_addr *internet_addr); 228token_t *au_to_ip(struct ip *ip); 229token_t *au_to_ipc(char type, int id); 230token_t *au_to_ipc_perm(struct ipc_perm *perm); 231token_t *au_to_iport(uint16_t iport); 232token_t *au_to_opaque(const char *data, uint16_t bytes); 233token_t *au_to_path(const char *path); 234token_t *au_to_privset(char *privtypestr, char *privstr); 235token_t *au_to_process(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 236 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 237token_t *au_to_process32(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 238 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 239token_t *au_to_process64(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 240 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 241token_t *au_to_process_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 242 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 243token_t *au_to_process32_ex(au_id_t auid, uid_t euid, gid_t egid, 244 uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid, 245 au_tid_addr_t *tid); 246token_t *au_to_process64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 247 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 248token_t *au_to_return(char status, uint32_t ret); 249token_t *au_to_return32(char status, uint32_t ret); 250token_t *au_to_return64(char status, uint64_t ret); 251token_t *au_to_seq(long audit_count); 252token_t *au_to_socket_ex(u_short so_domain, u_short so_type, 253 struct sockaddr *sa_local, struct sockaddr *sa_remote); 254token_t *au_to_sock_inet(struct sockaddr_in *so); 255token_t *au_to_sock_inet32(struct sockaddr_in *so); 256token_t *au_to_sock_inet128(struct sockaddr_in6 *so); 257token_t *au_to_sock_unix(struct sockaddr_un *so); 258token_t *au_to_subject(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 259 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 260token_t *au_to_subject32(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 261 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 262token_t *au_to_subject64(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 263 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 264token_t *au_to_subject_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 265 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 266token_t *au_to_subject32_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 267 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 268token_t *au_to_subject64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 269 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 270#if defined(_KERNEL) || defined(KERNEL) 271token_t *au_to_exec_args(char *args, int argc); 272token_t *au_to_exec_env(char *envs, int envc); 273#else 274token_t *au_to_exec_args(char **argv); 275token_t *au_to_exec_env(char **envp); 276#endif 277token_t *au_to_text(const char *text); 278token_t *au_to_kevent(struct kevent *kev); 279token_t *au_to_trailer(int rec_size); 280token_t *au_to_upriv(char sorf, char *priv); 281token_t *au_to_zonename(const char *zonename); 282 283/* 284 * BSM library routines for converting between local and BSM constant spaces. 285 */ 286int au_bsm_to_domain(u_short bsm_domain, int *local_domainp); 287int au_bsm_to_errno(u_char bsm_error, int *errorp); 288int au_bsm_to_fcntl_cmd(u_short bsm_fcntl_cmd, int *local_fcntl_cmdp); 289int au_bsm_to_socket_type(u_short bsm_socket_type, 290 int *local_socket_typep); 291u_short au_domain_to_bsm(int local_domain); 292u_char au_errno_to_bsm(int local_errno); 293u_short au_fcntl_cmd_to_bsm(int local_fcntl_command); 294u_short au_socket_type_to_bsm(int local_socket_type); 295 296__END_DECLS 297 298#endif /* ! _BSM_AUDIT_RECORD_H_ */ 299