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 * $FreeBSD$
30 */
31
32 #ifndef _BSM_AUDIT_RECORD_H_
33 #define _BSM_AUDIT_RECORD_H_
34
35 #include <sys/types.h>
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 #define AUT_RIGHTS 0x83
130
131 /* print values for the arbitrary token */
132 #define AUP_BINARY 0
133 #define AUP_OCTAL 1
134 #define AUP_DECIMAL 2
135 #define AUP_HEX 3
136 #define AUP_STRING 4
137
138 /* data-types for the arbitrary token */
139 #define AUR_BYTE 0
140 #define AUR_CHAR AUR_BYTE
141 #define AUR_SHORT 1
142 #define AUR_INT32 2
143 #define AUR_INT AUR_INT32
144 #define AUR_INT64 3
145
146 /* ... and their sizes */
147 #define AUR_BYTE_SIZE sizeof(u_char)
148 #define AUR_CHAR_SIZE AUR_BYTE_SIZE
149 #define AUR_SHORT_SIZE sizeof(uint16_t)
150 #define AUR_INT32_SIZE sizeof(uint32_t)
151 #define AUR_INT_SIZE AUR_INT32_SIZE
152 #define AUR_INT64_SIZE sizeof(uint64_t)
153
154 /* Modifiers for the header token */
155 #define PAD_NOTATTR 0x4000 /* nonattributable event */
156 #define PAD_FAILURE 0x8000 /* fail audit event */
157
158 #define AUDIT_MAX_GROUPS 16
159
160 /*
161 * A number of BSM versions are floating around and defined. Here are
162 * constants for them. OpenBSM uses the same token types, etc, used in the
163 * Solaris BSM version, but has a separate version number in order to
164 * identify a potentially different event identifier name space.
165 */
166 #define AUDIT_HEADER_VERSION_OLDDARWIN 1 /* In retrospect, a mistake. */
167 #define AUDIT_HEADER_VERSION_SOLARIS 2
168 #define AUDIT_HEADER_VERSION_TSOL25 3
169 #define AUDIT_HEADER_VERSION_TSOL 4
170 #define AUDIT_HEADER_VERSION_OPENBSM10 10
171 #define AUDIT_HEADER_VERSION_OPENBSM11 11
172 #define AUDIT_HEADER_VERSION_OPENBSM AUDIT_HEADER_VERSION_OPENBSM11
173
174 #define AUT_TRAILER_MAGIC 0xb105
175
176 /* BSM library calls */
177
178 __BEGIN_DECLS
179
180 struct in_addr;
181 struct in6_addr;
182 struct ip;
183 struct ipc_perm;
184 struct kevent;
185 struct sockaddr;
186 struct sockaddr_in;
187 struct sockaddr_in6;
188 struct sockaddr_un;
189 #if defined(_KERNEL) || defined(KERNEL)
190 struct vnode_au_info;
191 #endif
192
193 #ifndef _CAP_RIGHTS_T_DECLARED
194 #define _CAP_RIGHTS_T_DECLARED
195 struct cap_rights;
196
197 typedef struct cap_rights cap_rights_t;
198 #endif
199
200 int au_open(void);
201 int au_write(int d, token_t *m);
202 int au_close(int d, int keep, short event);
203 int au_close_buffer(int d, short event, u_char *buffer, size_t *buflen);
204 int au_close_token(token_t *tok, u_char *buffer, size_t *buflen);
205
206 token_t *au_to_file(const char *file, struct timeval tm);
207
208 token_t *au_to_header32_tm(int rec_size, au_event_t e_type, au_emod_t e_mod,
209 struct timeval tm);
210 token_t *au_to_header32_ex_tm(int rec_size, au_event_t e_type, au_emod_t e_mod,
211 struct timeval tm, struct auditinfo_addr *aia);
212 token_t *au_to_header64_tm(int rec_size, au_event_t e_type, au_emod_t e_mod,
213 struct timeval tm);
214 #if !defined(KERNEL) && !defined(_KERNEL)
215 token_t *au_to_header(int rec_size, au_event_t e_type, au_emod_t e_mod);
216 token_t *au_to_header_ex(int rec_size, au_event_t e_type, au_emod_t e_mod);
217 token_t *au_to_header32(int rec_size, au_event_t e_type, au_emod_t e_mod);
218 token_t *au_to_header64(int rec_size, au_event_t e_type, au_emod_t e_mod);
219 token_t *au_to_header32_ex(int rec_size, au_event_t e_type, au_emod_t e_mod);
220 #endif
221
222 token_t *au_to_me(void);
223 token_t *au_to_arg(char n, const char *text, uint32_t v);
224 token_t *au_to_arg32(char n, const char *text, uint32_t v);
225 token_t *au_to_arg64(char n, const char *text, uint64_t v);
226
227 #if defined(_KERNEL) || defined(KERNEL)
228 token_t *au_to_attr(struct vnode_au_info *vni);
229 token_t *au_to_attr32(struct vnode_au_info *vni);
230 token_t *au_to_attr64(struct vnode_au_info *vni);
231 #endif
232
233 token_t *au_to_data(char unit_print, char unit_type, char unit_count,
234 const char *p);
235 token_t *au_to_exit(int retval, int err);
236 token_t *au_to_groups(int *groups);
237 token_t *au_to_newgroups(uint16_t n, gid_t *groups);
238 token_t *au_to_in_addr(struct in_addr *internet_addr);
239 token_t *au_to_in_addr_ex(struct in6_addr *internet_addr);
240 token_t *au_to_ip(struct ip *ip);
241 token_t *au_to_ipc(char type, int id);
242 token_t *au_to_ipc_perm(struct ipc_perm *perm);
243 token_t *au_to_iport(uint16_t iport);
244 token_t *au_to_opaque(const char *data, uint16_t bytes);
245 token_t *au_to_path(const char *path);
246 token_t *au_to_privset(char *privtypestr, char *privstr);
247 token_t *au_to_process(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_t *tid);
249 token_t *au_to_process32(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);
251 token_t *au_to_process64(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);
253 token_t *au_to_process_ex(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_addr_t *tid);
255 token_t *au_to_process32_ex(au_id_t auid, uid_t euid, gid_t egid,
256 uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid,
257 au_tid_addr_t *tid);
258 token_t *au_to_process64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
259 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid);
260 token_t *au_to_rights(cap_rights_t *rightsp);
261 token_t *au_to_return(char status, uint32_t ret);
262 token_t *au_to_return32(char status, uint32_t ret);
263 token_t *au_to_return64(char status, uint64_t ret);
264 token_t *au_to_seq(long audit_count);
265 token_t *au_to_socket_ex(u_short so_domain, u_short so_type,
266 struct sockaddr *sa_local, struct sockaddr *sa_remote);
267 token_t *au_to_sock_inet(struct sockaddr_in *so);
268 token_t *au_to_sock_inet32(struct sockaddr_in *so);
269 token_t *au_to_sock_inet128(struct sockaddr_in6 *so);
270 token_t *au_to_sock_unix(struct sockaddr_un *so);
271 token_t *au_to_subject(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
272 gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid);
273 token_t *au_to_subject32(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);
275 token_t *au_to_subject64(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);
277 token_t *au_to_subject_ex(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_addr_t *tid);
279 token_t *au_to_subject32_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);
281 token_t *au_to_subject64_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);
283 #if defined(_KERNEL) || defined(KERNEL)
284 token_t *au_to_exec_args(char *args, int argc);
285 token_t *au_to_exec_env(char *envs, int envc);
286 #else
287 token_t *au_to_exec_args(char **argv);
288 token_t *au_to_exec_env(char **envp);
289 #endif
290 token_t *au_to_text(const char *text);
291 token_t *au_to_kevent(struct kevent *kev);
292 token_t *au_to_trailer(int rec_size);
293 token_t *au_to_upriv(char sorf, char *priv);
294 token_t *au_to_zonename(const char *zonename);
295
296 /*
297 * BSM library routines for converting between local and BSM constant spaces.
298 */
299 int au_bsm_to_domain(u_short bsm_domain, int *local_domainp);
300 int au_bsm_to_errno(u_char bsm_error, int *errorp);
301 int au_bsm_to_fcntl_cmd(u_short bsm_fcntl_cmd, int *local_fcntl_cmdp);
302 int au_bsm_to_socket_type(u_short bsm_socket_type,
303 int *local_socket_typep);
304 u_short au_domain_to_bsm(int local_domain);
305 u_char au_errno_to_bsm(int local_errno);
306 u_short au_fcntl_cmd_to_bsm(int local_fcntl_command);
307 u_short au_socket_type_to_bsm(int local_socket_type);
308
309 __END_DECLS
310
311 #endif /* ! _BSM_AUDIT_RECORD_H_ */
Cache object: 4ad64524ff5fd8f44806296ce6ddb5f1
|