audit_private.h revision 191270
1/*- 2 * Copyright (c) 1999-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 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of Apple Inc. ("Apple") nor the names of 14 * its contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR 21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 25 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 27 * POSSIBILITY OF SUCH DAMAGE. 28 * 29 * $FreeBSD: head/sys/security/audit/audit_private.h 191270 2009-04-19 14:53:17Z rwatson $ 30 */ 31 32/* 33 * This include file contains function prototypes and type definitions used 34 * within the audit implementation. 35 */ 36 37#ifndef _SECURITY_AUDIT_PRIVATE_H_ 38#define _SECURITY_AUDIT_PRIVATE_H_ 39 40#ifndef _KERNEL 41#error "no user-serviceable parts inside" 42#endif 43 44#include <sys/ipc.h> 45#include <sys/socket.h> 46#include <sys/ucred.h> 47 48#ifdef MALLOC_DECLARE 49MALLOC_DECLARE(M_AUDITBSM); 50MALLOC_DECLARE(M_AUDITDATA); 51MALLOC_DECLARE(M_AUDITPATH); 52MALLOC_DECLARE(M_AUDITTEXT); 53#endif 54 55/* 56 * Audit control variables that are usually set/read via system calls and 57 * used to control various aspects of auditing. 58 */ 59extern struct au_qctrl audit_qctrl; 60extern struct audit_fstat audit_fstat; 61extern struct au_mask audit_nae_mask; 62extern int audit_panic_on_write_fail; 63extern int audit_fail_stop; 64extern int audit_argv; 65extern int audit_arge; 66 67/* 68 * Success/failure conditions for the conversion of a kernel audit record to 69 * BSM format. 70 */ 71#define BSM_SUCCESS 0 72#define BSM_FAILURE 1 73#define BSM_NOAUDIT 2 74 75/* 76 * Defines for the kernel audit record k_ar_commit field. Flags are set to 77 * indicate what sort of record it is, and which preselection mechanism 78 * selected it. 79 */ 80#define AR_COMMIT_KERNEL 0x00000001U 81#define AR_COMMIT_USER 0x00000010U 82 83#define AR_PRESELECT_TRAIL 0x00001000U 84#define AR_PRESELECT_PIPE 0x00002000U 85 86#define AR_PRESELECT_USER_TRAIL 0x00004000U 87#define AR_PRESELECT_USER_PIPE 0x00008000U 88 89/* 90 * Audit data is generated as a stream of struct audit_record structures, 91 * linked by struct kaudit_record, and contain storage for possible audit so 92 * that it will not need to be allocated during the processing of a system 93 * call, both improving efficiency and avoiding sleeping at untimely moments. 94 * This structure is converted to BSM format before being written to disk. 95 */ 96struct vnode_au_info { 97 mode_t vn_mode; 98 uid_t vn_uid; 99 gid_t vn_gid; 100 dev_t vn_dev; 101 long vn_fsid; 102 long vn_fileid; 103 long vn_gen; 104}; 105 106struct groupset { 107 gid_t gidset[NGROUPS]; 108 u_int gidset_size; 109}; 110 111struct socket_au_info { 112 int so_domain; 113 int so_type; 114 int so_protocol; 115 in_addr_t so_raddr; /* Remote address if INET socket. */ 116 in_addr_t so_laddr; /* Local address if INET socket. */ 117 u_short so_rport; /* Remote port. */ 118 u_short so_lport; /* Local port. */ 119}; 120 121/* 122 * The following is used for A_OLDSETQCTRL and AU_OLDGETQCTRL and a 64-bit 123 * userland. 124 */ 125struct au_qctrl64 { 126 u_int64_t aq64_hiwater; 127 u_int64_t aq64_lowater; 128 u_int64_t aq64_bufsz; 129 u_int64_t aq64_delay; 130 u_int64_t aq64_minfree; 131}; 132typedef struct au_qctrl64 au_qctrl64_t; 133 134union auditon_udata { 135 char *au_path; 136 int au_cond; 137 int au_flags; 138 int au_policy; 139 int au_trigger; 140 int64_t au_cond64; 141 int64_t au_policy64; 142 au_evclass_map_t au_evclass; 143 au_mask_t au_mask; 144 auditinfo_t au_auinfo; 145 auditpinfo_t au_aupinfo; 146 auditpinfo_addr_t au_aupinfo_addr; 147 au_qctrl_t au_qctrl; 148 au_qctrl64_t au_qctrl64; 149 au_stat_t au_stat; 150 au_fstat_t au_fstat; 151 auditinfo_addr_t au_kau_info; 152}; 153 154struct posix_ipc_perm { 155 uid_t pipc_uid; 156 gid_t pipc_gid; 157 mode_t pipc_mode; 158}; 159 160struct audit_record { 161 /* Audit record header. */ 162 u_int32_t ar_magic; 163 int ar_event; 164 int ar_retval; /* value returned to the process */ 165 int ar_errno; /* return status of system call */ 166 struct timespec ar_starttime; 167 struct timespec ar_endtime; 168 u_int64_t ar_valid_arg; /* Bitmask of valid arguments */ 169 170 /* Audit subject information. */ 171 struct xucred ar_subj_cred; 172 uid_t ar_subj_ruid; 173 gid_t ar_subj_rgid; 174 gid_t ar_subj_egid; 175 uid_t ar_subj_auid; /* Audit user ID */ 176 pid_t ar_subj_asid; /* Audit session ID */ 177 pid_t ar_subj_pid; 178 struct au_tid ar_subj_term; 179 struct au_tid_addr ar_subj_term_addr; 180 struct au_mask ar_subj_amask; 181 182 /* Operation arguments. */ 183 uid_t ar_arg_euid; 184 uid_t ar_arg_ruid; 185 uid_t ar_arg_suid; 186 gid_t ar_arg_egid; 187 gid_t ar_arg_rgid; 188 gid_t ar_arg_sgid; 189 pid_t ar_arg_pid; 190 pid_t ar_arg_asid; 191 struct au_tid ar_arg_termid; 192 struct au_tid_addr ar_arg_termid_addr; 193 uid_t ar_arg_uid; 194 uid_t ar_arg_auid; 195 gid_t ar_arg_gid; 196 struct groupset ar_arg_groups; 197 int ar_arg_fd; 198 int ar_arg_fflags; 199 mode_t ar_arg_mode; 200 int ar_arg_dev; 201 long ar_arg_value; 202 void * ar_arg_addr; 203 int ar_arg_len; 204 int ar_arg_mask; 205 u_int ar_arg_signum; 206 char ar_arg_login[MAXLOGNAME]; 207 int ar_arg_ctlname[CTL_MAXNAME]; 208 struct socket_au_info ar_arg_sockinfo; 209 char *ar_arg_upath1; 210 char *ar_arg_upath2; 211 char *ar_arg_text; 212 struct au_mask ar_arg_amask; 213 struct vnode_au_info ar_arg_vnode1; 214 struct vnode_au_info ar_arg_vnode2; 215 int ar_arg_cmd; 216 int ar_arg_svipc_cmd; 217 struct ipc_perm ar_arg_svipc_perm; 218 int ar_arg_svipc_id; 219 void * ar_arg_svipc_addr; 220 struct posix_ipc_perm ar_arg_pipc_perm; 221 union auditon_udata ar_arg_auditon; 222 char *ar_arg_argv; 223 int ar_arg_argc; 224 char *ar_arg_envv; 225 int ar_arg_envc; 226 int ar_arg_exitstatus; 227 int ar_arg_exitretval; 228 struct sockaddr_storage ar_arg_sockaddr; 229}; 230 231/* 232 * Arguments in the audit record are initially not defined; flags are set to 233 * indicate if they are present so they can be included in the audit log 234 * stream only if defined. 235 */ 236#define ARG_IS_VALID(kar, arg) ((kar)->k_ar.ar_valid_arg & (arg)) 237#define ARG_SET_VALID(kar, arg) do { \ 238 (kar)->k_ar.ar_valid_arg |= (arg); \ 239} while (0) 240 241/* 242 * In-kernel version of audit record; the basic record plus queue meta-data. 243 * This record can also have a pointer set to some opaque data that will be 244 * passed through to the audit writing mechanism. 245 */ 246struct kaudit_record { 247 struct audit_record k_ar; 248 u_int32_t k_ar_commit; 249 void *k_udata; /* User data. */ 250 u_int k_ulen; /* User data length. */ 251 struct uthread *k_uthread; /* Audited thread. */ 252 TAILQ_ENTRY(kaudit_record) k_q; 253}; 254TAILQ_HEAD(kaudit_queue, kaudit_record); 255 256/* 257 * Functions to manage the allocation, release, and commit of kernel audit 258 * records. 259 */ 260void audit_abort(struct kaudit_record *ar); 261void audit_commit(struct kaudit_record *ar, int error, 262 int retval); 263struct kaudit_record *audit_new(int event, struct thread *td); 264 265/* 266 * Functions relating to the conversion of internal kernel audit records to 267 * the BSM file format. 268 */ 269struct au_record; 270int kaudit_to_bsm(struct kaudit_record *kar, struct au_record **pau); 271int bsm_rec_verify(void *rec); 272 273/* 274 * Kernel versions of the libbsm audit record functions. 275 */ 276void kau_free(struct au_record *rec); 277void kau_init(void); 278 279/* 280 * Return values for pre-selection and post-selection decisions. 281 */ 282#define AU_PRS_SUCCESS 1 283#define AU_PRS_FAILURE 2 284#define AU_PRS_BOTH (AU_PRS_SUCCESS|AU_PRS_FAILURE) 285 286/* 287 * Data structures relating to the kernel audit queue. Ideally, these might 288 * be abstracted so that only accessor methods are exposed. 289 */ 290extern struct mtx audit_mtx; 291extern struct cv audit_watermark_cv; 292extern struct cv audit_worker_cv; 293extern struct kaudit_queue audit_q; 294extern int audit_q_len; 295extern int audit_pre_q_len; 296extern int audit_in_failure; 297 298/* 299 * Flags to use on audit files when opening and closing. 300 */ 301#define AUDIT_OPEN_FLAGS (FWRITE | O_APPEND) 302#define AUDIT_CLOSE_FLAGS (FWRITE | O_APPEND) 303 304#include <sys/fcntl.h> 305#include <sys/kernel.h> 306#include <sys/malloc.h> 307 308/* 309 * Some of the BSM tokenizer functions take different parameters in the 310 * kernel implementations in order to save the copying of large kernel data 311 * structures. The prototypes of these functions are declared here. 312 */ 313token_t *kau_to_socket(struct socket_au_info *soi); 314 315/* 316 * audit_klib prototypes 317 */ 318int au_preselect(au_event_t event, au_class_t class, 319 au_mask_t *mask_p, int sorf); 320void au_evclassmap_init(void); 321void au_evclassmap_insert(au_event_t event, au_class_t class); 322au_class_t au_event_class(au_event_t event); 323au_event_t audit_ctlname_to_sysctlevent(int name[], uint64_t valid_arg); 324au_event_t audit_flags_and_error_to_openevent(int oflags, int error); 325au_event_t audit_msgctl_to_event(int cmd); 326au_event_t audit_semctl_to_event(int cmr); 327void audit_canon_path(struct thread *td, char *path, char *cpath); 328au_event_t auditon_command_event(int cmd); 329 330/* 331 * Audit trigger events notify user space of kernel audit conditions 332 * asynchronously. 333 */ 334void audit_trigger_init(void); 335int audit_send_trigger(unsigned int trigger); 336 337/* 338 * Accessor functions to manage global audit state. 339 */ 340void audit_set_kinfo(struct auditinfo_addr *); 341void audit_get_kinfo(struct auditinfo_addr *); 342 343/* 344 * General audit related functions. 345 */ 346struct kaudit_record *currecord(void); 347void audit_free(struct kaudit_record *ar); 348void audit_shutdown(void *arg, int howto); 349void audit_rotate_vnode(struct ucred *cred, 350 struct vnode *vp); 351void audit_worker_init(void); 352 353/* 354 * Audit pipe functions. 355 */ 356int audit_pipe_preselect(au_id_t auid, au_event_t event, 357 au_class_t class, int sorf, int trail_select); 358void audit_pipe_submit(au_id_t auid, au_event_t event, au_class_t class, 359 int sorf, int trail_select, void *record, u_int record_len); 360void audit_pipe_submit_user(void *record, u_int record_len); 361 362#endif /* ! _SECURITY_AUDIT_PRIVATE_H_ */ 363