1 /*
2 * Copyright (c) 2013-2023 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 #ifndef _NET_NECP_H_
30 #define _NET_NECP_H_
31
32 #include <net/net_kev.h>
33 #ifdef PRIVATE
34
35 #include <netinet/in.h>
36 #include <netinet/in_private.h>
37 #include <netinet/in_stat.h>
38 #include <sys/socket.h>
39 #include <net/if_private.h>
40 #include <net/if_var_private.h>
41
42 #if SKYWALK
43 #include <skywalk/os_nexus_private.h>
44 #else /* !SKYWALK */
45 typedef uint16_t nexus_port_t;
46 #endif /* !SKYWALK */
47
48 /*
49 * Name registered by the NECP
50 */
51 #define NECP_CONTROL_NAME "com.apple.net.necp_control"
52
53 #define NECP_TLV_LENGTH_UINT32 1
54
55 struct necp_packet_header {
56 u_int8_t packet_type;
57 u_int8_t flags;
58 u_int32_t message_id;
59 };
60
61 typedef struct {
62 uid_t uid;
63 uuid_t effective_uuid;
64 uid_t persona_id;
65 } necp_application_id_t;
66
67 #define NECP_DOMAIN_TRIE_SUPPORT 1
68
69 /*
70 * Request sent from user-space to create a domain trie
71 */
72 #define NECP_DOMAIN_TRIE_FLAG_REVERSE_SEARCH 0x1
73 #define NECP_DOMAIN_TRIE_FLAG_ALLOW_PARTIAL_MATCH 0x2
74
75 typedef struct necp_domain_trie_request {
76 uint32_t id;
77 uint32_t total_mem_size;
78 uint32_t nodes_mem_size;
79 uint32_t maps_mem_size;
80 uint32_t bytes_mem_size;
81 uint32_t nodes_count;
82 uint32_t maps_count;
83 uint32_t bytes_count;
84 uint32_t partial_match_terminator;
85 uint32_t flags;
86 uint8_t data[__counted_by(total_mem_size)];
87 } necp_domain_trie_request_t;
88
89 /*
90 * Control message commands
91 */
92 #define NECP_PACKET_TYPE_POLICY_ADD 1
93 #define NECP_PACKET_TYPE_POLICY_GET 2
94 #define NECP_PACKET_TYPE_POLICY_DELETE 3
95 #define NECP_PACKET_TYPE_POLICY_APPLY_ALL 4
96 #define NECP_PACKET_TYPE_POLICY_LIST_ALL 5
97 #define NECP_PACKET_TYPE_POLICY_DELETE_ALL 6
98 #define NECP_PACKET_TYPE_SET_SESSION_PRIORITY 7
99 #define NECP_PACKET_TYPE_LOCK_SESSION_TO_PROC 8
100 #define NECP_PACKET_TYPE_REGISTER_SERVICE 9
101 #define NECP_PACKET_TYPE_UNREGISTER_SERVICE 10
102 #define NECP_PACKET_TYPE_POLICY_DUMP_ALL 11
103
104 /*
105 * Session actions
106 */
107 #define NECP_SESSION_ACTION_POLICY_ADD 1 // In: Policy TLVs Out: necp_policy_id
108 #define NECP_SESSION_ACTION_POLICY_GET 2 // In: necp_policy_id Out: Policy TLVs
109 #define NECP_SESSION_ACTION_POLICY_DELETE 3 // In: necp_policy_id Out: None
110 #define NECP_SESSION_ACTION_POLICY_APPLY_ALL 4 // In: None Out: None
111 #define NECP_SESSION_ACTION_POLICY_LIST_ALL 5 // In: None Out: TLVs of IDs
112 #define NECP_SESSION_ACTION_POLICY_DELETE_ALL 6 // In: None Out: None
113 #define NECP_SESSION_ACTION_SET_SESSION_PRIORITY 7 // In: necp_session_priority Out: None
114 #define NECP_SESSION_ACTION_LOCK_SESSION_TO_PROC 8 // In: None Out: None
115 #define NECP_SESSION_ACTION_REGISTER_SERVICE 9 // In: uuid_t Out: None
116 #define NECP_SESSION_ACTION_UNREGISTER_SERVICE 10 // In: uuid_t Out: None
117 #define NECP_SESSION_ACTION_POLICY_DUMP_ALL 11 // In: None Out: uint32_t bytes length, then Policy TLVs
118 #define NECP_SESSION_ACTION_ADD_DOMAIN_FILTER 12 // In: struct net_bloom_filter Out: uint32_t, ID
119 #define NECP_SESSION_ACTION_REMOVE_DOMAIN_FILTER 13 // In: uint32_t, ID Out: None
120 #define NECP_SESSION_ACTION_REMOVE_ALL_DOMAIN_FILTERS 14 // In: None Out: None
121 #define NECP_SESSION_ACTION_ADD_DOMAIN_TRIE 15 // In: struct necp_domain_trie_request Out: uint32_t, ID
122 #define NECP_SESSION_ACTION_REMOVE_DOMAIN_TRIE 16 // In: uint32_t, ID Out: None
123 #define NECP_SESSION_ACTION_REMOVE_ALL_DOMAIN_TRIES 17 // In: None Out: None
124 #define NECP_SESSION_ACTION_TRIE_DUMP_ALL 18 // In: None Out: uint8_t, count, then array of struct necp_domain_trie_request with no 'data'
125
126 /*
127 * Control message flags
128 */
129 #define NECP_PACKET_FLAGS_RESPONSE 0x01 // Used for acks, errors, and query responses
130
131 /*
132 * Control message TLV types
133 */
134 #define NECP_TLV_NIL 0
135 #define NECP_TLV_ERROR 1 // u_int32_t
136 #define NECP_TLV_POLICY_ORDER 2 // u_int32_t
137 #define NECP_TLV_POLICY_CONDITION 3
138 #define NECP_TLV_POLICY_RESULT 4
139 #define NECP_TLV_POLICY_ID 5 // u_int32_t
140 #define NECP_TLV_SESSION_PRIORITY 6 // u_int32_t
141 #define NECP_TLV_ATTRIBUTE_DOMAIN 7 // char[]
142 #define NECP_TLV_ATTRIBUTE_ACCOUNT 8 // char[]
143 #define NECP_TLV_SERVICE_UUID 9 // uuid_t
144 #define NECP_TLV_ROUTE_RULE 10
145 #define NECP_TLV_ATTRIBUTE_DOMAIN_OWNER 11 // char[]
146 #define NECP_TLV_ATTRIBUTE_TRACKER_DOMAIN 12 // char[]
147 #define NECP_TLV_ATTRIBUTE_DOMAIN_CONTEXT 13 // char[]
148
149 /*
150 * Control message TLV sent only by the kernel to userspace
151 */
152 #define NECP_TLV_POLICY_OWNER 100 // char []
153 #define NECP_TLV_POLICY_DUMP 101
154 #define NECP_TLV_POLICY_RESULT_STRING 102 // char []
155 #define NECP_TLV_POLICY_SESSION_ORDER 103 // u_int32_t
156
157 /*
158 * Condition flags
159 */
160 #define NECP_POLICY_CONDITION_FLAGS_NEGATIVE 0x01 // Negative
161 #define NECP_POLICY_CONDITION_FLAGS_EXACT 0x02 // For conditions that would otherwise have more inclusive matching, require an exact match
162
163 /*
164 * Added support for dumping negative conditions
165 */
166 #define NECP_POLICY_CONDITION_FLAGS_NEGATIVE_SUPPORTS_DUMP 1
167
168 /*
169 * Conditions
170 * Used for setting policies as well as passing parameters to necp_match_policy.
171 */
172 #define NECP_POLICY_CONDITION_DEFAULT 0 // N/A, not valid with any other conditions
173 // Socket/Application conditions
174 #define NECP_POLICY_CONDITION_APPLICATION 1 // uuid_t, uses effective UUID when possible
175 #define NECP_POLICY_CONDITION_REAL_APPLICATION 2 // uuid_t, never uses effective UUID. Only valid with NECP_POLICY_CONDITION_APPLICATION
176 #define NECP_POLICY_CONDITION_DOMAIN 3 // String, such as apple.com
177 #define NECP_POLICY_CONDITION_ACCOUNT 4 // String
178 #define NECP_POLICY_CONDITION_ENTITLEMENT 5 // String
179 #define NECP_POLICY_CONDITION_PID 6 // pid_t
180 #define NECP_POLICY_CONDITION_UID 7 // uid_t
181 #define NECP_POLICY_CONDITION_ALL_INTERFACES 8 // N/A
182 #define NECP_POLICY_CONDITION_BOUND_INTERFACE 9 // String
183 #define NECP_POLICY_CONDITION_TRAFFIC_CLASS 10 // necp_policy_condition_tc_range
184 // Socket/IP conditions
185 #define NECP_POLICY_CONDITION_IP_PROTOCOL 11 // u_int16_t
186 #define NECP_POLICY_CONDITION_LOCAL_ADDR 12 // necp_policy_condition_addr
187 #define NECP_POLICY_CONDITION_REMOTE_ADDR 13 // necp_policy_condition_addr
188 #define NECP_POLICY_CONDITION_LOCAL_ADDR_RANGE 14 // necp_policy_condition_addr_range
189 #define NECP_POLICY_CONDITION_REMOTE_ADDR_RANGE 15 // necp_policy_condition_addr_range
190 #define NECP_POLICY_CONDITION_AGENT_TYPE 16 // struct necp_policy_condition_agent_type
191 #define NECP_POLICY_CONDITION_HAS_CLIENT 17 // N/A
192 #define NECP_POLICY_CONDITION_LOCAL_NETWORKS 18 // Matches all local networks
193 // Socket-only conditions
194 #define NECP_POLICY_CONDITION_FLOW_IP_PROTOCOL 19 // u_int16_t
195 #define NECP_POLICY_CONDITION_FLOW_LOCAL_ADDR 20 // necp_policy_condition_addr
196 #define NECP_POLICY_CONDITION_FLOW_REMOTE_ADDR 21 // necp_policy_condition_addr
197 #define NECP_POLICY_CONDITION_FLOW_LOCAL_ADDR_RANGE 22 // necp_policy_condition_addr_range
198 #define NECP_POLICY_CONDITION_FLOW_REMOTE_ADDR_RANGE 23 // necp_policy_condition_addr_range
199 #define NECP_POLICY_CONDITION_FLOW_IS_LOOPBACK 31 // N/A
200 // Socket/Application conditions, continued
201 #define NECP_POLICY_CONDITION_CLIENT_FLAGS 24 // u_int32_t, values from NECP_CLIENT_PARAMETER_FLAG_*
202 #define NECP_POLICY_CONDITION_FLOW_LOCAL_ADDR_EMPTY 25 // N/A
203 #define NECP_POLICY_CONDITION_FLOW_REMOTE_ADDR_EMPTY 26 // N/A
204 #define NECP_POLICY_CONDITION_PLATFORM_BINARY 27 // N/A
205 #define NECP_POLICY_CONDITION_SDK_VERSION 28 // struct necp_policy_condition_sdk_version
206 #define NECP_POLICY_CONDITION_SIGNING_IDENTIFIER 29 // String
207 #define NECP_POLICY_CONDITION_PACKET_FILTER_TAGS 30 // u_int16_t
208 #define NECP_POLICY_CONDITION_DELEGATE_IS_PLATFORM_BINARY 32 // N/A
209 #define NECP_POLICY_CONDITION_DOMAIN_OWNER 33 // String, owner of domain (for example, "Google Inc")
210 #define NECP_POLICY_CONDITION_DOMAIN_CONTEXT 34 // String, eTLD+1 leading to networking activities to the domain
211 #define NECP_POLICY_CONDITION_TRACKER_DOMAIN 35 // String, tracker domain
212 #define NECP_POLICY_CONDITION_ATTRIBUTED_BUNDLE_IDENTIFIER 36 // String, app to which traffic is attributed to
213 #define NECP_POLICY_CONDITION_SCHEME_PORT 37 // u_int16_t, the port associated with the scheme for a connection
214 #define NECP_POLICY_CONDITION_DOMAIN_FILTER 38 // struct net_bloom_filter
215 #define NECP_POLICY_CONDITION_SYSTEM_SIGNED_RESULT 39 // N/A
216 #define NECP_POLICY_CONDITION_REAL_UID 40 // uid_t
217 #define NECP_POLICY_CONDITION_APPLICATION_ID 41 // necp_application_id_t
218 #define NECP_POLICY_CONDITION_URL 42 // String, URL
219 #define NECP_POLICY_CONDITION_BOUND_INTERFACE_FLAGS 43 // Interface flags: u_int32_t flags, u_int32_t eflags, u_int32_t xflags
220
221
222 /*
223 * Policy Condition Bound Interface Flags Order
224 */
225 #define NECP_POLICY_CONDITION_BOUND_INTERFACE_FLAGS_IDX_FLAGS 0
226 #define NECP_POLICY_CONDITION_BOUND_INTERFACE_FLAGS_IDX_EFLAGS 1
227 #define NECP_POLICY_CONDITION_BOUND_INTERFACE_FLAGS_IDX_XFLAGS 2
228 #define NECP_POLICY_CONDITION_BOUND_INTERFACE_FLAGS_IDX_MAX 3
229
230 /*
231 * Policy Packet tags
232 */
233 #define NECP_POLICY_CONDITION_PACKET_FILTER_TAG_STACK_DROP 0x01
234 #define NECP_POLICY_CONDITION_PACKET_FILTER_TAG_MAX NECP_POLICY_CONDITION_PACKET_FILTER_TAG_STACK_DROP
235
236 /*
237 * Results
238 */
239 #define NECP_POLICY_RESULT_PASS 1 // N/A
240 #define NECP_POLICY_RESULT_SKIP 2 // u_int32_t, policy order to skip to. 0 to skip all session policies.
241 #define NECP_POLICY_RESULT_DROP 3 // N/A
242 #define NECP_POLICY_RESULT_SOCKET_DIVERT 4 // u_int32_t, flow divert control unit
243 #define NECP_POLICY_RESULT_SOCKET_FILTER 5 // u_int32_t, filter control unit
244 #define NECP_POLICY_RESULT_IP_TUNNEL 6 // String, interface name
245 #define NECP_POLICY_RESULT_IP_FILTER 7 // ?
246 #define NECP_POLICY_RESULT_TRIGGER 8 // Deprecated
247 #define NECP_POLICY_RESULT_TRIGGER_IF_NEEDED 9 // Deprecated
248 #define NECP_POLICY_RESULT_TRIGGER_SCOPED 10 // Deprecated
249 #define NECP_POLICY_RESULT_NO_TRIGGER_SCOPED 11 // Deprecated
250 #define NECP_POLICY_RESULT_SOCKET_SCOPED 12 // String, interface name
251 #define NECP_POLICY_RESULT_ROUTE_RULES 13 // N/A, must have route rules defined
252 #define NECP_POLICY_RESULT_USE_NETAGENT 14 // netagent uuid_t
253 #define NECP_POLICY_RESULT_NETAGENT_SCOPED 15 // netagent uuid_t
254 #define NECP_POLICY_RESULT_SCOPED_DIRECT 16 // N/A, scopes to primary physical interface
255 #define NECP_POLICY_RESULT_ALLOW_UNENTITLED 17 // N/A
256 #define NECP_POLICY_RESULT_REMOVE_NETAGENT 18 // netagent uuid_t
257
258 #define NECP_POLICY_RESULT_MAX NECP_POLICY_RESULT_REMOVE_NETAGENT
259
260 /*
261 * PASS Result Flags
262 */
263 #define NECP_POLICY_PASS_NO_SKIP_IPSEC 0x01
264 #define NECP_POLICY_PASS_PF_TAG 0x02
265
266 /*
267 * DROP Result Flags
268 */
269 #define NECP_POLICY_DROP_FLAG_LOCAL_NETWORK 0x01
270 #define NECP_POLICY_DROP_FLAG_SUPPRESS_ALERTS 0x02
271
272 /*
273 * Local-Networks Condition Flags
274 */
275 #define NECP_POLICY_LOCAL_NETWORKS_FLAG_INCLUDE_LOCAL_ADDRESSES 0x01 // Include addresses on local interfaces for Local-Networks condition
276
277 /*
278 * Route Rules
279 * Detailed parameters for NECP_POLICY_RESULT_ROUTE_RULES.
280 */
281 #define NECP_ROUTE_RULE_NONE 0 // N/A
282 #define NECP_ROUTE_RULE_DENY_INTERFACE 1 // String, or empty to match all
283 #define NECP_ROUTE_RULE_ALLOW_INTERFACE 2 // String, or empty to match all
284 #define NECP_ROUTE_RULE_QOS_MARKING 3 // String, or empty to match all
285 #define NECP_ROUTE_RULE_DENY_LQM_ABORT 4 // String, or empty to match all
286 #define NECP_ROUTE_RULE_USE_NETAGENT 5 // UUID, followed by string or empty
287 #define NECP_ROUTE_RULE_REMOVE_NETAGENT 6 // UUID, followed by string or empty
288 #define NECP_ROUTE_RULE_DIVERT_SOCKET 7 // u_int32_t control unit, followed by string or empty
289 #define NECP_ROUTE_RULE_DENY_INTERFACE_WITH_TYPE 8 // u_int32_t effective type, followed by string or empty
290
291 #define NECP_ROUTE_RULE_FLAG_CELLULAR 0x01
292 #define NECP_ROUTE_RULE_FLAG_WIFI 0x02
293 #define NECP_ROUTE_RULE_FLAG_WIRED 0x04
294 #define NECP_ROUTE_RULE_FLAG_EXPENSIVE 0x08
295 #define NECP_ROUTE_RULE_FLAG_CONSTRAINED 0x10
296 #define NECP_ROUTE_RULE_FLAG_COMPANION 0x20
297 #define NECP_ROUTE_RULE_FLAG_VPN 0x40
298
299 #define NECP_ROUTE_RULE_FLAG_NETAGENT 0x80 // Last bit, reserved to mark that this applies only when an agent UUID is present
300
301 #define NECP_ROUTE_RULES_SUPPORT_NETAGENT_EXCEPTIONS 1
302
303 /*
304 * Error types
305 */
306 #define NECP_ERROR_INTERNAL 0
307 #define NECP_ERROR_UNKNOWN_PACKET_TYPE 1
308 #define NECP_ERROR_INVALID_TLV 2
309 #define NECP_ERROR_POLICY_RESULT_INVALID 3
310 #define NECP_ERROR_POLICY_CONDITIONS_INVALID 4
311 #define NECP_ERROR_POLICY_ID_NOT_FOUND 5
312 #define NECP_ERROR_INVALID_PROCESS 6
313 #define NECP_ERROR_ROUTE_RULES_INVALID 7
314
315 // Modifiers
316 #define NECP_MASK_USERSPACE_ONLY 0x80000000 // on filter_control_unit value
317 #define NECP_MASK_PRESERVE_CONNECTIONS 0x20000000 // on filter_control_unit value
318
319 struct necp_policy_condition_tc_range {
320 u_int32_t start_tc;
321 u_int32_t end_tc;
322 } __attribute__((__packed__));
323
324 struct necp_policy_condition_addr {
325 u_int8_t prefix;
326 union {
327 struct sockaddr sa;
328 struct sockaddr_in sin;
329 struct sockaddr_in6 sin6;
330 } address __attribute__((__packed__));
331 } __attribute__((__packed__));
332
333 struct necp_policy_condition_addr_range {
334 union {
335 struct sockaddr sa;
336 struct sockaddr_in sin;
337 struct sockaddr_in6 sin6;
338 } start_address __attribute__((__packed__));
339 union {
340 struct sockaddr sa;
341 struct sockaddr_in sin;
342 struct sockaddr_in6 sin6;
343 } end_address __attribute__((__packed__));
344 } __attribute__((__packed__));
345
346 struct necp_policy_condition_agent_type {
347 char agent_domain[32];
348 char agent_type[32];
349 } __attribute__((__packed__));
350
351 struct necp_policy_condition_sdk_version {
352 uint32_t platform; // e.g., PLATFORM_IOS
353 uint32_t min_version; // Encoded as XXXX.YY.ZZ
354 uint32_t version; // Encoded as XXXX.YY.ZZ
355 } __attribute__((__packed__));
356
357 #define NECP_SESSION_PRIORITY_UNKNOWN 0
358 #define NECP_SESSION_PRIORITY_CONTROL 1
359 #define NECP_SESSION_PRIORITY_CONTROL_1 2
360 #define NECP_SESSION_PRIORITY_PRIVILEGED_TUNNEL 3
361 #define NECP_SESSION_PRIORITY_HIGH 4
362 #define NECP_SESSION_PRIORITY_HIGH_1 5
363 #define NECP_SESSION_PRIORITY_HIGH_2 6
364 #define NECP_SESSION_PRIORITY_HIGH_3 7
365 #define NECP_SESSION_PRIORITY_HIGH_4 8
366 #define NECP_SESSION_PRIORITY_HIGH_RESTRICTED 9
367 #define NECP_SESSION_PRIORITY_DEFAULT 10
368 #define NECP_SESSION_PRIORITY_LOW 11
369 #define NECP_SESSION_NUM_PRIORITIES NECP_SESSION_PRIORITY_LOW
370
371 typedef u_int32_t necp_policy_id;
372 typedef u_int32_t necp_policy_order;
373 typedef u_int32_t necp_session_priority;
374
375 typedef u_int32_t necp_kernel_policy_result;
376 typedef u_int32_t necp_kernel_policy_filter;
377
378 typedef union {
379 u_int tunnel_interface_index;
380 u_int scoped_interface_index;
381 u_int32_t flow_divert_control_unit;
382 u_int32_t filter_control_unit;
383 u_int32_t pass_flags;
384 u_int32_t drop_flags;
385 } necp_kernel_policy_routing_result_parameter;
386
387 #define NECP_SERVICE_FLAGS_REGISTERED 0x01
388 #define NECP_MAX_NETAGENTS 16
389
390 #define NECP_AGENT_USE_FLAG_SCOPE 0x01
391 #define NECP_AGENT_USE_FLAG_REMOVE 0x02
392
393 #define NECP_TFO_COOKIE_LEN_MAX 16
394 struct necp_aggregate_result {
395 necp_kernel_policy_result routing_result;
396 necp_kernel_policy_routing_result_parameter routing_result_parameter;
397 necp_kernel_policy_filter filter_control_unit;
398 u_int32_t flow_divert_aggregate_unit;
399 necp_kernel_policy_result service_action;
400 uuid_t service_uuid;
401 u_int32_t service_flags;
402 u_int32_t service_data;
403 u_int routed_interface_index;
404 u_int32_t policy_id;
405 u_int32_t skip_policy_id;
406 uuid_t netagents[NECP_MAX_NETAGENTS];
407 u_int32_t netagent_use_flags[NECP_MAX_NETAGENTS];
408 struct ipv6_prefix nat64_prefixes[NAT64_MAX_NUM_PREFIXES];
409 u_int8_t mss_recommended;
410 };
411
412 /*
413 * Statistics. It would be nice if the definitions in ntstat.h could be used,
414 * but they get entangled with #defines for v4 etc in pfvar.h and it may be better practice
415 * to have separate definitions here.
416 */
417 struct necp_stat_counts {
418 /* Counters */
419 u_int64_t necp_stat_rxpackets __attribute__((aligned(8)));
420 u_int64_t necp_stat_rxbytes __attribute__((aligned(8)));
421 u_int64_t necp_stat_txpackets __attribute__((aligned(8)));
422 u_int64_t necp_stat_txbytes __attribute__((aligned(8)));
423
424 u_int32_t necp_stat_rxduplicatebytes;
425 u_int32_t necp_stat_rxoutoforderbytes;
426 u_int32_t necp_stat_txretransmit;
427
428 u_int32_t necp_stat_connectattempts;
429 u_int32_t necp_stat_connectsuccesses;
430
431 u_int32_t necp_stat_min_rtt;
432 u_int32_t necp_stat_avg_rtt;
433 u_int32_t necp_stat_var_rtt;
434
435 #define NECP_STAT_ROUTE_FLAGS 1
436 u_int32_t necp_stat_route_flags;
437 };
438
439 // Note, some metadata is implicit in the necp client itself:
440 // From the process itself : pid, upid, uuid, proc name.
441 // From the necp client parameters: local and remote addresses, euuid, traffic class, ifindex
442 //
443 // The following may well be supplied via future necp client parameters,
444 // but they are here so they don't get forgotten.
445 struct necp_basic_metadata {
446 u_int32_t rcvbufsize;
447 u_int32_t rcvbufused;
448 };
449
450 struct necp_connection_probe_status {
451 unsigned int probe_activated : 1;
452 unsigned int write_probe_failed : 1;
453 unsigned int read_probe_failed : 1;
454 unsigned int conn_probe_failed : 1;
455 };
456
457 struct necp_extra_tcp_metadata {
458 struct necp_connection_probe_status probestatus;
459
460 u_int32_t sndbufsize;
461 u_int32_t sndbufused;
462 u_int32_t txunacked;
463 u_int32_t txwindow;
464 u_int32_t txcwindow;
465 u_int32_t flags; // use SOF_*
466 u_int32_t flags1; // use SOF1_*
467 u_int32_t traffic_mgt_flags;
468 u_int32_t cc_alg_index;
469 u_int32_t state;
470 };
471
472 struct necp_stats_hdr {
473 u_int32_t necp_stats_type __attribute__((aligned(8)));
474 u_int32_t necp_stats_ver;
475 u_int64_t __necp_stats_reserved; // Pad the field for future use
476 };
477
478 #define NECP_CLIENT_STATISTICS_TYPE_TCP 1 // Identifies use of necp_tcp_stats
479 #define NECP_CLIENT_STATISTICS_TYPE_UDP 2 // Identifies use of necp_udp_stats
480 #define NECP_CLIENT_STATISTICS_TYPE_QUIC 3 // Identifies use of necp_quic_stats
481
482 #define NECP_CLIENT_STATISTICS_TYPE_TCP_VER_1 1 // Currently supported version for TCP
483 #define NECP_CLIENT_STATISTICS_TYPE_UDP_VER_1 1 // Currently supported version for UDP
484 #define NECP_CLIENT_STATISTICS_TYPE_QUIC_VER_1 1 // Currently supported version for QUIC
485
486 #define NECP_CLIENT_STATISTICS_TYPE_TCP_CURRENT_VER NECP_CLIENT_STATISTICS_TYPE_TCP_VER_1
487 #define NECP_CLIENT_STATISTICS_TYPE_UDP_CURRENT_VER NECP_CLIENT_STATISTICS_TYPE_UDP_VER_1
488 #define NECP_CLIENT_STATISTICS_TYPE_QUIC_CURRENT_VER NECP_CLIENT_STATISTICS_TYPE_QUIC_VER_1
489
490 #define NECP_CLIENT_STATISTICS_EVENT_INIT 0x00000000 // Register the flow
491 #define NECP_CLIENT_STATISTICS_EVENT_TIME_WAIT 0x00000001 // The flow is effectively finished but waiting on timer
492
493 struct necp_tcp_stats {
494 struct necp_stats_hdr necp_tcp_hdr;
495 struct necp_stat_counts necp_tcp_counts;
496 struct necp_basic_metadata necp_tcp_basic;
497 struct necp_extra_tcp_metadata necp_tcp_extra;
498 };
499
500 struct necp_udp_stats {
501 struct necp_stats_hdr necp_udp_hdr;
502 struct necp_stat_counts necp_udp_counts;
503 struct necp_basic_metadata necp_udp_basic;
504 };
505
506
507 /*
508 * The following reflects the special case for QUIC.
509 * It is a streaming protocol built on top of UDP.
510 * Therefore QUIC stats are defined as basic UDP stats
511 * with some extra meta data.
512 * TODO: For now the extra metadata is an exact replica
513 * of the metadata for TCP. However keeping that separate allows
514 * the structures to diverge later as new stats are added.
515 */
516 #define QUIC_STATELESS_RESET_TOKEN_SIZE 16
517 #define NECP_QUIC_HAS_PROBE_STATUS 1
518 struct necp_extra_quic_metadata {
519 u_int32_t sndbufsize;
520 u_int32_t sndbufused;
521 u_int32_t txunacked;
522 u_int32_t txwindow;
523 u_int32_t txcwindow;
524 u_int32_t traffic_mgt_flags;
525 u_int32_t cc_alg_index;
526 u_int32_t state;
527 u_int8_t ssr_token[QUIC_STATELESS_RESET_TOKEN_SIZE];
528 struct necp_connection_probe_status probestatus;
529 };
530
531 #define necp_quic_hdr necp_quic_udp_stats.necp_udp_hdr
532 #define necp_quic_counts necp_quic_udp_stats.necp_udp_counts
533 #define necp_quic_basic necp_quic_udp_stats.necp_udp_basic
534 struct necp_quic_stats {
535 struct necp_udp_stats necp_quic_udp_stats;
536 struct necp_extra_quic_metadata necp_quic_extra;
537 };
538
539 typedef struct necp_all_stats {
540 union {
541 struct necp_tcp_stats tcp_stats;
542 struct necp_udp_stats udp_stats;
543 struct necp_quic_stats quic_stats;
544 } all_stats_u;
545 } necp_all_stats;
546
547 // Memory for statistics is requested via a necp_stats_bufreq
548 //
549 struct necp_stats_bufreq {
550 u_int32_t necp_stats_bufreq_id __attribute__((aligned(8)));
551 u_int32_t necp_stats_bufreq_type; // NECP_CLIENT_STATISTICS_TYPE_*
552 u_int32_t necp_stats_bufreq_ver; // NECP_CLIENT_STATISTICS_TYPE_*_VER
553 u_int32_t necp_stats_bufreq_size;
554 union {
555 void *necp_stats_bufreq_addr;
556 mach_vm_address_t necp_stats_bufreq_uaddr;
557 };
558 };
559
560 #define NECP_CLIENT_STATISTICS_BUFREQ_ID 0xbf // Distinguishes from statistics actions taking a necp_all_stats struct
561
562 // There is a limit to the number of statistics structures that may be allocated per process, subject to change
563 //
564 #define NECP_MAX_PER_PROCESS_CLIENT_STATISTICS_STRUCTS 512
565
566 #define NECP_TCP_ECN_HEURISTICS_SYN_RST 1
567 typedef struct necp_tcp_ecn_cache {
568 u_int8_t necp_tcp_ecn_heuristics_success:1;
569 u_int8_t necp_tcp_ecn_heuristics_loss:1;
570 u_int8_t necp_tcp_ecn_heuristics_drop_rst:1;
571 u_int8_t necp_tcp_ecn_heuristics_drop_rxmt:1;
572 u_int8_t necp_tcp_ecn_heuristics_aggressive:1;
573 u_int8_t necp_tcp_ecn_heuristics_syn_rst:1;
574 } necp_tcp_ecn_cache;
575
576 #define NECP_TCP_TFO_HEURISTICS_RST 1
577 typedef struct necp_tcp_tfo_cache {
578 u_int8_t necp_tcp_tfo_cookie[NECP_TFO_COOKIE_LEN_MAX];
579 u_int8_t necp_tcp_tfo_cookie_len;
580 u_int8_t necp_tcp_tfo_heuristics_success:1; // TFO succeeded with data in the SYN
581 u_int8_t necp_tcp_tfo_heuristics_loss:1; // TFO SYN-loss with data
582 u_int8_t necp_tcp_tfo_heuristics_middlebox:1; // TFO middlebox detected
583 u_int8_t necp_tcp_tfo_heuristics_success_req:1; // TFO succeeded with the TFO-option in the SYN
584 u_int8_t necp_tcp_tfo_heuristics_loss_req:1; // TFO SYN-loss with the TFO-option
585 u_int8_t necp_tcp_tfo_heuristics_rst_data:1; // Recevied RST upon SYN with data in the SYN
586 u_int8_t necp_tcp_tfo_heuristics_rst_req:1; // Received RST upon SYN with the TFO-option
587 } necp_tcp_tfo_cache;
588
589 #define NECP_CLIENT_CACHE_TYPE_ECN 1 // Identifies use of necp_tcp_ecn_cache
590 #define NECP_CLIENT_CACHE_TYPE_TFO 2 // Identifies use of necp_tcp_tfo_cache
591
592 #define NECP_CLIENT_CACHE_TYPE_ECN_VER_1 1 // Currently supported version for ECN
593 #define NECP_CLIENT_CACHE_TYPE_TFO_VER_1 1 // Currently supported version for TFO
594
595 typedef struct necp_cache_buffer {
596 u_int8_t necp_cache_buf_type; // NECP_CLIENT_CACHE_TYPE_*
597 u_int8_t necp_cache_buf_ver; // NECP_CLIENT_CACHE_TYPE_*_VER
598 u_int32_t necp_cache_buf_size;
599 mach_vm_address_t necp_cache_buf_addr;
600 } necp_cache_buffer;
601
602 /*
603 * NECP Client definitions
604 */
605 #define NECP_MAX_CLIENT_PARAMETERS_SIZE 1024
606 #define NECP_MAX_CLIENT_RESULT_SIZE 512 // Legacy
607 #define NECP_BASE_CLIENT_RESULT_SIZE 1024
608 #define NECP_CLIENT_FLOW_RESULT_SIZE 512
609
610 #define NECP_OPEN_FLAG_OBSERVER 0x01 // Observers can query clients they don't own
611 #define NECP_OPEN_FLAG_BACKGROUND 0x02 // Mark this fd as backgrounded
612 #define NECP_OPEN_FLAG_PUSH_OBSERVER 0x04 // When used with the OBSERVER flag, allows updates to be pushed. Adding clients is not allowed in this mode.
613
614 #define NECP_FD_SUPPORTS_GUARD 1
615
616 #define NECP_CLIENT_ACTION_ADD 1 // Register a new client. Input: parameters in buffer; Output: client_id
617 #define NECP_CLIENT_ACTION_REMOVE 2 // Unregister a client. Input: client_id, optional struct ifnet_stats_per_flow
618 #define NECP_CLIENT_ACTION_COPY_PARAMETERS 3 // Copy client parameters. Input: client_id; Output: parameters in buffer
619 #define NECP_CLIENT_ACTION_COPY_RESULT 4 // Copy client result. Input: client_id; Output: result in buffer
620 #define NECP_CLIENT_ACTION_COPY_LIST 5 // Copy all client IDs. Output: struct necp_client_list in buffer
621 #define NECP_CLIENT_ACTION_REQUEST_NEXUS_INSTANCE 6 // Request a nexus instance from a nexus provider, optional struct necp_stats_bufreq
622 #define NECP_CLIENT_ACTION_AGENT 7 // Interact with agent. Input: client_id, agent parameters
623 #define NECP_CLIENT_ACTION_COPY_AGENT 8 // Copy agent content. Input: agent UUID; Output: struct netagent
624 #define NECP_CLIENT_ACTION_COPY_INTERFACE 9 // Copy interface details. Input: ifindex cast to UUID; Output: struct necp_interface_details
625 #define NECP_CLIENT_ACTION_SET_STATISTICS 10 // Deprecated
626 #define NECP_CLIENT_ACTION_COPY_ROUTE_STATISTICS 11 // Get route statistics. Input: client_id; Output: struct necp_stat_counts
627 #define NECP_CLIENT_ACTION_AGENT_USE 12 // Return the use count and increment the use count. Input/Output: struct necp_agent_use_parameters
628 #define NECP_CLIENT_ACTION_MAP_SYSCTLS 13 // Get the read-only sysctls memory location. Output: mach_vm_address_t
629 #define NECP_CLIENT_ACTION_UPDATE_CACHE 14 // Update heuristics and cache
630 #define NECP_CLIENT_ACTION_COPY_CLIENT_UPDATE 15 // Fetch an updated client for push-mode observer. Output: Client id, struct necp_client_observer_update in buffer
631 #define NECP_CLIENT_ACTION_COPY_UPDATED_RESULT 16 // Copy client result only if changed. Input: client_id; Output: result in buffer
632 #define NECP_CLIENT_ACTION_ADD_FLOW 17 // Add a flow. Input: client_id; Output: struct necp_client_add_flow
633 #define NECP_CLIENT_ACTION_REMOVE_FLOW 18 // Remove a flow. Input: flow_id, optional struct ifnet_stats_per_flow
634 #define NECP_CLIENT_ACTION_CLAIM 19 // Claim a client that has been added for this unique PID. Input: client_id
635 #define NECP_CLIENT_ACTION_SIGN 20 // Sign a query answer. Input: struct necp_client_signable; Output: struct necp_client_signature
636 #define NECP_CLIENT_ACTION_GET_INTERFACE_ADDRESS 21 // Get the best interface local address for given remote address. Input: ifindex, remote sockaddr; Output: matching local sockaddr
637 #define NECP_CLIENT_ACTION_ACQUIRE_AGENT_TOKEN 22 // Get a one-time use token from an agent. Input: agent UUID; Output: token buffer
638 #define NECP_CLIENT_ACTION_VALIDATE 23 // Validate a query answer. Input: struct necp_client_validatable; Output: None
639 #define NECP_CLIENT_ACTION_GET_SIGNED_CLIENT_ID 24 // Get a client ID for the appliction along with a signature.
640 #define NECP_CLIENT_ACTION_SET_SIGNED_CLIENT_ID 25 // Set a client ID for the appliction along with a signature.
641 #define NECP_CLIENT_ACTION_COPY_UPDATED_RESULT_FINAL 26 // Copy client result only if changed, discard data if buffer is too small. Input: client_id; Output: result in buffer
642
643 #define NECP_CLIENT_PARAMETER_APPLICATION NECP_POLICY_CONDITION_APPLICATION // Requires entitlement
644 #define NECP_CLIENT_PARAMETER_REAL_APPLICATION NECP_POLICY_CONDITION_REAL_APPLICATION // Requires entitlement
645 #define NECP_CLIENT_PARAMETER_DOMAIN NECP_POLICY_CONDITION_DOMAIN
646 #define NECP_CLIENT_PARAMETER_DOMAIN_OWNER NECP_POLICY_CONDITION_DOMAIN_OWNER
647 #define NECP_CLIENT_PARAMETER_DOMAIN_CONTEXT NECP_POLICY_CONDITION_DOMAIN_CONTEXT
648 #define NECP_CLIENT_PARAMETER_TRACKER_DOMAIN NECP_POLICY_CONDITION_TRACKER_DOMAIN
649 #define NECP_CLIENT_PARAMETER_URL NECP_POLICY_CONDITION_URL
650 #define NECP_CLIENT_PARAMETER_ATTRIBUTED_BUNDLE_IDENTIFIER NECP_POLICY_CONDITION_ATTRIBUTED_BUNDLE_IDENTIFIER
651 #define NECP_CLIENT_PARAMETER_ACCOUNT NECP_POLICY_CONDITION_ACCOUNT
652 #define NECP_CLIENT_PARAMETER_PID NECP_POLICY_CONDITION_PID // Requires entitlement
653 #define NECP_CLIENT_PARAMETER_UID NECP_POLICY_CONDITION_UID // Requires entitlement
654 #define NECP_CLIENT_PARAMETER_BOUND_INTERFACE NECP_POLICY_CONDITION_BOUND_INTERFACE
655 #define NECP_CLIENT_PARAMETER_TRAFFIC_CLASS NECP_POLICY_CONDITION_TRAFFIC_CLASS
656 #define NECP_CLIENT_PARAMETER_IP_PROTOCOL NECP_POLICY_CONDITION_IP_PROTOCOL
657 #define NECP_CLIENT_PARAMETER_LOCAL_ADDRESS NECP_POLICY_CONDITION_LOCAL_ADDR
658 #define NECP_CLIENT_PARAMETER_REMOTE_ADDRESS NECP_POLICY_CONDITION_REMOTE_ADDR
659 #define NECP_CLIENT_PARAMETER_SCHEME_PORT NECP_POLICY_CONDITION_SCHEME_PORT
660 #define NECP_CLIENT_PARAMETER_APPLICATION_ID NECP_POLICY_CONDITION_APPLICATION_ID
661 #define NECP_CLIENT_PARAMETER_NEXUS_KEY 102
662
663 // "Prohibit" will never choose an interface with that property
664 #define NECP_CLIENT_PARAMETER_PROHIBIT_INTERFACE 100 // String, interface name
665 #define NECP_CLIENT_PARAMETER_PROHIBIT_IF_TYPE 101 // u_int8_t, see ifru_functional_type in <net/if.h>
666 #define NECP_CLIENT_PARAMETER_PROHIBIT_AGENT 102 // uuid_t, network agent UUID
667 #define NECP_CLIENT_PARAMETER_PROHIBIT_AGENT_TYPE 103 // struct necp_client_parameter_netagent_type
668
669 // "Require" will choose an interface with that property, or none if not found
670 #define NECP_CLIENT_PARAMETER_REQUIRE_IF_TYPE 111 // u_int8_t, see ifru_functional_type in <net/if.h>
671 #define NECP_CLIENT_PARAMETER_REQUIRE_AGENT 112 // uuid_t, network agent UUID
672 #define NECP_CLIENT_PARAMETER_REQUIRE_AGENT_TYPE 113 // struct necp_client_parameter_netagent_type
673
674 // "Prefer" will choose an interface with an agent, or best otherwise if not found
675 #define NECP_CLIENT_PARAMETER_PREFER_AGENT 122 // uuid_t, network agent UUID
676 #define NECP_CLIENT_PARAMETER_PREFER_AGENT_TYPE 123 // struct necp_client_parameter_netagent_type
677
678 // "Avoid" will choose an interface without an agent, or best otherwise if unavoidable
679 #define NECP_CLIENT_PARAMETER_AVOID_AGENT 124 // uuid_t, network agent UUID
680 #define NECP_CLIENT_PARAMETER_AVOID_AGENT_TYPE 125 // struct necp_client_parameter_netagent_type
681
682 // Use actions with NECP_CLIENT_ACTION_AGENT
683 #define NECP_CLIENT_PARAMETER_TRIGGER_AGENT 130 // uuid_t, network agent UUID
684 #define NECP_CLIENT_PARAMETER_ASSERT_AGENT 131 // uuid_t, network agent UUID
685 #define NECP_CLIENT_PARAMETER_UNASSERT_AGENT 132 // uuid_t, network agent UUID
686 #define NECP_CLIENT_PARAMETER_AGENT_ADD_GROUP_MEMBERS 133 // struct necp_client_group_action
687 #define NECP_CLIENT_PARAMETER_AGENT_REMOVE_GROUP_MEMBERS 134 // struct necp_client_group_action
688 #define NECP_CLIENT_PARAMETER_REPORT_AGENT_ERROR 135 // int32_t
689
690 #define NECP_CLIENT_PARAMETER_FALLBACK_MODE 140 // u_int8_t, see SO_FALLBACK_MODE_* values
691
692 #define NECP_CLIENT_PARAMETER_PARENT_ID 150 // uuid_t, client UUID
693
694 #define NECP_CLIENT_PARAMETER_LOCAL_ENDPOINT 200 // struct necp_client_endpoint
695 #define NECP_CLIENT_PARAMETER_REMOTE_ENDPOINT 201 // struct necp_client_endpoint
696 #define NECP_CLIENT_PARAMETER_BROWSE_DESCRIPTOR 202 // struct necp_client_endpoint
697 #define NECP_CLIENT_PARAMETER_RESOLVER_TAG 203 // struct necp_client_validatable
698 #define NECP_CLIENT_PARAMETER_ADVERTISE_DESCRIPTOR 204 // struct necp_client_endpoint
699 #define NECP_CLIENT_PARAMETER_GROUP_DESCRIPTOR 205 // struct necp_client_group
700
701 #define NECP_CLIENT_PARAMETER_DELEGATED_UPID 210 // u_int64_t, requires entitlement
702
703 #define NECP_CLIENT_PARAMETER_ETHERTYPE 220 // u_int16_t, ethertype
704 #define NECP_CLIENT_PARAMETER_TRANSPORT_PROTOCOL 221 // u_int8_t, IPPROTO_
705
706 #define NECP_CLIENT_PARAMETER_LOCAL_ADDRESS_PREFERENCE 230 // u_int8_t, NECP_CLIENT_PARAMETER_LOCAL_ADDRESS_PREFERENCE_
707
708 #define NECP_CLIENT_PARAMETER_LOCAL_ADDRESS_PREFERENCE_DEFAULT 0
709 #define NECP_CLIENT_PARAMETER_LOCAL_ADDRESS_PREFERENCE_TEMPORARY 1
710 #define NECP_CLIENT_PARAMETER_LOCAL_ADDRESS_PREFERENCE_STABLE 2
711
712 #define NECP_CLIENT_PARAMETER_PERSONA_ID 231 // Used to send persona to agents
713
714 #define NECP_CLIENT_PARAMETER_FLAGS 250 // u_int32_t, see NECP_CLIENT_PAREMETER_FLAG_* values
715 #define NECP_CLIENT_PARAMETER_FLOW_DEMUX_PATTERN 251 // struct necp_demux_pattern
716
717 #define NECP_CLIENT_PARAMETER_FLAG_MULTIPATH 0x0001 // Get multipath interface results
718 #define NECP_CLIENT_PARAMETER_FLAG_BROWSE 0x0002 // Agent assertions on nexuses are requests to browse
719 #define NECP_CLIENT_PARAMETER_FLAG_PROHIBIT_EXPENSIVE 0x0004 // Prohibit expensive interfaces
720 #define NECP_CLIENT_PARAMETER_FLAG_LISTENER 0x0008 // Client is interested in listening for inbound connections
721 #define NECP_CLIENT_PARAMETER_FLAG_DISCRETIONARY 0x0010 // Client's traffic is discretionary, and eligible for early defuncting
722 #define NECP_CLIENT_PARAMETER_FLAG_ECN_ENABLE 0x0020 // Client is requesting to enable ECN
723 #define NECP_CLIENT_PARAMETER_FLAG_ECN_DISABLE 0x0040 // Client is requesting to disable ECN
724 #define NECP_CLIENT_PARAMETER_FLAG_TFO_ENABLE 0x0080 // Client is requesting to enable TFO
725 #define NECP_CLIENT_PARAMETER_FLAG_ONLY_PRIMARY_REQUIRES_TYPE 0x0100 // Interpret NECP_CLIENT_PARAMETER_REQUIRE_IF_TYPE only for primary interface, and allow exceptions for multipath or listeners
726 #define NECP_CLIENT_PARAMETER_FLAG_CUSTOM_ETHER 0x0200 // Client expects to open a custom ethernet channel
727 #define NECP_CLIENT_PARAMETER_FLAG_CUSTOM_IP 0x0400 // Client expects to open a custom IP protocol channel
728 #define NECP_CLIENT_PARAMETER_FLAG_INTERPOSE 0x0800 // Client expects to open an interpose filter channel
729 #define NECP_CLIENT_PARAMETER_FLAG_PROHIBIT_CONSTRAINED 0x1000 // Prohibit constrained interfaces
730 #define NECP_CLIENT_PARAMETER_FLAG_FALLBACK_TRAFFIC 0x2000 // Fallback traffic
731 #define NECP_CLIENT_PARAMETER_FLAG_INBOUND 0x4000 // Flow is inbound (passive)
732 #define NECP_CLIENT_PARAMETER_FLAG_SYSTEM_PROXY 0x8000 // Flow is a system proxy
733 #define NECP_CLIENT_PARAMETER_FLAG_KNOWN_TRACKER 0x10000 // Flow is contacting a known tracker
734 #define NECP_CLIENT_PARAMETER_FLAG_UNSAFE_SOCKET_ACCESS 0x20000 // Client allows direct access to sockets
735 #define NECP_CLIENT_PARAMETER_FLAG_NON_APP_INITIATED 0x40000 // Networking activities not initiated by application
736 #define NECP_CLIENT_PARAMETER_FLAG_THIRD_PARTY_WEB_CONTENT 0x80000 // Third-party web content, not main load
737 #define NECP_CLIENT_PARAMETER_FLAG_SILENT 0x100000 // Private browsing - do not log/track
738 #define NECP_CLIENT_PARAMETER_FLAG_APPROVED_APP_DOMAIN 0x200000 // Approved associated app domain; domain is "owned" by app
739 #define NECP_CLIENT_PARAMETER_FLAG_NO_WAKE_FROM_SLEEP 0x400000 // Don't wake from sleep on traffic for this client
740 #define NECP_CLIENT_PARAMETER_FLAG_REUSE_LOCAL 0x800000 // Request support for local address/port reuse
741 #define NECP_CLIENT_PARAMETER_FLAG_ENHANCED_PRIVACY 0x1000000 // Attempt protocol upgrade or proxy usage for more privacy
742 #define NECP_CLIENT_PARAMETER_FLAG_WEB_SEARCH_CONTENT 0x2000000 // Web search traffic
743 #define NECP_CLIENT_PARAMETER_FLAG_ALLOW_ULTRA_CONSTRAINED 0x4000000 // Allow ultra-constrained interfaces
744 #define NECP_CLIENT_PARAMETER_FLAG_HAS_ACCOUNT_ID 0x8000000 // Client has provided an account identifier
745
746 #define NECP_CLIENT_RESULT_CLIENT_ID 1 // uuid_t
747 #define NECP_CLIENT_RESULT_POLICY_RESULT 2 // u_int32_t
748 #define NECP_CLIENT_RESULT_POLICY_RESULT_PARAMETER 3 // u_int32_t
749 #define NECP_CLIENT_RESULT_FILTER_CONTROL_UNIT 4 // u_int32_t
750 #define NECP_CLIENT_RESULT_INTERFACE_INDEX 5 // u_int32_t
751 #define NECP_CLIENT_RESULT_NETAGENT 6 // struct necp_client_result_netagent
752 #define NECP_CLIENT_RESULT_FLAGS 7 // u_int32_t, see NECP_CLIENT_RESULT_FLAG_* values
753 #define NECP_CLIENT_RESULT_INTERFACE 8 // struct necp_client_result_interface
754 #define NECP_CLIENT_RESULT_INTERFACE_OPTION 9 // struct necp_client_interface_option
755 #define NECP_CLIENT_RESULT_EFFECTIVE_MTU 10 // u_int32_t
756 #define NECP_CLIENT_RESULT_FLOW 11 // TLV array of a single flow's state
757 #define NECP_CLIENT_RESULT_PROTO_CTL_EVENT 12
758 #define NECP_CLIENT_RESULT_TFO_COOKIE 13 // NECP_TFO_COOKIE_LEN_MAX
759 #define NECP_CLIENT_RESULT_TFO_FLAGS 14 // u_int8_t
760 #define NECP_CLIENT_RESULT_RECOMMENDED_MSS 15 // u_int8_t
761 #define NECP_CLIENT_RESULT_FLOW_ID 16 // uuid_t
762 #define NECP_CLIENT_RESULT_INTERFACE_TIME_DELTA 17 // u_int32_t, seconds since interface up/down
763 #define NECP_CLIENT_RESULT_REASON 18 // u_int32_t, see NECP_CLIENT_RESULT_REASON_* values
764 #define NECP_CLIENT_RESULT_FLOW_DIVERT_AGGREGATE_UNIT 19 // u_int32_t
765 #define NECP_CLIENT_RESULT_REQUEST_IN_PROCESS_FLOW_DIVERT 20 // Empty
766
767 #define NECP_CLIENT_RESULT_NEXUS_INSTANCE 100 // uuid_t
768 #define NECP_CLIENT_RESULT_NEXUS_PORT 101 // nexus_port_t
769 #define NECP_CLIENT_RESULT_NEXUS_KEY 102 // uuid_t
770 #define NECP_CLIENT_RESULT_NEXUS_PORT_FLOW_INDEX 103 // u_int32_t
771 #define NECP_CLIENT_RESULT_NEXUS_FLOW_STATS 104 // struct sk_stats_flow *
772
773 #define NECP_CLIENT_RESULT_LOCAL_ENDPOINT 200 // struct necp_client_endpoint
774 #define NECP_CLIENT_RESULT_REMOTE_ENDPOINT 201 // struct necp_client_endpoint
775 #define NECP_CLIENT_RESULT_DISCOVERED_ENDPOINT 202 // struct necp_client_endpoint, result of browse
776 #define NECP_CLIENT_RESULT_RESOLVED_ENDPOINT 203 // struct necp_client_endpoint, result of resolve
777 #define NECP_CLIENT_RESULT_LOCAL_ETHER_ADDR 204 // struct ether_addr
778 #define NECP_CLIENT_RESULT_REMOTE_ETHER_ADDR 205 // struct ether_addr
779 #define NECP_CLIENT_RESULT_EFFECTIVE_TRAFFIC_CLASS 210 // u_int32_t
780 #define NECP_CLIENT_RESULT_TRAFFIC_MGMT_BG 211 // u_int32_t, 1: background, 0: not background
781 #define NECP_CLIENT_RESULT_GATEWAY 212 // struct necp_client_endpoint
782 #define NECP_CLIENT_RESULT_GROUP_MEMBER 213 // struct necp_client_endpoint
783 #define NECP_CLIENT_RESULT_NAT64 214 // struct ipv6_prefix[NAT64_MAX_NUM_PREFIXES]
784 #define NECP_CLIENT_RESULT_ESTIMATED_THROUGHPUT 215 // struct necp_client_result_estimated_throughput
785 #define NECP_CLIENT_RESULT_AGENT_ERROR 216 // struct necp_client_result_agent_error
786
787 #define NECP_CLIENT_RESULT_FLAG_IS_LOCAL 0x0001 // Routes to this device
788 #define NECP_CLIENT_RESULT_FLAG_IS_DIRECT 0x0002 // Routes to directly accessible peer
789 #define NECP_CLIENT_RESULT_FLAG_HAS_IPV4 0x0004 // Supports IPv4
790 #define NECP_CLIENT_RESULT_FLAG_HAS_IPV6 0x0008 // Supports IPv6
791 #define NECP_CLIENT_RESULT_FLAG_DEFUNCT 0x0010 // Defunct
792 #define NECP_CLIENT_RESULT_FLAG_SATISFIED 0x0020 // Satisfied path
793 #define NECP_CLIENT_RESULT_FLAG_FLOW_ASSIGNED 0x0040 // Assigned, the flow is active
794 #define NECP_CLIENT_RESULT_FLAG_FLOW_VIABLE 0x0080 // Viable, the flow has a valid route
795 #define NECP_CLIENT_RESULT_FLAG_PROBE_CONNECTIVITY 0x0100 // Flow should probe connectivity
796 #define NECP_CLIENT_RESULT_FLAG_ECN_ENABLED 0x0200 // ECN should be used
797 #define NECP_CLIENT_RESULT_FLAG_FAST_OPEN_BLOCKED 0x0400 // Fast open should not be used
798 #define NECP_CLIENT_RESULT_FLAG_LINK_QUALITY_ABORT 0x0800 // Link quality is very bad, recommend close connections
799 #define NECP_CLIENT_RESULT_FLAG_ALLOW_QOS_MARKING 0x1000 // QoS marking is allowed
800 #define NECP_CLIENT_RESULT_FLAG_HAS_NAT64 0x2000 // Has NAT64 prefix
801 #define NECP_CLIENT_RESULT_FLAG_INTERFACE_LOW_POWER 0x4000 // Interface is in low-power mode
802 #define NECP_CLIENT_RESULT_FLAG_SPECIFIC_LISTENER 0x8000 // Listener should not listen on all interfaces
803 #define NECP_CLIENT_RESULT_FLAG_KEXT_FILTER_PRESENT 0x10000 // Kernel extension filter present
804 #define NECP_CLIENT_RESULT_FLAG_PF_RULES_PRESENT 0x20000 // Firewall rules present
805 #define NECP_CLIENT_RESULT_FLAG_ALF_PRESENT 0x40000 // Application Firewall enabled
806 #define NECP_CLIENT_RESULT_FLAG_PARENTAL_CONTROLS_PRESENT 0x80000 // Parental Controls present
807 #define NECP_CLIENT_RESULT_FLAG_IS_GLOBAL_INTERNET 0x100000 // Routes to global Internet
808
809
810 #define NECP_CLIENT_RESULT_FLAG_FORCE_UPDATE (NECP_CLIENT_RESULT_FLAG_HAS_IPV4 | NECP_CLIENT_RESULT_FLAG_HAS_IPV6 | NECP_CLIENT_RESULT_FLAG_HAS_NAT64 | NECP_CLIENT_RESULT_FLAG_INTERFACE_LOW_POWER)
811
812 #define NECP_CLIENT_RESULT_FAST_OPEN_SND_PROBE 0x01 // DEPRECATED - Fast open send probe
813 #define NECP_CLIENT_RESULT_FAST_OPEN_RCV_PROBE 0x02 // DEPRECATED - Fast open receive probe
814
815 #define NECP_CLIENT_RESULT_RECOMMENDED_MSS_NONE 0x01
816 #define NECP_CLIENT_RESULT_RECOMMENDED_MSS_LOW 0x02
817 #define NECP_CLIENT_RESULT_RECOMMENDED_MSS_MEDIUM 0x04
818
819 #define NECP_CLIENT_RESULT_REASON_EXPENSIVE_PROHIBITED 1 // Expensive networks were prohibited
820 #define NECP_CLIENT_RESULT_REASON_CONSTRAINED_PROHIBITED 2 // Constrained networks were prohibited
821 #define NECP_CLIENT_RESULT_REASON_CELLULAR_DENIED 3 // Denied by a cellular route rule
822 #define NECP_CLIENT_RESULT_REASON_WIFI_DENIED 4 // Denied by a wifi route rule
823 #define NECP_CLIENT_RESULT_REASON_LOCAL_NETWORK_PROHIBITED 5 // Local network access prohibited
824 #define NECP_CLIENT_RESULT_REASON_ULTRA_CONSTRAINED_NOT_ALLOWED 6 // Ultra constrained networks not allowed
825
826 struct necp_interface_signature {
827 u_int8_t signature[IFNET_SIGNATURELEN];
828 u_int8_t signature_len;
829 };
830
831 struct necp_interface_details {
832 char name[IFXNAMSIZ];
833 u_int32_t index;
834 u_int32_t generation;
835 u_int32_t functional_type;
836 u_int32_t delegate_index;
837 u_int32_t flags; // see NECP_INTERFACE_FLAG_*
838 u_int32_t mtu;
839 struct necp_interface_signature ipv4_signature;
840 struct necp_interface_signature ipv6_signature;
841 u_int32_t ipv4_netmask;
842 u_int32_t ipv4_broadcast;
843 /*
844 * This serves as a temporary header guard to protect libnetcore builds
845 * until the xnu changes are available in the build.
846 * XXX: Should be removed in a future build.
847 */
848 #define NECP_INTERFACE_SUPPORTS_TSO 1
849 u_int32_t tso_max_segment_size_v4;
850 u_int32_t tso_max_segment_size_v6;
851 #define NECP_INTERFACE_SUPPORTS_HWCSUM 1
852 u_int32_t hwcsum_flags;
853 u_int8_t radio_type;
854 u_int8_t radio_channel;
855 };
856
857 #define NECP_INTERFACE_FLAG_EXPENSIVE 0x0001
858 #define NECP_INTERFACE_FLAG_TXSTART 0X0002
859 #define NECP_INTERFACE_FLAG_NOACKPRI 0x0004
860 #define NECP_INTERFACE_FLAG_3CARRIERAGG 0x0008
861 #define NECP_INTERFACE_FLAG_IS_LOW_POWER 0x0010
862 #define NECP_INTERFACE_FLAG_MPK_LOG 0x0020 // Multi-layer Packet Logging
863 #define NECP_INTERFACE_FLAG_CONSTRAINED 0x0040
864 #define NECP_INTERFACE_FLAG_HAS_NETMASK 0x0080
865 #define NECP_INTERFACE_FLAG_HAS_BROADCAST 0x0100
866 #define NECP_INTERFACE_FLAG_SUPPORTS_MULTICAST 0x0200
867 #define NECP_INTERFACE_FLAG_HAS_DNS 0x0400
868 #define NECP_INTERFACE_FLAG_HAS_NAT64 0x0800
869 #define NECP_INTERFACE_FLAG_IPV4_ROUTABLE 0x1000
870 #define NECP_INTERFACE_FLAG_IPV6_ROUTABLE 0x2000
871 #define NECP_INTERFACE_FLAG_ULTRA_CONSTRAINED 0x4000
872
873 struct necp_client_parameter_netagent_type {
874 char netagent_domain[32];
875 char netagent_type[32];
876 };
877
878 struct necp_client_result_netagent {
879 u_int32_t generation;
880 uuid_t netagent_uuid;
881 };
882
883 struct necp_client_result_interface {
884 u_int32_t generation;
885 u_int32_t index;
886 };
887
888 struct necp_client_result_estimated_throughput {
889 u_int8_t up;
890 u_int8_t down;
891 };
892
893 struct necp_client_result_agent_error {
894 u_int32_t code;
895 u_int8_t domain;
896 };
897
898 #define NECP_USES_INTERFACE_OPTIONS_FOR_BROWSE 1
899
900 struct necp_client_interface_option {
901 u_int32_t interface_index;
902 u_int32_t interface_generation;
903 uuid_t nexus_agent;
904 };
905
906 #define NECP_CLIENT_ENDPOINT_TYPE_APPLICATION_SERVICE 6
907
908 struct necp_client_endpoint {
909 union {
910 struct sockaddr sa;
911 struct sockaddr_in sin;
912 struct sockaddr_in6 sin6;
913 struct {
914 u_int8_t endpoint_length;
915 u_int8_t endpoint_family; // Use AF_UNSPEC to target a name
916 u_int16_t endpoint_port;
917 u_int32_t endpoint_type; // Client-specific type
918 char endpoint_data[0]; // Type-specific endpoint value
919 } endpoint;
920 } u;
921 };
922
923 struct necp_client_group {
924 u_int32_t group_type;
925 uuid_t group_id;
926 };
927
928 struct necp_client_list {
929 u_int32_t client_count;
930 uuid_t clients[0];
931 };
932
933 struct kev_necp_policies_changed_data {
934 u_int32_t changed_count; // Defaults to 0.
935 };
936
937 #define NECP_CLIENT_FLOW_FLAGS_ALLOW_NEXUS 0x01 // Request a nexus instance upon adding a flow
938 #define NECP_CLIENT_FLOW_FLAGS_USE_CLIENT_ID 0x02 // Register the client ID rather than the flow registration ID with network agents
939 #define NECP_CLIENT_FLOW_FLAGS_BROWSE 0x04 // Create request with a browse agent
940 #define NECP_CLIENT_FLOW_FLAGS_RESOLVE 0x08 // Create request with a resolution agent
941 #define NECP_CLIENT_FLOW_FLAGS_OVERRIDE_ADDRESS 0x10 // Flow has a different remote address than the parent flow
942 #define NECP_CLIENT_FLOW_FLAGS_OVERRIDE_IP_PROTOCOL 0x20 // Flow has a different IP protocol than the parent flow
943
944 struct necp_client_flow_stats {
945 u_int32_t stats_type; // NECP_CLIENT_STATISTICS_TYPE_*
946 u_int32_t stats_version; // NECP_CLIENT_STATISTICS_TYPE_*_VER
947 u_int32_t stats_size;
948 mach_vm_address_t stats_addr;
949 };
950
951 struct necp_client_add_flow {
952 uuid_t agent_uuid;
953 uuid_t registration_id;
954 u_int16_t flags; // NECP_CLIENT_FLOW_FLAGS_*
955 u_int16_t stats_request_count;
956 struct necp_client_flow_stats stats_requests[0];
957 // sockaddr for override endpoint
958 // uint8 for override ip protocol
959 } __attribute__((__packed__));
960
961 struct necp_agent_use_parameters {
962 uuid_t agent_uuid;
963 uint64_t out_use_count;
964 };
965
966 struct necp_client_group_action {
967 uuid_t agent_uuid;
968 u_int16_t group_member_count;
969 struct necp_client_endpoint group_members[0];
970 } __attribute__((__packed__));
971
972 struct necp_client_flow_protoctl_event {
973 uint32_t protoctl_event_code;
974 uint32_t protoctl_event_val;
975 /* TCP seq number is in host byte order */
976 uint32_t protoctl_event_tcp_seq_num;
977 };
978
979 #define NECP_CLIENT_UPDATE_TYPE_PARAMETERS 1 // Parameters, for a new client
980 #define NECP_CLIENT_UPDATE_TYPE_RESULT 2 // Result, for a udpated client
981 #define NECP_CLIENT_UPDATE_TYPE_REMOVE 3 // Empty, for a removed client
982
983 struct necp_client_observer_update {
984 u_int32_t update_type; // NECP_CLIENT_UPDATE_TYPE_*
985 u_int8_t tlv_buffer[0]; // Parameters or result as TLVs, based on type
986 };
987
988 // These sign types are tied to specific clients.
989 // The client_id UUID is then the NECP client UUID that generated the query.
990 #define NECP_CLIENT_SIGN_TYPE_RESOLVER_ANSWER 1 // struct necp_client_host_resolver_answer
991 #define NECP_CLIENT_SIGN_TYPE_BROWSE_RESULT 2 // struct necp_client_browse_result
992 #define NECP_CLIENT_SIGN_TYPE_SERVICE_RESOLVER_ANSWER 3 // struct necp_client_service_resolver_answer
993
994 // These sign types are valid for system-wide use.
995 // The client_id UUID is a unique per-query UUID.
996 // These should be generated only on behalf of trusted or entitled processes.
997 #define NECP_CLIENT_SIGN_TYPE_SYSTEM_RESOLVER_ANSWER 4 // struct necp_client_host_resolver_answer
998 #define NECP_CLIENT_SIGN_TYPE_SYSTEM_BROWSE_RESULT 5 // struct necp_client_browse_result
999 #define NECP_CLIENT_SIGN_TYPE_SYSTEM_SERVICE_RESOLVER_ANSWER 6 // struct necp_client_service_resolver_answer
1000
1001 struct necp_client_signature {
1002 u_int8_t signed_tag[32];
1003 } __attribute__((__packed__));
1004
1005 //
1006 struct necp_client_signable {
1007 uuid_t client_id; // Interpretation depends on sign_type
1008 u_int32_t sign_type;
1009 u_int8_t signable_data[0];
1010 } __attribute__((__packed__));
1011
1012 struct necp_client_resolver_answer {
1013 uuid_t client_id;
1014 u_int32_t sign_type;
1015 union sockaddr_in_4_6 address_answer; // Can include port
1016 u_int32_t hostname_length;
1017 char hostname[0];
1018 } __attribute__((__packed__));
1019
1020 struct necp_client_host_resolver_answer {
1021 struct necp_client_signable header;
1022 u_int32_t metadata_hash; // Extra metadata that can be signed along with the answer, such as a network signature.
1023 union sockaddr_in_4_6 address_answer; // Can include port
1024 u_int32_t hostname_length;
1025 char hostname[0];
1026 } __attribute__((__packed__));
1027
1028 struct necp_client_browse_result {
1029 struct necp_client_signable header;
1030 u_int32_t metadata_hash; // Extra metadata that can be signed along with the service, which may include a TXT record or a network signature
1031 u_int16_t service_length;
1032 char service[0];
1033 } __attribute__((__packed__));
1034
1035 struct necp_client_service_resolver_answer {
1036 struct necp_client_signable header;
1037 u_int32_t metadata_hash; // Extra metadata that can be signed along with the service, which may include a TXT record or a network signature
1038 u_int16_t service_length;
1039 u_int16_t port;
1040 u_int16_t hostname_length;
1041 char service[0];
1042 char hostname[0];
1043 } __attribute__((__packed__));
1044
1045 struct necp_client_validatable {
1046 struct necp_client_signature signature;
1047 struct necp_client_signable signable;
1048 } __attribute__((__packed__));
1049
1050 #define NECP_CLIENT_ACTION_SIGN_MAX_STRING_LENGTH 1024
1051
1052 #define NECP_CLIENT_ACTION_SIGN_TAG_LENGTH 32
1053
1054 #define NECP_CLIENT_ACTION_SIGN_DEFAULT_DATA_LENGTH 128
1055 #define NECP_CLIENT_ACTION_SIGN_MAX_TOTAL_LENGTH 4096
1056
1057 #define NECP_FILTER_UNIT_NO_FILTER UINT32_MAX // Reserved filter unit value that prohibits all filters and socket filters
1058
1059 // Type of signed client ID requests.
1060 #define NECP_CLIENT_SIGNED_CLIENT_ID_TYPE_UUID 1 // struct necp_client_signed_client_id_uuid
1061
1062 struct necp_client_signed_client_id_uuid {
1063 uuid_t client_id;
1064 u_int32_t signature_length;
1065 u_int8_t signature_data[NECP_CLIENT_ACTION_SIGN_TAG_LENGTH];
1066 } __attribute__((__packed__));
1067
1068 /*
1069 * The sysctl "net.necp.necp_drop_dest_level" controls the global drop rule policy for
1070 * a set of destinations addresses at the given level -- the drop rule is the last one
1071 * to be evaluated at this level.
1072 */
1073 #define MAX_NECP_DROP_DEST_LEVEL_ADDRS 8
1074
1075 struct necp_drop_dest_entry {
1076 u_int32_t level; // priority level
1077 u_int32_t order; // session order (read only via sysctl)
1078 struct necp_policy_condition_addr cond_addr;
1079 };
1080
1081 struct necp_drop_dest_policy {
1082 u_int32_t entry_count;
1083 struct necp_drop_dest_entry entries[MAX_NECP_DROP_DEST_LEVEL_ADDRS];
1084 };
1085
1086
1087 #define NECP_DEMUX_MAX_LEN 32
1088 struct necp_demux_pattern {
1089 uint16_t offset;
1090 uint16_t len;
1091 uint8_t mask[NECP_DEMUX_MAX_LEN];
1092 uint8_t value[NECP_DEMUX_MAX_LEN];
1093 };
1094
1095 #ifdef BSD_KERNEL_PRIVATE
1096 #include <stdbool.h>
1097 #include <sys/socketvar.h>
1098 #include <sys/kern_control.h>
1099 #include <netinet/ip_var.h>
1100 #include <netinet6/ip6_var.h>
1101 #include <net/if_var.h>
1102 #include <sys/syslog.h>
1103 #include <net/network_agent.h>
1104 #include <net/ethernet.h>
1105 #include <os/log.h>
1106 #if SKYWALK
1107 #include <skywalk/namespace/netns.h>
1108 #endif /* SKYWALK */
1109
1110
1111 SYSCTL_DECL(_net_necp);
1112
1113 extern os_log_t necp_log_handle;
1114 extern os_log_t necp_data_trace_log_handle;
1115
1116 #define NECPLOG(level, format, ...) do { \
1117 if (level == LOG_ERR) { \
1118 os_log_error(necp_log_handle, "%s: " format "\n", __FUNCTION__, __VA_ARGS__); \
1119 } else { \
1120 os_log(necp_log_handle, "%s: " format "\n", __FUNCTION__, __VA_ARGS__); \
1121 } \
1122 } while (0)
1123
1124 #define NECPLOG0(level, msg) do { \
1125 if (level == LOG_ERR) { \
1126 os_log_error(necp_log_handle, "%s: %s\n", __FUNCTION__, msg); \
1127 } else { \
1128 os_log(necp_log_handle, "%s: %s\n", __FUNCTION__, msg); \
1129 } \
1130 } while (0)
1131
1132 #define NECPDATATRACELOG(level, format, ...) do { \
1133 if (level == LOG_ERR) { \
1134 os_log_error(necp_data_trace_log_handle, "%s: " format "\n", __FUNCTION__, __VA_ARGS__); \
1135 } else { \
1136 os_log(necp_data_trace_log_handle, "%s: " format "\n", __FUNCTION__, __VA_ARGS__); \
1137 } \
1138 } while (0)
1139
1140 enum necp_fd_type_t {
1141 necp_fd_type_invalid = 0,
1142 necp_fd_type_session = 1,
1143 necp_fd_type_client = 2,
1144 };
1145
1146 union necp_sockaddr_union {
1147 struct sockaddr sa;
1148 struct sockaddr_in sin;
1149 struct sockaddr_in6 sin6;
1150 };
1151
1152 /*
1153 * kstats
1154 * The ustats and kstats region are mirrored. So when we allocate with
1155 * skmem_cache from kstats region, we also get an ustats object. To tie them
1156 * together, kstats has an extra *necp_stats_ustats pointer pointing to the
1157 * ustats object
1158 */
1159 struct necp_all_kstats {
1160 struct necp_all_stats necp_stats_comm; /* kernel private stats snapshot */
1161 struct necp_all_stats *necp_stats_ustats; /* points to user-visible stats (in shared ustats region) */
1162 };
1163
1164 extern void necp_client_init(void);
1165 extern int necp_application_find_policy_match_internal(proc_t proc, u_int8_t *parameters __sized_by(parameters_size), u_int32_t parameters_size,
1166 struct necp_aggregate_result *returned_result,
1167 u_int32_t *flags, u_int32_t *reason, u_int required_interface_index,
1168 const union necp_sockaddr_union *override_local_addr,
1169 const union necp_sockaddr_union *override_remote_addr,
1170 struct necp_client_endpoint *returned_v4_gateway,
1171 struct necp_client_endpoint *returned_v6_gateway,
1172 struct rtentry **returned_route, bool ignore_address,
1173 bool has_client,
1174 uuid_t *returned_override_euuid);
1175 /*
1176 * TLV utilities
1177 *
1178 * Note that these functions (other than necp_buffer_find_tlv) do not check the length of the entire buffer,
1179 * so the caller must be sure that the entire TLV is within bounds.
1180 */
1181 struct necp_tlv_header {
1182 u_int8_t type;
1183 u_int32_t length;
1184 } __attribute__((__packed__));
1185
1186 extern u_int8_t * __counted_by(0) necp_buffer_write_tlv(u_int8_t * __counted_by(0)cursor_, u_int8_t type, u_int32_t length, const void *value __sized_by(length), u_int8_t * buffer __sized_by(buffer_length), u_int32_t buffer_length);
1187 extern u_int8_t * __counted_by(0) necp_buffer_write_tlv_if_different(u_int8_t * __counted_by(0)cursor_, u_int8_t type,
1188 u_int32_t length, const void *value __sized_by(length), bool *updated,
1189 u_int8_t * buffer __sized_by(buffer_length), u_int32_t buffer_length);
1190 extern u_int8_t necp_buffer_get_tlv_type(u_int8_t * __counted_by(buffer_length)buffer, size_t buffer_length, u_int32_t tlv_offset);
1191 extern u_int32_t necp_buffer_get_tlv_length(u_int8_t * __counted_by(buffer_length)buffer, size_t buffer_length, u_int32_t tlv_offset);
1192 extern u_int8_t *__sized_by(*value_size) __necp_buffer_get_tlv_value(u_int8_t * __counted_by(buffer_length)buffer, size_t buffer_length, u_int32_t tlv_offset, u_int32_t * value_size);
1193 extern int necp_buffer_find_tlv(u_int8_t * buffer __sized_by(buffer_length), u_int32_t buffer_length, int offset, u_int8_t type, int *err, int next);
1194
1195 /*
1196 * Inline shim to safely convert the result of `__necp_buffer_get_tlv_value'
1197 * to an indexable pointer, when appropriate.
1198 */
1199 __attribute__((always_inline))
1200 static inline u_int8_t * __header_indexable
necp_buffer_get_tlv_value(u_int8_t * __counted_by (buffer_length)buffer,size_t buffer_length,u_int32_t tlv_offset,u_int32_t * value_size)1201 necp_buffer_get_tlv_value(u_int8_t * __counted_by(buffer_length)buffer, size_t buffer_length, u_int32_t tlv_offset, u_int32_t *value_size)
1202 {
1203 u_int32_t ensured_value_size = 0;
1204 u_int8_t *value = __necp_buffer_get_tlv_value(buffer, buffer_length, tlv_offset, &ensured_value_size);
1205 if (value_size) {
1206 *value_size = ensured_value_size;
1207 }
1208 return value;
1209 }
1210
1211 #define NECPCTL_DROP_ALL_LEVEL 1 /* Drop all packets if no policy matches above this level */
1212 #define NECPCTL_DEBUG 2 /* Log all kernel policy matches */
1213 #define NECPCTL_PASS_LOOPBACK 3 /* Pass all loopback traffic */
1214 #define NECPCTL_PASS_KEEPALIVES 4 /* Pass all kernel-generated keepalive traffic */
1215 #define NECPCTL_SOCKET_POLICY_COUNT 5 /* Count of all socket-level policies */
1216 #define NECPCTL_SOCKET_NON_APP_POLICY_COUNT 6 /* Count of non-per-app socket-level policies */
1217 #define NECPCTL_IP_POLICY_COUNT 7 /* Count of all ip-level policies */
1218 #define NECPCTL_SESSION_COUNT 8 /* Count of NECP sessions */
1219 #define NECPCTL_CLIENT_FD_COUNT 9 /* Count of NECP client fds */
1220 #define NECPCTL_CLIENT_COUNT 10 /* Count of NECP clients */
1221 #define NECPCTL_ARENA_COUNT 11 /* Count of NECP arenas (stats, etc) */
1222 #define NECPCTL_NEXUS_FLOW_COUNT 12 /* Count of NECP nexus flows */
1223 #define NECPCTL_SOCKET_FLOW_COUNT 13 /* Count of NECP socket flows */
1224 #define NECPCTL_IF_FLOW_COUNT 14 /* Count of NECP socket flows */
1225 #define NECPCTL_OBSERVER_FD_COUNT 15 /* Count of NECP observer fds */
1226 #define NECPCTL_OBSERVER_MESSAGE_LIMIT 16 /* Number of of NECP observer messages allowed to be queued */
1227 #define NECPCTL_SYSCTL_ARENA_COUNT 17 /* Count of sysctl arenas */
1228 #define NECPCTL_DROP_UNENTITLED_LEVEL 18 /* Drop unentitled process traffic above this level */
1229 #define NECPCTL_PASS_INTERPOSE 19 /* Pass interpose */
1230 #define NECPCTL_RESTRICT_MULTICAST 20 /* Restrict multicast access */
1231 #define NECPCTL_DEDUP_POLICIES 21 /* Dedup overlapping policies */
1232 #define NECPCTL_CLIENT_TRACING_LEVEL 22 /* Client tracing level */
1233 #define NECPCTL_CLIENT_TRACING_PID 23 /* Apply client tracing only to specified pid */
1234 #define NECPCTL_DROP_MANAGEMENT_LEVEL 24 /* Drop management traffic at this level */
1235 #define NECPCTL_TRIE_COUNT 25 /* Count of tries */
1236
1237 #define NECP_LOOPBACK_PASS_ALL 1 // Pass all loopback traffic
1238 #define NECP_LOOPBACK_PASS_WITH_FILTER 2 // Pass all loopback traffic, but activate content filter and/or flow divert if applicable
1239
1240 #define NECPCTL_NAMES { \
1241 { 0, 0 }, \
1242 { "drop_all_level", CTLTYPE_INT }, \
1243 { "debug", CTLTYPE_INT }, \
1244 { "pass_loopback", CTLTYPE_INT }, \
1245 { "pass_keepalives", CTLTYPE_INT }, \
1246 { "pass_interpose", CTLTYPE_INT }, \
1247 }
1248
1249 typedef u_int32_t necp_kernel_policy_id;
1250 #define NECP_KERNEL_POLICY_ID_NONE 0
1251 #define NECP_KERNEL_POLICY_ID_NO_MATCH 1
1252 #define NECP_KERNEL_POLICY_ID_FIRST_VALID_SOCKET 2
1253 #define NECP_KERNEL_POLICY_ID_FIRST_VALID_IP UINT16_MAX
1254
1255 typedef u_int32_t necp_app_id;
1256
1257 #define NECP_KERNEL_POLICY_RESULT_NONE 0
1258 #define NECP_KERNEL_POLICY_RESULT_PASS NECP_POLICY_RESULT_PASS
1259 #define NECP_KERNEL_POLICY_RESULT_SKIP NECP_POLICY_RESULT_SKIP
1260 #define NECP_KERNEL_POLICY_RESULT_DROP NECP_POLICY_RESULT_DROP
1261 #define NECP_KERNEL_POLICY_RESULT_SOCKET_DIVERT NECP_POLICY_RESULT_SOCKET_DIVERT
1262 #define NECP_KERNEL_POLICY_RESULT_SOCKET_FILTER NECP_POLICY_RESULT_SOCKET_FILTER
1263 #define NECP_KERNEL_POLICY_RESULT_IP_TUNNEL NECP_POLICY_RESULT_IP_TUNNEL
1264 #define NECP_KERNEL_POLICY_RESULT_IP_FILTER NECP_POLICY_RESULT_IP_FILTER
1265 #define NECP_KERNEL_POLICY_RESULT_SOCKET_SCOPED NECP_POLICY_RESULT_SOCKET_SCOPED
1266 #define NECP_KERNEL_POLICY_RESULT_ROUTE_RULES NECP_POLICY_RESULT_ROUTE_RULES
1267 #define NECP_KERNEL_POLICY_RESULT_USE_NETAGENT NECP_POLICY_RESULT_USE_NETAGENT
1268 #define NECP_KERNEL_POLICY_RESULT_NETAGENT_SCOPED NECP_POLICY_RESULT_NETAGENT_SCOPED
1269 #define NECP_KERNEL_POLICY_RESULT_SCOPED_DIRECT NECP_POLICY_RESULT_SCOPED_DIRECT
1270 #define NECP_KERNEL_POLICY_RESULT_ALLOW_UNENTITLED NECP_POLICY_RESULT_ALLOW_UNENTITLED
1271 #define NECP_KERNEL_POLICY_RESULT_REMOVE_NETAGENT NECP_POLICY_RESULT_REMOVE_NETAGENT
1272
1273 #define NECP_KERNEL_POLICY_PASS_NO_SKIP_IPSEC NECP_POLICY_PASS_NO_SKIP_IPSEC
1274 #define NECP_KERNEL_POLICY_PASS_PF_TAG NECP_POLICY_PASS_PF_TAG
1275
1276 #define NECP_KERNEL_POLICY_DROP_FLAG_LOCAL_NETWORK NECP_POLICY_DROP_FLAG_LOCAL_NETWORK
1277 #define NECP_KERNEL_POLICY_DROP_FLAG_SUPPRESS_ALERTS NECP_POLICY_DROP_FLAG_SUPPRESS_ALERTS
1278
1279 typedef struct {
1280 u_int32_t identifier;
1281 u_int32_t data;
1282 } necp_kernel_policy_service;
1283
1284 typedef union {
1285 u_int tunnel_interface_index;
1286 u_int scoped_interface_index;
1287 u_int32_t flow_divert_control_unit;
1288 u_int32_t filter_control_unit;
1289 u_int32_t skip_policy_order;
1290 u_int32_t route_rule_id;
1291 u_int32_t netagent_id;
1292 u_int32_t pass_flags;
1293 u_int32_t drop_flags;
1294 necp_kernel_policy_service service;
1295 } necp_kernel_policy_result_parameter;
1296
1297 enum necp_boolean_state {
1298 necp_boolean_state_unknown = 0,
1299 necp_boolean_state_false = 1,
1300 necp_boolean_state_true = 2,
1301 };
1302
1303 struct necp_kernel_socket_policy {
1304 LIST_ENTRY(necp_kernel_socket_policy) chain;
1305 necp_kernel_policy_id id;
1306 necp_policy_order order;
1307 u_int32_t session_order;
1308 int session_pid;
1309
1310 u_int64_t condition_mask;
1311 u_int64_t condition_negated_mask;
1312 u_int32_t cond_client_flags;
1313 necp_kernel_policy_id cond_policy_id;
1314 u_int32_t cond_app_id; // Locally assigned ID value stored
1315 u_int32_t cond_real_app_id; // Locally assigned ID value stored
1316 char *cond_custom_entitlement __null_terminated; // String
1317 u_int32_t cond_account_id; // Locally assigned ID value stored
1318 char *cond_domain __null_terminated; // String
1319 u_int8_t cond_domain_dot_count; // Number of dots in cond_domain
1320 u_int32_t cond_domain_filter;
1321 pid_t cond_pid;
1322 uid_t cond_uid;
1323 uid_t cond_real_uid;
1324 ifnet_t cond_bound_interface; // Matches specific binding only
1325 struct necp_policy_condition_tc_range cond_traffic_class; // Matches traffic class in range
1326 u_int16_t cond_protocol; // Matches IP protcol number
1327 union necp_sockaddr_union cond_local_start; // Matches local IP address (or start)
1328 union necp_sockaddr_union cond_local_end; // Matches IP address range
1329 u_int8_t cond_local_prefix; // Defines subnet
1330 union necp_sockaddr_union cond_remote_start; // Matches remote IP address (or start)
1331 union necp_sockaddr_union cond_remote_end; // Matches IP address range
1332 u_int8_t cond_remote_prefix; // Defines subnet
1333 struct necp_policy_condition_agent_type cond_agent_type;
1334 struct necp_policy_condition_sdk_version cond_sdk_version;
1335 char *cond_signing_identifier __null_terminated; // String
1336 char *cond_url __null_terminated;// String
1337 u_int16_t cond_packet_filter_tags;
1338 u_int16_t cond_scheme_port;
1339 int32_t cond_pid_version;
1340 u_int32_t cond_bound_interface_flags;
1341 u_int32_t cond_bound_interface_eflags;
1342 u_int32_t cond_bound_interface_xflags;
1343 u_int8_t cond_local_networks_flags;
1344
1345 necp_kernel_policy_result result;
1346 necp_kernel_policy_result_parameter result_parameter;
1347 };
1348
1349 struct necp_kernel_ip_output_policy {
1350 LIST_ENTRY(necp_kernel_ip_output_policy) chain;
1351 necp_kernel_policy_id id;
1352 necp_policy_order suborder;
1353 necp_policy_order order;
1354 u_int32_t session_order;
1355 int session_pid;
1356
1357 u_int64_t condition_mask;
1358 u_int64_t condition_negated_mask;
1359 necp_kernel_policy_id cond_policy_id;
1360 ifnet_t cond_bound_interface; // Matches specific binding only
1361 u_int16_t cond_protocol; // Matches IP protcol number
1362 union necp_sockaddr_union cond_local_start; // Matches local IP address (or start)
1363 union necp_sockaddr_union cond_local_end; // Matches IP address range
1364 u_int8_t cond_local_prefix; // Defines subnet
1365 union necp_sockaddr_union cond_remote_start; // Matches remote IP address (or start)
1366 union necp_sockaddr_union cond_remote_end; // Matches IP address range
1367 u_int8_t cond_remote_prefix; // Defines subnet
1368 u_int32_t cond_last_interface_index;
1369 u_int16_t cond_packet_filter_tags;
1370 u_int16_t cond_scheme_port;
1371 u_int32_t cond_bound_interface_flags;
1372 u_int32_t cond_bound_interface_eflags;
1373 u_int32_t cond_bound_interface_xflags;
1374 u_int8_t cond_local_networks_flags;
1375
1376 necp_kernel_policy_result result;
1377 necp_kernel_policy_result_parameter result_parameter;
1378 };
1379
1380 #define MAX_KERNEL_SOCKET_POLICIES 1
1381 #define MAX_KERNEL_IP_OUTPUT_POLICIES 4
1382 struct necp_session_policy {
1383 LIST_ENTRY(necp_session_policy) chain;
1384 bool applied; // Applied into the kernel table
1385 bool pending_deletion; // Waiting to be removed from kernel table
1386 bool pending_update; // Policy has been modified since creation/last application
1387 necp_policy_id local_id;
1388 necp_policy_order order;
1389 u_int32_t result_size;
1390 u_int8_t *result __sized_by(result_size);
1391 u_int32_t conditions_size;
1392 u_int8_t *conditions __sized_by(conditions_size); // Array of conditions, each with a u_int32_t length at start
1393 u_int32_t route_rules_size;
1394 u_int8_t *route_rules __sized_by(route_rules_size); // Array of route rules, each with a u_int32_t length at start
1395
1396 uuid_t applied_app_uuid;
1397 uuid_t applied_real_app_uuid;
1398 u_int32_t applied_account_size;
1399 char *applied_account __sized_by(applied_account_size);
1400
1401 uuid_t applied_result_uuid;
1402
1403 u_int32_t applied_route_rules_id;
1404
1405 necp_kernel_policy_id kernel_socket_policies[MAX_KERNEL_SOCKET_POLICIES];
1406 necp_kernel_policy_id kernel_ip_output_policies[MAX_KERNEL_IP_OUTPUT_POLICIES];
1407 };
1408
1409 struct necp_aggregate_socket_result {
1410 necp_kernel_policy_result result;
1411 necp_kernel_policy_result_parameter result_parameter;
1412 necp_kernel_policy_filter filter_control_unit;
1413 u_int32_t flow_divert_aggregate_unit;
1414 u_int32_t route_rule_id;
1415 int32_t qos_marking_gencount;
1416 };
1417
1418 struct necp_inpcb_result {
1419 u_int32_t app_id;
1420 necp_kernel_policy_id policy_id;
1421 necp_kernel_policy_id skip_policy_id;
1422 int32_t policy_gencount;
1423 u_int32_t flowhash;
1424 u_int32_t network_denied_notifies;// Notification count
1425 struct necp_aggregate_socket_result results;
1426 };
1427
1428 extern void necp_init(void);
1429
1430 struct inp_necp_attributes;
1431 extern errno_t necp_set_socket_attributes(struct inp_necp_attributes *attributes, struct sockopt *sopt);
1432 extern errno_t necp_get_socket_attributes(struct inp_necp_attributes *attributes, struct sockopt *sopt);
1433 extern errno_t necp_set_socket_domain_attributes(struct socket *so, const char *domain __null_terminated, const char *domain_owner __null_terminated);
1434 extern int necp_set_socket_resolver_signature(struct inpcb *inp, struct sockopt *sopt);
1435 extern int necp_get_socket_resolver_signature(struct inpcb *inp, struct sockopt *sopt);
1436 extern bool necp_socket_has_resolver_signature(struct inpcb *inp);
1437 extern bool necp_socket_resolver_signature_matches_address(struct inpcb *inp, union necp_sockaddr_union *address);
1438 extern void necp_inpcb_remove_cb(struct inpcb *inp);
1439 extern void necp_inpcb_dispose(struct inpcb *inp);
1440
1441 extern u_int32_t necp_socket_get_content_filter_control_unit(struct socket *so);
1442 extern u_int32_t necp_socket_get_policy_gencount(struct socket *so);
1443
1444 extern bool necp_socket_should_use_flow_divert(struct inpcb *inp);
1445 extern u_int32_t necp_socket_get_flow_divert_control_unit(struct inpcb *inp, uint32_t *aggregate_unit);
1446
1447 extern bool necp_socket_should_rescope(struct inpcb *inp);
1448 extern u_int necp_socket_get_rescope_if_index(struct inpcb *inp);
1449 extern u_int32_t necp_socket_get_effective_mtu(struct inpcb *inp, u_int32_t current_mtu);
1450
1451 extern bool necp_socket_is_allowed_to_recv_on_interface(struct inpcb *inp, ifnet_t interface);
1452
1453 extern bool necp_socket_is_allowed_to_send_recv(struct inpcb *inp, ifnet_t input_interface, u_int16_t pf_tag,
1454 necp_kernel_policy_id *return_policy_id,
1455 u_int32_t *return_route_rule_id,
1456 necp_kernel_policy_id *return_skip_policy_id, u_int32_t *return_pass_flags);
1457 extern bool necp_socket_is_allowed_to_send_recv_v4(struct inpcb *inp, u_int16_t local_port,
1458 u_int16_t remote_port, struct in_addr *local_addr,
1459 struct in_addr *remote_addr, ifnet_t input_interface, u_int16_t pf_tag,
1460 necp_kernel_policy_id *return_policy_id, u_int32_t *return_route_rule_id,
1461 necp_kernel_policy_id *return_skip_policy_id, u_int32_t *return_pass_flags);
1462 extern bool necp_socket_is_allowed_to_send_recv_v6(struct inpcb *inp, u_int16_t local_port,
1463 u_int16_t remote_port, struct in6_addr *local_addr,
1464 struct in6_addr *remote_addr, ifnet_t input_interface, u_int16_t pf_tag,
1465 necp_kernel_policy_id *return_policy_id, u_int32_t *return_route_rule_id,
1466 necp_kernel_policy_id *return_skip_policy_id, u_int32_t *return_pass_flags);
1467 extern void necp_socket_update_qos_marking(struct inpcb *inp, struct rtentry *route, u_int32_t route_rule_id);
1468 extern bool necp_lookup_current_qos_marking(int32_t *qos_marking_gencount, struct rtentry *route, struct ifnet *interface, u_int32_t route_rule_id, bool old_qos_marking);
1469 extern int necp_mark_packet_from_socket(struct mbuf *packet, struct inpcb *inp, necp_kernel_policy_id policy_id,
1470 u_int32_t route_rule_id, necp_kernel_policy_id skip_policy_id, u_int32_t pass_flags);
1471 extern necp_kernel_policy_id necp_get_policy_id_from_packet(struct mbuf *packet);
1472 extern necp_kernel_policy_id necp_get_skip_policy_id_from_packet(struct mbuf *packet);
1473 extern u_int16_t necp_get_packet_filter_tags_from_packet(struct mbuf *packet);
1474 extern bool necp_packet_should_skip_filters(struct mbuf *packet);
1475 extern u_int32_t necp_get_last_interface_index_from_packet(struct mbuf *packet);
1476 extern u_int32_t necp_get_route_rule_id_from_packet(struct mbuf *packet);
1477 extern int necp_get_app_uuid_from_packet(struct mbuf *packet,
1478 uuid_t app_uuid);
1479
1480 extern necp_kernel_policy_id necp_socket_find_policy_match(struct inpcb *inp, struct sockaddr *override_local_addr,
1481 struct sockaddr *override_remote_addr, u_int32_t override_bound_interface);
1482 extern necp_kernel_policy_id necp_ip_output_find_policy_match(struct mbuf *packet, int flags, struct ip_out_args *ipoa,
1483 struct rtentry *rt,
1484 necp_kernel_policy_result *result,
1485 necp_kernel_policy_result_parameter *result_parameter);
1486 extern necp_kernel_policy_id necp_ip6_output_find_policy_match(struct mbuf *packet, int flags, struct ip6_out_args *ip6oa,
1487 struct rtentry *rt,
1488 necp_kernel_policy_result *result,
1489 necp_kernel_policy_result_parameter *result_parameter);
1490
1491 extern int necp_mark_packet_from_ip(struct mbuf *packet, necp_kernel_policy_id policy_id);
1492 extern int necp_mark_packet_from_ip_with_skip(struct mbuf *packet, necp_kernel_policy_id policy_id, necp_kernel_policy_id skip_policy_id);
1493 extern int necp_mark_packet_from_interface(struct mbuf *packet, ifnet_t interface);
1494
1495 extern ifnet_t necp_get_ifnet_from_result_parameter(necp_kernel_policy_result_parameter *result_parameter);
1496 extern bool necp_packet_can_rebind_to_ifnet(struct mbuf *packet, struct ifnet *interface, struct route *new_route, int family);
1497
1498 extern bool necp_packet_is_allowed_over_interface(struct mbuf *packet, struct ifnet *interface);
1499
1500 extern int necp_mark_packet_as_keepalive(struct mbuf *packet, bool is_keepalive);
1501 extern bool necp_get_is_keepalive_from_packet(struct mbuf *packet);
1502
1503 extern int necp_sign_resolver_answer(uuid_t client_id, u_int32_t sign_type,
1504 u_int8_t *data, size_t data_length,
1505 u_int8_t *tag, size_t *out_tag_length);
1506
1507 extern bool necp_validate_resolver_answer(uuid_t client_id, u_int32_t sign_type,
1508 u_int8_t *data __sized_by(data_length), size_t data_length,
1509 u_int8_t *tag __sized_by(tag_length), size_t tag_length);
1510
1511 extern int necp_sign_application_id(uuid_t client_id, u_int32_t sign_type,
1512 u_int8_t *__counted_by(*out_tag_length) tag, size_t *out_tag_length);
1513
1514 extern bool necp_validate_application_id(uuid_t client_id, u_int32_t sign_type,
1515 u_int8_t *tag __sized_by(tag_length), size_t tag_length);
1516
1517 extern void necp_update_all_clients(void); // Handle general re-evaluate event
1518 extern void necp_update_all_clients_immediately_if_needed(bool should_update_immediately); // Handle general re-evaluate event
1519
1520 extern void necp_force_update_client(uuid_t client_id, uuid_t remove_netagent_uuid, u_int32_t agent_generation); // Cause a single client to get an update event
1521
1522 extern bool necp_set_client_as_background(proc_t proc, struct fileproc *fp, bool background); // Set all clients for an fp as background or not
1523
1524 struct necp_fd_data;
1525 extern void necp_fd_memstatus(proc_t proc, uint32_t status, struct necp_fd_data *client_fd); // Purge memory of clients for the process
1526 extern void necp_fd_defunct(proc_t proc, struct necp_fd_data *client_fd); // Set all clients for an process as defunct
1527
1528 extern void necp_client_request_in_process_flow_divert(pid_t pid);
1529
1530 extern int necp_client_register_socket_flow(pid_t pid, uuid_t client_id, struct inpcb *inp);
1531
1532 extern int necp_client_register_socket_listener(pid_t pid, uuid_t client_id, struct inpcb *inp);
1533
1534 #if SKYWALK
1535 extern int necp_client_get_netns_flow_info(uuid_t client_id, struct ns_flow_info *flow_info);
1536 #endif /* SKYWALK */
1537
1538 extern int necp_client_assert_bb_radio_manager(uuid_t client_id, bool assert);
1539
1540 extern int necp_client_assign_from_socket(pid_t pid, uuid_t client_id, struct inpcb *inp);
1541
1542 extern int necp_assign_client_result(uuid_t netagent_uuid, uuid_t client_id,
1543 u_int8_t *assigned_results __sized_by(assigned_results_length), size_t assigned_results_length);
1544 extern int necp_assign_client_group_members(uuid_t netagent_uuid, uuid_t client_id,
1545 u_int8_t *__counted_by(assigned_group_members_length) assigned_group_members,
1546 size_t assigned_group_members_length);
1547
1548 struct skmem_obj_info; // forward declaration
1549 extern int necp_stats_ctor(struct skmem_obj_info *oi, struct skmem_obj_info *oim, void *arg, uint32_t skmflag);
1550 extern int necp_stats_dtor(void *addr, void *arg);
1551
1552 /* value to denote invalid flow advisory index */
1553 struct netagent_session;
1554 extern int
1555 necp_update_flow_protoctl_event(uuid_t netagent_uuid, uuid_t client_id,
1556 uint32_t protoctl_event_code, uint32_t protoctl_event_val,
1557 uint32_t protoctl_event_tcp_seq_num);
1558
1559 #define NECP_FLOWADV_IDX_INVALID UINT32_MAX
1560 extern void * __sized_by(*message_length) necp_create_nexus_assign_message(uuid_t nexus_instance, nexus_port_t nexus_port, void *key __sized_by(key_length), uint32_t key_length,
1561 struct necp_client_endpoint *local_endpoint, struct necp_client_endpoint *remote_endpoint,
1562 struct ether_addr *local_ether_addr,
1563 u_int32_t flow_adv_index, void *flow_stats, size_t *message_length);
1564
1565
1566 #define NECP_MAX_DEMUX_PATTERNS 4
1567 struct necp_client_nexus_parameters {
1568 pid_t pid;
1569 pid_t epid;
1570 uuid_t euuid;
1571 #if SKYWALK
1572 netns_token port_reservation;
1573 #else /* !SKYWALK */
1574 void *reserved;
1575 #endif /* !SKYWALK */
1576 union necp_sockaddr_union local_addr;
1577 union necp_sockaddr_union remote_addr;
1578 u_int8_t ip_protocol;
1579 u_int8_t transport_protocol;
1580 u_int16_t ethertype;
1581 u_int32_t traffic_class;
1582 necp_policy_id policy_id;
1583 necp_policy_id skip_policy_id;
1584 unsigned is_listener:1;
1585 unsigned is_interpose:1;
1586 unsigned is_custom_ether:1;
1587 unsigned allow_qos_marking:1;
1588 unsigned override_address_selection:1;
1589 unsigned use_stable_address:1; // Used if override_address_selection is set
1590 unsigned no_wake_from_sleep:1;
1591 unsigned is_demuxable_parent:1;
1592 unsigned reuse_port:1;
1593
1594 uuid_t parent_flow_uuid;
1595 struct necp_demux_pattern demux_patterns[NECP_MAX_DEMUX_PATTERNS];
1596 uint8_t demux_pattern_count;
1597 };
1598
1599 struct necp_client_group_members {
1600 size_t group_members_length;
1601 u_int8_t *group_members __sized_by(group_members_length);
1602 };
1603
1604 struct necp_client_error_parameters {
1605 int32_t error;
1606 bool force_report;
1607 };
1608
1609 struct necp_client_agent_parameters {
1610 union {
1611 struct necp_client_nexus_parameters nexus_request;
1612 u_int8_t close_token[QUIC_STATELESS_RESET_TOKEN_SIZE];
1613 struct necp_client_group_members group_members;
1614 struct necp_client_error_parameters error;
1615 } u;
1616 };
1617
1618 #define NECP_CLIENT_CBACTION_NONVIABLE 1
1619 #define NECP_CLIENT_CBACTION_VIABLE 2
1620 #define NECP_CLIENT_CBACTION_INITIAL 3
1621
1622 struct necp_client_add_flow_default {
1623 uuid_t agent_uuid;
1624 uuid_t registration_id;
1625 u_int16_t flags; // NECP_CLIENT_FLOW_FLAGS_*
1626 u_int16_t stats_request_count;
1627 struct necp_client_flow_stats stats_requests[1];
1628 } __attribute__((__packed__));
1629
1630 typedef void (*necp_client_flow_cb)(void *handle, int action, uint32_t interface_index, uint32_t necp_flags, bool *viable);
1631
1632 #if SKYWALK
1633 struct skmem_arena_mmap_info;
1634
1635 extern pid_t necp_client_get_proc_pid_from_arena_info(struct skmem_arena_mmap_info *arena_info);
1636
1637 extern void necp_client_early_close(uuid_t client_id); // Cause a single client to close stats, etc
1638
1639 #endif /* SKYWALK */
1640
1641 #endif /* BSD_KERNEL_PRIVATE */
1642
1643 #ifdef KERNEL
1644 #ifdef KERNEL_PRIVATE
1645 struct nstat_domain_info;
1646 extern void necp_copy_inp_domain_info(struct inpcb *, struct socket *, struct nstat_domain_info *);
1647 extern void necp_with_inp_domain_name(struct socket *so, void *ctx, void (*with_func)(char *domain_name __null_terminated, void *ctx));
1648 extern bool net_domain_contains_hostname(char *hostname_string __null_terminated, char *domain_string __null_terminated);
1649 #endif /* KERNEL_PRIVATE */
1650 #endif /* KERNEL */
1651
1652 #ifndef KERNEL
1653
1654 extern int necp_match_policy(const uint8_t *parameters, size_t parameters_size, struct necp_aggregate_result *returned_result);
1655
1656 extern int necp_open(int flags);
1657
1658 extern int necp_client_action(int necp_fd, uint32_t action, uuid_t client_id,
1659 size_t client_id_len, uint8_t *buffer, size_t buffer_size);
1660
1661 extern int necp_session_open(int flags);
1662
1663 extern int necp_session_action(int necp_fd, uint32_t action,
1664 uint8_t *in_buffer, size_t in_buffer_length,
1665 uint8_t *out_buffer, size_t out_buffer_length);
1666
1667 #endif /* !KERNEL */
1668
1669 #endif /* PRIVATE */
1670
1671 #endif
1672