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