1/*
2 * Copyright (c) 2010-2021 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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. 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.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
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.
25 *
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 */
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) */
85#define PRIV_SELECTIVE_FORCED_IDLE 1005 /* Configure and control Selective Forced Idle (SFI) subsystem */
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() */
94#define PRIV_TRIM_ACTIVE_FILE 1014 /* Allow freeing space out from under an active file */
95#define PRIV_PROC_CPUMON_OVERRIDE 1015 /* Allow CPU usage monitor parameters less restrictive than default */
96#define PRIV_ENDPOINTSECURITY_CLIENT 1016 /* Allow EndpointSecurity clients to connect */
97#define PRIV_AUDIT_SESSION_PORT 1017 /* Obtain send-right for arbitrary audit session's port. */
98
99/*
100 * Virtual memory privileges.
101 */
102#define PRIV_VM_PRESSURE 6000 /* Check VM pressure. */
103#define PRIV_VM_JETSAM 6001 /* Adjust jetsam configuration. */
104#define PRIV_VM_FOOTPRINT_LIMIT 6002 /* Adjust physical footprint limit. */
105
106/*
107 * Network stack privileges.
108 */
109#define PRIV_NET_PRIVILEGED_TRAFFIC_CLASS 10000 /* Set SO_PRIVILEGED_TRAFFIC_CLASS. */
110#define PRIV_NET_PRIVILEGED_SOCKET_DELEGATE 10001 /* Set delegate on a socket */
111#define PRIV_NET_INTERFACE_CONTROL 10002 /* Enable interface debug logging. */
112#define PRIV_NET_PRIVILEGED_NETWORK_STATISTICS 10003 /* Access to all sockets */
113#define PRIV_NET_PRIVILEGED_NECP_POLICIES 10004 /* Access to privileged Network Extension policies */
114#define PRIV_NET_RESTRICTED_AWDL 10005 /* Access to restricted AWDL mode */
115#define PRIV_NET_PRIVILEGED_NECP_MATCH 10006 /* Privilege verified by Network Extension policies */
116#define PRIV_NET_QOSMARKING_POLICY_OVERRIDE 10007 /* Privilege verified by Network Extension policies */
117#define PRIV_NET_RESTRICTED_INTCOPROC 10008 /* Access to internal co-processor network interfaces */
118
119/* unused 10009 */
120#define PRIV_NET_RESTRICTED_MULTIPATH_EXTENDED 10010 /* Extended multipath (more aggressive on cell) */
121#define PRIV_NET_RESTRICTED_ROUTE_NC_READ 10011 /* Enable route neighbhor cache read operations */
122
123#define PRIV_NET_PRIVILEGED_CLIENT_ACCESS 10012 /* Allow client networking access on restricted platforms */
124#define PRIV_NET_PRIVILEGED_SERVER_ACCESS 10013 /* Allow server networking access on restricted platforms */
125
126#define PRIV_NET_VALIDATED_RESOLVER 10014 /* Privilege to sign DNS resolver results for validation */
127
128#define PRIV_NET_CUSTOM_PROTOCOL 10015 /* Privilege to use custom protocol APIs */
129#define PRIV_NET_PRIVILEGED_NECP_DROP_ALL_BYPASS 10016 /* Privilege to bypass NECP drop-all */
130#define PRIV_NET_PRIVILEGED_IPSEC_WAKE_PACKET 10017 /* Privilege to get IPsec wake packet */
131
132#define PRIV_NET_RESTRICTED_MANAGEMENT_DATA 10018 /* Privilege to send/receive data over a management interface */
133
134/*
135 * IPv4 and IPv6 privileges.
136 */
137#define PRIV_NETINET_RESERVEDPORT 11000 /* Bind low port number. */
138#define PRIV_NETINET_TCP_KA_OFFLOAD 11001 /* Can set TCP keep alive offload option */
139
140/*
141 * Skywalk privileges.
142 */
143#define PRIV_SKYWALK_REGISTER_USER_PIPE 12000 /* Register a user pipe nexus */
144#define PRIV_SKYWALK_REGISTER_KERNEL_PIPE 12001 /* Register a kernel pipe nexus */
145#define PRIV_SKYWALK_REGISTER_NET_IF 12002 /* Register a net_if nexus */
146#define PRIV_SKYWALK_REGISTER_FLOW_SWITCH 12003 /* Register a flow switch nexus */
147#define PRIV_SKYWALK_LOW_LATENCY_CHANNEL 12004 /* open a low latency channel */
148#define PRIV_SKYWALK_OBSERVE_ALL 12010 /* Observe stats and data on channels */
149#define PRIV_SKYWALK_OBSERVE_STATS 12011 /* Observe stats only on channels */
150
151/*
152 * VFS privileges
153 */
154#define PRIV_VFS_OPEN_BY_ID 14000 /* Allow calling openbyid_np() */
155#define PRIV_VFS_MOVE_DATA_EXTENTS 14001 /* Allow F_MOVEDATAEXTENTS fcntl */
156#define PRIV_VFS_SNAPSHOT 14002 /* Allow create/rename/delete of snapshots */
157#define PRIV_VFS_DATALESS_RESOLVER 14004 /* Allow registration as dataless file resolver */
158#define PRIV_VFS_SETSIZE 14006 /* Allow resizing a file without zeroing space */
159
160#ifdef KERNEL
161/*
162 * Privilege check interface. No flags are currently defined for the API.
163 */
164#include <sys/cdefs.h>
165#include <sys/kauth.h>
166
167/*
168 * flags for priv_check_cred
169 */
170#define PRIVCHECK_DEFAULT_UNPRIVILEGED_FLAG (1) /* Don't grant root privilege by default */
171
172__BEGIN_DECLS
173int priv_check_cred(kauth_cred_t cred, int priv, int flags);
174__END_DECLS
175#endif
176
177#endif /* !_SYS_PRIV_H_ */
178