1 /*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21 /*
22 * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
24 *
25 * Copyright 2018 Nexenta Systems, Inc. All rights reserved.
26 */
27
28 #ifndef _BSM_AUDIT_RECORD_H
29 #define _BSM_AUDIT_RECORD_H
30
31
32 #ifdef _KERNEL
33 #include <sys/priv.h>
34 #else
35 #include <priv.h>
36 #endif
37 #include <sys/socket.h>
38 #include <sys/acl.h>
39 #include <sys/sid.h>
40
41 #include <sys/tsol/label.h>
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 /*
48 * Version of audit attributes
49 *
50 * OS Release Version Number Comments
51 * ========== ============== ========
52 * SunOS 5.1 2 Unbundled Package
53 * SunOS 5.3 2 Bundled into the base OS
54 * SunOS 5.4-5.x 2
55 * Trusted Solaris 2.5 3 To distinguish potential new tokens
56 * Trusted Solaris 7-8 4 Redefine X tokens that overlap with
57 * SunOS 5.7
58 */
59
60 #define TOKEN_VERSION 2
61
62 /*
63 * Audit record token type codes
64 */
65
66 /*
67 * Control token types
68 */
69
70 #define AUT_INVALID ((char)0x00)
71 #define AUT_OTHER_FILE ((char)0x11)
72 #define AUT_OTHER_FILE32 AUT_OTHER_FILE
73 #define AUT_OHEADER ((char)0x12)
74 #define AUT_TRAILER ((char)0x13)
75 #define AUT_HEADER ((char)0x14)
76 #define AUT_HEADER32 AUT_HEADER
77 #define AUT_HEADER32_EX ((char)0x15)
78 #define AUT_TRAILER_MAGIC ((short)0xB105)
79
80 /*
81 * Data token types
82 */
83
84 #define AUT_FMRI ((char)0x20)
85 #define AUT_DATA ((char)0x21)
86 #define AUT_IPC ((char)0x22)
87 #define AUT_PATH ((char)0x23)
88 #define AUT_SUBJECT ((char)0x24)
89 #define AUT_SUBJECT32 AUT_SUBJECT
90 #define AUT_XATPATH ((char)0x25)
91 #define AUT_PROCESS ((char)0x26)
92 #define AUT_PROCESS32 AUT_PROCESS
93 #define AUT_RETURN ((char)0x27)
94 #define AUT_RETURN32 AUT_RETURN
95 #define AUT_TEXT ((char)0x28)
96 #define AUT_OPAQUE ((char)0x29)
97 #define AUT_IN_ADDR ((char)0x2A)
98 #define AUT_IP ((char)0x2B)
99 #define AUT_IPORT ((char)0x2C)
100 #define AUT_ARG ((char)0x2D)
101 #define AUT_ARG32 AUT_ARG
102 #define AUT_SOCKET ((char)0x2E)
103 #define AUT_SEQ ((char)0x2F)
104 #define AUT_USER ((char)0x36) /* out of order */
105 #define AUT_TID ((char)0x61) /* out of order */
106
107 /*
108 * Modifier token types
109 */
110
111 #define AUT_ACL ((char)0x30)
112 #define AUT_ATTR ((char)0x31)
113 #define AUT_IPC_PERM ((char)0x32)
114 #define AUT_LABEL ((char)0x33)
115 #define AUT_GROUPS ((char)0x34)
116 #define AUT_ACE ((char)0x35)
117 /* 0x37 unused */
118 #define AUT_PRIV ((char)0x38)
119 #define AUT_UPRIV ((char)0x39)
120 #define AUT_LIAISON ((char)0x3A)
121 #define AUT_NEWGROUPS ((char)0x3B)
122 #define AUT_EXEC_ARGS ((char)0x3C)
123 #define AUT_EXEC_ENV ((char)0x3D)
124 #define AUT_ATTR32 ((char)0x3E)
125 #define AUT_UAUTH ((char)0x3F)
126 #define AUT_ZONENAME ((char)0x60) /* out of order */
127 #define AUT_SECFLAGS ((char)0x62) /* out of order */
128
129 /*
130 * X windows token types
131 */
132
133 #define AUT_XATOM ((char)0x40)
134 #define AUT_XOBJ ((char)0x41)
135 #define AUT_XPROTO ((char)0x42)
136 #define AUT_XSELECT ((char)0x43)
137
138 #if TOKEN_VERSION != 3
139 #define AUT_XCOLORMAP ((char)0x44)
140 #define AUT_XCURSOR ((char)0x45)
141 #define AUT_XFONT ((char)0x46)
142 #define AUT_XGC ((char)0x47)
143 #define AUT_XPIXMAP ((char)0x48)
144 #define AUT_XPROPERTY ((char)0x49)
145 #define AUT_XWINDOW ((char)0x4A)
146 #define AUT_XCLIENT ((char)0x4B)
147 #else /* TOKEN_VERSION == 3 */
148 #define AUT_XCOLORMAP ((char)0x74)
149 #define AUT_XCURSOR ((char)0x75)
150 #define AUT_XFONT ((char)0x76)
151 #define AUT_XGC ((char)0x77)
152 #define AUT_XPIXMAP ((char)0x78)
153 #define AUT_XPROPERTY ((char)0x79)
154 #define AUT_XWINDOW ((char)0x7A)
155 #define AUT_XCLIENT ((char)0x7B)
156 #endif /* TOKEN_VERSION != 3 */
157
158 /*
159 * Command token types
160 */
161
162 #define AUT_CMD ((char)0x51)
163 #define AUT_EXIT ((char)0x52)
164
165 /*
166 * Miscellaneous token types
167 */
168
169 #define AUT_HOST ((char)0x70)
170
171 /*
172 * Solaris64 token types
173 */
174
175 #define AUT_ARG64 ((char)0x71)
176 #define AUT_RETURN64 ((char)0x72)
177 #define AUT_ATTR64 ((char)0x73)
178 #define AUT_HEADER64 ((char)0x74)
179 #define AUT_SUBJECT64 ((char)0x75)
180 #define AUT_PROCESS64 ((char)0x77)
181 #define AUT_OTHER_FILE64 ((char)0x78)
182
183 /*
184 * Extended network address token types
185 */
186
187 #define AUT_HEADER64_EX ((char)0x79)
188 #define AUT_SUBJECT32_EX ((char)0x7a)
189 #define AUT_PROCESS32_EX ((char)0x7b)
190 #define AUT_SUBJECT64_EX ((char)0x7c)
191 #define AUT_PROCESS64_EX ((char)0x7d)
192 #define AUT_IN_ADDR_EX ((char)0x7e)
193 #define AUT_SOCKET_EX ((char)0x7f)
194
195 /*
196 * Can't do >= 0x80 because these are chars. 0x16/0x17 seem to be free here,
197 * but who knows if they have historical uses
198 */
199 #define AUT_ACCESS_MASK ((char)0x16)
200 #define AUT_WSID ((char)0x17)
201
202 /*
203 * Audit print suggestion types.
204 */
205
206 #define AUP_BINARY ((char)0)
207 #define AUP_OCTAL ((char)1)
208 #define AUP_DECIMAL ((char)2)
209 #define AUP_HEX ((char)3)
210 #define AUP_STRING ((char)4)
211
212 /*
213 * Audit data member types.
214 */
215
216 #define AUR_BYTE ((char)0)
217 #define AUR_CHAR ((char)0)
218 #define AUR_SHORT ((char)1)
219 #define AUR_INT ((char)2)
220 #define AUR_INT32 ((char)2)
221 #define AUR_INT64 ((char)3)
222
223 /*
224 * Adr structures
225 */
226
227 struct adr_s {
228 char *adr_stream; /* The base of the stream */
229 char *adr_now; /* The location within the stream */
230 };
231
232 typedef struct adr_s adr_t;
233
234
235 #ifdef _KERNEL
236
237 #include <sys/param.h>
238 #include <sys/systm.h> /* for rval */
239 #include <sys/time.h>
240 #include <sys/types.h>
241 #include <sys/vnode.h>
242 #include <sys/mode.h>
243 #include <sys/user.h>
244 #include <sys/session.h>
245 #include <sys/ipc_impl.h>
246 #include <netinet/in_systm.h>
247 #include <netinet/in.h>
248 #include <netinet/ip.h>
249 #include <sys/socket.h>
250 #include <net/route.h>
251 #include <netinet/in_pcb.h>
252
253 /*
254 * au_close flag arguments
255 */
256
257 #define AU_OK 0x1 /* Good audit record */
258 #define AU_DONTBLOCK 0x2 /* Don't block or discard if queue full */
259 #define AU_DEFER 0x4 /* Defer record queueing to syscall end */
260
261 /*
262 * Audit token type is really an au_membuf pointer
263 */
264 typedef au_buff_t token_t;
265 /*
266 * token generation functions
267 */
268 token_t *au_append_token(token_t *, token_t *);
269 token_t *au_set(caddr_t, uint_t);
270
271 void au_free_rec(au_buff_t *);
272
273 #define au_getclr() ((token_t *)au_get_buff())
274 #define au_toss_token(tok) (au_free_rec((au_buff_t *)(tok)))
275
276 token_t *au_to_acl();
277 token_t *au_to_ace();
278 token_t *au_to_access_mask(uint32_t);
279 token_t *au_to_wsid(ksid_t *);
280 token_t *au_to_attr(struct vattr *);
281 token_t *au_to_data(char, char, char, char *);
282 token_t *au_to_header(int, au_event_t, au_emod_t);
283 token_t *au_to_header_ex(int, au_event_t, au_emod_t);
284 token_t *au_to_ipc(char, int);
285 token_t *au_to_ipc_perm(kipc_perm_t *);
286 token_t *au_to_iport(ushort_t);
287 token_t *au_to_in_addr(struct in_addr *);
288 token_t *au_to_in_addr_ex(int32_t *);
289 token_t *au_to_ip(struct ip *);
290 token_t *au_to_groups(const gid_t *, uint_t);
291 token_t *au_to_path(struct audit_path *);
292 token_t *au_to_path_string(const char *);
293 token_t *au_to_seq();
294 token_t *au_to_process(uid_t, gid_t, uid_t, gid_t, pid_t,
295 au_id_t, au_asid_t, const au_tid_addr_t *);
296 token_t *au_to_subject(uid_t, gid_t, uid_t, gid_t, pid_t,
297 au_id_t, au_asid_t, const au_tid_addr_t *);
298 token_t *au_to_return32(int, int32_t);
299 token_t *au_to_return64(int, int64_t);
300 token_t *au_to_text(const char *);
301 /* token_t *au_to_tid(au_generic_tid_t *); no kernel implementation */
302 token_t *au_to_trailer(int);
303 token_t *au_to_uauth(char *);
304 size_t au_zonename_length(zone_t *);
305 token_t *au_to_zonename(size_t, zone_t *);
306 token_t *au_to_arg32(char, char *, uint32_t);
307 token_t *au_to_arg64(char, char *, uint64_t);
308 token_t *au_to_socket_ex(short, short, char *, char *);
309 token_t *au_to_sock_inet(struct sockaddr_in *);
310 token_t *au_to_exec_args(const char *, ssize_t);
311 token_t *au_to_exec_env(const char *, ssize_t);
312 token_t *au_to_label(bslabel_t *);
313 token_t *au_to_privset(const char *, const priv_set_t *, char, int);
314 token_t *au_to_secflags(const char *, secflagset_t);
315
316 void au_uwrite();
317 void au_close(au_kcontext_t *, caddr_t *, int, au_event_t, au_emod_t,
318 timestruc_t *);
319 void au_close_defer(token_t *, int, au_event_t, au_emod_t, timestruc_t *);
320 void au_close_time(au_kcontext_t *, token_t *, int, au_event_t, au_emod_t,
321 timestruc_t *);
322 void au_free_rec(au_buff_t *);
323 void au_write(caddr_t *, token_t *);
324 void au_mem_init(void);
325 void au_zone_setup();
326 void au_enqueue(au_kcontext_t *, au_buff_t *, adr_t *, adr_t *, int, int);
327 int au_doorio(au_kcontext_t *);
328 int au_doormsg(au_kcontext_t *, uint32_t, void *);
329 int au_token_size(token_t *);
330 int au_append_rec(au_buff_t *, au_buff_t *, int);
331 int au_append_buf(const char *, int, au_buff_t *);
332
333 #else /* !_KERNEL */
334
335 #include <limits.h>
336 #include <sys/types.h>
337 #include <sys/vnode.h>
338 #include <netinet/in_systm.h>
339 #include <netinet/in.h>
340 #include <netinet/ip.h>
341 #include <sys/ipc.h>
342
343 struct token_s {
344 struct token_s *tt_next; /* Next in the list */
345 short tt_size; /* Size of data */
346 char *tt_data; /* The data */
347 };
348 typedef struct token_s token_t;
349
350 /*
351 * Old socket structure definition, formerly in <sys/socketvar.h>
352 */
353 struct oldsocket {
354 short so_type; /* generic type, see socket.h */
355 short so_options; /* from socket call, see socket.h */
356 short so_linger; /* time to linger while closing */
357 short so_state; /* internal state flags SS_*, below */
358 struct inpcb *so_pcb; /* protocol control block */
359 struct protosw *so_proto; /* protocol handle */
360 /*
361 * Variables for connection queueing.
362 * Socket where accepts occur is so_head in all subsidiary sockets.
363 * If so_head is 0, socket is not related to an accept.
364 * For head socket so_q0 queues partially completed connections,
365 * while so_q is a queue of connections ready to be accepted.
366 * If a connection is aborted and it has so_head set, then
367 * it has to be pulled out of either so_q0 or so_q.
368 * We allow connections to queue up based on current queue lengths
369 * and limit on number of queued connections for this socket.
370 */
371 struct oldsocket *so_head; /* back pointer to accept socket */
372 struct oldsocket *so_q0; /* queue of partial connections */
373 struct oldsocket *so_q; /* queue of incoming connections */
374 short so_q0len; /* partials on so_q0 */
375 short so_qlen; /* number of connections on so_q */
376 short so_qlimit; /* max number queued connections */
377 short so_timeo; /* connection timeout */
378 ushort_t so_error; /* error affecting connection */
379 short so_pgrp; /* pgrp for signals */
380 ulong_t so_oobmark; /* chars to oob mark */
381 /*
382 * Variables for socket buffering.
383 */
384 struct sockbuf {
385 ulong_t sb_cc; /* actual chars in buffer */
386 ulong_t sb_hiwat; /* max actual char count */
387 ulong_t sb_mbcnt; /* chars of mbufs used */
388 ulong_t sb_mbmax; /* max chars of mbufs to use */
389 ulong_t sb_lowat; /* low water mark (not used yet) */
390 struct mbuf *sb_mb; /* the mbuf chain */
391 struct proc *sb_sel; /* process selecting read/write */
392 short sb_timeo; /* timeout (not used yet) */
393 short sb_flags; /* flags, see below */
394 } so_rcv, so_snd;
395 /*
396 * Hooks for alternative wakeup strategies.
397 * These are used by kernel subsystems wishing to access the socket
398 * abstraction. If so_wupfunc is nonnull, it is called in place of
399 * wakeup any time that wakeup would otherwise be called with an
400 * argument whose value is an address lying within a socket structure.
401 */
402 struct wupalt *so_wupalt;
403 };
404 extern token_t *au_to_arg32(char, char *, uint32_t);
405 extern token_t *au_to_arg64(char, char *, uint64_t);
406 extern token_t *au_to_acl(struct acl *);
407 extern token_t *au_to_attr(struct vattr *);
408 extern token_t *au_to_cmd(uint_t, char **, char **);
409 extern token_t *au_to_data(char, char, char, char *);
410 extern token_t *au_to_exec_args(char **);
411 extern token_t *au_to_exec_env(char **);
412 extern token_t *au_to_exit(int, int);
413 extern token_t *au_to_fmri(char *);
414 extern token_t *au_to_groups(int *);
415 extern token_t *au_to_newgroups(int, gid_t *);
416 extern token_t *au_to_header(au_event_t, au_emod_t);
417 extern token_t *au_to_header_ex(au_event_t, au_emod_t);
418 extern token_t *au_to_in_addr(struct in_addr *);
419 extern token_t *au_to_in_addr_ex(struct in6_addr *);
420 extern token_t *au_to_ipc(char, int);
421 extern token_t *au_to_ipc_perm(struct ipc_perm *);
422 extern token_t *au_to_iport(ushort_t);
423 extern token_t *au_to_me(void);
424 extern token_t *au_to_mylabel(void);
425 extern token_t *au_to_opaque(char *, short);
426 extern token_t *au_to_path(char *);
427 extern token_t *au_to_privset(const char *, const priv_set_t *);
428 extern token_t *au_to_process(au_id_t, uid_t, gid_t, uid_t, gid_t,
429 pid_t, au_asid_t, au_tid_t *);
430 extern token_t *au_to_process_ex(au_id_t, uid_t, gid_t, uid_t, gid_t,
431 pid_t, au_asid_t, au_tid_addr_t *);
432 extern token_t *au_to_return32(char, uint32_t);
433 extern token_t *au_to_return64(char, uint64_t);
434 extern token_t *au_to_seq(int);
435 extern token_t *au_to_label(m_label_t *);
436 extern token_t *au_to_socket(struct oldsocket *);
437 extern token_t *au_to_subject(au_id_t, uid_t, gid_t, uid_t, gid_t,
438 pid_t, au_asid_t, au_tid_t *);
439 extern token_t *au_to_subject_ex(au_id_t, uid_t, gid_t, uid_t, gid_t,
440 pid_t, au_asid_t, au_tid_addr_t *);
441 extern token_t *au_to_text(char *);
442 extern token_t *au_to_tid(au_generic_tid_t *);
443 extern token_t *au_to_trailer(void);
444 extern token_t *au_to_uauth(char *);
445 extern token_t *au_to_upriv(char, char *);
446 extern token_t *au_to_user(uid_t, char *);
447 extern token_t *au_to_xatom(char *);
448 extern token_t *au_to_xselect(char *, char *, char *);
449 extern token_t *au_to_xcolormap(int32_t, uid_t);
450 extern token_t *au_to_xcursor(int32_t, uid_t);
451 extern token_t *au_to_xfont(int32_t, uid_t);
452 extern token_t *au_to_xgc(int32_t, uid_t);
453 extern token_t *au_to_xpixmap(int32_t, uid_t);
454 extern token_t *au_to_xwindow(int32_t, uid_t);
455 extern token_t *au_to_xproperty(int32_t, uid_t, char *);
456 extern token_t *au_to_xclient(uint32_t);
457 extern token_t *au_to_zonename(char *);
458 #endif /* _KERNEL */
459
460 #ifdef _KERNEL
461
462 void adr_char(adr_t *, char *, int);
463 void adr_int32(adr_t *, int32_t *, int);
464 void adr_uint32(adr_t *, uint32_t *, int);
465 void adr_int64(adr_t *, int64_t *, int);
466 void adr_uint64(adr_t *, uint64_t *, int);
467 void adr_short(adr_t *, short *, int);
468 void adr_ushort(adr_t *, ushort_t *, int);
469 void adr_start(adr_t *, char *);
470
471 char *adr_getchar(adr_t *, char *);
472 char *adr_getshort(adr_t *, short *);
473 char *adr_getushort(adr_t *, ushort_t *);
474 char *adr_getint32(adr_t *, int32_t *);
475 char *adr_getuint32(adr_t *, uint32_t *);
476 char *adr_getint64(adr_t *, int64_t *);
477 char *adr_getuint64(adr_t *, uint64_t *);
478
479 int adr_count(adr_t *);
480
481 #endif /* _KERNEL */
482
483 #ifdef __cplusplus
484 }
485 #endif
486
487 #endif /* _BSM_AUDIT_RECORD_H */