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