1 | /* -*- Mode: C; tab-width: 4 -*- |
---|
2 | * |
---|
3 | * Copyright (c) 2002-2013 Apple Computer, 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 | NOTE: |
---|
18 | If you're building an application that uses DNS Service Discovery |
---|
19 | this is probably NOT the header file you're looking for. |
---|
20 | In most cases you will want to use /usr/include/dns_sd.h instead. |
---|
21 | |
---|
22 | This header file defines the lowest level raw interface to mDNSCore, |
---|
23 | which is appropriate *only* on tiny embedded systems where everything |
---|
24 | runs in a single address space and memory is extremely constrained. |
---|
25 | All the APIs here are malloc-free, which means that the caller is |
---|
26 | responsible for passing in a pointer to the relevant storage that |
---|
27 | will be used in the execution of that call, and (when called with |
---|
28 | correct parameters) all the calls are guaranteed to succeed. There |
---|
29 | is never a case where a call can suffer intermittent failures because |
---|
30 | the implementation calls malloc() and sometimes malloc() returns NULL |
---|
31 | because memory is so limited that no more is available. |
---|
32 | This is primarily for devices that need to have precisely known fixed |
---|
33 | memory requirements, with absolutely no uncertainty or run-time variation, |
---|
34 | but that certainty comes at a cost of more difficult programming. |
---|
35 | |
---|
36 | For applications running on general-purpose desktop operating systems |
---|
37 | (Mac OS, Linux, Solaris, Windows, etc.) the API you should use is |
---|
38 | /usr/include/dns_sd.h, which defines the API by which multiple |
---|
39 | independent client processes communicate their DNS Service Discovery |
---|
40 | requests to a single "mdnsd" daemon running in the background. |
---|
41 | |
---|
42 | Even on platforms that don't run multiple independent processes in |
---|
43 | multiple independent address spaces, you can still use the preferred |
---|
44 | dns_sd.h APIs by linking in "dnssd_clientshim.c", which implements |
---|
45 | the standard "dns_sd.h" API calls, allocates any required storage |
---|
46 | using malloc(), and then calls through to the low-level malloc-free |
---|
47 | mDNSCore routines defined here. This has the benefit that even though |
---|
48 | you're running on a small embedded system with a single address space, |
---|
49 | you can still use the exact same client C code as you'd use on a |
---|
50 | general-purpose desktop system. |
---|
51 | |
---|
52 | */ |
---|
53 | |
---|
54 | #ifndef __mDNSEmbeddedAPI_h |
---|
55 | #define __mDNSEmbeddedAPI_h |
---|
56 | |
---|
57 | #if defined(EFI32) || defined(EFI64) || defined(EFIX64) |
---|
58 | // EFI doesn't have stdarg.h unless it's building with GCC. |
---|
59 | #include "Tiano.h" |
---|
60 | #if !defined(__GNUC__) |
---|
61 | #define va_list VA_LIST |
---|
62 | #define va_start(a, b) VA_START(a, b) |
---|
63 | #define va_end(a) VA_END(a) |
---|
64 | #define va_arg(a, b) VA_ARG(a, b) |
---|
65 | #endif |
---|
66 | #else |
---|
67 | #include <stdarg.h> // stdarg.h is required for for va_list support for the mDNS_vsnprintf declaration |
---|
68 | #endif |
---|
69 | |
---|
70 | #include "mDNSDebug.h" |
---|
71 | #if APPLE_OSX_mDNSResponder |
---|
72 | #include <uuid/uuid.h> |
---|
73 | #endif |
---|
74 | |
---|
75 | #ifdef __cplusplus |
---|
76 | extern "C" { |
---|
77 | #endif |
---|
78 | |
---|
79 | // *************************************************************************** |
---|
80 | // Feature removal compile options & limited resource targets |
---|
81 | |
---|
82 | // The following compile options are responsible for removing certain features from mDNSCore to reduce the |
---|
83 | // memory footprint for use in embedded systems with limited resources. |
---|
84 | |
---|
85 | // UNICAST_DISABLED - disables unicast DNS functionality, including Wide Area Bonjour |
---|
86 | // ANONYMOUS_DISABLED - disables anonymous functionality |
---|
87 | // DNSSEC_DISABLED - disables DNSSEC functionality |
---|
88 | // SPC_DISABLED - disables Bonjour Sleep Proxy client |
---|
89 | // IDLESLEEPCONTROL_DISABLED - disables sleep control for Bonjour Sleep Proxy clients |
---|
90 | |
---|
91 | // In order to disable the above features pass the option to your compiler, e.g. -D UNICAST_DISABLED |
---|
92 | |
---|
93 | // Additionally, the LIMITED_RESOURCES_TARGET compile option will eliminate caching and |
---|
94 | // and reduce the maximum DNS message sizes. |
---|
95 | |
---|
96 | #ifdef LIMITED_RESOURCES_TARGET |
---|
97 | // Don't support jumbo frames |
---|
98 | #define AbsoluteMaxDNSMessageData 1500 |
---|
99 | // By the time you add IPv6 header (40 bytes) UDP header (8 bytes) and DNS message header (12 bytes) |
---|
100 | // this makes 1560 which is 60 bytes over the standard Ethernet MTU. D'oh! |
---|
101 | |
---|
102 | // StandardAuthRDSize is 264 (256+8), which is large enough to hold a maximum-sized SRV record (6 + 256 bytes) |
---|
103 | #define MaximumRDSize 264 |
---|
104 | // Don't cache anything |
---|
105 | #define AUTH_HASH_SLOTS 1 |
---|
106 | #define CACHE_HASH_SLOTS 1 |
---|
107 | #endif |
---|
108 | |
---|
109 | // *************************************************************************** |
---|
110 | // Function scope indicators |
---|
111 | |
---|
112 | // If you see "mDNSlocal" before a function name in a C file, it means the function is not callable outside this file |
---|
113 | #ifndef mDNSlocal |
---|
114 | #define mDNSlocal static |
---|
115 | #endif |
---|
116 | // If you see "mDNSexport" before a symbol in a C file, it means the symbol is exported for use by clients |
---|
117 | // For every "mDNSexport" in a C file, there needs to be a corresponding "extern" declaration in some header file |
---|
118 | // (When a C file #includes a header file, the "extern" declarations tell the compiler: |
---|
119 | // "This symbol exists -- but not necessarily in this C file.") |
---|
120 | #ifndef mDNSexport |
---|
121 | #define mDNSexport |
---|
122 | #endif |
---|
123 | |
---|
124 | // Explanation: These local/export markers are a little habit of mine for signaling the programmers' intentions. |
---|
125 | // When "mDNSlocal" is just a synonym for "static", and "mDNSexport" is a complete no-op, you could be |
---|
126 | // forgiven for asking what purpose they serve. The idea is that if you see "mDNSexport" in front of a |
---|
127 | // function definition it means the programmer intended it to be exported and callable from other files |
---|
128 | // in the project. If you see "mDNSlocal" in front of a function definition it means the programmer |
---|
129 | // intended it to be private to that file. If you see neither in front of a function definition it |
---|
130 | // means the programmer forgot (so you should work out which it is supposed to be, and fix it). |
---|
131 | // Using "mDNSlocal" instead of "static" makes it easier to do a textual searches for one or the other. |
---|
132 | // For example you can do a search for "static" to find if any functions declare any local variables as "static" |
---|
133 | // (generally a bad idea unless it's also "const", because static storage usually risks being non-thread-safe) |
---|
134 | // without the results being cluttered with hundreds of matches for functions declared static. |
---|
135 | // - Stuart Cheshire |
---|
136 | |
---|
137 | // *************************************************************************** |
---|
138 | // Structure packing macro |
---|
139 | |
---|
140 | // If we're not using GNUC, it's not fatal. |
---|
141 | // Most compilers naturally pack the on-the-wire structures correctly anyway, so a plain "struct" is usually fine. |
---|
142 | // In the event that structures are not packed correctly, mDNS_Init() will detect this and report an error, so the |
---|
143 | // developer will know what's wrong, and can investigate what needs to be done on that compiler to provide proper packing. |
---|
144 | #ifndef packedstruct |
---|
145 | #if ((__GNUC__ > 2) || ((__GNUC__ == 2) && (__GNUC_MINOR__ >= 9))) |
---|
146 | #define packedstruct struct __attribute__((__packed__)) |
---|
147 | #define packedunion union __attribute__((__packed__)) |
---|
148 | #else |
---|
149 | #define packedstruct struct |
---|
150 | #define packedunion union |
---|
151 | #endif |
---|
152 | #endif |
---|
153 | |
---|
154 | // *************************************************************************** |
---|
155 | #if 0 |
---|
156 | #pragma mark - DNS Resource Record class and type constants |
---|
157 | #endif |
---|
158 | |
---|
159 | typedef enum // From RFC 1035 |
---|
160 | { |
---|
161 | kDNSClass_IN = 1, // Internet |
---|
162 | kDNSClass_CS = 2, // CSNET |
---|
163 | kDNSClass_CH = 3, // CHAOS |
---|
164 | kDNSClass_HS = 4, // Hesiod |
---|
165 | kDNSClass_NONE = 254, // Used in DNS UPDATE [RFC 2136] |
---|
166 | |
---|
167 | kDNSClass_Mask = 0x7FFF, // Multicast DNS uses the bottom 15 bits to identify the record class... |
---|
168 | kDNSClass_UniqueRRSet = 0x8000, // ... and the top bit indicates that all other cached records are now invalid |
---|
169 | |
---|
170 | kDNSQClass_ANY = 255, // Not a DNS class, but a DNS query class, meaning "all classes" |
---|
171 | kDNSQClass_UnicastResponse = 0x8000 // Top bit set in a question means "unicast response acceptable" |
---|
172 | } DNS_ClassValues; |
---|
173 | |
---|
174 | typedef enum // From RFC 1035 |
---|
175 | { |
---|
176 | kDNSType_A = 1, // 1 Address |
---|
177 | kDNSType_NS, // 2 Name Server |
---|
178 | kDNSType_MD, // 3 Mail Destination |
---|
179 | kDNSType_MF, // 4 Mail Forwarder |
---|
180 | kDNSType_CNAME, // 5 Canonical Name |
---|
181 | kDNSType_SOA, // 6 Start of Authority |
---|
182 | kDNSType_MB, // 7 Mailbox |
---|
183 | kDNSType_MG, // 8 Mail Group |
---|
184 | kDNSType_MR, // 9 Mail Rename |
---|
185 | kDNSType_NULL, // 10 NULL RR |
---|
186 | kDNSType_WKS, // 11 Well-known-service |
---|
187 | kDNSType_PTR, // 12 Domain name pointer |
---|
188 | kDNSType_HINFO, // 13 Host information |
---|
189 | kDNSType_MINFO, // 14 Mailbox information |
---|
190 | kDNSType_MX, // 15 Mail Exchanger |
---|
191 | kDNSType_TXT, // 16 Arbitrary text string |
---|
192 | kDNSType_RP, // 17 Responsible person |
---|
193 | kDNSType_AFSDB, // 18 AFS cell database |
---|
194 | kDNSType_X25, // 19 X_25 calling address |
---|
195 | kDNSType_ISDN, // 20 ISDN calling address |
---|
196 | kDNSType_RT, // 21 Router |
---|
197 | kDNSType_NSAP, // 22 NSAP address |
---|
198 | kDNSType_NSAP_PTR, // 23 Reverse NSAP lookup (deprecated) |
---|
199 | kDNSType_SIG, // 24 Security signature |
---|
200 | kDNSType_KEY, // 25 Security key |
---|
201 | kDNSType_PX, // 26 X.400 mail mapping |
---|
202 | kDNSType_GPOS, // 27 Geographical position (withdrawn) |
---|
203 | kDNSType_AAAA, // 28 IPv6 Address |
---|
204 | kDNSType_LOC, // 29 Location Information |
---|
205 | kDNSType_NXT, // 30 Next domain (security) |
---|
206 | kDNSType_EID, // 31 Endpoint identifier |
---|
207 | kDNSType_NIMLOC, // 32 Nimrod Locator |
---|
208 | kDNSType_SRV, // 33 Service record |
---|
209 | kDNSType_ATMA, // 34 ATM Address |
---|
210 | kDNSType_NAPTR, // 35 Naming Authority PoinTeR |
---|
211 | kDNSType_KX, // 36 Key Exchange |
---|
212 | kDNSType_CERT, // 37 Certification record |
---|
213 | kDNSType_A6, // 38 IPv6 Address (deprecated) |
---|
214 | kDNSType_DNAME, // 39 Non-terminal DNAME (for IPv6) |
---|
215 | kDNSType_SINK, // 40 Kitchen sink (experimental) |
---|
216 | kDNSType_OPT, // 41 EDNS0 option (meta-RR) |
---|
217 | kDNSType_APL, // 42 Address Prefix List |
---|
218 | kDNSType_DS, // 43 Delegation Signer |
---|
219 | kDNSType_SSHFP, // 44 SSH Key Fingerprint |
---|
220 | kDNSType_IPSECKEY, // 45 IPSECKEY |
---|
221 | kDNSType_RRSIG, // 46 RRSIG |
---|
222 | kDNSType_NSEC, // 47 Denial of Existence |
---|
223 | kDNSType_DNSKEY, // 48 DNSKEY |
---|
224 | kDNSType_DHCID, // 49 DHCP Client Identifier |
---|
225 | kDNSType_NSEC3, // 50 Hashed Authenticated Denial of Existence |
---|
226 | kDNSType_NSEC3PARAM, // 51 Hashed Authenticated Denial of Existence |
---|
227 | |
---|
228 | kDNSType_HIP = 55, // 55 Host Identity Protocol |
---|
229 | |
---|
230 | kDNSType_SPF = 99, // 99 Sender Policy Framework for E-Mail |
---|
231 | kDNSType_UINFO, // 100 IANA-Reserved |
---|
232 | kDNSType_UID, // 101 IANA-Reserved |
---|
233 | kDNSType_GID, // 102 IANA-Reserved |
---|
234 | kDNSType_UNSPEC, // 103 IANA-Reserved |
---|
235 | |
---|
236 | kDNSType_TKEY = 249, // 249 Transaction key |
---|
237 | kDNSType_TSIG, // 250 Transaction signature |
---|
238 | kDNSType_IXFR, // 251 Incremental zone transfer |
---|
239 | kDNSType_AXFR, // 252 Transfer zone of authority |
---|
240 | kDNSType_MAILB, // 253 Transfer mailbox records |
---|
241 | kDNSType_MAILA, // 254 Transfer mail agent records |
---|
242 | kDNSQType_ANY // Not a DNS type, but a DNS query type, meaning "all types" |
---|
243 | } DNS_TypeValues; |
---|
244 | |
---|
245 | // *************************************************************************** |
---|
246 | #if 0 |
---|
247 | #pragma mark - |
---|
248 | #pragma mark - Simple types |
---|
249 | #endif |
---|
250 | |
---|
251 | // mDNS defines its own names for these common types to simplify portability across |
---|
252 | // multiple platforms that may each have their own (different) names for these types. |
---|
253 | typedef unsigned char mDNSBool; |
---|
254 | typedef signed char mDNSs8; |
---|
255 | typedef unsigned char mDNSu8; |
---|
256 | typedef signed short mDNSs16; |
---|
257 | typedef unsigned short mDNSu16; |
---|
258 | |
---|
259 | // Source: http://www.unix.org/version2/whatsnew/lp64_wp.html |
---|
260 | // http://software.intel.com/sites/products/documentation/hpc/mkl/lin/MKL_UG_structure/Support_for_ILP64_Programming.htm |
---|
261 | // It can be safely assumed that int is 32bits on the platform |
---|
262 | #if defined(_ILP64) || defined(__ILP64__) |
---|
263 | typedef signed int32 mDNSs32; |
---|
264 | typedef unsigned int32 mDNSu32; |
---|
265 | #else |
---|
266 | typedef signed int mDNSs32; |
---|
267 | typedef unsigned int mDNSu32; |
---|
268 | #endif |
---|
269 | |
---|
270 | // To enforce useful type checking, we make mDNSInterfaceID be a pointer to a dummy struct |
---|
271 | // This way, mDNSInterfaceIDs can be assigned, and compared with each other, but not with other types |
---|
272 | // Declaring the type to be the typical generic "void *" would lack this type checking |
---|
273 | typedef struct mDNSInterfaceID_dummystruct { void *dummy; } *mDNSInterfaceID; |
---|
274 | |
---|
275 | // These types are for opaque two- and four-byte identifiers. |
---|
276 | // The "NotAnInteger" fields of the unions allow the value to be conveniently passed around in a |
---|
277 | // register for the sake of efficiency, and compared for equality or inequality, but don't forget -- |
---|
278 | // just because it is in a register doesn't mean it is an integer. Operations like greater than, |
---|
279 | // less than, add, multiply, increment, decrement, etc., are undefined for opaque identifiers, |
---|
280 | // and if you make the mistake of trying to do those using the NotAnInteger field, then you'll |
---|
281 | // find you get code that doesn't work consistently on big-endian and little-endian machines. |
---|
282 | #if defined(_WIN32) |
---|
283 | #pragma pack(push,2) |
---|
284 | #endif |
---|
285 | typedef union { mDNSu8 b[ 2]; mDNSu16 NotAnInteger; } mDNSOpaque16; |
---|
286 | typedef union { mDNSu8 b[ 4]; mDNSu32 NotAnInteger; } mDNSOpaque32; |
---|
287 | typedef packedunion { mDNSu8 b[ 6]; mDNSu16 w[3]; mDNSu32 l[1]; } mDNSOpaque48; |
---|
288 | typedef union { mDNSu8 b[ 8]; mDNSu16 w[4]; mDNSu32 l[2]; } mDNSOpaque64; |
---|
289 | typedef union { mDNSu8 b[16]; mDNSu16 w[8]; mDNSu32 l[4]; } mDNSOpaque128; |
---|
290 | #if defined(_WIN32) |
---|
291 | #pragma pack(pop) |
---|
292 | #endif |
---|
293 | |
---|
294 | typedef mDNSOpaque16 mDNSIPPort; // An IP port is a two-byte opaque identifier (not an integer) |
---|
295 | typedef mDNSOpaque32 mDNSv4Addr; // An IP address is a four-byte opaque identifier (not an integer) |
---|
296 | typedef mDNSOpaque128 mDNSv6Addr; // An IPv6 address is a 16-byte opaque identifier (not an integer) |
---|
297 | typedef mDNSOpaque48 mDNSEthAddr; // An Ethernet address is a six-byte opaque identifier (not an integer) |
---|
298 | |
---|
299 | // Bit operations for opaque 64 bit quantity. Uses the 32 bit quantity(l[2]) to set and clear bits |
---|
300 | #define mDNSNBBY 8 |
---|
301 | #define bit_set_opaque64(op64, index) (op64.l[((index))/(sizeof(mDNSu32) * mDNSNBBY)] |= (1 << ((index) % (sizeof(mDNSu32) * mDNSNBBY)))) |
---|
302 | #define bit_clr_opaque64(op64, index) (op64.l[((index))/(sizeof(mDNSu32) * mDNSNBBY)] &= ~(1 << ((index) % (sizeof(mDNSu32) * mDNSNBBY)))) |
---|
303 | #define bit_get_opaque64(op64, index) (op64.l[((index))/(sizeof(mDNSu32) * mDNSNBBY)] & (1 << ((index) % (sizeof(mDNSu32) * mDNSNBBY)))) |
---|
304 | |
---|
305 | enum |
---|
306 | { |
---|
307 | mDNSAddrType_None = 0, |
---|
308 | mDNSAddrType_IPv4 = 4, |
---|
309 | mDNSAddrType_IPv6 = 6, |
---|
310 | mDNSAddrType_Unknown = ~0 // Special marker value used in known answer list recording |
---|
311 | }; |
---|
312 | |
---|
313 | enum |
---|
314 | { |
---|
315 | mDNSTransport_None = 0, |
---|
316 | mDNSTransport_UDP = 1, |
---|
317 | mDNSTransport_TCP = 2 |
---|
318 | }; |
---|
319 | |
---|
320 | typedef struct |
---|
321 | { |
---|
322 | mDNSs32 type; |
---|
323 | union { mDNSv6Addr v6; mDNSv4Addr v4; } ip; |
---|
324 | } mDNSAddr; |
---|
325 | |
---|
326 | enum { mDNSfalse = 0, mDNStrue = 1 }; |
---|
327 | |
---|
328 | #define mDNSNULL 0L |
---|
329 | |
---|
330 | enum |
---|
331 | { |
---|
332 | mStatus_Waiting = 1, |
---|
333 | mStatus_NoError = 0, |
---|
334 | |
---|
335 | // mDNS return values are in the range FFFE FF00 (-65792) to FFFE FFFF (-65537) |
---|
336 | // The top end of the range (FFFE FFFF) is used for error codes; |
---|
337 | // the bottom end of the range (FFFE FF00) is used for non-error values; |
---|
338 | |
---|
339 | // Error codes: |
---|
340 | mStatus_UnknownErr = -65537, // First value: 0xFFFE FFFF |
---|
341 | mStatus_NoSuchNameErr = -65538, |
---|
342 | mStatus_NoMemoryErr = -65539, |
---|
343 | mStatus_BadParamErr = -65540, |
---|
344 | mStatus_BadReferenceErr = -65541, |
---|
345 | mStatus_BadStateErr = -65542, |
---|
346 | mStatus_BadFlagsErr = -65543, |
---|
347 | mStatus_UnsupportedErr = -65544, |
---|
348 | mStatus_NotInitializedErr = -65545, |
---|
349 | mStatus_NoCache = -65546, |
---|
350 | mStatus_AlreadyRegistered = -65547, |
---|
351 | mStatus_NameConflict = -65548, |
---|
352 | mStatus_Invalid = -65549, |
---|
353 | mStatus_Firewall = -65550, |
---|
354 | mStatus_Incompatible = -65551, |
---|
355 | mStatus_BadInterfaceErr = -65552, |
---|
356 | mStatus_Refused = -65553, |
---|
357 | mStatus_NoSuchRecord = -65554, |
---|
358 | mStatus_NoAuth = -65555, |
---|
359 | mStatus_NoSuchKey = -65556, |
---|
360 | mStatus_NATTraversal = -65557, |
---|
361 | mStatus_DoubleNAT = -65558, |
---|
362 | mStatus_BadTime = -65559, |
---|
363 | mStatus_BadSig = -65560, // while we define this per RFC 2845, BIND 9 returns Refused for bad/missing signatures |
---|
364 | mStatus_BadKey = -65561, |
---|
365 | mStatus_TransientErr = -65562, // transient failures, e.g. sending packets shortly after a network transition or wake from sleep |
---|
366 | mStatus_ServiceNotRunning = -65563, // Background daemon not running |
---|
367 | mStatus_NATPortMappingUnsupported = -65564, // NAT doesn't support PCP, NAT-PMP or UPnP |
---|
368 | mStatus_NATPortMappingDisabled = -65565, // NAT supports PCP, NAT-PMP or UPnP, but it's disabled by the administrator |
---|
369 | mStatus_NoRouter = -65566, |
---|
370 | mStatus_PollingMode = -65567, |
---|
371 | mStatus_Timeout = -65568, |
---|
372 | // -65568 to -65786 currently unused; available for allocation |
---|
373 | |
---|
374 | // tcp connection status |
---|
375 | mStatus_ConnPending = -65787, |
---|
376 | mStatus_ConnFailed = -65788, |
---|
377 | mStatus_ConnEstablished = -65789, |
---|
378 | |
---|
379 | // Non-error values: |
---|
380 | mStatus_GrowCache = -65790, |
---|
381 | mStatus_ConfigChanged = -65791, |
---|
382 | mStatus_MemFree = -65792 // Last value: 0xFFFE FF00 |
---|
383 | // mStatus_MemFree is the last legal mDNS error code, at the end of the range allocated for mDNS |
---|
384 | }; |
---|
385 | |
---|
386 | typedef mDNSs32 mStatus; |
---|
387 | #define MaxIp 5 // Needs to be consistent with MaxInputIf in dns_services.h |
---|
388 | |
---|
389 | typedef enum { q_stop = 0, q_start } q_state; |
---|
390 | typedef enum { reg_stop = 0, reg_start } reg_state; |
---|
391 | |
---|
392 | // RFC 1034/1035 specify that a domain label consists of a length byte plus up to 63 characters |
---|
393 | #define MAX_DOMAIN_LABEL 63 |
---|
394 | typedef struct { mDNSu8 c[ 64]; } domainlabel; // One label: length byte and up to 63 characters |
---|
395 | |
---|
396 | // RFC 1034/1035/2181 specify that a domain name (length bytes and data bytes) may be up to 255 bytes long, |
---|
397 | // plus the terminating zero at the end makes 256 bytes total in the on-the-wire format. |
---|
398 | #define MAX_DOMAIN_NAME 256 |
---|
399 | typedef struct { mDNSu8 c[256]; } domainname; // Up to 256 bytes of length-prefixed domainlabels |
---|
400 | |
---|
401 | typedef struct { mDNSu8 c[256]; } UTF8str255; // Null-terminated C string |
---|
402 | |
---|
403 | // The longest legal textual form of a DNS name is 1009 bytes, including the C-string terminating NULL at the end. |
---|
404 | // Explanation: |
---|
405 | // When a native domainname object is converted to printable textual form using ConvertDomainNameToCString(), |
---|
406 | // non-printing characters are represented in the conventional DNS way, as '\ddd', where ddd is a three-digit decimal number. |
---|
407 | // The longest legal domain name is 256 bytes, in the form of four labels as shown below: |
---|
408 | // Length byte, 63 data bytes, length byte, 63 data bytes, length byte, 63 data bytes, length byte, 62 data bytes, zero byte. |
---|
409 | // Each label is encoded textually as characters followed by a trailing dot. |
---|
410 | // If every character has to be represented as a four-byte escape sequence, then this makes the maximum textual form four labels |
---|
411 | // plus the C-string terminating NULL as shown below: |
---|
412 | // 63*4+1 + 63*4+1 + 63*4+1 + 62*4+1 + 1 = 1009. |
---|
413 | // Note that MAX_ESCAPED_DOMAIN_LABEL is not normally used: If you're only decoding a single label, escaping is usually not required. |
---|
414 | // It is for domain names, where dots are used as label separators, that proper escaping is vital. |
---|
415 | #define MAX_ESCAPED_DOMAIN_LABEL 254 |
---|
416 | #define MAX_ESCAPED_DOMAIN_NAME 1009 |
---|
417 | |
---|
418 | // MAX_REVERSE_MAPPING_NAME |
---|
419 | // For IPv4: "123.123.123.123.in-addr.arpa." 30 bytes including terminating NUL |
---|
420 | // For IPv6: "x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.ip6.arpa." 74 bytes including terminating NUL |
---|
421 | |
---|
422 | #define MAX_REVERSE_MAPPING_NAME_V4 30 |
---|
423 | #define MAX_REVERSE_MAPPING_NAME_V6 74 |
---|
424 | #define MAX_REVERSE_MAPPING_NAME 74 |
---|
425 | |
---|
426 | // Most records have a TTL of 75 minutes, so that their 80% cache-renewal query occurs once per hour. |
---|
427 | // For records containing a hostname (in the name on the left, or in the rdata on the right), |
---|
428 | // like A, AAAA, reverse-mapping PTR, and SRV, we use a two-minute TTL by default, because we don't want |
---|
429 | // them to hang around for too long in the cache if the host in question crashes or otherwise goes away. |
---|
430 | |
---|
431 | #define kStandardTTL (3600UL * 100 / 80) |
---|
432 | #define kHostNameTTL 120UL |
---|
433 | |
---|
434 | // Some applications want to register their SRV records with a lower ttl so that in case the server |
---|
435 | // using a dynamic port number restarts, the clients will not have stale information for more than |
---|
436 | // 10 seconds |
---|
437 | |
---|
438 | #define kHostNameSmallTTL 10UL |
---|
439 | |
---|
440 | |
---|
441 | // Multicast DNS uses announcements (gratuitous responses) to update peer caches. |
---|
442 | // This means it is feasible to use relatively larger TTL values than we might otherwise |
---|
443 | // use, because we have a cache coherency protocol to keep the peer caches up to date. |
---|
444 | // With Unicast DNS, once an authoritative server gives a record with a certain TTL value to a client |
---|
445 | // or caching server, that client or caching server is entitled to hold onto the record until its TTL |
---|
446 | // expires, and has no obligation to contact the authoritative server again until that time arrives. |
---|
447 | // This means that whereas Multicast DNS can use announcements to pre-emptively update stale data |
---|
448 | // before it would otherwise have expired, standard Unicast DNS (not using LLQs) has no equivalent |
---|
449 | // mechanism, and TTL expiry is the *only* mechanism by which stale data gets deleted. Because of this, |
---|
450 | // we currently limit the TTL to ten seconds in such cases where no dynamic cache updating is possible. |
---|
451 | #define kStaticCacheTTL 10 |
---|
452 | |
---|
453 | #define DefaultTTLforRRType(X) (((X) == kDNSType_A || (X) == kDNSType_AAAA || (X) == kDNSType_SRV) ? kHostNameTTL : kStandardTTL) |
---|
454 | #define mDNS_KeepaliveRecord(rr) ((rr)->rrtype == kDNSType_NULL && SameDomainLabel(SecondLabel((rr)->name)->c, (mDNSu8 *)"\x0A_keepalive")) |
---|
455 | |
---|
456 | // Number of times keepalives are sent if no ACK is received before waking up the system |
---|
457 | // this is analogous to net.inet.tcp.keepcnt |
---|
458 | #define kKeepaliveRetryCount 10 |
---|
459 | // The frequency at which keepalives are retried if no ACK is received |
---|
460 | #define kKeepaliveRetryInterval 30 |
---|
461 | |
---|
462 | typedef struct AuthRecord_struct AuthRecord; |
---|
463 | typedef struct ServiceRecordSet_struct ServiceRecordSet; |
---|
464 | typedef struct CacheRecord_struct CacheRecord; |
---|
465 | typedef struct CacheGroup_struct CacheGroup; |
---|
466 | typedef struct AuthGroup_struct AuthGroup; |
---|
467 | typedef struct DNSQuestion_struct DNSQuestion; |
---|
468 | typedef struct ZoneData_struct ZoneData; |
---|
469 | typedef struct mDNS_struct mDNS; |
---|
470 | typedef struct mDNS_PlatformSupport_struct mDNS_PlatformSupport; |
---|
471 | typedef struct NATTraversalInfo_struct NATTraversalInfo; |
---|
472 | typedef struct ResourceRecord_struct ResourceRecord; |
---|
473 | |
---|
474 | // Structure to abstract away the differences between TCP/SSL sockets, and one for UDP sockets |
---|
475 | // The actual definition of these structures appear in the appropriate platform support code |
---|
476 | typedef struct TCPSocket_struct TCPSocket; |
---|
477 | typedef struct UDPSocket_struct UDPSocket; |
---|
478 | |
---|
479 | // *************************************************************************** |
---|
480 | #if 0 |
---|
481 | #pragma mark - |
---|
482 | #pragma mark - DNS Message structures |
---|
483 | #endif |
---|
484 | |
---|
485 | #define mDNS_numZones numQuestions |
---|
486 | #define mDNS_numPrereqs numAnswers |
---|
487 | #define mDNS_numUpdates numAuthorities |
---|
488 | |
---|
489 | typedef packedstruct |
---|
490 | { |
---|
491 | mDNSOpaque16 id; |
---|
492 | mDNSOpaque16 flags; |
---|
493 | mDNSu16 numQuestions; |
---|
494 | mDNSu16 numAnswers; |
---|
495 | mDNSu16 numAuthorities; |
---|
496 | mDNSu16 numAdditionals; |
---|
497 | } DNSMessageHeader; |
---|
498 | |
---|
499 | // We can send and receive packets up to 9000 bytes (Ethernet Jumbo Frame size, if that ever becomes widely used) |
---|
500 | // However, in the normal case we try to limit packets to 1500 bytes so that we don't get IP fragmentation on standard Ethernet |
---|
501 | // 40 (IPv6 header) + 8 (UDP header) + 12 (DNS message header) + 1440 (DNS message body) = 1500 total |
---|
502 | #ifndef AbsoluteMaxDNSMessageData |
---|
503 | #define AbsoluteMaxDNSMessageData 8940 |
---|
504 | #endif |
---|
505 | #define NormalMaxDNSMessageData 1440 |
---|
506 | typedef packedstruct |
---|
507 | { |
---|
508 | DNSMessageHeader h; // Note: Size 12 bytes |
---|
509 | mDNSu8 data[AbsoluteMaxDNSMessageData]; // 40 (IPv6) + 8 (UDP) + 12 (DNS header) + 8940 (data) = 9000 |
---|
510 | } DNSMessage; |
---|
511 | |
---|
512 | typedef struct tcpInfo_t |
---|
513 | { |
---|
514 | mDNS *m; |
---|
515 | TCPSocket *sock; |
---|
516 | DNSMessage request; |
---|
517 | int requestLen; |
---|
518 | DNSQuestion *question; // For queries |
---|
519 | AuthRecord *rr; // For record updates |
---|
520 | mDNSAddr Addr; |
---|
521 | mDNSIPPort Port; |
---|
522 | mDNSIPPort SrcPort; |
---|
523 | DNSMessage *reply; |
---|
524 | mDNSu16 replylen; |
---|
525 | unsigned long nread; |
---|
526 | int numReplies; |
---|
527 | } tcpInfo_t; |
---|
528 | |
---|
529 | // *************************************************************************** |
---|
530 | #if 0 |
---|
531 | #pragma mark - |
---|
532 | #pragma mark - Other Packet Format Structures |
---|
533 | #endif |
---|
534 | |
---|
535 | typedef packedstruct |
---|
536 | { |
---|
537 | mDNSEthAddr dst; |
---|
538 | mDNSEthAddr src; |
---|
539 | mDNSOpaque16 ethertype; |
---|
540 | } EthernetHeader; // 14 bytes |
---|
541 | |
---|
542 | typedef packedstruct |
---|
543 | { |
---|
544 | mDNSOpaque16 hrd; |
---|
545 | mDNSOpaque16 pro; |
---|
546 | mDNSu8 hln; |
---|
547 | mDNSu8 pln; |
---|
548 | mDNSOpaque16 op; |
---|
549 | mDNSEthAddr sha; |
---|
550 | mDNSv4Addr spa; |
---|
551 | mDNSEthAddr tha; |
---|
552 | mDNSv4Addr tpa; |
---|
553 | } ARP_EthIP; // 28 bytes |
---|
554 | |
---|
555 | typedef packedstruct |
---|
556 | { |
---|
557 | mDNSu8 vlen; |
---|
558 | mDNSu8 tos; |
---|
559 | mDNSu16 totlen; |
---|
560 | mDNSOpaque16 id; |
---|
561 | mDNSOpaque16 flagsfrags; |
---|
562 | mDNSu8 ttl; |
---|
563 | mDNSu8 protocol; // Payload type: 0x06 = TCP, 0x11 = UDP |
---|
564 | mDNSu16 checksum; |
---|
565 | mDNSv4Addr src; |
---|
566 | mDNSv4Addr dst; |
---|
567 | } IPv4Header; // 20 bytes |
---|
568 | |
---|
569 | typedef packedstruct |
---|
570 | { |
---|
571 | mDNSu32 vcf; // Version, Traffic Class, Flow Label |
---|
572 | mDNSu16 len; // Payload Length |
---|
573 | mDNSu8 pro; // Type of next header: 0x06 = TCP, 0x11 = UDP, 0x3A = ICMPv6 |
---|
574 | mDNSu8 ttl; // Hop Limit |
---|
575 | mDNSv6Addr src; |
---|
576 | mDNSv6Addr dst; |
---|
577 | } IPv6Header; // 40 bytes |
---|
578 | |
---|
579 | typedef packedstruct |
---|
580 | { |
---|
581 | mDNSv6Addr src; |
---|
582 | mDNSv6Addr dst; |
---|
583 | mDNSOpaque32 len; |
---|
584 | mDNSOpaque32 pro; |
---|
585 | } IPv6PseudoHeader; // 40 bytes |
---|
586 | |
---|
587 | typedef union |
---|
588 | { |
---|
589 | mDNSu8 bytes[20]; |
---|
590 | ARP_EthIP arp; |
---|
591 | IPv4Header v4; |
---|
592 | IPv6Header v6; |
---|
593 | } NetworkLayerPacket; |
---|
594 | |
---|
595 | typedef packedstruct |
---|
596 | { |
---|
597 | mDNSIPPort src; |
---|
598 | mDNSIPPort dst; |
---|
599 | mDNSu32 seq; |
---|
600 | mDNSu32 ack; |
---|
601 | mDNSu8 offset; |
---|
602 | mDNSu8 flags; |
---|
603 | mDNSu16 window; |
---|
604 | mDNSu16 checksum; |
---|
605 | mDNSu16 urgent; |
---|
606 | } TCPHeader; // 20 bytes; IP protocol type 0x06 |
---|
607 | |
---|
608 | typedef struct |
---|
609 | { |
---|
610 | mDNSInterfaceID IntfId; |
---|
611 | mDNSu32 seq; |
---|
612 | mDNSu32 ack; |
---|
613 | mDNSu16 window; |
---|
614 | } mDNSTCPInfo; |
---|
615 | |
---|
616 | typedef packedstruct |
---|
617 | { |
---|
618 | mDNSIPPort src; |
---|
619 | mDNSIPPort dst; |
---|
620 | mDNSu16 len; // Length including UDP header (i.e. minimum value is 8 bytes) |
---|
621 | mDNSu16 checksum; |
---|
622 | } UDPHeader; // 8 bytes; IP protocol type 0x11 |
---|
623 | |
---|
624 | typedef packedstruct |
---|
625 | { |
---|
626 | mDNSu8 type; // 0x87 == Neighbor Solicitation, 0x88 == Neighbor Advertisement |
---|
627 | mDNSu8 code; |
---|
628 | mDNSu16 checksum; |
---|
629 | mDNSu32 flags_res; // R/S/O flags and reserved bits |
---|
630 | mDNSv6Addr target; |
---|
631 | // Typically 8 bytes of options are also present |
---|
632 | } IPv6NDP; // 24 bytes or more; IP protocol type 0x3A |
---|
633 | |
---|
634 | typedef struct |
---|
635 | { |
---|
636 | mDNSAddr ipaddr; |
---|
637 | char ethaddr[18]; |
---|
638 | } IPAddressMACMapping; |
---|
639 | |
---|
640 | #define NDP_Sol 0x87 |
---|
641 | #define NDP_Adv 0x88 |
---|
642 | |
---|
643 | #define NDP_Router 0x80 |
---|
644 | #define NDP_Solicited 0x40 |
---|
645 | #define NDP_Override 0x20 |
---|
646 | |
---|
647 | #define NDP_SrcLL 1 |
---|
648 | #define NDP_TgtLL 2 |
---|
649 | |
---|
650 | typedef union |
---|
651 | { |
---|
652 | mDNSu8 bytes[20]; |
---|
653 | TCPHeader tcp; |
---|
654 | UDPHeader udp; |
---|
655 | IPv6NDP ndp; |
---|
656 | } TransportLayerPacket; |
---|
657 | |
---|
658 | typedef packedstruct |
---|
659 | { |
---|
660 | mDNSOpaque64 InitiatorCookie; |
---|
661 | mDNSOpaque64 ResponderCookie; |
---|
662 | mDNSu8 NextPayload; |
---|
663 | mDNSu8 Version; |
---|
664 | mDNSu8 ExchangeType; |
---|
665 | mDNSu8 Flags; |
---|
666 | mDNSOpaque32 MessageID; |
---|
667 | mDNSu32 Length; |
---|
668 | } IKEHeader; // 28 bytes |
---|
669 | |
---|
670 | // *************************************************************************** |
---|
671 | #if 0 |
---|
672 | #pragma mark - |
---|
673 | #pragma mark - Resource Record structures |
---|
674 | #endif |
---|
675 | |
---|
676 | // Authoritative Resource Records: |
---|
677 | // There are four basic types: Shared, Advisory, Unique, Known Unique |
---|
678 | |
---|
679 | // * Shared Resource Records do not have to be unique |
---|
680 | // -- Shared Resource Records are used for DNS-SD service PTRs |
---|
681 | // -- It is okay for several hosts to have RRs with the same name but different RDATA |
---|
682 | // -- We use a random delay on responses to reduce collisions when all the hosts respond to the same query |
---|
683 | // -- These RRs typically have moderately high TTLs (e.g. one hour) |
---|
684 | // -- These records are announced on startup and topology changes for the benefit of passive listeners |
---|
685 | // -- These records send a goodbye packet when deregistering |
---|
686 | // |
---|
687 | // * Advisory Resource Records are like Shared Resource Records, except they don't send a goodbye packet |
---|
688 | // |
---|
689 | // * Unique Resource Records should be unique among hosts within any given mDNS scope |
---|
690 | // -- The majority of Resource Records are of this type |
---|
691 | // -- If two entities on the network have RRs with the same name but different RDATA, this is a conflict |
---|
692 | // -- Responses may be sent immediately, because only one host should be responding to any particular query |
---|
693 | // -- These RRs typically have low TTLs (e.g. a few minutes) |
---|
694 | // -- On startup and after topology changes, a host issues queries to verify uniqueness |
---|
695 | |
---|
696 | // * Known Unique Resource Records are treated like Unique Resource Records, except that mDNS does |
---|
697 | // not have to verify their uniqueness because this is already known by other means (e.g. the RR name |
---|
698 | // is derived from the host's IP or Ethernet address, which is already known to be a unique identifier). |
---|
699 | |
---|
700 | // Summary of properties of different record types: |
---|
701 | // Probe? Does this record type send probes before announcing? |
---|
702 | // Conflict? Does this record type react if we observe an apparent conflict? |
---|
703 | // Goodbye? Does this record type send a goodbye packet on departure? |
---|
704 | // |
---|
705 | // Probe? Conflict? Goodbye? Notes |
---|
706 | // Unregistered Should not appear in any list (sanity check value) |
---|
707 | // Shared No No Yes e.g. Service PTR record |
---|
708 | // Deregistering No No Yes Shared record about to announce its departure and leave the list |
---|
709 | // Advisory No No No |
---|
710 | // Unique Yes Yes No Record intended to be unique -- will probe to verify |
---|
711 | // Verified Yes Yes No Record has completed probing, and is verified unique |
---|
712 | // KnownUnique No Yes No Record is assumed by other means to be unique |
---|
713 | |
---|
714 | // Valid lifecycle of a record: |
---|
715 | // Unregistered -> Shared -> Deregistering -(goodbye)-> Unregistered |
---|
716 | // Unregistered -> Advisory -> Unregistered |
---|
717 | // Unregistered -> Unique -(probe)-> Verified -> Unregistered |
---|
718 | // Unregistered -> KnownUnique -> Unregistered |
---|
719 | |
---|
720 | // Each Authoritative kDNSRecordType has only one bit set. This makes it easy to quickly see if a record |
---|
721 | // is one of a particular set of types simply by performing the appropriate bitwise masking operation. |
---|
722 | |
---|
723 | // Cache Resource Records (received from the network): |
---|
724 | // There are four basic types: Answer, Unique Answer, Additional, Unique Additional |
---|
725 | // Bit 7 (the top bit) of kDNSRecordType is always set for Cache Resource Records; always clear for Authoritative Resource Records |
---|
726 | // Bit 6 (value 0x40) is set for answer records; clear for authority/additional records |
---|
727 | // Bit 5 (value 0x20) is set for records received with the kDNSClass_UniqueRRSet |
---|
728 | |
---|
729 | enum |
---|
730 | { |
---|
731 | kDNSRecordTypeUnregistered = 0x00, // Not currently in any list |
---|
732 | kDNSRecordTypeDeregistering = 0x01, // Shared record about to announce its departure and leave the list |
---|
733 | |
---|
734 | kDNSRecordTypeUnique = 0x02, // Will become a kDNSRecordTypeVerified when probing is complete |
---|
735 | |
---|
736 | kDNSRecordTypeAdvisory = 0x04, // Like Shared, but no goodbye packet |
---|
737 | kDNSRecordTypeShared = 0x08, // Shared means record name does not have to be unique -- use random delay on responses |
---|
738 | |
---|
739 | kDNSRecordTypeVerified = 0x10, // Unique means mDNS should check that name is unique (and then send immediate responses) |
---|
740 | kDNSRecordTypeKnownUnique = 0x20, // Known Unique means mDNS can assume name is unique without checking |
---|
741 | // For Dynamic Update records, Known Unique means the record must already exist on the server. |
---|
742 | kDNSRecordTypeUniqueMask = (kDNSRecordTypeUnique | kDNSRecordTypeVerified | kDNSRecordTypeKnownUnique), |
---|
743 | kDNSRecordTypeActiveSharedMask = (kDNSRecordTypeAdvisory | kDNSRecordTypeShared), |
---|
744 | kDNSRecordTypeActiveUniqueMask = (kDNSRecordTypeVerified | kDNSRecordTypeKnownUnique), |
---|
745 | kDNSRecordTypeActiveMask = (kDNSRecordTypeActiveSharedMask | kDNSRecordTypeActiveUniqueMask), |
---|
746 | |
---|
747 | kDNSRecordTypePacketAdd = 0x80, // Received in the Additional Section of a DNS Response |
---|
748 | kDNSRecordTypePacketAddUnique = 0x90, // Received in the Additional Section of a DNS Response with kDNSClass_UniqueRRSet set |
---|
749 | kDNSRecordTypePacketAuth = 0xA0, // Received in the Authorities Section of a DNS Response |
---|
750 | kDNSRecordTypePacketAuthUnique = 0xB0, // Received in the Authorities Section of a DNS Response with kDNSClass_UniqueRRSet set |
---|
751 | kDNSRecordTypePacketAns = 0xC0, // Received in the Answer Section of a DNS Response |
---|
752 | kDNSRecordTypePacketAnsUnique = 0xD0, // Received in the Answer Section of a DNS Response with kDNSClass_UniqueRRSet set |
---|
753 | |
---|
754 | kDNSRecordTypePacketNegative = 0xF0, // Pseudo-RR generated to cache non-existence results like NXDomain |
---|
755 | |
---|
756 | kDNSRecordTypePacketUniqueMask = 0x10 // True for PacketAddUnique, PacketAnsUnique, PacketAuthUnique, kDNSRecordTypePacketNegative |
---|
757 | }; |
---|
758 | |
---|
759 | typedef packedstruct { mDNSu16 priority; mDNSu16 weight; mDNSIPPort port; domainname target; } rdataSRV; |
---|
760 | typedef packedstruct { mDNSu16 preference; domainname exchange; } rdataMX; |
---|
761 | typedef packedstruct { domainname mbox; domainname txt; } rdataRP; |
---|
762 | typedef packedstruct { mDNSu16 preference; domainname map822; domainname mapx400; } rdataPX; |
---|
763 | |
---|
764 | typedef packedstruct |
---|
765 | { |
---|
766 | domainname mname; |
---|
767 | domainname rname; |
---|
768 | mDNSs32 serial; // Modular counter; increases when zone changes |
---|
769 | mDNSu32 refresh; // Time in seconds that a slave waits after successful replication of the database before it attempts replication again |
---|
770 | mDNSu32 retry; // Time in seconds that a slave waits after an unsuccessful replication attempt before it attempts replication again |
---|
771 | mDNSu32 expire; // Time in seconds that a slave holds on to old data while replication attempts remain unsuccessful |
---|
772 | mDNSu32 min; // Nominally the minimum record TTL for this zone, in seconds; also used for negative caching. |
---|
773 | } rdataSOA; |
---|
774 | |
---|
775 | // http://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml |
---|
776 | // Algorithm used for RRSIG, DS and DNS KEY |
---|
777 | #define CRYPTO_RSA_SHA1 0x05 |
---|
778 | #define CRYPTO_DSA_NSEC3_SHA1 0x06 |
---|
779 | #define CRYPTO_RSA_NSEC3_SHA1 0x07 |
---|
780 | #define CRYPTO_RSA_SHA256 0x08 |
---|
781 | #define CRYPTO_RSA_SHA512 0x0A |
---|
782 | |
---|
783 | #define CRYPTO_ALG_MAX 0x0B |
---|
784 | |
---|
785 | // alg - same as in RRSIG, DNS KEY or DS. |
---|
786 | // RFC 4034 defines SHA1 |
---|
787 | // RFC 4509 defines SHA256 |
---|
788 | // Note: NSEC3 also uses 1 for SHA1 and hence we will reuse for now till a new |
---|
789 | // value is assigned. |
---|
790 | // |
---|
791 | #define SHA1_DIGEST_TYPE 1 |
---|
792 | #define SHA256_DIGEST_TYPE 2 |
---|
793 | #define DIGEST_TYPE_MAX 3 |
---|
794 | |
---|
795 | // We need support for base64 and base32 encoding for displaying KEY, NSEC3 |
---|
796 | // To make this platform agnostic, we define two types which the platform |
---|
797 | // needs to support |
---|
798 | #define ENC_BASE32 1 |
---|
799 | #define ENC_BASE64 2 |
---|
800 | #define ENC_ALG_MAX 3 |
---|
801 | |
---|
802 | #define DS_FIXED_SIZE 4 |
---|
803 | typedef packedstruct |
---|
804 | { |
---|
805 | mDNSu16 keyTag; |
---|
806 | mDNSu8 alg; |
---|
807 | mDNSu8 digestType; |
---|
808 | mDNSu8 *digest; |
---|
809 | } rdataDS; |
---|
810 | |
---|
811 | typedef struct TrustAnchor |
---|
812 | { |
---|
813 | struct TrustAnchor *next; |
---|
814 | int digestLen; |
---|
815 | mDNSu32 validFrom; |
---|
816 | mDNSu32 validUntil; |
---|
817 | domainname zone; |
---|
818 | rdataDS rds; |
---|
819 | } TrustAnchor; |
---|
820 | |
---|
821 | //size of rdataRRSIG excluding signerName and signature (which are variable fields) |
---|
822 | #define RRSIG_FIXED_SIZE 18 |
---|
823 | typedef packedstruct |
---|
824 | { |
---|
825 | mDNSu16 typeCovered; |
---|
826 | mDNSu8 alg; |
---|
827 | mDNSu8 labels; |
---|
828 | mDNSu32 origTTL; |
---|
829 | mDNSu32 sigExpireTime; |
---|
830 | mDNSu32 sigInceptTime; |
---|
831 | mDNSu16 keyTag; |
---|
832 | mDNSu8 *signerName; |
---|
833 | // mDNSu8 *signature |
---|
834 | } rdataRRSig; |
---|
835 | |
---|
836 | // RFC 4034: For DNS Key RR |
---|
837 | // flags - the valid value for DNSSEC is 256 (Zone signing key - ZSK) and 257 (Secure Entry Point) which also |
---|
838 | // includes the ZSK bit |
---|
839 | // |
---|
840 | #define DNSKEY_ZONE_SIGN_KEY 0x100 |
---|
841 | #define DNSKEY_SECURE_ENTRY_POINT 0x101 |
---|
842 | |
---|
843 | // proto - the only valid value for protocol is 3 (See RFC 4034) |
---|
844 | #define DNSKEY_VALID_PROTO_VALUE 0x003 |
---|
845 | |
---|
846 | // alg - The only mandatory algorithm that we support is RSA/SHA-1 |
---|
847 | // DNSSEC_RSA_SHA1_ALG |
---|
848 | |
---|
849 | #define DNSKEY_FIXED_SIZE 4 |
---|
850 | typedef packedstruct |
---|
851 | { |
---|
852 | mDNSu16 flags; |
---|
853 | mDNSu8 proto; |
---|
854 | mDNSu8 alg; |
---|
855 | mDNSu8 *data; |
---|
856 | } rdataDNSKey; |
---|
857 | |
---|
858 | #define NSEC3_FIXED_SIZE 5 |
---|
859 | #define NSEC3_FLAGS_OPTOUT 1 |
---|
860 | #define NSEC3_MAX_ITERATIONS 2500 |
---|
861 | typedef packedstruct |
---|
862 | { |
---|
863 | mDNSu8 alg; |
---|
864 | mDNSu8 flags; |
---|
865 | mDNSu16 iterations; |
---|
866 | mDNSu8 saltLength; |
---|
867 | mDNSu8 *salt; |
---|
868 | // hashLength, nxt, bitmap |
---|
869 | } rdataNSEC3; |
---|
870 | |
---|
871 | // In the multicast usage of NSEC3, we know the actual size of RData |
---|
872 | // 4 bytes : HashAlg, Flags,Iterations |
---|
873 | // 5 bytes : Salt Length 1 byte, Salt 4 bytes |
---|
874 | // 21 bytes : HashLength 1 byte, Hash 20 bytes |
---|
875 | // 34 bytes : Window number, Bitmap length, Type bit map to include the first 256 types |
---|
876 | #define MCAST_NSEC3_RDLENGTH (4 + 5 + 21 + 34) |
---|
877 | #define SHA1_HASH_LENGTH 20 |
---|
878 | |
---|
879 | // Base32 encoding takes 5 bytes of the input and encodes as 8 bytes of output. |
---|
880 | // For example, SHA-1 hash of 20 bytes will be encoded as 20/5 * 8 = 32 base32 |
---|
881 | // bytes. For a max domain name size of 255 bytes of base32 encoding : (255/8)*5 |
---|
882 | // is the max hash length possible. |
---|
883 | #define NSEC3_MAX_HASH_LEN 155 |
---|
884 | // In NSEC3, the names are hashed and stored in the first label and hence cannot exceed label |
---|
885 | // size. |
---|
886 | #define NSEC3_MAX_B32_LEN MAX_DOMAIN_LABEL |
---|
887 | |
---|
888 | // We define it here instead of dnssec.h so that these values can be used |
---|
889 | // in files without bringing in all of dnssec.h unnecessarily. |
---|
890 | typedef enum |
---|
891 | { |
---|
892 | DNSSEC_Secure = 1, // Securely validated and has a chain up to the trust anchor |
---|
893 | DNSSEC_Insecure, // Cannot build a chain up to the trust anchor |
---|
894 | DNSSEC_Indeterminate, // Not used currently |
---|
895 | DNSSEC_Bogus, // failed to validate signatures |
---|
896 | DNSSEC_NoResponse // No DNSSEC records to start with |
---|
897 | } DNSSECStatus; |
---|
898 | |
---|
899 | #define DNSSECRecordType(rrtype) (((rrtype) == kDNSType_RRSIG) || ((rrtype) == kDNSType_NSEC) || ((rrtype) == kDNSType_DNSKEY) || ((rrtype) == kDNSType_DS) || \ |
---|
900 | ((rrtype) == kDNSType_NSEC3)) |
---|
901 | |
---|
902 | typedef enum |
---|
903 | { |
---|
904 | platform_OSX = 1, // OSX Platform |
---|
905 | platform_iOS, // iOS Platform |
---|
906 | platform_Atv, // Atv Platform |
---|
907 | platform_NonApple // Non-Apple (Windows, POSIX) Platform |
---|
908 | } Platform_t; |
---|
909 | |
---|
910 | // EDNS Option Code registrations are recorded in the "DNS EDNS0 Options" section of |
---|
911 | // <http://www.iana.org/assignments/dns-parameters> |
---|
912 | |
---|
913 | #define kDNSOpt_LLQ 1 |
---|
914 | #define kDNSOpt_Lease 2 |
---|
915 | #define kDNSOpt_NSID 3 |
---|
916 | #define kDNSOpt_Owner 4 |
---|
917 | #define kDNSOpt_Trace 65001 // 65001-65534 Reserved for Local/Experimental Use |
---|
918 | |
---|
919 | typedef struct |
---|
920 | { |
---|
921 | mDNSu16 vers; |
---|
922 | mDNSu16 llqOp; |
---|
923 | mDNSu16 err; // Or UDP reply port, in setup request |
---|
924 | // Note: In the in-memory form, there's typically a two-byte space here, so that the following 64-bit id is word-aligned |
---|
925 | mDNSOpaque64 id; |
---|
926 | mDNSu32 llqlease; |
---|
927 | } LLQOptData; |
---|
928 | |
---|
929 | typedef struct |
---|
930 | { |
---|
931 | mDNSu8 vers; // Version number of this Owner OPT record |
---|
932 | mDNSs8 seq; // Sleep/wake epoch |
---|
933 | mDNSEthAddr HMAC; // Host's primary identifier (e.g. MAC of on-board Ethernet) |
---|
934 | mDNSEthAddr IMAC; // Interface's MAC address (if different to primary MAC) |
---|
935 | mDNSOpaque48 password; // Optional password |
---|
936 | } OwnerOptData; |
---|
937 | |
---|
938 | typedef struct |
---|
939 | { |
---|
940 | mDNSu8 platf; // Running platform (see enum Platform_t) |
---|
941 | mDNSu32 mDNSv; // mDNSResponder Version (DNS_SD_H defined in dns_sd.h) |
---|
942 | } TracerOptData; |
---|
943 | |
---|
944 | // Note: rdataOPT format may be repeated an arbitrary number of times in a single resource record |
---|
945 | typedef packedstruct |
---|
946 | { |
---|
947 | mDNSu16 opt; |
---|
948 | mDNSu16 optlen; |
---|
949 | union { LLQOptData llq; mDNSu32 updatelease; OwnerOptData owner; TracerOptData tracer; } u; |
---|
950 | } rdataOPT; |
---|
951 | |
---|
952 | // Space needed to put OPT records into a packet: |
---|
953 | // Header 11 bytes (name 1, type 2, class 2, TTL 4, length 2) |
---|
954 | // LLQ rdata 18 bytes (opt 2, len 2, vers 2, op 2, err 2, id 8, lease 4) |
---|
955 | // Lease rdata 8 bytes (opt 2, len 2, lease 4) |
---|
956 | // Owner rdata 12-24 bytes (opt 2, len 2, owner 8-20) |
---|
957 | // Trace rdata 9 bytes (opt 2, len 2, platf 1, mDNSv 4) |
---|
958 | |
---|
959 | |
---|
960 | #define DNSOpt_Header_Space 11 |
---|
961 | #define DNSOpt_LLQData_Space (4 + 2 + 2 + 2 + 8 + 4) |
---|
962 | #define DNSOpt_LeaseData_Space (4 + 4) |
---|
963 | #define DNSOpt_OwnerData_ID_Space (4 + 2 + 6) |
---|
964 | #define DNSOpt_OwnerData_ID_Wake_Space (4 + 2 + 6 + 6) |
---|
965 | #define DNSOpt_OwnerData_ID_Wake_PW4_Space (4 + 2 + 6 + 6 + 4) |
---|
966 | #define DNSOpt_OwnerData_ID_Wake_PW6_Space (4 + 2 + 6 + 6 + 6) |
---|
967 | #define DNSOpt_TraceData_Space (4 + 1 + 4) |
---|
968 | |
---|
969 | #define ValidOwnerLength(X) ( (X) == DNSOpt_OwnerData_ID_Space - 4 || \ |
---|
970 | (X) == DNSOpt_OwnerData_ID_Wake_Space - 4 || \ |
---|
971 | (X) == DNSOpt_OwnerData_ID_Wake_PW4_Space - 4 || \ |
---|
972 | (X) == DNSOpt_OwnerData_ID_Wake_PW6_Space - 4 ) |
---|
973 | |
---|
974 | #define DNSOpt_Owner_Space(A,B) (mDNSSameEthAddress((A),(B)) ? DNSOpt_OwnerData_ID_Space : DNSOpt_OwnerData_ID_Wake_Space) |
---|
975 | |
---|
976 | #define DNSOpt_Data_Space(O) ( \ |
---|
977 | (O)->opt == kDNSOpt_LLQ ? DNSOpt_LLQData_Space : \ |
---|
978 | (O)->opt == kDNSOpt_Lease ? DNSOpt_LeaseData_Space : \ |
---|
979 | (O)->opt == kDNSOpt_Trace ? DNSOpt_TraceData_Space : \ |
---|
980 | (O)->opt == kDNSOpt_Owner ? DNSOpt_Owner_Space(&(O)->u.owner.HMAC, &(O)->u.owner.IMAC) : 0x10000) |
---|
981 | |
---|
982 | // NSEC record is defined in RFC 4034. |
---|
983 | // 16 bit RRTYPE space is split into 256 windows and each window has 256 bits (32 bytes). |
---|
984 | // If we create a structure for NSEC, it's size would be: |
---|
985 | // |
---|
986 | // 256 bytes domainname 'nextname' |
---|
987 | // + 256 * 34 = 8704 bytes of bitmap data |
---|
988 | // = 8960 bytes total |
---|
989 | // |
---|
990 | // This would be a waste, as types about 256 are not very common. But it would be odd, if we receive |
---|
991 | // a type above 256 (.US zone had TYPE65534 when this code was written) and not able to handle it. |
---|
992 | // Hence, we handle any size by not fixing a strucure in place. The following is just a placeholder |
---|
993 | // and never used anywhere. |
---|
994 | // |
---|
995 | #define NSEC_MCAST_WINDOW_SIZE 32 |
---|
996 | typedef struct |
---|
997 | { |
---|
998 | domainname *next; //placeholders are uncommented because C89 in Windows requires that a struct has at least a member. |
---|
999 | char bitmap[32]; |
---|
1000 | } rdataNSEC; |
---|
1001 | |
---|
1002 | // StandardAuthRDSize is 264 (256+8), which is large enough to hold a maximum-sized SRV record (6 + 256 bytes) |
---|
1003 | // MaximumRDSize is 8K the absolute maximum we support (at least for now) |
---|
1004 | #define StandardAuthRDSize 264 |
---|
1005 | #ifndef MaximumRDSize |
---|
1006 | #define MaximumRDSize 8192 |
---|
1007 | #endif |
---|
1008 | |
---|
1009 | // InlineCacheRDSize is 68 |
---|
1010 | // Records received from the network with rdata this size or less have their rdata stored right in the CacheRecord object |
---|
1011 | // Records received from the network with rdata larger than this have additional storage allocated for the rdata |
---|
1012 | // A quick unscientific sample from a busy network at Apple with lots of machines revealed this: |
---|
1013 | // 1461 records in cache |
---|
1014 | // 292 were one-byte TXT records |
---|
1015 | // 136 were four-byte A records |
---|
1016 | // 184 were sixteen-byte AAAA records |
---|
1017 | // 780 were various PTR, TXT and SRV records from 12-64 bytes |
---|
1018 | // Only 69 records had rdata bigger than 64 bytes |
---|
1019 | // Note that since CacheRecord object and a CacheGroup object are allocated out of the same pool, it's sensible to |
---|
1020 | // have them both be the same size. Making one smaller without making the other smaller won't actually save any memory. |
---|
1021 | #define InlineCacheRDSize 68 |
---|
1022 | |
---|
1023 | // The RDataBody union defines the common rdata types that fit into our 264-byte limit |
---|
1024 | typedef union |
---|
1025 | { |
---|
1026 | mDNSu8 data[StandardAuthRDSize]; |
---|
1027 | mDNSv4Addr ipv4; // For 'A' record |
---|
1028 | domainname name; // For PTR, NS, CNAME, DNAME |
---|
1029 | UTF8str255 txt; |
---|
1030 | rdataMX mx; |
---|
1031 | mDNSv6Addr ipv6; // For 'AAAA' record |
---|
1032 | rdataSRV srv; |
---|
1033 | rdataOPT opt[2]; // For EDNS0 OPT record; RDataBody may contain multiple variable-length rdataOPT objects packed together |
---|
1034 | } RDataBody; |
---|
1035 | |
---|
1036 | // The RDataBody2 union is the same as above, except it includes fields for the larger types like soa, rp, px |
---|
1037 | typedef union |
---|
1038 | { |
---|
1039 | mDNSu8 data[StandardAuthRDSize]; |
---|
1040 | mDNSv4Addr ipv4; // For 'A' record |
---|
1041 | domainname name; // For PTR, NS, CNAME, DNAME |
---|
1042 | rdataSOA soa; // This is large; not included in the normal RDataBody definition |
---|
1043 | UTF8str255 txt; |
---|
1044 | rdataMX mx; |
---|
1045 | rdataRP rp; // This is large; not included in the normal RDataBody definition |
---|
1046 | rdataPX px; // This is large; not included in the normal RDataBody definition |
---|
1047 | mDNSv6Addr ipv6; // For 'AAAA' record |
---|
1048 | rdataSRV srv; |
---|
1049 | rdataOPT opt[2]; // For EDNS0 OPT record; RDataBody may contain multiple variable-length rdataOPT objects packed together |
---|
1050 | rdataDS ds; |
---|
1051 | rdataDNSKey key; |
---|
1052 | rdataRRSig rrsig; |
---|
1053 | } RDataBody2; |
---|
1054 | |
---|
1055 | typedef struct |
---|
1056 | { |
---|
1057 | mDNSu16 MaxRDLength; // Amount of storage allocated for rdata (usually sizeof(RDataBody)) |
---|
1058 | mDNSu16 padding; // So that RDataBody is aligned on 32-bit boundary |
---|
1059 | RDataBody u; |
---|
1060 | } RData; |
---|
1061 | |
---|
1062 | // sizeofRDataHeader should be 4 bytes |
---|
1063 | #define sizeofRDataHeader (sizeof(RData) - sizeof(RDataBody)) |
---|
1064 | |
---|
1065 | // RData_small is a smaller version of the RData object, used for inline data storage embedded in a CacheRecord_struct |
---|
1066 | typedef struct |
---|
1067 | { |
---|
1068 | mDNSu16 MaxRDLength; // Storage allocated for data (may be greater than InlineCacheRDSize if additional storage follows this object) |
---|
1069 | mDNSu16 padding; // So that data is aligned on 32-bit boundary |
---|
1070 | mDNSu8 data[InlineCacheRDSize]; |
---|
1071 | } RData_small; |
---|
1072 | |
---|
1073 | // Note: Within an mDNSRecordCallback mDNS all API calls are legal except mDNS_Init(), mDNS_Exit(), mDNS_Execute() |
---|
1074 | typedef void mDNSRecordCallback (mDNS *const m, AuthRecord *const rr, mStatus result); |
---|
1075 | |
---|
1076 | // Note: |
---|
1077 | // Restrictions: An mDNSRecordUpdateCallback may not make any mDNS API calls. |
---|
1078 | // The intent of this callback is to allow the client to free memory, if necessary. |
---|
1079 | // The internal data structures of the mDNS code may not be in a state where mDNS API calls may be made safely. |
---|
1080 | typedef void mDNSRecordUpdateCallback (mDNS *const m, AuthRecord *const rr, RData *OldRData, mDNSu16 OldRDLen); |
---|
1081 | |
---|
1082 | // *************************************************************************** |
---|
1083 | #if 0 |
---|
1084 | #pragma mark - |
---|
1085 | #pragma mark - NAT Traversal structures and constants |
---|
1086 | #endif |
---|
1087 | |
---|
1088 | #define NATMAP_MAX_RETRY_INTERVAL ((mDNSPlatformOneSecond * 60) * 15) // Max retry interval is 15 minutes |
---|
1089 | #define NATMAP_MIN_RETRY_INTERVAL (mDNSPlatformOneSecond * 2) // Min retry interval is 2 seconds |
---|
1090 | #define NATMAP_INIT_RETRY (mDNSPlatformOneSecond / 4) // start at 250ms w/ exponential decay |
---|
1091 | #define NATMAP_DEFAULT_LEASE (60 * 60 * 2) // 2 hour lease life in seconds |
---|
1092 | #define NATMAP_VERS 0 |
---|
1093 | |
---|
1094 | typedef enum |
---|
1095 | { |
---|
1096 | NATOp_AddrRequest = 0, |
---|
1097 | NATOp_MapUDP = 1, |
---|
1098 | NATOp_MapTCP = 2, |
---|
1099 | |
---|
1100 | NATOp_AddrResponse = 0x80 | 0, |
---|
1101 | NATOp_MapUDPResponse = 0x80 | 1, |
---|
1102 | NATOp_MapTCPResponse = 0x80 | 2, |
---|
1103 | } NATOp_t; |
---|
1104 | |
---|
1105 | enum |
---|
1106 | { |
---|
1107 | NATErr_None = 0, |
---|
1108 | NATErr_Vers = 1, |
---|
1109 | NATErr_Refused = 2, |
---|
1110 | NATErr_NetFail = 3, |
---|
1111 | NATErr_Res = 4, |
---|
1112 | NATErr_Opcode = 5 |
---|
1113 | }; |
---|
1114 | |
---|
1115 | typedef mDNSu16 NATErr_t; |
---|
1116 | |
---|
1117 | typedef packedstruct |
---|
1118 | { |
---|
1119 | mDNSu8 vers; |
---|
1120 | mDNSu8 opcode; |
---|
1121 | } NATAddrRequest; |
---|
1122 | |
---|
1123 | typedef packedstruct |
---|
1124 | { |
---|
1125 | mDNSu8 vers; |
---|
1126 | mDNSu8 opcode; |
---|
1127 | mDNSu16 err; |
---|
1128 | mDNSu32 upseconds; // Time since last NAT engine reboot, in seconds |
---|
1129 | mDNSv4Addr ExtAddr; |
---|
1130 | } NATAddrReply; |
---|
1131 | |
---|
1132 | typedef packedstruct |
---|
1133 | { |
---|
1134 | mDNSu8 vers; |
---|
1135 | mDNSu8 opcode; |
---|
1136 | mDNSOpaque16 unused; |
---|
1137 | mDNSIPPort intport; |
---|
1138 | mDNSIPPort extport; |
---|
1139 | mDNSu32 NATReq_lease; |
---|
1140 | } NATPortMapRequest; |
---|
1141 | |
---|
1142 | typedef packedstruct |
---|
1143 | { |
---|
1144 | mDNSu8 vers; |
---|
1145 | mDNSu8 opcode; |
---|
1146 | mDNSu16 err; |
---|
1147 | mDNSu32 upseconds; // Time since last NAT engine reboot, in seconds |
---|
1148 | mDNSIPPort intport; |
---|
1149 | mDNSIPPort extport; |
---|
1150 | mDNSu32 NATRep_lease; |
---|
1151 | } NATPortMapReply; |
---|
1152 | |
---|
1153 | // PCP Support for IPv4 mappings |
---|
1154 | |
---|
1155 | #define PCP_VERS 0x02 |
---|
1156 | #define PCP_WAITSECS_AFTER_EPOCH_INVALID 5 |
---|
1157 | |
---|
1158 | typedef enum |
---|
1159 | { |
---|
1160 | PCPOp_Announce = 0, |
---|
1161 | PCPOp_Map = 1 |
---|
1162 | } PCPOp_t; |
---|
1163 | |
---|
1164 | typedef enum |
---|
1165 | { |
---|
1166 | PCPProto_All = 0, |
---|
1167 | PCPProto_TCP = 6, |
---|
1168 | PCPProto_UDP = 17 |
---|
1169 | } PCPProto_t; |
---|
1170 | |
---|
1171 | typedef enum |
---|
1172 | { |
---|
1173 | PCPResult_Success = 0, |
---|
1174 | PCPResult_UnsuppVersion = 1, |
---|
1175 | PCPResult_NotAuthorized = 2, |
---|
1176 | PCPResult_MalformedReq = 3, |
---|
1177 | PCPResult_UnsuppOpcode = 4, |
---|
1178 | PCPResult_UnsuppOption = 5, |
---|
1179 | PCPResult_MalformedOption = 6, |
---|
1180 | PCPResult_NetworkFailure = 7, |
---|
1181 | PCPResult_NoResources = 8, |
---|
1182 | PCPResult_UnsuppProtocol = 9, |
---|
1183 | PCPResult_UserExQuota = 10, |
---|
1184 | PCPResult_CantProvideExt = 11, |
---|
1185 | PCPResult_AddrMismatch = 12, |
---|
1186 | PCPResult_ExcesRemotePeer = 13 |
---|
1187 | } PCPResult_t; |
---|
1188 | |
---|
1189 | typedef packedstruct |
---|
1190 | { |
---|
1191 | mDNSu8 version; |
---|
1192 | mDNSu8 opCode; |
---|
1193 | mDNSOpaque16 reserved; |
---|
1194 | mDNSu32 lifetime; |
---|
1195 | mDNSv6Addr clientAddr; |
---|
1196 | mDNSu32 nonce[3]; |
---|
1197 | mDNSu8 protocol; |
---|
1198 | mDNSu8 reservedMapOp[3]; |
---|
1199 | mDNSIPPort intPort; |
---|
1200 | mDNSIPPort extPort; |
---|
1201 | mDNSv6Addr extAddress; |
---|
1202 | } PCPMapRequest; |
---|
1203 | |
---|
1204 | typedef packedstruct |
---|
1205 | { |
---|
1206 | mDNSu8 version; |
---|
1207 | mDNSu8 opCode; |
---|
1208 | mDNSu8 reserved; |
---|
1209 | mDNSu8 result; |
---|
1210 | mDNSu32 lifetime; |
---|
1211 | mDNSu32 epoch; |
---|
1212 | mDNSu32 clientAddrParts[3]; |
---|
1213 | mDNSu32 nonce[3]; |
---|
1214 | mDNSu8 protocol; |
---|
1215 | mDNSu8 reservedMapOp[3]; |
---|
1216 | mDNSIPPort intPort; |
---|
1217 | mDNSIPPort extPort; |
---|
1218 | mDNSv6Addr extAddress; |
---|
1219 | } PCPMapReply; |
---|
1220 | |
---|
1221 | // LNT Support |
---|
1222 | |
---|
1223 | typedef enum |
---|
1224 | { |
---|
1225 | LNTDiscoveryOp = 1, |
---|
1226 | LNTExternalAddrOp = 2, |
---|
1227 | LNTPortMapOp = 3, |
---|
1228 | LNTPortMapDeleteOp = 4 |
---|
1229 | } LNTOp_t; |
---|
1230 | |
---|
1231 | #define LNT_MAXBUFSIZE 8192 |
---|
1232 | typedef struct tcpLNTInfo_struct tcpLNTInfo; |
---|
1233 | struct tcpLNTInfo_struct |
---|
1234 | { |
---|
1235 | tcpLNTInfo *next; |
---|
1236 | mDNS *m; |
---|
1237 | NATTraversalInfo *parentNATInfo; // pointer back to the parent NATTraversalInfo |
---|
1238 | TCPSocket *sock; |
---|
1239 | LNTOp_t op; // operation performed using this connection |
---|
1240 | mDNSAddr Address; // router address |
---|
1241 | mDNSIPPort Port; // router port |
---|
1242 | mDNSu8 *Request; // xml request to router |
---|
1243 | int requestLen; |
---|
1244 | mDNSu8 *Reply; // xml reply from router |
---|
1245 | int replyLen; |
---|
1246 | unsigned long nread; // number of bytes read so far |
---|
1247 | int retries; // number of times we've tried to do this port mapping |
---|
1248 | }; |
---|
1249 | |
---|
1250 | typedef void (*NATTraversalClientCallback)(mDNS *m, NATTraversalInfo *n); |
---|
1251 | |
---|
1252 | // if m->timenow < ExpiryTime then we have an active mapping, and we'll renew halfway to expiry |
---|
1253 | // if m->timenow >= ExpiryTime then our mapping has expired, and we're trying to create one |
---|
1254 | |
---|
1255 | typedef enum |
---|
1256 | { |
---|
1257 | NATTProtocolNone = 0, |
---|
1258 | NATTProtocolNATPMP = 1, |
---|
1259 | NATTProtocolUPNPIGD = 2, |
---|
1260 | NATTProtocolPCP = 3, |
---|
1261 | } NATTProtocol; |
---|
1262 | |
---|
1263 | struct NATTraversalInfo_struct |
---|
1264 | { |
---|
1265 | // Internal state fields. These are used internally by mDNSCore; the client layer needn't be concerned with them. |
---|
1266 | NATTraversalInfo *next; |
---|
1267 | |
---|
1268 | mDNSs32 ExpiryTime; // Time this mapping expires, or zero if no mapping |
---|
1269 | mDNSs32 retryInterval; // Current interval, between last packet we sent and the next one |
---|
1270 | mDNSs32 retryPortMap; // If Protocol is nonzero, time to send our next mapping packet |
---|
1271 | mStatus NewResult; // New error code; will be copied to Result just prior to invoking callback |
---|
1272 | NATTProtocol lastSuccessfulProtocol; // To send correct deletion request & update non-PCP external address operations |
---|
1273 | mDNSBool sentNATPMP; // Whether we just sent a NAT-PMP packet, so we won't send another if |
---|
1274 | // we receive another NAT-PMP "Unsupported Version" packet |
---|
1275 | |
---|
1276 | #ifdef _LEGACY_NAT_TRAVERSAL_ |
---|
1277 | tcpLNTInfo tcpInfo; // Legacy NAT traversal (UPnP) TCP connection |
---|
1278 | #endif |
---|
1279 | |
---|
1280 | // Result fields: When the callback is invoked these fields contain the answers the client is looking for |
---|
1281 | // When the callback is invoked ExternalPort is *usually* set to be the same the same as RequestedPort, except: |
---|
1282 | // (a) When we're behind a NAT gateway with port mapping disabled, ExternalPort is reported as zero to |
---|
1283 | // indicate that we don't currently have a working mapping (but RequestedPort retains the external port |
---|
1284 | // we'd like to get, the next time we meet an accomodating NAT gateway willing to give us one). |
---|
1285 | // (b) When we have a routable non-RFC1918 address, we don't *need* a port mapping, so ExternalPort |
---|
1286 | // is reported as the same as our InternalPort, since that is effectively our externally-visible port too. |
---|
1287 | // Again, RequestedPort retains the external port we'd like to get the next time we find ourself behind a NAT gateway. |
---|
1288 | // To improve stability of port mappings, RequestedPort is updated any time we get a successful |
---|
1289 | // mapping response from the PCP, NAT-PMP or UPnP gateway. For example, if we ask for port 80, and |
---|
1290 | // get assigned port 81, then thereafter we'll contine asking for port 81. |
---|
1291 | mDNSInterfaceID InterfaceID; |
---|
1292 | mDNSv4Addr ExternalAddress; // Initially set to onesIPv4Addr, until first callback |
---|
1293 | mDNSv4Addr NewAddress; // May be updated with actual value assigned by gateway |
---|
1294 | mDNSIPPort ExternalPort; |
---|
1295 | mDNSu32 Lifetime; |
---|
1296 | mStatus Result; |
---|
1297 | |
---|
1298 | // Client API fields: The client must set up these fields *before* making any NAT traversal API calls |
---|
1299 | mDNSu8 Protocol; // NATOp_MapUDP or NATOp_MapTCP, or zero if just requesting the external IP address |
---|
1300 | mDNSIPPort IntPort; // Client's internal port number (doesn't change) |
---|
1301 | mDNSIPPort RequestedPort; // Requested external port; may be updated with actual value assigned by gateway |
---|
1302 | mDNSu32 NATLease; // Requested lifetime in seconds (doesn't change) |
---|
1303 | NATTraversalClientCallback clientCallback; |
---|
1304 | void *clientContext; |
---|
1305 | }; |
---|
1306 | |
---|
1307 | // *************************************************************************** |
---|
1308 | #if 0 |
---|
1309 | #pragma mark - |
---|
1310 | #pragma mark - DNSServer & McastResolver structures and constants |
---|
1311 | #endif |
---|
1312 | |
---|
1313 | enum |
---|
1314 | { |
---|
1315 | DNSServer_Untested = 0, |
---|
1316 | DNSServer_Passed = 1, |
---|
1317 | DNSServer_Failed = 2, |
---|
1318 | DNSServer_Disabled = 3 |
---|
1319 | }; |
---|
1320 | |
---|
1321 | enum |
---|
1322 | { |
---|
1323 | DNSServer_FlagDelete = 1, |
---|
1324 | DNSServer_FlagNew = 2 |
---|
1325 | }; |
---|
1326 | |
---|
1327 | enum |
---|
1328 | { |
---|
1329 | McastResolver_FlagDelete = 1, |
---|
1330 | McastResolver_FlagNew = 2 |
---|
1331 | }; |
---|
1332 | |
---|
1333 | typedef struct McastResolver |
---|
1334 | { |
---|
1335 | struct McastResolver *next; |
---|
1336 | mDNSInterfaceID interface; |
---|
1337 | mDNSu32 flags; // Set when we're planning to delete this from the list |
---|
1338 | domainname domain; |
---|
1339 | mDNSu32 timeout; // timeout value for questions |
---|
1340 | } McastResolver; |
---|
1341 | |
---|
1342 | // scoped values for DNSServer matching |
---|
1343 | enum |
---|
1344 | { |
---|
1345 | kScopeNone = 0, // DNS server used by unscoped questions |
---|
1346 | kScopeInterfaceID = 1, // Scoped DNS server used only by scoped questions |
---|
1347 | kScopeServiceID = 2 // Service specific DNS server used only by questions |
---|
1348 | // have a matching serviceID |
---|
1349 | }; |
---|
1350 | |
---|
1351 | // Note: DNSSECAware is set if we are able to get a valid response to |
---|
1352 | // a DNSSEC question. In some cases it is possible that the proxy |
---|
1353 | // strips the EDNS0 option and we just get a plain response with no |
---|
1354 | // signatures. But we still mark DNSSECAware in that case. As DNSSECAware |
---|
1355 | // is only used to determine whether DNSSEC_VALIDATION_SECURE_OPTIONAL |
---|
1356 | // should be turned off or not, it is sufficient that we are getting |
---|
1357 | // responses back. |
---|
1358 | typedef struct DNSServer |
---|
1359 | { |
---|
1360 | struct DNSServer *next; |
---|
1361 | mDNSInterfaceID interface; // DNS requests should be sent on this interface |
---|
1362 | mDNSs32 serviceID; |
---|
1363 | mDNSAddr addr; |
---|
1364 | mDNSIPPort port; |
---|
1365 | mDNSOpaque16 testid; |
---|
1366 | mDNSu32 flags; // Set when we're planning to delete this from the list |
---|
1367 | mDNSu32 teststate; // Have we sent bug-detection query to this server? |
---|
1368 | mDNSs32 lasttest; // Time we sent last bug-detection query to this server |
---|
1369 | domainname domain; // name->server matching for "split dns" |
---|
1370 | mDNSs32 penaltyTime; // amount of time this server is penalized |
---|
1371 | mDNSu32 scoped; // See the scoped enum above |
---|
1372 | mDNSu32 timeout; // timeout value for questions |
---|
1373 | mDNSBool cellIntf; // Resolver from Cellular Interface ? |
---|
1374 | mDNSu16 resGroupID; // ID of the resolver group that contains this DNSServer |
---|
1375 | mDNSBool req_A; // If set, send v4 query (DNSConfig allows A queries) |
---|
1376 | mDNSBool req_AAAA; // If set, send v6 query (DNSConfig allows AAAA queries) |
---|
1377 | mDNSBool req_DO; // If set, okay to send DNSSEC queries (EDNS DO bit is supported) |
---|
1378 | mDNSBool retransDO; // Total Retransmissions for queries sent with DO option |
---|
1379 | mDNSBool DNSSECAware; // set if we are able to receive a response to a request |
---|
1380 | // sent with DO option. |
---|
1381 | } DNSServer; |
---|
1382 | |
---|
1383 | typedef struct |
---|
1384 | { |
---|
1385 | mDNSu8 *AnonData; |
---|
1386 | int AnonDataLen; |
---|
1387 | mDNSu32 salt; |
---|
1388 | ResourceRecord *nsec3RR; |
---|
1389 | mDNSInterfaceID SendNow; // The interface ID that this record should be sent on |
---|
1390 | } AnonymousInfo; |
---|
1391 | |
---|
1392 | struct ResourceRecord_struct |
---|
1393 | { |
---|
1394 | mDNSu8 RecordType; // See enum above |
---|
1395 | mDNSu16 rrtype; |
---|
1396 | mDNSu16 rrclass; |
---|
1397 | mDNSu32 rroriginalttl; // In seconds |
---|
1398 | mDNSu16 rdlength; // Size of the raw rdata, in bytes, in the on-the-wire format |
---|
1399 | // (In-memory storage may be larger, for structures containing 'holes', like SOA) |
---|
1400 | mDNSu16 rdestimate; // Upper bound on on-the-wire size of rdata after name compression |
---|
1401 | mDNSu32 namehash; // Name-based (i.e. case-insensitive) hash of name |
---|
1402 | mDNSu32 rdatahash; // For rdata containing domain name (e.g. PTR, SRV, CNAME etc.), case-insensitive name hash |
---|
1403 | // else, for all other rdata, 32-bit hash of the raw rdata |
---|
1404 | // Note: This requirement is important. Various routines like AddAdditionalsToResponseList(), |
---|
1405 | // ReconfirmAntecedents(), etc., use rdatahash as a pre-flight check to see |
---|
1406 | // whether it's worth doing a full SameDomainName() call. If the rdatahash |
---|
1407 | // is not a correct case-insensitive name hash, they'll get false negatives. |
---|
1408 | |
---|
1409 | // Grouping pointers together at the end of the structure improves the memory layout efficiency |
---|
1410 | mDNSInterfaceID InterfaceID; // Set if this RR is specific to one interface |
---|
1411 | // For records received off the wire, InterfaceID is *always* set to the receiving interface |
---|
1412 | // For our authoritative records, InterfaceID is usually zero, except for those few records |
---|
1413 | // that are interface-specific (e.g. address records, especially linklocal addresses) |
---|
1414 | const domainname *name; |
---|
1415 | RData *rdata; // Pointer to storage for this rdata |
---|
1416 | DNSServer *rDNSServer; // Unicast DNS server authoritative for this entry;null for multicast |
---|
1417 | AnonymousInfo *AnonInfo; // Anonymous Information |
---|
1418 | }; |
---|
1419 | |
---|
1420 | |
---|
1421 | // Unless otherwise noted, states may apply to either independent record registrations or service registrations |
---|
1422 | typedef enum |
---|
1423 | { |
---|
1424 | regState_Zero = 0, |
---|
1425 | regState_Pending = 1, // update sent, reply not received |
---|
1426 | regState_Registered = 2, // update sent, reply received |
---|
1427 | regState_DeregPending = 3, // dereg sent, reply not received |
---|
1428 | regState_Unregistered = 4, // not in any list |
---|
1429 | regState_Refresh = 5, // outstanding refresh (or target change) message |
---|
1430 | regState_NATMap = 6, // establishing NAT port mapping |
---|
1431 | regState_UpdatePending = 7, // update in flight as result of mDNS_Update call |
---|
1432 | regState_NoTarget = 8, // SRV Record registration pending registration of hostname |
---|
1433 | regState_NATError = 9 // unable to complete NAT traversal |
---|
1434 | } regState_t; |
---|
1435 | |
---|
1436 | enum |
---|
1437 | { |
---|
1438 | Target_Manual = 0, |
---|
1439 | Target_AutoHost = 1, |
---|
1440 | Target_AutoHostAndNATMAP = 2 |
---|
1441 | }; |
---|
1442 | |
---|
1443 | typedef enum |
---|
1444 | { |
---|
1445 | mergeState_Zero = 0, |
---|
1446 | mergeState_DontMerge = 1 // Set on fatal error conditions to disable merging |
---|
1447 | } mergeState_t; |
---|
1448 | |
---|
1449 | #define AUTH_GROUP_NAME_SIZE 128 |
---|
1450 | struct AuthGroup_struct // Header object for a list of AuthRecords with the same name |
---|
1451 | { |
---|
1452 | AuthGroup *next; // Next AuthGroup object in this hash table bucket |
---|
1453 | mDNSu32 namehash; // Name-based (i.e. case insensitive) hash of name |
---|
1454 | AuthRecord *members; // List of CacheRecords with this same name |
---|
1455 | AuthRecord **rrauth_tail; // Tail end of that list |
---|
1456 | domainname *name; // Common name for all AuthRecords in this list |
---|
1457 | AuthRecord *NewLocalOnlyRecords; |
---|
1458 | mDNSu8 namestorage[AUTH_GROUP_NAME_SIZE]; |
---|
1459 | }; |
---|
1460 | |
---|
1461 | #ifndef AUTH_HASH_SLOTS |
---|
1462 | #define AUTH_HASH_SLOTS 499 |
---|
1463 | #endif |
---|
1464 | #define FORALL_AUTHRECORDS(SLOT,AG,AR) \ |
---|
1465 | for ((SLOT) = 0; (SLOT) < AUTH_HASH_SLOTS; (SLOT)++) \ |
---|
1466 | for ((AG)=m->rrauth.rrauth_hash[(SLOT)]; (AG); (AG)=(AG)->next) \ |
---|
1467 | for ((AR) = (AG)->members; (AR); (AR)=(AR)->next) |
---|
1468 | |
---|
1469 | typedef union AuthEntity_union AuthEntity; |
---|
1470 | union AuthEntity_union { AuthEntity *next; AuthGroup ag; }; |
---|
1471 | typedef struct { |
---|
1472 | mDNSu32 rrauth_size; // Total number of available auth entries |
---|
1473 | mDNSu32 rrauth_totalused; // Number of auth entries currently occupied |
---|
1474 | mDNSu32 rrauth_report; |
---|
1475 | mDNSu8 rrauth_lock; // For debugging: Set at times when these lists may not be modified |
---|
1476 | AuthEntity *rrauth_free; |
---|
1477 | AuthGroup *rrauth_hash[AUTH_HASH_SLOTS]; |
---|
1478 | }AuthHash; |
---|
1479 | |
---|
1480 | // AuthRecordAny includes mDNSInterface_Any and interface specific auth records. |
---|
1481 | typedef enum |
---|
1482 | { |
---|
1483 | AuthRecordAny, // registered for *Any, NOT including P2P interfaces |
---|
1484 | AuthRecordAnyIncludeP2P, // registered for *Any, including P2P interfaces |
---|
1485 | AuthRecordAnyIncludeAWDL, // registered for *Any, including AWDL interface |
---|
1486 | AuthRecordAnyIncludeAWDLandP2P, // registered for *Any, including AWDL and P2P interfaces |
---|
1487 | AuthRecordLocalOnly, |
---|
1488 | AuthRecordP2P // discovered over D2D/P2P framework |
---|
1489 | } AuthRecType; |
---|
1490 | |
---|
1491 | typedef enum |
---|
1492 | { |
---|
1493 | AuthFlagsWakeOnly = 0x1 // WakeOnly service |
---|
1494 | } AuthRecordFlags; |
---|
1495 | |
---|
1496 | struct AuthRecord_struct |
---|
1497 | { |
---|
1498 | // For examples of how to set up this structure for use in mDNS_Register(), |
---|
1499 | // see mDNS_AdvertiseInterface() or mDNS_RegisterService(). |
---|
1500 | // Basically, resrec and persistent metadata need to be set up before calling mDNS_Register(). |
---|
1501 | // mDNS_SetupResourceRecord() is avaliable as a helper routine to set up most fields to sensible default values for you |
---|
1502 | |
---|
1503 | AuthRecord *next; // Next in list; first element of structure for efficiency reasons |
---|
1504 | // Field Group 1: Common ResourceRecord fields |
---|
1505 | ResourceRecord resrec; // 36 bytes when compiling for 32-bit; 48 when compiling for 64-bit |
---|
1506 | |
---|
1507 | // Field Group 2: Persistent metadata for Authoritative Records |
---|
1508 | AuthRecord *Additional1; // Recommended additional record to include in response (e.g. SRV for PTR record) |
---|
1509 | AuthRecord *Additional2; // Another additional (e.g. TXT for PTR record) |
---|
1510 | AuthRecord *DependentOn; // This record depends on another for its uniqueness checking |
---|
1511 | AuthRecord *RRSet; // This unique record is part of an RRSet |
---|
1512 | mDNSRecordCallback *RecordCallback; // Callback function to call for state changes, and to free memory asynchronously on deregistration |
---|
1513 | void *RecordContext; // Context parameter for the callback function |
---|
1514 | mDNSu8 AutoTarget; // Set if the target of this record (PTR, CNAME, SRV, etc.) is our host name |
---|
1515 | mDNSu8 AllowRemoteQuery; // Set if we allow hosts not on the local link to query this record |
---|
1516 | mDNSu8 ForceMCast; // Set by client to advertise solely via multicast, even for apparently unicast names |
---|
1517 | mDNSu8 AuthFlags; |
---|
1518 | |
---|
1519 | OwnerOptData WakeUp; // WakeUp.HMAC.l[0] nonzero indicates that this is a Sleep Proxy record |
---|
1520 | mDNSAddr AddressProxy; // For reverse-mapping Sleep Proxy PTR records, address in question |
---|
1521 | mDNSs32 TimeRcvd; // In platform time units |
---|
1522 | mDNSs32 TimeExpire; // In platform time units |
---|
1523 | AuthRecType ARType; // LocalOnly, P2P or Normal ? |
---|
1524 | mDNSs32 KATimeExpire; // In platform time units: time to send keepalive packet for the proxy record |
---|
1525 | |
---|
1526 | // Field Group 3: Transient state for Authoritative Records |
---|
1527 | mDNSu8 Acknowledged; // Set if we've given the success callback to the client |
---|
1528 | mDNSu8 ProbeRestartCount; // Number of times we have restarted probing |
---|
1529 | mDNSu8 ProbeCount; // Number of probes remaining before this record is valid (kDNSRecordTypeUnique) |
---|
1530 | mDNSu8 AnnounceCount; // Number of announcements remaining (kDNSRecordTypeShared) |
---|
1531 | mDNSu8 RequireGoodbye; // Set if this RR has been announced on the wire and will require a goodbye packet |
---|
1532 | mDNSu8 AnsweredLocalQ; // Set if this AuthRecord has been delivered to any local question (LocalOnly or mDNSInterface_Any) |
---|
1533 | mDNSu8 IncludeInProbe; // Set if this RR is being put into a probe right now |
---|
1534 | mDNSu8 ImmedUnicast; // Set if we may send our response directly via unicast to the requester |
---|
1535 | mDNSInterfaceID SendNSECNow; // Set if we need to generate associated NSEC data for this rrname |
---|
1536 | mDNSInterfaceID ImmedAnswer; // Someone on this interface issued a query we need to answer (all-ones for all interfaces) |
---|
1537 | #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES |
---|
1538 | mDNSs32 ImmedAnswerMarkTime; |
---|
1539 | #endif |
---|
1540 | mDNSInterfaceID ImmedAdditional; // Hint that we might want to also send this record, just to be helpful |
---|
1541 | mDNSInterfaceID SendRNow; // The interface this query is being sent on right now |
---|
1542 | mDNSv4Addr v4Requester; // Recent v4 query for this record, or all-ones if more than one recent query |
---|
1543 | mDNSv6Addr v6Requester; // Recent v6 query for this record, or all-ones if more than one recent query |
---|
1544 | AuthRecord *NextResponse; // Link to the next element in the chain of responses to generate |
---|
1545 | const mDNSu8 *NR_AnswerTo; // Set if this record was selected by virtue of being a direct answer to a question |
---|
1546 | AuthRecord *NR_AdditionalTo; // Set if this record was selected by virtue of being additional to another |
---|
1547 | mDNSs32 ThisAPInterval; // In platform time units: Current interval for announce/probe |
---|
1548 | mDNSs32 LastAPTime; // In platform time units: Last time we sent announcement/probe |
---|
1549 | mDNSs32 LastMCTime; // Last time we multicast this record (used to guard against packet-storm attacks) |
---|
1550 | mDNSInterfaceID LastMCInterface; // Interface this record was multicast on at the time LastMCTime was recorded |
---|
1551 | RData *NewRData; // Set if we are updating this record with new rdata |
---|
1552 | mDNSu16 newrdlength; // ... and the length of the new RData |
---|
1553 | mDNSRecordUpdateCallback *UpdateCallback; |
---|
1554 | mDNSu32 UpdateCredits; // Token-bucket rate limiting of excessive updates |
---|
1555 | mDNSs32 NextUpdateCredit; // Time next token is added to bucket |
---|
1556 | mDNSs32 UpdateBlocked; // Set if update delaying is in effect |
---|
1557 | |
---|
1558 | // Field Group 4: Transient uDNS state for Authoritative Records |
---|
1559 | regState_t state; // Maybe combine this with resrec.RecordType state? Right now it's ambiguous and confusing. |
---|
1560 | // e.g. rr->resrec.RecordType can be kDNSRecordTypeUnregistered, |
---|
1561 | // and rr->state can be regState_Unregistered |
---|
1562 | // What if we find one of those statements is true and the other false? What does that mean? |
---|
1563 | mDNSBool uselease; // dynamic update contains (should contain) lease option |
---|
1564 | mDNSs32 expire; // In platform time units: expiration of lease (-1 for static) |
---|
1565 | mDNSBool Private; // If zone is private, DNS updates may have to be encrypted to prevent eavesdropping |
---|
1566 | mDNSOpaque16 updateid; // Identifier to match update request and response -- also used when transferring records to Sleep Proxy |
---|
1567 | mDNSOpaque64 updateIntID; // Interface IDs (one bit per interface index)to which updates have been sent |
---|
1568 | const domainname *zone; // the zone that is updated |
---|
1569 | ZoneData *nta; |
---|
1570 | struct tcpInfo_t *tcp; |
---|
1571 | NATTraversalInfo NATinfo; |
---|
1572 | mDNSBool SRVChanged; // temporarily deregistered service because its SRV target or port changed |
---|
1573 | mergeState_t mState; // Unicast Record Registrations merge state |
---|
1574 | mDNSu8 refreshCount; // Number of refreshes to the server |
---|
1575 | mStatus updateError; // Record update resulted in Error ? |
---|
1576 | |
---|
1577 | // uDNS_UpdateRecord support fields |
---|
1578 | // Do we really need all these in *addition* to NewRData and newrdlength above? |
---|
1579 | void *UpdateContext; // Context parameter for the update callback function |
---|
1580 | mDNSu16 OrigRDLen; // previously registered, being deleted |
---|
1581 | mDNSu16 InFlightRDLen; // currently being registered |
---|
1582 | mDNSu16 QueuedRDLen; // pending operation (re-transmitting if necessary) THEN register the queued update |
---|
1583 | RData *OrigRData; |
---|
1584 | RData *InFlightRData; |
---|
1585 | RData *QueuedRData; |
---|
1586 | |
---|
1587 | // Field Group 5: Large data objects go at the end |
---|
1588 | domainname namestorage; |
---|
1589 | RData rdatastorage; // Normally the storage is right here, except for oversized records |
---|
1590 | // rdatastorage MUST be the last thing in the structure -- when using oversized AuthRecords, extra bytes |
---|
1591 | // are appended after the end of the AuthRecord, logically augmenting the size of the rdatastorage |
---|
1592 | // DO NOT ADD ANY MORE FIELDS HERE |
---|
1593 | }; |
---|
1594 | |
---|
1595 | // IsLocalDomain alone is not sufficient to determine that a record is mDNS or uDNS. By default domain names within |
---|
1596 | // the "local" pseudo-TLD (and within the IPv4 and IPv6 link-local reverse mapping domains) are automatically treated |
---|
1597 | // as mDNS records, but it is also possible to force any record (even those not within one of the inherently local |
---|
1598 | // domains) to be handled as an mDNS record by setting the ForceMCast flag, or by setting a non-zero InterfaceID. |
---|
1599 | // For example, the reverse-mapping PTR record created in AdvertiseInterface sets the ForceMCast flag, since it points to |
---|
1600 | // a dot-local hostname, and therefore it would make no sense to register this record with a wide-area Unicast DNS server. |
---|
1601 | // The same applies to Sleep Proxy records, which we will answer for when queried via mDNS, but we never want to try |
---|
1602 | // to register them with a wide-area Unicast DNS server -- and we probably don't have the required credentials anyway. |
---|
1603 | // Currently we have no concept of a wide-area uDNS record scoped to a particular interface, so if the InterfaceID is |
---|
1604 | // nonzero we treat this the same as ForceMCast. |
---|
1605 | // Note: Question_uDNS(Q) is used in *only* one place -- on entry to mDNS_StartQuery_internal, to decide whether to set TargetQID. |
---|
1606 | // Everywhere else in the code, the determination of whether a question is unicast is made by checking to see if TargetQID is nonzero. |
---|
1607 | #define AuthRecord_uDNS(R) ((R)->resrec.InterfaceID == mDNSInterface_Any && !(R)->ForceMCast && !IsLocalDomain((R)->resrec.name)) |
---|
1608 | #define Question_uDNS(Q) ((Q)->InterfaceID == mDNSInterface_Unicast || (Q)->ProxyQuestion || \ |
---|
1609 | ((Q)->InterfaceID != mDNSInterface_LocalOnly && (Q)->InterfaceID != mDNSInterface_P2P && !(Q)->ForceMCast && !IsLocalDomain(&(Q)->qname))) |
---|
1610 | |
---|
1611 | #define RRLocalOnly(rr) ((rr)->ARType == AuthRecordLocalOnly || (rr)->ARType == AuthRecordP2P) |
---|
1612 | |
---|
1613 | #define RRAny(rr) ((rr)->ARType == AuthRecordAny || (rr)->ARType == AuthRecordAnyIncludeP2P || (rr)->ARType == AuthRecordAnyIncludeAWDL || (rr)->ARType == AuthRecordAnyIncludeAWDLandP2P) |
---|
1614 | |
---|
1615 | // Question (A or AAAA) that is suppressed currently because IPv4 or IPv6 address |
---|
1616 | // is not available locally for A or AAAA question respectively. Also, if the |
---|
1617 | // query is disallowed for the "pid" that we are sending on behalf of, suppress it. |
---|
1618 | #define QuerySuppressed(Q) (((Q)->SuppressUnusable && (Q)->SuppressQuery) || ((Q)->DisallowPID)) |
---|
1619 | |
---|
1620 | #define PrivateQuery(Q) ((Q)->AuthInfo && (Q)->AuthInfo->AutoTunnel) |
---|
1621 | |
---|
1622 | // Normally we always lookup the cache and /etc/hosts before sending the query on the wire. For single label |
---|
1623 | // queries (A and AAAA) that are unqualified (indicated by AppendSearchDomains), we want to append search |
---|
1624 | // domains before we try them as such |
---|
1625 | #define ApplySearchDomainsFirst(q) ((q)->AppendSearchDomains && (CountLabels(&((q)->qname))) == 1) |
---|
1626 | |
---|
1627 | // Wrapper struct for Auth Records for higher-level code that cannot use the AuthRecord's ->next pointer field |
---|
1628 | typedef struct ARListElem |
---|
1629 | { |
---|
1630 | struct ARListElem *next; |
---|
1631 | AuthRecord ar; // Note: Must be last element of structure, to accomodate oversized AuthRecords |
---|
1632 | } ARListElem; |
---|
1633 | |
---|
1634 | struct CacheRecord_struct |
---|
1635 | { |
---|
1636 | CacheRecord *next; // Next in list; first element of structure for efficiency reasons |
---|
1637 | ResourceRecord resrec; // 36 bytes when compiling for 32-bit; 48 when compiling for 64-bit |
---|
1638 | |
---|
1639 | // Transient state for Cache Records |
---|
1640 | CacheRecord *NextInKAList; // Link to the next element in the chain of known answers to send |
---|
1641 | mDNSs32 TimeRcvd; // In platform time units |
---|
1642 | mDNSs32 DelayDelivery; // Set if we want to defer delivery of this answer to local clients |
---|
1643 | mDNSs32 NextRequiredQuery; // In platform time units |
---|
1644 | mDNSs32 LastUsed; // In platform time units |
---|
1645 | DNSQuestion *CRActiveQuestion; // Points to an active question referencing this answer. Can never point to a NewQuestion. |
---|
1646 | mDNSs32 LastUnansweredTime; // In platform time units; last time we incremented UnansweredQueries |
---|
1647 | mDNSu8 UnansweredQueries; // Number of times we've issued a query for this record without getting an answer |
---|
1648 | mDNSu8 CRDNSSECQuestion; // Set to 1 if this was created in response to a DNSSEC question |
---|
1649 | mDNSOpaque16 responseFlags; // Second 16 bit in the DNS response |
---|
1650 | #if ENABLE_MULTI_PACKET_QUERY_SNOOPING |
---|
1651 | mDNSu32 MPUnansweredQ; // Multi-packet query handling: Number of times we've seen a query for this record |
---|
1652 | mDNSs32 MPLastUnansweredQT; // Multi-packet query handling: Last time we incremented MPUnansweredQ |
---|
1653 | mDNSu32 MPUnansweredKA; // Multi-packet query handling: Number of times we've seen this record in a KA list |
---|
1654 | mDNSBool MPExpectingKA; // Multi-packet query handling: Set when we increment MPUnansweredQ; allows one KA |
---|
1655 | #endif |
---|
1656 | CacheRecord *NextInCFList; // Set if this is in the list of records we just received with the cache flush bit set |
---|
1657 | CacheRecord *nsec; // NSEC records needed for non-existence proofs |
---|
1658 | CacheRecord *soa; // SOA record to return for proxy questions |
---|
1659 | |
---|
1660 | mDNSAddr sourceAddress; // node from which we received this record |
---|
1661 | // Size to here is 76 bytes when compiling 32-bit; 104 bytes when compiling 64-bit |
---|
1662 | RData_small smallrdatastorage; // Storage for small records is right here (4 bytes header + 68 bytes data = 72 bytes) |
---|
1663 | }; |
---|
1664 | |
---|
1665 | // Should match the CacheGroup_struct members, except namestorage[]. Only used to calculate |
---|
1666 | // the size of the namestorage array in CacheGroup_struct so that |
---|
1667 | // sizeof(CacheGroup) == sizeof(CacheRecord) |
---|
1668 | struct CacheGroup_base |
---|
1669 | { |
---|
1670 | CacheGroup *next; |
---|
1671 | mDNSu32 namehash; |
---|
1672 | CacheRecord *members; |
---|
1673 | CacheRecord **rrcache_tail; |
---|
1674 | domainname *name; |
---|
1675 | }; |
---|
1676 | |
---|
1677 | struct CacheGroup_struct // Header object for a list of CacheRecords with the same name |
---|
1678 | { |
---|
1679 | CacheGroup *next; // Next CacheGroup object in this hash table bucket |
---|
1680 | mDNSu32 namehash; // Name-based (i.e. case insensitive) hash of name |
---|
1681 | CacheRecord *members; // List of CacheRecords with this same name |
---|
1682 | CacheRecord **rrcache_tail; // Tail end of that list |
---|
1683 | domainname *name; // Common name for all CacheRecords in this list |
---|
1684 | mDNSu8 namestorage[sizeof(CacheRecord) - sizeof(struct CacheGroup_base)]; // match sizeof(CacheRecord) |
---|
1685 | }; |
---|
1686 | |
---|
1687 | // Storage sufficient to hold either a CacheGroup header or a CacheRecord |
---|
1688 | // -- for best efficiency (to avoid wasted unused storage) they should be the same size |
---|
1689 | typedef union CacheEntity_union CacheEntity; |
---|
1690 | union CacheEntity_union { CacheEntity *next; CacheGroup cg; CacheRecord cr; }; |
---|
1691 | |
---|
1692 | typedef struct |
---|
1693 | { |
---|
1694 | CacheRecord r; |
---|
1695 | mDNSu8 _extradata[MaximumRDSize-InlineCacheRDSize]; // Glue on the necessary number of extra bytes |
---|
1696 | domainname namestorage; // Needs to go *after* the extra rdata bytes |
---|
1697 | } LargeCacheRecord; |
---|
1698 | |
---|
1699 | typedef struct HostnameInfo |
---|
1700 | { |
---|
1701 | struct HostnameInfo *next; |
---|
1702 | NATTraversalInfo natinfo; |
---|
1703 | domainname fqdn; |
---|
1704 | AuthRecord arv4; // registered IPv4 address record |
---|
1705 | AuthRecord arv6; // registered IPv6 address record |
---|
1706 | mDNSRecordCallback *StatusCallback; // callback to deliver success or error code to client layer |
---|
1707 | const void *StatusContext; // Client Context |
---|
1708 | } HostnameInfo; |
---|
1709 | |
---|
1710 | typedef struct ExtraResourceRecord_struct ExtraResourceRecord; |
---|
1711 | struct ExtraResourceRecord_struct |
---|
1712 | { |
---|
1713 | ExtraResourceRecord *next; |
---|
1714 | mDNSu32 ClientID; // Opaque ID field to be used by client to map an AddRecord call to a set of Extra records |
---|
1715 | AuthRecord r; |
---|
1716 | // Note: Add any additional fields *before* the AuthRecord in this structure, not at the end. |
---|
1717 | // In some cases clients can allocate larger chunks of memory and set r->rdata->MaxRDLength to indicate |
---|
1718 | // that this extra memory is available, which would result in any fields after the AuthRecord getting smashed |
---|
1719 | }; |
---|
1720 | |
---|
1721 | // Note: Within an mDNSServiceCallback mDNS all API calls are legal except mDNS_Init(), mDNS_Exit(), mDNS_Execute() |
---|
1722 | typedef void mDNSServiceCallback (mDNS *const m, ServiceRecordSet *const sr, mStatus result); |
---|
1723 | |
---|
1724 | // A ServiceRecordSet has no special meaning to the core code of the Multicast DNS protocol engine; |
---|
1725 | // it is just a convenience structure to group together the records that make up a standard service |
---|
1726 | // registration so that they can be allocted and deallocted together as a single memory object. |
---|
1727 | // It contains its own ServiceCallback+ServiceContext to report aggregate results up to the next layer of software above. |
---|
1728 | // It also contains: |
---|
1729 | // * the basic PTR/SRV/TXT triplet used to represent any DNS-SD service |
---|
1730 | // * the "_services" PTR record for service enumeration |
---|
1731 | // * the optional list of SubType PTR records |
---|
1732 | // * the optional list of additional records attached to the service set (e.g. iChat pictures) |
---|
1733 | |
---|
1734 | struct ServiceRecordSet_struct |
---|
1735 | { |
---|
1736 | // These internal state fields are used internally by mDNSCore; the client layer needn't be concerned with them. |
---|
1737 | // No fields need to be set up by the client prior to calling mDNS_RegisterService(); |
---|
1738 | // all required data is passed as parameters to that function. |
---|
1739 | mDNSServiceCallback *ServiceCallback; |
---|
1740 | void *ServiceContext; |
---|
1741 | mDNSBool Conflict; // Set if this record set was forcibly deregistered because of a conflict |
---|
1742 | |
---|
1743 | ExtraResourceRecord *Extras; // Optional list of extra AuthRecords attached to this service registration |
---|
1744 | mDNSu32 NumSubTypes; |
---|
1745 | AuthRecord *SubTypes; |
---|
1746 | const mDNSu8 *AnonData; |
---|
1747 | mDNSu32 flags; // saved for subsequent calls to mDNS_RegisterService() if records |
---|
1748 | // need to be re-registered. |
---|
1749 | AuthRecord RR_ADV; // e.g. _services._dns-sd._udp.local. PTR _printer._tcp.local. |
---|
1750 | AuthRecord RR_PTR; // e.g. _printer._tcp.local. PTR Name._printer._tcp.local. |
---|
1751 | AuthRecord RR_SRV; // e.g. Name._printer._tcp.local. SRV 0 0 port target |
---|
1752 | AuthRecord RR_TXT; // e.g. Name._printer._tcp.local. TXT PrintQueueName |
---|
1753 | // Don't add any fields after AuthRecord RR_TXT. |
---|
1754 | // This is where the implicit extra space goes if we allocate a ServiceRecordSet containing an oversized RR_TXT record |
---|
1755 | }; |
---|
1756 | |
---|
1757 | // *************************************************************************** |
---|
1758 | #if 0 |
---|
1759 | #pragma mark - |
---|
1760 | #pragma mark - Question structures |
---|
1761 | #endif |
---|
1762 | |
---|
1763 | // We record the last eight instances of each duplicate query |
---|
1764 | // This gives us v4/v6 on each of Ethernet, AirPort and Firewire, and two free slots "for future expansion" |
---|
1765 | // If the host has more active interfaces that this it is not fatal -- duplicate question suppression will degrade gracefully. |
---|
1766 | // Since we will still remember the last eight, the busiest interfaces will still get the effective duplicate question suppression. |
---|
1767 | #define DupSuppressInfoSize 8 |
---|
1768 | |
---|
1769 | typedef struct |
---|
1770 | { |
---|
1771 | mDNSs32 Time; |
---|
1772 | mDNSInterfaceID InterfaceID; |
---|
1773 | mDNSs32 Type; // v4 or v6? |
---|
1774 | } DupSuppressInfo; |
---|
1775 | |
---|
1776 | typedef enum |
---|
1777 | { |
---|
1778 | LLQ_InitialRequest = 1, |
---|
1779 | LLQ_SecondaryRequest = 2, |
---|
1780 | LLQ_Established = 3, |
---|
1781 | LLQ_Poll = 4 |
---|
1782 | } LLQ_State; |
---|
1783 | |
---|
1784 | // LLQ constants |
---|
1785 | #define kLLQ_Vers 1 |
---|
1786 | #define kLLQ_DefLease 7200 // 2 hours |
---|
1787 | #define kLLQ_MAX_TRIES 3 // retry an operation 3 times max |
---|
1788 | #define kLLQ_INIT_RESEND 2 // resend an un-ack'd packet after 2 seconds, then double for each additional |
---|
1789 | // LLQ Operation Codes |
---|
1790 | #define kLLQOp_Setup 1 |
---|
1791 | #define kLLQOp_Refresh 2 |
---|
1792 | #define kLLQOp_Event 3 |
---|
1793 | |
---|
1794 | // LLQ Errror Codes |
---|
1795 | enum |
---|
1796 | { |
---|
1797 | LLQErr_NoError = 0, |
---|
1798 | LLQErr_ServFull = 1, |
---|
1799 | LLQErr_Static = 2, |
---|
1800 | LLQErr_FormErr = 3, |
---|
1801 | LLQErr_NoSuchLLQ = 4, |
---|
1802 | LLQErr_BadVers = 5, |
---|
1803 | LLQErr_UnknownErr = 6 |
---|
1804 | }; |
---|
1805 | |
---|
1806 | enum { NoAnswer_Normal = 0, NoAnswer_Suspended = 1, NoAnswer_Fail = 2 }; |
---|
1807 | |
---|
1808 | #define HMAC_LEN 64 |
---|
1809 | #define HMAC_IPAD 0x36 |
---|
1810 | #define HMAC_OPAD 0x5c |
---|
1811 | #define MD5_LEN 16 |
---|
1812 | |
---|
1813 | #define AutoTunnelUnregistered(X) ( \ |
---|
1814 | (X)->AutoTunnelHostRecord.resrec.RecordType == kDNSRecordTypeUnregistered && \ |
---|
1815 | (X)->AutoTunnelTarget.resrec.RecordType == kDNSRecordTypeUnregistered && \ |
---|
1816 | (X)->AutoTunnelDeviceInfo.resrec.RecordType == kDNSRecordTypeUnregistered && \ |
---|
1817 | (X)->AutoTunnelService.resrec.RecordType == kDNSRecordTypeUnregistered && \ |
---|
1818 | (X)->AutoTunnel6Record.resrec.RecordType == kDNSRecordTypeUnregistered ) |
---|
1819 | |
---|
1820 | // Internal data structure to maintain authentication information |
---|
1821 | typedef struct DomainAuthInfo |
---|
1822 | { |
---|
1823 | struct DomainAuthInfo *next; |
---|
1824 | mDNSs32 deltime; // If we're planning to delete this DomainAuthInfo, the time we want it deleted |
---|
1825 | mDNSBool AutoTunnel; // Whether this is AutoTunnel |
---|
1826 | AuthRecord AutoTunnelHostRecord; // User-visible hostname; used as SRV target for AutoTunnel services |
---|
1827 | AuthRecord AutoTunnelTarget; // Opaque hostname of tunnel endpoint; used as SRV target for AutoTunnelService record |
---|
1828 | AuthRecord AutoTunnelDeviceInfo; // Device info of tunnel endpoint |
---|
1829 | AuthRecord AutoTunnelService; // Service record (possibly NAT-Mapped) of IKE daemon implementing tunnel endpoint |
---|
1830 | AuthRecord AutoTunnel6Record; // AutoTunnel AAAA Record obtained from awacsd |
---|
1831 | mDNSBool AutoTunnelServiceStarted; // Whether a service has been registered in this domain |
---|
1832 | mDNSv6Addr AutoTunnelInnerAddress; |
---|
1833 | domainname domain; |
---|
1834 | domainname keyname; |
---|
1835 | domainname hostname; |
---|
1836 | mDNSIPPort port; |
---|
1837 | char b64keydata[32]; |
---|
1838 | mDNSu8 keydata_ipad[HMAC_LEN]; // padded key for inner hash rounds |
---|
1839 | mDNSu8 keydata_opad[HMAC_LEN]; // padded key for outer hash rounds |
---|
1840 | } DomainAuthInfo; |
---|
1841 | |
---|
1842 | // Note: Within an mDNSQuestionCallback mDNS all API calls are legal except mDNS_Init(), mDNS_Exit(), mDNS_Execute() |
---|
1843 | // Note: Any value other than QC_rmv i.e., any non-zero value will result in kDNSServiceFlagsAdd to the application |
---|
1844 | // layer. These values are used within mDNSResponder and not sent across to the application. QC_addnocache is for |
---|
1845 | // delivering a response without adding to the cache. QC_forceresponse is superset of QC_addnocache where in |
---|
1846 | // addition to not entering in the cache, it also forces the negative response through. |
---|
1847 | typedef enum { QC_rmv = 0, QC_add, QC_addnocache, QC_forceresponse, QC_dnssec , QC_nodnssec, QC_suppressed } QC_result; |
---|
1848 | typedef void mDNSQuestionCallback (mDNS *const m, DNSQuestion *question, const ResourceRecord *const answer, QC_result AddRecord); |
---|
1849 | typedef void AsyncDispatchFunc(mDNS *const m, void *context); |
---|
1850 | typedef void DNSSECAuthInfoFreeCallback(mDNS *const m, void *context); |
---|
1851 | extern void mDNSPlatformDispatchAsync(mDNS *const m, void *context, AsyncDispatchFunc func); |
---|
1852 | |
---|
1853 | #define NextQSendTime(Q) ((Q)->LastQTime + (Q)->ThisQInterval) |
---|
1854 | #define ActiveQuestion(Q) ((Q)->ThisQInterval > 0 && !(Q)->DuplicateOf) |
---|
1855 | #define TimeToSendThisQuestion(Q,time) (ActiveQuestion(Q) && (time) - NextQSendTime(Q) >= 0) |
---|
1856 | |
---|
1857 | // q->ValidationStatus is either DNSSECValNotRequired or DNSSECValRequired and then moves onto DNSSECValInProgress. |
---|
1858 | // When Validation is done, we mark all "DNSSECValInProgress" questions "DNSSECValDone". If we are answering |
---|
1859 | // questions from /etc/hosts, then we go straight to DNSSECValDone from the initial state. |
---|
1860 | typedef enum { DNSSECValNotRequired = 0, DNSSECValRequired, DNSSECValInProgress, DNSSECValDone } DNSSECValState; |
---|
1861 | |
---|
1862 | // ValidationRequired can be set to the following values: |
---|
1863 | // |
---|
1864 | // SECURE validation is set to determine whether something is secure or bogus |
---|
1865 | // INSECURE validation is set internally by dnssec code to indicate that it is currently proving something |
---|
1866 | // is insecure |
---|
1867 | #define DNSSEC_VALIDATION_NONE 0x00 |
---|
1868 | #define DNSSEC_VALIDATION_SECURE 0x01 |
---|
1869 | #define DNSSEC_VALIDATION_SECURE_OPTIONAL 0x02 |
---|
1870 | #define DNSSEC_VALIDATION_INSECURE 0x03 |
---|
1871 | |
---|
1872 | // For both ValidationRequired and ValidatingResponse question, we validate DNSSEC responses. |
---|
1873 | // For ProxyQuestion with DNSSECOK, we just receive the DNSSEC records to pass them along without |
---|
1874 | // validation and if the CD bit is not set, we also validate. |
---|
1875 | #define DNSSECQuestion(q) ((q)->ValidationRequired || (q)->ValidatingResponse || ((q)->ProxyQuestion && (q)->ProxyDNSSECOK)) |
---|
1876 | |
---|
1877 | // ValidatingQuestion is used when we need to know whether we are validating the DNSSEC responses for a question |
---|
1878 | #define ValidatingQuestion(q) ((q)->ValidationRequired || (q)->ValidatingResponse) |
---|
1879 | |
---|
1880 | #define DNSSECOptionalQuestion(q) ((q)->ValidationRequired == DNSSEC_VALIDATION_SECURE_OPTIONAL) |
---|
1881 | |
---|
1882 | // Given the resource record and the question, should we follow the CNAME ? |
---|
1883 | #define FollowCNAME(q, rr, AddRecord) (AddRecord && (q)->qtype != kDNSType_CNAME && \ |
---|
1884 | (rr)->RecordType != kDNSRecordTypePacketNegative && \ |
---|
1885 | (rr)->rrtype == kDNSType_CNAME) |
---|
1886 | |
---|
1887 | // RFC 4122 defines it to be 16 bytes |
---|
1888 | #define UUID_SIZE 16 |
---|
1889 | |
---|
1890 | struct DNSQuestion_struct |
---|
1891 | { |
---|
1892 | // Internal state fields. These are used internally by mDNSCore; the client layer needn't be concerned with them. |
---|
1893 | DNSQuestion *next; |
---|
1894 | mDNSu32 qnamehash; |
---|
1895 | mDNSs32 DelayAnswering; // Set if we want to defer answering this question until the cache settles |
---|
1896 | mDNSs32 LastQTime; // Last scheduled transmission of this Q on *all* applicable interfaces |
---|
1897 | mDNSs32 ThisQInterval; // LastQTime + ThisQInterval is the next scheduled transmission of this Q |
---|
1898 | // ThisQInterval > 0 for an active question; |
---|
1899 | // ThisQInterval = 0 for a suspended question that's still in the list |
---|
1900 | // ThisQInterval = -1 for a cancelled question (should not still be in list) |
---|
1901 | mDNSs32 ExpectUnicastResp; // Set when we send a query with the kDNSQClass_UnicastResponse bit set |
---|
1902 | mDNSs32 LastAnswerPktNum; // The sequence number of the last response packet containing an answer to this Q |
---|
1903 | mDNSu32 RecentAnswerPkts; // Number of answers since the last time we sent this query |
---|
1904 | mDNSu32 CurrentAnswers; // Number of records currently in the cache that answer this question |
---|
1905 | mDNSu32 BrowseThreshold; // If we have received at least this number of answers, |
---|
1906 | // set the next question interval to MaxQuestionInterval |
---|
1907 | mDNSu32 LargeAnswers; // Number of answers with rdata > 1024 bytes |
---|
1908 | mDNSu32 UniqueAnswers; // Number of answers received with kDNSClass_UniqueRRSet bit set |
---|
1909 | mDNSInterfaceID FlappingInterface1; // Set when an interface goes away, to flag if remove events are delivered for this Q |
---|
1910 | mDNSInterfaceID FlappingInterface2; // Set when an interface goes away, to flag if remove events are delivered for this Q |
---|
1911 | DomainAuthInfo *AuthInfo; // Non-NULL if query is currently being done using Private DNS |
---|
1912 | DNSQuestion *DuplicateOf; |
---|
1913 | DNSQuestion *NextInDQList; |
---|
1914 | AnonymousInfo *AnonInfo; // Anonymous Information |
---|
1915 | DupSuppressInfo DupSuppress[DupSuppressInfoSize]; |
---|
1916 | mDNSInterfaceID SendQNow; // The interface this query is being sent on right now |
---|
1917 | mDNSBool SendOnAll; // Set if we're sending this question on all active interfaces |
---|
1918 | mDNSBool CachedAnswerNeedsUpdate; // See SendQueries(). Set if we're sending this question |
---|
1919 | // because a cached answer needs to be refreshed. |
---|
1920 | mDNSu32 RequestUnicast; // Non-zero if we want to send query with kDNSQClass_UnicastResponse bit set |
---|
1921 | mDNSs32 LastQTxTime; // Last time this Q was sent on one (but not necessarily all) interfaces |
---|
1922 | mDNSu32 CNAMEReferrals; // Count of how many CNAME redirections we've done |
---|
1923 | mDNSBool SuppressQuery; // This query should be suppressed and not sent on the wire |
---|
1924 | mDNSu8 LOAddressAnswers; // Number of answers from the local only auth records that are |
---|
1925 | // answering A, AAAA, CNAME, or PTR (/etc/hosts) |
---|
1926 | mDNSu8 WakeOnResolveCount; // Number of wakes that should be sent on resolve |
---|
1927 | mDNSs32 StopTime; // Time this question should be stopped by giving them a negative answer |
---|
1928 | |
---|
1929 | // DNSSEC fields |
---|
1930 | DNSSECValState ValidationState; // Current state of the Validation process |
---|
1931 | DNSSECStatus ValidationStatus; // Validation status for "ValidationRequired" questions (dnssec) |
---|
1932 | mDNSu8 ValidatingResponse; // Question trying to validate a response (dnssec) on behalf of |
---|
1933 | // ValidationRequired question |
---|
1934 | void *DNSSECAuthInfo; |
---|
1935 | DNSSECAuthInfoFreeCallback *DAIFreeCallback; |
---|
1936 | |
---|
1937 | // Wide Area fields. These are used internally by the uDNS core (Unicast) |
---|
1938 | UDPSocket *LocalSocket; |
---|
1939 | |
---|
1940 | // |-> DNS Configuration related fields used in uDNS (Subset of Wide Area/Unicast fields) |
---|
1941 | DNSServer *qDNSServer; // Caching server for this query (in the absence of an SRV saying otherwise) |
---|
1942 | mDNSOpaque64 validDNSServers; // Valid DNSServers for this question |
---|
1943 | mDNSu16 noServerResponse; // At least one server did not respond. |
---|
1944 | mDNSu16 triedAllServersOnce; // Tried all DNS servers once |
---|
1945 | mDNSu8 unansweredQueries; // The number of unanswered queries to this server |
---|
1946 | |
---|
1947 | ZoneData *nta; // Used for getting zone data for private or LLQ query |
---|
1948 | mDNSAddr servAddr; // Address and port learned from _dns-llq, _dns-llq-tls or _dns-query-tls SRV query |
---|
1949 | mDNSIPPort servPort; |
---|
1950 | struct tcpInfo_t *tcp; |
---|
1951 | mDNSIPPort tcpSrcPort; // Local Port TCP packet received on;need this as tcp struct is disposed |
---|
1952 | // by tcpCallback before calling into mDNSCoreReceive |
---|
1953 | mDNSu8 NoAnswer; // Set if we want to suppress answers until tunnel setup has completed |
---|
1954 | mDNSu8 Restart; // This question should be restarted soon |
---|
1955 | |
---|
1956 | // LLQ-specific fields. These fields are only meaningful when LongLived flag is set |
---|
1957 | LLQ_State state; |
---|
1958 | mDNSu32 ReqLease; // seconds (relative) |
---|
1959 | mDNSs32 expire; // ticks (absolute) |
---|
1960 | mDNSs16 ntries; // for UDP: the number of packets sent for this LLQ state |
---|
1961 | // for TCP: there is some ambiguity in the use of this variable, but in general, it is |
---|
1962 | // the number of TCP/TLS connection attempts for this LLQ state, or |
---|
1963 | // the number of packets sent for this TCP/TLS connection |
---|
1964 | mDNSOpaque64 id; |
---|
1965 | |
---|
1966 | // DNS Proxy fields |
---|
1967 | mDNSOpaque16 responseFlags; // Temporary place holder for the error we get back from the DNS server |
---|
1968 | // till we populate in the cache |
---|
1969 | mDNSBool DisallowPID; // Is the query allowed for the "PID" that we are sending on behalf of ? |
---|
1970 | mDNSs32 ServiceID; // Service identifier to match against the DNS server |
---|
1971 | |
---|
1972 | // Client API fields: The client must set up these fields *before* calling mDNS_StartQuery() |
---|
1973 | mDNSInterfaceID InterfaceID; // Non-zero if you want to issue queries only on a single specific IP interface |
---|
1974 | mDNSu32 flags; // flags from original DNSService*() API request. |
---|
1975 | mDNSAddr Target; // Non-zero if you want to direct queries to a specific unicast target address |
---|
1976 | mDNSIPPort TargetPort; // Must be set if Target is set |
---|
1977 | mDNSOpaque16 TargetQID; // Must be set if Target is set |
---|
1978 | domainname qname; |
---|
1979 | mDNSu16 qtype; |
---|
1980 | mDNSu16 qclass; |
---|
1981 | mDNSBool LongLived; // Set by client for calls to mDNS_StartQuery to indicate LLQs to unicast layer. |
---|
1982 | mDNSBool ExpectUnique; // Set by client if it's expecting unique RR(s) for this question, not shared RRs |
---|
1983 | mDNSBool ForceMCast; // Set by client to force mDNS query, even for apparently uDNS names |
---|
1984 | mDNSBool ReturnIntermed; // Set by client to request callbacks for intermediate CNAME/NXDOMAIN results |
---|
1985 | mDNSBool SuppressUnusable; // Set by client to suppress unusable queries to be sent on the wire |
---|
1986 | mDNSu8 RetryWithSearchDomains; // Retry with search domains if there is no entry in the cache or AuthRecords |
---|
1987 | mDNSu8 TimeoutQuestion; // Timeout this question if there is no reply in configured time |
---|
1988 | mDNSu8 WakeOnResolve; // Send wakeup on resolve |
---|
1989 | mDNSu8 UseBackgroundTrafficClass; // Use background traffic class for request |
---|
1990 | mDNSs8 SearchListIndex; // Index into SearchList; Used by the client layer but not touched by core |
---|
1991 | mDNSs8 AppendSearchDomains; // Search domains can be appended for this query |
---|
1992 | mDNSs8 AppendLocalSearchDomains; // Search domains ending in .local can be appended for this query |
---|
1993 | mDNSu8 ValidationRequired; // Requires DNSSEC validation. |
---|
1994 | mDNSu8 ProxyQuestion; // Proxy Question |
---|
1995 | mDNSu8 ProxyDNSSECOK; // Proxy Question with EDNS0 DNSSEC OK bit set |
---|
1996 | mDNSs32 pid; // Process ID of the client that is requesting the question |
---|
1997 | mDNSu8 uuid[UUID_SIZE]; // Unique ID of the client that is requesting the question (valid only if pid is zero) |
---|
1998 | domainname *qnameOrig; // Copy of the original question name if it is not fully qualified |
---|
1999 | mDNSQuestionCallback *QuestionCallback; |
---|
2000 | void *QuestionContext; |
---|
2001 | }; |
---|
2002 | |
---|
2003 | typedef struct |
---|
2004 | { |
---|
2005 | // Client API fields: The client must set up name and InterfaceID *before* calling mDNS_StartResolveService() |
---|
2006 | // When the callback is invoked, ip, port, TXTlen and TXTinfo will have been filled in with the results learned from the network. |
---|
2007 | domainname name; |
---|
2008 | mDNSInterfaceID InterfaceID; // ID of the interface the response was received on |
---|
2009 | mDNSAddr ip; // Remote (destination) IP address where this service can be accessed |
---|
2010 | mDNSIPPort port; // Port where this service can be accessed |
---|
2011 | mDNSu16 TXTlen; |
---|
2012 | mDNSu8 TXTinfo[2048]; // Additional demultiplexing information (e.g. LPR queue name) |
---|
2013 | } ServiceInfo; |
---|
2014 | |
---|
2015 | // Note: Within an mDNSServiceInfoQueryCallback mDNS all API calls are legal except mDNS_Init(), mDNS_Exit(), mDNS_Execute() |
---|
2016 | typedef struct ServiceInfoQuery_struct ServiceInfoQuery; |
---|
2017 | typedef void mDNSServiceInfoQueryCallback (mDNS *const m, ServiceInfoQuery *query); |
---|
2018 | struct ServiceInfoQuery_struct |
---|
2019 | { |
---|
2020 | // Internal state fields. These are used internally by mDNSCore; the client layer needn't be concerned with them. |
---|
2021 | // No fields need to be set up by the client prior to calling mDNS_StartResolveService(); |
---|
2022 | // all required data is passed as parameters to that function. |
---|
2023 | // The ServiceInfoQuery structure memory is working storage for mDNSCore to discover the requested information |
---|
2024 | // and place it in the ServiceInfo structure. After the client has called mDNS_StopResolveService(), it may |
---|
2025 | // dispose of the ServiceInfoQuery structure while retaining the results in the ServiceInfo structure. |
---|
2026 | DNSQuestion qSRV; |
---|
2027 | DNSQuestion qTXT; |
---|
2028 | DNSQuestion qAv4; |
---|
2029 | DNSQuestion qAv6; |
---|
2030 | mDNSu8 GotSRV; |
---|
2031 | mDNSu8 GotTXT; |
---|
2032 | mDNSu8 GotADD; |
---|
2033 | mDNSu32 Answers; |
---|
2034 | ServiceInfo *info; |
---|
2035 | mDNSServiceInfoQueryCallback *ServiceInfoQueryCallback; |
---|
2036 | void *ServiceInfoQueryContext; |
---|
2037 | }; |
---|
2038 | |
---|
2039 | typedef enum { ZoneServiceUpdate, ZoneServiceQuery, ZoneServiceLLQ } ZoneService; |
---|
2040 | |
---|
2041 | typedef void ZoneDataCallback (mDNS *const m, mStatus err, const ZoneData *result); |
---|
2042 | |
---|
2043 | struct ZoneData_struct |
---|
2044 | { |
---|
2045 | domainname ChildName; // Name for which we're trying to find the responsible server |
---|
2046 | ZoneService ZoneService; // Which service we're seeking for this zone (update, query, or LLQ) |
---|
2047 | domainname *CurrentSOA; // Points to somewhere within ChildName |
---|
2048 | domainname ZoneName; // Discovered result: Left-hand-side of SOA record |
---|
2049 | mDNSu16 ZoneClass; // Discovered result: DNS Class from SOA record |
---|
2050 | domainname Host; // Discovered result: Target host from SRV record |
---|
2051 | mDNSIPPort Port; // Discovered result: Update port, query port, or LLQ port from SRV record |
---|
2052 | mDNSAddr Addr; // Discovered result: Address of Target host from SRV record |
---|
2053 | mDNSBool ZonePrivate; // Discovered result: Does zone require encrypted queries? |
---|
2054 | ZoneDataCallback *ZoneDataCallback; // Caller-specified function to be called upon completion |
---|
2055 | void *ZoneDataContext; |
---|
2056 | DNSQuestion question; // Storage for any active question |
---|
2057 | }; |
---|
2058 | |
---|
2059 | extern ZoneData *StartGetZoneData(mDNS *const m, const domainname *const name, const ZoneService target, ZoneDataCallback callback, void *callbackInfo); |
---|
2060 | extern void CancelGetZoneData(mDNS *const m, ZoneData *nta); |
---|
2061 | extern mDNSBool IsGetZoneDataQuestion(DNSQuestion *q); |
---|
2062 | |
---|
2063 | typedef struct DNameListElem |
---|
2064 | { |
---|
2065 | struct DNameListElem *next; |
---|
2066 | mDNSu32 uid; |
---|
2067 | domainname name; |
---|
2068 | } DNameListElem; |
---|
2069 | |
---|
2070 | #if APPLE_OSX_mDNSResponder |
---|
2071 | // Different states that we go through locating the peer |
---|
2072 | #define TC_STATE_AAAA_PEER 0x000000001 /* Peer's BTMM IPv6 address */ |
---|
2073 | #define TC_STATE_AAAA_PEER_RELAY 0x000000002 /* Peer's IPv6 Relay address */ |
---|
2074 | #define TC_STATE_SRV_PEER 0x000000003 /* Peer's SRV Record corresponding to IPv4 address */ |
---|
2075 | #define TC_STATE_ADDR_PEER 0x000000004 /* Peer's IPv4 address */ |
---|
2076 | |
---|
2077 | typedef struct ClientTunnel |
---|
2078 | { |
---|
2079 | struct ClientTunnel *next; |
---|
2080 | domainname dstname; |
---|
2081 | mDNSBool MarkedForDeletion; |
---|
2082 | mDNSv6Addr loc_inner; |
---|
2083 | mDNSv4Addr loc_outer; |
---|
2084 | mDNSv6Addr loc_outer6; |
---|
2085 | mDNSv6Addr rmt_inner; |
---|
2086 | mDNSv4Addr rmt_outer; |
---|
2087 | mDNSv6Addr rmt_outer6; |
---|
2088 | mDNSIPPort rmt_outer_port; |
---|
2089 | mDNSu16 tc_state; |
---|
2090 | DNSQuestion q; |
---|
2091 | } ClientTunnel; |
---|
2092 | #endif |
---|
2093 | |
---|
2094 | // *************************************************************************** |
---|
2095 | #if 0 |
---|
2096 | #pragma mark - |
---|
2097 | #pragma mark - NetworkInterfaceInfo_struct |
---|
2098 | #endif |
---|
2099 | |
---|
2100 | typedef struct NetworkInterfaceInfo_struct NetworkInterfaceInfo; |
---|
2101 | |
---|
2102 | // A NetworkInterfaceInfo_struct serves two purposes: |
---|
2103 | // 1. It holds the address, PTR and HINFO records to advertise a given IP address on a given physical interface |
---|
2104 | // 2. It tells mDNSCore which physical interfaces are available; each physical interface has its own unique InterfaceID. |
---|
2105 | // Since there may be multiple IP addresses on a single physical interface, |
---|
2106 | // there may be multiple NetworkInterfaceInfo_structs with the same InterfaceID. |
---|
2107 | // In this case, to avoid sending the same packet n times, when there's more than one |
---|
2108 | // struct with the same InterfaceID, mDNSCore picks one member of the set to be the |
---|
2109 | // active representative of the set; all others have the 'InterfaceActive' flag unset. |
---|
2110 | |
---|
2111 | struct NetworkInterfaceInfo_struct |
---|
2112 | { |
---|
2113 | // Internal state fields. These are used internally by mDNSCore; the client layer needn't be concerned with them. |
---|
2114 | NetworkInterfaceInfo *next; |
---|
2115 | |
---|
2116 | mDNSu8 InterfaceActive; // Set if interface is sending & receiving packets (see comment above) |
---|
2117 | mDNSu8 IPv4Available; // If InterfaceActive, set if v4 available on this InterfaceID |
---|
2118 | mDNSu8 IPv6Available; // If InterfaceActive, set if v6 available on this InterfaceID |
---|
2119 | |
---|
2120 | DNSQuestion NetWakeBrowse; |
---|
2121 | DNSQuestion NetWakeResolve[3]; // For fault-tolerance, we try up to three Sleep Proxies |
---|
2122 | mDNSAddr SPSAddr[3]; |
---|
2123 | mDNSIPPort SPSPort[3]; |
---|
2124 | mDNSs32 NextSPSAttempt; // -1 if we're not currently attempting to register with any Sleep Proxy |
---|
2125 | mDNSs32 NextSPSAttemptTime; |
---|
2126 | |
---|
2127 | // Standard AuthRecords that every Responder host should have (one per active IP address) |
---|
2128 | AuthRecord RR_A; // 'A' or 'AAAA' (address) record for our ".local" name |
---|
2129 | AuthRecord RR_PTR; // PTR (reverse lookup) record |
---|
2130 | AuthRecord RR_HINFO; |
---|
2131 | |
---|
2132 | // Client API fields: The client must set up these fields *before* calling mDNS_RegisterInterface() |
---|
2133 | mDNSInterfaceID InterfaceID; // Identifies physical interface; MUST NOT be 0, -1, or -2 |
---|
2134 | mDNSAddr ip; // The IPv4 or IPv6 address to advertise |
---|
2135 | mDNSAddr mask; |
---|
2136 | mDNSEthAddr MAC; |
---|
2137 | char ifname[64]; // Windows uses a GUID string for the interface name, which doesn't fit in 16 bytes |
---|
2138 | mDNSu8 Advertise; // False if you are only searching on this interface |
---|
2139 | mDNSu8 McastTxRx; // Send/Receive multicast on this { InterfaceID, address family } ? |
---|
2140 | mDNSu8 NetWake; // Set if Wake-On-Magic-Packet is enabled on this interface |
---|
2141 | mDNSu8 Loopback; // Set if this is the loopback interface |
---|
2142 | mDNSu8 IgnoreIPv4LL; // Set if IPv4 Link-Local addresses have to be ignored. |
---|
2143 | mDNSu8 SendGoodbyes; // Send goodbyes on this interface while sleeping |
---|
2144 | mDNSBool DirectLink; // a direct link, indicating we can skip the probe for |
---|
2145 | // address records |
---|
2146 | }; |
---|
2147 | |
---|
2148 | #define SLE_DELETE 0x00000001 |
---|
2149 | #define SLE_WAB_BROWSE_QUERY_STARTED 0x00000002 |
---|
2150 | #define SLE_WAB_LBROWSE_QUERY_STARTED 0x00000004 |
---|
2151 | #define SLE_WAB_REG_QUERY_STARTED 0x00000008 |
---|
2152 | |
---|
2153 | typedef struct SearchListElem |
---|
2154 | { |
---|
2155 | struct SearchListElem *next; |
---|
2156 | domainname domain; |
---|
2157 | int flag; |
---|
2158 | mDNSInterfaceID InterfaceID; |
---|
2159 | DNSQuestion BrowseQ; |
---|
2160 | DNSQuestion DefBrowseQ; |
---|
2161 | DNSQuestion AutomaticBrowseQ; |
---|
2162 | DNSQuestion RegisterQ; |
---|
2163 | DNSQuestion DefRegisterQ; |
---|
2164 | int numCfAnswers; |
---|
2165 | ARListElem *AuthRecs; |
---|
2166 | } SearchListElem; |
---|
2167 | |
---|
2168 | // For domain enumeration and automatic browsing |
---|
2169 | // This is the user's DNS search list. |
---|
2170 | // In each of these domains we search for our special pointer records (lb._dns-sd._udp.<domain>, etc.) |
---|
2171 | // to discover recommended domains for domain enumeration (browse, default browse, registration, |
---|
2172 | // default registration) and possibly one or more recommended automatic browsing domains. |
---|
2173 | extern SearchListElem *SearchList; // This really ought to be part of mDNS_struct -- SC |
---|
2174 | |
---|
2175 | // *************************************************************************** |
---|
2176 | #if 0 |
---|
2177 | #pragma mark - |
---|
2178 | #pragma mark - Main mDNS object, used to hold all the mDNS state |
---|
2179 | #endif |
---|
2180 | |
---|
2181 | typedef void mDNSCallback (mDNS *const m, mStatus result); |
---|
2182 | |
---|
2183 | #ifndef CACHE_HASH_SLOTS |
---|
2184 | #define CACHE_HASH_SLOTS 499 |
---|
2185 | #endif |
---|
2186 | |
---|
2187 | enum |
---|
2188 | { |
---|
2189 | SleepState_Awake = 0, |
---|
2190 | SleepState_Transferring = 1, |
---|
2191 | SleepState_Sleeping = 2 |
---|
2192 | }; |
---|
2193 | |
---|
2194 | typedef enum |
---|
2195 | { |
---|
2196 | kStatsActionIncrement, |
---|
2197 | kStatsActionDecrement, |
---|
2198 | kStatsActionClear, |
---|
2199 | kStatsActionSet |
---|
2200 | } DNSSECStatsAction; |
---|
2201 | |
---|
2202 | typedef enum |
---|
2203 | { |
---|
2204 | kStatsTypeMemoryUsage, |
---|
2205 | kStatsTypeLatency, |
---|
2206 | kStatsTypeExtraPackets, |
---|
2207 | kStatsTypeStatus, |
---|
2208 | kStatsTypeProbe, |
---|
2209 | kStatsTypeMsgSize |
---|
2210 | } DNSSECStatsType; |
---|
2211 | |
---|
2212 | typedef struct |
---|
2213 | { |
---|
2214 | mDNSu32 TotalMemUsed; |
---|
2215 | mDNSu32 Latency0; // 0 to 4 ms |
---|
2216 | mDNSu32 Latency5; // 5 to 9 ms |
---|
2217 | mDNSu32 Latency10; // 10 to 19 ms |
---|
2218 | mDNSu32 Latency20; // 20 to 49 ms |
---|
2219 | mDNSu32 Latency50; // 50 to 99 ms |
---|
2220 | mDNSu32 Latency100; // >= 100 ms |
---|
2221 | mDNSu32 ExtraPackets0; // 0 to 2 packets |
---|
2222 | mDNSu32 ExtraPackets3; // 3 to 6 packets |
---|
2223 | mDNSu32 ExtraPackets7; // 7 to 9 packets |
---|
2224 | mDNSu32 ExtraPackets10; // >= 10 packets |
---|
2225 | mDNSu32 SecureStatus; |
---|
2226 | mDNSu32 InsecureStatus; |
---|
2227 | mDNSu32 IndeterminateStatus; |
---|
2228 | mDNSu32 BogusStatus; |
---|
2229 | mDNSu32 NoResponseStatus; |
---|
2230 | mDNSu32 NumProbesSent; // Number of probes sent |
---|
2231 | mDNSu32 MsgSize0; // DNSSEC message size <= 1024 |
---|
2232 | mDNSu32 MsgSize1; // DNSSEC message size <= 2048 |
---|
2233 | mDNSu32 MsgSize2; // DNSSEC message size > 2048 |
---|
2234 | } DNSSECStatistics; |
---|
2235 | |
---|
2236 | typedef struct |
---|
2237 | { |
---|
2238 | mDNSu32 NameConflicts; // Normal Name conflicts |
---|
2239 | mDNSu32 KnownUniqueNameConflicts; // Name Conflicts for KnownUnique Records |
---|
2240 | mDNSu32 DupQuerySuppressions; // Duplicate query suppressions |
---|
2241 | mDNSu32 KnownAnswerSuppressions; // Known Answer suppressions |
---|
2242 | mDNSu32 KnownAnswerMultiplePkts; // Known Answer in queries spannign multiple packets |
---|
2243 | mDNSu32 PoofCacheDeletions; // Number of times the cache was deleted due to POOF |
---|
2244 | mDNSu32 UnicastBitInQueries; // Queries with QU bit set |
---|
2245 | mDNSu32 NormalQueries; // Queries with QU bit not set |
---|
2246 | mDNSu32 MatchingAnswersForQueries; // Queries for which we had a response |
---|
2247 | mDNSu32 UnicastResponses; // Unicast responses to queries |
---|
2248 | mDNSu32 MulticastResponses; // Multicast responses to queries |
---|
2249 | mDNSu32 UnicastDemotedToMulticast; // Number of times unicast demoted to multicast |
---|
2250 | mDNSu32 Sleeps; // Total sleeps |
---|
2251 | mDNSu32 Wakes; // Total wakes |
---|
2252 | mDNSu32 InterfaceUp; // Total Interface UP events |
---|
2253 | mDNSu32 InterfaceUpFlap; // Total Interface UP events with flaps |
---|
2254 | mDNSu32 InterfaceDown; // Total Interface Down events |
---|
2255 | mDNSu32 InterfaceDownFlap; // Total Interface Down events with flaps |
---|
2256 | mDNSu32 CacheRefreshQueries; // Number of queries that we sent for refreshing cache |
---|
2257 | mDNSu32 CacheRefreshed; // Number of times the cache was refreshed due to a response |
---|
2258 | mDNSu32 WakeOnResolves; // Number of times we did a wake on resolve |
---|
2259 | } mDNSStatistics; |
---|
2260 | extern void LogMDNSStatistics(mDNS *const m); |
---|
2261 | |
---|
2262 | struct mDNS_struct |
---|
2263 | { |
---|
2264 | // Internal state fields. These hold the main internal state of mDNSCore; |
---|
2265 | // the client layer needn't be concerned with them. |
---|
2266 | // No fields need to be set up by the client prior to calling mDNS_Init(); |
---|
2267 | // all required data is passed as parameters to that function. |
---|
2268 | |
---|
2269 | mDNS_PlatformSupport *p; // Pointer to platform-specific data of indeterminite size |
---|
2270 | mDNSBool CanReceiveUnicastOn5353; |
---|
2271 | mDNSBool AdvertiseLocalAddresses; |
---|
2272 | mDNSBool DivertMulticastAdvertisements; // from interfaces that do not advertise local addresses to local-only |
---|
2273 | mStatus mDNSPlatformStatus; |
---|
2274 | mDNSIPPort UnicastPort4; |
---|
2275 | mDNSIPPort UnicastPort6; |
---|
2276 | mDNSEthAddr PrimaryMAC; // Used as unique host ID |
---|
2277 | mDNSCallback *MainCallback; |
---|
2278 | void *MainContext; |
---|
2279 | |
---|
2280 | // For debugging: To catch and report locking failures |
---|
2281 | mDNSu32 mDNS_busy; // Incremented between mDNS_Lock/mDNS_Unlock section |
---|
2282 | mDNSu32 mDNS_reentrancy; // Incremented when calling a client callback |
---|
2283 | mDNSu8 lock_rrcache; // For debugging: Set at times when these lists may not be modified |
---|
2284 | mDNSu8 lock_Questions; |
---|
2285 | mDNSu8 lock_Records; |
---|
2286 | #ifndef MaxMsg |
---|
2287 | #define MaxMsg 512 |
---|
2288 | #endif |
---|
2289 | char MsgBuffer[MaxMsg]; // Temp storage used while building error log messages |
---|
2290 | |
---|
2291 | // Task Scheduling variables |
---|
2292 | mDNSs32 timenow_adjust; // Correction applied if we ever discover time went backwards |
---|
2293 | mDNSs32 timenow; // The time that this particular activation of the mDNS code started |
---|
2294 | mDNSs32 timenow_last; // The time the last time we ran |
---|
2295 | mDNSs32 NextScheduledEvent; // Derived from values below |
---|
2296 | mDNSs32 ShutdownTime; // Set when we're shutting down; allows us to skip some unnecessary steps |
---|
2297 | mDNSs32 SuppressSending; // Don't send local-link mDNS packets during this time |
---|
2298 | mDNSs32 NextCacheCheck; // Next time to refresh cache record before it expires |
---|
2299 | mDNSs32 NextScheduledQuery; // Next time to send query in its exponential backoff sequence |
---|
2300 | mDNSs32 NextScheduledProbe; // Next time to probe for new authoritative record |
---|
2301 | mDNSs32 NextScheduledResponse; // Next time to send authoritative record(s) in responses |
---|
2302 | mDNSs32 NextScheduledNATOp; // Next time to send NAT-traversal packets |
---|
2303 | mDNSs32 NextScheduledSPS; // Next time to purge expiring Sleep Proxy records |
---|
2304 | mDNSs32 NextScheduledKA; // Next time to send Keepalive packets (SPS) |
---|
2305 | mDNSs32 RandomQueryDelay; // For de-synchronization of query packets on the wire |
---|
2306 | mDNSu32 RandomReconfirmDelay; // For de-synchronization of reconfirmation queries on the wire |
---|
2307 | mDNSs32 PktNum; // Unique sequence number assigned to each received packet |
---|
2308 | mDNSs32 MPktNum; // Unique sequence number assigned to each received Multicast packet |
---|
2309 | mDNSu8 LocalRemoveEvents; // Set if we may need to deliver remove events for local-only questions and/or local-only records |
---|
2310 | mDNSu8 SleepState; // Set if we're sleeping |
---|
2311 | mDNSu8 SleepSeqNum; // "Epoch number" of our current period of wakefulness |
---|
2312 | mDNSu8 SystemWakeOnLANEnabled; // Set if we want to register with a Sleep Proxy before going to sleep |
---|
2313 | mDNSu8 SentSleepProxyRegistration; // Set if we registered (or tried to register) with a Sleep Proxy |
---|
2314 | mDNSu8 SystemSleepOnlyIfWakeOnLAN; // Set if we may only sleep if we managed to register with a Sleep Proxy |
---|
2315 | mDNSs32 AnnounceOwner; // After waking from sleep, include OWNER option in packets until this time |
---|
2316 | mDNSs32 DelaySleep; // To inhibit re-sleeping too quickly right after wake |
---|
2317 | mDNSs32 SleepLimit; // Time window to allow deregistrations, etc., |
---|
2318 | // during which underying platform layer should inhibit system sleep |
---|
2319 | mDNSs32 TimeSlept; // Time we went to sleep. |
---|
2320 | |
---|
2321 | mDNSs32 StatStartTime; // Time we started gathering statistics during this interval. |
---|
2322 | mDNSs32 NextStatLogTime; // Next time to log statistics. |
---|
2323 | mDNSs32 ActiveStatTime; // Total time awake/gathering statistics for this log period. |
---|
2324 | mDNSs32 UnicastPacketsSent; // Number of unicast packets sent. |
---|
2325 | mDNSs32 MulticastPacketsSent; // Number of multicast packets sent. |
---|
2326 | mDNSs32 RemoteSubnet; // Multicast packets received from outside our subnet. |
---|
2327 | |
---|
2328 | mDNSs32 NextScheduledSPRetry; // Time next sleep proxy registration action is required. |
---|
2329 | // Only valid if SleepLimit is nonzero and DelaySleep is zero. |
---|
2330 | |
---|
2331 | mDNSs32 NextScheduledStopTime; // Next time to stop a question |
---|
2332 | |
---|
2333 | |
---|
2334 | // These fields only required for mDNS Searcher... |
---|
2335 | DNSQuestion *Questions; // List of all registered questions, active and inactive |
---|
2336 | DNSQuestion *NewQuestions; // Fresh questions not yet answered from cache |
---|
2337 | DNSQuestion *CurrentQuestion; // Next question about to be examined in AnswerLocalQuestions() |
---|
2338 | DNSQuestion *LocalOnlyQuestions; // Questions with InterfaceID set to mDNSInterface_LocalOnly or mDNSInterface_P2P |
---|
2339 | DNSQuestion *NewLocalOnlyQuestions; // Fresh local-only or P2P questions not yet answered |
---|
2340 | DNSQuestion *RestartQuestion; // Questions that are being restarted (stop followed by start) |
---|
2341 | DNSQuestion *ValidationQuestion; // Questions that are being validated (dnssec) |
---|
2342 | mDNSu32 rrcache_size; // Total number of available cache entries |
---|
2343 | mDNSu32 rrcache_totalused; // Number of cache entries currently occupied |
---|
2344 | mDNSu32 rrcache_totalused_unicast; // Number of cache entries currently occupied by unicast |
---|
2345 | mDNSu32 rrcache_active; // Number of cache entries currently occupied by records that answer active questions |
---|
2346 | mDNSu32 rrcache_report; |
---|
2347 | CacheEntity *rrcache_free; |
---|
2348 | CacheGroup *rrcache_hash[CACHE_HASH_SLOTS]; |
---|
2349 | mDNSs32 rrcache_nextcheck[CACHE_HASH_SLOTS]; |
---|
2350 | |
---|
2351 | AuthHash rrauth; |
---|
2352 | |
---|
2353 | // Fields below only required for mDNS Responder... |
---|
2354 | domainlabel nicelabel; // Rich text label encoded using canonically precomposed UTF-8 |
---|
2355 | domainlabel hostlabel; // Conforms to RFC 1034 "letter-digit-hyphen" ARPANET host name rules |
---|
2356 | domainname MulticastHostname; // Fully Qualified "dot-local" Host Name, e.g. "Foo.local." |
---|
2357 | UTF8str255 HIHardware; |
---|
2358 | UTF8str255 HISoftware; |
---|
2359 | AuthRecord DeviceInfo; |
---|
2360 | AuthRecord *ResourceRecords; |
---|
2361 | AuthRecord *DuplicateRecords; // Records currently 'on hold' because they are duplicates of existing records |
---|
2362 | AuthRecord *NewLocalRecords; // Fresh AuthRecords (public) not yet delivered to our local-only questions |
---|
2363 | AuthRecord *CurrentRecord; // Next AuthRecord about to be examined |
---|
2364 | mDNSBool NewLocalOnlyRecords; // Fresh AuthRecords (local only) not yet delivered to our local questions |
---|
2365 | NetworkInterfaceInfo *HostInterfaces; |
---|
2366 | mDNSs32 ProbeFailTime; |
---|
2367 | mDNSu32 NumFailedProbes; |
---|
2368 | mDNSs32 SuppressProbes; |
---|
2369 | Platform_t mDNS_plat; |
---|
2370 | |
---|
2371 | // Unicast-specific data |
---|
2372 | mDNSs32 NextuDNSEvent; // uDNS next event |
---|
2373 | mDNSs32 NextSRVUpdate; // Time to perform delayed update |
---|
2374 | |
---|
2375 | DNSServer *DNSServers; // list of DNS servers |
---|
2376 | McastResolver *McastResolvers; // list of Mcast Resolvers |
---|
2377 | |
---|
2378 | mDNSAddr Router; |
---|
2379 | mDNSAddr AdvertisedV4; // IPv4 address pointed to by hostname |
---|
2380 | mDNSAddr AdvertisedV6; // IPv6 address pointed to by hostname |
---|
2381 | |
---|
2382 | DomainAuthInfo *AuthInfoList; // list of domains requiring authentication for updates |
---|
2383 | |
---|
2384 | DNSQuestion ReverseMap; // Reverse-map query to find static hostname for service target |
---|
2385 | DNSQuestion AutomaticBrowseDomainQ; |
---|
2386 | domainname StaticHostname; // Current answer to reverse-map query |
---|
2387 | domainname FQDN; |
---|
2388 | HostnameInfo *Hostnames; // List of registered hostnames + hostname metadata |
---|
2389 | NATTraversalInfo AutoTunnelNAT; // Shared between all AutoTunnel DomainAuthInfo structs |
---|
2390 | mDNSv6Addr AutoTunnelRelayAddr; |
---|
2391 | |
---|
2392 | mDNSu32 WABBrowseQueriesCount; // Number of WAB Browse domain enumeration queries (b, db) callers |
---|
2393 | mDNSu32 WABLBrowseQueriesCount; // Number of legacy WAB Browse domain enumeration queries (lb) callers |
---|
2394 | mDNSu32 WABRegQueriesCount; // Number of WAB Registration domain enumeration queries (r, dr) callers |
---|
2395 | mDNSu8 SearchDomainsHash[MD5_LEN]; |
---|
2396 | |
---|
2397 | // NAT-Traversal fields |
---|
2398 | NATTraversalInfo LLQNAT; // Single shared NAT Traversal to receive inbound LLQ notifications |
---|
2399 | NATTraversalInfo *NATTraversals; |
---|
2400 | NATTraversalInfo *CurrentNATTraversal; |
---|
2401 | mDNSs32 retryIntervalGetAddr; // delta between time sent and retry for NAT-PMP & UPnP/IGD external address request |
---|
2402 | mDNSs32 retryGetAddr; // absolute time when we retry for NAT-PMP & UPnP/IGD external address request |
---|
2403 | mDNSv4Addr ExtAddress; // the external address discovered via NAT-PMP or UPnP/IGD |
---|
2404 | mDNSu32 PCPNonce[3]; // the nonce if using PCP |
---|
2405 | |
---|
2406 | UDPSocket *NATMcastRecvskt; // For receiving PCP & NAT-PMP announcement multicasts from router on port 5350 |
---|
2407 | mDNSu32 LastNATupseconds; // NAT engine uptime in seconds, from most recent NAT packet |
---|
2408 | mDNSs32 LastNATReplyLocalTime; // Local time in ticks when most recent NAT packet was received |
---|
2409 | mDNSu16 LastNATMapResultCode; // Most recent error code for mappings |
---|
2410 | |
---|
2411 | tcpLNTInfo tcpAddrInfo; // legacy NAT traversal TCP connection info for external address |
---|
2412 | tcpLNTInfo tcpDeviceInfo; // legacy NAT traversal TCP connection info for device info |
---|
2413 | tcpLNTInfo *tcpInfoUnmapList; // list of pending unmap requests |
---|
2414 | mDNSInterfaceID UPnPInterfaceID; |
---|
2415 | UDPSocket *SSDPSocket; // For SSDP request/response |
---|
2416 | mDNSBool SSDPWANPPPConnection; // whether we should send the SSDP query for WANIPConnection or WANPPPConnection |
---|
2417 | mDNSIPPort UPnPRouterPort; // port we send discovery messages to |
---|
2418 | mDNSIPPort UPnPSOAPPort; // port we send SOAP messages to |
---|
2419 | mDNSu8 *UPnPRouterURL; // router's URL string |
---|
2420 | mDNSBool UPnPWANPPPConnection; // whether we're using WANIPConnection or WANPPPConnection |
---|
2421 | mDNSu8 *UPnPSOAPURL; // router's SOAP control URL string |
---|
2422 | mDNSu8 *UPnPRouterAddressString; // holds both the router's address and port |
---|
2423 | mDNSu8 *UPnPSOAPAddressString; // holds both address and port for SOAP messages |
---|
2424 | |
---|
2425 | // Sleep Proxy client fields |
---|
2426 | AuthRecord *SPSRRSet; // To help the client keep track of the records registered with the sleep proxy |
---|
2427 | |
---|
2428 | // Sleep Proxy Server fields |
---|
2429 | mDNSu8 SPSType; // 0 = off, 10-99 encodes desirability metric |
---|
2430 | mDNSu8 SPSPortability; // 10-99 |
---|
2431 | mDNSu8 SPSMarginalPower; // 10-99 |
---|
2432 | mDNSu8 SPSTotalPower; // 10-99 |
---|
2433 | mDNSu8 SPSFeatureFlags; // Features supported. Currently 1 = TCP KeepAlive supported. |
---|
2434 | mDNSu8 SPSState; // 0 = off, 1 = running, 2 = shutting down, 3 = suspended during sleep |
---|
2435 | mDNSInterfaceID SPSProxyListChanged; |
---|
2436 | UDPSocket *SPSSocket; |
---|
2437 | #ifndef SPC_DISABLED |
---|
2438 | ServiceRecordSet SPSRecords; |
---|
2439 | #endif |
---|
2440 | mDNSQuestionCallback *SPSBrowseCallback; // So the platform layer can do something useful with SPS browse results |
---|
2441 | int ProxyRecords; // Total number of records we're holding as proxy |
---|
2442 | #define MAX_PROXY_RECORDS 10000 /* DOS protection: 400 machines at 25 records each */ |
---|
2443 | |
---|
2444 | #if APPLE_OSX_mDNSResponder |
---|
2445 | ClientTunnel *TunnelClients; |
---|
2446 | uuid_t asl_uuid; // uuid for ASL logging |
---|
2447 | void *WCF; |
---|
2448 | #endif |
---|
2449 | // DNS Proxy fields |
---|
2450 | mDNSu32 dp_ipintf[MaxIp]; // input interface index list from the DNS Proxy Client |
---|
2451 | mDNSu32 dp_opintf; // output interface index from the DNS Proxy Client |
---|
2452 | |
---|
2453 | TrustAnchor *TrustAnchors; |
---|
2454 | int notifyToken; |
---|
2455 | int uds_listener_skt; // Listening socket for incoming UDS clients |
---|
2456 | mDNSBool mDNSOppCaching; // Opportunistic Caching |
---|
2457 | mDNSu32 AutoTargetServices; // # of services that have AutoTarget set |
---|
2458 | DNSSECStatistics DNSSECStats; |
---|
2459 | mDNSStatistics mDNSStats; |
---|
2460 | |
---|
2461 | // Fixed storage, to avoid creating large objects on the stack |
---|
2462 | // The imsg is declared as a union with a pointer type to enforce CPU-appropriate alignment |
---|
2463 | union { DNSMessage m; void *p; } imsg; // Incoming message received from wire |
---|
2464 | DNSMessage omsg; // Outgoing message we're building |
---|
2465 | LargeCacheRecord rec; // Resource Record extracted from received message |
---|
2466 | }; |
---|
2467 | |
---|
2468 | #define FORALL_CACHERECORDS(SLOT,CG,CR) \ |
---|
2469 | for ((SLOT) = 0; (SLOT) < CACHE_HASH_SLOTS; (SLOT)++) \ |
---|
2470 | for ((CG)=m->rrcache_hash[(SLOT)]; (CG); (CG)=(CG)->next) \ |
---|
2471 | for ((CR) = (CG)->members; (CR); (CR)=(CR)->next) |
---|
2472 | |
---|
2473 | // *************************************************************************** |
---|
2474 | #if 0 |
---|
2475 | #pragma mark - |
---|
2476 | #pragma mark - Useful Static Constants |
---|
2477 | #endif |
---|
2478 | |
---|
2479 | extern const mDNSInterfaceID mDNSInterface_Any; // Zero |
---|
2480 | extern const mDNSInterfaceID mDNSInterface_LocalOnly; // Special value |
---|
2481 | extern const mDNSInterfaceID mDNSInterface_Unicast; // Special value |
---|
2482 | extern const mDNSInterfaceID mDNSInterfaceMark; // Special value |
---|
2483 | extern const mDNSInterfaceID mDNSInterface_P2P; // Special value |
---|
2484 | extern const mDNSInterfaceID uDNSInterfaceMark; // Special value |
---|
2485 | |
---|
2486 | extern const mDNSIPPort DiscardPort; |
---|
2487 | extern const mDNSIPPort SSHPort; |
---|
2488 | extern const mDNSIPPort UnicastDNSPort; |
---|
2489 | extern const mDNSIPPort SSDPPort; |
---|
2490 | extern const mDNSIPPort IPSECPort; |
---|
2491 | extern const mDNSIPPort NSIPCPort; |
---|
2492 | extern const mDNSIPPort NATPMPAnnouncementPort; |
---|
2493 | extern const mDNSIPPort NATPMPPort; |
---|
2494 | extern const mDNSIPPort DNSEXTPort; |
---|
2495 | extern const mDNSIPPort MulticastDNSPort; |
---|
2496 | extern const mDNSIPPort LoopbackIPCPort; |
---|
2497 | extern const mDNSIPPort PrivateDNSPort; |
---|
2498 | |
---|
2499 | extern const OwnerOptData zeroOwner; |
---|
2500 | |
---|
2501 | extern const mDNSIPPort zeroIPPort; |
---|
2502 | extern const mDNSv4Addr zerov4Addr; |
---|
2503 | extern const mDNSv6Addr zerov6Addr; |
---|
2504 | extern const mDNSEthAddr zeroEthAddr; |
---|
2505 | extern const mDNSv4Addr onesIPv4Addr; |
---|
2506 | extern const mDNSv6Addr onesIPv6Addr; |
---|
2507 | extern const mDNSEthAddr onesEthAddr; |
---|
2508 | extern const mDNSAddr zeroAddr; |
---|
2509 | |
---|
2510 | extern const mDNSv4Addr AllDNSAdminGroup; |
---|
2511 | extern const mDNSv4Addr AllHosts_v4; |
---|
2512 | extern const mDNSv6Addr AllHosts_v6; |
---|
2513 | extern const mDNSv6Addr NDP_prefix; |
---|
2514 | extern const mDNSEthAddr AllHosts_v6_Eth; |
---|
2515 | extern const mDNSAddr AllDNSLinkGroup_v4; |
---|
2516 | extern const mDNSAddr AllDNSLinkGroup_v6; |
---|
2517 | |
---|
2518 | extern const mDNSOpaque16 zeroID; |
---|
2519 | extern const mDNSOpaque16 onesID; |
---|
2520 | extern const mDNSOpaque16 QueryFlags; |
---|
2521 | extern const mDNSOpaque16 uQueryFlags; |
---|
2522 | extern const mDNSOpaque16 DNSSecQFlags; |
---|
2523 | extern const mDNSOpaque16 ResponseFlags; |
---|
2524 | extern const mDNSOpaque16 UpdateReqFlags; |
---|
2525 | extern const mDNSOpaque16 UpdateRespFlags; |
---|
2526 | |
---|
2527 | extern const mDNSOpaque64 zeroOpaque64; |
---|
2528 | |
---|
2529 | extern mDNSBool StrictUnicastOrdering; |
---|
2530 | extern mDNSu8 NumUnicastDNSServers; |
---|
2531 | |
---|
2532 | #define localdomain (*(const domainname *)"\x5" "local") |
---|
2533 | #define DeviceInfoName (*(const domainname *)"\xC" "_device-info" "\x4" "_tcp") |
---|
2534 | #define LocalDeviceInfoName (*(const domainname *)"\xC" "_device-info" "\x4" "_tcp" "\x5" "local") |
---|
2535 | #define SleepProxyServiceType (*(const domainname *)"\xC" "_sleep-proxy" "\x4" "_udp") |
---|
2536 | |
---|
2537 | // *************************************************************************** |
---|
2538 | #if 0 |
---|
2539 | #pragma mark - |
---|
2540 | #pragma mark - Inline functions |
---|
2541 | #endif |
---|
2542 | |
---|
2543 | #if (defined(_MSC_VER)) |
---|
2544 | #define mDNSinline static __inline |
---|
2545 | #elif ((__GNUC__ > 2) || ((__GNUC__ == 2) && (__GNUC_MINOR__ >= 9))) |
---|
2546 | #define mDNSinline static inline |
---|
2547 | #endif |
---|
2548 | |
---|
2549 | // If we're not doing inline functions, then this header needs to have the extern declarations |
---|
2550 | #if !defined(mDNSinline) |
---|
2551 | extern mDNSs32 NonZeroTime(mDNSs32 t); |
---|
2552 | extern mDNSu16 mDNSVal16(mDNSOpaque16 x); |
---|
2553 | extern mDNSOpaque16 mDNSOpaque16fromIntVal(mDNSu16 v); |
---|
2554 | #endif |
---|
2555 | |
---|
2556 | // If we're compiling the particular C file that instantiates our inlines, then we |
---|
2557 | // define "mDNSinline" (to empty string) so that we generate code in the following section |
---|
2558 | #if (!defined(mDNSinline) && mDNS_InstantiateInlines) |
---|
2559 | #define mDNSinline |
---|
2560 | #endif |
---|
2561 | |
---|
2562 | #ifdef mDNSinline |
---|
2563 | |
---|
2564 | mDNSinline mDNSs32 NonZeroTime(mDNSs32 t) { if (t) return(t);else return(1);} |
---|
2565 | |
---|
2566 | mDNSinline mDNSu16 mDNSVal16(mDNSOpaque16 x) { return((mDNSu16)((mDNSu16)x.b[0] << 8 | (mDNSu16)x.b[1])); } |
---|
2567 | |
---|
2568 | mDNSinline mDNSOpaque16 mDNSOpaque16fromIntVal(mDNSu16 v) |
---|
2569 | { |
---|
2570 | mDNSOpaque16 x; |
---|
2571 | x.b[0] = (mDNSu8)(v >> 8); |
---|
2572 | x.b[1] = (mDNSu8)(v & 0xFF); |
---|
2573 | return(x); |
---|
2574 | } |
---|
2575 | |
---|
2576 | #endif |
---|
2577 | |
---|
2578 | // *************************************************************************** |
---|
2579 | #if 0 |
---|
2580 | #pragma mark - |
---|
2581 | #pragma mark - Main Client Functions |
---|
2582 | #endif |
---|
2583 | |
---|
2584 | // Every client should call mDNS_Init, passing in storage for the mDNS object and the mDNS_PlatformSupport object. |
---|
2585 | // |
---|
2586 | // Clients that are only advertising services should use mDNS_Init_NoCache and mDNS_Init_ZeroCacheSize. |
---|
2587 | // Clients that plan to perform queries (mDNS_StartQuery, mDNS_StartBrowse, mDNS_StartResolveService, etc.) |
---|
2588 | // need to provide storage for the resource record cache, or the query calls will return 'mStatus_NoCache'. |
---|
2589 | // The rrcachestorage parameter is the address of memory for the resource record cache, and |
---|
2590 | // the rrcachesize parameter is the number of entries in the CacheRecord array passed in. |
---|
2591 | // (i.e. the size of the cache memory needs to be sizeof(CacheRecord) * rrcachesize). |
---|
2592 | // OS X 10.3 Panther uses an initial cache size of 64 entries, and then mDNSCore sends an |
---|
2593 | // mStatus_GrowCache message if it needs more. |
---|
2594 | // |
---|
2595 | // Most clients should use mDNS_Init_AdvertiseLocalAddresses. This causes mDNSCore to automatically |
---|
2596 | // create the correct address records for all the hosts interfaces. If you plan to advertise |
---|
2597 | // services being offered by the local machine, this is almost always what you want. |
---|
2598 | // There are two cases where you might use mDNS_Init_DontAdvertiseLocalAddresses: |
---|
2599 | // 1. A client-only device, that browses for services but doesn't advertise any of its own. |
---|
2600 | // 2. A proxy-registration service, that advertises services being offered by other machines, and takes |
---|
2601 | // the appropriate steps to manually create the correct address records for those other machines. |
---|
2602 | // In principle, a proxy-like registration service could manually create address records for its own machine too, |
---|
2603 | // but this would be pointless extra effort when using mDNS_Init_AdvertiseLocalAddresses does that for you. |
---|
2604 | // |
---|
2605 | // Note that a client-only device that wishes to prohibit multicast advertisements (e.g. from |
---|
2606 | // higher-layer API calls) must also set DivertMulticastAdvertisements in the mDNS structure and |
---|
2607 | // advertise local address(es) on a loopback interface. |
---|
2608 | // |
---|
2609 | // When mDNS has finished setting up the client's callback is called |
---|
2610 | // A client can also spin and poll the mDNSPlatformStatus field to see when it changes from mStatus_Waiting to mStatus_NoError |
---|
2611 | // |
---|
2612 | // Call mDNS_StartExit to tidy up before exiting |
---|
2613 | // Because exiting may be an asynchronous process (e.g. if unicast records need to be deregistered) |
---|
2614 | // client layer may choose to wait until mDNS_ExitNow() returns true before calling mDNS_FinalExit(). |
---|
2615 | // |
---|
2616 | // Call mDNS_Register with a completed AuthRecord object to register a resource record |
---|
2617 | // If the resource record type is kDNSRecordTypeUnique (or kDNSknownunique) then if a conflicting resource record is discovered, |
---|
2618 | // the resource record's mDNSRecordCallback will be called with error code mStatus_NameConflict. The callback should deregister |
---|
2619 | // the record, and may then try registering the record again after picking a new name (e.g. by automatically appending a number). |
---|
2620 | // Following deregistration, the RecordCallback will be called with result mStatus_MemFree to signal that it is safe to deallocate |
---|
2621 | // the record's storage (memory must be freed asynchronously to allow for goodbye packets and dynamic update deregistration). |
---|
2622 | // |
---|
2623 | // Call mDNS_StartQuery to initiate a query. mDNS will proceed to issue Multicast DNS query packets, and any time a response |
---|
2624 | // is received containing a record which matches the question, the DNSQuestion's mDNSAnswerCallback function will be called |
---|
2625 | // Call mDNS_StopQuery when no more answers are required |
---|
2626 | // |
---|
2627 | // Care should be taken on multi-threaded or interrupt-driven environments. |
---|
2628 | // The main mDNS routines call mDNSPlatformLock() on entry and mDNSPlatformUnlock() on exit; |
---|
2629 | // each platform layer needs to implement these appropriately for its respective platform. |
---|
2630 | // For example, if the support code on a particular platform implements timer callbacks at interrupt time, then |
---|
2631 | // mDNSPlatformLock/Unlock need to disable interrupts or do similar concurrency control to ensure that the mDNS |
---|
2632 | // code is not entered by an interrupt-time timer callback while in the middle of processing a client call. |
---|
2633 | |
---|
2634 | extern mStatus mDNS_Init (mDNS *const m, mDNS_PlatformSupport *const p, |
---|
2635 | CacheEntity *rrcachestorage, mDNSu32 rrcachesize, |
---|
2636 | mDNSBool AdvertiseLocalAddresses, |
---|
2637 | mDNSCallback *Callback, void *Context); |
---|
2638 | // See notes above on use of NoCache/ZeroCacheSize |
---|
2639 | #define mDNS_Init_NoCache mDNSNULL |
---|
2640 | #define mDNS_Init_ZeroCacheSize 0 |
---|
2641 | // See notes above on use of Advertise/DontAdvertiseLocalAddresses |
---|
2642 | #define mDNS_Init_AdvertiseLocalAddresses mDNStrue |
---|
2643 | #define mDNS_Init_DontAdvertiseLocalAddresses mDNSfalse |
---|
2644 | #define mDNS_Init_NoInitCallback mDNSNULL |
---|
2645 | #define mDNS_Init_NoInitCallbackContext mDNSNULL |
---|
2646 | |
---|
2647 | extern void mDNS_ConfigChanged(mDNS *const m); |
---|
2648 | extern void mDNS_GrowCache (mDNS *const m, CacheEntity *storage, mDNSu32 numrecords); |
---|
2649 | extern void mDNS_GrowAuth (mDNS *const m, AuthEntity *storage, mDNSu32 numrecords); |
---|
2650 | extern void mDNS_StartExit (mDNS *const m); |
---|
2651 | extern void mDNS_FinalExit (mDNS *const m); |
---|
2652 | #define mDNS_Close(m) do { mDNS_StartExit(m); mDNS_FinalExit(m); } while(0) |
---|
2653 | #define mDNS_ExitNow(m, now) ((now) - (m)->ShutdownTime >= 0 || (!(m)->ResourceRecords)) |
---|
2654 | |
---|
2655 | extern mDNSs32 mDNS_Execute (mDNS *const m); |
---|
2656 | |
---|
2657 | extern mStatus mDNS_Register (mDNS *const m, AuthRecord *const rr); |
---|
2658 | extern mStatus mDNS_Update (mDNS *const m, AuthRecord *const rr, mDNSu32 newttl, |
---|
2659 | const mDNSu16 newrdlength, RData *const newrdata, mDNSRecordUpdateCallback *Callback); |
---|
2660 | extern mStatus mDNS_Deregister(mDNS *const m, AuthRecord *const rr); |
---|
2661 | |
---|
2662 | extern mStatus mDNS_StartQuery(mDNS *const m, DNSQuestion *const question); |
---|
2663 | extern mStatus mDNS_StopQuery (mDNS *const m, DNSQuestion *const question); |
---|
2664 | extern mStatus mDNS_StopQueryWithRemoves(mDNS *const m, DNSQuestion *const question); |
---|
2665 | extern mStatus mDNS_Reconfirm (mDNS *const m, CacheRecord *const cacherr); |
---|
2666 | extern mStatus mDNS_Reconfirm_internal(mDNS *const m, CacheRecord *const rr, mDNSu32 interval); |
---|
2667 | extern mStatus mDNS_ReconfirmByValue(mDNS *const m, ResourceRecord *const rr); |
---|
2668 | extern void mDNS_PurgeCacheResourceRecord(mDNS *const m, CacheRecord *rr); |
---|
2669 | extern mDNSs32 mDNS_TimeNow(const mDNS *const m); |
---|
2670 | |
---|
2671 | extern mStatus mDNS_StartNATOperation(mDNS *const m, NATTraversalInfo *traversal); |
---|
2672 | extern mStatus mDNS_StopNATOperation(mDNS *const m, NATTraversalInfo *traversal); |
---|
2673 | extern mStatus mDNS_StopNATOperation_internal(mDNS *m, NATTraversalInfo *traversal); |
---|
2674 | |
---|
2675 | extern DomainAuthInfo *GetAuthInfoForName(mDNS *m, const domainname *const name); |
---|
2676 | |
---|
2677 | extern void mDNS_UpdateAllowSleep(mDNS *const m); |
---|
2678 | |
---|
2679 | // *************************************************************************** |
---|
2680 | #if 0 |
---|
2681 | #pragma mark - |
---|
2682 | #pragma mark - Platform support functions that are accessible to the client layer too |
---|
2683 | #endif |
---|
2684 | |
---|
2685 | extern mDNSs32 mDNSPlatformOneSecond; |
---|
2686 | |
---|
2687 | // *************************************************************************** |
---|
2688 | #if 0 |
---|
2689 | #pragma mark - |
---|
2690 | #pragma mark - General utility and helper functions |
---|
2691 | #endif |
---|
2692 | |
---|
2693 | // mDNS_Dereg_normal is used for most calls to mDNS_Deregister_internal |
---|
2694 | // mDNS_Dereg_rapid is used to send one goodbye instead of three, when we want the memory available for reuse sooner |
---|
2695 | // mDNS_Dereg_conflict is used to indicate that this record is being forcibly deregistered because of a conflict |
---|
2696 | // mDNS_Dereg_repeat is used when cleaning up, for records that may have already been forcibly deregistered |
---|
2697 | typedef enum { mDNS_Dereg_normal, mDNS_Dereg_rapid, mDNS_Dereg_conflict, mDNS_Dereg_repeat } mDNS_Dereg_type; |
---|
2698 | |
---|
2699 | // mDNS_RegisterService is a single call to register the set of resource records associated with a given named service. |
---|
2700 | // |
---|
2701 | // mDNS_StartResolveService is single call which is equivalent to multiple calls to mDNS_StartQuery, |
---|
2702 | // to find the IP address, port number, and demultiplexing information for a given named service. |
---|
2703 | // As with mDNS_StartQuery, it executes asynchronously, and calls the ServiceInfoQueryCallback when the answer is |
---|
2704 | // found. After the service is resolved, the client should call mDNS_StopResolveService to complete the transaction. |
---|
2705 | // The client can also call mDNS_StopResolveService at any time to abort the transaction. |
---|
2706 | // |
---|
2707 | // mDNS_AddRecordToService adds an additional record to a Service Record Set. This record may be deregistered |
---|
2708 | // via mDNS_RemoveRecordFromService, or by deregistering the service. mDNS_RemoveRecordFromService is passed a |
---|
2709 | // callback to free the memory associated with the extra RR when it is safe to do so. The ExtraResourceRecord |
---|
2710 | // object can be found in the record's context pointer. |
---|
2711 | |
---|
2712 | // mDNS_GetBrowseDomains is a special case of the mDNS_StartQuery call, where the resulting answers |
---|
2713 | // are a list of PTR records indicating (in the rdata) domains that are recommended for browsing. |
---|
2714 | // After getting the list of domains to browse, call mDNS_StopQuery to end the search. |
---|
2715 | // mDNS_GetDefaultBrowseDomain returns the name of the domain that should be highlighted by default. |
---|
2716 | // |
---|
2717 | // mDNS_GetRegistrationDomains and mDNS_GetDefaultRegistrationDomain are the equivalent calls to get the list |
---|
2718 | // of one or more domains that should be offered to the user as choices for where they may register their service, |
---|
2719 | // and the default domain in which to register in the case where the user has made no selection. |
---|
2720 | |
---|
2721 | extern void mDNS_SetupResourceRecord(AuthRecord *rr, RData *RDataStorage, mDNSInterfaceID InterfaceID, |
---|
2722 | mDNSu16 rrtype, mDNSu32 ttl, mDNSu8 RecordType, AuthRecType artype, mDNSRecordCallback Callback, void *Context); |
---|
2723 | |
---|
2724 | // mDNS_RegisterService() flags parameter bit definitions. |
---|
2725 | // Note these are only defined to transfer the corresponding DNSServiceFlags settings into mDNSCore routines, |
---|
2726 | // since code in mDNSCore does not include the DNSServiceFlags definitions in dns_sd.h. |
---|
2727 | enum |
---|
2728 | { |
---|
2729 | coreFlagIncludeP2P = 0x1, // include P2P interfaces when using mDNSInterface_Any |
---|
2730 | coreFlagIncludeAWDL = 0x2, // include AWDL interface when using mDNSInterface_Any |
---|
2731 | coreFlagKnownUnique = 0x4, // client guarantees that SRV and TXT record names are unique |
---|
2732 | coreFlagWakeOnly = 0x8 // Service won't be registered with sleep proxy |
---|
2733 | }; |
---|
2734 | |
---|
2735 | extern mStatus mDNS_RegisterService (mDNS *const m, ServiceRecordSet *sr, |
---|
2736 | const domainlabel *const name, const domainname *const type, const domainname *const domain, |
---|
2737 | const domainname *const host, mDNSIPPort port, const mDNSu8 txtinfo[], mDNSu16 txtlen, |
---|
2738 | AuthRecord *SubTypes, mDNSu32 NumSubTypes, |
---|
2739 | mDNSInterfaceID InterfaceID, mDNSServiceCallback Callback, void *Context, mDNSu32 flags); |
---|
2740 | extern mStatus mDNS_AddRecordToService(mDNS *const m, ServiceRecordSet *sr, ExtraResourceRecord *extra, RData *rdata, mDNSu32 ttl, mDNSu32 flags); |
---|
2741 | extern mStatus mDNS_RemoveRecordFromService(mDNS *const m, ServiceRecordSet *sr, ExtraResourceRecord *extra, mDNSRecordCallback MemFreeCallback, void *Context); |
---|
2742 | extern mStatus mDNS_RenameAndReregisterService(mDNS *const m, ServiceRecordSet *const sr, const domainlabel *newname); |
---|
2743 | extern mStatus mDNS_DeregisterService_drt(mDNS *const m, ServiceRecordSet *sr, mDNS_Dereg_type drt); |
---|
2744 | #define mDNS_DeregisterService(M,S) mDNS_DeregisterService_drt((M), (S), mDNS_Dereg_normal) |
---|
2745 | |
---|
2746 | extern mStatus mDNS_RegisterNoSuchService(mDNS *const m, AuthRecord *const rr, |
---|
2747 | const domainlabel *const name, const domainname *const type, const domainname *const domain, |
---|
2748 | const domainname *const host, |
---|
2749 | const mDNSInterfaceID InterfaceID, mDNSRecordCallback Callback, void *Context, mDNSu32 flags); |
---|
2750 | #define mDNS_DeregisterNoSuchService mDNS_Deregister |
---|
2751 | |
---|
2752 | extern void mDNS_SetupQuestion(DNSQuestion *const q, const mDNSInterfaceID InterfaceID, const domainname *const name, |
---|
2753 | const mDNSu16 qtype, mDNSQuestionCallback *const callback, void *const context); |
---|
2754 | |
---|
2755 | extern mStatus mDNS_StartBrowse(mDNS *const m, DNSQuestion *const question, |
---|
2756 | const domainname *const srv, const domainname *const domain, const mDNSu8 *anondata, |
---|
2757 | const mDNSInterfaceID InterfaceID, mDNSu32 flags, |
---|
2758 | mDNSBool ForceMCast, mDNSBool useBackgroundTrafficClass, |
---|
2759 | mDNSQuestionCallback *Callback, void *Context); |
---|
2760 | #define mDNS_StopBrowse mDNS_StopQuery |
---|
2761 | |
---|
2762 | extern mStatus mDNS_StartResolveService(mDNS *const m, ServiceInfoQuery *query, ServiceInfo *info, mDNSServiceInfoQueryCallback *Callback, void *Context); |
---|
2763 | extern void mDNS_StopResolveService (mDNS *const m, ServiceInfoQuery *query); |
---|
2764 | |
---|
2765 | typedef enum |
---|
2766 | { |
---|
2767 | mDNS_DomainTypeBrowse = 0, |
---|
2768 | mDNS_DomainTypeBrowseDefault = 1, |
---|
2769 | mDNS_DomainTypeBrowseAutomatic = 2, |
---|
2770 | mDNS_DomainTypeRegistration = 3, |
---|
2771 | mDNS_DomainTypeRegistrationDefault = 4, |
---|
2772 | |
---|
2773 | mDNS_DomainTypeMax = 4 |
---|
2774 | } mDNS_DomainType; |
---|
2775 | |
---|
2776 | extern const char *const mDNS_DomainTypeNames[]; |
---|
2777 | |
---|
2778 | extern mStatus mDNS_GetDomains(mDNS *const m, DNSQuestion *const question, mDNS_DomainType DomainType, const domainname *dom, |
---|
2779 | const mDNSInterfaceID InterfaceID, mDNSQuestionCallback *Callback, void *Context); |
---|
2780 | #define mDNS_StopGetDomains mDNS_StopQuery |
---|
2781 | extern mStatus mDNS_AdvertiseDomains(mDNS *const m, AuthRecord *rr, mDNS_DomainType DomainType, const mDNSInterfaceID InterfaceID, char *domname); |
---|
2782 | #define mDNS_StopAdvertiseDomains mDNS_Deregister |
---|
2783 | |
---|
2784 | extern mDNSOpaque16 mDNS_NewMessageID(mDNS *const m); |
---|
2785 | extern mDNSBool mDNS_AddressIsLocalSubnet(mDNS *const m, const mDNSInterfaceID InterfaceID, const mDNSAddr *addr, mDNSBool *myself); |
---|
2786 | |
---|
2787 | extern DNSServer *GetServerForQuestion(mDNS *m, DNSQuestion *question); |
---|
2788 | extern mDNSu32 SetValidDNSServers(mDNS *m, DNSQuestion *question); |
---|
2789 | |
---|
2790 | // *************************************************************************** |
---|
2791 | #if 0 |
---|
2792 | #pragma mark - |
---|
2793 | #pragma mark - DNS name utility functions |
---|
2794 | #endif |
---|
2795 | |
---|
2796 | // In order to expose the full capabilities of the DNS protocol (which allows any arbitrary eight-bit values |
---|
2797 | // in domain name labels, including unlikely characters like ascii nulls and even dots) all the mDNS APIs |
---|
2798 | // work with DNS's native length-prefixed strings. For convenience in C, the following utility functions |
---|
2799 | // are provided for converting between C's null-terminated strings and DNS's length-prefixed strings. |
---|
2800 | |
---|
2801 | // Assignment |
---|
2802 | // A simple C structure assignment of a domainname can cause a protection fault by accessing unmapped memory, |
---|
2803 | // because that object is defined to be 256 bytes long, but not all domainname objects are truly the full size. |
---|
2804 | // This macro uses mDNSPlatformMemCopy() to make sure it only touches the actual bytes that are valid. |
---|
2805 | #define AssignDomainName(DST, SRC) do { mDNSu16 len__ = DomainNameLength((SRC)); \ |
---|
2806 | if (len__ <= MAX_DOMAIN_NAME) mDNSPlatformMemCopy((DST)->c, (SRC)->c, len__);else (DST)->c[0] = 0;} while(0) |
---|
2807 | |
---|
2808 | // Comparison functions |
---|
2809 | #define SameDomainLabelCS(A,B) ((A)[0] == (B)[0] && mDNSPlatformMemSame((A)+1, (B)+1, (A)[0])) |
---|
2810 | extern mDNSBool SameDomainLabel(const mDNSu8 *a, const mDNSu8 *b); |
---|
2811 | extern mDNSBool SameDomainName(const domainname *const d1, const domainname *const d2); |
---|
2812 | extern mDNSBool SameDomainNameCS(const domainname *const d1, const domainname *const d2); |
---|
2813 | typedef mDNSBool DomainNameComparisonFn (const domainname *const d1, const domainname *const d2); |
---|
2814 | extern mDNSBool IsLocalDomain(const domainname *d); // returns true for domains that by default should be looked up using link-local multicast |
---|
2815 | |
---|
2816 | #define StripFirstLabel(X) ((const domainname *)& (X)->c[(X)->c[0] ? 1 + (X)->c[0] : 0]) |
---|
2817 | |
---|
2818 | #define FirstLabel(X) ((const domainlabel *)(X)) |
---|
2819 | #define SecondLabel(X) ((const domainlabel *)StripFirstLabel(X)) |
---|
2820 | #define ThirdLabel(X) ((const domainlabel *)StripFirstLabel(StripFirstLabel(X))) |
---|
2821 | |
---|
2822 | extern const mDNSu8 *LastLabel(const domainname *d); |
---|
2823 | |
---|
2824 | // Get total length of domain name, in native DNS format, including terminal root label |
---|
2825 | // (e.g. length of "com." is 5 (length byte, three data bytes, final zero) |
---|
2826 | extern mDNSu16 DomainNameLengthLimit(const domainname *const name, const mDNSu8 *limit); |
---|
2827 | #define DomainNameLength(name) DomainNameLengthLimit((name), (name)->c + MAX_DOMAIN_NAME) |
---|
2828 | |
---|
2829 | // Append functions to append one or more labels to an existing native format domain name: |
---|
2830 | // AppendLiteralLabelString adds a single label from a literal C string, with no escape character interpretation. |
---|
2831 | // AppendDNSNameString adds zero or more labels from a C string using conventional DNS dots-and-escaping interpretation |
---|
2832 | // AppendDomainLabel adds a single label from a native format domainlabel |
---|
2833 | // AppendDomainName adds zero or more labels from a native format domainname |
---|
2834 | extern mDNSu8 *AppendLiteralLabelString(domainname *const name, const char *cstr); |
---|
2835 | extern mDNSu8 *AppendDNSNameString (domainname *const name, const char *cstr); |
---|
2836 | extern mDNSu8 *AppendDomainLabel (domainname *const name, const domainlabel *const label); |
---|
2837 | extern mDNSu8 *AppendDomainName (domainname *const name, const domainname *const append); |
---|
2838 | |
---|
2839 | // Convert from null-terminated string to native DNS format: |
---|
2840 | // The DomainLabel form makes a single label from a literal C string, with no escape character interpretation. |
---|
2841 | // The DomainName form makes native format domain name from a C string using conventional DNS interpretation: |
---|
2842 | // dots separate labels, and within each label, '\.' represents a literal dot, '\\' represents a literal |
---|
2843 | // backslash and backslash with three decimal digits (e.g. \000) represents an arbitrary byte value. |
---|
2844 | extern mDNSBool MakeDomainLabelFromLiteralString(domainlabel *const label, const char *cstr); |
---|
2845 | extern mDNSu8 *MakeDomainNameFromDNSNameString (domainname *const name, const char *cstr); |
---|
2846 | |
---|
2847 | // Convert native format domainlabel or domainname back to C string format |
---|
2848 | // IMPORTANT: |
---|
2849 | // When using ConvertDomainLabelToCString, the target buffer must be MAX_ESCAPED_DOMAIN_LABEL (254) bytes long |
---|
2850 | // to guarantee there will be no buffer overrun. It is only safe to use a buffer shorter than this in rare cases |
---|
2851 | // where the label is known to be constrained somehow (for example, if the label is known to be either "_tcp" or "_udp"). |
---|
2852 | // Similarly, when using ConvertDomainNameToCString, the target buffer must be MAX_ESCAPED_DOMAIN_NAME (1009) bytes long. |
---|
2853 | // See definitions of MAX_ESCAPED_DOMAIN_LABEL and MAX_ESCAPED_DOMAIN_NAME for more detailed explanation. |
---|
2854 | extern char *ConvertDomainLabelToCString_withescape(const domainlabel *const name, char *cstr, char esc); |
---|
2855 | #define ConvertDomainLabelToCString_unescaped(D,C) ConvertDomainLabelToCString_withescape((D), (C), 0) |
---|
2856 | #define ConvertDomainLabelToCString(D,C) ConvertDomainLabelToCString_withescape((D), (C), '\\') |
---|
2857 | extern char *ConvertDomainNameToCString_withescape(const domainname *const name, char *cstr, char esc); |
---|
2858 | #define ConvertDomainNameToCString_unescaped(D,C) ConvertDomainNameToCString_withescape((D), (C), 0) |
---|
2859 | #define ConvertDomainNameToCString(D,C) ConvertDomainNameToCString_withescape((D), (C), '\\') |
---|
2860 | |
---|
2861 | extern void ConvertUTF8PstringToRFC1034HostLabel(const mDNSu8 UTF8Name[], domainlabel *const hostlabel); |
---|
2862 | |
---|
2863 | extern mDNSu8 *ConstructServiceName(domainname *const fqdn, const domainlabel *name, const domainname *type, const domainname *const domain); |
---|
2864 | extern mDNSBool DeconstructServiceName(const domainname *const fqdn, domainlabel *const name, domainname *const type, domainname *const domain); |
---|
2865 | |
---|
2866 | // Note: Some old functions have been replaced by more sensibly-named versions. |
---|
2867 | // You can uncomment the hash-defines below if you don't want to have to change your source code right away. |
---|
2868 | // When updating your code, note that (unlike the old versions) *all* the new routines take the target object |
---|
2869 | // as their first parameter. |
---|
2870 | //#define ConvertCStringToDomainName(SRC,DST) MakeDomainNameFromDNSNameString((DST),(SRC)) |
---|
2871 | //#define ConvertCStringToDomainLabel(SRC,DST) MakeDomainLabelFromLiteralString((DST),(SRC)) |
---|
2872 | //#define AppendStringLabelToName(DST,SRC) AppendLiteralLabelString((DST),(SRC)) |
---|
2873 | //#define AppendStringNameToName(DST,SRC) AppendDNSNameString((DST),(SRC)) |
---|
2874 | //#define AppendDomainLabelToName(DST,SRC) AppendDomainLabel((DST),(SRC)) |
---|
2875 | //#define AppendDomainNameToName(DST,SRC) AppendDomainName((DST),(SRC)) |
---|
2876 | |
---|
2877 | // *************************************************************************** |
---|
2878 | #if 0 |
---|
2879 | #pragma mark - |
---|
2880 | #pragma mark - Other utility functions and macros |
---|
2881 | #endif |
---|
2882 | |
---|
2883 | // mDNS_vsnprintf/snprintf return the number of characters written, excluding the final terminating null. |
---|
2884 | // The output is always null-terminated: for example, if the output turns out to be exactly buflen long, |
---|
2885 | // then the output will be truncated by one character to allow space for the terminating null. |
---|
2886 | // Unlike standard C vsnprintf/snprintf, they return the number of characters *actually* written, |
---|
2887 | // not the number of characters that *would* have been printed were buflen unlimited. |
---|
2888 | extern mDNSu32 mDNS_vsnprintf(char *sbuffer, mDNSu32 buflen, const char *fmt, va_list arg); |
---|
2889 | extern mDNSu32 mDNS_snprintf(char *sbuffer, mDNSu32 buflen, const char *fmt, ...) IS_A_PRINTF_STYLE_FUNCTION(3,4); |
---|
2890 | extern mDNSu32 NumCacheRecordsForInterfaceID(const mDNS *const m, mDNSInterfaceID id); |
---|
2891 | extern char *DNSTypeName(mDNSu16 rrtype); |
---|
2892 | extern char *GetRRDisplayString_rdb(const ResourceRecord *const rr, const RDataBody *const rd1, char *const buffer); |
---|
2893 | #define RRDisplayString(m, rr) GetRRDisplayString_rdb(rr, &(rr)->rdata->u, (m)->MsgBuffer) |
---|
2894 | #define ARDisplayString(m, rr) GetRRDisplayString_rdb(&(rr)->resrec, &(rr)->resrec.rdata->u, (m)->MsgBuffer) |
---|
2895 | #define CRDisplayString(m, rr) GetRRDisplayString_rdb(&(rr)->resrec, &(rr)->resrec.rdata->u, (m)->MsgBuffer) |
---|
2896 | extern mDNSBool mDNSSameAddress(const mDNSAddr *ip1, const mDNSAddr *ip2); |
---|
2897 | extern void IncrementLabelSuffix(domainlabel *name, mDNSBool RichText); |
---|
2898 | extern mDNSBool mDNSv4AddrIsRFC1918(const mDNSv4Addr * const addr); // returns true for RFC1918 private addresses |
---|
2899 | #define mDNSAddrIsRFC1918(X) ((X)->type == mDNSAddrType_IPv4 && mDNSv4AddrIsRFC1918(&(X)->ip.v4)) |
---|
2900 | |
---|
2901 | // For PCP |
---|
2902 | extern void mDNSAddrMapIPv4toIPv6(mDNSv4Addr* in, mDNSv6Addr* out); |
---|
2903 | extern mDNSBool mDNSAddrIPv4FromMappedIPv6(mDNSv6Addr *in, mDNSv4Addr *out); |
---|
2904 | |
---|
2905 | #define mDNSSameIPPort(A,B) ((A).NotAnInteger == (B).NotAnInteger) |
---|
2906 | #define mDNSSameOpaque16(A,B) ((A).NotAnInteger == (B).NotAnInteger) |
---|
2907 | #define mDNSSameOpaque32(A,B) ((A).NotAnInteger == (B).NotAnInteger) |
---|
2908 | #define mDNSSameOpaque64(A,B) ((A)->l[0] == (B)->l[0] && (A)->l[1] == (B)->l[1]) |
---|
2909 | |
---|
2910 | #define mDNSSameIPv4Address(A,B) ((A).NotAnInteger == (B).NotAnInteger) |
---|
2911 | #define mDNSSameIPv6Address(A,B) ((A).l[0] == (B).l[0] && (A).l[1] == (B).l[1] && (A).l[2] == (B).l[2] && (A).l[3] == (B).l[3]) |
---|
2912 | #define mDNSSameIPv6NetworkPart(A,B) ((A).l[0] == (B).l[0] && (A).l[1] == (B).l[1]) |
---|
2913 | #define mDNSSameEthAddress(A,B) ((A)->w[0] == (B)->w[0] && (A)->w[1] == (B)->w[1] && (A)->w[2] == (B)->w[2]) |
---|
2914 | |
---|
2915 | #define mDNSIPPortIsZero(A) ((A).NotAnInteger == 0) |
---|
2916 | #define mDNSOpaque16IsZero(A) ((A).NotAnInteger == 0) |
---|
2917 | #define mDNSOpaque64IsZero(A) (((A)->l[0] | (A)->l[1] ) == 0) |
---|
2918 | #define mDNSIPv4AddressIsZero(A) ((A).NotAnInteger == 0) |
---|
2919 | #define mDNSIPv6AddressIsZero(A) (((A).l[0] | (A).l[1] | (A).l[2] | (A).l[3]) == 0) |
---|
2920 | #define mDNSEthAddressIsZero(A) (((A).w[0] | (A).w[1] | (A).w[2] ) == 0) |
---|
2921 | |
---|
2922 | #define mDNSIPv4AddressIsOnes(A) ((A).NotAnInteger == 0xFFFFFFFF) |
---|
2923 | #define mDNSIPv6AddressIsOnes(A) (((A).l[0] & (A).l[1] & (A).l[2] & (A).l[3]) == 0xFFFFFFFF) |
---|
2924 | |
---|
2925 | #define mDNSAddressIsAllDNSLinkGroup(X) ( \ |
---|
2926 | ((X)->type == mDNSAddrType_IPv4 && mDNSSameIPv4Address((X)->ip.v4, AllDNSLinkGroup_v4.ip.v4)) || \ |
---|
2927 | ((X)->type == mDNSAddrType_IPv6 && mDNSSameIPv6Address((X)->ip.v6, AllDNSLinkGroup_v6.ip.v6)) ) |
---|
2928 | |
---|
2929 | #define mDNSAddressIsZero(X) ( \ |
---|
2930 | ((X)->type == mDNSAddrType_IPv4 && mDNSIPv4AddressIsZero((X)->ip.v4)) || \ |
---|
2931 | ((X)->type == mDNSAddrType_IPv6 && mDNSIPv6AddressIsZero((X)->ip.v6)) ) |
---|
2932 | |
---|
2933 | #define mDNSAddressIsValidNonZero(X) ( \ |
---|
2934 | ((X)->type == mDNSAddrType_IPv4 && !mDNSIPv4AddressIsZero((X)->ip.v4)) || \ |
---|
2935 | ((X)->type == mDNSAddrType_IPv6 && !mDNSIPv6AddressIsZero((X)->ip.v6)) ) |
---|
2936 | |
---|
2937 | #define mDNSAddressIsOnes(X) ( \ |
---|
2938 | ((X)->type == mDNSAddrType_IPv4 && mDNSIPv4AddressIsOnes((X)->ip.v4)) || \ |
---|
2939 | ((X)->type == mDNSAddrType_IPv6 && mDNSIPv6AddressIsOnes((X)->ip.v6)) ) |
---|
2940 | |
---|
2941 | #define mDNSAddressIsValid(X) ( \ |
---|
2942 | ((X)->type == mDNSAddrType_IPv4) ? !(mDNSIPv4AddressIsZero((X)->ip.v4) || mDNSIPv4AddressIsOnes((X)->ip.v4)) : \ |
---|
2943 | ((X)->type == mDNSAddrType_IPv6) ? !(mDNSIPv6AddressIsZero((X)->ip.v6) || mDNSIPv6AddressIsOnes((X)->ip.v6)) : mDNSfalse) |
---|
2944 | |
---|
2945 | #define mDNSv4AddressIsLinkLocal(X) ((X)->b[0] == 169 && (X)->b[1] == 254) |
---|
2946 | #define mDNSv6AddressIsLinkLocal(X) ((X)->b[0] == 0xFE && ((X)->b[1] & 0xC0) == 0x80) |
---|
2947 | |
---|
2948 | #define mDNSAddressIsLinkLocal(X) ( \ |
---|
2949 | ((X)->type == mDNSAddrType_IPv4) ? mDNSv4AddressIsLinkLocal(&(X)->ip.v4) : \ |
---|
2950 | ((X)->type == mDNSAddrType_IPv6) ? mDNSv6AddressIsLinkLocal(&(X)->ip.v6) : mDNSfalse) |
---|
2951 | |
---|
2952 | #define mDNSv4AddressIsLoopback(X) ((X)->b[0] == 127 && (X)->b[1] == 0 && (X)->b[2] == 0 && (X)->b[3] == 1) |
---|
2953 | #define mDNSv6AddressIsLoopback(X) ((((X)->l[0] | (X)->l[1] | (X)->l[2]) == 0) && ((X)->b[12] == 0 && (X)->b[13] == 0 && (X)->b[14] == 0 && (X)->b[15] == 1)) |
---|
2954 | |
---|
2955 | #define mDNSAddressIsLoopback(X) ( \ |
---|
2956 | ((X)->type == mDNSAddrType_IPv4) ? mDNSv4AddressIsLoopback(&(X)->ip.v4) : \ |
---|
2957 | ((X)->type == mDNSAddrType_IPv6) ? mDNSv6AddressIsLoopback(&(X)->ip.v6) : mDNSfalse) |
---|
2958 | |
---|
2959 | // *************************************************************************** |
---|
2960 | #if 0 |
---|
2961 | #pragma mark - |
---|
2962 | #pragma mark - Authentication Support |
---|
2963 | #endif |
---|
2964 | |
---|
2965 | // Unicast DNS and Dynamic Update specific Client Calls |
---|
2966 | // |
---|
2967 | // mDNS_SetSecretForDomain tells the core to authenticate (via TSIG with an HMAC_MD5 hash of the shared secret) |
---|
2968 | // when dynamically updating a given zone (and its subdomains). The key used in authentication must be in |
---|
2969 | // domain name format. The shared secret must be a null-terminated base64 encoded string. A minimum size of |
---|
2970 | // 16 bytes (128 bits) is recommended for an MD5 hash as per RFC 2485. |
---|
2971 | // Calling this routine multiple times for a zone replaces previously entered values. Call with a NULL key |
---|
2972 | // to disable authentication for the zone. A non-NULL autoTunnelPrefix means this is an AutoTunnel domain, |
---|
2973 | // and the value is prepended to the IPSec identifier (used for key lookup) |
---|
2974 | |
---|
2975 | extern mStatus mDNS_SetSecretForDomain(mDNS *m, DomainAuthInfo *info, |
---|
2976 | const domainname *domain, const domainname *keyname, const char *b64keydata, const domainname *hostname, mDNSIPPort *port, mDNSBool autoTunnel); |
---|
2977 | |
---|
2978 | extern void RecreateNATMappings(mDNS *const m, const mDNSu32 waitTicks); |
---|
2979 | |
---|
2980 | // Hostname/Unicast Interface Configuration |
---|
2981 | |
---|
2982 | // All hostnames advertised point to one IPv4 address and/or one IPv6 address, set via SetPrimaryInterfaceInfo. Invoking this routine |
---|
2983 | // updates all existing hostnames to point to the new address. |
---|
2984 | |
---|
2985 | // A hostname is added via AddDynDNSHostName, which points to the primary interface's v4 and/or v6 addresss |
---|
2986 | |
---|
2987 | // The status callback is invoked to convey success or failure codes - the callback should not modify the AuthRecord or free memory. |
---|
2988 | // Added hostnames may be removed (deregistered) via mDNS_RemoveDynDNSHostName. |
---|
2989 | |
---|
2990 | // Host domains added prior to specification of the primary interface address and computer name will be deferred until |
---|
2991 | // these values are initialized. |
---|
2992 | |
---|
2993 | // DNS servers used to resolve unicast queries are specified by mDNS_AddDNSServer. |
---|
2994 | // For "split" DNS configurations, in which queries for different domains are sent to different servers (e.g. VPN and external), |
---|
2995 | // a domain may be associated with a DNS server. For standard configurations, specify the root label (".") or NULL. |
---|
2996 | |
---|
2997 | extern void mDNS_AddDynDNSHostName(mDNS *m, const domainname *fqdn, mDNSRecordCallback *StatusCallback, const void *StatusContext); |
---|
2998 | extern void mDNS_RemoveDynDNSHostName(mDNS *m, const domainname *fqdn); |
---|
2999 | extern void mDNS_SetPrimaryInterfaceInfo(mDNS *m, const mDNSAddr *v4addr, const mDNSAddr *v6addr, const mDNSAddr *router); |
---|
3000 | extern DNSServer *mDNS_AddDNSServer(mDNS *const m, const domainname *d, const mDNSInterfaceID interface, mDNSs32 serviceID, const mDNSAddr *addr, |
---|
3001 | const mDNSIPPort port, mDNSu32 scoped, mDNSu32 timeout, mDNSBool cellIntf, mDNSu16 resGroupID, mDNSBool reqA, |
---|
3002 | mDNSBool reqAAAA, mDNSBool reqDO); |
---|
3003 | extern void PenalizeDNSServer(mDNS *const m, DNSQuestion *q, mDNSOpaque16 responseFlags); |
---|
3004 | extern void mDNS_AddSearchDomain(const domainname *const domain, mDNSInterfaceID InterfaceID); |
---|
3005 | |
---|
3006 | extern McastResolver *mDNS_AddMcastResolver(mDNS *const m, const domainname *d, const mDNSInterfaceID interface, mDNSu32 timeout); |
---|
3007 | |
---|
3008 | // We use ((void *)0) here instead of mDNSNULL to avoid compile warnings on gcc 4.2 |
---|
3009 | #define mDNS_AddSearchDomain_CString(X, I) \ |
---|
3010 | do { domainname d__; if (((X) != (void*)0) && MakeDomainNameFromDNSNameString(&d__, (X)) && d__.c[0]) mDNS_AddSearchDomain(&d__, I);} while(0) |
---|
3011 | |
---|
3012 | // Routines called by the core, exported by DNSDigest.c |
---|
3013 | |
---|
3014 | // Convert an arbitrary base64 encoded key key into an HMAC key (stored in AuthInfo struct) |
---|
3015 | extern mDNSs32 DNSDigest_ConstructHMACKeyfromBase64(DomainAuthInfo *info, const char *b64key); |
---|
3016 | |
---|
3017 | // sign a DNS message. The message must be complete, with all values in network byte order. end points to the end |
---|
3018 | // of the message, and is modified by this routine. numAdditionals is a pointer to the number of additional |
---|
3019 | // records in HOST byte order, which is incremented upon successful completion of this routine. The function returns |
---|
3020 | // the new end pointer on success, and NULL on failure. |
---|
3021 | extern void DNSDigest_SignMessage(DNSMessage *msg, mDNSu8 **end, DomainAuthInfo *info, mDNSu16 tcode); |
---|
3022 | |
---|
3023 | #define SwapDNSHeaderBytes(M) do { \ |
---|
3024 | (M)->h.numQuestions = (mDNSu16)((mDNSu8 *)&(M)->h.numQuestions )[0] << 8 | ((mDNSu8 *)&(M)->h.numQuestions )[1]; \ |
---|
3025 | (M)->h.numAnswers = (mDNSu16)((mDNSu8 *)&(M)->h.numAnswers )[0] << 8 | ((mDNSu8 *)&(M)->h.numAnswers )[1]; \ |
---|
3026 | (M)->h.numAuthorities = (mDNSu16)((mDNSu8 *)&(M)->h.numAuthorities)[0] << 8 | ((mDNSu8 *)&(M)->h.numAuthorities)[1]; \ |
---|
3027 | (M)->h.numAdditionals = (mDNSu16)((mDNSu8 *)&(M)->h.numAdditionals)[0] << 8 | ((mDNSu8 *)&(M)->h.numAdditionals)[1]; \ |
---|
3028 | } while (0) |
---|
3029 | |
---|
3030 | #define DNSDigest_SignMessageHostByteOrder(M,E,INFO) \ |
---|
3031 | do { SwapDNSHeaderBytes(M); DNSDigest_SignMessage((M), (E), (INFO), 0); SwapDNSHeaderBytes(M); } while (0) |
---|
3032 | |
---|
3033 | // verify a DNS message. The message must be complete, with all values in network byte order. end points to the |
---|
3034 | // end of the record. tsig is a pointer to the resource record that contains the TSIG OPT record. info is |
---|
3035 | // the matching key to use for verifying the message. This function expects that the additionals member |
---|
3036 | // of the DNS message header has already had one subtracted from it. |
---|
3037 | extern mDNSBool DNSDigest_VerifyMessage(DNSMessage *msg, mDNSu8 *end, LargeCacheRecord *tsig, DomainAuthInfo *info, mDNSu16 *rcode, mDNSu16 *tcode); |
---|
3038 | |
---|
3039 | // *************************************************************************** |
---|
3040 | #if 0 |
---|
3041 | #pragma mark - |
---|
3042 | #pragma mark - PlatformSupport interface |
---|
3043 | #endif |
---|
3044 | |
---|
3045 | // This section defines the interface to the Platform Support layer. |
---|
3046 | // Normal client code should not use any of types defined here, or directly call any of the functions defined here. |
---|
3047 | // The definitions are placed here because sometimes clients do use these calls indirectly, via other supported client operations. |
---|
3048 | // For example, AssignDomainName is a macro defined using mDNSPlatformMemCopy() |
---|
3049 | |
---|
3050 | // Every platform support module must provide the following functions. |
---|
3051 | // mDNSPlatformInit() typically opens a communication endpoint, and starts listening for mDNS packets. |
---|
3052 | // When Setup is complete, the platform support layer calls mDNSCoreInitComplete(). |
---|
3053 | // mDNSPlatformSendUDP() sends one UDP packet |
---|
3054 | // When a packet is received, the PlatformSupport code calls mDNSCoreReceive() |
---|
3055 | // mDNSPlatformClose() tidies up on exit |
---|
3056 | // |
---|
3057 | // Note: mDNSPlatformMemAllocate/mDNSPlatformMemFree are only required for handling oversized resource records and unicast DNS. |
---|
3058 | // If your target platform has a well-defined specialized application, and you know that all the records it uses |
---|
3059 | // are InlineCacheRDSize or less, then you can just make a simple mDNSPlatformMemAllocate() stub that always returns |
---|
3060 | // NULL. InlineCacheRDSize is a compile-time constant, which is set by default to 68. If you need to handle records |
---|
3061 | // a little larger than this and you don't want to have to implement run-time allocation and freeing, then you |
---|
3062 | // can raise the value of this constant to a suitable value (at the expense of increased memory usage). |
---|
3063 | // |
---|
3064 | // USE CAUTION WHEN CALLING mDNSPlatformRawTime: The m->timenow_adjust correction factor needs to be added |
---|
3065 | // Generally speaking: |
---|
3066 | // Code that's protected by the main mDNS lock should just use the m->timenow value |
---|
3067 | // Code outside the main mDNS lock should use mDNS_TimeNow(m) to get properly adjusted time |
---|
3068 | // In certain cases there may be reasons why it's necessary to get the time without taking the lock first |
---|
3069 | // (e.g. inside the routines that are doing the locking and unlocking, where a call to get the lock would result in a |
---|
3070 | // recursive loop); in these cases use mDNS_TimeNow_NoLock(m) to get mDNSPlatformRawTime with the proper correction factor added. |
---|
3071 | // |
---|
3072 | // mDNSPlatformUTC returns the time, in seconds, since Jan 1st 1970 UTC and is required for generating TSIG records |
---|
3073 | |
---|
3074 | extern mStatus mDNSPlatformInit (mDNS *const m); |
---|
3075 | extern void mDNSPlatformClose (mDNS *const m); |
---|
3076 | extern mStatus mDNSPlatformSendUDP(const mDNS *const m, const void *const msg, const mDNSu8 *const end, |
---|
3077 | mDNSInterfaceID InterfaceID, UDPSocket *src, const mDNSAddr *dst, |
---|
3078 | mDNSIPPort dstport, mDNSBool useBackgroundTrafficClass); |
---|
3079 | |
---|
3080 | extern mDNSBool mDNSPlatformPeekUDP (mDNS *const m, UDPSocket *src); |
---|
3081 | extern void mDNSPlatformLock (const mDNS *const m); |
---|
3082 | extern void mDNSPlatformUnlock (const mDNS *const m); |
---|
3083 | |
---|
3084 | extern void mDNSPlatformStrCopy ( void *dst, const void *src); |
---|
3085 | extern mDNSu32 mDNSPlatformStrLen ( const void *src); |
---|
3086 | extern void mDNSPlatformMemCopy ( void *dst, const void *src, mDNSu32 len); |
---|
3087 | extern mDNSBool mDNSPlatformMemSame (const void *dst, const void *src, mDNSu32 len); |
---|
3088 | extern int mDNSPlatformMemCmp (const void *dst, const void *src, mDNSu32 len); |
---|
3089 | extern void mDNSPlatformMemZero ( void *dst, mDNSu32 len); |
---|
3090 | extern void mDNSPlatformQsort (void *base, int nel, int width, int (*compar)(const void *, const void *)); |
---|
3091 | #if APPLE_OSX_mDNSResponder && MACOSX_MDNS_MALLOC_DEBUGGING |
---|
3092 | #define mDNSPlatformMemAllocate(X) mallocL(# X, X) |
---|
3093 | #else |
---|
3094 | extern void * mDNSPlatformMemAllocate (mDNSu32 len); |
---|
3095 | #endif |
---|
3096 | extern void mDNSPlatformMemFree (void *mem); |
---|
3097 | |
---|
3098 | // If the platform doesn't have a strong PRNG, we define a naive multiply-and-add based on a seed |
---|
3099 | // from the platform layer. Long-term, we should embed an arc4 implementation, but the strength |
---|
3100 | // will still depend on the randomness of the seed. |
---|
3101 | #if !defined(_PLATFORM_HAS_STRONG_PRNG_) && (_BUILDING_XCODE_PROJECT_ || defined(_WIN32)) |
---|
3102 | #define _PLATFORM_HAS_STRONG_PRNG_ 1 |
---|
3103 | #endif |
---|
3104 | #if _PLATFORM_HAS_STRONG_PRNG_ |
---|
3105 | extern mDNSu32 mDNSPlatformRandomNumber(void); |
---|
3106 | #else |
---|
3107 | extern mDNSu32 mDNSPlatformRandomSeed (void); |
---|
3108 | #endif // _PLATFORM_HAS_STRONG_PRNG_ |
---|
3109 | |
---|
3110 | extern mStatus mDNSPlatformTimeInit (void); |
---|
3111 | extern mDNSs32 mDNSPlatformRawTime (void); |
---|
3112 | extern mDNSs32 mDNSPlatformUTC (void); |
---|
3113 | #define mDNS_TimeNow_NoLock(m) (mDNSPlatformRawTime() + (m)->timenow_adjust) |
---|
3114 | |
---|
3115 | #if MDNS_DEBUGMSGS |
---|
3116 | extern void mDNSPlatformWriteDebugMsg(const char *msg); |
---|
3117 | #endif |
---|
3118 | extern void mDNSPlatformWriteLogMsg(const char *ident, const char *msg, mDNSLogLevel_t loglevel); |
---|
3119 | |
---|
3120 | #if APPLE_OSX_mDNSResponder |
---|
3121 | // Utility function for ASL logging |
---|
3122 | mDNSexport void mDNSASLLog(uuid_t *uuid, const char *subdomain, const char *result, const char *signature, const char *fmt, ...); |
---|
3123 | |
---|
3124 | // Log unicast and multicast traffic statistics once a day. Also used for DNSSEC statistics. |
---|
3125 | #define kDefaultNextStatsticsLogTime (24 * 60 * 60) |
---|
3126 | |
---|
3127 | extern void mDNSLogStatistics(mDNS *const m); |
---|
3128 | |
---|
3129 | #endif // APPLE_OSX_mDNSResponder |
---|
3130 | |
---|
3131 | // Platform support modules should provide the following functions to map between opaque interface IDs |
---|
3132 | // and interface indexes in order to support the DNS-SD API. If your target platform does not support |
---|
3133 | // multiple interfaces and/or does not support the DNS-SD API, these functions can be empty. |
---|
3134 | extern mDNSInterfaceID mDNSPlatformInterfaceIDfromInterfaceIndex(mDNS *const m, mDNSu32 ifindex); |
---|
3135 | extern mDNSu32 mDNSPlatformInterfaceIndexfromInterfaceID(mDNS *const m, mDNSInterfaceID id, mDNSBool suppressNetworkChange); |
---|
3136 | |
---|
3137 | // Every platform support module must provide the following functions if it is to support unicast DNS |
---|
3138 | // and Dynamic Update. |
---|
3139 | // All TCP socket operations implemented by the platform layer MUST NOT BLOCK. |
---|
3140 | // mDNSPlatformTCPConnect initiates a TCP connection with a peer, adding the socket descriptor to the |
---|
3141 | // main event loop. The return value indicates whether the connection succeeded, failed, or is pending |
---|
3142 | // (i.e. the call would block.) On return, the descriptor parameter is set to point to the connected socket. |
---|
3143 | // The TCPConnectionCallback is subsequently invoked when the connection |
---|
3144 | // completes (in which case the ConnectionEstablished parameter is true), or data is available for |
---|
3145 | // reading on the socket (indicated by the ConnectionEstablished parameter being false.) If the connection |
---|
3146 | // asynchronously fails, the TCPConnectionCallback should be invoked as usual, with the error being |
---|
3147 | // returned in subsequent calls to PlatformReadTCP or PlatformWriteTCP. (This allows for platforms |
---|
3148 | // with limited asynchronous error detection capabilities.) PlatformReadTCP and PlatformWriteTCP must |
---|
3149 | // return the number of bytes read/written, 0 if the call would block, and -1 if an error. PlatformReadTCP |
---|
3150 | // should set the closed argument if the socket has been closed. |
---|
3151 | // PlatformTCPCloseConnection must close the connection to the peer and remove the descriptor from the |
---|
3152 | // event loop. CloseConnectin may be called at any time, including in a ConnectionCallback. |
---|
3153 | |
---|
3154 | typedef enum |
---|
3155 | { |
---|
3156 | kTCPSocketFlags_Zero = 0, |
---|
3157 | kTCPSocketFlags_UseTLS = (1 << 0) |
---|
3158 | } TCPSocketFlags; |
---|
3159 | |
---|
3160 | typedef void (*TCPConnectionCallback)(TCPSocket *sock, void *context, mDNSBool ConnectionEstablished, mStatus err); |
---|
3161 | extern TCPSocket *mDNSPlatformTCPSocket(mDNS *const m, TCPSocketFlags flags, mDNSIPPort *port, mDNSBool useBackgroundTrafficClass); // creates a TCP socket |
---|
3162 | extern TCPSocket *mDNSPlatformTCPAccept(TCPSocketFlags flags, int sd); |
---|
3163 | extern int mDNSPlatformTCPGetFD(TCPSocket *sock); |
---|
3164 | extern mStatus mDNSPlatformTCPConnect(TCPSocket *sock, const mDNSAddr *dst, mDNSOpaque16 dstport, domainname *hostname, |
---|
3165 | mDNSInterfaceID InterfaceID, TCPConnectionCallback callback, void *context); |
---|
3166 | extern void mDNSPlatformTCPCloseConnection(TCPSocket *sock); |
---|
3167 | extern long mDNSPlatformReadTCP(TCPSocket *sock, void *buf, unsigned long buflen, mDNSBool *closed); |
---|
3168 | extern long mDNSPlatformWriteTCP(TCPSocket *sock, const char *msg, unsigned long len); |
---|
3169 | extern UDPSocket *mDNSPlatformUDPSocket(mDNS *const m, const mDNSIPPort requestedport); |
---|
3170 | extern mDNSu16 mDNSPlatformGetUDPPort(UDPSocket *sock); |
---|
3171 | extern void mDNSPlatformUDPClose(UDPSocket *sock); |
---|
3172 | extern void mDNSPlatformReceiveBPF_fd(mDNS *const m, int fd); |
---|
3173 | extern void mDNSPlatformUpdateProxyList(mDNS *const m, const mDNSInterfaceID InterfaceID); |
---|
3174 | extern void mDNSPlatformSendRawPacket(const void *const msg, const mDNSu8 *const end, mDNSInterfaceID InterfaceID); |
---|
3175 | extern void mDNSPlatformSetLocalAddressCacheEntry(mDNS *const m, const mDNSAddr *const tpa, const mDNSEthAddr *const tha, mDNSInterfaceID InterfaceID); |
---|
3176 | extern void mDNSPlatformSourceAddrForDest(mDNSAddr *const src, const mDNSAddr *const dst); |
---|
3177 | extern void mDNSPlatformSendKeepalive(mDNSAddr *sadd, mDNSAddr *dadd, mDNSIPPort *lport, mDNSIPPort *rport, mDNSu32 seq, mDNSu32 ack, mDNSu16 win); |
---|
3178 | extern mStatus mDNSPlatformRetrieveTCPInfo(mDNS *const m, mDNSAddr *laddr, mDNSIPPort *lport, mDNSAddr *raddr, mDNSIPPort *rport, mDNSTCPInfo *mti); |
---|
3179 | extern mStatus mDNSPlatformGetRemoteMacAddr(mDNS *const m, mDNSAddr *raddr); |
---|
3180 | extern mStatus mDNSPlatformStoreSPSMACAddr(mDNSAddr *spsaddr, char *ifname); |
---|
3181 | extern mStatus mDNSPlatformClearSPSMACAddr(void); |
---|
3182 | |
---|
3183 | // mDNSPlatformTLSSetupCerts/mDNSPlatformTLSTearDownCerts used by dnsextd |
---|
3184 | extern mStatus mDNSPlatformTLSSetupCerts(void); |
---|
3185 | extern void mDNSPlatformTLSTearDownCerts(void); |
---|
3186 | |
---|
3187 | // Platforms that support unicast browsing and dynamic update registration for clients who do not specify a domain |
---|
3188 | // in browse/registration calls must implement these routines to get the "default" browse/registration list. |
---|
3189 | |
---|
3190 | extern mDNSBool mDNSPlatformSetDNSConfig(mDNS *const m, mDNSBool setservers, mDNSBool setsearch, domainname *const fqdn, DNameListElem **RegDomains, |
---|
3191 | DNameListElem **BrowseDomains, mDNSBool ackConfig); |
---|
3192 | extern mStatus mDNSPlatformGetPrimaryInterface(mDNS *const m, mDNSAddr *v4, mDNSAddr *v6, mDNSAddr *router); |
---|
3193 | extern void mDNSPlatformDynDNSHostNameStatusChanged(const domainname *const dname, const mStatus status); |
---|
3194 | |
---|
3195 | extern void mDNSPlatformSetAllowSleep(mDNS *const m, mDNSBool allowSleep, const char *reason); |
---|
3196 | extern void mDNSPlatformSendWakeupPacket(mDNS *const m, mDNSInterfaceID InterfaceID, char *EthAddr, char *IPAddr, int iteration); |
---|
3197 | |
---|
3198 | extern mDNSBool mDNSPlatformInterfaceIsD2D(mDNSInterfaceID InterfaceID); |
---|
3199 | extern mDNSBool mDNSPlatformInterfaceIsAWDL(const NetworkInterfaceInfo *intf); |
---|
3200 | extern mDNSBool mDNSPlatformValidRecordForQuestion(const ResourceRecord *const rr, const DNSQuestion *const q); |
---|
3201 | extern mDNSBool mDNSPlatformValidRecordForInterface(AuthRecord *rr, const NetworkInterfaceInfo *intf); |
---|
3202 | extern mDNSBool mDNSPlatformValidQuestionForInterface(DNSQuestion *q, const NetworkInterfaceInfo *intf); |
---|
3203 | |
---|
3204 | extern void mDNSPlatformFormatTime(unsigned long t, mDNSu8 *buf, int bufsize); |
---|
3205 | |
---|
3206 | #ifdef _LEGACY_NAT_TRAVERSAL_ |
---|
3207 | // Support for legacy NAT traversal protocols, implemented by the platform layer and callable by the core. |
---|
3208 | extern void LNT_SendDiscoveryMsg(mDNS *m); |
---|
3209 | extern void LNT_ConfigureRouterInfo(mDNS *m, const mDNSInterfaceID InterfaceID, const mDNSu8 *const data, const mDNSu16 len); |
---|
3210 | extern mStatus LNT_GetExternalAddress(mDNS *m); |
---|
3211 | extern mStatus LNT_MapPort(mDNS *m, NATTraversalInfo *const n); |
---|
3212 | extern mStatus LNT_UnmapPort(mDNS *m, NATTraversalInfo *const n); |
---|
3213 | extern void LNT_ClearState(mDNS *const m); |
---|
3214 | #endif // _LEGACY_NAT_TRAVERSAL_ |
---|
3215 | |
---|
3216 | // The core mDNS code provides these functions, for the platform support code to call at appropriate times |
---|
3217 | // |
---|
3218 | // mDNS_SetFQDN() is called once on startup (typically from mDNSPlatformInit()) |
---|
3219 | // and then again on each subsequent change of the host name. |
---|
3220 | // |
---|
3221 | // mDNS_RegisterInterface() is used by the platform support layer to inform mDNSCore of what |
---|
3222 | // physical and/or logical interfaces are available for sending and receiving packets. |
---|
3223 | // Typically it is called on startup for each available interface, but register/deregister may be |
---|
3224 | // called again later, on multiple occasions, to inform the core of interface configuration changes. |
---|
3225 | // If set->Advertise is set non-zero, then mDNS_RegisterInterface() also registers the standard |
---|
3226 | // resource records that should be associated with every publicised IP address/interface: |
---|
3227 | // -- Name-to-address records (A/AAAA) |
---|
3228 | // -- Address-to-name records (PTR) |
---|
3229 | // -- Host information (HINFO) |
---|
3230 | // IMPORTANT: The specified mDNSInterfaceID MUST NOT be 0, -1, or -2; these values have special meaning |
---|
3231 | // mDNS_RegisterInterface does not result in the registration of global hostnames via dynamic update - |
---|
3232 | // see mDNS_SetPrimaryInterfaceInfo, mDNS_AddDynDNSHostName, etc. for this purpose. |
---|
3233 | // Note that the set may be deallocated immediately after it is deregistered via mDNS_DeegisterInterface. |
---|
3234 | // |
---|
3235 | // mDNS_RegisterDNS() is used by the platform support layer to provide the core with the addresses of |
---|
3236 | // available domain name servers for unicast queries/updates. RegisterDNS() should be called once for |
---|
3237 | // each name server, typically at startup, or when a new name server becomes available. DeregiterDNS() |
---|
3238 | // must be called whenever a registered name server becomes unavailable. DeregisterDNSList deregisters |
---|
3239 | // all registered servers. mDNS_DNSRegistered() returns true if one or more servers are registered in the core. |
---|
3240 | // |
---|
3241 | // mDNSCoreInitComplete() is called when the platform support layer is finished. |
---|
3242 | // Typically this is at the end of mDNSPlatformInit(), but may be later |
---|
3243 | // (on platforms like OT that allow asynchronous initialization of the networking stack). |
---|
3244 | // |
---|
3245 | // mDNSCoreReceive() is called when a UDP packet is received |
---|
3246 | // |
---|
3247 | // mDNSCoreMachineSleep() is called when the machine sleeps or wakes |
---|
3248 | // (This refers to heavyweight laptop-style sleep/wake that disables network access, |
---|
3249 | // not lightweight second-by-second CPU power management modes.) |
---|
3250 | |
---|
3251 | extern void mDNS_SetFQDN(mDNS *const m); |
---|
3252 | extern void mDNS_ActivateNetWake_internal (mDNS *const m, NetworkInterfaceInfo *set); |
---|
3253 | extern void mDNS_DeactivateNetWake_internal(mDNS *const m, NetworkInterfaceInfo *set); |
---|
3254 | extern mStatus mDNS_RegisterInterface (mDNS *const m, NetworkInterfaceInfo *set, mDNSBool flapping); |
---|
3255 | extern void mDNS_DeregisterInterface(mDNS *const m, NetworkInterfaceInfo *set, mDNSBool flapping); |
---|
3256 | extern void mDNSCoreInitComplete(mDNS *const m, mStatus result); |
---|
3257 | extern void mDNSCoreReceive(mDNS *const m, void *const msg, const mDNSu8 *const end, |
---|
3258 | const mDNSAddr *const srcaddr, const mDNSIPPort srcport, |
---|
3259 | const mDNSAddr *dstaddr, const mDNSIPPort dstport, const mDNSInterfaceID InterfaceID); |
---|
3260 | extern void mDNSCoreRestartQueries(mDNS *const m); |
---|
3261 | extern void mDNSCoreRestartQuestion(mDNS *const m, DNSQuestion *q); |
---|
3262 | extern void mDNSCoreRestartRegistration(mDNS *const m, AuthRecord *rr, int announceCount); |
---|
3263 | typedef void (*FlushCache)(mDNS *const m); |
---|
3264 | typedef void (*CallbackBeforeStartQuery)(mDNS *const m, void *context); |
---|
3265 | extern void mDNSCoreRestartAddressQueries(mDNS *const m, mDNSBool SearchDomainsChanged, FlushCache flushCacheRecords, |
---|
3266 | CallbackBeforeStartQuery beforeQueryStart, void *context); |
---|
3267 | extern mDNSBool mDNSCoreHaveAdvertisedMulticastServices(mDNS *const m); |
---|
3268 | extern void mDNSCoreMachineSleep(mDNS *const m, mDNSBool wake); |
---|
3269 | extern mDNSBool mDNSCoreReadyForSleep(mDNS *m, mDNSs32 now); |
---|
3270 | extern mDNSs32 mDNSCoreIntervalToNextWake(mDNS *const m, mDNSs32 now); |
---|
3271 | |
---|
3272 | extern void mDNSCoreReceiveRawPacket (mDNS *const m, const mDNSu8 *const p, const mDNSu8 *const end, const mDNSInterfaceID InterfaceID); |
---|
3273 | |
---|
3274 | extern mDNSBool mDNSAddrIsDNSMulticast(const mDNSAddr *ip); |
---|
3275 | |
---|
3276 | extern CacheRecord *CreateNewCacheEntry(mDNS *const m, const mDNSu32 slot, CacheGroup *cg, mDNSs32 delay, mDNSBool Add, const mDNSAddr *sourceAddress); |
---|
3277 | extern CacheGroup *CacheGroupForName(const mDNS *const m, const mDNSu32 slot, const mDNSu32 namehash, const domainname *const name); |
---|
3278 | extern void ReleaseCacheRecord(mDNS *const m, CacheRecord *r); |
---|
3279 | extern void ScheduleNextCacheCheckTime(mDNS *const m, const mDNSu32 slot, const mDNSs32 event); |
---|
3280 | extern void SetNextCacheCheckTimeForRecord(mDNS *const m, CacheRecord *const rr); |
---|
3281 | extern void GrantCacheExtensions(mDNS *const m, DNSQuestion *q, mDNSu32 lease); |
---|
3282 | extern void MakeNegativeCacheRecord(mDNS *const m, CacheRecord *const cr, |
---|
3283 | const domainname *const name, const mDNSu32 namehash, const mDNSu16 rrtype, const mDNSu16 rrclass, mDNSu32 ttl_seconds, |
---|
3284 | mDNSInterfaceID InterfaceID, DNSServer *dnsserver); |
---|
3285 | extern void CompleteDeregistration(mDNS *const m, AuthRecord *rr); |
---|
3286 | extern void AnswerCurrentQuestionWithResourceRecord(mDNS *const m, CacheRecord *const rr, const QC_result AddRecord); |
---|
3287 | extern void AnswerQuestionByFollowingCNAME(mDNS *const m, DNSQuestion *q, ResourceRecord *rr); |
---|
3288 | extern char *InterfaceNameForID(mDNS *const m, const mDNSInterfaceID InterfaceID); |
---|
3289 | extern void DNSServerChangeForQuestion(mDNS *const m, DNSQuestion *q, DNSServer *newServer); |
---|
3290 | extern void ActivateUnicastRegistration(mDNS *const m, AuthRecord *const rr); |
---|
3291 | extern void CheckSuppressUnusableQuestions(mDNS *const m); |
---|
3292 | extern void RetrySearchDomainQuestions(mDNS *const m); |
---|
3293 | extern mDNSBool DomainEnumQuery(const domainname *qname); |
---|
3294 | extern mStatus UpdateKeepaliveRData(mDNS *const m, AuthRecord *rr, NetworkInterfaceInfo *const intf, mDNSBool updateMac, char *ethAddr); |
---|
3295 | extern void UpdateKeepaliveRMACAsync(mDNS *const m, void *context); |
---|
3296 | extern void UpdateRMACCallback(mDNS *const m, void *context); |
---|
3297 | |
---|
3298 | // Used only in logging to restrict the number of /etc/hosts entries printed |
---|
3299 | extern void FreeEtcHosts(mDNS *const m, AuthRecord *const rr, mStatus result); |
---|
3300 | // exported for using the hash for /etc/hosts AuthRecords |
---|
3301 | extern AuthGroup *AuthGroupForName(AuthHash *r, const mDNSu32 slot, const mDNSu32 namehash, const domainname *const name); |
---|
3302 | extern AuthGroup *AuthGroupForRecord(AuthHash *r, const mDNSu32 slot, const ResourceRecord *const rr); |
---|
3303 | extern AuthGroup *InsertAuthRecord(mDNS *const m, AuthHash *r, AuthRecord *rr); |
---|
3304 | extern AuthGroup *RemoveAuthRecord(mDNS *const m, AuthHash *r, AuthRecord *rr); |
---|
3305 | extern mDNSBool mDNS_CheckForCacheRecord(mDNS *const m, DNSQuestion *q, mDNSu16 qtype); |
---|
3306 | |
---|
3307 | // For now this AutoTunnel stuff is specific to Mac OS X. |
---|
3308 | // In the future, if there's demand, we may see if we can abstract it out cleanly into the platform layer |
---|
3309 | #if APPLE_OSX_mDNSResponder |
---|
3310 | extern void AutoTunnelCallback(mDNS *const m, DNSQuestion *question, const ResourceRecord *const answer, QC_result AddRecord); |
---|
3311 | extern void AddNewClientTunnel(mDNS *const m, DNSQuestion *const q); |
---|
3312 | extern void StartServerTunnel(mDNS *const m, DomainAuthInfo *const info); |
---|
3313 | extern void UpdateAutoTunnelDomainStatuses(const mDNS *const m); |
---|
3314 | extern void RemoveAutoTunnel6Record(mDNS *const m); |
---|
3315 | extern mDNSBool RecordReadyForSleep(mDNS *const m, AuthRecord *rr); |
---|
3316 | // For now this LocalSleepProxy stuff is specific to Mac OS X. |
---|
3317 | // In the future, if there's demand, we may see if we can abstract it out cleanly into the platform layer |
---|
3318 | extern mStatus ActivateLocalProxy(mDNS *const m, NetworkInterfaceInfo *const intf); |
---|
3319 | extern void mDNSPlatformUpdateDNSStatus(mDNS *const m, DNSQuestion *q); |
---|
3320 | extern void mDNSPlatformTriggerDNSRetry(mDNS *const m, DNSQuestion *v4q, DNSQuestion *v6q); |
---|
3321 | extern void mDNSPlatformLogToFile(int log_level, const char *buffer); |
---|
3322 | extern mDNSBool SupportsInNICProxy(NetworkInterfaceInfo *const intf); |
---|
3323 | #endif |
---|
3324 | |
---|
3325 | typedef void ProxyCallback (mDNS *const m, void *socket, void *const msg, const mDNSu8 *const end, const mDNSAddr *const srcaddr, |
---|
3326 | const mDNSIPPort srcport, const mDNSAddr *dstaddr, const mDNSIPPort dstport, const mDNSInterfaceID InterfaceID, void *context); |
---|
3327 | extern void mDNSPlatformInitDNSProxySkts(mDNS *const m, ProxyCallback *UDPCallback, ProxyCallback *TCPCallback); |
---|
3328 | extern void mDNSPlatformCloseDNSProxySkts(mDNS *const m); |
---|
3329 | extern void mDNSPlatformDisposeProxyContext(void *context); |
---|
3330 | extern mDNSu8 *DNSProxySetAttributes(DNSQuestion *q, DNSMessageHeader *h, DNSMessage *msg, mDNSu8 *start, mDNSu8 *limit); |
---|
3331 | |
---|
3332 | // Sleep Assertions are specific to Mac OS X |
---|
3333 | #if APPLE_OSX_mDNSResponder |
---|
3334 | extern void mDNSPlatformSleepAssertion(mDNS *const m, double timeout); |
---|
3335 | #endif |
---|
3336 | |
---|
3337 | extern mDNSBool mDNSPlatformAllowPID(mDNS *const m, DNSQuestion *q); |
---|
3338 | extern mDNSs32 mDNSPlatformGetServiceID(mDNS *const m, DNSQuestion *q); |
---|
3339 | extern void mDNSPlatformSetDelegatePID(UDPSocket *src, const mDNSAddr *dst, DNSQuestion *q); |
---|
3340 | extern mDNSs32 mDNSPlatformGetPID(void); |
---|
3341 | |
---|
3342 | // *************************************************************************** |
---|
3343 | #if 0 |
---|
3344 | #pragma mark - |
---|
3345 | #pragma mark - Sleep Proxy |
---|
3346 | #endif |
---|
3347 | |
---|
3348 | // Sleep Proxy Server Property Encoding |
---|
3349 | // |
---|
3350 | // Sleep Proxy Servers are advertised using a structured service name, consisting of four |
---|
3351 | // metrics followed by a human-readable name. The metrics assist clients in deciding which |
---|
3352 | // Sleep Proxy Server(s) to use when multiple are available on the network. Each metric |
---|
3353 | // is a two-digit decimal number in the range 10-99. Lower metrics are generally better. |
---|
3354 | // |
---|
3355 | // AA-BB-CC-DD.FF Name |
---|
3356 | // |
---|
3357 | // Metrics: |
---|
3358 | // |
---|
3359 | // AA = Intent |
---|
3360 | // BB = Portability |
---|
3361 | // CC = Marginal Power |
---|
3362 | // DD = Total Power |
---|
3363 | // FF = Features Supported (Currently TCP Keepalive only) |
---|
3364 | // |
---|
3365 | // |
---|
3366 | // ** Intent Metric ** |
---|
3367 | // |
---|
3368 | // 20 = Dedicated Sleep Proxy Server -- a device, permanently powered on, |
---|
3369 | // installed for the express purpose of providing Sleep Proxy Service. |
---|
3370 | // |
---|
3371 | // 30 = Primary Network Infrastructure Hardware -- a router, DHCP server, NAT gateway, |
---|
3372 | // or similar permanently installed device which is permanently powered on. |
---|
3373 | // This is hardware designed for the express purpose of being network |
---|
3374 | // infrastructure, and for most home users is typically a single point |
---|
3375 | // of failure for the local network -- e.g. most home users only have |
---|
3376 | // a single NAT gateway / DHCP server. Even though in principle the |
---|
3377 | // hardware might technically be capable of running different software, |
---|
3378 | // a typical user is unlikely to do that. e.g. AirPort base station. |
---|
3379 | // |
---|
3380 | // 40 = Primary Network Infrastructure Software -- a general-purpose computer |
---|
3381 | // (e.g. Mac, Windows, Linux, etc.) which is currently running DHCP server |
---|
3382 | // or NAT gateway software, but the user could choose to turn that off |
---|
3383 | // fairly easily. e.g. iMac running Internet Sharing |
---|
3384 | // |
---|
3385 | // 50 = Secondary Network Infrastructure Hardware -- like primary infrastructure |
---|
3386 | // hardware, except not a single point of failure for the entire local network. |
---|
3387 | // For example, an AirPort base station in bridge mode. This may have clients |
---|
3388 | // associated with it, and if it goes away those clients will be inconvenienced, |
---|
3389 | // but unlike the NAT gateway / DHCP server, the entire local network is not |
---|
3390 | // dependent on it. |
---|
3391 | // |
---|
3392 | // 60 = Secondary Network Infrastructure Software -- like 50, but in a general- |
---|
3393 | // purpose CPU. |
---|
3394 | // |
---|
3395 | // 70 = Incidentally Available Hardware -- a device which has no power switch |
---|
3396 | // and is generally left powered on all the time. Even though it is not a |
---|
3397 | // part of what we conventionally consider network infrastructure (router, |
---|
3398 | // DHCP, NAT, DNS, etc.), and the rest of the network can operate fine |
---|
3399 | // without it, since it's available and unlikely to be turned off, it is a |
---|
3400 | // reasonable candidate for providing Sleep Proxy Service e.g. Apple TV, |
---|
3401 | // or an AirPort base station in client mode, associated with an existing |
---|
3402 | // wireless network (e.g. AirPort Express connected to a music system, or |
---|
3403 | // being used to share a USB printer). |
---|
3404 | // |
---|
3405 | // 80 = Incidentally Available Software -- a general-purpose computer which |
---|
3406 | // happens at this time to be set to "never sleep", and as such could be |
---|
3407 | // useful as a Sleep Proxy Server, but has not been intentionally provided |
---|
3408 | // for this purpose. Of all the Intent Metric categories this is the |
---|
3409 | // one most likely to be shut down or put to sleep without warning. |
---|
3410 | // However, if nothing else is availalable, it may be better than nothing. |
---|
3411 | // e.g. Office computer in the workplace which has been set to "never sleep" |
---|
3412 | // |
---|
3413 | // |
---|
3414 | // ** Portability Metric ** |
---|
3415 | // |
---|
3416 | // Inversely related to mass of device, on the basis that, all other things |
---|
3417 | // being equal, heavier devices are less likely to be moved than lighter devices. |
---|
3418 | // E.g. A MacBook running Internet Sharing is probably more likely to be |
---|
3419 | // put to sleep and taken away than a Mac Pro running Internet Sharing. |
---|
3420 | // The Portability Metric is a logarithmic decibel scale, computed by taking the |
---|
3421 | // (approximate) mass of the device in milligrammes, taking the base 10 logarithm |
---|
3422 | // of that, multiplying by 10, and subtracting the result from 100: |
---|
3423 | // |
---|
3424 | // Portability Metric = 100 - (log10(mg) * 10) |
---|
3425 | // |
---|
3426 | // The Portability Metric is not necessarily computed literally from the actual |
---|
3427 | // mass of the device; the intent is just that lower numbers indicate more |
---|
3428 | // permanent devices, and higher numbers indicate devices more likely to be |
---|
3429 | // removed from the network, e.g., in order of increasing portability: |
---|
3430 | // |
---|
3431 | // Mac Pro < iMac < Laptop < iPhone |
---|
3432 | // |
---|
3433 | // Example values: |
---|
3434 | // |
---|
3435 | // 10 = 1 metric tonne |
---|
3436 | // 40 = 1kg |
---|
3437 | // 70 = 1g |
---|
3438 | // 90 = 10mg |
---|
3439 | // |
---|
3440 | // |
---|
3441 | // ** Marginal Power and Total Power Metrics ** |
---|
3442 | // |
---|
3443 | // The Marginal Power Metric is the power difference between sleeping and staying awake |
---|
3444 | // to be a Sleep Proxy Server. |
---|
3445 | // |
---|
3446 | // The Total Power Metric is the total power consumption when being Sleep Proxy Server. |
---|
3447 | // |
---|
3448 | // The Power Metrics use a logarithmic decibel scale, computed as ten times the |
---|
3449 | // base 10 logarithm of the (approximate) power in microwatts: |
---|
3450 | // |
---|
3451 | // Power Metric = log10(uW) * 10 |
---|
3452 | // |
---|
3453 | // Higher values indicate higher power consumption. Example values: |
---|
3454 | // |
---|
3455 | // 10 = 10 uW |
---|
3456 | // 20 = 100 uW |
---|
3457 | // 30 = 1 mW |
---|
3458 | // 60 = 1 W |
---|
3459 | // 90 = 1 kW |
---|
3460 | |
---|
3461 | typedef enum |
---|
3462 | { |
---|
3463 | mDNSSleepProxyMetric_Dedicated = 20, |
---|
3464 | mDNSSleepProxyMetric_PrimaryHardware = 30, |
---|
3465 | mDNSSleepProxyMetric_PrimarySoftware = 40, |
---|
3466 | mDNSSleepProxyMetric_SecondaryHardware = 50, |
---|
3467 | mDNSSleepProxyMetric_SecondarySoftware = 60, |
---|
3468 | mDNSSleepProxyMetric_IncidentalHardware = 70, |
---|
3469 | mDNSSleepProxyMetric_IncidentalSoftware = 80 |
---|
3470 | } mDNSSleepProxyMetric; |
---|
3471 | |
---|
3472 | typedef enum |
---|
3473 | { |
---|
3474 | mDNS_NoWake = 0, // System does not support Wake on LAN |
---|
3475 | mDNS_WakeOnAC = 1, // System supports Wake on LAN when connected to AC power only |
---|
3476 | mDNS_WakeOnBattery = 2 // System supports Wake on LAN on battery |
---|
3477 | } mDNSWakeForNetworkAccess; |
---|
3478 | |
---|
3479 | extern void mDNSCoreBeSleepProxyServer_internal(mDNS *const m, mDNSu8 sps, mDNSu8 port, mDNSu8 marginalpower, mDNSu8 totpower, mDNSu8 features); |
---|
3480 | #define mDNSCoreBeSleepProxyServer(M,S,P,MP,TP,F) \ |
---|
3481 | do { mDNS_Lock(m); mDNSCoreBeSleepProxyServer_internal((M),(S),(P),(MP),(TP),(F)); mDNS_Unlock(m); } while(0) |
---|
3482 | |
---|
3483 | extern void FindSPSInCache(mDNS *const m, const DNSQuestion *const q, const CacheRecord *sps[3]); |
---|
3484 | #define PrototypeSPSName(X) ((X)[0] >= 11 && (X)[3] == '-' && (X)[ 4] == '9' && (X)[ 5] == '9' && \ |
---|
3485 | (X)[6] == '-' && (X)[ 7] == '9' && (X)[ 8] == '9' && \ |
---|
3486 | (X)[9] == '-' && (X)[10] == '9' && (X)[11] == '9' ) |
---|
3487 | #define ValidSPSName(X) ((X)[0] >= 5 && mDNSIsDigit((X)[1]) && mDNSIsDigit((X)[2]) && mDNSIsDigit((X)[4]) && mDNSIsDigit((X)[5])) |
---|
3488 | #define SPSMetric(X) (!ValidSPSName(X) || PrototypeSPSName(X) ? 1000000 : \ |
---|
3489 | ((X)[1]-'0') * 100000 + ((X)[2]-'0') * 10000 + ((X)[4]-'0') * 1000 + ((X)[5]-'0') * 100 + ((X)[7]-'0') * 10 + ((X)[8]-'0')) |
---|
3490 | #define LocalSPSMetric(X) ( (X)->SPSType * 10000 + (X)->SPSPortability * 100 + (X)->SPSMarginalPower) |
---|
3491 | #define SPSFeatures(X) ((X)[0] >= 13 && (X)[12] =='.' ? ((X)[13]-'0') : 0 ) |
---|
3492 | |
---|
3493 | #define MD5_DIGEST_LENGTH 16 /* digest length in bytes */ |
---|
3494 | #define MD5_BLOCK_BYTES 64 /* block size in bytes */ |
---|
3495 | #define MD5_BLOCK_LONG (MD5_BLOCK_BYTES / sizeof(mDNSu32)) |
---|
3496 | |
---|
3497 | typedef struct MD5state_st |
---|
3498 | { |
---|
3499 | mDNSu32 A,B,C,D; |
---|
3500 | mDNSu32 Nl,Nh; |
---|
3501 | mDNSu32 data[MD5_BLOCK_LONG]; |
---|
3502 | int num; |
---|
3503 | } MD5_CTX; |
---|
3504 | |
---|
3505 | extern int MD5_Init(MD5_CTX *c); |
---|
3506 | extern int MD5_Update(MD5_CTX *c, const void *data, unsigned long len); |
---|
3507 | extern int MD5_Final(unsigned char *md, MD5_CTX *c); |
---|
3508 | |
---|
3509 | // *************************************************************************** |
---|
3510 | #if 0 |
---|
3511 | #pragma mark - |
---|
3512 | #pragma mark - Compile-Time assertion checks |
---|
3513 | #endif |
---|
3514 | |
---|
3515 | // Some C compiler cleverness. We can make the compiler check certain things for |
---|
3516 | // us, and report compile-time errors if anything is wrong. The usual way to do |
---|
3517 | // this would be to use a run-time "if" statement, but then you don't find out |
---|
3518 | // what's wrong until you run the software. This way, if the assertion condition |
---|
3519 | // is false, the array size is negative, and the complier complains immediately. |
---|
3520 | |
---|
3521 | struct CompileTimeAssertionChecks_mDNS |
---|
3522 | { |
---|
3523 | // Check that the compiler generated our on-the-wire packet format structure definitions |
---|
3524 | // properly packed, without adding padding bytes to align fields on 32-bit or 64-bit boundaries. |
---|
3525 | char assert0[(sizeof(rdataSRV) == 262 ) ? 1 : -1]; |
---|
3526 | char assert1[(sizeof(DNSMessageHeader) == 12 ) ? 1 : -1]; |
---|
3527 | char assert2[(sizeof(DNSMessage) == 12+AbsoluteMaxDNSMessageData) ? 1 : -1]; |
---|
3528 | char assert3[(sizeof(mDNSs8) == 1 ) ? 1 : -1]; |
---|
3529 | char assert4[(sizeof(mDNSu8) == 1 ) ? 1 : -1]; |
---|
3530 | char assert5[(sizeof(mDNSs16) == 2 ) ? 1 : -1]; |
---|
3531 | char assert6[(sizeof(mDNSu16) == 2 ) ? 1 : -1]; |
---|
3532 | char assert7[(sizeof(mDNSs32) == 4 ) ? 1 : -1]; |
---|
3533 | char assert8[(sizeof(mDNSu32) == 4 ) ? 1 : -1]; |
---|
3534 | char assert9[(sizeof(mDNSOpaque16) == 2 ) ? 1 : -1]; |
---|
3535 | char assertA[(sizeof(mDNSOpaque32) == 4 ) ? 1 : -1]; |
---|
3536 | char assertB[(sizeof(mDNSOpaque128) == 16 ) ? 1 : -1]; |
---|
3537 | char assertC[(sizeof(CacheRecord ) == sizeof(CacheGroup) ) ? 1 : -1]; |
---|
3538 | char assertD[(sizeof(int) >= 4 ) ? 1 : -1]; |
---|
3539 | char assertE[(StandardAuthRDSize >= 256 ) ? 1 : -1]; |
---|
3540 | char assertF[(sizeof(EthernetHeader) == 14 ) ? 1 : -1]; |
---|
3541 | char assertG[(sizeof(ARP_EthIP ) == 28 ) ? 1 : -1]; |
---|
3542 | char assertH[(sizeof(IPv4Header ) == 20 ) ? 1 : -1]; |
---|
3543 | char assertI[(sizeof(IPv6Header ) == 40 ) ? 1 : -1]; |
---|
3544 | char assertJ[(sizeof(IPv6NDP ) == 24 ) ? 1 : -1]; |
---|
3545 | char assertK[(sizeof(UDPHeader ) == 8 ) ? 1 : -1]; |
---|
3546 | char assertL[(sizeof(IKEHeader ) == 28 ) ? 1 : -1]; |
---|
3547 | char assertM[(sizeof(TCPHeader ) == 20 ) ? 1 : -1]; |
---|
3548 | |
---|
3549 | // Check our structures are reasonable sizes. Including overly-large buffers, or embedding |
---|
3550 | // other overly-large structures instead of having a pointer to them, can inadvertently |
---|
3551 | // cause structure sizes (and therefore memory usage) to balloon unreasonably. |
---|
3552 | char sizecheck_RDataBody [(sizeof(RDataBody) == 264) ? 1 : -1]; |
---|
3553 | char sizecheck_ResourceRecord [(sizeof(ResourceRecord) <= 72) ? 1 : -1]; |
---|
3554 | char sizecheck_AuthRecord [(sizeof(AuthRecord) <= 1208) ? 1 : -1]; |
---|
3555 | char sizecheck_CacheRecord [(sizeof(CacheRecord) <= 232) ? 1 : -1]; |
---|
3556 | char sizecheck_CacheGroup [(sizeof(CacheGroup) <= 232) ? 1 : -1]; |
---|
3557 | char sizecheck_DNSQuestion [(sizeof(DNSQuestion) <= 832) ? 1 : -1]; |
---|
3558 | |
---|
3559 | // Checks commented out when sizeof(DNSQuestion) change cascaded into having to change yet another |
---|
3560 | // set of hardcoded size values because these structures contain one or more DNSQuestion |
---|
3561 | // instances. |
---|
3562 | // char sizecheck_ZoneData [(sizeof(ZoneData) <= 1648) ? 1 : -1]; |
---|
3563 | char sizecheck_NATTraversalInfo [(sizeof(NATTraversalInfo) <= 200) ? 1 : -1]; |
---|
3564 | char sizecheck_HostnameInfo [(sizeof(HostnameInfo) <= 3050) ? 1 : -1]; |
---|
3565 | char sizecheck_DNSServer [(sizeof(DNSServer) <= 340) ? 1 : -1]; |
---|
3566 | // char sizecheck_NetworkInterfaceInfo[(sizeof(NetworkInterfaceInfo) <= 6988) ? 1 : -1]; |
---|
3567 | char sizecheck_ServiceRecordSet [(sizeof(ServiceRecordSet) <= 5540) ? 1 : -1]; |
---|
3568 | char sizecheck_DomainAuthInfo [(sizeof(DomainAuthInfo) <= 7888) ? 1 : -1]; |
---|
3569 | // char sizecheck_ServiceInfoQuery [(sizeof(ServiceInfoQuery) <= 3302) ? 1 : -1]; |
---|
3570 | #if APPLE_OSX_mDNSResponder |
---|
3571 | // char sizecheck_ClientTunnel [(sizeof(ClientTunnel) <= 1160) ? 1 : -1]; |
---|
3572 | #endif |
---|
3573 | }; |
---|
3574 | |
---|
3575 | // Routine to initialize device-info TXT record contents |
---|
3576 | mDNSu32 initializeDeviceInfoTXT(mDNS *m, mDNSu8 *ptr); |
---|
3577 | |
---|
3578 | #if APPLE_OSX_mDNSResponder |
---|
3579 | extern void D2D_start_advertising_interface(NetworkInterfaceInfo *interface); |
---|
3580 | extern void D2D_stop_advertising_interface(NetworkInterfaceInfo *interface); |
---|
3581 | #endif |
---|
3582 | |
---|
3583 | // *************************************************************************** |
---|
3584 | |
---|
3585 | #ifdef __cplusplus |
---|
3586 | } |
---|
3587 | #endif |
---|
3588 | |
---|
3589 | #endif |
---|