bsd/security/audit/audit.h

   1 /*-
   2  * Copyright (c) 2004-2016 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  */
  30 /*
  31  * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
  32  * support for mandatory and extensible security protections.  This notice
  33  * is included in support of clause 2.2 (b) of the Apple Public License,
  34  * Version 2.0.
  35  */
  36
  37 /*
  38  * This header includes function prototypes and type definitions that are
  39  * necessary for the kernel as a whole to interact with the audit subsystem.
  40  */
  41
  42 #ifndef _SECURITY_AUDIT_AUDIT_H
  43 #define _SECURITY_AUDIT_AUDIT_H
  44
  45 #if defined(_KERNEL) || defined(KERNEL)
  46
  47 #if CONFIG_MACF
  48 #include <sys/queue.h>
  49 #include <security/mac_framework.h>
  50 #endif
  51
  52 #include <bsm/audit.h>
  53
  54 #include <sys/sysctl.h>
  55 #include <sys/user.h>
  56 #include <sys/ipc.h>
  57
  58 /*
  59  * Audit subsystem condition flags.  The audit_enabled flag is set and
  60  * removed automatically as a result of configuring log files, and can be
  61  * observed but should not be directly manipulated.  The audit suspension
  62  * flag permits audit to be temporarily disabled without reconfiguring the
  63  * audit target. The audit syscalls flag is set at the first hint that kernel
  64  * events (system and mach calls) need to be audited.  It is used for
  65  * performance so an event class map table lookup doesn't have be done for
  66  * every system call if only user events are being audited.
  67  */
  68 extern int      audit_enabled;
  69 extern int      audit_suspended;
  70 extern int      audit_syscalls;
  71
  72 /*
  73  * Define the masks for the audited arguments.
  74  *
  75  * XXXRW: These need to remain in audit.h for now because our vnode and name
  76  * lookup audit calls rely on passing in flags to indicate which name or
  77  * vnode is being logged.  These should move to audit_private.h when that is
  78  * fixed.
  79  */
  80 #define ARG_EUID                0x0000000000000001ULL
  81 #define ARG_RUID                0x0000000000000002ULL
  82 #define ARG_SUID                0x0000000000000004ULL
  83 #define ARG_EGID                0x0000000000000008ULL
  84 #define ARG_RGID                0x0000000000000010ULL
  85 #define ARG_SGID                0x0000000000000020ULL
  86 #define ARG_PID                 0x0000000000000040ULL
  87 #define ARG_UID                 0x0000000000000080ULL
  88 #define ARG_AUID                0x0000000000000100ULL
  89 #define ARG_GID                 0x0000000000000200ULL
  90 #define ARG_FD                  0x0000000000000400ULL
  91 #define ARG_FD1                 ARG_FD
  92 #define ARG_POSIX_IPC_PERM      0x0000000000000800ULL
  93 #define ARG_FFLAGS              0x0000000000001000ULL
  94 #define ARG_MODE                0x0000000000002000ULL
  95 #define ARG_VALUE32             0x0000000000004000ULL
  96 #define ARG_ADDR32              0x0000000000008000ULL
  97 #define ARG_ADDR                ARG_ADDR32
  98 #define ARG_LEN                 0x0000000000010000ULL
  99 #define ARG_MASK                0x0000000000020000ULL
 100 #define ARG_SIGNUM              0x0000000000040000ULL
 101 #define ARG_LOGIN               0x0000000000080000ULL
 102 #define ARG_SADDRINET           0x0000000000100000ULL
 103 #define ARG_SADDRINET6          0x0000000000200000ULL
 104 #define ARG_SADDRUNIX           0x0000000000400000ULL
 105 #define ARG_TERMID_ADDR         ARG_SADDRUNIX
 106 #define ARG_KPATH1              0x0000000000800000ULL   /* darwin-only */
 107 #define ARG_KPATH2              0x0000000001000000ULL   /* darwin-only */
 108 #define ARG_UPATH1              0x0000000002000000ULL
 109 #define ARG_UPATH2              0x0000000004000000ULL
 110 #define ARG_TEXT                0x0000000008000000ULL
 111 #define ARG_VNODE1              0x0000000010000000ULL
 112 #define ARG_VNODE2              0x0000000020000000ULL
 113 #define ARG_SVIPC_CMD           0x0000000040000000ULL
 114 #define ARG_SVIPC_PERM          0x0000000080000000ULL
 115 #define ARG_SVIPC_ID            0x0000000100000000ULL
 116 #define ARG_SVIPC_ADDR          0x0000000200000000ULL
 117 #define ARG_GROUPSET            0x0000000400000000ULL
 118 #define ARG_CMD                 0x0000000800000000ULL
 119 #define ARG_SOCKINFO            0x0000001000000000ULL
 120 #define ARG_ASID                0x0000002000000000ULL
 121 #define ARG_TERMID              0x0000004000000000ULL
 122 #define ARG_AUDITON             0x0000008000000000ULL
 123 #define ARG_VALUE64             0x0000010000000000ULL   /* darwin-only */
 124 #define ARG_AMASK               0x0000020000000000ULL
 125 #define ARG_CTLNAME             0x0000040000000000ULL
 126 #define ARG_PROCESS             0x0000080000000000ULL
 127 #define ARG_MACHPORT1           0x0000100000000000ULL
 128 #define ARG_MACHPORT2           0x0000200000000000ULL
 129 #define ARG_MAC_STRING          0x0000400000000000ULL
 130 #define ARG_EXIT                0x0000800000000000ULL
 131 #define ARG_IOVECSTR            0x0001000000000000ULL
 132 #define ARG_ARGV                0x0002000000000000ULL
 133 #define ARG_ENVV                0x0004000000000000ULL
 134 #define ARG_OPAQUE              0x0008000000000000ULL   /* darwin-only */
 135 #define ARG_DATA                0x0010000000000000ULL   /* darwin-only */
 136 #define ARG_ADDR64              0x0020000000000000ULL   /* darwin-only */
 137 #define ARG_FD2                 0x0040000000000000ULL   /* darwin-only */
 138 #define ARG_NONE                0x0000000000000000ULL
 139 #define ARG_ALL                 0xFFFFFFFFFFFFFFFFULL
 140
 141 #if CONFIG_MACF
 142
 143 #define MAC_AUDIT_LABEL_LEN 1024
 144 #define MAC_AUDIT_DATA_TYPE 0
 145 #define MAC_AUDIT_TEXT_TYPE 1
 146
 147 struct mac_audit_record {
 148         int type;               /* one of the types defined above */
 149         int length;             /* byte length of the data field */
 150         u_char *data;           /* the payload */
 151         LIST_ENTRY(mac_audit_record) records;
 152 };
 153
 154 #endif
 155
 156 struct proc;
 157 struct vnode;
 158 struct componentname;
 159
 160 int                      kau_will_audit(void);
 161 void                     audit_init(void);
 162 void                     audit_shutdown(void);
 163 void                     audit_syscall_enter(unsigned int code,
 164                                 struct proc *proc, struct uthread *uthread);
 165 #if CONFIG_MACF
 166 /*
 167  * The parameter list of audit_syscall_exit() was modified to also take the
 168  * Darwin syscall number, which is required by mac_audit_check_postselect().
 169  */
 170 void    audit_syscall_exit(unsigned int code, int error,
 171                 struct proc *proc, struct uthread *uthread);
 172 #else
 173 void    audit_syscall_exit(int error, struct proc *proc,
 174                         struct uthread *uthread);
 175 #endif
 176 void    audit_mach_syscall_enter(unsigned short audit_event);
 177 void    audit_mach_syscall_exit(int retval, struct uthread *uthread);
 178
 179 extern struct auditinfo_addr *audit_default_aia_p;
 180
 181 /*
 182  * The remaining kernel functions are conditionally compiled in as they are
 183  * wrapped by a macro, and the macro should be the only place in the source
 184  * tree where these functions are referenced.
 185  */
 186 #if CONFIG_AUDIT
 187 struct ipc_perm;
 188 struct sockaddr;
 189 union auditon_udata;
 190 void     audit_arg_addr(struct kaudit_record *ar, user_addr_t addr);
 191 void     audit_arg_exit(struct kaudit_record *ar, int status, int retval);
 192 void     audit_arg_len(struct kaudit_record *ar, user_size_t len);
 193 void     audit_arg_fd(struct kaudit_record *ar, int fd);
 194 void     audit_arg_fd2(struct kaudit_record *ar, int fd);
 195 void     audit_arg_fflags(struct kaudit_record *ar, int fflags);
 196 void     audit_arg_gid(struct kaudit_record *ar, gid_t gid);
 197 void     audit_arg_uid(struct kaudit_record *ar, uid_t uid);
 198 void     audit_arg_egid(struct kaudit_record *ar, gid_t egid);
 199 void     audit_arg_euid(struct kaudit_record *ar, uid_t euid);
 200 void     audit_arg_rgid(struct kaudit_record *ar, gid_t rgid);
 201 void     audit_arg_ruid(struct kaudit_record *ar, uid_t ruid);
 202 void     audit_arg_sgid(struct kaudit_record *ar, gid_t sgid);
 203 void     audit_arg_suid(struct kaudit_record *ar, uid_t suid);
 204 void     audit_arg_groupset(struct kaudit_record *ar, gid_t *gidset,
 205                 u_int gidset_size);
 206 void     audit_arg_login(struct kaudit_record *ar, char *login);
 207 void     audit_arg_ctlname(struct kaudit_record *ar, int *name, int namelen);
 208 void     audit_arg_mask(struct kaudit_record *ar, int mask);
 209 void     audit_arg_mode(struct kaudit_record *ar, mode_t mode);
 210 void     audit_arg_value32(struct kaudit_record *ar, uint32_t value32);
 211 void     audit_arg_value64(struct kaudit_record *ar, uint64_t value64);
 212 void     audit_arg_owner(struct kaudit_record *ar, uid_t uid, gid_t gid);
 213 void     audit_arg_pid(struct kaudit_record *ar, pid_t pid);
 214 void     audit_arg_process(struct kaudit_record *ar, proc_t p);
 215 void     audit_arg_signum(struct kaudit_record *ar, u_int signum);
 216 void     audit_arg_socket(struct kaudit_record *ar, int sodomain, int sotype,
 217                 int soprotocol);
 218 void     audit_arg_sockaddr(struct kaudit_record *ar, struct vnode *cwd_vp,
 219                 struct sockaddr *so);
 220 void     audit_arg_auid(struct kaudit_record *ar, uid_t auid);
 221 void     audit_arg_auditinfo(struct kaudit_record *ar,
 222                 struct auditinfo *au_info);
 223 void     audit_arg_auditinfo_addr(struct kaudit_record *ar,
 224                 struct auditinfo_addr *au_info);
 225 void     audit_arg_upath(struct kaudit_record *ar, struct vnode *cwd_vp,
 226                 char *upath, u_int64_t flags);
 227 void     audit_arg_vnpath(struct kaudit_record *ar, struct vnode *vp,
 228                 u_int64_t flags);
 229 void     audit_arg_vnpath_withref(struct kaudit_record *ar, struct vnode *vp,
 230                 u_int64_t flags);
 231 void     audit_arg_text(struct kaudit_record *ar, char *text);
 232 void     audit_arg_opaque(struct kaudit_record *ar, void *data, size_t size);
 233 void     audit_arg_data(struct kaudit_record *ar, void *data, size_t size,
 234                 size_t number);
 235 void     audit_arg_cmd(struct kaudit_record *ar, int cmd);
 236 void     audit_arg_svipc_cmd(struct kaudit_record *ar, int cmd);
 237 void     audit_arg_svipc_perm(struct kaudit_record *ar, struct ipc_perm *perm);
 238 void     audit_arg_svipc_id(struct kaudit_record *ar, int id);
 239 void     audit_arg_svipc_addr(struct kaudit_record *ar, user_addr_t addr);
 240 void     audit_arg_posix_ipc_perm(struct kaudit_record *ar, uid_t uid,
 241                 gid_t gid, mode_t mode);
 242 void     audit_arg_auditon(struct kaudit_record *ar,
 243                 union auditon_udata *udata);
 244 void     audit_arg_file(struct kaudit_record *ar, struct proc *p,
 245                 struct fileproc *fp);
 246 void     audit_arg_argv(struct kaudit_record *ar, char *argv, int argc,
 247                 int length);
 248 void     audit_arg_envv(struct kaudit_record *ar, char *envv, int envc,
 249                 int length);
 250
 251 void     audit_arg_mach_port1(struct kaudit_record *ar, mach_port_name_t port);
 252 void     audit_arg_mach_port2(struct kaudit_record *ar, mach_port_name_t port);
 253 void     audit_sysclose(struct kaudit_record *ar, struct proc *p, int fd);
 254
 255 void     audit_proc_coredump(proc_t proc, char *path, int errcode);
 256 void     audit_proc_init(struct proc *p);
 257 void     audit_proc_fork(struct proc *parent, struct proc *child);
 258 void     audit_proc_free(struct proc *p);
 259
 260 #ifndef _KAUTH_CRED_T
 261 #define _KAUTH_CRED_T
 262 struct ucred;
 263 typedef struct ucred *kauth_cred_t;
 264 #endif /* !_KAUTH_CRED_T */
 265
 266 void     audit_session_ref(kauth_cred_t cred);
 267 void     audit_session_unref(kauth_cred_t cred);
 268 void     audit_session_procnew(proc_t p);
 269 void     audit_session_procexit(proc_t p);
 270 int      audit_session_spawnjoin(proc_t p, task_t task, ipc_port_t port);
 271
 272 void     audit_sdev_submit(au_id_t auid, au_asid_t asid, void *record,
 273             u_int record_len);
 274
 275 /*
 276  * Audit session macros.
 277  */
 278 #define IS_VALID_SESSION(a)     ((a) != NULL && (a) != audit_default_aia_p)
 279
 280 #define AUDIT_SESSION_REF(cred)         audit_session_ref(cred)
 281 #define AUDIT_SESSION_UNREF(cred)       audit_session_unref(cred)
 282
 283 #define AUDIT_SESSION_PROCNEW(p)        audit_session_procnew(p)
 284 #define AUDIT_SESSION_PROCEXIT(p)       audit_session_procexit(p)
 285
 286 #if CONFIG_MACF
 287 /*
 288  * audit_mac_data() is the MAC Framework's entry point to the audit subsystem.
 289  * It currently creates only text and data audit tokens.
 290  */
 291 int      audit_mac_data(int type, int len, u_char *data);
 292 void     audit_arg_mac_string(struct kaudit_record *ar, char *string);
 293
 294 #endif
 295
 296 extern au_event_t sys_au_event[];
 297
 298 #define AUDIT_RECORD() \
 299         ((struct uthread*)get_bsdthread_info(current_thread()))->uu_ar
 300
 301 #ifndef AUDIT_USE_BUILTIN_EXPECT
 302 #define AUDIT_USE_BUILTIN_EXPECT
 303 #endif
 304
 305 #ifdef  AUDIT_USE_BUILTIN_EXPECT
 306 /*
 307  * Use branch prediction for the case of auditing enabled but not
 308  * auditing system calls.
 309  */
 310 #define AUDIT_SYSCALLS()        __builtin_expect(audit_syscalls, 0)
 311 #define AUDIT_ENABLED()         __builtin_expect(audit_syscalls &&      \
 312                                         audit_enabled, 0)
 313 #define AUDIT_AUDITING(x)       __builtin_expect(NULL != (x), 0)
 314
 315 #else
 316
 317 #define AUDIT_SYSCALLS()        (audit_syscalls)
 318 #define AUDIT_ENABLED()         (audit_syscalls && audit_enabled)
 319 #define AUDIT_AUDITING(x)       (NULL != (x))
 320
 321 #endif /* AUDIT_USE_BUILTIN_EXPECT */
 322
 323 /*
 324  * Define a macro to wrap the audit_arg_* calls by checking the global
 325  * audit_enabled flag before performing the actual call.
 326  */
 327 #define AUDIT_ARG(op, args...)  do {                                    \
 328         if (AUDIT_SYSCALLS()) {                                         \
 329                 struct kaudit_record *__ar = AUDIT_RECORD();            \
 330                 if (AUDIT_AUDITING(__ar))                               \
 331                         audit_arg_ ## op (__ar, args);                  \
 332         }                                                               \
 333 } while (0)
 334
 335 #define AUDIT_SYSCALL_ENTER(args...)    do {                            \
 336         if (AUDIT_ENABLED()) {                                  \
 337                 audit_syscall_enter(args);                              \
 338         }                                                               \
 339 } while (0)
 340
 341 /*
 342  * Wrap the audit_syscall_exit() function so that it is called only when
 343  * we have a audit record on the thread.  Audit records can persist after
 344  * auditing is disabled, so we don't just check audit_enabled here.
 345  */
 346 #define AUDIT_SYSCALL_EXIT(code, proc, uthread, error)  do {            \
 347                 if (AUDIT_AUDITING(uthread->uu_ar))                     \
 348                         audit_syscall_exit(code, error, proc, uthread); \
 349 } while (0)
 350
 351 /*
 352  * Wrap the audit_mach_syscall_enter() and audit_mach_syscall_exit()
 353  * functions in a manner similar to other system call enter/exit functions.
 354  */
 355 #define AUDIT_MACH_SYSCALL_ENTER(args...)       do {                    \
 356         if (AUDIT_ENABLED()) {                                  \
 357                 audit_mach_syscall_enter(args);                         \
 358         }                                                               \
 359 } while (0)
 360
 361 #define AUDIT_MACH_SYSCALL_EXIT(retval)         do {                    \
 362         if (AUDIT_SYSCALLS()) {                                         \
 363                 struct uthread *__uthread =                             \
 364                         get_bsdthread_info(current_thread());           \
 365                 if (AUDIT_AUDITING(__uthread->uu_ar))                   \
 366                         audit_mach_syscall_exit(retval, __uthread);     \
 367         }                                                               \
 368 } while (0)
 369
 370 /*
 371  * A Macro to wrap the audit_sysclose() function.
 372  */
 373 #define AUDIT_SYSCLOSE(args...) do {                                    \
 374         if (AUDIT_SYSCALLS()) {                                         \
 375                 struct kaudit_record *__ar = AUDIT_RECORD();            \
 376                 if (AUDIT_AUDITING(__ar))                               \
 377                         audit_sysclose(__ar, args);                     \
 378         }                                                               \
 379 } while (0)
 380
 381 #else /* !CONFIG_AUDIT */
 382
 383 #define AUDIT_ARG(op, args...)  do {                                    \
 384 } while (0)
 385
 386 #define AUDIT_SYSCALL_ENTER(args...)    do {                            \
 387 } while (0)
 388
 389 #define AUDIT_SYSCALL_EXIT(code, proc, uthread, error)  do {            \
 390 } while (0)
 391
 392 #define AUDIT_MACH_SYSCALL_ENTER(args...)       do {                    \
 393 } while (0)
 394
 395 #define AUDIT_MACH_SYSCALL_EXIT(retval)         do {                    \
 396 } while (0)
 397
 398 #define AUDIT_SYSCLOSE(op, args...)     do {                            \
 399 } while (0)
 400
 401 #define AUDIT_SESSION_REF(cred)         do {                            \
 402 } while (0)
 403
 404 #define AUDIT_SESSION_UNREF(cred)       do {                            \
 405 } while (0)
 406
 407 #define AUDIT_SESSION_PROCNEW(cred)     do {                            \
 408 } while (0)
 409
 410 #define AUDIT_SESSION_PROCEXIT(cred)    do {                            \
 411 } while (0)
 412
 413 #define AUDIT_SESSION_REF(cred)         do {                            \
 414 } while (0)
 415
 416 #define AUDIT_SESSION_UNREF(cred)       do {                            \
 417 } while (0)
 418
 419 #define AUDIT_SESSION_PROCNEW(cred)     do {                            \
 420 } while (0)
 421
 422 #define AUDIT_SESSION_PROCEXIT(cred)    do {                            \
 423 } while (0)
 424
 425 #endif /* CONFIG_AUDIT */
 426
 427 #endif /* KERNEL */
 428
 429 #endif /* !_SECURITY_AUDIT_ADUIT_H */