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