[apple/xnu.git] / bsd / security / audit / audit_ioctl.h

/*-
 * Copyright (c) 2006 Robert N. M. Watson
 * Copyright (c) 2008 Apple, Inc.
 * All rights reserved.
 *
 * This software was developed by Robert Watson for the TrustedBSD Project.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef _SECURITY_AUDIT_AUDIT_IOCTL_H_
#define _SECURITY_AUDIT_AUDIT_IOCTL_H_

#define AUDITPIPE_IOBASE        'A'
#define AUDITSDEV_IOBASE        'S'

/*
 * Data structures used for complex ioctl arguments.  Do not change existing
 * structures, add new revised ones to be used by new ioctls, and keep the
 * old structures and ioctls for backwards compatibility.
 */
struct auditpipe_ioctl_preselect {
	au_id_t         aip_auid;
	au_mask_t       aip_mask;
};

/*
 * Possible modes of operation for audit pipe preselection.
 */
#define AUDITPIPE_PRESELECT_MODE_TRAIL  1       /* Global audit trail. */
#define AUDITPIPE_PRESELECT_MODE_LOCAL  2       /* Local audit trail. */

/*
 * Ioctls to read and control the behavior of individual audit pipe devices.
 */
#define AUDITPIPE_GET_QLEN              _IOR(AUDITPIPE_IOBASE, 1, u_int)
#define AUDITPIPE_GET_QLIMIT            _IOR(AUDITPIPE_IOBASE, 2, u_int)
#define AUDITPIPE_SET_QLIMIT            _IOW(AUDITPIPE_IOBASE, 3, u_int)
#define AUDITPIPE_GET_QLIMIT_MIN        _IOR(AUDITPIPE_IOBASE, 4, u_int)
#define AUDITPIPE_GET_QLIMIT_MAX        _IOR(AUDITPIPE_IOBASE, 5, u_int)
#define AUDITPIPE_GET_PRESELECT_FLAGS   _IOR(AUDITPIPE_IOBASE, 6, au_mask_t)
#define AUDITPIPE_SET_PRESELECT_FLAGS   _IOW(AUDITPIPE_IOBASE, 7, au_mask_t)
#define AUDITPIPE_GET_PRESELECT_NAFLAGS _IOR(AUDITPIPE_IOBASE, 8, au_mask_t)
#define AUDITPIPE_SET_PRESELECT_NAFLAGS _IOW(AUDITPIPE_IOBASE, 9, au_mask_t)
#define AUDITPIPE_GET_PRESELECT_AUID    _IOR(AUDITPIPE_IOBASE, 10,      \
	                                    struct auditpipe_ioctl_preselect)
#define AUDITPIPE_SET_PRESELECT_AUID    _IOW(AUDITPIPE_IOBASE, 11,      \
	                                    struct auditpipe_ioctl_preselect)
#define AUDITPIPE_DELETE_PRESELECT_AUID _IOW(AUDITPIPE_IOBASE, 12, au_id_t)
#define AUDITPIPE_FLUSH_PRESELECT_AUID  _IO(AUDITPIPE_IOBASE, 13)
#define AUDITPIPE_GET_PRESELECT_MODE    _IOR(AUDITPIPE_IOBASE, 14, int)
#define AUDITPIPE_SET_PRESELECT_MODE    _IOW(AUDITPIPE_IOBASE, 15, int)
#define AUDITPIPE_FLUSH                 _IO(AUDITPIPE_IOBASE, 16)
#define AUDITPIPE_GET_MAXAUDITDATA      _IOR(AUDITPIPE_IOBASE, 17, u_int)

/*
 * Ioctls to retrieve audit pipe statistics.
 */
#define AUDITPIPE_GET_INSERTS           _IOR(AUDITPIPE_IOBASE, 100, u_int64_t)
#define AUDITPIPE_GET_READS             _IOR(AUDITPIPE_IOBASE, 101, u_int64_t)
#define AUDITPIPE_GET_DROPS             _IOR(AUDITPIPE_IOBASE, 102, u_int64_t)
#define AUDITPIPE_GET_TRUNCATES         _IOR(AUDITPIPE_IOBASE, 103, u_int64_t)

/*
 * Ioctls for the audit session device.
 */
#define AUDITSDEV_GET_QLEN              _IOR(AUDITSDEV_IOBASE, 1, u_int)
#define AUDITSDEV_GET_QLIMIT            _IOR(AUDITSDEV_IOBASE, 2, u_int)
#define AUDITSDEV_SET_QLIMIT            _IOW(AUDITSDEV_IOBASE, 3, u_int)
#define AUDITSDEV_GET_QLIMIT_MIN        _IOR(AUDITSDEV_IOBASE, 4, u_int)
#define AUDITSDEV_GET_QLIMIT_MAX        _IOR(AUDITSDEV_IOBASE, 5, u_int)
#define AUDITSDEV_FLUSH                 _IO(AUDITSDEV_IOBASE, 6)
#define AUDITSDEV_GET_MAXDATA           _IOR(AUDITSDEV_IOBASE, 7, u_int)

/*
 * Ioctls to retrieve and set the ALLSESSIONS flag in the audit session device.
 */
#define AUDITSDEV_GET_ALLSESSIONS       _IOR(AUDITSDEV_IOBASE, 100, u_int)
#define AUDITSDEV_SET_ALLSESSIONS       _IOW(AUDITSDEV_IOBASE, 101, u_int)

/*
 * Ioctls to retrieve audit sessions device statistics.
 */
#define AUDITSDEV_GET_INSERTS           _IOR(AUDITSDEV_IOBASE, 200, u_int64_t)
#define AUDITSDEV_GET_READS             _IOR(AUDITSDEV_IOBASE, 201, u_int64_t)
#define AUDITSDEV_GET_DROPS             _IOR(AUDITSDEV_IOBASE, 202, u_int64_t)

#endif /* _SECURITY_AUDIT_AUDIT_IOCTL_H_ */
Commit	Line	Data
b0d623f7 A	1	/*-
	2	* Copyright (c) 2006 Robert N. M. Watson
	3	* Copyright (c) 2008 Apple, Inc.
	4	* All rights reserved.
	5	*
	6	* This software was developed by Robert Watson for the TrustedBSD Project.
	7	*
	8	* Redistribution and use in source and binary forms, with or without
	9	* modification, are permitted provided that the following conditions
	10	* are met:
	11	* 1. Redistributions of source code must retain the above copyright
	12	* notice, this list of conditions and the following disclaimer.
	13	* 2. Redistributions in binary form must reproduce the above copyright
	14	* notice, this list of conditions and the following disclaimer in the
	15	* documentation and/or other materials provided with the distribution.
	16	*
	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND 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 THE AUTHOR OR CONTRIBUTORS BE LIABLE
	21	* FOR 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, STRICT
	25	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	26	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	27	* SUCH DAMAGE.
	28	*/
0a7de745	29
b0d623f7	30	#ifndef _SECURITY_AUDIT_AUDIT_IOCTL_H_
0a7de745	31	#define _SECURITY_AUDIT_AUDIT_IOCTL_H_
b0d623f7	32
0a7de745 A	33	#define AUDITPIPE_IOBASE 'A'
0a7de745 A	34	#define AUDITSDEV_IOBASE 'S'
b0d623f7 A	35
	36	/*
	37	* Data structures used for complex ioctl arguments. Do not change existing
	38	* structures, add new revised ones to be used by new ioctls, and keep the
	39	* old structures and ioctls for backwards compatibility.
	40	*/
	41	struct auditpipe_ioctl_preselect {
0a7de745 A	42	au_id_t aip_auid;
0a7de745 A	43	au_mask_t aip_mask;
b0d623f7 A	44	};
	45
	46	/*
	47	* Possible modes of operation for audit pipe preselection.
	48	*/
0a7de745 A	49	#define AUDITPIPE_PRESELECT_MODE_TRAIL 1 /* Global audit trail. */
0a7de745 A	50	#define AUDITPIPE_PRESELECT_MODE_LOCAL 2 /* Local audit trail. */
b0d623f7 A	51
	52	/*
	53	* Ioctls to read and control the behavior of individual audit pipe devices.
	54	*/
0a7de745 A	55	#define AUDITPIPE_GET_QLEN _IOR(AUDITPIPE_IOBASE, 1, u_int)
	56	#define AUDITPIPE_GET_QLIMIT _IOR(AUDITPIPE_IOBASE, 2, u_int)
	57	#define AUDITPIPE_SET_QLIMIT _IOW(AUDITPIPE_IOBASE, 3, u_int)
	58	#define AUDITPIPE_GET_QLIMIT_MIN _IOR(AUDITPIPE_IOBASE, 4, u_int)
	59	#define AUDITPIPE_GET_QLIMIT_MAX _IOR(AUDITPIPE_IOBASE, 5, u_int)
	60	#define AUDITPIPE_GET_PRESELECT_FLAGS _IOR(AUDITPIPE_IOBASE, 6, au_mask_t)
	61	#define AUDITPIPE_SET_PRESELECT_FLAGS _IOW(AUDITPIPE_IOBASE, 7, au_mask_t)
	62	#define AUDITPIPE_GET_PRESELECT_NAFLAGS _IOR(AUDITPIPE_IOBASE, 8, au_mask_t)
	63	#define AUDITPIPE_SET_PRESELECT_NAFLAGS _IOW(AUDITPIPE_IOBASE, 9, au_mask_t)
	64	#define AUDITPIPE_GET_PRESELECT_AUID _IOR(AUDITPIPE_IOBASE, 10, \
	65	struct auditpipe_ioctl_preselect)
	66	#define AUDITPIPE_SET_PRESELECT_AUID _IOW(AUDITPIPE_IOBASE, 11, \
	67	struct auditpipe_ioctl_preselect)
	68	#define AUDITPIPE_DELETE_PRESELECT_AUID _IOW(AUDITPIPE_IOBASE, 12, au_id_t)
	69	#define AUDITPIPE_FLUSH_PRESELECT_AUID _IO(AUDITPIPE_IOBASE, 13)
	70	#define AUDITPIPE_GET_PRESELECT_MODE _IOR(AUDITPIPE_IOBASE, 14, int)
	71	#define AUDITPIPE_SET_PRESELECT_MODE _IOW(AUDITPIPE_IOBASE, 15, int)
	72	#define AUDITPIPE_FLUSH _IO(AUDITPIPE_IOBASE, 16)
	73	#define AUDITPIPE_GET_MAXAUDITDATA _IOR(AUDITPIPE_IOBASE, 17, u_int)
b0d623f7 A	74
	75	/*
	76	* Ioctls to retrieve audit pipe statistics.
	77	*/
0a7de745 A	78	#define AUDITPIPE_GET_INSERTS _IOR(AUDITPIPE_IOBASE, 100, u_int64_t)
	79	#define AUDITPIPE_GET_READS _IOR(AUDITPIPE_IOBASE, 101, u_int64_t)
	80	#define AUDITPIPE_GET_DROPS _IOR(AUDITPIPE_IOBASE, 102, u_int64_t)
	81	#define AUDITPIPE_GET_TRUNCATES _IOR(AUDITPIPE_IOBASE, 103, u_int64_t)
b0d623f7	82
6d2010ae A	83	/*
	84	* Ioctls for the audit session device.
	85	*/
0a7de745 A	86	#define AUDITSDEV_GET_QLEN _IOR(AUDITSDEV_IOBASE, 1, u_int)
	87	#define AUDITSDEV_GET_QLIMIT _IOR(AUDITSDEV_IOBASE, 2, u_int)
	88	#define AUDITSDEV_SET_QLIMIT _IOW(AUDITSDEV_IOBASE, 3, u_int)
	89	#define AUDITSDEV_GET_QLIMIT_MIN _IOR(AUDITSDEV_IOBASE, 4, u_int)
	90	#define AUDITSDEV_GET_QLIMIT_MAX _IOR(AUDITSDEV_IOBASE, 5, u_int)
	91	#define AUDITSDEV_FLUSH _IO(AUDITSDEV_IOBASE, 6)
	92	#define AUDITSDEV_GET_MAXDATA _IOR(AUDITSDEV_IOBASE, 7, u_int)
6d2010ae A	93
	94	/*
	95	* Ioctls to retrieve and set the ALLSESSIONS flag in the audit session device.
	96	*/
0a7de745 A	97	#define AUDITSDEV_GET_ALLSESSIONS _IOR(AUDITSDEV_IOBASE, 100, u_int)
0a7de745 A	98	#define AUDITSDEV_SET_ALLSESSIONS _IOW(AUDITSDEV_IOBASE, 101, u_int)
6d2010ae A	99
	100	/*
	101	* Ioctls to retrieve audit sessions device statistics.
	102	*/
0a7de745 A	103	#define AUDITSDEV_GET_INSERTS _IOR(AUDITSDEV_IOBASE, 200, u_int64_t)
	104	#define AUDITSDEV_GET_READS _IOR(AUDITSDEV_IOBASE, 201, u_int64_t)
	105	#define AUDITSDEV_GET_DROPS _IOR(AUDITSDEV_IOBASE, 202, u_int64_t)
6d2010ae	106
b0d623f7	107	#endif /* _SECURITY_AUDIT_AUDIT_IOCTL_H_ */