[apple/xnu.git] / bsd / sys / priv.h

/*
 * Copyright (c) 2010-2014 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * 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. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * 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_OSREFERENCE_LICENSE_HEADER_END@
 */
/*-
 * Copyright (c) 2006 nCircle Network Security, Inc.
 * All rights reserved.
 *
 * This software was developed by Robert N. M. Watson for the TrustedBSD
 * Project under contract to nCircle Network Security, Inc.
 *
 * 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, NCIRCLE NETWORK SECURITY,
 * INC., 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.
 *
 * $FreeBSD: src/sys/sys/priv.h,v 1.38.2.1.2.1 2009/10/25 01:10:29 kensmith Exp $
 */

/*
 * Kernel privilege checking interface.
 */
#ifndef _SYS_PRIV_H_
#define	_SYS_PRIV_H_

/*
 * Privilege list, sorted loosely by kernel subsystem.
 *
 * Think carefully before adding or reusing one of these privileges -- are
 * there existing instances referring to the same privilege?  Particular
 * numeric privilege assignments are part of the kernel extension ABI.
 */

/*
 * The remaining privileges typically correspond to one or a small
 * number of specific privilege checks, and have (relatively) precise
 * meanings.  They are loosely sorted into a set of base system
 * privileges, such as the ability to reboot, and then loosely by
 * subsystem, indicated by a subsystem name.
 */
#define	PRIV_ADJTIME			1000	/* Set time adjustment. */
#define PRIV_PROC_UUID_POLICY		1001	/* Change process uuid policy table. */
#define PRIV_GLOBAL_PROC_INFO		1002	/* Query information for processes owned by other users */
#define PRIV_SYSTEM_OVERRIDE		1003	/* Override global system settings for various subsystems for a limited duration/system-mode */
#define PRIV_HW_DEBUG_DATA		1004	/* Extract hw-specific debug data (e.g. ECC data) */
#define PRIV_SELECTIVE_FORCED_IDLE	1005	/* Configure and control Selective Forced Idle (SFI) subsystem */
#define PRIV_PROC_TRACE_INSPECT		1006	/* Request trace memory of arbitrary process to be inspected */
#define PRIV_DARKBOOT			1007	/* Manipulate the darkboot flag */
#define PRIV_WORK_INTERVAL		1008	/* Express details about a work interval */
#define PRIV_SMB_TIMEMACHINE_CONTROL	1009	/* Control Time Machine properties of an SMB share */
#define PRIV_AUDIO_LATENCY		1010	/* set audio latency requirements for background tracing */
#define PRIV_KTRACE_BACKGROUND		1011	/* Operate ktrace in the background */
#define PRIV_SETPRIORITY_DARWIN_ROLE	1012	/* Allow setpriority(PRIO_DARWIN_ROLE) */
#define PRIV_PACKAGE_EXTENSIONS		1013	/* Push package extension list used by vn_path_package_check() */

/*
 * Virtual memory privileges.
 */
#define	PRIV_VM_PRESSURE	6000	/* Check VM pressure. */
#define	PRIV_VM_JETSAM	   	6001	/* Adjust jetsam configuration. */
#define	PRIV_VM_FOOTPRINT_LIMIT 6002    /* Adjust physical footprint limit. */

/*
 * Network stack privileges.
 */
#define	PRIV_NET_PRIVILEGED_TRAFFIC_CLASS	10000	/* Set SO_PRIVILEGED_TRAFFIC_CLASS. */
#define	PRIV_NET_PRIVILEGED_SOCKET_DELEGATE	10001	/* Set delegate on a socket */
#define	PRIV_NET_INTERFACE_CONTROL		10002	/* Enable interface debug logging. */
#define	PRIV_NET_PRIVILEGED_NETWORK_STATISTICS	10003	/* Access to all sockets */
#define	PRIV_NET_PRIVILEGED_NECP_POLICIES	10004	/* Access to privileged Network Extension policies */
#define	PRIV_NET_RESTRICTED_AWDL		10005	/* Access to restricted AWDL mode */
#define	PRIV_NET_PRIVILEGED_NECP_MATCH		10006	/* Privilege verified by Network Extension policies */
#define	PRIV_NET_QOSMARKING_POLICY_OVERRIDE	10007	/* Privilege verified by Network Extension policies */
#define	PRIV_NET_RESTRICTED_INTCOPROC		10008	/* Access to internal co-processor network interfaces */
/*
 * IPv4 and IPv6 privileges.
 */
#define	PRIV_NETINET_RESERVEDPORT	11000	/* Bind low port number. */


/*
 * VFS privileges
 */
#define PRIV_VFS_OPEN_BY_ID		14000 	/* Allow calling openbyid_np() */
#define PRIV_VFS_MOVE_DATA_EXTENTS	14001   /* Allow F_MOVEDATAEXTENTS fcntl */
#define PRIV_VFS_SNAPSHOT		14002	/* Allow calling fs_snapshot_*() */

#ifdef KERNEL
/*
 * Privilege check interface.  No flags are currently defined for the API.
 */
#include <sys/kauth.h>
int	priv_check_cred(kauth_cred_t cred, int priv, int flags);
#endif

#endif /* !_SYS_PRIV_H_ */
Commit	Line	Data
6d2010ae	1	/*
fe8ab488	2	* Copyright (c) 2010-2014 Apple Inc. All rights reserved.
6d2010ae A	3	*
6d2010ae A	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
39037602	5	*
6d2010ae A	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. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
39037602	14	*
6d2010ae A	15	* Please obtain a copy of the License at
6d2010ae A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
39037602	17	*
6d2010ae A	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
39037602	25	*
6d2010ae A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
	27	*/
	28	/*-
	29	* Copyright (c) 2006 nCircle Network Security, Inc.
	30	* All rights reserved.
	31	*
	32	* This software was developed by Robert N. M. Watson for the TrustedBSD
	33	* Project under contract to nCircle Network Security, Inc.
	34	*
	35	* Redistribution and use in source and binary forms, with or without
	36	* modification, are permitted provided that the following conditions
	37	* are met:
	38	* 1. Redistributions of source code must retain the above copyright
	39	* notice, this list of conditions and the following disclaimer.
	40	* 2. Redistributions in binary form must reproduce the above copyright
	41	* notice, this list of conditions and the following disclaimer in the
	42	* documentation and/or other materials provided with the distribution.
	43	*
	44	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
	45	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	46	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	47	* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR, NCIRCLE NETWORK SECURITY,
	48	* INC., OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	49	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
	50	* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
	51	* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
	52	* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
	53	* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	54	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	55	*
	56	* $FreeBSD: src/sys/sys/priv.h,v 1.38.2.1.2.1 2009/10/25 01:10:29 kensmith Exp $
	57	*/
	58
	59	/*
	60	* Kernel privilege checking interface.
	61	*/
	62	#ifndef _SYS_PRIV_H_
	63	#define _SYS_PRIV_H_
	64
	65	/*
	66	* Privilege list, sorted loosely by kernel subsystem.
	67	*
	68	* Think carefully before adding or reusing one of these privileges -- are
	69	* there existing instances referring to the same privilege? Particular
	70	* numeric privilege assignments are part of the kernel extension ABI.
	71	*/
	72
	73	/*
	74	* The remaining privileges typically correspond to one or a small
	75	* number of specific privilege checks, and have (relatively) precise
	76	* meanings. They are loosely sorted into a set of base system
	77	* privileges, such as the ability to reboot, and then loosely by
	78	* subsystem, indicated by a subsystem name.
	79	*/
39037602 A	80	#define PRIV_ADJTIME 1000 /* Set time adjustment. */
	81	#define PRIV_PROC_UUID_POLICY 1001 /* Change process uuid policy table. */
	82	#define PRIV_GLOBAL_PROC_INFO 1002 /* Query information for processes owned by other users */
	83	#define PRIV_SYSTEM_OVERRIDE 1003 /* Override global system settings for various subsystems for a limited duration/system-mode */
	84	#define PRIV_HW_DEBUG_DATA 1004 /* Extract hw-specific debug data (e.g. ECC data) */
fe8ab488	85	#define PRIV_SELECTIVE_FORCED_IDLE 1005 /* Configure and control Selective Forced Idle (SFI) subsystem */
39037602 A	86	#define PRIV_PROC_TRACE_INSPECT 1006 /* Request trace memory of arbitrary process to be inspected */
	87	#define PRIV_DARKBOOT 1007 /* Manipulate the darkboot flag */
	88	#define PRIV_WORK_INTERVAL 1008 /* Express details about a work interval */
	89	#define PRIV_SMB_TIMEMACHINE_CONTROL 1009 /* Control Time Machine properties of an SMB share */
	90	#define PRIV_AUDIO_LATENCY 1010 /* set audio latency requirements for background tracing */
	91	#define PRIV_KTRACE_BACKGROUND 1011 /* Operate ktrace in the background */
	92	#define PRIV_SETPRIORITY_DARWIN_ROLE 1012 /* Allow setpriority(PRIO_DARWIN_ROLE) */
	93	#define PRIV_PACKAGE_EXTENSIONS 1013 /* Push package extension list used by vn_path_package_check() */
6d2010ae	94
316670eb A	95	/*
	96	* Virtual memory privileges.
	97	*/
	98	#define PRIV_VM_PRESSURE 6000 /* Check VM pressure. */
	99	#define PRIV_VM_JETSAM 6001 /* Adjust jetsam configuration. */
39236c6e	100	#define PRIV_VM_FOOTPRINT_LIMIT 6002 /* Adjust physical footprint limit. */
316670eb A	101
	102	/*
	103	* Network stack privileges.
	104	*/
39037602	105	#define PRIV_NET_PRIVILEGED_TRAFFIC_CLASS 10000 /* Set SO_PRIVILEGED_TRAFFIC_CLASS. */
39236c6e A	106	#define PRIV_NET_PRIVILEGED_SOCKET_DELEGATE 10001 /* Set delegate on a socket */
	107	#define PRIV_NET_INTERFACE_CONTROL 10002 /* Enable interface debug logging. */
	108	#define PRIV_NET_PRIVILEGED_NETWORK_STATISTICS 10003 /* Access to all sockets */
fe8ab488 A	109	#define PRIV_NET_PRIVILEGED_NECP_POLICIES 10004 /* Access to privileged Network Extension policies */
	110	#define PRIV_NET_RESTRICTED_AWDL 10005 /* Access to restricted AWDL mode */
	111	#define PRIV_NET_PRIVILEGED_NECP_MATCH 10006 /* Privilege verified by Network Extension policies */
39037602 A	112	#define PRIV_NET_QOSMARKING_POLICY_OVERRIDE 10007 /* Privilege verified by Network Extension policies */
39037602 A	113	#define PRIV_NET_RESTRICTED_INTCOPROC 10008 /* Access to internal co-processor network interfaces */
6d2010ae A	114	/*
	115	* IPv4 and IPv6 privileges.
	116	*/
	117	#define PRIV_NETINET_RESERVEDPORT 11000 /* Bind low port number. */
	118
39037602	119
fe8ab488 A	120	/*
	121	* VFS privileges
	122	*/
c7d2c2c6 A	123	#define PRIV_VFS_OPEN_BY_ID 14000 /* Allow calling openbyid_np() */
c7d2c2c6 A	124	#define PRIV_VFS_MOVE_DATA_EXTENTS 14001 /* Allow F_MOVEDATAEXTENTS fcntl */
39037602	125	#define PRIV_VFS_SNAPSHOT 14002 /* Allow calling fs_snapshot_() /
fe8ab488	126
6d2010ae A	127	#ifdef KERNEL
	128	/*
	129	* Privilege check interface. No flags are currently defined for the API.
	130	*/
	131	#include <sys/kauth.h>
	132	int priv_check_cred(kauth_cred_t cred, int priv, int flags);
	133	#endif
	134
	135	#endif /* !_SYS_PRIV_H_ */