[apple/xnu.git] / bsd / bsm / audit_kernel.h

/*
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2004 Apple Computer, Inc.  All Rights Reserved.
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

#ifndef _BSM_AUDIT_KERNEL_H
#define	_BSM_AUDIT_KERNEL_H

#ifdef KERNEL

#include <bsm/audit.h>

#include <sys/sysctl.h>
#include <sys/eventvar.h>
#include <sys/user.h>

/*
 * Audit subsystem condition flags.  The audit_enabled flag is set and
 * removed automatically as a result of configuring log files, and
 * can be observed but should not be directly manipulated.  The audit
 * suspension flag permits audit to be temporarily disabled without
 * reconfiguring the audit target.
 */
extern int	audit_enabled;
extern int	audit_suspended;

#define BSM_SUCCESS		0
#define BSM_FAILURE		1
#define BSM_NOAUDIT		2

/*
 * Define the masks for the audited arguments.
 */
#define ARG_EUID		0x0000000000000001ULL
#define ARG_RUID		0x0000000000000002ULL
#define ARG_SUID		0x0000000000000004ULL
#define ARG_EGID		0x0000000000000008ULL
#define ARG_RGID		0x0000000000000010ULL
#define ARG_SGID		0x0000000000000020ULL
#define ARG_PID			0x0000000000000040ULL
#define ARG_UID			0x0000000000000080ULL
#define ARG_AUID		0x0000000000000100ULL
#define ARG_GID			0x0000000000000200ULL
#define ARG_FD			0x0000000000000400ULL
#define ARG_POSIX_IPC_PERM 	0x0000000000000800ULL
#define ARG_FFLAGS		0x0000000000001000ULL
#define ARG_MODE		0x0000000000002000ULL
#define ARG_DEV			0x0000000000004000ULL
#define ARG_ADDR		0x0000000000008000ULL
#define ARG_LEN			0x0000000000010000ULL
#define ARG_MASK		0x0000000000020000ULL
#define ARG_SIGNUM		0x0000000000040000ULL
#define ARG_LOGIN		0x0000000000080000ULL
#define ARG_SADDRINET		0x0000000000100000ULL
#define ARG_SADDRINET6		0x0000000000200000ULL
#define ARG_SADDRUNIX		0x0000000000400000ULL
#define ARG_KPATH1		0x0000000000800000ULL
#define ARG_KPATH2		0x0000000001000000ULL
#define ARG_UPATH1		0x0000000002000000ULL
#define ARG_UPATH2		0x0000000004000000ULL
#define ARG_TEXT		0x0000000008000000ULL
#define ARG_VNODE1		0x0000000010000000ULL
#define ARG_VNODE2		0x0000000020000000ULL
#define ARG_SVIPC_CMD		0x0000000040000000ULL
#define ARG_SVIPC_PERM		0x0000000080000000ULL
#define ARG_SVIPC_ID		0x0000000100000000ULL
#define ARG_SVIPC_ADDR		0x0000000200000000ULL
#define ARG_GROUPSET		0x0000000400000000ULL
#define ARG_CMD			0x0000000800000000ULL
#define ARG_SOCKINFO		0x0000001000000000ULL
#define ARG_ASID		0x0000002000000000ULL
#define ARG_TERMID		0x0000004000000000ULL
#define ARG_AUDITON		0x0000008000000000ULL
#define ARG_VALUE		0x0000010000000000ULL
#define ARG_AMASK		0x0000020000000000ULL
#define ARG_CTLNAME		0x0000040000000000ULL
#define ARG_PROCESS		0x0000080000000000ULL
#define ARG_MACHPORT1		0x0000100000000000ULL
#define ARG_MACHPORT2		0x0000200000000000ULL
#define ARG_NONE		0x0000000000000000ULL
#define ARG_ALL			0xFFFFFFFFFFFFFFFFULL

/* Defines for the kernel audit record k_ar_commit field */
#define AR_COMMIT_KERNEL	0x00000001U
#define AR_COMMIT_USER		0x00000010U

struct vnode_au_info {
	mode_t		vn_mode;
	uid_t		vn_uid;
	gid_t		vn_gid;
	dev_t		vn_dev;
	long		vn_fsid;
	long		vn_fileid;
	long		vn_gen;
};

struct groupset {
	gid_t	gidset[NGROUPS];
	u_int	gidset_size;
};

struct socket_au_info {
	int 		so_domain;
	int		so_type;
	int		so_protocol;
	in_addr_t	so_raddr;	/* remote address if INET socket */
	in_addr_t	so_laddr;	/* local address if INET socket */
	u_short		so_rport;	/* remote port */
	u_short		so_lport;	/* local port */
};

union auditon_udata {
	char			au_path[MAXPATHLEN];
	long			au_cond;
	long			au_flags;
	long			au_policy;
	au_evclass_map_t	au_evclass;
	au_mask_t		au_mask;
	auditinfo_t		au_auinfo;
	auditpinfo_t		au_aupinfo;
	auditpinfo_addr_t	au_aupinfo_addr;
	au_qctrl_t		au_qctrl;
	au_stat_t		au_stat;
	au_fstat_t		au_fstat;
};

struct posix_ipc_perm {
	uid_t			pipc_uid;
	gid_t			pipc_gid;
	mode_t			pipc_mode;
};

struct audit_record {
	/* Audit record header. */
	u_int32_t		ar_magic;
	int			ar_event;
	int			ar_retval; /* value returned to the process */
	int			ar_errno;  /* return status of system call */
	struct timespec		ar_starttime;
	struct timespec		ar_endtime;
	u_int64_t		ar_valid_arg;  /* Bitmask of valid arguments */

	/* Audit subject information. */
	struct xucred			ar_subj_cred;
	uid_t				ar_subj_ruid;
	gid_t				ar_subj_rgid;
	gid_t				ar_subj_egid;
	uid_t				ar_subj_auid; /* Audit user ID */
	pid_t				ar_subj_asid; /* Audit session ID */
	pid_t				ar_subj_pid;
	struct au_tid			ar_subj_term;	
	char				ar_subj_comm[MAXCOMLEN + 1];
	struct au_mask			ar_subj_amask;

	/* Operation arguments. */
	uid_t				ar_arg_euid;
	uid_t				ar_arg_ruid;
	uid_t				ar_arg_suid;
	gid_t				ar_arg_egid;
	gid_t				ar_arg_rgid;
	gid_t				ar_arg_sgid;
	pid_t				ar_arg_pid;
	pid_t				ar_arg_asid;
	struct au_tid			ar_arg_termid;	
	uid_t				ar_arg_uid;
	uid_t				ar_arg_auid;
	gid_t				ar_arg_gid;
	struct groupset			ar_arg_groups;
	int				ar_arg_fd;
	int				ar_arg_fflags;
	mode_t				ar_arg_mode;
	int				ar_arg_dev;
	long				ar_arg_value;
	void *				ar_arg_addr;
	int				ar_arg_len;
	int				ar_arg_mask;
	u_int				ar_arg_signum;
	char				ar_arg_login[MAXLOGNAME];
	int				ar_arg_ctlname[CTL_MAXNAME];
	struct sockaddr			ar_arg_sockaddr;
	struct socket_au_info		ar_arg_sockinfo;
	char				*ar_arg_upath1;
	char				*ar_arg_upath2;
	char				*ar_arg_kpath1;
	char				*ar_arg_kpath2;
	char				*ar_arg_text;
	struct au_mask			ar_arg_amask;
	struct vnode_au_info		ar_arg_vnode1;
	struct vnode_au_info		ar_arg_vnode2;
	int				ar_arg_cmd;
	int				ar_arg_svipc_cmd;
	struct ipc_perm			ar_arg_svipc_perm;
	int				ar_arg_svipc_id;
	void *				ar_arg_svipc_addr;
	struct posix_ipc_perm		ar_arg_pipc_perm;
	mach_port_t			ar_arg_mach_port1;
	mach_port_t			ar_arg_mach_port2;
	union auditon_udata		ar_arg_auditon;
};

/*
 * In-kernel version of audit record; the basic record plus queue meta-data.
 * This record can also have a pointer set to some opaque data that will
 * be passed through to the audit writing mechanism.
 */
struct kaudit_record {
	struct audit_record		k_ar;
	u_int32_t			k_ar_commit; 
	void 				*k_udata;    /* user data */	
	u_int				k_ulen;     /* user data length */	
	struct uthread			*k_uthread; /* thread we are auditing */
	TAILQ_ENTRY(kaudit_record)	k_q;
};

struct proc;
struct vnode;
struct componentname;

void			 audit_abort(struct kaudit_record *ar);
void			 audit_commit(struct kaudit_record *ar, int error, 
					int retval);
void			 audit_init(void);
void			 audit_shutdown(void);

struct kaudit_record	*audit_new(int event, struct proc *p,
			    struct uthread *uthread);

void			 audit_syscall_enter(unsigned short code,
				struct proc *proc, struct uthread *uthread);
void			 audit_syscall_exit(int error, struct proc *proc,
				struct uthread *uthread);
void			 audit_mach_syscall_enter(unsigned short audit_event);
void			 audit_mach_syscall_exit(int retval,
				struct uthread *uthread);

int			kaudit_to_bsm(struct kaudit_record *kar,
					struct au_record **pau);

int			bsm_rec_verify(void *rec);

/*
 * Kernel versions of the BSM audit record functions.
 */
struct au_record 	*kau_open(void);
int			kau_write(struct au_record *rec, token_t *m);
int			kau_close(struct au_record *rec, 
				 struct timespec *endtime, short event);
void			kau_free(struct au_record *rec);
void			kau_init(void);
token_t			*kau_to_file(char *file, struct timeval *tv);
token_t			*kau_to_header(struct timespec *ctime, int rec_size, 
					au_event_t e_type, au_emod_t e_mod);
token_t			*kau_to_header32(struct timespec *ctime, int rec_size, 
					au_event_t e_type, au_emod_t e_mod);
token_t			*kau_to_header64(struct timespec *ctime, int rec_size,
					 au_event_t e_type, au_emod_t e_mod);
/*
 * The remaining kernel functions are conditionally compiled in as they
 * are wrapped by a macro, and the macro should be the only place in 
 * the source tree where these functions are referenced.
 */
#ifdef AUDIT
void			 audit_arg_addr(void * addr);
void			 audit_arg_len(int len);
void			 audit_arg_fd(int fd);
void			 audit_arg_fflags(int fflags);
void			 audit_arg_gid(gid_t gid, gid_t egid, gid_t rgid, 
					gid_t sgid);
void			 audit_arg_uid(uid_t uid, uid_t euid, uid_t ruid, 
					uid_t suid);
void			 audit_arg_groupset(gid_t *gidset, u_int gidset_size);
void			 audit_arg_login(char *login);
void			 audit_arg_ctlname(int *name, int namelen);
void			 audit_arg_mask(int mask);
void			 audit_arg_mode(mode_t mode);
void			 audit_arg_dev(int dev);
void			 audit_arg_value(long value);
void			 audit_arg_owner(uid_t uid, gid_t gid);
void			 audit_arg_pid(pid_t pid);
void			 audit_arg_process(struct proc *p);
void			 audit_arg_signum(u_int signum);
void			 audit_arg_socket(int sodomain, int sotype, 
						int soprotocol);
void			 audit_arg_sockaddr(struct proc *p, 
						struct sockaddr *so);
void			 audit_arg_auid(uid_t auid);
void			 audit_arg_auditinfo(struct auditinfo *au_info);
void			 audit_arg_upath(struct proc *p, char *upath, 
					 u_int64_t flags);
void			 audit_arg_vnpath(struct vnode *vp, u_int64_t flags);
void			 audit_arg_text(char *text);
void			 audit_arg_cmd(int cmd);
void			 audit_arg_svipc_cmd(int cmd);
void			 audit_arg_svipc_perm(struct ipc_perm *perm);
void			 audit_arg_svipc_id(int id);
void			 audit_arg_svipc_addr(void *addr);
void			 audit_arg_posix_ipc_perm(uid_t uid, gid_t gid, 
						 mode_t mode);
void			 audit_arg_auditon(union auditon_udata *udata);
void			 audit_arg_file(struct proc *p, struct file *fp);
void			 audit_arg_mach_port1(mach_port_t port);
void			 audit_arg_mach_port2(mach_port_t port);

void			 audit_sysclose(struct proc *p, int fd);

void			 audit_proc_init(struct proc *p);
void			 audit_proc_fork(struct proc *parent, 
					 struct proc *child);
void			 audit_proc_free(struct proc *p);

/*
 * Define a macro to wrap the audit_arg_* calls by checking the global
 * audit_enabled flag before performing the actual call.
 */
#define	AUDIT_ARG(op, args...)	do {					\
	if (audit_enabled)						\
		audit_arg_ ## op (args);				\
	} while (0)

#define AUDIT_SYSCALL_ENTER(args...)	do {				\
	if (audit_enabled) {						\
		audit_syscall_enter(args);				\
	}								\
	} while (0)

/*
 * Wrap the audit_syscall_exit() function so that it is called only when
 * auditing is enabled, or we have a audit record on the thread. It is 
 * possible that an audit record was begun before auditing was turned off.
 */
#define AUDIT_SYSCALL_EXIT(error, proc, uthread)	do {		\
	if (audit_enabled | (uthread->uu_ar != NULL)) {			\
		audit_syscall_exit(error, proc, uthread);		\
	}								\
	} while (0)

/*
 * Wrap the audit_mach_syscall_enter() and audit_mach_syscall_exit()
 * functions in a manner similar to other system call enter/exit functions.
 */
#define AUDIT_MACH_SYSCALL_ENTER(args...)       do {			\
	if (audit_enabled) {						\
		audit_mach_syscall_enter(args);				\
	}								\
	} while (0)

#define AUDIT_MACH_SYSCALL_EXIT(retval) 	do {			\
	struct uthread *uthread = get_bsdthread_info(current_act());	\
	if (audit_enabled | (uthread->uu_ar != NULL)) {			\
		audit_mach_syscall_exit(retval, uthread);		\
	}								\
	} while (0)

/*
 * A Macro to wrap the audit_sysclose() function.
 */
#define	AUDIT_SYSCLOSE(args...)	do {					\
	if (audit_enabled)						\
		audit_sysclose(args);					\
	} while (0)

#else /* !AUDIT */
#define AUDIT_SYSCALL_ENTER(args...)	do {				\
	} while (0)

#define AUDIT_SYSCALL_EXIT(error, proc, uthread)	do {		\
	} while (0)

#define AUDIT_MACH_SYSCALL_ENTER(args...)       do {			\
	} while (0)

#define AUDIT_MACH_SYSCALL_EXIT(retval) 	do {			\
	} while (0)

#define	AUDIT_SYSCLOSE(op, args...)	do {				\
	} while (0)

#endif /* AUDIT */

#endif /* KERNEL */

#endif /* !_BSM_AUDIT_KERNEL_H */
Commit	Line	Data
e5568f75 A	1	/*
	2	* @APPLE_LICENSE_HEADER_START@
	3	*
	4	* Copyright (c) 1999-2004 Apple Computer, Inc. All Rights Reserved.
	5	*
	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. Please obtain a copy of the License at
	10	* http://www.opensource.apple.com/apsl/ and read it before using this
	11	* file.
	12	*
	13	* The Original Code and all software distributed under the License are
	14	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	16	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	17	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	18	* Please see the License for the specific language governing rights and
	19	* limitations under the License.
	20	*
	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
	23
	24	#ifndef _BSM_AUDIT_KERNEL_H
	25	#define _BSM_AUDIT_KERNEL_H
	26
	27	#ifdef KERNEL
	28
	29	#include <bsm/audit.h>
	30
	31	#include <sys/sysctl.h>
	32	#include <sys/eventvar.h>
	33	#include <sys/user.h>
	34
	35	/*
	36	* Audit subsystem condition flags. The audit_enabled flag is set and
	37	* removed automatically as a result of configuring log files, and
	38	* can be observed but should not be directly manipulated. The audit
	39	* suspension flag permits audit to be temporarily disabled without
	40	* reconfiguring the audit target.
	41	*/
	42	extern int audit_enabled;
	43	extern int audit_suspended;
	44
	45	#define BSM_SUCCESS 0
	46	#define BSM_FAILURE 1
	47	#define BSM_NOAUDIT 2
	48
	49	/*
	50	* Define the masks for the audited arguments.
	51	*/
	52	#define ARG_EUID 0x0000000000000001ULL
	53	#define ARG_RUID 0x0000000000000002ULL
	54	#define ARG_SUID 0x0000000000000004ULL
	55	#define ARG_EGID 0x0000000000000008ULL
	56	#define ARG_RGID 0x0000000000000010ULL
	57	#define ARG_SGID 0x0000000000000020ULL
	58	#define ARG_PID 0x0000000000000040ULL
	59	#define ARG_UID 0x0000000000000080ULL
	60	#define ARG_AUID 0x0000000000000100ULL
	61	#define ARG_GID 0x0000000000000200ULL
	62	#define ARG_FD 0x0000000000000400ULL
	63	#define ARG_POSIX_IPC_PERM 0x0000000000000800ULL
	64	#define ARG_FFLAGS 0x0000000000001000ULL
65	#define ARG_MODE 0x0000000000002000ULL
66	#define ARG_DEV 0x0000000000004000ULL
67	#define ARG_ADDR 0x0000000000008000ULL
68	#define ARG_LEN 0x0000000000010000ULL
69	#define ARG_MASK 0x0000000000020000ULL
70	#define ARG_SIGNUM 0x0000000000040000ULL
71	#define ARG_LOGIN 0x0000000000080000ULL
72	#define ARG_SADDRINET 0x0000000000100000ULL
73	#define ARG_SADDRINET6 0x0000000000200000ULL
74	#define ARG_SADDRUNIX 0x0000000000400000ULL
75	#define ARG_KPATH1 0x0000000000800000ULL
76	#define ARG_KPATH2 0x0000000001000000ULL
77	#define ARG_UPATH1 0x0000000002000000ULL
78	#define ARG_UPATH2 0x0000000004000000ULL
79	#define ARG_TEXT 0x0000000008000000ULL
80	#define ARG_VNODE1 0x0000000010000000ULL
81	#define ARG_VNODE2 0x0000000020000000ULL
82	#define ARG_SVIPC_CMD 0x0000000040000000ULL
83	#define ARG_SVIPC_PERM 0x0000000080000000ULL
84	#define ARG_SVIPC_ID 0x0000000100000000ULL
85	#define ARG_SVIPC_ADDR 0x0000000200000000ULL
86	#define ARG_GROUPSET 0x0000000400000000ULL
87	#define ARG_CMD 0x0000000800000000ULL
88	#define ARG_SOCKINFO 0x0000001000000000ULL
89	#define ARG_ASID 0x0000002000000000ULL
90	#define ARG_TERMID 0x0000004000000000ULL
91	#define ARG_AUDITON 0x0000008000000000ULL
92	#define ARG_VALUE 0x0000010000000000ULL
93	#define ARG_AMASK 0x0000020000000000ULL
94	#define ARG_CTLNAME 0x0000040000000000ULL
95	#define ARG_PROCESS 0x0000080000000000ULL
96	#define ARG_MACHPORT1 0x0000100000000000ULL
97	#define ARG_MACHPORT2 0x0000200000000000ULL
98	#define ARG_NONE 0x0000000000000000ULL
99	#define ARG_ALL 0xFFFFFFFFFFFFFFFFULL
100
101	/* Defines for the kernel audit record k_ar_commit field */
102	#define AR_COMMIT_KERNEL 0x00000001U
103	#define AR_COMMIT_USER 0x00000010U
104
105	struct vnode_au_info {
106	mode_t vn_mode;
107	uid_t vn_uid;
108	gid_t vn_gid;
109	dev_t vn_dev;
110	long vn_fsid;
111	long vn_fileid;
112	long vn_gen;
113	};
114
115	struct groupset {
116	gid_t gidset[NGROUPS];
117	u_int gidset_size;
118	};
119
120	struct socket_au_info {
121	int so_domain;
122	int so_type;
123	int so_protocol;
124	in_addr_t so_raddr; /* remote address if INET socket */
125	in_addr_t so_laddr; /* local address if INET socket */
126	u_short so_rport; /* remote port */
127	u_short so_lport; /* local port */
128	};
129
130	union auditon_udata {
131	char au_path[MAXPATHLEN];
132	long au_cond;
133	long au_flags;
134	long au_policy;
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_kpath1;
203	char *ar_arg_kpath2;
204	char *ar_arg_text;
205	struct au_mask ar_arg_amask;
206	struct vnode_au_info ar_arg_vnode1;
207	struct vnode_au_info ar_arg_vnode2;
208	int ar_arg_cmd;
209	int ar_arg_svipc_cmd;
210	struct ipc_perm ar_arg_svipc_perm;
211	int ar_arg_svipc_id;
212	void * ar_arg_svipc_addr;
213	struct posix_ipc_perm ar_arg_pipc_perm;
214	mach_port_t ar_arg_mach_port1;
215	mach_port_t ar_arg_mach_port2;
216	union auditon_udata ar_arg_auditon;
217	};
218
219	/*
220	* In-kernel version of audit record; the basic record plus queue meta-data.
221	* This record can also have a pointer set to some opaque data that will
222	* be passed through to the audit writing mechanism.
223	*/
224	struct kaudit_record {
225	struct audit_record k_ar;
226	u_int32_t k_ar_commit;
227	void k_udata; / user data */
228	u_int k_ulen; /* user data length */
229	struct uthread k_uthread; / thread we are auditing */
230	TAILQ_ENTRY(kaudit_record) k_q;
231	};
232
233	struct proc;
234	struct vnode;
235	struct componentname;
236
237	void audit_abort(struct kaudit_record *ar);
238	void audit_commit(struct kaudit_record *ar, int error,
239	int retval);
240	void audit_init(void);
241	void audit_shutdown(void);
242
243	struct kaudit_record audit_new(int event, struct proc p,
244	struct uthread *uthread);
245
246	void audit_syscall_enter(unsigned short code,
247	struct proc proc, struct uthread uthread);
248	void audit_syscall_exit(int error, struct proc *proc,
249	struct uthread *uthread);
250	void audit_mach_syscall_enter(unsigned short audit_event);
251	void audit_mach_syscall_exit(int retval,
252	struct uthread *uthread);
253
254	int kaudit_to_bsm(struct kaudit_record *kar,
255	struct au_record **pau);
256
257	int bsm_rec_verify(void *rec);
258
259	/*
260	* Kernel versions of the BSM audit record functions.
261	*/
262	struct au_record *kau_open(void);
263	int kau_write(struct au_record rec, token_t m);
264	int kau_close(struct au_record *rec,
265	struct timespec *endtime, short event);
266	void kau_free(struct au_record *rec);
267	void kau_init(void);
268	token_t kau_to_file(char file, struct timeval *tv);
269	token_t kau_to_header(struct timespec ctime, int rec_size,
270	au_event_t e_type, au_emod_t e_mod);
271	token_t kau_to_header32(struct timespec ctime, int rec_size,
272	au_event_t e_type, au_emod_t e_mod);
273	token_t kau_to_header64(struct timespec ctime, int rec_size,
274	au_event_t e_type, au_emod_t e_mod);
275	/*
276	* The remaining kernel functions are conditionally compiled in as they
277	* are wrapped by a macro, and the macro should be the only place in
278	* the source tree where these functions are referenced.
279	*/
280	#ifdef AUDIT
281	void audit_arg_addr(void * addr);
282	void audit_arg_len(int len);
283	void audit_arg_fd(int fd);
284	void audit_arg_fflags(int fflags);
285	void audit_arg_gid(gid_t gid, gid_t egid, gid_t rgid,
286	gid_t sgid);
287	void audit_arg_uid(uid_t uid, uid_t euid, uid_t ruid,
288	uid_t suid);
289	void audit_arg_groupset(gid_t *gidset, u_int gidset_size);
290	void audit_arg_login(char *login);
291	void audit_arg_ctlname(int *name, int namelen);
292	void audit_arg_mask(int mask);
293	void audit_arg_mode(mode_t mode);
294	void audit_arg_dev(int dev);
295	void audit_arg_value(long value);
296	void audit_arg_owner(uid_t uid, gid_t gid);
297	void audit_arg_pid(pid_t pid);
298	void audit_arg_process(struct proc *p);
299	void audit_arg_signum(u_int signum);
300	void audit_arg_socket(int sodomain, int sotype,
301	int soprotocol);
302	void audit_arg_sockaddr(struct proc *p,
303	struct sockaddr *so);
304	void audit_arg_auid(uid_t auid);
305	void audit_arg_auditinfo(struct auditinfo *au_info);
306	void audit_arg_upath(struct proc p, char upath,
307	u_int64_t flags);
308	void audit_arg_vnpath(struct vnode *vp, u_int64_t flags);
309	void audit_arg_text(char *text);
310	void audit_arg_cmd(int cmd);
311	void audit_arg_svipc_cmd(int cmd);
312	void audit_arg_svipc_perm(struct ipc_perm *perm);
313	void audit_arg_svipc_id(int id);
314	void audit_arg_svipc_addr(void *addr);
315	void audit_arg_posix_ipc_perm(uid_t uid, gid_t gid,
316	mode_t mode);
317	void audit_arg_auditon(union auditon_udata *udata);
318	void audit_arg_file(struct proc p, struct file fp);
319	void audit_arg_mach_port1(mach_port_t port);
320	void audit_arg_mach_port2(mach_port_t port);
321
322	void audit_sysclose(struct proc *p, int fd);
323
324	void audit_proc_init(struct proc *p);
325	void audit_proc_fork(struct proc *parent,
326	struct proc *child);
327	void audit_proc_free(struct proc *p);
328
329	/*
330	* Define a macro to wrap the audit_arg_* calls by checking the global
331	* audit_enabled flag before performing the actual call.
332	*/
333	#define AUDIT_ARG(op, args...) do { \
334	if (audit_enabled) \
335	audit_arg_ ## op (args); \
336	} while (0)
337
338	#define AUDIT_SYSCALL_ENTER(args...) do { \
339	if (audit_enabled) { \
340	audit_syscall_enter(args); \
341	} \
342	} while (0)
343
344	/*
345	* Wrap the audit_syscall_exit() function so that it is called only when
346	* auditing is enabled, or we have a audit record on the thread. It is
347	* possible that an audit record was begun before auditing was turned off.
348	*/
349	#define AUDIT_SYSCALL_EXIT(error, proc, uthread) do { \
350	if (audit_enabled \| (uthread->uu_ar != NULL)) { \
351	audit_syscall_exit(error, proc, uthread); \
352	} \
353	} while (0)
354
355	/*
356	* Wrap the audit_mach_syscall_enter() and audit_mach_syscall_exit()
357	* functions in a manner similar to other system call enter/exit functions.
358	*/
359	#define AUDIT_MACH_SYSCALL_ENTER(args...) do { \
360	if (audit_enabled) { \
361	audit_mach_syscall_enter(args); \
362	} \
363	} while (0)
364
365	#define AUDIT_MACH_SYSCALL_EXIT(retval) do { \
366	struct uthread *uthread = get_bsdthread_info(current_act()); \
367	if (audit_enabled \| (uthread->uu_ar != NULL)) { \
368	audit_mach_syscall_exit(retval, uthread); \
369	} \
370	} while (0)
371
372	/*
373	* A Macro to wrap the audit_sysclose() function.
374	*/
375	#define AUDIT_SYSCLOSE(args...) do { \
376	if (audit_enabled) \
377	audit_sysclose(args); \
378	} while (0)
379
380	#else /* !AUDIT */
381	#define AUDIT_SYSCALL_ENTER(args...) do { \
382	} while (0)
383
384	#define AUDIT_SYSCALL_EXIT(error, proc, uthread) do { \
385	} while (0)
386
387	#define AUDIT_MACH_SYSCALL_ENTER(args...) do { \
388	} while (0)
389
390	#define AUDIT_MACH_SYSCALL_EXIT(retval) do { \
391	} while (0)
392
393	#define AUDIT_SYSCLOSE(op, args...) do { \
394	} while (0)
395
396	#endif /* AUDIT */
397
398	#endif /* KERNEL */
399
400	#endif /* !_BSM_AUDIT_KERNEL_H */