]> git.saurik.com Git - apple/xnu.git/blame_incremental - bsd/net/necp.h
projects / apple / xnu.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
xnu-7195.101.1.tar.gz
[apple/xnu.git] / bsd / net / necp.h
... / ...
CommitLineData
1/*
2 * Copyright (c) 2013-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#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_stat.h>
37#include <sys/socket.h>
38#include <net/if.h>
39
40/*
41 * Name registered by the NECP
42 */
43#define NECP_CONTROL_NAME "com.apple.net.necp_control"
44
45#define NECP_TLV_LENGTH_UINT32 1
46
47struct necp_packet_header {
48 u_int8_t packet_type;
49 u_int8_t flags;
50 u_int32_t message_id;
51};
52
53/*
54 * Control message commands
55 */
56#define NECP_PACKET_TYPE_POLICY_ADD 1
57#define NECP_PACKET_TYPE_POLICY_GET 2
58#define NECP_PACKET_TYPE_POLICY_DELETE 3
59#define NECP_PACKET_TYPE_POLICY_APPLY_ALL 4
60#define NECP_PACKET_TYPE_POLICY_LIST_ALL 5
61#define NECP_PACKET_TYPE_POLICY_DELETE_ALL 6
62#define NECP_PACKET_TYPE_SET_SESSION_PRIORITY 7
63#define NECP_PACKET_TYPE_LOCK_SESSION_TO_PROC 8
64#define NECP_PACKET_TYPE_REGISTER_SERVICE 9
65#define NECP_PACKET_TYPE_UNREGISTER_SERVICE 10
66#define NECP_PACKET_TYPE_POLICY_DUMP_ALL 11
67
68/*
69 * Session actions
70 */
71#define NECP_SESSION_ACTION_POLICY_ADD 1 // In: Policy TLVs Out: necp_policy_id
72#define NECP_SESSION_ACTION_POLICY_GET 2 // In: necp_policy_id Out: Policy TLVs
73#define NECP_SESSION_ACTION_POLICY_DELETE 3 // In: necp_policy_id Out: None
74#define NECP_SESSION_ACTION_POLICY_APPLY_ALL 4 // In: None Out: None
75#define NECP_SESSION_ACTION_POLICY_LIST_ALL 5 // In: None Out: TLVs of IDs
76#define NECP_SESSION_ACTION_POLICY_DELETE_ALL 6 // In: None Out: None
77#define NECP_SESSION_ACTION_SET_SESSION_PRIORITY 7 // In: necp_session_priority Out: None
78#define NECP_SESSION_ACTION_LOCK_SESSION_TO_PROC 8 // In: None Out: None
79#define NECP_SESSION_ACTION_REGISTER_SERVICE 9 // In: uuid_t Out: None
80#define NECP_SESSION_ACTION_UNREGISTER_SERVICE 10 // In: uuid_t Out: None
81#define NECP_SESSION_ACTION_POLICY_DUMP_ALL 11 // In: None Out: uint32_t bytes length, then Policy TLVs
82
83/*
84 * Control message flags
85 */
86#define NECP_PACKET_FLAGS_RESPONSE 0x01 // Used for acks, errors, and query responses
87
88/*
89 * Control message TLV types
90 */
91#define NECP_TLV_NIL 0
92#define NECP_TLV_ERROR 1 // u_int32_t
93#define NECP_TLV_POLICY_ORDER 2 // u_int32_t
94#define NECP_TLV_POLICY_CONDITION 3
95#define NECP_TLV_POLICY_RESULT 4
96#define NECP_TLV_POLICY_ID 5 // u_int32_t
97#define NECP_TLV_SESSION_PRIORITY 6 // u_int32_t
98#define NECP_TLV_ATTRIBUTE_DOMAIN 7 // char[]
99#define NECP_TLV_ATTRIBUTE_ACCOUNT 8 // char[]
100#define NECP_TLV_SERVICE_UUID 9 // uuid_t
101#define NECP_TLV_ROUTE_RULE 10
102
103/*
104 * Control message TLV sent only by the kernel to userspace
105 */
106#define NECP_TLV_POLICY_OWNER 100 // char []
107#define NECP_TLV_POLICY_DUMP 101
108#define NECP_TLV_POLICY_RESULT_STRING 102 // char []
109#define NECP_TLV_POLICY_SESSION_ORDER 103 // u_int32_t
110
111/*
112 * Condition flags
113 */
114#define NECP_POLICY_CONDITION_FLAGS_NEGATIVE 0x01 // Negative
115
116/*
117 * Conditions
118 * Used for setting policies as well as passing parameters to necp_match_policy.
119 */
120#define NECP_POLICY_CONDITION_DEFAULT 0 // N/A, not valid with any other conditions
121// Socket/Application conditions
122#define NECP_POLICY_CONDITION_APPLICATION 1 // uuid_t, uses effective UUID when possible
123#define NECP_POLICY_CONDITION_REAL_APPLICATION 2 // uuid_t, never uses effective UUID. Only valid with NECP_POLICY_CONDITION_APPLICATION
124#define NECP_POLICY_CONDITION_DOMAIN 3 // String, such as apple.com
125#define NECP_POLICY_CONDITION_ACCOUNT 4 // String
126#define NECP_POLICY_CONDITION_ENTITLEMENT 5 // String
127#define NECP_POLICY_CONDITION_PID 6 // pid_t
128#define NECP_POLICY_CONDITION_UID 7 // uid_t
129#define NECP_POLICY_CONDITION_ALL_INTERFACES 8 // N/A
130#define NECP_POLICY_CONDITION_BOUND_INTERFACE 9 // String
131#define NECP_POLICY_CONDITION_TRAFFIC_CLASS 10 // necp_policy_condition_tc_range
132// Socket/IP conditions
133#define NECP_POLICY_CONDITION_IP_PROTOCOL 11 // u_int16_t
134#define NECP_POLICY_CONDITION_LOCAL_ADDR 12 // necp_policy_condition_addr
135#define NECP_POLICY_CONDITION_REMOTE_ADDR 13 // necp_policy_condition_addr
136#define NECP_POLICY_CONDITION_LOCAL_ADDR_RANGE 14 // necp_policy_condition_addr_range
137#define NECP_POLICY_CONDITION_REMOTE_ADDR_RANGE 15 // necp_policy_condition_addr_range
138#define NECP_POLICY_CONDITION_AGENT_TYPE 16 // struct necp_policy_condition_agent_type
139#define NECP_POLICY_CONDITION_HAS_CLIENT 17 // N/A
140#define NECP_POLICY_CONDITION_LOCAL_NETWORKS 18 // Matches all local networks
141// Socket-only conditions
142#define NECP_POLICY_CONDITION_FLOW_IP_PROTOCOL 19 // u_int16_t
143#define NECP_POLICY_CONDITION_FLOW_LOCAL_ADDR 20 // necp_policy_condition_addr
144#define NECP_POLICY_CONDITION_FLOW_REMOTE_ADDR 21 // necp_policy_condition_addr
145#define NECP_POLICY_CONDITION_FLOW_LOCAL_ADDR_RANGE 22 // necp_policy_condition_addr_range
146#define NECP_POLICY_CONDITION_FLOW_REMOTE_ADDR_RANGE 23 // necp_policy_condition_addr_range
147#define NECP_POLICY_CONDITION_FLOW_IS_LOOPBACK 31 // N/A
148// Socket/Application conditions, continued
149#define NECP_POLICY_CONDITION_CLIENT_FLAGS 24 // u_int32_t, values from NECP_CLIENT_PARAMETER_FLAG_*
150#define NECP_POLICY_CONDITION_FLOW_LOCAL_ADDR_EMPTY 25 // N/A
151#define NECP_POLICY_CONDITION_FLOW_REMOTE_ADDR_EMPTY 26 // N/A
152#define NECP_POLICY_CONDITION_PLATFORM_BINARY 27 // N/A
153#define NECP_POLICY_CONDITION_SDK_VERSION 28 // struct necp_policy_condition_sdk_version
154#define NECP_POLICY_CONDITION_SIGNING_IDENTIFIER 29 // String
155#define NECP_POLICY_CONDITION_PACKET_FILTER_TAGS 30 // u_int16_t
156#define NECP_POLICY_CONDITION_DELEGATE_IS_PLATFORM_BINARY 32 // N/A
157
158/*
159 * Policy Packet tags
160 */
161#define NECP_POLICY_CONDITION_PACKET_FILTER_TAG_STACK_DROP 0x01
162#define NECP_POLICY_CONDITION_PACKET_FILTER_TAG_MAX NECP_POLICY_CONDITION_PACKET_FILTER_TAG_STACK_DROP
163
164/*
165 * Results
166 */
167#define NECP_POLICY_RESULT_PASS 1 // N/A
168#define NECP_POLICY_RESULT_SKIP 2 // u_int32_t, policy order to skip to. 0 to skip all session policies.
169#define NECP_POLICY_RESULT_DROP 3 // N/A
170#define NECP_POLICY_RESULT_SOCKET_DIVERT 4 // u_int32_t, flow divert control unit
171#define NECP_POLICY_RESULT_SOCKET_FILTER 5 // u_int32_t, filter control unit
172#define NECP_POLICY_RESULT_IP_TUNNEL 6 // String, interface name
173#define NECP_POLICY_RESULT_IP_FILTER 7 // ?
174#define NECP_POLICY_RESULT_TRIGGER 8 // service uuid_t
175#define NECP_POLICY_RESULT_TRIGGER_IF_NEEDED 9 // service uuid_t
176#define NECP_POLICY_RESULT_TRIGGER_SCOPED 10 // service uuid_t
177#define NECP_POLICY_RESULT_NO_TRIGGER_SCOPED 11 // service uuid_t
178#define NECP_POLICY_RESULT_SOCKET_SCOPED 12 // String, interface name
179#define NECP_POLICY_RESULT_ROUTE_RULES 13 // N/A, must have route rules defined
180#define NECP_POLICY_RESULT_USE_NETAGENT 14 // netagent uuid_t
181#define NECP_POLICY_RESULT_NETAGENT_SCOPED 15 // netagent uuid_t
182#define NECP_POLICY_RESULT_SCOPED_DIRECT 16 // N/A, scopes to primary physical interface
183#define NECP_POLICY_RESULT_ALLOW_UNENTITLED 17 // N/A
184
185#define NECP_POLICY_RESULT_MAX NECP_POLICY_RESULT_ALLOW_UNENTITLED
186
187/*
188 * PASS Result Flags
189 */
190#define NECP_POLICY_PASS_NO_SKIP_IPSEC 0x01
191#define NECP_POLICY_PASS_PF_TAG 0x02
192
193/*
194 * DROP Result Flags
195 */
196#define NECP_POLICY_DROP_FLAG_LOCAL_NETWORK 0x01
197
198/*
199 * Route Rules
200 * Detailed parameters for NECP_POLICY_RESULT_ROUTE_RULES.
201 */
202#define NECP_ROUTE_RULE_NONE 0 // N/A
203#define NECP_ROUTE_RULE_DENY_INTERFACE 1 // String, or empty to match all
204#define NECP_ROUTE_RULE_ALLOW_INTERFACE 2 // String, or empty to match all
205#define NECP_ROUTE_RULE_QOS_MARKING 3 // String, or empty to match all
206#define NECP_ROUTE_RULE_DENY_LQM_ABORT 4 // String, or empty to match all
207#define NECP_ROUTE_RULE_USE_NETAGENT 5 // UUID, followed by string or empty
208
209#define NECP_ROUTE_RULE_FLAG_CELLULAR 0x01
210#define NECP_ROUTE_RULE_FLAG_WIFI 0x02
211#define NECP_ROUTE_RULE_FLAG_WIRED 0x04
212#define NECP_ROUTE_RULE_FLAG_EXPENSIVE 0x08
213#define NECP_ROUTE_RULE_FLAG_CONSTRAINED 0x10
214
215/*
216 * Error types
217 */
218#define NECP_ERROR_INTERNAL 0
219#define NECP_ERROR_UNKNOWN_PACKET_TYPE 1
220#define NECP_ERROR_INVALID_TLV 2
221#define NECP_ERROR_POLICY_RESULT_INVALID 3
222#define NECP_ERROR_POLICY_CONDITIONS_INVALID 4
223#define NECP_ERROR_POLICY_ID_NOT_FOUND 5
224#define NECP_ERROR_INVALID_PROCESS 6
225#define NECP_ERROR_ROUTE_RULES_INVALID 7
226
227// Modifiers
228#define NECP_MASK_USERSPACE_ONLY 0x80000000 // on filter_control_unit value
229
230struct necp_policy_condition_tc_range {
231 u_int32_t start_tc;
232 u_int32_t end_tc;
233} __attribute__((__packed__));
234
235struct necp_policy_condition_addr {
236 u_int8_t prefix;
237 union {
238 struct sockaddr sa;
239 struct sockaddr_in sin;
240 struct sockaddr_in6 sin6;
241 } address;
242} __attribute__((__packed__));
243
244struct necp_policy_condition_addr_range {
245 union {
246 struct sockaddr sa;
247 struct sockaddr_in sin;
248 struct sockaddr_in6 sin6;
249 } start_address;
250 union {
251 struct sockaddr sa;
252 struct sockaddr_in sin;
253 struct sockaddr_in6 sin6;
254 } end_address;
255} __attribute__((__packed__));
256
257struct necp_policy_condition_agent_type {
258 char agent_domain[32];
259 char agent_type[32];
260} __attribute__((__packed__));
261
262struct necp_policy_condition_sdk_version {
263 uint32_t platform; // e.g., PLATFORM_IOS
264 uint32_t min_version; // Encoded as XXXX.YY.ZZ
265 uint32_t version; // Encoded as XXXX.YY.ZZ
266} __attribute__((__packed__));
267
268#define NECP_SESSION_PRIORITY_UNKNOWN 0
269#define NECP_SESSION_PRIORITY_CONTROL 1
270#define NECP_SESSION_PRIORITY_PRIVILEGED_TUNNEL 2
271#define NECP_SESSION_PRIORITY_HIGH 3
272#define NECP_SESSION_PRIORITY_HIGH_1 4
273#define NECP_SESSION_PRIORITY_HIGH_2 5
274#define NECP_SESSION_PRIORITY_HIGH_3 6
275#define NECP_SESSION_PRIORITY_HIGH_4 7
276#define NECP_SESSION_PRIORITY_HIGH_RESTRICTED 8
277#define NECP_SESSION_PRIORITY_DEFAULT 9
278#define NECP_SESSION_PRIORITY_LOW 10
279#define NECP_SESSION_NUM_PRIORITIES NECP_SESSION_PRIORITY_LOW
280
281typedef u_int32_t necp_policy_id;
282typedef u_int32_t necp_policy_order;
283typedef u_int32_t necp_session_priority;
284
285typedef u_int32_t necp_kernel_policy_result;
286typedef u_int32_t necp_kernel_policy_filter;
287
288typedef union {
289 u_int tunnel_interface_index;
290 u_int scoped_interface_index;
291 u_int32_t flow_divert_control_unit;
292 u_int32_t filter_control_unit;
293 u_int32_t pass_flags;
294 u_int32_t drop_flags;
295} necp_kernel_policy_routing_result_parameter;
296
297#define NECP_SERVICE_FLAGS_REGISTERED 0x01
298#define NECP_MAX_NETAGENTS 8
299
300#define NECP_AGENT_USE_FLAG_SCOPE 0x01
301
302#define NECP_TFO_COOKIE_LEN_MAX 16
303struct necp_aggregate_result {
304 necp_kernel_policy_result routing_result;
305 necp_kernel_policy_routing_result_parameter routing_result_parameter;
306 necp_kernel_policy_filter filter_control_unit;
307 u_int32_t flow_divert_aggregate_unit;
308 necp_kernel_policy_result service_action;
309 uuid_t service_uuid;
310 u_int32_t service_flags;
311 u_int32_t service_data;
312 u_int routed_interface_index;
313 u_int32_t policy_id;
314 uuid_t netagents[NECP_MAX_NETAGENTS];
315 u_int32_t netagent_use_flags[NECP_MAX_NETAGENTS];
316 struct ipv6_prefix nat64_prefixes[NAT64_MAX_NUM_PREFIXES];
317 u_int8_t mss_recommended;
318};
319
320/*
321 * Statistics. It would be nice if the definitions in ntstat.h could be used,
322 * but they get entangled with #defines for v4 etc in pfvar.h and it may be better practice
323 * to have separate definitions here.
324 */
325struct necp_stat_counts {
326 /* Counters */
327 u_int64_t necp_stat_rxpackets __attribute__((aligned(8)));
328 u_int64_t necp_stat_rxbytes __attribute__((aligned(8)));
329 u_int64_t necp_stat_txpackets __attribute__((aligned(8)));
330 u_int64_t necp_stat_txbytes __attribute__((aligned(8)));
331
332 u_int32_t necp_stat_rxduplicatebytes;
333 u_int32_t necp_stat_rxoutoforderbytes;
334 u_int32_t necp_stat_txretransmit;
335
336 u_int32_t necp_stat_connectattempts;
337 u_int32_t necp_stat_connectsuccesses;
338
339 u_int32_t necp_stat_min_rtt;
340 u_int32_t necp_stat_avg_rtt;
341 u_int32_t necp_stat_var_rtt;
342
343#define NECP_STAT_ROUTE_FLAGS 1
344 u_int32_t necp_stat_route_flags;
345};
346
347// Note, some metadata is implicit in the necp client itself:
348// From the process itself : pid, upid, uuid, proc name.
349// From the necp client parameters: local and remote addresses, euuid, traffic class, ifindex
350//
351// The following may well be supplied via future necp client parameters,
352// but they are here so they don't get forgotten.
353struct necp_basic_metadata {
354 u_int32_t rcvbufsize;
355 u_int32_t rcvbufused;
356};
357
358struct necp_connection_probe_status {
359 unsigned int probe_activated : 1;
360 unsigned int write_probe_failed : 1;
361 unsigned int read_probe_failed : 1;
362 unsigned int conn_probe_failed : 1;
363};
364
365struct necp_extra_tcp_metadata {
366 struct necp_connection_probe_status probestatus;
367
368 u_int32_t sndbufsize;
369 u_int32_t sndbufused;
370 u_int32_t txunacked;
371 u_int32_t txwindow;
372 u_int32_t txcwindow;
373 u_int32_t flags; // use SOF_*
374 u_int32_t flags1; // use SOF1_*
375 u_int32_t traffic_mgt_flags;
376 u_int32_t cc_alg_index;
377 u_int32_t state;
378};
379
380struct necp_stats_hdr {
381 u_int32_t necp_stats_type __attribute__((aligned(8)));
382 u_int32_t necp_stats_ver;
383 u_int64_t __necp_stats_reserved; // Pad the field for future use
384};
385
386#define NECP_CLIENT_STATISTICS_TYPE_TCP 1 // Identifies use of necp_tcp_stats
387#define NECP_CLIENT_STATISTICS_TYPE_UDP 2 // Identifies use of necp_udp_stats
388#define NECP_CLIENT_STATISTICS_TYPE_QUIC 3 // Identifies use of necp_quic_stats
389
390#define NECP_CLIENT_STATISTICS_TYPE_TCP_VER_1 1 // Currently supported version for TCP
391#define NECP_CLIENT_STATISTICS_TYPE_UDP_VER_1 1 // Currently supported version for UDP
392#define NECP_CLIENT_STATISTICS_TYPE_QUIC_VER_1 1 // Currently supported version for QUIC
393
394#define NECP_CLIENT_STATISTICS_TYPE_TCP_CURRENT_VER NECP_CLIENT_STATISTICS_TYPE_TCP_VER_1
395#define NECP_CLIENT_STATISTICS_TYPE_UDP_CURRENT_VER NECP_CLIENT_STATISTICS_TYPE_UDP_VER_1
396#define NECP_CLIENT_STATISTICS_TYPE_QUIC_CURRENT_VER NECP_CLIENT_STATISTICS_TYPE_QUIC_VER_1
397
398#define NECP_CLIENT_STATISTICS_EVENT_INIT 0x00000000 // Register the flow
399#define NECP_CLIENT_STATISTICS_EVENT_TIME_WAIT 0x00000001 // The flow is effectively finished but waiting on timer
400
401struct necp_tcp_stats {
402 struct necp_stats_hdr necp_tcp_hdr;
403 struct necp_stat_counts necp_tcp_counts;
404 struct necp_basic_metadata necp_tcp_basic;
405 struct necp_extra_tcp_metadata necp_tcp_extra;
406};
407
408struct necp_udp_stats {
409 struct necp_stats_hdr necp_udp_hdr;
410 struct necp_stat_counts necp_udp_counts;
411 struct necp_basic_metadata necp_udp_basic;
412};
413
414
415/*
416 * The following reflects the special case for QUIC.
417 * It is a streaming protocol built on top of UDP.
418 * Therefore QUIC stats are defined as basic UDP stats
419 * with some extra meta data.
420 * TODO: For now the extra metadata is an exact replica
421 * of the metadata for TCP. However keeping that separate allows
422 * the structures to diverge later as new stats are added.
423 */
424#define QUIC_STATELESS_RESET_TOKEN_SIZE 16
425struct necp_extra_quic_metadata {
426 u_int32_t sndbufsize;
427 u_int32_t sndbufused;
428 u_int32_t txunacked;
429 u_int32_t txwindow;
430 u_int32_t txcwindow;
431 u_int32_t traffic_mgt_flags;
432 u_int32_t cc_alg_index;
433 u_int32_t state;
434 u_int8_t ssr_token[QUIC_STATELESS_RESET_TOKEN_SIZE];
435};
436
437#define necp_quic_hdr necp_quic_udp_stats.necp_udp_hdr
438#define necp_quic_counts necp_quic_udp_stats.necp_udp_counts
439#define necp_quic_basic necp_quic_udp_stats.necp_udp_basic
440struct necp_quic_stats {
441 struct necp_udp_stats necp_quic_udp_stats;
442 struct necp_extra_quic_metadata necp_quic_extra;
443};
444
445typedef struct necp_all_stats {
446 union {
447 struct necp_tcp_stats tcp_stats;
448 struct necp_udp_stats udp_stats;
449 struct necp_quic_stats quic_stats;
450 } all_stats_u;
451} necp_all_stats;
452
453// Memory for statistics is requested via a necp_stats_bufreq
454//
455struct necp_stats_bufreq {
456 u_int32_t necp_stats_bufreq_id __attribute__((aligned(8)));
457 u_int32_t necp_stats_bufreq_type; // NECP_CLIENT_STATISTICS_TYPE_*
458 u_int32_t necp_stats_bufreq_ver; // NECP_CLIENT_STATISTICS_TYPE_*_VER
459 u_int32_t necp_stats_bufreq_size;
460 union {
461 void *necp_stats_bufreq_addr;
462 mach_vm_address_t necp_stats_bufreq_uaddr;
463 };
464};
465
466#define NECP_CLIENT_STATISTICS_BUFREQ_ID 0xbf // Distinguishes from statistics actions taking a necp_all_stats struct
467
468// There is a limit to the number of statistics structures that may be allocated per process, subject to change
469//
470#define NECP_MAX_PER_PROCESS_CLIENT_STATISTICS_STRUCTS 512
471
472#define NECP_TCP_ECN_HEURISTICS_SYN_RST 1
473typedef struct necp_tcp_ecn_cache {
474 u_int8_t necp_tcp_ecn_heuristics_success:1;
475 u_int8_t necp_tcp_ecn_heuristics_loss:1;
476 u_int8_t necp_tcp_ecn_heuristics_drop_rst:1;
477 u_int8_t necp_tcp_ecn_heuristics_drop_rxmt:1;
478 u_int8_t necp_tcp_ecn_heuristics_aggressive:1;
479 u_int8_t necp_tcp_ecn_heuristics_syn_rst:1;
480} necp_tcp_ecn_cache;
481
482#define NECP_TCP_TFO_HEURISTICS_RST 1
483typedef struct necp_tcp_tfo_cache {
484 u_int8_t necp_tcp_tfo_cookie[NECP_TFO_COOKIE_LEN_MAX];
485 u_int8_t necp_tcp_tfo_cookie_len;
486 u_int8_t necp_tcp_tfo_heuristics_success:1; // TFO succeeded with data in the SYN
487 u_int8_t necp_tcp_tfo_heuristics_loss:1; // TFO SYN-loss with data
488 u_int8_t necp_tcp_tfo_heuristics_middlebox:1; // TFO middlebox detected
489 u_int8_t necp_tcp_tfo_heuristics_success_req:1; // TFO succeeded with the TFO-option in the SYN
490 u_int8_t necp_tcp_tfo_heuristics_loss_req:1; // TFO SYN-loss with the TFO-option
491 u_int8_t necp_tcp_tfo_heuristics_rst_data:1; // Recevied RST upon SYN with data in the SYN
492 u_int8_t necp_tcp_tfo_heuristics_rst_req:1; // Received RST upon SYN with the TFO-option
493} necp_tcp_tfo_cache;
494
495#define NECP_CLIENT_CACHE_TYPE_ECN 1 // Identifies use of necp_tcp_ecn_cache
496#define NECP_CLIENT_CACHE_TYPE_TFO 2 // Identifies use of necp_tcp_tfo_cache
497
498#define NECP_CLIENT_CACHE_TYPE_ECN_VER_1 1 // Currently supported version for ECN
499#define NECP_CLIENT_CACHE_TYPE_TFO_VER_1 1 // Currently supported version for TFO
500
501typedef struct necp_cache_buffer {
502 u_int8_t necp_cache_buf_type; // NECP_CLIENT_CACHE_TYPE_*
503 u_int8_t necp_cache_buf_ver; // NECP_CLIENT_CACHE_TYPE_*_VER
504 u_int32_t necp_cache_buf_size;
505 mach_vm_address_t necp_cache_buf_addr;
506} necp_cache_buffer;
507
508/*
509 * NECP Client definitions
510 */
511#define NECP_MAX_CLIENT_PARAMETERS_SIZE 1024
512#define NECP_MAX_CLIENT_RESULT_SIZE 512
513
514#define NECP_OPEN_FLAG_OBSERVER 0x01 // Observers can query clients they don't own
515#define NECP_OPEN_FLAG_BACKGROUND 0x02 // Mark this fd as backgrounded
516#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.
517
518#define NECP_FD_SUPPORTS_GUARD 1
519
520#define NECP_CLIENT_ACTION_ADD 1 // Register a new client. Input: parameters in buffer; Output: client_id
521#define NECP_CLIENT_ACTION_REMOVE 2 // Unregister a client. Input: client_id, optional struct ifnet_stats_per_flow
522#define NECP_CLIENT_ACTION_COPY_PARAMETERS 3 // Copy client parameters. Input: client_id; Output: parameters in buffer
523#define NECP_CLIENT_ACTION_COPY_RESULT 4 // Copy client result. Input: client_id; Output: result in buffer
524#define NECP_CLIENT_ACTION_COPY_LIST 5 // Copy all client IDs. Output: struct necp_client_list in buffer
525#define NECP_CLIENT_ACTION_REQUEST_NEXUS_INSTANCE 6 // Request a nexus instance from a nexus provider, optional struct necp_stats_bufreq
526#define NECP_CLIENT_ACTION_AGENT 7 // Interact with agent. Input: client_id, agent parameters
527#define NECP_CLIENT_ACTION_COPY_AGENT 8 // Copy agent content. Input: agent UUID; Output: struct netagent
528#define NECP_CLIENT_ACTION_COPY_INTERFACE 9 // Copy interface details. Input: ifindex cast to UUID; Output: struct necp_interface_details
529#define NECP_CLIENT_ACTION_SET_STATISTICS 10 // Deprecated
530#define NECP_CLIENT_ACTION_COPY_ROUTE_STATISTICS 11 // Get route statistics. Input: client_id; Output: struct necp_stat_counts
531#define NECP_CLIENT_ACTION_AGENT_USE 12 // Return the use count and increment the use count. Input/Output: struct necp_agent_use_parameters
532#define NECP_CLIENT_ACTION_MAP_SYSCTLS 13 // Get the read-only sysctls memory location. Output: mach_vm_address_t
533#define NECP_CLIENT_ACTION_UPDATE_CACHE 14 // Update heuristics and cache
534#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
535#define NECP_CLIENT_ACTION_COPY_UPDATED_RESULT 16 // Copy client result only if changed. Input: client_id; Output: result in buffer
536#define NECP_CLIENT_ACTION_ADD_FLOW 17 // Add a flow. Input: client_id; Output: struct necp_client_add_flow
537#define NECP_CLIENT_ACTION_REMOVE_FLOW 18 // Remove a flow. Input: flow_id, optional struct ifnet_stats_per_flow
538#define NECP_CLIENT_ACTION_CLAIM 19 // Claim a client that has been added for this unique PID. Input: client_id
539#define NECP_CLIENT_ACTION_SIGN 20 // Sign a resolver answer. Input: struct necp_client_resolver_answer; Output: signed tag, expected to be 32 bytes
540#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
541
542#define NECP_CLIENT_PARAMETER_APPLICATION NECP_POLICY_CONDITION_APPLICATION // Requires entitlement
543#define NECP_CLIENT_PARAMETER_REAL_APPLICATION NECP_POLICY_CONDITION_REAL_APPLICATION // Requires entitlement
544#define NECP_CLIENT_PARAMETER_DOMAIN NECP_POLICY_CONDITION_DOMAIN
545#define NECP_CLIENT_PARAMETER_ACCOUNT NECP_POLICY_CONDITION_ACCOUNT
546#define NECP_CLIENT_PARAMETER_PID NECP_POLICY_CONDITION_PID // Requires entitlement
547#define NECP_CLIENT_PARAMETER_UID NECP_POLICY_CONDITION_UID // Requires entitlement
548#define NECP_CLIENT_PARAMETER_BOUND_INTERFACE NECP_POLICY_CONDITION_BOUND_INTERFACE
549#define NECP_CLIENT_PARAMETER_TRAFFIC_CLASS NECP_POLICY_CONDITION_TRAFFIC_CLASS
550#define NECP_CLIENT_PARAMETER_IP_PROTOCOL NECP_POLICY_CONDITION_IP_PROTOCOL
551#define NECP_CLIENT_PARAMETER_LOCAL_ADDRESS NECP_POLICY_CONDITION_LOCAL_ADDR
552#define NECP_CLIENT_PARAMETER_REMOTE_ADDRESS NECP_POLICY_CONDITION_REMOTE_ADDR
553#define NECP_CLIENT_PARAMETER_NEXUS_KEY 102
554
555// "Prohibit" will never choose an interface with that property
556#define NECP_CLIENT_PARAMETER_PROHIBIT_INTERFACE 100 // String, interface name
557#define NECP_CLIENT_PARAMETER_PROHIBIT_IF_TYPE 101 // u_int8_t, see ifru_functional_type in <net/if.h>
558#define NECP_CLIENT_PARAMETER_PROHIBIT_AGENT 102 // uuid_t, network agent UUID
559#define NECP_CLIENT_PARAMETER_PROHIBIT_AGENT_TYPE 103 // struct necp_client_parameter_netagent_type
560
561// "Require" will choose an interface with that property, or none if not found
562#define NECP_CLIENT_PARAMETER_REQUIRE_IF_TYPE 111 // u_int8_t, see ifru_functional_type in <net/if.h>
563#define NECP_CLIENT_PARAMETER_REQUIRE_AGENT 112 // uuid_t, network agent UUID
564#define NECP_CLIENT_PARAMETER_REQUIRE_AGENT_TYPE 113 // struct necp_client_parameter_netagent_type
565
566// "Prefer" will choose an interface with an agent, or best otherwise if not found
567#define NECP_CLIENT_PARAMETER_PREFER_AGENT 122 // uuid_t, network agent UUID
568#define NECP_CLIENT_PARAMETER_PREFER_AGENT_TYPE 123 // struct necp_client_parameter_netagent_type
569
570// "Avoid" will choose an interface without an agent, or best otherwise if unavoidable
571#define NECP_CLIENT_PARAMETER_AVOID_AGENT 124 // uuid_t, network agent UUID
572#define NECP_CLIENT_PARAMETER_AVOID_AGENT_TYPE 125 // struct necp_client_parameter_netagent_type
573
574// Use actions with NECP_CLIENT_ACTION_AGENT
575#define NECP_CLIENT_PARAMETER_TRIGGER_AGENT 130 // uuid_t, network agent UUID
576#define NECP_CLIENT_PARAMETER_ASSERT_AGENT 131 // uuid_t, network agent UUID
577#define NECP_CLIENT_PARAMETER_UNASSERT_AGENT 132 // uuid_t, network agent UUID
578
579#define NECP_CLIENT_PARAMETER_PARENT_ID 150 // uuid_t, client UUID
580
581#define NECP_CLIENT_PARAMETER_LOCAL_ENDPOINT 200 // struct necp_client_endpoint
582#define NECP_CLIENT_PARAMETER_REMOTE_ENDPOINT 201 // struct necp_client_endpoint
583#define NECP_CLIENT_PARAMETER_BROWSE_DESCRIPTOR 202 // struct necp_client_endpoint
584#define NECP_CLIENT_PARAMETER_RESOLVER_TAG 203 // Tag as bytes, expected to be 32 bytes
585#define NECP_CLIENT_PARAMETER_ADVERTISE_DESCRIPTOR 204 // struct necp_client_endpoint
586
587#define NECP_CLIENT_PARAMETER_DELEGATED_UPID 210 // u_int64_t, requires entitlement
588
589#define NECP_CLIENT_PARAMETER_ETHERTYPE 220 // u_int16_t, ethertype
590#define NECP_CLIENT_PARAMETER_TRANSPORT_PROTOCOL 221 // u_int8_t, IPPROTO_
591
592#define NECP_CLIENT_PARAMETER_LOCAL_ADDRESS_PREFERENCE 230 // u_int8_t, NECP_CLIENT_PARAMETER_LOCAL_ADDRESS_PREFERENCE_
593
594#define NECP_CLIENT_PARAMETER_LOCAL_ADDRESS_PREFERENCE_DEFAULT 0
595#define NECP_CLIENT_PARAMETER_LOCAL_ADDRESS_PREFERENCE_TEMPORARY 1
596#define NECP_CLIENT_PARAMETER_LOCAL_ADDRESS_PREFERENCE_STABLE 2
597
598#define NECP_CLIENT_PARAMETER_FLAGS 250 // u_int32_t, see NECP_CLIENT_PAREMETER_FLAG_* values
599
600#define NECP_CLIENT_PARAMETER_FLAG_MULTIPATH 0x0001 // Get multipath interface results
601#define NECP_CLIENT_PARAMETER_FLAG_BROWSE 0x0002 // Agent assertions on nexuses are requests to browse
602#define NECP_CLIENT_PARAMETER_FLAG_PROHIBIT_EXPENSIVE 0x0004 // Prohibit expensive interfaces
603#define NECP_CLIENT_PARAMETER_FLAG_LISTENER 0x0008 // Client is interested in listening for inbound connections
604#define NECP_CLIENT_PARAMETER_FLAG_DISCRETIONARY 0x0010 // Client's traffic is discretionary, and eligible for early defuncting
605#define NECP_CLIENT_PARAMETER_FLAG_ECN_ENABLE 0x0020 // Client is requesting to enable ECN
606#define NECP_CLIENT_PARAMETER_FLAG_ECN_DISABLE 0x0040 // Client is requesting to disable ECN
607#define NECP_CLIENT_PARAMETER_FLAG_TFO_ENABLE 0x0080 // Client is requesting to enable TFO
608#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
609#define NECP_CLIENT_PARAMETER_FLAG_CUSTOM_ETHER 0x0200 // Client expects to open a custom ethernet channel
610#define NECP_CLIENT_PARAMETER_FLAG_CUSTOM_IP 0x0400 // Client expects to open a custom IP protocol channel
611#define NECP_CLIENT_PARAMETER_FLAG_INTERPOSE 0x0800 // Client expects to open an interpose filter channel
612#define NECP_CLIENT_PARAMETER_FLAG_PROHIBIT_CONSTRAINED 0x1000 // Prohibit constrained interfaces
613#define NECP_CLIENT_PARAMETER_FLAG_FALLBACK_TRAFFIC 0x2000 // Fallback traffic
614#define NECP_CLIENT_PARAMETER_FLAG_INBOUND 0x4000 // Flow is inbound (passive)
615
616#define NECP_CLIENT_RESULT_CLIENT_ID 1 // uuid_t
617#define NECP_CLIENT_RESULT_POLICY_RESULT 2 // u_int32_t
618#define NECP_CLIENT_RESULT_POLICY_RESULT_PARAMETER 3 // u_int32_t
619#define NECP_CLIENT_RESULT_FILTER_CONTROL_UNIT 4 // u_int32_t
620#define NECP_CLIENT_RESULT_INTERFACE_INDEX 5 // u_int32_t
621#define NECP_CLIENT_RESULT_NETAGENT 6 // struct necp_client_result_netagent
622#define NECP_CLIENT_RESULT_FLAGS 7 // u_int32_t, see NECP_CLIENT_RESULT_FLAG_* values
623#define NECP_CLIENT_RESULT_INTERFACE 8 // struct necp_client_result_interface
624#define NECP_CLIENT_RESULT_INTERFACE_OPTION 9 // struct necp_client_interface_option
625#define NECP_CLIENT_RESULT_EFFECTIVE_MTU 10 // u_int32_t
626#define NECP_CLIENT_RESULT_FLOW 11 // TLV array of a single flow's state
627#define NECP_CLIENT_RESULT_PROTO_CTL_EVENT 12
628#define NECP_CLIENT_RESULT_TFO_COOKIE 13 // NECP_TFO_COOKIE_LEN_MAX
629#define NECP_CLIENT_RESULT_TFO_FLAGS 14 // u_int8_t
630#define NECP_CLIENT_RESULT_RECOMMENDED_MSS 15 // u_int8_t
631#define NECP_CLIENT_RESULT_FLOW_ID 16 // uuid_t
632#define NECP_CLIENT_RESULT_INTERFACE_TIME_DELTA 17 // u_int32_t, seconds since interface up/down
633#define NECP_CLIENT_RESULT_REASON 18 // u_int32_t, see NECP_CLIENT_RESULT_REASON_* values
634#define NECP_CLIENT_RESULT_FLOW_DIVERT_AGGREGATE_UNIT 19 // u_int32_t
635
636#define NECP_CLIENT_RESULT_NEXUS_INSTANCE 100 // uuid_t
637#define NECP_CLIENT_RESULT_NEXUS_PORT 101 // u_int16_t
638#define NECP_CLIENT_RESULT_NEXUS_KEY 102 // uuid_t
639#define NECP_CLIENT_RESULT_NEXUS_PORT_FLOW_INDEX 103 // u_int32_t
640#define NECP_CLIENT_RESULT_NEXUS_FLOW_STATS 104 // struct sk_stats_flow *
641
642#define NECP_CLIENT_RESULT_LOCAL_ENDPOINT 200 // struct necp_client_endpoint
643#define NECP_CLIENT_RESULT_REMOTE_ENDPOINT 201 // struct necp_client_endpoint
644#define NECP_CLIENT_RESULT_DISCOVERED_ENDPOINT 202 // struct necp_client_endpoint, result of browse
645#define NECP_CLIENT_RESULT_RESOLVED_ENDPOINT 203 // struct necp_client_endpoint, result of resolve
646#define NECP_CLIENT_RESULT_LOCAL_ETHER_ADDR 204 // struct ether_addr
647#define NECP_CLIENT_RESULT_REMOTE_ETHER_ADDR 205 // struct ether_addr
648#define NECP_CLIENT_RESULT_EFFECTIVE_TRAFFIC_CLASS 210 // u_int32_t
649#define NECP_CLIENT_RESULT_TRAFFIC_MGMT_BG 211 // u_int32_t, 1: background, 0: not background
650#define NECP_CLIENT_RESULT_GATEWAY 212 // struct necp_client_endpoint
651#define NECP_CLIENT_RESULT_NAT64 213 // struct ipv6_prefix[NAT64_MAX_NUM_PREFIXES]
652
653#define NECP_CLIENT_RESULT_FLAG_IS_LOCAL 0x0001 // Routes to this device
654#define NECP_CLIENT_RESULT_FLAG_IS_DIRECT 0x0002 // Routes to directly accessible peer
655#define NECP_CLIENT_RESULT_FLAG_HAS_IPV4 0x0004 // Supports IPv4
656#define NECP_CLIENT_RESULT_FLAG_HAS_IPV6 0x0008 // Supports IPv6
657#define NECP_CLIENT_RESULT_FLAG_DEFUNCT 0x0010 // Defunct
658#define NECP_CLIENT_RESULT_FLAG_SATISFIED 0x0020 // Satisfied path
659#define NECP_CLIENT_RESULT_FLAG_FLOW_ASSIGNED 0x0040 // Assigned, the flow is active
660#define NECP_CLIENT_RESULT_FLAG_FLOW_VIABLE 0x0080 // Viable, the flow has a valid route
661#define NECP_CLIENT_RESULT_FLAG_PROBE_CONNECTIVITY 0x0100 // Flow should probe connectivity
662#define NECP_CLIENT_RESULT_FLAG_ECN_ENABLED 0x0200 // ECN should be used
663#define NECP_CLIENT_RESULT_FLAG_FAST_OPEN_BLOCKED 0x0400 // Fast open should not be used
664#define NECP_CLIENT_RESULT_FLAG_LINK_QUALITY_ABORT 0x0800 // Link quality is very bad, recommend close connections
665#define NECP_CLIENT_RESULT_FLAG_ALLOW_QOS_MARKING 0x1000 // QoS marking is allowed
666#define NECP_CLIENT_RESULT_FLAG_HAS_NAT64 0x2000 // Has NAT64 prefix
667#define NECP_CLIENT_RESULT_FLAG_INTERFACE_LOW_POWER 0x4000 // Interface is in low-power mode
668#define NECP_CLIENT_RESULT_FLAG_SPECIFIC_LISTENER 0x8000 // Listener should not listen on all interfaces
669
670#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)
671
672#define NECP_CLIENT_RESULT_FAST_OPEN_SND_PROBE 0x01 // DEPRECATED - Fast open send probe
673#define NECP_CLIENT_RESULT_FAST_OPEN_RCV_PROBE 0x02 // DEPRECATED - Fast open receive probe
674
675#define NECP_CLIENT_RESULT_RECOMMENDED_MSS_NONE 0x01
676#define NECP_CLIENT_RESULT_RECOMMENDED_MSS_LOW 0x02
677#define NECP_CLIENT_RESULT_RECOMMENDED_MSS_MEDIUM 0x04
678
679#define NECP_CLIENT_RESULT_REASON_EXPENSIVE_PROHIBITED 1 // Expensive networks were prohibited
680#define NECP_CLIENT_RESULT_REASON_CONSTRAINED_PROHIBITED 2 // Constrained networks were prohibited
681#define NECP_CLIENT_RESULT_REASON_CELLULAR_DENIED 3 // Denied by a cellular route rule
682#define NECP_CLIENT_RESULT_REASON_WIFI_DENIED 4 // Denied by a wifi route rule
683#define NECP_CLIENT_RESULT_REASON_LOCAL_NETWORK_PROHIBITED 5 // Local network access prohibited
684
685struct necp_interface_signature {
686 u_int8_t signature[IFNET_SIGNATURELEN];
687 u_int8_t signature_len;
688};
689
690struct necp_interface_details {
691 char name[IFXNAMSIZ];
692 u_int32_t index;
693 u_int32_t generation;
694 u_int32_t functional_type;
695 u_int32_t delegate_index;
696 u_int32_t flags; // see NECP_INTERFACE_FLAG_*
697 u_int32_t mtu;
698 struct necp_interface_signature ipv4_signature;
699 struct necp_interface_signature ipv6_signature;
700 u_int32_t ipv4_netmask;
701 u_int32_t ipv4_broadcast;
702};
703
704#define NECP_INTERFACE_FLAG_EXPENSIVE 0x0001
705#define NECP_INTERFACE_FLAG_TXSTART 0X0002
706#define NECP_INTERFACE_FLAG_NOACKPRI 0x0004
707#define NECP_INTERFACE_FLAG_3CARRIERAGG 0x0008
708#define NECP_INTERFACE_FLAG_IS_LOW_POWER 0x0010
709#define NECP_INTERFACE_FLAG_MPK_LOG 0x0020 // Multi-layer Packet Logging
710#define NECP_INTERFACE_FLAG_CONSTRAINED 0x0040
711#define NECP_INTERFACE_FLAG_HAS_NETMASK 0x0080
712#define NECP_INTERFACE_FLAG_HAS_BROADCAST 0x0100
713#define NECP_INTERFACE_FLAG_SUPPORTS_MULTICAST 0x0200
714#define NECP_INTERFACE_FLAG_HAS_DNS 0x0400
715#define NECP_INTERFACE_FLAG_HAS_NAT64 0x0800
716#define NECP_INTERFACE_FLAG_IPV4_ROUTABLE 0x1000
717#define NECP_INTERFACE_FLAG_IPV6_ROUTABLE 0x2000
718
719struct necp_client_parameter_netagent_type {
720 char netagent_domain[32];
721 char netagent_type[32];
722};
723
724struct necp_client_result_netagent {
725 u_int32_t generation;
726 uuid_t netagent_uuid;
727};
728
729struct necp_client_result_interface {
730 u_int32_t generation;
731 u_int32_t index;
732};
733
734#define NECP_USES_INTERFACE_OPTIONS_FOR_BROWSE 1
735
736struct necp_client_interface_option {
737 u_int32_t interface_index;
738 u_int32_t interface_generation;
739 uuid_t nexus_agent;
740};
741
742struct necp_client_endpoint {
743 union {
744 struct sockaddr sa;
745 struct sockaddr_in sin;
746 struct sockaddr_in6 sin6;
747 struct {
748 u_int8_t endpoint_length;
749 u_int8_t endpoint_family; // Use AF_UNSPEC to target a name
750 u_int16_t endpoint_port;
751 u_int32_t endpoint_type; // Client-specific type
752 char endpoint_data[0]; // Type-specific endpoint value
753 } endpoint;
754 } u;
755};
756
757struct necp_client_list {
758 u_int32_t client_count;
759 uuid_t clients[0];
760};
761
762struct kev_necp_policies_changed_data {
763 u_int32_t changed_count; // Defaults to 0.
764};
765
766#define NECP_CLIENT_FLOW_FLAGS_ALLOW_NEXUS 0x01 // Request a nexus instance upon adding a flow
767#define NECP_CLIENT_FLOW_FLAGS_USE_CLIENT_ID 0x02 // Register the client ID rather than the flow registration ID with network agents
768#define NECP_CLIENT_FLOW_FLAGS_BROWSE 0x04 // Create request with a browse agent
769#define NECP_CLIENT_FLOW_FLAGS_RESOLVE 0x08 // Create request with a resolution agent
770#define NECP_CLIENT_FLOW_FLAGS_OVERRIDE_ADDRESS 0x10 // Flow has a different remote address than the parent flow
771
772struct necp_client_flow_stats {
773 u_int32_t stats_type; // NECP_CLIENT_STATISTICS_TYPE_*
774 u_int32_t stats_version; // NECP_CLIENT_STATISTICS_TYPE_*_VER
775 u_int32_t stats_size;
776 mach_vm_address_t stats_addr;
777};
778
779struct necp_client_add_flow {
780 uuid_t agent_uuid;
781 uuid_t registration_id;
782 u_int16_t flags; // NECP_CLIENT_FLOW_FLAGS_*
783 u_int16_t stats_request_count;
784 struct necp_client_flow_stats stats_requests[0];
785 // sockaddr for override endpoint
786} __attribute__((__packed__));
787
788struct necp_agent_use_parameters {
789 uuid_t agent_uuid;
790 uint64_t out_use_count;
791};
792
793struct necp_client_flow_protoctl_event {
794 uint32_t protoctl_event_code;
795 uint32_t protoctl_event_val;
796 /* TCP seq number is in host byte order */
797 uint32_t protoctl_event_tcp_seq_num;
798};
799
800#define NECP_CLIENT_UPDATE_TYPE_PARAMETERS 1 // Parameters, for a new client
801#define NECP_CLIENT_UPDATE_TYPE_RESULT 2 // Result, for a udpated client
802#define NECP_CLIENT_UPDATE_TYPE_REMOVE 3 // Empty, for a removed client
803
804struct necp_client_observer_update {
805 u_int32_t update_type; // NECP_CLIENT_UPDATE_TYPE_*
806 u_int8_t tlv_buffer[0]; // Parameters or result as TLVs, based on type
807};
808
809#define NECP_CLIENT_SIGN_TYPE_RESOLVER_ANSWER 1
810
811struct necp_client_signable {
812 uuid_t client_id;
813 u_int32_t sign_type;
814} __attribute__((__packed__));
815
816struct necp_client_resolver_answer {
817 uuid_t client_id;
818 u_int32_t sign_type;
819 union sockaddr_in_4_6 address_answer;
820 u_int32_t hostname_length;
821 // hostname
822} __attribute__((__packed__));
823
824#define NECP_FILTER_UNIT_NO_FILTER UINT32_MAX // Reserved filter unit value that prohibits all filters and socket filters
825
826/*
827 * The sysctl "net.necp.necp_drop_dest_level" controls the global drop rule policy for
828 * a set of destinations addresses at the given level -- the drop rule is the last one
829 * to be evaluated at this level.
830 */
831#define MAX_NECP_DROP_DEST_LEVEL_ADDRS 8
832
833struct necp_drop_dest_entry {
834 u_int32_t level; // priority level
835 u_int32_t order; // session order (read only via sysctl)
836 struct necp_policy_condition_addr cond_addr;
837};
838
839struct necp_drop_dest_policy {
840 u_int32_t entry_count;
841 struct necp_drop_dest_entry entries[MAX_NECP_DROP_DEST_LEVEL_ADDRS];
842};
843
844#ifdef BSD_KERNEL_PRIVATE
845#include <stdbool.h>
846#include <sys/socketvar.h>
847#include <sys/kern_control.h>
848#include <netinet/ip_var.h>
849#include <netinet6/ip6_var.h>
850#include <net/if_var.h>
851#include <sys/syslog.h>
852#include <net/network_agent.h>
853#include <net/ethernet.h>
854#include <os/log.h>
855
856
857SYSCTL_DECL(_net_necp);
858
859extern os_log_t necp_log_handle;
860
861#define NECPLOG(level, format, ...) do { \
862 if (level == LOG_ERR) { \
863 os_log_error(necp_log_handle, "%s: " format "\n", __FUNCTION__, __VA_ARGS__); \
864 } else { \
865 os_log(necp_log_handle, "%s: " format "\n", __FUNCTION__, __VA_ARGS__); \
866 } \
867} while (0)
868
869#define NECPLOG0(level, msg) do { \
870 if (level == LOG_ERR) { \
871 os_log_error(necp_log_handle, "%s: %s\n", __FUNCTION__, msg); \
872 } else { \
873 os_log(necp_log_handle, "%s: %s\n", __FUNCTION__, msg); \
874 } \
875} while (0)
876
877enum necp_fd_type_t {
878 necp_fd_type_invalid = 0,
879 necp_fd_type_session = 1,
880 necp_fd_type_client = 2,
881};
882
883union necp_sockaddr_union {
884 struct sockaddr sa;
885 struct sockaddr_in sin;
886 struct sockaddr_in6 sin6;
887};
888
889/*
890 * kstats
891 * The ustats and kstats region are mirrored. So when we allocate with
892 * skmem_cache from kstats region, we also get an ustats object. To tie them
893 * together, kstats has an extra *necp_stats_ustats pointer pointing to the
894 * ustats object
895 */
896struct necp_all_kstats {
897 struct necp_all_stats necp_stats_comm; /* kernel private stats snapshot */
898 struct necp_all_stats *necp_stats_ustats; /* points to user-visible stats (in shared ustats region) */
899};
900
901extern errno_t necp_client_init(void);
902extern int necp_application_find_policy_match_internal(proc_t proc, u_int8_t *parameters, u_int32_t parameters_size,
903 struct necp_aggregate_result *returned_result,
904 u_int32_t *flags, u_int32_t *reason, u_int required_interface_index,
905 const union necp_sockaddr_union *override_local_addr,
906 const union necp_sockaddr_union *override_remote_addr,
907 struct necp_client_endpoint *returned_v4_gateway,
908 struct necp_client_endpoint *returned_v6_gateway,
909 struct rtentry **returned_route, bool ignore_address,
910 bool has_client,
911 uuid_t *returned_override_euuid);
912/*
913 * TLV utilities
914 *
915 * Note that these functions (other than necp_buffer_find_tlv) do not check the length of the entire buffer,
916 * so the caller must be sure that the entire TLV is within bounds.
917 */
918struct necp_tlv_header {
919 u_int8_t type;
920 u_int32_t length;
921} __attribute__((__packed__));
922
923extern u_int8_t *necp_buffer_write_tlv(u_int8_t *cursor, u_int8_t type, u_int32_t length, const void *value,
924 u_int8_t *buffer, u_int32_t buffer_length);
925extern u_int8_t *necp_buffer_write_tlv_if_different(u_int8_t *cursor, u_int8_t type,
926 u_int32_t length, const void *value, bool *updated,
927 u_int8_t *buffer, u_int32_t buffer_length);
928extern u_int8_t necp_buffer_get_tlv_type(u_int8_t *buffer, int tlv_offset);
929extern u_int32_t necp_buffer_get_tlv_length(u_int8_t *buffer, int tlv_offset);
930extern u_int8_t *necp_buffer_get_tlv_value(u_int8_t *buffer, int tlv_offset, u_int32_t *value_size);
931extern int necp_buffer_find_tlv(u_int8_t *buffer, u_int32_t buffer_length, int offset, u_int8_t type, int *err, int next);
932
933#define NECPCTL_DROP_ALL_LEVEL 1 /* Drop all packets if no policy matches above this level */
934#define NECPCTL_DEBUG 2 /* Log all kernel policy matches */
935#define NECPCTL_PASS_LOOPBACK 3 /* Pass all loopback traffic */
936#define NECPCTL_PASS_KEEPALIVES 4 /* Pass all kernel-generated keepalive traffic */
937#define NECPCTL_SOCKET_POLICY_COUNT 5 /* Count of all socket-level policies */
938#define NECPCTL_SOCKET_NON_APP_POLICY_COUNT 6 /* Count of non-per-app socket-level policies */
939#define NECPCTL_IP_POLICY_COUNT 7 /* Count of all ip-level policies */
940#define NECPCTL_SESSION_COUNT 8 /* Count of NECP sessions */
941#define NECPCTL_CLIENT_FD_COUNT 9 /* Count of NECP client fds */
942#define NECPCTL_CLIENT_COUNT 10 /* Count of NECP clients */
943#define NECPCTL_ARENA_COUNT 11 /* Count of NECP arenas (stats, etc) */
944#define NECPCTL_NEXUS_FLOW_COUNT 12 /* Count of NECP nexus flows */
945#define NECPCTL_SOCKET_FLOW_COUNT 13 /* Count of NECP socket flows */
946#define NECPCTL_IF_FLOW_COUNT 14 /* Count of NECP socket flows */
947#define NECPCTL_OBSERVER_FD_COUNT 15 /* Count of NECP observer fds */
948#define NECPCTL_OBSERVER_MESSAGE_LIMIT 16 /* Number of of NECP observer messages allowed to be queued */
949#define NECPCTL_SYSCTL_ARENA_COUNT 17 /* Count of sysctl arenas */
950#define NECPCTL_DROP_UNENTITLED_LEVEL 18 /* Drop unentitled process traffic above this level */
951#define NECPCTL_PASS_INTERPOSE 19 /* Pass interpose */
952#define NECPCTL_RESTRICT_MULTICAST 20 /* Restrict multicast access */
953#define NECPCTL_DEDUP_POLICIES 21 /* Dedup overlapping policies */
954
955#define NECP_LOOPBACK_PASS_ALL 1 // Pass all loopback traffic
956#define NECP_LOOPBACK_PASS_WITH_FILTER 2 // Pass all loopback traffic, but activate content filter and/or flow divert if applicable
957
958#define NECPCTL_NAMES { \
959 { 0, 0 }, \
960 { "drop_all_level", CTLTYPE_INT }, \
961 { "debug", CTLTYPE_INT }, \
962 { "pass_loopback", CTLTYPE_INT }, \
963 { "pass_keepalives", CTLTYPE_INT }, \
964 { "pass_interpose", CTLTYPE_INT }, \
965}
966
967typedef u_int32_t necp_kernel_policy_id;
968#define NECP_KERNEL_POLICY_ID_NONE 0
969#define NECP_KERNEL_POLICY_ID_NO_MATCH 1
970#define NECP_KERNEL_POLICY_ID_FIRST_VALID_SOCKET 2
971#define NECP_KERNEL_POLICY_ID_FIRST_VALID_IP UINT16_MAX
972
973typedef u_int32_t necp_app_id;
974
975#define NECP_KERNEL_POLICY_RESULT_NONE 0
976#define NECP_KERNEL_POLICY_RESULT_PASS NECP_POLICY_RESULT_PASS
977#define NECP_KERNEL_POLICY_RESULT_SKIP NECP_POLICY_RESULT_SKIP
978#define NECP_KERNEL_POLICY_RESULT_DROP NECP_POLICY_RESULT_DROP
979#define NECP_KERNEL_POLICY_RESULT_SOCKET_DIVERT NECP_POLICY_RESULT_SOCKET_DIVERT
980#define NECP_KERNEL_POLICY_RESULT_SOCKET_FILTER NECP_POLICY_RESULT_SOCKET_FILTER
981#define NECP_KERNEL_POLICY_RESULT_IP_TUNNEL NECP_POLICY_RESULT_IP_TUNNEL
982#define NECP_KERNEL_POLICY_RESULT_IP_FILTER NECP_POLICY_RESULT_IP_FILTER
983#define NECP_KERNEL_POLICY_RESULT_TRIGGER NECP_POLICY_RESULT_TRIGGER
984#define NECP_KERNEL_POLICY_RESULT_TRIGGER_IF_NEEDED NECP_POLICY_RESULT_TRIGGER_IF_NEEDED
985#define NECP_KERNEL_POLICY_RESULT_TRIGGER_SCOPED NECP_POLICY_RESULT_TRIGGER_SCOPED
986#define NECP_KERNEL_POLICY_RESULT_NO_TRIGGER_SCOPED NECP_POLICY_RESULT_NO_TRIGGER_SCOPED
987#define NECP_KERNEL_POLICY_RESULT_SOCKET_SCOPED NECP_POLICY_RESULT_SOCKET_SCOPED
988#define NECP_KERNEL_POLICY_RESULT_ROUTE_RULES NECP_POLICY_RESULT_ROUTE_RULES
989#define NECP_KERNEL_POLICY_RESULT_USE_NETAGENT NECP_POLICY_RESULT_USE_NETAGENT
990#define NECP_KERNEL_POLICY_RESULT_NETAGENT_SCOPED NECP_POLICY_RESULT_NETAGENT_SCOPED
991#define NECP_KERNEL_POLICY_RESULT_SCOPED_DIRECT NECP_POLICY_RESULT_SCOPED_DIRECT
992#define NECP_KERNEL_POLICY_RESULT_ALLOW_UNENTITLED NECP_POLICY_RESULT_ALLOW_UNENTITLED
993
994#define NECP_KERNEL_POLICY_PASS_NO_SKIP_IPSEC NECP_POLICY_PASS_NO_SKIP_IPSEC
995#define NECP_KERNEL_POLICY_PASS_PF_TAG NECP_POLICY_PASS_PF_TAG
996
997#define NECP_KERNEL_POLICY_DROP_FLAG_LOCAL_NETWORK NECP_POLICY_DROP_FLAG_LOCAL_NETWORK
998
999typedef struct {
1000 u_int32_t identifier;
1001 u_int32_t data;
1002} necp_kernel_policy_service;
1003
1004typedef union {
1005 u_int tunnel_interface_index;
1006 u_int scoped_interface_index;
1007 u_int32_t flow_divert_control_unit;
1008 u_int32_t filter_control_unit;
1009 u_int32_t skip_policy_order;
1010 u_int32_t route_rule_id;
1011 u_int32_t netagent_id;
1012 u_int32_t pass_flags;
1013 u_int32_t drop_flags;
1014 necp_kernel_policy_service service;
1015} necp_kernel_policy_result_parameter;
1016
1017enum necp_boolean_state {
1018 necp_boolean_state_unknown = 0,
1019 necp_boolean_state_false = 1,
1020 necp_boolean_state_true = 2,
1021};
1022
1023struct necp_kernel_socket_policy {
1024 LIST_ENTRY(necp_kernel_socket_policy) chain;
1025 necp_kernel_policy_id id;
1026 necp_policy_order order;
1027 u_int32_t session_order;
1028 int session_pid;
1029
1030 u_int32_t condition_mask;
1031 u_int32_t condition_negated_mask;
1032 u_int32_t cond_client_flags;
1033 necp_kernel_policy_id cond_policy_id;
1034 u_int32_t cond_app_id; // Locally assigned ID value stored
1035 u_int32_t cond_real_app_id; // Locally assigned ID value stored
1036 char *cond_custom_entitlement; // String
1037 u_int8_t cond_custom_entitlement_matched;// Boolean if entitlement matched app
1038 u_int32_t cond_account_id; // Locally assigned ID value stored
1039 char *cond_domain; // String
1040 u_int8_t cond_domain_dot_count; // Number of dots in cond_domain
1041 pid_t cond_pid;
1042 uid_t cond_uid;
1043 ifnet_t cond_bound_interface; // Matches specific binding only
1044 struct necp_policy_condition_tc_range cond_traffic_class; // Matches traffic class in range
1045 u_int16_t cond_protocol; // Matches IP protcol number
1046 union necp_sockaddr_union cond_local_start; // Matches local IP address (or start)
1047 union necp_sockaddr_union cond_local_end; // Matches IP address range
1048 u_int8_t cond_local_prefix; // Defines subnet
1049 union necp_sockaddr_union cond_remote_start; // Matches remote IP address (or start)
1050 union necp_sockaddr_union cond_remote_end; // Matches IP address range
1051 u_int8_t cond_remote_prefix; // Defines subnet
1052 struct necp_policy_condition_agent_type cond_agent_type;
1053 struct necp_policy_condition_sdk_version cond_sdk_version;
1054 char *cond_signing_identifier; // String
1055 u_int16_t cond_packet_filter_tags;
1056 int32_t cond_pid_version;
1057
1058 necp_kernel_policy_result result;
1059 necp_kernel_policy_result_parameter result_parameter;
1060};
1061
1062struct necp_kernel_ip_output_policy {
1063 LIST_ENTRY(necp_kernel_ip_output_policy) chain;
1064 necp_kernel_policy_id id;
1065 necp_policy_order suborder;
1066 necp_policy_order order;
1067 u_int32_t session_order;
1068 int session_pid;
1069
1070 u_int32_t condition_mask;
1071 u_int32_t condition_negated_mask;
1072 necp_kernel_policy_id cond_policy_id;
1073 ifnet_t cond_bound_interface; // Matches specific binding only
1074 u_int16_t cond_protocol; // Matches IP protcol number
1075 union necp_sockaddr_union cond_local_start; // Matches local IP address (or start)
1076 union necp_sockaddr_union cond_local_end; // Matches IP address range
1077 u_int8_t cond_local_prefix; // Defines subnet
1078 union necp_sockaddr_union cond_remote_start; // Matches remote IP address (or start)
1079 union necp_sockaddr_union cond_remote_end; // Matches IP address range
1080 u_int8_t cond_remote_prefix; // Defines subnet
1081 u_int32_t cond_last_interface_index;
1082 u_int16_t cond_packet_filter_tags;
1083
1084 necp_kernel_policy_result result;
1085 necp_kernel_policy_result_parameter result_parameter;
1086};
1087
1088#define MAX_KERNEL_SOCKET_POLICIES 1
1089#define MAX_KERNEL_IP_OUTPUT_POLICIES 4
1090struct necp_session_policy {
1091 LIST_ENTRY(necp_session_policy) chain;
1092 bool applied; // Applied into the kernel table
1093 bool pending_deletion; // Waiting to be removed from kernel table
1094 bool pending_update; // Policy has been modified since creation/last application
1095 necp_policy_id local_id;
1096 necp_policy_order order;
1097 u_int8_t *result;
1098 u_int32_t result_size;
1099 u_int8_t *conditions; // Array of conditions, each with a u_int32_t length at start
1100 u_int32_t conditions_size;
1101 u_int8_t *route_rules; // Array of route rules, each with a u_int32_t length at start
1102 u_int32_t route_rules_size;
1103
1104 uuid_t applied_app_uuid;
1105 uuid_t applied_real_app_uuid;
1106 char *applied_account;
1107
1108 uuid_t applied_result_uuid;
1109
1110 u_int32_t applied_route_rules_id;
1111
1112 necp_kernel_policy_id kernel_socket_policies[MAX_KERNEL_SOCKET_POLICIES];
1113 necp_kernel_policy_id kernel_ip_output_policies[MAX_KERNEL_IP_OUTPUT_POLICIES];
1114};
1115
1116struct necp_aggregate_socket_result {
1117 necp_kernel_policy_result result;
1118 necp_kernel_policy_result_parameter result_parameter;
1119 necp_kernel_policy_filter filter_control_unit;
1120 u_int32_t flow_divert_aggregate_unit;
1121 u_int32_t route_rule_id;
1122 int32_t qos_marking_gencount;
1123};
1124
1125struct necp_inpcb_result {
1126 u_int32_t app_id;
1127 necp_kernel_policy_id policy_id;
1128 necp_kernel_policy_id skip_policy_id;
1129 int32_t policy_gencount;
1130 u_int32_t flowhash;
1131 u_int32_t network_denied_notifies;// Notification count
1132 struct necp_aggregate_socket_result results;
1133};
1134
1135extern errno_t necp_init(void);
1136
1137extern errno_t necp_set_socket_attributes(struct socket *so, struct sockopt *sopt);
1138extern errno_t necp_get_socket_attributes(struct socket *so, struct sockopt *sopt);
1139extern void necp_inpcb_remove_cb(struct inpcb *inp);
1140extern void necp_inpcb_dispose(struct inpcb *inp);
1141
1142extern u_int32_t necp_socket_get_content_filter_control_unit(struct socket *so);
1143
1144extern bool necp_socket_should_use_flow_divert(struct inpcb *inp);
1145extern u_int32_t necp_socket_get_flow_divert_control_unit(struct inpcb *inp, uint32_t *aggregate_unit);
1146
1147extern bool necp_socket_should_rescope(struct inpcb *inp);
1148extern u_int necp_socket_get_rescope_if_index(struct inpcb *inp);
1149extern u_int32_t necp_socket_get_effective_mtu(struct inpcb *inp, u_int32_t current_mtu);
1150
1151extern bool necp_socket_is_allowed_to_recv_on_interface(struct inpcb *inp, ifnet_t interface);
1152
1153extern bool necp_socket_is_allowed_to_send_recv(struct inpcb *inp, ifnet_t input_interface, u_int16_t pf_tag,
1154 necp_kernel_policy_id *return_policy_id,
1155 u_int32_t *return_route_rule_id,
1156 necp_kernel_policy_id *return_skip_policy_id, u_int32_t *return_pass_flags);
1157extern bool necp_socket_is_allowed_to_send_recv_v4(struct inpcb *inp, u_int16_t local_port,
1158 u_int16_t remote_port, struct in_addr *local_addr,
1159 struct in_addr *remote_addr, ifnet_t input_interface, u_int16_t pf_tag,
1160 necp_kernel_policy_id *return_policy_id, u_int32_t *return_route_rule_id,
1161 necp_kernel_policy_id *return_skip_policy_id, u_int32_t *return_pass_flags);
1162extern bool necp_socket_is_allowed_to_send_recv_v6(struct inpcb *inp, u_int16_t local_port,
1163 u_int16_t remote_port, struct in6_addr *local_addr,
1164 struct in6_addr *remote_addr, ifnet_t input_interface, u_int16_t pf_tag,
1165 necp_kernel_policy_id *return_policy_id, u_int32_t *return_route_rule_id,
1166 necp_kernel_policy_id *return_skip_policy_id, u_int32_t *return_pass_flags);
1167extern void necp_socket_update_qos_marking(struct inpcb *inp, struct rtentry *route, u_int32_t route_rule_id);
1168extern 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);
1169extern int necp_mark_packet_from_socket(struct mbuf *packet, struct inpcb *inp, necp_kernel_policy_id policy_id,
1170 u_int32_t route_rule_id, necp_kernel_policy_id skip_policy_id, u_int32_t pass_flags);
1171extern necp_kernel_policy_id necp_get_policy_id_from_packet(struct mbuf *packet);
1172extern necp_kernel_policy_id necp_get_skip_policy_id_from_packet(struct mbuf *packet);
1173extern u_int16_t necp_get_packet_filter_tags_from_packet(struct mbuf *packet);
1174extern bool necp_packet_should_skip_filters(struct mbuf *packet);
1175extern u_int32_t necp_get_last_interface_index_from_packet(struct mbuf *packet);
1176extern u_int32_t necp_get_route_rule_id_from_packet(struct mbuf *packet);
1177extern int necp_get_app_uuid_from_packet(struct mbuf *packet,
1178 uuid_t app_uuid);
1179
1180extern necp_kernel_policy_id necp_socket_find_policy_match(struct inpcb *inp, struct sockaddr *override_local_addr,
1181 struct sockaddr *override_remote_addr, u_int32_t override_bound_interface);
1182extern necp_kernel_policy_id necp_ip_output_find_policy_match(struct mbuf *packet, int flags, struct ip_out_args *ipoa,
1183 struct rtentry *rt,
1184 necp_kernel_policy_result *result,
1185 necp_kernel_policy_result_parameter *result_parameter);
1186extern necp_kernel_policy_id necp_ip6_output_find_policy_match(struct mbuf *packet, int flags, struct ip6_out_args *ip6oa,
1187 struct rtentry *rt,
1188 necp_kernel_policy_result *result,
1189 necp_kernel_policy_result_parameter *result_parameter);
1190
1191extern int necp_mark_packet_from_ip(struct mbuf *packet, necp_kernel_policy_id policy_id);
1192extern int necp_mark_packet_from_interface(struct mbuf *packet, ifnet_t interface);
1193
1194extern ifnet_t necp_get_ifnet_from_result_parameter(necp_kernel_policy_result_parameter *result_parameter);
1195extern bool necp_packet_can_rebind_to_ifnet(struct mbuf *packet, struct ifnet *interface, struct route *new_route, int family);
1196
1197extern bool necp_packet_is_allowed_over_interface(struct mbuf *packet, struct ifnet *interface);
1198
1199extern int necp_mark_packet_as_keepalive(struct mbuf *packet, bool is_keepalive);
1200extern bool necp_get_is_keepalive_from_packet(struct mbuf *packet);
1201
1202extern int necp_sign_resolver_answer(uuid_t client_id, u_int8_t *query, u_int32_t query_length,
1203 u_int8_t *answer, u_int32_t answer_length,
1204 u_int8_t *tag, u_int32_t *out_tag_length);
1205
1206extern bool necp_validate_resolver_answer(uuid_t client_id, u_int8_t *query, u_int32_t query_length,
1207 u_int8_t *answer, u_int32_t answer_length,
1208 u_int8_t *tag, u_int32_t tag_length);
1209
1210extern void necp_update_all_clients(void); // Handle general re-evaluate event
1211extern void necp_update_all_clients_immediately_if_needed(bool should_update_immediately); // Handle general re-evaluate event
1212
1213extern 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
1214
1215extern bool necp_set_client_as_background(proc_t proc, struct fileproc *fp, bool background); // Set all clients for an fp as background or not
1216
1217struct necp_fd_data;
1218extern void necp_fd_memstatus(proc_t proc, uint32_t status, struct necp_fd_data *client_fd); // Purge memory of clients for the process
1219extern void necp_fd_defunct(proc_t proc, struct necp_fd_data *client_fd); // Set all clients for an process as defunct
1220
1221extern int necp_client_register_socket_flow(pid_t pid, uuid_t client_id, struct inpcb *inp);
1222
1223extern int necp_client_register_socket_listener(pid_t pid, uuid_t client_id, struct inpcb *inp);
1224
1225
1226extern int necp_client_assert_bb_radio_manager(uuid_t client_id, bool assert);
1227
1228extern int necp_client_assign_from_socket(pid_t pid, uuid_t client_id, struct inpcb *inp);
1229
1230extern int necp_assign_client_result(uuid_t netagent_uuid, uuid_t client_id,
1231 u_int8_t *assigned_results, size_t assigned_results_length);
1232struct skmem_obj_info; // forward declaration
1233extern int necp_stats_ctor(struct skmem_obj_info *oi, struct skmem_obj_info *oim, void *arg, uint32_t skmflag);
1234extern int necp_stats_dtor(void *addr, void *arg);
1235
1236/* value to denote invalid flow advisory index */
1237struct netagent_session;
1238extern int
1239necp_update_flow_protoctl_event(uuid_t netagent_uuid, uuid_t client_id,
1240 uint32_t protoctl_event_code, uint32_t protoctl_event_val,
1241 uint32_t protoctl_event_tcp_seq_num);
1242
1243#define NECP_FLOWADV_IDX_INVALID UINT32_MAX
1244extern void *necp_create_nexus_assign_message(uuid_t nexus_instance, u_int32_t nexus_port, void *key, uint32_t key_length,
1245 struct necp_client_endpoint *local_endpoint, struct necp_client_endpoint *remote_endpoint,
1246 struct ether_addr *local_ether_addr,
1247 u_int32_t flow_adv_index, void *flow_stats, size_t *message_length);
1248
1249struct necp_client_nexus_parameters {
1250 pid_t pid;
1251 pid_t epid;
1252 uuid_t euuid;
1253 union necp_sockaddr_union local_addr;
1254 union necp_sockaddr_union remote_addr;
1255 u_int8_t ip_protocol;
1256 u_int8_t transport_protocol;
1257 u_int16_t ethertype;
1258 u_int32_t traffic_class;
1259 necp_policy_id policy_id;
1260 unsigned is_listener:1;
1261 unsigned is_interpose:1;
1262 unsigned is_custom_ether:1;
1263 unsigned allow_qos_marking:1;
1264 unsigned override_address_selection:1;
1265 unsigned use_stable_address:1; // Used if override_address_selection is set
1266};
1267
1268struct necp_client_agent_parameters {
1269 union {
1270 struct necp_client_nexus_parameters nexus_request;
1271 u_int8_t close_token[QUIC_STATELESS_RESET_TOKEN_SIZE];
1272 } u;
1273};
1274
1275#define NECP_CLIENT_CBACTION_NONVIABLE 1
1276#define NECP_CLIENT_CBACTION_VIABLE 2
1277#define NECP_CLIENT_CBACTION_INITIAL 3
1278
1279struct necp_client_add_flow_default {
1280 uuid_t agent_uuid;
1281 uuid_t registration_id;
1282 u_int16_t flags; // NECP_CLIENT_FLOW_FLAGS_*
1283 u_int16_t stats_request_count;
1284 struct necp_client_flow_stats stats_requests[1];
1285} __attribute__((__packed__));
1286
1287typedef void (*necp_client_flow_cb)(void *handle, int action, uint32_t interface_index, uint32_t necp_flags, bool *viable);
1288
1289extern void necp_client_reap_caches(boolean_t purge);
1290
1291
1292#endif /* BSD_KERNEL_PRIVATE */
1293
1294#ifdef KERNEL
1295#ifdef KERNEL_PRIVATE
1296extern bool net_domain_contains_hostname(char *hostname_string, char *domain_string);
1297#endif /* KERNEL_PRIVATE */
1298#endif /* KERNEL */
1299
1300#ifndef KERNEL
1301
1302extern int necp_match_policy(const uint8_t *parameters, size_t parameters_size, struct necp_aggregate_result *returned_result);
1303
1304extern int necp_open(int flags);
1305
1306extern int necp_client_action(int necp_fd, uint32_t action, uuid_t client_id,
1307 size_t client_id_len, uint8_t *buffer, size_t buffer_size);
1308
1309extern int necp_session_open(int flags);
1310
1311extern int necp_session_action(int necp_fd, uint32_t action,
1312 uint8_t *in_buffer, size_t in_buffer_length,
1313 uint8_t *out_buffer, size_t out_buffer_length);
1314
1315#endif /* !KERNEL */
1316
1317#endif /* PRIVATE */
1318
1319#endif
mirror of XNU