bsd/net/network_agent.h

   1 /*
   2  * Copyright (c) 2014-2016 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_assign_nexus_message {
  67         uuid_t                  assign_client_id;
  68         u_int8_t                assign_necp_results[0];
  69 };
  70
  71 #define NETAGENT_MESSAGE_TYPE_REGISTER                  1       // Pass netagent to set, no return value
  72 #define NETAGENT_MESSAGE_TYPE_UNREGISTER                2       // No value, no return value
  73 #define NETAGENT_MESSAGE_TYPE_UPDATE                    3       // Pass netagent to update, no return value
  74 #define NETAGENT_MESSAGE_TYPE_GET                               4       // No value, return netagent
  75 #define NETAGENT_MESSAGE_TYPE_TRIGGER                   5       // Kernel initiated, no reply expected
  76 #define NETAGENT_MESSAGE_TYPE_ASSERT                    6       // Deprecated
  77 #define NETAGENT_MESSAGE_TYPE_UNASSERT                  7       // Deprecated
  78 #define NETAGENT_MESSAGE_TYPE_TRIGGER_ASSERT    8       // Kernel initiated, no reply expected
  79 #define NETAGENT_MESSAGE_TYPE_TRIGGER_UNASSERT  9       // Kernel initiated, no reply expected
  80 #define NETAGENT_MESSAGE_TYPE_REQUEST_NEXUS             10      // Kernel initiated, struct netagent_client_message
  81 #define NETAGENT_MESSAGE_TYPE_ASSIGN_NEXUS              11      // Pass struct netagent_assign_nexus_message
  82 #define NETAGENT_MESSAGE_TYPE_CLOSE_NEXUS               12      // Kernel initiated, struct netagent_client_message
  83 #define NETAGENT_MESSAGE_TYPE_CLIENT_TRIGGER    13      // Kernel initiated, struct netagent_client_message
  84 #define NETAGENT_MESSAGE_TYPE_CLIENT_ASSERT             14      // Kernel initiated, struct netagent_client_message
  85 #define NETAGENT_MESSAGE_TYPE_CLIENT_UNASSERT   15      // Kernel initiated, struct netagent_client_message
  86
  87 #define NETAGENT_OPTION_TYPE_REGISTER                   NETAGENT_MESSAGE_TYPE_REGISTER          // Pass netagent to set, no return value
  88 #define NETAGENT_OPTION_TYPE_UNREGISTER                 NETAGENT_MESSAGE_TYPE_UNREGISTER        // No value, no return value
  89 #define NETAGENT_OPTION_TYPE_UPDATE                             NETAGENT_MESSAGE_TYPE_UPDATE            // Pass netagent to update, no return value
  90 #define NETAGENT_OPTION_TYPE_ASSIGN_NEXUS               NETAGENT_MESSAGE_TYPE_ASSIGN_NEXUS      // Pass struct netagent_assign_nexus_message
  91 #define NETAGENT_OPTION_TYPE_USE_COUNT                  16                                                                      // Pass use count to set, get current use count
  92
  93 #define NETAGENT_MESSAGE_FLAGS_RESPONSE                 0x01    // Used for acks, errors, and query responses
  94
  95 #define NETAGENT_MESSAGE_ERROR_NONE                     0
  96 #define NETAGENT_MESSAGE_ERROR_INTERNAL                 1
  97 #define NETAGENT_MESSAGE_ERROR_UNKNOWN_TYPE             2
  98 #define NETAGENT_MESSAGE_ERROR_INVALID_DATA             3
  99 #define NETAGENT_MESSAGE_ERROR_NOT_REGISTERED           4
 100 #define NETAGENT_MESSAGE_ERROR_ALREADY_REGISTERED       5
 101 #define NETAGENT_MESSAGE_ERROR_CANNOT_UPDATE            6
 102 #define NETAGENT_MESSAGE_ERROR_CANNOT_ASSIGN            7
 103
 104 #define NETAGENT_DOMAINSIZE             32
 105 #define NETAGENT_TYPESIZE               32
 106 #define NETAGENT_DESCSIZE               128
 107
 108 #define NETAGENT_MAX_DATA_SIZE  4096
 109
 110 #define NETAGENT_FLAG_REGISTERED                0x0001  // Agent is registered
 111 #define NETAGENT_FLAG_ACTIVE                    0x0002  // Agent is active
 112 #define NETAGENT_FLAG_KERNEL_ACTIVATED          0x0004  // Agent can be activated by kernel activity
 113 #define NETAGENT_FLAG_USER_ACTIVATED            0x0008  // Agent can be activated by system call (netagent_trigger)
 114 #define NETAGENT_FLAG_VOLUNTARY                 0x0010  // Use of agent is optional
 115 #define NETAGENT_FLAG_SPECIFIC_USE_ONLY         0x0020  // Agent should only be used and activated when specifically required
 116 #define NETAGENT_FLAG_NETWORK_PROVIDER          0x0040 // Agent provides network access
 117 #define NETAGENT_FLAG_NEXUS_PROVIDER            0x0080 // Agent provides a skywalk nexus
 118
 119 #define NETAGENT_NEXUS_MAX_REQUEST_TYPES                        16
 120 #define NETAGENT_NEXUS_MAX_RESOLUTION_TYPE_PAIRS        16
 121
 122 #define NETAGENT_NEXUS_FRAME_TYPE_UNKNOWN               0
 123 #define NETAGENT_NEXUS_FRAME_TYPE_LINK                  1
 124 #define NETAGENT_NEXUS_FRAME_TYPE_INTERNET              2
 125 #define NETAGENT_NEXUS_FRAME_TYPE_TRANSPORT             3
 126 #define NETAGENT_NEXUS_FRAME_TYPE_APPLICATION   4
 127
 128 struct netagent_nexus {
 129         u_int32_t       frame_type;
 130         u_int32_t       endpoint_assignment_type;
 131         u_int32_t       endpoint_request_types[NETAGENT_NEXUS_MAX_REQUEST_TYPES];
 132         u_int32_t       endpoint_resolution_type_pairs[NETAGENT_NEXUS_MAX_RESOLUTION_TYPE_PAIRS * 2];
 133 };
 134
 135 #define NETAGENT_TRIGGER_FLAG_USER              0x0001  // Userspace triggered agent
 136 #define NETAGENT_TRIGGER_FLAG_KERNEL            0x0002  // Kernel triggered agent
 137
 138 struct kev_netagent_data {
 139         uuid_t          netagent_uuid;
 140 };
 141
 142 // To be used with kernel control socket
 143 struct netagent {
 144         uuid_t          netagent_uuid;
 145         char            netagent_domain[NETAGENT_DOMAINSIZE];
 146         char            netagent_type[NETAGENT_TYPESIZE];
 147         char            netagent_desc[NETAGENT_DESCSIZE];
 148         u_int32_t       netagent_flags;
 149         u_int32_t       netagent_data_size;
 150         u_int8_t        netagent_data[0];
 151 };
 152
 153 // To be used with SIOCGAGENTDATA
 154 struct netagent_req {
 155         uuid_t          netagent_uuid;
 156         char            netagent_domain[NETAGENT_DOMAINSIZE];
 157         char            netagent_type[NETAGENT_TYPESIZE];
 158         char            netagent_desc[NETAGENT_DESCSIZE];
 159         u_int32_t       netagent_flags;
 160         u_int32_t       netagent_data_size;
 161         u_int8_t        *netagent_data;
 162 };
 163
 164 // To be used with SIOCGAGENTLIST
 165 struct netagentlist_req {
 166         u_int32_t       data_size;
 167         u_int8_t        *data;
 168 };
 169 #ifdef BSD_KERNEL_PRIVATE
 170 int netagent_ioctl(u_long cmd, caddr_t data);
 171
 172 struct netagent_req32 {
 173         uuid_t          netagent_uuid;
 174         char            netagent_domain[NETAGENT_DOMAINSIZE];
 175         char            netagent_type[NETAGENT_TYPESIZE];
 176         char            netagent_desc[NETAGENT_DESCSIZE];
 177         u_int32_t       netagent_flags;
 178         u_int32_t       netagent_data_size;
 179         user32_addr_t   netagent_data;
 180 };
 181 struct netagent_req64 {
 182         uuid_t          netagent_uuid;
 183         char            netagent_domain[NETAGENT_DOMAINSIZE];
 184         char            netagent_type[NETAGENT_TYPESIZE];
 185         char            netagent_desc[NETAGENT_DESCSIZE];
 186         u_int32_t       netagent_flags;
 187         u_int32_t       netagent_data_size;
 188         user64_addr_t   netagent_data __attribute__((aligned(8)));
 189 };
 190 struct netagentlist_req32 {
 191         u_int32_t       data_size;
 192         user32_addr_t   data;
 193 };
 194 struct netagentlist_req64 {
 195         u_int32_t       data_size;
 196         user64_addr_t   data __attribute__((aligned(8)));
 197 };
 198
 199 // Kernel accessors
 200 extern void netagent_post_updated_interfaces(uuid_t uuid); // To be called from interface ioctls
 201
 202 extern u_int32_t netagent_get_flags(uuid_t uuid);
 203
 204 extern u_int32_t netagent_get_generation(uuid_t uuid);
 205
 206 extern bool netagent_get_agent_domain_and_type(uuid_t uuid, char *domain, char *type);
 207
 208 extern int netagent_kernel_trigger(uuid_t uuid);
 209
 210 extern int netagent_client_message(uuid_t agent_uuid, uuid_t necp_client_uuid, u_int8_t message_type);
 211
 212 extern int netagent_copyout(uuid_t uuid, user_addr_t user_addr, u_int32_t user_size);
 213
 214 extern int netagent_use(uuid_t agent_uuid, uint64_t *out_use_count);
 215 #endif /* BSD_KERNEL_PRIVATE */
 216
 217 #ifndef KERNEL
 218 extern int netagent_trigger(uuid_t agent_uuid, size_t agent_uuidlen);
 219 #endif /* !KERNEL */
 220
 221 #endif /* PRIVATE */
 222
 223 #endif /* _NETAGENT_H_ */