audit_record.h revision 168782
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#24 $ 34 * $FreeBSD: head/sys/bsm/audit_record.h 168782 2007-04-16 16:13:10Z rwatson $ 35 */ 36 37#ifndef _BSM_AUDIT_RECORD_H_ 38#define _BSM_AUDIT_RECORD_H_ 39 40#include <sys/time.h> /* struct timeval */ 41 42/* 43 * Token type identifiers. 44 */ 45#define AUT_INVALID 0x00 46#define AUT_OTHER_FILE32 0x11 47#define AUT_OHEADER 0x12 48#define AUT_TRAILER 0x13 49#define AUT_HEADER32 0x14 50#define AUT_HEADER32_EX 0x15 51#define AUT_DATA 0x21 52#define AUT_IPC 0x22 53#define AUT_PATH 0x23 54#define AUT_SUBJECT32 0x24 55#define AUT_SERVER32 0x25 56#define AUT_PROCESS32 0x26 57#define AUT_RETURN32 0x27 58#define AUT_TEXT 0x28 59#define AUT_OPAQUE 0x29 60#define AUT_IN_ADDR 0x2a 61#define AUT_IP 0x2b 62#define AUT_IPORT 0x2c 63#define AUT_ARG32 0x2d 64#define AUT_SOCKET 0x2e 65#define AUT_SEQ 0x2f 66#define AUT_ACL 0x30 67#define AUT_ATTR 0x31 68#define AUT_IPC_PERM 0x32 69#define AUT_LABEL 0x33 70#define AUT_GROUPS 0x34 71#define AUT_ILABEL 0x35 72#define AUT_SLABEL 0x36 73#define AUT_CLEAR 0x37 74#define AUT_PRIV 0x38 75#define AUT_UPRIV 0x39 76#define AUT_LIAISON 0x3a 77#define AUT_NEWGROUPS 0x3b 78#define AUT_EXEC_ARGS 0x3c 79#define AUT_EXEC_ENV 0x3d 80#define AUT_ATTR32 0x3e 81/* #define AUT_???? 0x3f */ 82#define AUT_XATOM 0x40 83#define AUT_XOBJ 0x41 84#define AUT_XPROTO 0x42 85#define AUT_XSELECT 0x43 86/* XXXRW: Additional X11 tokens not defined? */ 87#define AUT_CMD 0x51 88#define AUT_EXIT 0x52 89#define AUT_ZONENAME 0x60 90/* XXXRW: OpenBSM 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_SERVER64 0x76 97#define AUT_PROCESS64 0x77 98#define AUT_OTHER_FILE64 0x78 99#define AUT_HEADER64_EX 0x79 100#define AUT_SUBJECT32_EX 0x7a 101#define AUT_PROCESS32_EX 0x7b 102#define AUT_SUBJECT64_EX 0x7c 103#define AUT_PROCESS64_EX 0x7d 104#define AUT_IN_ADDR_EX 0x7e 105#define AUT_SOCKET_EX 0x7f 106 107/* 108 * Pre-64-bit BSM, 32-bit tokens weren't explicitly named as '32'. We have 109 * compatibility defines. 110 */ 111#define AUT_HEADER AUT_HEADER32 112#define AUT_ARG AUT_ARG32 113#define AUT_RETURN AUT_RETURN32 114#define AUT_SUBJECT AUT_SUBJECT32 115#define AUT_SERVER AUT_SERVER32 116#define AUT_PROCESS AUT_PROCESS32 117#define AUT_OTHER_FILE AUT_OTHER_FILE32 118 119/* 120 * Darwin's bsm distribution uses the following non-BSM token name defines. 121 * We provide them for a single OpenBSM release for compatibility reasons. 122 */ 123#define AU_FILE_TOKEN AUT_OTHER_FILE32 124#define AU_TRAILER_TOKEN AUT_TRAILER 125#define AU_HEADER_32_TOKEN AUT_HEADER32 126#define AU_DATA_TOKEN AUT_DATA 127#define AU_ARB_TOKEN AUT_DATA 128#define AU_IPC_TOKEN AUT_IPC 129#define AU_PATH_TOKEN AUT_PATH 130#define AU_SUBJECT_32_TOKEN AUT_SUBJECT32 131#define AU_PROCESS_32_TOKEN AUT_PROCESS32 132#define AU_RETURN_32_TOKEN AUT_RETURN32 133#define AU_TEXT_TOKEN AUT_TEXT 134#define AU_OPAQUE_TOKEN AUT_OPAQUE 135#define AU_IN_ADDR_TOKEN AUT_IN_ADDR 136#define AU_IP_TOKEN AUT_IP 137#define AU_IPORT_TOKEN AUT_IPORT 138#define AU_ARG32_TOKEN AUT_ARG32 139#define AU_SOCK_TOKEN AUT_SOCKET 140#define AU_SEQ_TOKEN AUT_SEQ 141#define AU_ATTR_TOKEN AUT_ATTR 142#define AU_IPCPERM_TOKEN AUT_IPC_PERM 143#define AU_NEWGROUPS_TOKEN AUT_NEWGROUPS 144#define AU_EXEC_ARG_TOKEN AUT_EXEC_ARGS 145#define AU_EXEC_ENV_TOKEN AUT_EXEC_ENV 146#define AU_ATTR32_TOKEN AUT_ATTR32 147#define AU_CMD_TOKEN AUT_CMD 148#define AU_EXIT_TOKEN AUT_EXIT 149#define AU_ARG64_TOKEN AUT_ARG64 150#define AU_RETURN_64_TOKEN AUT_RETURN64 151#define AU_ATTR64_TOKEN AUT_ATTR64 152#define AU_HEADER_64_TOKEN AUT_HEADER64 153#define AU_SUBJECT_64_TOKEN AUT_SUBJECT64 154#define AU_PROCESS_64_TOKEN AUT_PROCESS64 155#define AU_HEADER_64_EX_TOKEN AUT_HEADER64_EX 156#define AU_SUBJECT_32_EX_TOKEN AUT_SUBJECT32_EX 157#define AU_PROCESS_32_EX_TOKEN AUT_PROCESS32_EX 158#define AU_SUBJECT_64_EX_TOKEN AUT_SUBJECT64_EX 159#define AU_PROCESS_64_EX_TOKEN AUT_PROCESS64_EX 160#define AU_IN_ADDR_EX_TOKEN AUT_IN_ADDR_EX 161#define AU_SOCK_32_EX_TOKEN AUT_SOCKET_EX 162 163/* 164 * The values for the following token ids are not defined by BSM. 165 * 166 * XXXRW: Not sure how to handle these in OpenBSM yet, but I'll give them 167 * names more consistent with Sun's BSM. These originally came from Apple's 168 * BSM. 169 */ 170#define AUT_SOCKINET32 0x80 /* XXX */ 171#define AUT_SOCKINET128 0x81 /* XXX */ 172#define AUT_SOCKUNIX 0x82 /* XXX */ 173#define AU_SOCK_INET_32_TOKEN AUT_SOCKINET32 174#define AU_SOCK_INET_128_TOKEN AUT_SOCKINET128 175#define AU_SOCK_UNIX_TOKEN AUT_SOCKUNIX 176 177/* print values for the arbitrary token */ 178#define AUP_BINARY 0 179#define AUP_OCTAL 1 180#define AUP_DECIMAL 2 181#define AUP_HEX 3 182#define AUP_STRING 4 183 184/* data-types for the arbitrary token */ 185#define AUR_BYTE 0 186#define AUR_CHAR AUR_BYTE 187#define AUR_SHORT 1 188#define AUR_INT32 2 189#define AUR_INT AUR_INT32 190#define AUR_INT64 3 191 192/* ... and their sizes */ 193#define AUR_BYTE_SIZE sizeof(u_char) 194#define AUR_CHAR_SIZE AUR_BYTE_SIZE 195#define AUR_SHORT_SIZE sizeof(uint16_t) 196#define AUR_INT32_SIZE sizeof(uint32_t) 197#define AUR_INT_SIZE AUR_INT32_SIZE 198#define AUR_INT64_SIZE sizeof(uint64_t) 199 200/* Modifiers for the header token */ 201#define PAD_NOTATTR 0x4000 /* nonattributable event */ 202#define PAD_FAILURE 0x8000 /* fail audit event */ 203 204#define AUDIT_MAX_GROUPS 16 205 206/* 207 * A number of BSM versions are floating around and defined. Here are 208 * constants for them. OpenBSM uses the same token types, etc, used in the 209 * Solaris BSM version, but has a separate version number in order to 210 * identify a potentially different event identifier name space. 211 */ 212#define AUDIT_HEADER_VERSION_OLDDARWIN 1 /* In retrospect, a mistake. */ 213#define AUDIT_HEADER_VERSION_SOLARIS 2 214#define AUDIT_HEADER_VERSION_TSOL25 3 215#define AUDIT_HEADER_VERSION_TSOL 4 216#define AUDIT_HEADER_VERSION_OPENBSM 10 217 218/* 219 * BSM define is AUT_TRAILER_MAGIC; Apple BSM define is TRAILER_PAD_MAGIC; we 220 * split the difference, will remove the Apple define for the next release. 221 */ 222#define AUT_TRAILER_MAGIC 0xb105 223#define TRAILER_PAD_MAGIC AUT_TRAILER_MAGIC 224 225/* BSM library calls */ 226 227__BEGIN_DECLS 228 229struct in_addr; 230struct in6_addr; 231struct ip; 232struct ipc_perm; 233struct kevent; 234struct sockaddr_in; 235struct sockaddr_in6; 236struct sockaddr_un; 237#if defined(_KERNEL) || defined(KERNEL) 238struct vnode_au_info; 239#endif 240 241int au_open(void); 242int au_write(int d, token_t *m); 243int au_close(int d, int keep, short event); 244int au_close_buffer(int d, short event, u_char *buffer, size_t *buflen); 245int au_close_token(token_t *tok, u_char *buffer, size_t *buflen); 246 247token_t *au_to_file(char *file, struct timeval tm); 248 249token_t *au_to_header32_tm(int rec_size, au_event_t e_type, au_emod_t e_mod, 250 struct timeval tm); 251token_t *au_to_header64_tm(int rec_size, au_event_t e_type, au_emod_t e_mod, 252 struct timeval tm); 253#if !defined(KERNEL) && !defined(_KERNEL) 254token_t *au_to_header(int rec_size, au_event_t e_type, au_emod_t e_mod); 255token_t *au_to_header32(int rec_size, au_event_t e_type, au_emod_t e_mod); 256token_t *au_to_header64(int rec_size, au_event_t e_type, au_emod_t e_mod); 257#endif 258 259token_t *au_to_me(void); 260token_t *au_to_arg(char n, char *text, uint32_t v); 261token_t *au_to_arg32(char n, char *text, uint32_t v); 262token_t *au_to_arg64(char n, char *text, uint64_t v); 263 264#if defined(_KERNEL) || defined(KERNEL) 265token_t *au_to_attr(struct vnode_au_info *vni); 266token_t *au_to_attr32(struct vnode_au_info *vni); 267token_t *au_to_attr64(struct vnode_au_info *vni); 268#endif 269 270token_t *au_to_data(char unit_print, char unit_type, char unit_count, 271 char *p); 272token_t *au_to_exit(int retval, int err); 273token_t *au_to_groups(int *groups); 274token_t *au_to_newgroups(uint16_t n, gid_t *groups); 275token_t *au_to_in_addr(struct in_addr *internet_addr); 276token_t *au_to_in_addr_ex(struct in6_addr *internet_addr); 277token_t *au_to_ip(struct ip *ip); 278token_t *au_to_ipc(char type, int id); 279token_t *au_to_ipc_perm(struct ipc_perm *perm); 280token_t *au_to_iport(uint16_t iport); 281token_t *au_to_opaque(char *data, uint16_t bytes); 282token_t *au_to_path(char *path); 283token_t *au_to_process(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 284 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 285token_t *au_to_process32(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 286 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 287token_t *au_to_process64(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_t *tid); 289token_t *au_to_process_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 290 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 291token_t *au_to_process32_ex(au_id_t auid, uid_t euid, gid_t egid, 292 uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid, 293 au_tid_addr_t *tid); 294token_t *au_to_process64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 295 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 296token_t *au_to_return(char status, uint32_t ret); 297token_t *au_to_return32(char status, uint32_t ret); 298token_t *au_to_return64(char status, uint64_t ret); 299token_t *au_to_seq(long audit_count); 300 301#if defined(_KERNEL) || defined(KERNEL) 302token_t *au_to_socket(struct socket *so); 303token_t *au_to_socket_ex_32(uint16_t lp, uint16_t rp, struct sockaddr *la, 304 struct sockaddr *ta); 305token_t *au_to_socket_ex_128(uint16_t lp, uint16_t rp, struct sockaddr *la, 306 struct sockaddr *ta); 307#endif 308 309token_t *au_to_sock_inet(struct sockaddr_in *so); 310token_t *au_to_sock_inet32(struct sockaddr_in *so); 311token_t *au_to_sock_inet128(struct sockaddr_in6 *so); 312token_t *au_to_sock_unix(struct sockaddr_un *so); 313token_t *au_to_subject(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 314 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 315token_t *au_to_subject32(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 316 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 317token_t *au_to_subject64(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 318 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 319token_t *au_to_subject_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 320 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 321token_t *au_to_subject32_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 322 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 323token_t *au_to_subject64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 324 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 325#if defined(_KERNEL) || defined(KERNEL) 326token_t *au_to_exec_args(char *args, int argc); 327token_t *au_to_exec_env(char *envs, int envc); 328#else 329token_t *au_to_exec_args(char **argv); 330token_t *au_to_exec_env(char **envp); 331#endif 332token_t *au_to_text(char *text); 333token_t *au_to_kevent(struct kevent *kev); 334token_t *au_to_trailer(int rec_size); 335token_t *au_to_zonename(char *zonename); 336 337__END_DECLS 338 339#endif /* ! _BSM_AUDIT_RECORD_H_ */ 340