1 /* 2 * Copyright (c) 1999-2005 Apple Computer, 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 Computer, 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$ 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 49 MALLOC_DECLARE(M_AUDITBSM); 50 MALLOC_DECLARE(M_AUDITDATA); 51 MALLOC_DECLARE(M_AUDITPATH); 52 MALLOC_DECLARE(M_AUDITTEXT); 53 #endif 54 55 /* 56 * The AUDIT_EXCESSIVELY_VERBOSE define enables a number of gratuitously 57 * noisy printf's to the console. Due to the volume, it should be left off 58 * unless you want your system to churn a lot whenever the audit record flow 59 * gets high. 60 */ 61 //#define AUDIT_EXCESSIVELY_VERBOSE 62 #ifdef AUDIT_EXCESSIVELY_VERBOSE 63 #define AUDIT_PRINTF(x) printf x 64 #else 65 #define AUDIT_PRINTF(x) 66 #endif 67 68 /* 69 * Audit control variables that are usually set/read via system calls and 70 * used to control various aspects of auditing. 71 */ 72 extern struct au_qctrl audit_qctrl; 73 extern struct audit_fstat audit_fstat; 74 extern struct au_mask audit_nae_mask; 75 extern int audit_panic_on_write_fail; 76 extern int audit_fail_stop; 77 78 /* 79 * Success/failure conditions for the conversion of a kernel audit record to 80 * BSM format. 81 */ 82 #define BSM_SUCCESS 0 83 #define BSM_FAILURE 1 84 #define BSM_NOAUDIT 2 85 86 /* 87 * Defines for the kernel audit record k_ar_commit field. Flags are set to 88 * indicate what sort of record it is, and which preselection mechanism 89 * selected it. 90 */ 91 #define AR_COMMIT_KERNEL 0x00000001U 92 #define AR_COMMIT_USER 0x00000010U 93 94 #define AR_PRESELECT_TRAIL 0x00001000U 95 #define AR_PRESELECT_PIPE 0x00002000U 96 97 /* 98 * Audit data is generated as a stream of struct audit_record structures, 99 * linked by struct kaudit_record, and contain storage for possible audit so 100 * that it will not need to be allocated during the processing of a system 101 * call, both improving efficiency and avoiding sleeping at untimely moments. 102 * This structure is converted to BSM format before being written to disk. 103 */ 104 struct vnode_au_info { 105 mode_t vn_mode; 106 uid_t vn_uid; 107 gid_t vn_gid; 108 dev_t vn_dev; 109 long vn_fsid; 110 long vn_fileid; 111 long vn_gen; 112 }; 113 114 struct groupset { 115 gid_t gidset[NGROUPS]; 116 u_int gidset_size; 117 }; 118 119 struct socket_au_info { 120 int so_domain; 121 int so_type; 122 int so_protocol; 123 in_addr_t so_raddr; /* Remote address if INET socket. */ 124 in_addr_t so_laddr; /* Local address if INET socket. */ 125 u_short so_rport; /* Remote port. */ 126 u_short so_lport; /* Local port. */ 127 }; 128 129 union auditon_udata { 130 char *au_path; 131 long au_cond; 132 long au_flags; 133 long au_policy; 134 int au_trigger; 135 au_evclass_map_t au_evclass; 136 au_mask_t au_mask; 137 auditinfo_t au_auinfo; 138 auditpinfo_t au_aupinfo; 139 auditpinfo_addr_t au_aupinfo_addr; 140 au_qctrl_t au_qctrl; 141 au_stat_t au_stat; 142 au_fstat_t au_fstat; 143 }; 144 145 struct posix_ipc_perm { 146 uid_t pipc_uid; 147 gid_t pipc_gid; 148 mode_t pipc_mode; 149 }; 150 151 struct audit_record { 152 /* Audit record header. */ 153 u_int32_t ar_magic; 154 int ar_event; 155 int ar_retval; /* value returned to the process */ 156 int ar_errno; /* return status of system call */ 157 struct timespec ar_starttime; 158 struct timespec ar_endtime; 159 u_int64_t ar_valid_arg; /* Bitmask of valid arguments */ 160 161 /* Audit subject information. */ 162 struct xucred ar_subj_cred; 163 uid_t ar_subj_ruid; 164 gid_t ar_subj_rgid; 165 gid_t ar_subj_egid; 166 uid_t ar_subj_auid; /* Audit user ID */ 167 pid_t ar_subj_asid; /* Audit session ID */ 168 pid_t ar_subj_pid; 169 struct au_tid ar_subj_term; 170 char ar_subj_comm[MAXCOMLEN + 1]; 171 struct au_mask ar_subj_amask; 172 173 /* Operation arguments. */ 174 uid_t ar_arg_euid; 175 uid_t ar_arg_ruid; 176 uid_t ar_arg_suid; 177 gid_t ar_arg_egid; 178 gid_t ar_arg_rgid; 179 gid_t ar_arg_sgid; 180 pid_t ar_arg_pid; 181 pid_t ar_arg_asid; 182 struct au_tid ar_arg_termid; 183 uid_t ar_arg_uid; 184 uid_t ar_arg_auid; 185 gid_t ar_arg_gid; 186 struct groupset ar_arg_groups; 187 int ar_arg_fd; 188 int ar_arg_fflags; 189 mode_t ar_arg_mode; 190 int ar_arg_dev; 191 long ar_arg_value; 192 void * ar_arg_addr; 193 int ar_arg_len; 194 int ar_arg_mask; 195 u_int ar_arg_signum; 196 char ar_arg_login[MAXLOGNAME]; 197 int ar_arg_ctlname[CTL_MAXNAME]; 198 struct sockaddr ar_arg_sockaddr; 199 struct socket_au_info ar_arg_sockinfo; 200 char *ar_arg_upath1; 201 char *ar_arg_upath2; 202 char *ar_arg_text; 203 struct au_mask ar_arg_amask; 204 struct vnode_au_info ar_arg_vnode1; 205 struct vnode_au_info ar_arg_vnode2; 206 int ar_arg_cmd; 207 int ar_arg_svipc_cmd; 208 struct ipc_perm ar_arg_svipc_perm; 209 int ar_arg_svipc_id; 210 void * ar_arg_svipc_addr; 211 struct posix_ipc_perm ar_arg_pipc_perm; 212 union auditon_udata ar_arg_auditon; 213 int ar_arg_exitstatus; 214 int ar_arg_exitretval; 215 }; 216 217 /* 218 * Arguments in the audit record are initially not defined; flags are set to 219 * indicate if they are present so they can be included in the audit log 220 * stream only if defined. 221 */ 222 #define ARG_IS_VALID(kar, arg) ((kar)->k_ar.ar_valid_arg & (arg)) 223 #define ARG_SET_VALID(kar, arg) do { \ 224 (kar)->k_ar.ar_valid_arg |= (arg); \ 225 } while (0) 226 227 /* 228 * In-kernel version of audit record; the basic record plus queue meta-data. 229 * This record can also have a pointer set to some opaque data that will be 230 * passed through to the audit writing mechanism. 231 */ 232 struct kaudit_record { 233 struct audit_record k_ar; 234 u_int32_t k_ar_commit; 235 void *k_udata; /* User data. */ 236 u_int k_ulen; /* User data length. */ 237 struct uthread *k_uthread; /* Audited thread. */ 238 TAILQ_ENTRY(kaudit_record) k_q; 239 }; 240 TAILQ_HEAD(kaudit_queue, kaudit_record); 241 242 /* 243 * Functions to manage the allocation, release, and commit of kernel audit 244 * records. 245 */ 246 void audit_abort(struct kaudit_record *ar); 247 void audit_commit(struct kaudit_record *ar, int error, 248 int retval); 249 struct kaudit_record *audit_new(int event, struct thread *td); 250 251 /* 252 * Functions relating to the conversion of internal kernel audit records to 253 * the BSM file format. 254 */ 255 struct au_record; 256 int kaudit_to_bsm(struct kaudit_record *kar, struct au_record **pau); 257 int bsm_rec_verify(void *rec); 258 259 /* 260 * Kernel versions of the libbsm audit record functions. 261 */ 262 void kau_free(struct au_record *rec); 263 void kau_init(void); 264 265 /* 266 * Return values for pre-selection and post-selection decisions. 267 */ 268 #define AU_PRS_SUCCESS 1 269 #define AU_PRS_FAILURE 2 270 #define AU_PRS_BOTH (AU_PRS_SUCCESS|AU_PRS_FAILURE) 271 272 /* 273 * Data structures relating to the kernel audit queue. Ideally, these might 274 * be abstracted so that only accessor methods are exposed. 275 */ 276 extern struct mtx audit_mtx; 277 extern struct cv audit_watermark_cv; 278 extern struct cv audit_worker_cv; 279 extern struct kaudit_queue audit_q; 280 extern int audit_q_len; 281 extern int audit_pre_q_len; 282 extern int audit_in_failure; 283 284 /* 285 * Flags to use on audit files when opening and closing. 286 */ 287 #define AUDIT_OPEN_FLAGS (FWRITE | O_APPEND) 288 #define AUDIT_CLOSE_FLAGS (FWRITE | O_APPEND) 289 290 #include <sys/fcntl.h> 291 #include <sys/kernel.h> 292 #include <sys/malloc.h> 293 294 /* 295 * Some of the BSM tokenizer functions take different parameters in the 296 * kernel implementations in order to save the copying of large kernel data 297 * structures. The prototypes of these functions are declared here. 298 */ 299 token_t *kau_to_socket(struct socket_au_info *soi); 300 301 /* 302 * audit_klib prototypes 303 */ 304 int au_preselect(au_event_t event, au_class_t class, 305 au_mask_t *mask_p, int sorf); 306 au_event_t flags_and_error_to_openevent(int oflags, int error); 307 void au_evclassmap_init(void); 308 void au_evclassmap_insert(au_event_t event, au_class_t class); 309 au_class_t au_event_class(au_event_t event); 310 au_event_t ctlname_to_sysctlevent(int name[], uint64_t valid_arg); 311 int auditon_command_event(int cmd); 312 int msgctl_to_event(int cmd); 313 int semctl_to_event(int cmr); 314 void canon_path(struct thread *td, char *path, char *cpath); 315 316 /* 317 * Audit trigger events notify user space of kernel audit conditions 318 * asynchronously. 319 */ 320 void audit_trigger_init(void); 321 int send_trigger(unsigned int trigger); 322 323 /* 324 * General audit related functions. 325 */ 326 struct kaudit_record *currecord(void); 327 void audit_free(struct kaudit_record *ar); 328 void audit_shutdown(void *arg, int howto); 329 void audit_rotate_vnode(struct ucred *cred, 330 struct vnode *vp); 331 void audit_worker_init(void); 332 333 /* 334 * Audit pipe functions. 335 */ 336 int audit_pipe_preselect(au_id_t auid, au_event_t event, 337 au_class_t class, int sorf, int trail_select); 338 void audit_pipe_submit(au_id_t auid, au_event_t event, au_class_t class, 339 int sorf, int trail_select, void *record, u_int record_len); 340 void audit_pipe_submit_user(void *record, u_int record_len); 341 342 #endif /* ! _SECURITY_AUDIT_PRIVATE_H_ */ 343