1185573Srwatson/*- 2191270Srwatson * Copyright (c) 2005-2009 Apple Inc. 3155191Srwatson * All rights reserved. 4155191Srwatson * 5155191Srwatson * Redistribution and use in source and binary forms, with or without 6155191Srwatson * modification, are permitted provided that the following conditions 7155191Srwatson * are met: 8155191Srwatson * 9155191Srwatson * 1. Redistributions of source code must retain the above copyright 10155191Srwatson * notice, this list of conditions and the following disclaimer. 11155191Srwatson * 2. Redistributions in binary form must reproduce the above copyright 12155191Srwatson * notice, this list of conditions and the following disclaimer in the 13155191Srwatson * documentation and/or other materials provided with the distribution. 14181053Srwatson * 3. Neither the name of Apple Inc. ("Apple") nor the names of 15155191Srwatson * its contributors may be used to endorse or promote products derived 16155191Srwatson * from this software without specific prior written permission. 17155191Srwatson * 18155191Srwatson * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY 19155191Srwatson * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 20155191Srwatson * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 21155191Srwatson * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY 22155191Srwatson * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 23155191Srwatson * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 24155191Srwatson * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 25155191Srwatson * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26155191Srwatson * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 27155191Srwatson * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28155191Srwatson * 29155191Srwatson * $FreeBSD$ 30155191Srwatson */ 31155191Srwatson 32155191Srwatson#ifndef _BSM_AUDIT_RECORD_H_ 33155191Srwatson#define _BSM_AUDIT_RECORD_H_ 34155191Srwatson 35160084Srwatson#include <sys/time.h> /* struct timeval */ 36255219Spjd#include <sys/caprights.h> /* cap_rights_t */ 37160084Srwatson 38155191Srwatson/* 39159257Srwatson * Token type identifiers. 40155191Srwatson */ 41155191Srwatson#define AUT_INVALID 0x00 42155191Srwatson#define AUT_OTHER_FILE32 0x11 43155191Srwatson#define AUT_OHEADER 0x12 44155191Srwatson#define AUT_TRAILER 0x13 45155191Srwatson#define AUT_HEADER32 0x14 46155191Srwatson#define AUT_HEADER32_EX 0x15 47155191Srwatson#define AUT_DATA 0x21 48155191Srwatson#define AUT_IPC 0x22 49155191Srwatson#define AUT_PATH 0x23 50155191Srwatson#define AUT_SUBJECT32 0x24 51185573Srwatson#define AUT_XATPATH 0x25 52155191Srwatson#define AUT_PROCESS32 0x26 53155191Srwatson#define AUT_RETURN32 0x27 54155191Srwatson#define AUT_TEXT 0x28 55155191Srwatson#define AUT_OPAQUE 0x29 56155191Srwatson#define AUT_IN_ADDR 0x2a 57155191Srwatson#define AUT_IP 0x2b 58155191Srwatson#define AUT_IPORT 0x2c 59155191Srwatson#define AUT_ARG32 0x2d 60155191Srwatson#define AUT_SOCKET 0x2e 61155191Srwatson#define AUT_SEQ 0x2f 62155191Srwatson#define AUT_ACL 0x30 63155191Srwatson#define AUT_ATTR 0x31 64155191Srwatson#define AUT_IPC_PERM 0x32 65155191Srwatson#define AUT_LABEL 0x33 66155191Srwatson#define AUT_GROUPS 0x34 67185573Srwatson#define AUT_ACE 0x35 68155191Srwatson#define AUT_PRIV 0x38 69155191Srwatson#define AUT_UPRIV 0x39 70155191Srwatson#define AUT_LIAISON 0x3a 71155191Srwatson#define AUT_NEWGROUPS 0x3b 72155191Srwatson#define AUT_EXEC_ARGS 0x3c 73155191Srwatson#define AUT_EXEC_ENV 0x3d 74155191Srwatson#define AUT_ATTR32 0x3e 75185573Srwatson#define AUT_UNAUTH 0x3f 76155191Srwatson#define AUT_XATOM 0x40 77155191Srwatson#define AUT_XOBJ 0x41 78155191Srwatson#define AUT_XPROTO 0x42 79155191Srwatson#define AUT_XSELECT 0x43 80185573Srwatson#define AUT_XCOLORMAP 0x44 81185573Srwatson#define AUT_XCURSOR 0x45 82185573Srwatson#define AUT_XFONT 0x46 83185573Srwatson#define AUT_XGC 0x47 84185573Srwatson#define AUT_XPIXMAP 0x48 85185573Srwatson#define AUT_XPROPERTY 0x49 86185573Srwatson#define AUT_XWINDOW 0x4a 87185573Srwatson#define AUT_XCLIENT 0x4b 88155191Srwatson#define AUT_CMD 0x51 89155191Srwatson#define AUT_EXIT 0x52 90168765Scsjp#define AUT_ZONENAME 0x60 91185573Srwatson#define AUT_HOST 0x70 92155191Srwatson#define AUT_ARG64 0x71 93155191Srwatson#define AUT_RETURN64 0x72 94155191Srwatson#define AUT_ATTR64 0x73 95155191Srwatson#define AUT_HEADER64 0x74 96155191Srwatson#define AUT_SUBJECT64 0x75 97155191Srwatson#define AUT_PROCESS64 0x77 98155191Srwatson#define AUT_OTHER_FILE64 0x78 99155191Srwatson#define AUT_HEADER64_EX 0x79 100155191Srwatson#define AUT_SUBJECT32_EX 0x7a 101155191Srwatson#define AUT_PROCESS32_EX 0x7b 102155191Srwatson#define AUT_SUBJECT64_EX 0x7c 103155191Srwatson#define AUT_PROCESS64_EX 0x7d 104155191Srwatson#define AUT_IN_ADDR_EX 0x7e 105155191Srwatson#define AUT_SOCKET_EX 0x7f 106155191Srwatson 107155191Srwatson/* 108155191Srwatson * Pre-64-bit BSM, 32-bit tokens weren't explicitly named as '32'. We have 109155191Srwatson * compatibility defines. 110155191Srwatson */ 111155191Srwatson#define AUT_HEADER AUT_HEADER32 112155191Srwatson#define AUT_ARG AUT_ARG32 113155191Srwatson#define AUT_RETURN AUT_RETURN32 114155191Srwatson#define AUT_SUBJECT AUT_SUBJECT32 115155191Srwatson#define AUT_PROCESS AUT_PROCESS32 116155191Srwatson#define AUT_OTHER_FILE AUT_OTHER_FILE32 117155191Srwatson 118155191Srwatson/* 119155191Srwatson * The values for the following token ids are not defined by BSM. 120155191Srwatson * 121155191Srwatson * XXXRW: Not sure how to handle these in OpenBSM yet, but I'll give them 122155191Srwatson * names more consistent with Sun's BSM. These originally came from Apple's 123155191Srwatson * BSM. 124155191Srwatson */ 125155191Srwatson#define AUT_SOCKINET32 0x80 /* XXX */ 126155191Srwatson#define AUT_SOCKINET128 0x81 /* XXX */ 127155191Srwatson#define AUT_SOCKUNIX 0x82 /* XXX */ 128155191Srwatson 129255219Spjd#define AUT_RIGHTS 0x83 130255219Spjd 131155191Srwatson/* print values for the arbitrary token */ 132155191Srwatson#define AUP_BINARY 0 133155191Srwatson#define AUP_OCTAL 1 134155191Srwatson#define AUP_DECIMAL 2 135155191Srwatson#define AUP_HEX 3 136155191Srwatson#define AUP_STRING 4 137155191Srwatson 138155191Srwatson/* data-types for the arbitrary token */ 139155191Srwatson#define AUR_BYTE 0 140159257Srwatson#define AUR_CHAR AUR_BYTE 141155191Srwatson#define AUR_SHORT 1 142159257Srwatson#define AUR_INT32 2 143161635Srwatson#define AUR_INT AUR_INT32 144159257Srwatson#define AUR_INT64 3 145155191Srwatson 146155191Srwatson/* ... and their sizes */ 147155191Srwatson#define AUR_BYTE_SIZE sizeof(u_char) 148159257Srwatson#define AUR_CHAR_SIZE AUR_BYTE_SIZE 149155191Srwatson#define AUR_SHORT_SIZE sizeof(uint16_t) 150159257Srwatson#define AUR_INT32_SIZE sizeof(uint32_t) 151159257Srwatson#define AUR_INT_SIZE AUR_INT32_SIZE 152159257Srwatson#define AUR_INT64_SIZE sizeof(uint64_t) 153155191Srwatson 154155191Srwatson/* Modifiers for the header token */ 155155191Srwatson#define PAD_NOTATTR 0x4000 /* nonattributable event */ 156155191Srwatson#define PAD_FAILURE 0x8000 /* fail audit event */ 157155191Srwatson 158161635Srwatson#define AUDIT_MAX_GROUPS 16 159155191Srwatson 160161635Srwatson/* 161161635Srwatson * A number of BSM versions are floating around and defined. Here are 162161635Srwatson * constants for them. OpenBSM uses the same token types, etc, used in the 163161635Srwatson * Solaris BSM version, but has a separate version number in order to 164161635Srwatson * identify a potentially different event identifier name space. 165161635Srwatson */ 166161635Srwatson#define AUDIT_HEADER_VERSION_OLDDARWIN 1 /* In retrospect, a mistake. */ 167161635Srwatson#define AUDIT_HEADER_VERSION_SOLARIS 2 168161635Srwatson#define AUDIT_HEADER_VERSION_TSOL25 3 169161635Srwatson#define AUDIT_HEADER_VERSION_TSOL 4 170186647Srwatson#define AUDIT_HEADER_VERSION_OPENBSM10 10 171186647Srwatson#define AUDIT_HEADER_VERSION_OPENBSM11 11 172186647Srwatson#define AUDIT_HEADER_VERSION_OPENBSM AUDIT_HEADER_VERSION_OPENBSM11 173155191Srwatson 174155191Srwatson#define AUT_TRAILER_MAGIC 0xb105 175155191Srwatson 176155191Srwatson/* BSM library calls */ 177155191Srwatson 178155191Srwatson__BEGIN_DECLS 179155191Srwatson 180155191Srwatsonstruct in_addr; 181155191Srwatsonstruct in6_addr; 182155191Srwatsonstruct ip; 183155191Srwatsonstruct ipc_perm; 184155191Srwatsonstruct kevent; 185186647Srwatsonstruct sockaddr; 186155191Srwatsonstruct sockaddr_in; 187155191Srwatsonstruct sockaddr_in6; 188155191Srwatsonstruct sockaddr_un; 189155191Srwatson#if defined(_KERNEL) || defined(KERNEL) 190155191Srwatsonstruct vnode_au_info; 191155191Srwatson#endif 192155191Srwatson 193155191Srwatsonint au_open(void); 194155191Srwatsonint au_write(int d, token_t *m); 195155191Srwatsonint au_close(int d, int keep, short event); 196155191Srwatsonint au_close_buffer(int d, short event, u_char *buffer, size_t *buflen); 197159257Srwatsonint au_close_token(token_t *tok, u_char *buffer, size_t *buflen); 198155191Srwatson 199185573Srwatsontoken_t *au_to_file(const char *file, struct timeval tm); 200155191Srwatson 201159257Srwatsontoken_t *au_to_header32_tm(int rec_size, au_event_t e_type, au_emod_t e_mod, 202155191Srwatson struct timeval tm); 203184856Scsjptoken_t *au_to_header32_ex_tm(int rec_size, au_event_t e_type, au_emod_t e_mod, 204184856Scsjp struct timeval tm, struct auditinfo_addr *aia); 205168782Srwatsontoken_t *au_to_header64_tm(int rec_size, au_event_t e_type, au_emod_t e_mod, 206168782Srwatson struct timeval tm); 207159257Srwatson#if !defined(KERNEL) && !defined(_KERNEL) 208155191Srwatsontoken_t *au_to_header(int rec_size, au_event_t e_type, au_emod_t e_mod); 209184856Scsjptoken_t *au_to_header_ex(int rec_size, au_event_t e_type, au_emod_t e_mod); 210155191Srwatsontoken_t *au_to_header32(int rec_size, au_event_t e_type, au_emod_t e_mod); 211159257Srwatsontoken_t *au_to_header64(int rec_size, au_event_t e_type, au_emod_t e_mod); 212186647Srwatsontoken_t *au_to_header32_ex(int rec_size, au_event_t e_type, au_emod_t e_mod); 213155191Srwatson#endif 214155191Srwatson 215155191Srwatsontoken_t *au_to_me(void); 216185573Srwatsontoken_t *au_to_arg(char n, const char *text, uint32_t v); 217185573Srwatsontoken_t *au_to_arg32(char n, const char *text, uint32_t v); 218185573Srwatsontoken_t *au_to_arg64(char n, const char *text, uint64_t v); 219155191Srwatson 220155191Srwatson#if defined(_KERNEL) || defined(KERNEL) 221155191Srwatsontoken_t *au_to_attr(struct vnode_au_info *vni); 222155191Srwatsontoken_t *au_to_attr32(struct vnode_au_info *vni); 223155191Srwatsontoken_t *au_to_attr64(struct vnode_au_info *vni); 224155191Srwatson#endif 225155191Srwatson 226155191Srwatsontoken_t *au_to_data(char unit_print, char unit_type, char unit_count, 227185573Srwatson const char *p); 228155191Srwatsontoken_t *au_to_exit(int retval, int err); 229155191Srwatsontoken_t *au_to_groups(int *groups); 230155191Srwatsontoken_t *au_to_newgroups(uint16_t n, gid_t *groups); 231155191Srwatsontoken_t *au_to_in_addr(struct in_addr *internet_addr); 232155191Srwatsontoken_t *au_to_in_addr_ex(struct in6_addr *internet_addr); 233155191Srwatsontoken_t *au_to_ip(struct ip *ip); 234155191Srwatsontoken_t *au_to_ipc(char type, int id); 235155191Srwatsontoken_t *au_to_ipc_perm(struct ipc_perm *perm); 236155191Srwatsontoken_t *au_to_iport(uint16_t iport); 237185573Srwatsontoken_t *au_to_opaque(const char *data, uint16_t bytes); 238185573Srwatsontoken_t *au_to_path(const char *path); 239243751Srwatsontoken_t *au_to_privset(char *privtypestr, char *privstr); 240155191Srwatsontoken_t *au_to_process(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 241155191Srwatson gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 242155191Srwatsontoken_t *au_to_process32(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 243155191Srwatson gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 244155191Srwatsontoken_t *au_to_process64(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 245155191Srwatson gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 246155191Srwatsontoken_t *au_to_process_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 247155191Srwatson gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 248155191Srwatsontoken_t *au_to_process32_ex(au_id_t auid, uid_t euid, gid_t egid, 249155191Srwatson uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid, 250155191Srwatson au_tid_addr_t *tid); 251155191Srwatsontoken_t *au_to_process64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 252155191Srwatson gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 253255219Spjdtoken_t *au_to_rights(cap_rights_t *rightsp); 254155191Srwatsontoken_t *au_to_return(char status, uint32_t ret); 255155191Srwatsontoken_t *au_to_return32(char status, uint32_t ret); 256155191Srwatsontoken_t *au_to_return64(char status, uint64_t ret); 257155191Srwatsontoken_t *au_to_seq(long audit_count); 258186647Srwatsontoken_t *au_to_socket_ex(u_short so_domain, u_short so_type, 259186647Srwatson struct sockaddr *sa_local, struct sockaddr *sa_remote); 260155191Srwatsontoken_t *au_to_sock_inet(struct sockaddr_in *so); 261155191Srwatsontoken_t *au_to_sock_inet32(struct sockaddr_in *so); 262155191Srwatsontoken_t *au_to_sock_inet128(struct sockaddr_in6 *so); 263155191Srwatsontoken_t *au_to_sock_unix(struct sockaddr_un *so); 264155191Srwatsontoken_t *au_to_subject(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 265155191Srwatson gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 266155191Srwatsontoken_t *au_to_subject32(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 267155191Srwatson gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 268155191Srwatsontoken_t *au_to_subject64(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 269155191Srwatson gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid); 270155191Srwatsontoken_t *au_to_subject_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 271155191Srwatson gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 272155191Srwatsontoken_t *au_to_subject32_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 273155191Srwatson gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 274155191Srwatsontoken_t *au_to_subject64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, 275155191Srwatson gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid); 276161813Swsalamon#if defined(_KERNEL) || defined(KERNEL) 277161813Swsalamontoken_t *au_to_exec_args(char *args, int argc); 278161813Swsalamontoken_t *au_to_exec_env(char *envs, int envc); 279161813Swsalamon#else 280161813Swsalamontoken_t *au_to_exec_args(char **argv); 281161813Swsalamontoken_t *au_to_exec_env(char **envp); 282161813Swsalamon#endif 283185573Srwatsontoken_t *au_to_text(const char *text); 284155191Srwatsontoken_t *au_to_kevent(struct kevent *kev); 285155191Srwatsontoken_t *au_to_trailer(int rec_size); 286243751Srwatsontoken_t *au_to_upriv(char sorf, char *priv); 287185573Srwatsontoken_t *au_to_zonename(const char *zonename); 288155191Srwatson 289186647Srwatson/* 290187214Srwatson * BSM library routines for converting between local and BSM constant spaces. 291186647Srwatson */ 292187214Srwatsonint au_bsm_to_domain(u_short bsm_domain, int *local_domainp); 293186647Srwatsonint au_bsm_to_errno(u_char bsm_error, int *errorp); 294191270Srwatsonint au_bsm_to_fcntl_cmd(u_short bsm_fcntl_cmd, int *local_fcntl_cmdp); 295187214Srwatsonint au_bsm_to_socket_type(u_short bsm_socket_type, 296187214Srwatson int *local_socket_typep); 297187214Srwatsonu_short au_domain_to_bsm(int local_domain); 298187214Srwatsonu_char au_errno_to_bsm(int local_errno); 299191270Srwatsonu_short au_fcntl_cmd_to_bsm(int local_fcntl_command); 300187214Srwatsonu_short au_socket_type_to_bsm(int local_socket_type); 301186647Srwatson 302155191Srwatson__END_DECLS 303155191Srwatson 304155191Srwatson#endif /* ! _BSM_AUDIT_RECORD_H_ */ 305