mDNSMacOSX/mDNSMacOSX.h

   1 /* -*- Mode: C; tab-width: 4; c-file-style: "bsd"; c-basic-offset: 4; fill-column: 108; indent-tabs-mode: nil; -*-
   2  *
   3  * Copyright (c) 2002-2018 Apple Inc. All rights reserved.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #ifndef __mDNSMacOSX_h
  19 #define __mDNSMacOSX_h
  20
  21 #ifdef  __cplusplus
  22 extern "C" {
  23 #endif
  24
  25 #include <SystemConfiguration/SystemConfiguration.h>
  26 #include <IOKit/pwr_mgt/IOPM.h>
  27 #include <IOKit/pwr_mgt/IOPMLib.h>
  28 #include <IOKit/pwr_mgt/IOPMLibPrivate.h>
  29 #include <sys/socket.h>
  30 #include <netinet/in.h>
  31 #include "mDNSEmbeddedAPI.h"        // for domain name structure
  32 #include "mdns_private.h"           // for mdns_interface_monitor_t struct
  33
  34 #include <net/if.h>
  35 #include <os/log.h>
  36
  37 //#define MDNSRESPONDER_USES_LIB_DISPATCH_AS_PRIMARY_EVENT_LOOP_MECHANISM
  38 #ifdef MDNSRESPONDER_USES_LIB_DISPATCH_AS_PRIMARY_EVENT_LOOP_MECHANISM
  39 #include <dispatch/dispatch.h>
  40 #include <dispatch/private.h>
  41 #endif
  42
  43 #if TARGET_OS_IPHONE
  44 #define NO_SECURITYFRAMEWORK 1
  45 #define NO_CFUSERNOTIFICATION 1
  46 #endif
  47
  48 #ifndef NO_SECURITYFRAMEWORK
  49 #include <Security/SecureTransport.h>
  50 #include <Security/Security.h>
  51 #endif /* NO_SECURITYFRAMEWORK */
  52
  53 enum mDNSDynamicStoreSetConfigKey
  54 {
  55     kmDNSMulticastConfig = 1,
  56     kmDNSDynamicConfig,
  57     kmDNSPrivateConfig,
  58     kmDNSBackToMyMacConfig,
  59     kmDNSSleepProxyServersState,
  60     kmDNSDebugState,
  61 };
  62
  63 typedef struct NetworkInterfaceInfoOSX_struct NetworkInterfaceInfoOSX;
  64
  65 typedef void (*KQueueEventCallback)(int fd, short filter, void *context, mDNSBool encounteredEOF);
  66 typedef struct
  67 {
  68     KQueueEventCallback KQcallback;
  69     void                *KQcontext;
  70     const char          *KQtask;        // For debugging messages
  71 #ifdef MDNSRESPONDER_USES_LIB_DISPATCH_AS_PRIMARY_EVENT_LOOP_MECHANISM
  72     dispatch_source_t readSource;
  73     dispatch_source_t writeSource;
  74     mDNSBool fdClosed;
  75 #endif
  76 } KQueueEntry;
  77
  78 typedef struct
  79 {
  80     mDNSIPPort port; // MUST BE FIRST FIELD -- UDPSocket_struct begins with a KQSocketSet,
  81     // and mDNSCore requires every UDPSocket_struct to begin with a mDNSIPPort port
  82     mDNS                    *m;
  83     int sktv4;
  84     KQueueEntry kqsv4;
  85     int sktv6;
  86     KQueueEntry kqsv6;
  87     int                     *closeFlag;
  88     mDNSBool proxy;
  89     mDNSBool sktv4EOF;
  90     mDNSBool sktv6EOF;
  91 } KQSocketSet;
  92
  93 struct UDPSocket_struct
  94 {
  95     KQSocketSet ss;     // First field of KQSocketSet has to be mDNSIPPort -- mDNSCore requires every UDPSocket_struct to begin with mDNSIPPort port
  96 };
  97
  98 // TCP socket support
  99
 100 typedef enum
 101 {
 102     handshake_required,
 103     handshake_in_progress,
 104     handshake_completed,
 105     handshake_to_be_closed
 106 } handshakeStatus;
 107
 108 struct TCPSocket_struct
 109 {
 110     mDNSIPPort port;                // MUST BE FIRST FIELD -- mDNSCore expects every TCPSocket_struct to begin with mDNSIPPort
 111     TCPSocketFlags flags;           // MUST BE SECOND FIELD -- mDNSCore expects every TCPSocket_struct have TCPSocketFlags flags after mDNSIPPort
 112     TCPConnectionCallback callback;
 113     int fd;
 114     KQueueEntry kqEntry;
 115 #ifndef NO_SECURITYFRAMEWORK
 116     SSLContextRef tlsContext;
 117     pthread_t handshake_thread;
 118 #endif /* NO_SECURITYFRAMEWORK */
 119     domainname *hostname;
 120     void *context;
 121     mDNSBool setup;
 122     mDNSBool connected;
 123     handshakeStatus handshake;
 124     mDNS *m; // So we can call KQueueLock from the SSLHandshake thread
 125     mStatus err;
 126 };
 127
 128 struct TCPListener_struct
 129 {
 130     TCPAcceptedCallback callback;
 131     int fd;
 132     KQueueEntry kqEntry;
 133     void *context;
 134     mDNSAddr_Type addressType;
 135     TCPSocketFlags socketFlags;
 136     mDNS *m; // So we can call KQueueLock from the SSLHandshake thread
 137 };
 138
 139 // Value assiged to 'Exists' to indicate the multicast state of the interface has changed.
 140 #define MulticastStateChanged   2
 141
 142 struct NetworkInterfaceInfoOSX_struct
 143 {
 144     NetworkInterfaceInfo ifinfo;                // MUST be the first element in this structure
 145     NetworkInterfaceInfoOSX *next;
 146     mDNS                    *m;
 147     mDNSu8 Exists;                              // 1 = currently exists in getifaddrs list; 0 = doesn't
 148                                                 // 2 = exists, but McastTxRx state changed
 149     mDNSu8 Flashing;                            // Set if interface appeared for less than 60 seconds and then vanished
 150     mDNSu8 Occulting;                           // Set if interface vanished for less than 60 seconds and then came back
 151     mDNSu8 D2DInterface;                        // IFEF_LOCALNET_PRIVATE flag indicates we should call
 152                                                 // D2D plugin for operations over this interface
 153     mDNSs32 AppearanceTime;                     // Time this interface appeared most recently in getifaddrs list
 154                                                 // i.e. the first time an interface is seen, AppearanceTime is set.
 155                                                 // If an interface goes away temporarily and then comes back then
 156                                                 // AppearanceTime is updated to the time of the most recent appearance.
 157     mDNSs32 LastSeen;                           // If Exists==0, last time this interface appeared in getifaddrs list
 158     unsigned int ifa_flags;
 159     struct in_addr ifa_v4addr;
 160     mDNSu32 scope_id;                           // interface index / IPv6 scope ID
 161     mDNSEthAddr BSSID;                          // BSSID of 802.11 base station, if applicable
 162     u_short sa_family;
 163     int BPF_fd;                                 // -1 uninitialized; -2 requested BPF; -3 failed
 164     int BPF_mcfd;                               // Socket for our IPv6 ND group membership
 165     u_int BPF_len;
 166     mDNSBool isAWDL;                            // True if this interface has the IFEF_AWDL flag set.
 167 #ifdef MDNSRESPONDER_USES_LIB_DISPATCH_AS_PRIMARY_EVENT_LOOP_MECHANISM
 168     dispatch_source_t BPF_source;
 169 #else
 170     CFSocketRef BPF_cfs;
 171     CFRunLoopSourceRef BPF_rls;
 172 #endif
 173     NetworkInterfaceInfoOSX *Registered;        // non-NULL means registered with mDNS Core
 174 };
 175
 176 struct mDNS_PlatformSupport_struct
 177 {
 178     NetworkInterfaceInfoOSX *InterfaceList;
 179     CFMutableArrayRef InterfaceMonitors;
 180     KQSocketSet permanentsockets;
 181     int num_mcasts;                             // Number of multicasts received during this CPU scheduling period (used for CPU limiting)
 182     domainlabel userhostlabel;                  // The hostlabel as it was set in System Preferences the last time we looked
 183     domainlabel usernicelabel;                  // The nicelabel as it was set in System Preferences the last time we looked
 184     // Following four variables are used for optimization where the helper is not
 185     // invoked when not needed. It records the state of what we told helper the
 186     // last time we invoked mDNSPreferencesSetName
 187     domainlabel prevoldhostlabel;               // Previous m->p->userhostlabel
 188     domainlabel prevnewhostlabel;               // Previous m->hostlabel
 189     domainlabel prevoldnicelabel;               // Previous m->p->usernicelabel
 190     domainlabel prevnewnicelabel;               // Previous m->nicelabel
 191     mDNSs32 NotifyUser;
 192     mDNSs32 HostNameConflict;                   // Time we experienced conflict on our link-local host name
 193     mDNSs32 KeyChainTimer;
 194
 195     SCDynamicStoreRef Store;
 196     CFRunLoopSourceRef StoreRLS;
 197     CFRunLoopSourceRef PMRLS;
 198     int SysEventNotifier;
 199     KQueueEntry SysEventKQueue;
 200     IONotificationPortRef PowerPortRef;
 201     io_connect_t PowerConnection;
 202     io_object_t PowerNotifier;
 203 #ifdef kIOPMAcknowledgmentOptionSystemCapabilityRequirements
 204     IOPMConnection IOPMConnection;
 205 #endif
 206     IOPMAssertionID IOPMAssertion;
 207     long SleepCookie;                           // Cookie we need to pass to IOAllowPowerChange()
 208     long WakeAtUTC;
 209     mDNSs32 RequestReSleep;
 210 #ifdef MDNSRESPONDER_USES_LIB_DISPATCH_AS_PRIMARY_EVENT_LOOP_MECHANISM
 211     dispatch_source_t timer;
 212     dispatch_source_t custom;
 213 #else
 214     pthread_mutex_t BigMutex;
 215 #endif
 216     mDNSs32 BigMutexStartTime;
 217     int WakeKQueueLoopFD;
 218     mDNSu8 v4answers;                  // non-zero if we are receiving answers
 219     mDNSu8 v6answers;                  // for A/AAAA from external DNS servers
 220     mDNSs32 DNSTrigger;                // Time the DNSTrigger was given
 221     uint64_t LastConfigGeneration;     // DNS configuration generation number
 222     mDNSBool if_interface_changed;     // There are some changes that we do not know from LastConfigGeneration, such as
 223                                        // if the interface is expensive/constrained or not. Therefore, we need an additional
 224                                        // field to determine if the interface has changed.
 225     UDPSocket UDPProxy;
 226     TCPSocket TCPProxyV4;
 227     TCPSocket TCPProxyV6;
 228     ProxyCallback *UDPProxyCallback;
 229     ProxyCallback *TCPProxyCallback;
 230 };
 231
 232 extern int OfferSleepProxyService;
 233 extern int DisableSleepProxyClient;
 234 extern int UseInternalSleepProxy;
 235 extern int OSXVers, iOSVers;
 236
 237 extern int KQueueFD;
 238
 239 extern void NotifyOfElusiveBug(const char *title, const char *msg); // Both strings are UTF-8 text
 240 extern void SetDomainSecrets(mDNS *m);
 241 extern void mDNSMacOSXNetworkChanged(void);
 242 extern void mDNSMacOSXSystemBuildNumber(char *HINFO_SWstring);
 243 extern NetworkInterfaceInfoOSX *IfindexToInterfaceInfoOSX(mDNSInterfaceID ifindex);
 244 extern void mDNSUpdatePacketFilter(const ResourceRecord *const excludeRecord);
 245 extern void myKQSocketCallBack(int s1, short filter, void *context, mDNSBool encounteredEOF);
 246 extern void mDNSDynamicStoreSetConfig(int key, const char *subkey, CFPropertyListRef value);
 247 extern void UpdateDebugState(void);
 248
 249 #ifdef MDNSRESPONDER_USES_LIB_DISPATCH_AS_PRIMARY_EVENT_LOOP_MECHANISM
 250 extern int KQueueSet(int fd, u_short flags, short filter, KQueueEntry *const entryRef);
 251 mDNSexport void TriggerEventCompletion(void);
 252 #else
 253 extern int KQueueSet(int fd, u_short flags, short filter, const KQueueEntry *const entryRef);
 254 #endif
 255
 256 // When events are processed on the non-kqueue thread (i.e. CFRunLoop notifications like Sleep/Wake,
 257 // Interface changes, Keychain changes, etc.) they must use KQueueLock/KQueueUnlock to lock out the kqueue thread
 258 extern void KQueueLock(void);
 259 extern void KQueueUnlock(const char* task);
 260 extern void mDNSPlatformCloseFD(KQueueEntry *kq, int fd);
 261 extern ssize_t myrecvfrom(const int s, void *const buffer, const size_t max,
 262                              struct sockaddr *const from, size_t *const fromlen, mDNSAddr *dstaddr, char *ifname, mDNSu8 *ttl);
 263
 264 extern mDNSBool DictionaryIsEnabled(CFDictionaryRef dict);
 265
 266 // If any event takes more than WatchDogReportingThreshold milliseconds to be processed, we log a warning message
 267 // General event categories are:
 268 //  o Mach client request initiated / terminated
 269 //  o UDS client request
 270 //  o Handling UDP packets received from the network
 271 //  o Environmental change events:
 272 //    - network interface changes
 273 //    - sleep/wake
 274 //    - keychain changes
 275 //  o Name conflict dialog dismissal
 276 //  o Reception of Unix signal (e.g. SIGINFO)
 277 //  o Idle task processing
 278 // If we find that we're getting warnings for any of these categories, and it's not evident
 279 // what's causing the problem, we may need to subdivide some categories into finer-grained
 280 // sub-categories (e.g. "Idle task processing" covers a pretty broad range of sub-tasks).
 281
 282 extern int WatchDogReportingThreshold;
 283
 284 struct CompileTimeAssertionChecks_mDNSMacOSX
 285 {
 286     // Check our structures are reasonable sizes. Including overly-large buffers, or embedding
 287     // other overly-large structures instead of having a pointer to them, can inadvertently
 288     // cause structure sizes (and therefore memory usage) to balloon unreasonably.
 289     char sizecheck_NetworkInterfaceInfoOSX[(sizeof(NetworkInterfaceInfoOSX) <=  8488) ? 1 : -1];
 290     char sizecheck_mDNS_PlatformSupport   [(sizeof(mDNS_PlatformSupport)    <=  1378) ? 1 : -1];
 291 };
 292
 293 extern mDNSInterfaceID AWDLInterfaceID;
 294 void initializeD2DPlugins(mDNS *const m);
 295 void terminateD2DPlugins(void);
 296
 297 #if MDNSRESPONDER_SUPPORTS(APPLE, REACHABILITY_TRIGGER)
 298 extern void mDNSPlatformUpdateDNSStatus(const DNSQuestion *q);
 299 extern void mDNSPlatformTriggerDNSRetry(const DNSQuestion *v4q, const DNSQuestion *v6q);
 300 #endif
 301
 302 extern mdns_interface_monitor_t GetInterfaceMonitorForIndex(uint32_t ifIndex);
 303
 304 #ifdef  __cplusplus
 305 }
 306 #endif
 307
 308 #endif