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