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