1 /* 2 * Copyright (c) 2005 Apple Computer, Inc. 3 * All rights reserved. 4 * 5 * @APPLE_BSD_LICENSE_HEADER_START@ 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of 17 * its contributors may be used to endorse or promote products derived 18 * from this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY 21 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 23 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY 24 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 27 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 * 31 * @APPLE_BSD_LICENSE_HEADER_END@ 32 * 33 * $P4: //depot/projects/trustedbsd/audit3/sys/bsm/audit_record.h#8 $ 34 * $FreeBSD$ 35 */ 36 37 #ifndef _BSM_AUDIT_RECORD_H_ 38 #define _BSM_AUDIT_RECORD_H_ 39 40 /* Various token id types */ 41 42 /* 43 * Values inside the comments are not documented in the BSM pages and 44 * have been picked up from the header files 45 */ 46 47 /* 48 * Values marked as XXX do not have a value defined in the BSM header files 49 */ 50 51 #define AUT_INVALID 0x00 52 #define AUT_OTHER_FILE32 0x11 53 #define AUT_OHEADER 0x12 54 #define AUT_TRAILER 0x13 55 #define AUT_HEADER32 0x14 56 #define AUT_HEADER32_EX 0x15 57 #define AUT_DATA 0x21 58 #define AUT_IPC 0x22 59 #define AUT_PATH 0x23 60 #define AUT_SUBJECT32 0x24 61 #define AUT_SERVER32 0x25 62 #define AUT_PROCESS32 0x26 63 #define AUT_RETURN32 0x27 64 #define AUT_TEXT 0x28 65 #define AUT_OPAQUE 0x29 66 #define AUT_IN_ADDR 0x2a 67 #define AUT_IP 0x2b 68 #define AUT_IPORT 0x2c 69 #define AUT_ARG32 0x2d 70 #define AUT_SOCKET 0x2e 71 #define AUT_SEQ 0x2f 72 #define AUT_ACL 0x30 73 #define AUT_ATTR 0x31 74 #define AUT_IPC_PERM 0x32 75 #define AUT_LABEL 0x33 76 #define AUT_GROUPS 0x34 77 #define AUT_ILABEL 0x35 78 #define AUT_SLABEL 0x36 79 #define AUT_CLEAR 0x37 80 #define AUT_PRIV 0x38 81 #define AUT_UPRIV 0x39 82 #define AUT_LIAISON 0x3a 83 #define AUT_NEWGROUPS 0x3b 84 #define AUT_EXEC_ARGS 0x3c 85 #define AUT_EXEC_ENV 0x3d 86 #define AUT_ATTR32 0x3e 87 /* #define AUT_???? 0x3f */ 88 #define AUT_XATOM 0x40 89 #define AUT_XOBJ 0x41 90 #define AUT_XPROTO 0x42 91 #define AUT_XSELECT 0x43 92 /* XXXRW: Additional X11 tokens not defined? */ 93 #define AUT_CMD 0x51 94 #define AUT_EXIT 0x52 95 /* XXXRW: OpenBSM AUT_HOST 0x70? */ 96 #define AUT_ARG64 0x71 97 #define AUT_RETURN64 0x72 98 #define AUT_ATTR64 0x73 99 #define AUT_HEADER64 0x74 100 #define AUT_SUBJECT64 0x75 101 #define AUT_SERVER64 0x76 102 #define AUT_PROCESS64 0x77 103 #define AUT_OTHER_FILE64 0x78 104 #define AUT_HEADER64_EX 0x79 105 #define AUT_SUBJECT32_EX 0x7a 106 #define AUT_PROCESS32_EX 0x7b 107 #define AUT_SUBJECT64_EX 0x7c 108 #define AUT_PROCESS64_EX 0x7d 109 #define AUT_IN_ADDR_EX 0x7e 110 #define AUT_SOCKET_EX 0x7f 111 112 /* 113 * Pre-64-bit BSM, 32-bit tokens weren't explicitly named as '32'. We have 114 * compatibility defines. 115 */ 116 #define AUT_HEADER AUT_HEADER32 117 #define AUT_ARG AUT_ARG32 118 #define AUT_RETURN AUT_RETURN32 119 #define AUT_SUBJECT AUT_SUBJECT32 120 #define AUT_SERVER AUT_SERVER32 121 #define AUT_PROCESS AUT_PROCESS32 122 #define AUT_OTHER_FILE AUT_OTHER_FILE32 123 124 /* 125 * Darwin's bsm distribution uses the following non-BSM token name defines. 126 * We provide them for a single OpenBSM release for compatibility reasons. 127 */ 128 #define AU_FILE_TOKEN AUT_OTHER_FILE32 129 #define AU_TRAILER_TOKEN AUT_TRAILER 130 #define AU_HEADER_32_TOKEN AUT_HEADER32 131 #define AU_DATA_TOKEN AUT_DATA 132 #define AU_ARB_TOKEN AUT_DATA 133 #define AU_IPC_TOKEN AUT_IPC 134 #define AU_PATH_TOKEN AUT_PATH 135 #define AU_SUBJECT_32_TOKEN AUT_SUBJECT32 136 #define AU_PROCESS_32_TOKEN AUT_PROCESS32 137 #define AU_RETURN_32_TOKEN AUT_RETURN32 138 #define AU_TEXT_TOKEN AUT_TEXT 139 #define AU_OPAQUE_TOKEN AUT_OPAQUE 140 #define AU_IN_ADDR_TOKEN AUT_IN_ADDR 141 #define AU_IP_TOKEN AUT_IP 142 #define AU_IPORT_TOKEN AUT_IPORT 143 #define AU_ARG32_TOKEN AUT_ARG32 144 #define AU_SOCK_TOKEN AUT_SOCKET 145 #define AU_SEQ_TOKEN AUT_SEQ 146 #define AU_ATTR_TOKEN AUT_ATTR 147 #define AU_IPCPERM_TOKEN AUT_IPC_PERM 148 #define AU_NEWGROUPS_TOKEN AUT_NEWGROUPS 149 #define AU_EXEC_ARG_TOKEN AUT_EXEC_ARGS 150 #define AU_EXEC_ENV_TOKEN AUT_EXEC_ENV 151 #define AU_ATTR32_TOKEN AUT_ATTR32 152 #define AU_CMD_TOKEN AUT_CMD 153 #define AU_EXIT_TOKEN AUT_EXIT 154 #define AU_ARG64_TOKEN AUT_ARG64 155 #define AU_RETURN_64_TOKEN AUT_RETURN64 156 #define AU_ATTR64_TOKEN AUT_ATTR64 157 #define AU_HEADER_64_TOKEN AUT_HEADER64 158 #define AU_SUBJECT_64_TOKEN AUT_SUBJECT64 159 #define AU_PROCESS_64_TOKEN AUT_PROCESS64 160 #define AU_HEADER_64_EX_TOKEN AUT_HEADER64_EX 161 #define AU_SUBJECT_32_EX_TOKEN AUT_SUBJECT32_EX 162 #define AU_PROCESS_32_EX_TOKEN AUT_PROCESS32_EX 163 #define AU_SUBJECT_64_EX_TOKEN AUT_SUBJECT64_EX 164 #define AU_PROCESS_64_EX_TOKEN AUT_PROCESS64_EX 165 #define AU_IN_ADDR_EX_TOKEN AUT_IN_ADDR_EX 166 #define AU_SOCK_32_EX_TOKEN AUT_SOCKET_EX 167 168 /* 169 * The values for the following token ids are not defined by BSM. 170 * 171 * XXXRW: Not sure how to handle these in OpenBSM yet, but I'll give them 172 * names more consistent with Sun's BSM. These originally came from Apple's 173 * BSM. 174 */ 175 #define AUT_SOCKINET32 0x80 /* XXX */ 176 #define AUT_SOCKINET128 0x81 /* XXX */ 177 #define AUT_SOCKUNIX 0x82 /* XXX */ 178 #define AU_SOCK_INET_32_TOKEN AUT_SOCKINET32 179 #define AU_SOCK_INET_128_TOKEN AUT_SOCKINET128 180 #define AU_SOCK_UNIX_TOKEN AUT_SOCKUNIX 181 182 /* print values for the arbitrary token */ 183 #define AUP_BINARY 0 184 #define AUP_OCTAL 1 185 #define AUP_DECIMAL 2 186 #define AUP_HEX 3 187 #define AUP_STRING 4 188 189 /* data-types for the arbitrary token */ 190 #define AUR_BYTE 0 191 #define AUR_SHORT 1 192 #define AUR_LONG 2 193 194 /* ... and their sizes */ 195 #define AUR_BYTE_SIZE sizeof(u_char) 196 #define AUR_SHORT_SIZE sizeof(uint16_t) 197 #define AUR_LONG_SIZE sizeof(uint32_t) 198 199 /* Modifiers for the header token */ 200 #define PAD_NOTATTR 0x4000 /* nonattributable event */ 201 #define PAD_FAILURE 0x8000 /* fail audit event */ 202 203 204 #define BSM_MAX_GROUPS 16 205 #define HEADER_VERSION 1 206 207 /* 208 * BSM define is AUT_TRAILER_MAGIC; Apple BSM define is TRAILER_PAD_MAGIC; we 209 * split the difference, will remove the Apple define for the next release. 210 */ 211 #define AUT_TRAILER_MAGIC 0xb105 212 #define TRAILER_PAD_MAGIC AUT_TRAILER_MAGIC 213 214 /* BSM library calls */ 215 216 __BEGIN_DECLS 217 218 struct in_addr; 219 struct in6_addr; 220 struct ip; 221 struct ipc_perm; 222 struct kevent; 223 struct sockaddr_in; 224 struct sockaddr_in6; 225 struct sockaddr_un; 226 #if defined(_KERNEL) || defined(KERNEL) 227 struct vnode_au_info; 228 #endif 229 230 int au_open(void); 231 int au_write(int d, token_t *m); 232 int au_close(int d, int keep, short event); 233 int au_close_buffer(int d, short event, u_char *buffer, size_t *buflen); 234 235 #if defined(KERNEL) || defined(_KERNEL) 236 token_t *au_to_file(char *file, struct timeval tm); 237 #else 238 token_t *au_to_file(char *file); 239 #endif 240 241 #if defined(KERNEL) || defined(_KERNEL) 242 token_t *au_to_header(int rec_size, au_event_t e_type, au_emod_t e_mod, 243 struct timeval tm); 244 token_t *au_to_header32(int rec_size, au_event_t e_type, au_emod_t e_mod, 245 struct timeval tm); 246 #else 247 token_t *au_to_header(int rec_size, au_event_t e_type, au_emod_t e_mod); 248 token_t *au_to_header32(int rec_size, au_event_t e_type, au_emod_t e_mod); 249 #endif 250 251 token_t *au_to_header64(int rec_size, au_event_t e_type, au_emod_t e_mod); 252 token_t *au_to_me(void); 253 token_t *au_to_arg(char n, char *text, uint32_t v); 254 token_t *au_to_arg32(char n, char *text, uint32_t v); 255 token_t *au_to_arg64(char n, char *text, uint64_t v); 256 257 #if defined(_KERNEL) || defined(KERNEL) 258 token_t *au_to_attr(struct vnode_au_info *vni); 259 token_t *au_to_attr32(struct vnode_au_info *vni); 260 token_t *au_to_attr64(struct vnode_au_info *vni); 261 #endif 262 263 token_t *au_to_data(char unit_print, char unit_type, char unit_count, 264 char *p); 265 token_t *au_to_exit(int retval, int err); 266 token_t *au_to_groups(int *groups); 267 token_t *au_to_newgroups(uint16_t n, gid_t *groups); 268 token_t *au_to_in_addr(struct in_addr *internet_addr); 269 token_t *au_to_in_addr_ex(struct in6_addr *internet_addr); 270 token_t *au_to_ip(struct ip *ip); 271 token_t *au_to_ipc(char type, int id); 272 token_t *au_to_ipc_perm(struct ipc_perm *perm); 273 token_t *au_to_iport(uint16_t iport); 274 token_t *au_to_opaque(char *data, uint16_t bytes); 275 token_t *au_to_path(char *path); 276 token_t *au_to_process(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 277 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 278 token_t *au_to_process32(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 279 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 280 token_t *au_to_process64(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 281 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 282 token_t *au_to_process_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 283 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 284 token_t *au_to_process32_ex(au_id_t auid, uid_t euid, gid_t egid, 285 uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid, 286 au_tid_addr_t *tid); 287 token_t *au_to_process64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 288 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 289 token_t *au_to_return(char status, uint32_t ret); 290 token_t *au_to_return32(char status, uint32_t ret); 291 token_t *au_to_return64(char status, uint64_t ret); 292 token_t *au_to_seq(long audit_count); 293 294 #if defined(_KERNEL) || defined(KERNEL) 295 token_t *au_to_socket(struct socket *so); 296 token_t *au_to_socket_ex_32(uint16_t lp, uint16_t rp, struct sockaddr *la, 297 struct sockaddr *ta); 298 token_t *au_to_socket_ex_128(uint16_t lp, uint16_t rp, struct sockaddr *la, 299 struct sockaddr *ta); 300 #endif 301 302 token_t *au_to_sock_inet(struct sockaddr_in *so); 303 token_t *au_to_sock_inet32(struct sockaddr_in *so); 304 token_t *au_to_sock_inet128(struct sockaddr_in6 *so); 305 token_t *au_to_sock_unix(struct sockaddr_un *so); 306 token_t *au_to_subject(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 307 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 308 token_t *au_to_subject32(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 309 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 310 token_t *au_to_subject64(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 311 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 312 token_t *au_to_subject_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 313 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 314 token_t *au_to_subject32_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 315 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 316 token_t *au_to_subject64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 317 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 318 token_t *au_to_exec_args(const char **); 319 token_t *au_to_exec_env(const char **); 320 token_t *au_to_text(char *text); 321 token_t *au_to_kevent(struct kevent *kev); 322 token_t *au_to_trailer(int rec_size); 323 324 __END_DECLS 325 326 #endif /* ! _BSM_AUDIT_RECORD_H_ */ 327