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