1 /* 2 * Copyright (c) 2014-2017 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 _NETAGENT_H_ 30 #define _NETAGENT_H_ 31 #include <net/net_kev.h> 32 33 #ifdef PRIVATE 34 35 #include <netinet/in.h> 36 #include <sys/socket.h> 37 38 #ifdef BSD_KERNEL_PRIVATE 39 #include <stdbool.h> 40 41 errno_t netagent_init(void); 42 #endif 43 /* 44 * Name registered by the Network Agent kernel control 45 */ 46 #define NETAGENT_CONTROL_NAME "com.apple.net.netagent" 47 48 struct netagent_message_header { 49 u_int8_t message_type; 50 u_int8_t message_flags; 51 u_int32_t message_id; 52 u_int32_t message_error; 53 u_int32_t message_payload_length; 54 }; 55 56 struct netagent_trigger_message { 57 u_int32_t trigger_flags; 58 pid_t trigger_pid; 59 uuid_t trigger_proc_uuid; 60 }; 61 62 struct netagent_client_message { 63 uuid_t client_id; 64 }; 65 66 struct netagent_client_error_message { 67 uuid_t client_id; 68 int32_t error_code; 69 }; 70 71 struct netagent_client_group_message { 72 uuid_t client_id; 73 u_int8_t group_members[0]; 74 }; 75 76 struct netagent_assign_nexus_message { 77 uuid_t assign_client_id; 78 u_int8_t assign_necp_results[0]; 79 }; 80 81 #define NETAGENT_MESSAGE_TYPE_REGISTER 1 // Pass netagent to set, no return value 82 #define NETAGENT_MESSAGE_TYPE_UNREGISTER 2 // No value, no return value 83 #define NETAGENT_MESSAGE_TYPE_UPDATE 3 // Pass netagent to update, no return value 84 #define NETAGENT_MESSAGE_TYPE_GET 4 // No value, return netagent 85 #define NETAGENT_MESSAGE_TYPE_TRIGGER 5 // Kernel initiated, no reply expected 86 #define NETAGENT_MESSAGE_TYPE_ASSERT 6 // Deprecated 87 #define NETAGENT_MESSAGE_TYPE_UNASSERT 7 // Deprecated 88 #define NETAGENT_MESSAGE_TYPE_TRIGGER_ASSERT 8 // Kernel initiated, no reply expected 89 #define NETAGENT_MESSAGE_TYPE_TRIGGER_UNASSERT 9 // Kernel initiated, no reply expected 90 #define NETAGENT_MESSAGE_TYPE_REQUEST_NEXUS 10 // Kernel initiated, struct netagent_client_message 91 #define NETAGENT_MESSAGE_TYPE_ASSIGN_NEXUS 11 // Pass struct netagent_assign_nexus_message 92 #define NETAGENT_MESSAGE_TYPE_CLOSE_NEXUS 12 // Kernel initiated, struct netagent_client_message 93 #define NETAGENT_MESSAGE_TYPE_CLIENT_TRIGGER 13 // Kernel initiated, struct netagent_client_message 94 #define NETAGENT_MESSAGE_TYPE_CLIENT_ASSERT 14 // Kernel initiated, struct netagent_client_message 95 #define NETAGENT_MESSAGE_TYPE_CLIENT_UNASSERT 15 // Kernel initiated, struct netagent_client_message 96 97 #define NETAGENT_OPTION_TYPE_REGISTER NETAGENT_MESSAGE_TYPE_REGISTER // Pass netagent to set, no return value 98 #define NETAGENT_OPTION_TYPE_UNREGISTER NETAGENT_MESSAGE_TYPE_UNREGISTER // No value, no return value 99 #define NETAGENT_OPTION_TYPE_UPDATE NETAGENT_MESSAGE_TYPE_UPDATE // Pass netagent to update, no return value 100 #define NETAGENT_OPTION_TYPE_ASSIGN_NEXUS NETAGENT_MESSAGE_TYPE_ASSIGN_NEXUS // Pass struct netagent_assign_nexus_message 101 #define NETAGENT_OPTION_TYPE_USE_COUNT 16 // Pass use count to set, get current use count 102 #define NETAGENT_MESSAGE_TYPE_ABORT_NEXUS 17 // Kernel private 103 #define NETAGENT_MESSAGE_TYPE_ADD_GROUP_MEMBERS 18 // Kernel initiated, struct netagent_client_group_message 104 #define NETAGENT_MESSAGE_TYPE_REMOVE_GROUP_MEMBERS 19 // Kernel initiated, struct netagent_client_group_message 105 #define NETAGENT_MESSAGE_TYPE_ASSIGN_GROUP_MEMBERS 20 // Pass struct netagent_assign_nexus_message 106 #define NETAGENT_OPTION_TYPE_ADD_TOKEN 21 // Set new token bytes 107 #define NETAGENT_OPTION_TYPE_FLUSH_TOKENS 22 // Flush all tokens 108 #define NETAGENT_OPTION_TYPE_TOKEN_COUNT 23 // Get remaining token count (uint32_t) 109 #define NETAGENT_OPTION_TYPE_TOKEN_LOW_WATER 24 // Set/get token low water mark (uint32_t) 110 #define NETAGENT_MESSAGE_TYPE_TOKENS_NEEDED 25 // Kernel intiated, no content 111 #define NETAGENT_MESSAGE_TYPE_CLIENT_ERROR 26 // Kernel intiated, struct netagent_client_error_message 112 #define NETAGENT_OPTION_TYPE_RESET_CLIENT_ERROR 27 // Call to reset client error and counts 113 114 115 #define NETAGENT_MESSAGE_FLAGS_RESPONSE 0x01 // Used for acks, errors, and query responses 116 117 #define NETAGENT_MESSAGE_ERROR_NONE 0 118 #define NETAGENT_MESSAGE_ERROR_INTERNAL 1 119 #define NETAGENT_MESSAGE_ERROR_UNKNOWN_TYPE 2 120 #define NETAGENT_MESSAGE_ERROR_INVALID_DATA 3 121 #define NETAGENT_MESSAGE_ERROR_NOT_REGISTERED 4 122 #define NETAGENT_MESSAGE_ERROR_ALREADY_REGISTERED 5 123 #define NETAGENT_MESSAGE_ERROR_CANNOT_UPDATE 6 124 #define NETAGENT_MESSAGE_ERROR_CANNOT_ASSIGN 7 125 126 #define NETAGENT_DOMAINSIZE 32 127 #define NETAGENT_TYPESIZE 32 128 #define NETAGENT_DESCSIZE 128 129 130 #define NETAGENT_MAX_DATA_SIZE 4096 131 132 #define NETAGENT_MAX_TOKEN_COUNT 256 133 134 135 #define NETAGENT_FLAG_REGISTERED 0x0001 // Agent is registered 136 #define NETAGENT_FLAG_ACTIVE 0x0002 // Agent is active 137 #define NETAGENT_FLAG_KERNEL_ACTIVATED 0x0004 // Agent can be activated by kernel activity 138 #define NETAGENT_FLAG_USER_ACTIVATED 0x0008 // Agent can be activated by system call (netagent_trigger) 139 #define NETAGENT_FLAG_VOLUNTARY 0x0010 // Use of agent is optional 140 #define NETAGENT_FLAG_SPECIFIC_USE_ONLY 0x0020 // Agent should only be used and activated when specifically required 141 #define NETAGENT_FLAG_NETWORK_PROVIDER 0x0040 // Agent provides network access 142 #define NETAGENT_FLAG_NEXUS_PROVIDER 0x0080 // Agent provides a skywalk nexus 143 #define NETAGENT_FLAG_SUPPORTS_BROWSE 0x0100 // Assertions will cause agent to fill in browse endpoints 144 #define NETAGENT_FLAG_REQUIRES_ASSERT 0x0200 // Assertions are expected to be taken against this agent 145 #define NETAGENT_FLAG_NEXUS_LISTENER 0x0400 // Nexus supports listeners 146 #define NETAGENT_FLAG_UPDATE_IMMEDIATELY 0x0800 // Updates the clients without waiting for a leeway 147 #define NETAGENT_FLAG_CUSTOM_ETHER_NEXUS 0x2000 // Agent provides a custom ethertype nexus 148 #define NETAGENT_FLAG_CUSTOM_IP_NEXUS 0x4000 // Agent provides a custom IP nexus 149 #define NETAGENT_FLAG_INTERPOSE_NEXUS 0x8000 // Agent provides an interpose nexus 150 #define NETAGENT_FLAG_SUPPORTS_RESOLVE 0x10000 // Assertions will cause agent to fill in resolved endpoints 151 #define NETAGENT_FLAG_SUPPORTS_GROUPS 0x20000 // Group actions can be performed 152 153 #define NETAGENT_NEXUS_MAX_REQUEST_TYPES 16 154 #define NETAGENT_NEXUS_MAX_RESOLUTION_TYPE_PAIRS 15 155 156 #define NETAGENT_NEXUS_FRAME_TYPE_UNKNOWN 0 157 #define NETAGENT_NEXUS_FRAME_TYPE_LINK 1 158 #define NETAGENT_NEXUS_FRAME_TYPE_INTERNET 2 159 #define NETAGENT_NEXUS_FRAME_TYPE_TRANSPORT 3 160 #define NETAGENT_NEXUS_FRAME_TYPE_APPLICATION 4 161 162 #define NETAGENT_NEXUS_ENDPOINT_TYPE_ADDRESS 1 163 #define NETAGENT_NEXUS_ENDPOINT_TYPE_HOST 2 164 #define NETAGENT_NEXUS_ENDPOINT_TYPE_BONJOUR 3 165 #define NETAGENT_NEXUS_ENDPOINT_TYPE_SRV 5 166 167 #define NETAGENT_NEXUS_FLAG_SUPPORTS_USER_PACKET_POOL 0x1 168 #define NETAGENT_NEXUS_FLAG_ASSERT_UNSUPPORTED 0x2 // No calls to assert the agent are required 169 #define NETAGENT_NEXUS_FLAG_SHOULD_USE_EVENT_RING 0x4 // indicates that nexus agent should use event rings 170 171 struct netagent_nexus { 172 u_int32_t frame_type; 173 u_int32_t endpoint_assignment_type; 174 u_int32_t endpoint_request_types[NETAGENT_NEXUS_MAX_REQUEST_TYPES]; 175 u_int32_t endpoint_resolution_type_pairs[NETAGENT_NEXUS_MAX_RESOLUTION_TYPE_PAIRS * 2]; 176 u_int32_t nexus_max_buf_size; 177 u_int32_t reserved; 178 u_int32_t nexus_flags; 179 }; 180 181 #define NETAGENT_NEXUS_HAS_MAX_BUF_SIZE 1 // struct netagent_nexus includes nexus_max_buf_size 182 183 #define NETAGENT_TRIGGER_FLAG_USER 0x0001 // Userspace triggered agent 184 #define NETAGENT_TRIGGER_FLAG_KERNEL 0x0002 // Kernel triggered agent 185 186 struct kev_netagent_data { 187 uuid_t netagent_uuid; 188 }; 189 190 // To be used with kernel control socket 191 struct netagent { 192 uuid_t netagent_uuid; 193 char netagent_domain[NETAGENT_DOMAINSIZE]; 194 char netagent_type[NETAGENT_TYPESIZE]; 195 char netagent_desc[NETAGENT_DESCSIZE]; 196 u_int32_t netagent_flags; 197 u_int32_t netagent_data_size; 198 u_int8_t netagent_data[0]; 199 }; 200 201 // To be used with SIOCGAGENTDATA 202 struct netagent_req { 203 uuid_t netagent_uuid; 204 char netagent_domain[NETAGENT_DOMAINSIZE]; 205 char netagent_type[NETAGENT_TYPESIZE]; 206 char netagent_desc[NETAGENT_DESCSIZE]; 207 u_int32_t netagent_flags; 208 u_int32_t netagent_data_size; 209 u_int8_t *netagent_data; 210 }; 211 212 // To be used with SIOCGAGENTLIST 213 struct netagentlist_req { 214 u_int32_t data_size; 215 u_int8_t *data; 216 }; 217 #ifdef BSD_KERNEL_PRIVATE 218 int netagent_ioctl(u_long cmd, caddr_t data); 219 220 struct netagent_req32 { 221 uuid_t netagent_uuid; 222 char netagent_domain[NETAGENT_DOMAINSIZE]; 223 char netagent_type[NETAGENT_TYPESIZE]; 224 char netagent_desc[NETAGENT_DESCSIZE]; 225 u_int32_t netagent_flags; 226 u_int32_t netagent_data_size; 227 user32_addr_t netagent_data; 228 }; 229 struct netagent_req64 { 230 uuid_t netagent_uuid; 231 char netagent_domain[NETAGENT_DOMAINSIZE]; 232 char netagent_type[NETAGENT_TYPESIZE]; 233 char netagent_desc[NETAGENT_DESCSIZE]; 234 u_int32_t netagent_flags; 235 u_int32_t netagent_data_size; 236 user64_addr_t netagent_data __attribute__((aligned(8))); 237 }; 238 struct netagentlist_req32 { 239 u_int32_t data_size; 240 user32_addr_t data; 241 }; 242 struct netagentlist_req64 { 243 u_int32_t data_size; 244 user64_addr_t data __attribute__((aligned(8))); 245 }; 246 247 struct necp_client_agent_parameters; 248 249 // Kernel accessors 250 extern void netagent_post_updated_interfaces(uuid_t uuid); // To be called from interface ioctls 251 252 extern u_int32_t netagent_get_flags(uuid_t uuid); 253 254 extern errno_t netagent_set_flags(uuid_t uuid, u_int32_t flags); 255 256 extern u_int32_t netagent_get_generation(uuid_t uuid); 257 258 extern bool netagent_get_agent_domain_and_type(uuid_t uuid, char *domain, char *type); 259 260 extern int netagent_kernel_trigger(uuid_t uuid); 261 262 extern int netagent_client_message(uuid_t agent_uuid, uuid_t necp_client_uuid, pid_t pid, void *handle, u_int8_t message_type); 263 264 extern int netagent_client_message_with_params(uuid_t agent_uuid, 265 uuid_t necp_client_uuid, 266 pid_t pid, 267 void *handle, 268 u_int8_t message_type, 269 struct necp_client_agent_parameters *parameters, 270 void **assigned_results, 271 size_t *assigned_results_length); 272 273 extern int netagent_copyout(uuid_t uuid, user_addr_t user_addr, u_int32_t user_size); 274 275 extern int netagent_acquire_token(uuid_t uuid, user_addr_t user_addr, u_int32_t user_size, int *retval); 276 277 278 // Kernel agent management 279 280 typedef void * netagent_session_t; 281 282 struct netagent_nexus_agent { 283 struct netagent agent; 284 struct netagent_nexus nexus_data; 285 }; 286 287 #define NETAGENT_EVENT_TRIGGER NETAGENT_MESSAGE_TYPE_CLIENT_TRIGGER 288 #define NETAGENT_EVENT_ASSERT NETAGENT_MESSAGE_TYPE_CLIENT_ASSERT 289 #define NETAGENT_EVENT_UNASSERT NETAGENT_MESSAGE_TYPE_CLIENT_UNASSERT 290 #define NETAGENT_EVENT_NEXUS_FLOW_INSERT NETAGENT_MESSAGE_TYPE_REQUEST_NEXUS 291 #define NETAGENT_EVENT_NEXUS_FLOW_REMOVE NETAGENT_MESSAGE_TYPE_CLOSE_NEXUS 292 #define NETAGENT_EVENT_NEXUS_FLOW_ABORT NETAGENT_MESSAGE_TYPE_ABORT_NEXUS 293 294 typedef errno_t (*netagent_event_f)(u_int8_t event, uuid_t necp_client_uuid, pid_t pid, void *necp_handle, void *context, struct necp_client_agent_parameters *parameters, void **assigned_results, size_t *assigned_results_length); 295 296 extern netagent_session_t netagent_create(netagent_event_f event_handler, void *handle); 297 298 extern void netagent_destroy(netagent_session_t session); 299 300 extern errno_t netagent_register(netagent_session_t session, struct netagent *agent); 301 302 extern errno_t netagent_update(netagent_session_t session, struct netagent *agent); 303 304 extern errno_t netagent_unregister(netagent_session_t session); 305 306 extern errno_t netagent_assign_nexus(netagent_session_t _session, 307 uuid_t necp_client_uuid, 308 void *assign_message, 309 size_t assigned_results_length); // Length of assigned_results_length 310 311 extern errno_t netagent_update_flow_protoctl_event(netagent_session_t _session, 312 uuid_t client_id, 313 uint32_t protoctl_event_code, 314 uint32_t protoctl_event_val, 315 uint32_t protoctl_event_tcp_seq_number); 316 317 extern int netagent_use(uuid_t agent_uuid, uint64_t *out_use_count); 318 319 #endif /* BSD_KERNEL_PRIVATE */ 320 321 #ifndef KERNEL 322 extern int netagent_trigger(uuid_t agent_uuid, size_t agent_uuidlen); 323 #endif /* !KERNEL */ 324 325 #endif /* PRIVATE */ 326 327 #endif /* _NETAGENT_H_ */ 328