2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1999-2009 Apple Inc.
5 * Copyright (c) 2016-2017 Robert N. M. Watson
8 * Portions of this software were developed by BAE Systems, the University of
9 * Cambridge Computer Laboratory, and Memorial University under DARPA/AFRL
10 * contract FA8650-15-C-7558 ("CADETS"), as part of the DARPA Transparent
11 * Computing (TC) research program.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. Neither the name of Apple Inc. ("Apple") nor the names of
22 * its contributors may be used to endorse or promote products derived
23 * from this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
29 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
33 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
34 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
41 * This include file contains function prototypes and type definitions used
42 * within the audit implementation.
45 #ifndef _SECURITY_AUDIT_PRIVATE_H_
46 #define _SECURITY_AUDIT_PRIVATE_H_
49 #error "no user-serviceable parts inside"
52 #include <sys/caprights.h>
54 #include <sys/socket.h>
55 #include <sys/ucred.h>
58 MALLOC_DECLARE(M_AUDITBSM);
59 MALLOC_DECLARE(M_AUDITDATA);
60 MALLOC_DECLARE(M_AUDITPATH);
61 MALLOC_DECLARE(M_AUDITTEXT);
62 MALLOC_DECLARE(M_AUDITGIDSET);
66 * Audit control variables that are usually set/read via system calls and
67 * used to control various aspects of auditing.
69 extern struct au_qctrl audit_qctrl;
70 extern struct audit_fstat audit_fstat;
71 extern struct au_mask audit_nae_mask;
72 extern int audit_panic_on_write_fail;
73 extern int audit_fail_stop;
74 extern int audit_argv;
75 extern int audit_arge;
78 * Success/failure conditions for the conversion of a kernel audit record to
86 * Defines for the kernel audit record k_ar_commit field. Flags are set to
87 * indicate what sort of record it is, and which preselection mechanism
90 #define AR_COMMIT_KERNEL 0x00000001U
91 #define AR_COMMIT_USER 0x00000010U
93 #define AR_PRESELECT_TRAIL 0x00001000U
94 #define AR_PRESELECT_PIPE 0x00002000U
96 #define AR_PRESELECT_USER_TRAIL 0x00004000U
97 #define AR_PRESELECT_USER_PIPE 0x00008000U
99 #define AR_PRESELECT_DTRACE 0x00010000U
102 * Audit data is generated as a stream of struct audit_record structures,
103 * linked by struct kaudit_record, and contain storage for possible audit so
104 * that it will not need to be allocated during the processing of a system
105 * call, both improving efficiency and avoiding sleeping at untimely moments.
106 * This structure is converted to BSM format before being written to disk.
108 struct vnode_au_info {
112 u_int32_t vn_dev; /* XXX dev_t compatibility */
113 long vn_fsid; /* XXX uint64_t compatibility */
114 long vn_fileid; /* XXX ino_t compatibility */
123 struct socket_au_info {
127 in_addr_t so_raddr; /* Remote address if INET socket. */
128 in_addr_t so_laddr; /* Local address if INET socket. */
129 u_short so_rport; /* Remote port. */
130 u_short so_lport; /* Local port. */
134 * The following is used for A_OLDSETQCTRL and AU_OLDGETQCTRL and a 64-bit
138 u_int64_t aq64_hiwater;
139 u_int64_t aq64_lowater;
140 u_int64_t aq64_bufsz;
141 u_int64_t aq64_delay;
142 u_int64_t aq64_minfree;
144 typedef struct au_qctrl64 au_qctrl64_t;
146 union auditon_udata {
154 au_evclass_map_t au_evclass;
156 auditinfo_t au_auinfo;
157 auditpinfo_t au_aupinfo;
158 auditpinfo_addr_t au_aupinfo_addr;
160 au_qctrl64_t au_qctrl64;
163 auditinfo_addr_t au_kau_info;
164 au_evname_map_t au_evname;
167 struct posix_ipc_perm {
173 struct audit_record {
174 /* Audit record header. */
177 int ar_retval; /* value returned to the process */
178 int ar_errno; /* return status of system call */
179 struct timespec ar_starttime;
180 struct timespec ar_endtime;
181 u_int64_t ar_valid_arg; /* Bitmask of valid arguments */
183 /* Audit subject information. */
184 struct xucred ar_subj_cred;
188 uid_t ar_subj_auid; /* Audit user ID */
189 pid_t ar_subj_asid; /* Audit session ID */
191 struct au_tid ar_subj_term;
192 struct au_tid_addr ar_subj_term_addr;
193 struct au_mask ar_subj_amask;
195 /* Operation arguments. */
204 struct au_tid ar_arg_termid;
205 struct au_tid_addr ar_arg_termid_addr;
209 struct groupset ar_arg_groups;
215 int ar_arg_dev; /* XXX dev_t compatibility */
221 char ar_arg_login[MAXLOGNAME];
222 int ar_arg_ctlname[CTL_MAXNAME];
223 struct socket_au_info ar_arg_sockinfo;
227 struct au_mask ar_arg_amask;
228 struct vnode_au_info ar_arg_vnode1;
229 struct vnode_au_info ar_arg_vnode2;
231 int ar_arg_svipc_which;
232 int ar_arg_svipc_cmd;
233 struct ipc_perm ar_arg_svipc_perm;
235 void *ar_arg_svipc_addr;
236 struct posix_ipc_perm ar_arg_pipc_perm;
237 union auditon_udata ar_arg_auditon;
242 int ar_arg_exitstatus;
243 int ar_arg_exitretval;
244 struct sockaddr_storage ar_arg_sockaddr;
245 cap_rights_t ar_arg_rights;
246 uint32_t ar_arg_fcntl_rights;
247 char ar_jailname[MAXHOSTNAMELEN];
251 * Arguments in the audit record are initially not defined; flags are set to
252 * indicate if they are present so they can be included in the audit log
253 * stream only if defined.
255 #define ARG_EUID 0x0000000000000001ULL
256 #define ARG_RUID 0x0000000000000002ULL
257 #define ARG_SUID 0x0000000000000004ULL
258 #define ARG_EGID 0x0000000000000008ULL
259 #define ARG_RGID 0x0000000000000010ULL
260 #define ARG_SGID 0x0000000000000020ULL
261 #define ARG_PID 0x0000000000000040ULL
262 #define ARG_UID 0x0000000000000080ULL
263 #define ARG_AUID 0x0000000000000100ULL
264 #define ARG_GID 0x0000000000000200ULL
265 #define ARG_FD 0x0000000000000400ULL
266 #define ARG_POSIX_IPC_PERM 0x0000000000000800ULL
267 #define ARG_FFLAGS 0x0000000000001000ULL
268 #define ARG_MODE 0x0000000000002000ULL
269 #define ARG_DEV 0x0000000000004000ULL
270 #define ARG_ADDR 0x0000000000008000ULL
271 #define ARG_LEN 0x0000000000010000ULL
272 #define ARG_MASK 0x0000000000020000ULL
273 #define ARG_SIGNUM 0x0000000000040000ULL
274 #define ARG_LOGIN 0x0000000000080000ULL
275 #define ARG_SADDRINET 0x0000000000100000ULL
276 #define ARG_SADDRINET6 0x0000000000200000ULL
277 #define ARG_SADDRUNIX 0x0000000000400000ULL
278 #define ARG_TERMID_ADDR 0x0000000000800000ULL
279 #define ARG_UNUSED2 0x0000000001000000ULL
280 #define ARG_UPATH1 0x0000000002000000ULL
281 #define ARG_UPATH2 0x0000000004000000ULL
282 #define ARG_TEXT 0x0000000008000000ULL
283 #define ARG_VNODE1 0x0000000010000000ULL
284 #define ARG_VNODE2 0x0000000020000000ULL
285 #define ARG_SVIPC_CMD 0x0000000040000000ULL
286 #define ARG_SVIPC_PERM 0x0000000080000000ULL
287 #define ARG_SVIPC_ID 0x0000000100000000ULL
288 #define ARG_SVIPC_ADDR 0x0000000200000000ULL
289 #define ARG_GROUPSET 0x0000000400000000ULL
290 #define ARG_CMD 0x0000000800000000ULL
291 #define ARG_SOCKINFO 0x0000001000000000ULL
292 #define ARG_ASID 0x0000002000000000ULL
293 #define ARG_TERMID 0x0000004000000000ULL
294 #define ARG_AUDITON 0x0000008000000000ULL
295 #define ARG_VALUE 0x0000010000000000ULL
296 #define ARG_AMASK 0x0000020000000000ULL
297 #define ARG_CTLNAME 0x0000040000000000ULL
298 #define ARG_PROCESS 0x0000080000000000ULL
299 #define ARG_MACHPORT1 0x0000100000000000ULL
300 #define ARG_MACHPORT2 0x0000200000000000ULL
301 #define ARG_EXIT 0x0000400000000000ULL
302 #define ARG_IOVECSTR 0x0000800000000000ULL
303 #define ARG_ARGV 0x0001000000000000ULL
304 #define ARG_ENVV 0x0002000000000000ULL
305 #define ARG_ATFD1 0x0004000000000000ULL
306 #define ARG_ATFD2 0x0008000000000000ULL
307 #define ARG_RIGHTS 0x0010000000000000ULL
308 #define ARG_FCNTL_RIGHTS 0x0020000000000000ULL
309 #define ARG_SVIPC_WHICH 0x0200000000000000ULL
310 #define ARG_NONE 0x0000000000000000ULL
311 #define ARG_ALL 0xFFFFFFFFFFFFFFFFULL
313 #define ARG_IS_VALID(kar, arg) ((kar)->k_ar.ar_valid_arg & (arg))
314 #define ARG_SET_VALID(kar, arg) do { \
315 (kar)->k_ar.ar_valid_arg |= (arg); \
317 #define ARG_CLEAR_VALID(kar, arg) do { \
318 (kar)->k_ar.ar_valid_arg &= ~(arg); \
322 * In-kernel version of audit record; the basic record plus queue meta-data.
323 * This record can also have a pointer set to some opaque data that will be
324 * passed through to the audit writing mechanism.
326 struct kaudit_record {
327 struct audit_record k_ar;
328 u_int32_t k_ar_commit;
329 void *k_udata; /* User data. */
330 u_int k_ulen; /* User data length. */
331 struct uthread *k_uthread; /* Audited thread. */
332 void *k_dtaudit_state;
333 TAILQ_ENTRY(kaudit_record) k_q;
335 TAILQ_HEAD(kaudit_queue, kaudit_record);
338 * Functions to manage the allocation, release, and commit of kernel audit
341 void audit_abort(struct kaudit_record *ar);
342 void audit_commit(struct kaudit_record *ar, int error,
344 struct kaudit_record *audit_new(int event, struct thread *td);
347 * Functions relating to the conversion of internal kernel audit records to
348 * the BSM file format.
351 int kaudit_to_bsm(struct kaudit_record *kar, struct au_record **pau);
352 int bsm_rec_verify(void *rec);
355 * Kernel versions of the libbsm audit record functions.
357 void kau_free(struct au_record *rec);
361 * Return values for pre-selection and post-selection decisions.
363 #define AU_PRS_SUCCESS 1
364 #define AU_PRS_FAILURE 2
365 #define AU_PRS_BOTH (AU_PRS_SUCCESS|AU_PRS_FAILURE)
368 * Data structures relating to the kernel audit queue. Ideally, these might
369 * be abstracted so that only accessor methods are exposed.
371 extern struct mtx audit_mtx;
372 extern struct cv audit_watermark_cv;
373 extern struct cv audit_worker_cv;
374 extern struct kaudit_queue audit_q;
375 extern int audit_q_len;
376 extern int audit_pre_q_len;
377 extern int audit_in_failure;
380 * Flags to use on audit files when opening and closing.
382 #define AUDIT_OPEN_FLAGS (FWRITE | O_APPEND)
383 #define AUDIT_CLOSE_FLAGS (FWRITE | O_APPEND)
386 * Audit event-to-name mapping structure, maintained in audit_bsm_klib.c. It
387 * appears in this header so that the DTrace audit provider can dereference
388 * instances passed back in the au_evname_foreach() callbacks. Safe access to
389 * its fields requires holding ene_lock (after it is visible in the global
393 * (c) - Constant after inserted in the global table
394 * (l) - Protected by ene_lock
395 * (m) - Protected by evnamemap_lock (audit_bsm_klib.c)
396 * (M) - Writes protected by evnamemap_lock; reads unprotected.
399 au_event_t ene_event; /* (c) */
400 char ene_name[EVNAMEMAP_NAME_SIZE]; /* (l) */
401 LIST_ENTRY(evname_elem) ene_entry; /* (m) */
404 /* DTrace probe IDs; 0 if not yet registered. */
405 uint32_t ene_commit_probe_id; /* (M) */
406 uint32_t ene_bsm_probe_id; /* (M) */
408 /* Flags indicating if the probes enabled or not. */
409 int ene_commit_probe_enabled; /* (M) */
410 int ene_bsm_probe_enabled; /* (M) */
413 #define EVNAME_LOCK(ene) mtx_lock(&(ene)->ene_lock)
414 #define EVNAME_UNLOCK(ene) mtx_unlock(&(ene)->ene_lock)
417 * Callback function typedef for the same.
419 typedef void (*au_evnamemap_callback_t)(struct evname_elem *ene);
422 * DTrace audit provider (dtaudit) hooks -- to be set non-NULL when the audit
423 * provider is loaded and ready to be called into.
425 extern void *(*dtaudit_hook_preselect)(au_id_t auid, au_event_t event,
427 extern int (*dtaudit_hook_commit)(struct kaudit_record *kar,
428 au_id_t auid, au_event_t event, au_class_t class,
430 extern void (*dtaudit_hook_bsm)(struct kaudit_record *kar, au_id_t auid,
431 au_event_t event, au_class_t class, int sorf,
432 void *bsm_data, size_t bsm_len);
434 #include <sys/fcntl.h>
435 #include <sys/kernel.h>
436 #include <sys/malloc.h>
439 * Some of the BSM tokenizer functions take different parameters in the
440 * kernel implementations in order to save the copying of large kernel data
441 * structures. The prototypes of these functions are declared here.
443 token_t *kau_to_socket(struct socket_au_info *soi);
446 * audit_klib prototypes
448 int au_preselect(au_event_t event, au_class_t class,
449 au_mask_t *mask_p, int sorf);
450 void au_evclassmap_init(void);
451 void au_evclassmap_insert(au_event_t event, au_class_t class);
452 au_class_t au_event_class(au_event_t event);
453 void au_evnamemap_init(void);
454 void au_evnamemap_insert(au_event_t event, const char *name);
455 void au_evnamemap_foreach(au_evnamemap_callback_t callback);
456 struct evname_elem *au_evnamemap_lookup(au_event_t event);
457 int au_event_name(au_event_t event, char *name);
458 au_event_t audit_ctlname_to_sysctlevent(int name[], uint64_t valid_arg);
459 au_event_t audit_flags_and_error_to_openevent(int oflags, int error);
460 au_event_t audit_flags_and_error_to_openatevent(int oflags, int error);
461 au_event_t audit_msgctl_to_event(int cmd);
462 au_event_t audit_msgsys_to_event(int which);
463 au_event_t audit_semctl_to_event(int cmd);
464 au_event_t audit_semsys_to_event(int which);
465 au_event_t audit_shmsys_to_event(int which);
466 void audit_canon_path(struct thread *td, int dirfd, char *path,
468 au_event_t auditon_command_event(int cmd);
471 * Audit trigger events notify user space of kernel audit conditions
474 void audit_trigger_init(void);
475 int audit_send_trigger(unsigned int trigger);
478 * Accessor functions to manage global audit state.
480 void audit_set_kinfo(struct auditinfo_addr *);
481 void audit_get_kinfo(struct auditinfo_addr *);
484 * General audit related functions.
486 struct kaudit_record *currecord(void);
487 void audit_free(struct kaudit_record *ar);
488 void audit_shutdown(void *arg, int howto);
489 void audit_rotate_vnode(struct ucred *cred,
491 void audit_worker_init(void);
494 * Audit pipe functions.
496 int audit_pipe_preselect(au_id_t auid, au_event_t event,
497 au_class_t class, int sorf, int trail_select);
498 void audit_pipe_submit(au_id_t auid, au_event_t event, au_class_t class,
499 int sorf, int trail_select, void *record, u_int record_len);
500 void audit_pipe_submit_user(void *record, u_int record_len);
502 #endif /* ! _SECURITY_AUDIT_PRIVATE_H_ */