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#10 $
30 */
31
32#ifndef _BSM_AUDIT_RECORD_H_
33#define _BSM_AUDIT_RECORD_H_
34
35#include <bsm/audit.h> /* token_t */
36#include <sys/time.h> /* struct timeval */
37
38/*
39 * Token type identifiers.
40 */
41#define AUT_INVALID 0x00
42#define AUT_OTHER_FILE32 0x11
43#define AUT_OHEADER 0x12
44#define AUT_TRAILER 0x13
45#define AUT_HEADER32 0x14
46#define AUT_HEADER32_EX 0x15
47#define AUT_DATA 0x21
48#define AUT_IPC 0x22
49#define AUT_PATH 0x23
50#define AUT_SUBJECT32 0x24
51#define AUT_XATPATH 0x25
52#define AUT_PROCESS32 0x26
53#define AUT_RETURN32 0x27
54#define AUT_TEXT 0x28
55#define AUT_OPAQUE 0x29
56#define AUT_IN_ADDR 0x2a
57#define AUT_IP 0x2b
58#define AUT_IPORT 0x2c
59#define AUT_ARG32 0x2d
60#define AUT_SOCKET 0x2e
61#define AUT_SEQ 0x2f
62#define AUT_ACL 0x30
63#define AUT_ATTR 0x31
64#define AUT_IPC_PERM 0x32
65#define AUT_LABEL 0x33
66#define AUT_GROUPS 0x34
67#define AUT_ACE 0x35
68#define AUT_PRIV 0x38
69#define AUT_UPRIV 0x39
70#define AUT_LIAISON 0x3a
71#define AUT_NEWGROUPS 0x3b
72#define AUT_EXEC_ARGS 0x3c
73#define AUT_EXEC_ENV 0x3d
74#define AUT_ATTR32 0x3e
75#define AUT_UNAUTH 0x3f
76#define AUT_XATOM 0x40
77#define AUT_XOBJ 0x41
78#define AUT_XPROTO 0x42
79#define AUT_XSELECT 0x43
80#define AUT_XCOLORMAP 0x44
81#define AUT_XCURSOR 0x45
82#define AUT_XFONT 0x46
83#define AUT_XGC 0x47
84#define AUT_XPIXMAP 0x48
85#define AUT_XPROPERTY 0x49
86#define AUT_XWINDOW 0x4a
87#define AUT_XCLIENT 0x4b
88#define AUT_CMD 0x51
89#define AUT_EXIT 0x52
90#define AUT_ZONENAME 0x60
91#define AUT_HOST 0x70
92#define AUT_ARG64 0x71
93#define AUT_RETURN64 0x72
94#define AUT_ATTR64 0x73
95#define AUT_HEADER64 0x74
96#define AUT_SUBJECT64 0x75
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_PROCESS AUT_PROCESS32
116#define AUT_OTHER_FILE AUT_OTHER_FILE32
117
118/*
119 * The values for the following token ids are not defined by BSM.
120 *
121 * XXXRW: Not sure how to handle these in OpenBSM yet, but I'll give them
122 * names more consistent with Sun's BSM. These originally came from Apple's
123 * BSM.
124 */
125#define AUT_SOCKINET32 0x80 /* XXX */
126#define AUT_SOCKINET128 0x81 /* XXX */
127#define AUT_SOCKUNIX 0x82 /* XXX */
128
129/* Apple specific tokens*/
130#define AUT_IDENTITY 0xed
131#define AUT_KRB5_PRINCIPAL 0xee
132#define AUT_CERT_HASH 0xef
133
134/* print values for the arbitrary token */
135#define AUP_BINARY 0
136#define AUP_OCTAL 1
137#define AUP_DECIMAL 2
138#define AUP_HEX 3
139#define AUP_STRING 4
140
141/* data-types for the arbitrary token */
142#define AUR_BYTE 0
143#define AUR_CHAR AUR_BYTE
144#define AUR_SHORT 1
145#define AUR_INT32 2
146#define AUR_INT AUR_INT32
147#define AUR_INT64 3
148
149/* ... and their sizes */
150#define AUR_BYTE_SIZE sizeof(u_char)
151#define AUR_CHAR_SIZE AUR_BYTE_SIZE
152#define AUR_SHORT_SIZE sizeof(uint16_t)
153#define AUR_INT32_SIZE sizeof(uint32_t)
154#define AUR_INT_SIZE AUR_INT32_SIZE
155#define AUR_INT64_SIZE sizeof(uint64_t)
156
157/* Modifiers for the header token */
158#define PAD_NOTATTR 0x4000 /* nonattributable event */
159#define PAD_FAILURE 0x8000 /* fail audit event */
160
161#define AUDIT_MAX_GROUPS 16
162
163/*
164 * A number of BSM versions are floating around and defined. Here are
165 * constants for them. OpenBSM uses the same token types, etc, used in the
166 * Solaris BSM version, but has a separate version number in order to
167 * identify a potentially different event identifier name space.
168 */
169#define AUDIT_HEADER_VERSION_OLDDARWIN 1 /* In retrospect, a mistake. */
170#define AUDIT_HEADER_VERSION_SOLARIS 2
171#define AUDIT_HEADER_VERSION_TSOL25 3
172#define AUDIT_HEADER_VERSION_TSOL 4
173#define AUDIT_HEADER_VERSION_OPENBSM10 10
174#define AUDIT_HEADER_VERSION_OPENBSM11 11
175#define AUDIT_HEADER_VERSION_OPENBSM AUDIT_HEADER_VERSION_OPENBSM11
176
177#define AUT_TRAILER_MAGIC 0xb105
178
179#if !defined(_KERNEL) && !defined(KERNEL)
180#include <Availability.h>
181#define __AUDIT_API_DEPRECATED __API_DEPRECATED("audit is deprecated", macos(10.4, 10.16))
182#define __AUDIT_API_14_DEPRECATED __API_DEPRECATED("audit is deprecated", macos(10.14, 10.16))
183#else
184#define __AUDIT_API_DEPRECATED
185#define __AUDIT_API_14_DEPRECATED
186#endif
187
188/* BSM library calls */
189
190__BEGIN_DECLS
191
192struct in_addr;
193struct in6_addr;
194struct ip;
195struct ipc_perm;
196struct kevent;
197struct sockaddr;
198struct sockaddr_in;
199struct sockaddr_in6;
200struct sockaddr_un;
201#if defined(_KERNEL) || defined(KERNEL)
202struct vnode_au_info;
203#endif
204
205int au_open(void)
206__AUDIT_API_DEPRECATED;
207int au_write(int d, token_t *m)
208__AUDIT_API_DEPRECATED;
209int au_close(int d, int keep, short event)
210__AUDIT_API_DEPRECATED;
211int au_close_buffer(int d, short event, u_char *buffer, size_t *buflen)
212__AUDIT_API_DEPRECATED;
213int au_close_token(token_t *tok, u_char *buffer, size_t *buflen)
214__AUDIT_API_DEPRECATED;
215
216token_t *au_to_file(const char *file, struct timeval tm)
217__AUDIT_API_DEPRECATED;
218
219token_t *au_to_header32_tm(int rec_size, au_event_t e_type, au_emod_t e_mod,
220 struct timeval tm)
221__AUDIT_API_DEPRECATED;
222token_t *au_to_header32_ex_tm(int rec_size, au_event_t e_type, au_emod_t e_mod,
223 struct timeval tm, struct auditinfo_addr *aia)
224__AUDIT_API_DEPRECATED;
225token_t *au_to_header64_tm(int rec_size, au_event_t e_type, au_emod_t e_mod,
226 struct timeval tm)
227__AUDIT_API_DEPRECATED;
228#if !defined(KERNEL) && !defined(_KERNEL)
229token_t *au_to_header(int rec_size, au_event_t e_type, au_emod_t e_mod)
230__AUDIT_API_DEPRECATED;
231token_t *au_to_header_ex(int rec_size, au_event_t e_type, au_emod_t e_mod)
232__AUDIT_API_DEPRECATED;
233token_t *au_to_header32(int rec_size, au_event_t e_type, au_emod_t e_mod)
234__AUDIT_API_DEPRECATED;
235token_t *au_to_header64(int rec_size, au_event_t e_type, au_emod_t e_mod)
236__AUDIT_API_DEPRECATED;
237token_t *au_to_header32_ex(int rec_size, au_event_t e_type, au_emod_t e_mod)
238__AUDIT_API_DEPRECATED;
239#endif
240
241token_t *au_to_me(void)
242__AUDIT_API_DEPRECATED;
243token_t *au_to_arg(char n, const char *text, uint32_t v)
244__AUDIT_API_DEPRECATED;
245token_t *au_to_arg32(char n, const char *text, uint32_t v)
246__AUDIT_API_DEPRECATED;
247token_t *au_to_arg64(char n, const char *text, uint64_t v)
248__AUDIT_API_DEPRECATED;
249
250#if defined(_KERNEL) || defined(KERNEL)
251token_t *au_to_attr(struct vnode_au_info *vni)
252__AUDIT_API_DEPRECATED;
253token_t *au_to_attr32(struct vnode_au_info *vni)
254__AUDIT_API_DEPRECATED;
255token_t *au_to_attr64(struct vnode_au_info *vni)
256__AUDIT_API_DEPRECATED;
257#endif
258
259token_t *au_to_data(char unit_print, char unit_type, char unit_count,
260 const char *p)
261__AUDIT_API_DEPRECATED;
262token_t *au_to_exit(int retval, int err)
263__AUDIT_API_DEPRECATED;
264token_t *au_to_groups(int *groups)
265__AUDIT_API_DEPRECATED;
266token_t *au_to_newgroups(uint16_t n, gid_t *groups)
267__AUDIT_API_DEPRECATED;
268token_t *au_to_in_addr(struct in_addr *internet_addr)
269__AUDIT_API_DEPRECATED;
270token_t *au_to_in_addr_ex(struct in6_addr *internet_addr)
271__AUDIT_API_DEPRECATED;
272token_t *au_to_ip(struct ip *ip)
273__AUDIT_API_DEPRECATED;
274token_t *au_to_ipc(char type, int id)
275__AUDIT_API_DEPRECATED;
276token_t *au_to_ipc_perm(struct ipc_perm *perm)
277__AUDIT_API_DEPRECATED;
278token_t *au_to_iport(uint16_t iport)
279__AUDIT_API_DEPRECATED;
280token_t *au_to_opaque(const char *data, uint16_t bytes)
281__AUDIT_API_DEPRECATED;
282token_t *au_to_path(const char *path)
283__AUDIT_API_DEPRECATED;
284token_t *au_to_process(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
285 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid)
286__AUDIT_API_DEPRECATED;
287token_t *au_to_process32(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)
289__AUDIT_API_DEPRECATED;
290token_t *au_to_process64(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
291 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid)
292__AUDIT_API_DEPRECATED;
293token_t *au_to_process_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
294 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid)
295__AUDIT_API_DEPRECATED;
296token_t *au_to_process32_ex(au_id_t auid, uid_t euid, gid_t egid,
297 uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid,
298 au_tid_addr_t *tid)
299__AUDIT_API_DEPRECATED;
300token_t *au_to_process64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
301 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid)
302__AUDIT_API_DEPRECATED;
303token_t *au_to_return(char status, uint32_t ret)
304__AUDIT_API_DEPRECATED;
305token_t *au_to_return32(char status, uint32_t ret)
306__AUDIT_API_DEPRECATED;
307token_t *au_to_return64(char status, uint64_t ret)
308__AUDIT_API_DEPRECATED;
309token_t *au_to_seq(long audit_count)
310__AUDIT_API_DEPRECATED;
311token_t *au_to_socket_ex(u_short so_domain, u_short so_type,
312 struct sockaddr *sa_local, struct sockaddr *sa_remote)
313__AUDIT_API_DEPRECATED;
314token_t *au_to_sock_inet(struct sockaddr_in *so)
315__AUDIT_API_DEPRECATED;
316token_t *au_to_sock_inet32(struct sockaddr_in *so)
317__AUDIT_API_DEPRECATED;
318token_t *au_to_sock_inet128(struct sockaddr_in6 *so)
319__AUDIT_API_DEPRECATED;
320token_t *au_to_sock_unix(struct sockaddr_un *so)
321__AUDIT_API_DEPRECATED;
322token_t *au_to_subject(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
323 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid)
324__AUDIT_API_DEPRECATED;
325token_t *au_to_subject32(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
326 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid)
327__AUDIT_API_DEPRECATED;
328token_t *au_to_subject64(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
329 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid)
330__AUDIT_API_DEPRECATED;
331token_t *au_to_subject_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
332 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid)
333__AUDIT_API_DEPRECATED;
334token_t *au_to_subject32_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
335 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid)
336__AUDIT_API_DEPRECATED;
337token_t *au_to_subject64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
338 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid)
339__AUDIT_API_DEPRECATED;
340#if defined(_KERNEL) || defined(KERNEL)
341token_t *au_to_exec_args(char *args, int argc)
342__AUDIT_API_DEPRECATED;
343token_t *au_to_exec_env(char *envs, int envc)
344__AUDIT_API_DEPRECATED;
345token_t *au_to_certificate_hash(char *hash, int hashc)
346__AUDIT_API_14_DEPRECATED;
347token_t *au_to_krb5_principal(char *principal, int princ)
348__AUDIT_API_14_DEPRECATED;
349#else
350token_t *au_to_exec_args(char **argv)
351__AUDIT_API_DEPRECATED;
352token_t *au_to_exec_env(char **envp)
353__AUDIT_API_DEPRECATED;
354token_t *au_to_certificate_hash(char **hash)
355__AUDIT_API_14_DEPRECATED;
356token_t *au_to_krb5_principal(char **principal)
357__AUDIT_API_14_DEPRECATED;
358#endif
359token_t *au_to_text(const char *text)
360__AUDIT_API_DEPRECATED;
361token_t *au_to_kevent(struct kevent *kev)
362__AUDIT_API_DEPRECATED;
363token_t *au_to_trailer(int rec_size)
364__AUDIT_API_DEPRECATED;
365token_t *au_to_zonename(const char *zonename)
366__AUDIT_API_DEPRECATED;
367token_t *au_to_identity(uint32_t signer_type, const char* signing_id,
368 u_char signing_id_trunc, const char* team_id, u_char team_id_trunc,
369 uint8_t* cdhash, uint16_t cdhash_len)
370__AUDIT_API_14_DEPRECATED;
371
372/*
373 * BSM library routines for converting between local and BSM constant spaces.
374 */
375int au_bsm_to_domain(u_short bsm_domain, int *local_domainp)
376__AUDIT_API_DEPRECATED;
377int au_bsm_to_errno(u_char bsm_error, int *errorp)
378__AUDIT_API_DEPRECATED;
379int au_bsm_to_fcntl_cmd(u_short bsm_fcntl_cmd, int *local_fcntl_cmdp)
380__AUDIT_API_DEPRECATED;
381int au_bsm_to_socket_type(u_short bsm_socket_type,
382 int *local_socket_typep)
383__AUDIT_API_DEPRECATED;
384u_short au_domain_to_bsm(int local_domain)
385__AUDIT_API_DEPRECATED;
386u_char au_errno_to_bsm(int local_errno)
387__AUDIT_API_DEPRECATED;
388u_short au_fcntl_cmd_to_bsm(int local_fcntl_command)
389__AUDIT_API_DEPRECATED;
390u_short au_socket_type_to_bsm(int local_socket_type)
391__AUDIT_API_DEPRECATED;
392
393__END_DECLS
394
395#endif /* ! _BSM_AUDIT_RECORD_H_ */
396