]> git.saurik.com Git - apple/mdnsresponder.git/blob - mDNSCore/mDNS.c
mDNSResponder-878.200.35.tar.gz
[apple/mdnsresponder.git] / mDNSCore / mDNS.c
1 /* -*- Mode: C; tab-width: 4 -*-
2 *
3 * Copyright (c) 2002-2018 Apple Inc. All rights reserved.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 * This code is completely 100% portable C. It does not depend on any external header files
18 * from outside the mDNS project -- all the types it expects to find are defined right here.
19 *
20 * The previous point is very important: This file does not depend on any external
21 * header files. It should compile on *any* platform that has a C compiler, without
22 * making *any* assumptions about availability of so-called "standard" C functions,
23 * routines, or types (which may or may not be present on any given platform).
24 */
25
26 #include "DNSCommon.h" // Defines general DNS utility routines
27 #include "uDNS.h" // Defines entry points into unicast-specific routines
28 #include "nsec.h"
29 #include "dnssec.h"
30 #include "anonymous.h"
31
32 // Disable certain benign warnings with Microsoft compilers
33 #if (defined(_MSC_VER))
34 // Disable "conditional expression is constant" warning for debug macros.
35 // Otherwise, this generates warnings for the perfectly natural construct "while(1)"
36 // If someone knows a variant way of writing "while(1)" that doesn't generate warning messages, please let us know
37 #pragma warning(disable:4127)
38
39 // Disable "assignment within conditional expression".
40 // Other compilers understand the convention that if you place the assignment expression within an extra pair
41 // of parentheses, this signals to the compiler that you really intended an assignment and no warning is necessary.
42 // The Microsoft compiler doesn't understand this convention, so in the absense of any other way to signal
43 // to the compiler that the assignment is intentional, we have to just turn this warning off completely.
44 #pragma warning(disable:4706)
45 #endif
46
47 #include "dns_sd.h" // for kDNSServiceFlags* definitions
48 #include "dns_sd_internal.h"
49
50 #if APPLE_OSX_mDNSResponder
51 #include <WebFilterDNS/WebFilterDNS.h>
52
53 // Delay in seconds before disabling multicast after there are no active queries or registrations.
54 #define BONJOUR_DISABLE_DELAY 60
55
56 #if !NO_WCF
57 WCFConnection *WCFConnectionNew(void) __attribute__((weak_import));
58 void WCFConnectionDealloc(WCFConnection* c) __attribute__((weak_import));
59
60 // Do we really need to define a macro for "if"?
61 #define CHECK_WCF_FUNCTION(X) if (X)
62 #endif // ! NO_WCF
63
64 #else
65
66 #define NO_WCF 1
67 #endif // APPLE_OSX_mDNSResponder
68
69 #if AWD_METRICS
70 #include "Metrics.h"
71 #endif
72
73 #if USE_DNS64
74 #include "DNS64.h"
75 #endif
76
77 #ifdef UNIT_TEST
78 #include "unittest.h"
79 #endif
80
81 // Forward declarations
82 mDNSlocal void BeginSleepProcessing(mDNS *const m);
83 mDNSlocal void RetrySPSRegistrations(mDNS *const m);
84 mDNSlocal void SendWakeup(mDNS *const m, mDNSInterfaceID InterfaceID, mDNSEthAddr *EthAddr, mDNSOpaque48 *password, mDNSBool unicastOnly);
85 mDNSlocal mDNSBool LocalRecordRmvEventsForQuestion(mDNS *const m, DNSQuestion *q);
86 mDNSlocal void mDNS_PurgeBeforeResolve(mDNS *const m, DNSQuestion *q);
87 mDNSlocal void CheckForDNSSECRecords(mDNS *const m, DNSQuestion *q);
88 mDNSlocal void mDNS_SendKeepalives(mDNS *const m);
89 mDNSlocal void mDNS_ExtractKeepaliveInfo(AuthRecord *ar, mDNSu32 *timeout, mDNSAddr *laddr, mDNSAddr *raddr, mDNSEthAddr *eth,
90 mDNSu32 *seq, mDNSu32 *ack, mDNSIPPort *lport, mDNSIPPort *rport, mDNSu16 *win);
91
92 mDNSlocal void AdvertiseAllInterfaceRecords(mDNS *const m);
93 mDNSlocal void DeadvertiseAllInterfaceRecords(mDNS *const m);
94 mDNSlocal void FreeNSECRecords(mDNS *const m, CacheRecord *NSECRecords);
95 mDNSlocal void mDNSParseNSEC3Records(mDNS *const m, const DNSMessage *const response, const mDNSu8 *end,
96 const mDNSInterfaceID InterfaceID, CacheRecord **NSEC3Records);
97 mDNSlocal mDNSu8 *GetValueForMACAddr(mDNSu8 *ptr, mDNSu8 *limit, mDNSEthAddr *eth);
98
99
100 // ***************************************************************************
101 #if COMPILER_LIKES_PRAGMA_MARK
102 #pragma mark - Program Constants
103 #endif
104
105 // To Turn OFF mDNS_Tracer set MDNS_TRACER to 0 or undef it
106 #define MDNS_TRACER 1
107
108 #define NO_HINFO 1
109
110 // Any records bigger than this are considered 'large' records
111 #define SmallRecordLimit 1024
112
113 #define kMaxUpdateCredits 10
114 #define kUpdateCreditRefreshInterval (mDNSPlatformOneSecond * 6)
115
116 // define special NR_AnswerTo values
117 #define NR_AnswerMulticast (mDNSu8*)~0
118 #define NR_AnswerUnicast (mDNSu8*)~1
119
120 // Question default timeout values
121 #define DEFAULT_MCAST_TIMEOUT 5
122 #define DEFAULT_LO_OR_P2P_TIMEOUT 5
123
124 // The code (see SendQueries() and BuildQuestion()) needs to have the
125 // RequestUnicast value set to a value one greater than the number of times you want the query
126 // sent with the "request unicast response" (QU) bit set.
127 #define SET_QU_IN_FIRST_QUERY 2
128 #define kDefaultRequestUnicastCount SET_QU_IN_FIRST_QUERY
129
130 // The time needed to offload records to a sleep proxy after powerd sends the kIOMessageSystemWillSleep notification
131 #define DARK_WAKE_DELAY_SLEEP 5
132 #define kDarkWakeDelaySleep (mDNSPlatformOneSecond * DARK_WAKE_DELAY_SLEEP)
133
134 // The maximum number of times we delay probing to prevent spurious conflicts due to stale packets
135 #define MAX_CONFLICT_PROCESSING_DELAYS 3
136
137 // RFC 6762 defines Passive Observation Of Failures (POOF)
138 //
139 // A host observes the multicast queries issued by the other hosts on
140 // the network. One of the major benefits of also sending responses
141 // using multicast is that it allows all hosts to see the responses
142 // (or lack thereof) to those queries.
143 //
144 // If a host sees queries, for which a record in its cache would be
145 // expected to be given as an answer in a multicast response, but no
146 // such answer is seen, then the host may take this as an indication
147 // that the record may no longer be valid.
148 //
149 // After seeing two or more of these queries, and seeing no multicast
150 // response containing the expected answer within ten seconds, then even
151 // though its TTL may indicate that it is not yet due to expire, that
152 // record SHOULD be flushed from the cache.
153 //
154 // <https://tools.ietf.org/html/rfc6762#section-10.5>
155
156 #define POOF_ENABLED 1
157
158 mDNSexport const char *const mDNS_DomainTypeNames[] =
159 {
160 "b._dns-sd._udp.", // Browse
161 "db._dns-sd._udp.", // Default Browse
162 "lb._dns-sd._udp.", // Automatic Browse
163 "r._dns-sd._udp.", // Registration
164 "dr._dns-sd._udp." // Default Registration
165 };
166
167 #ifdef UNICAST_DISABLED
168 #define uDNS_IsActiveQuery(q, u) mDNSfalse
169 #endif
170
171 // ***************************************************************************
172 #if COMPILER_LIKES_PRAGMA_MARK
173 #pragma mark -
174 #pragma mark - General Utility Functions
175 #endif
176
177 // Returns true if this is a unique, authoritative LocalOnly record that answers questions of type
178 // A, AAAA , CNAME, or PTR. The caller should answer the question with this record and not send out
179 // the question on the wire if LocalOnlyRecordAnswersQuestion() also returns true.
180 // Main use is to handle /etc/hosts records and the LocalOnly PTR records created for localhost.
181 #define UniqueLocalOnlyRecord(rr) ((rr)->ARType == AuthRecordLocalOnly && \
182 (rr)->resrec.RecordType & kDNSRecordTypeUniqueMask && \
183 ((rr)->resrec.rrtype == kDNSType_A || (rr)->resrec.rrtype == kDNSType_AAAA || \
184 (rr)->resrec.rrtype == kDNSType_CNAME || \
185 (rr)->resrec.rrtype == kDNSType_PTR))
186
187 mDNSlocal void SetNextQueryStopTime(mDNS *const m, const DNSQuestion *const q)
188 {
189 mDNS_CheckLock(m);
190
191 if (m->NextScheduledStopTime - q->StopTime > 0)
192 m->NextScheduledStopTime = q->StopTime;
193 }
194
195 mDNSexport void SetNextQueryTime(mDNS *const m, const DNSQuestion *const q)
196 {
197 mDNS_CheckLock(m);
198
199 if (ActiveQuestion(q))
200 {
201 // Depending on whether this is a multicast or unicast question we want to set either:
202 // m->NextScheduledQuery = NextQSendTime(q) or
203 // m->NextuDNSEvent = NextQSendTime(q)
204 mDNSs32 *const timer = mDNSOpaque16IsZero(q->TargetQID) ? &m->NextScheduledQuery : &m->NextuDNSEvent;
205 if (*timer - NextQSendTime(q) > 0)
206 *timer = NextQSendTime(q);
207 }
208 }
209
210 mDNSlocal void ReleaseAuthEntity(AuthHash *r, AuthEntity *e)
211 {
212 #if APPLE_OSX_mDNSResponder && MACOSX_MDNS_MALLOC_DEBUGGING >= 1
213 unsigned int i;
214 for (i=0; i<sizeof(*e); i++) ((char*)e)[i] = 0xFF;
215 #endif
216 e->next = r->rrauth_free;
217 r->rrauth_free = e;
218 r->rrauth_totalused--;
219 }
220
221 mDNSlocal void ReleaseAuthGroup(AuthHash *r, AuthGroup **cp)
222 {
223 AuthEntity *e = (AuthEntity *)(*cp);
224 LogMsg("ReleaseAuthGroup: Releasing AuthGroup %##s", (*cp)->name->c);
225 if ((*cp)->rrauth_tail != &(*cp)->members)
226 LogMsg("ERROR: (*cp)->members == mDNSNULL but (*cp)->rrauth_tail != &(*cp)->members)");
227 if ((*cp)->name != (domainname*)((*cp)->namestorage)) mDNSPlatformMemFree((*cp)->name);
228 (*cp)->name = mDNSNULL;
229 *cp = (*cp)->next; // Cut record from list
230 ReleaseAuthEntity(r, e);
231 }
232
233 mDNSlocal AuthEntity *GetAuthEntity(AuthHash *r, const AuthGroup *const PreserveAG)
234 {
235 AuthEntity *e = mDNSNULL;
236
237 if (r->rrauth_lock) { LogMsg("GetFreeCacheRR ERROR! Cache already locked!"); return(mDNSNULL); }
238 r->rrauth_lock = 1;
239
240 if (!r->rrauth_free)
241 {
242 // We allocate just one AuthEntity at a time because we need to be able
243 // free them all individually which normally happens when we parse /etc/hosts into
244 // AuthHash where we add the "new" entries and discard (free) the already added
245 // entries. If we allocate as chunks, we can't free them individually.
246 AuthEntity *storage = mDNSPlatformMemAllocate(sizeof(AuthEntity));
247 storage->next = mDNSNULL;
248 r->rrauth_free = storage;
249 }
250
251 // If we still have no free records, recycle all the records we can.
252 // Enumerating the entire auth is moderately expensive, so when we do it, we reclaim all the records we can in one pass.
253 if (!r->rrauth_free)
254 {
255 mDNSu32 oldtotalused = r->rrauth_totalused;
256 mDNSu32 slot;
257 for (slot = 0; slot < AUTH_HASH_SLOTS; slot++)
258 {
259 AuthGroup **cp = &r->rrauth_hash[slot];
260 while (*cp)
261 {
262 if ((*cp)->members || (*cp)==PreserveAG) cp=&(*cp)->next;
263 else ReleaseAuthGroup(r, cp);
264 }
265 }
266 LogInfo("GetAuthEntity: Recycled %d records to reduce auth cache from %d to %d",
267 oldtotalused - r->rrauth_totalused, oldtotalused, r->rrauth_totalused);
268 }
269
270 if (r->rrauth_free) // If there are records in the free list, take one
271 {
272 e = r->rrauth_free;
273 r->rrauth_free = e->next;
274 if (++r->rrauth_totalused >= r->rrauth_report)
275 {
276 LogInfo("RR Auth now using %ld objects", r->rrauth_totalused);
277 if (r->rrauth_report < 100) r->rrauth_report += 10;
278 else if (r->rrauth_report < 1000) r->rrauth_report += 100;
279 else r->rrauth_report += 1000;
280 }
281 mDNSPlatformMemZero(e, sizeof(*e));
282 }
283
284 r->rrauth_lock = 0;
285
286 return(e);
287 }
288
289 mDNSexport AuthGroup *AuthGroupForName(AuthHash *r, const mDNSu32 namehash, const domainname *const name)
290 {
291 AuthGroup *ag;
292 const mDNSu32 slot = namehash % AUTH_HASH_SLOTS;
293
294 for (ag = r->rrauth_hash[slot]; ag; ag=ag->next)
295 if (ag->namehash == namehash && SameDomainName(ag->name, name))
296 break;
297 return(ag);
298 }
299
300 mDNSexport AuthGroup *AuthGroupForRecord(AuthHash *r, const ResourceRecord *const rr)
301 {
302 return(AuthGroupForName(r, rr->namehash, rr->name));
303 }
304
305 mDNSlocal AuthGroup *GetAuthGroup(AuthHash *r, const ResourceRecord *const rr)
306 {
307 mDNSu16 namelen = DomainNameLength(rr->name);
308 AuthGroup *ag = (AuthGroup*)GetAuthEntity(r, mDNSNULL);
309 const mDNSu32 slot = rr->namehash % AUTH_HASH_SLOTS;
310 if (!ag) { LogMsg("GetAuthGroup: Failed to allocate memory for %##s", rr->name->c); return(mDNSNULL); }
311 ag->next = r->rrauth_hash[slot];
312 ag->namehash = rr->namehash;
313 ag->members = mDNSNULL;
314 ag->rrauth_tail = &ag->members;
315 ag->NewLocalOnlyRecords = mDNSNULL;
316 if (namelen > sizeof(ag->namestorage))
317 ag->name = mDNSPlatformMemAllocate(namelen);
318 else
319 ag->name = (domainname*)ag->namestorage;
320 if (!ag->name)
321 {
322 LogMsg("GetAuthGroup: Failed to allocate name storage for %##s", rr->name->c);
323 ReleaseAuthEntity(r, (AuthEntity*)ag);
324 return(mDNSNULL);
325 }
326 AssignDomainName(ag->name, rr->name);
327
328 if (AuthGroupForRecord(r, rr)) LogMsg("GetAuthGroup: Already have AuthGroup for %##s", rr->name->c);
329 r->rrauth_hash[slot] = ag;
330 if (AuthGroupForRecord(r, rr) != ag) LogMsg("GetAuthGroup: Not finding AuthGroup for %##s", rr->name->c);
331
332 return(ag);
333 }
334
335 // Returns the AuthGroup in which the AuthRecord was inserted
336 mDNSexport AuthGroup *InsertAuthRecord(mDNS *const m, AuthHash *r, AuthRecord *rr)
337 {
338 AuthGroup *ag;
339
340 (void)m;
341 ag = AuthGroupForRecord(r, &rr->resrec);
342 if (!ag) ag = GetAuthGroup(r, &rr->resrec); // If we don't have a AuthGroup for this name, make one now
343 if (ag)
344 {
345 *(ag->rrauth_tail) = rr; // Append this record to tail of cache slot list
346 ag->rrauth_tail = &(rr->next); // Advance tail pointer
347 }
348 return ag;
349 }
350
351 mDNSexport AuthGroup *RemoveAuthRecord(mDNS *const m, AuthHash *r, AuthRecord *rr)
352 {
353 AuthGroup *a;
354 AuthRecord **rp;
355
356 a = AuthGroupForRecord(r, &rr->resrec);
357 if (!a) { LogMsg("RemoveAuthRecord: ERROR!! AuthGroup not found for %s", ARDisplayString(m, rr)); return mDNSNULL; }
358 rp = &a->members;
359 while (*rp)
360 {
361 if (*rp != rr)
362 rp=&(*rp)->next;
363 else
364 {
365 // We don't break here, so that we can set the tail below without tracking "prev" pointers
366
367 LogInfo("RemoveAuthRecord: removing auth record %s from table", ARDisplayString(m, rr));
368 *rp = (*rp)->next; // Cut record from list
369 }
370 }
371 // TBD: If there are no more members, release authgroup ?
372 a->rrauth_tail = rp;
373 return a;
374 }
375
376 mDNSexport CacheGroup *CacheGroupForName(const mDNS *const m, const mDNSu32 namehash, const domainname *const name)
377 {
378 CacheGroup *cg;
379 mDNSu32 slot = HashSlotFromNameHash(namehash);
380 for (cg = m->rrcache_hash[slot]; cg; cg=cg->next)
381 if (cg->namehash == namehash && SameDomainName(cg->name, name))
382 break;
383 return(cg);
384 }
385
386 mDNSlocal CacheGroup *CacheGroupForRecord(const mDNS *const m, const ResourceRecord *const rr)
387 {
388 return(CacheGroupForName(m, rr->namehash, rr->name));
389 }
390
391 mDNSexport mDNSBool mDNS_AddressIsLocalSubnet(mDNS *const m, const mDNSInterfaceID InterfaceID, const mDNSAddr *addr)
392 {
393 NetworkInterfaceInfo *intf;
394
395 if (addr->type == mDNSAddrType_IPv4)
396 {
397 // Normally we resist touching the NotAnInteger fields, but here we're doing tricky bitwise masking so we make an exception
398 if (mDNSv4AddressIsLinkLocal(&addr->ip.v4)) return(mDNStrue);
399 for (intf = m->HostInterfaces; intf; intf = intf->next)
400 if (intf->ip.type == addr->type && intf->InterfaceID == InterfaceID && intf->McastTxRx)
401 if (((intf->ip.ip.v4.NotAnInteger ^ addr->ip.v4.NotAnInteger) & intf->mask.ip.v4.NotAnInteger) == 0)
402 return(mDNStrue);
403 }
404
405 if (addr->type == mDNSAddrType_IPv6)
406 {
407 if (mDNSv6AddressIsLinkLocal(&addr->ip.v6)) return(mDNStrue);
408 for (intf = m->HostInterfaces; intf; intf = intf->next)
409 if (intf->ip.type == addr->type && intf->InterfaceID == InterfaceID && intf->McastTxRx)
410 if ((((intf->ip.ip.v6.l[0] ^ addr->ip.v6.l[0]) & intf->mask.ip.v6.l[0]) == 0) &&
411 (((intf->ip.ip.v6.l[1] ^ addr->ip.v6.l[1]) & intf->mask.ip.v6.l[1]) == 0) &&
412 (((intf->ip.ip.v6.l[2] ^ addr->ip.v6.l[2]) & intf->mask.ip.v6.l[2]) == 0) &&
413 (((intf->ip.ip.v6.l[3] ^ addr->ip.v6.l[3]) & intf->mask.ip.v6.l[3]) == 0))
414 return(mDNStrue);
415 }
416
417 return(mDNSfalse);
418 }
419
420 mDNSlocal NetworkInterfaceInfo *FirstInterfaceForID(mDNS *const m, const mDNSInterfaceID InterfaceID)
421 {
422 NetworkInterfaceInfo *intf = m->HostInterfaces;
423 while (intf && intf->InterfaceID != InterfaceID) intf = intf->next;
424 return(intf);
425 }
426
427 mDNSlocal NetworkInterfaceInfo *FirstIPv4LLInterfaceForID(mDNS *const m, const mDNSInterfaceID InterfaceID)
428 {
429 NetworkInterfaceInfo *intf;
430
431 if (!InterfaceID)
432 return mDNSNULL;
433
434 // Note: We don't check for InterfaceActive, as the active interface could be IPv6 and
435 // we still want to find the first IPv4 Link-Local interface
436 for (intf = m->HostInterfaces; intf; intf = intf->next)
437 {
438 if (intf->InterfaceID == InterfaceID &&
439 intf->ip.type == mDNSAddrType_IPv4 && mDNSv4AddressIsLinkLocal(&intf->ip.ip.v4))
440 {
441 debugf("FirstIPv4LLInterfaceForID: found LL interface with address %.4a", &intf->ip.ip.v4);
442 return intf;
443 }
444 }
445 return (mDNSNULL);
446 }
447
448 mDNSexport char *InterfaceNameForID(mDNS *const m, const mDNSInterfaceID InterfaceID)
449 {
450 NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
451 return(intf ? intf->ifname : mDNSNULL);
452 }
453
454 // Caller should hold the lock
455 mDNSlocal void GenerateNegativeResponse(mDNS *const m, mDNSInterfaceID InterfaceID, QC_result qc)
456 {
457 DNSQuestion *q;
458 if (!m->CurrentQuestion) { LogMsg("GenerateNegativeResponse: ERROR!! CurrentQuestion not set"); return; }
459 q = m->CurrentQuestion;
460 LogInfo("GenerateNegativeResponse: Generating negative response for question %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
461
462 MakeNegativeCacheRecord(m, &m->rec.r, &q->qname, q->qnamehash, q->qtype, q->qclass, 60, InterfaceID, mDNSNULL);
463
464 // We need to force the response through in the following cases
465 //
466 // a) SuppressUnusable questions that are suppressed
467 // b) Append search domains and retry the question
468 //
469 // The question may not have set Intermediates in which case we don't deliver negative responses. So, to force
470 // through we use "QC_forceresponse".
471 AnswerCurrentQuestionWithResourceRecord(m, &m->rec.r, qc);
472 if (m->CurrentQuestion == q) { q->ThisQInterval = 0; } // Deactivate this question
473 // Don't touch the question after this
474 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
475 }
476
477 mDNSexport void AnswerQuestionByFollowingCNAME(mDNS *const m, DNSQuestion *q, ResourceRecord *rr)
478 {
479 const mDNSBool selfref = SameDomainName(&q->qname, &rr->rdata->u.name);
480 if (q->CNAMEReferrals >= 10 || selfref)
481 {
482 LogMsg("AnswerQuestionByFollowingCNAME: %p %##s (%s) NOT following CNAME referral %d%s for %s",
483 q, q->qname.c, DNSTypeName(q->qtype), q->CNAMEReferrals, selfref ? " (Self-Referential)" : "", RRDisplayString(m, rr));
484 }
485 else
486 {
487 const mDNSu32 c = q->CNAMEReferrals + 1; // Stash a copy of the new q->CNAMEReferrals value
488 UDPSocket *sock = q->LocalSocket;
489 mDNSOpaque16 id = q->TargetQID;
490 #if AWD_METRICS
491 uDNSMetrics metrics;
492 #endif
493
494 q->LocalSocket = mDNSNULL;
495
496 // The SameDomainName check above is to ignore bogus CNAME records that point right back at
497 // themselves. Without that check we can get into a case where we have two duplicate questions,
498 // A and B, and when we stop question A, UpdateQuestionDuplicates copies the value of CNAMEReferrals
499 // from A to B, and then A is re-appended to the end of the list as a duplicate of B (because
500 // the target name is still the same), and then when we stop question B, UpdateQuestionDuplicates
501 // copies the B's value of CNAMEReferrals back to A, and we end up not incrementing CNAMEReferrals
502 // for either of them. This is not a problem for CNAME loops of two or more records because in
503 // those cases the newly re-appended question A has a different target name and therefore cannot be
504 // a duplicate of any other question ('B') which was itself a duplicate of the previous question A.
505
506 // Right now we just stop and re-use the existing query. If we really wanted to be 100% perfect,
507 // and track CNAMEs coming and going, we should really create a subordinate query here,
508 // which we would subsequently cancel and retract if the CNAME referral record were removed.
509 // In reality this is such a corner case we'll ignore it until someone actually needs it.
510
511 LogInfo("AnswerQuestionByFollowingCNAME: %p %##s (%s) following CNAME referral %d for %s",
512 q, q->qname.c, DNSTypeName(q->qtype), q->CNAMEReferrals, RRDisplayString(m, rr));
513
514 #if AWD_METRICS
515 if ((q->CNAMEReferrals == 0) && !q->metrics.originalQName)
516 {
517 domainname * qName;
518 mDNSu16 qNameLen;
519
520 qNameLen = DomainNameLength(&q->qname);
521 if ((qNameLen > 0) && (qNameLen <= MAX_DOMAIN_NAME))
522 {
523 qName = mDNSPlatformMemAllocate(qNameLen);
524 if (qName)
525 {
526 mDNSPlatformMemCopy(qName->c, q->qname.c, qNameLen);
527 q->metrics.originalQName = qName;
528 }
529 }
530 }
531 metrics = q->metrics;
532 mDNSPlatformMemZero(&q->metrics, sizeof(q->metrics));
533 #endif
534 mDNS_StopQuery_internal(m, q); // Stop old query
535 AssignDomainName(&q->qname, &rr->rdata->u.name); // Update qname
536 q->qnamehash = DomainNameHashValue(&q->qname); // and namehash
537 // If a unicast query results in a CNAME that points to a .local, we need to re-try
538 // this as unicast. Setting the mDNSInterface_Unicast tells mDNS_StartQuery_internal
539 // to try this as unicast query even though it is a .local name
540 if (!mDNSOpaque16IsZero(q->TargetQID) && IsLocalDomain(&q->qname))
541 {
542 LogInfo("AnswerQuestionByFollowingCNAME: Resolving a .local CNAME %p %##s (%s) Record %s",
543 q, q->qname.c, DNSTypeName(q->qtype), RRDisplayString(m, rr));
544 q->InterfaceID = mDNSInterface_Unicast;
545 }
546 mDNS_StartQuery_internal(m, q); // start new query
547 // Record how many times we've done this. We need to do this *after* mDNS_StartQuery_internal,
548 // because mDNS_StartQuery_internal re-initializes CNAMEReferrals to zero
549 q->CNAMEReferrals = c;
550 #if AWD_METRICS
551 metrics.expiredAnswerState = q->metrics.expiredAnswerState; // We want the newly initialized state for this value
552 q->metrics = metrics;
553 #endif
554 if (sock)
555 {
556 // If our new query is a duplicate, then it can't have a socket of its own, so we have to close the one we saved.
557 if (q->DuplicateOf) mDNSPlatformUDPClose(sock);
558 else
559 {
560 // Transplant the old socket into the new question, and copy the query ID across too.
561 // No need to close the old q->LocalSocket value because it won't have been created yet (they're made lazily on-demand).
562 q->LocalSocket = sock;
563 q->TargetQID = id;
564 }
565 }
566 }
567 }
568
569 #ifdef USE_LIBIDN
570
571 #include <unicode/uidna.h>
572
573 // #define DEBUG_PUNYCODE 1
574
575 mDNSlocal mDNSu8 *PunycodeConvert(const mDNSu8 *const src, mDNSu8 *const dst, const mDNSu8 *const end)
576 {
577 UErrorCode errorCode = U_ZERO_ERROR;
578 UIDNAInfo info = UIDNA_INFO_INITIALIZER;
579 UIDNA *uts46 = uidna_openUTS46(UIDNA_USE_STD3_RULES|UIDNA_NONTRANSITIONAL_TO_UNICODE, &errorCode);
580 int32_t len = uidna_nameToASCII_UTF8(uts46, (const char *)src+1, src[0], (char *)dst+1, end-(dst+1), &info, &errorCode);
581 uidna_close(uts46);
582 #if DEBUG_PUNYCODE
583 if (errorCode) LogMsg("uidna_nameToASCII_UTF8(%##s) failed errorCode %d", src, errorCode);
584 if (info.errors) LogMsg("uidna_nameToASCII_UTF8(%##s) failed info.errors 0x%08X", src, info.errors);
585 if (len > MAX_DOMAIN_LABEL) LogMsg("uidna_nameToASCII_UTF8(%##s) result too long %d", src, len);
586 #endif
587 if (errorCode || info.errors || len > MAX_DOMAIN_LABEL) return mDNSNULL;
588 *dst = len;
589 return(dst + 1 + len);
590 }
591
592 mDNSlocal mDNSBool IsHighASCIILabel(const mDNSu8 *d)
593 {
594 int i;
595 for (i=1; i<=d[0]; i++) if (d[i] & 0x80) return mDNStrue;
596 return mDNSfalse;
597 }
598
599 mDNSlocal const mDNSu8 *FindLastHighASCIILabel(const domainname *const d)
600 {
601 const mDNSu8 *ptr = d->c;
602 const mDNSu8 *ans = mDNSNULL;
603 while (ptr[0])
604 {
605 const mDNSu8 *const next = ptr + 1 + ptr[0];
606 if (ptr[0] > MAX_DOMAIN_LABEL || next >= d->c + MAX_DOMAIN_NAME) return mDNSNULL;
607 if (IsHighASCIILabel(ptr)) ans = ptr;
608 ptr = next;
609 }
610 return ans;
611 }
612
613 mDNSlocal mDNSBool PerformNextPunycodeConversion(const DNSQuestion *const q, domainname *const newname)
614 {
615 const mDNSu8 *h = FindLastHighASCIILabel(&q->qname);
616 #if DEBUG_PUNYCODE
617 LogMsg("PerformNextPunycodeConversion: %##s (%s) Last High-ASCII Label %##s", q->qname.c, DNSTypeName(q->qtype), h);
618 #endif
619 if (!h) return mDNSfalse; // There are no high-ascii labels to convert
620
621 mDNSu8 *const dst = PunycodeConvert(h, newname->c + (h - q->qname.c), newname->c + MAX_DOMAIN_NAME);
622 if (!dst)
623 return mDNSfalse; // The label was not convertible to Punycode
624 else
625 {
626 // If Punycode conversion of final eligible label was successful, copy the rest of the domainname
627 const mDNSu8 *const src = h + 1 + h[0];
628 const mDNSu8 remainder = DomainNameLength((domainname*)src);
629 if (dst + remainder > newname->c + MAX_DOMAIN_NAME) return mDNSfalse; // Name too long -- cannot be converted to Punycode
630
631 mDNSPlatformMemCopy(newname->c, q->qname.c, h - q->qname.c); // Fill in the leading part
632 mDNSPlatformMemCopy(dst, src, remainder); // Fill in the trailing part
633 #if DEBUG_PUNYCODE
634 LogMsg("PerformNextPunycodeConversion: %##s converted to %##s", q->qname.c, newname->c);
635 #endif
636 return mDNStrue;
637 }
638 }
639
640 #endif // USE_LIBIDN
641
642 // For a single given DNSQuestion pointed to by CurrentQuestion, deliver an add/remove result for the single given AuthRecord
643 // Note: All the callers should use the m->CurrentQuestion to see if the question is still valid or not
644 mDNSlocal void AnswerLocalQuestionWithLocalAuthRecord(mDNS *const m, AuthRecord *rr, QC_result AddRecord)
645 {
646 DNSQuestion *q = m->CurrentQuestion;
647 mDNSBool followcname;
648
649 if (!q)
650 {
651 LogMsg("AnswerLocalQuestionWithLocalAuthRecord: ERROR!! CurrentQuestion NULL while answering with %s", ARDisplayString(m, rr));
652 return;
653 }
654
655 followcname = FollowCNAME(q, &rr->resrec, AddRecord);
656
657 // We should not be delivering results for record types Unregistered, Deregistering, and (unverified) Unique
658 if (!(rr->resrec.RecordType & kDNSRecordTypeActiveMask))
659 {
660 LogMsg("AnswerLocalQuestionWithLocalAuthRecord: *NOT* delivering %s event for local record type %X %s",
661 AddRecord ? "Add" : "Rmv", rr->resrec.RecordType, ARDisplayString(m, rr));
662 return;
663 }
664
665 // Indicate that we've given at least one positive answer for this record, so we should be prepared to send a goodbye for it
666 if (AddRecord) rr->AnsweredLocalQ = mDNStrue;
667 mDNS_DropLockBeforeCallback(); // Allow client to legally make mDNS API calls from the callback
668 if (q->QuestionCallback && !q->NoAnswer)
669 {
670 q->CurrentAnswers += AddRecord ? 1 : -1;
671 if (UniqueLocalOnlyRecord(rr))
672 {
673 if (!followcname || q->ReturnIntermed)
674 {
675 // Don't send this packet on the wire as we answered from /etc/hosts
676 q->ThisQInterval = 0;
677 q->LOAddressAnswers += AddRecord ? 1 : -1;
678 q->QuestionCallback(m, q, &rr->resrec, AddRecord);
679 }
680 mDNS_ReclaimLockAfterCallback(); // Decrement mDNS_reentrancy to block mDNS API calls again
681 // The callback above could have caused the question to stop. Detect that
682 // using m->CurrentQuestion
683 if (followcname && m->CurrentQuestion == q)
684 AnswerQuestionByFollowingCNAME(m, q, &rr->resrec);
685 return;
686 }
687 else
688 {
689 q->QuestionCallback(m, q, &rr->resrec, AddRecord);
690 }
691 }
692 mDNS_ReclaimLockAfterCallback(); // Decrement mDNS_reentrancy to block mDNS API calls again
693 }
694
695 mDNSlocal void AnswerInterfaceAnyQuestionsWithLocalAuthRecord(mDNS *const m, AuthRecord *rr, QC_result AddRecord)
696 {
697 if (m->CurrentQuestion)
698 LogMsg("AnswerInterfaceAnyQuestionsWithLocalAuthRecord: ERROR m->CurrentQuestion already set: %##s (%s)",
699 m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
700 m->CurrentQuestion = m->Questions;
701 while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
702 {
703 mDNSBool answered;
704 DNSQuestion *q = m->CurrentQuestion;
705 if (RRAny(rr))
706 answered = ResourceRecordAnswersQuestion(&rr->resrec, q);
707 else
708 answered = LocalOnlyRecordAnswersQuestion(rr, q);
709 if (answered)
710 AnswerLocalQuestionWithLocalAuthRecord(m, rr, AddRecord); // MUST NOT dereference q again
711 if (m->CurrentQuestion == q) // If m->CurrentQuestion was not auto-advanced, do it ourselves now
712 m->CurrentQuestion = q->next;
713 }
714 m->CurrentQuestion = mDNSNULL;
715 }
716
717 // When a new local AuthRecord is created or deleted, AnswerAllLocalQuestionsWithLocalAuthRecord()
718 // delivers the appropriate add/remove events to listening questions:
719 // 1. It runs though all our LocalOnlyQuestions delivering answers as appropriate,
720 // stopping if it reaches a NewLocalOnlyQuestion -- brand-new questions are handled by AnswerNewLocalOnlyQuestion().
721 // 2. If the AuthRecord is marked mDNSInterface_LocalOnly or mDNSInterface_P2P, then it also runs though
722 // our main question list, delivering answers to mDNSInterface_Any questions as appropriate,
723 // stopping if it reaches a NewQuestion -- brand-new questions are handled by AnswerNewQuestion().
724 //
725 // AnswerAllLocalQuestionsWithLocalAuthRecord is used by the m->NewLocalRecords loop in mDNS_Execute(),
726 // and by mDNS_Deregister_internal()
727
728 mDNSlocal void AnswerAllLocalQuestionsWithLocalAuthRecord(mDNS *const m, AuthRecord *rr, QC_result AddRecord)
729 {
730 if (m->CurrentQuestion)
731 LogMsg("AnswerAllLocalQuestionsWithLocalAuthRecord ERROR m->CurrentQuestion already set: %##s (%s)",
732 m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
733
734 m->CurrentQuestion = m->LocalOnlyQuestions;
735 while (m->CurrentQuestion && m->CurrentQuestion != m->NewLocalOnlyQuestions)
736 {
737 mDNSBool answered;
738 DNSQuestion *q = m->CurrentQuestion;
739 // We are called with both LocalOnly/P2P record or a regular AuthRecord
740 if (RRAny(rr))
741 answered = ResourceRecordAnswersQuestion(&rr->resrec, q);
742 else
743 answered = LocalOnlyRecordAnswersQuestion(rr, q);
744 if (answered)
745 AnswerLocalQuestionWithLocalAuthRecord(m, rr, AddRecord); // MUST NOT dereference q again
746 if (m->CurrentQuestion == q) // If m->CurrentQuestion was not auto-advanced, do it ourselves now
747 m->CurrentQuestion = q->next;
748 }
749
750 m->CurrentQuestion = mDNSNULL;
751
752 // If this AuthRecord is marked LocalOnly or P2P, then we want to deliver it to all local 'mDNSInterface_Any' questions
753 if (rr->ARType == AuthRecordLocalOnly || rr->ARType == AuthRecordP2P)
754 AnswerInterfaceAnyQuestionsWithLocalAuthRecord(m, rr, AddRecord);
755
756 }
757
758 // ***************************************************************************
759 #if COMPILER_LIKES_PRAGMA_MARK
760 #pragma mark -
761 #pragma mark - Resource Record Utility Functions
762 #endif
763
764 #define RRTypeIsAddressType(T) ((T) == kDNSType_A || (T) == kDNSType_AAAA)
765
766 #define ResourceRecordIsValidAnswer(RR) ( ((RR)->resrec.RecordType & kDNSRecordTypeActiveMask) && \
767 ((RR)->Additional1 == mDNSNULL || ((RR)->Additional1->resrec.RecordType & kDNSRecordTypeActiveMask)) && \
768 ((RR)->Additional2 == mDNSNULL || ((RR)->Additional2->resrec.RecordType & kDNSRecordTypeActiveMask)) && \
769 ((RR)->DependentOn == mDNSNULL || ((RR)->DependentOn->resrec.RecordType & kDNSRecordTypeActiveMask)) )
770
771 #define ResourceRecordIsValidInterfaceAnswer(RR, INTID) \
772 (ResourceRecordIsValidAnswer(RR) && \
773 ((RR)->resrec.InterfaceID == mDNSInterface_Any || (RR)->resrec.InterfaceID == (INTID)))
774
775 #define DefaultProbeCountForTypeUnique ((mDNSu8)3)
776 #define DefaultProbeCountForRecordType(X) ((X) == kDNSRecordTypeUnique ? DefaultProbeCountForTypeUnique : (mDNSu8)0)
777
778 // See RFC 6762: "8.3 Announcing"
779 // "The Multicast DNS responder MUST send at least two unsolicited responses, one second apart."
780 // Send 4, which is really 8 since we send on both IPv4 and IPv6.
781 #define InitialAnnounceCount ((mDNSu8)4)
782
783 // For goodbye packets we set the count to 3, and for wakeups we set it to 18
784 // (which will be up to 15 wakeup attempts over the course of 30 seconds,
785 // and then if the machine fails to wake, 3 goodbye packets).
786 #define GoodbyeCount ((mDNSu8)3)
787 #define WakeupCount ((mDNSu8)18)
788 #define MAX_PROBE_RESTARTS ((mDNSu8)20)
789 #define MAX_GHOST_TIME ((mDNSs32)((60*60*24*7)*mDNSPlatformOneSecond)) // One week
790
791 // Number of wakeups we send if WakeOnResolve is set in the question
792 #define InitialWakeOnResolveCount ((mDNSu8)3)
793
794 // Note that the announce intervals use exponential backoff, doubling each time. The probe intervals do not.
795 // This means that because the announce interval is doubled after sending the first packet, the first
796 // observed on-the-wire inter-packet interval between announcements is actually one second.
797 // The half-second value here may be thought of as a conceptual (non-existent) half-second delay *before* the first packet is sent.
798 #define DefaultProbeIntervalForTypeUnique (mDNSPlatformOneSecond/4)
799 #define DefaultAnnounceIntervalForTypeShared (mDNSPlatformOneSecond/2)
800 #define DefaultAnnounceIntervalForTypeUnique (mDNSPlatformOneSecond/2)
801
802 #define DefaultAPIntervalForRecordType(X) ((X) &kDNSRecordTypeActiveSharedMask ? DefaultAnnounceIntervalForTypeShared : \
803 (X) &kDNSRecordTypeUnique ? DefaultProbeIntervalForTypeUnique : \
804 (X) &kDNSRecordTypeActiveUniqueMask ? DefaultAnnounceIntervalForTypeUnique : 0)
805
806 #define TimeToAnnounceThisRecord(RR,time) ((RR)->AnnounceCount && (time) - ((RR)->LastAPTime + (RR)->ThisAPInterval) >= 0)
807 #define TicksTTL(RR) ((mDNSs32)(RR)->resrec.rroriginalttl * mDNSPlatformOneSecond)
808 #define RRExpireTime(RR) ((RR)->TimeRcvd + TicksTTL(RR))
809
810 // Adjustment factor to avoid race condition (used for unicast cache entries) :
811 // Suppose real record has TTL of 3600, and our local caching server has held it for 3500 seconds, so it returns an aged TTL of 100.
812 // If we do our normal refresh at 80% of the TTL, our local caching server will return 20 seconds, so we'll do another
813 // 80% refresh after 16 seconds, and then the server will return 4 seconds, and so on, in the fashion of Zeno's paradox.
814 // To avoid this, we extend the record's effective TTL to give it a little extra grace period.
815 // We adjust the 100 second TTL to 127. This means that when we do our 80% query at 102 seconds,
816 // the cached copy at our local caching server will already have expired, so the server will be forced
817 // to fetch a fresh copy from the authoritative server, and then return a fresh record with the full TTL of 3600 seconds.
818
819 #define RRAdjustTTL(ttl) ((ttl) + ((ttl)/4) + 2)
820 #define RRUnadjustedTTL(ttl) ((((ttl) - 2) * 4) / 5)
821
822 #define MaxUnansweredQueries 4
823
824 // SameResourceRecordSignature returns true if two resources records have the same name, type, and class, and may be sent
825 // (or were received) on the same interface (i.e. if *both* records specify an interface, then it has to match).
826 // TTL and rdata may differ.
827 // This is used for cache flush management:
828 // When sending a unique record, all other records matching "SameResourceRecordSignature" must also be sent
829 // When receiving a unique record, all old cache records matching "SameResourceRecordSignature" are flushed
830
831 // SameResourceRecordNameClassInterface is functionally the same as SameResourceRecordSignature, except rrtype does not have to match
832
833 #define SameResourceRecordSignature(A,B) (A)->resrec.rrtype == (B)->resrec.rrtype && SameResourceRecordNameClassInterface((A),(B))
834
835 mDNSlocal mDNSBool SameResourceRecordNameClassInterface(const AuthRecord *const r1, const AuthRecord *const r2)
836 {
837 if (!r1) { LogMsg("SameResourceRecordSignature ERROR: r1 is NULL"); return(mDNSfalse); }
838 if (!r2) { LogMsg("SameResourceRecordSignature ERROR: r2 is NULL"); return(mDNSfalse); }
839 if (r1->resrec.InterfaceID &&
840 r2->resrec.InterfaceID &&
841 r1->resrec.InterfaceID != r2->resrec.InterfaceID) return(mDNSfalse);
842 return (mDNSBool)(
843 r1->resrec.rrclass == r2->resrec.rrclass &&
844 r1->resrec.namehash == r2->resrec.namehash &&
845 SameDomainName(r1->resrec.name, r2->resrec.name));
846 }
847
848 // PacketRRMatchesSignature behaves as SameResourceRecordSignature, except that types may differ if our
849 // authoratative record is unique (as opposed to shared). For unique records, we are supposed to have
850 // complete ownership of *all* types for this name, so *any* record type with the same name is a conflict.
851 // In addition, when probing we send our questions with the wildcard type kDNSQType_ANY,
852 // so a response of any type should match, even if it is not actually the type the client plans to use.
853
854 // For now, to make it easier to avoid false conflicts, we treat SPS Proxy records like shared records,
855 // and require the rrtypes to match for the rdata to be considered potentially conflicting
856 mDNSlocal mDNSBool PacketRRMatchesSignature(const CacheRecord *const pktrr, const AuthRecord *const authrr)
857 {
858 if (!pktrr) { LogMsg("PacketRRMatchesSignature ERROR: pktrr is NULL"); return(mDNSfalse); }
859 if (!authrr) { LogMsg("PacketRRMatchesSignature ERROR: authrr is NULL"); return(mDNSfalse); }
860 if (pktrr->resrec.InterfaceID &&
861 authrr->resrec.InterfaceID &&
862 pktrr->resrec.InterfaceID != authrr->resrec.InterfaceID) return(mDNSfalse);
863 if (!(authrr->resrec.RecordType & kDNSRecordTypeUniqueMask) || authrr->WakeUp.HMAC.l[0])
864 if (pktrr->resrec.rrtype != authrr->resrec.rrtype) return(mDNSfalse);
865 if ((authrr->resrec.InterfaceID == mDNSInterface_Any) &&
866 !mDNSPlatformValidRecordForInterface(authrr, pktrr->resrec.InterfaceID)) return(mDNSfalse);
867 return (mDNSBool)(
868 pktrr->resrec.rrclass == authrr->resrec.rrclass &&
869 pktrr->resrec.namehash == authrr->resrec.namehash &&
870 SameDomainName(pktrr->resrec.name, authrr->resrec.name));
871 }
872
873 // CacheRecord *ka is the CacheRecord from the known answer list in the query.
874 // This is the information that the requester believes to be correct.
875 // AuthRecord *rr is the answer we are proposing to give, if not suppressed.
876 // This is the information that we believe to be correct.
877 // We've already determined that we plan to give this answer on this interface
878 // (either the record is non-specific, or it is specific to this interface)
879 // so now we just need to check the name, type, class, rdata and TTL.
880 mDNSlocal mDNSBool ShouldSuppressKnownAnswer(const CacheRecord *const ka, const AuthRecord *const rr)
881 {
882 // If RR signature is different, or data is different, then don't suppress our answer
883 if (!IdenticalResourceRecord(&ka->resrec, &rr->resrec)) return(mDNSfalse);
884
885 // If the requester's indicated TTL is less than half the real TTL,
886 // we need to give our answer before the requester's copy expires.
887 // If the requester's indicated TTL is at least half the real TTL,
888 // then we can suppress our answer this time.
889 // If the requester's indicated TTL is greater than the TTL we believe,
890 // then that's okay, and we don't need to do anything about it.
891 // (If two responders on the network are offering the same information,
892 // that's okay, and if they are offering the information with different TTLs,
893 // the one offering the lower TTL should defer to the one offering the higher TTL.)
894 return (mDNSBool)(ka->resrec.rroriginalttl >= rr->resrec.rroriginalttl / 2);
895 }
896
897 mDNSlocal void SetNextAnnounceProbeTime(mDNS *const m, const AuthRecord *const rr)
898 {
899 if (rr->resrec.RecordType == kDNSRecordTypeUnique)
900 {
901 if ((rr->LastAPTime + rr->ThisAPInterval) - m->timenow > mDNSPlatformOneSecond * 10)
902 {
903 LogMsg("SetNextAnnounceProbeTime: ProbeCount %d Next in %d %s", rr->ProbeCount, (rr->LastAPTime + rr->ThisAPInterval) - m->timenow, ARDisplayString(m, rr));
904 LogMsg("SetNextAnnounceProbeTime: m->SuppressProbes %d m->timenow %d diff %d", m->SuppressProbes, m->timenow, m->SuppressProbes - m->timenow);
905 }
906 if (m->NextScheduledProbe - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
907 m->NextScheduledProbe = (rr->LastAPTime + rr->ThisAPInterval);
908 // Some defensive code:
909 // If (rr->LastAPTime + rr->ThisAPInterval) happens to be far in the past, we don't want to allow
910 // NextScheduledProbe to be set excessively in the past, because that can cause bad things to happen.
911 // See: <rdar://problem/7795434> mDNS: Sometimes advertising stops working and record interval is set to zero
912 if (m->NextScheduledProbe - m->timenow < 0)
913 m->NextScheduledProbe = m->timenow;
914 }
915 else if (rr->AnnounceCount && (ResourceRecordIsValidAnswer(rr) || rr->resrec.RecordType == kDNSRecordTypeDeregistering))
916 {
917 if (m->NextScheduledResponse - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
918 m->NextScheduledResponse = (rr->LastAPTime + rr->ThisAPInterval);
919 }
920 }
921
922 mDNSlocal void InitializeLastAPTime(mDNS *const m, AuthRecord *const rr)
923 {
924 // For reverse-mapping Sleep Proxy PTR records, probe interval is one second
925 rr->ThisAPInterval = rr->AddressProxy.type ? mDNSPlatformOneSecond : DefaultAPIntervalForRecordType(rr->resrec.RecordType);
926
927 // * If this is a record type that's going to probe, then we use the m->SuppressProbes time.
928 // * Otherwise, if it's not going to probe, but m->SuppressProbes is set because we have other
929 // records that are going to probe, then we delay its first announcement so that it will
930 // go out synchronized with the first announcement for the other records that *are* probing.
931 // This is a minor performance tweak that helps keep groups of related records synchronized together.
932 // The addition of "interval / 2" is to make sure that, in the event that any of the probes are
933 // delayed by a few milliseconds, this announcement does not inadvertently go out *before* the probing is complete.
934 // When the probing is complete and those records begin to announce, these records will also be picked up and accelerated,
935 // because they will meet the criterion of being at least half-way to their scheduled announcement time.
936 // * If it's not going to probe and m->SuppressProbes is not already set then we should announce immediately.
937
938 if (rr->ProbeCount)
939 {
940 // If we have no probe suppression time set, or it is in the past, set it now
941 if (m->SuppressProbes == 0 || m->SuppressProbes - m->timenow < 0)
942 {
943 // To allow us to aggregate probes when a group of services are registered together,
944 // the first probe is delayed by a random delay in the range 1/8 to 1/4 second.
945 // This means the common-case behaviour is:
946 // randomized wait; probe
947 // 1/4 second wait; probe
948 // 1/4 second wait; probe
949 // 1/4 second wait; announce (i.e. service is normally announced 7/8 to 1 second after being registered)
950 m->SuppressProbes = NonZeroTime(m->timenow + DefaultProbeIntervalForTypeUnique/2 + mDNSRandom(DefaultProbeIntervalForTypeUnique/2));
951
952 // If we already have a *probe* scheduled to go out sooner, then use that time to get better aggregation
953 if (m->SuppressProbes - m->NextScheduledProbe >= 0)
954 m->SuppressProbes = NonZeroTime(m->NextScheduledProbe);
955 if (m->SuppressProbes - m->timenow < 0) // Make sure we don't set m->SuppressProbes excessively in the past
956 m->SuppressProbes = m->timenow;
957
958 // If we already have a *query* scheduled to go out sooner, then use that time to get better aggregation
959 if (m->SuppressProbes - m->NextScheduledQuery >= 0)
960 m->SuppressProbes = NonZeroTime(m->NextScheduledQuery);
961 if (m->SuppressProbes - m->timenow < 0) // Make sure we don't set m->SuppressProbes excessively in the past
962 m->SuppressProbes = m->timenow;
963
964 // except... don't expect to be able to send before the m->SuppressSending timer fires
965 if (m->SuppressSending && m->SuppressProbes - m->SuppressSending < 0)
966 m->SuppressProbes = NonZeroTime(m->SuppressSending);
967
968 if (m->SuppressProbes - m->timenow > mDNSPlatformOneSecond * 8)
969 {
970 LogMsg("InitializeLastAPTime ERROR m->SuppressProbes %d m->NextScheduledProbe %d m->NextScheduledQuery %d m->SuppressSending %d %d",
971 m->SuppressProbes - m->timenow,
972 m->NextScheduledProbe - m->timenow,
973 m->NextScheduledQuery - m->timenow,
974 m->SuppressSending,
975 m->SuppressSending - m->timenow);
976 m->SuppressProbes = NonZeroTime(m->timenow + DefaultProbeIntervalForTypeUnique/2 + mDNSRandom(DefaultProbeIntervalForTypeUnique/2));
977 }
978 }
979 rr->LastAPTime = m->SuppressProbes - rr->ThisAPInterval;
980 }
981 // Skip kDNSRecordTypeKnownUnique and kDNSRecordTypeShared records here and set their LastAPTime in the "else" block below so
982 // that they get announced immediately, otherwise, their announcement would be delayed until the based on the SuppressProbes value.
983 else if ((rr->resrec.RecordType != kDNSRecordTypeKnownUnique) && (rr->resrec.RecordType != kDNSRecordTypeShared) && m->SuppressProbes && (m->SuppressProbes - m->timenow >= 0))
984 rr->LastAPTime = m->SuppressProbes - rr->ThisAPInterval + DefaultProbeIntervalForTypeUnique * DefaultProbeCountForTypeUnique + rr->ThisAPInterval / 2;
985 else
986 rr->LastAPTime = m->timenow - rr->ThisAPInterval;
987
988 // For reverse-mapping Sleep Proxy PTR records we don't want to start probing instantly -- we
989 // wait one second to give the client a chance to go to sleep, and then start our ARP/NDP probing.
990 // After three probes one second apart with no answer, we conclude the client is now sleeping
991 // and we can begin broadcasting our announcements to take over ownership of that IP address.
992 // If we don't wait for the client to go to sleep, then when the client sees our ARP Announcements there's a risk
993 // (depending on the OS and networking stack it's using) that it might interpret it as a conflict and change its IP address.
994 if (rr->AddressProxy.type)
995 rr->LastAPTime = m->timenow;
996
997 // Set LastMCTime to now, to inhibit multicast responses
998 // (no need to send additional multicast responses when we're announcing anyway)
999 rr->LastMCTime = m->timenow;
1000 rr->LastMCInterface = mDNSInterfaceMark;
1001
1002 SetNextAnnounceProbeTime(m, rr);
1003 }
1004
1005 mDNSlocal const domainname *SetUnicastTargetToHostName(mDNS *const m, AuthRecord *rr)
1006 {
1007 const domainname *target;
1008 if (rr->AutoTarget)
1009 {
1010 // For autotunnel services pointing at our IPv6 ULA we don't need or want a NAT mapping, but for all other
1011 // advertised services referencing our uDNS hostname, we want NAT mappings automatically created as appropriate,
1012 // with the port number in our advertised SRV record automatically tracking the external mapped port.
1013 DomainAuthInfo *AuthInfo = GetAuthInfoForName_internal(m, rr->resrec.name);
1014 if (!AuthInfo || !AuthInfo->AutoTunnel) rr->AutoTarget = Target_AutoHostAndNATMAP;
1015 }
1016
1017 target = GetServiceTarget(m, rr);
1018 if (!target || target->c[0] == 0)
1019 {
1020 // defer registration until we've got a target
1021 LogInfo("SetUnicastTargetToHostName No target for %s", ARDisplayString(m, rr));
1022 rr->state = regState_NoTarget;
1023 return mDNSNULL;
1024 }
1025 else
1026 {
1027 LogInfo("SetUnicastTargetToHostName target %##s for resource record %s", target->c, ARDisplayString(m,rr));
1028 return target;
1029 }
1030 }
1031
1032 // Right now this only applies to mDNS (.local) services where the target host is always m->MulticastHostname
1033 // Eventually we should unify this with GetServiceTarget() in uDNS.c
1034 mDNSlocal void SetTargetToHostName(mDNS *const m, AuthRecord *const rr)
1035 {
1036 domainname *const target = GetRRDomainNameTarget(&rr->resrec);
1037 const domainname *newname = &m->MulticastHostname;
1038
1039 if (!target) LogInfo("SetTargetToHostName: Don't know how to set the target of rrtype %s", DNSTypeName(rr->resrec.rrtype));
1040
1041 if (!(rr->ForceMCast || rr->ARType == AuthRecordLocalOnly || rr->ARType == AuthRecordP2P || IsLocalDomain(&rr->namestorage)))
1042 {
1043 const domainname *const n = SetUnicastTargetToHostName(m, rr);
1044 if (n) newname = n;
1045 else { if (target) target->c[0] = 0; SetNewRData(&rr->resrec, mDNSNULL, 0); return; }
1046 }
1047
1048 if (target && SameDomainName(target, newname))
1049 debugf("SetTargetToHostName: Target of %##s is already %##s", rr->resrec.name->c, target->c);
1050
1051 if (target && !SameDomainName(target, newname))
1052 {
1053 AssignDomainName(target, newname);
1054 SetNewRData(&rr->resrec, mDNSNULL, 0); // Update rdlength, rdestimate, rdatahash
1055
1056 // If we're in the middle of probing this record, we need to start again,
1057 // because changing its rdata may change the outcome of the tie-breaker.
1058 // (If the record type is kDNSRecordTypeUnique (unconfirmed unique) then DefaultProbeCountForRecordType is non-zero.)
1059 rr->ProbeCount = DefaultProbeCountForRecordType(rr->resrec.RecordType);
1060
1061 // If we've announced this record, we really should send a goodbye packet for the old rdata before
1062 // changing to the new rdata. However, in practice, we only do SetTargetToHostName for unique records,
1063 // so when we announce them we'll set the kDNSClass_UniqueRRSet and clear any stale data that way.
1064 if (rr->RequireGoodbye && rr->resrec.RecordType == kDNSRecordTypeShared)
1065 debugf("Have announced shared record %##s (%s) at least once: should have sent a goodbye packet before updating",
1066 rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1067
1068 rr->AnnounceCount = InitialAnnounceCount;
1069 rr->RequireGoodbye = mDNSfalse;
1070 rr->ProbeRestartCount = 0;
1071 InitializeLastAPTime(m, rr);
1072 }
1073 }
1074
1075 mDNSlocal void AcknowledgeRecord(mDNS *const m, AuthRecord *const rr)
1076 {
1077 if (rr->RecordCallback)
1078 {
1079 // CAUTION: MUST NOT do anything more with rr after calling rr->Callback(), because the client's callback function
1080 // is allowed to do anything, including starting/stopping queries, registering/deregistering records, etc.
1081 rr->Acknowledged = mDNStrue;
1082 mDNS_DropLockBeforeCallback(); // Allow client to legally make mDNS API calls from the callback
1083 rr->RecordCallback(m, rr, mStatus_NoError);
1084 mDNS_ReclaimLockAfterCallback(); // Decrement mDNS_reentrancy to block mDNS API calls again
1085 }
1086 }
1087
1088 mDNSexport void ActivateUnicastRegistration(mDNS *const m, AuthRecord *const rr)
1089 {
1090 // Make sure that we don't activate the SRV record and associated service records, if it is in
1091 // NoTarget state. First time when a service is being instantiated, SRV record may be in NoTarget state.
1092 // We should not activate any of the other reords (PTR, TXT) that are part of the service. When
1093 // the target becomes available, the records will be reregistered.
1094 if (rr->resrec.rrtype != kDNSType_SRV)
1095 {
1096 AuthRecord *srvRR = mDNSNULL;
1097 if (rr->resrec.rrtype == kDNSType_PTR)
1098 srvRR = rr->Additional1;
1099 else if (rr->resrec.rrtype == kDNSType_TXT)
1100 srvRR = rr->DependentOn;
1101 if (srvRR)
1102 {
1103 if (srvRR->resrec.rrtype != kDNSType_SRV)
1104 {
1105 LogMsg("ActivateUnicastRegistration: ERROR!! Resource record %s wrong, expecting SRV type", ARDisplayString(m, srvRR));
1106 }
1107 else
1108 {
1109 LogInfo("ActivateUnicastRegistration: Found Service Record %s in state %d for %##s (%s)",
1110 ARDisplayString(m, srvRR), srvRR->state, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1111 rr->state = srvRR->state;
1112 }
1113 }
1114 }
1115
1116 if (rr->state == regState_NoTarget)
1117 {
1118 LogInfo("ActivateUnicastRegistration record %s in regState_NoTarget, not activating", ARDisplayString(m, rr));
1119 return;
1120 }
1121 // When we wake up from sleep, we call ActivateUnicastRegistration. It is possible that just before we went to sleep,
1122 // the service/record was being deregistered. In that case, we should not try to register again. For the cases where
1123 // the records are deregistered due to e.g., no target for the SRV record, we would have returned from above if it
1124 // was already in NoTarget state. If it was in the process of deregistration but did not complete fully before we went
1125 // to sleep, then it is okay to start in Pending state as we will go back to NoTarget state if we don't have a target.
1126 if (rr->resrec.RecordType == kDNSRecordTypeDeregistering)
1127 {
1128 LogInfo("ActivateUnicastRegistration: Resource record %s, current state %d, moving to DeregPending", ARDisplayString(m, rr), rr->state);
1129 rr->state = regState_DeregPending;
1130 }
1131 else
1132 {
1133 LogInfo("ActivateUnicastRegistration: Resource record %s, current state %d, moving to Pending", ARDisplayString(m, rr), rr->state);
1134 rr->state = regState_Pending;
1135 }
1136 rr->ProbeCount = 0;
1137 rr->ProbeRestartCount = 0;
1138 rr->AnnounceCount = 0;
1139 rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
1140 rr->LastAPTime = m->timenow - rr->ThisAPInterval;
1141 rr->expire = 0; // Forget about all the leases, start fresh
1142 rr->uselease = mDNStrue;
1143 rr->updateid = zeroID;
1144 rr->SRVChanged = mDNSfalse;
1145 rr->updateError = mStatus_NoError;
1146 // RestartRecordGetZoneData calls this function whenever a new interface gets registered with core.
1147 // The records might already be registered with the server and hence could have NAT state.
1148 if (rr->NATinfo.clientContext)
1149 {
1150 mDNS_StopNATOperation_internal(m, &rr->NATinfo);
1151 rr->NATinfo.clientContext = mDNSNULL;
1152 }
1153 if (rr->nta) { CancelGetZoneData(m, rr->nta); rr->nta = mDNSNULL; }
1154 if (rr->tcp) { DisposeTCPConn(rr->tcp); rr->tcp = mDNSNULL; }
1155 if (m->NextuDNSEvent - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
1156 m->NextuDNSEvent = (rr->LastAPTime + rr->ThisAPInterval);
1157 }
1158
1159 // Two records qualify to be local duplicates if:
1160 // (a) the RecordTypes are the same, or
1161 // (b) one is Unique and the other Verified
1162 // (c) either is in the process of deregistering
1163 #define RecordLDT(A,B) ((A)->resrec.RecordType == (B)->resrec.RecordType || \
1164 ((A)->resrec.RecordType | (B)->resrec.RecordType) == (kDNSRecordTypeUnique | kDNSRecordTypeVerified) || \
1165 ((A)->resrec.RecordType == kDNSRecordTypeDeregistering || (B)->resrec.RecordType == kDNSRecordTypeDeregistering))
1166
1167 #define RecordIsLocalDuplicate(A,B) \
1168 ((A)->resrec.InterfaceID == (B)->resrec.InterfaceID && RecordLDT((A),(B)) && IdenticalResourceRecord(& (A)->resrec, & (B)->resrec))
1169
1170 mDNSlocal AuthRecord *CheckAuthIdenticalRecord(AuthHash *r, AuthRecord *rr)
1171 {
1172 const AuthGroup *a;
1173 AuthRecord *rp;
1174
1175 a = AuthGroupForRecord(r, &rr->resrec);
1176 if (!a) return mDNSNULL;
1177 rp = a->members;
1178 while (rp)
1179 {
1180 if (!RecordIsLocalDuplicate(rp, rr))
1181 rp = rp->next;
1182 else
1183 {
1184 if (rp->resrec.RecordType == kDNSRecordTypeDeregistering)
1185 {
1186 rp->AnnounceCount = 0;
1187 rp = rp->next;
1188 }
1189 else return rp;
1190 }
1191 }
1192 return (mDNSNULL);
1193 }
1194
1195 mDNSlocal mDNSBool CheckAuthRecordConflict(AuthHash *r, AuthRecord *rr)
1196 {
1197 const AuthGroup *a;
1198 const AuthRecord *rp;
1199
1200 a = AuthGroupForRecord(r, &rr->resrec);
1201 if (!a) return mDNSfalse;
1202 rp = a->members;
1203 while (rp)
1204 {
1205 const AuthRecord *s1 = rr->RRSet ? rr->RRSet : rr;
1206 const AuthRecord *s2 = rp->RRSet ? rp->RRSet : rp;
1207 if (s1 != s2 && SameResourceRecordSignature(rp, rr) && !IdenticalSameNameRecord(&rp->resrec, &rr->resrec))
1208 return mDNStrue;
1209 else
1210 rp = rp->next;
1211 }
1212 return (mDNSfalse);
1213 }
1214
1215 // checks to see if "rr" is already present
1216 mDNSlocal AuthRecord *CheckAuthSameRecord(AuthHash *r, AuthRecord *rr)
1217 {
1218 const AuthGroup *a;
1219 AuthRecord *rp;
1220
1221 a = AuthGroupForRecord(r, &rr->resrec);
1222 if (!a) return mDNSNULL;
1223 rp = a->members;
1224 while (rp)
1225 {
1226 if (rp != rr)
1227 rp = rp->next;
1228 else
1229 {
1230 return rp;
1231 }
1232 }
1233 return (mDNSNULL);
1234 }
1235
1236
1237 mDNSlocal void DecrementAutoTargetServices(mDNS *const m, AuthRecord *const rr)
1238 {
1239 if (RRLocalOnly(rr))
1240 {
1241 // A sanity check, this should be prevented in calling code.
1242 LogInfo("DecrementAutoTargetServices: called for RRLocalOnly() record: %s", ARDisplayString(m, rr));
1243 return;
1244 }
1245
1246 if (!AuthRecord_uDNS(rr) && rr->resrec.rrtype == kDNSType_SRV && rr->AutoTarget == Target_AutoHost)
1247 {
1248 // If about to get rid of the last advertised service
1249 if (m->AutoTargetServices == 1)
1250 DeadvertiseAllInterfaceRecords(m);
1251
1252 m->AutoTargetServices--;
1253 LogInfo("DecrementAutoTargetServices: AutoTargetServices %d Record %s", m->AutoTargetServices, ARDisplayString(m, rr));
1254 }
1255
1256 #if BONJOUR_ON_DEMAND
1257 if (!AuthRecord_uDNS(rr))
1258 {
1259 if (m->NumAllInterfaceRecords + m->NumAllInterfaceQuestions == 1)
1260 m->NextBonjourDisableTime = NonZeroTime(m->timenow + (BONJOUR_DISABLE_DELAY * mDNSPlatformOneSecond));
1261 m->NumAllInterfaceRecords--;
1262 LogInfo("DecrementAutoTargetServices: NumAllInterfaceRecords %d NumAllInterfaceQuestions %d %s",
1263 m->NumAllInterfaceRecords, m->NumAllInterfaceQuestions, ARDisplayString(m, rr));
1264 }
1265 #endif // BONJOUR_ON_DEMAND
1266 }
1267
1268 mDNSlocal void IncrementAutoTargetServices(mDNS *const m, AuthRecord *const rr)
1269 {
1270 mDNSBool enablingBonjour = 0;
1271
1272 if (RRLocalOnly(rr))
1273 {
1274 // A sanity check, this should be prevented in calling code.
1275 LogInfo("IncrementAutoTargetServices: called for RRLocalOnly() record: %s", ARDisplayString(m, rr));
1276 return;
1277 }
1278
1279 #if BONJOUR_ON_DEMAND
1280 if (!AuthRecord_uDNS(rr))
1281 {
1282 m->NumAllInterfaceRecords++;
1283 LogInfo("IncrementAutoTargetServices: NumAllInterfaceRecords %d NumAllInterfaceQuestions %d %s",
1284 m->NumAllInterfaceRecords, m->NumAllInterfaceQuestions, ARDisplayString(m, rr));
1285 if (m->NumAllInterfaceRecords + m->NumAllInterfaceQuestions == 1)
1286 {
1287 m->NextBonjourDisableTime = 0;
1288 if (m->BonjourEnabled == 0)
1289 {
1290 // Enable Bonjour immediately by scheduling network changed processing where
1291 // we will join the multicast group on each active interface.
1292 m->BonjourEnabled = 1;
1293 enablingBonjour = 1;
1294 m->NetworkChanged = m->timenow;
1295 }
1296 }
1297 }
1298 #endif // BONJOUR_ON_DEMAND
1299
1300 if (!AuthRecord_uDNS(rr) && rr->resrec.rrtype == kDNSType_SRV && rr->AutoTarget == Target_AutoHost)
1301 {
1302 m->AutoTargetServices++;
1303 LogInfo("IncrementAutoTargetServices: AutoTargetServices %d Record %s", m->AutoTargetServices, ARDisplayString(m, rr));
1304
1305 // If this is the first advertised service and we did not just enable Bonjour above, then
1306 // advertise all the interface records. If we did enable Bonjour above, the interface records will
1307 // be advertised during the network changed processing scheduled above, so no need
1308 // to do it here.
1309 if ((m->AutoTargetServices == 1) && (enablingBonjour == 0))
1310 AdvertiseAllInterfaceRecords(m);
1311 }
1312 }
1313
1314 mDNSlocal void getKeepaliveRaddr(mDNS *const m, AuthRecord *rr, mDNSAddr *raddr)
1315 {
1316 mDNSAddr laddr = zeroAddr;
1317 mDNSEthAddr eth = zeroEthAddr;
1318 mDNSIPPort lport = zeroIPPort;
1319 mDNSIPPort rport = zeroIPPort;
1320 mDNSu32 timeout = 0;
1321 mDNSu32 seq = 0;
1322 mDNSu32 ack = 0;
1323 mDNSu16 win = 0;
1324
1325 if (mDNS_KeepaliveRecord(&rr->resrec))
1326 {
1327 mDNS_ExtractKeepaliveInfo(rr, &timeout, &laddr, raddr, &eth, &seq, &ack, &lport, &rport, &win);
1328 if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(raddr) || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport))
1329 {
1330 LogMsg("getKeepaliveRaddr: not a valid record %s for keepalive %#a:%d %#a:%d", ARDisplayString(m, rr), &laddr, lport.NotAnInteger, raddr, rport.NotAnInteger);
1331 return;
1332 }
1333 }
1334 }
1335
1336 // Exported so uDNS.c can call this
1337 mDNSexport mStatus mDNS_Register_internal(mDNS *const m, AuthRecord *const rr)
1338 {
1339 domainname *target = GetRRDomainNameTarget(&rr->resrec);
1340 AuthRecord *r;
1341 AuthRecord **p = &m->ResourceRecords;
1342 AuthRecord **d = &m->DuplicateRecords;
1343
1344 if ((mDNSs32)rr->resrec.rroriginalttl <= 0)
1345 { LogMsg("mDNS_Register_internal: TTL %X should be 1 - 0x7FFFFFFF %s", rr->resrec.rroriginalttl, ARDisplayString(m, rr)); return(mStatus_BadParamErr); }
1346
1347 if (!rr->resrec.RecordType)
1348 { LogMsg("mDNS_Register_internal: RecordType must be non-zero %s", ARDisplayString(m, rr)); return(mStatus_BadParamErr); }
1349
1350 if (m->ShutdownTime)
1351 { LogMsg("mDNS_Register_internal: Shutting down, can't register %s", ARDisplayString(m, rr)); return(mStatus_ServiceNotRunning); }
1352
1353 if (m->DivertMulticastAdvertisements && !AuthRecord_uDNS(rr))
1354 {
1355 mDNSInterfaceID previousID = rr->resrec.InterfaceID;
1356 if (rr->resrec.InterfaceID == mDNSInterface_Any || rr->resrec.InterfaceID == mDNSInterface_P2P)
1357 {
1358 rr->resrec.InterfaceID = mDNSInterface_LocalOnly;
1359 rr->ARType = AuthRecordLocalOnly;
1360 }
1361 if (rr->resrec.InterfaceID != mDNSInterface_LocalOnly)
1362 {
1363 NetworkInterfaceInfo *intf = FirstInterfaceForID(m, rr->resrec.InterfaceID);
1364 if (intf && !intf->Advertise) { rr->resrec.InterfaceID = mDNSInterface_LocalOnly; rr->ARType = AuthRecordLocalOnly; }
1365 }
1366 if (rr->resrec.InterfaceID != previousID)
1367 LogInfo("mDNS_Register_internal: Diverting record to local-only %s", ARDisplayString(m, rr));
1368 }
1369
1370 if (RRLocalOnly(rr))
1371 {
1372 if (CheckAuthSameRecord(&m->rrauth, rr))
1373 {
1374 LogMsg("mDNS_Register_internal: ERROR!! Tried to register LocalOnly AuthRecord %p %##s (%s) that's already in the list",
1375 rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1376 return(mStatus_AlreadyRegistered);
1377 }
1378 }
1379 else
1380 {
1381 while (*p && *p != rr) p=&(*p)->next;
1382 if (*p)
1383 {
1384 LogMsg("mDNS_Register_internal: ERROR!! Tried to register AuthRecord %p %##s (%s) that's already in the list",
1385 rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1386 return(mStatus_AlreadyRegistered);
1387 }
1388 }
1389
1390 while (*d && *d != rr) d=&(*d)->next;
1391 if (*d)
1392 {
1393 LogMsg("mDNS_Register_internal: ERROR!! Tried to register AuthRecord %p %##s (%s) that's already in the Duplicate list",
1394 rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1395 return(mStatus_AlreadyRegistered);
1396 }
1397
1398 if (rr->DependentOn)
1399 {
1400 if (rr->resrec.RecordType == kDNSRecordTypeUnique)
1401 rr->resrec.RecordType = kDNSRecordTypeVerified;
1402 else if (rr->resrec.RecordType != kDNSRecordTypeKnownUnique)
1403 {
1404 LogMsg("mDNS_Register_internal: ERROR! %##s (%s): rr->DependentOn && RecordType != kDNSRecordTypeUnique or kDNSRecordTypeKnownUnique",
1405 rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1406 return(mStatus_Invalid);
1407 }
1408 if (!(rr->DependentOn->resrec.RecordType & (kDNSRecordTypeUnique | kDNSRecordTypeVerified | kDNSRecordTypeKnownUnique)))
1409 {
1410 LogMsg("mDNS_Register_internal: ERROR! %##s (%s): rr->DependentOn->RecordType bad type %X",
1411 rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), rr->DependentOn->resrec.RecordType);
1412 return(mStatus_Invalid);
1413 }
1414 }
1415
1416 rr->next = mDNSNULL;
1417
1418 // Field Group 1: The actual information pertaining to this resource record
1419 // Set up by client prior to call
1420
1421 // Field Group 2: Persistent metadata for Authoritative Records
1422 // rr->Additional1 = set to mDNSNULL in mDNS_SetupResourceRecord; may be overridden by client
1423 // rr->Additional2 = set to mDNSNULL in mDNS_SetupResourceRecord; may be overridden by client
1424 // rr->DependentOn = set to mDNSNULL in mDNS_SetupResourceRecord; may be overridden by client
1425 // rr->RRSet = set to mDNSNULL in mDNS_SetupResourceRecord; may be overridden by client
1426 // rr->Callback = already set in mDNS_SetupResourceRecord
1427 // rr->Context = already set in mDNS_SetupResourceRecord
1428 // rr->RecordType = already set in mDNS_SetupResourceRecord
1429 // rr->HostTarget = set to mDNSfalse in mDNS_SetupResourceRecord; may be overridden by client
1430 // rr->AllowRemoteQuery = set to mDNSfalse in mDNS_SetupResourceRecord; may be overridden by client
1431 // Make sure target is not uninitialized data, or we may crash writing debugging log messages
1432 if (rr->AutoTarget && target) target->c[0] = 0;
1433
1434 // Field Group 3: Transient state for Authoritative Records
1435 rr->Acknowledged = mDNSfalse;
1436 rr->ProbeCount = DefaultProbeCountForRecordType(rr->resrec.RecordType);
1437 rr->ProbeRestartCount = 0;
1438 rr->AnnounceCount = InitialAnnounceCount;
1439 rr->RequireGoodbye = mDNSfalse;
1440 rr->AnsweredLocalQ = mDNSfalse;
1441 rr->IncludeInProbe = mDNSfalse;
1442 rr->ImmedUnicast = mDNSfalse;
1443 rr->SendNSECNow = mDNSNULL;
1444 rr->ImmedAnswer = mDNSNULL;
1445 rr->ImmedAdditional = mDNSNULL;
1446 rr->SendRNow = mDNSNULL;
1447 rr->v4Requester = zerov4Addr;
1448 rr->v6Requester = zerov6Addr;
1449 rr->NextResponse = mDNSNULL;
1450 rr->NR_AnswerTo = mDNSNULL;
1451 rr->NR_AdditionalTo = mDNSNULL;
1452 if (!rr->AutoTarget) InitializeLastAPTime(m, rr);
1453 // rr->LastAPTime = Set for us in InitializeLastAPTime()
1454 // rr->LastMCTime = Set for us in InitializeLastAPTime()
1455 // rr->LastMCInterface = Set for us in InitializeLastAPTime()
1456 rr->NewRData = mDNSNULL;
1457 rr->newrdlength = 0;
1458 rr->UpdateCallback = mDNSNULL;
1459 rr->UpdateCredits = kMaxUpdateCredits;
1460 rr->NextUpdateCredit = 0;
1461 rr->UpdateBlocked = 0;
1462
1463 // For records we're holding as proxy (except reverse-mapping PTR records) two announcements is sufficient
1464 if (rr->WakeUp.HMAC.l[0] && !rr->AddressProxy.type) rr->AnnounceCount = 2;
1465
1466 // Field Group 4: Transient uDNS state for Authoritative Records
1467 rr->state = regState_Zero;
1468 rr->uselease = 0;
1469 rr->expire = 0;
1470 rr->Private = 0;
1471 rr->updateid = zeroID;
1472 rr->updateIntID = zeroOpaque64;
1473 rr->zone = rr->resrec.name;
1474 rr->nta = mDNSNULL;
1475 rr->tcp = mDNSNULL;
1476 rr->OrigRData = 0;
1477 rr->OrigRDLen = 0;
1478 rr->InFlightRData = 0;
1479 rr->InFlightRDLen = 0;
1480 rr->QueuedRData = 0;
1481 rr->QueuedRDLen = 0;
1482 //mDNSPlatformMemZero(&rr->NATinfo, sizeof(rr->NATinfo));
1483 // We should be recording the actual internal port for this service record here. Once we initiate our NAT mapping
1484 // request we'll subsequently overwrite srv.port with the allocated external NAT port -- potentially multiple
1485 // times with different values if the external NAT port changes during the lifetime of the service registration.
1486 //if (rr->resrec.rrtype == kDNSType_SRV) rr->NATinfo.IntPort = rr->resrec.rdata->u.srv.port;
1487
1488 // rr->resrec.interface = already set in mDNS_SetupResourceRecord
1489 // rr->resrec.name->c = MUST be set by client
1490 // rr->resrec.rrtype = already set in mDNS_SetupResourceRecord
1491 // rr->resrec.rrclass = already set in mDNS_SetupResourceRecord
1492 // rr->resrec.rroriginalttl = already set in mDNS_SetupResourceRecord
1493 // rr->resrec.rdata = MUST be set by client, unless record type is CNAME or PTR and rr->HostTarget is set
1494
1495 // BIND named (name daemon) doesn't allow TXT records with zero-length rdata. This is strictly speaking correct,
1496 // since RFC 1035 specifies a TXT record as "One or more <character-string>s", not "Zero or more <character-string>s".
1497 // Since some legacy apps try to create zero-length TXT records, we'll silently correct it here.
1498 if (rr->resrec.rrtype == kDNSType_TXT && rr->resrec.rdlength == 0) { rr->resrec.rdlength = 1; rr->resrec.rdata->u.txt.c[0] = 0; }
1499
1500 if (rr->AutoTarget)
1501 {
1502 SetTargetToHostName(m, rr); // Also sets rdlength and rdestimate for us, and calls InitializeLastAPTime();
1503 #ifndef UNICAST_DISABLED
1504 // If we have no target record yet, SetTargetToHostName will set rr->state == regState_NoTarget
1505 // In this case we leave the record half-formed in the list, and later we'll remove it from the list and re-add it properly.
1506 if (rr->state == regState_NoTarget)
1507 {
1508 // Initialize the target so that we don't crash while logging etc.
1509 domainname *tar = GetRRDomainNameTarget(&rr->resrec);
1510 if (tar) tar->c[0] = 0;
1511 LogInfo("mDNS_Register_internal: record %s in NoTarget state", ARDisplayString(m, rr));
1512 }
1513 #endif
1514 }
1515 else
1516 {
1517 rr->resrec.rdlength = GetRDLength(&rr->resrec, mDNSfalse);
1518 rr->resrec.rdestimate = GetRDLength(&rr->resrec, mDNStrue);
1519 }
1520
1521 if (!ValidateDomainName(rr->resrec.name))
1522 { LogMsg("Attempt to register record with invalid name: %s", ARDisplayString(m, rr)); return(mStatus_Invalid); }
1523
1524 // Don't do this until *after* we've set rr->resrec.rdlength
1525 if (!ValidateRData(rr->resrec.rrtype, rr->resrec.rdlength, rr->resrec.rdata))
1526 { LogMsg("Attempt to register record with invalid rdata: %s", ARDisplayString(m, rr)); return(mStatus_Invalid); }
1527
1528 rr->resrec.namehash = DomainNameHashValue(rr->resrec.name);
1529 rr->resrec.rdatahash = target ? DomainNameHashValue(target) : RDataHashValue(&rr->resrec);
1530
1531 if (RRLocalOnly(rr))
1532 {
1533 // If this is supposed to be unique, make sure we don't have any name conflicts.
1534 // If we found a conflict, we may still want to insert the record in the list but mark it appropriately
1535 // (kDNSRecordTypeDeregistering) so that we deliver RMV events to the application. But this causes more
1536 // complications and not clear whether there are any benefits. See rdar:9304275 for details.
1537 // Hence, just bail out.
1538 // This comment is doesn’t make any sense. -- SC
1539 if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
1540 {
1541 if (CheckAuthRecordConflict(&m->rrauth, rr))
1542 {
1543 LogInfo("mDNS_Register_internal: Name conflict %s (%p), InterfaceID %p", ARDisplayString(m, rr), rr, rr->resrec.InterfaceID);
1544 return mStatus_NameConflict;
1545 }
1546 }
1547 }
1548
1549 // For uDNS records, we don't support duplicate checks at this time.
1550 #ifndef UNICAST_DISABLED
1551 if (AuthRecord_uDNS(rr))
1552 {
1553 if (!m->NewLocalRecords) m->NewLocalRecords = rr;
1554 // When we called SetTargetToHostName, it may have caused mDNS_Register_internal to be re-entered, appending new
1555 // records to the list, so we now need to update p to advance to the new end to the list before appending our new record.
1556 // Note that for AutoTunnel this should never happen, but this check makes the code future-proof.
1557 while (*p) p=&(*p)->next;
1558 *p = rr;
1559 if (rr->resrec.RecordType == kDNSRecordTypeUnique) rr->resrec.RecordType = kDNSRecordTypeVerified;
1560 rr->ProbeCount = 0;
1561 rr->ProbeRestartCount = 0;
1562 rr->AnnounceCount = 0;
1563 if (rr->state != regState_NoTarget) ActivateUnicastRegistration(m, rr);
1564 return(mStatus_NoError); // <--- Note: For unicast records, code currently bails out at this point
1565 }
1566 #endif
1567
1568 // Now that we've finished building our new record, make sure it's not identical to one we already have
1569 if (RRLocalOnly(rr))
1570 {
1571 rr->ProbeCount = 0;
1572 rr->ProbeRestartCount = 0;
1573 rr->AnnounceCount = 0;
1574 r = CheckAuthIdenticalRecord(&m->rrauth, rr);
1575 }
1576 else
1577 {
1578 for (r = m->ResourceRecords; r; r=r->next)
1579 if (RecordIsLocalDuplicate(r, rr))
1580 {
1581 if (r->resrec.RecordType == kDNSRecordTypeDeregistering) r->AnnounceCount = 0;
1582 else break;
1583 }
1584 }
1585
1586 if (r)
1587 {
1588 LogInfo("mDNS_Register_internal: Adding to duplicate list %s", ARDisplayString(m,rr));
1589 *d = rr;
1590 // If the previous copy of this record is already verified unique,
1591 // then indicate that we should move this record promptly to kDNSRecordTypeUnique state.
1592 // Setting ProbeCount to zero will cause SendQueries() to advance this record to
1593 // kDNSRecordTypeVerified state and call the client callback at the next appropriate time.
1594 if (rr->resrec.RecordType == kDNSRecordTypeUnique && r->resrec.RecordType == kDNSRecordTypeVerified)
1595 rr->ProbeCount = 0;
1596 }
1597 else
1598 {
1599 LogInfo("mDNS_Register_internal: Adding to active record list %s", ARDisplayString(m,rr));
1600 if (RRLocalOnly(rr))
1601 {
1602 AuthGroup *ag;
1603 ag = InsertAuthRecord(m, &m->rrauth, rr);
1604 if (ag && !ag->NewLocalOnlyRecords)
1605 {
1606 m->NewLocalOnlyRecords = mDNStrue;
1607 ag->NewLocalOnlyRecords = rr;
1608 }
1609 // No probing for LocalOnly records; acknowledge them right away
1610 if (rr->resrec.RecordType == kDNSRecordTypeUnique) rr->resrec.RecordType = kDNSRecordTypeVerified;
1611 AcknowledgeRecord(m, rr);
1612 return(mStatus_NoError);
1613 }
1614 else
1615 {
1616 if (!m->NewLocalRecords) m->NewLocalRecords = rr;
1617 *p = rr;
1618 }
1619 }
1620
1621 if (!AuthRecord_uDNS(rr)) // This check is superfluous, given that for unicast records we (currently) bail out above
1622 {
1623 // We have inserted the record in the list. See if we have to advertise the A/AAAA, HINFO, PTR records.
1624 IncrementAutoTargetServices(m, rr);
1625
1626 // For records that are not going to probe, acknowledge them right away
1627 if (rr->resrec.RecordType != kDNSRecordTypeUnique && rr->resrec.RecordType != kDNSRecordTypeDeregistering)
1628 AcknowledgeRecord(m, rr);
1629
1630 // Adding a record may affect whether or not we should sleep
1631 mDNS_UpdateAllowSleep(m);
1632 }
1633
1634 // If this is a non-sleep proxy keepalive record, fetch the MAC address of the remote host.
1635 // This is used by the in-NIC proxy to send the keepalive packets.
1636 if (!rr->WakeUp.HMAC.l[0] && mDNS_KeepaliveRecord(&rr->resrec))
1637 {
1638 mDNSAddr raddr;
1639 // Set the record type to known unique to prevent probing keep alive records.
1640 // Also make sure we do not announce the keepalive records.
1641 rr->resrec.RecordType = kDNSRecordTypeKnownUnique;
1642 rr->AnnounceCount = 0;
1643 getKeepaliveRaddr(m, rr, &raddr);
1644 // This is an asynchronous call. Once the remote MAC address is available, helper will schedule an
1645 // asynchronous task to update the resource record
1646 mDNSPlatformGetRemoteMacAddr(&raddr);
1647 }
1648
1649 return(mStatus_NoError);
1650 }
1651
1652 mDNSlocal void RecordProbeFailure(mDNS *const m, const AuthRecord *const rr)
1653 {
1654 m->ProbeFailTime = m->timenow;
1655 m->NumFailedProbes++;
1656 // If we've had fifteen or more probe failures, rate-limit to one every five seconds.
1657 // If a bunch of hosts have all been configured with the same name, then they'll all
1658 // conflict and run through the same series of names: name-2, name-3, name-4, etc.,
1659 // up to name-10. After that they'll start adding random increments in the range 1-100,
1660 // so they're more likely to branch out in the available namespace and settle on a set of
1661 // unique names quickly. If after five more tries the host is still conflicting, then we
1662 // may have a serious problem, so we start rate-limiting so we don't melt down the network.
1663 if (m->NumFailedProbes >= 15)
1664 {
1665 m->SuppressProbes = NonZeroTime(m->timenow + mDNSPlatformOneSecond * 5);
1666 LogMsg("Excessive name conflicts (%lu) for %##s (%s); rate limiting in effect",
1667 m->NumFailedProbes, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1668 }
1669 }
1670
1671 mDNSlocal void CompleteRDataUpdate(mDNS *const m, AuthRecord *const rr)
1672 {
1673 RData *OldRData = rr->resrec.rdata;
1674 mDNSu16 OldRDLen = rr->resrec.rdlength;
1675 SetNewRData(&rr->resrec, rr->NewRData, rr->newrdlength); // Update our rdata
1676 rr->NewRData = mDNSNULL; // Clear the NewRData pointer ...
1677 if (rr->UpdateCallback)
1678 rr->UpdateCallback(m, rr, OldRData, OldRDLen); // ... and let the client know
1679 }
1680
1681 // Note: mDNS_Deregister_internal can call a user callback, which may change the record list and/or question list.
1682 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
1683 // Exported so uDNS.c can call this
1684 mDNSexport mStatus mDNS_Deregister_internal(mDNS *const m, AuthRecord *const rr, mDNS_Dereg_type drt)
1685 {
1686 AuthRecord *r2;
1687 mDNSu8 RecordType = rr->resrec.RecordType;
1688 AuthRecord **p = &m->ResourceRecords; // Find this record in our list of active records
1689 mDNSBool dupList = mDNSfalse;
1690
1691 if (RRLocalOnly(rr))
1692 {
1693 AuthGroup *a;
1694 AuthRecord **rp;
1695
1696 a = AuthGroupForRecord(&m->rrauth, &rr->resrec);
1697 if (!a) return mDNSfalse;
1698 rp = &a->members;
1699 while (*rp && *rp != rr) rp=&(*rp)->next;
1700 p = rp;
1701 }
1702 else
1703 {
1704 while (*p && *p != rr) p=&(*p)->next;
1705 }
1706
1707 if (*p)
1708 {
1709 // We found our record on the main list. See if there are any duplicates that need special handling.
1710 if (drt == mDNS_Dereg_conflict) // If this was a conflict, see that all duplicates get the same treatment
1711 {
1712 // Scan for duplicates of rr, and mark them for deregistration at the end of this routine, after we've finished
1713 // deregistering rr. We need to do this scan *before* we give the client the chance to free and reuse the rr memory.
1714 for (r2 = m->DuplicateRecords; r2; r2=r2->next) if (RecordIsLocalDuplicate(r2, rr)) r2->ProbeCount = 0xFF;
1715 }
1716 else
1717 {
1718 // Before we delete the record (and potentially send a goodbye packet)
1719 // first see if we have a record on the duplicate list ready to take over from it.
1720 AuthRecord **d = &m->DuplicateRecords;
1721 while (*d && !RecordIsLocalDuplicate(*d, rr)) d=&(*d)->next;
1722 if (*d)
1723 {
1724 AuthRecord *dup = *d;
1725 debugf("mDNS_Register_internal: Duplicate record %p taking over from %p %##s (%s)",
1726 dup, rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1727 *d = dup->next; // Cut replacement record from DuplicateRecords list
1728 if (RRLocalOnly(rr))
1729 {
1730 dup->next = mDNSNULL;
1731 if (!InsertAuthRecord(m, &m->rrauth, dup)) LogMsg("mDNS_Deregister_internal: ERROR!! cannot insert %s", ARDisplayString(m, dup));
1732 }
1733 else
1734 {
1735 dup->next = rr->next; // And then...
1736 rr->next = dup; // ... splice it in right after the record we're about to delete
1737 }
1738 dup->resrec.RecordType = rr->resrec.RecordType;
1739 dup->ProbeCount = rr->ProbeCount;
1740 dup->ProbeRestartCount = rr->ProbeRestartCount;
1741 dup->AnnounceCount = rr->AnnounceCount;
1742 dup->RequireGoodbye = rr->RequireGoodbye;
1743 dup->AnsweredLocalQ = rr->AnsweredLocalQ;
1744 dup->ImmedAnswer = rr->ImmedAnswer;
1745 dup->ImmedUnicast = rr->ImmedUnicast;
1746 dup->ImmedAdditional = rr->ImmedAdditional;
1747 dup->v4Requester = rr->v4Requester;
1748 dup->v6Requester = rr->v6Requester;
1749 dup->ThisAPInterval = rr->ThisAPInterval;
1750 dup->LastAPTime = rr->LastAPTime;
1751 dup->LastMCTime = rr->LastMCTime;
1752 dup->LastMCInterface = rr->LastMCInterface;
1753 dup->Private = rr->Private;
1754 dup->state = rr->state;
1755 rr->RequireGoodbye = mDNSfalse;
1756 rr->AnsweredLocalQ = mDNSfalse;
1757 }
1758 }
1759 }
1760 else
1761 {
1762 // We didn't find our record on the main list; try the DuplicateRecords list instead.
1763 p = &m->DuplicateRecords;
1764 while (*p && *p != rr) p=&(*p)->next;
1765 // If we found our record on the duplicate list, then make sure we don't send a goodbye for it
1766 if (*p)
1767 {
1768 // Duplicate records are not used for sending wakeups or goodbyes. Hence, deregister them
1769 // immediately. When there is a conflict, we deregister all the conflicting duplicate records
1770 // also that have been marked above in this function. In that case, we come here and if we don't
1771 // deregister (unilink from the DuplicateRecords list), we will be recursing infinitely. Hence,
1772 // clear the HMAC which will cause it to deregister. See <rdar://problem/10380988> for
1773 // details.
1774 rr->WakeUp.HMAC = zeroEthAddr;
1775 rr->RequireGoodbye = mDNSfalse;
1776 rr->resrec.RecordType = kDNSRecordTypeDeregistering;
1777 dupList = mDNStrue;
1778 }
1779 if (*p) debugf("mDNS_Deregister_internal: Deleting DuplicateRecord %p %##s (%s)",
1780 rr, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1781 }
1782
1783 if (!*p)
1784 {
1785 // No need to log an error message if we already know this is a potentially repeated deregistration
1786 if (drt != mDNS_Dereg_repeat)
1787 LogMsg("mDNS_Deregister_internal: Record %p not found in list %s", rr, ARDisplayString(m,rr));
1788 return(mStatus_BadReferenceErr);
1789 }
1790
1791 // If this is a shared record and we've announced it at least once,
1792 // we need to retract that announcement before we delete the record
1793
1794 // If this is a record (including mDNSInterface_LocalOnly records) for which we've given local-only answers then
1795 // it's tempting to just do "AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNSfalse)" here, but that would not not be safe.
1796 // The AnswerAllLocalQuestionsWithLocalAuthRecord routine walks the question list invoking client callbacks, using the "m->CurrentQuestion"
1797 // mechanism to cope with the client callback modifying the question list while that's happening.
1798 // However, mDNS_Deregister could have been called from a client callback (e.g. from the domain enumeration callback FoundDomain)
1799 // which means that the "m->CurrentQuestion" mechanism is already in use to protect that list, so we can't use it twice.
1800 // More generally, if we invoke callbacks from within a client callback, then those callbacks could deregister other
1801 // records, thereby invoking yet more callbacks, without limit.
1802 // The solution is to defer delivering the "Remove" events until mDNS_Execute time, just like we do for sending
1803 // actual goodbye packets.
1804
1805 #ifndef UNICAST_DISABLED
1806 if (AuthRecord_uDNS(rr))
1807 {
1808 if (rr->RequireGoodbye)
1809 {
1810 if (rr->tcp) { DisposeTCPConn(rr->tcp); rr->tcp = mDNSNULL; }
1811 rr->resrec.RecordType = kDNSRecordTypeDeregistering;
1812 m->LocalRemoveEvents = mDNStrue;
1813 uDNS_DeregisterRecord(m, rr);
1814 // At this point unconditionally we bail out
1815 // Either uDNS_DeregisterRecord will have completed synchronously, and called CompleteDeregistration,
1816 // which calls us back here with RequireGoodbye set to false, or it will have initiated the deregistration
1817 // process and will complete asynchronously. Either way we don't need to do anything more here.
1818 return(mStatus_NoError);
1819 }
1820 // Sometimes the records don't complete proper deregistration i.e., don't wait for a response
1821 // from the server. In that case, if the records have been part of a group update, clear the
1822 // state here. Some recors e.g., AutoTunnel gets reused without ever being completely initialized
1823 rr->updateid = zeroID;
1824
1825 // We defer cleaning up NAT state only after sending goodbyes. This is important because
1826 // RecordRegistrationGotZoneData guards against creating NAT state if clientContext is non-NULL.
1827 // This happens today when we turn on/off interface where we get multiple network transitions
1828 // and RestartRecordGetZoneData triggers re-registration of the resource records even though
1829 // they may be in Registered state which causes NAT information to be setup multiple times. Defering
1830 // the cleanup here keeps clientContext non-NULL and hence prevents that. Note that cleaning up
1831 // NAT state here takes care of the case where we did not send goodbyes at all.
1832 if (rr->NATinfo.clientContext)
1833 {
1834 mDNS_StopNATOperation_internal(m, &rr->NATinfo);
1835 rr->NATinfo.clientContext = mDNSNULL;
1836 }
1837 if (rr->nta) { CancelGetZoneData(m, rr->nta); rr->nta = mDNSNULL; }
1838 if (rr->tcp) { DisposeTCPConn(rr->tcp); rr->tcp = mDNSNULL; }
1839 }
1840 #endif // UNICAST_DISABLED
1841
1842 if (RecordType == kDNSRecordTypeUnregistered)
1843 LogMsg("mDNS_Deregister_internal: %s already marked kDNSRecordTypeUnregistered", ARDisplayString(m, rr));
1844 else if (RecordType == kDNSRecordTypeDeregistering)
1845 {
1846 LogMsg("mDNS_Deregister_internal: %s already marked kDNSRecordTypeDeregistering", ARDisplayString(m, rr));
1847 return(mStatus_BadReferenceErr);
1848 }
1849
1850 // <rdar://problem/7457925> Local-only questions don't get remove events for unique records
1851 // We may want to consider changing this code so that we generate local-only question "rmv"
1852 // events (and maybe goodbye packets too) for unique records as well as for shared records
1853 // Note: If we change the logic for this "if" statement, need to ensure that the code in
1854 // CompleteDeregistration() sets the appropriate state variables to gaurantee that "else"
1855 // clause will execute here and the record will be cut from the list.
1856 if (rr->WakeUp.HMAC.l[0] ||
1857 (RecordType == kDNSRecordTypeShared && (rr->RequireGoodbye || rr->AnsweredLocalQ)))
1858 {
1859 verbosedebugf("mDNS_Deregister_internal: Starting deregistration for %s", ARDisplayString(m, rr));
1860 rr->resrec.RecordType = kDNSRecordTypeDeregistering;
1861 rr->resrec.rroriginalttl = 0;
1862 rr->AnnounceCount = rr->WakeUp.HMAC.l[0] ? WakeupCount : (drt == mDNS_Dereg_rapid) ? 1 : GoodbyeCount;
1863 rr->ThisAPInterval = mDNSPlatformOneSecond * 2;
1864 rr->LastAPTime = m->timenow - rr->ThisAPInterval;
1865 m->LocalRemoveEvents = mDNStrue;
1866 if (m->NextScheduledResponse - (m->timenow + mDNSPlatformOneSecond/10) >= 0)
1867 m->NextScheduledResponse = (m->timenow + mDNSPlatformOneSecond/10);
1868 }
1869 else
1870 {
1871 if (!dupList && RRLocalOnly(rr))
1872 {
1873 AuthGroup *ag = RemoveAuthRecord(m, &m->rrauth, rr);
1874 if (ag->NewLocalOnlyRecords == rr) ag->NewLocalOnlyRecords = rr->next;
1875 }
1876 else
1877 {
1878 *p = rr->next; // Cut this record from the list
1879 if (m->NewLocalRecords == rr) m->NewLocalRecords = rr->next;
1880 DecrementAutoTargetServices(m, rr);
1881 }
1882 // If someone is about to look at this, bump the pointer forward
1883 if (m->CurrentRecord == rr) m->CurrentRecord = rr->next;
1884 rr->next = mDNSNULL;
1885
1886 // Should we generate local remove events here?
1887 // i.e. something like:
1888 // if (rr->AnsweredLocalQ) { AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNSfalse); rr->AnsweredLocalQ = mDNSfalse; }
1889
1890 verbosedebugf("mDNS_Deregister_internal: Deleting record for %s", ARDisplayString(m, rr));
1891 rr->resrec.RecordType = kDNSRecordTypeUnregistered;
1892
1893 if ((drt == mDNS_Dereg_conflict || drt == mDNS_Dereg_repeat) && RecordType == kDNSRecordTypeShared)
1894 debugf("mDNS_Deregister_internal: Cannot have a conflict on a shared record! %##s (%s)",
1895 rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1896
1897 // If we have an update queued up which never executed, give the client a chance to free that memory
1898 if (rr->NewRData) CompleteRDataUpdate(m, rr); // Update our rdata, clear the NewRData pointer, and return memory to the client
1899
1900
1901 // CAUTION: MUST NOT do anything more with rr after calling rr->Callback(), because the client's callback function
1902 // is allowed to do anything, including starting/stopping queries, registering/deregistering records, etc.
1903 // In this case the likely client action to the mStatus_MemFree message is to free the memory,
1904 // so any attempt to touch rr after this is likely to lead to a crash.
1905 if (drt != mDNS_Dereg_conflict)
1906 {
1907 mDNS_DropLockBeforeCallback(); // Allow client to legally make mDNS API calls from the callback
1908 LogInfo("mDNS_Deregister_internal: callback with mStatus_MemFree for %s", ARDisplayString(m, rr));
1909 if (rr->RecordCallback)
1910 rr->RecordCallback(m, rr, mStatus_MemFree); // MUST NOT touch rr after this
1911 mDNS_ReclaimLockAfterCallback(); // Decrement mDNS_reentrancy to block mDNS API calls again
1912 }
1913 else
1914 {
1915 RecordProbeFailure(m, rr);
1916 mDNS_DropLockBeforeCallback(); // Allow client to legally make mDNS API calls from the callback
1917 if (rr->RecordCallback)
1918 rr->RecordCallback(m, rr, mStatus_NameConflict); // MUST NOT touch rr after this
1919 mDNS_ReclaimLockAfterCallback(); // Decrement mDNS_reentrancy to block mDNS API calls again
1920 // Now that we've finished deregistering rr, check our DuplicateRecords list for any that we marked previously.
1921 // Note that with all the client callbacks going on, by the time we get here all the
1922 // records we marked may have been explicitly deregistered by the client anyway.
1923 r2 = m->DuplicateRecords;
1924 while (r2)
1925 {
1926 if (r2->ProbeCount != 0xFF)
1927 {
1928 r2 = r2->next;
1929 }
1930 else
1931 {
1932 #if APPLE_OSX_mDNSResponder
1933 // See if this record was also registered with any D2D plugins.
1934 D2D_stop_advertising_record(r2);
1935 #endif
1936 mDNS_Deregister_internal(m, r2, mDNS_Dereg_conflict);
1937 // As this is a duplicate record, it will be unlinked from the list
1938 // immediately
1939 r2 = m->DuplicateRecords;
1940 }
1941 }
1942 }
1943 }
1944 mDNS_UpdateAllowSleep(m);
1945 return(mStatus_NoError);
1946 }
1947
1948 // ***************************************************************************
1949 #if COMPILER_LIKES_PRAGMA_MARK
1950 #pragma mark -
1951 #pragma mark - Packet Sending Functions
1952 #endif
1953
1954 mDNSlocal void AddRecordToResponseList(AuthRecord ***nrpp, AuthRecord *rr, AuthRecord *add)
1955 {
1956 if (rr->NextResponse == mDNSNULL && *nrpp != &rr->NextResponse)
1957 {
1958 **nrpp = rr;
1959 // NR_AdditionalTo must point to a record with NR_AnswerTo set (and not NR_AdditionalTo)
1960 // If 'add' does not meet this requirement, then follow its NR_AdditionalTo pointer to a record that does
1961 // The referenced record will definitely be acceptable (by recursive application of this rule)
1962 if (add && add->NR_AdditionalTo) add = add->NR_AdditionalTo;
1963 rr->NR_AdditionalTo = add;
1964 *nrpp = &rr->NextResponse;
1965 }
1966 debugf("AddRecordToResponseList: %##s (%s) already in list", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
1967 }
1968
1969 mDNSlocal void AddRRSetAdditionalsToResponseList(mDNS *const m, AuthRecord ***nrpp, AuthRecord *rr, AuthRecord *additional, const mDNSInterfaceID InterfaceID)
1970 {
1971 AuthRecord *rr2;
1972 if (additional->resrec.RecordType & kDNSRecordTypeUniqueMask)
1973 {
1974 for (rr2 = m->ResourceRecords; rr2; rr2 = rr2->next)
1975 {
1976 if ((rr2->resrec.namehash == additional->resrec.namehash) &&
1977 (rr2->resrec.rrtype == additional->resrec.rrtype) &&
1978 (rr2 != additional) &&
1979 (rr2->resrec.RecordType & kDNSRecordTypeUniqueMask) &&
1980 (rr2->resrec.rrclass == additional->resrec.rrclass) &&
1981 ResourceRecordIsValidInterfaceAnswer(rr2, InterfaceID) &&
1982 SameDomainName(rr2->resrec.name, additional->resrec.name))
1983 {
1984 AddRecordToResponseList(nrpp, rr2, rr);
1985 }
1986 }
1987 }
1988 }
1989
1990 mDNSlocal void AddAdditionalsToResponseList(mDNS *const m, AuthRecord *ResponseRecords, AuthRecord ***nrpp, const mDNSInterfaceID InterfaceID)
1991 {
1992 AuthRecord *rr, *rr2;
1993 for (rr=ResponseRecords; rr; rr=rr->NextResponse) // For each record we plan to put
1994 {
1995 // (Note: This is an "if", not a "while". If we add a record, we'll find it again
1996 // later in the "for" loop, and we will follow further "additional" links then.)
1997 if (rr->Additional1 && ResourceRecordIsValidInterfaceAnswer(rr->Additional1, InterfaceID))
1998 {
1999 AddRecordToResponseList(nrpp, rr->Additional1, rr);
2000 AddRRSetAdditionalsToResponseList(m, nrpp, rr, rr->Additional1, InterfaceID);
2001 }
2002
2003 if (rr->Additional2 && ResourceRecordIsValidInterfaceAnswer(rr->Additional2, InterfaceID))
2004 {
2005 AddRecordToResponseList(nrpp, rr->Additional2, rr);
2006 AddRRSetAdditionalsToResponseList(m, nrpp, rr, rr->Additional2, InterfaceID);
2007 }
2008
2009 // For SRV records, automatically add the Address record(s) for the target host
2010 if (rr->resrec.rrtype == kDNSType_SRV)
2011 {
2012 for (rr2=m->ResourceRecords; rr2; rr2=rr2->next) // Scan list of resource records
2013 if (RRTypeIsAddressType(rr2->resrec.rrtype) && // For all address records (A/AAAA) ...
2014 ResourceRecordIsValidInterfaceAnswer(rr2, InterfaceID) && // ... which are valid for answer ...
2015 rr->resrec.rdatahash == rr2->resrec.namehash && // ... whose name is the name of the SRV target
2016 SameDomainName(&rr->resrec.rdata->u.srv.target, rr2->resrec.name))
2017 AddRecordToResponseList(nrpp, rr2, rr);
2018 }
2019 else if (RRTypeIsAddressType(rr->resrec.rrtype)) // For A or AAAA, put counterpart as additional
2020 {
2021 for (rr2=m->ResourceRecords; rr2; rr2=rr2->next) // Scan list of resource records
2022 if (RRTypeIsAddressType(rr2->resrec.rrtype) && // For all address records (A/AAAA) ...
2023 ResourceRecordIsValidInterfaceAnswer(rr2, InterfaceID) && // ... which are valid for answer ...
2024 rr->resrec.namehash == rr2->resrec.namehash && // ... and have the same name
2025 SameDomainName(rr->resrec.name, rr2->resrec.name))
2026 AddRecordToResponseList(nrpp, rr2, rr);
2027 }
2028 else if (rr->resrec.rrtype == kDNSType_PTR) // For service PTR, see if we want to add DeviceInfo record
2029 {
2030 if (ResourceRecordIsValidInterfaceAnswer(&m->DeviceInfo, InterfaceID) &&
2031 SameDomainLabel(rr->resrec.rdata->u.name.c, m->DeviceInfo.resrec.name->c))
2032 AddRecordToResponseList(nrpp, &m->DeviceInfo, rr);
2033 }
2034 }
2035 }
2036
2037 mDNSlocal int AnonInfoSpace(AnonymousInfo *info)
2038 {
2039 ResourceRecord *rr = info->nsec3RR;
2040
2041 // 2 bytes for compressed name + type (2) class (2) TTL (4) rdlength (2) rdata (n)
2042 return (2 + 10 + rr->rdlength);
2043 }
2044
2045 mDNSlocal void SendDelayedUnicastResponse(mDNS *const m, const mDNSAddr *const dest, const mDNSInterfaceID InterfaceID)
2046 {
2047 AuthRecord *rr;
2048 AuthRecord *ResponseRecords = mDNSNULL;
2049 AuthRecord **nrp = &ResponseRecords;
2050 NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
2051 int AnoninfoSpace = 0;
2052
2053 // Make a list of all our records that need to be unicast to this destination
2054 for (rr = m->ResourceRecords; rr; rr=rr->next)
2055 {
2056 // If we find we can no longer unicast this answer, clear ImmedUnicast
2057 if (rr->ImmedAnswer == mDNSInterfaceMark ||
2058 mDNSSameIPv4Address(rr->v4Requester, onesIPv4Addr) ||
2059 mDNSSameIPv6Address(rr->v6Requester, onesIPv6Addr) )
2060 rr->ImmedUnicast = mDNSfalse;
2061
2062 if (rr->ImmedUnicast && rr->ImmedAnswer == InterfaceID)
2063 {
2064 if ((dest->type == mDNSAddrType_IPv4 && mDNSSameIPv4Address(rr->v4Requester, dest->ip.v4)) ||
2065 (dest->type == mDNSAddrType_IPv6 && mDNSSameIPv6Address(rr->v6Requester, dest->ip.v6)))
2066 {
2067 rr->ImmedAnswer = mDNSNULL; // Clear the state fields
2068 rr->ImmedUnicast = mDNSfalse;
2069 rr->v4Requester = zerov4Addr;
2070 rr->v6Requester = zerov6Addr;
2071
2072 // Only sent records registered for P2P over P2P interfaces
2073 if (intf && !mDNSPlatformValidRecordForInterface(rr, intf->InterfaceID))
2074 {
2075 continue;
2076 }
2077
2078 if (rr->NextResponse == mDNSNULL && nrp != &rr->NextResponse) // rr->NR_AnswerTo
2079 {
2080 rr->NR_AnswerTo = NR_AnswerMulticast;
2081 *nrp = rr;
2082 nrp = &rr->NextResponse;
2083 }
2084 }
2085 }
2086 }
2087
2088 AddAdditionalsToResponseList(m, ResponseRecords, &nrp, InterfaceID);
2089
2090 while (ResponseRecords)
2091 {
2092 mDNSu8 *responseptr = m->omsg.data;
2093 mDNSu8 *newptr;
2094 InitializeDNSMessage(&m->omsg.h, zeroID, ResponseFlags);
2095
2096 // Put answers in the packet
2097 while (ResponseRecords && ResponseRecords->NR_AnswerTo)
2098 {
2099 rr = ResponseRecords;
2100 if (rr->resrec.AnonInfo)
2101 {
2102 AnoninfoSpace += AnonInfoSpace(rr->resrec.AnonInfo);
2103 rr->resrec.AnonInfo->SendNow = mDNSInterfaceMark;
2104 }
2105 if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2106 rr->resrec.rrclass |= kDNSClass_UniqueRRSet; // Temporarily set the cache flush bit so PutResourceRecord will set it
2107
2108 // Retract the limit by AnoninfoSpace which we need to put the AnoInfo option.
2109 newptr = PutResourceRecordTTLWithLimit(&m->omsg, responseptr, &m->omsg.h.numAnswers, &rr->resrec, rr->resrec.rroriginalttl,
2110 m->omsg.data + (AllowedRRSpace(&m->omsg) - AnoninfoSpace));
2111
2112 rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet; // Make sure to clear cache flush bit back to normal state
2113 if (!newptr && m->omsg.h.numAnswers)
2114 {
2115 break; // If packet full, send it now
2116 }
2117 if (newptr) responseptr = newptr;
2118 ResponseRecords = rr->NextResponse;
2119 rr->NextResponse = mDNSNULL;
2120 rr->NR_AnswerTo = mDNSNULL;
2121 rr->NR_AdditionalTo = mDNSNULL;
2122 rr->RequireGoodbye = mDNStrue;
2123 }
2124
2125 // We have reserved the space for AnonInfo option. PutResourceRecord uses the
2126 // standard limit (AllowedRRSpace) and we should have space now.
2127 for (rr = m->ResourceRecords; rr; rr=rr->next)
2128 {
2129 if (rr->resrec.AnonInfo && rr->resrec.AnonInfo->SendNow == mDNSInterfaceMark)
2130 {
2131 ResourceRecord *nsec3RR = rr->resrec.AnonInfo->nsec3RR;
2132
2133 newptr = PutResourceRecord(&m->omsg, responseptr, &m->omsg.h.numAuthorities, nsec3RR);
2134 if (newptr)
2135 {
2136 responseptr = newptr;
2137 debugf("SendDelayedUnicastResponse: Added NSEC3 Record %s on %p", RRDisplayString(m, nsec3RR), intf->InterfaceID);
2138 }
2139 else
2140 {
2141 // We allocated space and we should not fail. Don't break, we need to clear the SendNow flag.
2142 LogMsg("SendDelayedUnicastResponse: ERROR!! Cannot Add NSEC3 Record %s on %p", RRDisplayString(m, nsec3RR), intf->InterfaceID);
2143 }
2144 rr->resrec.AnonInfo->SendNow = mDNSNULL;
2145 }
2146 }
2147
2148 // Add additionals, if there's space
2149 while (ResponseRecords && !ResponseRecords->NR_AnswerTo)
2150 {
2151 rr = ResponseRecords;
2152 if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2153 rr->resrec.rrclass |= kDNSClass_UniqueRRSet; // Temporarily set the cache flush bit so PutResourceRecord will set it
2154 newptr = PutResourceRecord(&m->omsg, responseptr, &m->omsg.h.numAdditionals, &rr->resrec);
2155 rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet; // Make sure to clear cache flush bit back to normal state
2156
2157 if (newptr) responseptr = newptr;
2158 if (newptr && m->omsg.h.numAnswers) rr->RequireGoodbye = mDNStrue;
2159 else if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask) rr->ImmedAnswer = mDNSInterfaceMark;
2160 ResponseRecords = rr->NextResponse;
2161 rr->NextResponse = mDNSNULL;
2162 rr->NR_AnswerTo = mDNSNULL;
2163 rr->NR_AdditionalTo = mDNSNULL;
2164 }
2165
2166 if (m->omsg.h.numAnswers)
2167 mDNSSendDNSMessage(m, &m->omsg, responseptr, InterfaceID, mDNSNULL, dest, MulticastDNSPort, mDNSNULL, mDNSNULL, mDNSfalse);
2168 }
2169 }
2170
2171 // CompleteDeregistration guarantees that on exit the record will have been cut from the m->ResourceRecords list
2172 // and the client's mStatus_MemFree callback will have been invoked
2173 mDNSexport void CompleteDeregistration(mDNS *const m, AuthRecord *rr)
2174 {
2175 LogInfo("CompleteDeregistration: called for Resource record %s", ARDisplayString(m, rr));
2176 // Clearing rr->RequireGoodbye signals mDNS_Deregister_internal() that
2177 // it should go ahead and immediately dispose of this registration
2178 rr->resrec.RecordType = kDNSRecordTypeShared;
2179 rr->RequireGoodbye = mDNSfalse;
2180 rr->WakeUp.HMAC = zeroEthAddr;
2181 if (rr->AnsweredLocalQ) { AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNSfalse); rr->AnsweredLocalQ = mDNSfalse; }
2182 mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal); // Don't touch rr after this
2183 }
2184
2185 // DiscardDeregistrations is used on shutdown and sleep to discard (forcibly and immediately)
2186 // any deregistering records that remain in the m->ResourceRecords list.
2187 // DiscardDeregistrations calls mDNS_Deregister_internal which can call a user callback,
2188 // which may change the record list and/or question list.
2189 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
2190 mDNSlocal void DiscardDeregistrations(mDNS *const m)
2191 {
2192 if (m->CurrentRecord)
2193 LogMsg("DiscardDeregistrations ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
2194 m->CurrentRecord = m->ResourceRecords;
2195
2196 while (m->CurrentRecord)
2197 {
2198 AuthRecord *rr = m->CurrentRecord;
2199 if (!AuthRecord_uDNS(rr) && rr->resrec.RecordType == kDNSRecordTypeDeregistering)
2200 CompleteDeregistration(m, rr); // Don't touch rr after this
2201 else
2202 m->CurrentRecord = rr->next;
2203 }
2204 }
2205
2206 mDNSlocal mStatus GetLabelDecimalValue(const mDNSu8 *const src, mDNSu8 *dst)
2207 {
2208 int i, val = 0;
2209 if (src[0] < 1 || src[0] > 3) return(mStatus_Invalid);
2210 for (i=1; i<=src[0]; i++)
2211 {
2212 if (src[i] < '0' || src[i] > '9') return(mStatus_Invalid);
2213 val = val * 10 + src[i] - '0';
2214 }
2215 if (val > 255) return(mStatus_Invalid);
2216 *dst = (mDNSu8)val;
2217 return(mStatus_NoError);
2218 }
2219
2220 mDNSlocal mStatus GetIPv4FromName(mDNSAddr *const a, const domainname *const name)
2221 {
2222 int skip = CountLabels(name) - 6;
2223 if (skip < 0) { LogMsg("GetIPFromName: Need six labels in IPv4 reverse mapping name %##s", name); return mStatus_Invalid; }
2224 if (GetLabelDecimalValue(SkipLeadingLabels(name, skip+3)->c, &a->ip.v4.b[0]) ||
2225 GetLabelDecimalValue(SkipLeadingLabels(name, skip+2)->c, &a->ip.v4.b[1]) ||
2226 GetLabelDecimalValue(SkipLeadingLabels(name, skip+1)->c, &a->ip.v4.b[2]) ||
2227 GetLabelDecimalValue(SkipLeadingLabels(name, skip+0)->c, &a->ip.v4.b[3])) return mStatus_Invalid;
2228 a->type = mDNSAddrType_IPv4;
2229 return(mStatus_NoError);
2230 }
2231
2232 #define HexVal(X) ( ((X) >= '0' && (X) <= '9') ? ((X) - '0' ) : \
2233 ((X) >= 'A' && (X) <= 'F') ? ((X) - 'A' + 10) : \
2234 ((X) >= 'a' && (X) <= 'f') ? ((X) - 'a' + 10) : -1)
2235
2236 mDNSlocal mStatus GetIPv6FromName(mDNSAddr *const a, const domainname *const name)
2237 {
2238 int i, h, l;
2239 const domainname *n;
2240
2241 int skip = CountLabels(name) - 34;
2242 if (skip < 0) { LogMsg("GetIPFromName: Need 34 labels in IPv6 reverse mapping name %##s", name); return mStatus_Invalid; }
2243
2244 n = SkipLeadingLabels(name, skip);
2245 for (i=0; i<16; i++)
2246 {
2247 if (n->c[0] != 1) return mStatus_Invalid;
2248 l = HexVal(n->c[1]);
2249 n = (const domainname *)(n->c + 2);
2250
2251 if (n->c[0] != 1) return mStatus_Invalid;
2252 h = HexVal(n->c[1]);
2253 n = (const domainname *)(n->c + 2);
2254
2255 if (l<0 || h<0) return mStatus_Invalid;
2256 a->ip.v6.b[15-i] = (mDNSu8)((h << 4) | l);
2257 }
2258
2259 a->type = mDNSAddrType_IPv6;
2260 return(mStatus_NoError);
2261 }
2262
2263 mDNSlocal mDNSs32 ReverseMapDomainType(const domainname *const name)
2264 {
2265 int skip = CountLabels(name) - 2;
2266 if (skip >= 0)
2267 {
2268 const domainname *suffix = SkipLeadingLabels(name, skip);
2269 if (SameDomainName(suffix, (const domainname*)"\x7" "in-addr" "\x4" "arpa")) return mDNSAddrType_IPv4;
2270 if (SameDomainName(suffix, (const domainname*)"\x3" "ip6" "\x4" "arpa")) return mDNSAddrType_IPv6;
2271 }
2272 return(mDNSAddrType_None);
2273 }
2274
2275 mDNSlocal void SendARP(mDNS *const m, const mDNSu8 op, const AuthRecord *const rr,
2276 const mDNSv4Addr *const spa, const mDNSEthAddr *const tha, const mDNSv4Addr *const tpa, const mDNSEthAddr *const dst)
2277 {
2278 int i;
2279 mDNSu8 *ptr = m->omsg.data;
2280 NetworkInterfaceInfo *intf = FirstInterfaceForID(m, rr->resrec.InterfaceID);
2281 if (!intf) { LogMsg("SendARP: No interface with InterfaceID %p found %s", rr->resrec.InterfaceID, ARDisplayString(m,rr)); return; }
2282
2283 // 0x00 Destination address
2284 for (i=0; i<6; i++) *ptr++ = dst->b[i];
2285
2286 // 0x06 Source address (Note: Since we don't currently set the BIOCSHDRCMPLT option, BPF will fill in the real interface address for us)
2287 for (i=0; i<6; i++) *ptr++ = intf->MAC.b[0];
2288
2289 // 0x0C ARP Ethertype (0x0806)
2290 *ptr++ = 0x08; *ptr++ = 0x06;
2291
2292 // 0x0E ARP header
2293 *ptr++ = 0x00; *ptr++ = 0x01; // Hardware address space; Ethernet = 1
2294 *ptr++ = 0x08; *ptr++ = 0x00; // Protocol address space; IP = 0x0800
2295 *ptr++ = 6; // Hardware address length
2296 *ptr++ = 4; // Protocol address length
2297 *ptr++ = 0x00; *ptr++ = op; // opcode; Request = 1, Response = 2
2298
2299 // 0x16 Sender hardware address (our MAC address)
2300 for (i=0; i<6; i++) *ptr++ = intf->MAC.b[i];
2301
2302 // 0x1C Sender protocol address
2303 for (i=0; i<4; i++) *ptr++ = spa->b[i];
2304
2305 // 0x20 Target hardware address
2306 for (i=0; i<6; i++) *ptr++ = tha->b[i];
2307
2308 // 0x26 Target protocol address
2309 for (i=0; i<4; i++) *ptr++ = tpa->b[i];
2310
2311 // 0x2A Total ARP Packet length 42 bytes
2312 mDNSPlatformSendRawPacket(m->omsg.data, ptr, rr->resrec.InterfaceID);
2313 }
2314
2315 mDNSlocal mDNSu16 CheckSum(const void *const data, mDNSs32 length, mDNSu32 sum)
2316 {
2317 const mDNSu16 *ptr = data;
2318 while (length > 0) { length -= 2; sum += *ptr++; }
2319 sum = (sum & 0xFFFF) + (sum >> 16);
2320 sum = (sum & 0xFFFF) + (sum >> 16);
2321 return(sum != 0xFFFF ? sum : 0);
2322 }
2323
2324 mDNSlocal mDNSu16 IPv6CheckSum(const mDNSv6Addr *const src, const mDNSv6Addr *const dst, const mDNSu8 protocol, const void *const data, const mDNSu32 length)
2325 {
2326 IPv6PseudoHeader ph;
2327 ph.src = *src;
2328 ph.dst = *dst;
2329 ph.len.b[0] = length >> 24;
2330 ph.len.b[1] = length >> 16;
2331 ph.len.b[2] = length >> 8;
2332 ph.len.b[3] = length;
2333 ph.pro.b[0] = 0;
2334 ph.pro.b[1] = 0;
2335 ph.pro.b[2] = 0;
2336 ph.pro.b[3] = protocol;
2337 return CheckSum(&ph, sizeof(ph), CheckSum(data, length, 0));
2338 }
2339
2340 mDNSlocal void SendNDP(mDNS *const m, const mDNSu8 op, const mDNSu8 flags, const AuthRecord *const rr,
2341 const mDNSv6Addr *const spa, const mDNSEthAddr *const tha, const mDNSv6Addr *const tpa, const mDNSEthAddr *const dst)
2342 {
2343 int i;
2344 mDNSOpaque16 checksum;
2345 mDNSu8 *ptr = m->omsg.data;
2346 // Some recipient hosts seem to ignore Neighbor Solicitations if the IPv6-layer destination address is not the
2347 // appropriate IPv6 solicited node multicast address, so we use that IPv6-layer destination address, even though
2348 // at the Ethernet-layer we unicast the packet to the intended target, to avoid wasting network bandwidth.
2349 const mDNSv6Addr mc = { { 0xFF,0x02,0x00,0x00, 0,0,0,0, 0,0,0,1, 0xFF,tpa->b[0xD],tpa->b[0xE],tpa->b[0xF] } };
2350 const mDNSv6Addr *const v6dst = (op == NDP_Sol) ? &mc : tpa;
2351 NetworkInterfaceInfo *intf = FirstInterfaceForID(m, rr->resrec.InterfaceID);
2352 if (!intf) { LogMsg("SendNDP: No interface with InterfaceID %p found %s", rr->resrec.InterfaceID, ARDisplayString(m,rr)); return; }
2353
2354 // 0x00 Destination address
2355 for (i=0; i<6; i++) *ptr++ = dst->b[i];
2356 // Right now we only send Neighbor Solicitations to verify whether the host we're proxying for has gone to sleep yet.
2357 // Since we know who we're looking for, we send it via Ethernet-layer unicast, rather than bothering every host on the
2358 // link with a pointless link-layer multicast.
2359 // Should we want to send traditional Neighbor Solicitations in the future, where we really don't know in advance what
2360 // Ethernet-layer address we're looking for, we'll need to send to the appropriate Ethernet-layer multicast address:
2361 // *ptr++ = 0x33;
2362 // *ptr++ = 0x33;
2363 // *ptr++ = 0xFF;
2364 // *ptr++ = tpa->b[0xD];
2365 // *ptr++ = tpa->b[0xE];
2366 // *ptr++ = tpa->b[0xF];
2367
2368 // 0x06 Source address (Note: Since we don't currently set the BIOCSHDRCMPLT option, BPF will fill in the real interface address for us)
2369 for (i=0; i<6; i++) *ptr++ = (tha ? *tha : intf->MAC).b[i];
2370
2371 // 0x0C IPv6 Ethertype (0x86DD)
2372 *ptr++ = 0x86; *ptr++ = 0xDD;
2373
2374 // 0x0E IPv6 header
2375 *ptr++ = 0x60; *ptr++ = 0x00; *ptr++ = 0x00; *ptr++ = 0x00; // Version, Traffic Class, Flow Label
2376 *ptr++ = 0x00; *ptr++ = 0x20; // Length
2377 *ptr++ = 0x3A; // Protocol == ICMPv6
2378 *ptr++ = 0xFF; // Hop Limit
2379
2380 // 0x16 Sender IPv6 address
2381 for (i=0; i<16; i++) *ptr++ = spa->b[i];
2382
2383 // 0x26 Destination IPv6 address
2384 for (i=0; i<16; i++) *ptr++ = v6dst->b[i];
2385
2386 // 0x36 NDP header
2387 *ptr++ = op; // 0x87 == Neighbor Solicitation, 0x88 == Neighbor Advertisement
2388 *ptr++ = 0x00; // Code
2389 *ptr++ = 0x00; *ptr++ = 0x00; // Checksum placeholder (0x38, 0x39)
2390 *ptr++ = flags;
2391 *ptr++ = 0x00; *ptr++ = 0x00; *ptr++ = 0x00;
2392
2393 if (op == NDP_Sol) // Neighbor Solicitation. The NDP "target" is the address we seek.
2394 {
2395 // 0x3E NDP target.
2396 for (i=0; i<16; i++) *ptr++ = tpa->b[i];
2397 // 0x4E Source Link-layer Address
2398 // <http://www.ietf.org/rfc/rfc2461.txt>
2399 // MUST NOT be included when the source IP address is the unspecified address.
2400 // Otherwise, on link layers that have addresses this option MUST be included
2401 // in multicast solicitations and SHOULD be included in unicast solicitations.
2402 if (!mDNSIPv6AddressIsZero(*spa))
2403 {
2404 *ptr++ = NDP_SrcLL; // Option Type 1 == Source Link-layer Address
2405 *ptr++ = 0x01; // Option length 1 (in units of 8 octets)
2406 for (i=0; i<6; i++) *ptr++ = (tha ? *tha : intf->MAC).b[i];
2407 }
2408 }
2409 else // Neighbor Advertisement. The NDP "target" is the address we're giving information about.
2410 {
2411 // 0x3E NDP target.
2412 for (i=0; i<16; i++) *ptr++ = spa->b[i];
2413 // 0x4E Target Link-layer Address
2414 *ptr++ = NDP_TgtLL; // Option Type 2 == Target Link-layer Address
2415 *ptr++ = 0x01; // Option length 1 (in units of 8 octets)
2416 for (i=0; i<6; i++) *ptr++ = (tha ? *tha : intf->MAC).b[i];
2417 }
2418
2419 // 0x4E or 0x56 Total NDP Packet length 78 or 86 bytes
2420 m->omsg.data[0x13] = ptr - &m->omsg.data[0x36]; // Compute actual length
2421 checksum.NotAnInteger = ~IPv6CheckSum(spa, v6dst, 0x3A, &m->omsg.data[0x36], m->omsg.data[0x13]);
2422 m->omsg.data[0x38] = checksum.b[0];
2423 m->omsg.data[0x39] = checksum.b[1];
2424
2425 mDNSPlatformSendRawPacket(m->omsg.data, ptr, rr->resrec.InterfaceID);
2426 }
2427
2428 mDNSlocal void SetupTracerOpt(const mDNS *const m, rdataOPT *const Trace)
2429 {
2430 mDNSu32 DNS_VERS = _DNS_SD_H;
2431 Trace->u.tracer.platf = m->mDNS_plat;
2432 Trace->u.tracer.mDNSv = DNS_VERS;
2433
2434 Trace->opt = kDNSOpt_Trace;
2435 Trace->optlen = DNSOpt_TraceData_Space - 4;
2436 }
2437
2438 mDNSlocal void SetupOwnerOpt(const mDNS *const m, const NetworkInterfaceInfo *const intf, rdataOPT *const owner)
2439 {
2440 owner->u.owner.vers = 0;
2441 owner->u.owner.seq = m->SleepSeqNum;
2442 owner->u.owner.HMAC = m->PrimaryMAC;
2443 owner->u.owner.IMAC = intf->MAC;
2444 owner->u.owner.password = zeroEthAddr;
2445
2446 // Don't try to compute the optlen until *after* we've set up the data fields
2447 // Right now the DNSOpt_Owner_Space macro does not depend on the owner->u.owner being set up correctly, but in the future it might
2448 owner->opt = kDNSOpt_Owner;
2449 owner->optlen = DNSOpt_Owner_Space(&m->PrimaryMAC, &intf->MAC) - 4;
2450 }
2451
2452 mDNSlocal void GrantUpdateCredit(AuthRecord *rr)
2453 {
2454 if (++rr->UpdateCredits >= kMaxUpdateCredits) rr->NextUpdateCredit = 0;
2455 else rr->NextUpdateCredit = NonZeroTime(rr->NextUpdateCredit + kUpdateCreditRefreshInterval);
2456 }
2457
2458 mDNSlocal mDNSBool ShouldSendGoodbyesBeforeSleep(mDNS *const m, const NetworkInterfaceInfo *intf, AuthRecord *rr)
2459 {
2460 // If there are no sleep proxies, we set the state to SleepState_Sleeping explicitly
2461 // and hence there is no need to check for Transfering state. But if we have sleep
2462 // proxies and partially sending goodbyes for some records, we will be in Transfering
2463 // state and hence need to make sure that we send goodbyes in that case too. Checking whether
2464 // we are not awake handles both cases.
2465 if ((rr->AuthFlags & AuthFlagsWakeOnly) && (m->SleepState != SleepState_Awake))
2466 {
2467 debugf("ShouldSendGoodbyesBeforeSleep: marking for goodbye", ARDisplayString(m, rr));
2468 return mDNStrue;
2469 }
2470
2471 if (m->SleepState != SleepState_Sleeping)
2472 return mDNSfalse;
2473
2474 // If we are going to sleep and in SleepState_Sleeping, SendGoodbyes on the interface tell you
2475 // whether you can send goodbyes or not.
2476 if (!intf->SendGoodbyes)
2477 {
2478 debugf("ShouldSendGoodbyesBeforeSleep: not sending goodbye %s, int %p", ARDisplayString(m, rr), intf->InterfaceID);
2479 return mDNSfalse;
2480 }
2481 else
2482 {
2483 debugf("ShouldSendGoodbyesBeforeSleep: sending goodbye %s, int %p", ARDisplayString(m, rr), intf->InterfaceID);
2484 return mDNStrue;
2485 }
2486 }
2487
2488 mDNSlocal mDNSBool IsInterfaceValidForAuthRecord(const AuthRecord *ar, mDNSInterfaceID InterfaceID)
2489 {
2490 mDNSBool result;
2491
2492 if (ar->resrec.InterfaceID == mDNSInterface_Any)
2493 {
2494 result = mDNSPlatformValidRecordForInterface(ar, InterfaceID);
2495 }
2496 else
2497 {
2498 result = (ar->resrec.InterfaceID == InterfaceID);
2499 }
2500
2501 return(result);
2502 }
2503
2504 // Note about acceleration of announcements to facilitate automatic coalescing of
2505 // multiple independent threads of announcements into a single synchronized thread:
2506 // The announcements in the packet may be at different stages of maturity;
2507 // One-second interval, two-second interval, four-second interval, and so on.
2508 // After we've put in all the announcements that are due, we then consider
2509 // whether there are other nearly-due announcements that are worth accelerating.
2510 // To be eligible for acceleration, a record MUST NOT be older (further along
2511 // its timeline) than the most mature record we've already put in the packet.
2512 // In other words, younger records can have their timelines accelerated to catch up
2513 // with their elder bretheren; this narrows the age gap and helps them eventually get in sync.
2514 // Older records cannot have their timelines accelerated; this would just widen
2515 // the gap between them and their younger bretheren and get them even more out of sync.
2516
2517 // Note: SendResponses calls mDNS_Deregister_internal which can call a user callback, which may change
2518 // the record list and/or question list.
2519 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
2520 mDNSlocal void SendResponses(mDNS *const m)
2521 {
2522 int pktcount = 0;
2523 AuthRecord *rr, *r2;
2524 mDNSs32 maxExistingAnnounceInterval = 0;
2525 const NetworkInterfaceInfo *intf = GetFirstActiveInterface(m->HostInterfaces);
2526
2527 m->NextScheduledResponse = m->timenow + FutureTime;
2528
2529 if (m->SleepState == SleepState_Transferring) RetrySPSRegistrations(m);
2530
2531 for (rr = m->ResourceRecords; rr; rr=rr->next)
2532 if (rr->ImmedUnicast)
2533 {
2534 mDNSAddr v4 = { mDNSAddrType_IPv4, {{{0}}} };
2535 mDNSAddr v6 = { mDNSAddrType_IPv6, {{{0}}} };
2536 v4.ip.v4 = rr->v4Requester;
2537 v6.ip.v6 = rr->v6Requester;
2538 if (!mDNSIPv4AddressIsZero(rr->v4Requester)) SendDelayedUnicastResponse(m, &v4, rr->ImmedAnswer);
2539 if (!mDNSIPv6AddressIsZero(rr->v6Requester)) SendDelayedUnicastResponse(m, &v6, rr->ImmedAnswer);
2540 if (rr->ImmedUnicast)
2541 {
2542 LogMsg("SendResponses: ERROR: rr->ImmedUnicast still set: %s", ARDisplayString(m, rr));
2543 rr->ImmedUnicast = mDNSfalse;
2544 }
2545 }
2546
2547 // ***
2548 // *** 1. Setup: Set the SendRNow and ImmedAnswer fields to indicate which interface(s) the records need to be sent on
2549 // ***
2550
2551 // Run through our list of records, and decide which ones we're going to announce on all interfaces
2552 for (rr = m->ResourceRecords; rr; rr=rr->next)
2553 {
2554 while (rr->NextUpdateCredit && m->timenow - rr->NextUpdateCredit >= 0) GrantUpdateCredit(rr);
2555 if (TimeToAnnounceThisRecord(rr, m->timenow))
2556 {
2557 if (rr->resrec.RecordType == kDNSRecordTypeDeregistering)
2558 {
2559 if (!rr->WakeUp.HMAC.l[0])
2560 {
2561 if (rr->AnnounceCount) rr->ImmedAnswer = mDNSInterfaceMark; // Send goodbye packet on all interfaces
2562 }
2563 else
2564 {
2565 mDNSBool unicastOnly;
2566 LogSPS("SendResponses: Sending wakeup %2d for %.6a %s", rr->AnnounceCount-3, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
2567 unicastOnly = ((rr->AnnounceCount == WakeupCount) || (rr->AnnounceCount == WakeupCount - 1)) ? mDNStrue : mDNSfalse;
2568 SendWakeup(m, rr->resrec.InterfaceID, &rr->WakeUp.IMAC, &rr->WakeUp.password, unicastOnly);
2569 for (r2 = rr; r2; r2=r2->next)
2570 if ((r2->resrec.RecordType == kDNSRecordTypeDeregistering) && r2->AnnounceCount && (r2->resrec.InterfaceID == rr->resrec.InterfaceID) &&
2571 mDNSSameEthAddress(&r2->WakeUp.IMAC, &rr->WakeUp.IMAC) && !mDNSSameEthAddress(&zeroEthAddr, &r2->WakeUp.HMAC))
2572 {
2573 // For now we only want to send a single Unsolicited Neighbor Advertisement restoring the address to the original
2574 // owner, because these packets can cause some IPv6 stacks to falsely conclude that there's an address conflict.
2575 if (r2->AddressProxy.type == mDNSAddrType_IPv6 && r2->AnnounceCount == WakeupCount)
2576 {
2577 LogSPS("NDP Announcement %2d Releasing traffic for H-MAC %.6a I-MAC %.6a %s",
2578 r2->AnnounceCount-3, &r2->WakeUp.HMAC, &r2->WakeUp.IMAC, ARDisplayString(m,r2));
2579 SendNDP(m, NDP_Adv, NDP_Override, r2, &r2->AddressProxy.ip.v6, &r2->WakeUp.IMAC, &AllHosts_v6, &AllHosts_v6_Eth);
2580 }
2581 r2->LastAPTime = m->timenow;
2582 // After 15 wakeups without success (maybe host has left the network) send three goodbyes instead
2583 if (--r2->AnnounceCount <= GoodbyeCount) r2->WakeUp.HMAC = zeroEthAddr;
2584 }
2585 }
2586 }
2587 else if (ResourceRecordIsValidAnswer(rr))
2588 {
2589 if (rr->AddressProxy.type)
2590 {
2591 if (!mDNSSameEthAddress(&zeroEthAddr, &rr->WakeUp.HMAC))
2592 {
2593 rr->AnnounceCount--;
2594 rr->ThisAPInterval *= 2;
2595 rr->LastAPTime = m->timenow;
2596 if (rr->AddressProxy.type == mDNSAddrType_IPv4)
2597 {
2598 LogSPS("ARP Announcement %2d Capturing traffic for H-MAC %.6a I-MAC %.6a %s",
2599 rr->AnnounceCount, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m,rr));
2600 SendARP(m, 1, rr, &rr->AddressProxy.ip.v4, &zeroEthAddr, &rr->AddressProxy.ip.v4, &onesEthAddr);
2601 }
2602 else if (rr->AddressProxy.type == mDNSAddrType_IPv6)
2603 {
2604 LogSPS("NDP Announcement %2d Capturing traffic for H-MAC %.6a I-MAC %.6a %s",
2605 rr->AnnounceCount, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m,rr));
2606 SendNDP(m, NDP_Adv, NDP_Override, rr, &rr->AddressProxy.ip.v6, mDNSNULL, &AllHosts_v6, &AllHosts_v6_Eth);
2607 }
2608 }
2609 }
2610 else
2611 {
2612 rr->ImmedAnswer = mDNSInterfaceMark; // Send on all interfaces
2613 if (maxExistingAnnounceInterval < rr->ThisAPInterval)
2614 maxExistingAnnounceInterval = rr->ThisAPInterval;
2615 if (rr->UpdateBlocked) rr->UpdateBlocked = 0;
2616 }
2617 }
2618 }
2619 }
2620
2621 // Any interface-specific records we're going to send are marked as being sent on all appropriate interfaces (which is just one)
2622 // Eligible records that are more than half-way to their announcement time are accelerated
2623 for (rr = m->ResourceRecords; rr; rr=rr->next)
2624 if ((rr->resrec.InterfaceID && rr->ImmedAnswer) ||
2625 (rr->ThisAPInterval <= maxExistingAnnounceInterval &&
2626 TimeToAnnounceThisRecord(rr, m->timenow + rr->ThisAPInterval/2) &&
2627 !rr->AddressProxy.type && // Don't include ARP Annoucements when considering which records to accelerate
2628 ResourceRecordIsValidAnswer(rr)))
2629 rr->ImmedAnswer = mDNSInterfaceMark; // Send on all interfaces
2630
2631 // When sending SRV records (particularly when announcing a new service) automatically add related Address record(s) as additionals
2632 // Note: Currently all address records are interface-specific, so it's safe to set ImmedAdditional to their InterfaceID,
2633 // which will be non-null. If by some chance there is an address record that's not interface-specific (should never happen)
2634 // then all that means is that it won't get sent -- which would not be the end of the world.
2635 for (rr = m->ResourceRecords; rr; rr=rr->next)
2636 {
2637 if (rr->ImmedAnswer && rr->resrec.rrtype == kDNSType_SRV)
2638 for (r2=m->ResourceRecords; r2; r2=r2->next) // Scan list of resource records
2639 if (RRTypeIsAddressType(r2->resrec.rrtype) && // For all address records (A/AAAA) ...
2640 ResourceRecordIsValidAnswer(r2) && // ... which are valid for answer ...
2641 rr->LastMCTime - r2->LastMCTime >= 0 && // ... which we have not sent recently ...
2642 rr->resrec.rdatahash == r2->resrec.namehash && // ... whose name is the name of the SRV target
2643 SameDomainName(&rr->resrec.rdata->u.srv.target, r2->resrec.name) &&
2644 (rr->ImmedAnswer == mDNSInterfaceMark || rr->ImmedAnswer == r2->resrec.InterfaceID))
2645 r2->ImmedAdditional = r2->resrec.InterfaceID; // ... then mark this address record for sending too
2646 // We also make sure we send the DeviceInfo TXT record too, if necessary
2647 // We check for RecordType == kDNSRecordTypeShared because we don't want to tag the
2648 // DeviceInfo TXT record onto a goodbye packet (RecordType == kDNSRecordTypeDeregistering).
2649 if (rr->ImmedAnswer && rr->resrec.RecordType == kDNSRecordTypeShared && rr->resrec.rrtype == kDNSType_PTR)
2650 if (ResourceRecordIsValidAnswer(&m->DeviceInfo) && SameDomainLabel(rr->resrec.rdata->u.name.c, m->DeviceInfo.resrec.name->c))
2651 {
2652 if (!m->DeviceInfo.ImmedAnswer) m->DeviceInfo.ImmedAnswer = rr->ImmedAnswer;
2653 else m->DeviceInfo.ImmedAnswer = mDNSInterfaceMark;
2654 }
2655 }
2656
2657 // If there's a record which is supposed to be unique that we're going to send, then make sure that we give
2658 // the whole RRSet as an atomic unit. That means that if we have any other records with the same name/type/class
2659 // then we need to mark them for sending too. Otherwise, if we set the kDNSClass_UniqueRRSet bit on a
2660 // record, then other RRSet members that have not been sent recently will get flushed out of client caches.
2661 // -- If a record is marked to be sent on a certain interface, make sure the whole set is marked to be sent on that interface
2662 // -- If any record is marked to be sent on all interfaces, make sure the whole set is marked to be sent on all interfaces
2663 for (rr = m->ResourceRecords; rr; rr=rr->next)
2664 if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2665 {
2666 if (rr->ImmedAnswer) // If we're sending this as answer, see that its whole RRSet is similarly marked
2667 {
2668 for (r2 = m->ResourceRecords; r2; r2=r2->next)
2669 {
2670 if ((r2->resrec.RecordType & kDNSRecordTypeUniqueMask) && ResourceRecordIsValidAnswer(r2) &&
2671 (r2->ImmedAnswer != mDNSInterfaceMark) && (r2->ImmedAnswer != rr->ImmedAnswer) &&
2672 SameResourceRecordSignature(r2, rr) &&
2673 ((rr->ImmedAnswer == mDNSInterfaceMark) || IsInterfaceValidForAuthRecord(r2, rr->ImmedAnswer)))
2674 {
2675 r2->ImmedAnswer = !r2->ImmedAnswer ? rr->ImmedAnswer : mDNSInterfaceMark;
2676 }
2677 }
2678 }
2679 else if (rr->ImmedAdditional) // If we're sending this as additional, see that its whole RRSet is similarly marked
2680 {
2681 for (r2 = m->ResourceRecords; r2; r2=r2->next)
2682 {
2683 if ((r2->resrec.RecordType & kDNSRecordTypeUniqueMask) && ResourceRecordIsValidAnswer(r2) &&
2684 (r2->ImmedAdditional != rr->ImmedAdditional) &&
2685 SameResourceRecordSignature(r2, rr) &&
2686 IsInterfaceValidForAuthRecord(r2, rr->ImmedAdditional))
2687 {
2688 r2->ImmedAdditional = rr->ImmedAdditional;
2689 }
2690 }
2691 }
2692 }
2693
2694 // Now set SendRNow state appropriately
2695 for (rr = m->ResourceRecords; rr; rr=rr->next)
2696 {
2697 if (rr->ImmedAnswer == mDNSInterfaceMark) // Sending this record on all appropriate interfaces
2698 {
2699 rr->SendRNow = !intf ? mDNSNULL : (rr->resrec.InterfaceID) ? rr->resrec.InterfaceID : intf->InterfaceID;
2700 rr->ImmedAdditional = mDNSNULL; // No need to send as additional if sending as answer
2701 rr->LastMCTime = m->timenow;
2702 rr->LastMCInterface = rr->ImmedAnswer;
2703 rr->ProbeRestartCount = 0; // Reset the probe restart count
2704 // If we're announcing this record, and it's at least half-way to its ordained time, then consider this announcement done
2705 if (TimeToAnnounceThisRecord(rr, m->timenow + rr->ThisAPInterval/2))
2706 {
2707 rr->AnnounceCount--;
2708 if (rr->resrec.RecordType != kDNSRecordTypeDeregistering)
2709 rr->ThisAPInterval *= 2;
2710 rr->LastAPTime = m->timenow;
2711 debugf("Announcing %##s (%s) %d", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), rr->AnnounceCount);
2712 }
2713 }
2714 else if (rr->ImmedAnswer) // Else, just respond to a single query on single interface:
2715 {
2716 rr->SendRNow = rr->ImmedAnswer; // Just respond on that interface
2717 rr->ImmedAdditional = mDNSNULL; // No need to send as additional too
2718 rr->LastMCTime = m->timenow;
2719 rr->LastMCInterface = rr->ImmedAnswer;
2720 }
2721 SetNextAnnounceProbeTime(m, rr);
2722 //if (rr->SendRNow) LogMsg("%-15.4a %s", &rr->v4Requester, ARDisplayString(m, rr));
2723 }
2724
2725 // ***
2726 // *** 2. Loop through interface list, sending records as appropriate
2727 // ***
2728
2729 while (intf)
2730 {
2731 int OwnerRecordSpace = (m->AnnounceOwner && intf->MAC.l[0]) ? DNSOpt_Header_Space + DNSOpt_Owner_Space(&m->PrimaryMAC, &intf->MAC) : 0;
2732 int TraceRecordSpace = (mDNS_McastTracingEnabled && MDNS_TRACER) ? DNSOpt_Header_Space + DNSOpt_TraceData_Space : 0;
2733 int numDereg = 0;
2734 int numAnnounce = 0;
2735 int numAnswer = 0;
2736 int AnoninfoSpace = 0;
2737 mDNSu8 *responseptr = m->omsg.data;
2738 mDNSu8 *newptr;
2739 InitializeDNSMessage(&m->omsg.h, zeroID, ResponseFlags);
2740
2741 // First Pass. Look for:
2742 // 1. Deregistering records that need to send their goodbye packet
2743 // 2. Updated records that need to retract their old data
2744 // 3. Answers and announcements we need to send
2745 for (rr = m->ResourceRecords; rr; rr=rr->next)
2746 {
2747
2748 // Skip this interface if the record InterfaceID is *Any and the record is not
2749 // appropriate for the interface type.
2750 if ((rr->SendRNow == intf->InterfaceID) &&
2751 ((rr->resrec.InterfaceID == mDNSInterface_Any) && !mDNSPlatformValidRecordForInterface(rr, intf->InterfaceID)))
2752 {
2753 rr->SendRNow = GetNextActiveInterfaceID(intf);
2754 }
2755 else if (rr->SendRNow == intf->InterfaceID)
2756 {
2757 RData *OldRData = rr->resrec.rdata;
2758 mDNSu16 oldrdlength = rr->resrec.rdlength;
2759 mDNSu8 active = (mDNSu8)
2760 (rr->resrec.RecordType != kDNSRecordTypeDeregistering && !ShouldSendGoodbyesBeforeSleep(m, intf, rr));
2761 newptr = mDNSNULL;
2762 if (rr->NewRData && active)
2763 {
2764 // See if we should send a courtesy "goodbye" for the old data before we replace it.
2765 if (ResourceRecordIsValidAnswer(rr) && rr->resrec.RecordType == kDNSRecordTypeShared && rr->RequireGoodbye)
2766 {
2767 newptr = PutRR_OS_TTL(responseptr, &m->omsg.h.numAnswers, &rr->resrec, 0);
2768 if (newptr) { responseptr = newptr; numDereg++; rr->RequireGoodbye = mDNSfalse; }
2769 else continue; // If this packet is already too full to hold the goodbye for this record, skip it for now and we'll retry later
2770 }
2771 SetNewRData(&rr->resrec, rr->NewRData, rr->newrdlength);
2772 }
2773
2774 if (rr->resrec.AnonInfo)
2775 {
2776 int tmp = AnonInfoSpace(rr->resrec.AnonInfo);
2777
2778 AnoninfoSpace += tmp;
2779 // Adjust OwnerRecordSpace/TraceRecordSpace which is used by PutRR_OS_TTL below so that
2780 // we have space to put in the NSEC3 record in the authority section.
2781 OwnerRecordSpace += tmp;
2782 TraceRecordSpace += tmp;
2783 }
2784
2785 if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2786 rr->resrec.rrclass |= kDNSClass_UniqueRRSet; // Temporarily set the cache flush bit so PutResourceRecord will set it
2787 newptr = PutRR_OS_TTL(responseptr, &m->omsg.h.numAnswers, &rr->resrec, active ? rr->resrec.rroriginalttl : 0);
2788 rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet; // Make sure to clear cache flush bit back to normal state
2789 if (newptr)
2790 {
2791 responseptr = newptr;
2792 rr->RequireGoodbye = active;
2793 if (rr->resrec.RecordType == kDNSRecordTypeDeregistering) numDereg++;
2794 else if (rr->LastAPTime == m->timenow) numAnnounce++;else numAnswer++;
2795 }
2796
2797 if (rr->NewRData && active)
2798 SetNewRData(&rr->resrec, OldRData, oldrdlength);
2799
2800 // The first time through (pktcount==0), if this record is verified unique
2801 // (i.e. typically A, AAAA, SRV, TXT and reverse-mapping PTR), set the flag to add an NSEC too.
2802 if (!pktcount && active && (rr->resrec.RecordType & kDNSRecordTypeActiveUniqueMask) && !rr->SendNSECNow)
2803 rr->SendNSECNow = mDNSInterfaceMark;
2804
2805 if (newptr) // If succeeded in sending, advance to next interface
2806 {
2807 if (rr->resrec.AnonInfo)
2808 {
2809 debugf("SendResponses: Marking %s, OwnerRecordSpace %d, TraceRecordSpace %d, limit %p", ARDisplayString(m, rr), OwnerRecordSpace,
2810 TraceRecordSpace, m->omsg.data + AllowedRRSpace(&m->omsg) - OwnerRecordSpace - TraceRecordSpace);
2811 rr->resrec.AnonInfo->SendNow = intf->InterfaceID;
2812 }
2813
2814 // If sending on all interfaces, go to next interface; else we're finished now
2815 if (rr->ImmedAnswer == mDNSInterfaceMark && rr->resrec.InterfaceID == mDNSInterface_Any)
2816 rr->SendRNow = GetNextActiveInterfaceID(intf);
2817 else
2818 rr->SendRNow = mDNSNULL;
2819 }
2820 }
2821 }
2822
2823 // Get the reserved space back
2824 OwnerRecordSpace -= AnoninfoSpace;
2825 TraceRecordSpace -= AnoninfoSpace;
2826 newptr = responseptr;
2827 for (rr = m->ResourceRecords; rr; rr=rr->next)
2828 {
2829 if (rr->resrec.AnonInfo && rr->resrec.AnonInfo->SendNow == intf->InterfaceID)
2830 {
2831 ResourceRecord *nsec3RR = rr->resrec.AnonInfo->nsec3RR;
2832
2833 newptr = PutRR_OS_TTL(newptr, &m->omsg.h.numAuthorities, nsec3RR, nsec3RR->rroriginalttl);
2834 if (newptr)
2835 {
2836 responseptr = newptr;
2837 debugf("SendResponses: Added NSEC3 %s, OwnerRecordSpace %d, TraceRecordSpace %d, limit %p", ARDisplayString(m, rr), OwnerRecordSpace,
2838 TraceRecordSpace, m->omsg.data + AllowedRRSpace(&m->omsg) - OwnerRecordSpace - TraceRecordSpace);
2839 }
2840 else
2841 {
2842 LogMsg("SendResponses: Cannot add NSEC3 %s, OwnerRecordSpace %d, TraceRecordSpace %d, limit %p", ARDisplayString(m, rr), OwnerRecordSpace,
2843 TraceRecordSpace, m->omsg.data + AllowedRRSpace(&m->omsg) - OwnerRecordSpace - TraceRecordSpace);
2844 }
2845 rr->resrec.AnonInfo->SendNow = mDNSNULL;
2846 }
2847 }
2848 // Second Pass. Add additional records, if there's space.
2849 newptr = responseptr;
2850 for (rr = m->ResourceRecords; rr; rr=rr->next)
2851 if (rr->ImmedAdditional == intf->InterfaceID)
2852 if (ResourceRecordIsValidAnswer(rr))
2853 {
2854 // If we have at least one answer already in the packet, then plan to add additionals too
2855 mDNSBool SendAdditional = (m->omsg.h.numAnswers > 0);
2856
2857 // If we're not planning to send any additionals, but this record is a unique one, then
2858 // make sure we haven't already sent any other members of its RRSet -- if we have, then they
2859 // will have had the cache flush bit set, so now we need to finish the job and send the rest.
2860 if (!SendAdditional && (rr->resrec.RecordType & kDNSRecordTypeUniqueMask))
2861 {
2862 const AuthRecord *a;
2863 for (a = m->ResourceRecords; a; a=a->next)
2864 if (a->LastMCTime == m->timenow &&
2865 a->LastMCInterface == intf->InterfaceID &&
2866 SameResourceRecordSignature(a, rr)) { SendAdditional = mDNStrue; break; }
2867 }
2868 if (!SendAdditional) // If we don't want to send this after all,
2869 rr->ImmedAdditional = mDNSNULL; // then cancel its ImmedAdditional field
2870 else if (newptr) // Else, try to add it if we can
2871 {
2872 // The first time through (pktcount==0), if this record is verified unique
2873 // (i.e. typically A, AAAA, SRV, TXT and reverse-mapping PTR), set the flag to add an NSEC too.
2874 if (!pktcount && (rr->resrec.RecordType & kDNSRecordTypeActiveUniqueMask) && !rr->SendNSECNow)
2875 rr->SendNSECNow = mDNSInterfaceMark;
2876
2877 if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
2878 rr->resrec.rrclass |= kDNSClass_UniqueRRSet; // Temporarily set the cache flush bit so PutResourceRecord will set it
2879 newptr = PutRR_OS(newptr, &m->omsg.h.numAdditionals, &rr->resrec);
2880 rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet; // Make sure to clear cache flush bit back to normal state
2881 if (newptr)
2882 {
2883 responseptr = newptr;
2884 rr->ImmedAdditional = mDNSNULL;
2885 rr->RequireGoodbye = mDNStrue;
2886 // If we successfully put this additional record in the packet, we record LastMCTime & LastMCInterface.
2887 // This matters particularly in the case where we have more than one IPv6 (or IPv4) address, because otherwise,
2888 // when we see our own multicast with the cache flush bit set, if we haven't set LastMCTime, then we'll get
2889 // all concerned and re-announce our record again to make sure it doesn't get flushed from peer caches.
2890 rr->LastMCTime = m->timenow;
2891 rr->LastMCInterface = intf->InterfaceID;
2892 }
2893 }
2894 }
2895
2896 // Third Pass. Add NSEC records, if there's space.
2897 // When we're generating an NSEC record in response to a specify query for that type
2898 // (recognized by rr->SendNSECNow == intf->InterfaceID) we should really put the NSEC in the Answer Section,
2899 // not Additional Section, but for now it's easier to handle both cases in this Additional Section loop here.
2900 for (rr = m->ResourceRecords; rr; rr=rr->next)
2901 if (rr->SendNSECNow == mDNSInterfaceMark || rr->SendNSECNow == intf->InterfaceID)
2902 {
2903 AuthRecord nsec;
2904 mDNSu8 *ptr;
2905 int len;
2906 mDNS_SetupResourceRecord(&nsec, mDNSNULL, mDNSInterface_Any, kDNSType_NSEC, rr->resrec.rroriginalttl, kDNSRecordTypeUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
2907 nsec.resrec.rrclass |= kDNSClass_UniqueRRSet;
2908 AssignDomainName(&nsec.namestorage, rr->resrec.name);
2909 ptr = nsec.rdatastorage.u.data;
2910 len = DomainNameLength(rr->resrec.name);
2911 // We have a nxt name followed by window number, window length and a window bitmap
2912 nsec.resrec.rdlength = len + 2 + NSEC_MCAST_WINDOW_SIZE;
2913 if (nsec.resrec.rdlength <= StandardAuthRDSize)
2914 {
2915 mDNSPlatformMemZero(ptr, nsec.resrec.rdlength);
2916 AssignDomainName((domainname *)ptr, rr->resrec.name);
2917 ptr += len;
2918 *ptr++ = 0; // window number
2919 *ptr++ = NSEC_MCAST_WINDOW_SIZE; // window length
2920 for (r2 = m->ResourceRecords; r2; r2=r2->next)
2921 if (ResourceRecordIsValidAnswer(r2) && SameResourceRecordNameClassInterface(r2, rr))
2922 {
2923 if (r2->resrec.rrtype >= kDNSQType_ANY) { LogMsg("SendResponses: Can't create NSEC for record %s", ARDisplayString(m, r2)); break; }
2924 else ptr[r2->resrec.rrtype >> 3] |= 128 >> (r2->resrec.rrtype & 7);
2925 }
2926 newptr = responseptr;
2927 if (!r2) // If we successfully built our NSEC record, add it to the packet now
2928 {
2929 newptr = PutRR_OS(responseptr, &m->omsg.h.numAdditionals, &nsec.resrec);
2930 if (newptr) responseptr = newptr;
2931 }
2932 }
2933 else LogMsg("SendResponses: not enough space (%d) in authrecord for nsec", nsec.resrec.rdlength);
2934
2935 // If we successfully put the NSEC record, clear the SendNSECNow flag
2936 // If we consider this NSEC optional, then we unconditionally clear the SendNSECNow flag, even if we fail to put this additional record
2937 if (newptr || rr->SendNSECNow == mDNSInterfaceMark)
2938 {
2939 rr->SendNSECNow = mDNSNULL;
2940 // Run through remainder of list clearing SendNSECNow flag for all other records which would generate the same NSEC
2941 for (r2 = rr->next; r2; r2=r2->next)
2942 if (SameResourceRecordNameClassInterface(r2, rr))
2943 if (r2->SendNSECNow == mDNSInterfaceMark || r2->SendNSECNow == intf->InterfaceID)
2944 r2->SendNSECNow = mDNSNULL;
2945 }
2946 }
2947
2948 if (m->omsg.h.numAnswers || m->omsg.h.numAdditionals)
2949 {
2950 // If we have data to send, add OWNER/TRACER/OWNER+TRACER option if necessary, then send packet
2951 if (OwnerRecordSpace || TraceRecordSpace)
2952 {
2953 AuthRecord opt;
2954 mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
2955 opt.resrec.rrclass = NormalMaxDNSMessageData;
2956 opt.resrec.rdlength = sizeof(rdataOPT);
2957 opt.resrec.rdestimate = sizeof(rdataOPT);
2958 if (OwnerRecordSpace && TraceRecordSpace)
2959 {
2960 opt.resrec.rdlength += sizeof(rdataOPT); // Two options in this OPT record
2961 opt.resrec.rdestimate += sizeof(rdataOPT);
2962 SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
2963 SetupTracerOpt(m, &opt.resrec.rdata->u.opt[1]);
2964 }
2965 else if (OwnerRecordSpace)
2966 {
2967 SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
2968 }
2969 else if (TraceRecordSpace)
2970 {
2971 SetupTracerOpt(m, &opt.resrec.rdata->u.opt[0]);
2972 }
2973 newptr = PutResourceRecord(&m->omsg, responseptr, &m->omsg.h.numAdditionals, &opt.resrec);
2974 if (newptr)
2975 {
2976 responseptr = newptr;
2977 }
2978 else if (m->omsg.h.numAnswers + m->omsg.h.numAuthorities + m->omsg.h.numAdditionals == 1)
2979 {
2980 LogInfo("SendResponses: No space in packet for %s %s OPT record (%d/%d/%d/%d) %s", OwnerRecordSpace ? "OWNER" : "", TraceRecordSpace ? "TRACER" : "",
2981 m->omsg.h.numQuestions, m->omsg.h.numAnswers, m->omsg.h.numAuthorities, m->omsg.h.numAdditionals, ARDisplayString(m, &opt));
2982 }
2983 else
2984 {
2985 LogMsg("SendResponses: How did we fail to have space for %s %s OPT record (%d/%d/%d/%d) %s", OwnerRecordSpace ? "OWNER" : "", TraceRecordSpace ? "TRACER" : "",
2986 m->omsg.h.numQuestions, m->omsg.h.numAnswers, m->omsg.h.numAuthorities, m->omsg.h.numAdditionals, ARDisplayString(m, &opt));
2987 }
2988 }
2989
2990 debugf("SendResponses: Sending %d Deregistration%s, %d Announcement%s, %d Answer%s, %d Additional%s on %p",
2991 numDereg, numDereg == 1 ? "" : "s",
2992 numAnnounce, numAnnounce == 1 ? "" : "s",
2993 numAnswer, numAnswer == 1 ? "" : "s",
2994 m->omsg.h.numAdditionals, m->omsg.h.numAdditionals == 1 ? "" : "s", intf->InterfaceID);
2995
2996 if (intf->IPv4Available) mDNSSendDNSMessage(m, &m->omsg, responseptr, intf->InterfaceID, mDNSNULL, &AllDNSLinkGroup_v4, MulticastDNSPort, mDNSNULL, mDNSNULL, mDNSfalse);
2997 if (intf->IPv6Available) mDNSSendDNSMessage(m, &m->omsg, responseptr, intf->InterfaceID, mDNSNULL, &AllDNSLinkGroup_v6, MulticastDNSPort, mDNSNULL, mDNSNULL, mDNSfalse);
2998 if (!m->SuppressSending) m->SuppressSending = NonZeroTime(m->timenow + (mDNSPlatformOneSecond+9)/10);
2999 if (++pktcount >= 1000) { LogMsg("SendResponses exceeded loop limit %d: giving up", pktcount); break; }
3000 // There might be more things to send on this interface, so go around one more time and try again.
3001 }
3002 else // Nothing more to send on this interface; go to next
3003 {
3004 const NetworkInterfaceInfo *next = GetFirstActiveInterface(intf->next);
3005 #if MDNS_DEBUGMSGS && 0
3006 const char *const msg = next ? "SendResponses: Nothing more on %p; moving to %p" : "SendResponses: Nothing more on %p";
3007 debugf(msg, intf, next);
3008 #endif
3009 intf = next;
3010 pktcount = 0; // When we move to a new interface, reset packet count back to zero -- NSEC generation logic uses it
3011 }
3012 }
3013
3014 // ***
3015 // *** 3. Cleanup: Now that everything is sent, call client callback functions, and reset state variables
3016 // ***
3017
3018 if (m->CurrentRecord)
3019 LogMsg("SendResponses ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
3020 m->CurrentRecord = m->ResourceRecords;
3021 while (m->CurrentRecord)
3022 {
3023 rr = m->CurrentRecord;
3024 m->CurrentRecord = rr->next;
3025
3026 if (rr->SendRNow)
3027 {
3028 if (rr->ARType != AuthRecordLocalOnly && rr->ARType != AuthRecordP2P)
3029 LogInfo("SendResponses: No active interface %d to send: %d %02X %s",
3030 (uint32_t)rr->SendRNow, (uint32_t)rr->resrec.InterfaceID, rr->resrec.RecordType, ARDisplayString(m, rr));
3031 rr->SendRNow = mDNSNULL;
3032 }
3033
3034 if (rr->ImmedAnswer || rr->resrec.RecordType == kDNSRecordTypeDeregistering)
3035 {
3036 if (rr->NewRData) CompleteRDataUpdate(m, rr); // Update our rdata, clear the NewRData pointer, and return memory to the client
3037
3038 if (rr->resrec.RecordType == kDNSRecordTypeDeregistering && rr->AnnounceCount == 0)
3039 {
3040 // For Unicast, when we get the response from the server, we will call CompleteDeregistration
3041 if (!AuthRecord_uDNS(rr)) CompleteDeregistration(m, rr); // Don't touch rr after this
3042 }
3043 else
3044 {
3045 rr->ImmedAnswer = mDNSNULL;
3046 rr->ImmedUnicast = mDNSfalse;
3047 rr->v4Requester = zerov4Addr;
3048 rr->v6Requester = zerov6Addr;
3049 }
3050 }
3051 }
3052 verbosedebugf("SendResponses: Next in %ld ticks", m->NextScheduledResponse - m->timenow);
3053 }
3054
3055 // Calling CheckCacheExpiration() is an expensive operation because it has to look at the entire cache,
3056 // so we want to be lazy about how frequently we do it.
3057 // 1. If a cache record is currently referenced by *no* active questions,
3058 // then we don't mind expiring it up to a minute late (who will know?)
3059 // 2. Else, if a cache record is due for some of its final expiration queries,
3060 // we'll allow them to be late by up to 2% of the TTL
3061 // 3. Else, if a cache record has completed all its final expiration queries without success,
3062 // and is expiring, and had an original TTL more than ten seconds, we'll allow it to be one second late
3063 // 4. Else, it is expiring and had an original TTL of ten seconds or less (includes explicit goodbye packets),
3064 // so allow at most 1/10 second lateness
3065 // 5. For records with rroriginalttl set to zero, that means we really want to delete them immediately
3066 // (we have a new record with DelayDelivery set, waiting for the old record to go away before we can notify clients).
3067 #define CacheCheckGracePeriod(RR) ( \
3068 ((RR)->CRActiveQuestion == mDNSNULL ) ? (60 * mDNSPlatformOneSecond) : \
3069 ((RR)->UnansweredQueries < MaxUnansweredQueries) ? (TicksTTL(rr)/50) : \
3070 ((RR)->resrec.rroriginalttl > 10 ) ? (mDNSPlatformOneSecond) : \
3071 ((RR)->resrec.rroriginalttl > 0 ) ? (mDNSPlatformOneSecond/10) : 0)
3072
3073 #define NextCacheCheckEvent(RR) ((RR)->NextRequiredQuery + CacheCheckGracePeriod(RR))
3074
3075 mDNSexport void ScheduleNextCacheCheckTime(mDNS *const m, const mDNSu32 slot, const mDNSs32 event)
3076 {
3077 if (m->rrcache_nextcheck[slot] - event > 0)
3078 m->rrcache_nextcheck[slot] = event;
3079 if (m->NextCacheCheck - event > 0)
3080 m->NextCacheCheck = event;
3081 }
3082
3083 // Note: MUST call SetNextCacheCheckTimeForRecord any time we change:
3084 // rr->TimeRcvd
3085 // rr->resrec.rroriginalttl
3086 // rr->UnansweredQueries
3087 // rr->CRActiveQuestion
3088 mDNSexport void SetNextCacheCheckTimeForRecord(mDNS *const m, CacheRecord *const rr)
3089 {
3090 rr->NextRequiredQuery = RRExpireTime(rr);
3091
3092 // If we have an active question, then see if we want to schedule a refresher query for this record.
3093 // Usually we expect to do four queries, at 80-82%, 85-87%, 90-92% and then 95-97% of the TTL.
3094 if (rr->CRActiveQuestion && rr->UnansweredQueries < MaxUnansweredQueries)
3095 {
3096 rr->NextRequiredQuery -= TicksTTL(rr)/20 * (MaxUnansweredQueries - rr->UnansweredQueries);
3097 rr->NextRequiredQuery += mDNSRandom((mDNSu32)TicksTTL(rr)/50);
3098 verbosedebugf("SetNextCacheCheckTimeForRecord: NextRequiredQuery in %ld sec CacheCheckGracePeriod %d ticks for %s",
3099 (rr->NextRequiredQuery - m->timenow) / mDNSPlatformOneSecond, CacheCheckGracePeriod(rr), CRDisplayString(m,rr));
3100 }
3101 ScheduleNextCacheCheckTime(m, HashSlotFromNameHash(rr->resrec.namehash), NextCacheCheckEvent(rr));
3102 }
3103
3104 #define kMinimumReconfirmTime ((mDNSu32)mDNSPlatformOneSecond * 5)
3105 #define kDefaultReconfirmTimeForWake ((mDNSu32)mDNSPlatformOneSecond * 5)
3106 #define kDefaultReconfirmTimeForNoAnswer ((mDNSu32)mDNSPlatformOneSecond * 5)
3107
3108 // Delay before restarting questions on a flapping interface.
3109 #define kDefaultQueryDelayTimeForFlappingInterface ((mDNSu32)mDNSPlatformOneSecond * 3)
3110 // After kDefaultQueryDelayTimeForFlappingInterface seconds, allow enough time for up to three queries (0, 1, and 4 seconds)
3111 // plus three seconds for "response delay" before removing the reconfirmed records from the cache.
3112 #define kDefaultReconfirmTimeForFlappingInterface (kDefaultQueryDelayTimeForFlappingInterface + ((mDNSu32)mDNSPlatformOneSecond * 7))
3113
3114 mDNSexport mStatus mDNS_Reconfirm_internal(mDNS *const m, CacheRecord *const rr, mDNSu32 interval)
3115 {
3116 if (interval < kMinimumReconfirmTime)
3117 interval = kMinimumReconfirmTime;
3118 if (interval > 0x10000000) // Make sure interval doesn't overflow when we multiply by four below
3119 interval = 0x10000000;
3120
3121 // If the expected expiration time for this record is more than interval+33%, then accelerate its expiration
3122 if (RRExpireTime(rr) - m->timenow > (mDNSs32)((interval * 4) / 3))
3123 {
3124 // Add a 33% random amount to the interval, to avoid synchronization between multiple hosts
3125 // For all the reconfirmations in a given batch, we want to use the same random value
3126 // so that the reconfirmation questions can be grouped into a single query packet
3127 if (!m->RandomReconfirmDelay) m->RandomReconfirmDelay = 1 + mDNSRandom(FutureTime);
3128 interval += m->RandomReconfirmDelay % ((interval/3) + 1);
3129 rr->TimeRcvd = m->timenow - (mDNSs32)interval * 3;
3130 rr->resrec.rroriginalttl = (interval * 4 + mDNSPlatformOneSecond - 1) / mDNSPlatformOneSecond;
3131 SetNextCacheCheckTimeForRecord(m, rr);
3132 }
3133 debugf("mDNS_Reconfirm_internal:%6ld ticks to go for %s %p",
3134 RRExpireTime(rr) - m->timenow, CRDisplayString(m, rr), rr->CRActiveQuestion);
3135 return(mStatus_NoError);
3136 }
3137
3138 // BuildQuestion puts a question into a DNS Query packet and if successful, updates the value of queryptr.
3139 // It also appends to the list of known answer records that need to be included,
3140 // and updates the forcast for the size of the known answer section.
3141 mDNSlocal mDNSBool BuildQuestion(mDNS *const m, const NetworkInterfaceInfo *intf, DNSMessage *query, mDNSu8 **queryptr,
3142 DNSQuestion *q, CacheRecord ***kalistptrptr, mDNSu32 *answerforecast)
3143 {
3144 mDNSBool ucast = (q->LargeAnswers || q->RequestUnicast) && m->CanReceiveUnicastOn5353 && intf->SupportsUnicastMDNSResponse;
3145 mDNSu16 ucbit = (mDNSu16)(ucast ? kDNSQClass_UnicastResponse : 0);
3146 const mDNSu8 *const limit = query->data + NormalMaxDNSMessageData;
3147 mDNSu8 anoninfo_space = q->AnonInfo ? AnonInfoSpace(q->AnonInfo) : 0;
3148 mDNSu8 *newptr = putQuestion(query, *queryptr, limit - *answerforecast - anoninfo_space, &q->qname, q->qtype, (mDNSu16)(q->qclass | ucbit));
3149 if (!newptr)
3150 {
3151 debugf("BuildQuestion: No more space in this packet for question %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
3152 return(mDNSfalse);
3153 }
3154 else
3155 {
3156 mDNSu32 forecast = *answerforecast + anoninfo_space;
3157 const CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
3158 CacheRecord *rr;
3159 CacheRecord **ka = *kalistptrptr; // Make a working copy of the pointer we're going to update
3160
3161 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next) // If we have a resource record in our cache,
3162 if (rr->resrec.InterfaceID == q->SendQNow && // received on this interface
3163 !(rr->resrec.RecordType & kDNSRecordTypeUniqueMask) && // which is a shared (i.e. not unique) record type
3164 rr->NextInKAList == mDNSNULL && ka != &rr->NextInKAList && // which is not already in the known answer list
3165 rr->resrec.rdlength <= SmallRecordLimit && // which is small enough to sensibly fit in the packet
3166 SameNameRecordAnswersQuestion(&rr->resrec, q) && // which answers our question
3167 rr->TimeRcvd + TicksTTL(rr)/2 - m->timenow > // and its half-way-to-expiry time is at least 1 second away
3168 mDNSPlatformOneSecond) // (also ensures we never include goodbye records with TTL=1)
3169 {
3170 // We don't want to include unique records in the Known Answer section. The Known Answer section
3171 // is intended to suppress floods of shared-record replies from many other devices on the network.
3172 // That concept really does not apply to unique records, and indeed if we do send a query for
3173 // which we have a unique record already in our cache, then including that unique record as a
3174 // Known Answer, so as to suppress the only answer we were expecting to get, makes little sense.
3175
3176 *ka = rr; // Link this record into our known answer chain
3177 ka = &rr->NextInKAList;
3178 // We forecast: compressed name (2) type (2) class (2) TTL (4) rdlength (2) rdata (n)
3179 forecast += 12 + rr->resrec.rdestimate;
3180 // If we're trying to put more than one question in this packet, and it doesn't fit
3181 // then undo that last question and try again next time
3182 if (query->h.numQuestions > 1 && newptr + forecast >= limit)
3183 {
3184 query->h.numQuestions--;
3185 debugf("BuildQuestion: Retracting question %##s (%s) new forecast total %d, total questions %d",
3186 q->qname.c, DNSTypeName(q->qtype), newptr + forecast - query->data, query->h.numQuestions);
3187 ka = *kalistptrptr; // Go back to where we started and retract these answer records
3188 while (*ka) { CacheRecord *c = *ka; *ka = mDNSNULL; ka = &c->NextInKAList; }
3189 return(mDNSfalse); // Return false, so we'll try again in the next packet
3190 }
3191 }
3192
3193 // Success! Update our state pointers, increment UnansweredQueries as appropriate, and return
3194 *queryptr = newptr; // Update the packet pointer
3195 *answerforecast = forecast; // Update the forecast
3196 *kalistptrptr = ka; // Update the known answer list pointer
3197 if (ucast) q->ExpectUnicastResp = NonZeroTime(m->timenow);
3198
3199 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next) // For every resource record in our cache,
3200 if (rr->resrec.InterfaceID == q->SendQNow && // received on this interface
3201 rr->NextInKAList == mDNSNULL && ka != &rr->NextInKAList && // which is not in the known answer list
3202 SameNameRecordAnswersQuestion(&rr->resrec, q)) // which answers our question
3203 {
3204 rr->UnansweredQueries++; // indicate that we're expecting a response
3205 rr->LastUnansweredTime = m->timenow;
3206 SetNextCacheCheckTimeForRecord(m, rr);
3207 }
3208
3209 return(mDNStrue);
3210 }
3211 }
3212
3213 // When we have a query looking for a specified name, but there appear to be no answers with
3214 // that name, ReconfirmAntecedents() is called with depth=0 to start the reconfirmation process
3215 // for any records in our cache that reference the given name (e.g. PTR and SRV records).
3216 // For any such cache record we find, we also recursively call ReconfirmAntecedents() for *its* name.
3217 // We increment depth each time we recurse, to guard against possible infinite loops, with a limit of 5.
3218 // A typical reconfirmation scenario might go like this:
3219 // Depth 0: Name "myhost.local" has no address records
3220 // Depth 1: SRV "My Service._example._tcp.local." refers to "myhost.local"; may be stale
3221 // Depth 2: PTR "_example._tcp.local." refers to "My Service"; may be stale
3222 // Depth 3: PTR "_services._dns-sd._udp.local." refers to "_example._tcp.local."; may be stale
3223 // Currently depths 4 and 5 are not expected to occur; if we did get to depth 5 we'd reconfim any records we
3224 // found referring to the given name, but not recursively descend any further reconfirm *their* antecedents.
3225 mDNSlocal void ReconfirmAntecedents(mDNS *const m, const domainname *const name, const mDNSu32 namehash, const mDNSInterfaceID InterfaceID, const int depth)
3226 {
3227 mDNSu32 slot;
3228 const CacheGroup *cg;
3229 CacheRecord *cr;
3230 debugf("ReconfirmAntecedents (depth=%d) for %##s", depth, name->c);
3231 if (!InterfaceID) return; // mDNS records have a non-zero InterfaceID. If InterfaceID is 0, then there's nothing to do.
3232 FORALL_CACHERECORDS(slot, cg, cr)
3233 {
3234 const domainname *crtarget;
3235 if (cr->resrec.InterfaceID != InterfaceID) continue; // Skip non-mDNS records and mDNS records from other interfaces.
3236 if (cr->resrec.rdatahash != namehash) continue; // Skip records whose rdata hash doesn't match the name hash.
3237 crtarget = GetRRDomainNameTarget(&cr->resrec);
3238 if (crtarget && SameDomainName(crtarget, name))
3239 {
3240 LogInfo("ReconfirmAntecedents: Reconfirming (depth=%d, InterfaceID=%p) %s", depth, InterfaceID, CRDisplayString(m, cr));
3241 mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
3242 if (depth < 5)
3243 ReconfirmAntecedents(m, cr->resrec.name, cr->resrec.namehash, InterfaceID, depth+1);
3244 }
3245 }
3246 }
3247
3248 // If we get no answer for a AAAA query, then before doing an automatic implicit ReconfirmAntecedents
3249 // we check if we have an address record for the same name. If we do have an IPv4 address for a given
3250 // name but not an IPv6 address, that's okay (it just means the device doesn't do IPv6) so the failure
3251 // to get a AAAA response is not grounds to doubt the PTR/SRV chain that lead us to that name.
3252 mDNSlocal const CacheRecord *CacheHasAddressTypeForName(mDNS *const m, const domainname *const name, const mDNSu32 namehash)
3253 {
3254 CacheGroup *const cg = CacheGroupForName(m, namehash, name);
3255 const CacheRecord *cr = cg ? cg->members : mDNSNULL;
3256 while (cr && !RRTypeIsAddressType(cr->resrec.rrtype)) cr=cr->next;
3257 return(cr);
3258 }
3259
3260
3261 mDNSlocal const CacheRecord *FindSPSInCache1(mDNS *const m, const DNSQuestion *const q, const CacheRecord *const c0, const CacheRecord *const c1)
3262 {
3263 #ifndef SPC_DISABLED
3264 CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
3265 const CacheRecord *cr, *bestcr = mDNSNULL;
3266 mDNSu32 bestmetric = 1000000;
3267 for (cr = cg ? cg->members : mDNSNULL; cr; cr=cr->next)
3268 if (cr->resrec.rrtype == kDNSType_PTR && cr->resrec.rdlength >= 6) // If record is PTR type, with long enough name,
3269 if (cr != c0 && cr != c1) // that's not one we've seen before,
3270 if (SameNameRecordAnswersQuestion(&cr->resrec, q)) // and answers our browse query,
3271 if (!IdenticalSameNameRecord(&cr->resrec, &m->SPSRecords.RR_PTR.resrec)) // and is not our own advertised service...
3272 {
3273 mDNSu32 metric = SPSMetric(cr->resrec.rdata->u.name.c);
3274 if (bestmetric > metric) { bestmetric = metric; bestcr = cr; }
3275 }
3276 return(bestcr);
3277 #else // SPC_DISABLED
3278 (void) m;
3279 (void) q;
3280 (void) c0;
3281 (void) c1;
3282 (void) c1;
3283 return mDNSNULL;
3284 #endif // SPC_DISABLED
3285 }
3286
3287 mDNSlocal void CheckAndSwapSPS(const CacheRecord **sps1, const CacheRecord **sps2)
3288 {
3289 const CacheRecord *swap_sps;
3290 mDNSu32 metric1, metric2;
3291
3292 if (!(*sps1) || !(*sps2)) return;
3293 metric1 = SPSMetric((*sps1)->resrec.rdata->u.name.c);
3294 metric2 = SPSMetric((*sps2)->resrec.rdata->u.name.c);
3295 if (!SPSFeatures((*sps1)->resrec.rdata->u.name.c) && SPSFeatures((*sps2)->resrec.rdata->u.name.c) && (metric2 >= metric1))
3296 {
3297 swap_sps = *sps1;
3298 *sps1 = *sps2;
3299 *sps2 = swap_sps;
3300 }
3301 }
3302
3303 mDNSlocal void ReorderSPSByFeature(const CacheRecord *sps[3])
3304 {
3305 CheckAndSwapSPS(&sps[0], &sps[1]);
3306 CheckAndSwapSPS(&sps[0], &sps[2]);
3307 CheckAndSwapSPS(&sps[1], &sps[2]);
3308 }
3309
3310
3311 // Finds the three best Sleep Proxies we currently have in our cache
3312 mDNSexport void FindSPSInCache(mDNS *const m, const DNSQuestion *const q, const CacheRecord *sps[3])
3313 {
3314 sps[0] = FindSPSInCache1(m, q, mDNSNULL, mDNSNULL);
3315 sps[1] = !sps[0] ? mDNSNULL : FindSPSInCache1(m, q, sps[0], mDNSNULL);
3316 sps[2] = !sps[1] ? mDNSNULL : FindSPSInCache1(m, q, sps[0], sps[1]);
3317
3318 // SPS is already sorted by metric. We want to move the entries to the beginning of the array
3319 // only if they have equally good metric and support features.
3320 ReorderSPSByFeature(sps);
3321 }
3322
3323 // Only DupSuppressInfos newer than the specified 'time' are allowed to remain active
3324 mDNSlocal void ExpireDupSuppressInfo(DupSuppressInfo ds[DupSuppressInfoSize], mDNSs32 time)
3325 {
3326 int i;
3327 for (i=0; i<DupSuppressInfoSize; i++) if (ds[i].Time - time < 0) ds[i].InterfaceID = mDNSNULL;
3328 }
3329
3330 mDNSlocal void ExpireDupSuppressInfoOnInterface(DupSuppressInfo ds[DupSuppressInfoSize], mDNSs32 time, mDNSInterfaceID InterfaceID)
3331 {
3332 int i;
3333 for (i=0; i<DupSuppressInfoSize; i++) if (ds[i].InterfaceID == InterfaceID && ds[i].Time - time < 0) ds[i].InterfaceID = mDNSNULL;
3334 }
3335
3336 mDNSlocal mDNSBool SuppressOnThisInterface(const DupSuppressInfo ds[DupSuppressInfoSize], const NetworkInterfaceInfo * const intf)
3337 {
3338 int i;
3339 mDNSBool v4 = !intf->IPv4Available; // If this interface doesn't do v4, we don't need to find a v4 duplicate of this query
3340 mDNSBool v6 = !intf->IPv6Available; // If this interface doesn't do v6, we don't need to find a v6 duplicate of this query
3341 for (i=0; i<DupSuppressInfoSize; i++)
3342 if (ds[i].InterfaceID == intf->InterfaceID)
3343 {
3344 if (ds[i].Type == mDNSAddrType_IPv4) v4 = mDNStrue;
3345 else if (ds[i].Type == mDNSAddrType_IPv6) v6 = mDNStrue;
3346 if (v4 && v6) return(mDNStrue);
3347 }
3348 return(mDNSfalse);
3349 }
3350
3351 mDNSlocal void RecordDupSuppressInfo(DupSuppressInfo ds[DupSuppressInfoSize], mDNSs32 Time, mDNSInterfaceID InterfaceID, mDNSs32 Type)
3352 {
3353 int i, j;
3354
3355 // See if we have this one in our list somewhere already
3356 for (i=0; i<DupSuppressInfoSize; i++) if (ds[i].InterfaceID == InterfaceID && ds[i].Type == Type) break;
3357
3358 // If not, find a slot we can re-use
3359 if (i >= DupSuppressInfoSize)
3360 {
3361 i = 0;
3362 for (j=1; j<DupSuppressInfoSize && ds[i].InterfaceID; j++)
3363 if (!ds[j].InterfaceID || ds[j].Time - ds[i].Time < 0)
3364 i = j;
3365 }
3366
3367 // Record the info about this query we saw
3368 ds[i].Time = Time;
3369 ds[i].InterfaceID = InterfaceID;
3370 ds[i].Type = Type;
3371 }
3372
3373 mDNSlocal void mDNSSendWakeOnResolve(mDNS *const m, DNSQuestion *q)
3374 {
3375 int len, i, cnt;
3376 mDNSInterfaceID InterfaceID = q->InterfaceID;
3377 domainname *d = &q->qname;
3378
3379 // We can't send magic packets without knowing which interface to send it on.
3380 if (InterfaceID == mDNSInterface_Any || LocalOnlyOrP2PInterface(InterfaceID))
3381 {
3382 LogMsg("mDNSSendWakeOnResolve: ERROR!! Invalid InterfaceID %p for question %##s", InterfaceID, q->qname.c);
3383 return;
3384 }
3385
3386 // Split MAC@IPAddress and pass them separately
3387 len = d->c[0];
3388 cnt = 0;
3389 for (i = 1; i < len; i++)
3390 {
3391 if (d->c[i] == '@')
3392 {
3393 char EthAddr[18]; // ethernet adddress : 12 bytes + 5 ":" + 1 NULL byte
3394 char IPAddr[47]; // Max IP address len: 46 bytes (IPv6) + 1 NULL byte
3395 if (cnt != 5)
3396 {
3397 LogMsg("mDNSSendWakeOnResolve: ERROR!! Malformed Ethernet address %##s, cnt %d", q->qname.c, cnt);
3398 return;
3399 }
3400 if ((i - 1) > (int) (sizeof(EthAddr) - 1))
3401 {
3402 LogMsg("mDNSSendWakeOnResolve: ERROR!! Malformed Ethernet address %##s, length %d", q->qname.c, i - 1);
3403 return;
3404 }
3405 if ((len - i) > (int)(sizeof(IPAddr) - 1))
3406 {
3407 LogMsg("mDNSSendWakeOnResolve: ERROR!! Malformed IP address %##s, length %d", q->qname.c, len - i);
3408 return;
3409 }
3410 mDNSPlatformMemCopy(EthAddr, &d->c[1], i - 1);
3411 EthAddr[i - 1] = 0;
3412 mDNSPlatformMemCopy(IPAddr, &d->c[i + 1], len - i);
3413 IPAddr[len - i] = 0;
3414 m->mDNSStats.WakeOnResolves++;
3415 mDNSPlatformSendWakeupPacket(InterfaceID, EthAddr, IPAddr, InitialWakeOnResolveCount - q->WakeOnResolveCount);
3416 return;
3417 }
3418 else if (d->c[i] == ':')
3419 cnt++;
3420 }
3421 LogMsg("mDNSSendWakeOnResolve: ERROR!! Malformed WakeOnResolve name %##s", q->qname.c);
3422 }
3423
3424
3425 mDNSlocal mDNSBool AccelerateThisQuery(mDNS *const m, DNSQuestion *q)
3426 {
3427 // If more than 90% of the way to the query time, we should unconditionally accelerate it
3428 if (TimeToSendThisQuestion(q, m->timenow + q->ThisQInterval/10))
3429 return(mDNStrue);
3430
3431 // If half-way to next scheduled query time, only accelerate if it will add less than 512 bytes to the packet
3432 if (TimeToSendThisQuestion(q, m->timenow + q->ThisQInterval/2))
3433 {
3434 // We forecast: qname (n) type (2) class (2)
3435 mDNSu32 forecast = (mDNSu32)DomainNameLength(&q->qname) + 4;
3436 const CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
3437 const CacheRecord *rr;
3438 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next) // If we have a resource record in our cache,
3439 if (rr->resrec.rdlength <= SmallRecordLimit && // which is small enough to sensibly fit in the packet
3440 SameNameRecordAnswersQuestion(&rr->resrec, q) && // which answers our question
3441 rr->TimeRcvd + TicksTTL(rr)/2 - m->timenow >= 0 && // and it is less than half-way to expiry
3442 rr->NextRequiredQuery - (m->timenow + q->ThisQInterval) > 0) // and we'll ask at least once again before NextRequiredQuery
3443 {
3444 // We forecast: compressed name (2) type (2) class (2) TTL (4) rdlength (2) rdata (n)
3445 forecast += 12 + rr->resrec.rdestimate;
3446 if (forecast >= 512) return(mDNSfalse); // If this would add 512 bytes or more to the packet, don't accelerate
3447 }
3448 return(mDNStrue);
3449 }
3450
3451 return(mDNSfalse);
3452 }
3453
3454 // How Standard Queries are generated:
3455 // 1. The Question Section contains the question
3456 // 2. The Additional Section contains answers we already know, to suppress duplicate responses
3457
3458 // How Probe Queries are generated:
3459 // 1. The Question Section contains queries for the name we intend to use, with QType=ANY because
3460 // if some other host is already using *any* records with this name, we want to know about it.
3461 // 2. The Authority Section contains the proposed values we intend to use for one or more
3462 // of our records with that name (analogous to the Update section of DNS Update packets)
3463 // because if some other host is probing at the same time, we each want to know what the other is
3464 // planning, in order to apply the tie-breaking rule to see who gets to use the name and who doesn't.
3465
3466 mDNSlocal void SendQueries(mDNS *const m)
3467 {
3468 mDNSu32 slot;
3469 CacheGroup *cg;
3470 CacheRecord *cr;
3471 AuthRecord *ar;
3472 int pktcount = 0;
3473 DNSQuestion *q;
3474 // For explanation of maxExistingQuestionInterval logic, see comments for maxExistingAnnounceInterval
3475 mDNSs32 maxExistingQuestionInterval = 0;
3476 const NetworkInterfaceInfo *intf = GetFirstActiveInterface(m->HostInterfaces);
3477 CacheRecord *KnownAnswerList = mDNSNULL;
3478
3479 // 1. If time for a query, work out what we need to do
3480
3481 // We're expecting to send a query anyway, so see if any expiring cache records are close enough
3482 // to their NextRequiredQuery to be worth batching them together with this one
3483 FORALL_CACHERECORDS(slot, cg, cr)
3484 {
3485 if (cr->CRActiveQuestion && cr->UnansweredQueries < MaxUnansweredQueries)
3486 {
3487 if (m->timenow + TicksTTL(cr)/50 - cr->NextRequiredQuery >= 0)
3488 {
3489 debugf("Sending %d%% cache expiration query for %s", 80 + 5 * cr->UnansweredQueries, CRDisplayString(m, cr));
3490 q = cr->CRActiveQuestion;
3491 ExpireDupSuppressInfoOnInterface(q->DupSuppress, m->timenow - TicksTTL(cr)/20, cr->resrec.InterfaceID);
3492 // For uDNS queries (TargetQID non-zero) we adjust LastQTime,
3493 // and bump UnansweredQueries so that we don't spin trying to send the same cache expiration query repeatedly
3494 if (q->Target.type)
3495 {
3496 q->SendQNow = mDNSInterfaceMark; // If targeted query, mark it
3497 }
3498 else if (!mDNSOpaque16IsZero(q->TargetQID))
3499 {
3500 q->LastQTime = m->timenow - q->ThisQInterval;
3501 cr->UnansweredQueries++;
3502 m->mDNSStats.CacheRefreshQueries++;
3503 }
3504 else if (q->SendQNow == mDNSNULL)
3505 {
3506 q->SendQNow = cr->resrec.InterfaceID;
3507 }
3508 else if (q->SendQNow != cr->resrec.InterfaceID)
3509 {
3510 q->SendQNow = mDNSInterfaceMark;
3511 }
3512
3513 // Indicate that this question was marked for sending
3514 // to update an existing cached answer record.
3515 // The browse throttling logic below uses this to determine
3516 // if the query should be sent.
3517 if (mDNSOpaque16IsZero(q->TargetQID))
3518 q->CachedAnswerNeedsUpdate = mDNStrue;
3519 }
3520 }
3521 }
3522
3523 // Scan our list of questions to see which:
3524 // *WideArea* queries need to be sent
3525 // *unicast* queries need to be sent
3526 // *multicast* queries we're definitely going to send
3527 if (m->CurrentQuestion)
3528 LogMsg("SendQueries ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
3529 m->CurrentQuestion = m->Questions;
3530 while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
3531 {
3532 q = m->CurrentQuestion;
3533 if (q->Target.type && (q->SendQNow || TimeToSendThisQuestion(q, m->timenow)))
3534 {
3535 mDNSu8 *qptr = m->omsg.data;
3536 const mDNSu8 *const limit = m->omsg.data + sizeof(m->omsg.data);
3537
3538 // If we fail to get a new on-demand socket (should only happen cases of the most extreme resource exhaustion), we'll try again next time
3539 if (!q->LocalSocket) q->LocalSocket = mDNSPlatformUDPSocket(zeroIPPort);
3540 if (q->LocalSocket)
3541 {
3542 InitializeDNSMessage(&m->omsg.h, q->TargetQID, QueryFlags);
3543 qptr = putQuestion(&m->omsg, qptr, limit, &q->qname, q->qtype, q->qclass);
3544 mDNSSendDNSMessage(m, &m->omsg, qptr, mDNSInterface_Any, q->LocalSocket, &q->Target, q->TargetPort, mDNSNULL, mDNSNULL, q->UseBackgroundTrafficClass);
3545 q->ThisQInterval *= QuestionIntervalStep;
3546 }
3547 if (q->ThisQInterval > MaxQuestionInterval)
3548 q->ThisQInterval = MaxQuestionInterval;
3549 q->LastQTime = m->timenow;
3550 q->LastQTxTime = m->timenow;
3551 q->RecentAnswerPkts = 0;
3552 q->SendQNow = mDNSNULL;
3553 q->ExpectUnicastResp = NonZeroTime(m->timenow);
3554 }
3555 else if (mDNSOpaque16IsZero(q->TargetQID) && !q->Target.type && TimeToSendThisQuestion(q, m->timenow))
3556 {
3557 //LogInfo("Time to send %##s (%s) %d", q->qname.c, DNSTypeName(q->qtype), m->timenow - NextQSendTime(q));
3558 q->SendQNow = mDNSInterfaceMark; // Mark this question for sending on all interfaces
3559 if (maxExistingQuestionInterval < q->ThisQInterval)
3560 maxExistingQuestionInterval = q->ThisQInterval;
3561 }
3562 // If m->CurrentQuestion wasn't modified out from under us, advance it now
3563 // We can't do this at the start of the loop because uDNS_CheckCurrentQuestion() depends on having
3564 // m->CurrentQuestion point to the right question
3565 if (q == m->CurrentQuestion) m->CurrentQuestion = m->CurrentQuestion->next;
3566 }
3567 while (m->CurrentQuestion)
3568 {
3569 LogInfo("SendQueries question loop 1: Skipping NewQuestion %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
3570 m->CurrentQuestion = m->CurrentQuestion->next;
3571 }
3572 m->CurrentQuestion = mDNSNULL;
3573
3574 // Scan our list of questions
3575 // (a) to see if there are any more that are worth accelerating, and
3576 // (b) to update the state variables for *all* the questions we're going to send
3577 // Note: Don't set NextScheduledQuery until here, because uDNS_CheckCurrentQuestion in the loop above can add new questions to the list,
3578 // which causes NextScheduledQuery to get (incorrectly) set to m->timenow. Setting it here is the right place, because the very
3579 // next thing we do is scan the list and call SetNextQueryTime() for every question we find, so we know we end up with the right value.
3580 m->NextScheduledQuery = m->timenow + FutureTime;
3581 for (q = m->Questions; q && q != m->NewQuestions; q=q->next)
3582 {
3583 if (mDNSOpaque16IsZero(q->TargetQID)
3584 && (q->SendQNow || (!q->Target.type && ActiveQuestion(q) && q->ThisQInterval <= maxExistingQuestionInterval && AccelerateThisQuery(m,q))))
3585 {
3586 // If at least halfway to next query time, advance to next interval
3587 // If less than halfway to next query time, then
3588 // treat this as logically a repeat of the last transmission, without advancing the interval
3589 if (m->timenow - (q->LastQTime + (q->ThisQInterval/2)) >= 0)
3590 {
3591 // If we have reached the answer threshold for this question,
3592 // don't send it again until MaxQuestionInterval unless:
3593 // one of its cached answers needs to be refreshed,
3594 // or it's the initial query for a kDNSServiceFlagsThresholdFinder mode browse.
3595 if (q->BrowseThreshold
3596 && (q->CurrentAnswers >= q->BrowseThreshold)
3597 && (q->CachedAnswerNeedsUpdate == mDNSfalse)
3598 && !((q->flags & kDNSServiceFlagsThresholdFinder) && (q->ThisQInterval == InitialQuestionInterval)))
3599 {
3600 q->SendQNow = mDNSNULL;
3601 q->ThisQInterval = MaxQuestionInterval;
3602 q->LastQTime = m->timenow;
3603 q->RequestUnicast = 0;
3604 LogInfo("SendQueries: (%s) %##s reached threshold of %d answers",
3605 DNSTypeName(q->qtype), q->qname.c, q->BrowseThreshold);
3606 }
3607 else
3608 {
3609 // Mark this question for sending on all interfaces
3610 q->SendQNow = mDNSInterfaceMark;
3611 q->ThisQInterval *= QuestionIntervalStep;
3612 }
3613
3614 debugf("SendQueries: %##s (%s) next interval %d seconds RequestUnicast = %d",
3615 q->qname.c, DNSTypeName(q->qtype), q->ThisQInterval / InitialQuestionInterval, q->RequestUnicast);
3616
3617 if (q->ThisQInterval > MaxQuestionInterval)
3618 {
3619 q->ThisQInterval = MaxQuestionInterval;
3620 }
3621 else if (mDNSOpaque16IsZero(q->TargetQID) && q->InterfaceID &&
3622 q->CurrentAnswers == 0 && q->ThisQInterval == InitialQuestionInterval * QuestionIntervalStep3 && !q->RequestUnicast &&
3623 !(RRTypeIsAddressType(q->qtype) && CacheHasAddressTypeForName(m, &q->qname, q->qnamehash)))
3624 {
3625 // Generally don't need to log this.
3626 // It's not especially noteworthy if a query finds no results -- this usually happens for domain
3627 // enumeration queries in the LL subdomain (e.g. "db._dns-sd._udp.0.0.254.169.in-addr.arpa")
3628 // and when there simply happen to be no instances of the service the client is looking
3629 // for (e.g. iTunes is set to look for RAOP devices, and the current network has none).
3630 debugf("SendQueries: Zero current answers for %##s (%s); will reconfirm antecedents",
3631 q->qname.c, DNSTypeName(q->qtype));
3632 // Sending third query, and no answers yet; time to begin doubting the source
3633 ReconfirmAntecedents(m, &q->qname, q->qnamehash, q->InterfaceID, 0);
3634 }
3635 }
3636
3637 // Mark for sending. (If no active interfaces, then don't even try.)
3638 q->SendOnAll = (q->SendQNow == mDNSInterfaceMark);
3639 if (q->SendOnAll)
3640 {
3641 q->SendQNow = !intf ? mDNSNULL : (q->InterfaceID) ? q->InterfaceID : intf->InterfaceID;
3642 q->LastQTime = m->timenow;
3643 }
3644
3645 // If we recorded a duplicate suppression for this question less than half an interval ago,
3646 // then we consider it recent enough that we don't need to do an identical query ourselves.
3647 ExpireDupSuppressInfo(q->DupSuppress, m->timenow - q->ThisQInterval/2);
3648
3649 q->LastQTxTime = m->timenow;
3650 q->RecentAnswerPkts = 0;
3651 if (q->RequestUnicast) q->RequestUnicast--;
3652 }
3653 // For all questions (not just the ones we're sending) check what the next scheduled event will be
3654 // We don't need to consider NewQuestions here because for those we'll set m->NextScheduledQuery in AnswerNewQuestion
3655 SetNextQueryTime(m,q);
3656 }
3657
3658 // 2. Scan our authoritative RR list to see what probes we might need to send
3659
3660 m->NextScheduledProbe = m->timenow + FutureTime;
3661
3662 if (m->CurrentRecord)
3663 LogMsg("SendQueries ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
3664 m->CurrentRecord = m->ResourceRecords;
3665 while (m->CurrentRecord)
3666 {
3667 ar = m->CurrentRecord;
3668 m->CurrentRecord = ar->next;
3669 if (!AuthRecord_uDNS(ar) && ar->resrec.RecordType == kDNSRecordTypeUnique) // For all records that are still probing...
3670 {
3671 // 1. If it's not reached its probe time, just make sure we update m->NextScheduledProbe correctly
3672 if (m->timenow - (ar->LastAPTime + ar->ThisAPInterval) < 0)
3673 {
3674 SetNextAnnounceProbeTime(m, ar);
3675 }
3676 // 2. else, if it has reached its probe time, mark it for sending and then update m->NextScheduledProbe correctly
3677 else if (ar->ProbeCount)
3678 {
3679 if (ar->AddressProxy.type == mDNSAddrType_IPv4)
3680 {
3681 // There's a problem here. If a host is waking up, and we probe to see if it responds, then
3682 // it will see those ARP probes as signalling intent to use the address, so it picks a different one.
3683 // A more benign way to find out if a host is responding to ARPs might be send a standard ARP *request*
3684 // (using our sender IP address) instead of an ARP *probe* (using all-zero sender IP address).
3685 // A similar concern may apply to the NDP Probe too. -- SC
3686 LogSPS("SendQueries ARP Probe %d %s %s", ar->ProbeCount, InterfaceNameForID(m, ar->resrec.InterfaceID), ARDisplayString(m,ar));
3687 SendARP(m, 1, ar, &zerov4Addr, &zeroEthAddr, &ar->AddressProxy.ip.v4, &ar->WakeUp.IMAC);
3688 }
3689 else if (ar->AddressProxy.type == mDNSAddrType_IPv6)
3690 {
3691 LogSPS("SendQueries NDP Probe %d %s %s", ar->ProbeCount, InterfaceNameForID(m, ar->resrec.InterfaceID), ARDisplayString(m,ar));
3692 // IPv6 source = zero
3693 // No target hardware address
3694 // IPv6 target address is address we're probing
3695 // Ethernet destination address is Ethernet interface address of the Sleep Proxy client we're probing
3696 SendNDP(m, NDP_Sol, 0, ar, &zerov6Addr, mDNSNULL, &ar->AddressProxy.ip.v6, &ar->WakeUp.IMAC);
3697 }
3698 // Mark for sending. (If no active interfaces, then don't even try.)
3699 ar->SendRNow = (!intf || ar->WakeUp.HMAC.l[0]) ? mDNSNULL : ar->resrec.InterfaceID ? ar->resrec.InterfaceID : intf->InterfaceID;
3700 ar->LastAPTime = m->timenow;
3701 // When we have a late conflict that resets a record to probing state we use a special marker value greater
3702 // than DefaultProbeCountForTypeUnique. Here we detect that state and reset ar->ProbeCount back to the right value.
3703 if (ar->ProbeCount > DefaultProbeCountForTypeUnique)
3704 ar->ProbeCount = DefaultProbeCountForTypeUnique;
3705 ar->ProbeCount--;
3706 SetNextAnnounceProbeTime(m, ar);
3707 if (ar->ProbeCount == 0)
3708 {
3709 // If this is the last probe for this record, then see if we have any matching records
3710 // on our duplicate list which should similarly have their ProbeCount cleared to zero...
3711 AuthRecord *r2;
3712 for (r2 = m->DuplicateRecords; r2; r2=r2->next)
3713 if (r2->resrec.RecordType == kDNSRecordTypeUnique && RecordIsLocalDuplicate(r2, ar))
3714 r2->ProbeCount = 0;
3715 // ... then acknowledge this record to the client.
3716 // We do this optimistically, just as we're about to send the third probe.
3717 // This helps clients that both advertise and browse, and want to filter themselves
3718 // from the browse results list, because it helps ensure that the registration
3719 // confirmation will be delivered 1/4 second *before* the browse "add" event.
3720 // A potential downside is that we could deliver a registration confirmation and then find out
3721 // moments later that there's a name conflict, but applications have to be prepared to handle
3722 // late conflicts anyway (e.g. on connection of network cable, etc.), so this is nothing new.
3723 if (!ar->Acknowledged) AcknowledgeRecord(m, ar);
3724 }
3725 }
3726 // else, if it has now finished probing, move it to state Verified,
3727 // and update m->NextScheduledResponse so it will be announced
3728 else
3729 {
3730 if (!ar->Acknowledged) AcknowledgeRecord(m, ar); // Defensive, just in case it got missed somehow
3731 ar->resrec.RecordType = kDNSRecordTypeVerified;
3732 ar->ThisAPInterval = DefaultAnnounceIntervalForTypeUnique;
3733 ar->LastAPTime = m->timenow - DefaultAnnounceIntervalForTypeUnique;
3734 SetNextAnnounceProbeTime(m, ar);
3735 }
3736 }
3737 }
3738 m->CurrentRecord = m->DuplicateRecords;
3739 while (m->CurrentRecord)
3740 {
3741 ar = m->CurrentRecord;
3742 m->CurrentRecord = ar->next;
3743 if (ar->resrec.RecordType == kDNSRecordTypeUnique && ar->ProbeCount == 0 && !ar->Acknowledged)
3744 AcknowledgeRecord(m, ar);
3745 }
3746
3747 // 3. Now we know which queries and probes we're sending,
3748 // go through our interface list sending the appropriate queries on each interface
3749 while (intf)
3750 {
3751 int OwnerRecordSpace = (m->AnnounceOwner && intf->MAC.l[0]) ? DNSOpt_Header_Space + DNSOpt_Owner_Space(&m->PrimaryMAC, &intf->MAC) : 0;
3752 int TraceRecordSpace = (mDNS_McastTracingEnabled && MDNS_TRACER) ? DNSOpt_Header_Space + DNSOpt_TraceData_Space : 0;
3753 mDNSu8 *queryptr = m->omsg.data;
3754 mDNSBool useBackgroundTrafficClass = mDNSfalse; // set if we should use background traffic class
3755
3756 InitializeDNSMessage(&m->omsg.h, zeroID, QueryFlags);
3757 if (KnownAnswerList) verbosedebugf("SendQueries: KnownAnswerList set... Will continue from previous packet");
3758 if (!KnownAnswerList)
3759 {
3760 // Start a new known-answer list
3761 CacheRecord **kalistptr = &KnownAnswerList;
3762 mDNSu32 answerforecast = OwnerRecordSpace + TraceRecordSpace; // Start by assuming we'll need at least enough space to put the Owner+Tracer Option
3763
3764 // Put query questions in this packet
3765 for (q = m->Questions; q && q != m->NewQuestions; q=q->next)
3766 {
3767 if (mDNSOpaque16IsZero(q->TargetQID) && (q->SendQNow == intf->InterfaceID))
3768 {
3769 mDNSBool Suppress = mDNSfalse;
3770 debugf("SendQueries: %s question for %##s (%s) at %d forecast total %d",
3771 SuppressOnThisInterface(q->DupSuppress, intf) ? "Suppressing" : "Putting ",
3772 q->qname.c, DNSTypeName(q->qtype), queryptr - m->omsg.data, queryptr + answerforecast - m->omsg.data);
3773
3774 // If interface is P2P type, verify that query should be sent over it.
3775 if (!mDNSPlatformValidQuestionForInterface(q, intf))
3776 {
3777 q->SendQNow = (q->InterfaceID || !q->SendOnAll) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3778 }
3779 // If we're suppressing this question, or we successfully put it, update its SendQNow state
3780 else if ((Suppress = SuppressOnThisInterface(q->DupSuppress, intf)) ||
3781 BuildQuestion(m, intf, &m->omsg, &queryptr, q, &kalistptr, &answerforecast))
3782 {
3783 // We successfully added the question to the packet. Make sure that
3784 // we also send the NSEC3 record if required. BuildQuestion accounted for
3785 // the space.
3786 //
3787 // Note: We don't suppress anonymous questions and hence Suppress should always
3788 // be zero.
3789
3790 if (Suppress)
3791 m->mDNSStats.DupQuerySuppressions++;
3792
3793 if (!Suppress && q->AnonInfo)
3794 {
3795 debugf("SendQueries: marking for question %##s, Suppress %d", q->qname.c, Suppress);
3796 q->AnonInfo->SendNow = intf->InterfaceID;
3797 }
3798 q->SendQNow = (q->InterfaceID || !q->SendOnAll) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3799 if (q->WakeOnResolveCount)
3800 {
3801 mDNSSendWakeOnResolve(m, q);
3802 q->WakeOnResolveCount--;
3803 }
3804
3805 // use background traffic class if any included question requires it
3806 if (q->UseBackgroundTrafficClass)
3807 {
3808 useBackgroundTrafficClass = mDNStrue;
3809 }
3810 }
3811 }
3812 }
3813
3814 // Put probe questions in this packet
3815 for (ar = m->ResourceRecords; ar; ar=ar->next)
3816 {
3817 if (ar->SendRNow != intf->InterfaceID)
3818 continue;
3819
3820 // If interface is a P2P variant, verify that the probe should be sent over it.
3821 if (!mDNSPlatformValidRecordForInterface(ar, intf->InterfaceID))
3822 {
3823 ar->SendRNow = (ar->resrec.InterfaceID) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3824 ar->IncludeInProbe = mDNSfalse;
3825 }
3826 else
3827 {
3828 mDNSBool ucast = (ar->ProbeCount >= DefaultProbeCountForTypeUnique-1) && m->CanReceiveUnicastOn5353 && intf->SupportsUnicastMDNSResponse;
3829 mDNSu16 ucbit = (mDNSu16)(ucast ? kDNSQClass_UnicastResponse : 0);
3830 const mDNSu8 *const limit = m->omsg.data + (m->omsg.h.numQuestions ? NormalMaxDNSMessageData : AbsoluteMaxDNSMessageData);
3831 // We forecast: compressed name (2) type (2) class (2) TTL (4) rdlength (2) rdata (n)
3832 mDNSu32 forecast = answerforecast + 12 + ar->resrec.rdestimate;
3833 mDNSBool putProbe = mDNStrue;
3834 mDNSu16 qclass = ar->resrec.rrclass | ucbit;
3835
3836 {// Determine if this probe question is already in packet's dns message
3837 const mDNSu8 *questionptr = m->omsg.data;
3838 DNSQuestion question;
3839 mDNSu16 n;
3840 for (n = 0; n < m->omsg.h.numQuestions && questionptr; n++)
3841 {
3842 questionptr = getQuestion(&m->omsg, questionptr, limit, mDNSInterface_Any, &question);
3843 if (questionptr && (question.qtype == kDNSQType_ANY) && (question.qclass == qclass) &&
3844 (question.qnamehash == ar->resrec.namehash) && SameDomainName(&question.qname, ar->resrec.name))
3845 {
3846 putProbe = mDNSfalse; // set to false if already in message
3847 break;
3848 }
3849 }
3850 }
3851
3852 if (putProbe)
3853 {
3854 mDNSu8 *newptr = putQuestion(&m->omsg, queryptr, limit - forecast, ar->resrec.name, kDNSQType_ANY, qclass);
3855 if (newptr)
3856 {
3857 queryptr = newptr;
3858 answerforecast = forecast;
3859 ar->SendRNow = (ar->resrec.InterfaceID) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3860 ar->IncludeInProbe = mDNStrue;
3861 verbosedebugf("SendQueries: Put Question %##s (%s) probecount %d InterfaceID= %d %d %d",
3862 ar->resrec.name->c, DNSTypeName(ar->resrec.rrtype), ar->ProbeCount, ar->resrec.InterfaceID, ar->resrec.rdestimate, answerforecast);
3863 }
3864 }
3865 else
3866 {
3867 ar->SendRNow = (ar->resrec.InterfaceID) ? mDNSNULL : GetNextActiveInterfaceID(intf);
3868 ar->IncludeInProbe = mDNStrue;
3869 }
3870 }
3871 }
3872 }
3873
3874 // Put our known answer list (either new one from this question or questions, or remainder of old one from last time)
3875 while (KnownAnswerList)
3876 {
3877 CacheRecord *ka = KnownAnswerList;
3878 mDNSu32 SecsSinceRcvd = ((mDNSu32)(m->timenow - ka->TimeRcvd)) / mDNSPlatformOneSecond;
3879 mDNSu8 *newptr = PutResourceRecordTTLWithLimit(&m->omsg, queryptr, &m->omsg.h.numAnswers, &ka->resrec, ka->resrec.rroriginalttl - SecsSinceRcvd,
3880 m->omsg.data + NormalMaxDNSMessageData - OwnerRecordSpace - TraceRecordSpace);
3881 if (newptr)
3882 {
3883 verbosedebugf("SendQueries: Put %##s (%s) at %d - %d",
3884 ka->resrec.name->c, DNSTypeName(ka->resrec.rrtype), queryptr - m->omsg.data, newptr - m->omsg.data);
3885 queryptr = newptr;
3886 KnownAnswerList = ka->NextInKAList;
3887 ka->NextInKAList = mDNSNULL;
3888 }
3889 else
3890 {
3891 // If we ran out of space and we have more than one question in the packet, that's an error --
3892 // we shouldn't have put more than one question if there was a risk of us running out of space.
3893 if (m->omsg.h.numQuestions > 1)
3894 LogMsg("SendQueries: Put %d answers; No more space for known answers", m->omsg.h.numAnswers);
3895 m->omsg.h.flags.b[0] |= kDNSFlag0_TC;
3896 break;
3897 }
3898 }
3899
3900 for (ar = m->ResourceRecords; ar; ar=ar->next)
3901 {
3902 if (ar->IncludeInProbe)
3903 {
3904 mDNSu8 *newptr = PutResourceRecord(&m->omsg, queryptr, &m->omsg.h.numAuthorities, &ar->resrec);
3905 ar->IncludeInProbe = mDNSfalse;
3906 if (newptr) queryptr = newptr;
3907 else LogMsg("SendQueries: How did we fail to have space for the Update record %s", ARDisplayString(m,ar));
3908 }
3909 }
3910
3911 for (q = m->Questions; q; q = q->next)
3912 {
3913 if (q->AnonInfo && q->AnonInfo->SendNow == intf->InterfaceID)
3914 {
3915 mDNSu8 *newptr = PutResourceRecord(&m->omsg, queryptr, &m->omsg.h.numAuthorities, q->AnonInfo->nsec3RR);
3916 if (newptr)
3917 {
3918 debugf("SendQueries: Added NSEC3 record %s on InterfaceID %p", RRDisplayString(m, q->AnonInfo->nsec3RR), intf->InterfaceID);
3919 queryptr = newptr;
3920 }
3921 else
3922 {
3923 LogMsg("SendQueries: ERROR!! Cannot add NSEC3 record %s on InterfaceID %p", RRDisplayString(m, q->AnonInfo->nsec3RR), intf->InterfaceID);
3924 }
3925 q->AnonInfo->SendNow = mDNSNULL;
3926 }
3927 }
3928
3929 if (queryptr > m->omsg.data)
3930 {
3931 // If we have data to send, add OWNER/TRACER/OWNER+TRACER option if necessary, then send packet
3932 if (OwnerRecordSpace || TraceRecordSpace)
3933 {
3934 AuthRecord opt;
3935 mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
3936 opt.resrec.rrclass = NormalMaxDNSMessageData;
3937 opt.resrec.rdlength = sizeof(rdataOPT);
3938 opt.resrec.rdestimate = sizeof(rdataOPT);
3939 if (OwnerRecordSpace && TraceRecordSpace)
3940 {
3941 opt.resrec.rdlength += sizeof(rdataOPT); // Two options in this OPT record
3942 opt.resrec.rdestimate += sizeof(rdataOPT);
3943 SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
3944 SetupTracerOpt(m, &opt.resrec.rdata->u.opt[1]);
3945 }
3946 else if (OwnerRecordSpace)
3947 {
3948 SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
3949 }
3950 else if (TraceRecordSpace)
3951 {
3952 SetupTracerOpt(m, &opt.resrec.rdata->u.opt[0]);
3953 }
3954 queryptr = PutResourceRecordTTLWithLimit(&m->omsg, queryptr, &m->omsg.h.numAdditionals,
3955 &opt.resrec, opt.resrec.rroriginalttl, m->omsg.data + AbsoluteMaxDNSMessageData);
3956 if (!queryptr)
3957 {
3958 LogMsg("SendQueries: How did we fail to have space for %s %s OPT record (%d/%d/%d/%d) %s", OwnerRecordSpace ? "OWNER" : "", TraceRecordSpace ? "TRACER" : "",
3959 m->omsg.h.numQuestions, m->omsg.h.numAnswers, m->omsg.h.numAuthorities, m->omsg.h.numAdditionals, ARDisplayString(m, &opt));
3960 }
3961 if (queryptr > m->omsg.data + NormalMaxDNSMessageData)
3962 {
3963 if (m->omsg.h.numQuestions != 1 || m->omsg.h.numAnswers != 0 || m->omsg.h.numAuthorities != 1 || m->omsg.h.numAdditionals != 1)
3964 LogMsg("SendQueries: Why did we generate oversized packet with %s %s OPT record %p %p %p (%d/%d/%d/%d) %s", OwnerRecordSpace ? "OWNER" : "",
3965 TraceRecordSpace ? "TRACER" : "", m->omsg.data, m->omsg.data + NormalMaxDNSMessageData, queryptr, m->omsg.h.numQuestions, m->omsg.h.numAnswers,
3966 m->omsg.h.numAuthorities, m->omsg.h.numAdditionals, ARDisplayString(m, &opt));
3967 }
3968 }
3969
3970 if ((m->omsg.h.flags.b[0] & kDNSFlag0_TC) && m->omsg.h.numQuestions > 1)
3971 LogMsg("SendQueries: Should not have more than one question (%d) in a truncated packet", m->omsg.h.numQuestions);
3972 debugf("SendQueries: Sending %d Question%s %d Answer%s %d Update%s on %p",
3973 m->omsg.h.numQuestions, m->omsg.h.numQuestions == 1 ? "" : "s",
3974 m->omsg.h.numAnswers, m->omsg.h.numAnswers == 1 ? "" : "s",
3975 m->omsg.h.numAuthorities, m->omsg.h.numAuthorities == 1 ? "" : "s", intf->InterfaceID);
3976 if (intf->IPv4Available) mDNSSendDNSMessage(m, &m->omsg, queryptr, intf->InterfaceID, mDNSNULL, &AllDNSLinkGroup_v4, MulticastDNSPort, mDNSNULL, mDNSNULL, useBackgroundTrafficClass);
3977 if (intf->IPv6Available) mDNSSendDNSMessage(m, &m->omsg, queryptr, intf->InterfaceID, mDNSNULL, &AllDNSLinkGroup_v6, MulticastDNSPort, mDNSNULL, mDNSNULL, useBackgroundTrafficClass);
3978 if (!m->SuppressSending) m->SuppressSending = NonZeroTime(m->timenow + (mDNSPlatformOneSecond+9)/10);
3979 if (++pktcount >= 1000)
3980 { LogMsg("SendQueries exceeded loop limit %d: giving up", pktcount); break; }
3981 // There might be more records left in the known answer list, or more questions to send
3982 // on this interface, so go around one more time and try again.
3983 }
3984 else // Nothing more to send on this interface; go to next
3985 {
3986 const NetworkInterfaceInfo *next = GetFirstActiveInterface(intf->next);
3987 #if MDNS_DEBUGMSGS && 0
3988 const char *const msg = next ? "SendQueries: Nothing more on %p; moving to %p" : "SendQueries: Nothing more on %p";
3989 debugf(msg, intf, next);
3990 #endif
3991 intf = next;
3992 }
3993 }
3994
3995 // 4. Final housekeeping
3996
3997 // 4a. Debugging check: Make sure we announced all our records
3998 for (ar = m->ResourceRecords; ar; ar=ar->next)
3999 if (ar->SendRNow)
4000 {
4001 if (ar->ARType != AuthRecordLocalOnly && ar->ARType != AuthRecordP2P)
4002 LogInfo("SendQueries: No active interface %d to send probe: %d %s",
4003 (uint32_t)ar->SendRNow, (uint32_t)ar->resrec.InterfaceID, ARDisplayString(m, ar));
4004 ar->SendRNow = mDNSNULL;
4005 }
4006
4007 // 4b. When we have lingering cache records that we're keeping around for a few seconds in the hope
4008 // that their interface which went away might come back again, the logic will want to send queries
4009 // for those records, but we can't because their interface isn't here any more, so to keep the
4010 // state machine ticking over we just pretend we did so.
4011 // If the interface does not come back in time, the cache record will expire naturally
4012 FORALL_CACHERECORDS(slot, cg, cr)
4013 {
4014 if (cr->CRActiveQuestion && cr->UnansweredQueries < MaxUnansweredQueries)
4015 {
4016 if (m->timenow + TicksTTL(cr)/50 - cr->NextRequiredQuery >= 0)
4017 {
4018 cr->UnansweredQueries++;
4019 cr->CRActiveQuestion->SendQNow = mDNSNULL;
4020 SetNextCacheCheckTimeForRecord(m, cr);
4021 }
4022 }
4023 }
4024
4025 // 4c. Debugging check: Make sure we sent all our planned questions
4026 // Do this AFTER the lingering cache records check above, because that will prevent spurious warnings for questions
4027 // we legitimately couldn't send because the interface is no longer available
4028 for (q = m->Questions; q; q=q->next)
4029 {
4030 if (q->SendQNow)
4031 {
4032 DNSQuestion *x;
4033 for (x = m->NewQuestions; x; x=x->next) if (x == q) break; // Check if this question is a NewQuestion
4034 // There will not be an active interface for questions applied to mDNSInterface_BLE
4035 // so don't log the warning in that case.
4036 if (q->InterfaceID != mDNSInterface_BLE)
4037 LogInfo("SendQueries: No active interface %d to send %s question: %d %##s (%s)",
4038 (uint32_t)q->SendQNow, x ? "new" : "old", (uint32_t)q->InterfaceID, q->qname.c, DNSTypeName(q->qtype));
4039 q->SendQNow = mDNSNULL;
4040 }
4041 q->CachedAnswerNeedsUpdate = mDNSfalse;
4042 }
4043 }
4044
4045 mDNSlocal void SendWakeup(mDNS *const m, mDNSInterfaceID InterfaceID, mDNSEthAddr *EthAddr, mDNSOpaque48 *password, mDNSBool unicastOnly)
4046 {
4047 int i, j;
4048
4049 mDNSu8 *ptr = m->omsg.data;
4050 NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
4051 if (!intf) { LogMsg("SendARP: No interface with InterfaceID %p found", InterfaceID); return; }
4052
4053 // 0x00 Destination address
4054 for (i=0; i<6; i++) *ptr++ = EthAddr->b[i];
4055
4056 // 0x06 Source address (Note: Since we don't currently set the BIOCSHDRCMPLT option, BPF will fill in the real interface address for us)
4057 for (i=0; i<6; i++) *ptr++ = intf->MAC.b[0];
4058
4059 // 0x0C Ethertype (0x0842)
4060 *ptr++ = 0x08;
4061 *ptr++ = 0x42;
4062
4063 // 0x0E Wakeup sync sequence
4064 for (i=0; i<6; i++) *ptr++ = 0xFF;
4065
4066 // 0x14 Wakeup data
4067 for (j=0; j<16; j++) for (i=0; i<6; i++) *ptr++ = EthAddr->b[i];
4068
4069 // 0x74 Password
4070 for (i=0; i<6; i++) *ptr++ = password->b[i];
4071
4072 mDNSPlatformSendRawPacket(m->omsg.data, ptr, InterfaceID);
4073
4074 if (!unicastOnly)
4075 {
4076 // For Ethernet switches that don't flood-foward packets with unknown unicast destination MAC addresses,
4077 // broadcast is the only reliable way to get a wakeup packet to the intended target machine.
4078 // For 802.11 WPA networks, where a sleeping target machine may have missed a broadcast/multicast
4079 // key rotation, unicast is the only way to get a wakeup packet to the intended target machine.
4080 // So, we send one of each, unicast first, then broadcast second.
4081 for (i=0; i<6; i++) m->omsg.data[i] = 0xFF;
4082 mDNSPlatformSendRawPacket(m->omsg.data, ptr, InterfaceID);
4083 }
4084 }
4085
4086 // ***************************************************************************
4087 #if COMPILER_LIKES_PRAGMA_MARK
4088 #pragma mark -
4089 #pragma mark - RR List Management & Task Management
4090 #endif
4091
4092 // Whenever a question is answered, reset its state so that we don't query
4093 // the network repeatedly. This happens first time when we answer the question and
4094 // and later when we refresh the cache.
4095 mDNSlocal void ResetQuestionState(mDNS *const m, DNSQuestion *q)
4096 {
4097 q->LastQTime = m->timenow;
4098 q->LastQTxTime = m->timenow;
4099 q->RecentAnswerPkts = 0;
4100 q->ThisQInterval = MaxQuestionInterval;
4101 q->RequestUnicast = 0;
4102 // Reset unansweredQueries so that we don't penalize this server later when we
4103 // start sending queries when the cache expires.
4104 q->unansweredQueries = 0;
4105 debugf("ResetQuestionState: Set MaxQuestionInterval for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4106 }
4107
4108 // Note: AnswerCurrentQuestionWithResourceRecord can call a user callback, which may change the record list and/or question list.
4109 // Any code walking either list must use the m->CurrentQuestion (and possibly m->CurrentRecord) mechanism to protect against this.
4110 // In fact, to enforce this, the routine will *only* answer the question currently pointed to by m->CurrentQuestion,
4111 // which will be auto-advanced (possibly to NULL) if the client callback cancels the question.
4112 mDNSexport void AnswerCurrentQuestionWithResourceRecord(mDNS *const m, CacheRecord *const rr, const QC_result AddRecord)
4113 {
4114 DNSQuestion *const q = m->CurrentQuestion;
4115 const mDNSBool followcname = FollowCNAME(q, &rr->resrec, AddRecord);
4116
4117 verbosedebugf("AnswerCurrentQuestionWithResourceRecord:%4lu %s (%s) TTL %d %s",
4118 q->CurrentAnswers, AddRecord ? "Add" : "Rmv", MortalityDisplayString(rr->resrec.mortality),
4119 rr->resrec.rroriginalttl, CRDisplayString(m, rr));
4120
4121 // When the response for the question was validated, the entire rrset was validated. If we deliver
4122 // a RMV for a single record in the rrset, we invalidate the response. If we deliver another add
4123 // in the future, we will do the revalidation again.
4124 //
4125 // Also, if we deliver an ADD for a negative cache record and it has no NSEC/NSEC3, the ValidationStatus needs
4126 // to be reset. This happens normally when we deliver a "secure" negative response followed by an insecure
4127 // negative response which can happen e.g., when disconnecting from network that leads to a negative response
4128 // due to no DNS servers. As we don't deliver RMVs for negative responses that were delivered before, we need
4129 // to do it on the next ADD of a negative cache record. This ADD could be the result of a timeout, no DNS servers
4130 // etc. in which case we need to reset the state to make sure we don't deliver them as secure. If this is
4131 // a real negative response, we would reset the state here and validate the results at the end of this function.
4132 // or the real response again if we purge the cache.
4133 if (q->ValidationRequired && ((AddRecord == QC_rmv) ||
4134 (rr->resrec.RecordType == kDNSRecordTypePacketNegative && (AddRecord == QC_add))))
4135 {
4136 q->ValidationStatus = 0;
4137 q->ValidationState = DNSSECValRequired;
4138 }
4139
4140 // Normally we don't send out the unicast query if we have answered using our local only auth records e.g., /etc/hosts.
4141 // But if the query for "A" record has a local answer but query for "AAAA" record has no local answer, we might
4142 // send the AAAA query out which will come back with CNAME and will also answer the "A" query. To prevent that,
4143 // we check to see if that query already has a unique local answer.
4144 if (q->LOAddressAnswers)
4145 {
4146 LogInfo("AnswerCurrentQuestionWithResourceRecord: Question %p %##s (%s) not answering with record %s due to "
4147 "LOAddressAnswers %d", q, q->qname.c, DNSTypeName(q->qtype), ARDisplayString(m, rr),
4148 q->LOAddressAnswers);
4149 return;
4150 }
4151
4152 if (QuerySuppressed(q))
4153 {
4154 // If the query is suppressed, then we don't want to answer from the cache. But if this query is
4155 // supposed to time out, we still want to callback the clients. We do this only for TimeoutQuestions
4156 // that are timing out, which we know are answered with negative cache record when timing out.
4157 if (!q->TimeoutQuestion || rr->resrec.RecordType != kDNSRecordTypePacketNegative || (m->timenow - q->StopTime < 0))
4158 return;
4159 }
4160
4161 // Set the record to immortal if appropriate
4162 if (AddRecord == QC_add && Question_uDNS(q) && rr->resrec.RecordType != kDNSRecordTypePacketNegative &&
4163 q->allowExpired != AllowExpired_None && rr->resrec.mortality == Mortality_Mortal ) rr->resrec.mortality = Mortality_Immortal; // Update a non-expired cache record to immortal if appropriate
4164
4165 #if AWD_METRICS
4166 if ((AddRecord == QC_add) && Question_uDNS(q) && !followcname)
4167 {
4168 const domainname * queryName;
4169 mDNSu32 responseLatencyMs;
4170 mDNSBool isForCellular;
4171
4172 queryName = q->metrics.originalQName ? q->metrics.originalQName : &q->qname;
4173 isForCellular = (q->qDNSServer && q->qDNSServer->cellIntf);
4174 if (!q->metrics.answered)
4175 {
4176 if (q->metrics.querySendCount > 0)
4177 {
4178 responseLatencyMs = ((m->timenow - q->metrics.firstQueryTime) * 1000) / mDNSPlatformOneSecond;
4179 }
4180 else
4181 {
4182 responseLatencyMs = 0;
4183 }
4184
4185 MetricsUpdateDNSQueryStats(queryName, q->qtype, &rr->resrec, q->metrics.querySendCount, q->metrics.expiredAnswerState, responseLatencyMs, isForCellular);
4186 q->metrics.answered = mDNStrue;
4187 }
4188 if (q->metrics.querySendCount > 0)
4189 {
4190 MetricsUpdateDNSResolveStats(queryName, &rr->resrec, isForCellular);
4191 }
4192 }
4193 #endif
4194 // Note: Use caution here. In the case of records with rr->DelayDelivery set, AnswerCurrentQuestionWithResourceRecord(... mDNStrue)
4195 // may be called twice, once when the record is received, and again when it's time to notify local clients.
4196 // If any counters or similar are added here, care must be taken to ensure that they are not double-incremented by this.
4197
4198 if (AddRecord == QC_add && !q->DuplicateOf && rr->CRActiveQuestion != q && rr->resrec.mortality != Mortality_Ghost)
4199 {
4200 if (!rr->CRActiveQuestion) m->rrcache_active++; // If not previously active, increment rrcache_active count
4201 debugf("AnswerCurrentQuestionWithResourceRecord: Updating CRActiveQuestion from %p to %p for cache record %s, CurrentAnswer %d",
4202 rr->CRActiveQuestion, q, CRDisplayString(m,rr), q->CurrentAnswers);
4203 rr->CRActiveQuestion = q; // We know q is non-null
4204 SetNextCacheCheckTimeForRecord(m, rr);
4205 }
4206
4207 // If this is:
4208 // (a) a no-cache add, where we've already done at least one 'QM' query, or
4209 // (b) a normal add, where we have at least one unique-type answer,
4210 // then there's no need to keep polling the network.
4211 // (If we have an answer in the cache, then we'll automatically ask again in time to stop it expiring.)
4212 // We do this for mDNS questions and uDNS one-shot questions, but not for
4213 // uDNS LongLived questions, because that would mess up our LLQ lease renewal timing.
4214 if ((AddRecord == QC_addnocache && !q->RequestUnicast) ||
4215 (AddRecord == QC_add && (q->ExpectUnique || (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask))))
4216 if (ActiveQuestion(q) && (mDNSOpaque16IsZero(q->TargetQID) || !q->LongLived))
4217 {
4218 ResetQuestionState(m, q);
4219 }
4220
4221 if (rr->DelayDelivery) return; // We'll come back later when CacheRecordDeferredAdd() calls us
4222
4223 #if USE_DNS64
4224 // If DNS64StateMachine() returns true, then the question was restarted as a different question, so return.
4225 if (!mDNSOpaque16IsZero(q->TargetQID) && DNS64StateMachine(m, q, &rr->resrec, AddRecord)) return;
4226 #endif
4227
4228 #ifdef USE_LIBIDN
4229 if (rr->resrec.RecordType == kDNSRecordTypePacketNegative) // If negative answer, check if we need to try Punycode conversion
4230 {
4231 domainname newname;
4232 if (PerformNextPunycodeConversion(q, &newname)) // Itertative Punycode conversion succeeded, so reissue question with new name
4233 {
4234 UDPSocket *const sock = q->LocalSocket; // Save old socket and transaction ID
4235 const mDNSOpaque16 id = q->TargetQID;
4236 q->LocalSocket = mDNSNULL;
4237 mDNS_StopQuery_internal(m, q); // Stop old query
4238 AssignDomainName(&q->qname, &newname); // Update qname
4239 q->qnamehash = DomainNameHashValue(&q->qname); // and namehash
4240 mDNS_StartQuery_internal(m, q); // Start new query
4241
4242 if (sock) // Transplant saved socket, if appropriate
4243 {
4244 if (q->DuplicateOf) mDNSPlatformUDPClose(sock);
4245 else { q->LocalSocket = sock; q->TargetQID = id; }
4246 }
4247 return; // All done for now; wait until we get the next answer
4248 }
4249 }
4250 #endif // USE_LIBIDN
4251
4252 // Only deliver negative answers if client has explicitly requested them except when we are forcing a negative response
4253 // for the purpose of retrying search domains/timeout OR the question is suppressed
4254 if (rr->resrec.RecordType == kDNSRecordTypePacketNegative || (q->qtype != kDNSType_NSEC && RRAssertsNonexistence(&rr->resrec, q->qtype)))
4255 if (!AddRecord || (AddRecord != QC_suppressed && AddRecord != QC_forceresponse && !q->ReturnIntermed)) return;
4256
4257 // For CNAME results to non-CNAME questions, only inform the client if they explicitly requested that
4258 if (q->QuestionCallback && !q->NoAnswer && (!followcname || q->ReturnIntermed))
4259 {
4260 mDNS_DropLockBeforeCallback(); // Allow client (and us) to legally make mDNS API calls
4261 if (q->qtype != kDNSType_NSEC && RRAssertsNonexistence(&rr->resrec, q->qtype))
4262 {
4263 CacheRecord neg;
4264 MakeNegativeCacheRecord(m, &neg, &q->qname, q->qnamehash, q->qtype, q->qclass, 1, rr->resrec.InterfaceID, q->qDNSServer);
4265 q->QuestionCallback(m, q, &neg.resrec, AddRecord);
4266 }
4267 else
4268 {
4269 #if USE_DNS64
4270 if (DNS64ShouldAnswerQuestion(q, &rr->resrec))
4271 {
4272 DNS64AnswerQuestion(m, q, &rr->resrec, AddRecord);
4273 }
4274 else
4275 #endif
4276 {
4277 q->QuestionCallback(m, q, &rr->resrec, AddRecord);
4278 }
4279 }
4280 mDNS_ReclaimLockAfterCallback(); // Decrement mDNS_reentrancy to block mDNS API calls again
4281 }
4282 // If this is an "Add" operation and this question needs validation, validate the response.
4283 // In the case of negative responses, extra care should be taken. Negative cache records are
4284 // used for many purposes. For example,
4285 //
4286 // 1) Suppressing questions (SuppressUnusable)
4287 // 2) Timeout questions
4288 // 3) The name does not exist
4289 // 4) No DNS servers are available and we need a quick response for the application
4290 //
4291 // (1) and (2) are handled by "QC_add" check as AddRecord would be "QC_forceresponse" or "QC_suppressed"
4292 // in that case. For (3), it is possible that we don't get nsecs back but we still need to call
4293 // VerifySignature so that we can deliver the appropriate DNSSEC result. There is no point in verifying
4294 // signature for (4) and hence the explicit check for q->qDNSServer.
4295 //
4296 if (m->CurrentQuestion == q && (AddRecord == QC_add) && !q->ValidatingResponse && q->ValidationRequired &&
4297 q->ValidationState == DNSSECValRequired && q->qDNSServer)
4298 {
4299 q->ValidationState = DNSSECValInProgress;
4300 // Treat it as callback call as that's what dnssec code expects
4301 mDNS_DropLockBeforeCallback(); // Allow client (and us) to legally make mDNS API calls
4302 VerifySignature(m, mDNSNULL, q);
4303 mDNS_ReclaimLockAfterCallback(); // Decrement mDNS_reentrancy to block mDNS API calls again
4304 return;
4305 }
4306
4307 if ((m->CurrentQuestion == q) && !ValidatingQuestion(q))
4308 {
4309 // If we get a CNAME back while we are validating the response (i.e., CNAME for DS, DNSKEY, RRSIG),
4310 // don't follow them. If it is a ValidationRequired question, wait for the CNAME to be validated
4311 // first before following it
4312 if (followcname) AnswerQuestionByFollowingCNAME(m, q, &rr->resrec);
4313
4314 // If we are returning expired RRs, then remember the first expired qname we we can start the query again
4315 if (rr->resrec.mortality == Mortality_Ghost && !q->firstExpiredQname.c[0] && (q->allowExpired == AllowExpired_AllowExpiredAnswers) && rr->resrec.RecordType != kDNSRecordTypePacketNegative)
4316 {
4317 debugf("AnswerCurrentQuestionWithResourceRecord: Keeping track of domain for expired RR %s for question %p", CRDisplayString(m,rr), q);
4318 // Note: question->qname is already changed at this point if following a CNAME
4319 AssignDomainName(&q->firstExpiredQname, rr->resrec.name); // Update firstExpiredQname
4320 }
4321 }
4322 }
4323
4324 mDNSlocal void CacheRecordDeferredAdd(mDNS *const m, CacheRecord *rr)
4325 {
4326 rr->DelayDelivery = 0;
4327 if (m->CurrentQuestion)
4328 LogMsg("CacheRecordDeferredAdd ERROR m->CurrentQuestion already set: %##s (%s)",
4329 m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4330 m->CurrentQuestion = m->Questions;
4331 while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
4332 {
4333 DNSQuestion *q = m->CurrentQuestion;
4334 if (ResourceRecordAnswersQuestion(&rr->resrec, q))
4335 AnswerCurrentQuestionWithResourceRecord(m, rr, QC_add);
4336 if (m->CurrentQuestion == q) // If m->CurrentQuestion was not auto-advanced, do it ourselves now
4337 m->CurrentQuestion = q->next;
4338 }
4339 m->CurrentQuestion = mDNSNULL;
4340 }
4341
4342 mDNSlocal mDNSs32 CheckForSoonToExpireRecords(mDNS *const m, const domainname *const name, const mDNSu32 namehash)
4343 {
4344 const mDNSs32 threshold = m->timenow + mDNSPlatformOneSecond; // See if there are any records expiring within one second
4345 const mDNSs32 start = m->timenow - 0x10000000;
4346 mDNSs32 delay = start;
4347 CacheGroup *cg = CacheGroupForName(m, namehash, name);
4348 const CacheRecord *rr;
4349
4350 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
4351 {
4352 if (threshold - RRExpireTime(rr) >= 0) // If we have records about to expire within a second
4353 {
4354 if (delay - RRExpireTime(rr) < 0) // then delay until after they've been deleted
4355 delay = RRExpireTime(rr);
4356 }
4357 }
4358 if (delay - start > 0)
4359 return(NonZeroTime(delay));
4360 else
4361 return(0);
4362 }
4363
4364 // CacheRecordAdd is only called from CreateNewCacheEntry, *never* directly as a result of a client API call.
4365 // If new questions are created as a result of invoking client callbacks, they will be added to
4366 // the end of the question list, and m->NewQuestions will be set to indicate the first new question.
4367 // rr is a new CacheRecord just received into our cache
4368 // (kDNSRecordTypePacketAns/PacketAnsUnique/PacketAdd/PacketAddUnique).
4369 // Note: CacheRecordAdd calls AnswerCurrentQuestionWithResourceRecord which can call a user callback,
4370 // which may change the record list and/or question list.
4371 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
4372 mDNSlocal void CacheRecordAdd(mDNS *const m, CacheRecord *rr)
4373 {
4374 DNSQuestion *q;
4375
4376 // We stop when we get to NewQuestions -- if we increment their CurrentAnswers/LargeAnswers/UniqueAnswers
4377 // counters here we'll end up double-incrementing them when we do it again in AnswerNewQuestion().
4378 for (q = m->Questions; q && q != m->NewQuestions; q=q->next)
4379 {
4380 if (ResourceRecordAnswersQuestion(&rr->resrec, q))
4381 {
4382 // If this question is one that's actively sending queries, and it's received ten answers within one
4383 // second of sending the last query packet, then that indicates some radical network topology change,
4384 // so reset its exponential backoff back to the start. We must be at least at the eight-second interval
4385 // to do this. If we're at the four-second interval, or less, there's not much benefit accelerating
4386 // because we will anyway send another query within a few seconds. The first reset query is sent out
4387 // randomized over the next four seconds to reduce possible synchronization between machines.
4388 if (q->LastAnswerPktNum != m->PktNum)
4389 {
4390 q->LastAnswerPktNum = m->PktNum;
4391 if (mDNSOpaque16IsZero(q->TargetQID) && ActiveQuestion(q) && ++q->RecentAnswerPkts >= 10 &&
4392 q->ThisQInterval > InitialQuestionInterval * QuestionIntervalStep3 && m->timenow - q->LastQTxTime < mDNSPlatformOneSecond)
4393 {
4394 LogMsg("CacheRecordAdd: %##s (%s) got immediate answer burst (%d); restarting exponential backoff sequence (%d)",
4395 q->qname.c, DNSTypeName(q->qtype), q->RecentAnswerPkts, q->ThisQInterval);
4396 q->LastQTime = m->timenow - InitialQuestionInterval + (mDNSs32)mDNSRandom((mDNSu32)mDNSPlatformOneSecond*4);
4397 q->ThisQInterval = InitialQuestionInterval;
4398 SetNextQueryTime(m,q);
4399 }
4400 }
4401 verbosedebugf("CacheRecordAdd %p %##s (%s) %lu %#a:%d question %p", rr, rr->resrec.name->c,
4402 DNSTypeName(rr->resrec.rrtype), rr->resrec.rroriginalttl, rr->resrec.rDNSServer ?
4403 &rr->resrec.rDNSServer->addr : mDNSNULL, mDNSVal16(rr->resrec.rDNSServer ?
4404 rr->resrec.rDNSServer->port : zeroIPPort), q);
4405 q->CurrentAnswers++;
4406
4407 q->unansweredQueries = 0;
4408 if (rr->resrec.rdlength > SmallRecordLimit) q->LargeAnswers++;
4409 if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) q->UniqueAnswers++;
4410 if (q->CurrentAnswers > 4000)
4411 {
4412 static int msgcount = 0;
4413 if (msgcount++ < 10)
4414 LogMsg("CacheRecordAdd: %##s (%s) has %d answers; shedding records to resist DOS attack",
4415 q->qname.c, DNSTypeName(q->qtype), q->CurrentAnswers);
4416 rr->resrec.rroriginalttl = 0;
4417 rr->UnansweredQueries = MaxUnansweredQueries;
4418 }
4419 }
4420 }
4421
4422 if (!rr->DelayDelivery)
4423 {
4424 if (m->CurrentQuestion)
4425 LogMsg("CacheRecordAdd ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4426 m->CurrentQuestion = m->Questions;
4427 while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
4428 {
4429 q = m->CurrentQuestion;
4430 if (ResourceRecordAnswersQuestion(&rr->resrec, q))
4431 AnswerCurrentQuestionWithResourceRecord(m, rr, QC_add);
4432 if (m->CurrentQuestion == q) // If m->CurrentQuestion was not auto-advanced, do it ourselves now
4433 m->CurrentQuestion = q->next;
4434 }
4435 m->CurrentQuestion = mDNSNULL;
4436 }
4437
4438 SetNextCacheCheckTimeForRecord(m, rr);
4439 }
4440
4441 // NoCacheAnswer is only called from mDNSCoreReceiveResponse, *never* directly as a result of a client API call.
4442 // If new questions are created as a result of invoking client callbacks, they will be added to
4443 // the end of the question list, and m->NewQuestions will be set to indicate the first new question.
4444 // rr is a new CacheRecord just received from the wire (kDNSRecordTypePacketAns/AnsUnique/Add/AddUnique)
4445 // but we don't have any place to cache it. We'll deliver question 'add' events now, but we won't have any
4446 // way to deliver 'remove' events in future, nor will we be able to include this in known-answer lists,
4447 // so we immediately bump ThisQInterval up to MaxQuestionInterval to avoid pounding the network.
4448 // Note: NoCacheAnswer calls AnswerCurrentQuestionWithResourceRecord which can call a user callback,
4449 // which may change the record list and/or question list.
4450 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
4451 mDNSlocal void NoCacheAnswer(mDNS *const m, CacheRecord *rr)
4452 {
4453 LogMsg("No cache space: Delivering non-cached result for %##s", m->rec.r.resrec.name->c);
4454 if (m->CurrentQuestion)
4455 LogMsg("NoCacheAnswer ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4456 m->CurrentQuestion = m->Questions;
4457 // We do this for *all* questions, not stopping when we get to m->NewQuestions,
4458 // since we're not caching the record and we'll get no opportunity to do this later
4459 while (m->CurrentQuestion)
4460 {
4461 DNSQuestion *q = m->CurrentQuestion;
4462 if (ResourceRecordAnswersQuestion(&rr->resrec, q))
4463 AnswerCurrentQuestionWithResourceRecord(m, rr, QC_addnocache); // QC_addnocache means "don't expect remove events for this"
4464 if (m->CurrentQuestion == q) // If m->CurrentQuestion was not auto-advanced, do it ourselves now
4465 m->CurrentQuestion = q->next;
4466 }
4467 m->CurrentQuestion = mDNSNULL;
4468 }
4469
4470 // CacheRecordRmv is only called from CheckCacheExpiration, which is called from mDNS_Execute.
4471 // Note that CacheRecordRmv is *only* called for records that are referenced by at least one active question.
4472 // If new questions are created as a result of invoking client callbacks, they will be added to
4473 // the end of the question list, and m->NewQuestions will be set to indicate the first new question.
4474 // rr is an existing cache CacheRecord that just expired and is being deleted
4475 // (kDNSRecordTypePacketAns/PacketAnsUnique/PacketAdd/PacketAddUnique).
4476 // Note: CacheRecordRmv calls AnswerCurrentQuestionWithResourceRecord which can call a user callback,
4477 // which may change the record list and/or question list.
4478 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
4479 mDNSlocal void CacheRecordRmv(mDNS *const m, CacheRecord *rr)
4480 {
4481 if (m->CurrentQuestion)
4482 LogMsg("CacheRecordRmv ERROR m->CurrentQuestion already set: %##s (%s)",
4483 m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4484 m->CurrentQuestion = m->Questions;
4485
4486 // We stop when we get to NewQuestions -- for new questions their CurrentAnswers/LargeAnswers/UniqueAnswers counters
4487 // will all still be zero because we haven't yet gone through the cache counting how many answers we have for them.
4488 while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
4489 {
4490 DNSQuestion *q = m->CurrentQuestion;
4491 // When a question enters suppressed state, we generate RMV events and generate a negative
4492 // response. A cache may be present that answers this question e.g., cache entry generated
4493 // before the question became suppressed. We need to skip the suppressed questions here as
4494 // the RMV event has already been generated.
4495 if (!QuerySuppressed(q) && ResourceRecordAnswersQuestion(&rr->resrec, q) &&
4496 (q->allowExpired == AllowExpired_None || rr->resrec.mortality == Mortality_Mortal))
4497 {
4498 verbosedebugf("CacheRecordRmv %p %s", rr, CRDisplayString(m, rr));
4499 q->FlappingInterface1 = mDNSNULL;
4500 q->FlappingInterface2 = mDNSNULL;
4501
4502 if (q->CurrentAnswers == 0)
4503 LogMsg("CacheRecordRmv ERROR!!: How can CurrentAnswers already be zero for %p %##s (%s) DNSServer %#a:%d",
4504 q, q->qname.c, DNSTypeName(q->qtype), q->qDNSServer ? &q->qDNSServer->addr : mDNSNULL,
4505 mDNSVal16(q->qDNSServer ? q->qDNSServer->port : zeroIPPort));
4506 else
4507 {
4508 q->CurrentAnswers--;
4509 if (rr->resrec.rdlength > SmallRecordLimit) q->LargeAnswers--;
4510 if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) q->UniqueAnswers--;
4511 }
4512
4513 // If we have dropped below the answer threshold for this mDNS question,
4514 // restart the queries at InitialQuestionInterval.
4515 if (mDNSOpaque16IsZero(q->TargetQID) && (q->BrowseThreshold > 0) && (q->CurrentAnswers < q->BrowseThreshold))
4516 {
4517 q->ThisQInterval = InitialQuestionInterval;
4518 q->LastQTime = m->timenow - q->ThisQInterval;
4519 SetNextQueryTime(m,q);
4520 LogInfo("CacheRecordRmv: (%s) %##s dropped below threshold of %d answers",
4521 DNSTypeName(q->qtype), q->qname.c, q->BrowseThreshold);
4522 }
4523 if (rr->resrec.rdata->MaxRDLength) // Never generate "remove" events for negative results
4524 {
4525 if ((q->CurrentAnswers == 0) && mDNSOpaque16IsZero(q->TargetQID))
4526 {
4527 LogInfo("CacheRecordRmv: Last answer for %##s (%s) expired from cache; will reconfirm antecedents",
4528 q->qname.c, DNSTypeName(q->qtype));
4529 ReconfirmAntecedents(m, &q->qname, q->qnamehash, rr->resrec.InterfaceID, 0);
4530 }
4531 AnswerCurrentQuestionWithResourceRecord(m, rr, QC_rmv);
4532 }
4533 }
4534 if (m->CurrentQuestion == q) // If m->CurrentQuestion was not auto-advanced, do it ourselves now
4535 m->CurrentQuestion = q->next;
4536 }
4537 m->CurrentQuestion = mDNSNULL;
4538 }
4539
4540 mDNSlocal void ReleaseCacheEntity(mDNS *const m, CacheEntity *e)
4541 {
4542 #if APPLE_OSX_mDNSResponder && MACOSX_MDNS_MALLOC_DEBUGGING >= 1
4543 unsigned int i;
4544 for (i=0; i<sizeof(*e); i++) ((char*)e)[i] = 0xFF;
4545 #endif
4546 e->next = m->rrcache_free;
4547 m->rrcache_free = e;
4548 m->rrcache_totalused--;
4549 }
4550
4551 mDNSlocal void ReleaseCacheGroup(mDNS *const m, CacheGroup **cp)
4552 {
4553 CacheEntity *e = (CacheEntity *)(*cp);
4554 //LogMsg("ReleaseCacheGroup: Releasing CacheGroup for %p, %##s", (*cp)->name->c, (*cp)->name->c);
4555 if ((*cp)->rrcache_tail != &(*cp)->members)
4556 LogMsg("ERROR: (*cp)->members == mDNSNULL but (*cp)->rrcache_tail != &(*cp)->members)");
4557 //if ((*cp)->name != (domainname*)((*cp)->namestorage))
4558 // LogMsg("ReleaseCacheGroup: %##s, %p %p", (*cp)->name->c, (*cp)->name, (domainname*)((*cp)->namestorage));
4559 if ((*cp)->name != (domainname*)((*cp)->namestorage)) mDNSPlatformMemFree((*cp)->name);
4560 (*cp)->name = mDNSNULL;
4561 *cp = (*cp)->next; // Cut record from list
4562 ReleaseCacheEntity(m, e);
4563 }
4564
4565 mDNSlocal void ReleaseAdditionalCacheRecords(mDNS *const m, CacheRecord **rp)
4566 {
4567 while (*rp)
4568 {
4569 CacheRecord *rr = *rp;
4570 *rp = (*rp)->next; // Cut record from list
4571 if (rr->resrec.rdata && rr->resrec.rdata != (RData*)&rr->smallrdatastorage)
4572 {
4573 mDNSPlatformMemFree(rr->resrec.rdata);
4574 rr->resrec.rdata = mDNSNULL;
4575 }
4576 // NSEC or SOA records that are not added to the CacheGroup do not share the name
4577 // of the CacheGroup.
4578 if (rr->resrec.name)
4579 {
4580 debugf("ReleaseAdditionalCacheRecords: freeing cached record %##s (%s)", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
4581 mDNSPlatformMemFree((void *)rr->resrec.name);
4582 rr->resrec.name = mDNSNULL;
4583 }
4584 // Don't count the NSEC3 records used by anonymous browse/reg
4585 if (!rr->resrec.InterfaceID)
4586 {
4587 m->rrcache_totalused_unicast -= rr->resrec.rdlength;
4588 if (DNSSECRecordType(rr->resrec.rrtype))
4589 BumpDNSSECStats(m, kStatsActionDecrement, kStatsTypeMemoryUsage, rr->resrec.rdlength);
4590 }
4591 ReleaseCacheEntity(m, (CacheEntity *)rr);
4592 }
4593 }
4594
4595 mDNSexport void ReleaseCacheRecord(mDNS *const m, CacheRecord *r)
4596 {
4597 CacheGroup *cg;
4598
4599 //LogMsg("ReleaseCacheRecord: Releasing %s", CRDisplayString(m, r));
4600 if (r->resrec.rdata && r->resrec.rdata != (RData*)&r->smallrdatastorage) mDNSPlatformMemFree(r->resrec.rdata);
4601 r->resrec.rdata = mDNSNULL;
4602
4603 cg = CacheGroupForRecord(m, &r->resrec);
4604
4605 if (!cg)
4606 {
4607 // It is okay to have this printed for NSEC/NSEC3s
4608 LogInfo("ReleaseCacheRecord: ERROR!! cg NULL for %##s (%s)", r->resrec.name->c, DNSTypeName(r->resrec.rrtype));
4609 }
4610 // When NSEC records are not added to the cache, it is usually cached at the "nsec" list
4611 // of the CacheRecord. But sometimes they may be freed without adding to the "nsec" list
4612 // (which is handled below) and in that case it should be freed here.
4613 if (r->resrec.name && cg && r->resrec.name != cg->name)
4614 {
4615 debugf("ReleaseCacheRecord: freeing %##s (%s)", r->resrec.name->c, DNSTypeName(r->resrec.rrtype));
4616 mDNSPlatformMemFree((void *)r->resrec.name);
4617 }
4618 r->resrec.name = mDNSNULL;
4619
4620 if (r->resrec.AnonInfo)
4621 {
4622 debugf("ReleaseCacheRecord: freeing AnonInfo for %##s (%s)", r->resrec.name->c, DNSTypeName(r->resrec.rrtype));
4623 FreeAnonInfo((void *)r->resrec.AnonInfo);
4624 }
4625 r->resrec.AnonInfo = mDNSNULL;
4626
4627 if (!r->resrec.InterfaceID)
4628 {
4629 m->rrcache_totalused_unicast -= r->resrec.rdlength;
4630 if (DNSSECRecordType(r->resrec.rrtype))
4631 BumpDNSSECStats(m, kStatsActionDecrement, kStatsTypeMemoryUsage, r->resrec.rdlength);
4632 }
4633
4634 ReleaseAdditionalCacheRecords(m, &r->nsec);
4635 ReleaseAdditionalCacheRecords(m, &r->soa);
4636
4637 ReleaseCacheEntity(m, (CacheEntity *)r);
4638 }
4639
4640 // Note: We want to be careful that we deliver all the CacheRecordRmv calls before delivering
4641 // CacheRecordDeferredAdd calls. The in-order nature of the cache lists ensures that all
4642 // callbacks for old records are delivered before callbacks for newer records.
4643 mDNSlocal void CheckCacheExpiration(mDNS *const m, const mDNSu32 slot, CacheGroup *const cg)
4644 {
4645 CacheRecord **rp = &cg->members;
4646
4647 if (m->lock_rrcache) { LogMsg("CheckCacheExpiration ERROR! Cache already locked!"); return; }
4648 m->lock_rrcache = 1;
4649
4650 while (*rp)
4651 {
4652 CacheRecord *const rr = *rp;
4653 mDNSBool recordReleased = mDNSfalse;
4654 mDNSs32 event = RRExpireTime(rr);
4655 if (m->timenow - event >= 0) // If expired, delete it
4656 {
4657 if (rr->CRActiveQuestion) // If this record has one or more active questions, tell them it's going away
4658 {
4659 DNSQuestion *q = rr->CRActiveQuestion;
4660 verbosedebugf("CheckCacheExpiration: Removing%7d %7d %p %s",
4661 m->timenow - rr->TimeRcvd, rr->resrec.rroriginalttl, rr->CRActiveQuestion, CRDisplayString(m, rr));
4662 // When a cache record is about to expire, we expect to do four queries at 80-82%, 85-87%, 90-92% and
4663 // then 95-97% of the TTL. If the DNS server does not respond, then we will remove the cache entry
4664 // before we pick a new DNS server. As the question interval is set to MaxQuestionInterval, we may
4665 // not send out a query anytime soon. Hence, we need to reset the question interval. If this is
4666 // a normal deferred ADD case, then AnswerCurrentQuestionWithResourceRecord will reset it to
4667 // MaxQuestionInterval. If we have inactive questions referring to negative cache entries,
4668 // don't ressurect them as they will deliver duplicate "No such Record" ADD events
4669 if (!mDNSOpaque16IsZero(q->TargetQID) && !q->LongLived && ActiveQuestion(q))
4670 {
4671 q->ThisQInterval = InitialQuestionInterval;
4672 q->LastQTime = m->timenow - q->ThisQInterval;
4673 SetNextQueryTime(m, q);
4674 }
4675 CacheRecordRmv(m, rr);
4676 m->rrcache_active--;
4677 }
4678
4679 event += MAX_GHOST_TIME; // Adjust so we can check for a ghost expiration
4680 if (rr->resrec.mortality == Mortality_Mortal || // Normal expired mortal record that needs released
4681 (rr->resrec.mortality == Mortality_Ghost && m->timenow - event >= 0)) // A ghost record that expired more than MAX_GHOST_TIME ago
4682 { // Release as normal
4683 *rp = rr->next; // Cut it from the list before ReleaseCacheRecord
4684 verbosedebugf("CheckCacheExpiration: Deleting (%s)%7d %7d %p %s",
4685 MortalityDisplayString(rr->resrec.mortality),
4686 m->timenow - rr->TimeRcvd, rr->resrec.rroriginalttl, rr->CRActiveQuestion, CRDisplayString(m, rr));
4687 ReleaseCacheRecord(m, rr);
4688 recordReleased = mDNStrue;
4689 }
4690 else // An immortal record needs to become a ghost when it expires
4691 { // Don't release this entry
4692 if (rr->resrec.mortality == Mortality_Immortal)
4693 {
4694 rr->resrec.mortality = Mortality_Ghost; // Expired immortal records become ghosts
4695 verbosedebugf("CheckCacheExpiration: NOT Deleting (%s)%7d %7d %p %s",
4696 MortalityDisplayString(rr->resrec.mortality),
4697 m->timenow - rr->TimeRcvd, rr->resrec.rroriginalttl, rr->CRActiveQuestion, CRDisplayString(m, rr));
4698 }
4699 }
4700 }
4701 else // else, not expired; see if we need to query
4702 {
4703 // If waiting to delay delivery, do nothing until then
4704 if (rr->DelayDelivery && rr->DelayDelivery - m->timenow > 0)
4705 event = rr->DelayDelivery;
4706 else
4707 {
4708 if (rr->DelayDelivery) CacheRecordDeferredAdd(m, rr);
4709 if (rr->CRActiveQuestion && rr->UnansweredQueries < MaxUnansweredQueries)
4710 {
4711 if (m->timenow - rr->NextRequiredQuery < 0) // If not yet time for next query
4712 event = NextCacheCheckEvent(rr); // then just record when we want the next query
4713 else // else trigger our question to go out now
4714 {
4715 // Set NextScheduledQuery to timenow so that SendQueries() will run.
4716 // SendQueries() will see that we have records close to expiration, and send FEQs for them.
4717 m->NextScheduledQuery = m->timenow;
4718 // After sending the query we'll increment UnansweredQueries and call SetNextCacheCheckTimeForRecord(),
4719 // which will correctly update m->NextCacheCheck for us.
4720 event = m->timenow + FutureTime;
4721 }
4722 }
4723 }
4724 }
4725
4726 if (!recordReleased) // Schedule if we did not release the record
4727 {
4728 verbosedebugf("CheckCacheExpiration:%6d %5d %s",
4729 (event - m->timenow) / mDNSPlatformOneSecond, CacheCheckGracePeriod(rr), CRDisplayString(m, rr));
4730 if (m->rrcache_nextcheck[slot] - event > 0)
4731 m->rrcache_nextcheck[slot] = event;
4732 rp = &rr->next;
4733 }
4734 }
4735 if (cg->rrcache_tail != rp) verbosedebugf("CheckCacheExpiration: Updating CacheGroup tail from %p to %p", cg->rrcache_tail, rp);
4736 cg->rrcache_tail = rp;
4737 m->lock_rrcache = 0;
4738 }
4739
4740 // "LORecord" includes both LocalOnly and P2P record. This function assumes m->CurrentQuestion is pointing to "q".
4741 //
4742 // If "CheckOnly" is set to "true", the question won't be answered but just check to see if there is an answer and
4743 // returns true if there is an answer.
4744 //
4745 // If "CheckOnly" is set to "false", the question will be answered if there is a LocalOnly/P2P record and
4746 // returns true to indicate the same.
4747 mDNSlocal mDNSBool AnswerQuestionWithLORecord(mDNS *const m, DNSQuestion *q, mDNSBool checkOnly)
4748 {
4749 AuthRecord *lr;
4750 AuthGroup *ag;
4751
4752 if (m->CurrentRecord)
4753 LogMsg("AnswerQuestionWithLORecord ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
4754
4755 ag = AuthGroupForName(&m->rrauth, q->qnamehash, &q->qname);
4756 if (ag)
4757 {
4758 m->CurrentRecord = ag->members;
4759 while (m->CurrentRecord && m->CurrentRecord != ag->NewLocalOnlyRecords)
4760 {
4761 AuthRecord *rr = m->CurrentRecord;
4762 m->CurrentRecord = rr->next;
4763 //
4764 // If the question is mDNSInterface_LocalOnly, all records local to the machine should be used
4765 // to answer the query. This is handled in AnswerNewLocalOnlyQuestion.
4766 //
4767 // We handle mDNSInterface_Any and scoped questions here. See LocalOnlyRecordAnswersQuestion for more
4768 // details on how we handle this case. For P2P we just handle "Interface_Any" questions. For LocalOnly
4769 // we handle both mDNSInterface_Any and scoped questions.
4770
4771 if (rr->ARType == AuthRecordLocalOnly || (rr->ARType == AuthRecordP2P && (q->InterfaceID == mDNSInterface_Any || q->InterfaceID == mDNSInterface_BLE)))
4772 if (LocalOnlyRecordAnswersQuestion(rr, q))
4773 {
4774 if (checkOnly)
4775 {
4776 LogInfo("AnswerQuestionWithLORecord: question %##s (%s) answered by %s", q->qname.c, DNSTypeName(q->qtype),
4777 ARDisplayString(m, rr));
4778 m->CurrentRecord = mDNSNULL;
4779 return mDNStrue;
4780 }
4781 AnswerLocalQuestionWithLocalAuthRecord(m, rr, mDNStrue);
4782 if (m->CurrentQuestion != q)
4783 break; // If callback deleted q, then we're finished here
4784 }
4785 }
4786 }
4787 m->CurrentRecord = mDNSNULL;
4788
4789 if (m->CurrentQuestion != q)
4790 {
4791 LogInfo("AnswerQuestionWithLORecord: Question deleted while while answering LocalOnly record answers");
4792 return mDNStrue;
4793 }
4794
4795 if (q->LOAddressAnswers)
4796 {
4797 LogInfo("AnswerQuestionWithLORecord: Question %p %##s (%s) answered using local auth records LOAddressAnswers %d",
4798 q, q->qname.c, DNSTypeName(q->qtype), q->LOAddressAnswers);
4799 return mDNStrue;
4800 }
4801
4802 // Before we go check the cache and ship this query on the wire, we have to be sure that there are
4803 // no local records that could possibly answer this question. As we did not check the NewLocalRecords, we
4804 // need to just peek at them to see whether it will answer this question. If it would answer, pretend
4805 // that we answered. AnswerAllLocalQuestionsWithLocalAuthRecord will answer shortly. This happens normally
4806 // when we add new /etc/hosts entries and restart the question. It is a new question and also a new record.
4807 if (ag)
4808 {
4809 lr = ag->NewLocalOnlyRecords;
4810 while (lr)
4811 {
4812 if (UniqueLocalOnlyRecord(lr) && LocalOnlyRecordAnswersQuestion(lr, q))
4813 {
4814 LogInfo("AnswerQuestionWithLORecord: Question %p %##s (%s) will be answered using new local auth records "
4815 " LOAddressAnswers %d", q, q->qname.c, DNSTypeName(q->qtype), q->LOAddressAnswers);
4816 return mDNStrue;
4817 }
4818 lr = lr->next;
4819 }
4820 }
4821 return mDNSfalse;
4822 }
4823
4824 // Today, we suppress questions (not send them on the wire) for several reasons e.g.,
4825 // AAAA query is suppressed because no IPv6 capability or PID is not allowed to make
4826 // DNS requests. We need to temporarily suspend the suppress status so that we can
4827 // deliver a negative response (AnswerCurrentQuestionWithResourceRecord does not answer
4828 // suppressed questions) and reset it back. In the future, if there are other
4829 // reasons for suppressing the query, this function should be updated.
4830 mDNSlocal void AnswerSuppressedQuestion(mDNS *const m, DNSQuestion *q)
4831 {
4832 mDNSBool SuppressQuery;
4833 mDNSBool DisallowPID;
4834
4835 // If the client did not set the kDNSServiceFlagsReturnIntermediates flag, then don't generate a negative response, just
4836 // deactivate the DNSQuestion.
4837 if (!q->ReturnIntermed)
4838 {
4839 q->ThisQInterval = 0;
4840 return;
4841 }
4842
4843 SuppressQuery = q->SuppressQuery;
4844 DisallowPID = q->DisallowPID;
4845
4846 // make sure that QuerySuppressed() returns false
4847 q->SuppressQuery = mDNSfalse;
4848 q->DisallowPID = mDNSfalse;
4849
4850 GenerateNegativeResponse(m, mDNSInterface_Any, QC_suppressed);
4851
4852 q->SuppressQuery = SuppressQuery;
4853 q->DisallowPID = DisallowPID;
4854 }
4855
4856 mDNSlocal void AnswerNewQuestion(mDNS *const m)
4857 {
4858 mDNSBool ShouldQueryImmediately = mDNStrue;
4859 DNSQuestion *const q = m->NewQuestions; // Grab the question we're going to answer
4860 #if USE_DNS64
4861 if (!mDNSOpaque16IsZero(q->TargetQID)) DNS64HandleNewQuestion(m, q);
4862 #endif
4863 CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
4864 mDNSBool AnsweredFromCache = mDNSfalse;
4865
4866 verbosedebugf("AnswerNewQuestion: Answering %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4867
4868 if (cg) CheckCacheExpiration(m, HashSlotFromNameHash(q->qnamehash), cg);
4869 if (m->NewQuestions != q) { LogInfo("AnswerNewQuestion: Question deleted while doing CheckCacheExpiration"); goto exit; }
4870 m->NewQuestions = q->next;
4871 // Advance NewQuestions to the next *after* calling CheckCacheExpiration, because if we advance it first
4872 // then CheckCacheExpiration may give this question add/remove callbacks, and it's not yet ready for that.
4873 //
4874 // Also, CheckCacheExpiration() calls CacheRecordDeferredAdd() and CacheRecordRmv(), which invoke
4875 // client callbacks, which may delete their own or any other question. Our mechanism for detecting
4876 // whether our current m->NewQuestions question got deleted by one of these callbacks is to store the
4877 // value of m->NewQuestions in 'q' before calling CheckCacheExpiration(), and then verify afterwards
4878 // that they're still the same. If m->NewQuestions has changed (because mDNS_StopQuery_internal
4879 // advanced it), that means the question was deleted, so we no longer need to worry about answering
4880 // it (and indeed 'q' is now a dangling pointer, so dereferencing it at all would be bad, and the
4881 // values we computed for slot and cg are now stale and relate to a question that no longer exists).
4882 //
4883 // We can't use the usual m->CurrentQuestion mechanism for this because CacheRecordDeferredAdd() and
4884 // CacheRecordRmv() both use that themselves when walking the list of (non-new) questions generating callbacks.
4885 // Fortunately mDNS_StopQuery_internal auto-advances both m->CurrentQuestion *AND* m->NewQuestions when
4886 // deleting a question, so luckily we have an easy alternative way of detecting if our question got deleted.
4887
4888 if (m->lock_rrcache) LogMsg("AnswerNewQuestion ERROR! Cache already locked!");
4889 // This should be safe, because calling the client's question callback may cause the
4890 // question list to be modified, but should not ever cause the rrcache list to be modified.
4891 // If the client's question callback deletes the question, then m->CurrentQuestion will
4892 // be advanced, and we'll exit out of the loop
4893 m->lock_rrcache = 1;
4894 if (m->CurrentQuestion)
4895 LogMsg("AnswerNewQuestion ERROR m->CurrentQuestion already set: %##s (%s)",
4896 m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
4897 m->CurrentQuestion = q; // Indicate which question we're answering, so we'll know if it gets deleted
4898
4899 if (q->NoAnswer == NoAnswer_Fail)
4900 {
4901 LogMsg("AnswerNewQuestion: NoAnswer_Fail %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4902 MakeNegativeCacheRecord(m, &m->rec.r, &q->qname, q->qnamehash, q->qtype, q->qclass, 60, mDNSInterface_Any, q->qDNSServer);
4903 q->NoAnswer = NoAnswer_Normal; // Temporarily turn off answer suppression
4904 AnswerCurrentQuestionWithResourceRecord(m, &m->rec.r, QC_addnocache);
4905 // Don't touch the question if it has been stopped already
4906 if (m->CurrentQuestion == q) q->NoAnswer = NoAnswer_Fail; // Restore NoAnswer state
4907 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
4908 }
4909
4910 if (m->CurrentQuestion != q)
4911 {
4912 LogInfo("AnswerNewQuestion: Question deleted while generating NoAnswer_Fail response");
4913 goto exit;
4914 }
4915
4916 // See if we want to tell it about LocalOnly/P2P records. If we answered them using LocalOnly
4917 // or P2P record, then we are done.
4918 if (AnswerQuestionWithLORecord(m, q, mDNSfalse))
4919 goto exit;
4920
4921 // If we are not supposed to answer this question, generate a negative response.
4922 // Temporarily suspend the SuppressQuery so that AnswerCurrentQuestionWithResourceRecord can answer the question
4923 //
4924 // If it is a question trying to validate some response, it already checked the cache for a response. If it still
4925 // reissues a question it means it could not find the RRSIGs. So, we need to bypass the cache check and send
4926 // the question out.
4927 if (QuerySuppressed(q))
4928 {
4929 AnswerSuppressedQuestion(m, q);
4930 }
4931 else if (!q->ValidatingResponse)
4932 {
4933 CacheRecord *rr;
4934 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
4935 if (SameNameRecordAnswersQuestion(&rr->resrec, q))
4936 {
4937 // SecsSinceRcvd is whole number of elapsed seconds, rounded down
4938 mDNSu32 SecsSinceRcvd = ((mDNSu32)(m->timenow - rr->TimeRcvd)) / mDNSPlatformOneSecond;
4939 if (rr->resrec.rroriginalttl <= SecsSinceRcvd && q->allowExpired != AllowExpired_AllowExpiredAnswers) continue; // Go to next one in loop
4940
4941 // If this record set is marked unique, then that means we can reasonably assume we have the whole set
4942 // -- we don't need to rush out on the network and query immediately to see if there are more answers out there
4943 if ((rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) || (q->ExpectUnique))
4944 ShouldQueryImmediately = mDNSfalse;
4945 q->CurrentAnswers++;
4946 if (rr->resrec.rdlength > SmallRecordLimit) q->LargeAnswers++;
4947 if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) q->UniqueAnswers++;
4948 AnsweredFromCache = mDNStrue;
4949 #if AWD_METRICS
4950 if (q->metrics.expiredAnswerState == ExpiredAnswer_Allowed) q->metrics.expiredAnswerState = ExpiredAnswer_AnsweredWithExpired;
4951 #endif
4952 AnswerCurrentQuestionWithResourceRecord(m, rr, QC_add);
4953 if (m->CurrentQuestion != q) break; // If callback deleted q, then we're finished here
4954 }
4955 else if (mDNSOpaque16IsZero(q->TargetQID) && RRTypeIsAddressType(rr->resrec.rrtype) && RRTypeIsAddressType(q->qtype))
4956 ShouldQueryImmediately = mDNSfalse;
4957 }
4958 // We don't use LogInfo for this "Question deleted" message because it happens so routinely that
4959 // it's not remotely remarkable, and therefore unlikely to be of much help tracking down bugs.
4960 if (m->CurrentQuestion != q) { debugf("AnswerNewQuestion: Question deleted while giving cache answers"); goto exit; }
4961
4962 // Neither a local record nor a cache entry could answer this question. If this question need to be retried
4963 // with search domains, generate a negative response which will now retry after appending search domains.
4964 // If the query was suppressed above, we already generated a negative response. When it gets unsuppressed,
4965 // we will retry with search domains.
4966 if (!QuerySuppressed(q) && !AnsweredFromCache && q->RetryWithSearchDomains)
4967 {
4968 LogInfo("AnswerNewQuestion: Generating response for retrying with search domains %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4969 GenerateNegativeResponse(m, mDNSInterface_Any, QC_forceresponse);
4970 }
4971
4972 if (m->CurrentQuestion != q) { debugf("AnswerNewQuestion: Question deleted while giving negative answer"); goto exit; }
4973
4974 if (q->allowExpired == AllowExpired_AllowExpiredAnswers)
4975 {
4976 q->allowExpired = AllowExpired_MakeAnswersImmortal; // After looking through the cache for an answer, demote to make immortal
4977 if (q->firstExpiredQname.c[0]) // If an original query name was saved on an expired answer, start it over in case it is updated
4978 {
4979 LogMsg("AnswerNewQuestion: Restarting original question %p firstExpiredQname %##s for allowExpiredAnswers question", q, &q->firstExpiredQname.c);
4980 mDNS_StopQuery_internal(m, q); // Stop old query
4981 AssignDomainName(&q->qname, &q->firstExpiredQname); // Update qname
4982 q->qnamehash = DomainNameHashValue(&q->qname); // and namehash
4983 mDNS_StartQuery_internal(m, q); // start new query
4984 q->CNAMEReferrals = 0; // Reset referral count
4985 q->firstExpiredQname.c[0] = 0; // Erase the domain name
4986 }
4987 }
4988
4989 // Note: When a query gets suppressed or retried with search domains, we de-activate the question.
4990 // Hence we don't execute the following block of code for those cases.
4991 if (ShouldQueryImmediately && ActiveQuestion(q))
4992 {
4993 debugf("AnswerNewQuestion: ShouldQueryImmediately %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4994 q->ThisQInterval = InitialQuestionInterval;
4995 q->LastQTime = m->timenow - q->ThisQInterval;
4996 if (mDNSOpaque16IsZero(q->TargetQID)) // For mDNS, spread packets to avoid a burst of simultaneous queries
4997 {
4998 // Compute random delay in the range 1-6 seconds, then divide by 50 to get 20-120ms
4999 if (!m->RandomQueryDelay)
5000 m->RandomQueryDelay = (mDNSPlatformOneSecond + mDNSRandom(mDNSPlatformOneSecond*5) - 1) / 50 + 1;
5001 q->LastQTime += m->RandomQueryDelay;
5002 }
5003 }
5004
5005 // IN ALL CASES make sure that m->NextScheduledQuery is set appropriately.
5006 // In cases where m->NewQuestions->DelayAnswering is set, we may have delayed generating our
5007 // answers for this question until *after* its scheduled transmission time, in which case
5008 // m->NextScheduledQuery may now be set to 'never', and in that case -- even though we're *not* doing
5009 // ShouldQueryImmediately -- we still need to make sure we set m->NextScheduledQuery correctly.
5010 SetNextQueryTime(m,q);
5011
5012 exit:
5013 m->CurrentQuestion = mDNSNULL;
5014 m->lock_rrcache = 0;
5015 }
5016
5017 // When a NewLocalOnlyQuestion is created, AnswerNewLocalOnlyQuestion runs though our ResourceRecords delivering any
5018 // appropriate answers, stopping if it reaches a NewLocalOnlyRecord -- these will be handled by AnswerAllLocalQuestionsWithLocalAuthRecord
5019 mDNSlocal void AnswerNewLocalOnlyQuestion(mDNS *const m)
5020 {
5021 AuthGroup *ag;
5022 DNSQuestion *q = m->NewLocalOnlyQuestions; // Grab the question we're going to answer
5023 mDNSBool retEv = mDNSfalse;
5024 m->NewLocalOnlyQuestions = q->next; // Advance NewLocalOnlyQuestions to the next (if any)
5025
5026 debugf("AnswerNewLocalOnlyQuestion: Answering %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5027
5028 if (m->CurrentQuestion)
5029 LogMsg("AnswerNewLocalOnlyQuestion ERROR m->CurrentQuestion already set: %##s (%s)",
5030 m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
5031 m->CurrentQuestion = q; // Indicate which question we're answering, so we'll know if it gets deleted
5032
5033 if (m->CurrentRecord)
5034 LogMsg("AnswerNewLocalOnlyQuestion ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
5035
5036 // 1. First walk the LocalOnly records answering the LocalOnly question
5037 // 2. As LocalOnly questions should also be answered by any other Auth records local to the machine,
5038 // walk the ResourceRecords list delivering the answers
5039 ag = AuthGroupForName(&m->rrauth, q->qnamehash, &q->qname);
5040 if (ag)
5041 {
5042 m->CurrentRecord = ag->members;
5043 while (m->CurrentRecord && m->CurrentRecord != ag->NewLocalOnlyRecords)
5044 {
5045 AuthRecord *rr = m->CurrentRecord;
5046 m->CurrentRecord = rr->next;
5047 if (LocalOnlyRecordAnswersQuestion(rr, q))
5048 {
5049 retEv = mDNStrue;
5050 AnswerLocalQuestionWithLocalAuthRecord(m, rr, mDNStrue);
5051 if (m->CurrentQuestion != q) break; // If callback deleted q, then we're finished here
5052 }
5053 }
5054 }
5055
5056 if (m->CurrentQuestion == q)
5057 {
5058 m->CurrentRecord = m->ResourceRecords;
5059
5060 while (m->CurrentRecord && m->CurrentRecord != m->NewLocalRecords)
5061 {
5062 AuthRecord *rr = m->CurrentRecord;
5063 m->CurrentRecord = rr->next;
5064 if (ResourceRecordAnswersQuestion(&rr->resrec, q))
5065 {
5066 retEv = mDNStrue;
5067 AnswerLocalQuestionWithLocalAuthRecord(m, rr, mDNStrue);
5068 if (m->CurrentQuestion != q) break; // If callback deleted q, then we're finished here
5069 }
5070 }
5071 }
5072
5073 // The local host is the authoritative source for LocalOnly questions
5074 // so if no records exist and client requested intermediates, then generate a negative response
5075 if (!retEv && (m->CurrentQuestion == q) && q->ReturnIntermed)
5076 GenerateNegativeResponse(m, mDNSInterface_LocalOnly, QC_forceresponse);
5077
5078 m->CurrentQuestion = mDNSNULL;
5079 m->CurrentRecord = mDNSNULL;
5080 }
5081
5082 mDNSlocal CacheEntity *GetCacheEntity(mDNS *const m, const CacheGroup *const PreserveCG)
5083 {
5084 CacheEntity *e = mDNSNULL;
5085
5086 if (m->lock_rrcache) { LogMsg("GetFreeCacheRR ERROR! Cache already locked!"); return(mDNSNULL); }
5087 m->lock_rrcache = 1;
5088
5089 // If we have no free records, ask the client layer to give us some more memory
5090 if (!m->rrcache_free && m->MainCallback)
5091 {
5092 if (m->rrcache_totalused != m->rrcache_size)
5093 LogMsg("GetFreeCacheRR: count mismatch: m->rrcache_totalused %lu != m->rrcache_size %lu",
5094 m->rrcache_totalused, m->rrcache_size);
5095
5096 // We don't want to be vulnerable to a malicious attacker flooding us with an infinite
5097 // number of bogus records so that we keep growing our cache until the machine runs out of memory.
5098 // To guard against this, if our cache grows above 512kB (approx 3168 records at 164 bytes each),
5099 // and we're actively using less than 1/32 of that cache, then we purge all the unused records
5100 // and recycle them, instead of allocating more memory.
5101 if (m->rrcache_size > 5000 && m->rrcache_size / 32 > m->rrcache_active)
5102 LogInfo("Possible denial-of-service attack in progress: m->rrcache_size %lu; m->rrcache_active %lu",
5103 m->rrcache_size, m->rrcache_active);
5104 else
5105 {
5106 mDNS_DropLockBeforeCallback(); // Allow client to legally make mDNS API calls from the callback
5107 m->MainCallback(m, mStatus_GrowCache);
5108 mDNS_ReclaimLockAfterCallback(); // Decrement mDNS_reentrancy to block mDNS API calls again
5109 }
5110 }
5111
5112 // If we still have no free records, recycle all the records we can.
5113 // Enumerating the entire cache is moderately expensive, so when we do it, we reclaim all the records we can in one pass.
5114 if (!m->rrcache_free)
5115 {
5116 mDNSu32 oldtotalused = m->rrcache_totalused;
5117 mDNSu32 slot;
5118 for (slot = 0; slot < CACHE_HASH_SLOTS; slot++)
5119 {
5120 CacheGroup **cp = &m->rrcache_hash[slot];
5121 while (*cp)
5122 {
5123 CacheRecord **rp = &(*cp)->members;
5124 while (*rp)
5125 {
5126 // Records that answer still-active questions are not candidates for recycling
5127 // Records that are currently linked into the CacheFlushRecords list may not be recycled, or we'll crash
5128 if ((*rp)->CRActiveQuestion || (*rp)->NextInCFList)
5129 rp=&(*rp)->next;
5130 else
5131 {
5132 CacheRecord *rr = *rp;
5133 *rp = (*rp)->next; // Cut record from list
5134 ReleaseCacheRecord(m, rr);
5135 }
5136 }
5137 if ((*cp)->rrcache_tail != rp)
5138 verbosedebugf("GetFreeCacheRR: Updating rrcache_tail[%lu] from %p to %p", slot, (*cp)->rrcache_tail, rp);
5139 (*cp)->rrcache_tail = rp;
5140 if ((*cp)->members || (*cp)==PreserveCG) cp=&(*cp)->next;
5141 else ReleaseCacheGroup(m, cp);
5142 }
5143 }
5144 LogInfo("GetCacheEntity recycled %d records to reduce cache from %d to %d",
5145 oldtotalused - m->rrcache_totalused, oldtotalused, m->rrcache_totalused);
5146 }
5147
5148 if (m->rrcache_free) // If there are records in the free list, take one
5149 {
5150 e = m->rrcache_free;
5151 m->rrcache_free = e->next;
5152 if (++m->rrcache_totalused >= m->rrcache_report)
5153 {
5154 LogInfo("RR Cache now using %ld objects", m->rrcache_totalused);
5155 if (m->rrcache_report < 100) m->rrcache_report += 10;
5156 else if (m->rrcache_report < 1000) m->rrcache_report += 100;
5157 else m->rrcache_report += 1000;
5158 }
5159 mDNSPlatformMemZero(e, sizeof(*e));
5160 }
5161
5162 m->lock_rrcache = 0;
5163
5164 return(e);
5165 }
5166
5167 mDNSlocal CacheRecord *GetCacheRecord(mDNS *const m, CacheGroup *cg, mDNSu16 RDLength)
5168 {
5169 CacheRecord *r = (CacheRecord *)GetCacheEntity(m, cg);
5170 if (r)
5171 {
5172 r->resrec.rdata = (RData*)&r->smallrdatastorage; // By default, assume we're usually going to be using local storage
5173 if (RDLength > InlineCacheRDSize) // If RDLength is too big, allocate extra storage
5174 {
5175 r->resrec.rdata = (RData*)mDNSPlatformMemAllocate(sizeofRDataHeader + RDLength);
5176 if (r->resrec.rdata) r->resrec.rdata->MaxRDLength = r->resrec.rdlength = RDLength;
5177 else { ReleaseCacheEntity(m, (CacheEntity*)r); r = mDNSNULL; }
5178 }
5179 }
5180 return(r);
5181 }
5182
5183 mDNSlocal CacheGroup *GetCacheGroup(mDNS *const m, const mDNSu32 slot, const ResourceRecord *const rr)
5184 {
5185 mDNSu16 namelen = DomainNameLength(rr->name);
5186 CacheGroup *cg = (CacheGroup*)GetCacheEntity(m, mDNSNULL);
5187 if (!cg) { LogMsg("GetCacheGroup: Failed to allocate memory for %##s", rr->name->c); return(mDNSNULL); }
5188 cg->next = m->rrcache_hash[slot];
5189 cg->namehash = rr->namehash;
5190 cg->members = mDNSNULL;
5191 cg->rrcache_tail = &cg->members;
5192 if (namelen > sizeof(cg->namestorage))
5193 cg->name = mDNSPlatformMemAllocate(namelen);
5194 else
5195 cg->name = (domainname*)cg->namestorage;
5196 if (!cg->name)
5197 {
5198 LogMsg("GetCacheGroup: Failed to allocate name storage for %##s", rr->name->c);
5199 ReleaseCacheEntity(m, (CacheEntity*)cg);
5200 return(mDNSNULL);
5201 }
5202 AssignDomainName(cg->name, rr->name);
5203
5204 if (CacheGroupForRecord(m, rr)) LogMsg("GetCacheGroup: Already have CacheGroup for %##s", rr->name->c);
5205 m->rrcache_hash[slot] = cg;
5206 if (CacheGroupForRecord(m, rr) != cg) LogMsg("GetCacheGroup: Not finding CacheGroup for %##s", rr->name->c);
5207
5208 return(cg);
5209 }
5210
5211 mDNSexport void mDNS_PurgeCacheResourceRecord(mDNS *const m, CacheRecord *rr)
5212 {
5213 mDNS_CheckLock(m);
5214
5215 // Make sure we mark this record as thoroughly expired -- we don't ever want to give
5216 // a positive answer using an expired record (e.g. from an interface that has gone away).
5217 // We don't want to clear CRActiveQuestion here, because that would leave the record subject to
5218 // summary deletion without giving the proper callback to any questions that are monitoring it.
5219 // By setting UnansweredQueries to MaxUnansweredQueries we ensure it won't trigger any further expiration queries.
5220 rr->TimeRcvd = m->timenow - mDNSPlatformOneSecond * 60;
5221 rr->UnansweredQueries = MaxUnansweredQueries;
5222 rr->resrec.rroriginalttl = 0;
5223 SetNextCacheCheckTimeForRecord(m, rr);
5224 }
5225
5226 mDNSexport mDNSs32 mDNS_TimeNow(const mDNS *const m)
5227 {
5228 mDNSs32 time;
5229 mDNSPlatformLock(m);
5230 if (m->mDNS_busy)
5231 {
5232 LogMsg("mDNS_TimeNow called while holding mDNS lock. This is incorrect. Code protected by lock should just use m->timenow.");
5233 if (!m->timenow) LogMsg("mDNS_TimeNow: m->mDNS_busy is %ld but m->timenow not set", m->mDNS_busy);
5234 }
5235
5236 if (m->timenow) time = m->timenow;
5237 else time = mDNS_TimeNow_NoLock(m);
5238 mDNSPlatformUnlock(m);
5239 return(time);
5240 }
5241
5242 // To avoid pointless CPU thrash, we use SetSPSProxyListChanged(X) to record the last interface that
5243 // had its Sleep Proxy client list change, and defer to actual BPF reconfiguration to mDNS_Execute().
5244 // (GetNextScheduledEvent() returns "now" when m->SPSProxyListChanged is set)
5245 #define SetSPSProxyListChanged(X) do { \
5246 if (m->SPSProxyListChanged && m->SPSProxyListChanged != (X)) mDNSPlatformUpdateProxyList(m->SPSProxyListChanged); \
5247 m->SPSProxyListChanged = (X); } while(0)
5248
5249 // Called from mDNS_Execute() to expire stale proxy records
5250 mDNSlocal void CheckProxyRecords(mDNS *const m, AuthRecord *list)
5251 {
5252 m->CurrentRecord = list;
5253 while (m->CurrentRecord)
5254 {
5255 AuthRecord *rr = m->CurrentRecord;
5256 if (rr->resrec.RecordType != kDNSRecordTypeDeregistering && rr->WakeUp.HMAC.l[0])
5257 {
5258 // If m->SPSSocket is NULL that means we're not acting as a sleep proxy any more,
5259 // so we need to cease proxying for *all* records we may have, expired or not.
5260 if (m->SPSSocket && m->timenow - rr->TimeExpire < 0) // If proxy record not expired yet, update m->NextScheduledSPS
5261 {
5262 if (m->NextScheduledSPS - rr->TimeExpire > 0)
5263 m->NextScheduledSPS = rr->TimeExpire;
5264 }
5265 else // else proxy record expired, so remove it
5266 {
5267 LogSPS("CheckProxyRecords: Removing %d H-MAC %.6a I-MAC %.6a %d %s",
5268 m->ProxyRecords, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, rr->WakeUp.seq, ARDisplayString(m, rr));
5269 SetSPSProxyListChanged(rr->resrec.InterfaceID);
5270 mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
5271 // Don't touch rr after this -- memory may have been free'd
5272 }
5273 }
5274 // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
5275 // new records could have been added to the end of the list as a result of that call.
5276 if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
5277 m->CurrentRecord = rr->next;
5278 }
5279 }
5280
5281 mDNSlocal void CheckRmvEventsForLocalRecords(mDNS *const m)
5282 {
5283 while (m->CurrentRecord)
5284 {
5285 AuthRecord *rr = m->CurrentRecord;
5286 if (rr->AnsweredLocalQ && rr->resrec.RecordType == kDNSRecordTypeDeregistering)
5287 {
5288 debugf("CheckRmvEventsForLocalRecords: Generating local RMV events for %s", ARDisplayString(m, rr));
5289 rr->resrec.RecordType = kDNSRecordTypeShared;
5290 AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNSfalse);
5291 if (m->CurrentRecord == rr) // If rr still exists in list, restore its state now
5292 {
5293 rr->resrec.RecordType = kDNSRecordTypeDeregistering;
5294 rr->AnsweredLocalQ = mDNSfalse;
5295 // SendResponses normally calls CompleteDeregistration after sending goodbyes.
5296 // For LocalOnly records, we don't do that and hence we need to do that here.
5297 if (RRLocalOnly(rr)) CompleteDeregistration(m, rr);
5298 }
5299 }
5300 if (m->CurrentRecord == rr) // If m->CurrentRecord was not auto-advanced, do it ourselves now
5301 m->CurrentRecord = rr->next;
5302 }
5303 }
5304
5305 mDNSlocal void TimeoutQuestions_internal(mDNS *const m, DNSQuestion* questions, mDNSInterfaceID InterfaceID)
5306 {
5307 if (m->CurrentQuestion)
5308 LogMsg("TimeoutQuestions ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c,
5309 DNSTypeName(m->CurrentQuestion->qtype));
5310 m->CurrentQuestion = questions;
5311 while (m->CurrentQuestion)
5312 {
5313 DNSQuestion *const q = m->CurrentQuestion;
5314 if (q->StopTime)
5315 {
5316 if (!q->TimeoutQuestion)
5317 LogMsg("TimeoutQuestions: ERROR!! TimeoutQuestion not set, but StopTime set for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5318
5319 if (m->timenow - q->StopTime >= 0)
5320 {
5321 LogInfo("TimeoutQuestions: question %p %##s timed out, time %d", q, q->qname.c, m->timenow - q->StopTime);
5322 q->LOAddressAnswers = 0; // unset since timing out the question
5323 GenerateNegativeResponse(m, InterfaceID, QC_forceresponse);
5324 if (m->CurrentQuestion == q) q->StopTime = 0;
5325 }
5326 else
5327 {
5328 if (m->NextScheduledStopTime - q->StopTime > 0)
5329 m->NextScheduledStopTime = q->StopTime;
5330 }
5331 }
5332 // If m->CurrentQuestion wasn't modified out from under us, advance it now
5333 // We can't do this at the start of the loop because GenerateNegativeResponse
5334 // depends on having m->CurrentQuestion point to the right question
5335 if (m->CurrentQuestion == q)
5336 m->CurrentQuestion = q->next;
5337 }
5338 m->CurrentQuestion = mDNSNULL;
5339 }
5340
5341 mDNSlocal void TimeoutQuestions(mDNS *const m)
5342 {
5343 m->NextScheduledStopTime = m->timenow + FutureTime; // push reschedule of TimeoutQuestions to way off into the future
5344 TimeoutQuestions_internal(m, m->Questions, mDNSInterface_Any);
5345 TimeoutQuestions_internal(m, m->LocalOnlyQuestions, mDNSInterface_LocalOnly);
5346 }
5347
5348 mDNSlocal void mDNSCoreFreeProxyRR(mDNS *const m)
5349 {
5350 AuthRecord *rrPtr = m->SPSRRSet, *rrNext = mDNSNULL;
5351 LogSPS("%s : Freeing stored sleep proxy A/AAAA records", __func__);
5352 while (rrPtr)
5353 {
5354 rrNext = rrPtr->next;
5355 mDNSPlatformMemFree(rrPtr);
5356 rrPtr = rrNext;
5357 }
5358 m->SPSRRSet = mDNSNULL;
5359 }
5360
5361 mDNSexport mDNSs32 mDNS_Execute(mDNS *const m)
5362 {
5363 mDNS_Lock(m); // Must grab lock before trying to read m->timenow
5364
5365 if (m->timenow - m->NextScheduledEvent >= 0)
5366 {
5367 int i;
5368 AuthRecord *head, *tail;
5369 mDNSu32 slot;
5370 AuthGroup *ag;
5371
5372 verbosedebugf("mDNS_Execute");
5373
5374 if (m->CurrentQuestion)
5375 LogMsg("mDNS_Execute: ERROR m->CurrentQuestion already set: %##s (%s)",
5376 m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
5377
5378 if (m->CurrentRecord)
5379 LogMsg("mDNS_Execute: ERROR m->CurrentRecord already set: %s", ARDisplayString(m, m->CurrentRecord));
5380
5381 // 1. If we're past the probe suppression time, we can clear it
5382 if (m->SuppressProbes && m->timenow - m->SuppressProbes >= 0) m->SuppressProbes = 0;
5383
5384 // 2. If it's been more than ten seconds since the last probe failure, we can clear the counter
5385 if (m->NumFailedProbes && m->timenow - m->ProbeFailTime >= mDNSPlatformOneSecond * 10) m->NumFailedProbes = 0;
5386
5387 // 3. Purge our cache of stale old records
5388 if (m->rrcache_size && m->timenow - m->NextCacheCheck >= 0)
5389 {
5390 mDNSu32 numchecked = 0;
5391 m->NextCacheCheck = m->timenow + FutureTime;
5392 for (slot = 0; slot < CACHE_HASH_SLOTS; slot++)
5393 {
5394 if (m->timenow - m->rrcache_nextcheck[slot] >= 0)
5395 {
5396 CacheGroup **cp = &m->rrcache_hash[slot];
5397 m->rrcache_nextcheck[slot] = m->timenow + FutureTime;
5398 while (*cp)
5399 {
5400 debugf("m->NextCacheCheck %4d Slot %3d %##s", numchecked, slot, *cp ? (*cp)->name : (domainname*)"\x04NULL");
5401 numchecked++;
5402 CheckCacheExpiration(m, slot, *cp);
5403 if ((*cp)->members) cp=&(*cp)->next;
5404 else ReleaseCacheGroup(m, cp);
5405 }
5406 }
5407 // Even if we didn't need to actually check this slot yet, still need to
5408 // factor its nextcheck time into our overall NextCacheCheck value
5409 if (m->NextCacheCheck - m->rrcache_nextcheck[slot] > 0)
5410 m->NextCacheCheck = m->rrcache_nextcheck[slot];
5411 }
5412 debugf("m->NextCacheCheck %4d checked, next in %d", numchecked, m->NextCacheCheck - m->timenow);
5413 }
5414
5415 if (m->timenow - m->NextScheduledSPS >= 0)
5416 {
5417 m->NextScheduledSPS = m->timenow + FutureTime;
5418 CheckProxyRecords(m, m->DuplicateRecords); // Clear m->DuplicateRecords first, then m->ResourceRecords
5419 CheckProxyRecords(m, m->ResourceRecords);
5420 }
5421
5422 SetSPSProxyListChanged(mDNSNULL); // Perform any deferred BPF reconfiguration now
5423
5424 // Check to see if we need to send any keepalives. Do this after we called CheckProxyRecords above
5425 // as records could have expired during that check
5426 if (m->timenow - m->NextScheduledKA >= 0)
5427 {
5428 m->NextScheduledKA = m->timenow + FutureTime;
5429 mDNS_SendKeepalives(m);
5430 }
5431
5432 #if BONJOUR_ON_DEMAND
5433 if (m->NextBonjourDisableTime && (m->timenow - m->NextBonjourDisableTime >= 0))
5434 {
5435 // Schedule immediate network change processing to leave the multicast group
5436 // since the delay time has expired since the previous active registration or query.
5437 m->NetworkChanged = m->timenow;
5438 m->NextBonjourDisableTime = 0;
5439 m->BonjourEnabled = 0;
5440
5441 LogInfo("mDNS_Execute: Scheduled network changed processing to leave multicast group.");
5442 }
5443 #endif // BONJOUR_ON_DEMAND
5444
5445 // Clear AnnounceOwner if necessary. (Do this *before* SendQueries() and SendResponses().)
5446 if (m->AnnounceOwner && m->timenow - m->AnnounceOwner >= 0)
5447 {
5448 m->AnnounceOwner = 0;
5449
5450 // This is a good time to reset the delay counter used to prevent spurious conflicts
5451 m->DelayConflictProcessing = 0;
5452 }
5453
5454 if (m->DelaySleep && m->timenow - m->DelaySleep >= 0)
5455 {
5456 m->DelaySleep = 0;
5457 if (m->SleepState == SleepState_Transferring)
5458 {
5459 LogSPS("Re-sleep delay passed; now checking for Sleep Proxy Servers");
5460 BeginSleepProcessing(m);
5461 }
5462 }
5463
5464 // 4. See if we can answer any of our new local questions from the cache
5465 for (i=0; m->NewQuestions && i<1000; i++)
5466 {
5467 if (m->NewQuestions->DelayAnswering && m->timenow - m->NewQuestions->DelayAnswering < 0) break;
5468 AnswerNewQuestion(m);
5469 }
5470 if (i >= 1000) LogMsg("mDNS_Execute: AnswerNewQuestion exceeded loop limit");
5471
5472 // Make sure we deliver *all* local RMV events, and clear the corresponding rr->AnsweredLocalQ flags, *before*
5473 // we begin generating *any* new ADD events in the m->NewLocalOnlyQuestions and m->NewLocalRecords loops below.
5474 for (i=0; i<1000 && m->LocalRemoveEvents; i++)
5475 {
5476 m->LocalRemoveEvents = mDNSfalse;
5477 m->CurrentRecord = m->ResourceRecords;
5478 CheckRmvEventsForLocalRecords(m);
5479 // Walk the LocalOnly records and deliver the RMV events
5480 for (slot = 0; slot < AUTH_HASH_SLOTS; slot++)
5481 for (ag = m->rrauth.rrauth_hash[slot]; ag; ag = ag->next)
5482 {
5483 m->CurrentRecord = ag->members;
5484 if (m->CurrentRecord) CheckRmvEventsForLocalRecords(m);
5485 }
5486 }
5487
5488 if (i >= 1000) LogMsg("mDNS_Execute: m->LocalRemoveEvents exceeded loop limit");
5489
5490 for (i=0; m->NewLocalOnlyQuestions && i<1000; i++) AnswerNewLocalOnlyQuestion(m);
5491 if (i >= 1000) LogMsg("mDNS_Execute: AnswerNewLocalOnlyQuestion exceeded loop limit");
5492
5493 head = tail = mDNSNULL;
5494 for (i=0; i<1000 && m->NewLocalRecords && m->NewLocalRecords != head; i++)
5495 {
5496 AuthRecord *rr = m->NewLocalRecords;
5497 m->NewLocalRecords = m->NewLocalRecords->next;
5498 if (LocalRecordReady(rr))
5499 {
5500 debugf("mDNS_Execute: Delivering Add event with LocalAuthRecord %s", ARDisplayString(m, rr));
5501 AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNStrue);
5502 }
5503 else if (!rr->next)
5504 {
5505 // If we have just one record that is not ready, we don't have to unlink and
5506 // reinsert. As the NewLocalRecords will be NULL for this case, the loop will
5507 // terminate and set the NewLocalRecords to rr.
5508 debugf("mDNS_Execute: Just one LocalAuthRecord %s, breaking out of the loop early", ARDisplayString(m, rr));
5509 if (head != mDNSNULL || m->NewLocalRecords != mDNSNULL)
5510 LogMsg("mDNS_Execute: ERROR!!: head %p, NewLocalRecords %p", head, m->NewLocalRecords);
5511
5512 head = rr;
5513 }
5514 else
5515 {
5516 AuthRecord **p = &m->ResourceRecords; // Find this record in our list of active records
5517 debugf("mDNS_Execute: Skipping LocalAuthRecord %s", ARDisplayString(m, rr));
5518 // if this is the first record we are skipping, move to the end of the list.
5519 // if we have already skipped records before, append it at the end.
5520 while (*p && *p != rr) p=&(*p)->next;
5521 if (*p) *p = rr->next; // Cut this record from the list
5522 else { LogMsg("mDNS_Execute: ERROR!! Cannot find record %s in ResourceRecords list", ARDisplayString(m, rr)); break; }
5523 if (!head)
5524 {
5525 while (*p) p=&(*p)->next;
5526 *p = rr;
5527 head = tail = rr;
5528 }
5529 else
5530 {
5531 tail->next = rr;
5532 tail = rr;
5533 }
5534 rr->next = mDNSNULL;
5535 }
5536 }
5537 m->NewLocalRecords = head;
5538 debugf("mDNS_Execute: Setting NewLocalRecords to %s", (head ? ARDisplayString(m, head) : "NULL"));
5539
5540 if (i >= 1000) LogMsg("mDNS_Execute: m->NewLocalRecords exceeded loop limit");
5541
5542 // Check to see if we have any new LocalOnly/P2P records to examine for delivering
5543 // to our local questions
5544 if (m->NewLocalOnlyRecords)
5545 {
5546 m->NewLocalOnlyRecords = mDNSfalse;
5547 for (slot = 0; slot < AUTH_HASH_SLOTS; slot++)
5548 for (ag = m->rrauth.rrauth_hash[slot]; ag; ag = ag->next)
5549 {
5550 for (i=0; i<100 && ag->NewLocalOnlyRecords; i++)
5551 {
5552 AuthRecord *rr = ag->NewLocalOnlyRecords;
5553 ag->NewLocalOnlyRecords = ag->NewLocalOnlyRecords->next;
5554 // LocalOnly records should always be ready as they never probe
5555 if (LocalRecordReady(rr))
5556 {
5557 debugf("mDNS_Execute: Delivering Add event with LocalAuthRecord %s", ARDisplayString(m, rr));
5558 AnswerAllLocalQuestionsWithLocalAuthRecord(m, rr, mDNStrue);
5559 }
5560 else LogMsg("mDNS_Execute: LocalOnlyRecord %s not ready", ARDisplayString(m, rr));
5561 }
5562 // We limit about 100 per AuthGroup that can be serviced at a time
5563 if (i >= 100) LogMsg("mDNS_Execute: ag->NewLocalOnlyRecords exceeded loop limit");
5564 }
5565 }
5566
5567 // 5. See what packets we need to send
5568 if (m->mDNSPlatformStatus != mStatus_NoError || (m->SleepState == SleepState_Sleeping))
5569 DiscardDeregistrations(m);
5570 if (m->mDNSPlatformStatus == mStatus_NoError && (m->SuppressSending == 0 || m->timenow - m->SuppressSending >= 0))
5571 {
5572 // If the platform code is ready, and we're not suppressing packet generation right now
5573 // then send our responses, probes, and questions.
5574 // We check the cache first, because there might be records close to expiring that trigger questions to refresh them.
5575 // We send queries next, because there might be final-stage probes that complete their probing here, causing
5576 // them to advance to announcing state, and we want those to be included in any announcements we send out.
5577 // Finally, we send responses, including the previously mentioned records that just completed probing.
5578 m->SuppressSending = 0;
5579
5580 // 6. Send Query packets. This may cause some probing records to advance to announcing state
5581 if (m->timenow - m->NextScheduledQuery >= 0 || m->timenow - m->NextScheduledProbe >= 0) SendQueries(m);
5582 if (m->timenow - m->NextScheduledQuery >= 0)
5583 {
5584 DNSQuestion *q;
5585 LogMsg("mDNS_Execute: SendQueries didn't send all its queries (%d - %d = %d) will try again in one second",
5586 m->timenow, m->NextScheduledQuery, m->timenow - m->NextScheduledQuery);
5587 m->NextScheduledQuery = m->timenow + mDNSPlatformOneSecond;
5588 for (q = m->Questions; q && q != m->NewQuestions; q=q->next)
5589 if (ActiveQuestion(q) && m->timenow - NextQSendTime(q) >= 0)
5590 LogMsg("mDNS_Execute: SendQueries didn't send %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5591 }
5592 if (m->timenow - m->NextScheduledProbe >= 0)
5593 {
5594 LogMsg("mDNS_Execute: SendQueries didn't send all its probes (%d - %d = %d) will try again in one second",
5595 m->timenow, m->NextScheduledProbe, m->timenow - m->NextScheduledProbe);
5596 m->NextScheduledProbe = m->timenow + mDNSPlatformOneSecond;
5597 }
5598
5599 // 7. Send Response packets, including probing records just advanced to announcing state
5600 if (m->timenow - m->NextScheduledResponse >= 0) SendResponses(m);
5601 if (m->timenow - m->NextScheduledResponse >= 0)
5602 {
5603 LogMsg("mDNS_Execute: SendResponses didn't send all its responses; will try again in one second");
5604 m->NextScheduledResponse = m->timenow + mDNSPlatformOneSecond;
5605 }
5606 }
5607
5608 // Clear RandomDelay values, ready to pick a new different value next time
5609 m->RandomQueryDelay = 0;
5610 m->RandomReconfirmDelay = 0;
5611
5612 // See if any questions (or local-only questions) have timed out
5613 if (m->NextScheduledStopTime && m->timenow - m->NextScheduledStopTime >= 0) TimeoutQuestions(m);
5614 #ifndef UNICAST_DISABLED
5615 if (m->NextSRVUpdate && m->timenow - m->NextSRVUpdate >= 0) UpdateAllSRVRecords(m);
5616 if (m->timenow - m->NextScheduledNATOp >= 0) CheckNATMappings(m);
5617 if (m->timenow - m->NextuDNSEvent >= 0) uDNS_Tasks(m);
5618 #endif
5619 #if APPLE_OSX_mDNSResponder && ENABLE_BLE_TRIGGERED_BONJOUR
5620 extern void serviceBLE();
5621 if (m->NextBLEServiceTime && (m->timenow - m->NextBLEServiceTime >= 0)) serviceBLE();
5622 #endif // APPLE_OSX_mDNSResponder && ENABLE_BLE_TRIGGERED_BONJOUR
5623 }
5624
5625 // Note about multi-threaded systems:
5626 // On a multi-threaded system, some other thread could run right after the mDNS_Unlock(),
5627 // performing mDNS API operations that change our next scheduled event time.
5628 //
5629 // On multi-threaded systems (like the current Windows implementation) that have a single main thread
5630 // calling mDNS_Execute() (and other threads allowed to call mDNS API routines) it is the responsibility
5631 // of the mDNSPlatformUnlock() routine to signal some kind of stateful condition variable that will
5632 // signal whatever blocking primitive the main thread is using, so that it will wake up and execute one
5633 // more iteration of its loop, and immediately call mDNS_Execute() again. The signal has to be stateful
5634 // in the sense that if the main thread has not yet entered its blocking primitive, then as soon as it
5635 // does, the state of the signal will be noticed, causing the blocking primitive to return immediately
5636 // without blocking. This avoids the race condition between the signal from the other thread arriving
5637 // just *before* or just *after* the main thread enters the blocking primitive.
5638 //
5639 // On multi-threaded systems (like the current Mac OS 9 implementation) that are entirely timer-driven,
5640 // with no main mDNS_Execute() thread, it is the responsibility of the mDNSPlatformUnlock() routine to
5641 // set the timer according to the m->NextScheduledEvent value, and then when the timer fires, the timer
5642 // callback function should call mDNS_Execute() (and ignore the return value, which may already be stale
5643 // by the time it gets to the timer callback function).
5644
5645 mDNS_Unlock(m); // Calling mDNS_Unlock is what gives m->NextScheduledEvent its new value
5646 return(m->NextScheduledEvent);
5647 }
5648
5649 #ifndef UNICAST_DISABLED
5650 mDNSlocal void SuspendLLQs(mDNS *m)
5651 {
5652 DNSQuestion *q;
5653 for (q = m->Questions; q; q = q->next)
5654 if (ActiveQuestion(q) && !mDNSOpaque16IsZero(q->TargetQID) && q->LongLived && q->state == LLQ_Established)
5655 { q->ReqLease = 0; sendLLQRefresh(m, q); }
5656 }
5657 #endif // UNICAST_DISABLED
5658
5659 mDNSlocal mDNSBool QuestionHasLocalAnswers(mDNS *const m, DNSQuestion *q)
5660 {
5661 AuthRecord *rr;
5662 AuthGroup *ag;
5663
5664 ag = AuthGroupForName(&m->rrauth, q->qnamehash, &q->qname);
5665 if (ag)
5666 {
5667 for (rr = ag->members; rr; rr=rr->next)
5668 // Filter the /etc/hosts records - LocalOnly, Unique, A/AAAA/CNAME
5669 if (UniqueLocalOnlyRecord(rr) && LocalOnlyRecordAnswersQuestion(rr, q))
5670 {
5671 LogInfo("QuestionHasLocalAnswers: Question %p %##s (%s) has local answer %s", q, q->qname.c, DNSTypeName(q->qtype), ARDisplayString(m, rr));
5672 return mDNStrue;
5673 }
5674 }
5675 return mDNSfalse;
5676 }
5677
5678 // ActivateUnicastQuery() is called from three places:
5679 // 1. When a new question is created
5680 // 2. On wake from sleep
5681 // 3. When the DNS configuration changes
5682 // In case 1 we don't want to mess with our established ThisQInterval and LastQTime (ScheduleImmediately is false)
5683 // In cases 2 and 3 we do want to cause the question to be resent immediately (ScheduleImmediately is true)
5684 mDNSlocal void ActivateUnicastQuery(mDNS *const m, DNSQuestion *const question, mDNSBool ScheduleImmediately)
5685 {
5686 // For now this AutoTunnel stuff is specific to Mac OS X.
5687 // In the future, if there's demand, we may see if we can abstract it out cleanly into the platform layer
5688 #if APPLE_OSX_mDNSResponder
5689 // Even though BTMM client tunnels are only useful for AAAA queries, we need to treat v4 and v6 queries equally.
5690 // Otherwise we can get the situation where the A query completes really fast (with an NXDOMAIN result) and the
5691 // caller then gives up waiting for the AAAA result while we're still in the process of setting up the tunnel.
5692 // To level the playing field, we block both A and AAAA queries while tunnel setup is in progress, and then
5693 // returns results for both at the same time. If we are looking for the _autotunnel6 record, then skip this logic
5694 // as this would trigger looking up _autotunnel6._autotunnel6 and end up failing the original query.
5695
5696 if (RRTypeIsAddressType(question->qtype) && PrivateQuery(question) &&
5697 !SameDomainLabel(question->qname.c, (const mDNSu8 *)"\x0c_autotunnel6")&& question->QuestionCallback != AutoTunnelCallback)
5698 {
5699 question->NoAnswer = NoAnswer_Suspended;
5700 AddNewClientTunnel(question);
5701 return;
5702 }
5703 #endif // APPLE_OSX_mDNSResponder
5704
5705 if (!question->DuplicateOf)
5706 {
5707 debugf("ActivateUnicastQuery: %##s %s%s%s",
5708 question->qname.c, DNSTypeName(question->qtype), PrivateQuery(question) ? " (Private)" : "", ScheduleImmediately ? " ScheduleImmediately" : "");
5709 question->CNAMEReferrals = 0;
5710 if (question->nta) { CancelGetZoneData(m, question->nta); question->nta = mDNSNULL; }
5711 if (question->LongLived)
5712 {
5713 question->state = LLQ_InitialRequest;
5714 question->id = zeroOpaque64;
5715 question->servPort = zeroIPPort;
5716 if (question->tcp) { DisposeTCPConn(question->tcp); question->tcp = mDNSNULL; }
5717 }
5718 // If the question has local answers, then we don't want answers from outside
5719 if (ScheduleImmediately && !QuestionHasLocalAnswers(m, question))
5720 {
5721 question->ThisQInterval = InitialQuestionInterval;
5722 question->LastQTime = m->timenow - question->ThisQInterval;
5723 SetNextQueryTime(m, question);
5724 }
5725 }
5726 }
5727
5728 // Caller should hold the lock
5729 mDNSexport void mDNSCoreRestartAddressQueries(mDNS *const m, mDNSBool SearchDomainsChanged, FlushCache flushCacheRecords,
5730 CallbackBeforeStartQuery BeforeStartCallback, void *context)
5731 {
5732 DNSQuestion *q;
5733 DNSQuestion *restart = mDNSNULL;
5734
5735 mDNS_CheckLock(m);
5736
5737 // 1. Flush the cache records
5738 if (flushCacheRecords) flushCacheRecords(m);
5739
5740 // 2. Even though we may have purged the cache records above, before it can generate RMV event
5741 // we are going to stop the question. Hence we need to deliver the RMV event before we
5742 // stop the question.
5743 //
5744 // CurrentQuestion is used by RmvEventsForQuestion below. While delivering RMV events, the
5745 // application callback can potentially stop the current question (detected by CurrentQuestion) or
5746 // *any* other question which could be the next one that we may process here. RestartQuestion
5747 // points to the "next" question which will be automatically advanced in mDNS_StopQuery_internal
5748 // if the "next" question is stopped while the CurrentQuestion is stopped
5749
5750 if (m->RestartQuestion)
5751 LogMsg("mDNSCoreRestartAddressQueries: ERROR!! m->RestartQuestion already set: %##s (%s)",
5752 m->RestartQuestion->qname.c, DNSTypeName(m->RestartQuestion->qtype));
5753
5754 m->RestartQuestion = m->Questions;
5755 while (m->RestartQuestion)
5756 {
5757 q = m->RestartQuestion;
5758 m->RestartQuestion = q->next;
5759 // GetZoneData questions are referenced by other questions (original query that started the GetZoneData
5760 // question) through their "nta" pointer. Normally when the original query stops, it stops the
5761 // GetZoneData question and also frees the memory (See CancelGetZoneData). If we stop the GetZoneData
5762 // question followed by the original query that refers to this GetZoneData question, we will end up
5763 // freeing the GetZoneData question and then start the "freed" question at the end.
5764
5765 if (IsGetZoneDataQuestion(q))
5766 {
5767 DNSQuestion *refq = q->next;
5768 LogInfo("mDNSCoreRestartAddressQueries: Skipping GetZoneDataQuestion %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
5769 // debug stuff, we just try to find the referencing question and don't do much with it
5770 while (refq)
5771 {
5772 if (q == &refq->nta->question)
5773 {
5774 LogInfo("mDNSCoreRestartAddressQueries: Question %p %##s (%s) referring to GetZoneDataQuestion %p, not stopping", refq, refq->qname.c, DNSTypeName(refq->qtype), q);
5775 }
5776 refq = refq->next;
5777 }
5778 continue;
5779 }
5780
5781 // This function is called when /etc/hosts changes and that could affect A, AAAA and CNAME queries
5782 if (q->qtype != kDNSType_A && q->qtype != kDNSType_AAAA && q->qtype != kDNSType_CNAME) continue;
5783
5784 // If the search domains did not change, then we restart all the queries. Otherwise, only
5785 // for queries for which we "might" have appended search domains ("might" because we may
5786 // find results before we apply search domains even though AppendSearchDomains is set to 1)
5787 if (!SearchDomainsChanged || q->AppendSearchDomains)
5788 {
5789 // NOTE: CacheRecordRmvEventsForQuestion will not generate RMV events for queries that have non-zero
5790 // LOAddressAnswers. Hence it is important that we call CacheRecordRmvEventsForQuestion before
5791 // LocalRecordRmvEventsForQuestion (which decrements LOAddressAnswers). Let us say that
5792 // /etc/hosts has an A Record for web.apple.com. Any queries for web.apple.com will be answered locally.
5793 // But this can't prevent a CNAME/AAAA query to not to be sent on the wire. When it is sent on the wire,
5794 // it could create cache entries. When we are restarting queries, we can't deliver the cache RMV events
5795 // for the original query using these cache entries as ADDs were never delivered using these cache
5796 // entries and hence this order is needed.
5797
5798 // If the query is suppressed, the RMV events won't be delivered
5799 if (!CacheRecordRmvEventsForQuestion(m, q)) { LogInfo("mDNSCoreRestartAddressQueries: Question deleted while delivering Cache Record RMV events"); continue; }
5800
5801 // SuppressQuery status does not affect questions that are answered using local records
5802 if (!LocalRecordRmvEventsForQuestion(m, q)) { LogInfo("mDNSCoreRestartAddressQueries: Question deleted while delivering Local Record RMV events"); continue; }
5803
5804 LogInfo("mDNSCoreRestartAddressQueries: Stop question %p %##s (%s), AppendSearchDomains %d, qnameOrig %p", q,
5805 q->qname.c, DNSTypeName(q->qtype), q->AppendSearchDomains, q->qnameOrig);
5806 mDNS_StopQuery_internal(m, q);
5807 // Reset state so that it looks like it was in the beginning i.e it should look at /etc/hosts, cache
5808 // and then search domains should be appended. At the beginning, qnameOrig was NULL.
5809 if (q->qnameOrig)
5810 {
5811 LogInfo("mDNSCoreRestartAddressQueries: qnameOrig %##s", q->qnameOrig);
5812 AssignDomainName(&q->qname, q->qnameOrig);
5813 mDNSPlatformMemFree(q->qnameOrig);
5814 q->qnameOrig = mDNSNULL;
5815 q->RetryWithSearchDomains = ApplySearchDomainsFirst(q) ? 1 : 0;
5816 }
5817 q->SearchListIndex = 0;
5818 q->next = restart;
5819 restart = q;
5820 }
5821 }
5822
5823 // 3. Callback before we start the query
5824 if (BeforeStartCallback) BeforeStartCallback(m, context);
5825
5826 // 4. Restart all the stopped queries
5827 while (restart)
5828 {
5829 q = restart;
5830 restart = restart->next;
5831 q->next = mDNSNULL;
5832 LogInfo("mDNSCoreRestartAddressQueries: Start question %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
5833 mDNS_StartQuery_internal(m, q);
5834 }
5835 }
5836
5837 mDNSexport void mDNSCoreRestartQueries(mDNS *const m)
5838 {
5839 DNSQuestion *q;
5840
5841 #ifndef UNICAST_DISABLED
5842 // Retrigger all our uDNS questions
5843 if (m->CurrentQuestion)
5844 LogMsg("mDNSCoreRestartQueries: ERROR m->CurrentQuestion already set: %##s (%s)",
5845 m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
5846 m->CurrentQuestion = m->Questions;
5847 while (m->CurrentQuestion)
5848 {
5849 q = m->CurrentQuestion;
5850 m->CurrentQuestion = m->CurrentQuestion->next;
5851 if (!mDNSOpaque16IsZero(q->TargetQID) && ActiveQuestion(q)) ActivateUnicastQuery(m, q, mDNStrue);
5852 }
5853 #endif
5854
5855 // Retrigger all our mDNS questions
5856 for (q = m->Questions; q; q=q->next) // Scan our list of questions
5857 mDNSCoreRestartQuestion(m, q);
5858 }
5859
5860 // restart question if it's multicast and currently active
5861 mDNSexport void mDNSCoreRestartQuestion(mDNS *const m, DNSQuestion *q)
5862 {
5863 if (mDNSOpaque16IsZero(q->TargetQID) && ActiveQuestion(q))
5864 {
5865 q->ThisQInterval = InitialQuestionInterval; // MUST be > zero for an active question
5866 q->RequestUnicast = kDefaultRequestUnicastCount;
5867 q->LastQTime = m->timenow - q->ThisQInterval;
5868 q->RecentAnswerPkts = 0;
5869 ExpireDupSuppressInfo(q->DupSuppress, m->timenow);
5870 m->NextScheduledQuery = m->timenow;
5871 }
5872 }
5873
5874 // restart the probe/announce cycle for multicast record
5875 mDNSexport void mDNSCoreRestartRegistration(mDNS *const m, AuthRecord *rr, int announceCount)
5876 {
5877 if (!AuthRecord_uDNS(rr))
5878 {
5879 if (rr->resrec.RecordType == kDNSRecordTypeVerified && !rr->DependentOn) rr->resrec.RecordType = kDNSRecordTypeUnique;
5880 rr->ProbeCount = DefaultProbeCountForRecordType(rr->resrec.RecordType);
5881
5882 if (mDNS_KeepaliveRecord(&rr->resrec))
5883 {
5884 rr->AnnounceCount = 0; // Do not announce keepalive records
5885 }
5886 else
5887 {
5888 // announceCount < 0 indicates default announce count should be used
5889 if (announceCount < 0)
5890 announceCount = InitialAnnounceCount;
5891 if (rr->AnnounceCount < (mDNSu8)announceCount)
5892 rr->AnnounceCount = (mDNSu8)announceCount;
5893 }
5894
5895 rr->SendNSECNow = mDNSNULL;
5896 InitializeLastAPTime(m, rr);
5897 }
5898 }
5899
5900 // ***************************************************************************
5901 #if COMPILER_LIKES_PRAGMA_MARK
5902 #pragma mark -
5903 #pragma mark - Power Management (Sleep/Wake)
5904 #endif
5905
5906 mDNSexport void mDNS_UpdateAllowSleep(mDNS *const m)
5907 {
5908 #ifndef IDLESLEEPCONTROL_DISABLED
5909 mDNSBool allowSleep = mDNStrue;
5910 char reason[128];
5911
5912 reason[0] = 0;
5913
5914 if (m->SystemSleepOnlyIfWakeOnLAN)
5915 {
5916 // Don't sleep if we are a proxy for any services
5917 if (m->ProxyRecords)
5918 {
5919 allowSleep = mDNSfalse;
5920 mDNS_snprintf(reason, sizeof(reason), "sleep proxy for %d records", m->ProxyRecords);
5921 LogInfo("mDNS_UpdateAllowSleep: Sleep disabled because we are proxying %d records", m->ProxyRecords);
5922 }
5923
5924 if (allowSleep && mDNSCoreHaveAdvertisedMulticastServices(m))
5925 {
5926 // Scan the list of active interfaces
5927 NetworkInterfaceInfo *intf;
5928 for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
5929 {
5930 if (intf->McastTxRx && !intf->Loopback && !mDNSPlatformInterfaceIsD2D(intf->InterfaceID))
5931 {
5932 // Disallow sleep if this interface doesn't support NetWake
5933 if (!intf->NetWake)
5934 {
5935 allowSleep = mDNSfalse;
5936 mDNS_snprintf(reason, sizeof(reason), "%s does not support NetWake", intf->ifname);
5937 LogInfo("mDNS_UpdateAllowSleep: Sleep disabled because %s does not support NetWake", intf->ifname);
5938 break;
5939 }
5940
5941 // If the interface can be an in-NIC Proxy, we should check if it can accomodate all the records
5942 // that will be offloaded. If not, we should prevent sleep.
5943 // This check will be possible once the lower layers provide an API to query the space available for offloads on the NIC.
5944 #if APPLE_OSX_mDNSResponder
5945 if (!SupportsInNICProxy(intf))
5946 #endif
5947 {
5948 // Disallow sleep if there is no sleep proxy server
5949 const CacheRecord *cr = FindSPSInCache1(m, &intf->NetWakeBrowse, mDNSNULL, mDNSNULL);
5950 if ( cr == mDNSNULL)
5951 {
5952 allowSleep = mDNSfalse;
5953 mDNS_snprintf(reason, sizeof(reason), "No sleep proxy server on %s", intf->ifname);
5954 LogInfo("mDNS_UpdateAllowSleep: Sleep disabled because %s has no sleep proxy server", intf->ifname);
5955 break;
5956 }
5957 else if (m->SPSType != 0)
5958 {
5959 mDNSu32 mymetric = LocalSPSMetric(m);
5960 mDNSu32 metric = SPSMetric(cr->resrec.rdata->u.name.c);
5961 if (metric >= mymetric)
5962 {
5963 allowSleep = mDNSfalse;
5964 mDNS_snprintf(reason, sizeof(reason), "No sleep proxy server with better metric on %s", intf->ifname);
5965 LogInfo("mDNS_UpdateAllowSleep: Sleep disabled because %s has no sleep proxy server with a better metric", intf->ifname);
5966 break;
5967 }
5968 }
5969 }
5970 }
5971 }
5972 }
5973 }
5974
5975 // Call the platform code to enable/disable sleep
5976 mDNSPlatformSetAllowSleep(allowSleep, reason);
5977 #else
5978 (void) m;
5979 #endif /* !defined(IDLESLEEPCONTROL_DISABLED) */
5980 }
5981
5982 mDNSlocal mDNSBool mDNSUpdateOkToSend(mDNS *const m, AuthRecord *rr, NetworkInterfaceInfo *const intf, mDNSu32 scopeid)
5983 {
5984 // If it is not a uDNS record, check to see if the updateid is zero. "updateid" is cleared when we have
5985 // sent the resource record on all the interfaces. If the update id is not zero, check to see if it is time
5986 // to send.
5987 if (AuthRecord_uDNS(rr) || (rr->AuthFlags & AuthFlagsWakeOnly) || mDNSOpaque16IsZero(rr->updateid) ||
5988 m->timenow - (rr->LastAPTime + rr->ThisAPInterval) < 0)
5989 {
5990 return mDNSfalse;
5991 }
5992
5993 // If we have a pending registration for "scopeid", it is ok to send the update on that interface.
5994 // If the scopeid is too big to check for validity, we don't check against updateIntID. When
5995 // we successfully update on all the interfaces (with whatever set in "rr->updateIntID"), we clear
5996 // updateid and we should have returned from above.
5997 //
5998 // Note: scopeid is the same as intf->InterfaceID. It is passed in so that we don't have to call the
5999 // platform function to extract the value from "intf" every time.
6000
6001 if ((scopeid >= (sizeof(rr->updateIntID) * mDNSNBBY) || bit_get_opaque64(rr->updateIntID, scopeid)) &&
6002 (!rr->resrec.InterfaceID || rr->resrec.InterfaceID == intf->InterfaceID))
6003 return mDNStrue;
6004
6005 return mDNSfalse;
6006 }
6007
6008 mDNSexport void UpdateRMAC(mDNS *const m, void *context)
6009 {
6010 IPAddressMACMapping *addrmap = (IPAddressMACMapping *)context ;
6011 m->CurrentRecord = m->ResourceRecords;
6012
6013 if (!addrmap)
6014 {
6015 LogMsg("UpdateRMAC: Address mapping is NULL");
6016 return;
6017 }
6018
6019 while (m->CurrentRecord)
6020 {
6021 AuthRecord *rr = m->CurrentRecord;
6022 // If this is a non-sleep proxy keepalive record and the remote IP address matches, update the RData
6023 if (!rr->WakeUp.HMAC.l[0] && mDNS_KeepaliveRecord(&rr->resrec))
6024 {
6025 mDNSAddr raddr;
6026 getKeepaliveRaddr(m, rr, &raddr);
6027 if (mDNSSameAddress(&raddr, &addrmap->ipaddr))
6028 {
6029 // Update the MAC address only if it is not a zero MAC address
6030 mDNSEthAddr macAddr;
6031 mDNSu8 *ptr = GetValueForMACAddr((mDNSu8 *)(addrmap->ethaddr), (mDNSu8 *) (addrmap->ethaddr + sizeof(addrmap->ethaddr)), &macAddr);
6032 if (ptr != mDNSNULL && !mDNSEthAddressIsZero(macAddr))
6033 {
6034 UpdateKeepaliveRData(m, rr, mDNSNULL, mDNStrue, (char *)(addrmap->ethaddr));
6035 }
6036 }
6037 }
6038 m->CurrentRecord = rr->next;
6039 }
6040
6041 if (addrmap)
6042 mDNSPlatformMemFree(addrmap);
6043
6044 }
6045
6046 mDNSexport mStatus UpdateKeepaliveRData(mDNS *const m, AuthRecord *rr, NetworkInterfaceInfo *const intf, mDNSBool updateMac, char *ethAddr)
6047 {
6048 mDNSu16 newrdlength;
6049 mDNSAddr laddr = zeroAddr;
6050 mDNSAddr raddr = zeroAddr;
6051 mDNSEthAddr eth = zeroEthAddr;
6052 mDNSIPPort lport = zeroIPPort;
6053 mDNSIPPort rport = zeroIPPort;
6054 mDNSu32 timeout = 0;
6055 mDNSu32 seq = 0;
6056 mDNSu32 ack = 0;
6057 mDNSu16 win = 0;
6058 UTF8str255 txt;
6059 int rdsize;
6060 RData *newrd;
6061 mDNSTCPInfo mti;
6062 mStatus ret;
6063
6064 // Note: If we fail to update the DNS NULL record with additional information in this function, it will be registered
6065 // with the SPS like any other record. SPS will not send keepalives if it does not have additional information.
6066 mDNS_ExtractKeepaliveInfo(rr, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
6067 if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(&raddr) || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport))
6068 {
6069 LogMsg("UpdateKeepaliveRData: not a valid record %s for keepalive %#a:%d %#a:%d", ARDisplayString(m, rr), &laddr, lport.NotAnInteger, &raddr, rport.NotAnInteger);
6070 return mStatus_UnknownErr;
6071 }
6072
6073 if (updateMac)
6074 {
6075 if (laddr.type == mDNSAddrType_IPv4)
6076 newrdlength = mDNS_snprintf((char *)&txt.c[1], sizeof(txt.c) - 1, "t=%d i=%d c=%d h=%#a d=%#a l=%u r=%u m=%s", timeout, kKeepaliveRetryInterval, kKeepaliveRetryCount, &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport), ethAddr);
6077 else
6078 newrdlength = mDNS_snprintf((char *)&txt.c[1], sizeof(txt.c) - 1, "t=%d i=%d c=%d H=%#a D=%#a l=%u r=%u m=%s", timeout, kKeepaliveRetryInterval, kKeepaliveRetryCount, &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport), ethAddr);
6079
6080 }
6081 else
6082 {
6083 // If this keepalive packet would be sent on a different interface than the current one that we are processing
6084 // now, then we don't update the DNS NULL record. But we do not prevent it from registering with the SPS. When SPS sees
6085 // this DNS NULL record, it does not send any keepalives as it does not have all the information
6086 mDNSPlatformMemZero(&mti, sizeof (mDNSTCPInfo));
6087 ret = mDNSPlatformRetrieveTCPInfo(&laddr, &lport, &raddr, &rport, &mti);
6088 if (ret != mStatus_NoError)
6089 {
6090 LogMsg("mDNSPlatformRetrieveTCPInfo: mDNSPlatformRetrieveTCPInfo failed %d", ret);
6091 return ret;
6092 }
6093 if ((intf != mDNSNULL) && (mti.IntfId != intf->InterfaceID))
6094 {
6095 LogInfo("mDNSPlatformRetrieveTCPInfo: InterfaceID mismatch mti.IntfId = %p InterfaceID = %p", mti.IntfId, intf->InterfaceID);
6096 return mStatus_BadParamErr;
6097 }
6098
6099 if (laddr.type == mDNSAddrType_IPv4)
6100 newrdlength = mDNS_snprintf((char *)&txt.c[1], sizeof(txt.c) - 1, "t=%d i=%d c=%d h=%#a d=%#a l=%u r=%u m=%.6a s=%u a=%u w=%u", timeout, kKeepaliveRetryInterval, kKeepaliveRetryCount, &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport), &eth, mti.seq, mti.ack, mti.window);
6101 else
6102 newrdlength = mDNS_snprintf((char *)&txt.c[1], sizeof(txt.c) - 1, "t=%d i=%d c=%d H=%#a D=%#a l=%u r=%u m=%.6a s=%u a=%u w=%u", timeout, kKeepaliveRetryInterval, kKeepaliveRetryCount, &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport), &eth, mti.seq, mti.ack, mti.window);
6103 }
6104
6105 // Did we insert a null byte at the end ?
6106 if (newrdlength == (sizeof(txt.c) - 1))
6107 {
6108 LogMsg("UpdateKeepaliveRData: could not allocate memory %s", ARDisplayString(m, rr));
6109 return mStatus_NoMemoryErr;
6110 }
6111
6112 // Include the length for the null byte at the end
6113 txt.c[0] = newrdlength + 1;
6114 // Account for the first length byte and the null byte at the end
6115 newrdlength += 2;
6116
6117 rdsize = newrdlength > sizeof(RDataBody) ? newrdlength : sizeof(RDataBody);
6118 newrd = mDNSPlatformMemAllocate(sizeof(RData) - sizeof(RDataBody) + rdsize);
6119 if (!newrd) { LogMsg("UpdateKeepaliveRData: ptr NULL"); return mStatus_NoMemoryErr; }
6120
6121 newrd->MaxRDLength = (mDNSu16) rdsize;
6122 mDNSPlatformMemCopy(&newrd->u, txt.c, newrdlength);
6123
6124 // If we are updating the record for the first time, rdata points to rdatastorage as the rdata memory
6125 // was allocated as part of the AuthRecord itself. We allocate memory when we update the AuthRecord.
6126 // If the resource record has data that we allocated in a previous pass (to update MAC address),
6127 // free that memory here before copying in the new data.
6128 if ( rr->resrec.rdata != &rr->rdatastorage)
6129 {
6130 LogSPS("UpdateKeepaliveRData: Freed allocated memory for keep alive packet: %s ", ARDisplayString(m, rr));
6131 mDNSPlatformMemFree(rr->resrec.rdata);
6132 }
6133 SetNewRData(&rr->resrec, newrd, newrdlength); // Update our rdata
6134
6135 LogSPS("UpdateKeepaliveRData: successfully updated the record %s", ARDisplayString(m, rr));
6136 return mStatus_NoError;
6137 }
6138
6139 mDNSlocal void SendSPSRegistrationForOwner(mDNS *const m, NetworkInterfaceInfo *const intf, const mDNSOpaque16 id, const OwnerOptData *const owner)
6140 {
6141 const int optspace = DNSOpt_Header_Space + DNSOpt_LeaseData_Space + DNSOpt_Owner_Space(&m->PrimaryMAC, &intf->MAC);
6142 const int sps = intf->NextSPSAttempt / 3;
6143 AuthRecord *rr;
6144 mDNSOpaque16 msgid;
6145 mDNSu32 scopeid;
6146
6147 scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, intf->InterfaceID, mDNStrue);
6148 if (!intf->SPSAddr[sps].type)
6149 {
6150 intf->NextSPSAttemptTime = m->timenow + mDNSPlatformOneSecond;
6151 if (m->NextScheduledSPRetry - intf->NextSPSAttemptTime > 0)
6152 m->NextScheduledSPRetry = intf->NextSPSAttemptTime;
6153 LogSPS("SendSPSRegistration: %s SPS %d (%d) %##s not yet resolved", intf->ifname, intf->NextSPSAttempt, sps, intf->NetWakeResolve[sps].qname.c);
6154 goto exit;
6155 }
6156
6157 // Mark our mDNS records (not unicast records) for transfer to SPS
6158 if (mDNSOpaque16IsZero(id))
6159 {
6160 // We may have to register this record over multiple interfaces and we don't want to
6161 // overwrite the id. We send the registration over interface X with id "IDX" and before
6162 // we get a response, we overwrite with id "IDY" for interface Y and we won't accept responses
6163 // for "IDX". Hence, we want to use the same ID across all interfaces.
6164 //
6165 // In the case of sleep proxy server transfering its records when it goes to sleep, the owner
6166 // option check below will set the same ID across the records from the same owner. Records
6167 // with different owner option gets different ID.
6168 msgid = mDNS_NewMessageID(m);
6169 for (rr = m->ResourceRecords; rr; rr=rr->next)
6170 {
6171 if (!(rr->AuthFlags & AuthFlagsWakeOnly) && rr->resrec.RecordType > kDNSRecordTypeDeregistering)
6172 {
6173 if (rr->resrec.InterfaceID == intf->InterfaceID || (!rr->resrec.InterfaceID && (rr->ForceMCast || IsLocalDomain(rr->resrec.name))))
6174 {
6175 if (mDNSPlatformMemSame(owner, &rr->WakeUp, sizeof(*owner)))
6176 {
6177 rr->SendRNow = mDNSInterfaceMark; // mark it now
6178 // When we are registering on the first interface, rr->updateid is zero in which case
6179 // initialize with the new ID. For subsequent interfaces, we want to use the same ID.
6180 // At the end, all the updates sent across all the interfaces with the same ID.
6181 if (mDNSOpaque16IsZero(rr->updateid))
6182 rr->updateid = msgid;
6183 else
6184 msgid = rr->updateid;
6185 }
6186 }
6187 }
6188 }
6189 }
6190 else
6191 msgid = id;
6192
6193 while (1)
6194 {
6195 mDNSu8 *p = m->omsg.data;
6196 // To comply with RFC 2782, PutResourceRecord suppresses name compression for SRV records in unicast updates.
6197 // For now we follow that same logic for SPS registrations too.
6198 // If we decide to compress SRV records in SPS registrations in the future, we can achieve that by creating our
6199 // initial DNSMessage with h.flags set to zero, and then update it to UpdateReqFlags right before sending the packet.
6200 InitializeDNSMessage(&m->omsg.h, msgid, UpdateReqFlags);
6201
6202 for (rr = m->ResourceRecords; rr; rr=rr->next)
6203 if (rr->SendRNow || mDNSUpdateOkToSend(m, rr, intf, scopeid))
6204 {
6205 if (mDNSPlatformMemSame(owner, &rr->WakeUp, sizeof(*owner)))
6206 {
6207 mDNSu8 *newptr;
6208 const mDNSu8 *const limit = m->omsg.data + (m->omsg.h.mDNS_numUpdates ? NormalMaxDNSMessageData : AbsoluteMaxDNSMessageData) - optspace;
6209
6210 // If we can't update the keepalive record, don't send it
6211 if (mDNS_KeepaliveRecord(&rr->resrec) && (UpdateKeepaliveRData(m, rr, intf, mDNSfalse, mDNSNULL) != mStatus_NoError))
6212 {
6213 if (scopeid < (sizeof(rr->updateIntID) * mDNSNBBY))
6214 {
6215 bit_clr_opaque64(rr->updateIntID, scopeid);
6216 }
6217 rr->SendRNow = mDNSNULL;
6218 continue;
6219 }
6220
6221 if (rr->resrec.RecordType & kDNSRecordTypeUniqueMask)
6222 rr->resrec.rrclass |= kDNSClass_UniqueRRSet; // Temporarily set the 'unique' bit so PutResourceRecord will set it
6223 newptr = PutResourceRecordTTLWithLimit(&m->omsg, p, &m->omsg.h.mDNS_numUpdates, &rr->resrec, rr->resrec.rroriginalttl, limit);
6224 rr->resrec.rrclass &= ~kDNSClass_UniqueRRSet; // Make sure to clear 'unique' bit back to normal state
6225 if (!newptr)
6226 LogSPS("SendSPSRegistration put %s FAILED %d/%d %s", intf->ifname, p - m->omsg.data, limit - m->omsg.data, ARDisplayString(m, rr));
6227 else
6228 {
6229 LogSPS("SendSPSRegistration put %s 0x%x 0x%x (updateid %d) %s", intf->ifname, rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(m->omsg.h.id), ARDisplayString(m, rr));
6230 rr->SendRNow = mDNSNULL;
6231 rr->ThisAPInterval = mDNSPlatformOneSecond;
6232 rr->LastAPTime = m->timenow;
6233 // should be initialized above
6234 if (mDNSOpaque16IsZero(rr->updateid)) LogMsg("SendSPSRegistration: ERROR!! rr %s updateid is zero", ARDisplayString(m, rr));
6235 if (m->NextScheduledResponse - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
6236 m->NextScheduledResponse = (rr->LastAPTime + rr->ThisAPInterval);
6237 p = newptr;
6238 }
6239 }
6240 }
6241
6242 if (!m->omsg.h.mDNS_numUpdates) break;
6243 else
6244 {
6245 AuthRecord opt;
6246 mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
6247 opt.resrec.rrclass = NormalMaxDNSMessageData;
6248 opt.resrec.rdlength = sizeof(rdataOPT) * 2; // Two options in this OPT record
6249 opt.resrec.rdestimate = sizeof(rdataOPT) * 2;
6250 opt.resrec.rdata->u.opt[0].opt = kDNSOpt_Lease;
6251 opt.resrec.rdata->u.opt[0].optlen = DNSOpt_LeaseData_Space - 4;
6252 opt.resrec.rdata->u.opt[0].u.updatelease = DEFAULT_UPDATE_LEASE;
6253 if (!owner->HMAC.l[0]) // If no owner data,
6254 SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[1]); // use our own interface information
6255 else // otherwise, use the owner data we were given
6256 {
6257 opt.resrec.rdata->u.opt[1].u.owner = *owner;
6258 opt.resrec.rdata->u.opt[1].opt = kDNSOpt_Owner;
6259 opt.resrec.rdata->u.opt[1].optlen = DNSOpt_Owner_Space(&owner->HMAC, &owner->IMAC) - 4;
6260 }
6261 LogSPS("SendSPSRegistration put %s %s", intf->ifname, ARDisplayString(m, &opt));
6262 p = PutResourceRecordTTLWithLimit(&m->omsg, p, &m->omsg.h.numAdditionals, &opt.resrec, opt.resrec.rroriginalttl, m->omsg.data + AbsoluteMaxDNSMessageData);
6263 if (!p)
6264 LogMsg("SendSPSRegistration: Failed to put OPT record (%d updates) %s", m->omsg.h.mDNS_numUpdates, ARDisplayString(m, &opt));
6265 else
6266 {
6267 mStatus err;
6268
6269 LogSPS("SendSPSRegistration: Sending Update %s %d (%d) id %5d with %d records %d bytes to %#a:%d", intf->ifname, intf->NextSPSAttempt, sps,
6270 mDNSVal16(m->omsg.h.id), m->omsg.h.mDNS_numUpdates, p - m->omsg.data, &intf->SPSAddr[sps], mDNSVal16(intf->SPSPort[sps]));
6271 // if (intf->NextSPSAttempt < 5) m->omsg.h.flags = zeroID; // For simulating packet loss
6272 err = mDNSSendDNSMessage(m, &m->omsg, p, intf->InterfaceID, mDNSNULL, &intf->SPSAddr[sps], intf->SPSPort[sps], mDNSNULL, mDNSNULL, mDNSfalse);
6273 if (err) LogSPS("SendSPSRegistration: mDNSSendDNSMessage err %d", err);
6274 if (err && intf->SPSAddr[sps].type == mDNSAddrType_IPv4 && intf->NetWakeResolve[sps].ThisQInterval == -1)
6275 {
6276 LogSPS("SendSPSRegistration %d %##s failed to send to IPv4 address; will try IPv6 instead", sps, intf->NetWakeResolve[sps].qname.c);
6277 intf->NetWakeResolve[sps].qtype = kDNSType_AAAA;
6278 mDNS_StartQuery_internal(m, &intf->NetWakeResolve[sps]);
6279 return;
6280 }
6281 }
6282 }
6283 }
6284
6285 intf->NextSPSAttemptTime = m->timenow + mDNSPlatformOneSecond * 10; // If successful, update NextSPSAttemptTime
6286
6287 exit:
6288 if (mDNSOpaque16IsZero(id) && intf->NextSPSAttempt < 8) intf->NextSPSAttempt++;
6289 }
6290
6291 mDNSlocal mDNSBool RecordIsFirstOccurrenceOfOwner(mDNS *const m, const AuthRecord *const rr)
6292 {
6293 AuthRecord *ar;
6294 for (ar = m->ResourceRecords; ar && ar != rr; ar=ar->next)
6295 if (mDNSPlatformMemSame(&rr->WakeUp, &ar->WakeUp, sizeof(rr->WakeUp))) return mDNSfalse;
6296 return mDNStrue;
6297 }
6298
6299 mDNSlocal void mDNSCoreStoreProxyRR(mDNS *const m, const mDNSInterfaceID InterfaceID, AuthRecord *const rr)
6300 {
6301 AuthRecord *newRR = mDNSPlatformMemAllocate(sizeof(AuthRecord));
6302
6303 if (newRR == mDNSNULL)
6304 {
6305 LogSPS("%s : could not allocate memory for new resource record", __func__);
6306 return;
6307 }
6308
6309 mDNSPlatformMemZero(newRR, sizeof(AuthRecord));
6310 mDNS_SetupResourceRecord(newRR, mDNSNULL, InterfaceID, rr->resrec.rrtype,
6311 rr->resrec.rroriginalttl, rr->resrec.RecordType,
6312 rr->ARType, mDNSNULL, mDNSNULL);
6313
6314 AssignDomainName(&newRR->namestorage, &rr->namestorage);
6315 newRR->resrec.rdlength = DomainNameLength(rr->resrec.name);
6316 newRR->resrec.namehash = DomainNameHashValue(newRR->resrec.name);
6317 newRR->resrec.rrclass = rr->resrec.rrclass;
6318
6319 if (rr->resrec.rrtype == kDNSType_A)
6320 {
6321 newRR->resrec.rdata->u.ipv4 = rr->resrec.rdata->u.ipv4;
6322 }
6323 else if (rr->resrec.rrtype == kDNSType_AAAA)
6324 {
6325 newRR->resrec.rdata->u.ipv6 = rr->resrec.rdata->u.ipv6;
6326 }
6327 SetNewRData(&newRR->resrec, mDNSNULL, 0);
6328
6329 // Insert the new node at the head of the list.
6330 newRR->next = m->SPSRRSet;
6331 m->SPSRRSet = newRR;
6332 LogSPS("%s : Storing proxy record : %s ", __func__, ARDisplayString(m, rr));
6333 }
6334
6335 // Some records are interface specific and some are not. The ones that are supposed to be registered
6336 // on multiple interfaces need to be initialized with all the valid interfaces on which it will be sent.
6337 // updateIntID bit field tells us on which interfaces we need to register this record. When we get an
6338 // ack from the sleep proxy server, we clear the interface bit. This way, we know when a record completes
6339 // registration on all the interfaces
6340 mDNSlocal void SPSInitRecordsBeforeUpdate(mDNS *const m, mDNSOpaque64 updateIntID, mDNSBool *WakeOnlyService)
6341 {
6342 AuthRecord *ar;
6343 LogSPS("SPSInitRecordsBeforeUpdate: UpdateIntID 0x%x 0x%x", updateIntID.l[1], updateIntID.l[0]);
6344
6345 *WakeOnlyService = mDNSfalse;
6346
6347 // Before we store the A and AAAA records that we are going to register with the sleep proxy,
6348 // make sure that the old sleep proxy records are removed.
6349 mDNSCoreFreeProxyRR(m);
6350
6351 // For records that are registered only on a specific interface, mark only that bit as it will
6352 // never be registered on any other interface. For others, it should be sent on all interfaces.
6353 for (ar = m->ResourceRecords; ar; ar=ar->next)
6354 {
6355 ar->updateIntID = zeroOpaque64;
6356 ar->updateid = zeroID;
6357 if (AuthRecord_uDNS(ar))
6358 {
6359 continue;
6360 }
6361 if (ar->AuthFlags & AuthFlagsWakeOnly)
6362 {
6363 if (ar->resrec.RecordType == kDNSRecordTypeShared && ar->RequireGoodbye)
6364 {
6365 ar->ImmedAnswer = mDNSInterfaceMark;
6366 *WakeOnlyService = mDNStrue;
6367 continue;
6368 }
6369 }
6370 if (!ar->resrec.InterfaceID)
6371 {
6372 LogSPS("Setting scopeid (ALL) 0x%x 0x%x for %s", updateIntID.l[1], updateIntID.l[0], ARDisplayString(m, ar));
6373 ar->updateIntID = updateIntID;
6374 }
6375 else
6376 {
6377 // Filter records that belong to interfaces that we won't register the records on. UpdateIntID captures
6378 // exactly this.
6379 mDNSu32 scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, ar->resrec.InterfaceID, mDNStrue);
6380 if ((scopeid < (sizeof(updateIntID) * mDNSNBBY)) && bit_get_opaque64(updateIntID, scopeid))
6381 {
6382 bit_set_opaque64(ar->updateIntID, scopeid);
6383 LogSPS("SPSInitRecordsBeforeUpdate: Setting scopeid(%d) 0x%x 0x%x for %s", scopeid, ar->updateIntID.l[1],
6384 ar->updateIntID.l[0], ARDisplayString(m, ar));
6385 }
6386 else
6387 {
6388 LogSPS("SPSInitRecordsBeforeUpdate: scopeid %d beyond range or not valid for SPS registration", scopeid);
6389 }
6390 }
6391 // Store the A and AAAA records that we registered with the sleep proxy.
6392 // We will use this to prevent spurious name conflicts that may occur when we wake up
6393 if (ar->resrec.rrtype == kDNSType_A || ar->resrec.rrtype == kDNSType_AAAA)
6394 {
6395 mDNSCoreStoreProxyRR(m, ar->resrec.InterfaceID, ar);
6396 }
6397 }
6398 }
6399
6400 mDNSlocal void SendSPSRegistration(mDNS *const m, NetworkInterfaceInfo *const intf, const mDNSOpaque16 id)
6401 {
6402 AuthRecord *ar;
6403 OwnerOptData owner = zeroOwner;
6404
6405 SendSPSRegistrationForOwner(m, intf, id, &owner);
6406
6407 for (ar = m->ResourceRecords; ar; ar=ar->next)
6408 {
6409 if (!mDNSPlatformMemSame(&owner, &ar->WakeUp, sizeof(owner)) && RecordIsFirstOccurrenceOfOwner(m, ar))
6410 {
6411 owner = ar->WakeUp;
6412 SendSPSRegistrationForOwner(m, intf, id, &owner);
6413 }
6414 }
6415 }
6416
6417 // RetrySPSRegistrations is called from SendResponses, with the lock held
6418 mDNSlocal void RetrySPSRegistrations(mDNS *const m)
6419 {
6420 AuthRecord *rr;
6421 NetworkInterfaceInfo *intf;
6422
6423 // First make sure none of our interfaces' NextSPSAttemptTimes are inadvertently set to m->timenow + mDNSPlatformOneSecond * 10
6424 for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6425 if (intf->NextSPSAttempt && intf->NextSPSAttemptTime == m->timenow + mDNSPlatformOneSecond * 10)
6426 intf->NextSPSAttemptTime++;
6427
6428 // Retry any record registrations that are due
6429 for (rr = m->ResourceRecords; rr; rr=rr->next)
6430 if (!AuthRecord_uDNS(rr) && !mDNSOpaque16IsZero(rr->updateid) && m->timenow - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
6431 {
6432 for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6433 {
6434 // If we still have registrations pending on this interface, send it now
6435 mDNSu32 scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, intf->InterfaceID, mDNStrue);
6436 if ((scopeid >= (sizeof(rr->updateIntID) * mDNSNBBY) || bit_get_opaque64(rr->updateIntID, scopeid)) &&
6437 (!rr->resrec.InterfaceID || rr->resrec.InterfaceID == intf->InterfaceID))
6438 {
6439 LogSPS("RetrySPSRegistrations: 0x%x 0x%x (updateid %d) %s", rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(rr->updateid), ARDisplayString(m, rr));
6440 SendSPSRegistration(m, intf, rr->updateid);
6441 }
6442 }
6443 }
6444
6445 // For interfaces where we did an SPS registration attempt, increment intf->NextSPSAttempt
6446 for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6447 if (intf->NextSPSAttempt && intf->NextSPSAttemptTime == m->timenow + mDNSPlatformOneSecond * 10 && intf->NextSPSAttempt < 8)
6448 intf->NextSPSAttempt++;
6449 }
6450
6451 mDNSlocal void NetWakeResolve(mDNS *const m, DNSQuestion *question, const ResourceRecord *const answer, QC_result AddRecord)
6452 {
6453 NetworkInterfaceInfo *intf = (NetworkInterfaceInfo *)question->QuestionContext;
6454 int sps = (int)(question - intf->NetWakeResolve);
6455 (void)m; // Unused
6456 LogSPS("NetWakeResolve: SPS: %d Add: %d %s", sps, AddRecord, RRDisplayString(m, answer));
6457
6458 if (!AddRecord) return; // Don't care about REMOVE events
6459 if (answer->rrtype != question->qtype) return; // Don't care about CNAMEs
6460
6461 // if (answer->rrtype == kDNSType_AAAA && sps == 0) return; // To test failing to resolve sleep proxy's address
6462
6463 if (answer->rrtype == kDNSType_SRV)
6464 {
6465 // 1. Got the SRV record; now look up the target host's IP address
6466 mDNS_StopQuery(m, question);
6467 intf->SPSPort[sps] = answer->rdata->u.srv.port;
6468 AssignDomainName(&question->qname, &answer->rdata->u.srv.target);
6469 question->qtype = kDNSType_A;
6470 mDNS_StartQuery(m, question);
6471 }
6472 else if (answer->rrtype == kDNSType_A && answer->rdlength == sizeof(mDNSv4Addr))
6473 {
6474 // 2. Got an IPv4 address for the target host; record address and initiate an SPS registration if appropriate
6475 mDNS_StopQuery(m, question);
6476 question->ThisQInterval = -1;
6477 intf->SPSAddr[sps].type = mDNSAddrType_IPv4;
6478 intf->SPSAddr[sps].ip.v4 = answer->rdata->u.ipv4;
6479 mDNS_Lock(m);
6480 if (sps == intf->NextSPSAttempt/3) SendSPSRegistration(m, intf, zeroID); // If we're ready for this result, use it now
6481 mDNS_Unlock(m);
6482 }
6483 else if (answer->rrtype == kDNSType_A && answer->rdlength == 0)
6484 {
6485 // 3. Got negative response -- target host apparently has IPv6 disabled -- so try looking up the target host's IPv4 address(es) instead
6486 mDNS_StopQuery(m, question);
6487 LogSPS("NetWakeResolve: SPS %d %##s has no IPv4 address, will try IPv6 instead", sps, question->qname.c);
6488 question->qtype = kDNSType_AAAA;
6489 mDNS_StartQuery(m, question);
6490 }
6491 else if (answer->rrtype == kDNSType_AAAA && answer->rdlength == sizeof(mDNSv6Addr) && mDNSv6AddressIsLinkLocal(&answer->rdata->u.ipv6))
6492 {
6493 // 4. Got the target host's IPv6 link-local address; record address and initiate an SPS registration if appropriate
6494 mDNS_StopQuery(m, question);
6495 question->ThisQInterval = -1;
6496 intf->SPSAddr[sps].type = mDNSAddrType_IPv6;
6497 intf->SPSAddr[sps].ip.v6 = answer->rdata->u.ipv6;
6498 mDNS_Lock(m);
6499 if (sps == intf->NextSPSAttempt/3) SendSPSRegistration(m, intf, zeroID); // If we're ready for this result, use it now
6500 mDNS_Unlock(m);
6501 }
6502 }
6503
6504 mDNSexport mDNSBool mDNSCoreHaveAdvertisedMulticastServices(mDNS *const m)
6505 {
6506 AuthRecord *rr;
6507 for (rr = m->ResourceRecords; rr; rr=rr->next)
6508 if (mDNS_KeepaliveRecord(&rr->resrec) || (rr->resrec.rrtype == kDNSType_SRV && !AuthRecord_uDNS(rr) && !mDNSSameIPPort(rr->resrec.rdata->u.srv.port, DiscardPort)))
6509 return mDNStrue;
6510 return mDNSfalse;
6511 }
6512
6513 #define WAKE_ONLY_SERVICE 1
6514 #define AC_ONLY_SERVICE 2
6515
6516 #ifdef APPLE_OSX_mDNSResponder
6517 mDNSlocal void SendGoodbyesForSelectServices(mDNS *const m, mDNSBool *servicePresent, mDNSu32 serviceType)
6518 {
6519 AuthRecord *rr;
6520 *servicePresent = mDNSfalse;
6521
6522 // Mark all the records we need to deregister and send them
6523 for (rr = m->ResourceRecords; rr; rr=rr->next)
6524 {
6525 // If the service type is wake only service and the auth flags match and requires a goodbye
6526 // OR if the service type is AC only and it is not a keepalive record,
6527 // mark the records we need to deregister and send them
6528 if ((serviceType == WAKE_ONLY_SERVICE && (rr->AuthFlags & AuthFlagsWakeOnly) &&
6529 rr->resrec.RecordType == kDNSRecordTypeShared && rr->RequireGoodbye) ||
6530 (serviceType == AC_ONLY_SERVICE && !mDNS_KeepaliveRecord(&rr->resrec)))
6531 {
6532 rr->ImmedAnswer = mDNSInterfaceMark;
6533 *servicePresent = mDNStrue;
6534 }
6535 }
6536 }
6537 #endif
6538
6539 #ifdef APPLE_OSX_mDNSResponder
6540 // This function is used only in the case of local NIC proxy. For external
6541 // sleep proxy server, we do this in SPSInitRecordsBeforeUpdate when we
6542 // walk the resource records.
6543 mDNSlocal void SendGoodbyesForWakeOnlyService(mDNS *const m, mDNSBool *WakeOnlyService)
6544 {
6545 return SendGoodbyesForSelectServices(m, WakeOnlyService, WAKE_ONLY_SERVICE);
6546 }
6547 #endif // APPLE_OSX_mDNSResponder
6548
6549
6550 mDNSlocal void SendSleepGoodbyes(mDNS *const m, mDNSBool AllInterfaces, mDNSBool unicast)
6551 {
6552 AuthRecord *rr;
6553 m->SleepState = SleepState_Sleeping;
6554
6555 // If AllInterfaces is not set, the caller has already marked it appropriately
6556 // on which interfaces this should be sent.
6557 if (AllInterfaces)
6558 {
6559 NetworkInterfaceInfo *intf;
6560 for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6561 {
6562 intf->SendGoodbyes = 1;
6563 }
6564 }
6565 if (unicast)
6566 {
6567 #ifndef UNICAST_DISABLED
6568 SleepRecordRegistrations(m); // If we have no SPS, need to deregister our uDNS records
6569 #endif /* UNICAST_DISABLED */
6570 }
6571
6572 // Mark all the records we need to deregister and send them
6573 for (rr = m->ResourceRecords; rr; rr=rr->next)
6574 if (rr->resrec.RecordType == kDNSRecordTypeShared && rr->RequireGoodbye)
6575 rr->ImmedAnswer = mDNSInterfaceMark;
6576 SendResponses(m);
6577 }
6578
6579 /*
6580 * This function attempts to detect if multiple interfaces are on the same subnet.
6581 * It makes this determination based only on the IPv4 Addresses and subnet masks.
6582 * IPv6 link local addresses that are configured by default on all interfaces make
6583 * it hard to make this determination
6584 *
6585 * The 'real' fix for this would be to send out multicast packets over one interface
6586 * and conclude that multiple interfaces are on the same subnet only if these packets
6587 * are seen on other interfaces on the same system
6588 */
6589 mDNSlocal mDNSBool skipSameSubnetRegistration(mDNS *const m, mDNSInterfaceID *regID, mDNSu32 count, mDNSInterfaceID intfid)
6590 {
6591 NetworkInterfaceInfo *intf;
6592 NetworkInterfaceInfo *newIntf;
6593 mDNSu32 i;
6594
6595 for (newIntf = FirstInterfaceForID(m, intfid); newIntf; newIntf = newIntf->next)
6596 {
6597 if ((newIntf->InterfaceID != intfid) ||
6598 (newIntf->ip.type != mDNSAddrType_IPv4))
6599 {
6600 continue;
6601 }
6602 for ( i = 0; i < count; i++)
6603 {
6604 for (intf = FirstInterfaceForID(m, regID[i]); intf; intf = intf->next)
6605 {
6606 if ((intf->InterfaceID != regID[i]) ||
6607 (intf->ip.type != mDNSAddrType_IPv4))
6608 {
6609 continue;
6610 }
6611 if ((intf->ip.ip.v4.NotAnInteger & intf->mask.ip.v4.NotAnInteger) == (newIntf->ip.ip.v4.NotAnInteger & newIntf->mask.ip.v4.NotAnInteger))
6612 {
6613 LogSPS("%s : Already registered for the same subnet (IPv4) for interface %s", __func__, intf->ifname);
6614 return (mDNStrue);
6615 }
6616 }
6617 }
6618 }
6619 return (mDNSfalse);
6620 }
6621
6622 mDNSlocal void DoKeepaliveCallbacks(mDNS *m)
6623 {
6624 // Loop through the keepalive records and callback with an error
6625 m->CurrentRecord = m->ResourceRecords;
6626 while (m->CurrentRecord)
6627 {
6628 AuthRecord *const rr = m->CurrentRecord;
6629 if ((mDNS_KeepaliveRecord(&rr->resrec)) && (rr->resrec.RecordType != kDNSRecordTypeDeregistering))
6630 {
6631 LogSPS("DoKeepaliveCallbacks: Invoking the callback for %s", ARDisplayString(m, rr));
6632 if (rr->RecordCallback)
6633 rr->RecordCallback(m, rr, mStatus_BadStateErr);
6634 }
6635 if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
6636 m->CurrentRecord = rr->next;
6637 }
6638 }
6639
6640 // BeginSleepProcessing is called, with the lock held, from either mDNS_Execute or mDNSCoreMachineSleep
6641 mDNSlocal void BeginSleepProcessing(mDNS *const m)
6642 {
6643 mDNSBool SendGoodbyes = mDNStrue;
6644 mDNSBool WakeOnlyService = mDNSfalse;
6645 mDNSBool invokeKACallback = mDNStrue;
6646 const CacheRecord *sps[3] = { mDNSNULL };
6647 mDNSOpaque64 updateIntID = zeroOpaque64;
6648 mDNSInterfaceID registeredIntfIDS[128] = { 0 };
6649 mDNSu32 registeredCount = 0;
6650 int skippedRegistrations = 0;
6651
6652 m->NextScheduledSPRetry = m->timenow;
6653
6654 // Clear out the SCDynamic entry that stores the external SPS information
6655 mDNSPlatformClearSPSData();
6656
6657 if (!m->SystemWakeOnLANEnabled) LogSPS("BeginSleepProcessing: m->SystemWakeOnLANEnabled is false");
6658 else if (!mDNSCoreHaveAdvertisedMulticastServices(m)) LogSPS("BeginSleepProcessing: No advertised services");
6659 else // If we have at least one advertised service
6660 {
6661 NetworkInterfaceInfo *intf;
6662 for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
6663 {
6664 // Intialize it to false. These values make sense only when SleepState is set to Sleeping.
6665 intf->SendGoodbyes = 0;
6666
6667 // If it is not multicast capable, we could not have possibly discovered sleep proxy
6668 // servers.
6669 if (!intf->McastTxRx || mDNSPlatformInterfaceIsD2D(intf->InterfaceID))
6670 {
6671 LogSPS("BeginSleepProcessing: %-6s Ignoring for registrations", intf->ifname);
6672 continue;
6673 }
6674
6675 // If we are not capable of WOMP, then don't register with sleep proxy.
6676 //
6677 // Note: If we are not NetWake capable, we don't browse for the sleep proxy server.
6678 // We might find sleep proxy servers in the cache and start a resolve on them.
6679 // But then if the interface goes away, we won't stop these questions because
6680 // mDNS_DeactivateNetWake_internal assumes that a browse has been started for it
6681 // to stop both the browse and resolve questions.
6682 if (!intf->NetWake)
6683 {
6684 LogSPS("BeginSleepProcessing: %-6s not capable of magic packet wakeup", intf->ifname);
6685 intf->SendGoodbyes = 1;
6686 skippedRegistrations++;
6687 continue;
6688 }
6689
6690 // Check if we have already registered with a sleep proxy for this subnet
6691 if (skipSameSubnetRegistration(m, registeredIntfIDS, registeredCount, intf->InterfaceID))
6692 {
6693 LogSPS("%s : Skipping sleep proxy registration on %s", __func__, intf->ifname);
6694 continue;
6695 }
6696
6697 #if APPLE_OSX_mDNSResponder
6698 else if (SupportsInNICProxy(intf))
6699 {
6700 mDNSBool keepaliveOnly = mDNSfalse;
6701 if (ActivateLocalProxy(intf, &keepaliveOnly) == mStatus_NoError)
6702 {
6703 SendGoodbyesForWakeOnlyService(m, &WakeOnlyService);
6704
6705 // Send goodbyes for all advertised services if the only record offloaded was the keepalive record.
6706 SendGoodbyes = (keepaliveOnly) ? mDNStrue: mDNSfalse;
6707 invokeKACallback = mDNSfalse;
6708 LogSPS("BeginSleepProcessing: %-6s using local proxy", intf->ifname);
6709 // This will leave m->SleepState set to SleepState_Transferring,
6710 // which is okay because with no outstanding resolves, or updates in flight,
6711 // mDNSCoreReadyForSleep() will conclude correctly that all the updates have already completed
6712
6713 // Setting this flag activates the SleepLimit which delays sleep by 5 seconds and
6714 // will allow the system to deregister any BTMM records.
6715 m->NextScheduledSPRetry = m->timenow + (5 * mDNSPlatformOneSecond);
6716 registeredIntfIDS[registeredCount] = intf->InterfaceID;
6717 registeredCount++;
6718 }
6719 }
6720 #endif // APPLE_OSX_mDNSResponder
6721 else
6722 {
6723 #if APPLE_OSX_mDNSResponder
6724 // If on battery, do not attempt to offload to external sleep proxies
6725 if (m->SystemWakeOnLANEnabled == mDNS_WakeOnBattery)
6726 {
6727 LogSPS("BegingSleepProcessing: Not connected to AC power - Not registering with an external sleep proxy.");
6728 return;
6729 }
6730 #endif // APPLE_OSX_mDNSResponder
6731 FindSPSInCache(m, &intf->NetWakeBrowse, sps);
6732 if (!sps[0]) LogSPS("BeginSleepProcessing: %-6s %#a No Sleep Proxy Server found (Next Browse Q in %d, interval %d)",
6733 intf->ifname, &intf->ip, NextQSendTime(&intf->NetWakeBrowse) - m->timenow, intf->NetWakeBrowse.ThisQInterval);
6734 else
6735 {
6736 int i;
6737 mDNSu32 scopeid;
6738 SendGoodbyes = mDNSfalse;
6739 intf->NextSPSAttempt = 0;
6740 intf->NextSPSAttemptTime = m->timenow + mDNSPlatformOneSecond;
6741
6742 scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, intf->InterfaceID, mDNStrue);
6743 // Now we know for sure that we have to wait for registration to complete on this interface.
6744 if (scopeid < (sizeof(updateIntID) * mDNSNBBY))
6745 bit_set_opaque64(updateIntID, scopeid);
6746
6747 // Don't need to set m->NextScheduledSPRetry here because we already set "m->NextScheduledSPRetry = m->timenow" above
6748 for (i=0; i<3; i++)
6749 {
6750 #if ForceAlerts
6751 if (intf->SPSAddr[i].type)
6752 LogFatalError("BeginSleepProcessing: %s %d intf->SPSAddr[i].type %d", intf->ifname, i, intf->SPSAddr[i].type);
6753 if (intf->NetWakeResolve[i].ThisQInterval >= 0)
6754 LogFatalError("BeginSleepProcessing: %s %d intf->NetWakeResolve[i].ThisQInterval %d", intf->ifname, i, intf->NetWakeResolve[i].ThisQInterval);
6755 #endif
6756 intf->SPSAddr[i].type = mDNSAddrType_None;
6757 if (intf->NetWakeResolve[i].ThisQInterval >= 0) mDNS_StopQuery(m, &intf->NetWakeResolve[i]);
6758 intf->NetWakeResolve[i].ThisQInterval = -1;
6759 if (sps[i])
6760 {
6761 LogSPS("BeginSleepProcessing: %-6s Found Sleep Proxy Server %d TTL %d %s", intf->ifname, i, sps[i]->resrec.rroriginalttl, CRDisplayString(m, sps[i]));
6762 mDNS_SetupQuestion(&intf->NetWakeResolve[i], intf->InterfaceID, &sps[i]->resrec.rdata->u.name, kDNSType_SRV, NetWakeResolve, intf);
6763 intf->NetWakeResolve[i].ReturnIntermed = mDNStrue;
6764 mDNS_StartQuery_internal(m, &intf->NetWakeResolve[i]);
6765
6766 // If we are registering with a Sleep Proxy for a new subnet, add it to our list
6767 registeredIntfIDS[registeredCount] = intf->InterfaceID;
6768 registeredCount++;
6769 }
6770 }
6771 }
6772 }
6773 }
6774 }
6775
6776 // If we have at least one interface on which we are registering with an external sleep proxy,
6777 // initialize all the records appropriately.
6778 if (!mDNSOpaque64IsZero(&updateIntID))
6779 SPSInitRecordsBeforeUpdate(m, updateIntID, &WakeOnlyService);
6780
6781 // Call the applicaitons that registered a keepalive record to inform them that we failed to offload
6782 // the records to a sleep proxy.
6783 if (invokeKACallback)
6784 {
6785 LogSPS("BeginSleepProcessing: Did not register with an in-NIC proxy - invoking the callbacks for KA records");
6786 DoKeepaliveCallbacks(m);
6787 }
6788
6789 // SendSleepGoodbyes last two arguments control whether we send goodbyes on all
6790 // interfaces and also deregister unicast registrations.
6791 //
6792 // - If there are no sleep proxy servers, then send goodbyes on all interfaces
6793 // for both multicast and unicast.
6794 //
6795 // - If we skipped registrations on some interfaces, then we have already marked
6796 // them appropriately above. We don't need to send goodbyes for unicast as
6797 // we have registered with at least one sleep proxy.
6798 //
6799 // - If we are not planning to send any goodbyes, then check for WakeOnlyServices.
6800 //
6801 // Note: If we are planning to send goodbyes, we mark the record with mDNSInterfaceAny
6802 // and call SendResponses which inturn calls ShouldSendGoodbyesBeforeSleep which looks
6803 // at WakeOnlyServices first.
6804 if (SendGoodbyes)
6805 {
6806 LogSPS("BeginSleepProcessing: Not registering with Sleep Proxy Server");
6807 SendSleepGoodbyes(m, mDNStrue, mDNStrue);
6808 }
6809 else if (skippedRegistrations)
6810 {
6811 LogSPS("BeginSleepProcessing: Not registering with Sleep Proxy Server on all interfaces");
6812 SendSleepGoodbyes(m, mDNSfalse, mDNSfalse);
6813 }
6814 else if (WakeOnlyService)
6815 {
6816 // If we saw WakeOnly service above, send the goodbyes now.
6817 LogSPS("BeginSleepProcessing: Sending goodbyes for WakeOnlyService");
6818 SendResponses(m);
6819 }
6820 }
6821
6822 // Call mDNSCoreMachineSleep(m, mDNStrue) when the machine is about to go to sleep.
6823 // Call mDNSCoreMachineSleep(m, mDNSfalse) when the machine is has just woken up.
6824 // Normally, the platform support layer below mDNSCore should call this, not the client layer above.
6825 mDNSexport void mDNSCoreMachineSleep(mDNS *const m, mDNSBool sleep)
6826 {
6827 AuthRecord *rr;
6828
6829 LogSPS("%s (old state %d) at %ld", sleep ? "Sleeping" : "Waking", m->SleepState, m->timenow);
6830
6831 if (sleep && !m->SleepState) // Going to sleep
6832 {
6833 mDNS_Lock(m);
6834 // If we're going to sleep, need to stop advertising that we're a Sleep Proxy Server
6835 if (m->SPSSocket)
6836 {
6837 mDNSu8 oldstate = m->SPSState;
6838 mDNS_DropLockBeforeCallback(); // mDNS_DeregisterService expects to be called without the lock held, so we emulate that here
6839 m->SPSState = 2;
6840 #ifndef SPC_DISABLED
6841 if (oldstate == 1) mDNS_DeregisterService(m, &m->SPSRecords);
6842 #else
6843 (void)oldstate;
6844 #endif
6845 mDNS_ReclaimLockAfterCallback();
6846 }
6847 #ifdef _LEGACY_NAT_TRAVERSAL_
6848 if (m->SSDPSocket)
6849 {
6850 mDNSPlatformUDPClose(m->SSDPSocket);
6851 m->SSDPSocket = mDNSNULL;
6852 }
6853 #endif
6854 m->SleepState = SleepState_Transferring;
6855 if (m->SystemWakeOnLANEnabled && m->DelaySleep)
6856 {
6857 // If we just woke up moments ago, allow ten seconds for networking to stabilize before going back to sleep
6858 LogSPS("mDNSCoreMachineSleep: Re-sleeping immediately after waking; will delay for %d ticks", m->DelaySleep - m->timenow);
6859 m->SleepLimit = NonZeroTime(m->DelaySleep + mDNSPlatformOneSecond * 10);
6860 }
6861 else
6862 {
6863 m->DelaySleep = 0;
6864 m->SleepLimit = NonZeroTime(m->timenow + mDNSPlatformOneSecond * 10);
6865 m->mDNSStats.Sleeps++;
6866 BeginSleepProcessing(m);
6867 }
6868
6869 #ifndef UNICAST_DISABLED
6870 SuspendLLQs(m);
6871 #endif
6872 #if APPLE_OSX_mDNSResponder
6873 RemoveAutoTunnel6Record(m);
6874 #endif
6875 LogSPS("mDNSCoreMachineSleep: m->SleepState %d (%s) seq %d", m->SleepState,
6876 m->SleepState == SleepState_Transferring ? "Transferring" :
6877 m->SleepState == SleepState_Sleeping ? "Sleeping" : "?", m->SleepSeqNum);
6878 mDNS_Unlock(m);
6879 }
6880 else if (!sleep) // Waking up
6881 {
6882 mDNSu32 slot;
6883 CacheGroup *cg;
6884 CacheRecord *cr;
6885 NetworkInterfaceInfo *intf;
6886 mDNSs32 currtime, diff;
6887
6888 mDNS_Lock(m);
6889 // Reset SleepLimit back to 0 now that we're awake again.
6890 m->SleepLimit = 0;
6891
6892 // If we were previously sleeping, but now we're not, increment m->SleepSeqNum to indicate that we're entering a new period of wakefulness
6893 if (m->SleepState != SleepState_Awake)
6894 {
6895 m->SleepState = SleepState_Awake;
6896 m->SleepSeqNum++;
6897 // If the machine wakes and then immediately tries to sleep again (e.g. a maintenance wake)
6898 // then we enforce a minimum delay of five seconds before we begin sleep processing.
6899 // This is to allow time for the Ethernet link to come up, DHCP to get an address, mDNS to issue queries, etc.,
6900 // before we make our determination of whether there's a Sleep Proxy out there we should register with.
6901 m->DelaySleep = NonZeroTime(m->timenow + kDarkWakeDelaySleep);
6902 }
6903
6904 if (m->SPSState == 3)
6905 {
6906 m->SPSState = 0;
6907 mDNSCoreBeSleepProxyServer_internal(m, m->SPSType, m->SPSPortability, m->SPSMarginalPower, m->SPSTotalPower, m->SPSFeatureFlags);
6908 }
6909 m->mDNSStats.Wakes++;
6910 m->DelayConflictProcessing = MAX_CONFLICT_PROCESSING_DELAYS;
6911 // ... and the same for NextSPSAttempt
6912 for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next)) intf->NextSPSAttempt = -1;
6913
6914 // Restart unicast and multicast queries
6915 mDNSCoreRestartQueries(m);
6916
6917 // and reactivtate service registrations
6918 m->NextSRVUpdate = NonZeroTime(m->timenow + mDNSPlatformOneSecond);
6919 LogInfo("mDNSCoreMachineSleep waking: NextSRVUpdate in %d %d", m->NextSRVUpdate - m->timenow, m->timenow);
6920
6921 // 2. Re-validate our cache records
6922 currtime = mDNSPlatformUTC();
6923
6924 diff = currtime - m->TimeSlept;
6925 FORALL_CACHERECORDS(slot, cg, cr)
6926 {
6927 // Temporary fix: For unicast cache records, look at how much time we slept.
6928 // Adjust the RecvTime by the amount of time we slept so that we age the
6929 // cache record appropriately. If it is expired already, purge. If there
6930 // is a network change that happens after the wakeup, we might purge the
6931 // cache anyways and this helps only in the case where there are no network
6932 // changes across sleep/wakeup transition.
6933 //
6934 // Note: If there is a network/DNS server change that already happened and
6935 // these cache entries are already refreshed and we are getting a delayed
6936 // wake up notification, we might adjust the TimeRcvd based on the time slept
6937 // now which can cause the cache to purge pre-maturely. As this is not a very
6938 // common case, this should happen rarely.
6939 if (!cr->resrec.InterfaceID)
6940 {
6941 if (diff > 0)
6942 {
6943 mDNSu32 uTTL = RRUnadjustedTTL(cr->resrec.rroriginalttl);
6944 const mDNSs32 remain = uTTL - (m->timenow - cr->TimeRcvd) / mDNSPlatformOneSecond;
6945
6946 // -if we have slept longer than the remaining TTL, purge and start fresh.
6947 // -if we have been sleeping for a long time, we could reduce TimeRcvd below by
6948 // a sufficiently big value which could cause the value to go into the future
6949 // because of the signed comparison of time. For this to happen, we should have been
6950 // sleeping really long (~24 days). For now, we want to be conservative and flush even
6951 // if we have slept for more than two days.
6952
6953 if (diff >= remain || diff > (2 * 24 * 3600))
6954 {
6955 LogInfo("mDNSCoreMachineSleep: %s: Purging cache entry SleptTime %d, Remaining TTL %d",
6956 CRDisplayString(m, cr), diff, remain);
6957 mDNS_PurgeCacheResourceRecord(m, cr);
6958 continue;
6959 }
6960 cr->TimeRcvd -= (diff * mDNSPlatformOneSecond);
6961 if (m->timenow - (cr->TimeRcvd + ((mDNSs32)uTTL * mDNSPlatformOneSecond)) >= 0)
6962 {
6963 LogInfo("mDNSCoreMachineSleep: %s: Purging after adjusting the remaining TTL %d by %d seconds",
6964 CRDisplayString(m, cr), remain, diff);
6965 mDNS_PurgeCacheResourceRecord(m, cr);
6966 }
6967 else
6968 {
6969 LogInfo("mDNSCoreMachineSleep: %s: Adjusted the remain ttl %u by %d seconds", CRDisplayString(m, cr), remain, diff);
6970 }
6971 }
6972 }
6973 else
6974 {
6975 mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForWake);
6976 }
6977 }
6978
6979 // 3. Retrigger probing and announcing for all our authoritative records
6980 for (rr = m->ResourceRecords; rr; rr=rr->next)
6981 {
6982 if (AuthRecord_uDNS(rr))
6983 {
6984 ActivateUnicastRegistration(m, rr);
6985 }
6986 else
6987 {
6988 mDNSCoreRestartRegistration(m, rr, -1);
6989 }
6990 }
6991
6992 // 4. Refresh NAT mappings
6993 // We don't want to have to assume that all hardware can necessarily keep accurate
6994 // track of passage of time while asleep, so on wake we refresh our NAT mappings.
6995 // We typically wake up with no interfaces active, so there's no need to rush to try to find our external address.
6996 // But if we do get a network configuration change, mDNSMacOSXNetworkChanged will call uDNS_SetupDNSConfig, which
6997 // will call mDNS_SetPrimaryInterfaceInfo, which will call RecreateNATMappings to refresh them, potentially sooner
6998 // than five seconds from now.
6999 LogInfo("mDNSCoreMachineSleep: recreating NAT mappings in 5 seconds");
7000 RecreateNATMappings(m, mDNSPlatformOneSecond * 5);
7001 mDNS_Unlock(m);
7002 }
7003 }
7004
7005 mDNSexport mDNSBool mDNSCoreReadyForSleep(mDNS *m, mDNSs32 now)
7006 {
7007 DNSQuestion *q;
7008 AuthRecord *rr;
7009 NetworkInterfaceInfo *intf;
7010
7011 mDNS_Lock(m);
7012
7013 if (m->DelaySleep) goto notready;
7014
7015 // If we've not hit the sleep limit time, and it's not time for our next retry, we can skip these checks
7016 if (m->SleepLimit - now > 0 && m->NextScheduledSPRetry - now > 0) goto notready;
7017
7018 m->NextScheduledSPRetry = now + 0x40000000UL;
7019
7020 // See if we might need to retransmit any lost Sleep Proxy Registrations
7021 for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
7022 if (intf->NextSPSAttempt >= 0)
7023 {
7024 if (now - intf->NextSPSAttemptTime >= 0)
7025 {
7026 LogSPS("mDNSCoreReadyForSleep: retrying for %s SPS %d try %d",
7027 intf->ifname, intf->NextSPSAttempt/3, intf->NextSPSAttempt);
7028 SendSPSRegistration(m, intf, zeroID);
7029 // Don't need to "goto notready" here, because if we do still have record registrations
7030 // that have not been acknowledged yet, we'll catch that in the record list scan below.
7031 }
7032 else
7033 if (m->NextScheduledSPRetry - intf->NextSPSAttemptTime > 0)
7034 m->NextScheduledSPRetry = intf->NextSPSAttemptTime;
7035 }
7036
7037 // Scan list of interfaces, and see if we're still waiting for any sleep proxy resolves to complete
7038 for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
7039 {
7040 int sps = (intf->NextSPSAttempt == 0) ? 0 : (intf->NextSPSAttempt-1)/3;
7041 if (intf->NetWakeResolve[sps].ThisQInterval >= 0)
7042 {
7043 LogSPS("mDNSCoreReadyForSleep: waiting for SPS Resolve %s %##s (%s)",
7044 intf->ifname, intf->NetWakeResolve[sps].qname.c, DNSTypeName(intf->NetWakeResolve[sps].qtype));
7045 goto spsnotready;
7046 }
7047 }
7048
7049 // Scan list of registered records
7050 for (rr = m->ResourceRecords; rr; rr = rr->next)
7051 if (!AuthRecord_uDNS(rr))
7052 if (!mDNSOpaque64IsZero(&rr->updateIntID))
7053 { LogSPS("mDNSCoreReadyForSleep: waiting for SPS updateIntID 0x%x 0x%x (updateid %d) %s", rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(rr->updateid), ARDisplayString(m,rr)); goto spsnotready; }
7054
7055 // Scan list of private LLQs, and make sure they've all completed their handshake with the server
7056 for (q = m->Questions; q; q = q->next)
7057 if (!mDNSOpaque16IsZero(q->TargetQID) && q->LongLived && q->ReqLease == 0 && q->tcp)
7058 {
7059 LogSPS("mDNSCoreReadyForSleep: waiting for LLQ %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
7060 goto notready;
7061 }
7062
7063 // Scan list of registered records
7064 for (rr = m->ResourceRecords; rr; rr = rr->next)
7065 if (AuthRecord_uDNS(rr))
7066 {
7067 if (rr->state == regState_Refresh && rr->tcp)
7068 { LogSPS("mDNSCoreReadyForSleep: waiting for Record updateIntID 0x%x 0x%x (updateid %d) %s", rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(rr->updateid), ARDisplayString(m,rr)); goto notready; }
7069 #if APPLE_OSX_mDNSResponder
7070 if (!RecordReadyForSleep(rr)) { LogSPS("mDNSCoreReadyForSleep: waiting for %s", ARDisplayString(m, rr)); goto notready; }
7071 #endif
7072 }
7073
7074 mDNS_Unlock(m);
7075 return mDNStrue;
7076
7077 spsnotready:
7078
7079 // If we failed to complete sleep proxy registration within ten seconds, we give up on that
7080 // and allow up to ten seconds more to complete wide-area deregistration instead
7081 if (now - m->SleepLimit >= 0)
7082 {
7083 LogMsg("Failed to register with SPS, now sending goodbyes");
7084
7085 for (intf = GetFirstActiveInterface(m->HostInterfaces); intf; intf = GetFirstActiveInterface(intf->next))
7086 if (intf->NetWakeBrowse.ThisQInterval >= 0)
7087 {
7088 LogSPS("ReadyForSleep mDNS_DeactivateNetWake %s %##s (%s)",
7089 intf->ifname, intf->NetWakeResolve[0].qname.c, DNSTypeName(intf->NetWakeResolve[0].qtype));
7090 mDNS_DeactivateNetWake_internal(m, intf);
7091 }
7092
7093 for (rr = m->ResourceRecords; rr; rr = rr->next)
7094 if (!AuthRecord_uDNS(rr))
7095 if (!mDNSOpaque64IsZero(&rr->updateIntID))
7096 {
7097 LogSPS("ReadyForSleep clearing updateIntID 0x%x 0x%x (updateid %d) for %s", rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(rr->updateid), ARDisplayString(m, rr));
7098 rr->updateIntID = zeroOpaque64;
7099 }
7100
7101 // We'd really like to allow up to ten seconds more here,
7102 // but if we don't respond to the sleep notification within 30 seconds
7103 // we'll be put back to sleep forcibly without the chance to schedule the next maintenance wake.
7104 // Right now we wait 16 sec after wake for all the interfaces to come up, then we wait up to 10 seconds
7105 // more for SPS resolves and record registrations to complete, which puts us at 26 seconds.
7106 // If we allow just one more second to send our goodbyes, that puts us at 27 seconds.
7107 m->SleepLimit = now + mDNSPlatformOneSecond * 1;
7108
7109 SendSleepGoodbyes(m, mDNStrue, mDNStrue);
7110 }
7111
7112 notready:
7113 mDNS_Unlock(m);
7114 return mDNSfalse;
7115 }
7116
7117 mDNSexport mDNSs32 mDNSCoreIntervalToNextWake(mDNS *const m, mDNSs32 now)
7118 {
7119 AuthRecord *ar;
7120
7121 // Even when we have no wake-on-LAN-capable interfaces, or we failed to find a sleep proxy, or we have other
7122 // failure scenarios, we still want to wake up in at most 120 minutes, to see if the network environment has changed.
7123 // E.g. we might wake up and find no wireless network because the base station got rebooted just at that moment,
7124 // and if that happens we don't want to just give up and go back to sleep and never try again.
7125 mDNSs32 e = now + (120 * 60 * mDNSPlatformOneSecond); // Sleep for at most 120 minutes
7126
7127 NATTraversalInfo *nat;
7128 for (nat = m->NATTraversals; nat; nat=nat->next)
7129 if (nat->Protocol && nat->ExpiryTime && nat->ExpiryTime - now > mDNSPlatformOneSecond*4)
7130 {
7131 mDNSs32 t = nat->ExpiryTime - (nat->ExpiryTime - now) / 10; // Wake up when 90% of the way to the expiry time
7132 if (e - t > 0) e = t;
7133 LogSPS("ComputeWakeTime: %p %s Int %5d Ext %5d Err %d Retry %5d Interval %5d Expire %5d Wake %5d",
7134 nat, nat->Protocol == NATOp_MapTCP ? "TCP" : "UDP",
7135 mDNSVal16(nat->IntPort), mDNSVal16(nat->ExternalPort), nat->Result,
7136 nat->retryPortMap ? (nat->retryPortMap - now) / mDNSPlatformOneSecond : 0,
7137 nat->retryInterval / mDNSPlatformOneSecond,
7138 nat->ExpiryTime ? (nat->ExpiryTime - now) / mDNSPlatformOneSecond : 0,
7139 (t - now) / mDNSPlatformOneSecond);
7140 }
7141
7142 // This loop checks both the time we need to renew wide-area registrations,
7143 // and the time we need to renew Sleep Proxy registrations
7144 for (ar = m->ResourceRecords; ar; ar = ar->next)
7145 if (ar->expire && ar->expire - now > mDNSPlatformOneSecond*4)
7146 {
7147 mDNSs32 t = ar->expire - (ar->expire - now) / 10; // Wake up when 90% of the way to the expiry time
7148 if (e - t > 0) e = t;
7149 LogSPS("ComputeWakeTime: %p Int %7d Next %7d Expire %7d Wake %7d %s",
7150 ar, ar->ThisAPInterval / mDNSPlatformOneSecond,
7151 (ar->LastAPTime + ar->ThisAPInterval - now) / mDNSPlatformOneSecond,
7152 ar->expire ? (ar->expire - now) / mDNSPlatformOneSecond : 0,
7153 (t - now) / mDNSPlatformOneSecond, ARDisplayString(m, ar));
7154 }
7155
7156 return(e - now);
7157 }
7158
7159 // ***************************************************************************
7160 #if COMPILER_LIKES_PRAGMA_MARK
7161 #pragma mark -
7162 #pragma mark - Packet Reception Functions
7163 #endif
7164
7165 #define MustSendRecord(RR) ((RR)->NR_AnswerTo || (RR)->NR_AdditionalTo)
7166
7167 mDNSlocal mDNSu8 *GenerateUnicastResponse(const DNSMessage *const query, const mDNSu8 *const end,
7168 const mDNSInterfaceID InterfaceID, mDNSBool LegacyQuery, DNSMessage *const response, AuthRecord *ResponseRecords)
7169 {
7170 mDNSu8 *responseptr = response->data;
7171 const mDNSu8 *const limit = response->data + sizeof(response->data);
7172 const mDNSu8 *ptr = query->data;
7173 AuthRecord *rr;
7174 mDNSu32 maxttl = 0x70000000;
7175 int i;
7176
7177 // Initialize the response fields so we can answer the questions
7178 InitializeDNSMessage(&response->h, query->h.id, ResponseFlags);
7179
7180 // ***
7181 // *** 1. Write out the list of questions we are actually going to answer with this packet
7182 // ***
7183 if (LegacyQuery)
7184 {
7185 maxttl = kStaticCacheTTL;
7186 for (i=0; i<query->h.numQuestions; i++) // For each question...
7187 {
7188 DNSQuestion q;
7189 ptr = getQuestion(query, ptr, end, InterfaceID, &q); // get the question...
7190 if (!ptr) return(mDNSNULL);
7191
7192 for (rr=ResponseRecords; rr; rr=rr->NextResponse) // and search our list of proposed answers
7193 {
7194 if (rr->NR_AnswerTo == ptr) // If we're going to generate a record answering this question
7195 { // then put the question in the question section
7196 responseptr = putQuestion(response, responseptr, limit, &q.qname, q.qtype, q.qclass);
7197 if (!responseptr) { debugf("GenerateUnicastResponse: Ran out of space for questions!"); return(mDNSNULL); }
7198 break; // break out of the ResponseRecords loop, and go on to the next question
7199 }
7200 }
7201 }
7202
7203 if (response->h.numQuestions == 0) { LogMsg("GenerateUnicastResponse: ERROR! Why no questions?"); return(mDNSNULL); }
7204 }
7205
7206 // ***
7207 // *** 2. Write Answers
7208 // ***
7209 for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7210 if (rr->NR_AnswerTo)
7211 {
7212 mDNSu8 *p = PutResourceRecordTTL(response, responseptr, &response->h.numAnswers, &rr->resrec,
7213 maxttl < rr->resrec.rroriginalttl ? maxttl : rr->resrec.rroriginalttl);
7214 if (p) responseptr = p;
7215 else { debugf("GenerateUnicastResponse: Ran out of space for answers!"); response->h.flags.b[0] |= kDNSFlag0_TC; }
7216 }
7217
7218 // ***
7219 // *** 3. Write Additionals
7220 // ***
7221 for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7222 if (rr->NR_AdditionalTo && !rr->NR_AnswerTo)
7223 {
7224 mDNSu8 *p = PutResourceRecordTTL(response, responseptr, &response->h.numAdditionals, &rr->resrec,
7225 maxttl < rr->resrec.rroriginalttl ? maxttl : rr->resrec.rroriginalttl);
7226 if (p) responseptr = p;
7227 else debugf("GenerateUnicastResponse: No more space for additionals");
7228 }
7229
7230 return(responseptr);
7231 }
7232
7233 // AuthRecord *our is our Resource Record
7234 // CacheRecord *pkt is the Resource Record from the response packet we've witnessed on the network
7235 // Returns 0 if there is no conflict
7236 // Returns +1 if there was a conflict and we won
7237 // Returns -1 if there was a conflict and we lost and have to rename
7238 mDNSlocal int CompareRData(const AuthRecord *const our, const CacheRecord *const pkt)
7239 {
7240 mDNSu8 ourdata[256], *ourptr = ourdata, *ourend;
7241 mDNSu8 pktdata[256], *pktptr = pktdata, *pktend;
7242 if (!our) { LogMsg("CompareRData ERROR: our is NULL"); return(+1); }
7243 if (!pkt) { LogMsg("CompareRData ERROR: pkt is NULL"); return(+1); }
7244
7245 ourend = putRData(mDNSNULL, ourdata, ourdata + sizeof(ourdata), &our->resrec);
7246 pktend = putRData(mDNSNULL, pktdata, pktdata + sizeof(pktdata), &pkt->resrec);
7247 while (ourptr < ourend && pktptr < pktend && *ourptr == *pktptr) { ourptr++; pktptr++; }
7248 if (ourptr >= ourend && pktptr >= pktend) return(0); // If data identical, not a conflict
7249
7250 if (ourptr >= ourend) return(-1); // Our data ran out first; We lost
7251 if (pktptr >= pktend) return(+1); // Packet data ran out first; We won
7252 if (*pktptr > *ourptr) return(-1); // Our data is numerically lower; We lost
7253 if (*pktptr < *ourptr) return(+1); // Packet data is numerically lower; We won
7254
7255 LogMsg("CompareRData ERROR: Invalid state");
7256 return(-1);
7257 }
7258
7259 // See if we have an authoritative record that's identical to this packet record,
7260 // whose canonical DependentOn record is the specified master record.
7261 // The DependentOn pointer is typically used for the TXT record of service registrations
7262 // It indicates that there is no inherent conflict detection for the TXT record
7263 // -- it depends on the SRV record to resolve name conflicts
7264 // If we find any identical ResourceRecords in our authoritative list, then follow their DependentOn
7265 // pointer chain (if any) to make sure we reach the canonical DependentOn record
7266 // If the record has no DependentOn, then just return that record's pointer
7267 // Returns NULL if we don't have any local RRs that are identical to the one from the packet
7268 mDNSlocal mDNSBool MatchDependentOn(const mDNS *const m, const CacheRecord *const pktrr, const AuthRecord *const master)
7269 {
7270 const AuthRecord *r1;
7271 for (r1 = m->ResourceRecords; r1; r1=r1->next)
7272 {
7273 if (IdenticalResourceRecord(&r1->resrec, &pktrr->resrec))
7274 {
7275 const AuthRecord *r2 = r1;
7276 while (r2->DependentOn) r2 = r2->DependentOn;
7277 if (r2 == master) return(mDNStrue);
7278 }
7279 }
7280 for (r1 = m->DuplicateRecords; r1; r1=r1->next)
7281 {
7282 if (IdenticalResourceRecord(&r1->resrec, &pktrr->resrec))
7283 {
7284 const AuthRecord *r2 = r1;
7285 while (r2->DependentOn) r2 = r2->DependentOn;
7286 if (r2 == master) return(mDNStrue);
7287 }
7288 }
7289 return(mDNSfalse);
7290 }
7291
7292 // Find the canonical RRSet pointer for this RR received in a packet.
7293 // If we find any identical AuthRecord in our authoritative list, then follow its RRSet
7294 // pointers (if any) to make sure we return the canonical member of this name/type/class
7295 // Returns NULL if we don't have any local RRs that are identical to the one from the packet
7296 mDNSlocal const AuthRecord *FindRRSet(const mDNS *const m, const CacheRecord *const pktrr)
7297 {
7298 const AuthRecord *rr;
7299 for (rr = m->ResourceRecords; rr; rr=rr->next)
7300 {
7301 if (IdenticalResourceRecord(&rr->resrec, &pktrr->resrec))
7302 {
7303 while (rr->RRSet && rr != rr->RRSet) rr = rr->RRSet;
7304 return(rr);
7305 }
7306 }
7307 return(mDNSNULL);
7308 }
7309
7310 // PacketRRConflict is called when we've received an RR (pktrr) which has the same name
7311 // as one of our records (our) but different rdata.
7312 // 1. If our record is not a type that's supposed to be unique, we don't care.
7313 // 2a. If our record is marked as dependent on some other record for conflict detection, ignore this one.
7314 // 2b. If the packet rr exactly matches one of our other RRs, and *that* record's DependentOn pointer
7315 // points to our record, ignore this conflict (e.g. the packet record matches one of our
7316 // TXT records, and that record is marked as dependent on 'our', its SRV record).
7317 // 3. If we have some *other* RR that exactly matches the one from the packet, and that record and our record
7318 // are members of the same RRSet, then this is not a conflict.
7319 mDNSlocal mDNSBool PacketRRConflict(const mDNS *const m, const AuthRecord *const our, const CacheRecord *const pktrr)
7320 {
7321 // If not supposed to be unique, not a conflict
7322 if (!(our->resrec.RecordType & kDNSRecordTypeUniqueMask)) return(mDNSfalse);
7323
7324 // If a dependent record, not a conflict
7325 if (our->DependentOn || MatchDependentOn(m, pktrr, our)) return(mDNSfalse);
7326 else
7327 {
7328 // If the pktrr matches a member of ourset, not a conflict
7329 const AuthRecord *ourset = our->RRSet ? our->RRSet : our;
7330 const AuthRecord *pktset = FindRRSet(m, pktrr);
7331 if (pktset == ourset) return(mDNSfalse);
7332
7333 // For records we're proxying, where we don't know the full
7334 // relationship between the records, having any matching record
7335 // in our AuthRecords list is sufficient evidence of non-conflict
7336 if (our->WakeUp.HMAC.l[0] && pktset) return(mDNSfalse);
7337 }
7338
7339 // Okay, this is a conflict
7340 return(mDNStrue);
7341 }
7342
7343 // Note: ResolveSimultaneousProbe calls mDNS_Deregister_internal which can call a user callback, which may change
7344 // the record list and/or question list.
7345 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
7346 mDNSlocal void ResolveSimultaneousProbe(mDNS *const m, const DNSMessage *const query, const mDNSu8 *const end,
7347 DNSQuestion *q, AuthRecord *our)
7348 {
7349 int i;
7350 const mDNSu8 *ptr = LocateAuthorities(query, end);
7351 mDNSBool FoundUpdate = mDNSfalse;
7352
7353 for (i = 0; i < query->h.numAuthorities; i++)
7354 {
7355 ptr = GetLargeResourceRecord(m, query, ptr, end, q->InterfaceID, kDNSRecordTypePacketAuth, &m->rec);
7356 if (!ptr) break;
7357 if (m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && ResourceRecordAnswersQuestion(&m->rec.r.resrec, q))
7358 {
7359 FoundUpdate = mDNStrue;
7360 if (PacketRRConflict(m, our, &m->rec.r))
7361 {
7362 int result = (int)our->resrec.rrclass - (int)m->rec.r.resrec.rrclass;
7363 if (!result) result = (int)our->resrec.rrtype - (int)m->rec.r.resrec.rrtype;
7364 if (!result) result = CompareRData(our, &m->rec.r);
7365 if (result)
7366 {
7367 const char *const msg = (result < 0) ? "lost:" : (result > 0) ? "won: " : "tie: ";
7368 LogMsg("ResolveSimultaneousProbe: %p Pkt Record: %08lX %s", q->InterfaceID, m->rec.r.resrec.rdatahash, CRDisplayString(m, &m->rec.r));
7369 LogMsg("ResolveSimultaneousProbe: %p Our Record %d %s %08lX %s", our->resrec.InterfaceID, our->ProbeCount, msg, our->resrec.rdatahash, ARDisplayString(m, our));
7370 }
7371 // If we lost the tie-break for simultaneous probes, we don't immediately give up, because we might be seeing stale packets on the network.
7372 // Instead we pause for one second, to give the other host (if real) a chance to establish its name, and then try probing again.
7373 // If there really is another live host out there with the same name, it will answer our probes and we'll then rename.
7374 if (result < 0)
7375 {
7376 m->SuppressProbes = NonZeroTime(m->timenow + mDNSPlatformOneSecond);
7377 our->ProbeCount = DefaultProbeCountForTypeUnique;
7378 our->AnnounceCount = InitialAnnounceCount;
7379 InitializeLastAPTime(m, our);
7380 goto exit;
7381 }
7382 }
7383 #if 0
7384 else
7385 {
7386 LogMsg("ResolveSimultaneousProbe: %p Pkt Record: %08lX %s", q->InterfaceID, m->rec.r.resrec.rdatahash, CRDisplayString(m, &m->rec.r));
7387 LogMsg("ResolveSimultaneousProbe: %p Our Record %d ign: %08lX %s", our->resrec.InterfaceID, our->ProbeCount, our->resrec.rdatahash, ARDisplayString(m, our));
7388 }
7389 #endif
7390 }
7391 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
7392 }
7393 if (!FoundUpdate)
7394 LogInfo("ResolveSimultaneousProbe: %##s (%s): No Update Record found", our->resrec.name->c, DNSTypeName(our->resrec.rrtype));
7395 exit:
7396 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
7397 }
7398
7399 mDNSlocal CacheRecord *FindIdenticalRecordInCache(const mDNS *const m, const ResourceRecord *const pktrr)
7400 {
7401 CacheGroup *cg = CacheGroupForRecord(m, pktrr);
7402 CacheRecord *rr;
7403 mDNSBool match;
7404 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
7405 {
7406 if (!pktrr->InterfaceID)
7407 {
7408 mDNSu16 id1 = (pktrr->rDNSServer ? pktrr->rDNSServer->resGroupID : 0);
7409 mDNSu16 id2 = (rr->resrec.rDNSServer ? rr->resrec.rDNSServer->resGroupID : 0);
7410 match = (id1 == id2);
7411 }
7412 else match = (pktrr->InterfaceID == rr->resrec.InterfaceID);
7413
7414 if (match && IdenticalSameNameRecord(pktrr, &rr->resrec)) break;
7415 }
7416 return(rr);
7417 }
7418 mDNSlocal void DeregisterProxyRecord(mDNS *const m, AuthRecord *const rr)
7419 {
7420 rr->WakeUp.HMAC = zeroEthAddr; // Clear HMAC so that mDNS_Deregister_internal doesn't waste packets trying to wake this host
7421 rr->RequireGoodbye = mDNSfalse; // and we don't want to send goodbye for it
7422 mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
7423 SetSPSProxyListChanged(m->rec.r.resrec.InterfaceID);
7424 }
7425
7426 mDNSlocal void ClearKeepaliveProxyRecords(mDNS *const m, const OwnerOptData *const owner, AuthRecord *const thelist, const mDNSInterfaceID InterfaceID)
7427 {
7428 if (m->CurrentRecord)
7429 LogMsg("ClearKeepaliveProxyRecords ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
7430 m->CurrentRecord = thelist;
7431
7432 // Normally, the RDATA of the keepalive record will be different each time and hence we always
7433 // clean up the keepalive record.
7434 while (m->CurrentRecord)
7435 {
7436 AuthRecord *const rr = m->CurrentRecord;
7437 if (InterfaceID == rr->resrec.InterfaceID && mDNSSameEthAddress(&owner->HMAC, &rr->WakeUp.HMAC))
7438 {
7439 if (mDNS_KeepaliveRecord(&m->rec.r.resrec))
7440 {
7441 LogSPS("ClearKeepaliveProxyRecords: Removing %3d H-MAC %.6a I-MAC %.6a %d %d %s",
7442 m->ProxyRecords, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, rr->WakeUp.seq, owner->seq, ARDisplayString(m, rr));
7443 DeregisterProxyRecord(m, rr);
7444 }
7445 }
7446 // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
7447 // new records could have been added to the end of the list as a result of that call.
7448 if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
7449 m->CurrentRecord = rr->next;
7450 }
7451 }
7452
7453 // Called from mDNSCoreReceiveUpdate when we get a sleep proxy registration request,
7454 // to check our lists and discard any stale duplicates of this record we already have
7455 mDNSlocal void ClearIdenticalProxyRecords(mDNS *const m, const OwnerOptData *const owner, AuthRecord *const thelist)
7456 {
7457 if (m->CurrentRecord)
7458 LogMsg("ClearIdenticalProxyRecords ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
7459 m->CurrentRecord = thelist;
7460 while (m->CurrentRecord)
7461 {
7462 AuthRecord *const rr = m->CurrentRecord;
7463 if (m->rec.r.resrec.InterfaceID == rr->resrec.InterfaceID && mDNSSameEthAddress(&owner->HMAC, &rr->WakeUp.HMAC))
7464 if (IdenticalResourceRecord(&rr->resrec, &m->rec.r.resrec))
7465 {
7466 LogSPS("ClearIdenticalProxyRecords: Removing %3d H-MAC %.6a I-MAC %.6a %d %d %s",
7467 m->ProxyRecords, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, rr->WakeUp.seq, owner->seq, ARDisplayString(m, rr));
7468 DeregisterProxyRecord(m, rr);
7469 }
7470 // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
7471 // new records could have been added to the end of the list as a result of that call.
7472 if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
7473 m->CurrentRecord = rr->next;
7474 }
7475 }
7476
7477 // Called from ProcessQuery when we get an mDNS packet with an owner record in it
7478 mDNSlocal void ClearProxyRecords(mDNS *const m, const OwnerOptData *const owner, AuthRecord *const thelist)
7479 {
7480 if (m->CurrentRecord)
7481 LogMsg("ClearProxyRecords ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
7482 m->CurrentRecord = thelist;
7483 while (m->CurrentRecord)
7484 {
7485 AuthRecord *const rr = m->CurrentRecord;
7486 if (m->rec.r.resrec.InterfaceID == rr->resrec.InterfaceID && mDNSSameEthAddress(&owner->HMAC, &rr->WakeUp.HMAC))
7487 if (owner->seq != rr->WakeUp.seq || m->timenow - rr->TimeRcvd > mDNSPlatformOneSecond * 60)
7488 {
7489 if (rr->AddressProxy.type == mDNSAddrType_IPv6)
7490 {
7491 // We don't do this here because we know that the host is waking up at this point, so we don't send
7492 // Unsolicited Neighbor Advertisements -- even Neighbor Advertisements agreeing with what the host should be
7493 // saying itself -- because it can cause some IPv6 stacks to falsely conclude that there's an address conflict.
7494 #if MDNS_USE_Unsolicited_Neighbor_Advertisements
7495 LogSPS("NDP Announcement -- Releasing traffic for H-MAC %.6a I-MAC %.6a %s",
7496 &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m,rr));
7497 SendNDP(m, NDP_Adv, NDP_Override, rr, &rr->AddressProxy.ip.v6, &rr->WakeUp.IMAC, &AllHosts_v6, &AllHosts_v6_Eth);
7498 #endif
7499 }
7500 LogSPS("ClearProxyRecords: Removing %3d AC %2d %02X H-MAC %.6a I-MAC %.6a %d %d %s",
7501 m->ProxyRecords, rr->AnnounceCount, rr->resrec.RecordType,
7502 &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, rr->WakeUp.seq, owner->seq, ARDisplayString(m, rr));
7503 if (rr->resrec.RecordType == kDNSRecordTypeDeregistering) rr->resrec.RecordType = kDNSRecordTypeShared;
7504 rr->WakeUp.HMAC = zeroEthAddr; // Clear HMAC so that mDNS_Deregister_internal doesn't waste packets trying to wake this host
7505 rr->RequireGoodbye = mDNSfalse; // and we don't want to send goodbye for it, since real host is now back and functional
7506 mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
7507 SetSPSProxyListChanged(m->rec.r.resrec.InterfaceID);
7508 }
7509 // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
7510 // new records could have been added to the end of the list as a result of that call.
7511 if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
7512 m->CurrentRecord = rr->next;
7513 }
7514 }
7515
7516 // ProcessQuery examines a received query to see if we have any answers to give
7517 mDNSlocal mDNSu8 *ProcessQuery(mDNS *const m, const DNSMessage *const query, const mDNSu8 *const end,
7518 const mDNSAddr *srcaddr, const mDNSInterfaceID InterfaceID, mDNSBool LegacyQuery, mDNSBool QueryWasMulticast,
7519 mDNSBool QueryWasLocalUnicast, DNSMessage *const response)
7520 {
7521 mDNSBool FromLocalSubnet = srcaddr && mDNS_AddressIsLocalSubnet(m, InterfaceID, srcaddr);
7522 AuthRecord *ResponseRecords = mDNSNULL;
7523 AuthRecord **nrp = &ResponseRecords;
7524
7525 #if POOF_ENABLED
7526 mDNSBool notD2D = !mDNSPlatformInterfaceIsD2D(InterfaceID); // We don't run the POOF algorithm on D2D interfaces.
7527 CacheRecord *ExpectedAnswers = mDNSNULL; // Records in our cache we expect to see updated
7528 CacheRecord **eap = &ExpectedAnswers;
7529 #endif // POOF_ENABLED
7530
7531 DNSQuestion *DupQuestions = mDNSNULL; // Our questions that are identical to questions in this packet
7532 DNSQuestion **dqp = &DupQuestions;
7533 mDNSs32 delayresponse = 0;
7534 mDNSBool SendLegacyResponse = mDNSfalse;
7535 const mDNSu8 *ptr;
7536 mDNSu8 *responseptr = mDNSNULL;
7537 AuthRecord *rr;
7538 int i;
7539 CacheRecord *McastNSEC3Records = mDNSNULL;
7540
7541 // ***
7542 // *** 1. Look in Additional Section for an OPT record
7543 // ***
7544 ptr = LocateOptRR(query, end, DNSOpt_OwnerData_ID_Space);
7545 if (ptr)
7546 {
7547 ptr = GetLargeResourceRecord(m, query, ptr, end, InterfaceID, kDNSRecordTypePacketAdd, &m->rec);
7548 if (ptr && m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && m->rec.r.resrec.rrtype == kDNSType_OPT)
7549 {
7550 const rdataOPT *opt;
7551 const rdataOPT *const e = (const rdataOPT *)&m->rec.r.resrec.rdata->u.data[m->rec.r.resrec.rdlength];
7552 // Find owner sub-option(s). We verify that the MAC is non-zero, otherwise we could inadvertently
7553 // delete all our own AuthRecords (which are identified by having zero MAC tags on them).
7554 for (opt = &m->rec.r.resrec.rdata->u.opt[0]; opt < e; opt++)
7555 if (opt->opt == kDNSOpt_Owner && opt->u.owner.vers == 0 && opt->u.owner.HMAC.l[0])
7556 {
7557 ClearProxyRecords(m, &opt->u.owner, m->DuplicateRecords);
7558 ClearProxyRecords(m, &opt->u.owner, m->ResourceRecords);
7559 }
7560 }
7561 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
7562 }
7563
7564 //
7565 // Look in Authority Section for NSEC3 record
7566 //
7567
7568 mDNSParseNSEC3Records(m, query, end, InterfaceID, &McastNSEC3Records);
7569
7570 // ***
7571 // *** 2. Parse Question Section and mark potential answers
7572 // ***
7573 ptr = query->data;
7574 for (i=0; i<query->h.numQuestions; i++) // For each question...
7575 {
7576 mDNSBool QuestionNeedsMulticastResponse;
7577 int NumAnswersForThisQuestion = 0;
7578 AuthRecord *NSECAnswer = mDNSNULL;
7579 DNSQuestion pktq, *q;
7580 ptr = getQuestion(query, ptr, end, InterfaceID, &pktq); // get the question...
7581 if (!ptr) goto exit;
7582
7583 pktq.AnonInfo = mDNSNULL;
7584 if (McastNSEC3Records)
7585 InitializeAnonInfoForQuestion(m, &McastNSEC3Records, &pktq);
7586 // The only queries that *need* a multicast response are:
7587 // * Queries sent via multicast
7588 // * from port 5353
7589 // * that don't have the kDNSQClass_UnicastResponse bit set
7590 // These queries need multicast responses because other clients will:
7591 // * suppress their own identical questions when they see these questions, and
7592 // * expire their cache records if they don't see the expected responses
7593 // For other queries, we may still choose to send the occasional multicast response anyway,
7594 // to keep our neighbours caches warm, and for ongoing conflict detection.
7595 QuestionNeedsMulticastResponse = QueryWasMulticast && !LegacyQuery && !(pktq.qclass & kDNSQClass_UnicastResponse);
7596
7597 if (pktq.qclass & kDNSQClass_UnicastResponse)
7598 m->mDNSStats.UnicastBitInQueries++;
7599 else
7600 m->mDNSStats.NormalQueries++;
7601
7602 // Clear the UnicastResponse flag -- don't want to confuse the rest of the code that follows later
7603 pktq.qclass &= ~kDNSQClass_UnicastResponse;
7604
7605 // Note: We use the m->CurrentRecord mechanism here because calling ResolveSimultaneousProbe
7606 // can result in user callbacks which may change the record list and/or question list.
7607 // Also note: we just mark potential answer records here, without trying to build the
7608 // "ResponseRecords" list, because we don't want to risk user callbacks deleting records
7609 // from that list while we're in the middle of trying to build it.
7610 if (m->CurrentRecord)
7611 LogMsg("ProcessQuery ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
7612 m->CurrentRecord = m->ResourceRecords;
7613 while (m->CurrentRecord)
7614 {
7615 rr = m->CurrentRecord;
7616 m->CurrentRecord = rr->next;
7617 if (AnyTypeRecordAnswersQuestion(&rr->resrec, &pktq) && (QueryWasMulticast || QueryWasLocalUnicast || rr->AllowRemoteQuery))
7618 {
7619 m->mDNSStats.MatchingAnswersForQueries++;
7620 if (RRTypeAnswersQuestionType(&rr->resrec, pktq.qtype))
7621 {
7622 if (rr->resrec.RecordType == kDNSRecordTypeUnique)
7623 ResolveSimultaneousProbe(m, query, end, &pktq, rr);
7624 else if (ResourceRecordIsValidAnswer(rr))
7625 {
7626 NumAnswersForThisQuestion++;
7627 // As we have verified this question to be part of the same subset,
7628 // set the anonymous data which is needed below when walk the cache
7629 // records to see what answers we should be expecting. The cache records
7630 // may cache only the nsec3RR and not the anonymous data itself.
7631 if (pktq.AnonInfo && rr->resrec.AnonInfo)
7632 SetAnonData(&pktq, &rr->resrec, mDNStrue);
7633
7634 // Note: We should check here if this is a probe-type query, and if so, generate an immediate
7635 // unicast answer back to the source, because timeliness in answering probes is important.
7636
7637 // Notes:
7638 // NR_AnswerTo pointing into query packet means "answer via immediate legacy unicast" (may *also* choose to multicast)
7639 // NR_AnswerTo == NR_AnswerUnicast means "answer via delayed unicast" (to modern querier; may promote to multicast instead)
7640 // NR_AnswerTo == NR_AnswerMulticast means "definitely answer via multicast" (can't downgrade to unicast later)
7641 // If we're not multicasting this record because the kDNSQClass_UnicastResponse bit was set,
7642 // but the multicast querier is not on a matching subnet (e.g. because of overlaid subnets on one link)
7643 // then we'll multicast it anyway (if we unicast, the receiver will ignore it because it has an apparently non-local source)
7644 if (QuestionNeedsMulticastResponse || (!FromLocalSubnet && QueryWasMulticast && !LegacyQuery))
7645 {
7646 // We only mark this question for sending if it is at least one second since the last time we multicast it
7647 // on this interface. If it is more than a second, or LastMCInterface is different, then we may multicast it.
7648 // This is to guard against the case where someone blasts us with queries as fast as they can.
7649 if ((mDNSu32)(m->timenow - rr->LastMCTime) >= (mDNSu32)mDNSPlatformOneSecond ||
7650 (rr->LastMCInterface != mDNSInterfaceMark && rr->LastMCInterface != InterfaceID))
7651 rr->NR_AnswerTo = NR_AnswerMulticast;
7652 }
7653 else if (!rr->NR_AnswerTo) rr->NR_AnswerTo = LegacyQuery ? ptr : NR_AnswerUnicast;
7654 }
7655 }
7656 else if ((rr->resrec.RecordType & kDNSRecordTypeActiveUniqueMask) && ResourceRecordIsValidAnswer(rr))
7657 {
7658 // If we don't have any answers for this question, but we do own another record with the same name,
7659 // then we'll want to mark it to generate an NSEC record on this interface
7660 if (!NSECAnswer) NSECAnswer = rr;
7661 }
7662 }
7663 }
7664
7665 if (NumAnswersForThisQuestion == 0 && NSECAnswer)
7666 {
7667 NumAnswersForThisQuestion++;
7668 NSECAnswer->SendNSECNow = InterfaceID;
7669 m->NextScheduledResponse = m->timenow;
7670 }
7671
7672 // If we couldn't answer this question, someone else might be able to,
7673 // so use random delay on response to reduce collisions
7674 if (NumAnswersForThisQuestion == 0) delayresponse = mDNSPlatformOneSecond; // Divided by 50 = 20ms
7675
7676 if (query->h.flags.b[0] & kDNSFlag0_TC)
7677 m->mDNSStats.KnownAnswerMultiplePkts++;
7678 // We only do the following accelerated cache expiration and duplicate question suppression processing
7679 // for non-truncated multicast queries with multicast responses.
7680 // For any query generating a unicast response we don't do this because we can't assume we will see the response.
7681 // For truncated queries we don't do this because a response we're expecting might be suppressed by a subsequent
7682 // known-answer packet, and when there's packet loss we can't safely assume we'll receive *all* known-answer packets.
7683 if (QuestionNeedsMulticastResponse && !(query->h.flags.b[0] & kDNSFlag0_TC))
7684 {
7685 #if POOF_ENABLED
7686 if (notD2D)
7687 {
7688 CacheGroup *cg = CacheGroupForName(m, pktq.qnamehash, &pktq.qname);
7689 CacheRecord *cr;
7690
7691 // Make a list indicating which of our own cache records we expect to see updated as a result of this query
7692 // Note: Records larger than 1K are not habitually multicast, so don't expect those to be updated
7693 for (cr = cg ? cg->members : mDNSNULL; cr; cr=cr->next)
7694 if (SameNameRecordAnswersQuestion(&cr->resrec, &pktq) && cr->resrec.rdlength <= SmallRecordLimit)
7695 if (!cr->NextInKAList && eap != &cr->NextInKAList)
7696 {
7697 *eap = cr;
7698 eap = &cr->NextInKAList;
7699 }
7700 }
7701 #endif // POOF_ENABLED
7702
7703 // Check if this question is the same as any of mine.
7704 // We only do this for non-truncated queries. Right now it would be too complicated to try
7705 // to keep track of duplicate suppression state between multiple packets, especially when we
7706 // can't guarantee to receive all of the Known Answer packets that go with a particular query.
7707 // For anonymous question, the duplicate suppressesion should happen if the
7708 // question belongs in the same group. As the group is expected to be
7709 // small, we don't do the optimization for now.
7710 if (!pktq.AnonInfo)
7711 {
7712 for (q = m->Questions; q; q=q->next)
7713 if (!q->Target.type && ActiveQuestion(q) && m->timenow - q->LastQTxTime > mDNSPlatformOneSecond / 4)
7714 if (!q->InterfaceID || q->InterfaceID == InterfaceID)
7715 if (q->NextInDQList == mDNSNULL && dqp != &q->NextInDQList)
7716 if (q->qtype == pktq.qtype &&
7717 q->qclass == pktq.qclass &&
7718 q->qnamehash == pktq.qnamehash && SameDomainName(&q->qname, &pktq.qname))
7719 { *dqp = q; dqp = &q->NextInDQList; }
7720 }
7721 }
7722 if (pktq.AnonInfo)
7723 {
7724 FreeAnonInfo(pktq.AnonInfo);
7725 }
7726 }
7727
7728 // ***
7729 // *** 3. Now we can safely build the list of marked answers
7730 // ***
7731 for (rr = m->ResourceRecords; rr; rr=rr->next) // Now build our list of potential answers
7732 if (rr->NR_AnswerTo) // If we marked the record...
7733 AddRecordToResponseList(&nrp, rr, mDNSNULL); // ... add it to the list
7734
7735 // ***
7736 // *** 4. Add additional records
7737 // ***
7738 AddAdditionalsToResponseList(m, ResponseRecords, &nrp, InterfaceID);
7739
7740 // ***
7741 // *** 5. Parse Answer Section and cancel any records disallowed by Known-Answer list
7742 // ***
7743 for (i=0; i<query->h.numAnswers; i++) // For each record in the query's answer section...
7744 {
7745 // Get the record...
7746 CacheRecord *ourcacherr;
7747 ptr = GetLargeResourceRecord(m, query, ptr, end, InterfaceID, kDNSRecordTypePacketAns, &m->rec);
7748 if (!ptr) goto exit;
7749 if (m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative)
7750 {
7751 // See if this Known-Answer suppresses any of our currently planned answers
7752 for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7753 {
7754 if (MustSendRecord(rr) && ShouldSuppressKnownAnswer(&m->rec.r, rr))
7755 {
7756 m->mDNSStats.KnownAnswerSuppressions++;
7757 rr->NR_AnswerTo = mDNSNULL;
7758 rr->NR_AdditionalTo = mDNSNULL;
7759 }
7760 }
7761
7762 // See if this Known-Answer suppresses any previously scheduled answers (for multi-packet KA suppression)
7763 for (rr=m->ResourceRecords; rr; rr=rr->next)
7764 {
7765 // If we're planning to send this answer on this interface, and only on this interface, then allow KA suppression
7766 if (rr->ImmedAnswer == InterfaceID && ShouldSuppressKnownAnswer(&m->rec.r, rr))
7767 {
7768 if (srcaddr->type == mDNSAddrType_IPv4)
7769 {
7770 if (mDNSSameIPv4Address(rr->v4Requester, srcaddr->ip.v4)) rr->v4Requester = zerov4Addr;
7771 }
7772 else if (srcaddr->type == mDNSAddrType_IPv6)
7773 {
7774 if (mDNSSameIPv6Address(rr->v6Requester, srcaddr->ip.v6)) rr->v6Requester = zerov6Addr;
7775 }
7776 if (mDNSIPv4AddressIsZero(rr->v4Requester) && mDNSIPv6AddressIsZero(rr->v6Requester))
7777 {
7778 m->mDNSStats.KnownAnswerSuppressions++;
7779 rr->ImmedAnswer = mDNSNULL;
7780 rr->ImmedUnicast = mDNSfalse;
7781 #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
7782 LogMsg("Suppressed after%4d: %s", m->timenow - rr->ImmedAnswerMarkTime, ARDisplayString(m, rr));
7783 #endif
7784 }
7785 }
7786 }
7787
7788 ourcacherr = FindIdenticalRecordInCache(m, &m->rec.r.resrec);
7789
7790 #if POOF_ENABLED
7791 if (notD2D)
7792 {
7793 // Having built our ExpectedAnswers list from the questions in this packet, we then remove
7794 // any records that are suppressed by the Known Answer list in this packet.
7795 eap = &ExpectedAnswers;
7796 while (*eap)
7797 {
7798 CacheRecord *cr = *eap;
7799 if (cr->resrec.InterfaceID == InterfaceID && IdenticalResourceRecord(&m->rec.r.resrec, &cr->resrec))
7800 { *eap = cr->NextInKAList; cr->NextInKAList = mDNSNULL; }
7801 else eap = &cr->NextInKAList;
7802 }
7803 }
7804 #endif // POOF_ENABLED
7805
7806 // See if this Known-Answer is a surprise to us. If so, we shouldn't suppress our own query.
7807 if (!ourcacherr)
7808 {
7809 dqp = &DupQuestions;
7810 while (*dqp)
7811 {
7812 DNSQuestion *q = *dqp;
7813 if (ResourceRecordAnswersQuestion(&m->rec.r.resrec, q))
7814 { *dqp = q->NextInDQList; q->NextInDQList = mDNSNULL; }
7815 else dqp = &q->NextInDQList;
7816 }
7817 }
7818 }
7819 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
7820 }
7821
7822 // ***
7823 // *** 6. Cancel any additionals that were added because of now-deleted records
7824 // ***
7825 for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7826 if (rr->NR_AdditionalTo && !MustSendRecord(rr->NR_AdditionalTo))
7827 { rr->NR_AnswerTo = mDNSNULL; rr->NR_AdditionalTo = mDNSNULL; }
7828
7829 // ***
7830 // *** 7. Mark the send flags on the records we plan to send
7831 // ***
7832 for (rr=ResponseRecords; rr; rr=rr->NextResponse)
7833 {
7834 if (rr->NR_AnswerTo)
7835 {
7836 mDNSBool SendMulticastResponse = mDNSfalse; // Send modern multicast response
7837 mDNSBool SendUnicastResponse = mDNSfalse; // Send modern unicast response (not legacy unicast response)
7838
7839 // If it's been one TTL/4 since we multicast this, then send a multicast response
7840 // for conflict detection, etc.
7841 if ((mDNSu32)(m->timenow - rr->LastMCTime) >= (mDNSu32)TicksTTL(rr)/4)
7842 {
7843 SendMulticastResponse = mDNStrue;
7844 // If this record was marked for modern (delayed) unicast response, then mark it as promoted to
7845 // multicast response instead (don't want to end up ALSO setting SendUnicastResponse in the check below).
7846 // If this record was marked for legacy unicast response, then we mustn't change the NR_AnswerTo value.
7847 if (rr->NR_AnswerTo == NR_AnswerUnicast)
7848 {
7849 m->mDNSStats.UnicastDemotedToMulticast++;
7850 rr->NR_AnswerTo = NR_AnswerMulticast;
7851 }
7852 }
7853
7854 // If the client insists on a multicast response, then we'd better send one
7855 if (rr->NR_AnswerTo == NR_AnswerMulticast)
7856 {
7857 m->mDNSStats.MulticastResponses++;
7858 SendMulticastResponse = mDNStrue;
7859 }
7860 else if (rr->NR_AnswerTo == NR_AnswerUnicast)
7861 {
7862 m->mDNSStats.UnicastResponses++;
7863 SendUnicastResponse = mDNStrue;
7864 }
7865 else if (rr->NR_AnswerTo)
7866 {
7867 SendLegacyResponse = mDNStrue;
7868 }
7869
7870 if (SendMulticastResponse || SendUnicastResponse)
7871 {
7872 #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
7873 rr->ImmedAnswerMarkTime = m->timenow;
7874 #endif
7875 m->NextScheduledResponse = m->timenow;
7876 // If we're already planning to send this on another interface, just send it on all interfaces
7877 if (rr->ImmedAnswer && rr->ImmedAnswer != InterfaceID)
7878 rr->ImmedAnswer = mDNSInterfaceMark;
7879 else
7880 {
7881 rr->ImmedAnswer = InterfaceID; // Record interface to send it on
7882 if (SendUnicastResponse) rr->ImmedUnicast = mDNStrue;
7883 if (srcaddr->type == mDNSAddrType_IPv4)
7884 {
7885 if (mDNSIPv4AddressIsZero(rr->v4Requester)) rr->v4Requester = srcaddr->ip.v4;
7886 else if (!mDNSSameIPv4Address(rr->v4Requester, srcaddr->ip.v4)) rr->v4Requester = onesIPv4Addr;
7887 }
7888 else if (srcaddr->type == mDNSAddrType_IPv6)
7889 {
7890 if (mDNSIPv6AddressIsZero(rr->v6Requester)) rr->v6Requester = srcaddr->ip.v6;
7891 else if (!mDNSSameIPv6Address(rr->v6Requester, srcaddr->ip.v6)) rr->v6Requester = onesIPv6Addr;
7892 }
7893 }
7894 }
7895 // If TC flag is set, it means we should expect that additional known answers may be coming in another packet,
7896 // so we allow roughly half a second before deciding to reply (we've observed inter-packet delays of 100-200ms on 802.11)
7897 // else, if record is a shared one, spread responses over 100ms to avoid implosion of simultaneous responses
7898 // else, for a simple unique record reply, we can reply immediately; no need for delay
7899 if (query->h.flags.b[0] & kDNSFlag0_TC) delayresponse = mDNSPlatformOneSecond * 20; // Divided by 50 = 400ms
7900 else if (rr->resrec.RecordType == kDNSRecordTypeShared) delayresponse = mDNSPlatformOneSecond; // Divided by 50 = 20ms
7901 }
7902 else if (rr->NR_AdditionalTo && rr->NR_AdditionalTo->NR_AnswerTo == NR_AnswerMulticast)
7903 {
7904 // Since additional records are an optimization anyway, we only ever send them on one interface at a time
7905 // If two clients on different interfaces do queries that invoke the same optional additional answer,
7906 // then the earlier client is out of luck
7907 rr->ImmedAdditional = InterfaceID;
7908 // No need to set m->NextScheduledResponse here
7909 // We'll send these additional records when we send them, or not, as the case may be
7910 }
7911 }
7912
7913 // ***
7914 // *** 8. If we think other machines are likely to answer these questions, set our packet suppression timer
7915 // ***
7916 if (delayresponse && (!m->SuppressSending || (m->SuppressSending - m->timenow) < (delayresponse + 49) / 50))
7917 {
7918 #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
7919 mDNSs32 oldss = m->SuppressSending;
7920 if (oldss && delayresponse)
7921 LogMsg("Current SuppressSending delay%5ld; require%5ld", m->SuppressSending - m->timenow, (delayresponse + 49) / 50);
7922 #endif
7923 // Pick a random delay:
7924 // We start with the base delay chosen above (typically either 1 second or 20 seconds),
7925 // and add a random value in the range 0-5 seconds (making 1-6 seconds or 20-25 seconds).
7926 // This is an integer value, with resolution determined by the platform clock rate.
7927 // We then divide that by 50 to get the delay value in ticks. We defer the division until last
7928 // to get better results on platforms with coarse clock granularity (e.g. ten ticks per second).
7929 // The +49 before dividing is to ensure we round up, not down, to ensure that even
7930 // on platforms where the native clock rate is less than fifty ticks per second,
7931 // we still guarantee that the final calculated delay is at least one platform tick.
7932 // We want to make sure we don't ever allow the delay to be zero ticks,
7933 // because if that happens we'll fail the Bonjour Conformance Test.
7934 // Our final computed delay is 20-120ms for normal delayed replies,
7935 // or 400-500ms in the case of multi-packet known-answer lists.
7936 m->SuppressSending = m->timenow + (delayresponse + (mDNSs32)mDNSRandom((mDNSu32)mDNSPlatformOneSecond*5) + 49) / 50;
7937 if (m->SuppressSending == 0) m->SuppressSending = 1;
7938 #if MDNS_LOG_ANSWER_SUPPRESSION_TIMES
7939 if (oldss && delayresponse)
7940 LogMsg("Set SuppressSending to %5ld", m->SuppressSending - m->timenow);
7941 #endif
7942 }
7943
7944 // ***
7945 // *** 9. If query is from a legacy client, or from a new client requesting a unicast reply, then generate a unicast response too
7946 // ***
7947 if (SendLegacyResponse)
7948 responseptr = GenerateUnicastResponse(query, end, InterfaceID, LegacyQuery, response, ResponseRecords);
7949
7950 exit:
7951 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
7952
7953 // ***
7954 // *** 10. Finally, clear our link chains ready for use next time
7955 // ***
7956 while (ResponseRecords)
7957 {
7958 rr = ResponseRecords;
7959 ResponseRecords = rr->NextResponse;
7960 rr->NextResponse = mDNSNULL;
7961 rr->NR_AnswerTo = mDNSNULL;
7962 rr->NR_AdditionalTo = mDNSNULL;
7963 }
7964
7965 #if POOF_ENABLED
7966 while (ExpectedAnswers && notD2D)
7967 {
7968 CacheRecord *cr = ExpectedAnswers;
7969 ExpectedAnswers = cr->NextInKAList;
7970 cr->NextInKAList = mDNSNULL;
7971
7972 // For non-truncated queries, we can definitively say that we should expect
7973 // to be seeing a response for any records still left in the ExpectedAnswers list
7974 if (!(query->h.flags.b[0] & kDNSFlag0_TC))
7975 if (cr->UnansweredQueries == 0 || m->timenow - cr->LastUnansweredTime >= mDNSPlatformOneSecond * 3/4)
7976 {
7977 cr->UnansweredQueries++;
7978 cr->LastUnansweredTime = m->timenow;
7979 if (cr->UnansweredQueries > 1)
7980 debugf("ProcessQuery: UnansweredQueries %lu %s", cr->UnansweredQueries, CRDisplayString(m, cr));
7981 SetNextCacheCheckTimeForRecord(m, cr);
7982 }
7983
7984 // If we've seen multiple unanswered queries for this record,
7985 // then mark it to expire in five seconds if we don't get a response by then.
7986 if (cr->UnansweredQueries >= MaxUnansweredQueries)
7987 {
7988 // Only show debugging message if this record was not about to expire anyway
7989 if (RRExpireTime(cr) - m->timenow > (mDNSs32) kDefaultReconfirmTimeForNoAnswer * 4 / 3 + mDNSPlatformOneSecond)
7990 LogInfo("ProcessQuery: UnansweredQueries %lu interface %lu TTL %lu mDNS_Reconfirm() for %s",
7991 cr->UnansweredQueries, InterfaceID, (RRExpireTime(cr) - m->timenow + mDNSPlatformOneSecond-1) / mDNSPlatformOneSecond, CRDisplayString(m, cr));
7992
7993 m->mDNSStats.PoofCacheDeletions++;
7994 mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
7995 }
7996 }
7997 #endif // POOF_ENABLED
7998
7999 while (DupQuestions)
8000 {
8001 DNSQuestion *q = DupQuestions;
8002 DupQuestions = q->NextInDQList;
8003 q->NextInDQList = mDNSNULL;
8004 RecordDupSuppressInfo(q->DupSuppress, m->timenow, InterfaceID, srcaddr->type);
8005 debugf("ProcessQuery: Recorded DSI for %##s (%s) on %p/%s", q->qname.c, DNSTypeName(q->qtype), InterfaceID,
8006 srcaddr->type == mDNSAddrType_IPv4 ? "v4" : "v6");
8007 }
8008
8009 if (McastNSEC3Records)
8010 {
8011 debugf("ProcessQuery: McastNSEC3Records not used");
8012 FreeNSECRecords(m, McastNSEC3Records);
8013 }
8014
8015 return(responseptr);
8016 }
8017
8018 mDNSlocal void mDNSCoreReceiveQuery(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *const end,
8019 const mDNSAddr *srcaddr, const mDNSIPPort srcport, const mDNSAddr *dstaddr, mDNSIPPort dstport,
8020 const mDNSInterfaceID InterfaceID)
8021 {
8022 mDNSu8 *responseend = mDNSNULL;
8023 mDNSBool QueryWasLocalUnicast = srcaddr && dstaddr &&
8024 !mDNSAddrIsDNSMulticast(dstaddr) && mDNS_AddressIsLocalSubnet(m, InterfaceID, srcaddr);
8025
8026 if (!dstaddr || (!InterfaceID && mDNSAddrIsDNSMulticast(dstaddr)))
8027 {
8028 const char *const reason = !dstaddr ? "Received over TCP connection" : "Multicast, but no InterfaceID";
8029 LogMsg("Ignoring Query from %#-15a:%-5d to %#-15a:%-5d on 0x%p with "
8030 "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes (%s)",
8031 srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), InterfaceID,
8032 msg->h.numQuestions, msg->h.numQuestions == 1 ? ", " : "s,",
8033 msg->h.numAnswers, msg->h.numAnswers == 1 ? ", " : "s,",
8034 msg->h.numAuthorities, msg->h.numAuthorities == 1 ? "y, " : "ies,",
8035 msg->h.numAdditionals, msg->h.numAdditionals == 1 ? " " : "s", end - msg->data, reason);
8036 return;
8037 }
8038
8039 verbosedebugf("Received Query from %#-15a:%-5d to %#-15a:%-5d on 0x%p with "
8040 "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes",
8041 srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), InterfaceID,
8042 msg->h.numQuestions, msg->h.numQuestions == 1 ? ", " : "s,",
8043 msg->h.numAnswers, msg->h.numAnswers == 1 ? ", " : "s,",
8044 msg->h.numAuthorities, msg->h.numAuthorities == 1 ? "y, " : "ies,",
8045 msg->h.numAdditionals, msg->h.numAdditionals == 1 ? " " : "s", end - msg->data);
8046
8047 responseend = ProcessQuery(m, msg, end, srcaddr, InterfaceID,
8048 !mDNSSameIPPort(srcport, MulticastDNSPort), mDNSAddrIsDNSMulticast(dstaddr), QueryWasLocalUnicast, &m->omsg);
8049
8050 if (responseend) // If responseend is non-null, that means we built a unicast response packet
8051 {
8052 debugf("Unicast Response: %d Question%s, %d Answer%s, %d Additional%s to %#-15a:%d on %p/%ld",
8053 m->omsg.h.numQuestions, m->omsg.h.numQuestions == 1 ? "" : "s",
8054 m->omsg.h.numAnswers, m->omsg.h.numAnswers == 1 ? "" : "s",
8055 m->omsg.h.numAdditionals, m->omsg.h.numAdditionals == 1 ? "" : "s",
8056 srcaddr, mDNSVal16(srcport), InterfaceID, srcaddr->type);
8057 mDNSSendDNSMessage(m, &m->omsg, responseend, InterfaceID, mDNSNULL, srcaddr, srcport, mDNSNULL, mDNSNULL, mDNSfalse);
8058 }
8059 }
8060
8061 #if 0
8062 mDNSlocal mDNSBool TrustedSource(const mDNS *const m, const mDNSAddr *const srcaddr)
8063 {
8064 DNSServer *s;
8065 (void)m; // Unused
8066 (void)srcaddr; // Unused
8067 for (s = m->DNSServers; s; s = s->next)
8068 if (mDNSSameAddress(srcaddr, &s->addr)) return(mDNStrue);
8069 return(mDNSfalse);
8070 }
8071 #endif
8072
8073 struct UDPSocket_struct
8074 {
8075 mDNSIPPort port; // MUST BE FIRST FIELD -- mDNSCoreReceive expects every UDPSocket_struct to begin with mDNSIPPort port
8076 };
8077
8078 mDNSlocal DNSQuestion *ExpectingUnicastResponseForQuestion(const mDNS *const m, const mDNSIPPort port, const mDNSOpaque16 id, const DNSQuestion *const question, mDNSBool tcp)
8079 {
8080 DNSQuestion *q;
8081 for (q = m->Questions; q; q=q->next)
8082 {
8083 if (!tcp && !q->LocalSocket) continue;
8084 if (mDNSSameIPPort(tcp ? q->tcpSrcPort : q->LocalSocket->port, port) &&
8085 mDNSSameOpaque16(q->TargetQID, id) &&
8086 q->qtype == question->qtype &&
8087 q->qclass == question->qclass &&
8088 q->qnamehash == question->qnamehash &&
8089 SameDomainName(&q->qname, &question->qname))
8090 return(q);
8091 }
8092 return(mDNSNULL);
8093 }
8094
8095 // This function is called when we receive a unicast response. This could be the case of a unicast response from the
8096 // DNS server or a response to the QU query. Hence, the cache record's InterfaceId can be both NULL or non-NULL (QU case)
8097 mDNSlocal DNSQuestion *ExpectingUnicastResponseForRecord(mDNS *const m,
8098 const mDNSAddr *const srcaddr, const mDNSBool SrcLocal, const mDNSIPPort port, const mDNSOpaque16 id, const CacheRecord *const rr, mDNSBool tcp)
8099 {
8100 DNSQuestion *q;
8101 (void)id;
8102 (void)srcaddr;
8103
8104 for (q = m->Questions; q; q=q->next)
8105 {
8106 if (!q->DuplicateOf && ResourceRecordAnswersUnicastResponse(&rr->resrec, q))
8107 {
8108 if (!mDNSOpaque16IsZero(q->TargetQID))
8109 {
8110 debugf("ExpectingUnicastResponseForRecord msg->h.id %d q->TargetQID %d for %s", mDNSVal16(id), mDNSVal16(q->TargetQID), CRDisplayString(m, rr));
8111
8112 if (mDNSSameOpaque16(q->TargetQID, id))
8113 {
8114 mDNSIPPort srcp;
8115 if (!tcp)
8116 {
8117 srcp = q->LocalSocket ? q->LocalSocket->port : zeroIPPort;
8118 }
8119 else
8120 {
8121 srcp = q->tcpSrcPort;
8122 }
8123 if (mDNSSameIPPort(srcp, port)) return(q);
8124
8125 // if (mDNSSameAddress(srcaddr, &q->Target)) return(mDNStrue);
8126 // if (q->LongLived && mDNSSameAddress(srcaddr, &q->servAddr)) return(mDNStrue); Shouldn't need this now that we have LLQType checking
8127 // if (TrustedSource(m, srcaddr)) return(mDNStrue);
8128 LogInfo("WARNING: Ignoring suspect uDNS response for %##s (%s) [q->Target %#a:%d] from %#a:%d %s",
8129 q->qname.c, DNSTypeName(q->qtype), &q->Target, mDNSVal16(srcp), srcaddr, mDNSVal16(port), CRDisplayString(m, rr));
8130 return(mDNSNULL);
8131 }
8132 }
8133 else
8134 {
8135 if (SrcLocal && q->ExpectUnicastResp && (mDNSu32)(m->timenow - q->ExpectUnicastResp) < (mDNSu32)(mDNSPlatformOneSecond*2))
8136 return(q);
8137 }
8138 }
8139 }
8140 return(mDNSNULL);
8141 }
8142
8143 // Certain data types need more space for in-memory storage than their in-packet rdlength would imply
8144 // Currently this applies only to rdata types containing more than one domainname,
8145 // or types where the domainname is not the last item in the structure.
8146 mDNSlocal mDNSu16 GetRDLengthMem(const ResourceRecord *const rr)
8147 {
8148 switch (rr->rrtype)
8149 {
8150 case kDNSType_SOA: return sizeof(rdataSOA);
8151 case kDNSType_RP: return sizeof(rdataRP);
8152 case kDNSType_PX: return sizeof(rdataPX);
8153 default: return rr->rdlength;
8154 }
8155 }
8156
8157 mDNSexport CacheRecord *CreateNewCacheEntry(mDNS *const m, const mDNSu32 slot, CacheGroup *cg, mDNSs32 delay, mDNSBool Add, const mDNSAddr *sourceAddress)
8158 {
8159 CacheRecord *rr = mDNSNULL;
8160 mDNSu16 RDLength = GetRDLengthMem(&m->rec.r.resrec);
8161
8162 if (!m->rec.r.resrec.InterfaceID) debugf("CreateNewCacheEntry %s", CRDisplayString(m, &m->rec.r));
8163
8164 //if (RDLength > InlineCacheRDSize)
8165 // LogInfo("Rdata len %4d > InlineCacheRDSize %d %s", RDLength, InlineCacheRDSize, CRDisplayString(m, &m->rec.r));
8166
8167 if (!cg) cg = GetCacheGroup(m, slot, &m->rec.r.resrec); // If we don't have a CacheGroup for this name, make one now
8168 if (cg) rr = GetCacheRecord(m, cg, RDLength); // Make a cache record, being careful not to recycle cg
8169 if (!rr) NoCacheAnswer(m, &m->rec.r);
8170 else
8171 {
8172 RData *saveptr = rr->resrec.rdata; // Save the rr->resrec.rdata pointer
8173 *rr = m->rec.r; // Block copy the CacheRecord object
8174 rr->resrec.rdata = saveptr; // Restore rr->resrec.rdata after the structure assignment
8175 rr->resrec.name = cg->name; // And set rr->resrec.name to point into our CacheGroup header
8176 rr->resrec.mortality = Mortality_Mortal;
8177
8178 // We need to add the anonymous info before we call CacheRecordAdd so that
8179 // if it finds a matching question with this record, it bumps up the counters like
8180 // CurrentAnswers etc. Otherwise, when a cache entry gets removed, CacheRecordRmv
8181 // will complain.
8182 if (m->rec.r.resrec.AnonInfo)
8183 {
8184 rr->resrec.AnonInfo = m->rec.r.resrec.AnonInfo;
8185 m->rec.r.resrec.AnonInfo = mDNSNULL;
8186 }
8187 rr->DelayDelivery = delay;
8188
8189 // If this is an oversized record with external storage allocated, copy rdata to external storage
8190 if (rr->resrec.rdata == (RData*)&rr->smallrdatastorage && RDLength > InlineCacheRDSize)
8191 LogMsg("rr->resrec.rdata == &rr->rdatastorage but length > InlineCacheRDSize %##s", m->rec.r.resrec.name->c);
8192 else if (rr->resrec.rdata != (RData*)&rr->smallrdatastorage && RDLength <= InlineCacheRDSize)
8193 LogMsg("rr->resrec.rdata != &rr->rdatastorage but length <= InlineCacheRDSize %##s", m->rec.r.resrec.name->c);
8194 if (RDLength > InlineCacheRDSize)
8195 mDNSPlatformMemCopy(rr->resrec.rdata, m->rec.r.resrec.rdata, sizeofRDataHeader + RDLength);
8196
8197 rr->next = mDNSNULL; // Clear 'next' pointer
8198 rr->nsec = mDNSNULL;
8199 rr->soa = mDNSNULL;
8200
8201 if (sourceAddress)
8202 rr->sourceAddress = *sourceAddress;
8203
8204 if (!rr->resrec.InterfaceID)
8205 {
8206 m->rrcache_totalused_unicast += rr->resrec.rdlength;
8207 if (DNSSECRecordType(rr->resrec.rrtype))
8208 BumpDNSSECStats(m, kStatsActionIncrement, kStatsTypeMemoryUsage, rr->resrec.rdlength);
8209 }
8210
8211 if (Add)
8212 {
8213 *(cg->rrcache_tail) = rr; // Append this record to tail of cache slot list
8214 cg->rrcache_tail = &(rr->next); // Advance tail pointer
8215 CacheRecordAdd(m, rr); // CacheRecordAdd calls SetNextCacheCheckTimeForRecord(m, rr); for us
8216 }
8217 else
8218 {
8219 // Can't use the "cg->name" if we are not adding to the cache as the
8220 // CacheGroup may be released anytime if it is empty
8221 domainname *name = mDNSPlatformMemAllocate(DomainNameLength(cg->name));
8222 if (name)
8223 {
8224 AssignDomainName(name, cg->name);
8225 rr->resrec.name = name;
8226 }
8227 else
8228 {
8229 ReleaseCacheRecord(m, rr);
8230 NoCacheAnswer(m, &m->rec.r);
8231 rr = mDNSNULL;
8232 }
8233 }
8234 }
8235 return(rr);
8236 }
8237
8238 mDNSlocal void RefreshCacheRecord(mDNS *const m, CacheRecord *rr, mDNSu32 ttl)
8239 {
8240 rr->TimeRcvd = m->timenow;
8241 rr->resrec.rroriginalttl = ttl;
8242 rr->UnansweredQueries = 0;
8243 if (rr->resrec.mortality != Mortality_Mortal) rr->resrec.mortality = Mortality_Immortal;
8244 SetNextCacheCheckTimeForRecord(m, rr);
8245 }
8246
8247 mDNSexport void GrantCacheExtensions(mDNS *const m, DNSQuestion *q, mDNSu32 lease)
8248 {
8249 CacheRecord *rr;
8250 CacheGroup *cg = CacheGroupForName(m, q->qnamehash, &q->qname);
8251 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
8252 if (rr->CRActiveQuestion == q)
8253 {
8254 //LogInfo("GrantCacheExtensions: new lease %d / %s", lease, CRDisplayString(m, rr));
8255 RefreshCacheRecord(m, rr, lease);
8256 }
8257 }
8258
8259 mDNSlocal mDNSu32 GetEffectiveTTL(const uDNS_LLQType LLQType, mDNSu32 ttl) // TTL in seconds
8260 {
8261 if (LLQType == uDNS_LLQ_Entire) ttl = kLLQ_DefLease;
8262 else if (LLQType == uDNS_LLQ_Events)
8263 {
8264 // If the TTL is -1 for uDNS LLQ event packet, that means "remove"
8265 if (ttl == 0xFFFFFFFF) ttl = 0;
8266 else ttl = kLLQ_DefLease;
8267 }
8268 else // else not LLQ (standard uDNS response)
8269 {
8270 // The TTL is already capped to a maximum value in GetLargeResourceRecord, but just to be extra safe we
8271 // also do this check here to make sure we can't get overflow below when we add a quarter to the TTL
8272 if (ttl > 0x60000000UL / mDNSPlatformOneSecond) ttl = 0x60000000UL / mDNSPlatformOneSecond;
8273
8274 ttl = RRAdjustTTL(ttl);
8275
8276 // For mDNS, TTL zero means "delete this record"
8277 // For uDNS, TTL zero means: this data is true at this moment, but don't cache it.
8278 // For the sake of network efficiency, we impose a minimum effective TTL of 15 seconds.
8279 // This means that we'll do our 80, 85, 90, 95% queries at 12.00, 12.75, 13.50, 14.25 seconds
8280 // respectively, and then if we get no response, delete the record from the cache at 15 seconds.
8281 // This gives the server up to three seconds to respond between when we send our 80% query at 12 seconds
8282 // and when we delete the record at 15 seconds. Allowing cache lifetimes less than 15 seconds would
8283 // (with the current code) result in the server having even less than three seconds to respond
8284 // before we deleted the record and reported a "remove" event to any active questions.
8285 // Furthermore, with the current code, if we were to allow a TTL of less than 2 seconds
8286 // then things really break (e.g. we end up making a negative cache entry).
8287 // In the future we may want to revisit this and consider properly supporting non-cached (TTL=0) uDNS answers.
8288 if (ttl < 15) ttl = 15;
8289 }
8290
8291 return ttl;
8292 }
8293
8294 // When the response does not match the question directly, we still want to cache them sometimes. The current response is
8295 // in m->rec.
8296 mDNSlocal mDNSBool IsResponseAcceptable(mDNS *const m, const CacheRecord *crlist, DNSQuestion *q, mDNSBool *nseclist)
8297 {
8298 CacheRecord *const newcr = &m->rec.r;
8299 ResourceRecord *rr = &newcr->resrec;
8300 const CacheRecord *cr;
8301
8302 *nseclist = mDNSfalse;
8303 for (cr = crlist; cr != (CacheRecord*)1; cr = cr->NextInCFList)
8304 {
8305 domainname *target = GetRRDomainNameTarget(&cr->resrec);
8306 // When we issue a query for A record, the response might contain both a CNAME and A records. Only the CNAME would
8307 // match the question and we already created a cache entry in the previous pass of this loop. Now when we process
8308 // the A record, it does not match the question because the record name here is the CNAME. Hence we try to
8309 // match with the previous records to make it an AcceptableResponse. We have to be careful about setting the
8310 // DNSServer value that we got in the previous pass. This can happen for other record types like SRV also.
8311
8312 if (target && cr->resrec.rdatahash == rr->namehash && SameDomainName(target, rr->name))
8313 {
8314 LogDebug("IsResponseAcceptable: Found a matching entry for %##s in the CacheFlushRecords %s", rr->name->c, CRDisplayString(m, cr));
8315 return (mDNStrue);
8316 }
8317 }
8318
8319 // Either the question requires validation or we are validating a response with DNSSEC in which case
8320 // we need to accept the RRSIGs also so that we can validate the response. It is also possible that
8321 // we receive NSECs for our query which does not match the qname and we need to cache in that case
8322 // too. nseclist is set if they have to be cached as part of the negative cache record.
8323 if (q && DNSSECQuestion(q))
8324 {
8325 mDNSBool same = SameDomainName(&q->qname, rr->name);
8326 if (same && (q->qtype == rr->rrtype || rr->rrtype == kDNSType_CNAME))
8327 {
8328 LogInfo("IsResponseAcceptable: Accepting, same name and qtype %s, CR %s", DNSTypeName(q->qtype),
8329 CRDisplayString(m, newcr));
8330 return mDNStrue;
8331 }
8332 // We cache RRSIGS if it covers the question type or NSEC. If it covers a NSEC,
8333 // "nseclist" is set
8334 if (rr->rrtype == kDNSType_RRSIG)
8335 {
8336 RDataBody2 *const rdb = (RDataBody2 *)newcr->smallrdatastorage.data;
8337 rdataRRSig *rrsig = &rdb->rrsig;
8338 mDNSu16 typeCovered = swap16(rrsig->typeCovered);
8339
8340 // Note the ordering. If we are looking up the NSEC record, then the RRSIG's typeCovered
8341 // would match the qtype and they are cached normally as they are not used to prove the
8342 // non-existence of any name. In that case, it is like any other normal dnssec validation
8343 // and hence nseclist should not be set.
8344
8345 if (same && ((typeCovered == q->qtype) || (typeCovered == kDNSType_CNAME)))
8346 {
8347 LogInfo("IsResponseAcceptable: Accepting RRSIG %s matches question type %s", CRDisplayString(m, newcr),
8348 DNSTypeName(q->qtype));
8349 return mDNStrue;
8350 }
8351 else if (typeCovered == kDNSType_NSEC || typeCovered == kDNSType_NSEC3)
8352 {
8353 LogInfo("IsResponseAcceptable: Accepting RRSIG %s matches %s type (nseclist = 1)", CRDisplayString(m, newcr), DNSTypeName(typeCovered));
8354 *nseclist = mDNStrue;
8355 return mDNStrue;
8356 }
8357 else if (typeCovered == kDNSType_SOA)
8358 {
8359 LogInfo("IsResponseAcceptable: Accepting RRSIG %s matches SOA type (nseclist = 1)", CRDisplayString(m, newcr));
8360 *nseclist = mDNStrue;
8361 return mDNStrue;
8362 }
8363 else return mDNSfalse;
8364 }
8365 if (rr->rrtype == kDNSType_NSEC)
8366 {
8367 if (!UNICAST_NSEC(rr))
8368 {
8369 LogMsg("IsResponseAcceptable: ERROR!! Not a unicast NSEC %s", CRDisplayString(m, newcr));
8370 return mDNSfalse;
8371 }
8372 LogInfo("IsResponseAcceptable: Accepting NSEC %s (nseclist = 1)", CRDisplayString(m, newcr));
8373 *nseclist = mDNStrue;
8374 return mDNStrue;
8375 }
8376 if (rr->rrtype == kDNSType_SOA)
8377 {
8378 LogInfo("IsResponseAcceptable: Accepting SOA %s (nseclist = 1)", CRDisplayString(m, newcr));
8379 *nseclist = mDNStrue;
8380 return mDNStrue;
8381 }
8382 else if (rr->rrtype == kDNSType_NSEC3)
8383 {
8384 LogInfo("IsResponseAcceptable: Accepting NSEC3 %s (nseclist = 1)", CRDisplayString(m, newcr));
8385 *nseclist = mDNStrue;
8386 return mDNStrue;
8387 }
8388 }
8389 return mDNSfalse;
8390 }
8391
8392 mDNSlocal void FreeNSECRecords(mDNS *const m, CacheRecord *NSECRecords)
8393 {
8394 CacheRecord *rp, *next;
8395
8396 for (rp = NSECRecords; rp; rp = next)
8397 {
8398 next = rp->next;
8399 ReleaseCacheRecord(m, rp);
8400 }
8401 }
8402
8403 // If we received zero DNSSEC records even when the DO/EDNS0 bit was set, we need to provide this
8404 // information to ValidatingResponse question to indicate the DNSSEC status to the application
8405 mDNSlocal void mDNSCoreReceiveNoDNSSECAnswers(mDNS *const m, const DNSMessage *const response, const mDNSu8 *end, const mDNSAddr *dstaddr,
8406 mDNSIPPort dstport, const mDNSInterfaceID InterfaceID)
8407 {
8408 int i;
8409 const mDNSu8 *ptr = response->data;
8410
8411 for (i = 0; i < response->h.numQuestions && ptr && ptr < end; i++)
8412 {
8413 DNSQuestion pktq;
8414 DNSQuestion *qptr = mDNSNULL;
8415 ptr = getQuestion(response, ptr, end, InterfaceID, &pktq);
8416 if (ptr && (qptr = ExpectingUnicastResponseForQuestion(m, dstport, response->h.id, &pktq, !dstaddr)) &&
8417 qptr->ValidatingResponse)
8418 {
8419 DNSQuestion *next, *q;
8420
8421 if (qptr->DuplicateOf)
8422 LogMsg("mDNSCoreReceiveNoDNSSECAnswers: ERROR!! qptr %##s (%s) Duplicate question matching response", qptr->qname.c, DNSTypeName(qptr->qtype));
8423
8424 // Be careful to call the callback for duplicate questions first and then the original
8425 // question. If we called the callback on the original question, it could stop and
8426 // a duplicate question would become the original question.
8427 mDNS_DropLockBeforeCallback(); // Allow client (and us) to legally make mDNS API calls
8428 for (q = qptr->next ; q && q != m->NewQuestions; q = next)
8429 {
8430 next = q->next;
8431 if (q->DuplicateOf == qptr)
8432 {
8433 if (q->ValidatingResponse)
8434 LogInfo("mDNSCoreReceiveNoDNSSECAnswers: qptr %##s (%s) Duplicate question found", q->qname.c, DNSTypeName(q->qtype));
8435 else
8436 LogMsg("mDNSCoreReceiveNoDNSSECAnswers: ERROR!! qptr %##s (%s) Duplicate question not ValidatingResponse", q->qname.c, DNSTypeName(q->qtype));
8437 if (q->QuestionCallback)
8438 q->QuestionCallback(m, q, mDNSNULL, QC_nodnssec);
8439 }
8440 }
8441 if (qptr->QuestionCallback)
8442 qptr->QuestionCallback(m, qptr, mDNSNULL, QC_nodnssec);
8443 mDNS_ReclaimLockAfterCallback(); // Decrement mDNS_reentrancy to block mDNS API calls again
8444 }
8445 }
8446 }
8447
8448 mDNSlocal void mDNSCoreReceiveNoUnicastAnswers(mDNS *const m, const DNSMessage *const response, const mDNSu8 *end, const mDNSAddr *dstaddr,
8449 mDNSIPPort dstport, const mDNSInterfaceID InterfaceID, uDNS_LLQType LLQType, mDNSu8 rcode, CacheRecord *NSECRecords)
8450 {
8451 int i;
8452 const mDNSu8 *ptr = response->data;
8453 CacheRecord *SOARecord = mDNSNULL;
8454
8455 for (i = 0; i < response->h.numQuestions && ptr && ptr < end; i++)
8456 {
8457 DNSQuestion q;
8458 DNSQuestion *qptr = mDNSNULL;
8459 ptr = getQuestion(response, ptr, end, InterfaceID, &q);
8460 if (ptr && (qptr = ExpectingUnicastResponseForQuestion(m, dstport, response->h.id, &q, !dstaddr)))
8461 {
8462 CacheRecord *rr, *neg = mDNSNULL;
8463 CacheGroup *cg = CacheGroupForName(m, q.qnamehash, &q.qname);
8464 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
8465 if (SameNameRecordAnswersQuestion(&rr->resrec, qptr))
8466 {
8467 // 1. If we got a fresh answer to this query, then don't need to generate a negative entry
8468 if (RRExpireTime(rr) - m->timenow > 0) break;
8469 // 2. If we already had a negative entry, keep track of it so we can resurrect it instead of creating a new one
8470 if (rr->resrec.RecordType == kDNSRecordTypePacketNegative) neg = rr;
8471 }
8472 // When we're doing parallel unicast and multicast queries for dot-local names (for supporting Microsoft
8473 // Active Directory sites) we don't want to waste memory making negative cache entries for all the unicast answers.
8474 // Otherwise we just fill up our cache with negative entries for just about every single multicast name we ever look up
8475 // (since the Microsoft Active Directory server is going to assert that pretty much every single multicast name doesn't exist).
8476 // This is not only a waste of memory, but there's also the problem of those negative entries confusing us later -- e.g. we
8477 // suppress sending our mDNS query packet because we think we already have a valid (negative) answer to that query in our cache.
8478 // The one exception is that we *DO* want to make a negative cache entry for "local. SOA", for the (common) case where we're
8479 // *not* on a Microsoft Active Directory network, and there is no authoritative server for "local". Note that this is not
8480 // in conflict with the mDNS spec, because that spec says, "Multicast DNS Zones have no SOA record," so it's okay to cache
8481 // negative answers for "local. SOA" from a uDNS server, because the mDNS spec already says that such records do not exist :-)
8482 //
8483 // By suppressing negative responses, it might take longer to timeout a .local question as it might be expecting a
8484 // response e.g., we deliver a positive "A" response and suppress negative "AAAA" response and the upper layer may
8485 // be waiting longer to get the AAAA response before returning the "A" response to the application. To handle this
8486 // case without creating the negative cache entries, we generate a negative response and let the layer above us
8487 // do the appropriate thing. This negative response is also needed for appending new search domains.
8488 if (!InterfaceID && q.qtype != kDNSType_SOA && IsLocalDomain(&q.qname))
8489 {
8490 if (!rr)
8491 {
8492 LogInfo("mDNSCoreReceiveNoUnicastAnswers: Generate negative response for %##s (%s)", q.qname.c, DNSTypeName(q.qtype));
8493 m->CurrentQuestion = qptr;
8494 // We are not creating a cache record in this case, we need to pass back
8495 // the error we got so that the proxy code can return the right one to
8496 // the application
8497 if (qptr->ProxyQuestion)
8498 qptr->responseFlags = response->h.flags;
8499 GenerateNegativeResponse(m, mDNSInterface_Any, QC_forceresponse);
8500 m->CurrentQuestion = mDNSNULL;
8501 }
8502 else
8503 {
8504 LogInfo("mDNSCoreReceiveNoUnicastAnswers: Skipping check and not creating a negative cache entry for %##s (%s)", q.qname.c, DNSTypeName(q.qtype));
8505 }
8506 }
8507 else
8508 {
8509 if (!rr)
8510 {
8511 // We start off assuming a negative caching TTL of 60 seconds
8512 // but then look to see if we can find an SOA authority record to tell us a better value we should be using
8513 mDNSu32 negttl = 60;
8514 int repeat = 0;
8515 const domainname *name = &q.qname;
8516 mDNSu32 hash = q.qnamehash;
8517
8518 // Special case for our special Microsoft Active Directory "local SOA" check.
8519 // Some cheap home gateways don't include an SOA record in the authority section when
8520 // they send negative responses, so we don't know how long to cache the negative result.
8521 // Because we don't want to keep hitting the root name servers with our query to find
8522 // if we're on a network using Microsoft Active Directory using "local" as a private
8523 // internal top-level domain, we make sure to cache the negative result for at least one day.
8524 if (q.qtype == kDNSType_SOA && SameDomainName(&q.qname, &localdomain)) negttl = 60 * 60 * 24;
8525
8526 // If we're going to make (or update) a negative entry, then look for the appropriate TTL from the SOA record
8527 if (response->h.numAuthorities && (ptr = LocateAuthorities(response, end)) != mDNSNULL)
8528 {
8529 ptr = GetLargeResourceRecord(m, response, ptr, end, InterfaceID, kDNSRecordTypePacketAuth, &m->rec);
8530 if (ptr && m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && m->rec.r.resrec.rrtype == kDNSType_SOA)
8531 {
8532 CacheGroup *cgSOA = CacheGroupForRecord(m, &m->rec.r.resrec);
8533 const rdataSOA *const soa = (const rdataSOA *)m->rec.r.resrec.rdata->u.data;
8534 mDNSu32 ttl_s = soa->min;
8535 // We use the lesser of the SOA.MIN field and the SOA record's TTL, *except*
8536 // for the SOA record for ".", where the record is reported as non-cacheable
8537 // (TTL zero) for some reason, so in this case we just take the SOA record's TTL as-is
8538 if (ttl_s > m->rec.r.resrec.rroriginalttl && m->rec.r.resrec.name->c[0])
8539 ttl_s = m->rec.r.resrec.rroriginalttl;
8540 if (negttl < ttl_s) negttl = ttl_s;
8541
8542 // Create the SOA record as we may have to return this to the questions
8543 // that we are acting as a proxy for currently or in the future.
8544 SOARecord = CreateNewCacheEntry(m, HashSlotFromNameHash(m->rec.r.resrec.namehash), cgSOA, 1, mDNSfalse, mDNSNULL);
8545
8546 // Special check for SOA queries: If we queried for a.b.c.d.com, and got no answer,
8547 // with an Authority Section SOA record for d.com, then this is a hint that the authority
8548 // is d.com, and consequently SOA records b.c.d.com and c.d.com don't exist either.
8549 // To do this we set the repeat count so the while loop below will make a series of negative cache entries for us
8550 //
8551 // For ProxyQuestions, we don't do this as we need to create additional SOA records to cache them
8552 // along with the negative cache record. For simplicity, we don't create the additional records.
8553 if (!qptr->ProxyQuestion && q.qtype == kDNSType_SOA)
8554 {
8555 int qcount = CountLabels(&q.qname);
8556 int scount = CountLabels(m->rec.r.resrec.name);
8557 if (qcount - 1 > scount)
8558 if (SameDomainName(SkipLeadingLabels(&q.qname, qcount - scount), m->rec.r.resrec.name))
8559 repeat = qcount - 1 - scount;
8560 }
8561 }
8562 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
8563 }
8564
8565 // If we already had a negative entry in the cache, then we double our existing negative TTL. This is to avoid
8566 // the case where the record doesn't exist (e.g. particularly for things like our lb._dns-sd._udp.<domain> query),
8567 // and the server returns no SOA record (or an SOA record with a small MIN TTL) so we assume a TTL
8568 // of 60 seconds, and we end up polling the server every minute for a record that doesn't exist.
8569 // With this fix in place, when this happens, we double the effective TTL each time (up to one hour),
8570 // so that we back off our polling rate and don't keep hitting the server continually.
8571 if (neg)
8572 {
8573 if (negttl < neg->resrec.rroriginalttl * 2)
8574 negttl = neg->resrec.rroriginalttl * 2;
8575 if (negttl > 3600)
8576 negttl = 3600;
8577 }
8578
8579 negttl = GetEffectiveTTL(LLQType, negttl); // Add 25% grace period if necessary
8580
8581 // If we already had a negative cache entry just update it, else make one or more new negative cache entries.
8582 if (neg)
8583 {
8584 LogInfo("mDNSCoreReceiveNoUnicastAnswers: Renewing negative TTL from %d to %d %s", neg->resrec.rroriginalttl, negttl, CRDisplayString(m, neg));
8585 RefreshCacheRecord(m, neg, negttl);
8586 // When we created the cache for the first time and answered the question, the question's
8587 // interval was set to MaxQuestionInterval. If the cache is about to expire and we are resending
8588 // the queries, the interval should still be at MaxQuestionInterval. If the query is being
8589 // restarted (setting it to InitialQuestionInterval) for other reasons e.g., wakeup,
8590 // we should reset its question interval here to MaxQuestionInterval.
8591 ResetQuestionState(m, qptr);
8592 if (DNSSECQuestion(qptr))
8593 neg->CRDNSSECQuestion = 1;
8594 // Update the NSEC records again.
8595 // TBD: Need to purge and revalidate if the cached NSECS and the new set are not same.
8596 if (NSECRecords)
8597 {
8598 if (!AddNSECSForCacheRecord(m, NSECRecords, neg, rcode))
8599 {
8600 // We might just have an SOA record for zones that are not signed and hence don't log
8601 // this as an error
8602 LogInfo("mDNSCoreReceiveNoUnicastAnswers: AddNSECSForCacheRecord failed to add NSEC for negcr %s during refresh", CRDisplayString(m, neg));
8603 FreeNSECRecords(m, NSECRecords);
8604 neg->CRDNSSECQuestion = 0;
8605 }
8606 NSECRecords = mDNSNULL;
8607 }
8608 if (SOARecord)
8609 {
8610 if (neg->soa)
8611 ReleaseCacheRecord(m, neg->soa);
8612 neg->soa = SOARecord;
8613 SOARecord = mDNSNULL;
8614 }
8615 }
8616 else while (1)
8617 {
8618 CacheRecord *negcr;
8619 debugf("mDNSCoreReceiveNoUnicastAnswers making negative cache entry TTL %d for %##s (%s)", negttl, name->c, DNSTypeName(q.qtype));
8620 MakeNegativeCacheRecord(m, &m->rec.r, name, hash, q.qtype, q.qclass, negttl, mDNSInterface_Any, qptr->qDNSServer);
8621 m->rec.r.responseFlags = response->h.flags;
8622 // We create SOA records above which might create new cache groups. Earlier
8623 // in the function we looked up the cache group for the name and it could have
8624 // been NULL. If we pass NULL cg to new cache entries that we create below,
8625 // it will create additional cache groups for the same name. To avoid that,
8626 // look up the cache group again to re-initialize cg again.
8627 cg = CacheGroupForName(m, hash, name);
8628 if (NSECRecords && DNSSECQuestion(qptr))
8629 {
8630 // Create the cache entry with delay and then add the NSEC records
8631 // to it and add it immediately.
8632 negcr = CreateNewCacheEntry(m, HashSlotFromNameHash(hash), cg, 1, mDNStrue, mDNSNULL);
8633 if (negcr)
8634 {
8635 negcr->CRDNSSECQuestion = 0;
8636 if (!AddNSECSForCacheRecord(m, NSECRecords, negcr, rcode))
8637 {
8638 LogInfo("mDNSCoreReceiveNoUnicastAnswers: AddNSECSForCacheRecord failed to add NSEC for negcr %s",
8639 CRDisplayString(m, negcr));
8640 FreeNSECRecords(m, NSECRecords);
8641 }
8642 else
8643 {
8644 negcr->CRDNSSECQuestion = 1;
8645 LogInfo("mDNSCoreReceiveNoUnicastAnswers: AddNSECSForCacheRecord added neg NSEC for %s", CRDisplayString(m, negcr));
8646 }
8647 NSECRecords = mDNSNULL;
8648 negcr->DelayDelivery = 0;
8649 CacheRecordDeferredAdd(m, negcr);
8650 }
8651 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
8652 break;
8653 }
8654 else
8655 {
8656 // Need to add with a delay so that we can tag the SOA record
8657 negcr = CreateNewCacheEntry(m, HashSlotFromNameHash(hash), cg, 1, mDNStrue, mDNSNULL);
8658 if (negcr)
8659 {
8660 negcr->CRDNSSECQuestion = 0;
8661 if (DNSSECQuestion(qptr))
8662 negcr->CRDNSSECQuestion = 1;
8663 negcr->DelayDelivery = 0;
8664
8665 if (SOARecord)
8666 {
8667 if (negcr->soa)
8668 ReleaseCacheRecord(m, negcr->soa);
8669 negcr->soa = SOARecord;
8670 SOARecord = mDNSNULL;
8671 }
8672 CacheRecordDeferredAdd(m, negcr);
8673 }
8674 }
8675 m->rec.r.responseFlags = zeroID;
8676 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
8677 if (!repeat) break;
8678 repeat--;
8679 name = (const domainname *)(name->c + 1 + name->c[0]);
8680 hash = DomainNameHashValue(name);
8681 }
8682 }
8683 }
8684 }
8685 }
8686 if (NSECRecords) { LogInfo("mDNSCoreReceiveNoUnicastAnswers: NSECRecords not used"); FreeNSECRecords(m, NSECRecords); }
8687 if (SOARecord) { LogInfo("mDNSCoreReceiveNoUnicastAnswers: SOARecord not used"); ReleaseCacheRecord(m, SOARecord); }
8688 }
8689
8690 mDNSlocal void mDNSCorePrintStoredProxyRecords(mDNS *const m)
8691 {
8692 AuthRecord *rrPtr = mDNSNULL;
8693 LogSPS("Stored Proxy records :");
8694 for (rrPtr = m->SPSRRSet; rrPtr; rrPtr = rrPtr->next)
8695 {
8696 LogSPS("%s", ARDisplayString(m, rrPtr));
8697 }
8698 }
8699
8700 mDNSlocal mDNSBool mDNSCoreRegisteredProxyRecord(mDNS *const m, AuthRecord *rr)
8701 {
8702 AuthRecord *rrPtr = mDNSNULL;
8703
8704 for (rrPtr = m->SPSRRSet; rrPtr; rrPtr = rrPtr->next)
8705 {
8706 if (IdenticalResourceRecord(&rrPtr->resrec, &rr->resrec))
8707 {
8708 LogSPS("mDNSCoreRegisteredProxyRecord: Ignoring packet registered with sleep proxy : %s ", ARDisplayString(m, rr));
8709 return mDNStrue;
8710 }
8711 }
8712 mDNSCorePrintStoredProxyRecords(m);
8713 return mDNSfalse;
8714 }
8715
8716 mDNSlocal CacheRecord* mDNSCoreReceiveCacheCheck(mDNS *const m, const DNSMessage *const response, uDNS_LLQType LLQType,
8717 const mDNSu32 slot, CacheGroup *cg, DNSQuestion *unicastQuestion, CacheRecord ***cfp, CacheRecord **NSECCachePtr,
8718 mDNSInterfaceID InterfaceID)
8719 {
8720 CacheRecord *rr;
8721 CacheRecord **cflocal = *cfp;
8722
8723 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
8724 {
8725 mDNSBool match;
8726 // Resource record received via unicast, the resGroupID should match ?
8727 if (!InterfaceID)
8728 {
8729 mDNSu16 id1 = (rr->resrec.rDNSServer ? rr->resrec.rDNSServer->resGroupID : 0);
8730 mDNSu16 id2 = (m->rec.r.resrec.rDNSServer ? m->rec.r.resrec.rDNSServer->resGroupID : 0);
8731 match = (id1 == id2);
8732 }
8733 else
8734 match = (rr->resrec.InterfaceID == InterfaceID);
8735 // If we found this exact resource record, refresh its TTL
8736 if (match && IdenticalSameNameRecord(&m->rec.r.resrec, &rr->resrec))
8737 {
8738 if (m->rec.r.resrec.rdlength > InlineCacheRDSize)
8739 verbosedebugf("mDNSCoreReceiveCacheCheck: Found record size %5d interface %p already in cache: %s",
8740 m->rec.r.resrec.rdlength, InterfaceID, CRDisplayString(m, &m->rec.r));
8741
8742 if (m->rec.r.resrec.RecordType & kDNSRecordTypePacketUniqueMask)
8743 {
8744 // If this packet record has the kDNSClass_UniqueRRSet flag set, then add it to our cache flushing list
8745 if (rr->NextInCFList == mDNSNULL && *cfp != &rr->NextInCFList && LLQType != uDNS_LLQ_Events)
8746 {
8747 *cflocal = rr;
8748 cflocal = &rr->NextInCFList;
8749 *cflocal = (CacheRecord*)1;
8750 *cfp = &rr->NextInCFList;
8751 }
8752
8753 // If this packet record is marked unique, and our previous cached copy was not, then fix it
8754 if (!(rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask))
8755 {
8756 DNSQuestion *q;
8757 for (q = m->Questions; q; q=q->next)
8758 {
8759 if (ResourceRecordAnswersQuestion(&rr->resrec, q))
8760 q->UniqueAnswers++;
8761 }
8762 rr->resrec.RecordType = m->rec.r.resrec.RecordType;
8763 }
8764 }
8765
8766 if (!SameRDataBody(&m->rec.r.resrec, &rr->resrec.rdata->u, SameDomainNameCS))
8767 {
8768 // If the rdata of the packet record differs in name capitalization from the record in our cache
8769 // then mDNSPlatformMemSame will detect this. In this case, throw the old record away, so that clients get
8770 // a 'remove' event for the record with the old capitalization, and then an 'add' event for the new one.
8771 // <rdar://problem/4015377> mDNS -F returns the same domain multiple times with different casing
8772 rr->resrec.rroriginalttl = 0;
8773 rr->TimeRcvd = m->timenow;
8774 rr->UnansweredQueries = MaxUnansweredQueries;
8775 SetNextCacheCheckTimeForRecord(m, rr);
8776 LogInfo("mDNSCoreReceiveCacheCheck: Discarding due to domainname case change old: %s", CRDisplayString(m, rr));
8777 LogInfo("mDNSCoreReceiveCacheCheck: Discarding due to domainname case change new: %s", CRDisplayString(m, &m->rec.r));
8778 LogInfo("mDNSCoreReceiveCacheCheck: Discarding due to domainname case change in %d slot %3d in %d %d",
8779 NextCacheCheckEvent(rr) - m->timenow, slot, m->rrcache_nextcheck[slot] - m->timenow, m->NextCacheCheck - m->timenow);
8780 // DO NOT break out here -- we want to continue as if we never found it
8781 }
8782 else if (!IdenticalAnonInfo(m->rec.r.resrec.AnonInfo, rr->resrec.AnonInfo))
8783 {
8784 // If the NSEC3 record changed, a few possibilities
8785 //
8786 // 1) the peer reinitialized e.g., after network change and still part of the
8787 // same set.
8788 // 2) the peer went to a different set but we did not see the goodbyes. If we just
8789 // update the nsec3 record, it would be incorrect. Flush the cache so that we
8790 // can deliver a RMV followed by ADD.
8791 // 3) if the peer is ourselves and we see the goodbye when moving to a different set
8792 // and so we flush the cache and create a new cache record with the new set information.
8793 // Now we move back to the original set. In this case, we can't just update the
8794 // NSEC3 record alone. We need to flush so that we can deliver an RMV followed by ADD
8795 // when we create the new cache entry.
8796 //
8797 // Note: For case (1), we could avoid flushing the cache but we can't tell the difference
8798 // from the other cases.
8799 rr->resrec.rroriginalttl = 0;
8800 rr->TimeRcvd = m->timenow;
8801 rr->UnansweredQueries = MaxUnansweredQueries;
8802 SetNextCacheCheckTimeForRecord(m, rr);
8803 LogInfo("mDNSCoreReceiveCacheCheck: AnonInfo changed for %s", CRDisplayString(m, rr));
8804 // DO NOT break out here -- we want to continue as if we never found it. When we return
8805 // from this function, we will create a new cache entry with the new NSEC3 record
8806 }
8807 else if (m->rec.r.resrec.rroriginalttl > 0)
8808 {
8809 DNSQuestion *q;
8810
8811 m->mDNSStats.CacheRefreshed++;
8812
8813 if (rr->resrec.mortality == Mortality_Ghost && unicastQuestion && (unicastQuestion->allowExpired != AllowExpired_AllowExpiredAnswers) && !rr->DelayDelivery)
8814 {
8815 rr->DelayDelivery = NonZeroTime(m->timenow);
8816 debugf("mDNSCoreReceiveCacheCheck: Reset DelayDelivery for mortalityExpired EXP:%d RR %s", m->timenow - RRExpireTime(rr), CRDisplayString(m, rr));
8817 }
8818
8819 if (rr->resrec.rroriginalttl == 0) debugf("uDNS rescuing %s", CRDisplayString(m, rr));
8820 RefreshCacheRecord(m, rr, m->rec.r.resrec.rroriginalttl);
8821 rr->responseFlags = response->h.flags;
8822
8823 // If we may have NSEC records returned with the answer (which we don't know yet as it
8824 // has not been processed), we need to cache them along with the first cache
8825 // record in the list that answers the question so that it can be used for validation
8826 // later. The "type" check below is to make sure that we cache on the cache record
8827 // that would answer the question. It is possible that we might cache additional things
8828 // e.g., MX question might cache A records also, and we want to cache the NSEC on
8829 // the record that answers the question.
8830 if (response->h.numAnswers && unicastQuestion && unicastQuestion->qtype == rr->resrec.rrtype
8831 && !(*NSECCachePtr))
8832 {
8833 LogInfo("mDNSCoreReceiveCacheCheck: rescuing RR %s", CRDisplayString(m, rr));
8834 *NSECCachePtr = rr;
8835 }
8836 // We have to reset the question interval to MaxQuestionInterval so that we don't keep
8837 // polling the network once we get a valid response back. For the first time when a new
8838 // cache entry is created, AnswerCurrentQuestionWithResourceRecord does that.
8839 // Subsequently, if we reissue questions from within the mDNSResponder e.g., DNS server
8840 // configuration changed, without flushing the cache, we reset the question interval here.
8841 // Currently, we do this for for both multicast and unicast questions as long as the record
8842 // type is unique. For unicast, resource record is always unique and for multicast it is
8843 // true for records like A etc. but not for PTR.
8844 if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask)
8845 {
8846 for (q = m->Questions; q; q=q->next)
8847 {
8848 if (!q->DuplicateOf && !q->LongLived &&
8849 ActiveQuestion(q) && ResourceRecordAnswersQuestion(&rr->resrec, q))
8850 {
8851 ResetQuestionState(m, q);
8852 debugf("mDNSCoreReceiveCacheCheck: Set MaxQuestionInterval for %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
8853 break; // Why break here? Aren't there other questions we might want to look at?-- SC July 2010
8854 }
8855 }
8856 }
8857 break;
8858 }
8859 else
8860 {
8861 // If the packet TTL is zero, that means we're deleting this record.
8862 // To give other hosts on the network a chance to protest, we push the deletion
8863 // out one second into the future. Also, we set UnansweredQueries to MaxUnansweredQueries.
8864 // Otherwise, we'll do final queries for this record at 80% and 90% of its apparent
8865 // lifetime (800ms and 900ms from now) which is a pointless waste of network bandwidth.
8866 // If record's current expiry time is more than a second from now, we set it to expire in one second.
8867 // If the record is already going to expire in less than one second anyway, we leave it alone --
8868 // we don't want to let the goodbye packet *extend* the record's lifetime in our cache.
8869 debugf("DE for %s", CRDisplayString(m, rr));
8870 if (RRExpireTime(rr) - m->timenow > mDNSPlatformOneSecond)
8871 {
8872 rr->resrec.rroriginalttl = 1;
8873 rr->TimeRcvd = m->timenow;
8874 rr->UnansweredQueries = MaxUnansweredQueries;
8875 SetNextCacheCheckTimeForRecord(m, rr);
8876 }
8877 break;
8878 }
8879 }
8880 }
8881 return rr;
8882 }
8883
8884 mDNSlocal void mDNSParseNSEC3Records(mDNS *const m, const DNSMessage *const response, const mDNSu8 *end,
8885 const mDNSInterfaceID InterfaceID, CacheRecord **NSEC3Records)
8886 {
8887 const mDNSu8 *ptr;
8888 CacheRecord *rr;
8889 int i;
8890
8891 if (!response->h.numAuthorities)
8892 return;
8893 ptr = LocateAuthorities(response, end);
8894 if (!ptr)
8895 {
8896 LogInfo("mDNSParseNSEC3Records: ERROR can't locate authorities");
8897 return;
8898 }
8899 for (i = 0; i < response->h.numAuthorities && ptr && ptr < end; i++)
8900 {
8901 CacheGroup *cg;
8902
8903 ptr = GetLargeResourceRecord(m, response, ptr, end, InterfaceID, kDNSRecordTypePacketAuth, &m->rec);
8904 if (!ptr || m->rec.r.resrec.RecordType == kDNSRecordTypePacketNegative || m->rec.r.resrec.rrtype != kDNSType_NSEC3)
8905 {
8906 debugf("mDNSParseNSEC3Records: ptr %p, Record %s, ignoring", ptr, CRDisplayString(m, &m->rec.r));
8907 m->rec.r.resrec.RecordType = 0;
8908 continue;
8909 }
8910 cg = CacheGroupForRecord(m, &m->rec.r.resrec);
8911 // Create the cache entry but don't add it to the cache it. We need
8912 // to cache this along with the main cache record.
8913 rr = CreateNewCacheEntry(m, HashSlotFromNameHash(m->rec.r.resrec.namehash), cg, 0, mDNSfalse, mDNSNULL);
8914 if (rr)
8915 {
8916 debugf("mDNSParseNSEC3Records: %s", CRDisplayString(m, rr));
8917 *NSEC3Records = rr;
8918 NSEC3Records = &rr->next;
8919 }
8920 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
8921 }
8922 }
8923
8924 mDNSlocal void mDNSCoreResetRecord(mDNS *const m)
8925 {
8926 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
8927 if (m->rec.r.resrec.AnonInfo)
8928 {
8929 FreeAnonInfo(m->rec.r.resrec.AnonInfo);
8930 m->rec.r.resrec.AnonInfo = mDNSNULL;
8931 }
8932 }
8933
8934 // Note: mDNSCoreReceiveResponse calls mDNS_Deregister_internal which can call a user callback, which may change
8935 // the record list and/or question list.
8936 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
8937 // InterfaceID non-NULL tells us the interface this multicast response was received on
8938 // InterfaceID NULL tells us this was a unicast response
8939 // dstaddr NULL tells us we received this over an outgoing TCP connection we made
8940 mDNSlocal void mDNSCoreReceiveResponse(mDNS *const m,
8941 const DNSMessage *const response, const mDNSu8 *end,
8942 const mDNSAddr *srcaddr, const mDNSIPPort srcport, const mDNSAddr *dstaddr, mDNSIPPort dstport,
8943 const mDNSInterfaceID InterfaceID)
8944 {
8945 int i;
8946 mDNSBool ResponseMCast = dstaddr && mDNSAddrIsDNSMulticast(dstaddr);
8947 mDNSBool ResponseSrcLocal = !srcaddr || mDNS_AddressIsLocalSubnet(m, InterfaceID, srcaddr);
8948 DNSQuestion *llqMatch = mDNSNULL;
8949 DNSQuestion *unicastQuestion = mDNSNULL;
8950 uDNS_LLQType LLQType = uDNS_recvLLQResponse(m, response, end, srcaddr, srcport, &llqMatch);
8951
8952 // "(CacheRecord*)1" is a special (non-zero) end-of-list marker
8953 // We use this non-zero marker so that records in our CacheFlushRecords list will always have NextInCFList
8954 // set non-zero, and that tells GetCacheEntity() that they're not, at this moment, eligible for recycling.
8955 CacheRecord *CacheFlushRecords = (CacheRecord*)1;
8956 CacheRecord **cfp = &CacheFlushRecords;
8957 CacheRecord *NSECRecords = mDNSNULL;
8958 CacheRecord *NSECCachePtr = mDNSNULL;
8959 CacheRecord **nsecp = &NSECRecords;
8960 CacheRecord *McastNSEC3Records = mDNSNULL;
8961 mDNSBool nseclist;
8962 mDNSu8 rcode = '\0';
8963 mDNSBool rrsigsCreated = mDNSfalse;
8964 mDNSBool DNSSECQuestion = mDNSfalse;
8965 NetworkInterfaceInfo *llintf = FirstIPv4LLInterfaceForID(m, InterfaceID);
8966 mDNSBool recordAcceptedInResponse = mDNSfalse; // Set if a record is accepted from a unicast mDNS response that answers an existing question.
8967
8968 // All records in a DNS response packet are treated as equally valid statements of truth. If we want
8969 // to guard against spoof responses, then the only credible protection against that is cryptographic
8970 // security, e.g. DNSSEC., not worrying about which section in the spoof packet contained the record.
8971 int firstauthority = response->h.numAnswers;
8972 int firstadditional = firstauthority + response->h.numAuthorities;
8973 int totalrecords = firstadditional + response->h.numAdditionals;
8974 const mDNSu8 *ptr = response->data;
8975 DNSServer *uDNSServer = mDNSNULL;
8976
8977 debugf("Received Response from %#-15a addressed to %#-15a on %p with "
8978 "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes LLQType %d",
8979 srcaddr, dstaddr, InterfaceID,
8980 response->h.numQuestions, response->h.numQuestions == 1 ? ", " : "s,",
8981 response->h.numAnswers, response->h.numAnswers == 1 ? ", " : "s,",
8982 response->h.numAuthorities, response->h.numAuthorities == 1 ? "y, " : "ies,",
8983 response->h.numAdditionals, response->h.numAdditionals == 1 ? " " : "s", end - response->data, LLQType);
8984
8985 #if AWD_METRICS
8986 if (mDNSSameIPPort(srcport, UnicastDNSPort))
8987 {
8988 MetricsUpdateDNSResponseSize((mDNSu32)(end - (mDNSu8 *)response));
8989 }
8990 #endif
8991
8992 // According to RFC 2181 <http://www.ietf.org/rfc/rfc2181.txt>
8993 // When a DNS client receives a reply with TC
8994 // set, it should ignore that response, and query again, using a
8995 // mechanism, such as a TCP connection, that will permit larger replies.
8996 // It feels wrong to be throwing away data after the network went to all the trouble of delivering it to us, but
8997 // delivering some records of the RRSet first and then the remainder a couple of milliseconds later was causing
8998 // failures in our Microsoft Active Directory client, which expects to get the entire set of answers at once.
8999 // <rdar://problem/6690034> Can't bind to Active Directory
9000 // In addition, if the client immediately canceled its query after getting the initial partial response, then we'll
9001 // abort our TCP connection, and not complete the operation, and end up with an incomplete RRSet in our cache.
9002 // Next time there's a query for this RRSet we'll see answers in our cache, and assume we have the whole RRSet already,
9003 // and not even do the TCP query.
9004 // Accordingly, if we get a uDNS reply with kDNSFlag0_TC set, we bail out and wait for the TCP response containing the
9005 // entire RRSet, with the following exception. If the response contains an answer section and one or more records in
9006 // either the authority section or additional section, then that implies that truncation occurred beyond the answer
9007 // section, and the answer section is therefore assumed to be complete.
9008 //
9009 // From section 6.2 of RFC 1035 <https://tools.ietf.org/html/rfc1035>:
9010 // When a response is so long that truncation is required, the truncation
9011 // should start at the end of the response and work forward in the
9012 // datagram. Thus if there is any data for the authority section, the
9013 // answer section is guaranteed to be unique.
9014 if (!InterfaceID && (response->h.flags.b[0] & kDNSFlag0_TC) &&
9015 ((response->h.numAnswers == 0) || ((response->h.numAuthorities == 0) && (response->h.numAdditionals == 0)))) return;
9016
9017 if (LLQType == uDNS_LLQ_Ignore) return;
9018
9019 // 1. We ignore questions (if any) in mDNS response packets
9020 // 2. If this is an LLQ response, we handle it much the same
9021 // Otherwise, this is a authoritative uDNS answer, so arrange for any stale records to be purged
9022 if (ResponseMCast || LLQType == uDNS_LLQ_Events)
9023 ptr = LocateAnswers(response, end);
9024 // Otherwise, for one-shot queries, any answers in our cache that are not also contained
9025 // in this response packet are immediately deemed to be invalid.
9026 else
9027 {
9028 mDNSBool failure, returnEarly;
9029 rcode = (mDNSu8)(response->h.flags.b[1] & kDNSFlag1_RC_Mask);
9030 failure = !(rcode == kDNSFlag1_RC_NoErr || rcode == kDNSFlag1_RC_NXDomain || rcode == kDNSFlag1_RC_NotAuth);
9031 returnEarly = mDNSfalse;
9032 // We could possibly combine this with the similar loop at the end of this function --
9033 // instead of tagging cache records here and then rescuing them if we find them in the answer section,
9034 // we could instead use the "m->PktNum" mechanism to tag each cache record with the packet number in
9035 // which it was received (or refreshed), and then at the end if we find any cache records which
9036 // answer questions in this packet's question section, but which aren't tagged with this packet's
9037 // packet number, then we deduce they are old and delete them
9038 for (i = 0; i < response->h.numQuestions && ptr && ptr < end; i++)
9039 {
9040 DNSQuestion q, *qptr = mDNSNULL;
9041 ptr = getQuestion(response, ptr, end, InterfaceID, &q);
9042 if (ptr && (qptr = ExpectingUnicastResponseForQuestion(m, dstport, response->h.id, &q, !dstaddr)))
9043 {
9044 if (!failure)
9045 {
9046 CacheRecord *rr;
9047 // Remember the unicast question that we found, which we use to make caching
9048 // decisions later on in this function
9049 CacheGroup *cg = CacheGroupForName(m, q.qnamehash, &q.qname);
9050 if (!mDNSOpaque16IsZero(response->h.id))
9051 {
9052 unicastQuestion = qptr;
9053 if (qptr->qDNSServer && DNSSECQuestion(qptr))
9054 {
9055 LogInfo("mDNSCoreReceiveResponse: Setting aware for %##s (%s) on %#a", qptr->qname.c,
9056 DNSTypeName(qptr->qtype), &qptr->qDNSServer->addr);
9057 qptr->qDNSServer->DNSSECAware = mDNStrue;
9058 qptr->qDNSServer->req_DO = mDNStrue;
9059 }
9060 if (qptr->ValidatingResponse)
9061 DNSSECQuestion = mDNStrue;
9062 }
9063 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
9064 if (SameNameRecordAnswersQuestion(&rr->resrec, qptr))
9065 {
9066 debugf("uDNS marking %p %##s (%s) %p %s", q.InterfaceID, q.qname.c, DNSTypeName(q.qtype),
9067 rr->resrec.InterfaceID, CRDisplayString(m, rr));
9068 // Don't want to disturb rroriginalttl here, because code below might need it for the exponential backoff doubling algorithm
9069 rr->TimeRcvd = m->timenow - TicksTTL(rr) - 1;
9070 rr->UnansweredQueries = MaxUnansweredQueries;
9071 rr->CRDNSSECQuestion = 0;
9072 if (unicastQuestion && DNSSECQuestion(unicastQuestion))
9073 {
9074 LogInfo("mDNSCoreReceiveResponse: CRDNSSECQuestion set for record %s, question %##s (%s)", CRDisplayString(m, rr),
9075 unicastQuestion->qname.c, DNSTypeName(unicastQuestion->qtype));
9076 rr->CRDNSSECQuestion = 1;
9077 }
9078 }
9079 }
9080 else
9081 {
9082 if (qptr)
9083 {
9084 // If we recv any error from the DNSServer for a DNSSEC Query and if we know that the server
9085 // is not DNSSEC aware, stop doing DNSSEC for that DNSServer. Note that by setting the
9086 // req_DO to false here, the next retransmission for this question will turn off validation
9087 // and hence retransmit without the EDNS0/DOK option.
9088 if (DNSSECOptionalQuestion(qptr) && qptr->qDNSServer && !qptr->qDNSServer->DNSSECAware)
9089 {
9090 LogInfo("mDNSCoreReceiveResponse: Server %p responded with code %d to DNSSEC Query %##s (%s), clear DO flag",
9091 qptr->qDNSServer, rcode, q.qname.c, DNSTypeName(q.qtype));
9092 qptr->qDNSServer->req_DO = mDNSfalse;
9093 }
9094 // For Unicast DNS Queries, penalize the DNSServer
9095 else
9096 {
9097 LogInfo("mDNSCoreReceiveResponse: Server %p responded with code %d to query %##s (%s)",
9098 qptr->qDNSServer, rcode, q.qname.c, DNSTypeName(q.qtype));
9099 PenalizeDNSServer(m, qptr, response->h.flags);
9100 }
9101 }
9102 returnEarly = mDNStrue;
9103 }
9104 }
9105 }
9106 if (returnEarly)
9107 {
9108 LogInfo("Ignoring %2d Answer%s %2d Authorit%s %2d Additional%s",
9109 response->h.numAnswers, response->h.numAnswers == 1 ? ", " : "s,",
9110 response->h.numAuthorities, response->h.numAuthorities == 1 ? "y, " : "ies,",
9111 response->h.numAdditionals, response->h.numAdditionals == 1 ? "" : "s");
9112 // not goto exit because we won't have any CacheFlushRecords and we do not want to
9113 // generate negative cache entries (we want to query the next server)
9114 return;
9115 }
9116 if (unicastQuestion && DNSSECQuestion(unicastQuestion))
9117 {
9118 BumpDNSSECStats(m, kStatsActionSet, kStatsTypeMsgSize, (end - response->data));
9119 }
9120 }
9121
9122 // Parse the NSEC3 records from the Authority section before we process
9123 // the Answer section so that we can cache them along with the proper
9124 // cache records we create.
9125 if (mDNSOpaque16IsZero(response->h.id))
9126 mDNSParseNSEC3Records(m, response, end, InterfaceID, &McastNSEC3Records);
9127
9128 for (i = 0; i < totalrecords && ptr && ptr < end; i++)
9129 {
9130 // All responses sent via LL multicast are acceptable for caching
9131 // All responses received over our outbound TCP connections are acceptable for caching
9132 // We accept all records in a unicast response to a multicast query once we find one that
9133 // answers an active question.
9134 mDNSBool AcceptableResponse = ResponseMCast || !dstaddr || LLQType || recordAcceptedInResponse;
9135 // (Note that just because we are willing to cache something, that doesn't necessarily make it a trustworthy answer
9136 // to any specific question -- any code reading records from the cache needs to make that determination for itself.)
9137
9138 const mDNSu8 RecordType =
9139 (i < firstauthority ) ? (mDNSu8)kDNSRecordTypePacketAns :
9140 (i < firstadditional) ? (mDNSu8)kDNSRecordTypePacketAuth : (mDNSu8)kDNSRecordTypePacketAdd;
9141 ptr = GetLargeResourceRecord(m, response, ptr, end, InterfaceID, RecordType, &m->rec);
9142 if (!ptr) goto exit; // Break out of the loop and clean up our CacheFlushRecords list before exiting
9143
9144 if (m->rec.r.resrec.RecordType == kDNSRecordTypePacketNegative)
9145 {
9146 mDNSCoreResetRecord(m);
9147 continue;
9148 }
9149
9150 // We have already parsed the NSEC3 records and cached them approrpriately for
9151 // multicast responses.
9152 if (mDNSOpaque16IsZero(response->h.id) && m->rec.r.resrec.rrtype == kDNSType_NSEC3)
9153 {
9154 mDNSCoreResetRecord(m);
9155 continue;
9156 }
9157 // Don't want to cache OPT or TSIG pseudo-RRs
9158 if (m->rec.r.resrec.rrtype == kDNSType_TSIG)
9159 {
9160 mDNSCoreResetRecord(m);
9161 continue;
9162 }
9163 if (m->rec.r.resrec.rrtype == kDNSType_OPT)
9164 {
9165 const rdataOPT *opt;
9166 const rdataOPT *const e = (const rdataOPT *)&m->rec.r.resrec.rdata->u.data[m->rec.r.resrec.rdlength];
9167 // Find owner sub-option(s). We verify that the MAC is non-zero, otherwise we could inadvertently
9168 // delete all our own AuthRecords (which are identified by having zero MAC tags on them).
9169 for (opt = &m->rec.r.resrec.rdata->u.opt[0]; opt < e; opt++)
9170 if (opt->opt == kDNSOpt_Owner && opt->u.owner.vers == 0 && opt->u.owner.HMAC.l[0])
9171 {
9172 ClearProxyRecords(m, &opt->u.owner, m->DuplicateRecords);
9173 ClearProxyRecords(m, &opt->u.owner, m->ResourceRecords);
9174 }
9175 mDNSCoreResetRecord(m);
9176 continue;
9177 }
9178 // if a CNAME record points to itself, then don't add it to the cache
9179 if ((m->rec.r.resrec.rrtype == kDNSType_CNAME) && SameDomainName(m->rec.r.resrec.name, &m->rec.r.resrec.rdata->u.name))
9180 {
9181 LogInfo("mDNSCoreReceiveResponse: CNAME loop domain name %##s", m->rec.r.resrec.name->c);
9182 mDNSCoreResetRecord(m);
9183 continue;
9184 }
9185
9186 // When we receive uDNS LLQ responses, we assume a long cache lifetime --
9187 // In the case of active LLQs, we'll get remove events when the records actually do go away
9188 // In the case of polling LLQs, we assume the record remains valid until the next poll
9189 if (!mDNSOpaque16IsZero(response->h.id))
9190 m->rec.r.resrec.rroriginalttl = GetEffectiveTTL(LLQType, m->rec.r.resrec.rroriginalttl);
9191
9192 // If response was not sent via LL multicast,
9193 // then see if it answers a recent query of ours, which would also make it acceptable for caching.
9194 if (!ResponseMCast)
9195 {
9196 if (LLQType)
9197 {
9198 // For Long Lived queries that are both sent over UDP and Private TCP, LLQType is set.
9199 // Even though it is AcceptableResponse, we need a matching DNSServer pointer for the
9200 // queries to get ADD/RMV events. To lookup the question, we can't use
9201 // ExpectingUnicastResponseForRecord as the port numbers don't match. uDNS_recvLLQRespose
9202 // has already matched the question using the 64 bit Id in the packet and we use that here.
9203
9204 if (llqMatch != mDNSNULL) m->rec.r.resrec.rDNSServer = uDNSServer = llqMatch->qDNSServer;
9205
9206 // If this is a DNSSEC question that is also LongLived, don't accept records from the
9207 // Additional/Authority section blindly. We need to go through IsAcceptableResponse below
9208 // so that NSEC/NSEC3 record are cached in the nseclist if we accept them. This can happen
9209 // for both negative responses and wildcard expanded positive responses as both of come
9210 // back with NSEC/NSEC3s.
9211 if (unicastQuestion && DNSSECQuestion(unicastQuestion))
9212 AcceptableResponse = mDNSfalse;
9213 }
9214 else if (!AcceptableResponse || !dstaddr)
9215 {
9216 // For responses that come over TCP (Responses that can't fit within UDP) or TLS (Private queries
9217 // that are not long lived e.g., AAAA lookup in a Private domain), it is indicated by !dstaddr.
9218 // Even though it is AcceptableResponse, we still need a DNSServer pointer for the resource records that
9219 // we create.
9220
9221 DNSQuestion *q = ExpectingUnicastResponseForRecord(m, srcaddr, ResponseSrcLocal, dstport, response->h.id, &m->rec.r, !dstaddr);
9222
9223 // Initialize the DNS server on the resource record which will now filter what questions we answer with
9224 // this record.
9225 //
9226 // We could potentially lookup the DNS server based on the source address, but that may not work always
9227 // and that's why ExpectingUnicastResponseForRecord does not try to verify whether the response came
9228 // from the DNS server that queried. We follow the same logic here. If we can find a matching quetion based
9229 // on the "id" and "source port", then this response answers the question and assume the response
9230 // came from the same DNS server that we sent the query to.
9231
9232 if (q != mDNSNULL)
9233 {
9234 AcceptableResponse = mDNStrue;
9235 if (!InterfaceID)
9236 {
9237 debugf("mDNSCoreReceiveResponse: InterfaceID %p %##s (%s)", q->InterfaceID, q->qname.c, DNSTypeName(q->qtype));
9238 m->rec.r.resrec.rDNSServer = uDNSServer = q->qDNSServer;
9239 }
9240 else
9241 {
9242 // Accept all remaining records in this unicast response to an mDNS query.
9243 recordAcceptedInResponse = mDNStrue;
9244 LogInfo("mDNSCoreReceiveResponse: Accepting response for query: %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
9245 }
9246 }
9247 else
9248 {
9249 // If we can't find a matching question, we need to see whether we have seen records earlier that matched
9250 // the question. The code below does that. So, make this record unacceptable for now
9251 if (!InterfaceID)
9252 {
9253 debugf("mDNSCoreReceiveResponse: Can't find question for record name %##s", m->rec.r.resrec.name->c);
9254 AcceptableResponse = mDNSfalse;
9255 }
9256 }
9257 }
9258 }
9259 else if (llintf && llintf->IgnoreIPv4LL && m->rec.r.resrec.rrtype == kDNSType_A)
9260 {
9261 // There are some routers (rare, thankfully) that generate bogus ARP responses for
9262 // any IPv4 address they don’t recognize, including RFC 3927 IPv4 link-local addresses.
9263 // To work with these broken routers, client devices need to blacklist these broken
9264 // routers and ignore their bogus ARP responses. Some devices implement a technique
9265 // such as the one described in US Patent 7436783, which lets clients detect and
9266 // ignore these broken routers: <https://www.google.com/patents/US7436783>
9267
9268 // OS X and iOS do not implement this defensive mechanism, instead taking a simpler
9269 // approach of just detecting these broken routers and completely disabling IPv4
9270 // link-local communication on interfaces where a broken router is detected.
9271 // OS X and iOS set the IFEF_ARPLL interface flag on interfaces
9272 // that are deemed “safe” for IPv4 link-local communication;
9273 // the flag is cleared on interfaces where a broken router is detected.
9274
9275 // OS X and iOS will not even try to communicate with an IPv4
9276 // link-local destination on an interface without the IFEF_ARPLL flag set.
9277 // This can cause some badly written applications to freeze for a long time if they
9278 // attempt to connect to an IPv4 link-local destination address and then wait for
9279 // that connection attempt to time out before trying other candidate addresses.
9280
9281 // To mask this client bug, we suppress acceptance of IPv4 link-local address
9282 // records on interfaces where we know the OS will be unwilling even to attempt
9283 // communication with those IPv4 link-local destination addresses.
9284 // <rdar://problem/9400639> kSuppress IPv4LL answers on interfaces without IFEF_ARPLL
9285
9286 const CacheRecord *const rr = &m->rec.r;
9287 const RDataBody2 *const rdb = (RDataBody2 *)rr->smallrdatastorage.data;
9288 if (mDNSv4AddressIsLinkLocal(&rdb->ipv4))
9289 {
9290 LogInfo("mDNSResponder: Dropping LinkLocal packet %s", CRDisplayString(m, &m->rec.r));
9291 mDNSCoreResetRecord(m);
9292 continue;
9293 }
9294 }
9295
9296 // 1. Check that this packet resource record does not conflict with any of ours
9297 if (mDNSOpaque16IsZero(response->h.id) && m->rec.r.resrec.rrtype != kDNSType_NSEC)
9298 {
9299 if (m->CurrentRecord)
9300 LogMsg("mDNSCoreReceiveResponse ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
9301 m->CurrentRecord = m->ResourceRecords;
9302 while (m->CurrentRecord)
9303 {
9304 AuthRecord *rr = m->CurrentRecord;
9305 m->CurrentRecord = rr->next;
9306 // We accept all multicast responses, and unicast responses resulting from queries we issued
9307 // For other unicast responses, this code accepts them only for responses with an
9308 // (apparently) local source address that pertain to a record of our own that's in probing state
9309 if (!AcceptableResponse && !(ResponseSrcLocal && rr->resrec.RecordType == kDNSRecordTypeUnique)) continue;
9310
9311 if (PacketRRMatchesSignature(&m->rec.r, rr)) // If interface, name, type (if shared record) and class match...
9312 {
9313 // ... check to see if type and rdata are identical
9314 if (IdenticalSameNameRecord(&m->rec.r.resrec, &rr->resrec))
9315 {
9316 // If the RR in the packet is identical to ours, just check they're not trying to lower the TTL on us
9317 if (m->rec.r.resrec.rroriginalttl >= rr->resrec.rroriginalttl/2 || m->SleepState)
9318 {
9319 // If we were planning to send on this -- and only this -- interface, then we don't need to any more
9320 if (rr->ImmedAnswer == InterfaceID) { rr->ImmedAnswer = mDNSNULL; rr->ImmedUnicast = mDNSfalse; }
9321 }
9322 else
9323 {
9324 if (rr->ImmedAnswer == mDNSNULL) { rr->ImmedAnswer = InterfaceID; m->NextScheduledResponse = m->timenow; }
9325 else if (rr->ImmedAnswer != InterfaceID) { rr->ImmedAnswer = mDNSInterfaceMark; m->NextScheduledResponse = m->timenow; }
9326 }
9327 }
9328 // else, the packet RR has different type or different rdata -- check to see if this is a conflict
9329 else if (m->rec.r.resrec.rroriginalttl > 0 && PacketRRConflict(m, rr, &m->rec.r))
9330 {
9331 LogInfo("mDNSCoreReceiveResponse: Pkt Record: %08lX %s", m->rec.r.resrec.rdatahash, CRDisplayString(m, &m->rec.r));
9332 LogInfo("mDNSCoreReceiveResponse: Our Record: %08lX %s", rr->resrec.rdatahash, ARDisplayString(m, rr));
9333
9334 // If this record is marked DependentOn another record for conflict detection purposes,
9335 // then *that* record has to be bumped back to probing state to resolve the conflict
9336 if (rr->DependentOn)
9337 {
9338 while (rr->DependentOn) rr = rr->DependentOn;
9339 LogInfo("mDNSCoreReceiveResponse: Dep Record: %08lX %s", rr->resrec.rdatahash, ARDisplayString(m, rr));
9340 }
9341
9342 // If we've just whacked this record's ProbeCount, don't need to do it again
9343 if (rr->ProbeCount > DefaultProbeCountForTypeUnique)
9344 LogInfo("mDNSCoreReceiveResponse: Already reset to Probing: %s", ARDisplayString(m, rr));
9345 else if (rr->ProbeCount == DefaultProbeCountForTypeUnique)
9346 LogInfo("mDNSCoreReceiveResponse: Ignoring response received before we even began probing: %s", ARDisplayString(m, rr));
9347 else
9348 {
9349 LogMsg("mDNSCoreReceiveResponse: Received from %#a:%d %s", srcaddr, mDNSVal16(srcport), CRDisplayString(m, &m->rec.r));
9350 // If we'd previously verified this record, put it back to probing state and try again
9351 if (rr->resrec.RecordType == kDNSRecordTypeVerified)
9352 {
9353 LogMsg("mDNSCoreReceiveResponse: Resetting to Probing: %s", ARDisplayString(m, rr));
9354 rr->resrec.RecordType = kDNSRecordTypeUnique;
9355 // We set ProbeCount to one more than the usual value so we know we've already touched this record.
9356 // This is because our single probe for "example-name.local" could yield a response with (say) two A records and
9357 // three AAAA records in it, and we don't want to call RecordProbeFailure() five times and count that as five conflicts.
9358 // This special value is recognised and reset to DefaultProbeCountForTypeUnique in SendQueries().
9359 rr->ProbeCount = DefaultProbeCountForTypeUnique + 1;
9360 rr->AnnounceCount = InitialAnnounceCount;
9361 InitializeLastAPTime(m, rr);
9362 RecordProbeFailure(m, rr); // Repeated late conflicts also cause us to back off to the slower probing rate
9363 }
9364 // If we're probing for this record, we just failed
9365 else if (rr->resrec.RecordType == kDNSRecordTypeUnique)
9366 {
9367 // At this point in the code, we're probing for uniqueness.
9368 // We've sent at least one probe (rr->ProbeCount < DefaultProbeCountForTypeUnique)
9369 // but we haven't completed probing yet (rr->resrec.RecordType == kDNSRecordTypeUnique).
9370 // Before we call deregister, check if this is a packet we registered with the sleep proxy.
9371 if (!mDNSCoreRegisteredProxyRecord(m, rr))
9372 {
9373 // This may be a conflict due to stale packets on the network. Delay probing by a second.
9374 // If there are conflicts after 3 such attempts, then it is a true conflict.
9375 if (m->DelayConflictProcessing)
9376 {
9377 m->DelayConflictProcessing--;
9378 LogMsg("Possible spurious conflict for %s. Attempt %d at suppressing probes for one second",
9379 ARDisplayString(m, rr), (MAX_CONFLICT_PROCESSING_DELAYS - m->DelayConflictProcessing));
9380 rr->ProbeCount = DefaultProbeCountForTypeUnique + 1;
9381 rr->AnnounceCount = InitialAnnounceCount;
9382 m->SuppressProbes = NonZeroTime(m->timenow + mDNSPlatformOneSecond);
9383 InitializeLastAPTime(m, rr);
9384 RecordProbeFailure(m, rr); // Repeated late conflicts also cause us to back off to the slower probing rate
9385 }
9386 else
9387 {
9388 LogMsg("mDNSCoreReceiveResponse: ProbeCount %d; will deregister %s", rr->ProbeCount, ARDisplayString(m, rr));
9389 m->mDNSStats.NameConflicts++;
9390 #if APPLE_OSX_mDNSResponder
9391 // See if this record was also registered with any D2D plugins.
9392 D2D_stop_advertising_record(rr);
9393 #endif
9394 mDNS_Deregister_internal(m, rr, mDNS_Dereg_conflict);
9395 }
9396
9397 }
9398 }
9399 // We assumed this record must be unique, but we were wrong. (e.g. There are two mDNSResponders on the
9400 // same machine giving different answers for the reverse mapping record, or there are two machines on the
9401 // network using the same IP address.) This is simply a misconfiguration, and there's nothing we can do
9402 // to fix it -- e.g. it's not our job to be trying to change the machine's IP address. We just discard our
9403 // record to avoid continued conflicts (as we do for a conflict on our Unique records) and get on with life.
9404 else if (rr->resrec.RecordType == kDNSRecordTypeKnownUnique)
9405 {
9406 LogMsg("mDNSCoreReceiveResponse: Unexpected conflict discarding %s", ARDisplayString(m, rr));
9407 m->mDNSStats.KnownUniqueNameConflicts++;
9408 #if APPLE_OSX_mDNSResponder
9409 D2D_stop_advertising_record(rr);
9410 #endif
9411 mDNS_Deregister_internal(m, rr, mDNS_Dereg_conflict);
9412 }
9413 else
9414 LogMsg("mDNSCoreReceiveResponse: Unexpected record type %X %s", rr->resrec.RecordType, ARDisplayString(m, rr));
9415 }
9416 }
9417 // Else, matching signature, different type or rdata, but not a considered a conflict.
9418 // If the packet record has the cache-flush bit set, then we check to see if we
9419 // have any record(s) of the same type that we should re-assert to rescue them
9420 // (see note about "multi-homing and bridged networks" at the end of this function).
9421 else if (m->rec.r.resrec.rrtype == rr->resrec.rrtype)
9422 if ((m->rec.r.resrec.RecordType & kDNSRecordTypePacketUniqueMask) && (mDNSu32)(m->timenow - rr->LastMCTime) > (mDNSu32)mDNSPlatformOneSecond/2)
9423 { rr->ImmedAnswer = mDNSInterfaceMark; m->NextScheduledResponse = m->timenow; }
9424 }
9425 }
9426 }
9427
9428 nseclist = mDNSfalse;
9429 if (!AcceptableResponse)
9430 {
9431 AcceptableResponse = IsResponseAcceptable(m, CacheFlushRecords, unicastQuestion, &nseclist);
9432 if (AcceptableResponse) m->rec.r.resrec.rDNSServer = uDNSServer;
9433 }
9434
9435 // 2. See if we want to add this packet resource record to our cache
9436 // We only try to cache answers if we have a cache to put them in
9437 // Also, we ignore any apparent attempts at cache poisoning unicast to us that do not answer any outstanding active query
9438 if (!AcceptableResponse) LogInfo("mDNSCoreReceiveResponse ignoring %s", CRDisplayString(m, &m->rec.r));
9439 if (m->rrcache_size && AcceptableResponse)
9440 {
9441 const mDNSu32 slot = HashSlotFromNameHash(m->rec.r.resrec.namehash);
9442 CacheGroup *cg = CacheGroupForRecord(m, &m->rec.r.resrec);
9443 CacheRecord *rr = mDNSNULL;
9444
9445 if (McastNSEC3Records)
9446 InitializeAnonInfoForCR(m, &McastNSEC3Records, &m->rec.r);
9447
9448 // 2a. Check if this packet resource record is already in our cache.
9449 //
9450 // If this record should go in the nseclist, don't look in the cache for updating it.
9451 // They are supposed to be cached under the "nsec" field of the cache record for
9452 // validation. Just create the cache record.
9453 if (!nseclist)
9454 {
9455 rr = mDNSCoreReceiveCacheCheck(m, response, LLQType, slot, cg, unicastQuestion, &cfp, &NSECCachePtr, InterfaceID);
9456 }
9457
9458 // If packet resource record not in our cache, add it now
9459 // (unless it is just a deletion of a record we never had, in which case we don't care)
9460 if (!rr && m->rec.r.resrec.rroriginalttl > 0)
9461 {
9462 const mDNSBool AddToCFList = (m->rec.r.resrec.RecordType & kDNSRecordTypePacketUniqueMask) && (LLQType != uDNS_LLQ_Events);
9463 mDNSs32 delay;
9464
9465 if (AddToCFList)
9466 delay = NonZeroTime(m->timenow + mDNSPlatformOneSecond);
9467 else
9468 delay = CheckForSoonToExpireRecords(m, m->rec.r.resrec.name, m->rec.r.resrec.namehash);
9469
9470 // If unique, assume we may have to delay delivery of this 'add' event.
9471 // Below, where we walk the CacheFlushRecords list, we either call CacheRecordDeferredAdd()
9472 // to immediately to generate answer callbacks, or we call ScheduleNextCacheCheckTime()
9473 // to schedule an mDNS_Execute task at the appropriate time.
9474 rr = CreateNewCacheEntry(m, slot, cg, delay, !nseclist, srcaddr);
9475 if (rr)
9476 {
9477 rr->responseFlags = response->h.flags;
9478 // If we are not creating signatures, then we need to inform DNSSEC so that
9479 // it does not wait forever. Don't do this if we got NSEC records
9480 // as it indicates that this name does not exist.
9481 if (rr->resrec.rrtype == kDNSType_RRSIG && !nseclist)
9482 {
9483 rrsigsCreated = mDNStrue;
9484 }
9485 // Remember whether we created a cache record in response to a DNSSEC question.
9486 // This helps DNSSEC code not to reissue the question to fetch the DNSSEC records.
9487 rr->CRDNSSECQuestion = 0;
9488 if (unicastQuestion && DNSSECQuestion(unicastQuestion))
9489 {
9490 LogInfo("mDNSCoreReceiveResponse: CRDNSSECQuestion set for new record %s, question %##s (%s)", CRDisplayString(m, rr),
9491 unicastQuestion->qname.c, DNSTypeName(unicastQuestion->qtype));
9492 rr->CRDNSSECQuestion = 1;
9493 }
9494 // NSEC/NSEC3 records and its signatures are cached with the negative cache entry
9495 // which we should be creating below. It is also needed in the wildcard
9496 // expanded answer case and in that case it is cached along with the answer.
9497 if (nseclist)
9498 {
9499 rr->TimeRcvd = m->timenow;
9500 *nsecp = rr;
9501 nsecp = &rr->next;
9502 }
9503 else if (AddToCFList)
9504 {
9505 *cfp = rr;
9506 cfp = &rr->NextInCFList;
9507 *cfp = (CacheRecord*)1;
9508 }
9509 else if (rr->DelayDelivery)
9510 {
9511 ScheduleNextCacheCheckTime(m, slot, rr->DelayDelivery);
9512 }
9513 }
9514 }
9515 else
9516 {
9517 if (rr && rr->resrec.AnonInfo && m->rec.r.resrec.AnonInfo)
9518 {
9519 CopyAnonInfoForCR(m, rr, &m->rec.r);
9520 }
9521 }
9522 }
9523 mDNSCoreResetRecord(m);
9524 }
9525
9526 exit:
9527 mDNSCoreResetRecord(m);
9528
9529 // If we've just received one or more records with their cache flush bits set,
9530 // then scan that cache slot to see if there are any old stale records we need to flush
9531 while (CacheFlushRecords != (CacheRecord*)1)
9532 {
9533 CacheRecord *r1 = CacheFlushRecords, *r2;
9534 const mDNSu32 slot = HashSlotFromNameHash(r1->resrec.namehash);
9535 const CacheGroup *cg = CacheGroupForRecord(m, &r1->resrec);
9536 mDNSBool purgedRecords = mDNSfalse;
9537 CacheFlushRecords = CacheFlushRecords->NextInCFList;
9538 r1->NextInCFList = mDNSNULL;
9539
9540 // Look for records in the cache with the same signature as this new one with the cache flush
9541 // bit set, and either (a) if they're fresh, just make sure the whole RRSet has the same TTL
9542 // (as required by DNS semantics) or (b) if they're old, mark them for deletion in one second.
9543 // We make these TTL adjustments *only* for records that still have *more* than one second
9544 // remaining to live. Otherwise, a record that we tagged for deletion half a second ago
9545 // (and now has half a second remaining) could inadvertently get its life extended, by either
9546 // (a) if we got an explicit goodbye packet half a second ago, the record would be considered
9547 // "fresh" and would be incorrectly resurrected back to the same TTL as the rest of the RRSet,
9548 // or (b) otherwise, the record would not be fully resurrected, but would be reset to expire
9549 // in one second, thereby inadvertently delaying its actual expiration, instead of hastening it.
9550 // If this were to happen repeatedly, the record's expiration could be deferred indefinitely.
9551 // To avoid this, we need to ensure that the cache flushing operation will only act to
9552 // *decrease* a record's remaining lifetime, never *increase* it.
9553 for (r2 = cg ? cg->members : mDNSNULL; r2; r2=r2->next)
9554 {
9555 mDNSu16 id1;
9556 mDNSu16 id2;
9557 if (!r1->resrec.InterfaceID)
9558 {
9559 id1 = (r1->resrec.rDNSServer ? r1->resrec.rDNSServer->resGroupID : 0);
9560 id2 = (r2->resrec.rDNSServer ? r2->resrec.rDNSServer->resGroupID : 0);
9561 }
9562 else
9563 {
9564 id1 = id2 = 0;
9565 }
9566 // When we receive new RRSIGs e.g., for DNSKEY record, we should not flush the old
9567 // RRSIGS e.g., for TXT record. To do so, we need to look at the typeCovered field of
9568 // the new RRSIG that we received. Process only if the typeCovered matches.
9569 if ((r1->resrec.rrtype == r2->resrec.rrtype) && (r1->resrec.rrtype == kDNSType_RRSIG))
9570 {
9571 rdataRRSig *rrsig1 = (rdataRRSig *)(((RDataBody2 *)(r1->resrec.rdata->u.data))->data);
9572 rdataRRSig *rrsig2 = (rdataRRSig *)(((RDataBody2 *)(r2->resrec.rdata->u.data))->data);
9573 if (swap16(rrsig1->typeCovered) != swap16(rrsig2->typeCovered))
9574 {
9575 debugf("mDNSCoreReceiveResponse: Received RRSIG typeCovered %s, found %s, not processing",
9576 DNSTypeName(swap16(rrsig1->typeCovered)), DNSTypeName(swap16(rrsig2->typeCovered)));
9577 continue;
9578 }
9579 }
9580
9581 // For Unicast (null InterfaceID) the resolver IDs should also match
9582 if ((r1->resrec.InterfaceID == r2->resrec.InterfaceID) &&
9583 (r1->resrec.InterfaceID || (id1 == id2)) &&
9584 r1->resrec.rrtype == r2->resrec.rrtype &&
9585 r1->resrec.rrclass == r2->resrec.rrclass)
9586 {
9587 if (r1->resrec.mortality == Mortality_Mortal && r2->resrec.mortality != Mortality_Mortal)
9588 {
9589 verbosedebugf("mDNSCoreReceiveResponse: R1(%p) is being immortalized by R2(%p)", r1, r2);
9590 r1->resrec.mortality = Mortality_Immortal; // Immortalize the replacement record
9591 }
9592
9593 // If record is recent, just ensure the whole RRSet has the same TTL (as required by DNS semantics)
9594 // else, if record is old, mark it to be flushed
9595 if (m->timenow - r2->TimeRcvd < mDNSPlatformOneSecond && RRExpireTime(r2) - m->timenow > mDNSPlatformOneSecond)
9596 {
9597 // If we find mismatched TTLs in an RRSet, correct them.
9598 // We only do this for records with a TTL of 2 or higher. It's possible to have a
9599 // goodbye announcement with the cache flush bit set (or a case-change on record rdata,
9600 // which we treat as a goodbye followed by an addition) and in that case it would be
9601 // inappropriate to synchronize all the other records to a TTL of 0 (or 1).
9602
9603 // We suppress the message for the specific case of correcting from 240 to 60 for type TXT,
9604 // because certain early Bonjour devices are known to have this specific mismatch, and
9605 // there's no point filling syslog with messages about something we already know about.
9606 // We also don't log this for uDNS responses, since a caching name server is obliged
9607 // to give us an aged TTL to correct for how long it has held the record,
9608 // so our received TTLs are expected to vary in that case
9609
9610 // We also suppress log message in the case of SRV records that are received
9611 // with a TTL of 4500 that are already cached with a TTL of 120 seconds, since
9612 // this behavior was observed for a number of discoveryd based AppleTV's in iOS 8
9613 // GM builds.
9614 if (r2->resrec.rroriginalttl != r1->resrec.rroriginalttl && r1->resrec.rroriginalttl > 1)
9615 {
9616 if (!(r2->resrec.rroriginalttl == 240 && r1->resrec.rroriginalttl == 60 && r2->resrec.rrtype == kDNSType_TXT) &&
9617 !(r2->resrec.rroriginalttl == 120 && r1->resrec.rroriginalttl == 4500 && r2->resrec.rrtype == kDNSType_SRV) &&
9618 mDNSOpaque16IsZero(response->h.id))
9619 LogInfo("Correcting TTL from %4d to %4d for %s",
9620 r2->resrec.rroriginalttl, r1->resrec.rroriginalttl, CRDisplayString(m, r2));
9621 r2->resrec.rroriginalttl = r1->resrec.rroriginalttl;
9622 }
9623 r2->TimeRcvd = m->timenow;
9624 SetNextCacheCheckTimeForRecord(m, r2);
9625 }
9626 else if (r2->resrec.InterfaceID) // else, if record is old, mark it to be flushed
9627 {
9628 verbosedebugf("Cache flush new %p age %d expire in %d %s", r1, m->timenow - r1->TimeRcvd, RRExpireTime(r1) - m->timenow, CRDisplayString(m, r1));
9629 verbosedebugf("Cache flush old %p age %d expire in %d %s", r2, m->timenow - r2->TimeRcvd, RRExpireTime(r2) - m->timenow, CRDisplayString(m, r2));
9630 // We set stale records to expire in one second.
9631 // This gives the owner a chance to rescue it if necessary.
9632 // This is important in the case of multi-homing and bridged networks:
9633 // Suppose host X is on Ethernet. X then connects to an AirPort base station, which happens to be
9634 // bridged onto the same Ethernet. When X announces its AirPort IP address with the cache-flush bit
9635 // set, the AirPort packet will be bridged onto the Ethernet, and all other hosts on the Ethernet
9636 // will promptly delete their cached copies of the (still valid) Ethernet IP address record.
9637 // By delaying the deletion by one second, we give X a change to notice that this bridging has
9638 // happened, and re-announce its Ethernet IP address to rescue it from deletion from all our caches.
9639
9640 // We set UnansweredQueries to MaxUnansweredQueries to avoid expensive and unnecessary
9641 // final expiration queries for this record.
9642
9643 // If a record is deleted twice, first with an explicit DE record, then a second time by virtue of the cache
9644 // flush bit on the new record replacing it, then we allow the record to be deleted immediately, without the usual
9645 // one-second grace period. This improves responsiveness for mDNS_Update(), as used for things like iChat status updates.
9646 // <rdar://problem/5636422> Updating TXT records is too slow
9647 // We check for "rroriginalttl == 1" because we want to include records tagged by the "packet TTL is zero" check above,
9648 // which sets rroriginalttl to 1, but not records tagged by the rdata case-change check, which sets rroriginalttl to 0.
9649 if (r2->TimeRcvd == m->timenow && r2->resrec.rroriginalttl == 1 && r2->UnansweredQueries == MaxUnansweredQueries)
9650 {
9651 LogInfo("Cache flush for DE record %s", CRDisplayString(m, r2));
9652 r2->resrec.rroriginalttl = 0;
9653 }
9654 else if (RRExpireTime(r2) - m->timenow > mDNSPlatformOneSecond)
9655 {
9656 // We only set a record to expire in one second if it currently has *more* than a second to live
9657 // If it's already due to expire in a second or less, we just leave it alone
9658 r2->resrec.rroriginalttl = 1;
9659 r2->UnansweredQueries = MaxUnansweredQueries;
9660 r2->TimeRcvd = m->timenow - 1;
9661 // We use (m->timenow - 1) instead of m->timenow, because we use that to identify records
9662 // that we marked for deletion via an explicit DE record
9663 }
9664 SetNextCacheCheckTimeForRecord(m, r2);
9665 }
9666 else
9667 {
9668 #if AWD_METRICS
9669 if (r2->resrec.mortality == Mortality_Ghost)
9670 {
9671 DNSQuestion * q;
9672 for (q = m->Questions; q; q=q->next)
9673 {
9674 if (!q->LongLived && ActiveQuestion(q) &&
9675 ResourceRecordAnswersQuestion(&r2->resrec, q) &&
9676 q->metrics.expiredAnswerState == ExpiredAnswer_AnsweredWithExpired)
9677 {
9678 q->metrics.expiredAnswerState = ExpiredAnswer_ExpiredAnswerChanged;
9679 }
9680 }
9681 }
9682 #endif
9683 // Old uDNS records are scheduled to be purged instead of given at most one second to live.
9684 r2->resrec.mortality = Mortality_Mortal; // We want it purged, so remove any immortality
9685 mDNS_PurgeCacheResourceRecord(m, r2);
9686 purgedRecords = mDNStrue;
9687 }
9688 }
9689 }
9690
9691 if (r1->DelayDelivery) // If we were planning to delay delivery of this record, see if we still need to
9692 {
9693 // If we had a unicast question for this response with at least one positive answer and we
9694 // have NSECRecords, it is most likely a wildcard expanded answer. Cache the NSEC and its
9695 // signatures along with the cache record which will be used for validation later. If
9696 // we rescued a few records earlier in this function, then NSECCachePtr would be set. In that
9697 // use that instead.
9698 if (response->h.numAnswers && unicastQuestion && NSECRecords)
9699 {
9700 if (!NSECCachePtr)
9701 {
9702 LogInfo("mDNSCoreReceiveResponse: Updating NSECCachePtr to %s", CRDisplayString(m, r1));
9703 NSECCachePtr = r1;
9704 }
9705 // Note: We need to do this before we call CacheRecordDeferredAdd as this
9706 // might start the verification process which needs these NSEC records
9707 if (!AddNSECSForCacheRecord(m, NSECRecords, NSECCachePtr, rcode))
9708 {
9709 LogInfo("mDNSCoreReceiveResponse: AddNSECSForCacheRecord failed to add NSEC for %s", CRDisplayString(m, NSECCachePtr));
9710 FreeNSECRecords(m, NSECRecords);
9711 }
9712 NSECRecords = mDNSNULL;
9713 NSECCachePtr = mDNSNULL;
9714 }
9715 if (r1->resrec.InterfaceID)
9716 {
9717 r1->DelayDelivery = CheckForSoonToExpireRecords(m, r1->resrec.name, r1->resrec.namehash);
9718 }
9719 else
9720 {
9721 // If uDNS records from an older RRset were scheduled to be purged, then delay delivery slightly to allow
9722 // them to be deleted before any ADD events for this record.
9723 r1->DelayDelivery = purgedRecords ? NonZeroTime(m->timenow) : 0;
9724 }
9725 // If no longer delaying, deliver answer now, else schedule delivery for the appropriate time
9726 if (!r1->DelayDelivery) CacheRecordDeferredAdd(m, r1);
9727 else ScheduleNextCacheCheckTime(m, slot, r1->DelayDelivery);
9728 }
9729 }
9730
9731 // If we have not consumed the NSEC records yet e.g., just refreshing the cache,
9732 // update them now for future validations.
9733 if (NSECRecords && NSECCachePtr)
9734 {
9735 LogInfo("mDNSCoreReceieveResponse: Updating NSEC records in %s", CRDisplayString(m, NSECCachePtr));
9736 if (!AddNSECSForCacheRecord(m, NSECRecords, NSECCachePtr, rcode))
9737 {
9738 LogInfo("mDNSCoreReceiveResponse: AddNSECSForCacheRecord failed to add NSEC for %s", CRDisplayString(m, NSECCachePtr));
9739 FreeNSECRecords(m, NSECRecords);
9740 }
9741 NSECRecords = mDNSNULL;
9742 NSECCachePtr = mDNSNULL;
9743 }
9744
9745 // If there is at least one answer and we did not create RRSIGs and there was a
9746 // ValidatingResponse question waiting for this response, give a hint that no RRSIGs
9747 // were created. We don't need to give a hint:
9748 //
9749 // - if we have no answers, the mDNSCoreReceiveNoUnicastAnswers below should
9750 // generate a negative response
9751 //
9752 // - if we have NSECRecords, it means we might have a potential proof for
9753 // non-existence of name that we are looking for
9754 //
9755 if (response->h.numAnswers && !rrsigsCreated && DNSSECQuestion && !NSECRecords)
9756 mDNSCoreReceiveNoDNSSECAnswers(m, response, end, dstaddr, dstport, InterfaceID);
9757
9758 // See if we need to generate negative cache entries for unanswered unicast questions
9759 mDNSCoreReceiveNoUnicastAnswers(m, response, end, dstaddr, dstport, InterfaceID, LLQType, rcode, NSECRecords);
9760
9761 if (McastNSEC3Records)
9762 {
9763 debugf("mDNSCoreReceiveResponse: McastNSEC3Records not used");
9764 FreeNSECRecords(m, McastNSEC3Records);
9765 }
9766 }
9767
9768 // ScheduleWakeup causes all proxy records with WakeUp.HMAC matching mDNSEthAddr 'e' to be deregistered, causing
9769 // multiple wakeup magic packets to be sent if appropriate, and all records to be ultimately freed after a few seconds.
9770 // ScheduleWakeup is called on mDNS record conflicts, ARP conflicts, NDP conflicts, or reception of trigger traffic
9771 // that warrants waking the sleeping host.
9772 // ScheduleWakeup must be called with the lock held (ScheduleWakeupForList uses mDNS_Deregister_internal)
9773
9774 mDNSlocal void ScheduleWakeupForList(mDNS *const m, mDNSInterfaceID InterfaceID, mDNSEthAddr *e, AuthRecord *const thelist)
9775 {
9776 // We need to use the m->CurrentRecord mechanism here when dealing with DuplicateRecords list as
9777 // mDNS_Deregister_internal deregisters duplicate records immediately as they are not used
9778 // to send wakeups or goodbyes. See the comment in that function for more details. To keep it
9779 // simple, we use the same mechanism for both lists.
9780 if (!e->l[0])
9781 {
9782 LogMsg("ScheduleWakeupForList ERROR: Target HMAC is zero");
9783 return;
9784 }
9785 m->CurrentRecord = thelist;
9786 while (m->CurrentRecord)
9787 {
9788 AuthRecord *const rr = m->CurrentRecord;
9789 if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering && mDNSSameEthAddress(&rr->WakeUp.HMAC, e))
9790 {
9791 LogInfo("ScheduleWakeupForList: Scheduling wakeup packets for %s", ARDisplayString(m, rr));
9792 mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
9793 }
9794 if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
9795 m->CurrentRecord = rr->next;
9796 }
9797 }
9798
9799 mDNSlocal void ScheduleWakeup(mDNS *const m, mDNSInterfaceID InterfaceID, mDNSEthAddr *e)
9800 {
9801 if (!e->l[0]) { LogMsg("ScheduleWakeup ERROR: Target HMAC is zero"); return; }
9802 ScheduleWakeupForList(m, InterfaceID, e, m->DuplicateRecords);
9803 ScheduleWakeupForList(m, InterfaceID, e, m->ResourceRecords);
9804 }
9805
9806 mDNSlocal void SPSRecordCallback(mDNS *const m, AuthRecord *const ar, mStatus result)
9807 {
9808 if (result && result != mStatus_MemFree)
9809 LogInfo("SPS Callback %d %s", result, ARDisplayString(m, ar));
9810
9811 if (result == mStatus_NameConflict)
9812 {
9813 mDNS_Lock(m);
9814 LogMsg("%-7s Conflicting mDNS -- waking %.6a %s", InterfaceNameForID(m, ar->resrec.InterfaceID), &ar->WakeUp.HMAC, ARDisplayString(m, ar));
9815 if (ar->WakeUp.HMAC.l[0])
9816 {
9817 SendWakeup(m, ar->resrec.InterfaceID, &ar->WakeUp.IMAC, &ar->WakeUp.password, mDNSfalse); // Send one wakeup magic packet
9818 ScheduleWakeup(m, ar->resrec.InterfaceID, &ar->WakeUp.HMAC); // Schedule all other records with the same owner to be woken
9819 }
9820 mDNS_Unlock(m);
9821 }
9822
9823 if (result == mStatus_NameConflict || result == mStatus_MemFree)
9824 {
9825 m->ProxyRecords--;
9826 mDNSPlatformMemFree(ar);
9827 mDNS_UpdateAllowSleep(m);
9828 }
9829 }
9830
9831 mDNSlocal mDNSu8 *GetValueForMACAddr(mDNSu8 *ptr, mDNSu8 *limit, mDNSEthAddr *eth)
9832 {
9833 int i;
9834 mDNSs8 hval = 0;
9835 int colons = 0;
9836 mDNSu8 val = 0;
9837
9838 for (i = 0; ptr < limit && *ptr != ' ' && i < 17; i++, ptr++)
9839 {
9840 hval = HexVal(*ptr);
9841 if (hval != -1)
9842 {
9843 val <<= 4;
9844 val |= hval;
9845 }
9846 else if (*ptr == ':')
9847 {
9848 if (colons >=5)
9849 {
9850 LogMsg("GetValueForMACAddr: Address malformed colons %d val %d", colons, val);
9851 return mDNSNULL;
9852 }
9853 eth->b[colons] = val;
9854 colons++;
9855 val = 0;
9856 }
9857 }
9858 if (colons != 5)
9859 {
9860 LogMsg("GetValueForMACAddr: Address malformed colons %d", colons);
9861 return mDNSNULL;
9862 }
9863 eth->b[colons] = val;
9864 return ptr;
9865 }
9866
9867 mDNSlocal mDNSu8 *GetValueForIPv6Addr(mDNSu8 *ptr, mDNSu8 *limit, mDNSv6Addr *v6)
9868 {
9869 int hval;
9870 int value;
9871 int numBytes;
9872 int digitsProcessed;
9873 int zeroFillStart;
9874 int numColons;
9875 mDNSu8 v6addr[16];
9876
9877 // RFC 3513: Section 2.2 specifies IPv6 presentation format. The following parsing
9878 // handles both (1) and (2) and does not handle embedded IPv4 addresses.
9879 //
9880 // First forms a address in "v6addr", then expands to fill the zeroes in and returns
9881 // the result in "v6"
9882
9883 numColons = numBytes = value = digitsProcessed = zeroFillStart = 0;
9884 while (ptr < limit && *ptr != ' ')
9885 {
9886 hval = HexVal(*ptr);
9887 if (hval != -1)
9888 {
9889 value <<= 4;
9890 value |= hval;
9891 digitsProcessed = 1;
9892 }
9893 else if (*ptr == ':')
9894 {
9895 if (!digitsProcessed)
9896 {
9897 // If we have already seen a "::", we should not see one more. Handle the special
9898 // case of "::"
9899 if (numColons)
9900 {
9901 // if we never filled any bytes and the next character is space (we have reached the end)
9902 // we are done
9903 if (!numBytes && (ptr + 1) < limit && *(ptr + 1) == ' ')
9904 {
9905 mDNSPlatformMemZero(v6->b, 16);
9906 return ptr + 1;
9907 }
9908 LogMsg("GetValueForIPv6Addr: zeroFillStart non-zero %d", zeroFillStart);
9909 return mDNSNULL;
9910 }
9911
9912 // We processed "::". We need to fill zeroes later. For now, mark the
9913 // point where we will start filling zeroes from.
9914 zeroFillStart = numBytes;
9915 numColons++;
9916 }
9917 else if ((ptr + 1) < limit && *(ptr + 1) == ' ')
9918 {
9919 // We have a trailing ":" i.e., no more characters after ":"
9920 LogMsg("GetValueForIPv6Addr: Trailing colon");
9921 return mDNSNULL;
9922 }
9923 else
9924 {
9925 // For a fully expanded IPv6 address, we fill the 14th and 15th byte outside of this while
9926 // loop below as there is no ":" at the end. Hence, the last two bytes that can possibly
9927 // filled here is 12 and 13.
9928 if (numBytes > 13) { LogMsg("GetValueForIPv6Addr:1: numBytes is %d", numBytes); return mDNSNULL; }
9929
9930 v6addr[numBytes++] = (mDNSu8) ((value >> 8) & 0xFF);
9931 v6addr[numBytes++] = (mDNSu8) (value & 0xFF);
9932 digitsProcessed = value = 0;
9933
9934 // Make sure that we did not fill the 13th and 14th byte above
9935 if (numBytes > 14) { LogMsg("GetValueForIPv6Addr:2: numBytes is %d", numBytes); return mDNSNULL; }
9936 }
9937 }
9938 ptr++;
9939 }
9940
9941 // We should be processing the last set of bytes following the last ":" here
9942 if (!digitsProcessed)
9943 {
9944 LogMsg("GetValueForIPv6Addr: no trailing bytes after colon, numBytes is %d", numBytes);
9945 return mDNSNULL;
9946 }
9947
9948 if (numBytes > 14) { LogMsg("GetValueForIPv6Addr:3: numBytes is %d", numBytes); return mDNSNULL; }
9949 v6addr[numBytes++] = (mDNSu8) ((value >> 8) & 0xFF);
9950 v6addr[numBytes++] = (mDNSu8) (value & 0xFF);
9951
9952 if (zeroFillStart)
9953 {
9954 int i, j, n;
9955 for (i = 0; i < zeroFillStart; i++)
9956 v6->b[i] = v6addr[i];
9957 for (j = i, n = 0; n < 16 - numBytes; j++, n++)
9958 v6->b[j] = 0;
9959 for (; j < 16; i++, j++)
9960 v6->b[j] = v6addr[i];
9961 }
9962 else if (numBytes == 16)
9963 mDNSPlatformMemCopy(v6->b, v6addr, 16);
9964 else
9965 {
9966 LogMsg("GetValueForIPv6addr: Not enough bytes for IPv6 address, numBytes is %d", numBytes);
9967 return mDNSNULL;
9968 }
9969 return ptr;
9970 }
9971
9972 mDNSlocal mDNSu8 *GetValueForIPv4Addr(mDNSu8 *ptr, mDNSu8 *limit, mDNSv4Addr *v4)
9973 {
9974 mDNSu32 val;
9975 int dots = 0;
9976 val = 0;
9977
9978 for ( ; ptr < limit && *ptr != ' '; ptr++)
9979 {
9980 if (*ptr >= '0' && *ptr <= '9')
9981 val = val * 10 + *ptr - '0';
9982 else if (*ptr == '.')
9983 {
9984 if (val > 255 || dots >= 3)
9985 {
9986 LogMsg("GetValueForIPv4Addr: something wrong ptr(%p) %c, limit %p, dots %d", ptr, *ptr, limit, dots);
9987 return mDNSNULL;
9988 }
9989 v4->b[dots++] = val;
9990 val = 0;
9991 }
9992 else
9993 {
9994 // We have a zero at the end and if we reached that, then we are done.
9995 if (*ptr == 0 && ptr == limit - 1 && dots == 3)
9996 {
9997 v4->b[dots] = val;
9998 return ptr + 1;
9999 }
10000 else { LogMsg("GetValueForIPv4Addr: something wrong ptr(%p) %c, limit %p, dots %d", ptr, *ptr, limit, dots); return mDNSNULL; }
10001 }
10002 }
10003 if (dots != 3) { LogMsg("GetValueForIPv4Addr: Address malformed dots %d", dots); return mDNSNULL; }
10004 v4->b[dots] = val;
10005 return ptr;
10006 }
10007
10008 mDNSlocal mDNSu8 *GetValueForKeepalive(mDNSu8 *ptr, mDNSu8 *limit, mDNSu32 *value)
10009 {
10010 mDNSu32 val;
10011
10012 val = 0;
10013 for ( ; ptr < limit && *ptr != ' '; ptr++)
10014 {
10015 if (*ptr < '0' || *ptr > '9')
10016 {
10017 // We have a zero at the end and if we reached that, then we are done.
10018 if (*ptr == 0 && ptr == limit - 1)
10019 {
10020 *value = val;
10021 return ptr + 1;
10022 }
10023 else { LogMsg("GetValueForKeepalive: *ptr %d, ptr %p, limit %p, ptr +1 %d", *ptr, ptr, limit, *(ptr + 1)); return mDNSNULL; }
10024 }
10025 val = val * 10 + *ptr - '0';
10026 }
10027 *value = val;
10028 return ptr;
10029 }
10030
10031 mDNSexport mDNSBool mDNSValidKeepAliveRecord(AuthRecord *rr)
10032 {
10033 mDNSAddr laddr, raddr;
10034 mDNSEthAddr eth;
10035 mDNSIPPort lport, rport;
10036 mDNSu32 timeout, seq, ack;
10037 mDNSu16 win;
10038
10039 if (!mDNS_KeepaliveRecord(&rr->resrec))
10040 {
10041 return mDNSfalse;
10042 }
10043
10044 timeout = seq = ack = 0;
10045 win = 0;
10046 laddr = raddr = zeroAddr;
10047 lport = rport = zeroIPPort;
10048 eth = zeroEthAddr;
10049
10050 mDNS_ExtractKeepaliveInfo(rr, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
10051
10052 if (mDNSAddressIsZero(&laddr) || mDNSIPPortIsZero(lport) ||
10053 mDNSAddressIsZero(&raddr) || mDNSIPPortIsZero(rport) ||
10054 mDNSEthAddressIsZero(eth))
10055 {
10056 return mDNSfalse;
10057 }
10058
10059 return mDNStrue;
10060 }
10061
10062
10063 mDNSlocal void mDNS_ExtractKeepaliveInfo(AuthRecord *ar, mDNSu32 *timeout, mDNSAddr *laddr, mDNSAddr *raddr, mDNSEthAddr *eth, mDNSu32 *seq,
10064 mDNSu32 *ack, mDNSIPPort *lport, mDNSIPPort *rport, mDNSu16 *win)
10065 {
10066 if (ar->resrec.rrtype != kDNSType_NULL)
10067 return;
10068
10069 if (mDNS_KeepaliveRecord(&ar->resrec))
10070 {
10071 int len = ar->resrec.rdlength;
10072 mDNSu8 *ptr = &ar->resrec.rdata->u.txt.c[1];
10073 mDNSu8 *limit = ptr + len - 1; // Exclude the first byte that is the length
10074 mDNSu32 value = 0;
10075
10076 while (ptr < limit)
10077 {
10078 mDNSu8 param = *ptr;
10079 ptr += 2; // Skip the letter and the "="
10080 if (param == 'h')
10081 {
10082 laddr->type = mDNSAddrType_IPv4;
10083 ptr = GetValueForIPv4Addr(ptr, limit, &laddr->ip.v4);
10084 }
10085 else if (param == 'd')
10086 {
10087 raddr->type = mDNSAddrType_IPv4;
10088 ptr = GetValueForIPv4Addr(ptr, limit, &raddr->ip.v4);
10089 }
10090 else if (param == 'H')
10091 {
10092 laddr->type = mDNSAddrType_IPv6;
10093 ptr = GetValueForIPv6Addr(ptr, limit, &laddr->ip.v6);
10094 }
10095 else if (param == 'D')
10096 {
10097 raddr->type = mDNSAddrType_IPv6;
10098 ptr = GetValueForIPv6Addr(ptr, limit, &raddr->ip.v6);
10099 }
10100 else if (param == 'm')
10101 {
10102 ptr = GetValueForMACAddr(ptr, limit, eth);
10103 }
10104 else
10105 {
10106 ptr = GetValueForKeepalive(ptr, limit, &value);
10107 }
10108 if (!ptr) { LogMsg("mDNS_ExtractKeepaliveInfo: Cannot parse\n"); return; }
10109
10110 // Extract everything in network order so that it is easy for sending a keepalive and also
10111 // for matching incoming TCP packets
10112 switch (param)
10113 {
10114 case 't':
10115 *timeout = value;
10116 //if (*timeout < 120) *timeout = 120;
10117 break;
10118 case 'h':
10119 case 'H':
10120 case 'd':
10121 case 'D':
10122 case 'm':
10123 case 'i':
10124 case 'c':
10125 break;
10126 case 'l':
10127 lport->NotAnInteger = swap16((mDNSu16)value);
10128 break;
10129 case 'r':
10130 rport->NotAnInteger = swap16((mDNSu16)value);
10131 break;
10132 case 's':
10133 *seq = swap32(value);
10134 break;
10135 case 'a':
10136 *ack = swap32(value);
10137 break;
10138 case 'w':
10139 *win = swap16((mDNSu16)value);
10140 break;
10141 default:
10142 LogMsg("mDNS_ExtractKeepaliveInfo: unknown value %c\n", param);
10143 ptr = limit;
10144 break;
10145 }
10146 ptr++; // skip the space
10147 }
10148 }
10149 }
10150
10151 // Matches the proxied auth records to the incoming TCP packet and returns the match and its sequence and ack in "rseq" and "rack" so that
10152 // the clients need not retrieve this information from the auth record again.
10153 mDNSlocal AuthRecord* mDNS_MatchKeepaliveInfo(mDNS *const m, const mDNSAddr* pladdr, const mDNSAddr* praddr, const mDNSIPPort plport,
10154 const mDNSIPPort prport, mDNSu32 *rseq, mDNSu32 *rack)
10155 {
10156 AuthRecord *ar;
10157 mDNSAddr laddr, raddr;
10158 mDNSEthAddr eth;
10159 mDNSIPPort lport, rport;
10160 mDNSu32 timeout, seq, ack;
10161 mDNSu16 win;
10162
10163 for (ar = m->ResourceRecords; ar; ar=ar->next)
10164 {
10165 timeout = seq = ack = 0;
10166 win = 0;
10167 laddr = raddr = zeroAddr;
10168 lport = rport = zeroIPPort;
10169
10170 if (!ar->WakeUp.HMAC.l[0]) continue;
10171
10172 mDNS_ExtractKeepaliveInfo(ar, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
10173
10174 // Did we parse correctly ?
10175 if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(&raddr) || !seq || !ack || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport) || !win)
10176 {
10177 debugf("mDNS_MatchKeepaliveInfo: not a valid record %s for keepalive", ARDisplayString(m, ar));
10178 continue;
10179 }
10180
10181 debugf("mDNS_MatchKeepaliveInfo: laddr %#a pladdr %#a, raddr %#a praddr %#a, lport %d plport %d, rport %d prport %d",
10182 &laddr, pladdr, &raddr, praddr, mDNSVal16(lport), mDNSVal16(plport), mDNSVal16(rport), mDNSVal16(prport));
10183
10184 // Does it match the incoming TCP packet ?
10185 if (mDNSSameAddress(&laddr, pladdr) && mDNSSameAddress(&raddr, praddr) && mDNSSameIPPort(lport, plport) && mDNSSameIPPort(rport, prport))
10186 {
10187 // returning in network order
10188 *rseq = seq;
10189 *rack = ack;
10190 return ar;
10191 }
10192 }
10193 return mDNSNULL;
10194 }
10195
10196 mDNSlocal void mDNS_SendKeepalives(mDNS *const m)
10197 {
10198 AuthRecord *ar;
10199
10200 for (ar = m->ResourceRecords; ar; ar=ar->next)
10201 {
10202 mDNSu32 timeout, seq, ack;
10203 mDNSu16 win;
10204 mDNSAddr laddr, raddr;
10205 mDNSEthAddr eth;
10206 mDNSIPPort lport, rport;
10207
10208 timeout = seq = ack = 0;
10209 win = 0;
10210
10211 laddr = raddr = zeroAddr;
10212 lport = rport = zeroIPPort;
10213
10214 if (!ar->WakeUp.HMAC.l[0]) continue;
10215
10216 mDNS_ExtractKeepaliveInfo(ar, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
10217
10218 if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(&raddr) || !seq || !ack || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport) || !win)
10219 {
10220 debugf("mDNS_SendKeepalives: not a valid record %s for keepalive", ARDisplayString(m, ar));
10221 continue;
10222 }
10223 LogMsg("mDNS_SendKeepalives: laddr %#a raddr %#a lport %d rport %d", &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport));
10224
10225 // When we receive a proxy update, we set KATimeExpire to zero so that we always send a keepalive
10226 // immediately (to detect any potential problems). After that we always set it to a non-zero value.
10227 if (!ar->KATimeExpire || (m->timenow - ar->KATimeExpire >= 0))
10228 {
10229 mDNSPlatformSendKeepalive(&laddr, &raddr, &lport, &rport, seq, ack, win);
10230 ar->KATimeExpire = NonZeroTime(m->timenow + timeout * mDNSPlatformOneSecond);
10231 }
10232 if (m->NextScheduledKA - ar->KATimeExpire > 0)
10233 m->NextScheduledKA = ar->KATimeExpire;
10234 }
10235 }
10236
10237 mDNSlocal void mDNS_SendKeepaliveACK(mDNS *const m, AuthRecord *ar)
10238 {
10239 mDNSu32 timeout, seq, ack, seqInc;
10240 mDNSu16 win;
10241 mDNSAddr laddr, raddr;
10242 mDNSEthAddr eth;
10243 mDNSIPPort lport, rport;
10244 mDNSu8 *ptr;
10245
10246 if (ar == mDNSNULL)
10247 {
10248 LogInfo("mDNS_SendKeepalivesACK: AuthRecord is NULL");
10249 return;
10250 }
10251
10252 timeout = seq = ack = 0;
10253 win = 0;
10254
10255 laddr = raddr = zeroAddr;
10256 lport = rport = zeroIPPort;
10257
10258 mDNS_ExtractKeepaliveInfo(ar, &timeout, &laddr, &raddr, &eth, &seq, &ack, &lport, &rport, &win);
10259
10260 if (!timeout || mDNSAddressIsZero(&laddr) || mDNSAddressIsZero(&raddr) || !seq || !ack || mDNSIPPortIsZero(lport) || mDNSIPPortIsZero(rport) || !win)
10261 {
10262 LogInfo("mDNS_SendKeepaliveACK: not a valid record %s for keepalive", ARDisplayString(m, ar));
10263 return;
10264 }
10265
10266 // To send a keepalive ACK, we need to add one to the sequence number from the keepalive
10267 // record, which is the TCP connection's "next" sequence number minus one. Otherwise, the
10268 // keepalive ACK also ends up being a keepalive probe. Also, seq is in network byte order, so
10269 // it's converted to host byte order before incrementing it by one.
10270 ptr = (mDNSu8 *)&seq;
10271 seqInc = (mDNSu32)((ptr[0] << 24) | (ptr[1] << 16) | (ptr[2] << 8) | ptr[3]) + 1;
10272 ptr[0] = (mDNSu8)((seqInc >> 24) & 0xFF);
10273 ptr[1] = (mDNSu8)((seqInc >> 16) & 0xFF);
10274 ptr[2] = (mDNSu8)((seqInc >> 8) & 0xFF);
10275 ptr[3] = (mDNSu8)((seqInc ) & 0xFF);
10276 LogMsg("mDNS_SendKeepaliveACK: laddr %#a raddr %#a lport %d rport %d", &laddr, &raddr, mDNSVal16(lport), mDNSVal16(rport));
10277 mDNSPlatformSendKeepalive(&laddr, &raddr, &lport, &rport, seq, ack, win);
10278 }
10279
10280 mDNSlocal void mDNSCoreReceiveUpdate(mDNS *const m,
10281 const DNSMessage *const msg, const mDNSu8 *end,
10282 const mDNSAddr *srcaddr, const mDNSIPPort srcport, const mDNSAddr *dstaddr, mDNSIPPort dstport,
10283 const mDNSInterfaceID InterfaceID)
10284 {
10285 int i;
10286 AuthRecord opt;
10287 mDNSu8 *p = m->omsg.data;
10288 OwnerOptData owner = zeroOwner; // Need to zero this, so we'll know if this Update packet was missing its Owner option
10289 mDNSu32 updatelease = 0;
10290 const mDNSu8 *ptr;
10291
10292 LogSPS("Received Update from %#-15a:%-5d to %#-15a:%-5d on 0x%p with "
10293 "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes",
10294 srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), InterfaceID,
10295 msg->h.numQuestions, msg->h.numQuestions == 1 ? ", " : "s,",
10296 msg->h.numAnswers, msg->h.numAnswers == 1 ? ", " : "s,",
10297 msg->h.numAuthorities, msg->h.numAuthorities == 1 ? "y, " : "ies,",
10298 msg->h.numAdditionals, msg->h.numAdditionals == 1 ? " " : "s", end - msg->data);
10299
10300 if (!InterfaceID || !m->SPSSocket || !mDNSSameIPPort(dstport, m->SPSSocket->port)) return;
10301
10302 if (mDNS_PacketLoggingEnabled)
10303 DumpPacket(mStatus_NoError, mDNSfalse, "UDP", srcaddr, srcport, dstaddr, dstport, msg, end);
10304
10305 ptr = LocateOptRR(msg, end, DNSOpt_LeaseData_Space + DNSOpt_OwnerData_ID_Space);
10306 if (ptr)
10307 {
10308 ptr = GetLargeResourceRecord(m, msg, ptr, end, 0, kDNSRecordTypePacketAdd, &m->rec);
10309 if (ptr && m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && m->rec.r.resrec.rrtype == kDNSType_OPT)
10310 {
10311 const rdataOPT *o;
10312 const rdataOPT *const e = (const rdataOPT *)&m->rec.r.resrec.rdata->u.data[m->rec.r.resrec.rdlength];
10313 for (o = &m->rec.r.resrec.rdata->u.opt[0]; o < e; o++)
10314 {
10315 if (o->opt == kDNSOpt_Lease) updatelease = o->u.updatelease;
10316 else if (o->opt == kDNSOpt_Owner && o->u.owner.vers == 0) owner = o->u.owner;
10317 }
10318 }
10319 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
10320 }
10321
10322 InitializeDNSMessage(&m->omsg.h, msg->h.id, UpdateRespFlags);
10323
10324 if (!updatelease || !owner.HMAC.l[0])
10325 {
10326 static int msgs = 0;
10327 if (msgs < 100)
10328 {
10329 msgs++;
10330 LogMsg("Refusing sleep proxy registration from %#a:%d:%s%s", srcaddr, mDNSVal16(srcport),
10331 !updatelease ? " No lease" : "", !owner.HMAC.l[0] ? " No owner" : "");
10332 }
10333 m->omsg.h.flags.b[1] |= kDNSFlag1_RC_FormErr;
10334 }
10335 else if (m->ProxyRecords + msg->h.mDNS_numUpdates > MAX_PROXY_RECORDS)
10336 {
10337 static int msgs = 0;
10338 if (msgs < 100)
10339 {
10340 msgs++;
10341 LogMsg("Refusing sleep proxy registration from %#a:%d: Too many records %d + %d = %d > %d", srcaddr, mDNSVal16(srcport),
10342 m->ProxyRecords, msg->h.mDNS_numUpdates, m->ProxyRecords + msg->h.mDNS_numUpdates, MAX_PROXY_RECORDS);
10343 }
10344 m->omsg.h.flags.b[1] |= kDNSFlag1_RC_Refused;
10345 }
10346 else
10347 {
10348 LogSPS("Received Update for H-MAC %.6a I-MAC %.6a Password %.6a seq %d", &owner.HMAC, &owner.IMAC, &owner.password, owner.seq);
10349
10350 if (updatelease > 24 * 60 * 60)
10351 updatelease = 24 * 60 * 60;
10352
10353 if (updatelease > 0x40000000UL / mDNSPlatformOneSecond)
10354 updatelease = 0x40000000UL / mDNSPlatformOneSecond;
10355
10356 ptr = LocateAuthorities(msg, end);
10357
10358 // Clear any stale TCP keepalive records that may exist
10359 ClearKeepaliveProxyRecords(m, &owner, m->DuplicateRecords, InterfaceID);
10360 ClearKeepaliveProxyRecords(m, &owner, m->ResourceRecords, InterfaceID);
10361
10362 for (i = 0; i < msg->h.mDNS_numUpdates && ptr && ptr < end; i++)
10363 {
10364 ptr = GetLargeResourceRecord(m, msg, ptr, end, InterfaceID, kDNSRecordTypePacketAuth, &m->rec);
10365 if (ptr && m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative)
10366 {
10367 mDNSu16 RDLengthMem = GetRDLengthMem(&m->rec.r.resrec);
10368 AuthRecord *ar = mDNSPlatformMemAllocate(sizeof(AuthRecord) - sizeof(RDataBody) + RDLengthMem);
10369 if (!ar)
10370 {
10371 m->omsg.h.flags.b[1] |= kDNSFlag1_RC_Refused;
10372 break;
10373 }
10374 else
10375 {
10376 mDNSu8 RecordType = m->rec.r.resrec.RecordType & kDNSRecordTypePacketUniqueMask ? kDNSRecordTypeUnique : kDNSRecordTypeShared;
10377 m->rec.r.resrec.rrclass &= ~kDNSClass_UniqueRRSet;
10378 // All stale keepalive records have been flushed prior to this loop.
10379 if (!mDNS_KeepaliveRecord(&m->rec.r.resrec))
10380 {
10381 ClearIdenticalProxyRecords(m, &owner, m->DuplicateRecords); // Make sure we don't have any old stale duplicates of this record
10382 ClearIdenticalProxyRecords(m, &owner, m->ResourceRecords);
10383 }
10384 mDNS_SetupResourceRecord(ar, mDNSNULL, InterfaceID, m->rec.r.resrec.rrtype, m->rec.r.resrec.rroriginalttl, RecordType, AuthRecordAny, SPSRecordCallback, ar);
10385 AssignDomainName(&ar->namestorage, m->rec.r.resrec.name);
10386 ar->resrec.rdlength = GetRDLength(&m->rec.r.resrec, mDNSfalse);
10387 ar->resrec.rdata->MaxRDLength = RDLengthMem;
10388 mDNSPlatformMemCopy(ar->resrec.rdata->u.data, m->rec.r.resrec.rdata->u.data, RDLengthMem);
10389 ar->ForceMCast = mDNStrue;
10390 ar->WakeUp = owner;
10391 if (m->rec.r.resrec.rrtype == kDNSType_PTR)
10392 {
10393 mDNSs32 t = ReverseMapDomainType(m->rec.r.resrec.name);
10394 if (t == mDNSAddrType_IPv4) GetIPv4FromName(&ar->AddressProxy, m->rec.r.resrec.name);
10395 else if (t == mDNSAddrType_IPv6) GetIPv6FromName(&ar->AddressProxy, m->rec.r.resrec.name);
10396 debugf("mDNSCoreReceiveUpdate: PTR %d %d %#a %s", t, ar->AddressProxy.type, &ar->AddressProxy, ARDisplayString(m, ar));
10397 if (ar->AddressProxy.type) SetSPSProxyListChanged(InterfaceID);
10398 }
10399 ar->TimeRcvd = m->timenow;
10400 ar->TimeExpire = m->timenow + updatelease * mDNSPlatformOneSecond;
10401 if (m->NextScheduledSPS - ar->TimeExpire > 0)
10402 m->NextScheduledSPS = ar->TimeExpire;
10403 ar->KATimeExpire = 0;
10404 mDNS_Register_internal(m, ar);
10405
10406 m->ProxyRecords++;
10407 mDNS_UpdateAllowSleep(m);
10408 LogSPS("SPS Registered %4d %X %s", m->ProxyRecords, RecordType, ARDisplayString(m,ar));
10409 }
10410 }
10411 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
10412 }
10413
10414 if (m->omsg.h.flags.b[1] & kDNSFlag1_RC_Mask)
10415 {
10416 LogMsg("Refusing sleep proxy registration from %#a:%d: Out of memory", srcaddr, mDNSVal16(srcport));
10417 ClearProxyRecords(m, &owner, m->DuplicateRecords);
10418 ClearProxyRecords(m, &owner, m->ResourceRecords);
10419 }
10420 else
10421 {
10422 mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
10423 opt.resrec.rrclass = NormalMaxDNSMessageData;
10424 opt.resrec.rdlength = sizeof(rdataOPT); // One option in this OPT record
10425 opt.resrec.rdestimate = sizeof(rdataOPT);
10426 opt.resrec.rdata->u.opt[0].opt = kDNSOpt_Lease;
10427 opt.resrec.rdata->u.opt[0].u.updatelease = updatelease;
10428 p = PutResourceRecordTTLWithLimit(&m->omsg, p, &m->omsg.h.numAdditionals, &opt.resrec, opt.resrec.rroriginalttl, m->omsg.data + AbsoluteMaxDNSMessageData);
10429 }
10430 }
10431
10432 if (p) mDNSSendDNSMessage(m, &m->omsg, p, InterfaceID, m->SPSSocket, srcaddr, srcport, mDNSNULL, mDNSNULL, mDNSfalse);
10433 mDNS_SendKeepalives(m);
10434 }
10435
10436 mDNSlocal mDNSu32 mDNSGenerateOwnerOptForInterface(mDNS *const m, const mDNSInterfaceID InterfaceID, DNSMessage *msg)
10437 {
10438 mDNSu8 *ptr = msg->data;
10439 mDNSu8 *end = mDNSNULL;
10440 mDNSu32 length = 0;
10441 AuthRecord opt;
10442 NetworkInterfaceInfo *intf;
10443
10444 mDNS_SetupResourceRecord(&opt, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
10445 opt.resrec.rrclass = NormalMaxDNSMessageData;
10446 opt.resrec.rdlength = sizeof(rdataOPT);
10447 opt.resrec.rdestimate = sizeof(rdataOPT);
10448
10449 intf = FirstInterfaceForID(m, InterfaceID);
10450 SetupOwnerOpt(m, intf, &opt.resrec.rdata->u.opt[0]);
10451
10452 LogSPS("Generated OPT record : %s", ARDisplayString(m, &opt));
10453 end = PutResourceRecord(msg, ptr, &msg->h.numAdditionals, &opt.resrec);
10454 if (end != mDNSNULL)
10455 {
10456 // Put all the integer values in IETF byte-order (MSB first, LSB second)
10457 SwapDNSHeaderBytes(msg);
10458 length = (end - msg->data);
10459 }
10460 else
10461 LogSPS("mDNSGenerateOwnerOptForInterface: Failed to generate owner OPT record");
10462
10463 return length;
10464 }
10465
10466 // Note that this routine is called both for Sleep Proxy Registrations, and for Standard Dynamic
10467 // DNS registrations, but (currently) only has to handle the Sleep Proxy Registration reply case,
10468 // and should ignore Standard Dynamic DNS registration replies, because those are handled elsewhere.
10469 // Really, both should be unified and handled in one place.
10470 mDNSlocal void mDNSCoreReceiveUpdateR(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *end, const mDNSAddr *srcaddr, const mDNSInterfaceID InterfaceID)
10471 {
10472 if (InterfaceID)
10473 {
10474 mDNSu32 pktlease = 0, spsupdates = 0;
10475 const mDNSBool gotlease = GetPktLease(m, msg, end, &pktlease);
10476 const mDNSu32 updatelease = gotlease ? pktlease : 60 * 60; // If SPS fails to indicate lease time, assume one hour
10477 if (gotlease) LogSPS("DNS Update response contains lease option granting %4d seconds, updateid %d, InterfaceID %p", updatelease, mDNSVal16(msg->h.id), InterfaceID);
10478
10479 if (m->CurrentRecord)
10480 LogMsg("mDNSCoreReceiveUpdateR ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
10481 m->CurrentRecord = m->ResourceRecords;
10482 while (m->CurrentRecord)
10483 {
10484 AuthRecord *const rr = m->CurrentRecord;
10485 if (rr->resrec.InterfaceID == InterfaceID || (!rr->resrec.InterfaceID && (rr->ForceMCast || IsLocalDomain(rr->resrec.name))))
10486 if (mDNSSameOpaque16(rr->updateid, msg->h.id))
10487 {
10488 // We successfully completed this record's registration on this "InterfaceID". Clear that bit.
10489 // Clear the updateid when we are done sending on all interfaces.
10490 mDNSu32 scopeid = mDNSPlatformInterfaceIndexfromInterfaceID(m, InterfaceID, mDNStrue);
10491 if (scopeid < (sizeof(rr->updateIntID) * mDNSNBBY))
10492 bit_clr_opaque64(rr->updateIntID, scopeid);
10493 if (mDNSOpaque64IsZero(&rr->updateIntID))
10494 rr->updateid = zeroID;
10495 rr->expire = NonZeroTime(m->timenow + updatelease * mDNSPlatformOneSecond);
10496 spsupdates++;
10497 LogSPS("Sleep Proxy %s record %2d %5d 0x%x 0x%x (%d) %s", rr->WakeUp.HMAC.l[0] ? "transferred" : "registered", spsupdates, updatelease, rr->updateIntID.l[1], rr->updateIntID.l[0], mDNSVal16(rr->updateid), ARDisplayString(m,rr));
10498 if (rr->WakeUp.HMAC.l[0])
10499 {
10500 rr->WakeUp.HMAC = zeroEthAddr; // Clear HMAC so that mDNS_Deregister_internal doesn't waste packets trying to wake this host
10501 rr->RequireGoodbye = mDNSfalse; // and we don't want to send goodbye for it
10502 mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
10503 }
10504 }
10505 // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
10506 // new records could have been added to the end of the list as a result of that call.
10507 if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
10508 m->CurrentRecord = rr->next;
10509 }
10510 if (spsupdates) // Only do this dynamic store stuff if this was, in fact, a Sleep Proxy Update response
10511 {
10512 char *ifname;
10513 mDNSAddr spsaddr;
10514 DNSMessage optMsg;
10515 int length;
10516 // Update the dynamic store with the IP Address and MAC address of the sleep proxy
10517 ifname = InterfaceNameForID(m, InterfaceID);
10518 mDNSPlatformMemCopy(&spsaddr, srcaddr, sizeof (mDNSAddr));
10519 mDNSPlatformStoreSPSMACAddr(&spsaddr, ifname);
10520
10521 // Store the Owner OPT record for this interface.
10522 // Configd may use the OPT record if it detects a conflict with the BSP when the system wakes up
10523 InitializeDNSMessage(&optMsg.h, zeroID, ResponseFlags);
10524 length = mDNSGenerateOwnerOptForInterface(m, InterfaceID, &optMsg);
10525 if (length != 0)
10526 {
10527 length += sizeof(DNSMessageHeader);
10528 mDNSPlatformStoreOwnerOptRecord(ifname, &optMsg, length);
10529 }
10530 }
10531 }
10532 // If we were waiting to go to sleep, then this SPS registration or wide-area record deletion
10533 // may have been the thing we were waiting for, so schedule another check to see if we can sleep now.
10534 if (m->SleepLimit) m->NextScheduledSPRetry = m->timenow;
10535 }
10536
10537 mDNSexport void MakeNegativeCacheRecord(mDNS *const m, CacheRecord *const cr,
10538 const domainname *const name, const mDNSu32 namehash, const mDNSu16 rrtype, const mDNSu16 rrclass, mDNSu32 ttl_seconds, mDNSInterfaceID InterfaceID, DNSServer *dnsserver)
10539 {
10540 if (cr == &m->rec.r && m->rec.r.resrec.RecordType)
10541 LogFatalError("MakeNegativeCacheRecord: m->rec appears to be already in use for %s", CRDisplayString(m, &m->rec.r));
10542
10543 // Create empty resource record
10544 cr->resrec.RecordType = kDNSRecordTypePacketNegative;
10545 cr->resrec.InterfaceID = InterfaceID;
10546 cr->resrec.rDNSServer = dnsserver;
10547 cr->resrec.name = name; // Will be updated to point to cg->name when we call CreateNewCacheEntry
10548 cr->resrec.rrtype = rrtype;
10549 cr->resrec.rrclass = rrclass;
10550 cr->resrec.rroriginalttl = ttl_seconds;
10551 cr->resrec.rdlength = 0;
10552 cr->resrec.rdestimate = 0;
10553 cr->resrec.namehash = namehash;
10554 cr->resrec.rdatahash = 0;
10555 cr->resrec.rdata = (RData*)&cr->smallrdatastorage;
10556 cr->resrec.rdata->MaxRDLength = 0;
10557
10558 cr->NextInKAList = mDNSNULL;
10559 cr->TimeRcvd = m->timenow;
10560 cr->DelayDelivery = 0;
10561 cr->NextRequiredQuery = m->timenow;
10562 cr->CRActiveQuestion = mDNSNULL;
10563 cr->UnansweredQueries = 0;
10564 cr->LastUnansweredTime = 0;
10565 cr->NextInCFList = mDNSNULL;
10566 cr->nsec = mDNSNULL;
10567 cr->soa = mDNSNULL;
10568 cr->CRDNSSECQuestion = 0;
10569 // Initialize to the basic one and the caller can set it to more
10570 // specific based on the response if any
10571 cr->responseFlags = ResponseFlags;
10572 }
10573
10574 mDNSexport void mDNSCoreReceive(mDNS *const m, DNSMessage *const msg, const mDNSu8 *const end,
10575 const mDNSAddr *const srcaddr, const mDNSIPPort srcport, const mDNSAddr *dstaddr, const mDNSIPPort dstport,
10576 const mDNSInterfaceID InterfaceID)
10577 {
10578 mDNSInterfaceID ifid = InterfaceID;
10579 const mDNSu8 *const pkt = (mDNSu8 *)msg;
10580 const mDNSu8 StdQ = kDNSFlag0_QR_Query | kDNSFlag0_OP_StdQuery;
10581 const mDNSu8 StdR = kDNSFlag0_QR_Response | kDNSFlag0_OP_StdQuery;
10582 const mDNSu8 UpdQ = kDNSFlag0_QR_Query | kDNSFlag0_OP_Update;
10583 const mDNSu8 UpdR = kDNSFlag0_QR_Response | kDNSFlag0_OP_Update;
10584 mDNSu8 QR_OP;
10585 mDNSu8 *ptr = mDNSNULL;
10586 mDNSBool TLS = (dstaddr == (mDNSAddr *)1); // For debug logs: dstaddr = 0 means TCP; dstaddr = 1 means TLS
10587 if (TLS) dstaddr = mDNSNULL;
10588
10589 #ifndef UNICAST_DISABLED
10590 if (mDNSSameAddress(srcaddr, &m->Router))
10591 {
10592 #ifdef _LEGACY_NAT_TRAVERSAL_
10593 if (mDNSSameIPPort(srcport, SSDPPort) || (m->SSDPSocket && mDNSSameIPPort(dstport, m->SSDPSocket->port)))
10594 {
10595 mDNS_Lock(m);
10596 LNT_ConfigureRouterInfo(m, InterfaceID, (mDNSu8 *)msg, (mDNSu16)(end - pkt));
10597 mDNS_Unlock(m);
10598 return;
10599 }
10600 #endif
10601 if (mDNSSameIPPort(srcport, NATPMPPort))
10602 {
10603 mDNS_Lock(m);
10604 uDNS_ReceiveNATPacket(m, InterfaceID, (mDNSu8 *)msg, (mDNSu16)(end - pkt));
10605 mDNS_Unlock(m);
10606 return;
10607 }
10608 }
10609 #ifdef _LEGACY_NAT_TRAVERSAL_
10610 else if (m->SSDPSocket && mDNSSameIPPort(dstport, m->SSDPSocket->port)) { debugf("Ignoring SSDP response from %#a:%d", srcaddr, mDNSVal16(srcport)); return; }
10611 #endif
10612
10613 #endif
10614 if ((unsigned)(end - pkt) < sizeof(DNSMessageHeader))
10615 {
10616 LogMsg("DNS Message from %#a:%d to %#a:%d length %d too short", srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), (int)(end - pkt));
10617 return;
10618 }
10619 QR_OP = (mDNSu8)(msg->h.flags.b[0] & kDNSFlag0_QROP_Mask);
10620 // Read the integer parts which are in IETF byte-order (MSB first, LSB second)
10621 ptr = (mDNSu8 *)&msg->h.numQuestions;
10622 msg->h.numQuestions = (mDNSu16)((mDNSu16)ptr[0] << 8 | ptr[1]);
10623 msg->h.numAnswers = (mDNSu16)((mDNSu16)ptr[2] << 8 | ptr[3]);
10624 msg->h.numAuthorities = (mDNSu16)((mDNSu16)ptr[4] << 8 | ptr[5]);
10625 msg->h.numAdditionals = (mDNSu16)((mDNSu16)ptr[6] << 8 | ptr[7]);
10626
10627 if (!m) { LogMsg("mDNSCoreReceive ERROR m is NULL"); return; }
10628
10629 // We use zero addresses and all-ones addresses at various places in the code to indicate special values like "no address"
10630 // If we accept and try to process a packet with zero or all-ones source address, that could really mess things up
10631 if (srcaddr && !mDNSAddressIsValid(srcaddr)) { debugf("mDNSCoreReceive ignoring packet from %#a", srcaddr); return; }
10632
10633 mDNS_Lock(m);
10634 m->PktNum++;
10635 if (mDNSOpaque16IsZero(msg->h.id))
10636 {
10637 m->MPktNum++;
10638 #if APPLE_OSX_mDNSResponder
10639 // Track the number of multicast packets received from a source outside our subnet.
10640 // Check the destination address to avoid accounting for spurious packets that
10641 // comes in with message id zero.
10642 if (!mDNS_AddressIsLocalSubnet(m, InterfaceID, srcaddr) && dstaddr &&
10643 mDNSAddressIsAllDNSLinkGroup(dstaddr))
10644 {
10645 m->RemoteSubnet++;
10646 }
10647 #endif // #if APPLE_OSX_mDNSResponder
10648 }
10649
10650 #ifndef UNICAST_DISABLED
10651 if (!dstaddr || (!mDNSAddressIsAllDNSLinkGroup(dstaddr) && (QR_OP == StdR || QR_OP == UpdR)))
10652 if (!mDNSOpaque16IsZero(msg->h.id)) // uDNS_ReceiveMsg only needs to get real uDNS responses, not "QU" mDNS responses
10653 {
10654 ifid = mDNSInterface_Any;
10655 if (mDNS_PacketLoggingEnabled)
10656 DumpPacket(mStatus_NoError, mDNSfalse, TLS ? "TLS" : !dstaddr ? "TCP" : "UDP", srcaddr, srcport, dstaddr, dstport, msg, end);
10657 uDNS_ReceiveMsg(m, msg, end, srcaddr, srcport);
10658 // Note: mDNSCore also needs to get access to received unicast responses
10659 }
10660 #endif
10661 if (QR_OP == StdQ) mDNSCoreReceiveQuery (m, msg, end, srcaddr, srcport, dstaddr, dstport, ifid);
10662 else if (QR_OP == StdR) mDNSCoreReceiveResponse(m, msg, end, srcaddr, srcport, dstaddr, dstport, ifid);
10663 else if (QR_OP == UpdQ) mDNSCoreReceiveUpdate (m, msg, end, srcaddr, srcport, dstaddr, dstport, InterfaceID);
10664 else if (QR_OP == UpdR) mDNSCoreReceiveUpdateR (m, msg, end, srcaddr, InterfaceID);
10665 else
10666 {
10667 if (mDNS_LoggingEnabled)
10668 {
10669 static int msgCount = 0;
10670 if (msgCount < 1000) {
10671 int i = 0;
10672 msgCount++;
10673 LogInfo("Unknown DNS packet type %02X%02X from %#-15a:%-5d to %#-15a:%-5d length %d on %p (ignored)",
10674 msg->h.flags.b[0], msg->h.flags.b[1], srcaddr, mDNSVal16(srcport), dstaddr, mDNSVal16(dstport), (int)(end - pkt), InterfaceID);
10675 while (i < (int)(end - pkt))
10676 {
10677 char buffer[128];
10678 char *p = buffer + mDNS_snprintf(buffer, sizeof(buffer), "%04X", i);
10679 do if (i < (int)(end - pkt)) p += mDNS_snprintf(p, sizeof(buffer), " %02X", pkt[i]);while (++i & 15);
10680 LogInfo("%s", buffer);
10681 }
10682 }
10683 }
10684 }
10685 // Packet reception often causes a change to the task list:
10686 // 1. Inbound queries can cause us to need to send responses
10687 // 2. Conflicing response packets received from other hosts can cause us to need to send defensive responses
10688 // 3. Other hosts announcing deletion of shared records can cause us to need to re-assert those records
10689 // 4. Response packets that answer questions may cause our client to issue new questions
10690 mDNS_Unlock(m);
10691 }
10692
10693 // ***************************************************************************
10694 #if COMPILER_LIKES_PRAGMA_MARK
10695 #pragma mark -
10696 #pragma mark - Searcher Functions
10697 #endif
10698
10699 // Targets are considered the same if both queries are untargeted, or
10700 // if both are targeted to the same address+port
10701 // (If Target address is zero, TargetPort is undefined)
10702 #define SameQTarget(A,B) (((A)->Target.type == mDNSAddrType_None && (B)->Target.type == mDNSAddrType_None) || \
10703 (mDNSSameAddress(& (A)->Target, & (B)->Target) && mDNSSameIPPort((A)->TargetPort, (B)->TargetPort)))
10704
10705 // SameQuestionKind is true if *both* questions are either multicast or unicast
10706 // TargetQID is used for this determination.
10707 #define SameQuestionKind(A,B) ((mDNSOpaque16IsZero(A) && mDNSOpaque16IsZero(B)) || \
10708 ((!mDNSOpaque16IsZero(A)) && (!mDNSOpaque16IsZero(B))))
10709
10710 // Note: We explicitly disallow making a public query be a duplicate of a private one. This is to avoid the
10711 // circular deadlock where a client does a query for something like "dns-sd -Q _dns-query-tls._tcp.company.com SRV"
10712 // and we have a key for company.com, so we try to locate the private query server for company.com, which necessarily entails
10713 // doing a standard DNS query for the _dns-query-tls._tcp SRV record for company.com. If we make the latter (public) query
10714 // a duplicate of the former (private) query, then it will block forever waiting for an answer that will never come.
10715 //
10716 // We keep SuppressUnusable questions separate so that we can return a quick response to them and not get blocked behind
10717 // the queries that are not marked SuppressUnusable. But if the query is not suppressed, they are treated the same as
10718 // non-SuppressUnusable questions. This should be fine as the goal of SuppressUnusable is to return quickly only if it
10719 // is suppressed. If it is not suppressed, we do try all the DNS servers for valid answers like any other question.
10720 // The main reason for this design is that cache entries point to a *single* question and that question is responsible
10721 // for keeping the cache fresh as long as it is active. Having multiple active question for a single cache entry
10722 // breaks this design principle.
10723 //
10724
10725 // If IsLLQ(Q) is true, it means the question is both:
10726 // (a) long-lived and
10727 // (b) being performed by a unicast DNS long-lived query (either full LLQ, or polling)
10728 // for multicast questions, we don't want to treat LongLived as anything special
10729 #define IsLLQ(Q) ((Q)->LongLived && !mDNSOpaque16IsZero((Q)->TargetQID))
10730 #define IsAWDLIncluded(Q) (((Q)->flags & kDNSServiceFlagsIncludeAWDL) != 0)
10731
10732 mDNSlocal DNSQuestion *FindDuplicateQuestion(const mDNS *const m, const DNSQuestion *const question)
10733 {
10734 DNSQuestion *q;
10735 // Note: A question can only be marked as a duplicate of one that occurs *earlier* in the list.
10736 // This prevents circular references, where two questions are each marked as a duplicate of the other.
10737 // Accordingly, we break out of the loop when we get to 'question', because there's no point searching
10738 // further in the list.
10739 for (q = m->Questions; q && q != question; q=q->next) // Scan our list for another question
10740 if (q->InterfaceID == question->InterfaceID && // with the same InterfaceID,
10741 SameQTarget(q, question) && // and same unicast/multicast target settings
10742 q->qtype == question->qtype && // type,
10743 q->qclass == question->qclass && // class,
10744 IsLLQ(q) == IsLLQ(question) && // and long-lived status matches
10745 (!q->AuthInfo || question->AuthInfo) && // to avoid deadlock, don't make public query dup of a private one
10746 (q->AnonInfo == question->AnonInfo) && // Anonymous query not a dup of normal query
10747 (q->SuppressQuery == question->SuppressQuery) && // Questions that are suppressed/not suppressed
10748 (q->ValidationRequired == question->ValidationRequired) && // Questions that require DNSSEC validation
10749 (q->ValidatingResponse == question->ValidatingResponse) && // Questions that are validating responses using DNSSEC
10750 (q->DisallowPID == question->DisallowPID) && // Disallowing a PID should not affect a PID that is allowed
10751 (q->BrowseThreshold == question->BrowseThreshold) && // browse thresholds must match
10752 q->qnamehash == question->qnamehash &&
10753 (IsAWDLIncluded(q) == IsAWDLIncluded(question)) && // Inclusion of AWDL interface must match
10754 SameQuestionKind(q->TargetQID, question->TargetQID) && // mDNS or uDNS must match
10755 SameDomainName(&q->qname, &question->qname)) // and name
10756 return(q);
10757 return(mDNSNULL);
10758 }
10759
10760 // This is called after a question is deleted, in case other identical questions were being suppressed as duplicates
10761 mDNSlocal void UpdateQuestionDuplicates(mDNS *const m, DNSQuestion *const question)
10762 {
10763 DNSQuestion *q;
10764 DNSQuestion *first = mDNSNULL;
10765
10766 // This is referring to some other question as duplicate. No other question can refer to this
10767 // question as a duplicate.
10768 if (question->DuplicateOf)
10769 {
10770 LogInfo("UpdateQuestionDuplicates: question %p %##s (%s) duplicate of %p %##s (%s)",
10771 question, question->qname.c, DNSTypeName(question->qtype),
10772 question->DuplicateOf, question->DuplicateOf->qname.c, DNSTypeName(question->DuplicateOf->qtype));
10773 return;
10774 }
10775
10776 for (q = m->Questions; q; q=q->next) // Scan our list of questions
10777 if (q->DuplicateOf == question) // To see if any questions were referencing this as their duplicate
10778 {
10779 q->DuplicateOf = first;
10780 if (!first)
10781 {
10782 first = q;
10783 // If q used to be a duplicate, but now is not,
10784 // then inherit the state from the question that's going away
10785 q->LastQTime = question->LastQTime;
10786 q->ThisQInterval = question->ThisQInterval;
10787 q->ExpectUnicastResp = question->ExpectUnicastResp;
10788 q->LastAnswerPktNum = question->LastAnswerPktNum;
10789 q->RecentAnswerPkts = question->RecentAnswerPkts;
10790 q->RequestUnicast = question->RequestUnicast;
10791 q->LastQTxTime = question->LastQTxTime;
10792 q->CNAMEReferrals = question->CNAMEReferrals;
10793 q->nta = question->nta;
10794 q->servAddr = question->servAddr;
10795 q->servPort = question->servPort;
10796 q->qDNSServer = question->qDNSServer;
10797 q->validDNSServers = question->validDNSServers;
10798 q->unansweredQueries = question->unansweredQueries;
10799 q->noServerResponse = question->noServerResponse;
10800 q->triedAllServersOnce = question->triedAllServersOnce;
10801
10802 q->TargetQID = question->TargetQID;
10803 q->LocalSocket = question->LocalSocket;
10804 // No need to close old q->LocalSocket first -- duplicate questions can't have their own sockets
10805
10806 q->state = question->state;
10807 // q->tcp = question->tcp;
10808 q->ReqLease = question->ReqLease;
10809 q->expire = question->expire;
10810 q->ntries = question->ntries;
10811 q->id = question->id;
10812
10813 question->LocalSocket = mDNSNULL;
10814 question->nta = mDNSNULL; // If we've got a GetZoneData in progress, transfer it to the newly active question
10815 // question->tcp = mDNSNULL;
10816
10817 if (q->LocalSocket)
10818 debugf("UpdateQuestionDuplicates transferred LocalSocket pointer for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
10819
10820 if (q->nta)
10821 {
10822 LogInfo("UpdateQuestionDuplicates transferred nta pointer for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
10823 q->nta->ZoneDataContext = q;
10824 }
10825
10826 // Need to work out how to safely transfer this state too -- appropriate context pointers need to be updated or the code will crash
10827 if (question->tcp) LogInfo("UpdateQuestionDuplicates did not transfer tcp pointer");
10828
10829 if (question->state == LLQ_Established)
10830 {
10831 LogInfo("UpdateQuestionDuplicates transferred LLQ state for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
10832 question->state = 0; // Must zero question->state, or mDNS_StopQuery_internal will clean up and cancel our LLQ from the server
10833 }
10834
10835 SetNextQueryTime(m,q);
10836 }
10837 }
10838 }
10839
10840 mDNSexport McastResolver *mDNS_AddMcastResolver(mDNS *const m, const domainname *d, const mDNSInterfaceID interface, mDNSu32 timeout)
10841 {
10842 McastResolver **p = &m->McastResolvers;
10843 McastResolver *tmp = mDNSNULL;
10844
10845 if (!d) d = (const domainname *)"";
10846
10847 LogInfo("mDNS_AddMcastResolver: Adding %##s, InterfaceID %p, timeout %u", d->c, interface, timeout);
10848
10849 mDNS_CheckLock(m);
10850
10851 while (*p) // Check if we already have this {interface, domain} tuple registered
10852 {
10853 if ((*p)->interface == interface && SameDomainName(&(*p)->domain, d))
10854 {
10855 if (!((*p)->flags & McastResolver_FlagDelete)) LogMsg("Note: Mcast Resolver domain %##s (%p) registered more than once", d->c, interface);
10856 (*p)->flags &= ~McastResolver_FlagDelete;
10857 tmp = *p;
10858 *p = tmp->next;
10859 tmp->next = mDNSNULL;
10860 }
10861 else
10862 p=&(*p)->next;
10863 }
10864
10865 if (tmp) *p = tmp; // move to end of list, to ensure ordering from platform layer
10866 else
10867 {
10868 // allocate, add to list
10869 *p = mDNSPlatformMemAllocate(sizeof(**p));
10870 if (!*p) LogMsg("mDNS_AddMcastResolver: ERROR!! - malloc");
10871 else
10872 {
10873 (*p)->interface = interface;
10874 (*p)->flags = McastResolver_FlagNew;
10875 (*p)->timeout = timeout;
10876 AssignDomainName(&(*p)->domain, d);
10877 (*p)->next = mDNSNULL;
10878 }
10879 }
10880 return(*p);
10881 }
10882
10883 mDNSinline mDNSs32 PenaltyTimeForServer(mDNS *m, DNSServer *server)
10884 {
10885 mDNSs32 ptime = 0;
10886 if (server->penaltyTime != 0)
10887 {
10888 ptime = server->penaltyTime - m->timenow;
10889 if (ptime < 0)
10890 {
10891 // This should always be a positive value between 0 and DNSSERVER_PENALTY_TIME
10892 // If it does not get reset in ResetDNSServerPenalties for some reason, we do it
10893 // here
10894 LogMsg("PenaltyTimeForServer: PenaltyTime negative %d, (server penaltyTime %d, timenow %d) resetting the penalty",
10895 ptime, server->penaltyTime, m->timenow);
10896 server->penaltyTime = 0;
10897 ptime = 0;
10898 }
10899 }
10900 return ptime;
10901 }
10902
10903 //Checks to see whether the newname is a better match for the name, given the best one we have
10904 //seen so far (given in bestcount).
10905 //Returns -1 if the newname is not a better match
10906 //Returns 0 if the newname is the same as the old match
10907 //Returns 1 if the newname is a better match
10908 mDNSlocal int BetterMatchForName(const domainname *name, int namecount, const domainname *newname, int newcount,
10909 int bestcount)
10910 {
10911 // If the name contains fewer labels than the new server's domain or the new name
10912 // contains fewer labels than the current best, then it can't possibly be a better match
10913 if (namecount < newcount || newcount < bestcount) return -1;
10914
10915 // If there is no match, return -1 and the caller will skip this newname for
10916 // selection
10917 //
10918 // If we find a match and the number of labels is the same as bestcount, then
10919 // we return 0 so that the caller can do additional logic to pick one of
10920 // the best based on some other factors e.g., penaltyTime
10921 //
10922 // If we find a match and the number of labels is more than bestcount, then we
10923 // return 1 so that the caller can pick this over the old one.
10924 //
10925 // Note: newcount can either be equal or greater than bestcount beause of the
10926 // check above.
10927
10928 if (SameDomainName(SkipLeadingLabels(name, namecount - newcount), newname))
10929 return bestcount == newcount ? 0 : 1;
10930 else
10931 return -1;
10932 }
10933
10934 // Normally, we have McastResolvers for .local, in-addr.arpa and ip6.arpa. But there
10935 // can be queries that can forced to multicast (ForceMCast) even though they don't end in these
10936 // names. In that case, we give a default timeout of 5 seconds
10937 #define DEFAULT_MCAST_TIMEOUT 5
10938 mDNSlocal mDNSu32 GetTimeoutForMcastQuestion(mDNS *m, DNSQuestion *question)
10939 {
10940 McastResolver *curmatch = mDNSNULL;
10941 int bestmatchlen = -1, namecount = CountLabels(&question->qname);
10942 McastResolver *curr;
10943 int bettermatch, currcount;
10944 for (curr = m->McastResolvers; curr; curr = curr->next)
10945 {
10946 currcount = CountLabels(&curr->domain);
10947 bettermatch = BetterMatchForName(&question->qname, namecount, &curr->domain, currcount, bestmatchlen);
10948 // Take the first best match. If there are multiple equally good matches (bettermatch = 0), we take
10949 // the timeout value from the first one
10950 if (bettermatch == 1)
10951 {
10952 curmatch = curr;
10953 bestmatchlen = currcount;
10954 }
10955 }
10956 LogInfo("GetTimeoutForMcastQuestion: question %##s curmatch %p, Timeout %d", question->qname.c, curmatch,
10957 curmatch ? curmatch->timeout : DEFAULT_MCAST_TIMEOUT);
10958 return ( curmatch ? curmatch->timeout : DEFAULT_MCAST_TIMEOUT);
10959 }
10960
10961 // Returns true if it is a Domain Enumeration Query
10962 mDNSexport mDNSBool DomainEnumQuery(const domainname *qname)
10963 {
10964 const mDNSu8 *mDNS_DEQLabels[] = { (const mDNSu8 *)"\001b", (const mDNSu8 *)"\002db", (const mDNSu8 *)"\002lb",
10965 (const mDNSu8 *)"\001r", (const mDNSu8 *)"\002dr", (const mDNSu8 *)mDNSNULL, };
10966 const domainname *d = qname;
10967 const mDNSu8 *label;
10968 int i = 0;
10969
10970 // We need at least 3 labels (DEQ prefix) + one more label to make a meaningful DE query
10971 if (CountLabels(qname) < 4) { debugf("DomainEnumQuery: question %##s, not enough labels", qname->c); return mDNSfalse; }
10972
10973 label = (const mDNSu8 *)d;
10974 while (mDNS_DEQLabels[i] != (const mDNSu8 *)mDNSNULL)
10975 {
10976 if (SameDomainLabel(mDNS_DEQLabels[i], label)) {debugf("DomainEnumQuery: DEQ %##s, label1 match", qname->c); break;}
10977 i++;
10978 }
10979 if (mDNS_DEQLabels[i] == (const mDNSu8 *)mDNSNULL)
10980 {
10981 debugf("DomainEnumQuery: Not a DEQ %##s, label1 mismatch", qname->c);
10982 return mDNSfalse;
10983 }
10984 debugf("DomainEnumQuery: DEQ %##s, label1 match", qname->c);
10985
10986 // CountLabels already verified the number of labels
10987 d = (const domainname *)(d->c + 1 + d->c[0]); // Second Label
10988 label = (const mDNSu8 *)d;
10989 if (!SameDomainLabel(label, (const mDNSu8 *)"\007_dns-sd"))
10990 {
10991 debugf("DomainEnumQuery: Not a DEQ %##s, label2 mismatch", qname->c);
10992 return(mDNSfalse);
10993 }
10994 debugf("DomainEnumQuery: DEQ %##s, label2 match", qname->c);
10995
10996 d = (const domainname *)(d->c + 1 + d->c[0]); // Third Label
10997 label = (const mDNSu8 *)d;
10998 if (!SameDomainLabel(label, (const mDNSu8 *)"\004_udp"))
10999 {
11000 debugf("DomainEnumQuery: Not a DEQ %##s, label3 mismatch", qname->c);
11001 return(mDNSfalse);
11002 }
11003 debugf("DomainEnumQuery: DEQ %##s, label3 match", qname->c);
11004
11005 debugf("DomainEnumQuery: Question %##s is a Domain Enumeration query", qname->c);
11006
11007 return mDNStrue;
11008 }
11009
11010 // Note: InterfaceID is the InterfaceID of the question
11011 mDNSlocal mDNSBool DNSServerMatch(DNSServer *d, mDNSInterfaceID InterfaceID, mDNSs32 ServiceID)
11012 {
11013 // 1) Unscoped questions (NULL InterfaceID) should consider *only* unscoped DNSServers ( DNSServer
11014 // with "scoped" set to kScopeNone)
11015 //
11016 // 2) Scoped questions (non-NULL InterfaceID) should consider *only* scoped DNSServers (DNSServer
11017 // with "scoped" set to kScopeInterfaceId) and their InterfaceIDs should match.
11018 //
11019 // 3) Scoped questions (non-zero ServiceID) should consider *only* scoped DNSServers (DNSServer
11020 // with "scoped" set to kScopeServiceID) and their ServiceIDs should match.
11021 //
11022 // The first condition in the "if" statement checks to see if both the question and the DNSServer are
11023 // unscoped. The question is unscoped only if InterfaceID is zero and ServiceID is -1.
11024 //
11025 // If the first condition fails, following are the possible cases (the notes below are using
11026 // InterfaceID for discussion and the same holds good for ServiceID):
11027 //
11028 // - DNSServer is not scoped, InterfaceID is not NULL - we should skip the current DNSServer entry
11029 // as scoped questions should not pick non-scoped DNSServer entry (Refer to (2) above).
11030 //
11031 // - DNSServer is scoped, InterfaceID is NULL - we should skip the current DNSServer entry as
11032 // unscoped question should not match scoped DNSServer (Refer to (1) above). The InterfaceID check
11033 // would fail in this case.
11034 //
11035 // - DNSServer is scoped and InterfaceID is not NULL - the InterfaceID of the question and the DNSServer
11036 // should match (Refer to (2) above).
11037 //
11038 // Note: mDNSInterface_Unicast is used only by .local unicast questions and are treated as unscoped.
11039 // If a question is scoped both to InterfaceID and ServiceID, the question will be scoped to InterfaceID.
11040
11041 if (((d->scoped == kScopeNone) && ((!InterfaceID && ServiceID == -1) || InterfaceID == mDNSInterface_Unicast)) ||
11042 ((d->scoped == kScopeInterfaceID) && d->interface == InterfaceID) ||
11043 ((d->scoped == kScopeServiceID) && d->serviceID == ServiceID))
11044 {
11045 return mDNStrue;
11046 }
11047 return mDNSfalse;
11048 }
11049
11050 // Sets all the Valid DNS servers for a question
11051 mDNSexport mDNSu32 SetValidDNSServers(mDNS *m, DNSQuestion *question)
11052 {
11053 int bestmatchlen = -1, namecount = CountLabels(&question->qname);
11054 DNSServer *curr;
11055 int bettermatch, currcount;
11056 int index = 0;
11057 mDNSu32 timeout = 0;
11058 mDNSBool DEQuery;
11059
11060 question->validDNSServers = zeroOpaque128;
11061 DEQuery = DomainEnumQuery(&question->qname);
11062 for (curr = m->DNSServers; curr; curr = curr->next)
11063 {
11064 debugf("SetValidDNSServers: Parsing DNS server Address %#a (Domain %##s), Scope: %d", &curr->addr, curr->domain.c, curr->scoped);
11065 // skip servers that will soon be deleted
11066 if (curr->flags & DNSServer_FlagDelete)
11067 {
11068 debugf("SetValidDNSServers: Delete set for index %d, DNS server %#a (Domain %##s), scoped %d", index, &curr->addr, curr->domain.c, curr->scoped);
11069 continue;
11070 }
11071
11072 // This happens normally when you unplug the interface where we reset the interfaceID to mDNSInterface_Any for all
11073 // the DNS servers whose scope match the interfaceID. Few seconds later, we also receive the updated DNS configuration.
11074 // But any questions that has mDNSInterface_Any scope that are started/restarted before we receive the update
11075 // (e.g., CheckSuppressUnusableQuestions is called when interfaces are deregistered with the core) should not
11076 // match the scoped entries by mistake.
11077 //
11078 // Note: DNS configuration change will help pick the new dns servers but currently it does not affect the timeout
11079
11080 // Skip DNSServers that are InterfaceID Scoped but have no valid interfaceid set OR DNSServers that are ServiceID Scoped but have no valid serviceid set
11081 if ((curr->scoped == kScopeInterfaceID && curr->interface == mDNSInterface_Any) || (curr->scoped == kScopeServiceID && curr->serviceID <= 0))
11082 {
11083 LogInfo("SetValidDNSServers: ScopeType[%d] Skipping DNS server %#a (Domain %##s) Interface:[%p] Serviceid:[%d]", curr->scoped, &curr->addr, curr->domain.c, curr->interface, curr->serviceID);
11084 continue;
11085 }
11086
11087 currcount = CountLabels(&curr->domain);
11088 if ((!curr->cellIntf || (!DEQuery && !(question->flags & kDNSServiceFlagsDenyCellular))) &&
11089 (!curr->isExpensive || !(question->flags & kDNSServiceFlagsDenyExpensive)) &&
11090 DNSServerMatch(curr, question->InterfaceID, question->ServiceID))
11091 {
11092 bettermatch = BetterMatchForName(&question->qname, namecount, &curr->domain, currcount, bestmatchlen);
11093
11094 // If we found a better match (bettermatch == 1) then clear all the bits
11095 // corresponding to the old DNSServers that we have may set before and start fresh.
11096 // If we find an equal match, then include that DNSServer also by setting the corresponding
11097 // bit
11098 if ((bettermatch == 1) || (bettermatch == 0))
11099 {
11100 bestmatchlen = currcount;
11101 if (bettermatch)
11102 {
11103 debugf("SetValidDNSServers: Resetting all the bits");
11104 question->validDNSServers = zeroOpaque128;
11105 timeout = 0;
11106 }
11107 debugf("SetValidDNSServers: question %##s Setting the bit for DNS server Address %#a (Domain %##s), Scoped:%d index %d,"
11108 " Timeout %d, interface %p", question->qname.c, &curr->addr, curr->domain.c, curr->scoped, index, curr->timeout,
11109 curr->interface);
11110 timeout += curr->timeout;
11111 if (DEQuery)
11112 debugf("DomainEnumQuery: Question %##s, DNSServer %#a, cell %d", question->qname.c, &curr->addr, curr->cellIntf);
11113 bit_set_opaque128(question->validDNSServers, index);
11114 }
11115 }
11116 index++;
11117 }
11118 question->noServerResponse = 0;
11119
11120 debugf("SetValidDNSServers: ValidDNSServer bits 0x%x%x%x%x for question %p %##s (%s)",
11121 question->validDNSServers.l[3], question->validDNSServers.l[2], question->validDNSServers.l[1], question->validDNSServers.l[0], question, question->qname.c, DNSTypeName(question->qtype));
11122 // If there are no matching resolvers, then use the default timeout value.
11123 // For ProxyQuestion, shorten the timeout so that dig does not timeout on us in case of no response.
11124 return ((question->ProxyQuestion || question->ValidatingResponse) ? DEFAULT_UDNSSEC_TIMEOUT : timeout ? timeout : DEFAULT_UDNS_TIMEOUT);
11125 }
11126
11127 // Get the Best server that matches a name. If you find penalized servers, look for the one
11128 // that will come out of the penalty box soon
11129 mDNSlocal DNSServer *GetBestServer(mDNS *m, const domainname *name, mDNSInterfaceID InterfaceID, mDNSs32 ServiceID, mDNSOpaque128 validBits,
11130 int *selected, mDNSBool nameMatch)
11131 {
11132 DNSServer *curmatch = mDNSNULL;
11133 int bestmatchlen = -1, namecount = name ? CountLabels(name) : 0;
11134 DNSServer *curr;
11135 mDNSs32 bestPenaltyTime, currPenaltyTime;
11136 int bettermatch, currcount;
11137 int index = 0;
11138 int currindex = -1;
11139
11140 debugf("GetBestServer: ValidDNSServer bits 0x%x%x", validBits.l[1], validBits.l[0]);
11141 bestPenaltyTime = DNSSERVER_PENALTY_TIME + 1;
11142 for (curr = m->DNSServers; curr; curr = curr->next)
11143 {
11144 // skip servers that will soon be deleted
11145 if (curr->flags & DNSServer_FlagDelete)
11146 {
11147 debugf("GetBestServer: Delete set for index %d, DNS server %#a (Domain %##s), scoped %d", index, &curr->addr, curr->domain.c, curr->scoped);
11148 continue;
11149 }
11150
11151 // Check if this is a valid DNSServer
11152 if (!bit_get_opaque64(validBits, index))
11153 {
11154 debugf("GetBestServer: continuing for index %d", index);
11155 index++;
11156 continue;
11157 }
11158
11159 currcount = CountLabels(&curr->domain);
11160 currPenaltyTime = PenaltyTimeForServer(m, curr);
11161
11162 debugf("GetBestServer: Address %#a (Domain %##s), PenaltyTime(abs) %d, PenaltyTime(rel) %d",
11163 &curr->addr, curr->domain.c, curr->penaltyTime, currPenaltyTime);
11164
11165 // If there are multiple best servers for a given question, we will pick the first one
11166 // if none of them are penalized. If some of them are penalized in that list, we pick
11167 // the least penalized one. BetterMatchForName walks through all best matches and
11168 // "currPenaltyTime < bestPenaltyTime" check lets us either pick the first best server
11169 // in the list when there are no penalized servers and least one among them
11170 // when there are some penalized servers.
11171
11172 if (DNSServerMatch(curr, InterfaceID, ServiceID))
11173 {
11174
11175 // If we know that all the names are already equally good matches, then skip calling BetterMatchForName.
11176 // This happens when we initially walk all the DNS servers and set the validity bit on the question.
11177 // Actually we just need PenaltyTime match, but for the sake of readability we just skip the expensive
11178 // part and still do some redundant steps e.g., InterfaceID match
11179
11180 if (nameMatch)
11181 bettermatch = BetterMatchForName(name, namecount, &curr->domain, currcount, bestmatchlen);
11182 else
11183 bettermatch = 0;
11184
11185 // If we found a better match (bettermatch == 1) then we don't need to
11186 // compare penalty times. But if we found an equal match, then we compare
11187 // the penalty times to pick a better match
11188
11189 if ((bettermatch == 1) || ((bettermatch == 0) && currPenaltyTime < bestPenaltyTime))
11190 {
11191 currindex = index;
11192 curmatch = curr;
11193 bestmatchlen = currcount;
11194 bestPenaltyTime = currPenaltyTime;
11195 }
11196 }
11197 index++;
11198 }
11199 if (selected) *selected = currindex;
11200 return curmatch;
11201 }
11202
11203 // Look up a DNS Server, matching by name and InterfaceID
11204 mDNSlocal DNSServer *GetServerForName(mDNS *m, const domainname *name, mDNSInterfaceID InterfaceID, mDNSs32 ServiceID)
11205 {
11206 DNSServer *curmatch = mDNSNULL;
11207 char *ifname = mDNSNULL; // for logging purposes only
11208 mDNSOpaque128 allValid;
11209
11210 if ((InterfaceID == mDNSInterface_Unicast) || (InterfaceID == mDNSInterface_LocalOnly))
11211 InterfaceID = mDNSNULL;
11212
11213 if (InterfaceID) ifname = InterfaceNameForID(m, InterfaceID);
11214
11215 // By passing in all ones, we make sure that every DNS server is considered
11216 allValid.l[0] = allValid.l[1] = allValid.l[2] = allValid.l[3] = 0xFFFFFFFF;
11217
11218 curmatch = GetBestServer(m, name, InterfaceID, ServiceID, allValid, mDNSNULL, mDNStrue);
11219
11220 if (curmatch != mDNSNULL)
11221 LogInfo("GetServerForName: DNS server %#a:%d (Penalty Time Left %d) (Scope %s:%p) for %##s", &curmatch->addr,
11222 mDNSVal16(curmatch->port), (curmatch->penaltyTime ? (curmatch->penaltyTime - m->timenow) : 0), ifname ? ifname : "None",
11223 InterfaceID, name);
11224 else
11225 LogInfo("GetServerForName: no DNS server (Scope %s:%p) for %##s", ifname ? ifname : "None", InterfaceID, name);
11226
11227 return(curmatch);
11228 }
11229
11230 // Look up a DNS Server for a question within its valid DNSServer bits
11231 mDNSexport DNSServer *GetServerForQuestion(mDNS *m, DNSQuestion *question)
11232 {
11233 DNSServer *curmatch = mDNSNULL;
11234 char *ifname = mDNSNULL; // for logging purposes only
11235 mDNSInterfaceID InterfaceID = question->InterfaceID;
11236 const domainname *name = &question->qname;
11237 int currindex;
11238
11239 if ((InterfaceID == mDNSInterface_Unicast) || (InterfaceID == mDNSInterface_LocalOnly))
11240 InterfaceID = mDNSNULL;
11241
11242 if (InterfaceID)
11243 ifname = InterfaceNameForID(m, InterfaceID);
11244
11245 if (!mDNSOpaque128IsZero(&question->validDNSServers))
11246 {
11247 curmatch = GetBestServer(m, name, InterfaceID, question->ServiceID, question->validDNSServers, &currindex, mDNSfalse);
11248 if (currindex != -1)
11249 bit_clr_opaque128(question->validDNSServers, currindex);
11250 }
11251
11252 if (curmatch != mDNSNULL)
11253 {
11254 LogInfo("GetServerForQuestion: %p DNS server (%p) %#a:%d (Penalty Time Left %d) (Scope %s:%p:%d) for %##s (%s)",
11255 question, curmatch, &curmatch->addr, mDNSVal16(curmatch->port),
11256 (curmatch->penaltyTime ? (curmatch->penaltyTime - m->timenow) : 0), ifname ? ifname : "None",
11257 InterfaceID, question->ServiceID, name, DNSTypeName(question->qtype));
11258 }
11259 else
11260 {
11261 LogInfo("GetServerForQuestion: %p no DNS server (Scope %s:%p:%d) for %##s (%s)",
11262 question, ifname ? ifname : "None", InterfaceID, question->ServiceID, name, DNSTypeName(question->qtype));
11263 }
11264
11265 return(curmatch);
11266 }
11267
11268
11269 #define ValidQuestionTarget(Q) (((Q)->Target.type == mDNSAddrType_IPv4 || (Q)->Target.type == mDNSAddrType_IPv6) && \
11270 (mDNSSameIPPort((Q)->TargetPort, UnicastDNSPort) || mDNSSameIPPort((Q)->TargetPort, MulticastDNSPort)))
11271
11272 // Called in normal client context (lock not held)
11273 mDNSlocal void LLQNATCallback(mDNS *m, NATTraversalInfo *n)
11274 {
11275 DNSQuestion *q;
11276 mDNS_Lock(m);
11277 LogInfo("LLQNATCallback external address:port %.4a:%u, NAT result %d", &n->ExternalAddress, mDNSVal16(n->ExternalPort), n->Result);
11278 n->clientContext = mDNSNULL; // we received at least one callback since starting this NAT-T
11279 for (q = m->Questions; q; q=q->next)
11280 if (ActiveQuestion(q) && !mDNSOpaque16IsZero(q->TargetQID) && q->LongLived)
11281 startLLQHandshake(m, q); // If ExternalPort is zero, will do StartLLQPolling instead
11282 #if APPLE_OSX_mDNSResponder
11283 UpdateAutoTunnelDomainStatuses(m);
11284 #endif
11285 mDNS_Unlock(m);
11286 }
11287
11288 mDNSlocal mDNSBool IsPrivateDomain(mDNS *const m, DNSQuestion *q)
11289 {
11290 DomainAuthInfo *AuthInfo;
11291 // Skip Private domains as we have special addresses to get the hosts in the Private domain
11292 AuthInfo = GetAuthInfoForName_internal(m, &q->qname);
11293 if (AuthInfo && !AuthInfo->deltime && AuthInfo->AutoTunnel)
11294 {
11295 debugf("IsPrivateDomain: %##s true", q->qname.c);
11296 return mDNStrue;
11297 }
11298 else
11299 {
11300 debugf("IsPrivateDomain: %##s false", q->qname.c);
11301 return mDNSfalse;
11302 }
11303 }
11304
11305 // This function takes the DNSServer as a separate argument because sometimes the
11306 // caller has not yet assigned the DNSServer, but wants to evaluate the SuppressQuery
11307 // status before switching to it.
11308 mDNSlocal mDNSBool ShouldSuppressUnicastQuery(mDNS *const m, DNSQuestion *q, DNSServer *d)
11309 {
11310 // Some callers don't check for the qtype
11311 if (q->qtype != kDNSType_A && q->qtype != kDNSType_AAAA)
11312 {
11313 LogDebug("ShouldSuppressUnicastQuery: Query not suppressed for %##s, qtype %s, not A/AAAA type", q->qname.c, DNSTypeName(q->qtype));
11314 return mDNSfalse;
11315 }
11316
11317 // Private domains are exempted irrespective of what the DNSServer says
11318 if (IsPrivateDomain(m, q))
11319 {
11320 LogDebug("ShouldSuppressUnicastQuery: Query not suppressed for %##s, qtype %s, Private Domain", q->qname.c, DNSTypeName(q->qtype));
11321 return mDNSfalse;
11322 }
11323
11324 if (!d)
11325 {
11326 LogInfo("ShouldSuppressUnicastQuery: Query suppressed for %##s, qtype %s, as the DNS server is NULL", q->qname.c, DNSTypeName(q->qtype));
11327 return mDNStrue;
11328 }
11329
11330 // Check if the DNS Configuration allows A/AAAA queries to be sent
11331 if ((q->qtype == kDNSType_A) && (d->req_A))
11332 {
11333 LogDebug("ShouldSuppressUnicastQuery: Query not suppressed for %##s, qtype %s, DNSServer %##s %#a:%d allows A queries", q->qname.c,
11334 DNSTypeName(q->qtype), d->domain.c, &d->addr, mDNSVal16(d->port));
11335 return mDNSfalse;
11336 }
11337 if ((q->qtype == kDNSType_AAAA) && (d->req_AAAA))
11338 {
11339 LogDebug("ShouldSuppressUnicastQuery: Query not suppressed for %##s, qtype %s, DNSServer %##s %#a:%d allows AAAA queries", q->qname.c,
11340 DNSTypeName(q->qtype), d->domain.c, &d->addr, mDNSVal16(d->port));
11341 return mDNSfalse;
11342 }
11343 #if USE_DNS64
11344 if (DNS64IsQueryingARecord(q->dns64.state))
11345 {
11346 LogDebug("ShouldSuppressUnicastQuery: DNS64 query not suppressed for %##s, qtype %s", q->qname.c, DNSTypeName(q->qtype));
11347 return mDNSfalse;
11348 }
11349 #endif
11350
11351 LogInfo("ShouldSuppressUnicastQuery: Query suppressed for %##s, qtype %s, since DNS Configuration does not allow (req_A is %s and req_AAAA is %s)",
11352 q->qname.c, DNSTypeName(q->qtype), d->req_A ? "true" : "false", d->req_AAAA ? "true" : "false");
11353
11354 return mDNStrue;
11355 }
11356
11357 mDNSlocal mDNSBool ShouldSuppressDotLocalQuery(mDNS *const m, DNSQuestion *q)
11358 {
11359 NetworkInterfaceInfo *intf;
11360 AuthRecord *rr;
11361 mDNSBool ret;
11362
11363 // Check to see if there is at least one interface other than loopback and don't suppress
11364 // .local questions if you find one. If we have at least one interface, it means that
11365 // we can send unicast queries for the .local name and we don't want to suppress
11366 // multicast in that case as upper layers don't know how to handle if we return a
11367 // negative response for multicast followed by a positive response for unicast.
11368 //
11369 // Note: we used to check for multicast capable interfaces instead of just any interface
11370 // present. That did not work in the case where we have a valid interface for unicast
11371 // but not multicast capable e.g., cellular, as we ended up delivering a negative response
11372 // first and the upper layer did not wait for the positive response that came later.
11373 for (intf = m->HostInterfaces; intf; intf = intf->next)
11374 {
11375 if (intf->InterfaceActive && !intf->Loopback)
11376 {
11377 LogInfo("ShouldSuppressDotLocalQuery: Found interface %s, not suppressing", intf->ifname);
11378 return mDNSfalse;
11379 }
11380 }
11381
11382 // 1. If we find a LocalOnly or P2P record answering this question, then don't suppress it.
11383 // Set m->CurrentQuestion as it is required by AnswerQuestionWithLORecord.
11384 m->CurrentQuestion = q;
11385 ret = AnswerQuestionWithLORecord(m, q, mDNStrue);
11386 m->CurrentQuestion = mDNSNULL;
11387
11388 if (ret)
11389 {
11390 LogInfo("ShouldSuppressDotLocalQuery: Found LocalOnly record for %##s (%s), not suppressing", q->qname.c,
11391 DNSTypeName(q->qtype));
11392 return mDNSfalse;
11393 }
11394
11395 // 2. If we find a local AuthRecord answering this question, then don't suppress it.
11396 for (rr = m->ResourceRecords; rr; rr = rr->next)
11397 {
11398 if (ResourceRecordAnswersQuestion(&rr->resrec, q))
11399 {
11400 LogInfo("ShouldSuppressDotLocalQuery: Found resource record %s for %##s (%s) not suppressing", ARDisplayString(m, rr),
11401 q->qname.c, DNSTypeName(q->qtype));
11402 return mDNSfalse;
11403 }
11404 }
11405 return mDNStrue;
11406 }
11407
11408 mDNSlocal mDNSBool ShouldSuppressQuery(mDNS *const m, DNSQuestion *q)
11409 {
11410 if (q->InterfaceID == mDNSInterface_LocalOnly)
11411 {
11412 LogInfo("ShouldSuppressQuery: LocalOnly query not suppressed for %##s, qtype %s", q->qname.c, DNSTypeName(q->qtype));
11413 return mDNSfalse;
11414 }
11415
11416 if (q->qtype != kDNSType_A && q->qtype != kDNSType_AAAA)
11417 {
11418 LogInfo("ShouldSuppressQuery: Query not suppressed for %##s, qtype %s, not A/AAAA type", q->qname.c, DNSTypeName(q->qtype));
11419 return mDNSfalse;
11420 }
11421
11422 // We still want the ability to be able to listen to the local services and hence
11423 // don't fail .local query if we have local records that can potentially answer
11424 // the question.
11425 if (q->InterfaceID != mDNSInterface_Unicast && IsLocalDomain(&q->qname))
11426 {
11427 if (!ShouldSuppressDotLocalQuery(m, q))
11428 {
11429 LogInfo("ShouldSuppressQuery: Query not suppressed for %##s, qtype %s, Local question", q->qname.c, DNSTypeName(q->qtype));
11430 return mDNSfalse;
11431 }
11432 else
11433 {
11434 LogInfo("ShouldSuppressQuery: Query suppressed for %##s, qtype %s, Local question", q->qname.c, DNSTypeName(q->qtype));
11435 return mDNStrue;
11436 }
11437 }
11438
11439 return (ShouldSuppressUnicastQuery(m, q, q->qDNSServer));
11440 }
11441
11442 mDNSlocal void CacheRecordRmvEventsForCurrentQuestion(mDNS *const m, DNSQuestion *q)
11443 {
11444 CacheRecord *rr;
11445 CacheGroup *cg;
11446
11447 cg = CacheGroupForName(m, q->qnamehash, &q->qname);
11448 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
11449 {
11450 // Don't deliver RMV events for negative records
11451 if (rr->resrec.RecordType == kDNSRecordTypePacketNegative)
11452 {
11453 LogInfo("CacheRecordRmvEventsForCurrentQuestion: CacheRecord %s Suppressing RMV events for question %p %##s (%s), CRActiveQuestion %p, CurrentAnswers %d",
11454 CRDisplayString(m, rr), q, q->qname.c, DNSTypeName(q->qtype), rr->CRActiveQuestion, q->CurrentAnswers);
11455 continue;
11456 }
11457
11458 if (SameNameRecordAnswersQuestion(&rr->resrec, q))
11459 {
11460 LogInfo("CacheRecordRmvEventsForCurrentQuestion: Calling AnswerCurrentQuestionWithResourceRecord (RMV) for question %##s using resource record %s LocalAnswers %d",
11461 q->qname.c, CRDisplayString(m, rr), q->LOAddressAnswers);
11462
11463 q->CurrentAnswers--;
11464 if (rr->resrec.rdlength > SmallRecordLimit) q->LargeAnswers--;
11465 if (rr->resrec.RecordType & kDNSRecordTypePacketUniqueMask) q->UniqueAnswers--;
11466
11467 if (rr->CRActiveQuestion == q)
11468 {
11469 DNSQuestion *qptr;
11470 // If this was the active question for this cache entry, it was the one that was
11471 // responsible for keeping the cache entry fresh when the cache entry was reaching
11472 // its expiry. We need to handover the responsibility to someone else. Otherwise,
11473 // when the cache entry is about to expire, we won't find an active question
11474 // (pointed by CRActiveQuestion) to refresh the cache.
11475 for (qptr = m->Questions; qptr; qptr=qptr->next)
11476 if (qptr != q && ActiveQuestion(qptr) && ResourceRecordAnswersQuestion(&rr->resrec, qptr))
11477 break;
11478
11479 if (qptr)
11480 LogInfo("CacheRecordRmvEventsForCurrentQuestion: Updating CRActiveQuestion to %p for cache record %s, "
11481 "Original question CurrentAnswers %d, new question CurrentAnswers %d, SuppressUnusable %d, SuppressQuery %d",
11482 qptr, CRDisplayString(m,rr), q->CurrentAnswers, qptr->CurrentAnswers, qptr->SuppressUnusable, qptr->SuppressQuery);
11483
11484 rr->CRActiveQuestion = qptr; // Question used to be active; new value may or may not be null
11485 if (!qptr) m->rrcache_active--; // If no longer active, decrement rrcache_active count
11486 }
11487 AnswerCurrentQuestionWithResourceRecord(m, rr, QC_rmv);
11488 if (m->CurrentQuestion != q) break; // If callback deleted q, then we're finished here
11489 }
11490 }
11491 }
11492
11493 mDNSlocal mDNSBool IsQuestionNew(mDNS *const m, DNSQuestion *question)
11494 {
11495 DNSQuestion *q;
11496 for (q = m->NewQuestions; q; q = q->next)
11497 if (q == question) return mDNStrue;
11498 return mDNSfalse;
11499 }
11500
11501 mDNSlocal mDNSBool LocalRecordRmvEventsForQuestion(mDNS *const m, DNSQuestion *q)
11502 {
11503 AuthRecord *rr;
11504 AuthGroup *ag;
11505
11506 if (m->CurrentQuestion)
11507 LogMsg("LocalRecordRmvEventsForQuestion: ERROR m->CurrentQuestion already set: %##s (%s)",
11508 m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
11509
11510 if (IsQuestionNew(m, q))
11511 {
11512 LogInfo("LocalRecordRmvEventsForQuestion: New Question %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
11513 return mDNStrue;
11514 }
11515 m->CurrentQuestion = q;
11516 ag = AuthGroupForName(&m->rrauth, q->qnamehash, &q->qname);
11517 if (ag)
11518 {
11519 for (rr = ag->members; rr; rr=rr->next)
11520 // Filter the /etc/hosts records - LocalOnly, Unique, A/AAAA/CNAME
11521 if (UniqueLocalOnlyRecord(rr) && LocalOnlyRecordAnswersQuestion(rr, q))
11522 {
11523 LogInfo("LocalRecordRmvEventsForQuestion: Delivering possible Rmv events with record %s",
11524 ARDisplayString(m, rr));
11525 if (q->CurrentAnswers <= 0 || q->LOAddressAnswers <= 0)
11526 {
11527 LogMsg("LocalRecordRmvEventsForQuestion: ERROR!! CurrentAnswers or LOAddressAnswers is zero %p %##s"
11528 " (%s) CurrentAnswers %d, LOAddressAnswers %d", q, q->qname.c, DNSTypeName(q->qtype),
11529 q->CurrentAnswers, q->LOAddressAnswers);
11530 continue;
11531 }
11532 AnswerLocalQuestionWithLocalAuthRecord(m, rr, QC_rmv); // MUST NOT dereference q again
11533 if (m->CurrentQuestion != q) { m->CurrentQuestion = mDNSNULL; return mDNSfalse; }
11534 }
11535 }
11536 m->CurrentQuestion = mDNSNULL;
11537 return mDNStrue;
11538 }
11539
11540 // Returns false if the question got deleted while delivering the RMV events
11541 // The caller should handle the case
11542 mDNSexport mDNSBool CacheRecordRmvEventsForQuestion(mDNS *const m, DNSQuestion *q)
11543 {
11544 if (m->CurrentQuestion)
11545 LogMsg("CacheRecordRmvEventsForQuestion: ERROR m->CurrentQuestion already set: %##s (%s)",
11546 m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
11547
11548 // If it is a new question, we have not delivered any ADD events yet. So, don't deliver RMV events.
11549 // If this question was answered using local auth records, then you can't deliver RMVs using cache
11550 if (!IsQuestionNew(m, q) && !q->LOAddressAnswers)
11551 {
11552 m->CurrentQuestion = q;
11553 CacheRecordRmvEventsForCurrentQuestion(m, q);
11554 if (m->CurrentQuestion != q) { m->CurrentQuestion = mDNSNULL; return mDNSfalse; }
11555 m->CurrentQuestion = mDNSNULL;
11556 }
11557 else { LogInfo("CacheRecordRmvEventsForQuestion: Question %p %##s (%s) is a new question", q, q->qname.c, DNSTypeName(q->qtype)); }
11558 return mDNStrue;
11559 }
11560
11561 mDNSlocal void SuppressStatusChanged(mDNS *const m, DNSQuestion *q, DNSQuestion **restart)
11562 {
11563 // NOTE: CacheRecordRmvEventsForQuestion will not generate RMV events for queries that have non-zero
11564 // LOAddressAnswers. Hence it is important that we call CacheRecordRmvEventsForQuestion before
11565 // LocalRecordRmvEventsForQuestion (which decrements LOAddressAnswers)
11566 if (q->SuppressQuery)
11567 {
11568 q->SuppressQuery = mDNSfalse;
11569 if (!CacheRecordRmvEventsForQuestion(m, q))
11570 {
11571 LogInfo("SuppressStatusChanged: Question deleted while delivering RMV events from cache");
11572 return;
11573 }
11574 q->SuppressQuery = mDNStrue;
11575 }
11576
11577 // SuppressUnusable does not affect questions that are answered from the local records (/etc/hosts)
11578 // and SuppressQuery status does not mean anything for these questions. As we are going to stop the
11579 // question below, we need to deliver the RMV events so that the ADDs that will be delivered during
11580 // the restart will not be a duplicate ADD
11581 if (!LocalRecordRmvEventsForQuestion(m, q))
11582 {
11583 LogInfo("SuppressStatusChanged: Question deleted while delivering RMV events from Local AuthRecords");
11584 return;
11585 }
11586
11587 // There are two cases here.
11588 //
11589 // 1. Previously it was suppressed and now it is not suppressed, restart the question so
11590 // that it will start as a new question. Note that we can't just call ActivateUnicastQuery
11591 // because when we get the response, if we had entries in the cache already, it will not answer
11592 // this question if the cache entry did not change. Hence, we need to restart
11593 // the query so that it can be answered from the cache.
11594 //
11595 // 2. Previously it was not suppressed and now it is suppressed. We need to restart the questions
11596 // so that we redo the duplicate checks in mDNS_StartQuery_internal. A SuppressUnusable question
11597 // is a duplicate of non-SuppressUnusable question if it is not suppressed (SuppressQuery is false).
11598 // A SuppressUnusable question is not a duplicate of non-SuppressUnusable question if it is suppressed
11599 // (SuppressQuery is true). The reason for this is that when a question is suppressed, we want an
11600 // immediate response and not want to be blocked behind a question that is querying DNS servers. When
11601 // the question is not suppressed, we don't want two active questions sending packets on the wire.
11602 // This affects both efficiency and also the current design where there is only one active question
11603 // pointed to from a cache entry.
11604 //
11605 // We restart queries in a two step process by first calling stop and build a temporary list which we
11606 // will restart at the end. The main reason for the two step process is to handle duplicate questions.
11607 // If there are duplicate questions, calling stop inherits the values from another question on the list (which
11608 // will soon become the real question) including q->ThisQInterval which might be zero if it was
11609 // suppressed before. At the end when we have restarted all questions, none of them is active as each
11610 // inherits from one another and we need to reactivate one of the questions here which is a little hacky.
11611 //
11612 // It is much cleaner and less error prone to build a list of questions and restart at the end.
11613
11614 LogInfo("SuppressStatusChanged: Stop question %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
11615 mDNS_StopQuery_internal(m, q);
11616 q->next = *restart;
11617 *restart = q;
11618 }
11619
11620 // The caller should hold the lock
11621 mDNSexport void CheckSuppressUnusableQuestions(mDNS *const m)
11622 {
11623 DNSQuestion *q;
11624 DNSQuestion *restart = mDNSNULL;
11625
11626 // We look through all questions including new questions. During network change events,
11627 // we potentially restart questions here in this function that ends up as new questions,
11628 // which may be suppressed at this instance. Before it is handled we get another network
11629 // event that changes the status e.g., address becomes available. If we did not process
11630 // new questions, we would never change its SuppressQuery status.
11631 //
11632 // CurrentQuestion is used by RmvEventsForQuestion below. While delivering RMV events, the
11633 // application callback can potentially stop the current question (detected by CurrentQuestion) or
11634 // *any* other question which could be the next one that we may process here. RestartQuestion
11635 // points to the "next" question which will be automatically advanced in mDNS_StopQuery_internal
11636 // if the "next" question is stopped while the CurrentQuestion is stopped
11637 if (m->RestartQuestion)
11638 LogMsg("CheckSuppressUnusableQuestions: ERROR!! m->RestartQuestion already set: %##s (%s)",
11639 m->RestartQuestion->qname.c, DNSTypeName(m->RestartQuestion->qtype));
11640 m->RestartQuestion = m->Questions;
11641 while (m->RestartQuestion)
11642 {
11643 q = m->RestartQuestion;
11644 m->RestartQuestion = q->next;
11645 if (q->SuppressUnusable)
11646 {
11647 mDNSBool old = q->SuppressQuery;
11648 q->SuppressQuery = ShouldSuppressQuery(m, q);
11649 if (q->SuppressQuery != old)
11650 {
11651 // Previously it was not suppressed, Generate RMV events for the ADDs that we might have delivered before
11652 // followed by a negative cache response. Temporarily turn off suppression so that
11653 // AnswerCurrentQuestionWithResourceRecord can answer the question
11654 SuppressStatusChanged(m, q, &restart);
11655 }
11656 }
11657 }
11658 while (restart)
11659 {
11660 q = restart;
11661 restart = restart->next;
11662 q->next = mDNSNULL;
11663 LogInfo("CheckSuppressUnusableQuestions: Start question %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
11664 mDNS_StartQuery_internal(m, q);
11665 }
11666 }
11667
11668 mDNSlocal void RestartUnicastQuestions(mDNS *const m)
11669 {
11670 DNSQuestion *q;
11671 DNSQuestion *restart = mDNSNULL;
11672
11673 if (m->RestartQuestion)
11674 LogMsg("RestartUnicastQuestions: ERROR!! m->RestartQuestion already set: %##s (%s)",
11675 m->RestartQuestion->qname.c, DNSTypeName(m->RestartQuestion->qtype));
11676 m->RestartQuestion = m->Questions;
11677 while (m->RestartQuestion)
11678 {
11679 q = m->RestartQuestion;
11680 m->RestartQuestion = q->next;
11681 if (q->Restart)
11682 {
11683 if (mDNSOpaque16IsZero(q->TargetQID))
11684 LogMsg("RestartUnicastQuestions: ERROR!! Restart set for multicast question %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
11685
11686 q->Restart = 0;
11687 SuppressStatusChanged(m, q, &restart);
11688 }
11689 }
11690 while (restart)
11691 {
11692 q = restart;
11693 restart = restart->next;
11694 q->next = mDNSNULL;
11695 LogInfo("RestartUnicastQuestions: Start question %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
11696 mDNS_StartQuery_internal(m, q);
11697 }
11698 }
11699
11700
11701 // ValidateParameters() is called by mDNS_StartQuery_internal() to check the client parameters of
11702 // DNS Question that are already set by the client before calling mDNS_StartQuery()
11703 mDNSlocal mStatus ValidateParameters(mDNS *const m, DNSQuestion *const question)
11704 {
11705
11706 if (question->Target.type && !ValidQuestionTarget(question))
11707 {
11708 LogMsg("ValidateParameters: Warning! Target.type = %ld port = %u (Client forgot to initialize before calling mDNS_StartQuery? for question %##s)",
11709 question->Target.type, mDNSVal16(question->TargetPort), question->qname.c);
11710 question->Target.type = mDNSAddrType_None;
11711 }
11712
11713 // If no question->Target specified, clear TargetPort
11714 if (!question->Target.type)
11715 question->TargetPort = zeroIPPort;
11716
11717 if (!ValidateDomainName(&question->qname))
11718 {
11719 LogMsg("ValidateParameters: Attempt to start query with invalid qname %##s (%s)", question->qname.c, DNSTypeName(question->qtype));
11720 return(mStatus_Invalid);
11721 }
11722
11723 // If this question is referencing a specific interface, verify it exists
11724 if (question->InterfaceID && !LocalOnlyOrP2PInterface(question->InterfaceID) && question->InterfaceID != mDNSInterface_Unicast)
11725 {
11726 NetworkInterfaceInfo *intf = FirstInterfaceForID(m, question->InterfaceID);
11727 if (!intf)
11728 LogInfo("ValidateParameters: Note: InterfaceID %d for question %##s (%s) not currently found in active interface list",
11729 (uint32_t)question->InterfaceID, question->qname.c, DNSTypeName(question->qtype));
11730 }
11731
11732 return(mStatus_NoError);
11733 }
11734
11735 // InitDNSConfig() is called by InitCommonState() to initialize the DNS configuration of the Question.
11736 // These are a subset of the internal uDNS fields. Must be done before ShouldSuppressQuery() & mDNS_PurgeBeforeResolve()
11737 mDNSlocal void InitDNSConfig(mDNS *const m, DNSQuestion *const question)
11738 {
11739 // First reset all DNS Configuration
11740 question->qDNSServer = mDNSNULL;
11741 question->validDNSServers = zeroOpaque128;
11742 question->triedAllServersOnce = 0;
11743 question->noServerResponse = 0;
11744 question->StopTime = (question->TimeoutQuestion) ? question->StopTime : 0;
11745 #if AWD_METRICS
11746 mDNSPlatformMemZero(&question->metrics, sizeof(question->metrics));
11747 question->metrics.expiredAnswerState = (question->allowExpired != AllowExpired_None) ? ExpiredAnswer_Allowed : ExpiredAnswer_None;
11748 #endif
11749
11750 // Need not initialize the DNS Configuration for Local Only OR P2P Questions when timeout not specified
11751 if (LocalOnlyOrP2PInterface(question->InterfaceID) && !question->TimeoutQuestion)
11752 return;
11753 // Proceed to initialize DNS Configuration (some are set in SetValidDNSServers())
11754 if (!mDNSOpaque16IsZero(question->TargetQID))
11755 {
11756 mDNSu32 timeout = SetValidDNSServers(m, question);
11757 // We set the timeout value the first time mDNS_StartQuery_internal is called for a question.
11758 // So if a question is restarted when a network change occurs, the StopTime is not reset.
11759 // Note that we set the timeout for all questions. If this turns out to be a duplicate,
11760 // it gets a full timeout value even if the original question times out earlier.
11761 if (question->TimeoutQuestion && !question->StopTime)
11762 {
11763 question->StopTime = NonZeroTime(m->timenow + timeout * mDNSPlatformOneSecond);
11764 LogInfo("InitDNSConfig: Setting StopTime on the uDNS question %p %##s (%s)", question, question->qname.c, DNSTypeName(question->qtype));
11765 }
11766
11767 question->qDNSServer = GetServerForQuestion(m, question);
11768 LogDebug("InitDNSConfig: question %p %##s (%s) Timeout %d, DNS Server %#a:%d",
11769 question, question->qname.c, DNSTypeName(question->qtype), timeout,
11770 question->qDNSServer ? &question->qDNSServer->addr : mDNSNULL,
11771 mDNSVal16(question->qDNSServer ? question->qDNSServer->port : zeroIPPort));
11772 }
11773 else if (question->TimeoutQuestion && !question->StopTime)
11774 {
11775 // If the question is to be timed out and its a multicast, local-only or P2P case,
11776 // then set it's stop time.
11777 mDNSu32 timeout = LocalOnlyOrP2PInterface(question->InterfaceID) ?
11778 DEFAULT_LO_OR_P2P_TIMEOUT : GetTimeoutForMcastQuestion(m, question);
11779 question->StopTime = NonZeroTime(m->timenow + timeout * mDNSPlatformOneSecond);
11780 LogInfo("InitDNSConfig: Setting StopTime on question %p %##s (%s)", question, question->qname.c, DNSTypeName(question->qtype));
11781 }
11782 // Set StopTime here since it is a part of DNS Configuration
11783 if (question->StopTime)
11784 SetNextQueryStopTime(m, question);
11785 // Don't call SetNextQueryTime() if a LocalOnly OR P2P Question since those questions
11786 // will never be transmitted on the wire.
11787 if (!(LocalOnlyOrP2PInterface(question->InterfaceID)))
11788 SetNextQueryTime(m,question);
11789 }
11790
11791 // InitCommonState() is called by mDNS_StartQuery_internal() to initialize the common(uDNS/mDNS) internal
11792 // state fields of the DNS Question. These are independent of the Client layer.
11793 mDNSlocal void InitCommonState(mDNS *const m, DNSQuestion *const question)
11794 {
11795 int i;
11796 mDNSBool isBlocked = mDNSfalse;
11797
11798 // Note: In the case where we already have the answer to this question in our cache, that may be all the client
11799 // wanted, and they may immediately cancel their question. In this case, sending an actual query on the wire would
11800 // be a waste. For that reason, we schedule our first query to go out in half a second (InitialQuestionInterval).
11801 // If AnswerNewQuestion() finds that we have *no* relevant answers currently in our cache, then it will accelerate
11802 // that to go out immediately.
11803 question->next = mDNSNULL;
11804 // ThisQInterval should be initialized before any memory allocations occur. If malloc
11805 // debugging is turned on within mDNSResponder (see mDNSDebug.h for details) it validates
11806 // the question list to check if ThisQInterval is negative which means the question has been
11807 // stopped and can't be on the list. The question is already on the list and ThisQInterval
11808 // can be negative if the caller just stopped it and starting it again. Hence, it always has to
11809 // be initialized. CheckForSoonToExpireRecords below prints the cache records when logging is
11810 // turned ON which can allocate memory e.g., base64 encoding, in the case of DNSSEC.
11811 question->ThisQInterval = InitialQuestionInterval; // MUST be > zero for an active question
11812 question->qnamehash = DomainNameHashValue(&question->qname);
11813 question->DelayAnswering = mDNSOpaque16IsZero(question->TargetQID) ? CheckForSoonToExpireRecords(m, &question->qname, question->qnamehash) : 0;
11814 question->LastQTime = m->timenow;
11815 question->ExpectUnicastResp = 0;
11816 question->LastAnswerPktNum = m->PktNum;
11817 question->RecentAnswerPkts = 0;
11818 question->CurrentAnswers = 0;
11819
11820 #if APPLE_OSX_mDNSResponder
11821
11822 // Initial browse threshold used by Finder.
11823 #define mDNSFinderBrowseThreshold 20
11824
11825 // Set the threshold at which we move to a passive browse state,
11826 // not actively sending queries.
11827 if (question->flags & kDNSServiceFlagsThresholdOne)
11828 question->BrowseThreshold = 1;
11829 else if (question->flags & kDNSServiceFlagsThresholdFinder)
11830 question->BrowseThreshold = mDNSFinderBrowseThreshold;
11831 else
11832 question->BrowseThreshold = 0;
11833
11834 #else // APPLE_OSX_mDNSResponder
11835 question->BrowseThreshold = 0;
11836 #endif // APPLE_OSX_mDNSResponder
11837 question->CachedAnswerNeedsUpdate = mDNSfalse;
11838
11839 question->LargeAnswers = 0;
11840 question->UniqueAnswers = 0;
11841 question->LOAddressAnswers = 0;
11842 question->FlappingInterface1 = mDNSNULL;
11843 question->FlappingInterface2 = mDNSNULL;
11844
11845 // if kDNSServiceFlagsServiceIndex flag is SET by the client, then do NOT call mDNSPlatformGetDNSRoutePolicy()
11846 // since we would already have the question->ServiceID in that case.
11847 if (!(question->flags & kDNSServiceFlagsServiceIndex))
11848 {
11849 #if APPLE_OSX_mDNSResponder
11850 mDNSPlatformGetDNSRoutePolicy(question, &isBlocked);
11851 #else
11852 question->ServiceID = -1;
11853 #endif
11854 }
11855 else
11856 LogInfo("InitCommonState: Query for %##s (%s), PID[%d], EUID[%d], ServiceID[%d] is already set by client", question->qname.c,
11857 DNSTypeName(question->qtype), question->pid, question->euid, question->ServiceID);
11858
11859 InitDNSConfig(m, question);
11860
11861 question->AuthInfo = GetAuthInfoForQuestion(m, question);
11862 question->SuppressQuery = 0;
11863 if (question->SuppressUnusable)
11864 question->SuppressQuery = ShouldSuppressQuery(m, question);
11865
11866 // If ServiceID is 0 or the policy disallows making DNS requests,
11867 // set DisallowPID
11868 question->DisallowPID = (question->ServiceID == 0 || isBlocked);
11869 if (question->DisallowPID)
11870 LogInfo("InitCommonState: Query suppressed for %##s (%s), PID %d/ServiceID %d not allowed", question->qname.c,
11871 DNSTypeName(question->qtype), question->pid, question->ServiceID);
11872
11873 question->NextInDQList = mDNSNULL;
11874 question->SendQNow = mDNSNULL;
11875 question->SendOnAll = mDNSfalse;
11876 question->RequestUnicast = kDefaultRequestUnicastCount;
11877
11878 #if APPLE_OSX_mDNSResponder
11879 // Set the QU bit in the first query for the following options.
11880 if ((question->flags & kDNSServiceFlagsUnicastResponse) || (question->flags & kDNSServiceFlagsThresholdFinder))
11881 {
11882 question->RequestUnicast = SET_QU_IN_FIRST_QUERY;
11883 LogInfo("InitCommonState: setting RequestUnicast = %d for %##s (%s)", question->RequestUnicast, question->qname.c,
11884 DNSTypeName(question->qtype));
11885 }
11886 #endif // APPLE_OSX_mDNSResponder
11887
11888 question->LastQTxTime = m->timenow;
11889 question->CNAMEReferrals = 0;
11890
11891 question->WakeOnResolveCount = 0;
11892 if (question->WakeOnResolve)
11893 {
11894 question->WakeOnResolveCount = InitialWakeOnResolveCount;
11895 }
11896
11897 for (i=0; i<DupSuppressInfoSize; i++)
11898 question->DupSuppress[i].InterfaceID = mDNSNULL;
11899
11900 question->Restart = 0;
11901
11902 debugf("InitCommonState: Question %##s (%s) Interface %p Now %d Send in %d Answer in %d (%p) %s (%p)",
11903 question->qname.c, DNSTypeName(question->qtype), question->InterfaceID, m->timenow,
11904 NextQSendTime(question) - m->timenow,
11905 question->DelayAnswering ? question->DelayAnswering - m->timenow : 0,
11906 question, question->DuplicateOf ? "duplicate of" : "not duplicate", question->DuplicateOf);
11907
11908 if (question->DelayAnswering)
11909 LogInfo("InitCommonState: Delaying answering for %d ticks while cache stabilizes for %##s (%s)",
11910 question->DelayAnswering - m->timenow, question->qname.c, DNSTypeName(question->qtype));
11911 }
11912
11913 // Excludes the DNS Config fields which are already handled by InitDNSConfig()
11914 mDNSlocal void InitWABState(DNSQuestion *const question)
11915 {
11916 // We'll create our question->LocalSocket on demand, if needed.
11917 // We won't need one for duplicate questions, or from questions answered immediately out of the cache.
11918 // We also don't need one for LLQs because (when we're using NAT) we want them all to share a single
11919 // NAT mapping for receiving inbound add/remove events.
11920 question->LocalSocket = mDNSNULL;
11921 question->unansweredQueries = 0;
11922 question->nta = mDNSNULL;
11923 question->servAddr = zeroAddr;
11924 question->servPort = zeroIPPort;
11925 question->tcp = mDNSNULL;
11926 question->NoAnswer = NoAnswer_Normal;
11927 }
11928
11929 mDNSlocal void InitLLQNATState(mDNS *const m)
11930 {
11931 // If we don't have our NAT mapping active, start it now
11932 if (!m->LLQNAT.clientCallback)
11933 {
11934 m->LLQNAT.Protocol = NATOp_MapUDP;
11935 m->LLQNAT.IntPort = m->UnicastPort4;
11936 m->LLQNAT.RequestedPort = m->UnicastPort4;
11937 m->LLQNAT.clientCallback = LLQNATCallback;
11938 m->LLQNAT.clientContext = (void*)1; // Means LLQ NAT Traversal just started
11939 mDNS_StartNATOperation_internal(m, &m->LLQNAT);
11940 }
11941 }
11942
11943 mDNSlocal void InitLLQState(DNSQuestion *const question)
11944 {
11945 question->state = LLQ_InitialRequest;
11946 question->ReqLease = 0;
11947 question->expire = 0;
11948 question->ntries = 0;
11949 question->id = zeroOpaque64;
11950 }
11951
11952 #ifdef DNS_PUSH_ENABLED
11953 mDNSlocal void InitDNSPNState(DNSQuestion *const question)
11954 {
11955 question->dnsPushState = DNSPUSH_INIT;
11956 }
11957 #endif // DNS_PUSH_ENABLED
11958
11959 // InitDNSSECProxyState() is called by mDNS_StartQuery_internal() to initialize
11960 // DNSSEC & DNS Proxy fields of the DNS Question.
11961 mDNSlocal void InitDNSSECProxyState(mDNS *const m, DNSQuestion *const question)
11962 {
11963 (void) m;
11964
11965 // DNS server selection affects DNSSEC. Turn off validation if req_DO is not set
11966 // or the request is going over cellular interface.
11967 //
11968 // Note: This needs to be done here before we call FindDuplicateQuestion as it looks
11969 // at ValidationRequired setting also.
11970 if (question->qDNSServer)
11971 {
11972 if (question->qDNSServer->cellIntf)
11973 {
11974 debugf("InitDNSSECProxyState: Turning off validation for %##s (%s); going over cell", question->qname.c, DNSTypeName(question->qtype));
11975 question->ValidationRequired = mDNSfalse;
11976 }
11977 if (DNSSECOptionalQuestion(question) && !(question->qDNSServer->req_DO))
11978 {
11979 LogInfo("InitDNSSECProxyState: Turning off validation for %##s (%s); req_DO false",
11980 question->qname.c, DNSTypeName(question->qtype));
11981 question->ValidationRequired = DNSSEC_VALIDATION_NONE;
11982 }
11983 }
11984 question->ValidationState = (question->ValidationRequired ? DNSSECValRequired : DNSSECValNotRequired);
11985 question->ValidationStatus = 0;
11986 question->responseFlags = zeroID;
11987 }
11988
11989 // Once the question is completely initialized including the duplicate logic, this function
11990 // is called to finalize the unicast question which requires flushing the cache if needed,
11991 // activating the query etc.
11992 mDNSlocal void FinalizeUnicastQuestion(mDNS *const m, DNSQuestion *question)
11993 {
11994 // Ensure DNS related info of duplicate question is same as the orig question
11995 if (question->DuplicateOf)
11996 {
11997 question->validDNSServers = question->DuplicateOf->validDNSServers;
11998 // If current(dup) question has DNS Server assigned but the original question has no DNS Server assigned to it,
11999 // then we log a line as it could indicate an issue
12000 if (question->DuplicateOf->qDNSServer == mDNSNULL)
12001 {
12002 if (question->qDNSServer)
12003 LogInfo("FinalizeUnicastQuestion: Current(dup) question %p has DNSServer(%#a:%d) but original question(%p) has no DNS Server! %##s (%s)",
12004 question, question->qDNSServer ? &question->qDNSServer->addr : mDNSNULL,
12005 mDNSVal16(question->qDNSServer ? question->qDNSServer->port : zeroIPPort),
12006 question->DuplicateOf, question->qname.c, DNSTypeName(question->qtype));
12007 }
12008 question->qDNSServer = question->DuplicateOf->qDNSServer;
12009 LogInfo("FinalizeUnicastQuestion: Duplicate question %p (%p) %##s (%s), DNS Server %#a:%d",
12010 question, question->DuplicateOf, question->qname.c, DNSTypeName(question->qtype),
12011 question->qDNSServer ? &question->qDNSServer->addr : mDNSNULL,
12012 mDNSVal16(question->qDNSServer ? question->qDNSServer->port : zeroIPPort));
12013 }
12014
12015 ActivateUnicastQuery(m, question, mDNSfalse);
12016
12017 if (!question->DuplicateOf && DNSSECQuestion(question))
12018 {
12019 // For DNSSEC questions, we need to have the RRSIGs also for verification.
12020 CheckForDNSSECRecords(m, question);
12021 }
12022 if (question->LongLived)
12023 {
12024 // Unlike other initializations, InitLLQNATState should be done after
12025 // we determine that it is a unicast question. LongLived is set for
12026 // both multicast and unicast browse questions but we should initialize
12027 // the LLQ NAT state only for unicast. Otherwise we will unnecessarily
12028 // start the NAT traversal that is not needed.
12029 InitLLQNATState(m);
12030 #if APPLE_OSX_mDNSResponder
12031 UpdateAutoTunnelDomainStatuses(m);
12032 #endif
12033 }
12034 }
12035
12036 mDNSexport mStatus mDNS_StartQuery_internal(mDNS *const m, DNSQuestion *const question)
12037 {
12038 DNSQuestion **q;
12039 mStatus vStatus;
12040
12041 // First check for cache space (can't do queries if there is no cache space allocated)
12042 if (m->rrcache_size == 0)
12043 return(mStatus_NoCache);
12044
12045 vStatus = ValidateParameters(m, question);
12046 if (vStatus)
12047 return(vStatus);
12048
12049 #ifdef USE_LIBIDN
12050 // If the TLD includes high-ascii bytes, assume it will need to be converted to Punycode.
12051 // (In the future the root name servers may answer UTF-8 queries directly, but for now they do not.)
12052 if (IsHighASCIILabel(LastLabel(&question->qname)))
12053 {
12054 domainname newname;
12055 if (PerformNextPunycodeConversion(question, &newname))
12056 AssignDomainName(&question->qname, &newname);
12057 }
12058 #endif // USE_LIBIDN
12059
12060 question->TargetQID =
12061 #ifndef UNICAST_DISABLED
12062 (question->Target.type || Question_uDNS(question)) ? mDNS_NewMessageID(m) :
12063 #endif // UNICAST_DISABLED
12064 zeroID;
12065 debugf("mDNS_StartQuery_internal: %##s (%s)", question->qname.c, DNSTypeName(question->qtype));
12066
12067 // Note: It important that new questions are appended at the *end* of the list, not prepended at the start
12068 q = &m->Questions;
12069 if (LocalOnlyOrP2PInterface(question->InterfaceID))
12070 q = &m->LocalOnlyQuestions;
12071 while (*q && *q != question)
12072 q=&(*q)->next;
12073
12074 if (*q)
12075 {
12076 LogMsg("mDNS_StartQuery_internal: Error! Tried to add a question %##s (%s) %p that's already in the active list",
12077 question->qname.c, DNSTypeName(question->qtype), question);
12078 return(mStatus_AlreadyRegistered);
12079 }
12080 *q = question;
12081
12082 // Intialize the question. The only ordering constraint we have today is that
12083 // InitDNSSECProxyState should be called after the DNS server is selected (in
12084 // InitCommonState -> InitDNSConfig) as DNS server selection affects DNSSEC
12085 // validation.
12086
12087 InitCommonState(m, question);
12088 InitWABState(question);
12089 InitLLQState(question);
12090 #ifdef DNS_PUSH_ENABLED
12091 InitDNSPNState(question);
12092 #endif // DNS_PUSH_ENABLED
12093 InitDNSSECProxyState(m, question);
12094
12095 // FindDuplicateQuestion should be called last after all the intialization
12096 // as the duplicate logic could be potentially based on any field in the
12097 // question.
12098 question->DuplicateOf = FindDuplicateQuestion(m, question);
12099 if (question->DuplicateOf)
12100 question->AuthInfo = question->DuplicateOf->AuthInfo;
12101
12102 if (LocalOnlyOrP2PInterface(question->InterfaceID))
12103 {
12104 if (!m->NewLocalOnlyQuestions)
12105 m->NewLocalOnlyQuestions = question;
12106 }
12107 else
12108 {
12109 if (!m->NewQuestions)
12110 m->NewQuestions = question;
12111
12112 // If the question's id is non-zero, then it's Wide Area
12113 // MUST NOT do this Wide Area setup until near the end of
12114 // mDNS_StartQuery_internal -- this code may itself issue queries (e.g. SOA,
12115 // NS, etc.) and if we haven't finished setting up our own question and setting
12116 // m->NewQuestions if necessary then we could end up recursively re-entering
12117 // this routine with the question list data structures in an inconsistent state.
12118 if (!mDNSOpaque16IsZero(question->TargetQID))
12119 {
12120 FinalizeUnicastQuestion(m, question);
12121 }
12122 else
12123 {
12124 #if BONJOUR_ON_DEMAND
12125 m->NumAllInterfaceQuestions++;
12126 LogInfo("mDNS_StartQuery_internal: NumAllInterfaceRecords %d NumAllInterfaceQuestions %d %##s (%s)",
12127 m->NumAllInterfaceRecords, m->NumAllInterfaceQuestions, question->qname.c, DNSTypeName(question->qtype));
12128 if (m->NumAllInterfaceRecords + m->NumAllInterfaceQuestions == 1)
12129 {
12130 m->NextBonjourDisableTime = 0;
12131 if (m->BonjourEnabled == 0)
12132 {
12133 // Enable Bonjour immediately by scheduling network changed processing where
12134 // we will join the multicast group on each active interface.
12135 m->BonjourEnabled = 1;
12136 m->NetworkChanged = m->timenow;
12137 }
12138 }
12139 #endif // BONJOUR_ON_DEMAND
12140 if (question->WakeOnResolve)
12141 {
12142 LogInfo("mDNS_StartQuery_internal: Purging for %##s", question->qname.c);
12143 mDNS_PurgeBeforeResolve(m, question);
12144 }
12145 }
12146 }
12147
12148 return(mStatus_NoError);
12149 }
12150
12151 // CancelGetZoneData is an internal routine (i.e. must be called with the lock already held)
12152 mDNSexport void CancelGetZoneData(mDNS *const m, ZoneData *nta)
12153 {
12154 debugf("CancelGetZoneData %##s (%s)", nta->question.qname.c, DNSTypeName(nta->question.qtype));
12155 // This function may be called anytime to free the zone information.The question may or may not have stopped.
12156 // If it was already stopped, mDNS_StopQuery_internal would have set q->ThisQInterval to -1 and should not
12157 // call it again
12158 if (nta->question.ThisQInterval != -1)
12159 {
12160 mDNS_StopQuery_internal(m, &nta->question);
12161 if (nta->question.ThisQInterval != -1)
12162 LogMsg("CancelGetZoneData: Question %##s (%s) ThisQInterval %d not -1", nta->question.qname.c, DNSTypeName(nta->question.qtype), nta->question.ThisQInterval);
12163 }
12164 mDNSPlatformMemFree(nta);
12165 }
12166
12167 mDNSexport mStatus mDNS_StopQuery_internal(mDNS *const m, DNSQuestion *const question)
12168 {
12169 CacheGroup *cg = CacheGroupForName(m, question->qnamehash, &question->qname);
12170 CacheRecord *rr;
12171 DNSQuestion **qp = &m->Questions;
12172
12173 //LogInfo("mDNS_StopQuery_internal %##s (%s)", question->qname.c, DNSTypeName(question->qtype));
12174
12175 if (LocalOnlyOrP2PInterface(question->InterfaceID))
12176 qp = &m->LocalOnlyQuestions;
12177 while (*qp && *qp != question) qp=&(*qp)->next;
12178 if (*qp) *qp = (*qp)->next;
12179 else
12180 {
12181 #if !ForceAlerts
12182 if (question->ThisQInterval >= 0) // Only log error message if the query was supposed to be active
12183 #endif
12184 LogFatalError("mDNS_StopQuery_internal: Question %##s (%s) not found in active list", question->qname.c, DNSTypeName(question->qtype));
12185 return(mStatus_BadReferenceErr);
12186 }
12187
12188 #if BONJOUR_ON_DEMAND
12189 if (!LocalOnlyOrP2PInterface(question->InterfaceID) && mDNSOpaque16IsZero(question->TargetQID))
12190 {
12191 if (m->NumAllInterfaceRecords + m->NumAllInterfaceQuestions == 1)
12192 m->NextBonjourDisableTime = NonZeroTime(m->timenow + (BONJOUR_DISABLE_DELAY * mDNSPlatformOneSecond));
12193 m->NumAllInterfaceQuestions--;
12194 LogInfo("mDNS_StopQuery_internal: NumAllInterfaceRecords %d NumAllInterfaceQuestions %d %##s (%s)",
12195 m->NumAllInterfaceRecords, m->NumAllInterfaceQuestions, question->qname.c, DNSTypeName(question->qtype));
12196 }
12197 #endif // BONJOUR_ON_DEMAND
12198
12199 #if AWD_METRICS
12200 if (Question_uDNS(question) && !question->metrics.answered && (question->metrics.querySendCount > 0))
12201 {
12202 const domainname * queryName;
12203 mDNSBool isForCell;
12204 mDNSu32 durationMs;
12205
12206 queryName = question->metrics.originalQName ? question->metrics.originalQName : &question->qname;
12207 isForCell = (question->qDNSServer && question->qDNSServer->cellIntf);
12208 durationMs = ((m->timenow - question->metrics.firstQueryTime) * 1000) / mDNSPlatformOneSecond;
12209 MetricsUpdateDNSQueryStats(queryName, question->qtype, mDNSNULL, question->metrics.querySendCount, question->metrics.expiredAnswerState, durationMs, isForCell);
12210 }
12211 #endif
12212 // Take care to cut question from list *before* calling UpdateQuestionDuplicates
12213 UpdateQuestionDuplicates(m, question);
12214 // But don't trash ThisQInterval until afterwards.
12215 question->ThisQInterval = -1;
12216
12217 // If there are any cache records referencing this as their active question, then see if there is any
12218 // other question that is also referencing them, else their CRActiveQuestion needs to get set to NULL.
12219 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
12220 {
12221 if (rr->CRActiveQuestion == question)
12222 {
12223 DNSQuestion *q;
12224 DNSQuestion *replacement = mDNSNULL;
12225 // If we find an active question that is answered by this cached record, use it as the cache record's
12226 // CRActiveQuestion replacement. If there are no such questions, but there's at least one unsuppressed inactive
12227 // question that is answered by this cache record, then use an inactive one to not forgo generating RMV events
12228 // via CacheRecordRmv() when the cache record expires.
12229 for (q = m->Questions; q && (q != m->NewQuestions); q = q->next)
12230 {
12231 if (!q->DuplicateOf && !QuerySuppressed(q) && ResourceRecordAnswersQuestion(&rr->resrec, q))
12232 {
12233 if (q->ThisQInterval > 0)
12234 {
12235 replacement = q;
12236 break;
12237 }
12238 else if (!replacement)
12239 {
12240 replacement = q;
12241 }
12242 }
12243 }
12244 if (replacement)
12245 debugf("mDNS_StopQuery_internal: Updating CRActiveQuestion to %p for cache record %s, Original question CurrentAnswers %d, new question "
12246 "CurrentAnswers %d, SuppressQuery %d", replacement, CRDisplayString(m,rr), question->CurrentAnswers, replacement->CurrentAnswers, replacement->SuppressQuery);
12247 rr->CRActiveQuestion = replacement; // Question used to be active; new value may or may not be null
12248 if (!replacement) m->rrcache_active--; // If no longer active, decrement rrcache_active count
12249 }
12250 }
12251
12252 // If we just deleted the question that CacheRecordAdd() or CacheRecordRmv() is about to look at,
12253 // bump its pointer forward one question.
12254 if (m->CurrentQuestion == question)
12255 {
12256 debugf("mDNS_StopQuery_internal: Just deleted the currently active question: %##s (%s)",
12257 question->qname.c, DNSTypeName(question->qtype));
12258 m->CurrentQuestion = question->next;
12259 }
12260
12261 if (m->NewQuestions == question)
12262 {
12263 debugf("mDNS_StopQuery_internal: Just deleted a new question that wasn't even answered yet: %##s (%s)",
12264 question->qname.c, DNSTypeName(question->qtype));
12265 m->NewQuestions = question->next;
12266 }
12267
12268 if (m->NewLocalOnlyQuestions == question) m->NewLocalOnlyQuestions = question->next;
12269
12270 if (m->RestartQuestion == question)
12271 {
12272 LogMsg("mDNS_StopQuery_internal: Just deleted the current restart question: %##s (%s)",
12273 question->qname.c, DNSTypeName(question->qtype));
12274 m->RestartQuestion = question->next;
12275 }
12276
12277 if (m->ValidationQuestion == question)
12278 {
12279 LogInfo("mDNS_StopQuery_internal: Just deleted the current Validation question: %##s (%s)",
12280 question->qname.c, DNSTypeName(question->qtype));
12281 m->ValidationQuestion = question->next;
12282 }
12283
12284 // Take care not to trash question->next until *after* we've updated m->CurrentQuestion and m->NewQuestions
12285 question->next = mDNSNULL;
12286
12287 // LogMsg("mDNS_StopQuery_internal: Question %##s (%s) removed", question->qname.c, DNSTypeName(question->qtype));
12288
12289 // And finally, cancel any associated GetZoneData operation that's still running.
12290 // Must not do this until last, because there's a good chance the GetZoneData question is the next in the list,
12291 // so if we delete it earlier in this routine, we could find that our "question->next" pointer above is already
12292 // invalid before we even use it. By making sure that we update m->CurrentQuestion and m->NewQuestions if necessary
12293 // *first*, then they're all ready to be updated a second time if necessary when we cancel our GetZoneData query.
12294 if (question->tcp) { DisposeTCPConn(question->tcp); question->tcp = mDNSNULL; }
12295 if (question->LocalSocket) { mDNSPlatformUDPClose(question->LocalSocket); question->LocalSocket = mDNSNULL; }
12296 if (!mDNSOpaque16IsZero(question->TargetQID) && question->LongLived)
12297 {
12298 // Scan our list to see if any more wide-area LLQs remain. If not, stop our NAT Traversal.
12299 DNSQuestion *q;
12300 for (q = m->Questions; q; q=q->next)
12301 if (!mDNSOpaque16IsZero(q->TargetQID) && q->LongLived) break;
12302 if (!q)
12303 {
12304 if (!m->LLQNAT.clientCallback) // Should never happen, but just in case...
12305 {
12306 LogMsg("mDNS_StopQuery ERROR LLQNAT.clientCallback NULL");
12307 }
12308 else
12309 {
12310 LogInfo("Stopping LLQNAT");
12311 mDNS_StopNATOperation_internal(m, &m->LLQNAT);
12312 m->LLQNAT.clientCallback = mDNSNULL; // Means LLQ NAT Traversal not running
12313 }
12314 }
12315
12316 // If necessary, tell server it can delete this LLQ state
12317 if (question->state == LLQ_Established)
12318 {
12319 question->ReqLease = 0;
12320 sendLLQRefresh(m, question);
12321 // If we need need to make a TCP connection to cancel the LLQ, that's going to take a little while.
12322 // We clear the tcp->question backpointer so that when the TCP connection completes, it doesn't
12323 // crash trying to access our cancelled question, but we don't cancel the TCP operation itself --
12324 // we let that run out its natural course and complete asynchronously.
12325 if (question->tcp)
12326 {
12327 question->tcp->question = mDNSNULL;
12328 question->tcp = mDNSNULL;
12329 }
12330 }
12331 #ifdef DNS_PUSH_ENABLED
12332 else if (question->dnsPushState == DNSPUSH_ESTABLISHED)
12333 {
12334 if (question->tcp)
12335 {
12336 UnSubscribeToDNSPushNotificationServer(m, q);
12337 question->tcp->question = mDNSNULL;
12338 question->tcp = mDNSNULL;
12339 }
12340 }
12341 #endif // DNS_PUSH_ENABLED
12342 #if APPLE_OSX_mDNSResponder
12343 UpdateAutoTunnelDomainStatuses(m);
12344 #endif
12345 }
12346 // wait until we send the refresh above which needs the nta
12347 if (question->nta) { CancelGetZoneData(m, question->nta); question->nta = mDNSNULL; }
12348
12349 if (question->ValidationRequired && question->DNSSECAuthInfo)
12350 {
12351 LogInfo("mDNS_StopQuery_internal: freeing DNSSECAuthInfo %##s", question->qname.c);
12352 question->DAIFreeCallback(m, question->DNSSECAuthInfo);
12353 question->DNSSECAuthInfo = mDNSNULL;
12354 }
12355 if (question->AnonInfo)
12356 {
12357 FreeAnonInfo(question->AnonInfo);
12358 question->AnonInfo = mDNSNULL;
12359 }
12360 #if AWD_METRICS
12361 if (question->metrics.originalQName)
12362 {
12363 mDNSPlatformMemFree(question->metrics.originalQName);
12364 question->metrics.originalQName = mDNSNULL;
12365 }
12366 #endif
12367
12368 #if USE_DNS64
12369 DNS64ResetState(question);
12370 #endif
12371
12372 return(mStatus_NoError);
12373 }
12374
12375 mDNSexport mStatus mDNS_StartQuery(mDNS *const m, DNSQuestion *const question)
12376 {
12377 mStatus status;
12378 mDNS_Lock(m);
12379 status = mDNS_StartQuery_internal(m, question);
12380 mDNS_Unlock(m);
12381 return(status);
12382 }
12383
12384 mDNSexport mStatus mDNS_StopQuery(mDNS *const m, DNSQuestion *const question)
12385 {
12386 mStatus status;
12387 mDNS_Lock(m);
12388 status = mDNS_StopQuery_internal(m, question);
12389 mDNS_Unlock(m);
12390 return(status);
12391 }
12392
12393 // Note that mDNS_StopQueryWithRemoves() does not currently implement the full generality of the other APIs
12394 // Specifically, question callbacks invoked as a result of this call cannot themselves make API calls.
12395 // We invoke the callback without using mDNS_DropLockBeforeCallback/mDNS_ReclaimLockAfterCallback
12396 // specifically to catch and report if the client callback does try to make API calls
12397 mDNSexport mStatus mDNS_StopQueryWithRemoves(mDNS *const m, DNSQuestion *const question)
12398 {
12399 mStatus status;
12400 DNSQuestion *qq;
12401 mDNS_Lock(m);
12402
12403 // Check if question is new -- don't want to give remove events for a question we haven't even answered yet
12404 for (qq = m->NewQuestions; qq; qq=qq->next) if (qq == question) break;
12405
12406 status = mDNS_StopQuery_internal(m, question);
12407 if (status == mStatus_NoError && !qq)
12408 {
12409 const CacheRecord *rr;
12410 CacheGroup *const cg = CacheGroupForName(m, question->qnamehash, &question->qname);
12411 LogInfo("Generating terminal removes for %##s (%s)", question->qname.c, DNSTypeName(question->qtype));
12412 for (rr = cg ? cg->members : mDNSNULL; rr; rr=rr->next)
12413 if (rr->resrec.RecordType != kDNSRecordTypePacketNegative && SameNameRecordAnswersQuestion(&rr->resrec, question))
12414 {
12415 // Don't use mDNS_DropLockBeforeCallback() here, since we don't allow API calls
12416 if (question->QuestionCallback)
12417 question->QuestionCallback(m, question, &rr->resrec, mDNSfalse);
12418 }
12419 }
12420 mDNS_Unlock(m);
12421 return(status);
12422 }
12423
12424 mDNSexport mStatus mDNS_Reconfirm(mDNS *const m, CacheRecord *const cr)
12425 {
12426 mStatus status;
12427 mDNS_Lock(m);
12428 status = mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
12429 if (status == mStatus_NoError) ReconfirmAntecedents(m, cr->resrec.name, cr->resrec.namehash, cr->resrec.InterfaceID, 0);
12430 mDNS_Unlock(m);
12431 return(status);
12432 }
12433
12434 mDNSexport mStatus mDNS_ReconfirmByValue(mDNS *const m, ResourceRecord *const rr)
12435 {
12436 mStatus status = mStatus_BadReferenceErr;
12437 CacheRecord *cr;
12438 mDNS_Lock(m);
12439 cr = FindIdenticalRecordInCache(m, rr);
12440 debugf("mDNS_ReconfirmByValue: %p %s", cr, RRDisplayString(m, rr));
12441 if (cr) status = mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
12442 if (status == mStatus_NoError) ReconfirmAntecedents(m, cr->resrec.name, cr->resrec.namehash, cr->resrec.InterfaceID, 0);
12443 mDNS_Unlock(m);
12444 return(status);
12445 }
12446
12447 mDNSlocal mStatus mDNS_StartBrowse_internal(mDNS *const m, DNSQuestion *const question,
12448 const domainname *const srv, const domainname *const domain,
12449 const mDNSu8 *anondata, const mDNSInterfaceID InterfaceID, mDNSu32 flags,
12450 mDNSBool ForceMCast, mDNSBool useBackgroundTrafficClass,
12451 mDNSQuestionCallback *Callback, void *Context)
12452 {
12453 question->InterfaceID = InterfaceID;
12454 question->flags = flags;
12455 question->Target = zeroAddr;
12456 question->qtype = kDNSType_PTR;
12457 question->qclass = kDNSClass_IN;
12458 question->LongLived = mDNStrue;
12459 question->ExpectUnique = mDNSfalse;
12460 question->ForceMCast = ForceMCast;
12461 question->ReturnIntermed = (flags & kDNSServiceFlagsReturnIntermediates) != 0;
12462 question->SuppressUnusable = mDNSfalse;
12463 question->SearchListIndex = 0;
12464 question->AppendSearchDomains = 0;
12465 question->RetryWithSearchDomains = mDNSfalse;
12466 question->TimeoutQuestion = 0;
12467 question->WakeOnResolve = 0;
12468 question->UseBackgroundTrafficClass = useBackgroundTrafficClass;
12469 question->ValidationRequired = 0;
12470 question->ValidatingResponse = 0;
12471 question->ProxyQuestion = 0;
12472 question->qnameOrig = mDNSNULL;
12473 question->AnonInfo = mDNSNULL;
12474 question->QuestionCallback = Callback;
12475 question->QuestionContext = Context;
12476
12477 if (!ConstructServiceName(&question->qname, mDNSNULL, srv, domain))
12478 return(mStatus_BadParamErr);
12479
12480 if (anondata)
12481 {
12482 question->AnonInfo = AllocateAnonInfo(&question->qname, anondata, mDNSPlatformStrLen(anondata), mDNSNULL);
12483 if (!question->AnonInfo)
12484 return(mStatus_BadParamErr);
12485 }
12486
12487 return(mDNS_StartQuery_internal(m, question));
12488 }
12489
12490 mDNSexport mStatus mDNS_StartBrowse(mDNS *const m, DNSQuestion *const question,
12491 const domainname *const srv, const domainname *const domain,
12492 const mDNSu8 *anondata, const mDNSInterfaceID InterfaceID, mDNSu32 flags,
12493 mDNSBool ForceMCast, mDNSBool useBackgroundTrafficClass,
12494 mDNSQuestionCallback *Callback, void *Context)
12495 {
12496 mStatus status;
12497 mDNS_Lock(m);
12498 status = mDNS_StartBrowse_internal(m, question, srv, domain, anondata, InterfaceID, flags, ForceMCast, useBackgroundTrafficClass, Callback, Context);
12499 mDNS_Unlock(m);
12500 return(status);
12501 }
12502
12503
12504 mDNSexport mStatus mDNS_GetDomains(mDNS *const m, DNSQuestion *const question, mDNS_DomainType DomainType, const domainname *dom,
12505 const mDNSInterfaceID InterfaceID, mDNSQuestionCallback *Callback, void *Context)
12506 {
12507 question->InterfaceID = InterfaceID;
12508 question->flags = 0;
12509 question->Target = zeroAddr;
12510 question->qtype = kDNSType_PTR;
12511 question->qclass = kDNSClass_IN;
12512 question->LongLived = mDNSfalse;
12513 question->ExpectUnique = mDNSfalse;
12514 question->ForceMCast = mDNSfalse;
12515 question->ReturnIntermed = mDNSfalse;
12516 question->SuppressUnusable = mDNSfalse;
12517 question->SearchListIndex = 0;
12518 question->AppendSearchDomains = 0;
12519 question->RetryWithSearchDomains = mDNSfalse;
12520 question->TimeoutQuestion = 0;
12521 question->WakeOnResolve = 0;
12522 question->UseBackgroundTrafficClass = mDNSfalse;
12523 question->ValidationRequired = 0;
12524 question->ValidatingResponse = 0;
12525 question->ProxyQuestion = 0;
12526 question->qnameOrig = mDNSNULL;
12527 question->AnonInfo = mDNSNULL;
12528 question->pid = mDNSPlatformGetPID();
12529 question->euid = 0;
12530 question->QuestionCallback = Callback;
12531 question->QuestionContext = Context;
12532 if (DomainType > mDNS_DomainTypeMax) return(mStatus_BadParamErr);
12533 if (!MakeDomainNameFromDNSNameString(&question->qname, mDNS_DomainTypeNames[DomainType])) return(mStatus_BadParamErr);
12534 if (!dom) dom = &localdomain;
12535 if (!AppendDomainName(&question->qname, dom)) return(mStatus_BadParamErr);
12536 return(mDNS_StartQuery(m, question));
12537 }
12538
12539 // ***************************************************************************
12540 #if COMPILER_LIKES_PRAGMA_MARK
12541 #pragma mark -
12542 #pragma mark - Responder Functions
12543 #endif
12544
12545 mDNSexport mStatus mDNS_Register(mDNS *const m, AuthRecord *const rr)
12546 {
12547 mStatus status;
12548 mDNS_Lock(m);
12549 status = mDNS_Register_internal(m, rr);
12550 mDNS_Unlock(m);
12551 return(status);
12552 }
12553
12554 mDNSexport mStatus mDNS_Update(mDNS *const m, AuthRecord *const rr, mDNSu32 newttl,
12555 const mDNSu16 newrdlength, RData *const newrdata, mDNSRecordUpdateCallback *Callback)
12556 {
12557 if (!ValidateRData(rr->resrec.rrtype, newrdlength, newrdata))
12558 {
12559 LogMsg("Attempt to update record with invalid rdata: %s", GetRRDisplayString_rdb(&rr->resrec, &newrdata->u, m->MsgBuffer));
12560 return(mStatus_Invalid);
12561 }
12562
12563 mDNS_Lock(m);
12564
12565 // If TTL is unspecified, leave TTL unchanged
12566 if (newttl == 0) newttl = rr->resrec.rroriginalttl;
12567
12568 // If we already have an update queued up which has not gone through yet, give the client a chance to free that memory
12569 if (rr->NewRData)
12570 {
12571 RData *n = rr->NewRData;
12572 rr->NewRData = mDNSNULL; // Clear the NewRData pointer ...
12573 if (rr->UpdateCallback)
12574 rr->UpdateCallback(m, rr, n, rr->newrdlength); // ...and let the client free this memory, if necessary
12575 }
12576
12577 rr->NewRData = newrdata;
12578 rr->newrdlength = newrdlength;
12579 rr->UpdateCallback = Callback;
12580
12581 #ifndef UNICAST_DISABLED
12582 if (rr->ARType != AuthRecordLocalOnly && rr->ARType != AuthRecordP2P && !IsLocalDomain(rr->resrec.name))
12583 {
12584 mStatus status = uDNS_UpdateRecord(m, rr);
12585 // The caller frees the memory on error, don't retain stale pointers
12586 if (status != mStatus_NoError) { rr->NewRData = mDNSNULL; rr->newrdlength = 0; }
12587 mDNS_Unlock(m);
12588 return(status);
12589 }
12590 #endif
12591
12592 if (RRLocalOnly(rr) || (rr->resrec.rroriginalttl == newttl &&
12593 rr->resrec.rdlength == newrdlength && mDNSPlatformMemSame(rr->resrec.rdata->u.data, newrdata->u.data, newrdlength)))
12594 CompleteRDataUpdate(m, rr);
12595 else
12596 {
12597 rr->AnnounceCount = InitialAnnounceCount;
12598 InitializeLastAPTime(m, rr);
12599 while (rr->NextUpdateCredit && m->timenow - rr->NextUpdateCredit >= 0) GrantUpdateCredit(rr);
12600 if (!rr->UpdateBlocked && rr->UpdateCredits) rr->UpdateCredits--;
12601 if (!rr->NextUpdateCredit) rr->NextUpdateCredit = NonZeroTime(m->timenow + kUpdateCreditRefreshInterval);
12602 if (rr->AnnounceCount > rr->UpdateCredits + 1) rr->AnnounceCount = (mDNSu8)(rr->UpdateCredits + 1);
12603 if (rr->UpdateCredits <= 5)
12604 {
12605 mDNSu32 delay = 6 - rr->UpdateCredits; // Delay 1 second, then 2, then 3, etc. up to 6 seconds maximum
12606 if (!rr->UpdateBlocked) rr->UpdateBlocked = NonZeroTime(m->timenow + (mDNSs32)delay * mDNSPlatformOneSecond);
12607 rr->ThisAPInterval *= 4;
12608 rr->LastAPTime = rr->UpdateBlocked - rr->ThisAPInterval;
12609 LogMsg("Excessive update rate for %##s; delaying announcement by %ld second%s",
12610 rr->resrec.name->c, delay, delay > 1 ? "s" : "");
12611 }
12612 rr->resrec.rroriginalttl = newttl;
12613 }
12614
12615 mDNS_Unlock(m);
12616 return(mStatus_NoError);
12617 }
12618
12619 // Note: mDNS_Deregister calls mDNS_Deregister_internal which can call a user callback, which may change
12620 // the record list and/or question list.
12621 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
12622 mDNSexport mStatus mDNS_Deregister(mDNS *const m, AuthRecord *const rr)
12623 {
12624 mStatus status;
12625 mDNS_Lock(m);
12626 status = mDNS_Deregister_internal(m, rr, mDNS_Dereg_normal);
12627 mDNS_Unlock(m);
12628 return(status);
12629 }
12630
12631 // Circular reference: AdvertiseInterface references mDNS_HostNameCallback, which calls mDNS_SetFQDN, which call AdvertiseInterface
12632 mDNSlocal void mDNS_HostNameCallback(mDNS *const m, AuthRecord *const rr, mStatus result);
12633
12634 mDNSlocal NetworkInterfaceInfo *FindFirstAdvertisedInterface(mDNS *const m)
12635 {
12636 NetworkInterfaceInfo *intf;
12637 for (intf = m->HostInterfaces; intf; intf = intf->next)
12638 if (intf->Advertise) break;
12639 return(intf);
12640 }
12641
12642 // The parameter "set" here refers to the set of AuthRecords used to advertise this interface.
12643 // (It's a set of records, not a set of interfaces.)
12644 mDNSlocal void AdvertiseInterface(mDNS *const m, NetworkInterfaceInfo *set)
12645 {
12646 char buffer[MAX_REVERSE_MAPPING_NAME];
12647 NetworkInterfaceInfo *primary;
12648 mDNSu8 recordType;
12649
12650 if (m->AutoTargetServices == 0)
12651 {
12652 LogInfo("AdvertiseInterface: Returning due to AutoTargetServices zero for %s", set->ifname);
12653 return;
12654 }
12655
12656 primary = FindFirstAdvertisedInterface(m);
12657 if (!primary) primary = set; // If no existing advertised interface, this new NetworkInterfaceInfo becomes our new primary
12658 // We should never have primary be NULL, because even if there is
12659 // no other interface yet, we should always find ourself in the list.
12660
12661 // If interface is marked as a direct link, we can assume the address record is unique
12662 // and does not need to go through the probe phase of the probe/announce packet sequence.
12663 recordType = (set->DirectLink ? kDNSRecordTypeKnownUnique : kDNSRecordTypeUnique);
12664
12665 if (set->DirectLink)
12666 LogInfo("AdvertiseInterface: Marking address record as kDNSRecordTypeKnownUnique for %s", set->ifname);
12667
12668 // Send dynamic update for non-linklocal IPv4 Addresses
12669 mDNS_SetupResourceRecord(&set->RR_A, mDNSNULL, set->InterfaceID, kDNSType_A, kHostNameTTL, recordType, AuthRecordAny, mDNS_HostNameCallback, set);
12670 mDNS_SetupResourceRecord(&set->RR_PTR, mDNSNULL, set->InterfaceID, kDNSType_PTR, kHostNameTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
12671 mDNS_SetupResourceRecord(&set->RR_HINFO, mDNSNULL, set->InterfaceID, kDNSType_HINFO, kHostNameTTL, kDNSRecordTypeUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
12672
12673 #if ANSWER_REMOTE_HOSTNAME_QUERIES
12674 set->RR_A.AllowRemoteQuery = mDNStrue;
12675 set->RR_PTR.AllowRemoteQuery = mDNStrue;
12676 set->RR_HINFO.AllowRemoteQuery = mDNStrue;
12677 #endif
12678 // 1. Set up Address record to map from host name ("foo.local.") to IP address
12679 // 2. Set up reverse-lookup PTR record to map from our address back to our host name
12680 AssignDomainName(&set->RR_A.namestorage, &m->MulticastHostname);
12681 if (set->ip.type == mDNSAddrType_IPv4)
12682 {
12683 set->RR_A.resrec.rrtype = kDNSType_A;
12684 set->RR_A.resrec.rdata->u.ipv4 = set->ip.ip.v4;
12685 // Note: This is reverse order compared to a normal dotted-decimal IP address, so we can't use our customary "%.4a" format code
12686 mDNS_snprintf(buffer, sizeof(buffer), "%d.%d.%d.%d.in-addr.arpa.",
12687 set->ip.ip.v4.b[3], set->ip.ip.v4.b[2], set->ip.ip.v4.b[1], set->ip.ip.v4.b[0]);
12688 }
12689 else if (set->ip.type == mDNSAddrType_IPv6)
12690 {
12691 int i;
12692 set->RR_A.resrec.rrtype = kDNSType_AAAA;
12693 set->RR_A.resrec.rdata->u.ipv6 = set->ip.ip.v6;
12694 for (i = 0; i < 16; i++)
12695 {
12696 static const char hexValues[] = "0123456789ABCDEF";
12697 buffer[i * 4 ] = hexValues[set->ip.ip.v6.b[15 - i] & 0x0F];
12698 buffer[i * 4 + 1] = '.';
12699 buffer[i * 4 + 2] = hexValues[set->ip.ip.v6.b[15 - i] >> 4];
12700 buffer[i * 4 + 3] = '.';
12701 }
12702 mDNS_snprintf(&buffer[64], sizeof(buffer)-64, "ip6.arpa.");
12703 }
12704
12705 MakeDomainNameFromDNSNameString(&set->RR_PTR.namestorage, buffer);
12706 set->RR_PTR.AutoTarget = Target_AutoHost; // Tell mDNS that the target of this PTR is to be kept in sync with our host name
12707 set->RR_PTR.ForceMCast = mDNStrue; // This PTR points to our dot-local name, so don't ever try to write it into a uDNS server
12708
12709 set->RR_A.RRSet = &primary->RR_A; // May refer to self
12710
12711 mDNS_Register_internal(m, &set->RR_A);
12712 mDNS_Register_internal(m, &set->RR_PTR);
12713
12714 #if APPLE_OSX_mDNSResponder
12715 // must be after the mDNS_Register_internal() calls so that records have complete rdata fields, etc
12716 D2D_start_advertising_interface(set);
12717 #endif // APPLE_OSX_mDNSResponder
12718
12719 if (!NO_HINFO && m->HIHardware.c[0] > 0 && m->HISoftware.c[0] > 0 && m->HIHardware.c[0] + m->HISoftware.c[0] <= 254)
12720 {
12721 mDNSu8 *p = set->RR_HINFO.resrec.rdata->u.data;
12722 AssignDomainName(&set->RR_HINFO.namestorage, &m->MulticastHostname);
12723 set->RR_HINFO.DependentOn = &set->RR_A;
12724 mDNSPlatformMemCopy(p, &m->HIHardware, 1 + (mDNSu32)m->HIHardware.c[0]);
12725 p += 1 + (int)p[0];
12726 mDNSPlatformMemCopy(p, &m->HISoftware, 1 + (mDNSu32)m->HISoftware.c[0]);
12727 mDNS_Register_internal(m, &set->RR_HINFO);
12728 }
12729 else
12730 {
12731 debugf("Not creating HINFO record: platform support layer provided no information");
12732 set->RR_HINFO.resrec.RecordType = kDNSRecordTypeUnregistered;
12733 }
12734 }
12735
12736 mDNSlocal void DeadvertiseInterface(mDNS *const m, NetworkInterfaceInfo *set)
12737 {
12738 if (m->AutoTargetServices == 0)
12739 {
12740 LogInfo("DeadvertiseInterface: Returning due to AutoTargetServices zero for %s", set->ifname);
12741 return;
12742 }
12743
12744 #if APPLE_OSX_mDNSResponder
12745 D2D_stop_advertising_interface(set);
12746 #endif // APPLE_OSX_mDNSResponder
12747
12748 // Unregister these records.
12749 // When doing the mDNS_Exit processing, we first call DeadvertiseInterface for each interface, so by the time the platform
12750 // support layer gets to call mDNS_DeregisterInterface, the address and PTR records have already been deregistered for it.
12751 // Also, in the event of a name conflict, one or more of our records will have been forcibly deregistered.
12752 // To avoid unnecessary and misleading warning messages, we check the RecordType before calling mDNS_Deregister_internal().
12753 if (set->RR_A .resrec.RecordType) mDNS_Deregister_internal(m, &set->RR_A, mDNS_Dereg_normal);
12754 if (set->RR_PTR .resrec.RecordType) mDNS_Deregister_internal(m, &set->RR_PTR, mDNS_Dereg_normal);
12755 if (set->RR_HINFO.resrec.RecordType) mDNS_Deregister_internal(m, &set->RR_HINFO, mDNS_Dereg_normal);
12756 }
12757
12758 mDNSlocal void AdvertiseAllInterfaceRecords(mDNS *const m)
12759 {
12760 NetworkInterfaceInfo *intf;
12761 for (intf = m->HostInterfaces; intf; intf = intf->next)
12762 {
12763 if (intf->Advertise)
12764 {
12765 LogInfo("AdvertiseInterface: Advertising for ifname %s", intf->ifname);
12766 AdvertiseInterface(m, intf);
12767 }
12768 }
12769 }
12770
12771 mDNSlocal void DeadvertiseAllInterfaceRecords(mDNS *const m)
12772 {
12773 NetworkInterfaceInfo *intf;
12774 for (intf = m->HostInterfaces; intf; intf = intf->next)
12775 {
12776 if (intf->Advertise)
12777 {
12778 LogInfo("DeadvertiseInterface: Deadvertising for ifname %s", intf->ifname);
12779 DeadvertiseInterface(m, intf);
12780 }
12781 }
12782 }
12783
12784 // Change target host name for record.
12785 mDNSlocal void UpdateTargetHostName(mDNS *const m, AuthRecord *const rr)
12786 {
12787 #if APPLE_OSX_mDNSResponder
12788 // If this record was also registered with any D2D plugins, stop advertising
12789 // the version with the old host name.
12790 D2D_stop_advertising_record(rr);
12791 #endif
12792
12793 SetTargetToHostName(m, rr);
12794
12795 #if APPLE_OSX_mDNSResponder
12796 // Advertise the record with the updated host name with the D2D plugins if appropriate.
12797 D2D_start_advertising_record(rr);
12798 #endif
12799 }
12800
12801 mDNSexport void mDNS_SetFQDN(mDNS *const m)
12802 {
12803 domainname newmname;
12804 AuthRecord *rr;
12805 newmname.c[0] = 0;
12806
12807 if (!AppendDomainLabel(&newmname, &m->hostlabel)) { LogMsg("ERROR: mDNS_SetFQDN: Cannot create MulticastHostname"); return; }
12808 if (!AppendLiteralLabelString(&newmname, "local")) { LogMsg("ERROR: mDNS_SetFQDN: Cannot create MulticastHostname"); return; }
12809
12810 mDNS_Lock(m);
12811
12812 if (SameDomainNameCS(&m->MulticastHostname, &newmname)) debugf("mDNS_SetFQDN - hostname unchanged");
12813 else
12814 {
12815 AssignDomainName(&m->MulticastHostname, &newmname);
12816 DeadvertiseAllInterfaceRecords(m);
12817 AdvertiseAllInterfaceRecords(m);
12818 }
12819
12820 // 3. Make sure that any AutoTarget SRV records (and the like) get updated
12821 for (rr = m->ResourceRecords; rr; rr=rr->next) if (rr->AutoTarget) UpdateTargetHostName(m, rr);
12822 for (rr = m->DuplicateRecords; rr; rr=rr->next) if (rr->AutoTarget) UpdateTargetHostName(m, rr);
12823
12824 mDNS_Unlock(m);
12825 }
12826
12827 mDNSlocal void mDNS_HostNameCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
12828 {
12829 (void)rr; // Unused parameter
12830
12831 #if MDNS_DEBUGMSGS
12832 {
12833 char *msg = "Unknown result";
12834 if (result == mStatus_NoError) msg = "Name registered";
12835 else if (result == mStatus_NameConflict) msg = "Name conflict";
12836 debugf("mDNS_HostNameCallback: %##s (%s) %s (%ld)", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), msg, result);
12837 }
12838 #endif
12839
12840 if (result == mStatus_NoError)
12841 {
12842 // Notify the client that the host name is successfully registered
12843 if (m->MainCallback)
12844 m->MainCallback(m, mStatus_NoError);
12845 }
12846 else if (result == mStatus_NameConflict)
12847 {
12848 domainlabel oldlabel = m->hostlabel;
12849
12850 // 1. First give the client callback a chance to pick a new name
12851 if (m->MainCallback)
12852 m->MainCallback(m, mStatus_NameConflict);
12853
12854 // 2. If the client callback didn't do it, add (or increment) an index ourselves
12855 // This needs to be case-INSENSITIVE compare, because we need to know that the name has been changed so as to
12856 // remedy the conflict, and a name that differs only in capitalization will just suffer the exact same conflict again.
12857 if (SameDomainLabel(m->hostlabel.c, oldlabel.c))
12858 IncrementLabelSuffix(&m->hostlabel, mDNSfalse);
12859
12860 // 3. Generate the FQDNs from the hostlabel,
12861 // and make sure all SRV records, etc., are updated to reference our new hostname
12862 mDNS_SetFQDN(m);
12863 LogMsg("Local Hostname %#s.local already in use; will try %#s.local instead", oldlabel.c, m->hostlabel.c);
12864 }
12865 else if (result == mStatus_MemFree)
12866 {
12867 // .local hostnames do not require goodbyes - we ignore the MemFree (which is sent directly by
12868 // mDNS_Deregister_internal), and allow the caller to deallocate immediately following mDNS_DeadvertiseInterface
12869 debugf("mDNS_HostNameCallback: MemFree (ignored)");
12870 }
12871 else
12872 LogMsg("mDNS_HostNameCallback: Unknown error %d for registration of record %s", result, rr->resrec.name->c);
12873 }
12874
12875 mDNSlocal void UpdateInterfaceProtocols(mDNS *const m, NetworkInterfaceInfo *active)
12876 {
12877 NetworkInterfaceInfo *intf;
12878 active->IPv4Available = mDNSfalse;
12879 active->IPv6Available = mDNSfalse;
12880 for (intf = m->HostInterfaces; intf; intf = intf->next)
12881 if (intf->InterfaceID == active->InterfaceID)
12882 {
12883 if (intf->ip.type == mDNSAddrType_IPv4 && intf->McastTxRx) active->IPv4Available = mDNStrue;
12884 if (intf->ip.type == mDNSAddrType_IPv6 && intf->McastTxRx) active->IPv6Available = mDNStrue;
12885 }
12886 }
12887
12888 mDNSlocal void RestartRecordGetZoneData(mDNS * const m)
12889 {
12890 AuthRecord *rr;
12891 LogInfo("RestartRecordGetZoneData: ResourceRecords");
12892 for (rr = m->ResourceRecords; rr; rr=rr->next)
12893 if (AuthRecord_uDNS(rr) && rr->state != regState_NoTarget)
12894 {
12895 debugf("RestartRecordGetZoneData: StartGetZoneData for %##s", rr->resrec.name->c);
12896 // Zero out the updateid so that if we have a pending response from the server, it won't
12897 // be accepted as a valid response. If we accept the response, we might free the new "nta"
12898 if (rr->nta) { rr->updateid = zeroID; CancelGetZoneData(m, rr->nta); }
12899 rr->nta = StartGetZoneData(m, rr->resrec.name, ZoneServiceUpdate, RecordRegistrationGotZoneData, rr);
12900 }
12901 }
12902
12903 mDNSlocal void InitializeNetWakeState(mDNS *const m, NetworkInterfaceInfo *set)
12904 {
12905 int i;
12906 // We initialize ThisQInterval to -1 indicating that the question has not been started
12907 // yet. If the question (browse) is started later during interface registration, it will
12908 // be stopped during interface deregistration. We can't sanity check to see if the
12909 // question has been stopped or not before initializing it to -1 because we need to
12910 // initialize it to -1 the very first time.
12911
12912 set->NetWakeBrowse.ThisQInterval = -1;
12913 for (i=0; i<3; i++)
12914 {
12915 set->NetWakeResolve[i].ThisQInterval = -1;
12916 set->SPSAddr[i].type = mDNSAddrType_None;
12917 }
12918 set->NextSPSAttempt = -1;
12919 set->NextSPSAttemptTime = m->timenow;
12920 }
12921
12922 mDNSexport void mDNS_ActivateNetWake_internal(mDNS *const m, NetworkInterfaceInfo *set)
12923 {
12924 NetworkInterfaceInfo *p = m->HostInterfaces;
12925 while (p && p != set) p=p->next;
12926 if (!p) { LogMsg("mDNS_ActivateNetWake_internal: NetworkInterfaceInfo %p not found in active list", set); return; }
12927
12928 if (set->InterfaceActive)
12929 {
12930 LogSPS("ActivateNetWake for %s (%#a)", set->ifname, &set->ip);
12931 mDNS_StartBrowse_internal(m, &set->NetWakeBrowse, &SleepProxyServiceType, &localdomain, mDNSNULL, set->InterfaceID, 0, mDNSfalse, mDNSfalse, m->SPSBrowseCallback, set);
12932 }
12933 }
12934
12935 mDNSexport void mDNS_DeactivateNetWake_internal(mDNS *const m, NetworkInterfaceInfo *set)
12936 {
12937 NetworkInterfaceInfo *p = m->HostInterfaces;
12938 while (p && p != set) p=p->next;
12939 if (!p) { LogMsg("mDNS_DeactivateNetWake_internal: NetworkInterfaceInfo %p not found in active list", set); return; }
12940
12941 // Note: We start the browse only if the interface is NetWake capable and we use this to
12942 // stop the resolves also. Hence, the resolves should not be started without the browse
12943 // being started i.e, resolves should not happen unless NetWake capable which is
12944 // guaranteed by BeginSleepProcessing.
12945 if (set->NetWakeBrowse.ThisQInterval >= 0)
12946 {
12947 int i;
12948 LogSPS("DeactivateNetWake for %s (%#a)", set->ifname, &set->ip);
12949
12950 // Stop our browse and resolve operations
12951 mDNS_StopQuery_internal(m, &set->NetWakeBrowse);
12952 for (i=0; i<3; i++) if (set->NetWakeResolve[i].ThisQInterval >= 0) mDNS_StopQuery_internal(m, &set->NetWakeResolve[i]);
12953
12954 // Make special call to the browse callback to let it know it can to remove all records for this interface
12955 if (m->SPSBrowseCallback)
12956 {
12957 mDNS_DropLockBeforeCallback(); // Allow client to legally make mDNS API calls from the callback
12958 m->SPSBrowseCallback(m, &set->NetWakeBrowse, mDNSNULL, mDNSfalse);
12959 mDNS_ReclaimLockAfterCallback(); // Decrement mDNS_reentrancy to block mDNS API calls again
12960 }
12961
12962 // Reset our variables back to initial state, so we're ready for when NetWake is turned back on
12963 // (includes resetting NetWakeBrowse.ThisQInterval back to -1)
12964 InitializeNetWakeState(m, set);
12965 }
12966 }
12967
12968 mDNSexport mStatus mDNS_RegisterInterface(mDNS *const m, NetworkInterfaceInfo *set, InterfaceActivationSpeed activationSpeed)
12969 {
12970 AuthRecord *rr;
12971 mDNSBool FirstOfType = mDNStrue;
12972 NetworkInterfaceInfo **p = &m->HostInterfaces;
12973
12974 if (!set->InterfaceID)
12975 { LogMsg("mDNS_RegisterInterface: Error! Tried to register a NetworkInterfaceInfo %#a with zero InterfaceID", &set->ip); return(mStatus_Invalid); }
12976
12977 if (!mDNSAddressIsValidNonZero(&set->mask))
12978 { LogMsg("mDNS_RegisterInterface: Error! Tried to register a NetworkInterfaceInfo %#a with invalid mask %#a", &set->ip, &set->mask); return(mStatus_Invalid); }
12979
12980 mDNS_Lock(m);
12981
12982 // Assume this interface will be active now, unless we find a duplicate already in the list
12983 set->InterfaceActive = mDNStrue;
12984 set->IPv4Available = (mDNSu8)(set->ip.type == mDNSAddrType_IPv4 && set->McastTxRx);
12985 set->IPv6Available = (mDNSu8)(set->ip.type == mDNSAddrType_IPv6 && set->McastTxRx);
12986
12987 InitializeNetWakeState(m, set);
12988
12989 // Scan list to see if this InterfaceID is already represented
12990 while (*p)
12991 {
12992 if (*p == set)
12993 {
12994 LogMsg("mDNS_RegisterInterface: Error! Tried to register a NetworkInterfaceInfo that's already in the list");
12995 mDNS_Unlock(m);
12996 return(mStatus_AlreadyRegistered);
12997 }
12998
12999 if ((*p)->InterfaceID == set->InterfaceID)
13000 {
13001 // This InterfaceID already represented by a different interface in the list, so mark this instance inactive for now
13002 set->InterfaceActive = mDNSfalse;
13003 if (set->ip.type == (*p)->ip.type) FirstOfType = mDNSfalse;
13004 if (set->ip.type == mDNSAddrType_IPv4 && set->McastTxRx) (*p)->IPv4Available = mDNStrue;
13005 if (set->ip.type == mDNSAddrType_IPv6 && set->McastTxRx) (*p)->IPv6Available = mDNStrue;
13006 }
13007
13008 p=&(*p)->next;
13009 }
13010
13011 set->next = mDNSNULL;
13012 *p = set;
13013
13014 if (set->Advertise)
13015 AdvertiseInterface(m, set);
13016
13017 LogInfo("mDNS_RegisterInterface: InterfaceID %d %s (%#a) %s",
13018 (uint32_t)set->InterfaceID, set->ifname, &set->ip,
13019 set->InterfaceActive ?
13020 "not represented in list; marking active and retriggering queries" :
13021 "already represented in list; marking inactive for now");
13022
13023 if (set->NetWake) mDNS_ActivateNetWake_internal(m, set);
13024
13025 // In early versions of OS X the IPv6 address remains on an interface even when the interface is turned off,
13026 // giving the false impression that there's an active representative of this interface when there really isn't.
13027 // Therefore, when registering an interface, we want to re-trigger our questions and re-probe our Resource Records,
13028 // even if we believe that we previously had an active representative of this interface.
13029 if (set->McastTxRx && (FirstOfType || set->InterfaceActive))
13030 {
13031 DNSQuestion *q;
13032 // Normally, after an interface comes up, we pause half a second before beginning probing.
13033 // This is to guard against cases where there's rapid interface changes, where we could be confused by
13034 // seeing packets we ourselves sent just moments ago (perhaps when this interface had a different address)
13035 // which are then echoed back after a short delay by some Ethernet switches and some 802.11 base stations.
13036 // We don't want to do a probe, and then see a stale echo of an announcement we ourselves sent,
13037 // and think it's a conflicting answer to our probe.
13038 // In the case of a flapping interface, we pause for five seconds, and reduce the announcement count to one packet.
13039 mDNSs32 probedelay;
13040 mDNSu8 numannounce;
13041 switch (activationSpeed)
13042 {
13043 case FastActivation:
13044 probedelay = (mDNSs32)0;
13045 numannounce = InitialAnnounceCount;
13046 LogMsg("mDNS_RegisterInterface: Using fast activation for DirectLink interface %s (%#a)", set->ifname, &set->ip);
13047 break;
13048
13049 case SlowActivation:
13050 probedelay = mDNSPlatformOneSecond * 5;
13051 numannounce = (mDNSu8)1;
13052 LogMsg("mDNS_RegisterInterface: Frequent transitions for interface %s (%#a), doing slow activation", set->ifname, &set->ip);
13053 m->mDNSStats.InterfaceUpFlap++;
13054 break;
13055
13056 case NormalActivation:
13057 default:
13058 probedelay = mDNSPlatformOneSecond / 2;
13059 numannounce = InitialAnnounceCount;
13060 break;
13061 }
13062
13063 LogInfo("mDNS_RegisterInterface: %s (%#a) probedelay %d", set->ifname, &set->ip, probedelay);
13064
13065 // No probe or sending suppression on DirectLink type interfaces.
13066 if (activationSpeed == FastActivation)
13067 {
13068 m->SuppressSending = 0;
13069 m->SuppressProbes = 0;
13070 }
13071 else
13072 {
13073 // Use a small amount of randomness:
13074 // In the case of a network administrator turning on an Ethernet hub so that all the
13075 // connected machines establish link at exactly the same time, we don't want them all
13076 // to go and hit the network with identical queries at exactly the same moment.
13077 // We set a random delay of up to InitialQuestionInterval (1/3 second).
13078 // We must *never* set m->SuppressSending to more than that (or set it repeatedly in a way
13079 // that causes mDNSResponder to remain in a prolonged state of SuppressSending, because
13080 // suppressing packet sending for more than about 1/3 second can cause protocol correctness
13081 // to start to break down (e.g. we don't answer probes fast enough, and get name conflicts).
13082 // See <rdar://problem/4073853> mDNS: m->SuppressSending set too enthusiastically
13083 if (!m->SuppressSending) m->SuppressSending = m->timenow + (mDNSs32)mDNSRandom((mDNSu32)InitialQuestionInterval);
13084
13085 if (m->SuppressProbes == 0 ||
13086 m->SuppressProbes - NonZeroTime(m->timenow + probedelay) < 0)
13087 m->SuppressProbes = NonZeroTime(m->timenow + probedelay);
13088 }
13089
13090 // Include OWNER option in packets for 60 seconds after connecting to the network. Setting
13091 // it here also handles the wake up case as the network link comes UP after waking causing
13092 // us to reconnect to the network. If we do this as part of the wake up code, it is possible
13093 // that the network link comes UP after 60 seconds and we never set the OWNER option
13094 m->AnnounceOwner = NonZeroTime(m->timenow + 60 * mDNSPlatformOneSecond);
13095 LogInfo("mDNS_RegisterInterface: Setting AnnounceOwner");
13096
13097 m->mDNSStats.InterfaceUp++;
13098 for (q = m->Questions; q; q=q->next) // Scan our list of questions
13099 {
13100 if (mDNSOpaque16IsZero(q->TargetQID))
13101 {
13102 if (!q->InterfaceID || q->InterfaceID == set->InterfaceID) // If non-specific Q, or Q on this specific interface,
13103 { // then reactivate this question
13104 // If flapping, delay between first and second queries is nine seconds instead of one second
13105 mDNSBool dodelay = (activationSpeed == SlowActivation) && (q->FlappingInterface1 == set->InterfaceID || q->FlappingInterface2 == set->InterfaceID);
13106 mDNSs32 initial = dodelay ? InitialQuestionInterval * QuestionIntervalStep2 : InitialQuestionInterval;
13107 mDNSs32 qdelay = dodelay ? kDefaultQueryDelayTimeForFlappingInterface : 0;
13108 if (dodelay) LogInfo("No cache records expired for %##s (%s); delaying questions by %d seconds", q->qname.c, DNSTypeName(q->qtype), qdelay);
13109
13110 if (!q->ThisQInterval || q->ThisQInterval > initial)
13111 {
13112 q->ThisQInterval = initial;
13113 q->RequestUnicast = kDefaultRequestUnicastCount;
13114 }
13115 q->LastQTime = m->timenow - q->ThisQInterval + qdelay;
13116 q->RecentAnswerPkts = 0;
13117 // Change the salt
13118 ReInitAnonInfo(&q->AnonInfo, &q->qname);
13119 SetNextQueryTime(m,q);
13120 }
13121 }
13122 }
13123
13124 // For all our non-specific authoritative resource records (and any dormant records specific to this interface)
13125 // we now need them to re-probe if necessary, and then re-announce.
13126 for (rr = m->ResourceRecords; rr; rr=rr->next)
13127 {
13128 if (!rr->resrec.InterfaceID || rr->resrec.InterfaceID == set->InterfaceID)
13129 {
13130 // Change the salt
13131 ReInitAnonInfo(&rr->resrec.AnonInfo, rr->resrec.name);
13132 mDNSCoreRestartRegistration(m, rr, numannounce);
13133 }
13134 }
13135 #if APPLE_OSX_mDNSResponder && !TARGET_OS_IPHONE
13136 DNSSECProbe(m);
13137 #endif
13138 }
13139
13140 RestartRecordGetZoneData(m);
13141
13142 mDNS_UpdateAllowSleep(m);
13143
13144 mDNS_Unlock(m);
13145 return(mStatus_NoError);
13146 }
13147
13148 // Note: mDNS_DeregisterInterface calls mDNS_Deregister_internal which can call a user callback, which may change
13149 // the record list and/or question list.
13150 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
13151 mDNSexport void mDNS_DeregisterInterface(mDNS *const m, NetworkInterfaceInfo *set, InterfaceActivationSpeed activationSpeed)
13152 {
13153 NetworkInterfaceInfo **p = &m->HostInterfaces;
13154 mDNSBool revalidate = mDNSfalse;
13155 NetworkInterfaceInfo *primary;
13156 NetworkInterfaceInfo *intf;
13157 AuthRecord *A;
13158
13159 mDNS_Lock(m);
13160
13161 // Find this record in our list
13162 while (*p && *p != set) p=&(*p)->next;
13163 if (!*p) { debugf("mDNS_DeregisterInterface: NetworkInterfaceInfo not found in list"); mDNS_Unlock(m); return; }
13164
13165 mDNS_DeactivateNetWake_internal(m, set);
13166
13167 // Unlink this record from our list
13168 *p = (*p)->next;
13169 set->next = mDNSNULL;
13170
13171 if (!set->InterfaceActive)
13172 {
13173 // If this interface not the active member of its set, update the v4/v6Available flags for the active member
13174 for (intf = m->HostInterfaces; intf; intf = intf->next)
13175 if (intf->InterfaceActive && intf->InterfaceID == set->InterfaceID)
13176 UpdateInterfaceProtocols(m, intf);
13177 }
13178 else
13179 {
13180 intf = FirstInterfaceForID(m, set->InterfaceID);
13181 if (intf)
13182 {
13183 LogInfo("mDNS_DeregisterInterface: Another representative of InterfaceID %d %s (%#a) exists;"
13184 " making it active", (uint32_t)set->InterfaceID, set->ifname, &set->ip);
13185 if (intf->InterfaceActive)
13186 LogMsg("mDNS_DeregisterInterface: ERROR intf->InterfaceActive already set for %s (%#a)", set->ifname, &set->ip);
13187 intf->InterfaceActive = mDNStrue;
13188 UpdateInterfaceProtocols(m, intf);
13189
13190 if (intf->NetWake) mDNS_ActivateNetWake_internal(m, intf);
13191
13192 // See if another representative *of the same type* exists. If not, we mave have gone from
13193 // dual-stack to v6-only (or v4-only) so we need to reconfirm which records are still valid.
13194 for (intf = m->HostInterfaces; intf; intf = intf->next)
13195 if (intf->InterfaceID == set->InterfaceID && intf->ip.type == set->ip.type)
13196 break;
13197 if (!intf) revalidate = mDNStrue;
13198 }
13199 else
13200 {
13201 mDNSu32 slot;
13202 CacheGroup *cg;
13203 CacheRecord *rr;
13204 DNSQuestion *q;
13205
13206 LogInfo("mDNS_DeregisterInterface: Last representative of InterfaceID %d %s (%#a) deregistered;"
13207 " marking questions etc. dormant", (uint32_t)set->InterfaceID, set->ifname, &set->ip);
13208
13209 m->mDNSStats.InterfaceDown++;
13210
13211 if (set->McastTxRx && (activationSpeed == SlowActivation))
13212 {
13213 LogMsg("mDNS_DeregisterInterface: Frequent transitions for interface %s (%#a)", set->ifname, &set->ip);
13214 m->mDNSStats.InterfaceDownFlap++;
13215 }
13216
13217 // 1. Deactivate any questions specific to this interface, and tag appropriate questions
13218 // so that mDNS_RegisterInterface() knows how swiftly it needs to reactivate them
13219 for (q = m->Questions; q; q=q->next)
13220 {
13221 if (q->InterfaceID == set->InterfaceID) q->ThisQInterval = 0;
13222 if (!q->InterfaceID || q->InterfaceID == set->InterfaceID)
13223 {
13224 q->FlappingInterface2 = q->FlappingInterface1;
13225 q->FlappingInterface1 = set->InterfaceID; // Keep history of the last two interfaces to go away
13226 }
13227 }
13228
13229 // 2. Flush any cache records received on this interface
13230 revalidate = mDNSfalse; // Don't revalidate if we're flushing the records
13231 FORALL_CACHERECORDS(slot, cg, rr)
13232 {
13233 if (rr->resrec.InterfaceID == set->InterfaceID)
13234 {
13235 // If this interface is deemed flapping,
13236 // postpone deleting the cache records in case the interface comes back again
13237 if (set->McastTxRx && (activationSpeed == SlowActivation))
13238 {
13239 // For a flapping interface we want these records to go away after
13240 // kDefaultReconfirmTimeForFlappingInterface seconds if they are not reconfirmed.
13241 mDNS_Reconfirm_internal(m, rr, kDefaultReconfirmTimeForFlappingInterface);
13242 // We set UnansweredQueries = MaxUnansweredQueries so we don't waste time doing any queries for them --
13243 // if the interface does come back, any relevant questions will be reactivated anyway
13244 rr->UnansweredQueries = MaxUnansweredQueries;
13245 }
13246 else
13247 {
13248 rr->resrec.mortality = Mortality_Mortal;
13249 mDNS_PurgeCacheResourceRecord(m, rr);
13250 }
13251 }
13252 }
13253 }
13254 }
13255
13256 // If we still have address records referring to this one, update them.
13257 // This is safe, because this NetworkInterfaceInfo has already been unlinked from the list,
13258 // so the call to FindFirstAdvertisedInterface() won’t accidentally find it.
13259 primary = FindFirstAdvertisedInterface(m);
13260 A = primary ? &primary->RR_A : mDNSNULL;
13261 for (intf = m->HostInterfaces; intf; intf = intf->next)
13262 if (intf->RR_A.RRSet == &set->RR_A)
13263 intf->RR_A.RRSet = A;
13264
13265 // If we were advertising on this interface, deregister those address and reverse-lookup records now
13266 if (set->Advertise) DeadvertiseInterface(m, set);
13267
13268 // If we have any cache records received on this interface that went away, then re-verify them.
13269 // In some versions of OS X the IPv6 address remains on an interface even when the interface is turned off,
13270 // giving the false impression that there's an active representative of this interface when there really isn't.
13271 // Don't need to do this when shutting down, because *all* interfaces are about to go away
13272 if (revalidate && !m->ShutdownTime)
13273 {
13274 mDNSu32 slot;
13275 CacheGroup *cg;
13276 CacheRecord *rr;
13277 FORALL_CACHERECORDS(slot, cg, rr)
13278 if (rr->resrec.InterfaceID == set->InterfaceID)
13279 mDNS_Reconfirm_internal(m, rr, kDefaultReconfirmTimeForFlappingInterface);
13280 }
13281
13282 mDNS_UpdateAllowSleep(m);
13283
13284 mDNS_Unlock(m);
13285 }
13286
13287 mDNSlocal void SetAnonInfoSRS(ServiceRecordSet *sr, int NumSubTypes)
13288 {
13289 int i, len;
13290
13291 if (!sr->AnonData)
13292 return;
13293
13294 len = mDNSPlatformStrLen(sr->AnonData);
13295 if (sr->RR_PTR.resrec.AnonInfo)
13296 {
13297 LogMsg("SetAnonInfoSRS: Freeing AnonInfo for PTR record %##s, should have been freed already", sr->RR_PTR.resrec.name->c);
13298 FreeAnonInfo(sr->RR_PTR.resrec.AnonInfo);
13299 }
13300 sr->RR_PTR.resrec.AnonInfo = AllocateAnonInfo(sr->RR_PTR.resrec.name, sr->AnonData, len, mDNSNULL);
13301 for (i=0; i<NumSubTypes; i++)
13302 {
13303 if (sr->SubTypes[i].resrec.AnonInfo)
13304 {
13305 LogMsg("SetAnonInfoSRS: Freeing AnonInfo for subtype record %##s, should have been freed already", sr->SubTypes[i].resrec.name->c);
13306 FreeAnonInfo(sr->SubTypes[i].resrec.AnonInfo);
13307 }
13308 sr->SubTypes[i].resrec.AnonInfo = AllocateAnonInfo(sr->SubTypes[i].resrec.name, sr->AnonData, len, mDNSNULL);
13309 }
13310 }
13311
13312 mDNSlocal void ResetAnonInfoSRS(ServiceRecordSet *sr, int NumSubTypes)
13313 {
13314 int i;
13315
13316 if (!sr->AnonData)
13317 return;
13318 if (sr->RR_PTR.resrec.AnonInfo)
13319 {
13320 FreeAnonInfo(sr->RR_PTR.resrec.AnonInfo);
13321 sr->RR_PTR.resrec.AnonInfo = mDNSNULL;
13322 }
13323 for (i=0; i<NumSubTypes; i++)
13324 {
13325 if (sr->SubTypes[i].resrec.AnonInfo)
13326 {
13327 FreeAnonInfo(sr->SubTypes[i].resrec.AnonInfo);
13328 sr->SubTypes[i].resrec.AnonInfo = mDNSNULL;
13329 }
13330 }
13331 }
13332
13333 mDNSlocal void ServiceCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
13334 {
13335 ServiceRecordSet *sr = (ServiceRecordSet *)rr->RecordContext;
13336 (void)m; // Unused parameter
13337
13338 #if MDNS_DEBUGMSGS
13339 {
13340 char *msg = "Unknown result";
13341 if (result == mStatus_NoError) msg = "Name Registered";
13342 else if (result == mStatus_NameConflict) msg = "Name Conflict";
13343 else if (result == mStatus_MemFree) msg = "Memory Free";
13344 debugf("ServiceCallback: %##s (%s) %s (%d)", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), msg, result);
13345 }
13346 #endif
13347
13348 // Only pass on the NoError acknowledgement for the SRV record (when it finishes probing)
13349 if (result == mStatus_NoError && rr != &sr->RR_SRV) return;
13350
13351 // If we got a name conflict on either SRV or TXT, forcibly deregister this service, and record that we did that
13352 if (result == mStatus_NameConflict)
13353 {
13354 sr->Conflict = mDNStrue; // Record that this service set had a conflict
13355 mDNS_DeregisterService(m, sr); // Unlink the records from our list
13356 return;
13357 }
13358
13359 if (result == mStatus_MemFree)
13360 {
13361 // If the SRV/TXT/PTR records, or the _services._dns-sd._udp record, or any of the subtype PTR records,
13362 // are still in the process of deregistering, don't pass on the NameConflict/MemFree message until
13363 // every record is finished cleaning up.
13364 mDNSu32 i;
13365 ExtraResourceRecord *e = sr->Extras;
13366
13367 if (sr->RR_SRV.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13368 if (sr->RR_TXT.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13369 if (sr->RR_PTR.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13370 if (sr->RR_ADV.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13371 for (i=0; i<sr->NumSubTypes; i++) if (sr->SubTypes[i].resrec.RecordType != kDNSRecordTypeUnregistered) return;
13372
13373 while (e)
13374 {
13375 if (e->r.resrec.RecordType != kDNSRecordTypeUnregistered) return;
13376 e = e->next;
13377 }
13378 ResetAnonInfoSRS(sr, sr->NumSubTypes);
13379
13380 // If this ServiceRecordSet was forcibly deregistered, and now its memory is ready for reuse,
13381 // then we can now report the NameConflict to the client
13382 if (sr->Conflict) result = mStatus_NameConflict;
13383
13384 }
13385
13386 LogInfo("ServiceCallback: All records %s for %##s", (result == mStatus_MemFree ? "Unregistered" : "Registered"), sr->RR_PTR.resrec.name->c);
13387 // CAUTION: MUST NOT do anything more with sr after calling sr->Callback(), because the client's callback
13388 // function is allowed to do anything, including deregistering this service and freeing its memory.
13389 if (sr->ServiceCallback)
13390 sr->ServiceCallback(m, sr, result);
13391 }
13392
13393 mDNSlocal void NSSCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
13394 {
13395 ServiceRecordSet *sr = (ServiceRecordSet *)rr->RecordContext;
13396 if (sr->ServiceCallback)
13397 sr->ServiceCallback(m, sr, result);
13398 }
13399
13400
13401 // Derive AuthRecType from the kDNSServiceFlags* values.
13402 mDNSlocal AuthRecType setAuthRecType(mDNSInterfaceID InterfaceID, mDNSu32 flags)
13403 {
13404 AuthRecType artype;
13405
13406 if (InterfaceID == mDNSInterface_LocalOnly)
13407 artype = AuthRecordLocalOnly;
13408 else if (InterfaceID == mDNSInterface_P2P || InterfaceID == mDNSInterface_BLE)
13409 artype = AuthRecordP2P;
13410 else if ((InterfaceID == mDNSInterface_Any) && (flags & kDNSServiceFlagsIncludeP2P)
13411 && (flags & kDNSServiceFlagsIncludeAWDL))
13412 artype = AuthRecordAnyIncludeAWDLandP2P;
13413 else if ((InterfaceID == mDNSInterface_Any) && (flags & kDNSServiceFlagsIncludeP2P))
13414 artype = AuthRecordAnyIncludeP2P;
13415 else if ((InterfaceID == mDNSInterface_Any) && (flags & kDNSServiceFlagsIncludeAWDL))
13416 artype = AuthRecordAnyIncludeAWDL;
13417 else
13418 artype = AuthRecordAny;
13419
13420 return artype;
13421 }
13422
13423 // Used to derive the original D2D specific flags specified by the client in the registration
13424 // when we don't have access to the original flag (kDNSServiceFlags*) values.
13425 mDNSexport mDNSu32 deriveD2DFlagsFromAuthRecType(AuthRecType authRecType)
13426 {
13427 mDNSu32 flags = 0;
13428 if ((authRecType == AuthRecordAnyIncludeP2P) || (authRecType == AuthRecordAnyIncludeAWDLandP2P))
13429 flags |= kDNSServiceFlagsIncludeP2P;
13430 else if ((authRecType == AuthRecordAnyIncludeAWDL) || (authRecType == AuthRecordAnyIncludeAWDLandP2P))
13431 flags |= kDNSServiceFlagsIncludeAWDL;
13432 return flags;
13433 }
13434
13435 // Note:
13436 // Name is first label of domain name (any dots in the name are actual dots, not label separators)
13437 // Type is service type (e.g. "_ipp._tcp.")
13438 // Domain is fully qualified domain name (i.e. ending with a null label)
13439 // We always register a TXT, even if it is empty (so that clients are not
13440 // left waiting forever looking for a nonexistent record.)
13441 // If the host parameter is mDNSNULL or the root domain (ASCII NUL),
13442 // then the default host name (m->MulticastHostname) is automatically used
13443 // If the optional target host parameter is set, then the storage it points to must remain valid for the lifetime of the service registration
13444 mDNSexport mStatus mDNS_RegisterService(mDNS *const m, ServiceRecordSet *sr,
13445 const domainlabel *const name, const domainname *const type, const domainname *const domain,
13446 const domainname *const host, mDNSIPPort port, RData *const txtrdata, const mDNSu8 txtinfo[], mDNSu16 txtlen,
13447 AuthRecord *SubTypes, mDNSu32 NumSubTypes,
13448 mDNSInterfaceID InterfaceID, mDNSServiceCallback Callback, void *Context, mDNSu32 flags)
13449 {
13450 mStatus err;
13451 mDNSu32 i;
13452 mDNSu32 hostTTL;
13453 AuthRecType artype;
13454 mDNSu8 recordType = (flags & kDNSServiceFlagsKnownUnique) ? kDNSRecordTypeKnownUnique : kDNSRecordTypeUnique;
13455
13456 sr->ServiceCallback = Callback;
13457 sr->ServiceContext = Context;
13458 sr->Conflict = mDNSfalse;
13459
13460 sr->Extras = mDNSNULL;
13461 sr->NumSubTypes = NumSubTypes;
13462 sr->SubTypes = SubTypes;
13463 sr->flags = flags;
13464
13465 artype = setAuthRecType(InterfaceID, flags);
13466
13467 // Initialize the AuthRecord objects to sane values
13468 // Need to initialize everything correctly *before* making the decision whether to do a RegisterNoSuchService and bail out
13469 mDNS_SetupResourceRecord(&sr->RR_ADV, mDNSNULL, InterfaceID, kDNSType_PTR, kStandardTTL, kDNSRecordTypeAdvisory, artype, ServiceCallback, sr);
13470 mDNS_SetupResourceRecord(&sr->RR_PTR, mDNSNULL, InterfaceID, kDNSType_PTR, kStandardTTL, kDNSRecordTypeShared, artype, ServiceCallback, sr);
13471
13472 if (flags & kDNSServiceFlagsWakeOnlyService)
13473 {
13474 sr->RR_PTR.AuthFlags = AuthFlagsWakeOnly;
13475 }
13476
13477 if (SameDomainName(type, (const domainname *) "\x4" "_ubd" "\x4" "_tcp"))
13478 hostTTL = kHostNameSmallTTL;
13479 else
13480 hostTTL = kHostNameTTL;
13481
13482 mDNS_SetupResourceRecord(&sr->RR_SRV, mDNSNULL, InterfaceID, kDNSType_SRV, hostTTL, recordType, artype, ServiceCallback, sr);
13483 mDNS_SetupResourceRecord(&sr->RR_TXT, txtrdata, InterfaceID, kDNSType_TXT, kStandardTTL, recordType, artype, ServiceCallback, sr);
13484
13485 // If port number is zero, that means the client is really trying to do a RegisterNoSuchService
13486 if (mDNSIPPortIsZero(port))
13487 return(mDNS_RegisterNoSuchService(m, &sr->RR_SRV, name, type, domain, mDNSNULL, InterfaceID, NSSCallback, sr, flags));
13488
13489 // If the caller is registering an oversized TXT record,
13490 // it is the caller's responsibility to allocate a ServiceRecordSet structure that is large enough for it
13491 if (sr->RR_TXT.resrec.rdata->MaxRDLength < txtlen)
13492 sr->RR_TXT.resrec.rdata->MaxRDLength = txtlen;
13493
13494 // Set up the record names
13495 // For now we only create an advisory record for the main type, not for subtypes
13496 // We need to gain some operational experience before we decide if there's a need to create them for subtypes too
13497 if (ConstructServiceName(&sr->RR_ADV.namestorage, (const domainlabel*)"\x09_services", (const domainname*)"\x07_dns-sd\x04_udp", domain) == mDNSNULL)
13498 return(mStatus_BadParamErr);
13499 if (ConstructServiceName(&sr->RR_PTR.namestorage, mDNSNULL, type, domain) == mDNSNULL) return(mStatus_BadParamErr);
13500 if (ConstructServiceName(&sr->RR_SRV.namestorage, name, type, domain) == mDNSNULL) return(mStatus_BadParamErr);
13501 AssignDomainName(&sr->RR_TXT.namestorage, sr->RR_SRV.resrec.name);
13502
13503 // 1. Set up the ADV record rdata to advertise our service type
13504 AssignDomainName(&sr->RR_ADV.resrec.rdata->u.name, sr->RR_PTR.resrec.name);
13505
13506 // 2. Set up the PTR record rdata to point to our service name
13507 // We set up two additionals, so when a client asks for this PTR we automatically send the SRV and the TXT too
13508 // Note: uDNS registration code assumes that Additional1 points to the SRV record
13509 AssignDomainName(&sr->RR_PTR.resrec.rdata->u.name, sr->RR_SRV.resrec.name);
13510 sr->RR_PTR.Additional1 = &sr->RR_SRV;
13511 sr->RR_PTR.Additional2 = &sr->RR_TXT;
13512
13513 // 2a. Set up any subtype PTRs to point to our service name
13514 // If the client is using subtypes, it is the client's responsibility to have
13515 // already set the first label of the record name to the subtype being registered
13516 for (i=0; i<NumSubTypes; i++)
13517 {
13518 domainname st;
13519 AssignDomainName(&st, sr->SubTypes[i].resrec.name);
13520 st.c[1+st.c[0]] = 0; // Only want the first label, not the whole FQDN (particularly for mDNS_RenameAndReregisterService())
13521 AppendDomainName(&st, type);
13522 mDNS_SetupResourceRecord(&sr->SubTypes[i], mDNSNULL, InterfaceID, kDNSType_PTR, kStandardTTL, kDNSRecordTypeShared, artype, ServiceCallback, sr);
13523 if (ConstructServiceName(&sr->SubTypes[i].namestorage, mDNSNULL, &st, domain) == mDNSNULL) return(mStatus_BadParamErr);
13524 AssignDomainName(&sr->SubTypes[i].resrec.rdata->u.name, &sr->RR_SRV.namestorage);
13525 sr->SubTypes[i].Additional1 = &sr->RR_SRV;
13526 sr->SubTypes[i].Additional2 = &sr->RR_TXT;
13527 }
13528
13529 SetAnonInfoSRS(sr, NumSubTypes);
13530
13531 // 3. Set up the SRV record rdata.
13532 sr->RR_SRV.resrec.rdata->u.srv.priority = 0;
13533 sr->RR_SRV.resrec.rdata->u.srv.weight = 0;
13534 sr->RR_SRV.resrec.rdata->u.srv.port = port;
13535
13536 // Setting AutoTarget tells DNS that the target of this SRV is to be automatically kept in sync with our host name
13537 if (host && host->c[0]) AssignDomainName(&sr->RR_SRV.resrec.rdata->u.srv.target, host);
13538 else { sr->RR_SRV.AutoTarget = Target_AutoHost; sr->RR_SRV.resrec.rdata->u.srv.target.c[0] = '\0'; }
13539
13540 // 4. Set up the TXT record rdata,
13541 // and set DependentOn because we're depending on the SRV record to find and resolve conflicts for us
13542 // Note: uDNS registration code assumes that DependentOn points to the SRV record
13543 if (txtinfo == mDNSNULL) sr->RR_TXT.resrec.rdlength = 0;
13544 else if (txtinfo != sr->RR_TXT.resrec.rdata->u.txt.c)
13545 {
13546 sr->RR_TXT.resrec.rdlength = txtlen;
13547 if (sr->RR_TXT.resrec.rdlength > sr->RR_TXT.resrec.rdata->MaxRDLength) return(mStatus_BadParamErr);
13548 mDNSPlatformMemCopy(sr->RR_TXT.resrec.rdata->u.txt.c, txtinfo, txtlen);
13549 }
13550 sr->RR_TXT.DependentOn = &sr->RR_SRV;
13551
13552 mDNS_Lock(m);
13553 // It is important that we register SRV first. uDNS assumes that SRV is registered first so
13554 // that if the SRV cannot find a target, rest of the records that belong to this service
13555 // will not be activated.
13556 err = mDNS_Register_internal(m, &sr->RR_SRV);
13557 // If we can't register the SRV record due to errors, bail out. It has not been inserted in
13558 // any list and hence no need to deregister. We could probably do similar checks for other
13559 // records below and bail out. For now, this seems to be sufficient to address rdar://9304275
13560 if (err)
13561 {
13562 mDNS_Unlock(m);
13563 return err;
13564 }
13565 if (!err) err = mDNS_Register_internal(m, &sr->RR_TXT);
13566 // We register the RR_PTR last, because we want to be sure that in the event of a forced call to
13567 // mDNS_StartExit, the RR_PTR will be the last one to be forcibly deregistered, since that is what triggers
13568 // the mStatus_MemFree callback to ServiceCallback, which in turn passes on the mStatus_MemFree back to
13569 // the client callback, which is then at liberty to free the ServiceRecordSet memory at will. We need to
13570 // make sure we've deregistered all our records and done any other necessary cleanup before that happens.
13571 if (!err) err = mDNS_Register_internal(m, &sr->RR_ADV);
13572 for (i=0; i<NumSubTypes; i++) if (!err) err = mDNS_Register_internal(m, &sr->SubTypes[i]);
13573 if (!err) err = mDNS_Register_internal(m, &sr->RR_PTR);
13574
13575 mDNS_Unlock(m);
13576
13577 if (err) mDNS_DeregisterService(m, sr);
13578 return(err);
13579 }
13580
13581 mDNSexport mStatus mDNS_AddRecordToService(mDNS *const m, ServiceRecordSet *sr,
13582 ExtraResourceRecord *extra, RData *rdata, mDNSu32 ttl, mDNSu32 flags)
13583 {
13584 ExtraResourceRecord **e;
13585 mStatus status;
13586 AuthRecType artype;
13587 mDNSInterfaceID InterfaceID = sr->RR_PTR.resrec.InterfaceID;
13588 ResourceRecord *rr;
13589
13590 artype = setAuthRecType(InterfaceID, flags);
13591
13592 extra->next = mDNSNULL;
13593 mDNS_SetupResourceRecord(&extra->r, rdata, sr->RR_PTR.resrec.InterfaceID,
13594 extra->r.resrec.rrtype, ttl, kDNSRecordTypeUnique, artype, ServiceCallback, sr);
13595 AssignDomainName(&extra->r.namestorage, sr->RR_SRV.resrec.name);
13596
13597 mDNS_Lock(m);
13598 rr = mDNSNULL;
13599 if (extra->r.resrec.rrtype == kDNSType_TXT)
13600 {
13601 if (sr->RR_TXT.resrec.RecordType & kDNSRecordTypeUniqueMask) rr = &sr->RR_TXT.resrec;
13602 }
13603 else if (extra->r.resrec.rrtype == kDNSType_SRV)
13604 {
13605 if (sr->RR_SRV.resrec.RecordType & kDNSRecordTypeUniqueMask) rr = &sr->RR_SRV.resrec;
13606 }
13607
13608 if (!rr)
13609 {
13610 ExtraResourceRecord *srExtra;
13611
13612 for (srExtra = sr->Extras; srExtra; srExtra = srExtra->next)
13613 {
13614 if ((srExtra->r.resrec.rrtype == extra->r.resrec.rrtype) && (srExtra->r.resrec.RecordType & kDNSRecordTypeUniqueMask))
13615 {
13616 rr = &srExtra->r.resrec;
13617 break;
13618 }
13619 }
13620 }
13621
13622 if (rr && (extra->r.resrec.rroriginalttl != rr->rroriginalttl))
13623 {
13624 LogMsg("mDNS_AddRecordToService: Correcting TTL from %4d to %4d for %s",
13625 extra->r.resrec.rroriginalttl, rr->rroriginalttl, RRDisplayString(m, &extra->r.resrec));
13626 extra->r.resrec.rroriginalttl = rr->rroriginalttl;
13627 }
13628
13629 e = &sr->Extras;
13630 while (*e) e = &(*e)->next;
13631
13632 extra->r.DependentOn = &sr->RR_SRV;
13633
13634 debugf("mDNS_AddRecordToService adding record to %##s %s %d",
13635 extra->r.resrec.name->c, DNSTypeName(extra->r.resrec.rrtype), extra->r.resrec.rdlength);
13636
13637 status = mDNS_Register_internal(m, &extra->r);
13638 if (status == mStatus_NoError) *e = extra;
13639
13640 mDNS_Unlock(m);
13641 return(status);
13642 }
13643
13644 mDNSexport mStatus mDNS_RemoveRecordFromService(mDNS *const m, ServiceRecordSet *sr, ExtraResourceRecord *extra,
13645 mDNSRecordCallback MemFreeCallback, void *Context)
13646 {
13647 ExtraResourceRecord **e;
13648 mStatus status;
13649
13650 mDNS_Lock(m);
13651 e = &sr->Extras;
13652 while (*e && *e != extra) e = &(*e)->next;
13653 if (!*e)
13654 {
13655 debugf("mDNS_RemoveRecordFromService failed to remove record from %##s", extra->r.resrec.name->c);
13656 status = mStatus_BadReferenceErr;
13657 }
13658 else
13659 {
13660 debugf("mDNS_RemoveRecordFromService removing record from %##s", extra->r.resrec.name->c);
13661 extra->r.RecordCallback = MemFreeCallback;
13662 extra->r.RecordContext = Context;
13663 *e = (*e)->next;
13664 status = mDNS_Deregister_internal(m, &extra->r, mDNS_Dereg_normal);
13665 }
13666 mDNS_Unlock(m);
13667 return(status);
13668 }
13669
13670 mDNSexport mStatus mDNS_RenameAndReregisterService(mDNS *const m, ServiceRecordSet *const sr, const domainlabel *newname)
13671 {
13672 // Note: Don't need to use mDNS_Lock(m) here, because this code is just using public routines
13673 // mDNS_RegisterService() and mDNS_AddRecordToService(), which do the right locking internally.
13674 domainlabel name1, name2;
13675 domainname type, domain;
13676 const domainname *host = sr->RR_SRV.AutoTarget ? mDNSNULL : &sr->RR_SRV.resrec.rdata->u.srv.target;
13677 ExtraResourceRecord *extras = sr->Extras;
13678 mStatus err;
13679
13680 DeconstructServiceName(sr->RR_SRV.resrec.name, &name1, &type, &domain);
13681 if (!newname)
13682 {
13683 name2 = name1;
13684 IncrementLabelSuffix(&name2, mDNStrue);
13685 newname = &name2;
13686 }
13687
13688 if (SameDomainName(&domain, &localdomain))
13689 debugf("%##s service renamed from \"%#s\" to \"%#s\"", type.c, name1.c, newname->c);
13690 else debugf("%##s service (domain %##s) renamed from \"%#s\" to \"%#s\"",type.c, domain.c, name1.c, newname->c);
13691
13692 err = mDNS_RegisterService(m, sr, newname, &type, &domain,
13693 host, sr->RR_SRV.resrec.rdata->u.srv.port,
13694 (sr->RR_TXT.resrec.rdata != &sr->RR_TXT.rdatastorage) ? sr->RR_TXT.resrec.rdata : mDNSNULL,
13695 sr->RR_TXT.resrec.rdata->u.txt.c, sr->RR_TXT.resrec.rdlength,
13696 sr->SubTypes, sr->NumSubTypes,
13697 sr->RR_PTR.resrec.InterfaceID, sr->ServiceCallback, sr->ServiceContext, sr->flags);
13698
13699 // mDNS_RegisterService() just reset sr->Extras to NULL.
13700 // Fortunately we already grabbed ourselves a copy of this pointer (above), so we can now run
13701 // through the old list of extra records, and re-add them to our freshly created service registration
13702 while (!err && extras)
13703 {
13704 ExtraResourceRecord *e = extras;
13705 extras = extras->next;
13706 err = mDNS_AddRecordToService(m, sr, e, e->r.resrec.rdata, e->r.resrec.rroriginalttl, 0);
13707 }
13708
13709 return(err);
13710 }
13711
13712 // Note: mDNS_DeregisterService calls mDNS_Deregister_internal which can call a user callback,
13713 // which may change the record list and/or question list.
13714 // Any code walking either list must use the CurrentQuestion and/or CurrentRecord mechanism to protect against this.
13715 mDNSexport mStatus mDNS_DeregisterService_drt(mDNS *const m, ServiceRecordSet *sr, mDNS_Dereg_type drt)
13716 {
13717 // If port number is zero, that means this was actually registered using mDNS_RegisterNoSuchService()
13718 if (mDNSIPPortIsZero(sr->RR_SRV.resrec.rdata->u.srv.port)) return(mDNS_DeregisterNoSuchService(m, &sr->RR_SRV));
13719
13720 if (sr->RR_PTR.resrec.RecordType == kDNSRecordTypeUnregistered)
13721 {
13722 debugf("Service set for %##s already deregistered", sr->RR_SRV.resrec.name->c);
13723 return(mStatus_BadReferenceErr);
13724 }
13725 else if (sr->RR_PTR.resrec.RecordType == kDNSRecordTypeDeregistering)
13726 {
13727 LogInfo("Service set for %##s already in the process of deregistering", sr->RR_SRV.resrec.name->c);
13728 // Avoid race condition:
13729 // If a service gets a conflict, then we set the Conflict flag to tell us to generate
13730 // an mStatus_NameConflict message when we get the mStatus_MemFree for our PTR record.
13731 // If the client happens to deregister the service in the middle of that process, then
13732 // we clear the flag back to the normal state, so that we deliver a plain mStatus_MemFree
13733 // instead of incorrectly promoting it to mStatus_NameConflict.
13734 // This race condition is exposed particularly when the conformance test generates
13735 // a whole batch of simultaneous conflicts across a range of services all advertised
13736 // using the same system default name, and if we don't take this precaution then
13737 // we end up incrementing m->nicelabel multiple times instead of just once.
13738 // <rdar://problem/4060169> Bug when auto-renaming Computer Name after name collision
13739 sr->Conflict = mDNSfalse;
13740 return(mStatus_NoError);
13741 }
13742 else
13743 {
13744 mDNSu32 i;
13745 mStatus status;
13746 ExtraResourceRecord *e;
13747 mDNS_Lock(m);
13748 e = sr->Extras;
13749
13750 // We use mDNS_Dereg_repeat because, in the event of a collision, some or all of the
13751 // SRV, TXT, or Extra records could have already been automatically deregistered, and that's okay
13752 mDNS_Deregister_internal(m, &sr->RR_SRV, mDNS_Dereg_repeat);
13753 mDNS_Deregister_internal(m, &sr->RR_TXT, mDNS_Dereg_repeat);
13754
13755 mDNS_Deregister_internal(m, &sr->RR_ADV, drt);
13756
13757 // We deregister all of the extra records, but we leave the sr->Extras list intact
13758 // in case the client wants to do a RenameAndReregister and reinstate the registration
13759 while (e)
13760 {
13761 mDNS_Deregister_internal(m, &e->r, mDNS_Dereg_repeat);
13762 e = e->next;
13763 }
13764
13765 for (i=0; i<sr->NumSubTypes; i++)
13766 mDNS_Deregister_internal(m, &sr->SubTypes[i], drt);
13767
13768 status = mDNS_Deregister_internal(m, &sr->RR_PTR, drt);
13769 mDNS_Unlock(m);
13770 return(status);
13771 }
13772 }
13773
13774 // Create a registration that asserts that no such service exists with this name.
13775 // This can be useful where there is a given function is available through several protocols.
13776 // For example, a printer called "Stuart's Printer" may implement printing via the "pdl-datastream" and "IPP"
13777 // protocols, but not via "LPR". In this case it would be prudent for the printer to assert the non-existence of an
13778 // "LPR" service called "Stuart's Printer". Without this precaution, another printer than offers only "LPR" printing
13779 // could inadvertently advertise its service under the same name "Stuart's Printer", which might be confusing for users.
13780 mDNSexport mStatus mDNS_RegisterNoSuchService(mDNS *const m, AuthRecord *const rr,
13781 const domainlabel *const name, const domainname *const type, const domainname *const domain,
13782 const domainname *const host,
13783 const mDNSInterfaceID InterfaceID, mDNSRecordCallback Callback, void *Context, mDNSu32 flags)
13784 {
13785 AuthRecType artype;
13786
13787 artype = setAuthRecType(InterfaceID, flags);
13788
13789 mDNS_SetupResourceRecord(rr, mDNSNULL, InterfaceID, kDNSType_SRV, kHostNameTTL, kDNSRecordTypeUnique, artype, Callback, Context);
13790 if (ConstructServiceName(&rr->namestorage, name, type, domain) == mDNSNULL) return(mStatus_BadParamErr);
13791 rr->resrec.rdata->u.srv.priority = 0;
13792 rr->resrec.rdata->u.srv.weight = 0;
13793 rr->resrec.rdata->u.srv.port = zeroIPPort;
13794 if (host && host->c[0]) AssignDomainName(&rr->resrec.rdata->u.srv.target, host);
13795 else rr->AutoTarget = Target_AutoHost;
13796 return(mDNS_Register(m, rr));
13797 }
13798
13799 mDNSexport mStatus mDNS_AdvertiseDomains(mDNS *const m, AuthRecord *rr,
13800 mDNS_DomainType DomainType, const mDNSInterfaceID InterfaceID, char *domname)
13801 {
13802 AuthRecType artype;
13803
13804 if (InterfaceID == mDNSInterface_LocalOnly)
13805 artype = AuthRecordLocalOnly;
13806 else if (InterfaceID == mDNSInterface_P2P || InterfaceID == mDNSInterface_BLE)
13807 artype = AuthRecordP2P;
13808 else
13809 artype = AuthRecordAny;
13810 mDNS_SetupResourceRecord(rr, mDNSNULL, InterfaceID, kDNSType_PTR, kStandardTTL, kDNSRecordTypeShared, artype, mDNSNULL, mDNSNULL);
13811 if (!MakeDomainNameFromDNSNameString(&rr->namestorage, mDNS_DomainTypeNames[DomainType])) return(mStatus_BadParamErr);
13812 if (!MakeDomainNameFromDNSNameString(&rr->resrec.rdata->u.name, domname)) return(mStatus_BadParamErr);
13813 return(mDNS_Register(m, rr));
13814 }
13815
13816 mDNSlocal mDNSBool mDNS_IdUsedInResourceRecordsList(mDNS * const m, mDNSOpaque16 id)
13817 {
13818 AuthRecord *r;
13819 for (r = m->ResourceRecords; r; r=r->next) if (mDNSSameOpaque16(id, r->updateid)) return mDNStrue;
13820 return mDNSfalse;
13821 }
13822
13823 mDNSlocal mDNSBool mDNS_IdUsedInQuestionsList(mDNS * const m, mDNSOpaque16 id)
13824 {
13825 DNSQuestion *q;
13826 for (q = m->Questions; q; q=q->next) if (mDNSSameOpaque16(id, q->TargetQID)) return mDNStrue;
13827 return mDNSfalse;
13828 }
13829
13830 mDNSexport mDNSOpaque16 mDNS_NewMessageID(mDNS * const m)
13831 {
13832 mDNSOpaque16 id;
13833 int i;
13834
13835 for (i=0; i<10; i++)
13836 {
13837 id = mDNSOpaque16fromIntVal(1 + (mDNSu16)mDNSRandom(0xFFFE));
13838 if (!mDNS_IdUsedInResourceRecordsList(m, id) && !mDNS_IdUsedInQuestionsList(m, id)) break;
13839 }
13840
13841 debugf("mDNS_NewMessageID: %5d", mDNSVal16(id));
13842
13843 return id;
13844 }
13845
13846 // ***************************************************************************
13847 #if COMPILER_LIKES_PRAGMA_MARK
13848 #pragma mark -
13849 #pragma mark - Sleep Proxy Server
13850 #endif
13851
13852 mDNSlocal void RestartARPProbing(mDNS *const m, AuthRecord *const rr)
13853 {
13854 // If we see an ARP from a machine we think is sleeping, then either
13855 // (i) the machine has woken, or
13856 // (ii) it's just a stray old packet from before the machine slept
13857 // To handle the second case, we reset ProbeCount, so we'll suppress our own answers for a while, to avoid
13858 // generating ARP conflicts with a waking machine, and set rr->LastAPTime so we'll start probing again in 10 seconds.
13859 // If the machine has just woken then we'll discard our records when we see the first new mDNS probe from that machine.
13860 // If it was a stray old packet, then after 10 seconds we'll probe again and then start answering ARPs again. In this case we *do*
13861 // need to send new ARP Announcements, because the owner's ARP broadcasts will have updated neighboring ARP caches, so we need to
13862 // re-assert our (temporary) ownership of that IP address in order to receive subsequent packets addressed to that IPv4 address.
13863
13864 rr->resrec.RecordType = kDNSRecordTypeUnique;
13865 rr->ProbeCount = DefaultProbeCountForTypeUnique;
13866 rr->ProbeRestartCount++;
13867
13868 // If we haven't started announcing yet (and we're not already in ten-second-delay mode) the machine is probably
13869 // still going to sleep, so we just reset rr->ProbeCount so we'll continue probing until it stops responding.
13870 // If we *have* started announcing, the machine is probably in the process of waking back up, so in that case
13871 // we're more cautious and we wait ten seconds before probing it again. We do this because while waking from
13872 // sleep, some network interfaces tend to lose or delay inbound packets, and without this delay, if the waking machine
13873 // didn't answer our three probes within three seconds then we'd announce and cause it an unnecessary address conflict.
13874 if (rr->AnnounceCount == InitialAnnounceCount && m->timenow - rr->LastAPTime >= 0)
13875 InitializeLastAPTime(m, rr);
13876 else
13877 {
13878 rr->AnnounceCount = InitialAnnounceCount;
13879 rr->ThisAPInterval = mDNSPlatformOneSecond;
13880 rr->LastAPTime = m->timenow + mDNSPlatformOneSecond * 9; // Send first packet at rr->LastAPTime + rr->ThisAPInterval, i.e. 10 seconds from now
13881 SetNextAnnounceProbeTime(m, rr);
13882 }
13883 }
13884
13885 mDNSlocal void mDNSCoreReceiveRawARP(mDNS *const m, const ARP_EthIP *const arp, const mDNSInterfaceID InterfaceID)
13886 {
13887 static const mDNSOpaque16 ARP_op_request = { { 0, 1 } };
13888 AuthRecord *rr;
13889 NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
13890 if (!intf) return;
13891
13892 mDNS_Lock(m);
13893
13894 // Pass 1:
13895 // Process ARP Requests and Probes (but not Announcements), and generate an ARP Reply if necessary.
13896 // We also process ARPs from our own kernel (and 'answer' them by injecting a local ARP table entry)
13897 // We ignore ARP Announcements here -- Announcements are not questions, they're assertions, so we don't need to answer them.
13898 // The times we might need to react to an ARP Announcement are:
13899 // (i) as an indication that the host in question has not gone to sleep yet (so we should delay beginning to proxy for it) or
13900 // (ii) if it's a conflicting Announcement from another host
13901 // -- and we check for these in Pass 2 below.
13902 if (mDNSSameOpaque16(arp->op, ARP_op_request) && !mDNSSameIPv4Address(arp->spa, arp->tpa))
13903 {
13904 for (rr = m->ResourceRecords; rr; rr=rr->next)
13905 if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
13906 rr->AddressProxy.type == mDNSAddrType_IPv4 && mDNSSameIPv4Address(rr->AddressProxy.ip.v4, arp->tpa))
13907 {
13908 static const char msg1[] = "ARP Req from owner -- re-probing";
13909 static const char msg2[] = "Ignoring ARP Request from ";
13910 static const char msg3[] = "Creating Local ARP Cache entry ";
13911 static const char msg4[] = "Answering ARP Request from ";
13912 const char *const msg = mDNSSameEthAddress(&arp->sha, &rr->WakeUp.IMAC) ? msg1 :
13913 (rr->AnnounceCount == InitialAnnounceCount) ? msg2 :
13914 mDNSSameEthAddress(&arp->sha, &intf->MAC) ? msg3 : msg4;
13915 LogMsg("Arp %-7s %s %.6a %.4a for %.4a -- H-MAC %.6a I-MAC %.6a %s",
13916 intf->ifname, msg, arp->sha.b, arp->spa.b, arp->tpa.b,
13917 &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
13918 if (msg == msg1)
13919 {
13920 if ( rr->ProbeRestartCount < MAX_PROBE_RESTARTS)
13921 RestartARPProbing(m, rr);
13922 else
13923 LogSPS("Reached maximum number of restarts for probing - %s", ARDisplayString(m,rr));
13924 }
13925 else if (msg == msg3)
13926 {
13927 mDNSPlatformSetLocalAddressCacheEntry(&rr->AddressProxy, &rr->WakeUp.IMAC, InterfaceID);
13928 }
13929 else if (msg == msg4)
13930 {
13931 SendARP(m, 2, rr, (mDNSv4Addr *)arp->tpa.b, &arp->sha, (mDNSv4Addr *)arp->spa.b, &arp->sha);
13932 }
13933 }
13934 }
13935
13936 // Pass 2:
13937 // For all types of ARP packet we check the Sender IP address to make sure it doesn't conflict with any AddressProxy record we're holding.
13938 // (Strictly speaking we're only checking Announcement/Request/Reply packets, since ARP Probes have zero Sender IP address,
13939 // so by definition (and by design) they can never conflict with any real (i.e. non-zero) IP address).
13940 // We ignore ARPs we sent ourselves (Sender MAC address is our MAC address) because our own proxy ARPs do not constitute a conflict that we need to handle.
13941 // If we see an apparently conflicting ARP, we check the sender hardware address:
13942 // If the sender hardware address is the original owner this is benign, so we just suppress our own proxy answering for a while longer.
13943 // If the sender hardware address is *not* the original owner, then this is a conflict, and we need to wake the sleeping machine to handle it.
13944 if (mDNSSameEthAddress(&arp->sha, &intf->MAC))
13945 debugf("ARP from self for %.4a", arp->tpa.b);
13946 else
13947 {
13948 if (!mDNSSameIPv4Address(arp->spa, zerov4Addr))
13949 for (rr = m->ResourceRecords; rr; rr=rr->next)
13950 if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
13951 rr->AddressProxy.type == mDNSAddrType_IPv4 && mDNSSameIPv4Address(rr->AddressProxy.ip.v4, arp->spa) && (rr->ProbeRestartCount < MAX_PROBE_RESTARTS))
13952 {
13953 if (mDNSSameEthAddress(&zeroEthAddr, &rr->WakeUp.HMAC))
13954 {
13955 LogMsg("%-7s ARP from %.6a %.4a for %.4a -- Invalid H-MAC %.6a I-MAC %.6a %s", intf->ifname,
13956 arp->sha.b, arp->spa.b, arp->tpa.b, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
13957 }
13958 else
13959 {
13960 RestartARPProbing(m, rr);
13961 if (mDNSSameEthAddress(&arp->sha, &rr->WakeUp.IMAC))
13962 {
13963 LogMsg("%-7s ARP %s from owner %.6a %.4a for %-15.4a -- re-starting probing for %s", intf->ifname,
13964 mDNSSameIPv4Address(arp->spa, arp->tpa) ? "Announcement " : mDNSSameOpaque16(arp->op, ARP_op_request) ? "Request " : "Response ",
13965 arp->sha.b, arp->spa.b, arp->tpa.b, ARDisplayString(m, rr));
13966 }
13967 else
13968 {
13969 LogMsg("%-7s Conflicting ARP from %.6a %.4a for %.4a -- waking H-MAC %.6a I-MAC %.6a %s", intf->ifname,
13970 arp->sha.b, arp->spa.b, arp->tpa.b, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
13971 ScheduleWakeup(m, rr->resrec.InterfaceID, &rr->WakeUp.HMAC);
13972 }
13973 }
13974 }
13975 }
13976
13977 mDNS_Unlock(m);
13978 }
13979
13980 /*
13981 // Option 1 is Source Link Layer Address Option
13982 // Option 2 is Target Link Layer Address Option
13983 mDNSlocal const mDNSEthAddr *GetLinkLayerAddressOption(const IPv6NDP *const ndp, const mDNSu8 *const end, mDNSu8 op)
13984 {
13985 const mDNSu8 *options = (mDNSu8 *)(ndp+1);
13986 while (options < end)
13987 {
13988 debugf("NDP Option %02X len %2d %d", options[0], options[1], end - options);
13989 if (options[0] == op && options[1] == 1) return (const mDNSEthAddr*)(options+2);
13990 options += options[1] * 8;
13991 }
13992 return mDNSNULL;
13993 }
13994 */
13995
13996 mDNSlocal void mDNSCoreReceiveRawND(mDNS *const m, const mDNSEthAddr *const sha, const mDNSv6Addr *spa,
13997 const IPv6NDP *const ndp, const mDNSu8 *const end, const mDNSInterfaceID InterfaceID)
13998 {
13999 AuthRecord *rr;
14000 NetworkInterfaceInfo *intf = FirstInterfaceForID(m, InterfaceID);
14001 if (!intf) return;
14002
14003 mDNS_Lock(m);
14004
14005 // Pass 1: Process Neighbor Solicitations, and generate a Neighbor Advertisement if necessary.
14006 if (ndp->type == NDP_Sol)
14007 {
14008 //const mDNSEthAddr *const sha = GetLinkLayerAddressOption(ndp, end, NDP_SrcLL);
14009 (void)end;
14010 for (rr = m->ResourceRecords; rr; rr=rr->next)
14011 if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
14012 rr->AddressProxy.type == mDNSAddrType_IPv6 && mDNSSameIPv6Address(rr->AddressProxy.ip.v6, ndp->target))
14013 {
14014 static const char msg1[] = "NDP Req from owner -- re-probing";
14015 static const char msg2[] = "Ignoring NDP Request from ";
14016 static const char msg3[] = "Creating Local NDP Cache entry ";
14017 static const char msg4[] = "Answering NDP Request from ";
14018 static const char msg5[] = "Answering NDP Probe from ";
14019 const char *const msg = sha && mDNSSameEthAddress(sha, &rr->WakeUp.IMAC) ? msg1 :
14020 (rr->AnnounceCount == InitialAnnounceCount) ? msg2 :
14021 sha && mDNSSameEthAddress(sha, &intf->MAC) ? msg3 :
14022 spa && mDNSIPv6AddressIsZero(*spa) ? msg4 : msg5;
14023 LogSPS("%-7s %s %.6a %.16a for %.16a -- H-MAC %.6a I-MAC %.6a %s",
14024 intf->ifname, msg, sha, spa, &ndp->target, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
14025 if (msg == msg1)
14026 {
14027 if (rr->ProbeRestartCount < MAX_PROBE_RESTARTS)
14028 RestartARPProbing(m, rr);
14029 else
14030 LogSPS("Reached maximum number of restarts for probing - %s", ARDisplayString(m,rr));
14031 }
14032 else if (msg == msg3)
14033 mDNSPlatformSetLocalAddressCacheEntry(&rr->AddressProxy, &rr->WakeUp.IMAC, InterfaceID);
14034 else if (msg == msg4)
14035 SendNDP(m, NDP_Adv, NDP_Solicited, rr, &ndp->target, mDNSNULL, spa, sha);
14036 else if (msg == msg5)
14037 SendNDP(m, NDP_Adv, 0, rr, &ndp->target, mDNSNULL, &AllHosts_v6, &AllHosts_v6_Eth);
14038 }
14039 }
14040
14041 // Pass 2: For all types of NDP packet we check the Sender IP address to make sure it doesn't conflict with any AddressProxy record we're holding.
14042 if (mDNSSameEthAddress(sha, &intf->MAC))
14043 debugf("NDP from self for %.16a", &ndp->target);
14044 else
14045 {
14046 // For Neighbor Advertisements we check the Target address field, not the actual IPv6 source address.
14047 // When a machine has both link-local and routable IPv6 addresses, it may send NDP packets making assertions
14048 // about its routable IPv6 address, using its link-local address as the source address for all NDP packets.
14049 // Hence it is the NDP target address we care about, not the actual packet source address.
14050 if (ndp->type == NDP_Adv) spa = &ndp->target;
14051 if (!mDNSSameIPv6Address(*spa, zerov6Addr))
14052 for (rr = m->ResourceRecords; rr; rr=rr->next)
14053 if (rr->resrec.InterfaceID == InterfaceID && rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
14054 rr->AddressProxy.type == mDNSAddrType_IPv6 && mDNSSameIPv6Address(rr->AddressProxy.ip.v6, *spa) && (rr->ProbeRestartCount < MAX_PROBE_RESTARTS))
14055 {
14056 if (mDNSSameEthAddress(&zeroEthAddr, &rr->WakeUp.HMAC))
14057 {
14058 LogSPS("%-7s NDP from %.6a %.16a for %.16a -- Invalid H-MAC %.6a I-MAC %.6a %s", intf->ifname,
14059 sha, spa, &ndp->target, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
14060 }
14061 else
14062 {
14063 RestartARPProbing(m, rr);
14064 if (mDNSSameEthAddress(sha, &rr->WakeUp.IMAC))
14065 {
14066 LogSPS("%-7s NDP %s from owner %.6a %.16a for %.16a -- re-starting probing for %s", intf->ifname,
14067 ndp->type == NDP_Sol ? "Solicitation " : "Advertisement", sha, spa, &ndp->target, ARDisplayString(m, rr));
14068 }
14069 else
14070 {
14071 LogMsg("%-7s Conflicting NDP from %.6a %.16a for %.16a -- waking H-MAC %.6a I-MAC %.6a %s", intf->ifname,
14072 sha, spa, &ndp->target, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, rr));
14073 ScheduleWakeup(m, rr->resrec.InterfaceID, &rr->WakeUp.HMAC);
14074 }
14075 }
14076 }
14077 }
14078
14079 mDNS_Unlock(m);
14080 }
14081
14082 mDNSlocal void mDNSCoreReceiveRawTransportPacket(mDNS *const m, const mDNSEthAddr *const sha, const mDNSAddr *const src, const mDNSAddr *const dst, const mDNSu8 protocol,
14083 const mDNSu8 *const p, const TransportLayerPacket *const t, const mDNSu8 *const end, const mDNSInterfaceID InterfaceID, const mDNSu16 len)
14084 {
14085 const mDNSIPPort port = (protocol == 0x06) ? t->tcp.dst : (protocol == 0x11) ? t->udp.dst : zeroIPPort;
14086 mDNSBool wake = mDNSfalse;
14087 mDNSBool kaWake = mDNSfalse;
14088
14089 switch (protocol)
14090 {
14091 #define XX wake ? "Received" : "Ignoring", end-p
14092 case 0x01: LogSPS("Ignoring %d-byte ICMP from %#a to %#a", end-p, src, dst);
14093 break;
14094
14095 case 0x06: {
14096 AuthRecord *kr;
14097 mDNSu32 seq, ack;
14098 #define TH_FIN 0x01
14099 #define TH_SYN 0x02
14100 #define TH_RST 0x04
14101 #define TH_ACK 0x10
14102
14103 kr = mDNS_MatchKeepaliveInfo(m, dst, src, port, t->tcp.src, &seq, &ack);
14104 if (kr)
14105 {
14106 LogSPS("mDNSCoreReceiveRawTransportPacket: Found a Keepalive record from %#a:%d to %#a:%d", src, mDNSVal16(t->tcp.src), dst, mDNSVal16(port));
14107 // Plan to wake if
14108 // (a) RST or FIN is set (the keepalive that we sent could have caused a reset)
14109 // (b) packet that contains new data and acks a sequence number higher than the one
14110 // we have been sending in the keepalive
14111
14112 wake = ((t->tcp.flags & TH_RST) || (t->tcp.flags & TH_FIN)) ;
14113 if (!wake)
14114 {
14115 mDNSu8 *ptr;
14116 mDNSu32 pseq, pack;
14117 mDNSBool data = mDNSfalse;
14118 mDNSu8 tcphlen;
14119
14120 // Convert to host order
14121 ptr = (mDNSu8 *)&seq;
14122 seq = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
14123
14124 ptr = (mDNSu8 *)&ack;
14125 ack = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
14126
14127 pseq = t->tcp.seq;
14128 ptr = (mDNSu8 *)&pseq;
14129 pseq = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
14130
14131 pack = t->tcp.ack;
14132 ptr = (mDNSu8 *)&pack;
14133 pack = ptr[0] << 24 | ptr[1] << 16 | ptr[2] << 8 | ptr[3];
14134
14135 // If the other side is acking one more than our sequence number (keepalive is one
14136 // less than the last valid sequence sent) and it's sequence is more than what we
14137 // acked before
14138 //if (end - p - 34 - ((t->tcp.offset >> 4) * 4) > 0) data = mDNStrue;
14139 tcphlen = ((t->tcp.offset >> 4) * 4);
14140 if (end - ((mDNSu8 *)t + tcphlen) > 0) data = mDNStrue;
14141 wake = ((int)(pack - seq) > 0) && ((int)(pseq - ack) >= 0) && data;
14142
14143 // If we got a regular keepalive on a connection that was registed with the KeepAlive API, respond with an ACK
14144 if ((t->tcp.flags & TH_ACK) && (data == mDNSfalse) &&
14145 ((int)(ack - pseq) == 1))
14146 {
14147 // Send an ACK;
14148 mDNS_SendKeepaliveACK(m, kr);
14149 }
14150 LogSPS("mDNSCoreReceiveRawTransportPacket: End %p, hlen %d, Datalen %d, pack %u, seq %u, pseq %u, ack %u, wake %d",
14151 end, tcphlen, end - ((mDNSu8 *)t + tcphlen), pack, seq, pseq, ack, wake);
14152 }
14153 else { LogSPS("mDNSCoreReceiveRawTransportPacket: waking because of RST or FIN th_flags %d", t->tcp.flags); }
14154 kaWake = wake;
14155 }
14156 else
14157 {
14158 // Plan to wake if
14159 // (a) RST is not set, AND
14160 // (b) packet is SYN, SYN+FIN, or plain data packet (no SYN or FIN). We won't wake for FIN alone.
14161 wake = (!(t->tcp.flags & TH_RST) && (t->tcp.flags & (TH_FIN|TH_SYN)) != TH_FIN);
14162
14163 // For now, to reduce spurious wakeups, we wake only for TCP SYN,
14164 // except for ssh connections, where we'll wake for plain data packets too
14165 if (!mDNSSameIPPort(port, SSHPort) && !(t->tcp.flags & 2)) wake = mDNSfalse;
14166
14167 LogSPS("%s %d-byte TCP from %#a:%d to %#a:%d%s%s%s", XX,
14168 src, mDNSVal16(t->tcp.src), dst, mDNSVal16(port),
14169 (t->tcp.flags & 2) ? " SYN" : "",
14170 (t->tcp.flags & 1) ? " FIN" : "",
14171 (t->tcp.flags & 4) ? " RST" : "");
14172 }
14173 break;
14174 }
14175
14176 case 0x11: {
14177 #define ARD_AsNumber 3283
14178 static const mDNSIPPort ARD = { { ARD_AsNumber >> 8, ARD_AsNumber & 0xFF } };
14179 const mDNSu16 udplen = (mDNSu16)((mDNSu16)t->bytes[4] << 8 | t->bytes[5]); // Length *including* 8-byte UDP header
14180 if (udplen >= sizeof(UDPHeader))
14181 {
14182 const mDNSu16 datalen = udplen - sizeof(UDPHeader);
14183 wake = mDNStrue;
14184
14185 // For Back to My Mac UDP port 4500 (IPSEC) packets, we do some special handling
14186 if (mDNSSameIPPort(port, IPSECPort))
14187 {
14188 // Specifically ignore NAT keepalive packets
14189 if (datalen == 1 && end >= &t->bytes[9] && t->bytes[8] == 0xFF) wake = mDNSfalse;
14190 else
14191 {
14192 // Skip over the Non-ESP Marker if present
14193 const mDNSBool NonESP = (end >= &t->bytes[12] && t->bytes[8] == 0 && t->bytes[9] == 0 && t->bytes[10] == 0 && t->bytes[11] == 0);
14194 const IKEHeader *const ike = (IKEHeader *)(t + (NonESP ? 12 : 8));
14195 const mDNSu16 ikelen = datalen - (NonESP ? 4 : 0);
14196 if (ikelen >= sizeof(IKEHeader) && end >= ((mDNSu8 *)ike) + sizeof(IKEHeader))
14197 if ((ike->Version & 0x10) == 0x10)
14198 {
14199 // ExchangeType == 5 means 'Informational' <http://www.ietf.org/rfc/rfc2408.txt>
14200 // ExchangeType == 34 means 'IKE_SA_INIT' <http://www.iana.org/assignments/ikev2-parameters>
14201 if (ike->ExchangeType == 5 || ike->ExchangeType == 34) wake = mDNSfalse;
14202 LogSPS("%s %d-byte IKE ExchangeType %d", XX, ike->ExchangeType);
14203 }
14204 }
14205 }
14206
14207 // For now, because we haven't yet worked out a clean elegant way to do this, we just special-case the
14208 // Apple Remote Desktop port number -- we ignore all packets to UDP 3283 (the "Net Assistant" port),
14209 // except for Apple Remote Desktop's explicit manual wakeup packet, which looks like this:
14210 // UDP header (8 bytes)
14211 // Payload: 13 88 00 6a 41 4e 41 20 (8 bytes) ffffffffffff (6 bytes) 16xMAC (96 bytes) = 110 bytes total
14212 if (mDNSSameIPPort(port, ARD)) wake = (datalen >= 110 && end >= &t->bytes[10] && t->bytes[8] == 0x13 && t->bytes[9] == 0x88);
14213
14214 LogSPS("%s %d-byte UDP from %#a:%d to %#a:%d", XX, src, mDNSVal16(t->udp.src), dst, mDNSVal16(port));
14215 }
14216 }
14217 break;
14218
14219 case 0x3A: if (&t->bytes[len] <= end)
14220 {
14221 mDNSu16 checksum = IPv6CheckSum(&src->ip.v6, &dst->ip.v6, protocol, t->bytes, len);
14222 if (!checksum) mDNSCoreReceiveRawND(m, sha, &src->ip.v6, &t->ndp, &t->bytes[len], InterfaceID);
14223 else LogInfo("IPv6CheckSum bad %04X %02X%02X from %#a to %#a", checksum, t->bytes[2], t->bytes[3], src, dst);
14224 }
14225 break;
14226
14227 default: LogSPS("Ignoring %d-byte IP packet unknown protocol %d from %#a to %#a", end-p, protocol, src, dst);
14228 break;
14229 }
14230
14231 if (wake)
14232 {
14233 AuthRecord *rr, *r2;
14234
14235 mDNS_Lock(m);
14236 for (rr = m->ResourceRecords; rr; rr=rr->next)
14237 if (rr->resrec.InterfaceID == InterfaceID &&
14238 rr->resrec.RecordType != kDNSRecordTypeDeregistering &&
14239 rr->AddressProxy.type && mDNSSameAddress(&rr->AddressProxy, dst))
14240 {
14241 const mDNSu8 *const tp = (protocol == 6) ? (const mDNSu8 *)"\x4_tcp" : (const mDNSu8 *)"\x4_udp";
14242 for (r2 = m->ResourceRecords; r2; r2=r2->next)
14243 if (r2->resrec.InterfaceID == InterfaceID && mDNSSameEthAddress(&r2->WakeUp.HMAC, &rr->WakeUp.HMAC) &&
14244 r2->resrec.RecordType != kDNSRecordTypeDeregistering &&
14245 r2->resrec.rrtype == kDNSType_SRV && mDNSSameIPPort(r2->resrec.rdata->u.srv.port, port) &&
14246 SameDomainLabel(ThirdLabel(r2->resrec.name)->c, tp))
14247 break;
14248 if (!r2 && mDNSSameIPPort(port, IPSECPort)) r2 = rr; // So that we wake for BTMM IPSEC packets, even without a matching SRV record
14249 if (!r2 && kaWake) r2 = rr; // So that we wake for keepalive packets, even without a matching SRV record
14250 if (r2)
14251 {
14252 LogMsg("Waking host at %s %#a H-MAC %.6a I-MAC %.6a for %s",
14253 InterfaceNameForID(m, rr->resrec.InterfaceID), dst, &rr->WakeUp.HMAC, &rr->WakeUp.IMAC, ARDisplayString(m, r2));
14254 ScheduleWakeup(m, rr->resrec.InterfaceID, &rr->WakeUp.HMAC);
14255 }
14256 else
14257 LogSPS("Sleeping host at %s %#a %.6a has no service on %#s %d",
14258 InterfaceNameForID(m, rr->resrec.InterfaceID), dst, &rr->WakeUp.HMAC, tp, mDNSVal16(port));
14259 }
14260 mDNS_Unlock(m);
14261 }
14262 }
14263
14264 mDNSexport void mDNSCoreReceiveRawPacket(mDNS *const m, const mDNSu8 *const p, const mDNSu8 *const end, const mDNSInterfaceID InterfaceID)
14265 {
14266 static const mDNSOpaque16 Ethertype_ARP = { { 0x08, 0x06 } }; // Ethertype 0x0806 = ARP
14267 static const mDNSOpaque16 Ethertype_IPv4 = { { 0x08, 0x00 } }; // Ethertype 0x0800 = IPv4
14268 static const mDNSOpaque16 Ethertype_IPv6 = { { 0x86, 0xDD } }; // Ethertype 0x86DD = IPv6
14269 static const mDNSOpaque16 ARP_hrd_eth = { { 0x00, 0x01 } }; // Hardware address space (Ethernet = 1)
14270 static const mDNSOpaque16 ARP_pro_ip = { { 0x08, 0x00 } }; // Protocol address space (IP = 0x0800)
14271
14272 // Note: BPF guarantees that the NETWORK LAYER header will be word aligned, not the link-layer header.
14273 // In other words, we can safely assume that pkt below (ARP, IPv4 or IPv6) is properly word aligned,
14274 // but if pkt is 4-byte aligned, that necessarily means that eth CANNOT also be 4-byte aligned
14275 // since it points to a an address 14 bytes before pkt.
14276 const EthernetHeader *const eth = (const EthernetHeader *)p;
14277 const NetworkLayerPacket *const pkt = (const NetworkLayerPacket *)(eth+1);
14278 mDNSAddr src, dst;
14279 #define RequiredCapLen(P) ((P)==0x01 ? 4 : (P)==0x06 ? 20 : (P)==0x11 ? 8 : (P)==0x3A ? 24 : 0)
14280
14281 // Is ARP? Length must be at least 14 + 28 = 42 bytes
14282 if (end >= p+42 && mDNSSameOpaque16(eth->ethertype, Ethertype_ARP) && mDNSSameOpaque16(pkt->arp.hrd, ARP_hrd_eth) && mDNSSameOpaque16(pkt->arp.pro, ARP_pro_ip))
14283 mDNSCoreReceiveRawARP(m, &pkt->arp, InterfaceID);
14284 // Is IPv4 with zero fragmentation offset? Length must be at least 14 + 20 = 34 bytes
14285 else if (end >= p+34 && mDNSSameOpaque16(eth->ethertype, Ethertype_IPv4) && (pkt->v4.flagsfrags.b[0] & 0x1F) == 0 && pkt->v4.flagsfrags.b[1] == 0)
14286 {
14287 const mDNSu8 *const trans = p + 14 + (pkt->v4.vlen & 0xF) * 4;
14288 const mDNSu8 * transEnd = p + 14 + mDNSVal16(pkt->v4.totlen);
14289 if (transEnd > end) transEnd = end;
14290 debugf("Got IPv4 %02X from %.4a to %.4a", pkt->v4.protocol, &pkt->v4.src, &pkt->v4.dst);
14291 src.type = mDNSAddrType_IPv4; src.ip.v4 = pkt->v4.src;
14292 dst.type = mDNSAddrType_IPv4; dst.ip.v4 = pkt->v4.dst;
14293 if (transEnd >= trans + RequiredCapLen(pkt->v4.protocol))
14294 mDNSCoreReceiveRawTransportPacket(m, &eth->src, &src, &dst, pkt->v4.protocol, p, (TransportLayerPacket*)trans, transEnd, InterfaceID, 0);
14295 }
14296 // Is IPv6? Length must be at least 14 + 28 = 42 bytes
14297 else if (end >= p+54 && mDNSSameOpaque16(eth->ethertype, Ethertype_IPv6))
14298 {
14299 const mDNSu8 *const trans = p + 54;
14300 debugf("Got IPv6 %02X from %.16a to %.16a", pkt->v6.pro, &pkt->v6.src, &pkt->v6.dst);
14301 src.type = mDNSAddrType_IPv6; src.ip.v6 = pkt->v6.src;
14302 dst.type = mDNSAddrType_IPv6; dst.ip.v6 = pkt->v6.dst;
14303 if (end >= trans + RequiredCapLen(pkt->v6.pro))
14304 mDNSCoreReceiveRawTransportPacket(m, &eth->src, &src, &dst, pkt->v6.pro, p, (TransportLayerPacket*)trans, end, InterfaceID,
14305 (mDNSu16)pkt->bytes[4] << 8 | pkt->bytes[5]);
14306 }
14307 }
14308
14309 mDNSlocal void ConstructSleepProxyServerName(mDNS *const m, domainlabel *name)
14310 {
14311 name->c[0] = (mDNSu8)mDNS_snprintf((char*)name->c+1, 62, "%d-%d-%d-%d.%d %#s",
14312 m->SPSType, m->SPSPortability, m->SPSMarginalPower, m->SPSTotalPower, m->SPSFeatureFlags, &m->nicelabel);
14313 }
14314
14315 #ifndef SPC_DISABLED
14316 mDNSlocal void SleepProxyServerCallback(mDNS *const m, ServiceRecordSet *const srs, mStatus result)
14317 {
14318 if (result == mStatus_NameConflict)
14319 mDNS_RenameAndReregisterService(m, srs, mDNSNULL);
14320 else if (result == mStatus_MemFree)
14321 {
14322 if (m->SleepState)
14323 m->SPSState = 3;
14324 else
14325 {
14326 m->SPSState = (mDNSu8)(m->SPSSocket != mDNSNULL);
14327 if (m->SPSState)
14328 {
14329 domainlabel name;
14330 ConstructSleepProxyServerName(m, &name);
14331 mDNS_RegisterService(m, srs,
14332 &name, &SleepProxyServiceType, &localdomain,
14333 mDNSNULL, m->SPSSocket->port, // Host, port
14334 mDNSNULL,
14335 (mDNSu8 *)"", 1, // TXT data, length
14336 mDNSNULL, 0, // Subtypes (none)
14337 mDNSInterface_Any, // Interface ID
14338 SleepProxyServerCallback, mDNSNULL, 0); // Callback, context, flags
14339 }
14340 LogSPS("Sleep Proxy Server %#s %s", srs->RR_SRV.resrec.name->c, m->SPSState ? "started" : "stopped");
14341 }
14342 }
14343 }
14344 #endif
14345
14346 // Called with lock held
14347 mDNSexport void mDNSCoreBeSleepProxyServer_internal(mDNS *const m, mDNSu8 sps, mDNSu8 port, mDNSu8 marginalpower, mDNSu8 totpower, mDNSu8 features)
14348 {
14349 // This routine uses mDNS_DeregisterService and calls SleepProxyServerCallback, so we execute in user callback context
14350 mDNS_DropLockBeforeCallback();
14351
14352 // If turning off SPS, close our socket
14353 // (Do this first, BEFORE calling mDNS_DeregisterService below)
14354 if (!sps && m->SPSSocket) { mDNSPlatformUDPClose(m->SPSSocket); m->SPSSocket = mDNSNULL; }
14355
14356 // If turning off, or changing type, deregister old name
14357 #ifndef SPC_DISABLED
14358 if (m->SPSState == 1 && sps != m->SPSType)
14359 { m->SPSState = 2; mDNS_DeregisterService_drt(m, &m->SPSRecords, sps ? mDNS_Dereg_rapid : mDNS_Dereg_normal); }
14360 #endif // SPC_DISABLED
14361
14362 // Record our new SPS parameters
14363 m->SPSType = sps;
14364 m->SPSPortability = port;
14365 m->SPSMarginalPower = marginalpower;
14366 m->SPSTotalPower = totpower;
14367 m->SPSFeatureFlags = features;
14368 // If turning on, open socket and advertise service
14369 if (sps)
14370 {
14371 if (!m->SPSSocket)
14372 {
14373 m->SPSSocket = mDNSPlatformUDPSocket(zeroIPPort);
14374 if (!m->SPSSocket) { LogMsg("mDNSCoreBeSleepProxyServer: Failed to allocate SPSSocket"); goto fail; }
14375 }
14376 #ifndef SPC_DISABLED
14377 if (m->SPSState == 0) SleepProxyServerCallback(m, &m->SPSRecords, mStatus_MemFree);
14378 #endif // SPC_DISABLED
14379 }
14380 else if (m->SPSState)
14381 {
14382 LogSPS("mDNSCoreBeSleepProxyServer turning off from state %d; will wake clients", m->SPSState);
14383 m->NextScheduledSPS = m->timenow;
14384 }
14385 fail:
14386 mDNS_ReclaimLockAfterCallback();
14387 }
14388
14389 // ***************************************************************************
14390 #if COMPILER_LIKES_PRAGMA_MARK
14391 #pragma mark -
14392 #pragma mark - Startup and Shutdown
14393 #endif
14394
14395 mDNSlocal void mDNS_GrowCache_internal(mDNS *const m, CacheEntity *storage, mDNSu32 numrecords)
14396 {
14397 if (storage && numrecords)
14398 {
14399 mDNSu32 i;
14400 debugf("Adding cache storage for %d more records (%d bytes)", numrecords, numrecords*sizeof(CacheEntity));
14401 for (i=0; i<numrecords; i++) storage[i].next = &storage[i+1];
14402 storage[numrecords-1].next = m->rrcache_free;
14403 m->rrcache_free = storage;
14404 m->rrcache_size += numrecords;
14405 }
14406 }
14407
14408 mDNSexport void mDNS_GrowCache(mDNS *const m, CacheEntity *storage, mDNSu32 numrecords)
14409 {
14410 mDNS_Lock(m);
14411 mDNS_GrowCache_internal(m, storage, numrecords);
14412 mDNS_Unlock(m);
14413 }
14414
14415 mDNSlocal mStatus mDNS_InitStorage(mDNS *const m, mDNS_PlatformSupport *const p,
14416 CacheEntity *rrcachestorage, mDNSu32 rrcachesize,
14417 mDNSBool AdvertiseLocalAddresses, mDNSCallback *Callback, void *Context)
14418 {
14419 mDNSu32 slot;
14420 mDNSs32 timenow;
14421 mStatus result;
14422
14423 if (!rrcachestorage) rrcachesize = 0;
14424
14425 m->p = p;
14426 m->NetworkChanged = 0;
14427 m->CanReceiveUnicastOn5353 = mDNSfalse; // Assume we can't receive unicasts on 5353, unless platform layer tells us otherwise
14428 m->AdvertiseLocalAddresses = AdvertiseLocalAddresses;
14429 m->DivertMulticastAdvertisements = mDNSfalse;
14430 m->mDNSPlatformStatus = mStatus_Waiting;
14431 m->UnicastPort4 = zeroIPPort;
14432 m->UnicastPort6 = zeroIPPort;
14433 m->PrimaryMAC = zeroEthAddr;
14434 m->MainCallback = Callback;
14435 m->MainContext = Context;
14436 m->rec.r.resrec.RecordType = 0;
14437 m->rec.r.resrec.AnonInfo = mDNSNULL;
14438
14439 // For debugging: To catch and report locking failures
14440 m->mDNS_busy = 0;
14441 m->mDNS_reentrancy = 0;
14442 m->ShutdownTime = 0;
14443 m->lock_rrcache = 0;
14444 m->lock_Questions = 0;
14445 m->lock_Records = 0;
14446
14447 // Task Scheduling variables
14448 result = mDNSPlatformTimeInit();
14449 if (result != mStatus_NoError) return(result);
14450 m->timenow_adjust = (mDNSs32)mDNSRandom(0xFFFFFFFF);
14451 timenow = mDNS_TimeNow_NoLock(m);
14452
14453 m->timenow = 0; // MUST only be set within mDNS_Lock/mDNS_Unlock section
14454 m->timenow_last = timenow;
14455 m->NextScheduledEvent = timenow;
14456 m->SuppressSending = timenow;
14457 m->NextCacheCheck = timenow + FutureTime;
14458 m->NextScheduledQuery = timenow + FutureTime;
14459 m->NextScheduledProbe = timenow + FutureTime;
14460 m->NextScheduledResponse = timenow + FutureTime;
14461 m->NextScheduledNATOp = timenow + FutureTime;
14462 m->NextScheduledSPS = timenow + FutureTime;
14463 m->NextScheduledKA = timenow + FutureTime;
14464 m->NextScheduledStopTime = timenow + FutureTime;
14465 m->NextBLEServiceTime = 0; // zero indicates inactive
14466
14467 #if BONJOUR_ON_DEMAND
14468 m->NextBonjourDisableTime = 0; // Timer active when non zero.
14469 m->BonjourEnabled = 0; // Set when Bonjour on Demand is enabled and Bonjour is currently enabled.
14470 #endif // BONJOUR_ON_DEMAND
14471
14472 m->DelayConflictProcessing = MAX_CONFLICT_PROCESSING_DELAYS;
14473 m->RandomQueryDelay = 0;
14474 m->RandomReconfirmDelay = 0;
14475 m->PktNum = 0;
14476 m->MPktNum = 0;
14477 m->LocalRemoveEvents = mDNSfalse;
14478 m->SleepState = SleepState_Awake;
14479 m->SleepSeqNum = 0;
14480 m->SystemWakeOnLANEnabled = mDNSfalse;
14481 m->AnnounceOwner = NonZeroTime(timenow + 60 * mDNSPlatformOneSecond);
14482 m->DelaySleep = 0;
14483 m->SleepLimit = 0;
14484
14485 #if APPLE_OSX_mDNSResponder
14486 m->UnicastPacketsSent = 0;
14487 m->MulticastPacketsSent = 0;
14488 m->RemoteSubnet = 0;
14489 #endif // APPLE_OSX_mDNSResponder
14490
14491 // These fields only required for mDNS Searcher...
14492 m->Questions = mDNSNULL;
14493 m->NewQuestions = mDNSNULL;
14494 m->CurrentQuestion = mDNSNULL;
14495 m->LocalOnlyQuestions = mDNSNULL;
14496 m->NewLocalOnlyQuestions = mDNSNULL;
14497 m->RestartQuestion = mDNSNULL;
14498 m->ValidationQuestion = mDNSNULL;
14499 m->rrcache_size = 0;
14500 m->rrcache_totalused = 0;
14501 m->rrcache_active = 0;
14502 m->rrcache_report = 10;
14503 m->rrcache_free = mDNSNULL;
14504
14505 for (slot = 0; slot < CACHE_HASH_SLOTS; slot++)
14506 {
14507 m->rrcache_hash[slot] = mDNSNULL;
14508 m->rrcache_nextcheck[slot] = timenow + FutureTime;;
14509 }
14510
14511 mDNS_GrowCache_internal(m, rrcachestorage, rrcachesize);
14512 m->rrauth.rrauth_free = mDNSNULL;
14513
14514 for (slot = 0; slot < AUTH_HASH_SLOTS; slot++)
14515 m->rrauth.rrauth_hash[slot] = mDNSNULL;
14516
14517 // Fields below only required for mDNS Responder...
14518 m->hostlabel.c[0] = 0;
14519 m->nicelabel.c[0] = 0;
14520 m->MulticastHostname.c[0] = 0;
14521 m->HIHardware.c[0] = 0;
14522 m->HISoftware.c[0] = 0;
14523 m->ResourceRecords = mDNSNULL;
14524 m->DuplicateRecords = mDNSNULL;
14525 m->NewLocalRecords = mDNSNULL;
14526 m->NewLocalOnlyRecords = mDNSfalse;
14527 m->CurrentRecord = mDNSNULL;
14528 m->HostInterfaces = mDNSNULL;
14529 m->ProbeFailTime = 0;
14530 m->NumFailedProbes = 0;
14531 m->SuppressProbes = 0;
14532
14533 #ifndef UNICAST_DISABLED
14534 m->NextuDNSEvent = timenow + FutureTime;
14535 m->NextSRVUpdate = timenow + FutureTime;
14536
14537 m->DNSServers = mDNSNULL;
14538
14539 m->Router = zeroAddr;
14540 m->AdvertisedV4 = zeroAddr;
14541 m->AdvertisedV6 = zeroAddr;
14542
14543 m->AuthInfoList = mDNSNULL;
14544
14545 m->ReverseMap.ThisQInterval = -1;
14546 m->StaticHostname.c[0] = 0;
14547 m->FQDN.c[0] = 0;
14548 m->Hostnames = mDNSNULL;
14549 m->AutoTunnelNAT.clientContext = mDNSNULL;
14550
14551 m->WABBrowseQueriesCount = 0;
14552 m->WABLBrowseQueriesCount = 0;
14553 m->WABRegQueriesCount = 0;
14554 m->AutoTargetServices = 0;
14555
14556 #if BONJOUR_ON_DEMAND
14557 m->NumAllInterfaceRecords = 0;
14558 m->NumAllInterfaceQuestions = 0;
14559 #endif
14560 // NAT traversal fields
14561 m->LLQNAT.clientCallback = mDNSNULL;
14562 m->LLQNAT.clientContext = mDNSNULL;
14563 m->NATTraversals = mDNSNULL;
14564 m->CurrentNATTraversal = mDNSNULL;
14565 m->retryIntervalGetAddr = 0; // delta between time sent and retry
14566 m->retryGetAddr = timenow + FutureTime; // absolute time when we retry
14567 m->ExtAddress = zerov4Addr;
14568 m->PCPNonce[0] = mDNSRandom(-1);
14569 m->PCPNonce[1] = mDNSRandom(-1);
14570 m->PCPNonce[2] = mDNSRandom(-1);
14571
14572 m->NATMcastRecvskt = mDNSNULL;
14573 m->LastNATupseconds = 0;
14574 m->LastNATReplyLocalTime = timenow;
14575 m->LastNATMapResultCode = NATErr_None;
14576
14577 m->UPnPInterfaceID = 0;
14578 m->SSDPSocket = mDNSNULL;
14579 m->SSDPWANPPPConnection = mDNSfalse;
14580 m->UPnPRouterPort = zeroIPPort;
14581 m->UPnPSOAPPort = zeroIPPort;
14582 m->UPnPRouterURL = mDNSNULL;
14583 m->UPnPWANPPPConnection = mDNSfalse;
14584 m->UPnPSOAPURL = mDNSNULL;
14585 m->UPnPRouterAddressString = mDNSNULL;
14586 m->UPnPSOAPAddressString = mDNSNULL;
14587 m->SPSType = 0;
14588 m->SPSPortability = 0;
14589 m->SPSMarginalPower = 0;
14590 m->SPSTotalPower = 0;
14591 m->SPSFeatureFlags = 0;
14592 m->SPSState = 0;
14593 m->SPSProxyListChanged = mDNSNULL;
14594 m->SPSSocket = mDNSNULL;
14595 m->SPSBrowseCallback = mDNSNULL;
14596 m->ProxyRecords = 0;
14597
14598 m->DNSPushServers = mDNSNULL;
14599 m->DNSPushZones = mDNSNULL;
14600 #endif
14601
14602 #if APPLE_OSX_mDNSResponder
14603 m->TunnelClients = mDNSNULL;
14604
14605 #if !NO_WCF
14606 CHECK_WCF_FUNCTION(WCFConnectionNew)
14607 {
14608 m->WCF = WCFConnectionNew();
14609 if (!m->WCF) { LogMsg("WCFConnectionNew failed"); return -1; }
14610 }
14611 #endif
14612
14613 #endif
14614
14615 return(result);
14616 }
14617
14618 mDNSexport mStatus mDNS_Init(mDNS *const m, mDNS_PlatformSupport *const p,
14619 CacheEntity *rrcachestorage, mDNSu32 rrcachesize,
14620 mDNSBool AdvertiseLocalAddresses, mDNSCallback *Callback, void *Context)
14621 {
14622 mStatus result = mDNS_InitStorage(m, p, rrcachestorage, rrcachesize, AdvertiseLocalAddresses, Callback, Context);
14623 if (result != mStatus_NoError)
14624 return(result);
14625
14626 result = mDNSPlatformInit(m);
14627
14628 #ifndef UNICAST_DISABLED
14629 // It's better to do this *after* the platform layer has set up the
14630 // interface list and security credentials
14631 uDNS_SetupDNSConfig(m); // Get initial DNS configuration
14632 #endif
14633
14634 return(result);
14635 }
14636
14637 mDNSexport void mDNS_ConfigChanged(mDNS *const m)
14638 {
14639 if (m->SPSState == 1)
14640 {
14641 domainlabel name, newname;
14642 #ifndef SPC_DISABLED
14643 domainname type, domain;
14644 DeconstructServiceName(m->SPSRecords.RR_SRV.resrec.name, &name, &type, &domain);
14645 #endif // SPC_DISABLED
14646 ConstructSleepProxyServerName(m, &newname);
14647 if (!SameDomainLabelCS(name.c, newname.c))
14648 {
14649 LogSPS("Renaming SPS from “%#s” to “%#s”", name.c, newname.c);
14650 // When SleepProxyServerCallback gets the mStatus_MemFree message,
14651 // it will reregister the service under the new name
14652 m->SPSState = 2;
14653 #ifndef SPC_DISABLED
14654 mDNS_DeregisterService_drt(m, &m->SPSRecords, mDNS_Dereg_rapid);
14655 #endif // SPC_DISABLED
14656 }
14657 }
14658
14659 if (m->MainCallback)
14660 m->MainCallback(m, mStatus_ConfigChanged);
14661 }
14662
14663 mDNSlocal void DynDNSHostNameCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
14664 {
14665 (void)m; // unused
14666 debugf("NameStatusCallback: result %d for registration of name %##s", result, rr->resrec.name->c);
14667 mDNSPlatformDynDNSHostNameStatusChanged(rr->resrec.name, result);
14668 }
14669
14670 mDNSlocal void PurgeOrReconfirmCacheRecord(mDNS *const m, CacheRecord *cr, const DNSServer * const ptr, mDNSBool lameduck)
14671 {
14672 mDNSBool purge = cr->resrec.RecordType == kDNSRecordTypePacketNegative ||
14673 cr->resrec.rrtype == kDNSType_A ||
14674 cr->resrec.rrtype == kDNSType_AAAA ||
14675 cr->resrec.rrtype == kDNSType_SRV ||
14676 cr->resrec.rrtype == kDNSType_CNAME;
14677
14678 (void) lameduck;
14679 (void) ptr;
14680 debugf("PurgeOrReconfirmCacheRecord: %s cache record due to %s server %p %#a:%d (%##s): %s",
14681 purge ? "purging" : "reconfirming",
14682 lameduck ? "lame duck" : "new",
14683 ptr, &ptr->addr, mDNSVal16(ptr->port), ptr->domain.c, CRDisplayString(m, cr));
14684
14685 if (purge)
14686 {
14687 LogInfo("PurgeorReconfirmCacheRecord: Purging Resourcerecord %s, RecordType %x", CRDisplayString(m, cr), cr->resrec.RecordType);
14688 mDNS_PurgeCacheResourceRecord(m, cr);
14689 }
14690 else
14691 {
14692 LogInfo("PurgeorReconfirmCacheRecord: Reconfirming Resourcerecord %s, RecordType %x", CRDisplayString(m, cr), cr->resrec.RecordType);
14693 mDNS_Reconfirm_internal(m, cr, kDefaultReconfirmTimeForNoAnswer);
14694 }
14695 }
14696
14697 mDNSlocal void mDNS_PurgeBeforeResolve(mDNS *const m, DNSQuestion *q)
14698 {
14699 CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
14700 CacheRecord *rp;
14701 mDNSu8 validatingResponse = 0;
14702
14703 // For DNSSEC questions, purge the corresponding RRSIGs also.
14704 if (DNSSECQuestion(q))
14705 {
14706 validatingResponse = q->ValidatingResponse;
14707 q->ValidatingResponse = mDNStrue;
14708 }
14709 for (rp = cg ? cg->members : mDNSNULL; rp; rp = rp->next)
14710 {
14711 if (SameNameRecordAnswersQuestion(&rp->resrec, q))
14712 {
14713 LogInfo("mDNS_PurgeBeforeResolve: Flushing %s", CRDisplayString(m, rp));
14714 mDNS_PurgeCacheResourceRecord(m, rp);
14715 }
14716 }
14717 if (DNSSECQuestion(q))
14718 {
14719 q->ValidatingResponse = validatingResponse;
14720 }
14721 }
14722
14723 // For DNSSEC question, we need the DNSSEC records also. If the cache does not
14724 // have the DNSSEC records, we need to re-issue the question with EDNS0/DO bit set.
14725 // Just re-issuing the question for RRSIGs does not work in practice as the response
14726 // may not contain the RRSIGs whose typeCovered field matches the question's qtype.
14727 //
14728 // For negative responses, we need the NSECs to prove the non-existence. If we don't
14729 // have the cached NSECs, purge them. For positive responses, if we don't have the
14730 // RRSIGs and if we have not already issued the question with EDNS0/DO bit set, purge
14731 // them.
14732 mDNSlocal void CheckForDNSSECRecords(mDNS *const m, DNSQuestion *q)
14733 {
14734 CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
14735 CacheRecord *rp;
14736
14737 for (rp = cg ? cg->members : mDNSNULL; rp; rp = rp->next)
14738 {
14739 if (SameNameRecordAnswersQuestion(&rp->resrec, q))
14740 {
14741 if (rp->resrec.RecordType != kDNSRecordTypePacketNegative || !rp->nsec)
14742 {
14743 if (!rp->CRDNSSECQuestion)
14744 {
14745 LogInfo("CheckForDNSSECRecords: Flushing %s", CRDisplayString(m, rp));
14746 mDNS_PurgeCacheResourceRecord(m, rp);
14747 }
14748 }
14749 }
14750 }
14751 }
14752
14753 // Check for a positive unicast response to the question but with qtype
14754 mDNSexport mDNSBool mDNS_CheckForCacheRecord(mDNS *const m, DNSQuestion *q, mDNSu16 qtype)
14755 {
14756 DNSQuestion question;
14757 CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
14758 CacheRecord *rp;
14759
14760 // Create an identical question but with qtype
14761 mDNS_SetupQuestion(&question, q->InterfaceID, &q->qname, qtype, mDNSNULL, mDNSNULL);
14762 question.qDNSServer = q->qDNSServer;
14763
14764 for (rp = cg ? cg->members : mDNSNULL; rp; rp = rp->next)
14765 {
14766 if (!rp->resrec.InterfaceID && rp->resrec.RecordType != kDNSRecordTypePacketNegative &&
14767 SameNameRecordAnswersQuestion(&rp->resrec, &question))
14768 {
14769 LogInfo("mDNS_CheckForCacheRecord: Found %s", CRDisplayString(m, rp));
14770 return mDNStrue;
14771 }
14772 }
14773 return mDNSfalse;
14774 }
14775
14776 mDNSexport void DNSServerChangeForQuestion(mDNS *const m, DNSQuestion *q, DNSServer *new)
14777 {
14778 DNSQuestion *qptr;
14779
14780 (void) m;
14781
14782 if (q->DuplicateOf)
14783 LogMsg("DNSServerChangeForQuestion: ERROR: Called for duplicate question %##s", q->qname.c);
14784
14785 // Make sure all the duplicate questions point to the same DNSServer so that delivery
14786 // of events for all of them are consistent. Duplicates for a question are always inserted
14787 // after in the list.
14788 q->qDNSServer = new;
14789 for (qptr = q->next ; qptr; qptr = qptr->next)
14790 {
14791 if (qptr->DuplicateOf == q) { qptr->validDNSServers = q->validDNSServers; qptr->qDNSServer = new; }
14792 }
14793 }
14794
14795 mDNSlocal void SetConfigState(mDNS *const m, mDNSBool delete)
14796 {
14797 McastResolver *mr;
14798 DNSServer *ptr;
14799
14800 if (delete)
14801 {
14802 for (ptr = m->DNSServers; ptr; ptr = ptr->next)
14803 {
14804 ptr->penaltyTime = 0;
14805 NumUnicastDNSServers--;
14806 ptr->flags |= DNSServer_FlagDelete;
14807 #if APPLE_OSX_mDNSResponder
14808 if (ptr->flags & DNSServer_FlagUnreachable)
14809 NumUnreachableDNSServers--;
14810 #endif
14811 }
14812 // We handle the mcast resolvers here itself as mDNSPlatformSetDNSConfig looks at
14813 // mcast resolvers. Today we get both mcast and ucast configuration using the same
14814 // API
14815 for (mr = m->McastResolvers; mr; mr = mr->next)
14816 mr->flags |= McastResolver_FlagDelete;
14817 }
14818 else
14819 {
14820 for (ptr = m->DNSServers; ptr; ptr = ptr->next)
14821 {
14822 ptr->penaltyTime = 0;
14823 NumUnicastDNSServers++;
14824 ptr->flags &= ~DNSServer_FlagDelete;
14825 #if APPLE_OSX_mDNSResponder
14826 if (ptr->flags & DNSServer_FlagUnreachable)
14827 NumUnreachableDNSServers++;
14828 #endif
14829 }
14830 for (mr = m->McastResolvers; mr; mr = mr->next)
14831 mr->flags &= ~McastResolver_FlagDelete;
14832 }
14833 }
14834
14835 mDNSlocal void SetDynDNSHostNameIfChanged(mDNS *const m, domainname *const fqdn)
14836 {
14837 // Did our FQDN change?
14838 if (!SameDomainName(fqdn, &m->FQDN))
14839 {
14840 if (m->FQDN.c[0]) mDNS_RemoveDynDNSHostName(m, &m->FQDN);
14841
14842 AssignDomainName(&m->FQDN, fqdn);
14843
14844 if (m->FQDN.c[0])
14845 {
14846 mDNSPlatformDynDNSHostNameStatusChanged(&m->FQDN, 1);
14847 mDNS_AddDynDNSHostName(m, &m->FQDN, DynDNSHostNameCallback, mDNSNULL);
14848 }
14849 }
14850 }
14851
14852 mDNSexport mStatus uDNS_SetupDNSConfig(mDNS *const m)
14853 {
14854 mDNSu32 slot;
14855 CacheGroup *cg;
14856 CacheRecord *cr;
14857 mDNSBool Restart = mDNSfalse;
14858 mDNSAddr v4, v6, r;
14859 domainname fqdn;
14860 DNSServer *ptr, **p = &m->DNSServers;
14861 const DNSServer *oldServers = m->DNSServers;
14862 DNSQuestion *q;
14863 McastResolver *mr, **mres = &m->McastResolvers;
14864
14865 debugf("uDNS_SetupDNSConfig: entry");
14866
14867 // Let the platform layer get the current DNS information and setup the WAB queries if needed.
14868 uDNS_SetupWABQueries(m);
14869
14870 mDNS_Lock(m);
14871
14872 // We need to first mark all the entries to be deleted. If the configuration changed, then
14873 // the entries would be undeleted appropriately. Otherwise, we need to clear them.
14874 //
14875 // Note: The last argument to mDNSPlatformSetDNSConfig is "mDNStrue" which means ack the
14876 // configuration. We already processed search domains in uDNS_SetupWABQueries above and
14877 // hence we are ready to ack the configuration as this is the last call to mDNSPlatformSetConfig
14878 // for the dns configuration change notification.
14879 SetConfigState(m, mDNStrue);
14880 if (!mDNSPlatformSetDNSConfig(mDNStrue, mDNSfalse, &fqdn, mDNSNULL, mDNSNULL, mDNStrue))
14881 {
14882 SetDynDNSHostNameIfChanged(m, &fqdn);
14883 SetConfigState(m, mDNSfalse);
14884 mDNS_Unlock(m);
14885 LogInfo("uDNS_SetupDNSConfig: No configuration change");
14886 return mStatus_NoError;
14887 }
14888
14889 // For now, we just delete the mcast resolvers. We don't deal with cache or
14890 // questions here. Neither question nor cache point to mcast resolvers. Questions
14891 // do inherit the timeout values from mcast resolvers. But we don't bother
14892 // affecting them as they never change.
14893 while (*mres)
14894 {
14895 if (((*mres)->flags & McastResolver_FlagDelete) != 0)
14896 {
14897 mr = *mres;
14898 *mres = (*mres)->next;
14899 debugf("uDNS_SetupDNSConfig: Deleting mcast resolver %##s", mr, mr->domain.c);
14900 mDNSPlatformMemFree(mr);
14901 }
14902 else
14903 {
14904 (*mres)->flags &= ~McastResolver_FlagNew;
14905 mres = &(*mres)->next;
14906 }
14907 }
14908
14909 // Update our qDNSServer pointers before we go and free the DNSServer object memory
14910 //
14911 // All non-scoped resolvers share the same resGroupID. At no point in time a cache entry using DNSServer
14912 // from scoped resolver will be used to answer non-scoped questions and vice versa, as scoped and non-scoped
14913 // resolvers don't share the same resGroupID. A few examples to describe the interaction with how we pick
14914 // DNSServers and flush the cache.
14915 //
14916 // - A non-scoped question picks DNSServer X, creates a cache entry with X. If a new resolver gets added later that
14917 // is a better match, we pick the new DNSServer for the question and activate the unicast query. We may or may not
14918 // flush the cache (See PurgeOrReconfirmCacheRecord). In either case, we don't change the cache record's DNSServer
14919 // pointer immediately (qDNSServer and rDNSServer may be different but still share the same resGroupID). If we don't
14920 // flush the cache immediately, the record's rDNSServer pointer will be updated (in mDNSCoreReceiveResponse)
14921 // later when we get the response. If we purge the cache, we still deliver a RMV when it is purged even though
14922 // we don't update the cache record's DNSServer pointer to match the question's DNSSever, as they both point to
14923 // the same resGroupID.
14924 //
14925 // Note: If the new DNSServer comes back with a different response than what we have in the cache, we will deliver a RMV
14926 // of the old followed by ADD of the new records.
14927 //
14928 // - A non-scoped question picks DNSServer X, creates a cache entry with X. If the resolver gets removed later, we will
14929 // pick a new DNSServer for the question which may or may not be NULL and set the cache record's pointer to the same
14930 // as in question's qDNSServer if the cache record is not flushed. If there is no active question, it will be set to NULL.
14931 //
14932 // - Two questions scoped and non-scoped for the same name will pick two different DNSServer and will end up creating separate
14933 // cache records and as the resGroupID is different, you can't use the cache record from the scoped DNSServer to answer the
14934 // non-scoped question and vice versa.
14935 //
14936 #if USE_DNS64
14937 DNS64RestartQuestions(m);
14938 #endif
14939 for (q = m->Questions; q; q=q->next)
14940 {
14941 if (!mDNSOpaque16IsZero(q->TargetQID))
14942 {
14943 DNSServer *s, *t;
14944 DNSQuestion *qptr;
14945 if (q->DuplicateOf) continue;
14946 SetValidDNSServers(m, q);
14947 q->triedAllServersOnce = 0;
14948 s = GetServerForQuestion(m, q);
14949 t = q->qDNSServer;
14950 if (t != s)
14951 {
14952 mDNSBool old, new;
14953 // If DNS Server for this question has changed, reactivate it
14954 LogInfo("uDNS_SetupDNSConfig: Updating DNS Server from %#a:%d (%##s) to %#a:%d (%##s) for question %##s (%s) (scope:%p)",
14955 t ? &t->addr : mDNSNULL, mDNSVal16(t ? t->port : zeroIPPort), t ? t->domain.c : (mDNSu8*)"",
14956 s ? &s->addr : mDNSNULL, mDNSVal16(s ? s->port : zeroIPPort), s ? s->domain.c : (mDNSu8*)"",
14957 q->qname.c, DNSTypeName(q->qtype), q->InterfaceID);
14958
14959 old = q->SuppressQuery;
14960 new = ShouldSuppressUnicastQuery(m, q, s);
14961 if (old != new)
14962 {
14963 // Changing the DNS server affected the SuppressQuery status. We need to
14964 // deliver RMVs for the previous ADDs (if any) before switching to the new
14965 // DNSServer. To keep it simple, we walk all the questions and mark them
14966 // to be restarted and then handle all of them at once.
14967 q->Restart = 1;
14968 q->SuppressQuery = new;
14969 for (qptr = q->next ; qptr; qptr = qptr->next)
14970 {
14971 if (qptr->DuplicateOf == q)
14972 qptr->Restart = 1;
14973 }
14974 Restart = mDNStrue;
14975 }
14976 else
14977 {
14978 DNSServerChangeForQuestion(m, q, s);
14979 q->unansweredQueries = 0;
14980
14981 // If we had sent a query out to DNSServer "t" and we are changing to "s", we
14982 // need to ignore the responses coming back from "t" as the DNS configuration
14983 // has changed e.g., when a new interface is coming up and that becomes the primary
14984 // interface, we switch to the DNS servers configured for the primary interface. In
14985 // this case, we should not accept responses associated with the previous interface as
14986 // the "name" could resolve differently on this new primary interface. Hence, discard
14987 // in-flight responses.
14988 q->TargetQID = mDNS_NewMessageID(m);
14989
14990 if (!QuerySuppressed(q))
14991 {
14992 debugf("uDNS_SetupDNSConfig: Activating query %p %##s (%s)", q, q->qname.c, DNSTypeName(q->qtype));
14993 ActivateUnicastQuery(m, q, mDNStrue);
14994 // ActivateUnicastQuery is called for duplicate questions also as it does something
14995 // special for AutoTunnel questions
14996 for (qptr = q->next ; qptr; qptr = qptr->next)
14997 {
14998 if (qptr->DuplicateOf == q) ActivateUnicastQuery(m, qptr, mDNStrue);
14999 }
15000 }
15001 }
15002 }
15003 else
15004 {
15005 debugf("uDNS_SetupDNSConfig: Not Updating DNS server question %p %##s (%s) DNS server %#a:%d %p %d",
15006 q, q->qname.c, DNSTypeName(q->qtype), t ? &t->addr : mDNSNULL, mDNSVal16(t ? t->port : zeroIPPort), q->DuplicateOf, q->SuppressUnusable);
15007 for (qptr = q->next ; qptr; qptr = qptr->next)
15008 if (qptr->DuplicateOf == q) { qptr->validDNSServers = q->validDNSServers; qptr->qDNSServer = q->qDNSServer; }
15009 }
15010 }
15011 }
15012 if (Restart)
15013 RestartUnicastQuestions(m);
15014
15015 FORALL_CACHERECORDS(slot, cg, cr)
15016 {
15017 if (cr->resrec.InterfaceID)
15018 continue;
15019
15020 // We already walked the questions and restarted/reactivated them if the dns server
15021 // change affected the question. That should take care of updating the cache. But
15022 // what if there is no active question at this point when the DNS server change
15023 // happened ? There could be old cache entries lying around and if we don't flush
15024 // them, a new question after the DNS server change could pick up these stale
15025 // entries and get a wrong answer.
15026 //
15027 // For cache entries that have active questions we might have skipped rescheduling
15028 // the questions if they were suppressed (see above). To keep it simple, we walk
15029 // all the cache entries to make sure that there are no stale entries. We use the
15030 // active question's InterfaceID/ServiceID for looking up the right DNS server.
15031 // Note that the unscoped value for ServiceID is -1.
15032 //
15033 // Note: If GetServerForName returns NULL, it could either mean that there are no
15034 // DNS servers or no matching DNS servers for this question. In either case,
15035 // the cache should get purged below when we process deleted DNS servers.
15036
15037 ptr = GetServerForName(m, cr->resrec.name,
15038 (cr->CRActiveQuestion ? cr->CRActiveQuestion->InterfaceID : mDNSNULL),
15039 (cr->CRActiveQuestion ? cr->CRActiveQuestion->ServiceID : -1));
15040
15041 // Purge or Reconfirm if this cache entry would use the new DNS server
15042 if (ptr && (ptr != cr->resrec.rDNSServer))
15043 {
15044 // As the DNSServers for this cache record is not the same anymore, we don't
15045 // want any new questions to pick this old value. If there is no active question,
15046 // we can't possibly re-confirm, so purge in that case. If it is a DNSSEC question,
15047 // purge the cache as the DNSSEC capabilities of the DNS server may have changed.
15048
15049 if (cr->CRActiveQuestion == mDNSNULL || DNSSECQuestion(cr->CRActiveQuestion))
15050 {
15051 LogInfo("uDNS_SetupDNSConfig: Purging Resourcerecord %s, New DNS server %#a , Old DNS server %#a", CRDisplayString(m, cr),
15052 &ptr->addr, (cr->resrec.rDNSServer != mDNSNULL ? &cr->resrec.rDNSServer->addr : mDNSNULL));
15053 cr->resrec.mortality = Mortality_Mortal;
15054 mDNS_PurgeCacheResourceRecord(m, cr);
15055 }
15056 else
15057 {
15058 LogInfo("uDNS_SetupDNSConfig: Purging/Reconfirming Resourcerecord %s, New DNS server %#a, Old DNS server %#a", CRDisplayString(m, cr),
15059 &ptr->addr, (cr->resrec.rDNSServer != mDNSNULL ? &cr->resrec.rDNSServer->addr : mDNSNULL));
15060 PurgeOrReconfirmCacheRecord(m, cr, ptr, mDNSfalse);
15061 }
15062 }
15063
15064 // If a cache record's DNSServer pointer is NULL, but its active question got a DNSServer in this DNS configuration
15065 // update, then use its DNSServer. This way, the active question and its duplicates don't miss out on RMV events.
15066 if (!cr->resrec.rDNSServer && cr->CRActiveQuestion && cr->CRActiveQuestion->qDNSServer)
15067 {
15068 cr->resrec.rDNSServer = cr->CRActiveQuestion->qDNSServer;
15069 LogInfo("uDNS_SetupDNSConfig: Using active question's DNS server %#a for cache record %s", &cr->resrec.rDNSServer->addr, CRDisplayString(m, cr));
15070 }
15071 }
15072
15073 while (*p)
15074 {
15075 if (((*p)->flags & DNSServer_FlagDelete) != 0)
15076 {
15077 // Scan our cache, looking for uDNS records that we would have queried this server for.
15078 // We reconfirm any records that match, because in this world of split DNS, firewalls, etc.
15079 // different DNS servers can give different answers to the same question.
15080 ptr = *p;
15081 FORALL_CACHERECORDS(slot, cg, cr)
15082 {
15083 if (cr->resrec.InterfaceID) continue;
15084 if (cr->resrec.rDNSServer == ptr)
15085 {
15086 // If we don't have an active question for this cache record, neither Purge can
15087 // generate RMV events nor Reconfirm can send queries out. Just set the DNSServer
15088 // pointer on the record NULL so that we don't point to freed memory (We might dereference
15089 // DNSServer pointers from resource record for logging purposes).
15090 //
15091 // If there is an active question, point to its DNSServer as long as it does not point to the
15092 // freed one. We already went through the questions above and made them point at either the
15093 // new server or NULL if there is no server.
15094
15095 if (cr->CRActiveQuestion)
15096 {
15097 DNSQuestion *qptr = cr->CRActiveQuestion;
15098
15099 if (qptr->qDNSServer == ptr)
15100 {
15101 LogMsg("uDNS_SetupDNSConfig: ERROR!! Cache Record %s Active question %##s (%s) (scope:%p) pointing to DNSServer Address %#a"
15102 " to be freed", CRDisplayString(m, cr), qptr->qname.c, DNSTypeName(qptr->qtype), qptr->InterfaceID, &ptr->addr);
15103 qptr->validDNSServers = zeroOpaque128;
15104 qptr->qDNSServer = mDNSNULL;
15105 cr->resrec.rDNSServer = mDNSNULL;
15106 }
15107 else
15108 {
15109 LogInfo("uDNS_SetupDNSConfig: Cache Record %s, Active question %##s (%s) (scope:%p), pointing to DNSServer %#a (to be deleted),"
15110 " resetting to question's DNSServer Address %#a", CRDisplayString(m, cr), qptr->qname.c, DNSTypeName(qptr->qtype),
15111 qptr->InterfaceID, &ptr->addr, (qptr->qDNSServer) ? &qptr->qDNSServer->addr : mDNSNULL);
15112 cr->resrec.rDNSServer = qptr->qDNSServer;
15113 }
15114 }
15115 else
15116 {
15117 LogInfo("uDNS_SetupDNSConfig: Cache Record %##s has no Active question, Record's DNSServer Address %#a, Server to be deleted %#a",
15118 cr->resrec.name, &cr->resrec.rDNSServer->addr, &ptr->addr);
15119 cr->resrec.rDNSServer = mDNSNULL;
15120 }
15121
15122 cr->resrec.mortality = Mortality_Mortal;
15123 PurgeOrReconfirmCacheRecord(m, cr, ptr, mDNStrue);
15124 }
15125 }
15126 *p = (*p)->next;
15127 LogInfo("uDNS_SetupDNSConfig: Deleting server %p %#a:%d (%##s) %d", ptr, &ptr->addr, mDNSVal16(ptr->port), ptr->domain.c, NumUnicastDNSServers);
15128 mDNSPlatformMemFree(ptr);
15129 }
15130 else
15131 {
15132 (*p)->flags &= ~DNSServer_FlagNew;
15133 p = &(*p)->next;
15134 }
15135 }
15136
15137 // If we now have no DNS servers at all and we used to have some, then immediately purge all unicast cache records (including for LLQs).
15138 // This is important for giving prompt remove events when the user disconnects the Ethernet cable or turns off wireless.
15139 // Otherwise, stale data lingers for 5-10 seconds, which is not the user-experience people expect from Bonjour.
15140 // Similarly, if we now have some DNS servers and we used to have none, we want to purge any fake negative results we may have generated.
15141 if ((m->DNSServers != mDNSNULL) != (oldServers != mDNSNULL))
15142 {
15143 int count = 0;
15144 FORALL_CACHERECORDS(slot, cg, cr)
15145 {
15146 if (!cr->resrec.InterfaceID)
15147 {
15148 mDNS_PurgeCacheResourceRecord(m, cr);
15149 count++;
15150 }
15151 }
15152 LogInfo("uDNS_SetupDNSConfig: %s available; purged %d unicast DNS records from cache",
15153 m->DNSServers ? "DNS server became" : "No DNS servers", count);
15154
15155 // Force anything that needs to get zone data to get that information again
15156 RestartRecordGetZoneData(m);
15157 }
15158
15159 SetDynDNSHostNameIfChanged(m, &fqdn);
15160
15161 mDNS_Unlock(m);
15162
15163 // handle router and primary interface changes
15164 v4 = v6 = r = zeroAddr;
15165 v4.type = r.type = mDNSAddrType_IPv4;
15166
15167 if (mDNSPlatformGetPrimaryInterface(&v4, &v6, &r) == mStatus_NoError && !mDNSv4AddressIsLinkLocal(&v4.ip.v4))
15168 {
15169 mDNS_SetPrimaryInterfaceInfo(m,
15170 !mDNSIPv4AddressIsZero(v4.ip.v4) ? &v4 : mDNSNULL,
15171 !mDNSIPv6AddressIsZero(v6.ip.v6) ? &v6 : mDNSNULL,
15172 !mDNSIPv4AddressIsZero(r.ip.v4) ? &r : mDNSNULL);
15173 }
15174 else
15175 {
15176 mDNS_SetPrimaryInterfaceInfo(m, mDNSNULL, mDNSNULL, mDNSNULL);
15177 if (m->FQDN.c[0]) mDNSPlatformDynDNSHostNameStatusChanged(&m->FQDN, 1); // Set status to 1 to indicate temporary failure
15178 }
15179
15180 debugf("uDNS_SetupDNSConfig: number of unicast DNS servers %d", NumUnicastDNSServers);
15181 return mStatus_NoError;
15182 }
15183
15184 mDNSexport void mDNSCoreInitComplete(mDNS *const m, mStatus result)
15185 {
15186 m->mDNSPlatformStatus = result;
15187 if (m->MainCallback)
15188 {
15189 mDNS_Lock(m);
15190 mDNS_DropLockBeforeCallback(); // Allow client to legally make mDNS API calls from the callback
15191 m->MainCallback(m, mStatus_NoError);
15192 mDNS_ReclaimLockAfterCallback(); // Decrement mDNS_reentrancy to block mDNS API calls again
15193 mDNS_Unlock(m);
15194 }
15195 }
15196
15197 mDNSlocal void DeregLoop(mDNS *const m, AuthRecord *const start)
15198 {
15199 m->CurrentRecord = start;
15200 while (m->CurrentRecord)
15201 {
15202 AuthRecord *rr = m->CurrentRecord;
15203 LogInfo("DeregLoop: %s deregistration for %p %02X %s",
15204 (rr->resrec.RecordType != kDNSRecordTypeDeregistering) ? "Initiating " : "Accelerating",
15205 rr, rr->resrec.RecordType, ARDisplayString(m, rr));
15206 if (rr->resrec.RecordType != kDNSRecordTypeDeregistering)
15207 mDNS_Deregister_internal(m, rr, mDNS_Dereg_rapid);
15208 else if (rr->AnnounceCount > 1)
15209 {
15210 rr->AnnounceCount = 1;
15211 rr->LastAPTime = m->timenow - rr->ThisAPInterval;
15212 }
15213 // Mustn't advance m->CurrentRecord until *after* mDNS_Deregister_internal, because
15214 // new records could have been added to the end of the list as a result of that call.
15215 if (m->CurrentRecord == rr) // If m->CurrentRecord was not advanced for us, do it now
15216 m->CurrentRecord = rr->next;
15217 }
15218 }
15219
15220 mDNSexport void mDNS_StartExit(mDNS *const m)
15221 {
15222 AuthRecord *rr;
15223
15224 mDNS_Lock(m);
15225
15226 LogInfo("mDNS_StartExit");
15227 m->ShutdownTime = NonZeroTime(m->timenow + mDNSPlatformOneSecond * 5);
15228
15229 mDNSCoreBeSleepProxyServer_internal(m, 0, 0, 0, 0, 0);
15230
15231 #if APPLE_OSX_mDNSResponder
15232 #if !NO_WCF
15233 CHECK_WCF_FUNCTION(WCFConnectionDealloc)
15234 {
15235 if (m->WCF) WCFConnectionDealloc((WCFConnection *)m->WCF);
15236 }
15237 #endif
15238 #endif
15239
15240 #ifndef UNICAST_DISABLED
15241 {
15242 SearchListElem *s;
15243 SuspendLLQs(m);
15244 // Don't need to do SleepRecordRegistrations() here
15245 // because we deregister all records and services later in this routine
15246 while (m->Hostnames) mDNS_RemoveDynDNSHostName(m, &m->Hostnames->fqdn);
15247
15248 // For each member of our SearchList, deregister any records it may have created, and cut them from the list.
15249 // Otherwise they'll be forcibly deregistered for us (without being cut them from the appropriate list)
15250 // and we may crash because the list still contains dangling pointers.
15251 for (s = SearchList; s; s = s->next)
15252 while (s->AuthRecs)
15253 {
15254 ARListElem *dereg = s->AuthRecs;
15255 s->AuthRecs = s->AuthRecs->next;
15256 mDNS_Deregister_internal(m, &dereg->ar, mDNS_Dereg_normal); // Memory will be freed in the FreeARElemCallback
15257 }
15258 }
15259 #endif
15260
15261 DeadvertiseAllInterfaceRecords(m);
15262
15263 // Shut down all our active NAT Traversals
15264 while (m->NATTraversals)
15265 {
15266 NATTraversalInfo *t = m->NATTraversals;
15267 mDNS_StopNATOperation_internal(m, t); // This will cut 't' from the list, thereby advancing m->NATTraversals in the process
15268
15269 // After stopping the NAT Traversal, we zero out the fields.
15270 // This has particularly important implications for our AutoTunnel records --
15271 // when we deregister our AutoTunnel records below, we don't want their mStatus_MemFree
15272 // handlers to just turn around and attempt to re-register those same records.
15273 // Clearing t->ExternalPort/t->RequestedPort will cause the mStatus_MemFree callback handlers
15274 // to not do this.
15275 t->ExternalAddress = zerov4Addr;
15276 t->NewAddress = zerov4Addr;
15277 t->ExternalPort = zeroIPPort;
15278 t->RequestedPort = zeroIPPort;
15279 t->Lifetime = 0;
15280 t->Result = mStatus_NoError;
15281 }
15282
15283 // Make sure there are nothing but deregistering records remaining in the list
15284 if (m->CurrentRecord)
15285 LogMsg("mDNS_StartExit: ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
15286
15287 // We're in the process of shutting down, so queries, etc. are no longer available.
15288 // Consequently, determining certain information, e.g. the uDNS update server's IP
15289 // address, will not be possible. The records on the main list are more likely to
15290 // already contain such information, so we deregister the duplicate records first.
15291 LogInfo("mDNS_StartExit: Deregistering duplicate resource records");
15292 DeregLoop(m, m->DuplicateRecords);
15293 LogInfo("mDNS_StartExit: Deregistering resource records");
15294 DeregLoop(m, m->ResourceRecords);
15295
15296 // If we scheduled a response to send goodbye packets, we set NextScheduledResponse to now. Normally when deregistering records,
15297 // we allow up to 100ms delay (to help improve record grouping) but when shutting down we don't want any such delay.
15298 if (m->NextScheduledResponse - m->timenow < mDNSPlatformOneSecond)
15299 {
15300 m->NextScheduledResponse = m->timenow;
15301 m->SuppressSending = 0;
15302 }
15303
15304 if (m->ResourceRecords) LogInfo("mDNS_StartExit: Sending final record deregistrations");
15305 else LogInfo("mDNS_StartExit: No deregistering records remain");
15306
15307 for (rr = m->DuplicateRecords; rr; rr = rr->next)
15308 LogMsg("mDNS_StartExit: Should not still have Duplicate Records remaining: %02X %s", rr->resrec.RecordType, ARDisplayString(m, rr));
15309
15310 // If any deregistering records remain, send their deregistration announcements before we exit
15311 if (m->mDNSPlatformStatus != mStatus_NoError) DiscardDeregistrations(m);
15312
15313 mDNS_Unlock(m);
15314
15315 LogInfo("mDNS_StartExit: done");
15316 }
15317
15318 mDNSexport void mDNS_FinalExit(mDNS *const m)
15319 {
15320 mDNSu32 rrcache_active = 0;
15321 mDNSu32 rrcache_totalused = m->rrcache_totalused;
15322 mDNSu32 slot;
15323 AuthRecord *rr;
15324
15325 LogInfo("mDNS_FinalExit: mDNSPlatformClose");
15326 mDNSPlatformClose(m);
15327
15328 for (slot = 0; slot < CACHE_HASH_SLOTS; slot++)
15329 {
15330 while (m->rrcache_hash[slot])
15331 {
15332 CacheGroup *cg = m->rrcache_hash[slot];
15333 while (cg->members)
15334 {
15335 CacheRecord *cr = cg->members;
15336 cg->members = cg->members->next;
15337 if (cr->CRActiveQuestion) rrcache_active++;
15338 ReleaseCacheRecord(m, cr);
15339 }
15340 cg->rrcache_tail = &cg->members;
15341 ReleaseCacheGroup(m, &m->rrcache_hash[slot]);
15342 }
15343 }
15344 debugf("mDNS_FinalExit: RR Cache was using %ld records, %lu active", rrcache_totalused, rrcache_active);
15345 if (rrcache_active != m->rrcache_active)
15346 LogMsg("*** ERROR *** rrcache_totalused %lu; rrcache_active %lu != m->rrcache_active %lu", rrcache_totalused, rrcache_active, m->rrcache_active);
15347
15348 for (rr = m->ResourceRecords; rr; rr = rr->next)
15349 LogMsg("mDNS_FinalExit failed to send goodbye for: %p %02X %s", rr, rr->resrec.RecordType, ARDisplayString(m, rr));
15350
15351 LogInfo("mDNS_FinalExit: done");
15352 }
15353
15354 #ifdef UNIT_TEST
15355 #include "../unittests/mdns_ut.c"
15356 #endif