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