]> git.saurik.com Git - apple/mdnsresponder.git/blob - mDNSCore/uDNS.c
mDNSResponder-878.240.1.tar.gz
[apple/mdnsresponder.git] / mDNSCore / uDNS.c
1 /* -*- Mode: C; tab-width: 4 -*-
2 *
3 * Copyright (c) 2002-2017 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 * To Do:
18 * Elimate all mDNSPlatformMemAllocate/mDNSPlatformMemFree from this code -- the core code
19 * is supposed to be malloc-free so that it runs in constant memory determined at compile-time.
20 * Any dynamic run-time requirements should be handled by the platform layer below or client layer above
21 */
22
23 #if APPLE_OSX_mDNSResponder
24 #include <TargetConditionals.h>
25 #endif
26 #include "uDNS.h"
27
28 #if AWD_METRICS
29 #include "Metrics.h"
30 #endif
31
32 #if (defined(_MSC_VER))
33 // Disable "assignment within conditional expression".
34 // Other compilers understand the convention that if you place the assignment expression within an extra pair
35 // of parentheses, this signals to the compiler that you really intended an assignment and no warning is necessary.
36 // The Microsoft compiler doesn't understand this convention, so in the absense of any other way to signal
37 // to the compiler that the assignment is intentional, we have to just turn this warning off completely.
38 #pragma warning(disable:4706)
39 #endif
40
41 // For domain enumeration and automatic browsing
42 // This is the user's DNS search list.
43 // In each of these domains we search for our special pointer records (lb._dns-sd._udp.<domain>, etc.)
44 // to discover recommended domains for domain enumeration (browse, default browse, registration,
45 // default registration) and possibly one or more recommended automatic browsing domains.
46 mDNSexport SearchListElem *SearchList = mDNSNULL;
47
48 // The value can be set to true by the Platform code e.g., MacOSX uses the plist mechanism
49 mDNSBool StrictUnicastOrdering = mDNSfalse;
50
51 // We keep track of the number of unicast DNS servers and log a message when we exceed 64.
52 // Currently the unicast queries maintain a 128 bit map to track the valid DNS servers for that
53 // question. Bit position is the index into the DNS server list. This is done so to try all
54 // the servers exactly once before giving up. If we could allocate memory in the core, then
55 // arbitrary limitation of 128 DNSServers can be removed.
56 mDNSu8 NumUnicastDNSServers = 0;
57 #define MAX_UNICAST_DNS_SERVERS 128
58 #if APPLE_OSX_mDNSResponder
59 mDNSu8 NumUnreachableDNSServers = 0;
60 #endif
61
62 #define SetNextuDNSEvent(m, rr) { \
63 if ((m)->NextuDNSEvent - ((rr)->LastAPTime + (rr)->ThisAPInterval) >= 0) \
64 (m)->NextuDNSEvent = ((rr)->LastAPTime + (rr)->ThisAPInterval); \
65 }
66
67 #ifndef UNICAST_DISABLED
68
69 // ***************************************************************************
70 #if COMPILER_LIKES_PRAGMA_MARK
71 #pragma mark - General Utility Functions
72 #endif
73
74 // set retry timestamp for record with exponential backoff
75 mDNSlocal void SetRecordRetry(mDNS *const m, AuthRecord *rr, mDNSu32 random)
76 {
77 rr->LastAPTime = m->timenow;
78
79 if (rr->expire && rr->refreshCount < MAX_UPDATE_REFRESH_COUNT)
80 {
81 mDNSs32 remaining = rr->expire - m->timenow;
82 rr->refreshCount++;
83 if (remaining > MIN_UPDATE_REFRESH_TIME)
84 {
85 // Refresh at 70% + random (currently it is 0 to 10%)
86 rr->ThisAPInterval = 7 * (remaining/10) + (random ? random : mDNSRandom(remaining/10));
87 // Don't update more often than 5 minutes
88 if (rr->ThisAPInterval < MIN_UPDATE_REFRESH_TIME)
89 rr->ThisAPInterval = MIN_UPDATE_REFRESH_TIME;
90 LogInfo("SetRecordRetry refresh in %d of %d for %s",
91 rr->ThisAPInterval/mDNSPlatformOneSecond, (rr->expire - m->timenow)/mDNSPlatformOneSecond, ARDisplayString(m, rr));
92 }
93 else
94 {
95 rr->ThisAPInterval = MIN_UPDATE_REFRESH_TIME;
96 LogInfo("SetRecordRetry clamping to min refresh in %d of %d for %s",
97 rr->ThisAPInterval/mDNSPlatformOneSecond, (rr->expire - m->timenow)/mDNSPlatformOneSecond, ARDisplayString(m, rr));
98 }
99 return;
100 }
101
102 rr->expire = 0;
103
104 rr->ThisAPInterval = rr->ThisAPInterval * QuestionIntervalStep; // Same Retry logic as Unicast Queries
105 if (rr->ThisAPInterval < INIT_RECORD_REG_INTERVAL)
106 rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
107 if (rr->ThisAPInterval > MAX_RECORD_REG_INTERVAL)
108 rr->ThisAPInterval = MAX_RECORD_REG_INTERVAL;
109
110 LogInfo("SetRecordRetry retry in %d ms for %s", rr->ThisAPInterval, ARDisplayString(m, rr));
111 }
112
113 // ***************************************************************************
114 #if COMPILER_LIKES_PRAGMA_MARK
115 #pragma mark - Name Server List Management
116 #endif
117
118 #define TrueFalseStr(X) ((X) ? "true" : "false")
119
120 mDNSexport DNSServer *mDNS_AddDNSServer(mDNS *const m, const domainname *d, const mDNSInterfaceID interface, const mDNSs32 serviceID, const mDNSAddr *addr,
121 const mDNSIPPort port, mDNSu32 scoped, mDNSu32 timeout, mDNSBool cellIntf, mDNSBool isExpensive, mDNSBool isCLAT46,
122 mDNSu16 resGroupID, mDNSBool reqA, mDNSBool reqAAAA, mDNSBool reqDO)
123 {
124 DNSServer **p = &m->DNSServers;
125 DNSServer *tmp = mDNSNULL;
126
127 if ((NumUnicastDNSServers + 1) > MAX_UNICAST_DNS_SERVERS)
128 {
129 LogMsg("mDNS_AddDNSServer: DNS server limit of %d reached, not adding this server", MAX_UNICAST_DNS_SERVERS);
130 return mDNSNULL;
131 }
132
133 if (!d)
134 d = (const domainname *)"";
135
136 LogInfo("mDNS_AddDNSServer(%d): Adding %#a for %##s, InterfaceID %p, serviceID %u, scoped %d, resGroupID %d req_A %s, req_AAAA %s, cell %s, expensive %s, CLAT46 %s, req_DO %s",
137 NumUnicastDNSServers, addr, d->c, interface, serviceID, scoped, resGroupID,
138 TrueFalseStr(reqA), TrueFalseStr(reqAAAA), TrueFalseStr(cellIntf), TrueFalseStr(isExpensive), TrueFalseStr(isCLAT46), TrueFalseStr(reqDO));
139
140 mDNS_CheckLock(m);
141
142 while (*p) // Check if we already have this {interface,address,port,domain} tuple registered + reqA/reqAAAA bits
143 {
144 if ((*p)->scoped == scoped && (*p)->interface == interface && (*p)->serviceID == serviceID &&
145 mDNSSameAddress(&(*p)->addr, addr) && mDNSSameIPPort((*p)->port, port) && SameDomainName(&(*p)->domain, d) &&
146 (*p)->req_A == reqA && (*p)->req_AAAA == reqAAAA)
147 {
148 if (!((*p)->flags & DNSServer_FlagDelete))
149 debugf("Note: DNS Server %#a:%d for domain %##s (%p) registered more than once", addr, mDNSVal16(port), d->c, interface);
150 tmp = *p;
151 *p = tmp->next;
152 tmp->next = mDNSNULL;
153 }
154 else
155 {
156 p=&(*p)->next;
157 }
158 }
159
160 // NumUnicastDNSServers is the count of active DNS servers i.e., ones that are not marked
161 // with DNSServer_FlagDelete. We should increment it:
162 //
163 // 1) When we add a new DNS server
164 // 2) When we resurrect a old DNS server that is marked with DNSServer_FlagDelete
165 //
166 // Don't increment when we resurrect a DNS server that is not marked with DNSServer_FlagDelete.
167 // We have already accounted for it when it was added for the first time. This case happens when
168 // we add DNS servers with the same address multiple times (mis-configuration).
169
170 if (!tmp || (tmp->flags & DNSServer_FlagDelete))
171 NumUnicastDNSServers++;
172
173
174 if (tmp)
175 {
176 #if APPLE_OSX_mDNSResponder
177 if (tmp->flags & DNSServer_FlagDelete)
178 {
179 tmp->flags &= ~DNSServer_FlagUnreachable;
180 }
181 #endif
182 tmp->flags &= ~DNSServer_FlagDelete;
183 *p = tmp; // move to end of list, to ensure ordering from platform layer
184 }
185 else
186 {
187 // allocate, add to list
188 *p = mDNSPlatformMemAllocate(sizeof(**p));
189 if (!*p)
190 {
191 LogMsg("Error: mDNS_AddDNSServer - malloc");
192 }
193 else
194 {
195 (*p)->scoped = scoped;
196 (*p)->interface = interface;
197 (*p)->serviceID = serviceID;
198 (*p)->addr = *addr;
199 (*p)->port = port;
200 (*p)->flags = DNSServer_FlagNew;
201 (*p)->timeout = timeout;
202 (*p)->cellIntf = cellIntf;
203 (*p)->isExpensive = isExpensive;
204 (*p)->isCLAT46 = isCLAT46;
205 (*p)->req_A = reqA;
206 (*p)->req_AAAA = reqAAAA;
207 (*p)->req_DO = reqDO;
208 // We start off assuming that the DNS server is not DNSSEC aware and
209 // when we receive the first response to a DNSSEC question, we set
210 // it to true.
211 (*p)->DNSSECAware = mDNSfalse;
212 (*p)->retransDO = 0;
213 AssignDomainName(&(*p)->domain, d);
214 (*p)->next = mDNSNULL;
215 }
216 }
217 if (*p) {
218 (*p)->penaltyTime = 0;
219 // We always update the ID (not just when we allocate a new instance) because we could
220 // be adding a new non-scoped resolver with a new ID and we want all the non-scoped
221 // resolvers belong to the same group.
222 (*p)->resGroupID = resGroupID;
223 }
224 return(*p);
225 }
226
227 // PenalizeDNSServer is called when the number of queries to the unicast
228 // DNS server exceeds MAX_UCAST_UNANSWERED_QUERIES or when we receive an
229 // error e.g., SERV_FAIL from DNS server.
230 mDNSexport void PenalizeDNSServer(mDNS *const m, DNSQuestion *q, mDNSOpaque16 responseFlags)
231 {
232 DNSServer *new;
233 DNSServer *orig = q->qDNSServer;
234 mDNSu8 rcode = '\0';
235
236 mDNS_CheckLock(m);
237
238 LogInfo("PenalizeDNSServer: Penalizing DNS server %#a question for question %p %##s (%s) SuppressUnusable %d",
239 (q->qDNSServer ? &q->qDNSServer->addr : mDNSNULL), q, q->qname.c, DNSTypeName(q->qtype), q->SuppressUnusable);
240
241 // If we get error from any DNS server, remember the error. If all of the servers,
242 // return the error, then return the first error.
243 if (mDNSOpaque16IsZero(q->responseFlags))
244 q->responseFlags = responseFlags;
245
246 rcode = (mDNSu8)(responseFlags.b[1] & kDNSFlag1_RC_Mask);
247
248 // After we reset the qDNSServer to NULL, we could get more SERV_FAILS that might end up
249 // penalizing again.
250 if (!q->qDNSServer)
251 goto end;
252
253 // If strict ordering of unicast servers needs to be preserved, we just lookup
254 // the next best match server below
255 //
256 // If strict ordering is not required which is the default behavior, we penalize the server
257 // for DNSSERVER_PENALTY_TIME. We may also use additional logic e.g., don't penalize for PTR
258 // in the future.
259
260 if (!StrictUnicastOrdering)
261 {
262 LogInfo("PenalizeDNSServer: Strict Unicast Ordering is FALSE");
263 // We penalize the server so that new queries don't pick this server for DNSSERVER_PENALTY_TIME
264 // XXX Include other logic here to see if this server should really be penalized
265 //
266 if (q->qtype == kDNSType_PTR)
267 {
268 LogInfo("PenalizeDNSServer: Not Penalizing PTR question");
269 }
270 else if ((rcode == kDNSFlag1_RC_FormErr) || (rcode == kDNSFlag1_RC_ServFail) || (rcode == kDNSFlag1_RC_NotImpl) || (rcode == kDNSFlag1_RC_Refused))
271 {
272 LogInfo("PenalizeDNSServer: Not Penalizing DNS Server since it at least responded with rcode %d", rcode);
273 }
274 else
275 {
276 LogInfo("PenalizeDNSServer: Penalizing question type %d", q->qtype);
277 q->qDNSServer->penaltyTime = NonZeroTime(m->timenow + DNSSERVER_PENALTY_TIME);
278 }
279 }
280 else
281 {
282 LogInfo("PenalizeDNSServer: Strict Unicast Ordering is TRUE");
283 }
284
285 end:
286 new = GetServerForQuestion(m, q);
287
288 if (new == orig)
289 {
290 if (new)
291 {
292 LogMsg("PenalizeDNSServer: ERROR!! GetServerForQuestion returned the same server %#a:%d", &new->addr,
293 mDNSVal16(new->port));
294 q->ThisQInterval = 0; // Inactivate this question so that we dont bombard the network
295 }
296 else
297 {
298 // When we have no more DNS servers, we might end up calling PenalizeDNSServer multiple
299 // times when we receive SERVFAIL from delayed packets in the network e.g., DNS server
300 // is slow in responding and we have sent three queries. When we repeatedly call, it is
301 // okay to receive the same NULL DNS server. Next time we try to send the query, we will
302 // realize and re-initialize the DNS servers.
303 LogInfo("PenalizeDNSServer: GetServerForQuestion returned the same server NULL");
304 }
305 }
306 else
307 {
308 // The new DNSServer is set in DNSServerChangeForQuestion
309 DNSServerChangeForQuestion(m, q, new);
310
311 if (new)
312 {
313 LogInfo("PenalizeDNSServer: Server for %##s (%s) changed to %#a:%d (%##s)",
314 q->qname.c, DNSTypeName(q->qtype), &q->qDNSServer->addr, mDNSVal16(q->qDNSServer->port), q->qDNSServer->domain.c);
315 // We want to try the next server immediately. As the question may already have backed off, reset
316 // the interval. We do this only the first time when we try all the DNS servers. Once we reached the end of
317 // list and retrying all the servers again e.g., at least one server failed to respond in the previous try, we
318 // use the normal backoff which is done in uDNS_CheckCurrentQuestion when we send the packet out.
319 if (!q->triedAllServersOnce)
320 {
321 q->ThisQInterval = InitialQuestionInterval;
322 q->LastQTime = m->timenow - q->ThisQInterval;
323 SetNextQueryTime(m, q);
324 }
325 }
326 else
327 {
328 // We don't have any more DNS servers for this question. If some server in the list did not return
329 // any response, we need to keep retrying till we get a response. uDNS_CheckCurrentQuestion handles
330 // this case.
331 //
332 // If all servers responded with a negative response, We need to do two things. First, generate a
333 // negative response so that applications get a reply. We also need to reinitialize the DNS servers
334 // so that when the cache expires, we can restart the query. We defer this up until we generate
335 // a negative cache response in uDNS_CheckCurrentQuestion.
336 //
337 // Be careful not to touch the ThisQInterval here. For a normal question, when we answer the question
338 // in AnswerCurrentQuestionWithResourceRecord will set ThisQInterval to MaxQuestionInterval and hence
339 // the next query will not happen until cache expiry. If it is a long lived question,
340 // AnswerCurrentQuestionWithResourceRecord will not set it to MaxQuestionInterval. In that case,
341 // we want the normal backoff to work.
342 LogInfo("PenalizeDNSServer: Server for %p, %##s (%s) changed to NULL, Interval %d", q, q->qname.c, DNSTypeName(q->qtype), q->ThisQInterval);
343 }
344 q->unansweredQueries = 0;
345
346 }
347 }
348
349 // ***************************************************************************
350 #if COMPILER_LIKES_PRAGMA_MARK
351 #pragma mark - authorization management
352 #endif
353
354 mDNSlocal DomainAuthInfo *GetAuthInfoForName_direct(mDNS *m, const domainname *const name)
355 {
356 const domainname *n = name;
357 while (n->c[0])
358 {
359 DomainAuthInfo *ptr;
360 for (ptr = m->AuthInfoList; ptr; ptr = ptr->next)
361 if (SameDomainName(&ptr->domain, n))
362 {
363 debugf("GetAuthInfoForName %##s Matched %##s Key name %##s", name->c, ptr->domain.c, ptr->keyname.c);
364 return(ptr);
365 }
366 n = (const domainname *)(n->c + 1 + n->c[0]);
367 }
368 //LogInfo("GetAuthInfoForName none found for %##s", name->c);
369 return mDNSNULL;
370 }
371
372 // MUST be called with lock held
373 mDNSexport DomainAuthInfo *GetAuthInfoForName_internal(mDNS *m, const domainname *const name)
374 {
375 DomainAuthInfo **p = &m->AuthInfoList;
376
377 mDNS_CheckLock(m);
378
379 // First purge any dead keys from the list
380 while (*p)
381 {
382 if ((*p)->deltime && m->timenow - (*p)->deltime >= 0 && AutoTunnelUnregistered(*p))
383 {
384 DNSQuestion *q;
385 DomainAuthInfo *info = *p;
386 LogInfo("GetAuthInfoForName_internal deleting expired key %##s %##s", info->domain.c, info->keyname.c);
387 *p = info->next; // Cut DomainAuthInfo from list *before* scanning our question list updating AuthInfo pointers
388 for (q = m->Questions; q; q=q->next)
389 if (q->AuthInfo == info)
390 {
391 q->AuthInfo = GetAuthInfoForName_direct(m, &q->qname);
392 debugf("GetAuthInfoForName_internal updated q->AuthInfo from %##s to %##s for %##s (%s)",
393 info->domain.c, q->AuthInfo ? q->AuthInfo->domain.c : mDNSNULL, q->qname.c, DNSTypeName(q->qtype));
394 }
395
396 // Probably not essential, but just to be safe, zero out the secret key data
397 // so we don't leave it hanging around in memory
398 // (where it could potentially get exposed via some other bug)
399 mDNSPlatformMemZero(info, sizeof(*info));
400 mDNSPlatformMemFree(info);
401 }
402 else
403 p = &(*p)->next;
404 }
405
406 return(GetAuthInfoForName_direct(m, name));
407 }
408
409 mDNSexport DomainAuthInfo *GetAuthInfoForName(mDNS *m, const domainname *const name)
410 {
411 DomainAuthInfo *d;
412 mDNS_Lock(m);
413 d = GetAuthInfoForName_internal(m, name);
414 mDNS_Unlock(m);
415 return(d);
416 }
417
418 // MUST be called with the lock held
419 mDNSexport mStatus mDNS_SetSecretForDomain(mDNS *m, DomainAuthInfo *info,
420 const domainname *domain, const domainname *keyname, const char *b64keydata, const domainname *hostname, mDNSIPPort *port, mDNSBool autoTunnel)
421 {
422 DNSQuestion *q;
423 DomainAuthInfo **p = &m->AuthInfoList;
424 if (!info || !b64keydata) { LogMsg("mDNS_SetSecretForDomain: ERROR: info %p b64keydata %p", info, b64keydata); return(mStatus_BadParamErr); }
425
426 LogInfo("mDNS_SetSecretForDomain: domain %##s key %##s%s", domain->c, keyname->c, autoTunnel ? " AutoTunnel" : "");
427
428 info->AutoTunnel = autoTunnel;
429 AssignDomainName(&info->domain, domain);
430 AssignDomainName(&info->keyname, keyname);
431 if (hostname)
432 AssignDomainName(&info->hostname, hostname);
433 else
434 info->hostname.c[0] = 0;
435 if (port)
436 info->port = *port;
437 else
438 info->port = zeroIPPort;
439 mDNS_snprintf(info->b64keydata, sizeof(info->b64keydata), "%s", b64keydata);
440
441 if (DNSDigest_ConstructHMACKeyfromBase64(info, b64keydata) < 0)
442 {
443 LogMsg("mDNS_SetSecretForDomain: ERROR: Could not convert shared secret from base64: domain %##s key %##s %s", domain->c, keyname->c, mDNS_LoggingEnabled ? b64keydata : "");
444 return(mStatus_BadParamErr);
445 }
446
447 // Don't clear deltime until after we've ascertained that b64keydata is valid
448 info->deltime = 0;
449
450 while (*p && (*p) != info) p=&(*p)->next;
451 if (*p) {LogInfo("mDNS_SetSecretForDomain: Domain %##s Already in list", (*p)->domain.c); return(mStatus_AlreadyRegistered);}
452
453 // Caution: Only zero AutoTunnelHostRecord.namestorage AFTER we've determined that this is a NEW DomainAuthInfo
454 // being added to the list. Otherwise we risk smashing our AutoTunnel host records that are already active and in use.
455 info->AutoTunnelHostRecord.resrec.RecordType = kDNSRecordTypeUnregistered;
456 info->AutoTunnelHostRecord.namestorage.c[0] = 0;
457 info->AutoTunnelTarget.resrec.RecordType = kDNSRecordTypeUnregistered;
458 info->AutoTunnelDeviceInfo.resrec.RecordType = kDNSRecordTypeUnregistered;
459 info->AutoTunnelService.resrec.RecordType = kDNSRecordTypeUnregistered;
460 info->AutoTunnel6Record.resrec.RecordType = kDNSRecordTypeUnregistered;
461 info->AutoTunnelServiceStarted = mDNSfalse;
462 info->AutoTunnelInnerAddress = zerov6Addr;
463 info->next = mDNSNULL;
464 *p = info;
465
466 // Check to see if adding this new DomainAuthInfo has changed the credentials for any of our questions
467 for (q = m->Questions; q; q=q->next)
468 {
469 DomainAuthInfo *newinfo = GetAuthInfoForQuestion(m, q);
470 if (q->AuthInfo != newinfo)
471 {
472 debugf("mDNS_SetSecretForDomain updating q->AuthInfo from %##s to %##s for %##s (%s)",
473 q->AuthInfo ? q->AuthInfo->domain.c : mDNSNULL,
474 newinfo ? newinfo->domain.c : mDNSNULL, q->qname.c, DNSTypeName(q->qtype));
475 q->AuthInfo = newinfo;
476 }
477 }
478
479 return(mStatus_NoError);
480 }
481
482 // ***************************************************************************
483 #if COMPILER_LIKES_PRAGMA_MARK
484 #pragma mark -
485 #pragma mark - NAT Traversal
486 #endif
487
488 // Keep track of when to request/refresh the external address using NAT-PMP or UPnP/IGD,
489 // and do so when necessary
490 mDNSlocal mStatus uDNS_RequestAddress(mDNS *m)
491 {
492 mStatus err = mStatus_NoError;
493
494 if (!m->NATTraversals)
495 {
496 m->retryGetAddr = NonZeroTime(m->timenow + FutureTime);
497 LogInfo("uDNS_RequestAddress: Setting retryGetAddr to future");
498 }
499 else if (m->timenow - m->retryGetAddr >= 0)
500 {
501 if (mDNSv4AddrIsRFC1918(&m->Router.ip.v4))
502 {
503 static NATAddrRequest req = {NATMAP_VERS, NATOp_AddrRequest};
504 static mDNSu8* start = (mDNSu8*)&req;
505 mDNSu8* end = start + sizeof(NATAddrRequest);
506 err = mDNSPlatformSendUDP(m, start, end, 0, mDNSNULL, &m->Router, NATPMPPort, mDNSfalse);
507 debugf("uDNS_RequestAddress: Sent NAT-PMP external address request %d", err);
508
509 #ifdef _LEGACY_NAT_TRAVERSAL_
510 if (mDNSIPPortIsZero(m->UPnPRouterPort) || mDNSIPPortIsZero(m->UPnPSOAPPort))
511 {
512 LNT_SendDiscoveryMsg(m);
513 debugf("uDNS_RequestAddress: LNT_SendDiscoveryMsg");
514 }
515 else
516 {
517 mStatus lnterr = LNT_GetExternalAddress(m);
518 if (lnterr)
519 LogMsg("uDNS_RequestAddress: LNT_GetExternalAddress returned error %d", lnterr);
520
521 err = err ? err : lnterr; // NAT-PMP error takes precedence
522 }
523 #endif // _LEGACY_NAT_TRAVERSAL_
524 }
525
526 // Always update the interval and retry time, so that even if we fail to send the
527 // packet, we won't spin in an infinite loop repeatedly failing to send the packet
528 if (m->retryIntervalGetAddr < NATMAP_INIT_RETRY)
529 {
530 m->retryIntervalGetAddr = NATMAP_INIT_RETRY;
531 }
532 else if (m->retryIntervalGetAddr < NATMAP_MAX_RETRY_INTERVAL / 2)
533 {
534 m->retryIntervalGetAddr *= 2;
535 }
536 else
537 {
538 m->retryIntervalGetAddr = NATMAP_MAX_RETRY_INTERVAL;
539 }
540
541 m->retryGetAddr = NonZeroTime(m->timenow + m->retryIntervalGetAddr);
542 }
543 else
544 {
545 debugf("uDNS_RequestAddress: Not time to send address request");
546 }
547
548 // Always update NextScheduledNATOp, even if we didn't change retryGetAddr, so we'll
549 // be called when we need to send the request(s)
550 if (m->NextScheduledNATOp - m->retryGetAddr > 0)
551 m->NextScheduledNATOp = m->retryGetAddr;
552
553 return err;
554 }
555
556 mDNSlocal mStatus uDNS_SendNATMsg(mDNS *m, NATTraversalInfo *info, mDNSBool usePCP, mDNSBool unmapping)
557 {
558 mStatus err = mStatus_NoError;
559
560 if (!info)
561 {
562 LogMsg("uDNS_SendNATMsg called unexpectedly with NULL info");
563 return mStatus_BadParamErr;
564 }
565
566 // send msg if the router's address is private (which means it's non-zero)
567 if (mDNSv4AddrIsRFC1918(&m->Router.ip.v4))
568 {
569 if (!usePCP)
570 {
571 if (!info->sentNATPMP)
572 {
573 if (info->Protocol)
574 {
575 static NATPortMapRequest NATPortReq;
576 static const mDNSu8* end = (mDNSu8 *)&NATPortReq + sizeof(NATPortMapRequest);
577 mDNSu8 *p = (mDNSu8 *)&NATPortReq.NATReq_lease;
578
579 NATPortReq.vers = NATMAP_VERS;
580 NATPortReq.opcode = info->Protocol;
581 NATPortReq.unused = zeroID;
582 NATPortReq.intport = info->IntPort;
583 NATPortReq.extport = info->RequestedPort;
584 p[0] = (mDNSu8)((info->NATLease >> 24) & 0xFF);
585 p[1] = (mDNSu8)((info->NATLease >> 16) & 0xFF);
586 p[2] = (mDNSu8)((info->NATLease >> 8) & 0xFF);
587 p[3] = (mDNSu8)( info->NATLease & 0xFF);
588
589 err = mDNSPlatformSendUDP(m, (mDNSu8 *)&NATPortReq, end, 0, mDNSNULL, &m->Router, NATPMPPort, mDNSfalse);
590 debugf("uDNS_SendNATMsg: Sent NAT-PMP mapping request %d", err);
591 }
592
593 // In case the address request already went out for another NAT-T,
594 // set the NewAddress to the currently known global external address, so
595 // Address-only operations will get the callback immediately
596 info->NewAddress = m->ExtAddress;
597
598 // Remember that we just sent a NAT-PMP packet, so we won't resend one later.
599 // We do this because the NAT-PMP "Unsupported Version" response has no
600 // information about the (PCP) request that triggered it, so we must send
601 // NAT-PMP requests for all operations. Without this, we'll send n PCP
602 // requests for n operations, receive n NAT-PMP "Unsupported Version"
603 // responses, and send n NAT-PMP requests for each of those responses,
604 // resulting in (n + n^2) packets sent. We only want to send 2n packets:
605 // n PCP requests followed by n NAT-PMP requests.
606 info->sentNATPMP = mDNStrue;
607 }
608 }
609 else
610 {
611 PCPMapRequest req;
612 mDNSu8* start = (mDNSu8*)&req;
613 mDNSu8* end = start + sizeof(req);
614 mDNSu8* p = (mDNSu8*)&req.lifetime;
615
616 req.version = PCP_VERS;
617 req.opCode = PCPOp_Map;
618 req.reserved = zeroID;
619
620 p[0] = (mDNSu8)((info->NATLease >> 24) & 0xFF);
621 p[1] = (mDNSu8)((info->NATLease >> 16) & 0xFF);
622 p[2] = (mDNSu8)((info->NATLease >> 8) & 0xFF);
623 p[3] = (mDNSu8)( info->NATLease & 0xFF);
624
625 mDNSAddrMapIPv4toIPv6(&m->AdvertisedV4.ip.v4, &req.clientAddr);
626
627 req.nonce[0] = m->PCPNonce[0];
628 req.nonce[1] = m->PCPNonce[1];
629 req.nonce[2] = m->PCPNonce[2];
630
631 req.protocol = (info->Protocol == NATOp_MapUDP ? PCPProto_UDP : PCPProto_TCP);
632
633 req.reservedMapOp[0] = 0;
634 req.reservedMapOp[1] = 0;
635 req.reservedMapOp[2] = 0;
636
637 req.intPort = info->Protocol ? info->IntPort : DiscardPort;
638 req.extPort = info->RequestedPort;
639
640 // Since we only support IPv4, even if using the all-zeros address, map it, so
641 // the PCP gateway will give us an IPv4 address & not an IPv6 address.
642 mDNSAddrMapIPv4toIPv6(&info->NewAddress, &req.extAddress);
643
644 err = mDNSPlatformSendUDP(m, start, end, 0, mDNSNULL, &m->Router, NATPMPPort, mDNSfalse);
645 debugf("uDNS_SendNATMsg: Sent PCP Mapping request %d", err);
646
647 // Unset the sentNATPMP flag, so that we'll send a NAT-PMP packet if we
648 // receive a NAT-PMP "Unsupported Version" packet. This will result in every
649 // renewal, retransmission, etc. being tried first as PCP, then if a NAT-PMP
650 // "Unsupported Version" response is received, fall-back & send the request
651 // using NAT-PMP.
652 info->sentNATPMP = mDNSfalse;
653
654 #ifdef _LEGACY_NAT_TRAVERSAL_
655 // If an unmapping is being performed, then don't send an LNT discovery message or an LNT port map request.
656 if (!unmapping)
657 {
658 if (mDNSIPPortIsZero(m->UPnPRouterPort) || mDNSIPPortIsZero(m->UPnPSOAPPort))
659 {
660 LNT_SendDiscoveryMsg(m);
661 debugf("uDNS_SendNATMsg: LNT_SendDiscoveryMsg");
662 }
663 else
664 {
665 mStatus lnterr = LNT_MapPort(m, info);
666 if (lnterr)
667 LogMsg("uDNS_SendNATMsg: LNT_MapPort returned error %d", lnterr);
668
669 err = err ? err : lnterr; // PCP error takes precedence
670 }
671 }
672 #else
673 (void)unmapping; // Unused
674 #endif // _LEGACY_NAT_TRAVERSAL_
675 }
676 }
677
678 return(err);
679 }
680
681 mDNSexport void RecreateNATMappings(mDNS *const m, const mDNSu32 waitTicks)
682 {
683 mDNSu32 when = NonZeroTime(m->timenow + waitTicks);
684 NATTraversalInfo *n;
685 for (n = m->NATTraversals; n; n=n->next)
686 {
687 n->ExpiryTime = 0; // Mark this mapping as expired
688 n->retryInterval = NATMAP_INIT_RETRY;
689 n->retryPortMap = when;
690 n->lastSuccessfulProtocol = NATTProtocolNone;
691 if (!n->Protocol) n->NewResult = mStatus_NoError;
692 #ifdef _LEGACY_NAT_TRAVERSAL_
693 if (n->tcpInfo.sock) { mDNSPlatformTCPCloseConnection(n->tcpInfo.sock); n->tcpInfo.sock = mDNSNULL; }
694 #endif // _LEGACY_NAT_TRAVERSAL_
695 }
696
697 m->PCPNonce[0] = mDNSRandom(-1);
698 m->PCPNonce[1] = mDNSRandom(-1);
699 m->PCPNonce[2] = mDNSRandom(-1);
700 m->retryIntervalGetAddr = 0;
701 m->retryGetAddr = when;
702
703 #ifdef _LEGACY_NAT_TRAVERSAL_
704 LNT_ClearState(m);
705 #endif // _LEGACY_NAT_TRAVERSAL_
706
707 m->NextScheduledNATOp = m->timenow; // Need to send packets immediately
708 }
709
710 mDNSexport void natTraversalHandleAddressReply(mDNS *const m, mDNSu16 err, mDNSv4Addr ExtAddr)
711 {
712 static mDNSu16 last_err = 0;
713 NATTraversalInfo *n;
714
715 if (err)
716 {
717 if (err != last_err) LogMsg("Error getting external address %d", err);
718 ExtAddr = zerov4Addr;
719 }
720 else
721 {
722 LogInfo("Received external IP address %.4a from NAT", &ExtAddr);
723 if (mDNSv4AddrIsRFC1918(&ExtAddr))
724 LogMsg("Double NAT (external NAT gateway address %.4a is also a private RFC 1918 address)", &ExtAddr);
725 if (mDNSIPv4AddressIsZero(ExtAddr))
726 err = NATErr_NetFail; // fake error to handle routers that pathologically report success with the zero address
727 }
728
729 // Globally remember the most recently discovered address, so it can be used in each
730 // new NATTraversal structure
731 m->ExtAddress = ExtAddr;
732
733 if (!err) // Success, back-off to maximum interval
734 m->retryIntervalGetAddr = NATMAP_MAX_RETRY_INTERVAL;
735 else if (!last_err) // Failure after success, retry quickly (then back-off exponentially)
736 m->retryIntervalGetAddr = NATMAP_INIT_RETRY;
737 // else back-off normally in case of pathological failures
738
739 m->retryGetAddr = m->timenow + m->retryIntervalGetAddr;
740 if (m->NextScheduledNATOp - m->retryGetAddr > 0)
741 m->NextScheduledNATOp = m->retryGetAddr;
742
743 last_err = err;
744
745 for (n = m->NATTraversals; n; n=n->next)
746 {
747 // We should change n->NewAddress only when n is one of:
748 // 1) a mapping operation that most recently succeeded using NAT-PMP or UPnP/IGD,
749 // because such an operation needs the update now. If the lastSuccessfulProtocol
750 // is currently none, then natTraversalHandlePortMapReplyWithAddress() will be
751 // called should NAT-PMP or UPnP/IGD succeed in the future.
752 // 2) an address-only operation that did not succeed via PCP, because when such an
753 // operation succeeds via PCP, it's for the TCP discard port just to learn the
754 // address. And that address may be different than the external address
755 // discovered via NAT-PMP or UPnP/IGD. If the lastSuccessfulProtocol
756 // is currently none, we must update the NewAddress as PCP may not succeed.
757 if (!mDNSSameIPv4Address(n->NewAddress, ExtAddr) &&
758 (n->Protocol ?
759 (n->lastSuccessfulProtocol == NATTProtocolNATPMP || n->lastSuccessfulProtocol == NATTProtocolUPNPIGD) :
760 (n->lastSuccessfulProtocol != NATTProtocolPCP)))
761 {
762 // Needs an update immediately
763 n->NewAddress = ExtAddr;
764 n->ExpiryTime = 0;
765 n->retryInterval = NATMAP_INIT_RETRY;
766 n->retryPortMap = m->timenow;
767 #ifdef _LEGACY_NAT_TRAVERSAL_
768 if (n->tcpInfo.sock) { mDNSPlatformTCPCloseConnection(n->tcpInfo.sock); n->tcpInfo.sock = mDNSNULL; }
769 #endif // _LEGACY_NAT_TRAVERSAL_
770
771 m->NextScheduledNATOp = m->timenow; // Need to send packets immediately
772 }
773 }
774 }
775
776 // Both places that call NATSetNextRenewalTime() update m->NextScheduledNATOp correctly afterwards
777 mDNSlocal void NATSetNextRenewalTime(mDNS *const m, NATTraversalInfo *n)
778 {
779 n->retryInterval = (n->ExpiryTime - m->timenow)/2;
780 if (n->retryInterval < NATMAP_MIN_RETRY_INTERVAL) // Min retry interval is 2 seconds
781 n->retryInterval = NATMAP_MIN_RETRY_INTERVAL;
782 n->retryPortMap = m->timenow + n->retryInterval;
783 }
784
785 mDNSlocal void natTraversalHandlePortMapReplyWithAddress(mDNS *const m, NATTraversalInfo *n, const mDNSInterfaceID InterfaceID, mDNSu16 err, mDNSv4Addr extaddr, mDNSIPPort extport, mDNSu32 lease, NATTProtocol protocol)
786 {
787 const char *prot = n->Protocol == 0 ? "Add" : n->Protocol == NATOp_MapUDP ? "UDP" : n->Protocol == NATOp_MapTCP ? "TCP" : "???";
788 (void)prot;
789 n->NewResult = err;
790 if (err || lease == 0 || mDNSIPPortIsZero(extport))
791 {
792 LogInfo("natTraversalHandlePortMapReplyWithAddress: %p Response %s Port %5d External %.4a:%d lease %d error %d",
793 n, prot, mDNSVal16(n->IntPort), &extaddr, mDNSVal16(extport), lease, err);
794 n->retryInterval = NATMAP_MAX_RETRY_INTERVAL;
795 n->retryPortMap = m->timenow + NATMAP_MAX_RETRY_INTERVAL;
796 // No need to set m->NextScheduledNATOp here, since we're only ever extending the m->retryPortMap time
797 if (err == NATErr_Refused) n->NewResult = mStatus_NATPortMappingDisabled;
798 else if (err > NATErr_None && err <= NATErr_Opcode) n->NewResult = mStatus_NATPortMappingUnsupported;
799 }
800 else
801 {
802 if (lease > 999999999UL / mDNSPlatformOneSecond)
803 lease = 999999999UL / mDNSPlatformOneSecond;
804 n->ExpiryTime = NonZeroTime(m->timenow + lease * mDNSPlatformOneSecond);
805
806 if (!mDNSSameIPv4Address(n->NewAddress, extaddr) || !mDNSSameIPPort(n->RequestedPort, extport))
807 LogInfo("natTraversalHandlePortMapReplyWithAddress: %p %s Response %s Port %5d External %.4a:%d changed to %.4a:%d lease %d",
808 n,
809 (n->lastSuccessfulProtocol == NATTProtocolNone ? "None " :
810 n->lastSuccessfulProtocol == NATTProtocolNATPMP ? "NAT-PMP " :
811 n->lastSuccessfulProtocol == NATTProtocolUPNPIGD ? "UPnP/IGD" :
812 n->lastSuccessfulProtocol == NATTProtocolPCP ? "PCP " :
813 /* else */ "Unknown " ),
814 prot, mDNSVal16(n->IntPort), &n->NewAddress, mDNSVal16(n->RequestedPort),
815 &extaddr, mDNSVal16(extport), lease);
816
817 n->InterfaceID = InterfaceID;
818 n->NewAddress = extaddr;
819 if (n->Protocol) n->RequestedPort = extport; // Don't report the (PCP) external port to address-only operations
820 n->lastSuccessfulProtocol = protocol;
821
822 NATSetNextRenewalTime(m, n); // Got our port mapping; now set timer to renew it at halfway point
823 m->NextScheduledNATOp = m->timenow; // May need to invoke client callback immediately
824 }
825 }
826
827 // To be called for NAT-PMP or UPnP/IGD mappings, to use currently discovered (global) address
828 mDNSexport void natTraversalHandlePortMapReply(mDNS *const m, NATTraversalInfo *n, const mDNSInterfaceID InterfaceID, mDNSu16 err, mDNSIPPort extport, mDNSu32 lease, NATTProtocol protocol)
829 {
830 natTraversalHandlePortMapReplyWithAddress(m, n, InterfaceID, err, m->ExtAddress, extport, lease, protocol);
831 }
832
833 // Must be called with the mDNS_Lock held
834 mDNSexport mStatus mDNS_StartNATOperation_internal(mDNS *const m, NATTraversalInfo *traversal)
835 {
836 NATTraversalInfo **n;
837
838 LogInfo("mDNS_StartNATOperation_internal %p Protocol %d IntPort %d RequestedPort %d NATLease %d", traversal,
839 traversal->Protocol, mDNSVal16(traversal->IntPort), mDNSVal16(traversal->RequestedPort), traversal->NATLease);
840
841 // Note: It important that new traversal requests are appended at the *end* of the list, not prepended at the start
842 for (n = &m->NATTraversals; *n; n=&(*n)->next)
843 {
844 if (traversal == *n)
845 {
846 LogFatalError("Error! Tried to add a NAT traversal that's already in the active list: request %p Prot %d Int %d TTL %d",
847 traversal, traversal->Protocol, mDNSVal16(traversal->IntPort), traversal->NATLease);
848 return(mStatus_AlreadyRegistered);
849 }
850 if (traversal->Protocol && traversal->Protocol == (*n)->Protocol && mDNSSameIPPort(traversal->IntPort, (*n)->IntPort) &&
851 !mDNSSameIPPort(traversal->IntPort, SSHPort))
852 LogMsg("Warning: Created port mapping request %p Prot %d Int %d TTL %d "
853 "duplicates existing port mapping request %p Prot %d Int %d TTL %d",
854 traversal, traversal->Protocol, mDNSVal16(traversal->IntPort), traversal->NATLease,
855 *n, (*n)->Protocol, mDNSVal16((*n)->IntPort), (*n)->NATLease);
856 }
857
858 // Initialize necessary fields
859 traversal->next = mDNSNULL;
860 traversal->ExpiryTime = 0;
861 traversal->retryInterval = NATMAP_INIT_RETRY;
862 traversal->retryPortMap = m->timenow;
863 traversal->NewResult = mStatus_NoError;
864 traversal->lastSuccessfulProtocol = NATTProtocolNone;
865 traversal->sentNATPMP = mDNSfalse;
866 traversal->ExternalAddress = onesIPv4Addr;
867 traversal->NewAddress = zerov4Addr;
868 traversal->ExternalPort = zeroIPPort;
869 traversal->Lifetime = 0;
870 traversal->Result = mStatus_NoError;
871
872 // set default lease if necessary
873 if (!traversal->NATLease) traversal->NATLease = NATMAP_DEFAULT_LEASE;
874
875 #ifdef _LEGACY_NAT_TRAVERSAL_
876 mDNSPlatformMemZero(&traversal->tcpInfo, sizeof(traversal->tcpInfo));
877 #endif // _LEGACY_NAT_TRAVERSAL_
878
879 if (!m->NATTraversals) // If this is our first NAT request, kick off an address request too
880 {
881 m->retryGetAddr = m->timenow;
882 m->retryIntervalGetAddr = NATMAP_INIT_RETRY;
883 }
884
885 // If this is an address-only operation, initialize to the current global address,
886 // or (in non-PCP environments) we won't know the address until the next external
887 // address request/response.
888 if (!traversal->Protocol)
889 {
890 traversal->NewAddress = m->ExtAddress;
891 }
892
893 m->NextScheduledNATOp = m->timenow; // This will always trigger sending the packet ASAP, and generate client callback if necessary
894
895 *n = traversal; // Append new NATTraversalInfo to the end of our list
896
897 return(mStatus_NoError);
898 }
899
900 // Must be called with the mDNS_Lock held
901 mDNSexport mStatus mDNS_StopNATOperation_internal(mDNS *m, NATTraversalInfo *traversal)
902 {
903 mDNSBool unmap = mDNStrue;
904 NATTraversalInfo *p;
905 NATTraversalInfo **ptr = &m->NATTraversals;
906
907 while (*ptr && *ptr != traversal) ptr=&(*ptr)->next;
908 if (*ptr) *ptr = (*ptr)->next; // If we found it, cut this NATTraversalInfo struct from our list
909 else
910 {
911 LogMsg("mDNS_StopNATOperation_internal: NATTraversalInfo %p not found in list", traversal);
912 return(mStatus_BadReferenceErr);
913 }
914
915 LogInfo("mDNS_StopNATOperation_internal %p %d %d %d %d", traversal,
916 traversal->Protocol, mDNSVal16(traversal->IntPort), mDNSVal16(traversal->RequestedPort), traversal->NATLease);
917
918 if (m->CurrentNATTraversal == traversal)
919 m->CurrentNATTraversal = m->CurrentNATTraversal->next;
920
921 // If there is a match for the operation being stopped, don't send a deletion request (unmap)
922 for (p = m->NATTraversals; p; p=p->next)
923 {
924 if (traversal->Protocol ?
925 ((traversal->Protocol == p->Protocol && mDNSSameIPPort(traversal->IntPort, p->IntPort)) ||
926 (!p->Protocol && traversal->Protocol == NATOp_MapTCP && mDNSSameIPPort(traversal->IntPort, DiscardPort))) :
927 (!p->Protocol || (p->Protocol == NATOp_MapTCP && mDNSSameIPPort(p->IntPort, DiscardPort))))
928 {
929 LogInfo("Warning: Removed port mapping request %p Prot %d Int %d TTL %d "
930 "duplicates existing port mapping request %p Prot %d Int %d TTL %d",
931 traversal, traversal->Protocol, mDNSVal16(traversal->IntPort), traversal->NATLease,
932 p, p->Protocol, mDNSVal16( p->IntPort), p->NATLease);
933 unmap = mDNSfalse;
934 }
935 }
936
937 // Even if we DIDN'T make a successful UPnP mapping yet, we might still have a partially-open TCP connection we need to clean up
938 // Before zeroing traversal->RequestedPort below, perform the LNT unmapping, which requires the mapping's external port,
939 // held by the traversal->RequestedPort variable.
940 #ifdef _LEGACY_NAT_TRAVERSAL_
941 {
942 mStatus err = LNT_UnmapPort(m, traversal);
943 if (err) LogMsg("Legacy NAT Traversal - unmap request failed with error %d", err);
944 }
945 #endif // _LEGACY_NAT_TRAVERSAL_
946
947 if (traversal->ExpiryTime && unmap)
948 {
949 traversal->NATLease = 0;
950 traversal->retryInterval = 0;
951
952 // In case we most recently sent NAT-PMP, we need to set sentNATPMP to false so
953 // that we'll send a NAT-PMP request to destroy the mapping. We do this because
954 // the NATTraversal struct has already been cut from the list, and the client
955 // layer will destroy the memory upon returning from this function, so we can't
956 // try PCP first and then fall-back to NAT-PMP. That is, if we most recently
957 // created/renewed the mapping using NAT-PMP, we need to destroy it using NAT-PMP
958 // now, because we won't get a chance later.
959 traversal->sentNATPMP = mDNSfalse;
960
961 // Both NAT-PMP & PCP RFCs state that the suggested port in deletion requests
962 // should be zero. And for PCP, the suggested external address should also be
963 // zero, specifically, the all-zeros IPv4-mapped address, since we would only
964 // would have requested an IPv4 address.
965 traversal->RequestedPort = zeroIPPort;
966 traversal->NewAddress = zerov4Addr;
967
968 uDNS_SendNATMsg(m, traversal, traversal->lastSuccessfulProtocol != NATTProtocolNATPMP, mDNStrue);
969 }
970
971 return(mStatus_NoError);
972 }
973
974 mDNSexport mStatus mDNS_StartNATOperation(mDNS *const m, NATTraversalInfo *traversal)
975 {
976 mStatus status;
977 mDNS_Lock(m);
978 status = mDNS_StartNATOperation_internal(m, traversal);
979 mDNS_Unlock(m);
980 return(status);
981 }
982
983 mDNSexport mStatus mDNS_StopNATOperation(mDNS *const m, NATTraversalInfo *traversal)
984 {
985 mStatus status;
986 mDNS_Lock(m);
987 status = mDNS_StopNATOperation_internal(m, traversal);
988 mDNS_Unlock(m);
989 return(status);
990 }
991
992 // ***************************************************************************
993 #if COMPILER_LIKES_PRAGMA_MARK
994 #pragma mark -
995 #pragma mark - Long-Lived Queries
996 #endif
997
998 // Lock must be held -- otherwise m->timenow is undefined
999 mDNSlocal void StartLLQPolling(mDNS *const m, DNSQuestion *q)
1000 {
1001 debugf("StartLLQPolling: %##s", q->qname.c);
1002 q->state = LLQ_Poll;
1003 q->ThisQInterval = INIT_UCAST_POLL_INTERVAL;
1004 // We want to send our poll query ASAP, but the "+ 1" is because if we set the time to now,
1005 // we risk causing spurious "SendQueries didn't send all its queries" log messages
1006 q->LastQTime = m->timenow - q->ThisQInterval + 1;
1007 SetNextQueryTime(m, q);
1008 #if APPLE_OSX_mDNSResponder
1009 UpdateAutoTunnelDomainStatuses(m);
1010 #endif
1011 }
1012
1013 mDNSlocal mDNSu8 *putLLQ(DNSMessage *const msg, mDNSu8 *ptr, const DNSQuestion *const question, const LLQOptData *const data)
1014 {
1015 AuthRecord rr;
1016 ResourceRecord *opt = &rr.resrec;
1017 rdataOPT *optRD;
1018
1019 //!!!KRS when we implement multiple llqs per message, we'll need to memmove anything past the question section
1020 ptr = putQuestion(msg, ptr, msg->data + AbsoluteMaxDNSMessageData, &question->qname, question->qtype, question->qclass);
1021 if (!ptr) { LogMsg("ERROR: putLLQ - putQuestion"); return mDNSNULL; }
1022
1023 // locate OptRR if it exists, set pointer to end
1024 // !!!KRS implement me
1025
1026 // format opt rr (fields not specified are zero-valued)
1027 mDNS_SetupResourceRecord(&rr, mDNSNULL, mDNSInterface_Any, kDNSType_OPT, kStandardTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, mDNSNULL, mDNSNULL);
1028 opt->rrclass = NormalMaxDNSMessageData;
1029 opt->rdlength = sizeof(rdataOPT); // One option in this OPT record
1030 opt->rdestimate = sizeof(rdataOPT);
1031
1032 optRD = &rr.resrec.rdata->u.opt[0];
1033 optRD->opt = kDNSOpt_LLQ;
1034 optRD->u.llq = *data;
1035 ptr = PutResourceRecordTTLJumbo(msg, ptr, &msg->h.numAdditionals, opt, 0);
1036 if (!ptr) { LogMsg("ERROR: putLLQ - PutResourceRecordTTLJumbo"); return mDNSNULL; }
1037
1038 return ptr;
1039 }
1040
1041 // Normally we'd just request event packets be sent directly to m->LLQNAT.ExternalPort, except...
1042 // with LLQs over TLS/TCP we're doing a weird thing where instead of requesting packets be sent to ExternalAddress:ExternalPort
1043 // we're requesting that packets be sent to ExternalPort, but at the source address of our outgoing TCP connection.
1044 // Normally, after going through the NAT gateway, the source address of our outgoing TCP connection is the same as ExternalAddress,
1045 // so this is fine, except when the TCP connection ends up going over a VPN tunnel instead.
1046 // To work around this, if we find that the source address for our TCP connection is not a private address, we tell the Dot Mac
1047 // LLQ server to send events to us directly at port 5353 on that address, instead of at our mapped external NAT port.
1048
1049 mDNSlocal mDNSu16 GetLLQEventPort(const mDNS *const m, const mDNSAddr *const dst)
1050 {
1051 mDNSAddr src;
1052 mDNSPlatformSourceAddrForDest(&src, dst);
1053 //LogMsg("GetLLQEventPort: src %#a for dst %#a (%d)", &src, dst, mDNSv4AddrIsRFC1918(&src.ip.v4) ? mDNSVal16(m->LLQNAT.ExternalPort) : 0);
1054 return(mDNSv4AddrIsRFC1918(&src.ip.v4) ? mDNSVal16(m->LLQNAT.ExternalPort) : mDNSVal16(MulticastDNSPort));
1055 }
1056
1057 // Normally called with llq set.
1058 // May be called with llq NULL, when retransmitting a lost Challenge Response
1059 mDNSlocal void sendChallengeResponse(mDNS *const m, DNSQuestion *const q, const LLQOptData *llq)
1060 {
1061 mDNSu8 *responsePtr = m->omsg.data;
1062 LLQOptData llqBuf;
1063
1064 if (q->tcp) { LogMsg("sendChallengeResponse: ERROR!!: question %##s (%s) tcp non-NULL", q->qname.c, DNSTypeName(q->qtype)); return; }
1065
1066 if (PrivateQuery(q)) { LogMsg("sendChallengeResponse: ERROR!!: Private Query %##s (%s)", q->qname.c, DNSTypeName(q->qtype)); return; }
1067
1068 if (q->ntries++ == kLLQ_MAX_TRIES)
1069 {
1070 LogMsg("sendChallengeResponse: %d failed attempts for LLQ %##s", kLLQ_MAX_TRIES, q->qname.c);
1071 StartLLQPolling(m,q);
1072 return;
1073 }
1074
1075 if (!llq) // Retransmission: need to make a new LLQOptData
1076 {
1077 llqBuf.vers = kLLQ_Vers;
1078 llqBuf.llqOp = kLLQOp_Setup;
1079 llqBuf.err = LLQErr_NoError; // Don't need to tell server UDP notification port when sending over UDP
1080 llqBuf.id = q->id;
1081 llqBuf.llqlease = q->ReqLease;
1082 llq = &llqBuf;
1083 }
1084
1085 q->LastQTime = m->timenow;
1086 q->ThisQInterval = q->tcp ? 0 : (kLLQ_INIT_RESEND * q->ntries * mDNSPlatformOneSecond); // If using TCP, don't need to retransmit
1087 SetNextQueryTime(m, q);
1088
1089 // To simulate loss of challenge response packet, uncomment line below
1090 //if (q->ntries == 1) return;
1091
1092 InitializeDNSMessage(&m->omsg.h, q->TargetQID, uQueryFlags);
1093 responsePtr = putLLQ(&m->omsg, responsePtr, q, llq);
1094 if (responsePtr)
1095 {
1096 mStatus err = mDNSSendDNSMessage(m, &m->omsg, responsePtr, mDNSInterface_Any, q->LocalSocket, &q->servAddr, q->servPort, mDNSNULL, mDNSNULL, mDNSfalse);
1097 if (err) { LogMsg("sendChallengeResponse: mDNSSendDNSMessage%s failed: %d", q->tcp ? " (TCP)" : "", err); }
1098 }
1099 else StartLLQPolling(m,q);
1100 }
1101
1102 mDNSlocal void SetLLQTimer(mDNS *const m, DNSQuestion *const q, const LLQOptData *const llq)
1103 {
1104 mDNSs32 lease = (mDNSs32)llq->llqlease * mDNSPlatformOneSecond;
1105 q->ReqLease = llq->llqlease;
1106 q->LastQTime = m->timenow;
1107 q->expire = m->timenow + lease;
1108 q->ThisQInterval = lease/2 + mDNSRandom(lease/10);
1109 debugf("SetLLQTimer setting %##s (%s) to %d %d", q->qname.c, DNSTypeName(q->qtype), lease/mDNSPlatformOneSecond, q->ThisQInterval/mDNSPlatformOneSecond);
1110 SetNextQueryTime(m, q);
1111 }
1112
1113 mDNSlocal void recvSetupResponse(mDNS *const m, mDNSu8 rcode, DNSQuestion *const q, const LLQOptData *const llq)
1114 {
1115 if (rcode && rcode != kDNSFlag1_RC_NXDomain)
1116 { LogMsg("ERROR: recvSetupResponse %##s (%s) - rcode && rcode != kDNSFlag1_RC_NXDomain", q->qname.c, DNSTypeName(q->qtype)); return; }
1117
1118 if (llq->llqOp != kLLQOp_Setup)
1119 { LogMsg("ERROR: recvSetupResponse %##s (%s) - bad op %d", q->qname.c, DNSTypeName(q->qtype), llq->llqOp); return; }
1120
1121 if (llq->vers != kLLQ_Vers)
1122 { LogMsg("ERROR: recvSetupResponse %##s (%s) - bad vers %d", q->qname.c, DNSTypeName(q->qtype), llq->vers); return; }
1123
1124 if (q->state == LLQ_InitialRequest)
1125 {
1126 //LogInfo("Got LLQ_InitialRequest");
1127
1128 if (llq->err) { LogMsg("recvSetupResponse - received llq->err %d from server", llq->err); StartLLQPolling(m,q); return; }
1129
1130 if (q->ReqLease != llq->llqlease)
1131 debugf("recvSetupResponse: requested lease %lu, granted lease %lu", q->ReqLease, llq->llqlease);
1132
1133 // cache expiration in case we go to sleep before finishing setup
1134 q->ReqLease = llq->llqlease;
1135 q->expire = m->timenow + ((mDNSs32)llq->llqlease * mDNSPlatformOneSecond);
1136
1137 // update state
1138 q->state = LLQ_SecondaryRequest;
1139 q->id = llq->id;
1140 q->ntries = 0; // first attempt to send response
1141 sendChallengeResponse(m, q, llq);
1142 }
1143 else if (q->state == LLQ_SecondaryRequest)
1144 {
1145 //LogInfo("Got LLQ_SecondaryRequest");
1146
1147 // Fix this immediately if not sooner. Copy the id from the LLQOptData into our DNSQuestion struct. This is only
1148 // an issue for private LLQs, because we skip parts 2 and 3 of the handshake. This is related to a bigger
1149 // problem of the current implementation of TCP LLQ setup: we're not handling state transitions correctly
1150 // if the server sends back SERVFULL or STATIC.
1151 if (PrivateQuery(q))
1152 {
1153 LogInfo("Private LLQ_SecondaryRequest; copying id %08X%08X", llq->id.l[0], llq->id.l[1]);
1154 q->id = llq->id;
1155 }
1156
1157 if (llq->err) { LogMsg("ERROR: recvSetupResponse %##s (%s) code %d from server", q->qname.c, DNSTypeName(q->qtype), llq->err); StartLLQPolling(m,q); return; }
1158 if (!mDNSSameOpaque64(&q->id, &llq->id))
1159 { LogMsg("recvSetupResponse - ID changed. discarding"); return; } // this can happen rarely (on packet loss + reordering)
1160 q->state = LLQ_Established;
1161 q->ntries = 0;
1162 SetLLQTimer(m, q, llq);
1163 #if APPLE_OSX_mDNSResponder
1164 UpdateAutoTunnelDomainStatuses(m);
1165 #endif
1166 }
1167 }
1168
1169 mDNSexport uDNS_LLQType uDNS_recvLLQResponse(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *const end,
1170 const mDNSAddr *const srcaddr, const mDNSIPPort srcport, DNSQuestion **matchQuestion)
1171 {
1172 DNSQuestion pktQ, *q;
1173 if (msg->h.numQuestions && getQuestion(msg, msg->data, end, 0, &pktQ))
1174 {
1175 const rdataOPT *opt = GetLLQOptData(m, msg, end);
1176
1177 for (q = m->Questions; q; q = q->next)
1178 {
1179 if (!mDNSOpaque16IsZero(q->TargetQID) && q->LongLived && q->qtype == pktQ.qtype && q->qnamehash == pktQ.qnamehash && SameDomainName(&q->qname, &pktQ.qname))
1180 {
1181 debugf("uDNS_recvLLQResponse found %##s (%s) %d %#a %#a %X %X %X %X %d",
1182 q->qname.c, DNSTypeName(q->qtype), q->state, srcaddr, &q->servAddr,
1183 opt ? opt->u.llq.id.l[0] : 0, opt ? opt->u.llq.id.l[1] : 0, q->id.l[0], q->id.l[1], opt ? opt->u.llq.llqOp : 0);
1184 if (q->state == LLQ_Poll) debugf("uDNS_LLQ_Events: q->state == LLQ_Poll msg->h.id %d q->TargetQID %d", mDNSVal16(msg->h.id), mDNSVal16(q->TargetQID));
1185 if (q->state == LLQ_Poll && mDNSSameOpaque16(msg->h.id, q->TargetQID))
1186 {
1187 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
1188
1189 // Don't reset the state to IntialRequest as we may write that to the dynamic store
1190 // and PrefPane might wrongly think that we are "Starting" instead of "Polling". If
1191 // we are in polling state because of PCP/NAT-PMP disabled or DoubleNAT, next LLQNATCallback
1192 // would kick us back to LLQInitialRequest. So, resetting the state here may not be useful.
1193 //
1194 // If we have a good NAT (neither PCP/NAT-PMP disabled nor Double-NAT), then we should not be
1195 // possibly in polling state. To be safe, we want to retry from the start in that case
1196 // as there may not be another LLQNATCallback
1197 //
1198 // NOTE: We can be in polling state if we cannot resolve the SOA record i.e, servAddr is set to
1199 // all ones. In that case, we would set it in LLQ_InitialRequest as it overrides the PCP/NAT-PMP or
1200 // Double-NAT state.
1201 if (!mDNSAddressIsOnes(&q->servAddr) && !mDNSIPPortIsZero(m->LLQNAT.ExternalPort) &&
1202 !m->LLQNAT.Result)
1203 {
1204 debugf("uDNS_recvLLQResponse got poll response; moving to LLQ_InitialRequest for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
1205 q->state = LLQ_InitialRequest;
1206 }
1207 q->servPort = zeroIPPort; // Clear servPort so that startLLQHandshake will retry the GetZoneData processing
1208 q->ThisQInterval = LLQ_POLL_INTERVAL + mDNSRandom(LLQ_POLL_INTERVAL/10); // Retry LLQ setup in approx 15 minutes
1209 q->LastQTime = m->timenow;
1210 SetNextQueryTime(m, q);
1211 *matchQuestion = q;
1212 return uDNS_LLQ_Entire; // uDNS_LLQ_Entire means flush stale records; assume a large effective TTL
1213 }
1214 // Note: In LLQ Event packets, the msg->h.id does not match our q->TargetQID, because in that case the msg->h.id nonce is selected by the server
1215 else if (opt && q->state == LLQ_Established && opt->u.llq.llqOp == kLLQOp_Event && mDNSSameOpaque64(&opt->u.llq.id, &q->id))
1216 {
1217 mDNSu8 *ackEnd;
1218 //debugf("Sending LLQ ack for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
1219 InitializeDNSMessage(&m->omsg.h, msg->h.id, ResponseFlags);
1220 ackEnd = putLLQ(&m->omsg, m->omsg.data, q, &opt->u.llq);
1221 if (ackEnd) mDNSSendDNSMessage(m, &m->omsg, ackEnd, mDNSInterface_Any, q->LocalSocket, srcaddr, srcport, mDNSNULL, mDNSNULL, mDNSfalse);
1222 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
1223 debugf("uDNS_LLQ_Events: q->state == LLQ_Established msg->h.id %d q->TargetQID %d", mDNSVal16(msg->h.id), mDNSVal16(q->TargetQID));
1224 *matchQuestion = q;
1225 return uDNS_LLQ_Events;
1226 }
1227 if (opt && mDNSSameOpaque16(msg->h.id, q->TargetQID))
1228 {
1229 if (q->state == LLQ_Established && opt->u.llq.llqOp == kLLQOp_Refresh && mDNSSameOpaque64(&opt->u.llq.id, &q->id) && msg->h.numAdditionals && !msg->h.numAnswers)
1230 {
1231 if (opt->u.llq.err != LLQErr_NoError) LogMsg("recvRefreshReply: received error %d from server", opt->u.llq.err);
1232 else
1233 {
1234 //LogInfo("Received refresh confirmation ntries %d for %##s (%s)", q->ntries, q->qname.c, DNSTypeName(q->qtype));
1235 // If we're waiting to go to sleep, then this LLQ deletion may have been the thing
1236 // we were waiting for, so schedule another check to see if we can sleep now.
1237 if (opt->u.llq.llqlease == 0 && m->SleepLimit) m->NextScheduledSPRetry = m->timenow;
1238 GrantCacheExtensions(m, q, opt->u.llq.llqlease);
1239 SetLLQTimer(m, q, &opt->u.llq);
1240 q->ntries = 0;
1241 }
1242 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
1243 *matchQuestion = q;
1244 return uDNS_LLQ_Ignore;
1245 }
1246 if (q->state < LLQ_Established && mDNSSameAddress(srcaddr, &q->servAddr))
1247 {
1248 LLQ_State oldstate = q->state;
1249 recvSetupResponse(m, msg->h.flags.b[1] & kDNSFlag1_RC_Mask, q, &opt->u.llq);
1250 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
1251 // We have a protocol anomaly here in the LLQ definition.
1252 // Both the challenge packet from the server and the ack+answers packet have opt->u.llq.llqOp == kLLQOp_Setup.
1253 // However, we need to treat them differently:
1254 // The challenge packet has no answers in it, and tells us nothing about whether our cache entries
1255 // are still valid, so this packet should not cause us to do anything that messes with our cache.
1256 // The ack+answers packet gives us the whole truth, so we should handle it by updating our cache
1257 // to match the answers in the packet, and only the answers in the packet.
1258 *matchQuestion = q;
1259 return (oldstate == LLQ_SecondaryRequest ? uDNS_LLQ_Entire : uDNS_LLQ_Ignore);
1260 }
1261 }
1262 }
1263 }
1264 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
1265 }
1266 *matchQuestion = mDNSNULL;
1267 return uDNS_LLQ_Not;
1268 }
1269
1270 // Stub definition of TCPSocket_struct so we can access flags field. (Rest of TCPSocket_struct is platform-dependent.)
1271 struct TCPSocket_struct { TCPSocketFlags flags; /* ... */ };
1272
1273 // tcpCallback is called to handle events (e.g. connection opening and data reception) on TCP connections for
1274 // Private DNS operations -- private queries, private LLQs, private record updates and private service updates
1275 mDNSlocal void tcpCallback(TCPSocket *sock, void *context, mDNSBool ConnectionEstablished, mStatus err)
1276 {
1277 tcpInfo_t *tcpInfo = (tcpInfo_t *)context;
1278 mDNSBool closed = mDNSfalse;
1279 mDNS *m = tcpInfo->m;
1280 DNSQuestion *const q = tcpInfo->question;
1281 tcpInfo_t **backpointer =
1282 q ? &q->tcp :
1283 tcpInfo->rr ? &tcpInfo->rr->tcp : mDNSNULL;
1284 if (backpointer && *backpointer != tcpInfo)
1285 LogMsg("tcpCallback: %d backpointer %p incorrect tcpInfo %p question %p rr %p",
1286 mDNSPlatformTCPGetFD(tcpInfo->sock), *backpointer, tcpInfo, q, tcpInfo->rr);
1287
1288 if (err) goto exit;
1289
1290 if (ConnectionEstablished)
1291 {
1292 mDNSu8 *end = ((mDNSu8*) &tcpInfo->request) + tcpInfo->requestLen;
1293 DomainAuthInfo *AuthInfo;
1294
1295 // Defensive coding for <rdar://problem/5546824> Crash in mDNSResponder at GetAuthInfoForName_internal + 366
1296 // Don't know yet what's causing this, but at least we can be cautious and try to avoid crashing if we find our pointers in an unexpected state
1297 if (tcpInfo->rr && tcpInfo->rr->resrec.name != &tcpInfo->rr->namestorage)
1298 LogMsg("tcpCallback: ERROR: tcpInfo->rr->resrec.name %p != &tcpInfo->rr->namestorage %p",
1299 tcpInfo->rr->resrec.name, &tcpInfo->rr->namestorage);
1300 if (tcpInfo->rr && tcpInfo->rr->resrec.name != &tcpInfo->rr->namestorage) return;
1301
1302 AuthInfo = tcpInfo->rr ? GetAuthInfoForName(m, tcpInfo->rr->resrec.name) : mDNSNULL;
1303
1304 // connection is established - send the message
1305 if (q && q->LongLived && q->state == LLQ_Established)
1306 {
1307 // Lease renewal over TCP, resulting from opening a TCP connection in sendLLQRefresh
1308 end = ((mDNSu8*) &tcpInfo->request) + tcpInfo->requestLen;
1309 }
1310 else if (q && q->LongLived && q->state != LLQ_Poll && !mDNSIPPortIsZero(m->LLQNAT.ExternalPort) && !mDNSIPPortIsZero(q->servPort))
1311 {
1312 // Notes:
1313 // If we have a NAT port mapping, ExternalPort is the external port
1314 // If we have a routable address so we don't need a port mapping, ExternalPort is the same as our own internal port
1315 // If we need a NAT port mapping but can't get one, then ExternalPort is zero
1316 LLQOptData llqData; // set llq rdata
1317 llqData.vers = kLLQ_Vers;
1318 llqData.llqOp = kLLQOp_Setup;
1319 llqData.err = GetLLQEventPort(m, &tcpInfo->Addr); // We're using TCP; tell server what UDP port to send notifications to
1320 LogInfo("tcpCallback: eventPort %d", llqData.err);
1321 llqData.id = zeroOpaque64;
1322 llqData.llqlease = kLLQ_DefLease;
1323 InitializeDNSMessage(&tcpInfo->request.h, q->TargetQID, uQueryFlags);
1324 end = putLLQ(&tcpInfo->request, tcpInfo->request.data, q, &llqData);
1325 if (!end) { LogMsg("ERROR: tcpCallback - putLLQ"); err = mStatus_UnknownErr; goto exit; }
1326 AuthInfo = q->AuthInfo; // Need to add TSIG to this message
1327 q->ntries = 0; // Reset ntries so that tcp/tls connection failures don't affect sendChallengeResponse failures
1328 }
1329 else if (q)
1330 {
1331 // LLQ Polling mode or non-LLQ uDNS over TCP
1332 InitializeDNSMessage(&tcpInfo->request.h, q->TargetQID, (DNSSECQuestion(q) ? DNSSecQFlags : uQueryFlags));
1333 end = putQuestion(&tcpInfo->request, tcpInfo->request.data, tcpInfo->request.data + AbsoluteMaxDNSMessageData, &q->qname, q->qtype, q->qclass);
1334 if (DNSSECQuestion(q) && q->qDNSServer && !q->qDNSServer->cellIntf)
1335 {
1336 if (q->ProxyQuestion)
1337 end = DNSProxySetAttributes(q, &tcpInfo->request.h, &tcpInfo->request, end, tcpInfo->request.data + AbsoluteMaxDNSMessageData);
1338 else
1339 end = putDNSSECOption(&tcpInfo->request, end, tcpInfo->request.data + AbsoluteMaxDNSMessageData);
1340 }
1341
1342 AuthInfo = q->AuthInfo; // Need to add TSIG to this message
1343 }
1344
1345 err = mDNSSendDNSMessage(m, &tcpInfo->request, end, mDNSInterface_Any, mDNSNULL, &tcpInfo->Addr, tcpInfo->Port, sock, AuthInfo, mDNSfalse);
1346 if (err) { debugf("ERROR: tcpCallback: mDNSSendDNSMessage - %d", err); err = mStatus_UnknownErr; goto exit; }
1347 #if AWD_METRICS
1348 if (mDNSSameIPPort(tcpInfo->Port, UnicastDNSPort))
1349 {
1350 MetricsUpdateDNSQuerySize((mDNSu32)(end - (mDNSu8 *)&tcpInfo->request));
1351 }
1352 #endif
1353
1354 // Record time we sent this question
1355 if (q)
1356 {
1357 mDNS_Lock(m);
1358 q->LastQTime = m->timenow;
1359 if (q->ThisQInterval < (256 * mDNSPlatformOneSecond)) // Now we have a TCP connection open, make sure we wait at least 256 seconds before retrying
1360 q->ThisQInterval = (256 * mDNSPlatformOneSecond);
1361 SetNextQueryTime(m, q);
1362 mDNS_Unlock(m);
1363 }
1364 }
1365 else
1366 {
1367 long n;
1368 const mDNSBool Read_replylen = (tcpInfo->nread < 2); // Do we need to read the replylen field first?
1369 if (Read_replylen) // First read the two-byte length preceeding the DNS message
1370 {
1371 mDNSu8 *lenptr = (mDNSu8 *)&tcpInfo->replylen;
1372 n = mDNSPlatformReadTCP(sock, lenptr + tcpInfo->nread, 2 - tcpInfo->nread, &closed);
1373 if (n < 0)
1374 {
1375 LogMsg("ERROR: tcpCallback - attempt to read message length failed (%d)", n);
1376 err = mStatus_ConnFailed;
1377 goto exit;
1378 }
1379 else if (closed)
1380 {
1381 // It's perfectly fine for this socket to close after the first reply. The server might
1382 // be sending gratuitous replies using UDP and doesn't have a need to leave the TCP socket open.
1383 // We'll only log this event if we've never received a reply before.
1384 // BIND 9 appears to close an idle connection after 30 seconds.
1385 if (tcpInfo->numReplies == 0)
1386 {
1387 LogMsg("ERROR: socket closed prematurely tcpInfo->nread = %d", tcpInfo->nread);
1388 err = mStatus_ConnFailed;
1389 goto exit;
1390 }
1391 else
1392 {
1393 // Note that we may not be doing the best thing if an error occurs after we've sent a second request
1394 // over this tcp connection. That is, we only track whether we've received at least one response
1395 // which may have been to a previous request sent over this tcp connection.
1396 if (backpointer) *backpointer = mDNSNULL; // Clear client backpointer FIRST so we don't risk double-disposing our tcpInfo_t
1397 DisposeTCPConn(tcpInfo);
1398 return;
1399 }
1400 }
1401
1402 tcpInfo->nread += n;
1403 if (tcpInfo->nread < 2) goto exit;
1404
1405 tcpInfo->replylen = (mDNSu16)((mDNSu16)lenptr[0] << 8 | lenptr[1]);
1406 if (tcpInfo->replylen < sizeof(DNSMessageHeader))
1407 { LogMsg("ERROR: tcpCallback - length too short (%d bytes)", tcpInfo->replylen); err = mStatus_UnknownErr; goto exit; }
1408
1409 tcpInfo->reply = mDNSPlatformMemAllocate(tcpInfo->replylen);
1410 if (!tcpInfo->reply) { LogMsg("ERROR: tcpCallback - malloc failed"); err = mStatus_NoMemoryErr; goto exit; }
1411 }
1412
1413 n = mDNSPlatformReadTCP(sock, ((char *)tcpInfo->reply) + (tcpInfo->nread - 2), tcpInfo->replylen - (tcpInfo->nread - 2), &closed);
1414
1415 if (n < 0)
1416 {
1417 // If this is our only read for this invokation, and it fails, then that's bad.
1418 // But if we did successfully read some or all of the replylen field this time through,
1419 // and this is now our second read from the socket, then it's expected that sometimes
1420 // there may be no more data present, and that's perfectly okay.
1421 // Assuming failure of the second read is a problem is what caused this bug:
1422 // <rdar://problem/15043194> mDNSResponder fails to read DNS over TCP packet correctly
1423 if (!Read_replylen) { LogMsg("ERROR: tcpCallback - read returned %d", n); err = mStatus_ConnFailed; }
1424 goto exit;
1425 }
1426 else if (closed)
1427 {
1428 if (tcpInfo->numReplies == 0)
1429 {
1430 LogMsg("ERROR: socket closed prematurely tcpInfo->nread = %d", tcpInfo->nread);
1431 err = mStatus_ConnFailed;
1432 goto exit;
1433 }
1434 else
1435 {
1436 // Note that we may not be doing the best thing if an error occurs after we've sent a second request
1437 // over this tcp connection. That is, we only track whether we've received at least one response
1438 // which may have been to a previous request sent over this tcp connection.
1439 if (backpointer) *backpointer = mDNSNULL; // Clear client backpointer FIRST so we don't risk double-disposing our tcpInfo_t
1440 DisposeTCPConn(tcpInfo);
1441 return;
1442 }
1443 }
1444
1445 tcpInfo->nread += n;
1446
1447 if ((tcpInfo->nread - 2) == tcpInfo->replylen)
1448 {
1449 mDNSBool tls;
1450 DNSMessage *reply = tcpInfo->reply;
1451 mDNSu8 *end = (mDNSu8 *)tcpInfo->reply + tcpInfo->replylen;
1452 mDNSAddr Addr = tcpInfo->Addr;
1453 mDNSIPPort Port = tcpInfo->Port;
1454 mDNSIPPort srcPort = zeroIPPort;
1455 tcpInfo->numReplies++;
1456 tcpInfo->reply = mDNSNULL; // Detach reply buffer from tcpInfo_t, to make sure client callback can't cause it to be disposed
1457 tcpInfo->nread = 0;
1458 tcpInfo->replylen = 0;
1459
1460 // If we're going to dispose this connection, do it FIRST, before calling client callback
1461 // Note: Sleep code depends on us clearing *backpointer here -- it uses the clearing of rr->tcp
1462 // as the signal that the DNS deregistration operation with the server has completed, and the machine may now sleep
1463 // If we clear the tcp pointer in the question, mDNSCoreReceiveResponse cannot find a matching question. Hence
1464 // we store the minimal information i.e., the source port of the connection in the question itself.
1465 // Dereference sock before it is disposed in DisposeTCPConn below.
1466
1467 if (sock->flags & kTCPSocketFlags_UseTLS) tls = mDNStrue;
1468 else tls = mDNSfalse;
1469
1470 if (q && q->tcp) {srcPort = q->tcp->SrcPort; q->tcpSrcPort = srcPort;}
1471
1472 if (backpointer)
1473 if (!q || !q->LongLived || m->SleepState)
1474 { *backpointer = mDNSNULL; DisposeTCPConn(tcpInfo); }
1475
1476 mDNSCoreReceive(m, reply, end, &Addr, Port, tls ? (mDNSAddr *)1 : mDNSNULL, srcPort, 0);
1477 // USE CAUTION HERE: Invoking mDNSCoreReceive may have caused the environment to change, including canceling this operation itself
1478
1479 mDNSPlatformMemFree(reply);
1480 return;
1481 }
1482 }
1483
1484 exit:
1485
1486 if (err)
1487 {
1488 // Clear client backpointer FIRST -- that way if one of the callbacks cancels its operation
1489 // we won't end up double-disposing our tcpInfo_t
1490 if (backpointer) *backpointer = mDNSNULL;
1491
1492 mDNS_Lock(m); // Need to grab the lock to get m->timenow
1493
1494 if (q)
1495 {
1496 if (q->ThisQInterval == 0)
1497 {
1498 // We get here when we fail to establish a new TCP/TLS connection that would have been used for a new LLQ request or an LLQ renewal.
1499 // Note that ThisQInterval is also zero when sendChallengeResponse resends the LLQ request on an extant TCP/TLS connection.
1500 q->LastQTime = m->timenow;
1501 if (q->LongLived)
1502 {
1503 // We didn't get the chance to send our request packet before the TCP/TLS connection failed.
1504 // We want to retry quickly, but want to back off exponentially in case the server is having issues.
1505 // Since ThisQInterval was 0, we can't just multiply by QuestionIntervalStep, we must track the number
1506 // of TCP/TLS connection failures using ntries.
1507 mDNSu32 count = q->ntries + 1; // want to wait at least 1 second before retrying
1508
1509 q->ThisQInterval = InitialQuestionInterval;
1510
1511 for (; count; count--)
1512 q->ThisQInterval *= QuestionIntervalStep;
1513
1514 if (q->ThisQInterval > LLQ_POLL_INTERVAL)
1515 q->ThisQInterval = LLQ_POLL_INTERVAL;
1516 else
1517 q->ntries++;
1518
1519 LogMsg("tcpCallback: stream connection for LLQ %##s (%s) failed %d times, retrying in %d ms", q->qname.c, DNSTypeName(q->qtype), q->ntries, q->ThisQInterval);
1520 }
1521 else
1522 {
1523 q->ThisQInterval = MAX_UCAST_POLL_INTERVAL;
1524 LogMsg("tcpCallback: stream connection for %##s (%s) failed, retrying in %d ms", q->qname.c, DNSTypeName(q->qtype), q->ThisQInterval);
1525 }
1526 SetNextQueryTime(m, q);
1527 }
1528 else if (NextQSendTime(q) - m->timenow > (q->LongLived ? LLQ_POLL_INTERVAL : MAX_UCAST_POLL_INTERVAL))
1529 {
1530 // If we get an error and our next scheduled query for this question is more than the max interval from now,
1531 // reset the next query to ensure we wait no longer the maximum interval from now before trying again.
1532 q->LastQTime = m->timenow;
1533 q->ThisQInterval = q->LongLived ? LLQ_POLL_INTERVAL : MAX_UCAST_POLL_INTERVAL;
1534 SetNextQueryTime(m, q);
1535 LogMsg("tcpCallback: stream connection for %##s (%s) failed, retrying in %d ms", q->qname.c, DNSTypeName(q->qtype), q->ThisQInterval);
1536 }
1537
1538 // We're about to dispose of the TCP connection, so we must reset the state to retry over TCP/TLS
1539 // because sendChallengeResponse will send the query via UDP if we don't have a tcp pointer.
1540 // Resetting to LLQ_InitialRequest will cause uDNS_CheckCurrentQuestion to call startLLQHandshake, which
1541 // will attempt to establish a new tcp connection.
1542 if (q->LongLived && q->state == LLQ_SecondaryRequest)
1543 q->state = LLQ_InitialRequest;
1544
1545 // ConnFailed may happen if the server sends a TCP reset or TLS fails, in which case we want to retry establishing the LLQ
1546 // quickly rather than switching to polling mode. This case is handled by the above code to set q->ThisQInterval just above.
1547 // If the error isn't ConnFailed, then the LLQ is in bad shape, so we switch to polling mode.
1548 if (err != mStatus_ConnFailed)
1549 {
1550 if (q->LongLived && q->state != LLQ_Poll) StartLLQPolling(m, q);
1551 }
1552 }
1553
1554 mDNS_Unlock(m);
1555
1556 DisposeTCPConn(tcpInfo);
1557 }
1558 }
1559
1560 mDNSlocal tcpInfo_t *MakeTCPConn(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *const end,
1561 TCPSocketFlags flags, const mDNSAddr *const Addr, const mDNSIPPort Port, domainname *hostname,
1562 DNSQuestion *const question, AuthRecord *const rr)
1563 {
1564 mStatus err;
1565 mDNSIPPort srcport = zeroIPPort;
1566 tcpInfo_t *info;
1567 mDNSBool useBackgroundTrafficClass;
1568
1569 useBackgroundTrafficClass = question ? question->UseBackgroundTrafficClass : mDNSfalse;
1570
1571 if ((flags & kTCPSocketFlags_UseTLS) && (!hostname || !hostname->c[0]))
1572 { LogMsg("MakeTCPConn: TLS connection being setup with NULL hostname"); return mDNSNULL; }
1573
1574 info = (tcpInfo_t *)mDNSPlatformMemAllocate(sizeof(tcpInfo_t));
1575 if (!info) { LogMsg("ERROR: MakeTCP - memallocate failed"); return(mDNSNULL); }
1576 mDNSPlatformMemZero(info, sizeof(tcpInfo_t));
1577
1578 info->m = m;
1579 info->sock = mDNSPlatformTCPSocket(flags, &srcport, useBackgroundTrafficClass);
1580 info->requestLen = 0;
1581 info->question = question;
1582 info->rr = rr;
1583 info->Addr = *Addr;
1584 info->Port = Port;
1585 info->reply = mDNSNULL;
1586 info->replylen = 0;
1587 info->nread = 0;
1588 info->numReplies = 0;
1589 info->SrcPort = srcport;
1590
1591 if (msg)
1592 {
1593 info->requestLen = (int) (end - ((mDNSu8*)msg));
1594 mDNSPlatformMemCopy(&info->request, msg, info->requestLen);
1595 }
1596
1597 if (!info->sock) { LogMsg("MakeTCPConn: unable to create TCP socket"); mDNSPlatformMemFree(info); return(mDNSNULL); }
1598 mDNSPlatformSetSocktOpt(info->sock, mDNSTransport_TCP, Addr->type, question);
1599 err = mDNSPlatformTCPConnect(info->sock, Addr, Port, hostname, (question ? question->InterfaceID : mDNSNULL), tcpCallback, info);
1600
1601 // Probably suboptimal here.
1602 // Instead of returning mDNSNULL here on failure, we should probably invoke the callback with an error code.
1603 // That way clients can put all the error handling and retry/recovery code in one place,
1604 // instead of having to handle immediate errors in one place and async errors in another.
1605 // Also: "err == mStatus_ConnEstablished" probably never happens.
1606
1607 // Don't need to log "connection failed" in customer builds -- it happens quite often during sleep, wake, configuration changes, etc.
1608 if (err == mStatus_ConnEstablished) { tcpCallback(info->sock, info, mDNStrue, mStatus_NoError); }
1609 else if (err != mStatus_ConnPending ) { LogInfo("MakeTCPConn: connection failed"); DisposeTCPConn(info); return(mDNSNULL); }
1610 return(info);
1611 }
1612
1613 mDNSexport void DisposeTCPConn(struct tcpInfo_t *tcp)
1614 {
1615 mDNSPlatformTCPCloseConnection(tcp->sock);
1616 if (tcp->reply) mDNSPlatformMemFree(tcp->reply);
1617 mDNSPlatformMemFree(tcp);
1618 }
1619
1620 // Lock must be held
1621 mDNSexport void startLLQHandshake(mDNS *m, DNSQuestion *q)
1622 {
1623 if (m->LLQNAT.clientContext != mDNSNULL) // LLQNAT just started, give it some time
1624 {
1625 LogInfo("startLLQHandshake: waiting for NAT status for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
1626 q->ThisQInterval = LLQ_POLL_INTERVAL + mDNSRandom(LLQ_POLL_INTERVAL/10); // Retry in approx 15 minutes
1627 q->LastQTime = m->timenow;
1628 SetNextQueryTime(m, q);
1629 return;
1630 }
1631
1632 // Either we don't have {PCP, NAT-PMP, UPnP/IGD} support (ExternalPort is zero) or behind a Double NAT that may or
1633 // may not have {PCP, NAT-PMP, UPnP/IGD} support (NATResult is non-zero)
1634 if (mDNSIPPortIsZero(m->LLQNAT.ExternalPort) || m->LLQNAT.Result)
1635 {
1636 LogInfo("startLLQHandshake: Cannot receive inbound packets; will poll for %##s (%s) External Port %d, NAT Result %d",
1637 q->qname.c, DNSTypeName(q->qtype), mDNSVal16(m->LLQNAT.ExternalPort), m->LLQNAT.Result);
1638 StartLLQPolling(m, q);
1639 return;
1640 }
1641
1642 if (mDNSIPPortIsZero(q->servPort))
1643 {
1644 debugf("startLLQHandshake: StartGetZoneData for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
1645 q->ThisQInterval = LLQ_POLL_INTERVAL + mDNSRandom(LLQ_POLL_INTERVAL/10); // Retry in approx 15 minutes
1646 q->LastQTime = m->timenow;
1647 SetNextQueryTime(m, q);
1648 q->servAddr = zeroAddr;
1649 // We know q->servPort is zero because of check above
1650 if (q->nta) CancelGetZoneData(m, q->nta);
1651 q->nta = StartGetZoneData(m, &q->qname, ZoneServiceLLQ, LLQGotZoneData, q);
1652 return;
1653 }
1654
1655 if (PrivateQuery(q))
1656 {
1657 if (q->tcp) LogInfo("startLLQHandshake: Disposing existing TCP connection for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
1658 if (q->tcp) { DisposeTCPConn(q->tcp); q->tcp = mDNSNULL; }
1659 if (!q->nta)
1660 {
1661 // Normally we lookup the zone data and then call this function. And we never free the zone data
1662 // for "PrivateQuery". But sometimes this can happen due to some race conditions. When we
1663 // switch networks, we might end up "Polling" the network e.g., we are behind a Double NAT.
1664 // When we poll, we free the zone information as we send the query to the server (See
1665 // PrivateQueryGotZoneData). The NAT callback (LLQNATCallback) may happen soon after that. If we
1666 // are still behind Double NAT, we would have returned early in this function. But we could
1667 // have switched to a network with no NATs and we should get the zone data again.
1668 LogInfo("startLLQHandshake: nta is NULL for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
1669 q->nta = StartGetZoneData(m, &q->qname, ZoneServiceLLQ, LLQGotZoneData, q);
1670 return;
1671 }
1672 else if (!q->nta->Host.c[0])
1673 {
1674 // This should not happen. If it happens, we print a log and MakeTCPConn will fail if it can't find a hostname
1675 LogMsg("startLLQHandshake: ERROR!!: nta non NULL for %##s (%s) but HostName %d NULL, LongLived %d", q->qname.c, DNSTypeName(q->qtype), q->nta->Host.c[0], q->LongLived);
1676 }
1677 q->tcp = MakeTCPConn(m, mDNSNULL, mDNSNULL, kTCPSocketFlags_UseTLS, &q->servAddr, q->servPort, &q->nta->Host, q, mDNSNULL);
1678 if (!q->tcp)
1679 q->ThisQInterval = mDNSPlatformOneSecond * 5; // If TCP failed (transient networking glitch) try again in five seconds
1680 else
1681 {
1682 q->state = LLQ_SecondaryRequest; // Right now, for private DNS, we skip the four-way LLQ handshake
1683 q->ReqLease = kLLQ_DefLease;
1684 q->ThisQInterval = 0;
1685 }
1686 q->LastQTime = m->timenow;
1687 SetNextQueryTime(m, q);
1688 }
1689 else
1690 {
1691 debugf("startLLQHandshake: m->AdvertisedV4 %#a%s Server %#a:%d%s %##s (%s)",
1692 &m->AdvertisedV4, mDNSv4AddrIsRFC1918(&m->AdvertisedV4.ip.v4) ? " (RFC 1918)" : "",
1693 &q->servAddr, mDNSVal16(q->servPort), mDNSAddrIsRFC1918(&q->servAddr) ? " (RFC 1918)" : "",
1694 q->qname.c, DNSTypeName(q->qtype));
1695
1696 if (q->ntries++ >= kLLQ_MAX_TRIES)
1697 {
1698 LogMsg("startLLQHandshake: %d failed attempts for LLQ %##s Polling.", kLLQ_MAX_TRIES, q->qname.c);
1699 StartLLQPolling(m, q);
1700 }
1701 else
1702 {
1703 mDNSu8 *end;
1704 LLQOptData llqData;
1705
1706 // set llq rdata
1707 llqData.vers = kLLQ_Vers;
1708 llqData.llqOp = kLLQOp_Setup;
1709 llqData.err = LLQErr_NoError; // Don't need to tell server UDP notification port when sending over UDP
1710 llqData.id = zeroOpaque64;
1711 llqData.llqlease = kLLQ_DefLease;
1712
1713 InitializeDNSMessage(&m->omsg.h, q->TargetQID, uQueryFlags);
1714 end = putLLQ(&m->omsg, m->omsg.data, q, &llqData);
1715 if (!end) { LogMsg("ERROR: startLLQHandshake - putLLQ"); StartLLQPolling(m,q); return; }
1716
1717 mDNSSendDNSMessage(m, &m->omsg, end, mDNSInterface_Any, q->LocalSocket, &q->servAddr, q->servPort, mDNSNULL, mDNSNULL, mDNSfalse);
1718
1719 // update question state
1720 q->state = LLQ_InitialRequest;
1721 q->ReqLease = kLLQ_DefLease;
1722 q->ThisQInterval = (kLLQ_INIT_RESEND * mDNSPlatformOneSecond);
1723 q->LastQTime = m->timenow;
1724 SetNextQueryTime(m, q);
1725 }
1726 }
1727 }
1728
1729
1730 // forward declaration so GetServiceTarget can do reverse lookup if needed
1731 mDNSlocal void GetStaticHostname(mDNS *m);
1732
1733 mDNSexport const domainname *GetServiceTarget(mDNS *m, AuthRecord *const rr)
1734 {
1735 debugf("GetServiceTarget %##s", rr->resrec.name->c);
1736
1737 if (!rr->AutoTarget) // If not automatically tracking this host's current name, just return the existing target
1738 return(&rr->resrec.rdata->u.srv.target);
1739 else
1740 {
1741 #if APPLE_OSX_mDNSResponder
1742 DomainAuthInfo *AuthInfo = GetAuthInfoForName_internal(m, rr->resrec.name);
1743 if (AuthInfo && AuthInfo->AutoTunnel)
1744 {
1745 StartServerTunnel(AuthInfo);
1746 if (AuthInfo->AutoTunnelHostRecord.namestorage.c[0] == 0) return(mDNSNULL);
1747 debugf("GetServiceTarget: Returning %##s", AuthInfo->AutoTunnelHostRecord.namestorage.c);
1748 return(&AuthInfo->AutoTunnelHostRecord.namestorage);
1749 }
1750 else
1751 #endif // APPLE_OSX_mDNSResponder
1752 {
1753 const int srvcount = CountLabels(rr->resrec.name);
1754 HostnameInfo *besthi = mDNSNULL, *hi;
1755 int best = 0;
1756 for (hi = m->Hostnames; hi; hi = hi->next)
1757 if (hi->arv4.state == regState_Registered || hi->arv4.state == regState_Refresh ||
1758 hi->arv6.state == regState_Registered || hi->arv6.state == regState_Refresh)
1759 {
1760 int x, hostcount = CountLabels(&hi->fqdn);
1761 for (x = hostcount < srvcount ? hostcount : srvcount; x > 0 && x > best; x--)
1762 if (SameDomainName(SkipLeadingLabels(rr->resrec.name, srvcount - x), SkipLeadingLabels(&hi->fqdn, hostcount - x)))
1763 { best = x; besthi = hi; }
1764 }
1765
1766 if (besthi) return(&besthi->fqdn);
1767 }
1768 if (m->StaticHostname.c[0]) return(&m->StaticHostname);
1769 else GetStaticHostname(m); // asynchronously do reverse lookup for primary IPv4 address
1770 LogInfo("GetServiceTarget: Returning NULL for %s", ARDisplayString(m, rr));
1771 return(mDNSNULL);
1772 }
1773 }
1774
1775 mDNSlocal const domainname *PUBLIC_UPDATE_SERVICE_TYPE = (const domainname*)"\x0B_dns-update" "\x04_udp";
1776 mDNSlocal const domainname *PUBLIC_LLQ_SERVICE_TYPE = (const domainname*)"\x08_dns-llq" "\x04_udp";
1777
1778 mDNSlocal const domainname *PRIVATE_UPDATE_SERVICE_TYPE = (const domainname*)"\x0F_dns-update-tls" "\x04_tcp";
1779 mDNSlocal const domainname *PRIVATE_QUERY_SERVICE_TYPE = (const domainname*)"\x0E_dns-query-tls" "\x04_tcp";
1780 mDNSlocal const domainname *PRIVATE_LLQ_SERVICE_TYPE = (const domainname*)"\x0C_dns-llq-tls" "\x04_tcp";
1781 mDNSlocal const domainname *DNS_PUSH_NOTIFICATION_SERVICE_TYPE = (const domainname*)"\x0C_dns-push-tls" "\x04_tcp";
1782
1783 #define ZoneDataSRV(X) ( \
1784 (X)->ZoneService == ZoneServiceUpdate ? ((X)->ZonePrivate ? PRIVATE_UPDATE_SERVICE_TYPE : PUBLIC_UPDATE_SERVICE_TYPE) : \
1785 (X)->ZoneService == ZoneServiceQuery ? ((X)->ZonePrivate ? PRIVATE_QUERY_SERVICE_TYPE : (const domainname*)"" ) : \
1786 (X)->ZoneService == ZoneServiceLLQ ? ((X)->ZonePrivate ? PRIVATE_LLQ_SERVICE_TYPE : PUBLIC_LLQ_SERVICE_TYPE ) : \
1787 (X)->ZoneService == ZoneServiceDNSPush ? DNS_PUSH_NOTIFICATION_SERVICE_TYPE : (const domainname*)"")
1788
1789 // Forward reference: GetZoneData_StartQuery references GetZoneData_QuestionCallback, and
1790 // GetZoneData_QuestionCallback calls GetZoneData_StartQuery
1791 mDNSlocal mStatus GetZoneData_StartQuery(mDNS *const m, ZoneData *zd, mDNSu16 qtype);
1792
1793 // GetZoneData_QuestionCallback is called from normal client callback context (core API calls allowed)
1794 mDNSlocal void GetZoneData_QuestionCallback(mDNS *const m, DNSQuestion *question, const ResourceRecord *const answer, QC_result AddRecord)
1795 {
1796 ZoneData *zd = (ZoneData*)question->QuestionContext;
1797
1798 debugf("GetZoneData_QuestionCallback: %s %s", AddRecord ? "Add" : "Rmv", RRDisplayString(m, answer));
1799
1800 if (!AddRecord) return; // Don't care about REMOVE events
1801 if (AddRecord == QC_addnocache && answer->rdlength == 0) return; // Don't care about transient failure indications
1802 if (answer->rrtype != question->qtype) return; // Don't care about CNAMEs
1803
1804 if (answer->rrtype == kDNSType_SOA)
1805 {
1806 debugf("GetZoneData GOT SOA %s", RRDisplayString(m, answer));
1807 mDNS_StopQuery(m, question);
1808 if (question->ThisQInterval != -1)
1809 LogMsg("GetZoneData_QuestionCallback: Question %##s (%s) ThisQInterval %d not -1", question->qname.c, DNSTypeName(question->qtype), question->ThisQInterval);
1810 if (answer->rdlength)
1811 {
1812 AssignDomainName(&zd->ZoneName, answer->name);
1813 zd->ZoneClass = answer->rrclass;
1814 AssignDomainName(&zd->question.qname, &zd->ZoneName);
1815 GetZoneData_StartQuery(m, zd, kDNSType_SRV);
1816 }
1817 else if (zd->CurrentSOA->c[0])
1818 {
1819 DomainAuthInfo *AuthInfo = GetAuthInfoForName(m, zd->CurrentSOA);
1820 if (AuthInfo && AuthInfo->AutoTunnel)
1821 {
1822 // To keep the load on the server down, we don't chop down on
1823 // SOA lookups for AutoTunnels
1824 LogInfo("GetZoneData_QuestionCallback: not chopping labels for %##s", zd->CurrentSOA->c);
1825 zd->ZoneDataCallback(m, mStatus_NoSuchNameErr, zd);
1826 }
1827 else
1828 {
1829 zd->CurrentSOA = (domainname *)(zd->CurrentSOA->c + zd->CurrentSOA->c[0]+1);
1830 AssignDomainName(&zd->question.qname, zd->CurrentSOA);
1831 GetZoneData_StartQuery(m, zd, kDNSType_SOA);
1832 }
1833 }
1834 else
1835 {
1836 LogInfo("GetZoneData recursed to root label of %##s without finding SOA", zd->ChildName.c);
1837 zd->ZoneDataCallback(m, mStatus_NoSuchNameErr, zd);
1838 }
1839 }
1840 else if (answer->rrtype == kDNSType_SRV)
1841 {
1842 debugf("GetZoneData GOT SRV %s", RRDisplayString(m, answer));
1843 mDNS_StopQuery(m, question);
1844 if (question->ThisQInterval != -1)
1845 LogMsg("GetZoneData_QuestionCallback: Question %##s (%s) ThisQInterval %d not -1", question->qname.c, DNSTypeName(question->qtype), question->ThisQInterval);
1846 // Right now we don't want to fail back to non-encrypted operations
1847 // If the AuthInfo has the AutoTunnel field set, then we want private or nothing
1848 // <rdar://problem/5687667> BTMM: Don't fallback to unencrypted operations when SRV lookup fails
1849 #if 0
1850 if (!answer->rdlength && zd->ZonePrivate && zd->ZoneService != ZoneServiceQuery)
1851 {
1852 zd->ZonePrivate = mDNSfalse; // Causes ZoneDataSRV() to yield a different SRV name when building the query
1853 GetZoneData_StartQuery(m, zd, kDNSType_SRV); // Try again, non-private this time
1854 }
1855 else
1856 #endif
1857 {
1858 if (answer->rdlength)
1859 {
1860 AssignDomainName(&zd->Host, &answer->rdata->u.srv.target);
1861 zd->Port = answer->rdata->u.srv.port;
1862 AssignDomainName(&zd->question.qname, &zd->Host);
1863 GetZoneData_StartQuery(m, zd, kDNSType_A);
1864 }
1865 else
1866 {
1867 zd->ZonePrivate = mDNSfalse;
1868 zd->Host.c[0] = 0;
1869 zd->Port = zeroIPPort;
1870 zd->Addr = zeroAddr;
1871 zd->ZoneDataCallback(m, mStatus_NoError, zd);
1872 }
1873 }
1874 }
1875 else if (answer->rrtype == kDNSType_A)
1876 {
1877 debugf("GetZoneData GOT A %s", RRDisplayString(m, answer));
1878 mDNS_StopQuery(m, question);
1879 if (question->ThisQInterval != -1)
1880 LogMsg("GetZoneData_QuestionCallback: Question %##s (%s) ThisQInterval %d not -1", question->qname.c, DNSTypeName(question->qtype), question->ThisQInterval);
1881 zd->Addr.type = mDNSAddrType_IPv4;
1882 zd->Addr.ip.v4 = (answer->rdlength == 4) ? answer->rdata->u.ipv4 : zerov4Addr;
1883 // In order to simulate firewalls blocking our outgoing TCP connections, returning immediate ICMP errors or TCP resets,
1884 // the code below will make us try to connect to loopback, resulting in an immediate "port unreachable" failure.
1885 // This helps us test to make sure we handle this case gracefully
1886 // <rdar://problem/5607082> BTMM: mDNSResponder taking 100 percent CPU after upgrading to 10.5.1
1887 #if 0
1888 zd->Addr.ip.v4.b[0] = 127;
1889 zd->Addr.ip.v4.b[1] = 0;
1890 zd->Addr.ip.v4.b[2] = 0;
1891 zd->Addr.ip.v4.b[3] = 1;
1892 #endif
1893 // The caller needs to free the memory when done with zone data
1894 zd->ZoneDataCallback(m, mStatus_NoError, zd);
1895 }
1896 }
1897
1898 // GetZoneData_StartQuery is called from normal client context (lock not held, or client callback)
1899 mDNSlocal mStatus GetZoneData_StartQuery(mDNS *const m, ZoneData *zd, mDNSu16 qtype)
1900 {
1901 if (qtype == kDNSType_SRV)
1902 {
1903 AssignDomainName(&zd->question.qname, ZoneDataSRV(zd));
1904 AppendDomainName(&zd->question.qname, &zd->ZoneName);
1905 debugf("lookupDNSPort %##s", zd->question.qname.c);
1906 }
1907
1908 // CancelGetZoneData can get called at any time. We should stop the question if it has not been
1909 // stopped already. A value of -1 for ThisQInterval indicates that the question is not active
1910 // yet.
1911 zd->question.ThisQInterval = -1;
1912 zd->question.InterfaceID = mDNSInterface_Any;
1913 zd->question.flags = 0;
1914 zd->question.Target = zeroAddr;
1915 //zd->question.qname.c[0] = 0; // Already set
1916 zd->question.qtype = qtype;
1917 zd->question.qclass = kDNSClass_IN;
1918 zd->question.LongLived = mDNSfalse;
1919 zd->question.ExpectUnique = mDNStrue;
1920 zd->question.ForceMCast = mDNSfalse;
1921 zd->question.ReturnIntermed = mDNStrue;
1922 zd->question.SuppressUnusable = mDNSfalse;
1923 zd->question.SearchListIndex = 0;
1924 zd->question.AppendSearchDomains = 0;
1925 zd->question.RetryWithSearchDomains = mDNSfalse;
1926 zd->question.TimeoutQuestion = 0;
1927 zd->question.WakeOnResolve = 0;
1928 zd->question.UseBackgroundTrafficClass = mDNSfalse;
1929 zd->question.ValidationRequired = 0;
1930 zd->question.ValidatingResponse = 0;
1931 zd->question.ProxyQuestion = 0;
1932 zd->question.qnameOrig = mDNSNULL;
1933 zd->question.AnonInfo = mDNSNULL;
1934 zd->question.pid = mDNSPlatformGetPID();
1935 zd->question.euid = 0;
1936 zd->question.QuestionCallback = GetZoneData_QuestionCallback;
1937 zd->question.QuestionContext = zd;
1938
1939 //LogMsg("GetZoneData_StartQuery %##s (%s) %p", zd->question.qname.c, DNSTypeName(zd->question.qtype), zd->question.Private);
1940 return(mDNS_StartQuery(m, &zd->question));
1941 }
1942
1943 // StartGetZoneData is an internal routine (i.e. must be called with the lock already held)
1944 mDNSexport ZoneData *StartGetZoneData(mDNS *const m, const domainname *const name, const ZoneService target, ZoneDataCallback callback, void *ZoneDataContext)
1945 {
1946 DomainAuthInfo *AuthInfo = GetAuthInfoForName_internal(m, name);
1947 int initialskip = (AuthInfo && AuthInfo->AutoTunnel) ? DomainNameLength(name) - DomainNameLength(&AuthInfo->domain) : 0;
1948 ZoneData *zd = (ZoneData*)mDNSPlatformMemAllocate(sizeof(ZoneData));
1949 if (!zd) { LogMsg("ERROR: StartGetZoneData - mDNSPlatformMemAllocate failed"); return mDNSNULL; }
1950 mDNSPlatformMemZero(zd, sizeof(ZoneData));
1951 AssignDomainName(&zd->ChildName, name);
1952 zd->ZoneService = target;
1953 zd->CurrentSOA = (domainname *)(&zd->ChildName.c[initialskip]);
1954 zd->ZoneName.c[0] = 0;
1955 zd->ZoneClass = 0;
1956 zd->Host.c[0] = 0;
1957 zd->Port = zeroIPPort;
1958 zd->Addr = zeroAddr;
1959 zd->ZonePrivate = AuthInfo && AuthInfo->AutoTunnel ? mDNStrue : mDNSfalse;
1960 zd->ZoneDataCallback = callback;
1961 zd->ZoneDataContext = ZoneDataContext;
1962
1963 zd->question.QuestionContext = zd;
1964
1965 mDNS_DropLockBeforeCallback(); // GetZoneData_StartQuery expects to be called from a normal callback, so we emulate that here
1966 if (AuthInfo && AuthInfo->AutoTunnel && !mDNSIPPortIsZero(AuthInfo->port))
1967 {
1968 LogInfo("StartGetZoneData: Bypassing SOA, SRV query for %##s", AuthInfo->domain.c);
1969 // We bypass SOA and SRV queries if we know the hostname and port already from the configuration.
1970 // Today this is only true for AutoTunnel. As we bypass, we need to infer a few things:
1971 //
1972 // 1. Zone name is the same as the AuthInfo domain
1973 // 2. ZoneClass is kDNSClass_IN which should be a safe assumption
1974 //
1975 // If we want to make this bypass mechanism work for non-AutoTunnels also, (1) has to hold
1976 // good. Otherwise, it has to be configured also.
1977
1978 AssignDomainName(&zd->ZoneName, &AuthInfo->domain);
1979 zd->ZoneClass = kDNSClass_IN;
1980 AssignDomainName(&zd->Host, &AuthInfo->hostname);
1981 zd->Port = AuthInfo->port;
1982 AssignDomainName(&zd->question.qname, &zd->Host);
1983 GetZoneData_StartQuery(m, zd, kDNSType_A);
1984 }
1985 else
1986 {
1987 if (AuthInfo && AuthInfo->AutoTunnel) LogInfo("StartGetZoneData: Not Bypassing SOA, SRV query for %##s", AuthInfo->domain.c);
1988 AssignDomainName(&zd->question.qname, zd->CurrentSOA);
1989 GetZoneData_StartQuery(m, zd, kDNSType_SOA);
1990 }
1991 mDNS_ReclaimLockAfterCallback();
1992
1993 return zd;
1994 }
1995
1996 // Returns if the question is a GetZoneData question. These questions are special in
1997 // that they are created internally while resolving a private query or LLQs.
1998 mDNSexport mDNSBool IsGetZoneDataQuestion(DNSQuestion *q)
1999 {
2000 if (q->QuestionCallback == GetZoneData_QuestionCallback) return(mDNStrue);
2001 else return(mDNSfalse);
2002 }
2003
2004 // GetZoneData queries are a special case -- even if we have a key for them, we don't do them privately,
2005 // because that would result in an infinite loop (i.e. to do a private query we first need to get
2006 // the _dns-query-tls SRV record for the zone, and we can't do *that* privately because to do so
2007 // we'd need to already know the _dns-query-tls SRV record.
2008 // Also, as a general rule, we never do SOA queries privately
2009 mDNSexport DomainAuthInfo *GetAuthInfoForQuestion(mDNS *m, const DNSQuestion *const q) // Must be called with lock held
2010 {
2011 if (q->QuestionCallback == GetZoneData_QuestionCallback) return(mDNSNULL);
2012 if (q->qtype == kDNSType_SOA ) return(mDNSNULL);
2013 return(GetAuthInfoForName_internal(m, &q->qname));
2014 }
2015
2016 // ***************************************************************************
2017 #if COMPILER_LIKES_PRAGMA_MARK
2018 #pragma mark - host name and interface management
2019 #endif
2020
2021 mDNSlocal void SendRecordRegistration(mDNS *const m, AuthRecord *rr);
2022 mDNSlocal void SendRecordDeregistration(mDNS *m, AuthRecord *rr);
2023 mDNSlocal mDNSBool IsRecordMergeable(mDNS *const m, AuthRecord *rr, mDNSs32 time);
2024
2025 // When this function is called, service record is already deregistered. We just
2026 // have to deregister the PTR and TXT records.
2027 mDNSlocal void UpdateAllServiceRecords(mDNS *const m, AuthRecord *rr, mDNSBool reg)
2028 {
2029 AuthRecord *r, *srvRR;
2030
2031 if (rr->resrec.rrtype != kDNSType_SRV) { LogMsg("UpdateAllServiceRecords:ERROR!! ResourceRecord not a service record %s", ARDisplayString(m, rr)); return; }
2032
2033 if (reg && rr->state == regState_NoTarget) { LogMsg("UpdateAllServiceRecords:ERROR!! SRV record %s in noTarget state during registration", ARDisplayString(m, rr)); return; }
2034
2035 LogInfo("UpdateAllServiceRecords: ResourceRecord %s", ARDisplayString(m, rr));
2036
2037 for (r = m->ResourceRecords; r; r=r->next)
2038 {
2039 if (!AuthRecord_uDNS(r)) continue;
2040 srvRR = mDNSNULL;
2041 if (r->resrec.rrtype == kDNSType_PTR)
2042 srvRR = r->Additional1;
2043 else if (r->resrec.rrtype == kDNSType_TXT)
2044 srvRR = r->DependentOn;
2045 if (srvRR && srvRR->resrec.rrtype != kDNSType_SRV)
2046 LogMsg("UpdateAllServiceRecords: ERROR!! Resource record %s wrong, expecting SRV type", ARDisplayString(m, srvRR));
2047 if (srvRR == rr)
2048 {
2049 if (!reg)
2050 {
2051 LogInfo("UpdateAllServiceRecords: deregistering %s", ARDisplayString(m, r));
2052 r->SRVChanged = mDNStrue;
2053 r->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
2054 r->LastAPTime = m->timenow - INIT_RECORD_REG_INTERVAL;
2055 r->state = regState_DeregPending;
2056 }
2057 else
2058 {
2059 // Clearing SRVchanged is a safety measure. If our pevious dereg never
2060 // came back and we had a target change, we are starting fresh
2061 r->SRVChanged = mDNSfalse;
2062 // if it is already registered or in the process of registering, then don't
2063 // bother re-registering. This happens today for non-BTMM domains where the
2064 // TXT and PTR get registered before SRV records because of the delay in
2065 // getting the port mapping. There is no point in re-registering the TXT
2066 // and PTR records.
2067 if ((r->state == regState_Registered) ||
2068 (r->state == regState_Pending && r->nta && !mDNSIPv4AddressIsZero(r->nta->Addr.ip.v4)))
2069 LogInfo("UpdateAllServiceRecords: not registering %s, state %d", ARDisplayString(m, r), r->state);
2070 else
2071 {
2072 LogInfo("UpdateAllServiceRecords: registering %s, state %d", ARDisplayString(m, r), r->state);
2073 ActivateUnicastRegistration(m, r);
2074 }
2075 }
2076 }
2077 }
2078 }
2079
2080 // Called in normal client context (lock not held)
2081 // Currently only supports SRV records for nat mapping
2082 mDNSlocal void CompleteRecordNatMap(mDNS *m, NATTraversalInfo *n)
2083 {
2084 const domainname *target;
2085 domainname *srvt;
2086 AuthRecord *rr = (AuthRecord *)n->clientContext;
2087 debugf("SRVNatMap complete %.4a IntPort %u ExternalPort %u NATLease %u", &n->ExternalAddress, mDNSVal16(n->IntPort), mDNSVal16(n->ExternalPort), n->NATLease);
2088
2089 if (!rr) { LogMsg("CompleteRecordNatMap called with unknown AuthRecord object"); return; }
2090 if (!n->NATLease) { LogMsg("CompleteRecordNatMap No NATLease for %s", ARDisplayString(m, rr)); return; }
2091
2092 if (rr->resrec.rrtype != kDNSType_SRV) {LogMsg("CompleteRecordNatMap: Not a service record %s", ARDisplayString(m, rr)); return; }
2093
2094 if (rr->resrec.RecordType == kDNSRecordTypeDeregistering) { LogInfo("CompleteRecordNatMap called for %s, Service deregistering", ARDisplayString(m, rr)); return; }
2095
2096 if (rr->state == regState_DeregPending) { LogInfo("CompleteRecordNatMap called for %s, record in DeregPending", ARDisplayString(m, rr)); return; }
2097
2098 // As we free the zone info after registering/deregistering with the server (See hndlRecordUpdateReply),
2099 // we need to restart the get zone data and nat mapping request to get the latest mapping result as we can't handle it
2100 // at this moment. Restart from the beginning.
2101 if (!rr->nta || mDNSIPv4AddressIsZero(rr->nta->Addr.ip.v4))
2102 {
2103 LogInfo("CompleteRecordNatMap called for %s but no zone information!", ARDisplayString(m, rr));
2104 // We need to clear out the NATinfo state so that it will result in re-acquiring the mapping
2105 // and hence this callback called again.
2106 if (rr->NATinfo.clientContext)
2107 {
2108 mDNS_StopNATOperation_internal(m, &rr->NATinfo);
2109 rr->NATinfo.clientContext = mDNSNULL;
2110 }
2111 rr->state = regState_Pending;
2112 rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
2113 rr->LastAPTime = m->timenow - INIT_RECORD_REG_INTERVAL;
2114 return;
2115 }
2116
2117 mDNS_Lock(m);
2118 // Reevaluate the target always as Target could have changed while
2119 // we were getting the port mapping (See UpdateOneSRVRecord)
2120 target = GetServiceTarget(m, rr);
2121 srvt = GetRRDomainNameTarget(&rr->resrec);
2122 if (!target || target->c[0] == 0 || mDNSIPPortIsZero(n->ExternalPort))
2123 {
2124 if (target && target->c[0])
2125 LogInfo("CompleteRecordNatMap - Target %##s for ResourceRecord %##s, ExternalPort %d", target->c, rr->resrec.name->c, mDNSVal16(n->ExternalPort));
2126 else
2127 LogInfo("CompleteRecordNatMap - no target for %##s, ExternalPort %d", rr->resrec.name->c, mDNSVal16(n->ExternalPort));
2128 if (srvt) srvt->c[0] = 0;
2129 rr->state = regState_NoTarget;
2130 rr->resrec.rdlength = rr->resrec.rdestimate = 0;
2131 mDNS_Unlock(m);
2132 UpdateAllServiceRecords(m, rr, mDNSfalse);
2133 return;
2134 }
2135 LogInfo("CompleteRecordNatMap - Target %##s for ResourceRecord %##s, ExternalPort %d", target->c, rr->resrec.name->c, mDNSVal16(n->ExternalPort));
2136 // This function might get called multiple times during a network transition event. Previosuly, we could
2137 // have put the SRV record in NoTarget state above and deregistered all the other records. When this
2138 // function gets called again with a non-zero ExternalPort, we need to set the target and register the
2139 // other records again.
2140 if (srvt && !SameDomainName(srvt, target))
2141 {
2142 AssignDomainName(srvt, target);
2143 SetNewRData(&rr->resrec, mDNSNULL, 0); // Update rdlength, rdestimate, rdatahash
2144 }
2145
2146 // SRVChanged is set when when the target of the SRV record changes (See UpdateOneSRVRecord).
2147 // As a result of the target change, we might register just that SRV Record if it was
2148 // previously registered and we have a new target OR deregister SRV (and the associated
2149 // PTR/TXT records) if we don't have a target anymore. When we get a response from the server,
2150 // SRVChanged state tells that we registered/deregistered because of a target change
2151 // and hence handle accordingly e.g., if we deregistered, put the records in NoTarget state OR
2152 // if we registered then put it in Registered state.
2153 //
2154 // Here, we are registering all the records again from the beginning. Treat this as first time
2155 // registration rather than a temporary target change.
2156 rr->SRVChanged = mDNSfalse;
2157
2158 // We want IsRecordMergeable to check whether it is a record whose update can be
2159 // sent with others. We set the time before we call IsRecordMergeable, so that
2160 // it does not fail this record based on time. We are interested in other checks
2161 // at this time
2162 rr->state = regState_Pending;
2163 rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
2164 rr->LastAPTime = m->timenow - INIT_RECORD_REG_INTERVAL;
2165 if (IsRecordMergeable(m, rr, m->timenow + MERGE_DELAY_TIME))
2166 // Delay the record registration by MERGE_DELAY_TIME so that we can merge them
2167 // into one update
2168 rr->LastAPTime += MERGE_DELAY_TIME;
2169 mDNS_Unlock(m);
2170 // We call this always even though it may not be necessary always e.g., normal registration
2171 // process where TXT and PTR gets registered followed by the SRV record after it gets
2172 // the port mapping. In that case, UpdateAllServiceRecords handles the optimization. The
2173 // update of TXT and PTR record is required if we entered noTargetState before as explained
2174 // above.
2175 UpdateAllServiceRecords(m, rr, mDNStrue);
2176 }
2177
2178 mDNSlocal void StartRecordNatMap(mDNS *m, AuthRecord *rr)
2179 {
2180 const mDNSu8 *p;
2181 mDNSu8 protocol;
2182
2183 if (rr->resrec.rrtype != kDNSType_SRV)
2184 {
2185 LogInfo("StartRecordNatMap: Resource Record %##s type %d, not supported", rr->resrec.name->c, rr->resrec.rrtype);
2186 return;
2187 }
2188 p = rr->resrec.name->c;
2189 //Assume <Service Instance>.<App Protocol>.<Transport protocol>.<Name>
2190 // Skip the first two labels to get to the transport protocol
2191 if (p[0]) p += 1 + p[0];
2192 if (p[0]) p += 1 + p[0];
2193 if (SameDomainLabel(p, (mDNSu8 *)"\x4" "_tcp")) protocol = NATOp_MapTCP;
2194 else if (SameDomainLabel(p, (mDNSu8 *)"\x4" "_udp")) protocol = NATOp_MapUDP;
2195 else { LogMsg("StartRecordNatMap: could not determine transport protocol of service %##s", rr->resrec.name->c); return; }
2196
2197 //LogMsg("StartRecordNatMap: clientContext %p IntPort %d srv.port %d %s",
2198 // rr->NATinfo.clientContext, mDNSVal16(rr->NATinfo.IntPort), mDNSVal16(rr->resrec.rdata->u.srv.port), ARDisplayString(m, rr));
2199 if (rr->NATinfo.clientContext) mDNS_StopNATOperation_internal(m, &rr->NATinfo);
2200 rr->NATinfo.Protocol = protocol;
2201
2202 // Shouldn't be trying to set IntPort here --
2203 // BuildUpdateMessage overwrites srs->RR_SRV.resrec.rdata->u.srv.port with external (mapped) port number
2204 rr->NATinfo.IntPort = rr->resrec.rdata->u.srv.port;
2205 rr->NATinfo.RequestedPort = rr->resrec.rdata->u.srv.port;
2206 rr->NATinfo.NATLease = 0; // Request default lease
2207 rr->NATinfo.clientCallback = CompleteRecordNatMap;
2208 rr->NATinfo.clientContext = rr;
2209 mDNS_StartNATOperation_internal(m, &rr->NATinfo);
2210 }
2211
2212 // Unlink an Auth Record from the m->ResourceRecords list.
2213 // When a resource record enters regState_NoTarget initially, mDNS_Register_internal
2214 // does not initialize completely e.g., it cannot check for duplicates etc. The resource
2215 // record is temporarily left in the ResourceRecords list so that we can initialize later
2216 // when the target is resolvable. Similarly, when host name changes, we enter regState_NoTarget
2217 // and we do the same.
2218
2219 // This UnlinkResourceRecord routine is very worrying. It bypasses all the normal cleanup performed
2220 // by mDNS_Deregister_internal and just unceremoniously cuts the record from the active list.
2221 // This is why re-regsitering this record was producing syslog messages like this:
2222 // "Error! Tried to add a NAT traversal that's already in the active list"
2223 // Right now UnlinkResourceRecord is fortunately only called by RegisterAllServiceRecords,
2224 // which then immediately calls mDNS_Register_internal to re-register the record, which probably
2225 // masked more serious problems. Any other use of UnlinkResourceRecord is likely to lead to crashes.
2226 // For now we'll workaround that specific problem by explicitly calling mDNS_StopNATOperation_internal,
2227 // but long-term we should either stop cancelling the record registration and then re-registering it,
2228 // or if we really do need to do this for some reason it should be done via the usual
2229 // mDNS_Deregister_internal path instead of just cutting the record from the list.
2230
2231 mDNSlocal mStatus UnlinkResourceRecord(mDNS *const m, AuthRecord *const rr)
2232 {
2233 AuthRecord **list = &m->ResourceRecords;
2234 while (*list && *list != rr) list = &(*list)->next;
2235 if (*list)
2236 {
2237 *list = rr->next;
2238 rr->next = mDNSNULL;
2239
2240 // Temporary workaround to cancel any active NAT mapping operation
2241 if (rr->NATinfo.clientContext)
2242 {
2243 mDNS_StopNATOperation_internal(m, &rr->NATinfo);
2244 rr->NATinfo.clientContext = mDNSNULL;
2245 if (rr->resrec.rrtype == kDNSType_SRV) rr->resrec.rdata->u.srv.port = rr->NATinfo.IntPort;
2246 }
2247
2248 return(mStatus_NoError);
2249 }
2250 LogMsg("UnlinkResourceRecord:ERROR!! - no such active record %##s", rr->resrec.name->c);
2251 return(mStatus_NoSuchRecord);
2252 }
2253
2254 // We need to go through mDNS_Register again as we did not complete the
2255 // full initialization last time e.g., duplicate checks.
2256 // After we register, we will be in regState_GetZoneData.
2257 mDNSlocal void RegisterAllServiceRecords(mDNS *const m, AuthRecord *rr)
2258 {
2259 LogInfo("RegisterAllServiceRecords: Service Record %##s", rr->resrec.name->c);
2260 // First Register the service record, we do this differently from other records because
2261 // when it entered NoTarget state, it did not go through complete initialization
2262 rr->SRVChanged = mDNSfalse;
2263 UnlinkResourceRecord(m, rr);
2264 mDNS_Register_internal(m, rr);
2265 // Register the other records
2266 UpdateAllServiceRecords(m, rr, mDNStrue);
2267 }
2268
2269 // Called with lock held
2270 mDNSlocal void UpdateOneSRVRecord(mDNS *m, AuthRecord *rr)
2271 {
2272 // Target change if:
2273 // We have a target and were previously waiting for one, or
2274 // We had a target and no longer do, or
2275 // The target has changed
2276
2277 domainname *curtarget = &rr->resrec.rdata->u.srv.target;
2278 const domainname *const nt = GetServiceTarget(m, rr);
2279 const domainname *const newtarget = nt ? nt : (domainname*)"";
2280 mDNSBool TargetChanged = (newtarget->c[0] && rr->state == regState_NoTarget) || !SameDomainName(curtarget, newtarget);
2281 mDNSBool HaveZoneData = rr->nta && !mDNSIPv4AddressIsZero(rr->nta->Addr.ip.v4);
2282
2283 // Nat state change if:
2284 // We were behind a NAT, and now we are behind a new NAT, or
2285 // We're not behind a NAT but our port was previously mapped to a different external port
2286 // We were not behind a NAT and now we are
2287
2288 mDNSIPPort port = rr->resrec.rdata->u.srv.port;
2289 mDNSBool NowNeedNATMAP = (rr->AutoTarget == Target_AutoHostAndNATMAP && !mDNSIPPortIsZero(port) && mDNSv4AddrIsRFC1918(&m->AdvertisedV4.ip.v4) && rr->nta && !mDNSAddrIsRFC1918(&rr->nta->Addr));
2290 mDNSBool WereBehindNAT = (rr->NATinfo.clientContext != mDNSNULL);
2291 mDNSBool PortWasMapped = (rr->NATinfo.clientContext && !mDNSSameIPPort(rr->NATinfo.RequestedPort, port)); // I think this is always false -- SC Sept 07
2292 mDNSBool NATChanged = (!WereBehindNAT && NowNeedNATMAP) || (!NowNeedNATMAP && PortWasMapped);
2293
2294 (void)HaveZoneData; //unused
2295
2296 LogInfo("UpdateOneSRVRecord: Resource Record %s TargetChanged %d, NewTarget %##s", ARDisplayString(m, rr), TargetChanged, nt->c);
2297
2298 debugf("UpdateOneSRVRecord: %##s newtarget %##s TargetChanged %d HaveZoneData %d port %d NowNeedNATMAP %d WereBehindNAT %d PortWasMapped %d NATChanged %d",
2299 rr->resrec.name->c, newtarget,
2300 TargetChanged, HaveZoneData, mDNSVal16(port), NowNeedNATMAP, WereBehindNAT, PortWasMapped, NATChanged);
2301
2302 mDNS_CheckLock(m);
2303
2304 if (!TargetChanged && !NATChanged) return;
2305
2306 // If we are deregistering the record, then ignore any NAT/Target change.
2307 if (rr->resrec.RecordType == kDNSRecordTypeDeregistering)
2308 {
2309 LogInfo("UpdateOneSRVRecord: Deregistering record, Ignoring TargetChanged %d, NATChanged %d for %##s, state %d", TargetChanged, NATChanged,
2310 rr->resrec.name->c, rr->state);
2311 return;
2312 }
2313
2314 if (newtarget)
2315 LogInfo("UpdateOneSRVRecord: TargetChanged %d, NATChanged %d for %##s, state %d, newtarget %##s", TargetChanged, NATChanged, rr->resrec.name->c, rr->state, newtarget->c);
2316 else
2317 LogInfo("UpdateOneSRVRecord: TargetChanged %d, NATChanged %d for %##s, state %d, null newtarget", TargetChanged, NATChanged, rr->resrec.name->c, rr->state);
2318 switch(rr->state)
2319 {
2320 case regState_NATMap:
2321 // In these states, the SRV has either not yet been registered (it will get up-to-date information when it is)
2322 // or is in the process of, or has already been, deregistered. This assumes that whenever we transition out
2323 // of this state, we need to look at the target again.
2324 return;
2325
2326 case regState_UpdatePending:
2327 // We are getting a Target change/NAT change while the SRV record is being updated ?
2328 // let us not do anything for now.
2329 return;
2330
2331 case regState_NATError:
2332 if (!NATChanged) return;
2333 // if nat changed, register if we have a target (below)
2334
2335 case regState_NoTarget:
2336 if (!newtarget->c[0])
2337 {
2338 LogInfo("UpdateOneSRVRecord: No target yet for Resource Record %s", ARDisplayString(m, rr));
2339 return;
2340 }
2341 RegisterAllServiceRecords(m, rr);
2342 return;
2343 case regState_DeregPending:
2344 // We are in DeregPending either because the service was deregistered from above or we handled
2345 // a NAT/Target change before and sent the deregistration below. There are a few race conditions
2346 // possible
2347 //
2348 // 1. We are handling a second NAT/Target change while the first dereg is in progress. It is possible
2349 // that first dereg never made it through because there was no network connectivity e.g., disconnecting
2350 // from network triggers this function due to a target change and later connecting to the network
2351 // retriggers this function but the deregistration never made it through yet. Just fall through.
2352 // If there is a target register otherwise deregister.
2353 //
2354 // 2. While we sent the dereg during a previous NAT/Target change, uDNS_DeregisterRecord gets
2355 // called as part of service deregistration. When the response comes back, we call
2356 // CompleteDeregistration rather than handle NAT/Target change because the record is in
2357 // kDNSRecordTypeDeregistering state.
2358 //
2359 // 3. If the upper layer deregisters the service, we check for kDNSRecordTypeDeregistering both
2360 // here in this function to avoid handling NAT/Target change and in hndlRecordUpdateReply to call
2361 // CompleteDeregistration instead of handling NAT/Target change. Hence, we are not concerned
2362 // about that case here.
2363 //
2364 // We just handle case (1) by falling through
2365 case regState_Pending:
2366 case regState_Refresh:
2367 case regState_Registered:
2368 // target or nat changed. deregister service. upon completion, we'll look for a new target
2369 rr->SRVChanged = mDNStrue;
2370 rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
2371 rr->LastAPTime = m->timenow - INIT_RECORD_REG_INTERVAL;
2372 if (newtarget->c[0])
2373 {
2374 LogInfo("UpdateOneSRVRecord: SRV record changed for service %##s, registering with new target %##s",
2375 rr->resrec.name->c, newtarget->c);
2376 rr->state = regState_Pending;
2377 }
2378 else
2379 {
2380 LogInfo("UpdateOneSRVRecord: SRV record changed for service %##s de-registering", rr->resrec.name->c);
2381 rr->state = regState_DeregPending;
2382 UpdateAllServiceRecords(m, rr, mDNSfalse);
2383 }
2384 return;
2385 case regState_Unregistered:
2386 default: LogMsg("UpdateOneSRVRecord: Unknown state %d for %##s", rr->state, rr->resrec.name->c);
2387 }
2388 }
2389
2390 mDNSexport void UpdateAllSRVRecords(mDNS *m)
2391 {
2392 m->NextSRVUpdate = 0;
2393 LogInfo("UpdateAllSRVRecords %d", m->SleepState);
2394
2395 if (m->CurrentRecord)
2396 LogMsg("UpdateAllSRVRecords ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
2397 m->CurrentRecord = m->ResourceRecords;
2398 while (m->CurrentRecord)
2399 {
2400 AuthRecord *rptr = m->CurrentRecord;
2401 m->CurrentRecord = m->CurrentRecord->next;
2402 if (AuthRecord_uDNS(rptr) && rptr->resrec.rrtype == kDNSType_SRV)
2403 UpdateOneSRVRecord(m, rptr);
2404 }
2405 }
2406
2407 // Forward reference: AdvertiseHostname references HostnameCallback, and HostnameCallback calls AdvertiseHostname
2408 mDNSlocal void HostnameCallback(mDNS *const m, AuthRecord *const rr, mStatus result);
2409
2410 // Called in normal client context (lock not held)
2411 mDNSlocal void hostnameGetPublicAddressCallback(mDNS *m, NATTraversalInfo *n)
2412 {
2413 HostnameInfo *h = (HostnameInfo *)n->clientContext;
2414
2415 if (!h) { LogMsg("RegisterHostnameRecord: registration cancelled"); return; }
2416
2417 if (!n->Result)
2418 {
2419 if (mDNSIPv4AddressIsZero(n->ExternalAddress) || mDNSv4AddrIsRFC1918(&n->ExternalAddress)) return;
2420
2421 if (h->arv4.resrec.RecordType)
2422 {
2423 if (mDNSSameIPv4Address(h->arv4.resrec.rdata->u.ipv4, n->ExternalAddress)) return; // If address unchanged, do nothing
2424 LogInfo("Updating hostname %p %##s IPv4 from %.4a to %.4a (NAT gateway's external address)",n,
2425 h->arv4.resrec.name->c, &h->arv4.resrec.rdata->u.ipv4, &n->ExternalAddress);
2426 mDNS_Deregister(m, &h->arv4); // mStatus_MemFree callback will re-register with new address
2427 }
2428 else
2429 {
2430 LogInfo("Advertising hostname %##s IPv4 %.4a (NAT gateway's external address)", h->arv4.resrec.name->c, &n->ExternalAddress);
2431 h->arv4.resrec.RecordType = kDNSRecordTypeKnownUnique;
2432 h->arv4.resrec.rdata->u.ipv4 = n->ExternalAddress;
2433 mDNS_Register(m, &h->arv4);
2434 }
2435 }
2436 }
2437
2438 // register record or begin NAT traversal
2439 mDNSlocal void AdvertiseHostname(mDNS *m, HostnameInfo *h)
2440 {
2441 if (!mDNSIPv4AddressIsZero(m->AdvertisedV4.ip.v4) && h->arv4.resrec.RecordType == kDNSRecordTypeUnregistered)
2442 {
2443 mDNS_SetupResourceRecord(&h->arv4, mDNSNULL, mDNSInterface_Any, kDNSType_A, kHostNameTTL, kDNSRecordTypeUnregistered, AuthRecordAny, HostnameCallback, h);
2444 AssignDomainName(&h->arv4.namestorage, &h->fqdn);
2445 h->arv4.resrec.rdata->u.ipv4 = m->AdvertisedV4.ip.v4;
2446 h->arv4.state = regState_Unregistered;
2447 if (mDNSv4AddrIsRFC1918(&m->AdvertisedV4.ip.v4))
2448 {
2449 // If we already have a NAT query active, stop it and restart it to make sure we get another callback
2450 if (h->natinfo.clientContext) mDNS_StopNATOperation_internal(m, &h->natinfo);
2451 h->natinfo.Protocol = 0;
2452 h->natinfo.IntPort = zeroIPPort;
2453 h->natinfo.RequestedPort = zeroIPPort;
2454 h->natinfo.NATLease = 0;
2455 h->natinfo.clientCallback = hostnameGetPublicAddressCallback;
2456 h->natinfo.clientContext = h;
2457 mDNS_StartNATOperation_internal(m, &h->natinfo);
2458 }
2459 else
2460 {
2461 LogInfo("Advertising hostname %##s IPv4 %.4a", h->arv4.resrec.name->c, &m->AdvertisedV4.ip.v4);
2462 h->arv4.resrec.RecordType = kDNSRecordTypeKnownUnique;
2463 mDNS_Register_internal(m, &h->arv4);
2464 }
2465 }
2466
2467 if (!mDNSIPv6AddressIsZero(m->AdvertisedV6.ip.v6) && h->arv6.resrec.RecordType == kDNSRecordTypeUnregistered)
2468 {
2469 mDNS_SetupResourceRecord(&h->arv6, mDNSNULL, mDNSInterface_Any, kDNSType_AAAA, kHostNameTTL, kDNSRecordTypeKnownUnique, AuthRecordAny, HostnameCallback, h);
2470 AssignDomainName(&h->arv6.namestorage, &h->fqdn);
2471 h->arv6.resrec.rdata->u.ipv6 = m->AdvertisedV6.ip.v6;
2472 h->arv6.state = regState_Unregistered;
2473 LogInfo("Advertising hostname %##s IPv6 %.16a", h->arv6.resrec.name->c, &m->AdvertisedV6.ip.v6);
2474 mDNS_Register_internal(m, &h->arv6);
2475 }
2476 }
2477
2478 mDNSlocal void HostnameCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
2479 {
2480 HostnameInfo *hi = (HostnameInfo *)rr->RecordContext;
2481
2482 if (result == mStatus_MemFree)
2483 {
2484 if (hi)
2485 {
2486 // If we're still in the Hostnames list, update to new address
2487 HostnameInfo *i;
2488 LogInfo("HostnameCallback: Got mStatus_MemFree for %p %p %s", hi, rr, ARDisplayString(m, rr));
2489 for (i = m->Hostnames; i; i = i->next)
2490 if (rr == &i->arv4 || rr == &i->arv6)
2491 { mDNS_Lock(m); AdvertiseHostname(m, i); mDNS_Unlock(m); return; }
2492
2493 // Else, we're not still in the Hostnames list, so free the memory
2494 if (hi->arv4.resrec.RecordType == kDNSRecordTypeUnregistered &&
2495 hi->arv6.resrec.RecordType == kDNSRecordTypeUnregistered)
2496 {
2497 if (hi->natinfo.clientContext) mDNS_StopNATOperation_internal(m, &hi->natinfo);
2498 hi->natinfo.clientContext = mDNSNULL;
2499 mDNSPlatformMemFree(hi); // free hi when both v4 and v6 AuthRecs deallocated
2500 }
2501 }
2502 return;
2503 }
2504
2505 if (result)
2506 {
2507 // don't unlink or free - we can retry when we get a new address/router
2508 if (rr->resrec.rrtype == kDNSType_A)
2509 LogMsg("HostnameCallback: Error %d for registration of %##s IP %.4a", result, rr->resrec.name->c, &rr->resrec.rdata->u.ipv4);
2510 else
2511 LogMsg("HostnameCallback: Error %d for registration of %##s IP %.16a", result, rr->resrec.name->c, &rr->resrec.rdata->u.ipv6);
2512 if (!hi) { mDNSPlatformMemFree(rr); return; }
2513 if (rr->state != regState_Unregistered) LogMsg("Error: HostnameCallback invoked with error code for record not in regState_Unregistered!");
2514
2515 if (hi->arv4.state == regState_Unregistered &&
2516 hi->arv6.state == regState_Unregistered)
2517 {
2518 // only deliver status if both v4 and v6 fail
2519 rr->RecordContext = (void *)hi->StatusContext;
2520 if (hi->StatusCallback)
2521 hi->StatusCallback(m, rr, result); // client may NOT make API calls here
2522 rr->RecordContext = (void *)hi;
2523 }
2524 return;
2525 }
2526
2527 // register any pending services that require a target
2528 mDNS_Lock(m);
2529 m->NextSRVUpdate = NonZeroTime(m->timenow);
2530 mDNS_Unlock(m);
2531
2532 // Deliver success to client
2533 if (!hi) { LogMsg("HostnameCallback invoked with orphaned address record"); return; }
2534 if (rr->resrec.rrtype == kDNSType_A)
2535 LogInfo("Registered hostname %##s IP %.4a", rr->resrec.name->c, &rr->resrec.rdata->u.ipv4);
2536 else
2537 LogInfo("Registered hostname %##s IP %.16a", rr->resrec.name->c, &rr->resrec.rdata->u.ipv6);
2538
2539 rr->RecordContext = (void *)hi->StatusContext;
2540 if (hi->StatusCallback)
2541 hi->StatusCallback(m, rr, result); // client may NOT make API calls here
2542 rr->RecordContext = (void *)hi;
2543 }
2544
2545 mDNSlocal void FoundStaticHostname(mDNS *const m, DNSQuestion *question, const ResourceRecord *const answer, QC_result AddRecord)
2546 {
2547 const domainname *pktname = &answer->rdata->u.name;
2548 domainname *storedname = &m->StaticHostname;
2549 HostnameInfo *h = m->Hostnames;
2550
2551 (void)question;
2552
2553 if (answer->rdlength != 0)
2554 LogInfo("FoundStaticHostname: question %##s -> answer %##s (%s)", question->qname.c, answer->rdata->u.name.c, AddRecord ? "ADD" : "RMV");
2555 else
2556 LogInfo("FoundStaticHostname: question %##s -> answer NULL (%s)", question->qname.c, AddRecord ? "ADD" : "RMV");
2557
2558 if (AddRecord && answer->rdlength != 0 && !SameDomainName(pktname, storedname))
2559 {
2560 AssignDomainName(storedname, pktname);
2561 while (h)
2562 {
2563 if (h->arv4.state == regState_Pending || h->arv4.state == regState_NATMap || h->arv6.state == regState_Pending)
2564 {
2565 // if we're in the process of registering a dynamic hostname, delay SRV update so we don't have to reregister services if the dynamic name succeeds
2566 m->NextSRVUpdate = NonZeroTime(m->timenow + 5 * mDNSPlatformOneSecond);
2567 debugf("FoundStaticHostname: NextSRVUpdate in %d %d", m->NextSRVUpdate - m->timenow, m->timenow);
2568 return;
2569 }
2570 h = h->next;
2571 }
2572 mDNS_Lock(m);
2573 m->NextSRVUpdate = NonZeroTime(m->timenow);
2574 mDNS_Unlock(m);
2575 }
2576 else if (!AddRecord && SameDomainName(pktname, storedname))
2577 {
2578 mDNS_Lock(m);
2579 storedname->c[0] = 0;
2580 m->NextSRVUpdate = NonZeroTime(m->timenow);
2581 mDNS_Unlock(m);
2582 }
2583 }
2584
2585 // Called with lock held
2586 mDNSlocal void GetStaticHostname(mDNS *m)
2587 {
2588 char buf[MAX_REVERSE_MAPPING_NAME_V4];
2589 DNSQuestion *q = &m->ReverseMap;
2590 mDNSu8 *ip = m->AdvertisedV4.ip.v4.b;
2591 mStatus err;
2592
2593 if (m->ReverseMap.ThisQInterval != -1) return; // already running
2594 if (mDNSIPv4AddressIsZero(m->AdvertisedV4.ip.v4)) return;
2595
2596 mDNSPlatformMemZero(q, sizeof(*q));
2597 // Note: This is reverse order compared to a normal dotted-decimal IP address, so we can't use our customary "%.4a" format code
2598 mDNS_snprintf(buf, sizeof(buf), "%d.%d.%d.%d.in-addr.arpa.", ip[3], ip[2], ip[1], ip[0]);
2599 if (!MakeDomainNameFromDNSNameString(&q->qname, buf)) { LogMsg("Error: GetStaticHostname - bad name %s", buf); return; }
2600
2601 q->InterfaceID = mDNSInterface_Any;
2602 q->flags = 0;
2603 q->Target = zeroAddr;
2604 q->qtype = kDNSType_PTR;
2605 q->qclass = kDNSClass_IN;
2606 q->LongLived = mDNSfalse;
2607 q->ExpectUnique = mDNSfalse;
2608 q->ForceMCast = mDNSfalse;
2609 q->ReturnIntermed = mDNStrue;
2610 q->SuppressUnusable = mDNSfalse;
2611 q->SearchListIndex = 0;
2612 q->AppendSearchDomains = 0;
2613 q->RetryWithSearchDomains = mDNSfalse;
2614 q->TimeoutQuestion = 0;
2615 q->WakeOnResolve = 0;
2616 q->UseBackgroundTrafficClass = mDNSfalse;
2617 q->ValidationRequired = 0;
2618 q->ValidatingResponse = 0;
2619 q->ProxyQuestion = 0;
2620 q->qnameOrig = mDNSNULL;
2621 q->AnonInfo = mDNSNULL;
2622 q->pid = mDNSPlatformGetPID();
2623 q->euid = 0;
2624 q->QuestionCallback = FoundStaticHostname;
2625 q->QuestionContext = mDNSNULL;
2626
2627 LogInfo("GetStaticHostname: %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
2628 err = mDNS_StartQuery_internal(m, q);
2629 if (err) LogMsg("Error: GetStaticHostname - StartQuery returned error %d", err);
2630 }
2631
2632 mDNSexport void mDNS_AddDynDNSHostName(mDNS *m, const domainname *fqdn, mDNSRecordCallback *StatusCallback, const void *StatusContext)
2633 {
2634 HostnameInfo **ptr = &m->Hostnames;
2635
2636 LogInfo("mDNS_AddDynDNSHostName %##s", fqdn);
2637
2638 while (*ptr && !SameDomainName(fqdn, &(*ptr)->fqdn)) ptr = &(*ptr)->next;
2639 if (*ptr) { LogMsg("DynDNSHostName %##s already in list", fqdn->c); return; }
2640
2641 // allocate and format new address record
2642 *ptr = mDNSPlatformMemAllocate(sizeof(**ptr));
2643 if (!*ptr) { LogMsg("ERROR: mDNS_AddDynDNSHostName - malloc"); return; }
2644
2645 mDNSPlatformMemZero(*ptr, sizeof(**ptr));
2646 AssignDomainName(&(*ptr)->fqdn, fqdn);
2647 (*ptr)->arv4.state = regState_Unregistered;
2648 (*ptr)->arv6.state = regState_Unregistered;
2649 (*ptr)->StatusCallback = StatusCallback;
2650 (*ptr)->StatusContext = StatusContext;
2651
2652 AdvertiseHostname(m, *ptr);
2653 }
2654
2655 mDNSexport void mDNS_RemoveDynDNSHostName(mDNS *m, const domainname *fqdn)
2656 {
2657 HostnameInfo **ptr = &m->Hostnames;
2658
2659 LogInfo("mDNS_RemoveDynDNSHostName %##s", fqdn);
2660
2661 while (*ptr && !SameDomainName(fqdn, &(*ptr)->fqdn)) ptr = &(*ptr)->next;
2662 if (!*ptr) LogMsg("mDNS_RemoveDynDNSHostName: no such domainname %##s", fqdn->c);
2663 else
2664 {
2665 HostnameInfo *hi = *ptr;
2666 // We do it this way because, if we have no active v6 record, the "mDNS_Deregister_internal(m, &hi->arv4);"
2667 // below could free the memory, and we have to make sure we don't touch hi fields after that.
2668 mDNSBool f4 = hi->arv4.resrec.RecordType != kDNSRecordTypeUnregistered && hi->arv4.state != regState_Unregistered;
2669 mDNSBool f6 = hi->arv6.resrec.RecordType != kDNSRecordTypeUnregistered && hi->arv6.state != regState_Unregistered;
2670 *ptr = (*ptr)->next; // unlink
2671 if (f4 || f6)
2672 {
2673 if (f4)
2674 {
2675 LogInfo("mDNS_RemoveDynDNSHostName removing v4 %##s", fqdn);
2676 mDNS_Deregister_internal(m, &hi->arv4, mDNS_Dereg_normal);
2677 }
2678 if (f6)
2679 {
2680 LogInfo("mDNS_RemoveDynDNSHostName removing v6 %##s", fqdn);
2681 mDNS_Deregister_internal(m, &hi->arv6, mDNS_Dereg_normal);
2682 }
2683 // When both deregistrations complete we'll free the memory in the mStatus_MemFree callback
2684 }
2685 else
2686 {
2687 if (hi->natinfo.clientContext)
2688 {
2689 mDNS_StopNATOperation_internal(m, &hi->natinfo);
2690 hi->natinfo.clientContext = mDNSNULL;
2691 }
2692 mDNSPlatformMemFree(hi);
2693 }
2694 }
2695 mDNS_CheckLock(m);
2696 m->NextSRVUpdate = NonZeroTime(m->timenow);
2697 }
2698
2699 // Currently called without holding the lock
2700 // Maybe we should change that?
2701 mDNSexport void mDNS_SetPrimaryInterfaceInfo(mDNS *m, const mDNSAddr *v4addr, const mDNSAddr *v6addr, const mDNSAddr *router)
2702 {
2703 mDNSBool v4Changed, v6Changed, RouterChanged;
2704
2705 if (m->mDNS_busy != m->mDNS_reentrancy)
2706 LogMsg("mDNS_SetPrimaryInterfaceInfo: mDNS_busy (%ld) != mDNS_reentrancy (%ld)", m->mDNS_busy, m->mDNS_reentrancy);
2707
2708 if (v4addr && v4addr->type != mDNSAddrType_IPv4) { LogMsg("mDNS_SetPrimaryInterfaceInfo v4 address - incorrect type. Discarding. %#a", v4addr); return; }
2709 if (v6addr && v6addr->type != mDNSAddrType_IPv6) { LogMsg("mDNS_SetPrimaryInterfaceInfo v6 address - incorrect type. Discarding. %#a", v6addr); return; }
2710 if (router && router->type != mDNSAddrType_IPv4) { LogMsg("mDNS_SetPrimaryInterfaceInfo passed non-v4 router. Discarding. %#a", router); return; }
2711
2712 mDNS_Lock(m);
2713
2714 v4Changed = !mDNSSameIPv4Address(m->AdvertisedV4.ip.v4, v4addr ? v4addr->ip.v4 : zerov4Addr);
2715 v6Changed = !mDNSSameIPv6Address(m->AdvertisedV6.ip.v6, v6addr ? v6addr->ip.v6 : zerov6Addr);
2716 RouterChanged = !mDNSSameIPv4Address(m->Router.ip.v4, router ? router->ip.v4 : zerov4Addr);
2717
2718 if (v4addr && (v4Changed || RouterChanged))
2719 debugf("mDNS_SetPrimaryInterfaceInfo: address changed from %#a to %#a", &m->AdvertisedV4, v4addr);
2720
2721 if (v4addr) m->AdvertisedV4 = *v4addr;else m->AdvertisedV4.ip.v4 = zerov4Addr;
2722 if (v6addr) m->AdvertisedV6 = *v6addr;else m->AdvertisedV6.ip.v6 = zerov6Addr;
2723 if (router) m->Router = *router;else m->Router.ip.v4 = zerov4Addr;
2724 // setting router to zero indicates that nat mappings must be reestablished when router is reset
2725
2726 if (v4Changed || RouterChanged || v6Changed)
2727 {
2728 HostnameInfo *i;
2729 LogInfo("mDNS_SetPrimaryInterfaceInfo: %s%s%s%#a %#a %#a",
2730 v4Changed ? "v4Changed " : "",
2731 RouterChanged ? "RouterChanged " : "",
2732 v6Changed ? "v6Changed " : "", v4addr, v6addr, router);
2733
2734 for (i = m->Hostnames; i; i = i->next)
2735 {
2736 LogInfo("mDNS_SetPrimaryInterfaceInfo updating host name registrations for %##s", i->fqdn.c);
2737
2738 if (i->arv4.resrec.RecordType > kDNSRecordTypeDeregistering &&
2739 !mDNSSameIPv4Address(i->arv4.resrec.rdata->u.ipv4, m->AdvertisedV4.ip.v4))
2740 {
2741 LogInfo("mDNS_SetPrimaryInterfaceInfo deregistering %s", ARDisplayString(m, &i->arv4));
2742 mDNS_Deregister_internal(m, &i->arv4, mDNS_Dereg_normal);
2743 }
2744
2745 if (i->arv6.resrec.RecordType > kDNSRecordTypeDeregistering &&
2746 !mDNSSameIPv6Address(i->arv6.resrec.rdata->u.ipv6, m->AdvertisedV6.ip.v6))
2747 {
2748 LogInfo("mDNS_SetPrimaryInterfaceInfo deregistering %s", ARDisplayString(m, &i->arv6));
2749 mDNS_Deregister_internal(m, &i->arv6, mDNS_Dereg_normal);
2750 }
2751
2752 // AdvertiseHostname will only register new address records.
2753 // For records still in the process of deregistering it will ignore them, and let the mStatus_MemFree callback handle them.
2754 AdvertiseHostname(m, i);
2755 }
2756
2757 if (v4Changed || RouterChanged)
2758 {
2759 // If we have a non-zero IPv4 address, we should try immediately to see if we have a NAT gateway
2760 // If we have no IPv4 address, we don't want to be in quite such a hurry to report failures to our clients
2761 // <rdar://problem/6935929> Sleeping server sometimes briefly disappears over Back to My Mac after it wakes up
2762 mDNSu32 waitSeconds = v4addr ? 0 : 5;
2763 NATTraversalInfo *n;
2764 m->ExtAddress = zerov4Addr;
2765 m->LastNATMapResultCode = NATErr_None;
2766
2767 RecreateNATMappings(m, mDNSPlatformOneSecond * waitSeconds);
2768
2769 for (n = m->NATTraversals; n; n=n->next)
2770 n->NewAddress = zerov4Addr;
2771
2772 LogInfo("mDNS_SetPrimaryInterfaceInfo:%s%s: recreating NAT mappings in %d seconds",
2773 v4Changed ? " v4Changed" : "",
2774 RouterChanged ? " RouterChanged" : "",
2775 waitSeconds);
2776 }
2777
2778 if (m->ReverseMap.ThisQInterval != -1) mDNS_StopQuery_internal(m, &m->ReverseMap);
2779 m->StaticHostname.c[0] = 0;
2780
2781 m->NextSRVUpdate = NonZeroTime(m->timenow);
2782
2783 #if APPLE_OSX_mDNSResponder
2784 UpdateAutoTunnelDomainStatuses(m);
2785 #endif
2786 }
2787
2788 mDNS_Unlock(m);
2789 }
2790
2791 // ***************************************************************************
2792 #if COMPILER_LIKES_PRAGMA_MARK
2793 #pragma mark - Incoming Message Processing
2794 #endif
2795
2796 mDNSlocal mStatus ParseTSIGError(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *const end, const domainname *const displayname)
2797 {
2798 const mDNSu8 *ptr;
2799 mStatus err = mStatus_NoError;
2800 int i;
2801
2802 ptr = LocateAdditionals(msg, end);
2803 if (!ptr) goto finish;
2804
2805 for (i = 0; i < msg->h.numAdditionals; i++)
2806 {
2807 ptr = GetLargeResourceRecord(m, msg, ptr, end, 0, kDNSRecordTypePacketAdd, &m->rec);
2808 if (!ptr) goto finish;
2809 if (m->rec.r.resrec.RecordType != kDNSRecordTypePacketNegative && m->rec.r.resrec.rrtype == kDNSType_TSIG)
2810 {
2811 mDNSu32 macsize;
2812 mDNSu8 *rd = m->rec.r.resrec.rdata->u.data;
2813 mDNSu8 *rdend = rd + m->rec.r.resrec.rdlength;
2814 int alglen = DomainNameLengthLimit(&m->rec.r.resrec.rdata->u.name, rdend);
2815 if (alglen > MAX_DOMAIN_NAME) goto finish;
2816 rd += alglen; // algorithm name
2817 if (rd + 6 > rdend) goto finish;
2818 rd += 6; // 48-bit timestamp
2819 if (rd + sizeof(mDNSOpaque16) > rdend) goto finish;
2820 rd += sizeof(mDNSOpaque16); // fudge
2821 if (rd + sizeof(mDNSOpaque16) > rdend) goto finish;
2822 macsize = mDNSVal16(*(mDNSOpaque16 *)rd);
2823 rd += sizeof(mDNSOpaque16); // MAC size
2824 if (rd + macsize > rdend) goto finish;
2825 rd += macsize;
2826 if (rd + sizeof(mDNSOpaque16) > rdend) goto finish;
2827 rd += sizeof(mDNSOpaque16); // orig id
2828 if (rd + sizeof(mDNSOpaque16) > rdend) goto finish;
2829 err = mDNSVal16(*(mDNSOpaque16 *)rd); // error code
2830
2831 if (err == TSIG_ErrBadSig) { LogMsg("%##s: bad signature", displayname->c); err = mStatus_BadSig; }
2832 else if (err == TSIG_ErrBadKey) { LogMsg("%##s: bad key", displayname->c); err = mStatus_BadKey; }
2833 else if (err == TSIG_ErrBadTime) { LogMsg("%##s: bad time", displayname->c); err = mStatus_BadTime; }
2834 else if (err) { LogMsg("%##s: unknown tsig error %d", displayname->c, err); err = mStatus_UnknownErr; }
2835 goto finish;
2836 }
2837 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
2838 }
2839
2840 finish:
2841 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
2842 return err;
2843 }
2844
2845 mDNSlocal mStatus checkUpdateResult(mDNS *const m, const domainname *const displayname, const mDNSu8 rcode, const DNSMessage *const msg, const mDNSu8 *const end)
2846 {
2847 (void)msg; // currently unused, needed for TSIG errors
2848 if (!rcode) return mStatus_NoError;
2849 else if (rcode == kDNSFlag1_RC_YXDomain)
2850 {
2851 debugf("name in use: %##s", displayname->c);
2852 return mStatus_NameConflict;
2853 }
2854 else if (rcode == kDNSFlag1_RC_Refused)
2855 {
2856 LogMsg("Update %##s refused", displayname->c);
2857 return mStatus_Refused;
2858 }
2859 else if (rcode == kDNSFlag1_RC_NXRRSet)
2860 {
2861 LogMsg("Reregister refused (NXRRSET): %##s", displayname->c);
2862 return mStatus_NoSuchRecord;
2863 }
2864 else if (rcode == kDNSFlag1_RC_NotAuth)
2865 {
2866 // TSIG errors should come with FormErr as per RFC 2845, but BIND 9 sends them with NotAuth so we look here too
2867 mStatus tsigerr = ParseTSIGError(m, msg, end, displayname);
2868 if (!tsigerr)
2869 {
2870 LogMsg("Permission denied (NOAUTH): %##s", displayname->c);
2871 return mStatus_UnknownErr;
2872 }
2873 else return tsigerr;
2874 }
2875 else if (rcode == kDNSFlag1_RC_FormErr)
2876 {
2877 mStatus tsigerr = ParseTSIGError(m, msg, end, displayname);
2878 if (!tsigerr)
2879 {
2880 LogMsg("Format Error: %##s", displayname->c);
2881 return mStatus_UnknownErr;
2882 }
2883 else return tsigerr;
2884 }
2885 else
2886 {
2887 LogMsg("Update %##s failed with rcode %d", displayname->c, rcode);
2888 return mStatus_UnknownErr;
2889 }
2890 }
2891
2892 // We add three Additional Records for unicast resource record registrations
2893 // which is a function of AuthInfo and AutoTunnel properties
2894 mDNSlocal mDNSu32 RRAdditionalSize(mDNS *const m, DomainAuthInfo *AuthInfo)
2895 {
2896 mDNSu32 leaseSize, hinfoSize, tsigSize;
2897 mDNSu32 rr_base_size = 10; // type (2) class (2) TTL (4) rdlength (2)
2898
2899 // OPT RR : Emptyname(.) + base size + rdataOPT
2900 leaseSize = 1 + rr_base_size + sizeof(rdataOPT);
2901
2902 // HINFO: Resource Record Name + base size + RDATA
2903 // HINFO is added only for autotunnels
2904 hinfoSize = 0;
2905 if (AuthInfo && AuthInfo->AutoTunnel)
2906 hinfoSize = (m->hostlabel.c[0] + 1) + DomainNameLength(&AuthInfo->domain) +
2907 rr_base_size + (2 + m->HIHardware.c[0] + m->HISoftware.c[0]);
2908
2909 //TSIG: Resource Record Name + base size + RDATA
2910 // RDATA:
2911 // Algorithm name: hmac-md5.sig-alg.reg.int (8+7+3+3 + 5 bytes for length = 26 bytes)
2912 // Time: 6 bytes
2913 // Fudge: 2 bytes
2914 // Mac Size: 2 bytes
2915 // Mac: 16 bytes
2916 // ID: 2 bytes
2917 // Error: 2 bytes
2918 // Len: 2 bytes
2919 // Total: 58 bytes
2920 tsigSize = 0;
2921 if (AuthInfo) tsigSize = DomainNameLength(&AuthInfo->keyname) + rr_base_size + 58;
2922
2923 return (leaseSize + hinfoSize + tsigSize);
2924 }
2925
2926 //Note: Make sure that RREstimatedSize is updated accordingly if anything that is done here
2927 //would modify rdlength/rdestimate
2928 mDNSlocal mDNSu8* BuildUpdateMessage(mDNS *const m, mDNSu8 *ptr, AuthRecord *rr, mDNSu8 *limit)
2929 {
2930 //If this record is deregistering, then just send the deletion record
2931 if (rr->state == regState_DeregPending)
2932 {
2933 rr->expire = 0; // Indicate that we have no active registration any more
2934 ptr = putDeletionRecordWithLimit(&m->omsg, ptr, &rr->resrec, limit);
2935 if (!ptr) goto exit;
2936 return ptr;
2937 }
2938
2939 // This is a common function to both sending an update in a group or individual
2940 // records separately. Hence, we change the state here.
2941 if (rr->state == regState_Registered) rr->state = regState_Refresh;
2942 if (rr->state != regState_Refresh && rr->state != regState_UpdatePending)
2943 rr->state = regState_Pending;
2944
2945 // For Advisory records like e.g., _services._dns-sd, which is shared, don't send goodbyes as multiple
2946 // host might be registering records and deregistering from one does not make sense
2947 if (rr->resrec.RecordType != kDNSRecordTypeAdvisory) rr->RequireGoodbye = mDNStrue;
2948
2949 if ((rr->resrec.rrtype == kDNSType_SRV) && (rr->AutoTarget == Target_AutoHostAndNATMAP) &&
2950 !mDNSIPPortIsZero(rr->NATinfo.ExternalPort))
2951 {
2952 rr->resrec.rdata->u.srv.port = rr->NATinfo.ExternalPort;
2953 }
2954
2955 if (rr->state == regState_UpdatePending)
2956 {
2957 // delete old RData
2958 SetNewRData(&rr->resrec, rr->OrigRData, rr->OrigRDLen);
2959 if (!(ptr = putDeletionRecordWithLimit(&m->omsg, ptr, &rr->resrec, limit))) goto exit; // delete old rdata
2960
2961 // add new RData
2962 SetNewRData(&rr->resrec, rr->InFlightRData, rr->InFlightRDLen);
2963 if (!(ptr = PutResourceRecordTTLWithLimit(&m->omsg, ptr, &m->omsg.h.mDNS_numUpdates, &rr->resrec, rr->resrec.rroriginalttl, limit))) goto exit;
2964 }
2965 else
2966 {
2967 if (rr->resrec.RecordType == kDNSRecordTypeKnownUnique || rr->resrec.RecordType == kDNSRecordTypeVerified)
2968 {
2969 // KnownUnique : Delete any previous value
2970 // For Unicast registrations, we don't verify that it is unique, but set to verified and hence we want to
2971 // delete any previous value
2972 ptr = putDeleteRRSetWithLimit(&m->omsg, ptr, rr->resrec.name, rr->resrec.rrtype, limit);
2973 if (!ptr) goto exit;
2974 }
2975 else if (rr->resrec.RecordType != kDNSRecordTypeShared)
2976 {
2977 // For now don't do this, until we have the logic for intelligent grouping of individual records into logical service record sets
2978 //ptr = putPrereqNameNotInUse(rr->resrec.name, &m->omsg, ptr, end);
2979 if (!ptr) goto exit;
2980 }
2981
2982 ptr = PutResourceRecordTTLWithLimit(&m->omsg, ptr, &m->omsg.h.mDNS_numUpdates, &rr->resrec, rr->resrec.rroriginalttl, limit);
2983 if (!ptr) goto exit;
2984 }
2985
2986 return ptr;
2987 exit:
2988 LogMsg("BuildUpdateMessage: Error formatting message for %s", ARDisplayString(m, rr));
2989 return mDNSNULL;
2990 }
2991
2992 // Called with lock held
2993 mDNSlocal void SendRecordRegistration(mDNS *const m, AuthRecord *rr)
2994 {
2995 mDNSu8 *ptr = m->omsg.data;
2996 mStatus err = mStatus_UnknownErr;
2997 mDNSu8 *limit;
2998 DomainAuthInfo *AuthInfo;
2999
3000 // For the ability to register large TXT records, we limit the single record registrations
3001 // to AbsoluteMaxDNSMessageData
3002 limit = ptr + AbsoluteMaxDNSMessageData;
3003
3004 AuthInfo = GetAuthInfoForName_internal(m, rr->resrec.name);
3005 limit -= RRAdditionalSize(m, AuthInfo);
3006
3007 mDNS_CheckLock(m);
3008
3009 if (!rr->nta || mDNSIPv4AddressIsZero(rr->nta->Addr.ip.v4))
3010 {
3011 // We never call this function when there is no zone information . Log a message if it ever happens.
3012 LogMsg("SendRecordRegistration: No Zone information, should not happen %s", ARDisplayString(m, rr));
3013 return;
3014 }
3015
3016 rr->updateid = mDNS_NewMessageID(m);
3017 InitializeDNSMessage(&m->omsg.h, rr->updateid, UpdateReqFlags);
3018
3019 // set zone
3020 ptr = putZone(&m->omsg, ptr, limit, rr->zone, mDNSOpaque16fromIntVal(rr->resrec.rrclass));
3021 if (!ptr) goto exit;
3022
3023 if (!(ptr = BuildUpdateMessage(m, ptr, rr, limit))) goto exit;
3024
3025 if (rr->uselease)
3026 {
3027 ptr = putUpdateLeaseWithLimit(&m->omsg, ptr, DEFAULT_UPDATE_LEASE, limit);
3028 if (!ptr) goto exit;
3029 }
3030 if (rr->Private)
3031 {
3032 LogInfo("SendRecordRegistration TCP %p %s", rr->tcp, ARDisplayString(m, rr));
3033 if (rr->tcp) LogInfo("SendRecordRegistration: Disposing existing TCP connection for %s", ARDisplayString(m, rr));
3034 if (rr->tcp) { DisposeTCPConn(rr->tcp); rr->tcp = mDNSNULL; }
3035 if (!rr->nta) { LogMsg("SendRecordRegistration:Private:ERROR!! nta is NULL for %s", ARDisplayString(m, rr)); return; }
3036 rr->tcp = MakeTCPConn(m, &m->omsg, ptr, kTCPSocketFlags_UseTLS, &rr->nta->Addr, rr->nta->Port, &rr->nta->Host, mDNSNULL, rr);
3037 }
3038 else
3039 {
3040 LogInfo("SendRecordRegistration UDP %s", ARDisplayString(m, rr));
3041 if (!rr->nta) { LogMsg("SendRecordRegistration:ERROR!! nta is NULL for %s", ARDisplayString(m, rr)); return; }
3042 err = mDNSSendDNSMessage(m, &m->omsg, ptr, mDNSInterface_Any, mDNSNULL, &rr->nta->Addr, rr->nta->Port, mDNSNULL, GetAuthInfoForName_internal(m, rr->resrec.name), mDNSfalse);
3043 if (err) debugf("ERROR: SendRecordRegistration - mDNSSendDNSMessage - %d", err);
3044 }
3045
3046 SetRecordRetry(m, rr, 0);
3047 return;
3048 exit:
3049 LogMsg("SendRecordRegistration: Error formatting message for %s, disabling further updates", ARDisplayString(m, rr));
3050 // Disable this record from future updates
3051 rr->state = regState_NoTarget;
3052 }
3053
3054 // Is the given record "rr" eligible for merging ?
3055 mDNSlocal mDNSBool IsRecordMergeable(mDNS *const m, AuthRecord *rr, mDNSs32 time)
3056 {
3057 DomainAuthInfo *info;
3058 // A record is eligible for merge, if the following properties are met.
3059 //
3060 // 1. uDNS Resource Record
3061 // 2. It is time to send them now
3062 // 3. It is in proper state
3063 // 4. Update zone has been resolved
3064 // 5. if DomainAuthInfo exists for the zone, it should not be soon deleted
3065 // 6. Zone information is present
3066 // 7. Update server is not zero
3067 // 8. It has a non-null zone
3068 // 9. It uses a lease option
3069 // 10. DontMerge is not set
3070 //
3071 // Following code is implemented as separate "if" statements instead of one "if" statement
3072 // is for better debugging purposes e.g., we know exactly what failed if debugging turned on.
3073
3074 if (!AuthRecord_uDNS(rr)) return mDNSfalse;
3075
3076 if (rr->LastAPTime + rr->ThisAPInterval - time > 0)
3077 { debugf("IsRecordMergeable: Time %d not reached for %s", rr->LastAPTime + rr->ThisAPInterval - m->timenow, ARDisplayString(m, rr)); return mDNSfalse; }
3078
3079 if (!rr->zone) return mDNSfalse;
3080
3081 info = GetAuthInfoForName_internal(m, rr->zone);
3082
3083 if (info && info->deltime && m->timenow - info->deltime >= 0) {debugf("IsRecordMergeable: Domain %##s will be deleted soon", info->domain.c); return mDNSfalse;}
3084
3085 if (rr->state != regState_DeregPending && rr->state != regState_Pending && rr->state != regState_Registered && rr->state != regState_Refresh && rr->state != regState_UpdatePending)
3086 { debugf("IsRecordMergeable: state %d not right %s", rr->state, ARDisplayString(m, rr)); return mDNSfalse; }
3087
3088 if (!rr->nta || mDNSIPv4AddressIsZero(rr->nta->Addr.ip.v4)) return mDNSfalse;
3089
3090 if (!rr->uselease) return mDNSfalse;
3091
3092 if (rr->mState == mergeState_DontMerge) {debugf("IsRecordMergeable Dontmerge true %s", ARDisplayString(m, rr)); return mDNSfalse;}
3093 debugf("IsRecordMergeable: Returning true for %s", ARDisplayString(m, rr));
3094 return mDNStrue;
3095 }
3096
3097 // Is the resource record "rr" eligible to merge to with "currentRR" ?
3098 mDNSlocal mDNSBool AreRecordsMergeable(mDNS *const m, AuthRecord *currentRR, AuthRecord *rr, mDNSs32 time)
3099 {
3100 // A record is eligible to merge with another record as long it is eligible for merge in itself
3101 // and it has the same zone information as the other record
3102 if (!IsRecordMergeable(m, rr, time)) return mDNSfalse;
3103
3104 if (!SameDomainName(currentRR->zone, rr->zone))
3105 { debugf("AreRecordMergeable zone mismatch current rr Zone %##s, rr zone %##s", currentRR->zone->c, rr->zone->c); return mDNSfalse; }
3106
3107 if (!mDNSSameIPv4Address(currentRR->nta->Addr.ip.v4, rr->nta->Addr.ip.v4)) return mDNSfalse;
3108
3109 if (!mDNSSameIPPort(currentRR->nta->Port, rr->nta->Port)) return mDNSfalse;
3110
3111 debugf("AreRecordsMergeable: Returning true for %s", ARDisplayString(m, rr));
3112 return mDNStrue;
3113 }
3114
3115 // If we can't build the message successfully because of problems in pre-computing
3116 // the space, we disable merging for all the current records
3117 mDNSlocal void RRMergeFailure(mDNS *const m)
3118 {
3119 AuthRecord *rr;
3120 for (rr = m->ResourceRecords; rr; rr = rr->next)
3121 {
3122 rr->mState = mergeState_DontMerge;
3123 rr->SendRNow = mDNSNULL;
3124 // Restarting the registration is much simpler than saving and restoring
3125 // the exact time
3126 ActivateUnicastRegistration(m, rr);
3127 }
3128 }
3129
3130 mDNSlocal void SendGroupRRMessage(mDNS *const m, AuthRecord *anchorRR, mDNSu8 *ptr, DomainAuthInfo *info)
3131 {
3132 mDNSu8 *limit;
3133 if (!anchorRR) {debugf("SendGroupRRMessage: Could not merge records"); return;}
3134
3135 if (info && info->AutoTunnel) limit = m->omsg.data + AbsoluteMaxDNSMessageData;
3136 else limit = m->omsg.data + NormalMaxDNSMessageData;
3137
3138 // This has to go in the additional section and hence need to be done last
3139 ptr = putUpdateLeaseWithLimit(&m->omsg, ptr, DEFAULT_UPDATE_LEASE, limit);
3140 if (!ptr)
3141 {
3142 LogMsg("SendGroupRRMessage: ERROR: Could not put lease option, failing the group registration");
3143 // if we can't put the lease, we need to undo the merge
3144 RRMergeFailure(m);
3145 return;
3146 }
3147 if (anchorRR->Private)
3148 {
3149 if (anchorRR->tcp) debugf("SendGroupRRMessage: Disposing existing TCP connection for %s", ARDisplayString(m, anchorRR));
3150 if (anchorRR->tcp) { DisposeTCPConn(anchorRR->tcp); anchorRR->tcp = mDNSNULL; }
3151 if (!anchorRR->nta) { LogMsg("SendGroupRRMessage:ERROR!! nta is NULL for %s", ARDisplayString(m, anchorRR)); return; }
3152 anchorRR->tcp = MakeTCPConn(m, &m->omsg, ptr, kTCPSocketFlags_UseTLS, &anchorRR->nta->Addr, anchorRR->nta->Port, &anchorRR->nta->Host, mDNSNULL, anchorRR);
3153 if (!anchorRR->tcp) LogInfo("SendGroupRRMessage: Cannot establish TCP connection for %s", ARDisplayString(m, anchorRR));
3154 else LogInfo("SendGroupRRMessage: Sent a group update ID: %d start %p, end %p, limit %p", mDNSVal16(m->omsg.h.id), m->omsg.data, ptr, limit);
3155 }
3156 else
3157 {
3158 mStatus err = mDNSSendDNSMessage(m, &m->omsg, ptr, mDNSInterface_Any, mDNSNULL, &anchorRR->nta->Addr, anchorRR->nta->Port, mDNSNULL, info, mDNSfalse);
3159 if (err) LogInfo("SendGroupRRMessage: Cannot send UDP message for %s", ARDisplayString(m, anchorRR));
3160 else LogInfo("SendGroupRRMessage: Sent a group UDP update ID: %d start %p, end %p, limit %p", mDNSVal16(m->omsg.h.id), m->omsg.data, ptr, limit);
3161 }
3162 return;
3163 }
3164
3165 // As we always include the zone information and the resource records contain zone name
3166 // at the end, it will get compressed. Hence, we subtract zoneSize and add two bytes for
3167 // the compression pointer
3168 mDNSlocal mDNSu32 RREstimatedSize(AuthRecord *rr, int zoneSize)
3169 {
3170 int rdlength;
3171
3172 // Note: Estimation of the record size has to mirror the logic in BuildUpdateMessage, otherwise estimation
3173 // would be wrong. Currently BuildUpdateMessage calls SetNewRData in UpdatePending case. Hence, we need
3174 // to account for that here. Otherwise, we might under estimate the size.
3175 if (rr->state == regState_UpdatePending)
3176 // old RData that will be deleted
3177 // new RData that will be added
3178 rdlength = rr->OrigRDLen + rr->InFlightRDLen;
3179 else
3180 rdlength = rr->resrec.rdestimate;
3181
3182 if (rr->state == regState_DeregPending)
3183 {
3184 debugf("RREstimatedSize: ResourceRecord %##s (%s), DomainNameLength %d, zoneSize %d, rdestimate %d",
3185 rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), DomainNameLength(rr->resrec.name), zoneSize, rdlength);
3186 return DomainNameLength(rr->resrec.name) - zoneSize + 2 + 10 + rdlength;
3187 }
3188
3189 // For SRV, TXT, AAAA etc. that are Unique/Verified, we also send a Deletion Record
3190 if (rr->resrec.RecordType == kDNSRecordTypeKnownUnique || rr->resrec.RecordType == kDNSRecordTypeVerified)
3191 {
3192 // Deletion Record: Resource Record Name + Base size (10) + 0
3193 // Record: Resource Record Name (Compressed = 2) + Base size (10) + rdestimate
3194
3195 debugf("RREstimatedSize: ResourceRecord %##s (%s), DomainNameLength %d, zoneSize %d, rdestimate %d",
3196 rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), DomainNameLength(rr->resrec.name), zoneSize, rdlength);
3197 return DomainNameLength(rr->resrec.name) - zoneSize + 2 + 10 + 2 + 10 + rdlength;
3198 }
3199 else
3200 {
3201 return DomainNameLength(rr->resrec.name) - zoneSize + 2 + 10 + rdlength;
3202 }
3203 }
3204
3205 mDNSlocal AuthRecord *MarkRRForSending(mDNS *const m)
3206 {
3207 AuthRecord *rr;
3208 AuthRecord *firstRR = mDNSNULL;
3209
3210 // Look for records that needs to be sent in the next two seconds (MERGE_DELAY_TIME is set to 1 second).
3211 // The logic is as follows.
3212 //
3213 // 1. Record 1 finishes getting zone data and its registration gets delayed by 1 second
3214 // 2. Record 2 comes 0.1 second later, finishes getting its zone data and its registration is also delayed by
3215 // 1 second which is now scheduled at 1.1 second
3216 //
3217 // By looking for 1 second into the future (m->timenow + MERGE_DELAY_TIME below does that) we have merged both
3218 // of the above records. Note that we can't look for records too much into the future as this will affect the
3219 // retry logic. The first retry is scheduled at 3 seconds. Hence, we should always look smaller than that.
3220 // Anything more than one second will affect the first retry to happen sooner.
3221 //
3222 // Note: As a side effect of looking one second into the future to facilitate merging, the retries happen
3223 // one second sooner.
3224 for (rr = m->ResourceRecords; rr; rr = rr->next)
3225 {
3226 if (!firstRR)
3227 {
3228 if (!IsRecordMergeable(m, rr, m->timenow + MERGE_DELAY_TIME)) continue;
3229 firstRR = rr;
3230 }
3231 else if (!AreRecordsMergeable(m, firstRR, rr, m->timenow + MERGE_DELAY_TIME)) continue;
3232
3233 if (rr->SendRNow) LogMsg("MarkRRForSending: Resourcerecord %s already marked for sending", ARDisplayString(m, rr));
3234 rr->SendRNow = uDNSInterfaceMark;
3235 }
3236
3237 // We parsed through all records and found something to send. The services/records might
3238 // get registered at different times but we want the refreshes to be all merged and sent
3239 // as one update. Hence, we accelerate some of the records so that they will sync up in
3240 // the future. Look at the records excluding the ones that we have already sent in the
3241 // previous pass. If it half way through its scheduled refresh/retransmit, merge them
3242 // into this packet.
3243 //
3244 // Note that we only look at Registered/Refresh state to keep it simple. As we don't know
3245 // whether the current update will fit into one or more packets, merging a resource record
3246 // (which is in a different state) that has been scheduled for retransmit would trigger
3247 // sending more packets.
3248 if (firstRR)
3249 {
3250 int acc = 0;
3251 for (rr = m->ResourceRecords; rr; rr = rr->next)
3252 {
3253 if ((rr->state != regState_Registered && rr->state != regState_Refresh) ||
3254 (rr->SendRNow == uDNSInterfaceMark) ||
3255 (!AreRecordsMergeable(m, firstRR, rr, m->timenow + rr->ThisAPInterval/2)))
3256 continue;
3257 rr->SendRNow = uDNSInterfaceMark;
3258 acc++;
3259 }
3260 if (acc) LogInfo("MarkRRForSending: Accelereated %d records", acc);
3261 }
3262 return firstRR;
3263 }
3264
3265 mDNSlocal mDNSBool SendGroupUpdates(mDNS *const m)
3266 {
3267 mDNSOpaque16 msgid;
3268 mDNSs32 spaceleft = 0;
3269 mDNSs32 zoneSize, rrSize;
3270 mDNSu8 *oldnext; // for debugging
3271 mDNSu8 *next = m->omsg.data;
3272 AuthRecord *rr;
3273 AuthRecord *anchorRR = mDNSNULL;
3274 int nrecords = 0;
3275 AuthRecord *startRR = m->ResourceRecords;
3276 mDNSu8 *limit = mDNSNULL;
3277 DomainAuthInfo *AuthInfo = mDNSNULL;
3278 mDNSBool sentallRecords = mDNStrue;
3279
3280
3281 // We try to fit as many ResourceRecords as possible in AbsoluteNormal/MaxDNSMessageData. Before we start
3282 // putting in resource records, we need to reserve space for a few things. Every group/packet should
3283 // have the following.
3284 //
3285 // 1) Needs space for the Zone information (which needs to be at the beginning)
3286 // 2) Additional section MUST have space for lease option, HINFO and TSIG option (which needs to
3287 // to be at the end)
3288 //
3289 // In future we need to reserve space for the pre-requisites which also goes at the beginning.
3290 // To accomodate pre-requisites in the future, first we walk the whole list marking records
3291 // that can be sent in this packet and computing the space needed for these records.
3292 // For TXT and SRV records, we delete the previous record if any by sending the same
3293 // resource record with ANY RDATA and zero rdlen. Hence, we need to have space for both of them.
3294
3295 while (startRR)
3296 {
3297 AuthInfo = mDNSNULL;
3298 anchorRR = mDNSNULL;
3299 nrecords = 0;
3300 zoneSize = 0;
3301 for (rr = startRR; rr; rr = rr->next)
3302 {
3303 if (rr->SendRNow != uDNSInterfaceMark) continue;
3304
3305 rr->SendRNow = mDNSNULL;
3306
3307 if (!anchorRR)
3308 {
3309 AuthInfo = GetAuthInfoForName_internal(m, rr->zone);
3310
3311 // Though we allow single record registrations for UDP to be AbsoluteMaxDNSMessageData (See
3312 // SendRecordRegistration) to handle large TXT records, to avoid fragmentation we limit UDP
3313 // message to NormalMaxDNSMessageData
3314 if (AuthInfo && AuthInfo->AutoTunnel) spaceleft = AbsoluteMaxDNSMessageData;
3315 else spaceleft = NormalMaxDNSMessageData;
3316
3317 next = m->omsg.data;
3318 spaceleft -= RRAdditionalSize(m, AuthInfo);
3319 if (spaceleft <= 0)
3320 {
3321 LogMsg("SendGroupUpdates: ERROR!!: spaceleft is zero at the beginning");
3322 RRMergeFailure(m);
3323 return mDNSfalse;
3324 }
3325 limit = next + spaceleft;
3326
3327 // Build the initial part of message before putting in the other records
3328 msgid = mDNS_NewMessageID(m);
3329 InitializeDNSMessage(&m->omsg.h, msgid, UpdateReqFlags);
3330
3331 // We need zone information at the beginning of the packet. Length: ZNAME, ZTYPE(2), ZCLASS(2)
3332 // zone has to be non-NULL for a record to be mergeable, hence it is safe to set/ examine zone
3333 //without checking for NULL.
3334 zoneSize = DomainNameLength(rr->zone) + 4;
3335 spaceleft -= zoneSize;
3336 if (spaceleft <= 0)
3337 {
3338 LogMsg("SendGroupUpdates: ERROR no space for zone information, disabling merge");
3339 RRMergeFailure(m);
3340 return mDNSfalse;
3341 }
3342 next = putZone(&m->omsg, next, limit, rr->zone, mDNSOpaque16fromIntVal(rr->resrec.rrclass));
3343 if (!next)
3344 {
3345 LogMsg("SendGroupUpdates: ERROR! Cannot put zone, disabling merge");
3346 RRMergeFailure(m);
3347 return mDNSfalse;
3348 }
3349 anchorRR = rr;
3350 }
3351
3352 rrSize = RREstimatedSize(rr, zoneSize - 4);
3353
3354 if ((spaceleft - rrSize) < 0)
3355 {
3356 // If we can't fit even a single message, skip it, it will be sent separately
3357 // in CheckRecordUpdates
3358 if (!nrecords)
3359 {
3360 LogInfo("SendGroupUpdates: Skipping message %s, spaceleft %d, rrSize %d", ARDisplayString(m, rr), spaceleft, rrSize);
3361 // Mark this as not sent so that the caller knows about it
3362 rr->SendRNow = uDNSInterfaceMark;
3363 // We need to remove the merge delay so that we can send it immediately
3364 rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
3365 rr->LastAPTime = m->timenow - INIT_RECORD_REG_INTERVAL;
3366 rr = rr->next;
3367 anchorRR = mDNSNULL;
3368 sentallRecords = mDNSfalse;
3369 }
3370 else
3371 {
3372 LogInfo("SendGroupUpdates:1: Parsed %d records and sending using %s, spaceleft %d, rrSize %d", nrecords, ARDisplayString(m, anchorRR), spaceleft, rrSize);
3373 SendGroupRRMessage(m, anchorRR, next, AuthInfo);
3374 }
3375 break; // breaks out of for loop
3376 }
3377 spaceleft -= rrSize;
3378 oldnext = next;
3379 LogInfo("SendGroupUpdates: Building a message with resource record %s, next %p, state %d, ttl %d", ARDisplayString(m, rr), next, rr->state, rr->resrec.rroriginalttl);
3380 if (!(next = BuildUpdateMessage(m, next, rr, limit)))
3381 {
3382 // We calculated the space and if we can't fit in, we had some bug in the calculation,
3383 // disable merge completely.
3384 LogMsg("SendGroupUpdates: ptr NULL while building message with %s", ARDisplayString(m, rr));
3385 RRMergeFailure(m);
3386 return mDNSfalse;
3387 }
3388 // If our estimate was higher, adjust to the actual size
3389 if ((next - oldnext) > rrSize)
3390 LogMsg("SendGroupUpdates: ERROR!! Record size estimation is wrong for %s, Estimate %d, Actual %d, state %d", ARDisplayString(m, rr), rrSize, next - oldnext, rr->state);
3391 else { spaceleft += rrSize; spaceleft -= (next - oldnext); }
3392
3393 nrecords++;
3394 // We could have sent an update earlier with this "rr" as anchorRR for which we never got a response.
3395 // To preserve ordering, we blow away the previous connection before sending this.
3396 if (rr->tcp) { DisposeTCPConn(rr->tcp); rr->tcp = mDNSNULL;}
3397 rr->updateid = msgid;
3398
3399 // By setting the retry time interval here, we will not be looking at these records
3400 // again when we return to CheckGroupRecordUpdates.
3401 SetRecordRetry(m, rr, 0);
3402 }
3403 // Either we have parsed all the records or stopped at "rr" above due to lack of space
3404 startRR = rr;
3405 }
3406
3407 if (anchorRR)
3408 {
3409 LogInfo("SendGroupUpdates: Parsed %d records and sending using %s", nrecords, ARDisplayString(m, anchorRR));
3410 SendGroupRRMessage(m, anchorRR, next, AuthInfo);
3411 }
3412 return sentallRecords;
3413 }
3414
3415 // Merge the record registrations and send them as a group only if they
3416 // have same DomainAuthInfo and hence the same key to put the TSIG
3417 mDNSlocal void CheckGroupRecordUpdates(mDNS *const m)
3418 {
3419 AuthRecord *rr, *nextRR;
3420 // Keep sending as long as there is at least one record to be sent
3421 while (MarkRRForSending(m))
3422 {
3423 if (!SendGroupUpdates(m))
3424 {
3425 // if everything that was marked was not sent, send them out individually
3426 for (rr = m->ResourceRecords; rr; rr = nextRR)
3427 {
3428 // SendRecordRegistrtion might delete the rr from list, hence
3429 // dereference nextRR before calling the function
3430 nextRR = rr->next;
3431 if (rr->SendRNow == uDNSInterfaceMark)
3432 {
3433 // Any records marked for sending should be eligible to be sent out
3434 // immediately. Just being cautious
3435 if (rr->LastAPTime + rr->ThisAPInterval - m->timenow > 0)
3436 { LogMsg("CheckGroupRecordUpdates: ERROR!! Resourcerecord %s not ready", ARDisplayString(m, rr)); continue; }
3437 rr->SendRNow = mDNSNULL;
3438 SendRecordRegistration(m, rr);
3439 }
3440 }
3441 }
3442 }
3443
3444 debugf("CheckGroupRecordUpdates: No work, returning");
3445 return;
3446 }
3447
3448 mDNSlocal void hndlSRVChanged(mDNS *const m, AuthRecord *rr)
3449 {
3450 // Reevaluate the target always as NAT/Target could have changed while
3451 // we were registering/deeregistering
3452 domainname *dt;
3453 const domainname *target = GetServiceTarget(m, rr);
3454 if (!target || target->c[0] == 0)
3455 {
3456 // we don't have a target, if we just derregistered, then we don't have to do anything
3457 if (rr->state == regState_DeregPending)
3458 {
3459 LogInfo("hndlSRVChanged: SRVChanged, No Target, SRV Deregistered for %##s, state %d", rr->resrec.name->c,
3460 rr->state);
3461 rr->SRVChanged = mDNSfalse;
3462 dt = GetRRDomainNameTarget(&rr->resrec);
3463 if (dt) dt->c[0] = 0;
3464 rr->state = regState_NoTarget; // Wait for the next target change
3465 rr->resrec.rdlength = rr->resrec.rdestimate = 0;
3466 return;
3467 }
3468
3469 // we don't have a target, if we just registered, we need to deregister
3470 if (rr->state == regState_Pending)
3471 {
3472 LogInfo("hndlSRVChanged: SRVChanged, No Target, Deregistering again %##s, state %d", rr->resrec.name->c, rr->state);
3473 rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
3474 rr->LastAPTime = m->timenow - INIT_RECORD_REG_INTERVAL;
3475 rr->state = regState_DeregPending;
3476 return;
3477 }
3478 LogInfo("hndlSRVChanged: Not in DeregPending or RegPending state %##s, state %d", rr->resrec.name->c, rr->state);
3479 }
3480 else
3481 {
3482 // If we were in registered state and SRV changed to NULL, we deregister and come back here
3483 // if we have a target, we need to register again.
3484 //
3485 // if we just registered check to see if it is same. If it is different just re-register the
3486 // SRV and its assoicated records
3487 //
3488 // UpdateOneSRVRecord takes care of re-registering all service records
3489 if ((rr->state == regState_DeregPending) ||
3490 (rr->state == regState_Pending && !SameDomainName(target, &rr->resrec.rdata->u.srv.target)))
3491 {
3492 dt = GetRRDomainNameTarget(&rr->resrec);
3493 if (dt) dt->c[0] = 0;
3494 rr->state = regState_NoTarget; // NoTarget will allow us to pick up new target OR nat traversal state
3495 rr->resrec.rdlength = rr->resrec.rdestimate = 0;
3496 LogInfo("hndlSRVChanged: SRVChanged, Valid Target %##s, Registering all records for %##s, state %d",
3497 target->c, rr->resrec.name->c, rr->state);
3498 rr->SRVChanged = mDNSfalse;
3499 UpdateOneSRVRecord(m, rr);
3500 return;
3501 }
3502 // Target did not change while this record was registering. Hence, we go to
3503 // Registered state - the state we started from.
3504 if (rr->state == regState_Pending) rr->state = regState_Registered;
3505 }
3506
3507 rr->SRVChanged = mDNSfalse;
3508 }
3509
3510 // Called with lock held
3511 mDNSlocal void hndlRecordUpdateReply(mDNS *m, AuthRecord *rr, mStatus err, mDNSu32 random)
3512 {
3513 mDNSBool InvokeCallback = mDNStrue;
3514 mDNSIPPort UpdatePort = zeroIPPort;
3515
3516 mDNS_CheckLock(m);
3517
3518 LogInfo("hndlRecordUpdateReply: err %d ID %d state %d %s(%p)", err, mDNSVal16(rr->updateid), rr->state, ARDisplayString(m, rr), rr);
3519
3520 rr->updateError = err;
3521 #if APPLE_OSX_mDNSResponder
3522 if (err == mStatus_BadSig || err == mStatus_BadKey || err == mStatus_BadTime) UpdateAutoTunnelDomainStatuses(m);
3523 #endif
3524
3525 SetRecordRetry(m, rr, random);
3526
3527 rr->updateid = zeroID; // Make sure that this is not considered as part of a group anymore
3528 // Later when need to send an update, we will get the zone data again. Thus we avoid
3529 // using stale information.
3530 //
3531 // Note: By clearing out the zone info here, it also helps better merging of records
3532 // in some cases. For example, when we get out regState_NoTarget state e.g., move out
3533 // of Double NAT, we want all the records to be in one update. Some BTMM records like
3534 // _autotunnel6 and host records are registered/deregistered when NAT state changes.
3535 // As they are re-registered the zone information is cleared out. To merge with other
3536 // records that might be possibly going out, clearing out the information here helps
3537 // as all of them try to get the zone data.
3538 if (rr->nta)
3539 {
3540 // We always expect the question to be stopped when we get a valid response from the server.
3541 // If the zone info tries to change during this time, updateid would be different and hence
3542 // this response should not have been accepted.
3543 if (rr->nta->question.ThisQInterval != -1)
3544 LogMsg("hndlRecordUpdateReply: ResourceRecord %s, zone info question %##s (%s) interval %d not -1",
3545 ARDisplayString(m, rr), rr->nta->question.qname.c, DNSTypeName(rr->nta->question.qtype), rr->nta->question.ThisQInterval);
3546 UpdatePort = rr->nta->Port;
3547 CancelGetZoneData(m, rr->nta);
3548 rr->nta = mDNSNULL;
3549 }
3550
3551 // If we are deregistering the record, then complete the deregistration. Ignore any NAT/SRV change
3552 // that could have happened during that time.
3553 if (rr->resrec.RecordType == kDNSRecordTypeDeregistering && rr->state == regState_DeregPending)
3554 {
3555 debugf("hndlRecordUpdateReply: Received reply for deregister record %##s type %d", rr->resrec.name->c, rr->resrec.rrtype);
3556 if (err) LogMsg("ERROR: Deregistration of record %##s type %d failed with error %d",
3557 rr->resrec.name->c, rr->resrec.rrtype, err);
3558 rr->state = regState_Unregistered;
3559 CompleteDeregistration(m, rr);
3560 return;
3561 }
3562
3563 // We are returning early without updating the state. When we come back from sleep we will re-register after
3564 // re-initializing all the state as though it is a first registration. If the record can't be registered e.g.,
3565 // no target, it will be deregistered. Hence, the updating to the right state should not matter when going
3566 // to sleep.
3567 if (m->SleepState)
3568 {
3569 // Need to set it to NoTarget state so that RecordReadyForSleep knows that
3570 // we are done
3571 if (rr->resrec.rrtype == kDNSType_SRV && rr->state == regState_DeregPending)
3572 rr->state = regState_NoTarget;
3573 return;
3574 }
3575
3576 if (rr->state == regState_UpdatePending)
3577 {
3578 if (err) LogMsg("Update record failed for %##s (err %d)", rr->resrec.name->c, err);
3579 rr->state = regState_Registered;
3580 // deallocate old RData
3581 if (rr->UpdateCallback) rr->UpdateCallback(m, rr, rr->OrigRData, rr->OrigRDLen);
3582 SetNewRData(&rr->resrec, rr->InFlightRData, rr->InFlightRDLen);
3583 rr->OrigRData = mDNSNULL;
3584 rr->InFlightRData = mDNSNULL;
3585 }
3586
3587 if (rr->SRVChanged)
3588 {
3589 if (rr->resrec.rrtype == kDNSType_SRV)
3590 hndlSRVChanged(m, rr);
3591 else
3592 {
3593 LogInfo("hndlRecordUpdateReply: Deregistered %##s (%s), state %d", rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype), rr->state);
3594 rr->SRVChanged = mDNSfalse;
3595 if (rr->state != regState_DeregPending) LogMsg("hndlRecordUpdateReply: ResourceRecord %s not in DeregPending state %d", ARDisplayString(m, rr), rr->state);
3596 rr->state = regState_NoTarget; // Wait for the next target change
3597 }
3598 return;
3599 }
3600
3601 if (rr->state == regState_Pending || rr->state == regState_Refresh)
3602 {
3603 if (!err)
3604 {
3605 if (rr->state == regState_Refresh) InvokeCallback = mDNSfalse;
3606 rr->state = regState_Registered;
3607 }
3608 else
3609 {
3610 // Retry without lease only for non-Private domains
3611 LogMsg("hndlRecordUpdateReply: Registration of record %##s type %d failed with error %d", rr->resrec.name->c, rr->resrec.rrtype, err);
3612 if (!rr->Private && rr->uselease && err == mStatus_UnknownErr && mDNSSameIPPort(UpdatePort, UnicastDNSPort))
3613 {
3614 LogMsg("hndlRecordUpdateReply: Will retry update of record %##s without lease option", rr->resrec.name->c);
3615 rr->uselease = mDNSfalse;
3616 rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
3617 rr->LastAPTime = m->timenow - INIT_RECORD_REG_INTERVAL;
3618 SetNextuDNSEvent(m, rr);
3619 return;
3620 }
3621 // Communicate the error to the application in the callback below
3622 }
3623 }
3624
3625 if (rr->QueuedRData && rr->state == regState_Registered)
3626 {
3627 rr->state = regState_UpdatePending;
3628 rr->InFlightRData = rr->QueuedRData;
3629 rr->InFlightRDLen = rr->QueuedRDLen;
3630 rr->OrigRData = rr->resrec.rdata;
3631 rr->OrigRDLen = rr->resrec.rdlength;
3632 rr->QueuedRData = mDNSNULL;
3633 rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
3634 rr->LastAPTime = m->timenow - INIT_RECORD_REG_INTERVAL;
3635 SetNextuDNSEvent(m, rr);
3636 return;
3637 }
3638
3639 // Don't invoke the callback on error as this may not be useful to the client.
3640 // The client may potentially delete the resource record on error which we normally
3641 // delete during deregistration
3642 if (!err && InvokeCallback && rr->RecordCallback)
3643 {
3644 LogInfo("hndlRecordUpdateReply: Calling record callback on %##s", rr->resrec.name->c);
3645 mDNS_DropLockBeforeCallback();
3646 rr->RecordCallback(m, rr, err);
3647 mDNS_ReclaimLockAfterCallback();
3648 }
3649 // CAUTION: MUST NOT do anything more with rr after calling rr->Callback(), because the client's callback function
3650 // is allowed to do anything, including starting/stopping queries, registering/deregistering records, etc.
3651 }
3652
3653 mDNSlocal void uDNS_ReceiveNATPMPPacket(mDNS *m, const mDNSInterfaceID InterfaceID, mDNSu8 *pkt, mDNSu16 len)
3654 {
3655 NATTraversalInfo *ptr;
3656 NATAddrReply *AddrReply = (NATAddrReply *)pkt;
3657 NATPortMapReply *PortMapReply = (NATPortMapReply *)pkt;
3658 mDNSu32 nat_elapsed, our_elapsed;
3659
3660 // Minimum NAT-PMP packet is vers (1) opcode (1) + err (2) = 4 bytes
3661 if (len < 4) { LogMsg("NAT-PMP message too short (%d bytes)", len); return; }
3662
3663 // Read multi-byte error value (field is identical in a NATPortMapReply)
3664 AddrReply->err = (mDNSu16) ((mDNSu16)pkt[2] << 8 | pkt[3]);
3665
3666 if (AddrReply->err == NATErr_Vers)
3667 {
3668 NATTraversalInfo *n;
3669 LogInfo("NAT-PMP version unsupported message received");
3670 for (n = m->NATTraversals; n; n=n->next)
3671 {
3672 // Send a NAT-PMP request for this operation as needed
3673 // and update the state variables
3674 uDNS_SendNATMsg(m, n, mDNSfalse, mDNSfalse);
3675 }
3676
3677 m->NextScheduledNATOp = m->timenow;
3678
3679 return;
3680 }
3681
3682 // The minimum reasonable NAT-PMP packet length is vers (1) + opcode (1) + err (2) + upseconds (4) = 8 bytes
3683 // If it's not at least this long, bail before we byte-swap the upseconds field & overrun our buffer.
3684 // The retry timer will ensure we converge to correctness.
3685 if (len < 8)
3686 {
3687 LogMsg("NAT-PMP message too short (%d bytes) 0x%X 0x%X", len, AddrReply->opcode, AddrReply->err);
3688 return;
3689 }
3690
3691 // Read multi-byte upseconds value (field is identical in a NATPortMapReply)
3692 AddrReply->upseconds = (mDNSs32) ((mDNSs32)pkt[4] << 24 | (mDNSs32)pkt[5] << 16 | (mDNSs32)pkt[6] << 8 | pkt[7]);
3693
3694 nat_elapsed = AddrReply->upseconds - m->LastNATupseconds;
3695 our_elapsed = (m->timenow - m->LastNATReplyLocalTime) / mDNSPlatformOneSecond;
3696 debugf("uDNS_ReceiveNATPMPPacket %X upseconds %u nat_elapsed %d our_elapsed %d", AddrReply->opcode, AddrReply->upseconds, nat_elapsed, our_elapsed);
3697
3698 // We compute a conservative estimate of how much the NAT gateways's clock should have advanced
3699 // 1. We subtract 12.5% from our own measured elapsed time, to allow for NAT gateways that have an inacurate clock that runs slowly
3700 // 2. We add a two-second safety margin to allow for rounding errors: e.g.
3701 // -- if NAT gateway sends a packet at t=2.000 seconds, then one at t=7.999, that's approximately 6 real seconds,
3702 // but based on the values in the packet (2,7) the apparent difference according to the packet is only 5 seconds
3703 // -- if we're slow handling packets and/or we have coarse clock granularity,
3704 // we could receive the t=2 packet at our t=1.999 seconds, which we round down to 1
3705 // and the t=7.999 packet at our t=8.000 seconds, which we record as 8,
3706 // giving an apparent local time difference of 7 seconds
3707 // The two-second safety margin coves this possible calculation discrepancy
3708 if (AddrReply->upseconds < m->LastNATupseconds || nat_elapsed + 2 < our_elapsed - our_elapsed/8)
3709 { LogMsg("NAT-PMP epoch time check failed: assuming NAT gateway %#a rebooted", &m->Router); RecreateNATMappings(m, 0); }
3710
3711 m->LastNATupseconds = AddrReply->upseconds;
3712 m->LastNATReplyLocalTime = m->timenow;
3713 #ifdef _LEGACY_NAT_TRAVERSAL_
3714 LNT_ClearState(m);
3715 #endif // _LEGACY_NAT_TRAVERSAL_
3716
3717 if (AddrReply->opcode == NATOp_AddrResponse)
3718 {
3719 #if APPLE_OSX_mDNSResponder
3720 LogInfo("uDNS_ReceiveNATPMPPacket: AddressRequest %s error %d", AddrReply->err ? "failure" : "success", AddrReply->err);
3721 #endif
3722 if (!AddrReply->err && len < sizeof(NATAddrReply)) { LogMsg("NAT-PMP AddrResponse message too short (%d bytes)", len); return; }
3723 natTraversalHandleAddressReply(m, AddrReply->err, AddrReply->ExtAddr);
3724 }
3725 else if (AddrReply->opcode == NATOp_MapUDPResponse || AddrReply->opcode == NATOp_MapTCPResponse)
3726 {
3727 mDNSu8 Protocol = AddrReply->opcode & 0x7F;
3728 #if APPLE_OSX_mDNSResponder
3729 LogInfo("uDNS_ReceiveNATPMPPacket: PortMapRequest %s %s - error %d",
3730 PortMapReply->err ? "failure" : "success", (AddrReply->opcode == NATOp_MapUDPResponse) ? "UDP" : "TCP", PortMapReply->err);
3731 #endif
3732 if (!PortMapReply->err)
3733 {
3734 if (len < sizeof(NATPortMapReply)) { LogMsg("NAT-PMP PortMapReply message too short (%d bytes)", len); return; }
3735 PortMapReply->NATRep_lease = (mDNSu32) ((mDNSu32)pkt[12] << 24 | (mDNSu32)pkt[13] << 16 | (mDNSu32)pkt[14] << 8 | pkt[15]);
3736 }
3737
3738 // Since some NAT-PMP server implementations don't return the requested internal port in
3739 // the reply, we can't associate this reply with a particular NATTraversalInfo structure.
3740 // We globally keep track of the most recent error code for mappings.
3741 m->LastNATMapResultCode = PortMapReply->err;
3742
3743 for (ptr = m->NATTraversals; ptr; ptr=ptr->next)
3744 if (ptr->Protocol == Protocol && mDNSSameIPPort(ptr->IntPort, PortMapReply->intport))
3745 natTraversalHandlePortMapReply(m, ptr, InterfaceID, PortMapReply->err, PortMapReply->extport, PortMapReply->NATRep_lease, NATTProtocolNATPMP);
3746 }
3747 else { LogMsg("Received NAT-PMP response with unknown opcode 0x%X", AddrReply->opcode); return; }
3748
3749 // Don't need an SSDP socket if we get a NAT-PMP packet
3750 if (m->SSDPSocket) { debugf("uDNS_ReceiveNATPMPPacket destroying SSDPSocket %p", &m->SSDPSocket); mDNSPlatformUDPClose(m->SSDPSocket); m->SSDPSocket = mDNSNULL; }
3751 }
3752
3753 mDNSlocal void uDNS_ReceivePCPPacket(mDNS *m, const mDNSInterfaceID InterfaceID, mDNSu8 *pkt, mDNSu16 len)
3754 {
3755 NATTraversalInfo *ptr;
3756 PCPMapReply *reply = (PCPMapReply*)pkt;
3757 mDNSu32 client_delta, server_delta;
3758 mDNSBool checkEpochValidity = m->LastNATupseconds != 0;
3759 mDNSu8 strippedOpCode;
3760 mDNSv4Addr mappedAddress = zerov4Addr;
3761 mDNSu8 protocol = 0;
3762 mDNSIPPort intport = zeroIPPort;
3763 mDNSIPPort extport = zeroIPPort;
3764
3765 // Minimum PCP packet is 24 bytes
3766 if (len < 24)
3767 {
3768 LogMsg("uDNS_ReceivePCPPacket: message too short (%d bytes)", len);
3769 return;
3770 }
3771
3772 strippedOpCode = reply->opCode & 0x7f;
3773
3774 if ((reply->opCode & 0x80) == 0x00 || (strippedOpCode != PCPOp_Announce && strippedOpCode != PCPOp_Map))
3775 {
3776 LogMsg("uDNS_ReceivePCPPacket: unhandled opCode %u", reply->opCode);
3777 return;
3778 }
3779
3780 // Read multi-byte values
3781 reply->lifetime = (mDNSs32)((mDNSs32)pkt[4] << 24 | (mDNSs32)pkt[5] << 16 | (mDNSs32)pkt[ 6] << 8 | pkt[ 7]);
3782 reply->epoch = (mDNSs32)((mDNSs32)pkt[8] << 24 | (mDNSs32)pkt[9] << 16 | (mDNSs32)pkt[10] << 8 | pkt[11]);
3783
3784 client_delta = (m->timenow - m->LastNATReplyLocalTime) / mDNSPlatformOneSecond;
3785 server_delta = reply->epoch - m->LastNATupseconds;
3786 debugf("uDNS_ReceivePCPPacket: %X %X upseconds %u client_delta %d server_delta %d", reply->opCode, reply->result, reply->epoch, client_delta, server_delta);
3787
3788 // If seconds since the epoch is 0, use 1 so we'll check epoch validity next time
3789 m->LastNATupseconds = reply->epoch ? reply->epoch : 1;
3790 m->LastNATReplyLocalTime = m->timenow;
3791
3792 #ifdef _LEGACY_NAT_TRAVERSAL_
3793 LNT_ClearState(m);
3794 #endif // _LEGACY_NAT_TRAVERSAL_
3795
3796 // Don't need an SSDP socket if we get a PCP packet
3797 if (m->SSDPSocket) { debugf("uDNS_ReceivePCPPacket: destroying SSDPSocket %p", &m->SSDPSocket); mDNSPlatformUDPClose(m->SSDPSocket); m->SSDPSocket = mDNSNULL; }
3798
3799 if (checkEpochValidity && (client_delta + 2 < server_delta - server_delta / 16 || server_delta + 2 < client_delta - client_delta / 16))
3800 {
3801 // If this is an ANNOUNCE packet, wait a random interval up to 5 seconds
3802 // otherwise, refresh immediately
3803 mDNSu32 waitTicks = strippedOpCode ? 0 : mDNSRandom(PCP_WAITSECS_AFTER_EPOCH_INVALID * mDNSPlatformOneSecond);
3804 LogMsg("uDNS_ReceivePCPPacket: Epoch invalid, %#a likely rebooted, waiting %u ticks", &m->Router, waitTicks);
3805 RecreateNATMappings(m, waitTicks);
3806 // we can ignore the rest of this packet, as new requests are about to go out
3807 return;
3808 }
3809
3810 if (strippedOpCode == PCPOp_Announce)
3811 return;
3812
3813 // We globally keep track of the most recent error code for mappings.
3814 // This seems bad to do with PCP, but best not change it now.
3815 m->LastNATMapResultCode = reply->result;
3816
3817 if (!reply->result)
3818 {
3819 if (len < sizeof(PCPMapReply))
3820 {
3821 LogMsg("uDNS_ReceivePCPPacket: mapping response too short (%d bytes)", len);
3822 return;
3823 }
3824
3825 // Check the nonce
3826 if (reply->nonce[0] != m->PCPNonce[0] || reply->nonce[1] != m->PCPNonce[1] || reply->nonce[2] != m->PCPNonce[2])
3827 {
3828 LogMsg("uDNS_ReceivePCPPacket: invalid nonce, ignoring. received { %x %x %x } expected { %x %x %x }",
3829 reply->nonce[0], reply->nonce[1], reply->nonce[2],
3830 m->PCPNonce[0], m->PCPNonce[1], m->PCPNonce[2]);
3831 return;
3832 }
3833
3834 // Get the values
3835 protocol = reply->protocol;
3836 intport = reply->intPort;
3837 extport = reply->extPort;
3838
3839 // Get the external address, which should be mapped, since we only support IPv4
3840 if (!mDNSAddrIPv4FromMappedIPv6(&reply->extAddress, &mappedAddress))
3841 {
3842 LogMsg("uDNS_ReceivePCPPacket: unexpected external address: %.16a", &reply->extAddress);
3843 reply->result = NATErr_NetFail;
3844 // fall through to report the error
3845 }
3846 else if (mDNSIPv4AddressIsZero(mappedAddress))
3847 {
3848 // If this is the deletion case, we will have sent the zero IPv4-mapped address
3849 // in our request, and the server should reflect it in the response, so we
3850 // should not log about receiving a zero address. And in this case, we no
3851 // longer have a NATTraversal to report errors back to, so it's ok to set the
3852 // result here.
3853 // In other cases, a zero address is an error, and we will have a NATTraversal
3854 // to report back to, so set an error and fall through to report it.
3855 // CheckNATMappings will log the error.
3856 reply->result = NATErr_NetFail;
3857 }
3858 }
3859 else
3860 {
3861 LogInfo("uDNS_ReceivePCPPacket: error received from server. opcode %X result %X lifetime %X epoch %X",
3862 reply->opCode, reply->result, reply->lifetime, reply->epoch);
3863
3864 // If the packet is long enough, get the protocol & intport for matching to report
3865 // the error
3866 if (len >= sizeof(PCPMapReply))
3867 {
3868 protocol = reply->protocol;
3869 intport = reply->intPort;
3870 }
3871 }
3872
3873 for (ptr = m->NATTraversals; ptr; ptr=ptr->next)
3874 {
3875 mDNSu8 ptrProtocol = ((ptr->Protocol & NATOp_MapTCP) == NATOp_MapTCP ? PCPProto_TCP : PCPProto_UDP);
3876 if ((protocol == ptrProtocol && mDNSSameIPPort(ptr->IntPort, intport)) ||
3877 (!ptr->Protocol && protocol == PCPProto_TCP && mDNSSameIPPort(DiscardPort, intport)))
3878 {
3879 natTraversalHandlePortMapReplyWithAddress(m, ptr, InterfaceID, reply->result ? NATErr_NetFail : NATErr_None, mappedAddress, extport, reply->lifetime, NATTProtocolPCP);
3880 }
3881 }
3882 }
3883
3884 mDNSexport void uDNS_ReceiveNATPacket(mDNS *m, const mDNSInterfaceID InterfaceID, mDNSu8 *pkt, mDNSu16 len)
3885 {
3886 if (len == 0)
3887 LogMsg("uDNS_ReceiveNATPacket: zero length packet");
3888 else if (pkt[0] == PCP_VERS)
3889 uDNS_ReceivePCPPacket(m, InterfaceID, pkt, len);
3890 else if (pkt[0] == NATMAP_VERS)
3891 uDNS_ReceiveNATPMPPacket(m, InterfaceID, pkt, len);
3892 else
3893 LogMsg("uDNS_ReceiveNATPacket: packet with version %u (expected %u or %u)", pkt[0], PCP_VERS, NATMAP_VERS);
3894 }
3895
3896 // Called from mDNSCoreReceive with the lock held
3897 mDNSexport void uDNS_ReceiveMsg(mDNS *const m, DNSMessage *const msg, const mDNSu8 *const end, const mDNSAddr *const srcaddr, const mDNSIPPort srcport)
3898 {
3899 DNSQuestion *qptr;
3900 mStatus err = mStatus_NoError;
3901
3902 mDNSu8 StdR = kDNSFlag0_QR_Response | kDNSFlag0_OP_StdQuery;
3903 mDNSu8 UpdateR = kDNSFlag0_QR_Response | kDNSFlag0_OP_Update;
3904 mDNSu8 QR_OP = (mDNSu8)(msg->h.flags.b[0] & kDNSFlag0_QROP_Mask);
3905 mDNSu8 rcode = (mDNSu8)(msg->h.flags.b[1] & kDNSFlag1_RC_Mask);
3906
3907 (void)srcport; // Unused
3908
3909 debugf("uDNS_ReceiveMsg from %#-15a with "
3910 "%2d Question%s %2d Answer%s %2d Authorit%s %2d Additional%s %d bytes",
3911 srcaddr,
3912 msg->h.numQuestions, msg->h.numQuestions == 1 ? ", " : "s,",
3913 msg->h.numAnswers, msg->h.numAnswers == 1 ? ", " : "s,",
3914 msg->h.numAuthorities, msg->h.numAuthorities == 1 ? "y, " : "ies,",
3915 msg->h.numAdditionals, msg->h.numAdditionals == 1 ? "" : "s", end - msg->data);
3916 #if APPLE_OSX_mDNSResponder
3917 if (NumUnreachableDNSServers > 0)
3918 SymptomReporterDNSServerReachable(m, srcaddr);
3919 #endif
3920
3921 if (QR_OP == StdR)
3922 {
3923 //if (srcaddr && recvLLQResponse(m, msg, end, srcaddr, srcport)) return;
3924 for (qptr = m->Questions; qptr; qptr = qptr->next)
3925 if (msg->h.flags.b[0] & kDNSFlag0_TC && mDNSSameOpaque16(qptr->TargetQID, msg->h.id) && m->timenow - qptr->LastQTime < RESPONSE_WINDOW)
3926 {
3927 if (!srcaddr) LogMsg("uDNS_ReceiveMsg: TCP DNS response had TC bit set: ignoring");
3928 else uDNS_RestartQuestionAsTCP(m, qptr, srcaddr, srcport);
3929 }
3930 }
3931
3932 if (QR_OP == UpdateR)
3933 {
3934 mDNSu32 pktlease = 0;
3935 mDNSBool gotlease = GetPktLease(m, msg, end, &pktlease);
3936 mDNSu32 lease = gotlease ? pktlease : 60 * 60; // If lease option missing, assume one hour
3937 mDNSs32 expire = m->timenow + (mDNSs32)lease * mDNSPlatformOneSecond;
3938 mDNSu32 random = mDNSRandom((mDNSs32)lease * mDNSPlatformOneSecond/10);
3939
3940 //rcode = kDNSFlag1_RC_ServFail; // Simulate server failure (rcode 2)
3941
3942 // Walk through all the records that matches the messageID. There could be multiple
3943 // records if we had sent them in a group
3944 if (m->CurrentRecord)
3945 LogMsg("uDNS_ReceiveMsg ERROR m->CurrentRecord already set %s", ARDisplayString(m, m->CurrentRecord));
3946 m->CurrentRecord = m->ResourceRecords;
3947 while (m->CurrentRecord)
3948 {
3949 AuthRecord *rptr = m->CurrentRecord;
3950 m->CurrentRecord = m->CurrentRecord->next;
3951 if (AuthRecord_uDNS(rptr) && mDNSSameOpaque16(rptr->updateid, msg->h.id))
3952 {
3953 err = checkUpdateResult(m, rptr->resrec.name, rcode, msg, end);
3954 if (!err && rptr->uselease && lease)
3955 if (rptr->expire - expire >= 0 || rptr->state != regState_UpdatePending)
3956 {
3957 rptr->expire = expire;
3958 rptr->refreshCount = 0;
3959 }
3960 // We pass the random value to make sure that if we update multiple
3961 // records, they all get the same random value
3962 hndlRecordUpdateReply(m, rptr, err, random);
3963 }
3964 }
3965 }
3966 debugf("Received unexpected response: ID %d matches no active records", mDNSVal16(msg->h.id));
3967 }
3968
3969 // ***************************************************************************
3970 #if COMPILER_LIKES_PRAGMA_MARK
3971 #pragma mark - Query Routines
3972 #endif
3973
3974 mDNSexport void sendLLQRefresh(mDNS *m, DNSQuestion *q)
3975 {
3976 mDNSu8 *end;
3977 LLQOptData llq;
3978 mDNSu8 *limit = m->omsg.data + AbsoluteMaxDNSMessageData;
3979
3980 if (q->ReqLease)
3981 if ((q->state == LLQ_Established && q->ntries >= kLLQ_MAX_TRIES) || q->expire - m->timenow < 0)
3982 {
3983 LogMsg("Unable to refresh LLQ %##s (%s) - will retry in %d seconds", q->qname.c, DNSTypeName(q->qtype), LLQ_POLL_INTERVAL / mDNSPlatformOneSecond);
3984 StartLLQPolling(m,q);
3985 return;
3986 }
3987
3988 llq.vers = kLLQ_Vers;
3989 llq.llqOp = kLLQOp_Refresh;
3990 llq.err = q->tcp ? GetLLQEventPort(m, &q->servAddr) : LLQErr_NoError; // If using TCP tell server what UDP port to send notifications to
3991 llq.id = q->id;
3992 llq.llqlease = q->ReqLease;
3993
3994 InitializeDNSMessage(&m->omsg.h, q->TargetQID, uQueryFlags);
3995 end = putLLQ(&m->omsg, m->omsg.data, q, &llq);
3996 if (!end) { LogMsg("sendLLQRefresh: putLLQ failed %##s (%s)", q->qname.c, DNSTypeName(q->qtype)); return; }
3997
3998 // Note that we (conditionally) add HINFO and TSIG here, since the question might be going away,
3999 // so we may not be able to reference it (most importantly it's AuthInfo) when we actually send the message
4000 end = putHINFO(m, &m->omsg, end, q->AuthInfo, limit);
4001 if (!end) { LogMsg("sendLLQRefresh: putHINFO failed %##s (%s)", q->qname.c, DNSTypeName(q->qtype)); return; }
4002
4003 if (PrivateQuery(q))
4004 {
4005 DNSDigest_SignMessageHostByteOrder(&m->omsg, &end, q->AuthInfo);
4006 if (!end) { LogMsg("sendLLQRefresh: DNSDigest_SignMessage failed %##s (%s)", q->qname.c, DNSTypeName(q->qtype)); return; }
4007 }
4008
4009 if (PrivateQuery(q) && !q->tcp)
4010 {
4011 LogInfo("sendLLQRefresh setting up new TLS session %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4012 if (!q->nta)
4013 {
4014 // Note: If a question is in LLQ_Established state, we never free the zone data for the
4015 // question (PrivateQuery). If we free, we reset the state to something other than LLQ_Established.
4016 // This function is called only if the query is in LLQ_Established state and hence nta should
4017 // never be NULL. In spite of that, we have seen q->nta being NULL in the field. Just refetch the
4018 // zone data in that case.
4019 q->nta = StartGetZoneData(m, &q->qname, ZoneServiceLLQ, LLQGotZoneData, q);
4020 return;
4021 // ThisQInterval is not adjusted when we return from here which means that we will get called back
4022 // again immediately. As q->servAddr and q->servPort are still valid and the nta->Host is initialized
4023 // without any additional discovery for PrivateQuery, things work.
4024 }
4025 q->tcp = MakeTCPConn(m, &m->omsg, end, kTCPSocketFlags_UseTLS, &q->servAddr, q->servPort, &q->nta->Host, q, mDNSNULL);
4026 }
4027 else
4028 {
4029 mStatus err;
4030
4031 // if AuthInfo and AuthInfo->AutoTunnel is set, we use the TCP socket but don't need to pass the AuthInfo as
4032 // we already protected the message above.
4033 LogInfo("sendLLQRefresh: using existing %s session %##s (%s)", PrivateQuery(q) ? "TLS" : "UDP",
4034 q->qname.c, DNSTypeName(q->qtype));
4035
4036 err = mDNSSendDNSMessage(m, &m->omsg, end, mDNSInterface_Any, q->LocalSocket, &q->servAddr, q->servPort, q->tcp ? q->tcp->sock : mDNSNULL, mDNSNULL, mDNSfalse);
4037 if (err)
4038 {
4039 LogMsg("sendLLQRefresh: mDNSSendDNSMessage%s failed: %d", q->tcp ? " (TCP)" : "", err);
4040 if (q->tcp) { DisposeTCPConn(q->tcp); q->tcp = mDNSNULL; }
4041 }
4042 }
4043
4044 q->ntries++;
4045
4046 debugf("sendLLQRefresh ntries %d %##s (%s)", q->ntries, q->qname.c, DNSTypeName(q->qtype));
4047
4048 q->LastQTime = m->timenow;
4049 SetNextQueryTime(m, q);
4050 }
4051
4052 mDNSexport void LLQGotZoneData(mDNS *const m, mStatus err, const ZoneData *zoneInfo)
4053 {
4054 DNSQuestion *q = (DNSQuestion *)zoneInfo->ZoneDataContext;
4055
4056 mDNS_Lock(m);
4057
4058 // If we get here it means that the GetZoneData operation has completed.
4059 // We hold on to the zone data if it is AutoTunnel as we use the hostname
4060 // in zoneInfo during the TLS connection setup.
4061 q->servAddr = zeroAddr;
4062 q->servPort = zeroIPPort;
4063
4064 if (!err && !mDNSIPPortIsZero(zoneInfo->Port) && !mDNSAddressIsZero(&zoneInfo->Addr) && zoneInfo->Host.c[0])
4065 {
4066 q->servAddr = zoneInfo->Addr;
4067 q->servPort = zoneInfo->Port;
4068 if (!PrivateQuery(q))
4069 {
4070 // We don't need the zone data as we use it only for the Host information which we
4071 // don't need if we are not going to use TLS connections.
4072 if (q->nta)
4073 {
4074 if (q->nta != zoneInfo) LogMsg("LLQGotZoneData: nta (%p) != zoneInfo (%p) %##s (%s)", q->nta, zoneInfo, q->qname.c, DNSTypeName(q->qtype));
4075 CancelGetZoneData(m, q->nta);
4076 q->nta = mDNSNULL;
4077 }
4078 }
4079 q->ntries = 0;
4080 debugf("LLQGotZoneData %#a:%d", &q->servAddr, mDNSVal16(q->servPort));
4081 startLLQHandshake(m, q);
4082 }
4083 else
4084 {
4085 if (q->nta)
4086 {
4087 if (q->nta != zoneInfo) LogMsg("LLQGotZoneData: nta (%p) != zoneInfo (%p) %##s (%s)", q->nta, zoneInfo, q->qname.c, DNSTypeName(q->qtype));
4088 CancelGetZoneData(m, q->nta);
4089 q->nta = mDNSNULL;
4090 }
4091 StartLLQPolling(m,q);
4092 if (err == mStatus_NoSuchNameErr)
4093 {
4094 // this actually failed, so mark it by setting address to all ones
4095 q->servAddr.type = mDNSAddrType_IPv4;
4096 q->servAddr.ip.v4 = onesIPv4Addr;
4097 }
4098 }
4099
4100 mDNS_Unlock(m);
4101 }
4102
4103 #ifdef DNS_PUSH_ENABLED
4104 mDNSexport void DNSPushNotificationGotZoneData(mDNS *const m, mStatus err, const ZoneData *zoneInfo)
4105 {
4106 DNSQuestion *q = (DNSQuestion *)zoneInfo->ZoneDataContext;
4107 mDNS_Lock(m);
4108
4109 // If we get here it means that the GetZoneData operation has completed.
4110 // We hold on to the zone data if it is AutoTunnel as we use the hostname
4111 // in zoneInfo during the TLS connection setup.
4112 q->servAddr = zeroAddr;
4113 q->servPort = zeroIPPort;
4114 if (!err && zoneInfo && !mDNSIPPortIsZero(zoneInfo->Port) && !mDNSAddressIsZero(&zoneInfo->Addr) && zoneInfo->Host.c[0])
4115 {
4116 q->dnsPushState = DNSPUSH_SERVERFOUND;
4117 q->dnsPushServerAddr = zoneInfo->Addr;
4118 q->dnsPushServerPort = zoneInfo->Port;
4119 q->ntries = 0;
4120 LogInfo("DNSPushNotificationGotZoneData %#a:%d", &q->dnsPushServerAddr, mDNSVal16(q->dnsPushServerPort));
4121 SubscribeToDNSPushNotificationServer(m,q);
4122 }
4123 else
4124 {
4125 q->dnsPushState = DNSPUSH_NOSERVER;
4126 StartLLQPolling(m,q);
4127 if (err == mStatus_NoSuchNameErr)
4128 {
4129 // this actually failed, so mark it by setting address to all ones
4130 q->servAddr.type = mDNSAddrType_IPv4;
4131 q->servAddr.ip.v4 = onesIPv4Addr;
4132 }
4133 }
4134 mDNS_Unlock(m);
4135 }
4136 #endif // DNS_PUSH_ENABLED
4137
4138 // Called in normal callback context (i.e. mDNS_busy and mDNS_reentrancy are both 1)
4139 mDNSlocal void PrivateQueryGotZoneData(mDNS *const m, mStatus err, const ZoneData *zoneInfo)
4140 {
4141 DNSQuestion *q = (DNSQuestion *) zoneInfo->ZoneDataContext;
4142
4143 LogInfo("PrivateQueryGotZoneData %##s (%s) err %d Zone %##s Private %d", q->qname.c, DNSTypeName(q->qtype), err, zoneInfo->ZoneName.c, zoneInfo->ZonePrivate);
4144
4145 if (q->nta != zoneInfo) LogMsg("PrivateQueryGotZoneData:ERROR!!: nta (%p) != zoneInfo (%p) %##s (%s)", q->nta, zoneInfo, q->qname.c, DNSTypeName(q->qtype));
4146
4147 if (err || !zoneInfo || mDNSAddressIsZero(&zoneInfo->Addr) || mDNSIPPortIsZero(zoneInfo->Port) || !zoneInfo->Host.c[0])
4148 {
4149 LogInfo("PrivateQueryGotZoneData: ERROR!! %##s (%s) invoked with error code %d %p %#a:%d",
4150 q->qname.c, DNSTypeName(q->qtype), err, zoneInfo,
4151 zoneInfo ? &zoneInfo->Addr : mDNSNULL,
4152 zoneInfo ? mDNSVal16(zoneInfo->Port) : 0);
4153 CancelGetZoneData(m, q->nta);
4154 q->nta = mDNSNULL;
4155 return;
4156 }
4157
4158 if (!zoneInfo->ZonePrivate)
4159 {
4160 debugf("Private port lookup failed -- retrying without TLS -- %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4161 q->AuthInfo = mDNSNULL; // Clear AuthInfo so we try again non-private
4162 q->ThisQInterval = InitialQuestionInterval;
4163 q->LastQTime = m->timenow - q->ThisQInterval;
4164 CancelGetZoneData(m, q->nta);
4165 q->nta = mDNSNULL;
4166 mDNS_Lock(m);
4167 SetNextQueryTime(m, q);
4168 mDNS_Unlock(m);
4169 return;
4170 // Next call to uDNS_CheckCurrentQuestion() will do this as a non-private query
4171 }
4172
4173 if (!PrivateQuery(q))
4174 {
4175 LogMsg("PrivateQueryGotZoneData: ERROR!! Not a private query %##s (%s) AuthInfo %p", q->qname.c, DNSTypeName(q->qtype), q->AuthInfo);
4176 CancelGetZoneData(m, q->nta);
4177 q->nta = mDNSNULL;
4178 return;
4179 }
4180
4181 q->TargetQID = mDNS_NewMessageID(m);
4182 if (q->tcp) { DisposeTCPConn(q->tcp); q->tcp = mDNSNULL; }
4183 if (!q->nta) { LogMsg("PrivateQueryGotZoneData:ERROR!! nta is NULL for %##s (%s)", q->qname.c, DNSTypeName(q->qtype)); return; }
4184 q->tcp = MakeTCPConn(m, mDNSNULL, mDNSNULL, kTCPSocketFlags_UseTLS, &zoneInfo->Addr, zoneInfo->Port, &q->nta->Host, q, mDNSNULL);
4185 if (q->nta) { CancelGetZoneData(m, q->nta); q->nta = mDNSNULL; }
4186 }
4187
4188 // ***************************************************************************
4189 #if COMPILER_LIKES_PRAGMA_MARK
4190 #pragma mark - Dynamic Updates
4191 #endif
4192
4193 // Called in normal callback context (i.e. mDNS_busy and mDNS_reentrancy are both 1)
4194 mDNSexport void RecordRegistrationGotZoneData(mDNS *const m, mStatus err, const ZoneData *zoneData)
4195 {
4196 AuthRecord *newRR;
4197 AuthRecord *ptr;
4198 int c1, c2;
4199
4200 if (!zoneData) { LogMsg("ERROR: RecordRegistrationGotZoneData invoked with NULL result and no error"); return; }
4201
4202 newRR = (AuthRecord*)zoneData->ZoneDataContext;
4203
4204 if (newRR->nta != zoneData)
4205 LogMsg("RecordRegistrationGotZoneData: nta (%p) != zoneData (%p) %##s (%s)", newRR->nta, zoneData, newRR->resrec.name->c, DNSTypeName(newRR->resrec.rrtype));
4206
4207 if (m->mDNS_busy != m->mDNS_reentrancy)
4208 LogMsg("RecordRegistrationGotZoneData: mDNS_busy (%ld) != mDNS_reentrancy (%ld)", m->mDNS_busy, m->mDNS_reentrancy);
4209
4210 // make sure record is still in list (!!!)
4211 for (ptr = m->ResourceRecords; ptr; ptr = ptr->next) if (ptr == newRR) break;
4212 if (!ptr)
4213 {
4214 LogMsg("RecordRegistrationGotZoneData - RR no longer in list. Discarding.");
4215 CancelGetZoneData(m, newRR->nta);
4216 newRR->nta = mDNSNULL;
4217 return;
4218 }
4219
4220 // check error/result
4221 if (err)
4222 {
4223 if (err != mStatus_NoSuchNameErr) LogMsg("RecordRegistrationGotZoneData: error %d", err);
4224 CancelGetZoneData(m, newRR->nta);
4225 newRR->nta = mDNSNULL;
4226 return;
4227 }
4228
4229 if (newRR->resrec.rrclass != zoneData->ZoneClass)
4230 {
4231 LogMsg("ERROR: New resource record's class (%d) does not match zone class (%d)", newRR->resrec.rrclass, zoneData->ZoneClass);
4232 CancelGetZoneData(m, newRR->nta);
4233 newRR->nta = mDNSNULL;
4234 return;
4235 }
4236
4237 // Don't try to do updates to the root name server.
4238 // We might be tempted also to block updates to any single-label name server (e.g. com, edu, net, etc.) but some
4239 // organizations use their own private pseudo-TLD, like ".home", etc, and we don't want to block that.
4240 if (zoneData->ZoneName.c[0] == 0)
4241 {
4242 LogInfo("RecordRegistrationGotZoneData: No name server found claiming responsibility for \"%##s\"!", newRR->resrec.name->c);
4243 CancelGetZoneData(m, newRR->nta);
4244 newRR->nta = mDNSNULL;
4245 return;
4246 }
4247
4248 // Store discovered zone data
4249 c1 = CountLabels(newRR->resrec.name);
4250 c2 = CountLabels(&zoneData->ZoneName);
4251 if (c2 > c1)
4252 {
4253 LogMsg("RecordRegistrationGotZoneData: Zone \"%##s\" is longer than \"%##s\"", zoneData->ZoneName.c, newRR->resrec.name->c);
4254 CancelGetZoneData(m, newRR->nta);
4255 newRR->nta = mDNSNULL;
4256 return;
4257 }
4258 newRR->zone = SkipLeadingLabels(newRR->resrec.name, c1-c2);
4259 if (!SameDomainName(newRR->zone, &zoneData->ZoneName))
4260 {
4261 LogMsg("RecordRegistrationGotZoneData: Zone \"%##s\" does not match \"%##s\" for \"%##s\"", newRR->zone->c, zoneData->ZoneName.c, newRR->resrec.name->c);
4262 CancelGetZoneData(m, newRR->nta);
4263 newRR->nta = mDNSNULL;
4264 return;
4265 }
4266
4267 if (mDNSIPPortIsZero(zoneData->Port) || mDNSAddressIsZero(&zoneData->Addr) || !zoneData->Host.c[0])
4268 {
4269 LogInfo("RecordRegistrationGotZoneData: No _dns-update._udp service found for \"%##s\"!", newRR->resrec.name->c);
4270 CancelGetZoneData(m, newRR->nta);
4271 newRR->nta = mDNSNULL;
4272 return;
4273 }
4274
4275 newRR->Private = zoneData->ZonePrivate;
4276 debugf("RecordRegistrationGotZoneData: Set zone information for %##s %##s to %#a:%d",
4277 newRR->resrec.name->c, zoneData->ZoneName.c, &zoneData->Addr, mDNSVal16(zoneData->Port));
4278
4279 // If we are deregistering, uDNS_DeregisterRecord will do that as it has the zone data now.
4280 if (newRR->state == regState_DeregPending)
4281 {
4282 mDNS_Lock(m);
4283 uDNS_DeregisterRecord(m, newRR);
4284 mDNS_Unlock(m);
4285 return;
4286 }
4287
4288 if (newRR->resrec.rrtype == kDNSType_SRV)
4289 {
4290 const domainname *target;
4291 // Reevaluate the target always as NAT/Target could have changed while
4292 // we were fetching zone data.
4293 mDNS_Lock(m);
4294 target = GetServiceTarget(m, newRR);
4295 mDNS_Unlock(m);
4296 if (!target || target->c[0] == 0)
4297 {
4298 domainname *t = GetRRDomainNameTarget(&newRR->resrec);
4299 LogInfo("RecordRegistrationGotZoneData - no target for %##s", newRR->resrec.name->c);
4300 if (t) t->c[0] = 0;
4301 newRR->resrec.rdlength = newRR->resrec.rdestimate = 0;
4302 newRR->state = regState_NoTarget;
4303 CancelGetZoneData(m, newRR->nta);
4304 newRR->nta = mDNSNULL;
4305 return;
4306 }
4307 }
4308 // If we have non-zero service port (always?)
4309 // and a private address, and update server is non-private
4310 // and this service is AutoTarget
4311 // then initiate a NAT mapping request. On completion it will do SendRecordRegistration() for us
4312 if (newRR->resrec.rrtype == kDNSType_SRV && !mDNSIPPortIsZero(newRR->resrec.rdata->u.srv.port) &&
4313 mDNSv4AddrIsRFC1918(&m->AdvertisedV4.ip.v4) && newRR->nta && !mDNSAddrIsRFC1918(&newRR->nta->Addr) &&
4314 newRR->AutoTarget == Target_AutoHostAndNATMAP)
4315 {
4316 DomainAuthInfo *AuthInfo;
4317 AuthInfo = GetAuthInfoForName(m, newRR->resrec.name);
4318 if (AuthInfo && AuthInfo->AutoTunnel)
4319 {
4320 domainname *t = GetRRDomainNameTarget(&newRR->resrec);
4321 LogMsg("RecordRegistrationGotZoneData: ERROR!! AutoTunnel has Target_AutoHostAndNATMAP for %s", ARDisplayString(m, newRR));
4322 if (t) t->c[0] = 0;
4323 newRR->resrec.rdlength = newRR->resrec.rdestimate = 0;
4324 newRR->state = regState_NoTarget;
4325 CancelGetZoneData(m, newRR->nta);
4326 newRR->nta = mDNSNULL;
4327 return;
4328 }
4329 // During network transitions, we are called multiple times in different states. Setup NAT
4330 // state just once for this record.
4331 if (!newRR->NATinfo.clientContext)
4332 {
4333 LogInfo("RecordRegistrationGotZoneData StartRecordNatMap %s", ARDisplayString(m, newRR));
4334 newRR->state = regState_NATMap;
4335 StartRecordNatMap(m, newRR);
4336 return;
4337 }
4338 else LogInfo("RecordRegistrationGotZoneData: StartRecordNatMap for %s, state %d, context %p", ARDisplayString(m, newRR), newRR->state, newRR->NATinfo.clientContext);
4339 }
4340 mDNS_Lock(m);
4341 // We want IsRecordMergeable to check whether it is a record whose update can be
4342 // sent with others. We set the time before we call IsRecordMergeable, so that
4343 // it does not fail this record based on time. We are interested in other checks
4344 // at this time. If a previous update resulted in error, then don't reset the
4345 // interval. Preserve the back-off so that we don't keep retrying aggressively.
4346 if (newRR->updateError == mStatus_NoError)
4347 {
4348 newRR->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
4349 newRR->LastAPTime = m->timenow - INIT_RECORD_REG_INTERVAL;
4350 }
4351 if (IsRecordMergeable(m, newRR, m->timenow + MERGE_DELAY_TIME))
4352 {
4353 // Delay the record registration by MERGE_DELAY_TIME so that we can merge them
4354 // into one update
4355 LogInfo("RecordRegistrationGotZoneData: Delayed registration for %s", ARDisplayString(m, newRR));
4356 newRR->LastAPTime += MERGE_DELAY_TIME;
4357 }
4358 mDNS_Unlock(m);
4359 }
4360
4361 mDNSlocal void SendRecordDeregistration(mDNS *m, AuthRecord *rr)
4362 {
4363 mDNSu8 *ptr = m->omsg.data;
4364 mDNSu8 *limit;
4365 DomainAuthInfo *AuthInfo;
4366
4367 mDNS_CheckLock(m);
4368
4369 if (!rr->nta || mDNSIPv4AddressIsZero(rr->nta->Addr.ip.v4))
4370 {
4371 LogMsg("SendRecordDeRegistration: No zone info for Resource record %s RecordType %d", ARDisplayString(m, rr), rr->resrec.RecordType);
4372 return;
4373 }
4374
4375 limit = ptr + AbsoluteMaxDNSMessageData;
4376 AuthInfo = GetAuthInfoForName_internal(m, rr->resrec.name);
4377 limit -= RRAdditionalSize(m, AuthInfo);
4378
4379 rr->updateid = mDNS_NewMessageID(m);
4380 InitializeDNSMessage(&m->omsg.h, rr->updateid, UpdateReqFlags);
4381
4382 // set zone
4383 ptr = putZone(&m->omsg, ptr, limit, rr->zone, mDNSOpaque16fromIntVal(rr->resrec.rrclass));
4384 if (!ptr) goto exit;
4385
4386 ptr = BuildUpdateMessage(m, ptr, rr, limit);
4387
4388 if (!ptr) goto exit;
4389
4390 if (rr->Private)
4391 {
4392 LogInfo("SendRecordDeregistration TCP %p %s", rr->tcp, ARDisplayString(m, rr));
4393 if (rr->tcp) LogInfo("SendRecordDeregistration: Disposing existing TCP connection for %s", ARDisplayString(m, rr));
4394 if (rr->tcp) { DisposeTCPConn(rr->tcp); rr->tcp = mDNSNULL; }
4395 if (!rr->nta) { LogMsg("SendRecordDeregistration:Private:ERROR!! nta is NULL for %s", ARDisplayString(m, rr)); return; }
4396 rr->tcp = MakeTCPConn(m, &m->omsg, ptr, kTCPSocketFlags_UseTLS, &rr->nta->Addr, rr->nta->Port, &rr->nta->Host, mDNSNULL, rr);
4397 }
4398 else
4399 {
4400 mStatus err;
4401 LogInfo("SendRecordDeregistration UDP %s", ARDisplayString(m, rr));
4402 if (!rr->nta) { LogMsg("SendRecordDeregistration:ERROR!! nta is NULL for %s", ARDisplayString(m, rr)); return; }
4403 err = mDNSSendDNSMessage(m, &m->omsg, ptr, mDNSInterface_Any, mDNSNULL, &rr->nta->Addr, rr->nta->Port, mDNSNULL, GetAuthInfoForName_internal(m, rr->resrec.name), mDNSfalse);
4404 if (err) debugf("ERROR: SendRecordDeregistration - mDNSSendDNSMessage - %d", err);
4405 //if (rr->state == regState_DeregPending) CompleteDeregistration(m, rr); // Don't touch rr after this
4406 }
4407 SetRecordRetry(m, rr, 0);
4408 return;
4409 exit:
4410 LogMsg("SendRecordDeregistration: Error formatting message for %s", ARDisplayString(m, rr));
4411 }
4412
4413 mDNSexport mStatus uDNS_DeregisterRecord(mDNS *const m, AuthRecord *const rr)
4414 {
4415 DomainAuthInfo *info;
4416
4417 LogInfo("uDNS_DeregisterRecord: Resource Record %s, state %d", ARDisplayString(m, rr), rr->state);
4418
4419 switch (rr->state)
4420 {
4421 case regState_Refresh:
4422 case regState_Pending:
4423 case regState_UpdatePending:
4424 case regState_Registered: break;
4425 case regState_DeregPending: break;
4426
4427 case regState_NATError:
4428 case regState_NATMap:
4429 // A record could be in NoTarget to start with if the corresponding SRV record could not find a target.
4430 // It is also possible to reenter the NoTarget state when we move to a network with a NAT that has
4431 // no {PCP, NAT-PMP, UPnP/IGD} support. In that case before we entered NoTarget, we already deregistered with
4432 // the server.
4433 case regState_NoTarget:
4434 case regState_Unregistered:
4435 case regState_Zero:
4436 default:
4437 LogInfo("uDNS_DeregisterRecord: State %d for %##s type %s", rr->state, rr->resrec.name->c, DNSTypeName(rr->resrec.rrtype));
4438 // This function may be called during sleep when there are no sleep proxy servers
4439 if (rr->resrec.RecordType == kDNSRecordTypeDeregistering) CompleteDeregistration(m, rr);
4440 return mStatus_NoError;
4441 }
4442
4443 // if unsent rdata is queued, free it.
4444 //
4445 // The data may be queued in QueuedRData or InFlightRData.
4446 //
4447 // 1) If the record is in Registered state, we store it in InFlightRData and copy the same in "rdata"
4448 // *just* before sending the update to the server. Till we get the response, InFlightRData and "rdata"
4449 // in the resource record are same. We don't want to free in that case. It will be freed when "rdata"
4450 // is freed. If they are not same, the update has not been sent and we should free it here.
4451 //
4452 // 2) If the record is in UpdatePending state, we queue the update in QueuedRData. When the previous update
4453 // comes back from the server, we copy it from QueuedRData to InFlightRData and repeat (1). This implies
4454 // that QueuedRData can never be same as "rdata" in the resource record. As long as we have something
4455 // left in QueuedRData, we should free it here.
4456
4457 if (rr->InFlightRData && rr->UpdateCallback)
4458 {
4459 if (rr->InFlightRData != rr->resrec.rdata)
4460 {
4461 LogInfo("uDNS_DeregisterRecord: Freeing InFlightRData for %s", ARDisplayString(m, rr));
4462 rr->UpdateCallback(m, rr, rr->InFlightRData, rr->InFlightRDLen);
4463 rr->InFlightRData = mDNSNULL;
4464 }
4465 else
4466 LogInfo("uDNS_DeregisterRecord: InFlightRData same as rdata for %s", ARDisplayString(m, rr));
4467 }
4468
4469 if (rr->QueuedRData && rr->UpdateCallback)
4470 {
4471 if (rr->QueuedRData == rr->resrec.rdata)
4472 LogMsg("uDNS_DeregisterRecord: ERROR!! QueuedRData same as rdata for %s", ARDisplayString(m, rr));
4473 else
4474 {
4475 LogInfo("uDNS_DeregisterRecord: Freeing QueuedRData for %s", ARDisplayString(m, rr));
4476 rr->UpdateCallback(m, rr, rr->QueuedRData, rr->QueuedRDLen);
4477 rr->QueuedRData = mDNSNULL;
4478 }
4479 }
4480
4481 // If a current group registration is pending, we can't send this deregisration till that registration
4482 // has reached the server i.e., the ordering is important. Previously, if we did not send this
4483 // registration in a group, then the previous connection will be torn down as part of sending the
4484 // deregistration. If we send this in a group, we need to locate the resource record that was used
4485 // to send this registration and terminate that connection. This means all the updates on that might
4486 // be lost (assuming the response is not waiting for us at the socket) and the retry will send the
4487 // update again sometime in the near future.
4488 //
4489 // NOTE: SSL handshake failures normally free the TCP connection immediately. Hence, you may not
4490 // find the TCP below there. This case can happen only when tcp is trying to actively retransmit
4491 // the request or SSL negotiation taking time i.e resource record is actively trying to get the
4492 // message to the server. During that time a deregister has to happen.
4493
4494 if (!mDNSOpaque16IsZero(rr->updateid))
4495 {
4496 AuthRecord *anchorRR;
4497 mDNSBool found = mDNSfalse;
4498 for (anchorRR = m->ResourceRecords; anchorRR; anchorRR = anchorRR->next)
4499 {
4500 if (AuthRecord_uDNS(rr) && mDNSSameOpaque16(anchorRR->updateid, rr->updateid) && anchorRR->tcp)
4501 {
4502 LogInfo("uDNS_DeregisterRecord: Found Anchor RR %s terminated", ARDisplayString(m, anchorRR));
4503 if (found)
4504 LogMsg("uDNS_DeregisterRecord: ERROR: Another anchorRR %s found", ARDisplayString(m, anchorRR));
4505 DisposeTCPConn(anchorRR->tcp);
4506 anchorRR->tcp = mDNSNULL;
4507 found = mDNStrue;
4508 }
4509 }
4510 if (!found) LogInfo("uDNSDeregisterRecord: Cannot find the anchor Resource Record for %s, not an error", ARDisplayString(m, rr));
4511 }
4512
4513 // Retry logic for deregistration should be no different from sending registration the first time.
4514 // Currently ThisAPInterval most likely is set to the refresh interval
4515 rr->state = regState_DeregPending;
4516 rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
4517 rr->LastAPTime = m->timenow - INIT_RECORD_REG_INTERVAL;
4518 info = GetAuthInfoForName_internal(m, rr->resrec.name);
4519 if (IsRecordMergeable(m, rr, m->timenow + MERGE_DELAY_TIME))
4520 {
4521 // Delay the record deregistration by MERGE_DELAY_TIME so that we can merge them
4522 // into one update. If the domain is being deleted, delay by 2 * MERGE_DELAY_TIME
4523 // so that we can merge all the AutoTunnel records and the service records in
4524 // one update (they get deregistered a little apart)
4525 if (info && info->deltime) rr->LastAPTime += (2 * MERGE_DELAY_TIME);
4526 else rr->LastAPTime += MERGE_DELAY_TIME;
4527 }
4528 // IsRecordMergeable could have returned false for several reasons e.g., DontMerge is set or
4529 // no zone information. Most likely it is the latter, CheckRecordUpdates will fetch the zone
4530 // data when it encounters this record.
4531
4532 if (m->NextuDNSEvent - (rr->LastAPTime + rr->ThisAPInterval) >= 0)
4533 m->NextuDNSEvent = (rr->LastAPTime + rr->ThisAPInterval);
4534
4535 return mStatus_NoError;
4536 }
4537
4538 mDNSexport mStatus uDNS_UpdateRecord(mDNS *m, AuthRecord *rr)
4539 {
4540 LogInfo("uDNS_UpdateRecord: Resource Record %##s, state %d", rr->resrec.name->c, rr->state);
4541 switch(rr->state)
4542 {
4543 case regState_DeregPending:
4544 case regState_Unregistered:
4545 // not actively registered
4546 goto unreg_error;
4547
4548 case regState_NATMap:
4549 case regState_NoTarget:
4550 // change rdata directly since it hasn't been sent yet
4551 if (rr->UpdateCallback) rr->UpdateCallback(m, rr, rr->resrec.rdata, rr->resrec.rdlength);
4552 SetNewRData(&rr->resrec, rr->NewRData, rr->newrdlength);
4553 rr->NewRData = mDNSNULL;
4554 return mStatus_NoError;
4555
4556 case regState_Pending:
4557 case regState_Refresh:
4558 case regState_UpdatePending:
4559 // registration in-flight. queue rdata and return
4560 if (rr->QueuedRData && rr->UpdateCallback)
4561 // if unsent rdata is already queued, free it before we replace it
4562 rr->UpdateCallback(m, rr, rr->QueuedRData, rr->QueuedRDLen);
4563 rr->QueuedRData = rr->NewRData;
4564 rr->QueuedRDLen = rr->newrdlength;
4565 rr->NewRData = mDNSNULL;
4566 return mStatus_NoError;
4567
4568 case regState_Registered:
4569 rr->OrigRData = rr->resrec.rdata;
4570 rr->OrigRDLen = rr->resrec.rdlength;
4571 rr->InFlightRData = rr->NewRData;
4572 rr->InFlightRDLen = rr->newrdlength;
4573 rr->NewRData = mDNSNULL;
4574 rr->state = regState_UpdatePending;
4575 rr->ThisAPInterval = INIT_RECORD_REG_INTERVAL;
4576 rr->LastAPTime = m->timenow - INIT_RECORD_REG_INTERVAL;
4577 SetNextuDNSEvent(m, rr);
4578 return mStatus_NoError;
4579
4580 case regState_NATError:
4581 LogMsg("ERROR: uDNS_UpdateRecord called for record %##s with bad state regState_NATError", rr->resrec.name->c);
4582 return mStatus_UnknownErr; // states for service records only
4583
4584 default: LogMsg("uDNS_UpdateRecord: Unknown state %d for %##s", rr->state, rr->resrec.name->c);
4585 }
4586
4587 unreg_error:
4588 LogMsg("uDNS_UpdateRecord: Requested update of record %##s type %d, in erroneous state %d",
4589 rr->resrec.name->c, rr->resrec.rrtype, rr->state);
4590 return mStatus_Invalid;
4591 }
4592
4593 // ***************************************************************************
4594 #if COMPILER_LIKES_PRAGMA_MARK
4595 #pragma mark - Periodic Execution Routines
4596 #endif
4597
4598 mDNSlocal void handle_unanswered_query(mDNS *const m)
4599 {
4600 DNSQuestion *q = m->CurrentQuestion;
4601
4602 if (q->unansweredQueries >= MAX_DNSSEC_UNANSWERED_QUERIES && DNSSECOptionalQuestion(q))
4603 {
4604 // If we are not receiving any responses for DNSSEC question, it could be due to
4605 // a broken middlebox or a DNS server that does not understand the EDNS0/DOK option that
4606 // silently drops the packets. Also as per RFC 5625 there are certain buggy DNS Proxies
4607 // that are known to drop these pkts. To handle this, we turn off sending the EDNS0/DOK
4608 // option if we have not received any responses indicating that the server or
4609 // the middlebox is DNSSEC aware. If we receive at least one response to a DNSSEC
4610 // question, we don't turn off validation. Also, we wait for MAX_DNSSEC_RETRANSMISSIONS
4611 // before turning off validation to accomodate packet loss.
4612 //
4613 // Note: req_DO affects only DNSSEC_VALIDATION_SECURE_OPTIONAL questions;
4614 // DNSSEC_VALIDATION_SECURE questions ignores req_DO.
4615
4616 if (!q->qDNSServer->DNSSECAware && q->qDNSServer->req_DO)
4617 {
4618 q->qDNSServer->retransDO++;
4619 if (q->qDNSServer->retransDO == MAX_DNSSEC_RETRANSMISSIONS)
4620 {
4621 LogInfo("handle_unanswered_query: setting req_DO false for %#a", &q->qDNSServer->addr);
4622 q->qDNSServer->req_DO = mDNSfalse;
4623 }
4624 }
4625
4626 if (!q->qDNSServer->req_DO)
4627 {
4628 q->ValidationState = DNSSECValNotRequired;
4629 q->ValidationRequired = DNSSEC_VALIDATION_NONE;
4630
4631 if (q->ProxyQuestion)
4632 q->ProxyDNSSECOK = mDNSfalse;
4633 LogInfo("handle_unanswered_query: unanswered query for %##s (%s), so turned off validation for %#a",
4634 q->qname.c, DNSTypeName(q->qtype), &q->qDNSServer->addr);
4635 }
4636 }
4637 }
4638
4639 mDNSlocal void uDNS_HandleLLQState(mDNS *const m, DNSQuestion *q)
4640 {
4641 #ifdef DNS_PUSH_ENABLED
4642 // First attempt to use DNS Push Notification.
4643 if (q->dnsPushState == DNSPUSH_INIT)
4644 DiscoverDNSPushNotificationServer(m, q);
4645 #endif // DNS_PUSH_ENABLED
4646 switch (q->state)
4647 {
4648 case LLQ_InitialRequest: startLLQHandshake(m, q); break;
4649 case LLQ_SecondaryRequest:
4650 // For PrivateQueries, we need to start the handshake again as we don't do the Challenge/Response step
4651 if (PrivateQuery(q)) startLLQHandshake(m, q);
4652 else sendChallengeResponse(m, q, mDNSNULL);
4653 break;
4654 case LLQ_Established: sendLLQRefresh(m, q); break;
4655 case LLQ_Poll: break; // Do nothing (handled below)
4656 }
4657 }
4658
4659 // The question to be checked is not passed in as an explicit parameter;
4660 // instead it is implicit that the question to be checked is m->CurrentQuestion.
4661 mDNSexport void uDNS_CheckCurrentQuestion(mDNS *const m)
4662 {
4663 DNSQuestion *q = m->CurrentQuestion;
4664 if (m->timenow - NextQSendTime(q) < 0) return;
4665
4666 if (q->LongLived)
4667 {
4668 uDNS_HandleLLQState(m,q);
4669 }
4670
4671 handle_unanswered_query(m);
4672 // We repeat the check above (rather than just making this the "else" case) because startLLQHandshake can change q->state to LLQ_Poll
4673 if (!(q->LongLived && q->state != LLQ_Poll))
4674 {
4675 if (q->unansweredQueries >= MAX_UCAST_UNANSWERED_QUERIES)
4676 {
4677 DNSServer *orig = q->qDNSServer;
4678 if (orig)
4679 LogInfo("uDNS_CheckCurrentQuestion: Sent %d unanswered queries for %##s (%s) to %#a:%d (%##s)",
4680 q->unansweredQueries, q->qname.c, DNSTypeName(q->qtype), &orig->addr, mDNSVal16(orig->port), orig->domain.c);
4681
4682 #if APPLE_OSX_mDNSResponder
4683 SymptomReporterDNSServerUnreachable(orig);
4684 #endif
4685 PenalizeDNSServer(m, q, zeroID);
4686 q->noServerResponse = 1;
4687 }
4688 // There are two cases here.
4689 //
4690 // 1. We have only one DNS server for this question. It is not responding even after we sent MAX_UCAST_UNANSWERED_QUERIES.
4691 // In that case, we need to keep retrying till we get a response. But we need to backoff as we retry. We set
4692 // noServerResponse in the block above and below we do not touch the question interval. When we come here, we
4693 // already waited for the response. We need to send another query right at this moment. We do that below by
4694 // reinitializing dns servers and reissuing the query.
4695 //
4696 // 2. We have more than one DNS server. If at least one server did not respond, we would have set noServerResponse
4697 // either now (the last server in the list) or before (non-last server in the list). In either case, if we have
4698 // reached the end of DNS server list, we need to try again from the beginning. Ideally we should try just the
4699 // servers that did not respond, but for simplicity we try all the servers. Once we reached the end of list, we
4700 // set triedAllServersOnce so that we don't try all the servers aggressively. See PenalizeDNSServer.
4701 if (!q->qDNSServer && q->noServerResponse)
4702 {
4703 DNSServer *new;
4704 DNSQuestion *qptr;
4705 q->triedAllServersOnce = 1;
4706 // Re-initialize all DNS servers for this question. If we have a DNSServer, DNSServerChangeForQuestion will
4707 // handle all the work including setting the new DNS server.
4708 SetValidDNSServers(m, q);
4709 new = GetServerForQuestion(m, q);
4710 if (new)
4711 {
4712 LogInfo("uDNS_checkCurrentQuestion: Retrying question %p %##s (%s) DNS Server %#a:%d ThisQInterval %d",
4713 q, q->qname.c, DNSTypeName(q->qtype), new ? &new->addr : mDNSNULL, mDNSVal16(new ? new->port : zeroIPPort), q->ThisQInterval);
4714 DNSServerChangeForQuestion(m, q, new);
4715 }
4716 for (qptr = q->next ; qptr; qptr = qptr->next)
4717 if (qptr->DuplicateOf == q) { qptr->validDNSServers = q->validDNSServers; qptr->qDNSServer = q->qDNSServer; }
4718 }
4719 if (q->qDNSServer)
4720 {
4721 mDNSu8 *end;
4722 mStatus err = mStatus_NoError;
4723 mDNSBool private = mDNSfalse;
4724
4725 InitializeDNSMessage(&m->omsg.h, q->TargetQID, (DNSSECQuestion(q) ? DNSSecQFlags : uQueryFlags));
4726
4727 end = putQuestion(&m->omsg, m->omsg.data, m->omsg.data + AbsoluteMaxDNSMessageData, &q->qname, q->qtype, q->qclass);
4728 if (DNSSECQuestion(q) && !q->qDNSServer->cellIntf)
4729 {
4730 if (q->ProxyQuestion)
4731 end = DNSProxySetAttributes(q, &m->omsg.h, &m->omsg, end, m->omsg.data + AbsoluteMaxDNSMessageData);
4732 else
4733 end = putDNSSECOption(&m->omsg, end, m->omsg.data + AbsoluteMaxDNSMessageData);
4734 }
4735 private = PrivateQuery(q);
4736
4737 if (end > m->omsg.data)
4738 {
4739 //LogMsg("uDNS_CheckCurrentQuestion %p %d %p %##s (%s)", q, NextQSendTime(q) - m->timenow, private, q->qname.c, DNSTypeName(q->qtype));
4740 if (private)
4741 {
4742 if (q->nta) CancelGetZoneData(m, q->nta);
4743 q->nta = StartGetZoneData(m, &q->qname, q->LongLived ? ZoneServiceLLQ : ZoneServiceQuery, PrivateQueryGotZoneData, q);
4744 if (q->state == LLQ_Poll) q->ThisQInterval = (LLQ_POLL_INTERVAL + mDNSRandom(LLQ_POLL_INTERVAL/10)) / QuestionIntervalStep;
4745 }
4746 else
4747 {
4748 debugf("uDNS_CheckCurrentQuestion sending %p %##s (%s) %#a:%d UnansweredQueries %d",
4749 q, q->qname.c, DNSTypeName(q->qtype),
4750 q->qDNSServer ? &q->qDNSServer->addr : mDNSNULL, mDNSVal16(q->qDNSServer ? q->qDNSServer->port : zeroIPPort), q->unansweredQueries);
4751 #if APPLE_OSX_mDNSResponder
4752 // When a DNS proxy network extension initiates the close of a UDP flow (this usually happens when a DNS
4753 // proxy gets disabled or crashes), mDNSResponder's corresponding UDP socket will be marked with the
4754 // SS_CANTRCVMORE state flag. Reading from such a socket is no longer possible, so close the current
4755 // socket pair so that we can create a new pair.
4756 if (q->LocalSocket && mDNSPlatformUDPSocketEncounteredEOF(q->LocalSocket))
4757 {
4758 mDNSPlatformUDPClose(q->LocalSocket);
4759 q->LocalSocket = mDNSNULL;
4760 }
4761 #endif
4762 if (!q->LocalSocket)
4763 {
4764 q->LocalSocket = mDNSPlatformUDPSocket(zeroIPPort);
4765 if (q->LocalSocket)
4766 {
4767 mDNSPlatformSetSocktOpt(q->LocalSocket, mDNSTransport_UDP, mDNSAddrType_IPv4, q);
4768 mDNSPlatformSetSocktOpt(q->LocalSocket, mDNSTransport_UDP, mDNSAddrType_IPv6, q);
4769 }
4770 }
4771 if (!q->LocalSocket) err = mStatus_NoMemoryErr; // If failed to make socket (should be very rare), we'll try again next time
4772 else
4773 {
4774 err = mDNSSendDNSMessage(m, &m->omsg, end, q->qDNSServer->interface, q->LocalSocket, &q->qDNSServer->addr, q->qDNSServer->port, mDNSNULL, mDNSNULL, q->UseBackgroundTrafficClass);
4775 #if AWD_METRICS
4776 if (!err)
4777 {
4778 MetricsUpdateDNSQuerySize((mDNSu32)(end - (mDNSu8 *)&m->omsg));
4779 if (q->metrics.answered)
4780 {
4781 q->metrics.querySendCount = 0;
4782 q->metrics.answered = mDNSfalse;
4783 }
4784 if (q->metrics.querySendCount++ == 0)
4785 {
4786 q->metrics.firstQueryTime = m->timenow;
4787 }
4788 }
4789 #endif
4790 }
4791 }
4792 }
4793
4794 if (err == mStatus_HostUnreachErr)
4795 {
4796 DNSServer *newServer;
4797
4798 LogInfo("uDNS_CheckCurrentQuestion: host unreachable error for DNS server %#a for question [%p] %##s (%s)",
4799 &q->qDNSServer->addr, q, q->qname.c, DNSTypeName(q->qtype));
4800
4801 if (!StrictUnicastOrdering)
4802 {
4803 q->qDNSServer->penaltyTime = NonZeroTime(m->timenow + DNSSERVER_PENALTY_TIME);
4804 }
4805
4806 newServer = GetServerForQuestion(m, q);
4807 if (!newServer)
4808 {
4809 q->triedAllServersOnce = 1;
4810 SetValidDNSServers(m, q);
4811 newServer = GetServerForQuestion(m, q);
4812 }
4813 if (newServer)
4814 {
4815 LogInfo("uDNS_checkCurrentQuestion: Retrying question %p %##s (%s) DNS Server %#a:%u ThisQInterval %d",
4816 q, q->qname.c, DNSTypeName(q->qtype), newServer ? &newServer->addr : mDNSNULL, mDNSVal16(newServer ? newServer->port : zeroIPPort), q->ThisQInterval);
4817 DNSServerChangeForQuestion(m, q, newServer);
4818 }
4819 if (q->triedAllServersOnce)
4820 {
4821 q->LastQTime = m->timenow;
4822 }
4823 else
4824 {
4825 q->ThisQInterval = InitialQuestionInterval;
4826 q->LastQTime = m->timenow - q->ThisQInterval;
4827 }
4828 q->unansweredQueries = 0;
4829 }
4830 else
4831 {
4832 if (err != mStatus_TransientErr) // if it is not a transient error backoff and DO NOT flood queries unnecessarily
4833 {
4834 // If all DNS Servers are not responding, then we back-off using the multiplier UDNSBackOffMultiplier(*2).
4835 // Only increase interval if send succeeded
4836
4837 q->ThisQInterval = q->ThisQInterval * UDNSBackOffMultiplier;
4838 if ((q->ThisQInterval > 0) && (q->ThisQInterval < MinQuestionInterval)) // We do not want to retx within 1 sec
4839 q->ThisQInterval = MinQuestionInterval;
4840
4841 q->unansweredQueries++;
4842 if (q->ThisQInterval > MAX_UCAST_POLL_INTERVAL)
4843 q->ThisQInterval = MAX_UCAST_POLL_INTERVAL;
4844 if (private && q->state != LLQ_Poll)
4845 {
4846 // We don't want to retransmit too soon. Hence, we always schedule our first
4847 // retransmisson at 3 seconds rather than one second
4848 if (q->ThisQInterval < (3 * mDNSPlatformOneSecond))
4849 q->ThisQInterval = q->ThisQInterval * QuestionIntervalStep;
4850 if (q->ThisQInterval > LLQ_POLL_INTERVAL)
4851 q->ThisQInterval = LLQ_POLL_INTERVAL;
4852 LogInfo("uDNS_CheckCurrentQuestion: private non polling question for %##s (%s) will be retried in %d ms", q->qname.c, DNSTypeName(q->qtype), q->ThisQInterval);
4853 }
4854 if (q->qDNSServer->cellIntf)
4855 {
4856 // We don't want to retransmit too soon. Schedule our first retransmisson at
4857 // MIN_UCAST_RETRANS_TIMEOUT seconds.
4858 if (q->ThisQInterval < MIN_UCAST_RETRANS_TIMEOUT)
4859 q->ThisQInterval = MIN_UCAST_RETRANS_TIMEOUT;
4860 }
4861 debugf("uDNS_CheckCurrentQuestion: Increased ThisQInterval to %d for %##s (%s), cell %d", q->ThisQInterval, q->qname.c, DNSTypeName(q->qtype), q->qDNSServer->cellIntf);
4862 }
4863 q->LastQTime = m->timenow;
4864 }
4865 SetNextQueryTime(m, q);
4866 }
4867 else
4868 {
4869 // If we have no server for this query, or the only server is a disabled one, then we deliver
4870 // a transient failure indication to the client. This is important for things like iPhone
4871 // where we want to return timely feedback to the user when no network is available.
4872 // After calling MakeNegativeCacheRecord() we store the resulting record in the
4873 // cache so that it will be visible to other clients asking the same question.
4874 // (When we have a group of identical questions, only the active representative of the group gets
4875 // passed to uDNS_CheckCurrentQuestion -- we only want one set of query packets hitting the wire --
4876 // but we want *all* of the questions to get answer callbacks.)
4877 CacheRecord *rr;
4878 const mDNSu32 slot = HashSlotFromNameHash(q->qnamehash);
4879 CacheGroup *const cg = CacheGroupForName(m, q->qnamehash, &q->qname);
4880
4881 if (!q->qDNSServer)
4882 {
4883 if (!mDNSOpaque128IsZero(&q->validDNSServers))
4884 LogMsg("uDNS_CheckCurrentQuestion: ERROR!!: valid DNSServer bits not zero 0x%x, 0x%x 0x%x 0x%x for question %##s (%s)",
4885 q->validDNSServers.l[3], q->validDNSServers.l[2], q->validDNSServers.l[1], q->validDNSServers.l[0], q->qname.c, DNSTypeName(q->qtype));
4886 // If we reached the end of list while picking DNS servers, then we don't want to deactivate the
4887 // question. Try after 60 seconds. We find this by looking for valid DNSServers for this question,
4888 // if we find any, then we must have tried them before we came here. This avoids maintaining
4889 // another state variable to see if we had valid DNS servers for this question.
4890 SetValidDNSServers(m, q);
4891 if (mDNSOpaque128IsZero(&q->validDNSServers))
4892 {
4893 LogInfo("uDNS_CheckCurrentQuestion: no DNS server for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
4894 q->ThisQInterval = 0;
4895 }
4896 else
4897 {
4898 DNSQuestion *qptr;
4899 // Pretend that we sent this question. As this is an ActiveQuestion, the NextScheduledQuery should
4900 // be set properly. Also, we need to properly backoff in cases where we don't set the question to
4901 // MaxQuestionInterval when we answer the question e.g., LongLived, we need to keep backing off
4902 q->ThisQInterval = q->ThisQInterval * QuestionIntervalStep;
4903 q->LastQTime = m->timenow;
4904 SetNextQueryTime(m, q);
4905 // Pick a new DNS server now. Otherwise, when the cache is 80% of its expiry, we will try
4906 // to send a query and come back to the same place here and log the above message.
4907 q->qDNSServer = GetServerForQuestion(m, q);
4908 for (qptr = q->next ; qptr; qptr = qptr->next)
4909 if (qptr->DuplicateOf == q) { qptr->validDNSServers = q->validDNSServers; qptr->qDNSServer = q->qDNSServer; }
4910 LogInfo("uDNS_checkCurrentQuestion: Tried all DNS servers, retry question %p SuppressUnusable %d %##s (%s) with DNS Server %#a:%d after 60 seconds, ThisQInterval %d",
4911 q, q->SuppressUnusable, q->qname.c, DNSTypeName(q->qtype),
4912 q->qDNSServer ? &q->qDNSServer->addr : mDNSNULL, mDNSVal16(q->qDNSServer ? q->qDNSServer->port : zeroIPPort), q->ThisQInterval);
4913 }
4914 }
4915 else
4916 {
4917 q->ThisQInterval = 0;
4918 LogMsg("uDNS_CheckCurrentQuestion DNS server %#a:%d for %##s is disabled", &q->qDNSServer->addr, mDNSVal16(q->qDNSServer->port), q->qname.c);
4919 }
4920
4921 if (cg)
4922 {
4923 for (rr = cg->members; rr; rr=rr->next)
4924 {
4925 if (SameNameRecordAnswersQuestion(&rr->resrec, q))
4926 {
4927 LogInfo("uDNS_CheckCurrentQuestion: Purged resourcerecord %s", CRDisplayString(m, rr));
4928 mDNS_PurgeCacheResourceRecord(m, rr);
4929 }
4930 }
4931 }
4932 // For some of the WAB queries that we generate form within the mDNSResponder, most of the home routers
4933 // don't understand and return ServFail/NXDomain. In those cases, we don't want to try too often. We try
4934 // every fifteen minutes in that case
4935 MakeNegativeCacheRecord(m, &m->rec.r, &q->qname, q->qnamehash, q->qtype, q->qclass, (DomainEnumQuery(&q->qname) ? 60 * 15 : 60), mDNSInterface_Any, q->qDNSServer);
4936 q->unansweredQueries = 0;
4937 if (!mDNSOpaque16IsZero(q->responseFlags))
4938 m->rec.r.responseFlags = q->responseFlags;
4939 // We're already using the m->CurrentQuestion pointer, so CacheRecordAdd can't use it to walk the question list.
4940 // To solve this problem we set rr->DelayDelivery to a nonzero value (which happens to be 'now') so that we
4941 // momentarily defer generating answer callbacks until mDNS_Execute time.
4942 CreateNewCacheEntry(m, slot, cg, NonZeroTime(m->timenow), mDNStrue, mDNSNULL);
4943 ScheduleNextCacheCheckTime(m, slot, NonZeroTime(m->timenow));
4944 m->rec.r.responseFlags = zeroID;
4945 m->rec.r.resrec.RecordType = 0; // Clear RecordType to show we're not still using it
4946 // MUST NOT touch m->CurrentQuestion (or q) after this -- client callback could have deleted it
4947 }
4948 }
4949 }
4950
4951 mDNSexport void CheckNATMappings(mDNS *m)
4952 {
4953 mDNSBool rfc1918 = mDNSv4AddrIsRFC1918(&m->AdvertisedV4.ip.v4);
4954 mDNSBool HaveRoutable = !rfc1918 && !mDNSIPv4AddressIsZero(m->AdvertisedV4.ip.v4);
4955 m->NextScheduledNATOp = m->timenow + FutureTime;
4956
4957 if (HaveRoutable) m->ExtAddress = m->AdvertisedV4.ip.v4;
4958
4959 if (m->NATTraversals && rfc1918) // Do we need to open a socket to receive multicast announcements from router?
4960 {
4961 if (m->NATMcastRecvskt == mDNSNULL) // If we are behind a NAT and the socket hasn't been opened yet, open it
4962 {
4963 // we need to log a message if we can't get our socket, but only the first time (after success)
4964 static mDNSBool needLog = mDNStrue;
4965 m->NATMcastRecvskt = mDNSPlatformUDPSocket(NATPMPAnnouncementPort);
4966 if (!m->NATMcastRecvskt)
4967 {
4968 if (needLog)
4969 {
4970 LogMsg("CheckNATMappings: Failed to allocate port 5350 UDP multicast socket for PCP & NAT-PMP announcements");
4971 needLog = mDNSfalse;
4972 }
4973 }
4974 else
4975 needLog = mDNStrue;
4976 }
4977 }
4978 else // else, we don't want to listen for announcements, so close them if they're open
4979 {
4980 if (m->NATMcastRecvskt) { mDNSPlatformUDPClose(m->NATMcastRecvskt); m->NATMcastRecvskt = mDNSNULL; }
4981 if (m->SSDPSocket) { debugf("CheckNATMappings destroying SSDPSocket %p", &m->SSDPSocket); mDNSPlatformUDPClose(m->SSDPSocket); m->SSDPSocket = mDNSNULL; }
4982 }
4983
4984 uDNS_RequestAddress(m);
4985
4986 if (m->CurrentNATTraversal) LogMsg("WARNING m->CurrentNATTraversal already in use");
4987 m->CurrentNATTraversal = m->NATTraversals;
4988
4989 while (m->CurrentNATTraversal)
4990 {
4991 NATTraversalInfo *cur = m->CurrentNATTraversal;
4992 mDNSv4Addr EffectiveAddress = HaveRoutable ? m->AdvertisedV4.ip.v4 : cur->NewAddress;
4993 m->CurrentNATTraversal = m->CurrentNATTraversal->next;
4994
4995 if (HaveRoutable) // If not RFC 1918 address, our own address and port are effectively our external address and port
4996 {
4997 cur->ExpiryTime = 0;
4998 cur->NewResult = mStatus_NoError;
4999 }
5000 else // Check if it's time to send port mapping packet(s)
5001 {
5002 if (m->timenow - cur->retryPortMap >= 0) // Time to send a mapping request for this packet
5003 {
5004 if (cur->ExpiryTime && cur->ExpiryTime - m->timenow < 0) // Mapping has expired
5005 {
5006 cur->ExpiryTime = 0;
5007 cur->retryInterval = NATMAP_INIT_RETRY;
5008 }
5009
5010 uDNS_SendNATMsg(m, cur, mDNStrue, mDNSfalse); // Will also do UPnP discovery for us, if necessary
5011
5012 if (cur->ExpiryTime) // If have active mapping then set next renewal time halfway to expiry
5013 NATSetNextRenewalTime(m, cur);
5014 else // else no mapping; use exponential backoff sequence
5015 {
5016 if (cur->retryInterval < NATMAP_INIT_RETRY ) cur->retryInterval = NATMAP_INIT_RETRY;
5017 else if (cur->retryInterval < NATMAP_MAX_RETRY_INTERVAL / 2) cur->retryInterval *= 2;
5018 else cur->retryInterval = NATMAP_MAX_RETRY_INTERVAL;
5019 cur->retryPortMap = m->timenow + cur->retryInterval;
5020 }
5021 }
5022
5023 if (m->NextScheduledNATOp - cur->retryPortMap > 0)
5024 {
5025 m->NextScheduledNATOp = cur->retryPortMap;
5026 }
5027 }
5028
5029 // Notify the client if necessary. We invoke the callback if:
5030 // (1) We have an effective address,
5031 // or we've tried and failed a couple of times to discover it
5032 // AND
5033 // (2) the client requested the address only,
5034 // or the client won't need a mapping because we have a routable address,
5035 // or the client has an expiry time and therefore a successful mapping,
5036 // or we've tried and failed a couple of times (see "Time line" below)
5037 // AND
5038 // (3) we have new data to give the client that's changed since the last callback
5039 //
5040 // Time line is: Send, Wait 500ms, Send, Wait 1sec, Send, Wait 2sec, Send
5041 // At this point we've sent three requests without an answer, we've just sent our fourth request,
5042 // retryInterval is now 4 seconds, which is greater than NATMAP_INIT_RETRY * 8 (2 seconds),
5043 // so we return an error result to the caller.
5044 if (!mDNSIPv4AddressIsZero(EffectiveAddress) || cur->retryInterval > NATMAP_INIT_RETRY * 8)
5045 {
5046 const mStatus EffectiveResult = cur->NewResult ? cur->NewResult : mDNSv4AddrIsRFC1918(&EffectiveAddress) ? mStatus_DoubleNAT : mStatus_NoError;
5047 const mDNSIPPort ExternalPort = HaveRoutable ? cur->IntPort :
5048 !mDNSIPv4AddressIsZero(EffectiveAddress) && cur->ExpiryTime ? cur->RequestedPort : zeroIPPort;
5049
5050 if (!cur->Protocol || HaveRoutable || cur->ExpiryTime || cur->retryInterval > NATMAP_INIT_RETRY * 8)
5051 {
5052 if (!mDNSSameIPv4Address(cur->ExternalAddress, EffectiveAddress) ||
5053 !mDNSSameIPPort (cur->ExternalPort, ExternalPort) ||
5054 cur->Result != EffectiveResult)
5055 {
5056 //LogMsg("NAT callback %d %d %d", cur->Protocol, cur->ExpiryTime, cur->retryInterval);
5057 if (cur->Protocol && mDNSIPPortIsZero(ExternalPort) && !mDNSIPv4AddressIsZero(m->Router.ip.v4))
5058 {
5059 if (!EffectiveResult)
5060 LogInfo("CheckNATMapping: Failed to obtain NAT port mapping %p from router %#a external address %.4a internal port %5d interval %d error %d",
5061 cur, &m->Router, &EffectiveAddress, mDNSVal16(cur->IntPort), cur->retryInterval, EffectiveResult);
5062 else
5063 LogMsg("CheckNATMapping: Failed to obtain NAT port mapping %p from router %#a external address %.4a internal port %5d interval %d error %d",
5064 cur, &m->Router, &EffectiveAddress, mDNSVal16(cur->IntPort), cur->retryInterval, EffectiveResult);
5065 }
5066
5067 cur->ExternalAddress = EffectiveAddress;
5068 cur->ExternalPort = ExternalPort;
5069 cur->Lifetime = cur->ExpiryTime && !mDNSIPPortIsZero(ExternalPort) ?
5070 (cur->ExpiryTime - m->timenow + mDNSPlatformOneSecond/2) / mDNSPlatformOneSecond : 0;
5071 cur->Result = EffectiveResult;
5072 mDNS_DropLockBeforeCallback(); // Allow client to legally make mDNS API calls from the callback
5073 if (cur->clientCallback)
5074 cur->clientCallback(m, cur);
5075 mDNS_ReclaimLockAfterCallback(); // Decrement mDNS_reentrancy to block mDNS API calls again
5076 // MUST NOT touch cur after invoking the callback
5077 }
5078 }
5079 }
5080 }
5081 }
5082
5083 mDNSlocal mDNSs32 CheckRecordUpdates(mDNS *m)
5084 {
5085 AuthRecord *rr;
5086 mDNSs32 nextevent = m->timenow + FutureTime;
5087
5088 CheckGroupRecordUpdates(m);
5089
5090 for (rr = m->ResourceRecords; rr; rr = rr->next)
5091 {
5092 if (!AuthRecord_uDNS(rr)) continue;
5093 if (rr->state == regState_NoTarget) {debugf("CheckRecordUpdates: Record %##s in NoTarget", rr->resrec.name->c); continue;}
5094 // While we are waiting for the port mapping, we have nothing to do. The port mapping callback
5095 // will take care of this
5096 if (rr->state == regState_NATMap) {debugf("CheckRecordUpdates: Record %##s in NATMap", rr->resrec.name->c); continue;}
5097 if (rr->state == regState_Pending || rr->state == regState_DeregPending || rr->state == regState_UpdatePending ||
5098 rr->state == regState_Refresh || rr->state == regState_Registered)
5099 {
5100 if (rr->LastAPTime + rr->ThisAPInterval - m->timenow <= 0)
5101 {
5102 if (rr->tcp) { DisposeTCPConn(rr->tcp); rr->tcp = mDNSNULL; }
5103 if (!rr->nta || mDNSIPv4AddressIsZero(rr->nta->Addr.ip.v4))
5104 {
5105 // Zero out the updateid so that if we have a pending response from the server, it won't
5106 // be accepted as a valid response. If we accept the response, we might free the new "nta"
5107 if (rr->nta) { rr->updateid = zeroID; CancelGetZoneData(m, rr->nta); }
5108 rr->nta = StartGetZoneData(m, rr->resrec.name, ZoneServiceUpdate, RecordRegistrationGotZoneData, rr);
5109
5110 // We have just started the GetZoneData. We need to wait for it to finish. SetRecordRetry here
5111 // schedules the update timer to fire in the future.
5112 //
5113 // There are three cases.
5114 //
5115 // 1) When the updates are sent the first time, the first retry is intended to be at three seconds
5116 // in the future. But by calling SetRecordRetry here we set it to nine seconds. But it does not
5117 // matter because when the answer comes back, RecordRegistrationGotZoneData resets the interval
5118 // back to INIT_RECORD_REG_INTERVAL. This also gives enough time for the query.
5119 //
5120 // 2) In the case of update errors (updateError), this causes further backoff as
5121 // RecordRegistrationGotZoneData does not reset the timer. This is intentional as in the case of
5122 // errors, we don't want to update aggressively.
5123 //
5124 // 3) We might be refreshing the update. This is very similar to case (1). RecordRegistrationGotZoneData
5125 // resets it back to INIT_RECORD_REG_INTERVAL.
5126 //
5127 SetRecordRetry(m, rr, 0);
5128 }
5129 else if (rr->state == regState_DeregPending) SendRecordDeregistration(m, rr);
5130 else SendRecordRegistration(m, rr);
5131 }
5132 }
5133 if (nextevent - (rr->LastAPTime + rr->ThisAPInterval) > 0)
5134 nextevent = (rr->LastAPTime + rr->ThisAPInterval);
5135 }
5136 return nextevent;
5137 }
5138
5139 mDNSexport void uDNS_Tasks(mDNS *const m)
5140 {
5141 mDNSs32 nexte;
5142 DNSServer *d;
5143
5144 m->NextuDNSEvent = m->timenow + FutureTime;
5145
5146 nexte = CheckRecordUpdates(m);
5147 if (m->NextuDNSEvent - nexte > 0)
5148 m->NextuDNSEvent = nexte;
5149
5150 for (d = m->DNSServers; d; d=d->next)
5151 if (d->penaltyTime)
5152 {
5153 if (m->timenow - d->penaltyTime >= 0)
5154 {
5155 LogInfo("DNS server %#a:%d out of penalty box", &d->addr, mDNSVal16(d->port));
5156 d->penaltyTime = 0;
5157 }
5158 else
5159 if (m->NextuDNSEvent - d->penaltyTime > 0)
5160 m->NextuDNSEvent = d->penaltyTime;
5161 }
5162
5163 if (m->CurrentQuestion)
5164 LogMsg("uDNS_Tasks ERROR m->CurrentQuestion already set: %##s (%s)", m->CurrentQuestion->qname.c, DNSTypeName(m->CurrentQuestion->qtype));
5165 m->CurrentQuestion = m->Questions;
5166 while (m->CurrentQuestion && m->CurrentQuestion != m->NewQuestions)
5167 {
5168 DNSQuestion *const q = m->CurrentQuestion;
5169 if (ActiveQuestion(q) && !mDNSOpaque16IsZero(q->TargetQID))
5170 {
5171 uDNS_CheckCurrentQuestion(m);
5172 if (q == m->CurrentQuestion)
5173 if (m->NextuDNSEvent - NextQSendTime(q) > 0)
5174 m->NextuDNSEvent = NextQSendTime(q);
5175 }
5176 // If m->CurrentQuestion wasn't modified out from under us, advance it now
5177 // We can't do this at the start of the loop because uDNS_CheckCurrentQuestion()
5178 // depends on having m->CurrentQuestion point to the right question
5179 if (m->CurrentQuestion == q)
5180 m->CurrentQuestion = q->next;
5181 }
5182 m->CurrentQuestion = mDNSNULL;
5183 }
5184
5185 // ***************************************************************************
5186 #if COMPILER_LIKES_PRAGMA_MARK
5187 #pragma mark - Startup, Shutdown, and Sleep
5188 #endif
5189
5190 mDNSexport void SleepRecordRegistrations(mDNS *m)
5191 {
5192 AuthRecord *rr;
5193 for (rr = m->ResourceRecords; rr; rr=rr->next)
5194 {
5195 if (AuthRecord_uDNS(rr))
5196 {
5197 // Zero out the updateid so that if we have a pending response from the server, it won't
5198 // be accepted as a valid response.
5199 if (rr->nta) { rr->updateid = zeroID; CancelGetZoneData(m, rr->nta); rr->nta = mDNSNULL; }
5200
5201 if (rr->NATinfo.clientContext)
5202 {
5203 mDNS_StopNATOperation_internal(m, &rr->NATinfo);
5204 rr->NATinfo.clientContext = mDNSNULL;
5205 }
5206 // We are waiting to update the resource record. The original data of the record is
5207 // in OrigRData and the updated value is in InFlightRData. Free the old and the new
5208 // one will be registered when we come back.
5209 if (rr->state == regState_UpdatePending)
5210 {
5211 // act as if the update succeeded, since we're about to delete the name anyway
5212 rr->state = regState_Registered;
5213 // deallocate old RData
5214 if (rr->UpdateCallback) rr->UpdateCallback(m, rr, rr->OrigRData, rr->OrigRDLen);
5215 SetNewRData(&rr->resrec, rr->InFlightRData, rr->InFlightRDLen);
5216 rr->OrigRData = mDNSNULL;
5217 rr->InFlightRData = mDNSNULL;
5218 }
5219
5220 // If we have not begun the registration process i.e., never sent a registration packet,
5221 // then uDNS_DeregisterRecord will not send a deregistration
5222 uDNS_DeregisterRecord(m, rr);
5223
5224 // When we wake, we call ActivateUnicastRegistration which starts at StartGetZoneData
5225 }
5226 }
5227 }
5228
5229 mDNSexport void mDNS_AddSearchDomain(const domainname *const domain, mDNSInterfaceID InterfaceID)
5230 {
5231 SearchListElem **p;
5232 SearchListElem *tmp = mDNSNULL;
5233
5234 // Check to see if we already have this domain in our list
5235 for (p = &SearchList; *p; p = &(*p)->next)
5236 if (((*p)->InterfaceID == InterfaceID) && SameDomainName(&(*p)->domain, domain))
5237 {
5238 // If domain is already in list, and marked for deletion, unmark the delete
5239 // Be careful not to touch the other flags that may be present
5240 LogInfo("mDNS_AddSearchDomain already in list %##s", domain->c);
5241 if ((*p)->flag & SLE_DELETE) (*p)->flag &= ~SLE_DELETE;
5242 tmp = *p;
5243 *p = tmp->next;
5244 tmp->next = mDNSNULL;
5245 break;
5246 }
5247
5248
5249 // move to end of list so that we maintain the same order
5250 while (*p) p = &(*p)->next;
5251
5252 if (tmp) *p = tmp;
5253 else
5254 {
5255 // if domain not in list, add to list, mark as add (1)
5256 *p = mDNSPlatformMemAllocate(sizeof(SearchListElem));
5257 if (!*p) { LogMsg("ERROR: mDNS_AddSearchDomain - malloc"); return; }
5258 mDNSPlatformMemZero(*p, sizeof(SearchListElem));
5259 AssignDomainName(&(*p)->domain, domain);
5260 (*p)->next = mDNSNULL;
5261 (*p)->InterfaceID = InterfaceID;
5262 LogInfo("mDNS_AddSearchDomain created new %##s, InterfaceID %p", domain->c, InterfaceID);
5263 }
5264 }
5265
5266 mDNSlocal void FreeARElemCallback(mDNS *const m, AuthRecord *const rr, mStatus result)
5267 {
5268 (void)m; // unused
5269 if (result == mStatus_MemFree) mDNSPlatformMemFree(rr->RecordContext);
5270 }
5271
5272 mDNSlocal void FoundDomain(mDNS *const m, DNSQuestion *question, const ResourceRecord *const answer, QC_result AddRecord)
5273 {
5274 SearchListElem *slElem = question->QuestionContext;
5275 mStatus err;
5276 const char *name;
5277
5278 if (answer->rrtype != kDNSType_PTR) return;
5279 if (answer->RecordType == kDNSRecordTypePacketNegative) return;
5280 if (answer->InterfaceID == mDNSInterface_LocalOnly) return;
5281
5282 if (question == &slElem->BrowseQ) name = mDNS_DomainTypeNames[mDNS_DomainTypeBrowse];
5283 else if (question == &slElem->DefBrowseQ) name = mDNS_DomainTypeNames[mDNS_DomainTypeBrowseDefault];
5284 else if (question == &slElem->AutomaticBrowseQ) name = mDNS_DomainTypeNames[mDNS_DomainTypeBrowseAutomatic];
5285 else if (question == &slElem->RegisterQ) name = mDNS_DomainTypeNames[mDNS_DomainTypeRegistration];
5286 else if (question == &slElem->DefRegisterQ) name = mDNS_DomainTypeNames[mDNS_DomainTypeRegistrationDefault];
5287 else { LogMsg("FoundDomain - unknown question"); return; }
5288
5289 LogInfo("FoundDomain: %p %s %s Q %##s A %s", answer->InterfaceID, AddRecord ? "Add" : "Rmv", name, question->qname.c, RRDisplayString(m, answer));
5290
5291 if (AddRecord)
5292 {
5293 ARListElem *arElem = mDNSPlatformMemAllocate(sizeof(ARListElem));
5294 if (!arElem) { LogMsg("ERROR: FoundDomain out of memory"); return; }
5295 mDNS_SetupResourceRecord(&arElem->ar, mDNSNULL, mDNSInterface_LocalOnly, kDNSType_PTR, 7200, kDNSRecordTypeShared, AuthRecordLocalOnly, FreeARElemCallback, arElem);
5296 MakeDomainNameFromDNSNameString(&arElem->ar.namestorage, name);
5297 AppendDNSNameString (&arElem->ar.namestorage, "local");
5298 AssignDomainName(&arElem->ar.resrec.rdata->u.name, &answer->rdata->u.name);
5299 LogInfo("FoundDomain: Registering %s", ARDisplayString(m, &arElem->ar));
5300 err = mDNS_Register(m, &arElem->ar);
5301 if (err) { LogMsg("ERROR: FoundDomain - mDNS_Register returned %d", err); mDNSPlatformMemFree(arElem); return; }
5302 arElem->next = slElem->AuthRecs;
5303 slElem->AuthRecs = arElem;
5304 }
5305 else
5306 {
5307 ARListElem **ptr = &slElem->AuthRecs;
5308 while (*ptr)
5309 {
5310 if (SameDomainName(&(*ptr)->ar.resrec.rdata->u.name, &answer->rdata->u.name))
5311 {
5312 ARListElem *dereg = *ptr;
5313 *ptr = (*ptr)->next;
5314 LogInfo("FoundDomain: Deregistering %s", ARDisplayString(m, &dereg->ar));
5315 err = mDNS_Deregister(m, &dereg->ar);
5316 if (err) LogMsg("ERROR: FoundDomain - mDNS_Deregister returned %d", err);
5317 // Memory will be freed in the FreeARElemCallback
5318 }
5319 else
5320 ptr = &(*ptr)->next;
5321 }
5322 }
5323 }
5324
5325 #if APPLE_OSX_mDNSResponder && MACOSX_MDNS_MALLOC_DEBUGGING
5326 mDNSexport void udns_validatelists(void *const v)
5327 {
5328 mDNS *const m = v;
5329
5330 NATTraversalInfo *n;
5331 for (n = m->NATTraversals; n; n=n->next)
5332 if (n->next == (NATTraversalInfo *)~0 || n->clientCallback == (NATTraversalClientCallback) ~0)
5333 LogMemCorruption("m->NATTraversals: %p is garbage", n);
5334
5335 DNSServer *d;
5336 for (d = m->DNSServers; d; d=d->next)
5337 if (d->next == (DNSServer *)~0)
5338 LogMemCorruption("m->DNSServers: %p is garbage", d);
5339
5340 DomainAuthInfo *info;
5341 for (info = m->AuthInfoList; info; info = info->next)
5342 if (info->next == (DomainAuthInfo *)~0)
5343 LogMemCorruption("m->AuthInfoList: %p is garbage", info);
5344
5345 HostnameInfo *hi;
5346 for (hi = m->Hostnames; hi; hi = hi->next)
5347 if (hi->next == (HostnameInfo *)~0 || hi->StatusCallback == (mDNSRecordCallback*)~0)
5348 LogMemCorruption("m->Hostnames: %p is garbage", n);
5349
5350 SearchListElem *ptr;
5351 for (ptr = SearchList; ptr; ptr = ptr->next)
5352 if (ptr->next == (SearchListElem *)~0 || ptr->AuthRecs == (void*)~0)
5353 LogMemCorruption("SearchList: %p is garbage (%X)", ptr, ptr->AuthRecs);
5354 }
5355 #endif
5356
5357 // This should probably move to the UDS daemon -- the concept of legacy clients and automatic registration / automatic browsing
5358 // is really a UDS API issue, not something intrinsic to uDNS
5359
5360 mDNSlocal void uDNS_DeleteWABQueries(mDNS *const m, SearchListElem *ptr, int delete)
5361 {
5362 const char *name1 = mDNSNULL;
5363 const char *name2 = mDNSNULL;
5364 ARListElem **arList = &ptr->AuthRecs;
5365 domainname namestorage1, namestorage2;
5366 mStatus err;
5367
5368 // "delete" parameter indicates the type of query.
5369 switch (delete)
5370 {
5371 case UDNS_WAB_BROWSE_QUERY:
5372 mDNS_StopGetDomains(m, &ptr->BrowseQ);
5373 mDNS_StopGetDomains(m, &ptr->DefBrowseQ);
5374 name1 = mDNS_DomainTypeNames[mDNS_DomainTypeBrowse];
5375 name2 = mDNS_DomainTypeNames[mDNS_DomainTypeBrowseDefault];
5376 break;
5377 case UDNS_WAB_LBROWSE_QUERY:
5378 mDNS_StopGetDomains(m, &ptr->AutomaticBrowseQ);
5379 name1 = mDNS_DomainTypeNames[mDNS_DomainTypeBrowseAutomatic];
5380 break;
5381 case UDNS_WAB_REG_QUERY:
5382 mDNS_StopGetDomains(m, &ptr->RegisterQ);
5383 mDNS_StopGetDomains(m, &ptr->DefRegisterQ);
5384 name1 = mDNS_DomainTypeNames[mDNS_DomainTypeRegistration];
5385 name2 = mDNS_DomainTypeNames[mDNS_DomainTypeRegistrationDefault];
5386 break;
5387 default:
5388 LogMsg("uDNS_DeleteWABQueries: ERROR!! returning from default");
5389 return;
5390 }
5391 // When we get the results to the domain enumeration queries, we add a LocalOnly
5392 // entry. For example, if we issue a domain enumeration query for b._dns-sd._udp.xxxx.com,
5393 // and when we get a response, we add a LocalOnly entry b._dns-sd._udp.local whose RDATA
5394 // points to what we got in the response. Locate the appropriate LocalOnly entries and delete
5395 // them.
5396 if (name1)
5397 {
5398 MakeDomainNameFromDNSNameString(&namestorage1, name1);
5399 AppendDNSNameString(&namestorage1, "local");
5400 }
5401 if (name2)
5402 {
5403 MakeDomainNameFromDNSNameString(&namestorage2, name2);
5404 AppendDNSNameString(&namestorage2, "local");
5405 }
5406 while (*arList)
5407 {
5408 ARListElem *dereg = *arList;
5409 if ((name1 && SameDomainName(&dereg->ar.namestorage, &namestorage1)) ||
5410 (name2 && SameDomainName(&dereg->ar.namestorage, &namestorage2)))
5411 {
5412 LogInfo("uDNS_DeleteWABQueries: Deregistering PTR %##s -> %##s", dereg->ar.resrec.name->c, dereg->ar.resrec.rdata->u.name.c);
5413 *arList = dereg->next;
5414 err = mDNS_Deregister(m, &dereg->ar);
5415 if (err) LogMsg("uDNS_DeleteWABQueries:: ERROR!! mDNS_Deregister returned %d", err);
5416 // Memory will be freed in the FreeARElemCallback
5417 }
5418 else
5419 {
5420 LogInfo("uDNS_DeleteWABQueries: Skipping PTR %##s -> %##s", dereg->ar.resrec.name->c, dereg->ar.resrec.rdata->u.name.c);
5421 arList = &(*arList)->next;
5422 }
5423 }
5424 }
5425
5426 mDNSexport void uDNS_SetupWABQueries(mDNS *const m)
5427 {
5428 SearchListElem **p = &SearchList, *ptr;
5429 mStatus err;
5430 int action = 0;
5431
5432 // step 1: mark each element for removal
5433 for (ptr = SearchList; ptr; ptr = ptr->next)
5434 ptr->flag |= SLE_DELETE;
5435
5436 // Make sure we have the search domains from the platform layer so that if we start the WAB
5437 // queries below, we have the latest information.
5438 mDNS_Lock(m);
5439 if (!mDNSPlatformSetDNSConfig(mDNSfalse, mDNStrue, mDNSNULL, mDNSNULL, mDNSNULL, mDNSfalse))
5440 {
5441 // If the configuration did not change, clear the flag so that we don't free the searchlist.
5442 // We still have to start the domain enumeration queries as we may not have started them
5443 // before.
5444 for (ptr = SearchList; ptr; ptr = ptr->next)
5445 ptr->flag &= ~SLE_DELETE;
5446 LogInfo("uDNS_SetupWABQueries: No config change");
5447 }
5448 mDNS_Unlock(m);
5449
5450 if (m->WABBrowseQueriesCount)
5451 action |= UDNS_WAB_BROWSE_QUERY;
5452 if (m->WABLBrowseQueriesCount)
5453 action |= UDNS_WAB_LBROWSE_QUERY;
5454 if (m->WABRegQueriesCount)
5455 action |= UDNS_WAB_REG_QUERY;
5456
5457
5458 // delete elems marked for removal, do queries for elems marked add
5459 while (*p)
5460 {
5461 ptr = *p;
5462 LogInfo("uDNS_SetupWABQueries:action 0x%x: Flags 0x%x, AuthRecs %p, InterfaceID %p %##s", action, ptr->flag, ptr->AuthRecs, ptr->InterfaceID, ptr->domain.c);
5463 // If SLE_DELETE is set, stop all the queries, deregister all the records and free the memory.
5464 // Otherwise, check to see what the "action" requires. If a particular action bit is not set and
5465 // we have started the corresponding queries as indicated by the "flags", stop those queries and
5466 // deregister the records corresponding to them.
5467 if ((ptr->flag & SLE_DELETE) ||
5468 (!(action & UDNS_WAB_BROWSE_QUERY) && (ptr->flag & SLE_WAB_BROWSE_QUERY_STARTED)) ||
5469 (!(action & UDNS_WAB_LBROWSE_QUERY) && (ptr->flag & SLE_WAB_LBROWSE_QUERY_STARTED)) ||
5470 (!(action & UDNS_WAB_REG_QUERY) && (ptr->flag & SLE_WAB_REG_QUERY_STARTED)))
5471 {
5472 if (ptr->flag & SLE_DELETE)
5473 {
5474 ARListElem *arList = ptr->AuthRecs;
5475 ptr->AuthRecs = mDNSNULL;
5476 *p = ptr->next;
5477
5478 // If the user has "local" in their DNS searchlist, we ignore that for the purposes of domain enumeration queries
5479 // We suppressed the domain enumeration for scoped search domains below. When we enable that
5480 // enable this.
5481 if ((ptr->flag & SLE_WAB_BROWSE_QUERY_STARTED) &&
5482 !SameDomainName(&ptr->domain, &localdomain) && (ptr->InterfaceID == mDNSInterface_Any))
5483 {
5484 LogInfo("uDNS_SetupWABQueries: DELETE Browse for domain %##s", ptr->domain.c);
5485 mDNS_StopGetDomains(m, &ptr->BrowseQ);
5486 mDNS_StopGetDomains(m, &ptr->DefBrowseQ);
5487 }
5488 if ((ptr->flag & SLE_WAB_LBROWSE_QUERY_STARTED) &&
5489 !SameDomainName(&ptr->domain, &localdomain) && (ptr->InterfaceID == mDNSInterface_Any))
5490 {
5491 LogInfo("uDNS_SetupWABQueries: DELETE Legacy Browse for domain %##s", ptr->domain.c);
5492 mDNS_StopGetDomains(m, &ptr->AutomaticBrowseQ);
5493 }
5494 if ((ptr->flag & SLE_WAB_REG_QUERY_STARTED) &&
5495 !SameDomainName(&ptr->domain, &localdomain) && (ptr->InterfaceID == mDNSInterface_Any))
5496 {
5497 LogInfo("uDNS_SetupWABQueries: DELETE Registration for domain %##s", ptr->domain.c);
5498 mDNS_StopGetDomains(m, &ptr->RegisterQ);
5499 mDNS_StopGetDomains(m, &ptr->DefRegisterQ);
5500 }
5501
5502 mDNSPlatformMemFree(ptr);
5503
5504 // deregister records generated from answers to the query
5505 while (arList)
5506 {
5507 ARListElem *dereg = arList;
5508 arList = arList->next;
5509 LogInfo("uDNS_SetupWABQueries: DELETE Deregistering PTR %##s -> %##s", dereg->ar.resrec.name->c, dereg->ar.resrec.rdata->u.name.c);
5510 err = mDNS_Deregister(m, &dereg->ar);
5511 if (err) LogMsg("uDNS_SetupWABQueries:: ERROR!! mDNS_Deregister returned %d", err);
5512 // Memory will be freed in the FreeARElemCallback
5513 }
5514 continue;
5515 }
5516
5517 // If the user has "local" in their DNS searchlist, we ignore that for the purposes of domain enumeration queries
5518 // We suppressed the domain enumeration for scoped search domains below. When we enable that
5519 // enable this.
5520 if (!(action & UDNS_WAB_BROWSE_QUERY) && (ptr->flag & SLE_WAB_BROWSE_QUERY_STARTED) &&
5521 !SameDomainName(&ptr->domain, &localdomain) && (ptr->InterfaceID == mDNSInterface_Any))
5522 {
5523 LogInfo("uDNS_SetupWABQueries: Deleting Browse for domain %##s", ptr->domain.c);
5524 ptr->flag &= ~SLE_WAB_BROWSE_QUERY_STARTED;
5525 uDNS_DeleteWABQueries(m, ptr, UDNS_WAB_BROWSE_QUERY);
5526 }
5527
5528 if (!(action & UDNS_WAB_LBROWSE_QUERY) && (ptr->flag & SLE_WAB_LBROWSE_QUERY_STARTED) &&
5529 !SameDomainName(&ptr->domain, &localdomain) && (ptr->InterfaceID == mDNSInterface_Any))
5530 {
5531 LogInfo("uDNS_SetupWABQueries: Deleting Legacy Browse for domain %##s", ptr->domain.c);
5532 ptr->flag &= ~SLE_WAB_LBROWSE_QUERY_STARTED;
5533 uDNS_DeleteWABQueries(m, ptr, UDNS_WAB_LBROWSE_QUERY);
5534 }
5535
5536 if (!(action & UDNS_WAB_REG_QUERY) && (ptr->flag & SLE_WAB_REG_QUERY_STARTED) &&
5537 !SameDomainName(&ptr->domain, &localdomain) && (ptr->InterfaceID == mDNSInterface_Any))
5538 {
5539 LogInfo("uDNS_SetupWABQueries: Deleting Registration for domain %##s", ptr->domain.c);
5540 ptr->flag &= ~SLE_WAB_REG_QUERY_STARTED;
5541 uDNS_DeleteWABQueries(m, ptr, UDNS_WAB_REG_QUERY);
5542 }
5543
5544 // Fall through to handle the ADDs
5545 }
5546
5547 if ((action & UDNS_WAB_BROWSE_QUERY) && !(ptr->flag & SLE_WAB_BROWSE_QUERY_STARTED))
5548 {
5549 // If the user has "local" in their DNS searchlist, we ignore that for the purposes of domain enumeration queries.
5550 // Also, suppress the domain enumeration for scoped search domains for now until there is a need.
5551 if (!SameDomainName(&ptr->domain, &localdomain) && (ptr->InterfaceID == mDNSInterface_Any))
5552 {
5553 mStatus err1, err2;
5554 err1 = mDNS_GetDomains(m, &ptr->BrowseQ, mDNS_DomainTypeBrowse, &ptr->domain, ptr->InterfaceID, FoundDomain, ptr);
5555 if (err1)
5556 {
5557 LogMsg("uDNS_SetupWABQueries: GetDomains for domain %##s returned error(s):\n"
5558 "%d (mDNS_DomainTypeBrowse)\n", ptr->domain.c, err1);
5559 }
5560 else
5561 {
5562 LogInfo("uDNS_SetupWABQueries: Starting Browse for domain %##s", ptr->domain.c);
5563 }
5564 err2 = mDNS_GetDomains(m, &ptr->DefBrowseQ, mDNS_DomainTypeBrowseDefault, &ptr->domain, ptr->InterfaceID, FoundDomain, ptr);
5565 if (err2)
5566 {
5567 LogMsg("uDNS_SetupWABQueries: GetDomains for domain %##s returned error(s):\n"
5568 "%d (mDNS_DomainTypeBrowseDefault)\n", ptr->domain.c, err2);
5569 }
5570 else
5571 {
5572 LogInfo("uDNS_SetupWABQueries: Starting Default Browse for domain %##s", ptr->domain.c);
5573 }
5574 // For simplicity, we mark a single bit for denoting that both the browse queries have started.
5575 // It is not clear as to why one would fail to start and the other would succeed in starting up.
5576 // If that happens, we will try to stop both the queries and one of them won't be in the list and
5577 // it is not a hard error.
5578 if (!err1 || !err2)
5579 {
5580 ptr->flag |= SLE_WAB_BROWSE_QUERY_STARTED;
5581 }
5582 }
5583 }
5584 if ((action & UDNS_WAB_LBROWSE_QUERY) && !(ptr->flag & SLE_WAB_LBROWSE_QUERY_STARTED))
5585 {
5586 // If the user has "local" in their DNS searchlist, we ignore that for the purposes of domain enumeration queries.
5587 // Also, suppress the domain enumeration for scoped search domains for now until there is a need.
5588 if (!SameDomainName(&ptr->domain, &localdomain) && (ptr->InterfaceID == mDNSInterface_Any))
5589 {
5590 mStatus err1;
5591 err1 = mDNS_GetDomains(m, &ptr->AutomaticBrowseQ, mDNS_DomainTypeBrowseAutomatic, &ptr->domain, ptr->InterfaceID, FoundDomain, ptr);
5592 if (err1)
5593 {
5594 LogMsg("uDNS_SetupWABQueries: GetDomains for domain %##s returned error(s):\n"
5595 "%d (mDNS_DomainTypeBrowseAutomatic)\n",
5596 ptr->domain.c, err1);
5597 }
5598 else
5599 {
5600 ptr->flag |= SLE_WAB_LBROWSE_QUERY_STARTED;
5601 LogInfo("uDNS_SetupWABQueries: Starting Legacy Browse for domain %##s", ptr->domain.c);
5602 }
5603 }
5604 }
5605 if ((action & UDNS_WAB_REG_QUERY) && !(ptr->flag & SLE_WAB_REG_QUERY_STARTED))
5606 {
5607 // If the user has "local" in their DNS searchlist, we ignore that for the purposes of domain enumeration queries.
5608 // Also, suppress the domain enumeration for scoped search domains for now until there is a need.
5609 if (!SameDomainName(&ptr->domain, &localdomain) && (ptr->InterfaceID == mDNSInterface_Any))
5610 {
5611 mStatus err1, err2;
5612 err1 = mDNS_GetDomains(m, &ptr->RegisterQ, mDNS_DomainTypeRegistration, &ptr->domain, ptr->InterfaceID, FoundDomain, ptr);
5613 if (err1)
5614 {
5615 LogMsg("uDNS_SetupWABQueries: GetDomains for domain %##s returned error(s):\n"
5616 "%d (mDNS_DomainTypeRegistration)\n", ptr->domain.c, err1);
5617 }
5618 else
5619 {
5620 LogInfo("uDNS_SetupWABQueries: Starting Registration for domain %##s", ptr->domain.c);
5621 }
5622 err2 = mDNS_GetDomains(m, &ptr->DefRegisterQ, mDNS_DomainTypeRegistrationDefault, &ptr->domain, ptr->InterfaceID, FoundDomain, ptr);
5623 if (err2)
5624 {
5625 LogMsg("uDNS_SetupWABQueries: GetDomains for domain %##s returned error(s):\n"
5626 "%d (mDNS_DomainTypeRegistrationDefault)", ptr->domain.c, err2);
5627 }
5628 else
5629 {
5630 LogInfo("uDNS_SetupWABQueries: Starting Default Registration for domain %##s", ptr->domain.c);
5631 }
5632 if (!err1 || !err2)
5633 {
5634 ptr->flag |= SLE_WAB_REG_QUERY_STARTED;
5635 }
5636 }
5637 }
5638
5639 p = &ptr->next;
5640 }
5641 }
5642
5643 // mDNS_StartWABQueries is called once per API invocation where normally
5644 // one of the bits is set.
5645 mDNSexport void uDNS_StartWABQueries(mDNS *const m, int queryType)
5646 {
5647 if (queryType & UDNS_WAB_BROWSE_QUERY)
5648 {
5649 m->WABBrowseQueriesCount++;
5650 LogInfo("uDNS_StartWABQueries: Browse query count %d", m->WABBrowseQueriesCount);
5651 }
5652 if (queryType & UDNS_WAB_LBROWSE_QUERY)
5653 {
5654 m->WABLBrowseQueriesCount++;
5655 LogInfo("uDNS_StartWABQueries: Legacy Browse query count %d", m->WABLBrowseQueriesCount);
5656 }
5657 if (queryType & UDNS_WAB_REG_QUERY)
5658 {
5659 m->WABRegQueriesCount++;
5660 LogInfo("uDNS_StartWABQueries: Reg query count %d", m->WABRegQueriesCount);
5661 }
5662 uDNS_SetupWABQueries(m);
5663 }
5664
5665 // mDNS_StopWABQueries is called once per API invocation where normally
5666 // one of the bits is set.
5667 mDNSexport void uDNS_StopWABQueries(mDNS *const m, int queryType)
5668 {
5669 if (queryType & UDNS_WAB_BROWSE_QUERY)
5670 {
5671 m->WABBrowseQueriesCount--;
5672 LogInfo("uDNS_StopWABQueries: Browse query count %d", m->WABBrowseQueriesCount);
5673 }
5674 if (queryType & UDNS_WAB_LBROWSE_QUERY)
5675 {
5676 m->WABLBrowseQueriesCount--;
5677 LogInfo("uDNS_StopWABQueries: Legacy Browse query count %d", m->WABLBrowseQueriesCount);
5678 }
5679 if (queryType & UDNS_WAB_REG_QUERY)
5680 {
5681 m->WABRegQueriesCount--;
5682 LogInfo("uDNS_StopWABQueries: Reg query count %d", m->WABRegQueriesCount);
5683 }
5684 uDNS_SetupWABQueries(m);
5685 }
5686
5687 mDNSexport domainname *uDNS_GetNextSearchDomain(mDNSInterfaceID InterfaceID, mDNSs8 *searchIndex, mDNSBool ignoreDotLocal)
5688 {
5689 SearchListElem *p = SearchList;
5690 int count = *searchIndex;
5691
5692 if (count < 0) { LogMsg("uDNS_GetNextSearchDomain: count %d less than zero", count); return mDNSNULL; }
5693
5694 // Skip the domains that we already looked at before. Guard against "p"
5695 // being NULL. When search domains change we may not set the SearchListIndex
5696 // of the question to zero immediately e.g., domain enumeration query calls
5697 // uDNS_SetupWABQueries which reads in the new search domain but does not
5698 // restart the questions immediately. Questions are restarted as part of
5699 // network change and hence temporarily SearchListIndex may be out of range.
5700
5701 for (; count && p; count--)
5702 p = p->next;
5703
5704 while (p)
5705 {
5706 int labels = CountLabels(&p->domain);
5707 if (labels > 0)
5708 {
5709 const domainname *d = SkipLeadingLabels(&p->domain, labels - 1);
5710 if (SameDomainLabel(d->c, (const mDNSu8 *)"\x4" "arpa"))
5711 {
5712 LogInfo("uDNS_GetNextSearchDomain: skipping search domain %##s, InterfaceID %p", p->domain.c, p->InterfaceID);
5713 (*searchIndex)++;
5714 p = p->next;
5715 continue;
5716 }
5717 if (ignoreDotLocal && SameDomainLabel(d->c, (const mDNSu8 *)"\x5" "local"))
5718 {
5719 LogInfo("uDNS_GetNextSearchDomain: skipping local domain %##s, InterfaceID %p", p->domain.c, p->InterfaceID);
5720 (*searchIndex)++;
5721 p = p->next;
5722 continue;
5723 }
5724 }
5725 // Point to the next one in the list which we will look at next time.
5726 (*searchIndex)++;
5727 // When we are appending search domains in a ActiveDirectory domain, the question's InterfaceID
5728 // set to mDNSInterface_Unicast. Match the unscoped entries in that case.
5729 if (((InterfaceID == mDNSInterface_Unicast) && (p->InterfaceID == mDNSInterface_Any)) ||
5730 p->InterfaceID == InterfaceID)
5731 {
5732 LogInfo("uDNS_GetNextSearchDomain returning domain %##s, InterfaceID %p", p->domain.c, p->InterfaceID);
5733 return &p->domain;
5734 }
5735 LogInfo("uDNS_GetNextSearchDomain skipping domain %##s, InterfaceID %p", p->domain.c, p->InterfaceID);
5736 p = p->next;
5737 }
5738 return mDNSNULL;
5739 }
5740
5741 mDNSexport void uDNS_RestartQuestionAsTCP(mDNS *m, DNSQuestion *const q, const mDNSAddr *const srcaddr, const mDNSIPPort srcport)
5742 {
5743 // Don't reuse TCP connections. We might have failed over to a different DNS server
5744 // while the first TCP connection is in progress. We need a new TCP connection to the
5745 // new DNS server. So, always try to establish a new connection.
5746 if (q->tcp) { DisposeTCPConn(q->tcp); q->tcp = mDNSNULL; }
5747 q->tcp = MakeTCPConn(m, mDNSNULL, mDNSNULL, kTCPSocketFlags_Zero, srcaddr, srcport, mDNSNULL, q, mDNSNULL);
5748 }
5749
5750 mDNSlocal void FlushAddressCacheRecords(mDNS *const m)
5751 {
5752 mDNSu32 slot;
5753 CacheGroup *cg;
5754 CacheRecord *cr;
5755 FORALL_CACHERECORDS(slot, cg, cr)
5756 {
5757 if (cr->resrec.InterfaceID) continue;
5758
5759 // If a resource record can answer A or AAAA, they need to be flushed so that we will
5760 // deliver an ADD or RMV
5761 if (RRTypeAnswersQuestionType(&cr->resrec, kDNSType_A) ||
5762 RRTypeAnswersQuestionType(&cr->resrec, kDNSType_AAAA))
5763 {
5764 LogInfo("FlushAddressCacheRecords: Purging Resourcerecord %s", CRDisplayString(m, cr));
5765 mDNS_PurgeCacheResourceRecord(m, cr);
5766 }
5767 }
5768 }
5769
5770 // Retry questions which has seach domains appended
5771 mDNSexport void RetrySearchDomainQuestions(mDNS *const m)
5772 {
5773 DNSQuestion *q;
5774 mDNSBool found = mDNSfalse;
5775
5776 // Check to see if there are any questions which needs search domains to be applied.
5777 // If there is none, search domains can't possibly affect them.
5778 for (q = m->Questions; q; q = q->next)
5779 {
5780 if (q->AppendSearchDomains)
5781 {
5782 found = mDNStrue;
5783 break;
5784 }
5785 }
5786 if (!found)
5787 {
5788 LogInfo("RetrySearchDomainQuestions: Questions with AppendSearchDomain not found");
5789 return;
5790 }
5791 LogInfo("RetrySearchDomainQuestions: Question with AppendSearchDomain found %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5792 // Purge all the A/AAAA cache records and restart the queries. mDNSCoreRestartAddressQueries
5793 // does this. When we restart the question, we first want to try the new search domains rather
5794 // than use the entries that is already in the cache. When we appended search domains, we might
5795 // have created cache entries which is no longer valid as there are new search domains now
5796 mDNSCoreRestartAddressQueries(m, mDNStrue, FlushAddressCacheRecords, mDNSNULL, mDNSNULL);
5797 }
5798
5799 // Construction of Default Browse domain list (i.e. when clients pass NULL) is as follows:
5800 // 1) query for b._dns-sd._udp.local on LocalOnly interface
5801 // (.local manually generated via explicit callback)
5802 // 2) for each search domain (from prefs pane), query for b._dns-sd._udp.<searchdomain>.
5803 // 3) for each result from (2), register LocalOnly PTR record b._dns-sd._udp.local. -> <result>
5804 // 4) result above should generate a callback from question in (1). result added to global list
5805 // 5) global list delivered to client via GetSearchDomainList()
5806 // 6) client calls to enumerate domains now go over LocalOnly interface
5807 // (!!!KRS may add outgoing interface in addition)
5808
5809 struct CompileTimeAssertionChecks_uDNS
5810 {
5811 // Check our structures are reasonable sizes. Including overly-large buffers, or embedding
5812 // other overly-large structures instead of having a pointer to them, can inadvertently
5813 // cause structure sizes (and therefore memory usage) to balloon unreasonably.
5814 char sizecheck_tcpInfo_t [(sizeof(tcpInfo_t) <= 9056) ? 1 : -1];
5815 char sizecheck_SearchListElem[(sizeof(SearchListElem) <= 6136) ? 1 : -1];
5816 };
5817
5818 #if COMPILER_LIKES_PRAGMA_MARK
5819 #pragma mark - DNS Push Notification functions
5820 #endif
5821
5822 #ifdef DNS_PUSH_ENABLED
5823 mDNSlocal tcpInfo_t * GetTCPConnectionToPushServer(mDNS *m, DNSQuestion *q)
5824 {
5825 DNSPushNotificationZone *zone;
5826 DNSPushNotificationServer *server;
5827 DNSPushNotificationZone *newZone;
5828 DNSPushNotificationServer *newServer;
5829
5830 // If we already have a question for this zone and if the server is the same, reuse it
5831 for (zone = m->DNSPushZones; zone != mDNSNULL; zone = zone->next)
5832 {
5833 if (SameDomainName(&q->nta->ChildName, &zone->zoneName))
5834 {
5835 DNSPushNotificationServer *zoneServer = mDNSNULL;
5836 for (zoneServer = zone->servers; zoneServer != mDNSNULL; zoneServer = zoneServer->next)
5837 {
5838 if (mDNSSameAddress(&q->dnsPushServerAddr, &zoneServer->serverAddr))
5839 {
5840 zone->numberOfQuestions++;
5841 zoneServer->numberOfQuestions++;
5842 return zoneServer->connection;
5843 }
5844 }
5845 }
5846 }
5847
5848 // If we have a connection to this server but it is for a differnt zone, create a new zone entry and reuse the connection
5849 for (server = m->DNSPushServers; server != mDNSNULL; server = server->next)
5850 {
5851 if (mDNSSameAddress(&q->dnsPushServerAddr, &server->serverAddr))
5852 {
5853 newZone = mDNSPlatformMemAllocate(sizeof(DNSPushNotificationZone));
5854 newZone->numberOfQuestions = 1;
5855 newZone->zoneName = q->nta->ChildName;
5856 newZone->servers = server;
5857
5858 // Add the new zone to the begining of the list
5859 newZone->next = m->DNSPushZones;
5860 m->DNSPushZones = newZone;
5861
5862 server->numberOfQuestions++;
5863 return server->connection;
5864 }
5865 }
5866
5867 // If we do not have any existing connections, create a new connection
5868 newServer = mDNSPlatformMemAllocate(sizeof(DNSPushNotificationServer));
5869 newZone = mDNSPlatformMemAllocate(sizeof(DNSPushNotificationZone));
5870
5871 newServer->numberOfQuestions = 1;
5872 newServer->serverAddr = q->dnsPushServerAddr;
5873 newServer->connection = MakeTCPConn(m, mDNSNULL, mDNSNULL, kTCPSocketFlags_UseTLS, &q->dnsPushServerAddr, q->dnsPushServerPort, &q->nta->Host, q, mDNSNULL);
5874
5875 newZone->numberOfQuestions = 1;
5876 newZone->zoneName = q->nta->ChildName;
5877 newZone->servers = newServer;
5878
5879 // Add the new zone to the begining of the list
5880 newZone->next = m->DNSPushZones;
5881 m->DNSPushZones = newZone;
5882
5883 newServer->next = m->DNSPushServers;
5884 m->DNSPushServers = newServer;
5885 return newServer->connection;
5886 }
5887
5888 mDNSexport void DiscoverDNSPushNotificationServer(mDNS *m, DNSQuestion *q)
5889 {
5890 /* Use the same NAT setup as in the LLQ case */
5891 if (m->LLQNAT.clientContext != mDNSNULL) // LLQNAT just started, give it some time
5892 {
5893 LogInfo("startLLQHandshake: waiting for NAT status for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5894 q->ThisQInterval = LLQ_POLL_INTERVAL + mDNSRandom(LLQ_POLL_INTERVAL/10); // Retry in approx 15 minutes
5895 q->LastQTime = m->timenow;
5896 SetNextQueryTime(m, q);
5897 return;
5898 }
5899
5900 // Either we don't have {PCP, NAT-PMP, UPnP/IGD} support (ExternalPort is zero) or behind a Double NAT that may or
5901 // may not have {PCP, NAT-PMP, UPnP/IGD} support (NATResult is non-zero)
5902 if (mDNSIPPortIsZero(m->LLQNAT.ExternalPort) || m->LLQNAT.Result)
5903 {
5904 LogInfo("startLLQHandshake: Cannot receive inbound packets; will poll for %##s (%s) External Port %d, NAT Result %d",
5905 q->qname.c, DNSTypeName(q->qtype), mDNSVal16(m->LLQNAT.ExternalPort), m->LLQNAT.Result);
5906 StartLLQPolling(m, q); // Actually sets up the NAT Auto Tunnel
5907 return;
5908 }
5909
5910 if (mDNSIPPortIsZero(q->dnsPushServerPort) && q->dnsPushState == DNSPUSH_INIT)
5911 {
5912 LogInfo("SubscribeToDNSPushNotificationServer: StartGetZoneData for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5913 q->ThisQInterval = LLQ_POLL_INTERVAL + mDNSRandom(LLQ_POLL_INTERVAL/10); // Retry in approx 15 minutes
5914 q->LastQTime = m->timenow;
5915 SetNextQueryTime(m, q);
5916 q->dnsPushServerAddr = zeroAddr;
5917 // We know q->dnsPushServerPort is zero because of check above
5918 if (q->nta) CancelGetZoneData(m, q->nta);
5919 q->nta = StartGetZoneData(m, &q->qname, ZoneServiceDNSPush, DNSPushNotificationGotZoneData, q);
5920 return;
5921 }
5922
5923 if (q->tcp)
5924 {
5925 LogInfo("SubscribeToDNSPushNotificationServer: Disposing existing TCP connection for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5926 DisposeTCPConn(q->tcp);
5927 q->tcp = mDNSNULL;
5928 }
5929
5930 if (!q->nta)
5931 {
5932 // Normally we lookup the zone data and then call this function. And we never free the zone data
5933 // for "PrivateQuery". But sometimes this can happen due to some race conditions. When we
5934 // switch networks, we might end up "Polling" the network e.g., we are behind a Double NAT.
5935 // When we poll, we free the zone information as we send the query to the server (See
5936 // PrivateQueryGotZoneData). The NAT callback (LLQNATCallback) may happen soon after that. If we
5937 // are still behind Double NAT, we would have returned early in this function. But we could
5938 // have switched to a network with no NATs and we should get the zone data again.
5939 LogInfo("SubscribeToDNSPushNotificationServer: nta is NULL for %##s (%s)", q->qname.c, DNSTypeName(q->qtype));
5940 q->nta = StartGetZoneData(m, &q->qname, ZoneServiceDNSPush, DNSPushNotificationGotZoneData, q);
5941 return;
5942 }
5943 else if (!q->nta->Host.c[0])
5944 {
5945 // This should not happen. If it happens, we print a log and MakeTCPConn will fail if it can't find a hostname
5946 LogMsg("SubscribeToDNSPushNotificationServer: ERROR!!: nta non NULL for %##s (%s) but HostName %d NULL, LongLived %d", q->qname.c, DNSTypeName(q->qtype), q->nta->Host.c[0], q->LongLived);
5947 }
5948 q->tcp = GetTCPConnectionToPushServer(m,q);
5949 // If TCP failed (transient networking glitch) try again in five seconds
5950 q->ThisQInterval = (q->tcp != mDNSNULL) ? q->ThisQInterval = 0 : (mDNSPlatformOneSecond * 5);
5951 q->LastQTime = m->timenow;
5952 SetNextQueryTime(m, q);
5953 }
5954
5955
5956 mDNSexport void SubscribeToDNSPushNotificationServer(mDNS *m, DNSQuestion *q)
5957 {
5958 mDNSu8 *end = mDNSNULL;
5959 InitializeDNSMessage(&m->omsg.h, zeroID, SubscribeFlags);
5960 end = putQuestion(&m->omsg, end, m->omsg.data + AbsoluteMaxDNSMessageData, &q->qname, q->qtype, q->qclass);
5961 if (!end)
5962 {
5963 LogMsg("ERROR: SubscribeToDNSPushNotificationServer putQuestion failed");
5964 return;
5965 }
5966
5967 mDNSSendDNSMessage(m, &m->omsg, end, mDNSInterface_Any, q->LocalSocket, &q->dnsPushServerAddr, q->dnsPushServerPort, q->tcp->sock, mDNSNULL, mDNSfalse);
5968
5969 // update question state
5970 q->dnsPushState = DNSPUSH_ESTABLISHED;
5971 q->ThisQInterval = (kLLQ_INIT_RESEND * mDNSPlatformOneSecond);
5972 q->LastQTime = m->timenow;
5973 SetNextQueryTime(m, q);
5974
5975 }
5976
5977 mDNSlocal void reconcileDNSPushConnection(mDNS *m, DNSQuestion *q)
5978 {
5979 DNSPushNotificationZone *zone;
5980 DNSPushNotificationServer *server;
5981 DNSPushNotificationServer *nextServer;
5982 DNSPushNotificationZone *nextZone;
5983
5984 // Update the counts
5985 for (zone = m->DNSPushZones; zone != mDNSNULL; zone = zone->next)
5986 {
5987 if (SameDomainName(&zone->zoneName, &q->nta->ChildName))
5988 {
5989 zone->numberOfQuestions--;
5990 for (server = zone->servers; server != mDNSNULL; server = server->next)
5991 {
5992 if (mDNSSameAddress(&server->serverAddr, &q->dnsPushServerAddr))
5993 server->numberOfQuestions--;
5994 }
5995 }
5996 }
5997
5998 // Now prune the lists
5999 server = m->DNSPushServers;
6000 nextServer = mDNSNULL;
6001 while(server != mDNSNULL)
6002 {
6003 nextServer = server->next;
6004 if (server->numberOfQuestions <= 0)
6005 {
6006 DisposeTCPConn(server->connection);
6007 if (server == m->DNSPushServers)
6008 m->DNSPushServers = nextServer;
6009 mDNSPlatformMemFree(server);
6010 server = nextServer;
6011 }
6012 else server = server->next;
6013 }
6014
6015 zone = m->DNSPushZones;
6016 nextZone = mDNSNULL;
6017 while(zone != mDNSNULL)
6018 {
6019 nextZone = zone->next;
6020 if (zone->numberOfQuestions <= 0)
6021 {
6022 if (zone == m->DNSPushZones)
6023 m->DNSPushZones = nextZone;
6024 mDNSPlatformMemFree(zone);
6025 zone = nextZone;
6026 }
6027 else zone = zone->next;
6028 }
6029
6030 }
6031
6032 mDNSexport void UnSubscribeToDNSPushNotificationServer(mDNS *m, DNSQuestion *q)
6033 {
6034 mDNSu8 *end = mDNSNULL;
6035 InitializeDNSMessage(&m->omsg.h, q->TargetQID, UnSubscribeFlags);
6036 end = putQuestion(&m->omsg, end, m->omsg.data + AbsoluteMaxDNSMessageData, &q->qname, q->qtype, q->qclass);
6037 if (!end)
6038 {
6039 LogMsg("ERROR: UnSubscribeToDNSPushNotificationServer - putQuestion failed");
6040 return;
6041 }
6042
6043 mDNSSendDNSMessage(m, &m->omsg, end, mDNSInterface_Any, q->LocalSocket, &q->dnsPushServerAddr, q->dnsPushServerPort, q->tcp->sock, mDNSNULL, mDNSfalse);
6044
6045 reconcileDNSPushConnection(m, q);
6046 }
6047
6048 #endif // DNS_PUSH_ENABLED
6049 #if COMPILER_LIKES_PRAGMA_MARK
6050 #pragma mark -
6051 #endif
6052 #else // !UNICAST_DISABLED
6053
6054 mDNSexport const domainname *GetServiceTarget(mDNS *m, AuthRecord *const rr)
6055 {
6056 (void) m;
6057 (void) rr;
6058
6059 return mDNSNULL;
6060 }
6061
6062 mDNSexport DomainAuthInfo *GetAuthInfoForName_internal(mDNS *m, const domainname *const name)
6063 {
6064 (void) m;
6065 (void) name;
6066
6067 return mDNSNULL;
6068 }
6069
6070 mDNSexport DomainAuthInfo *GetAuthInfoForQuestion(mDNS *m, const DNSQuestion *const q)
6071 {
6072 (void) m;
6073 (void) q;
6074
6075 return mDNSNULL;
6076 }
6077
6078 mDNSexport void startLLQHandshake(mDNS *m, DNSQuestion *q)
6079 {
6080 (void) m;
6081 (void) q;
6082 }
6083
6084 mDNSexport void DisposeTCPConn(struct tcpInfo_t *tcp)
6085 {
6086 (void) tcp;
6087 }
6088
6089 mDNSexport mStatus mDNS_StartNATOperation_internal(mDNS *m, NATTraversalInfo *traversal)
6090 {
6091 (void) m;
6092 (void) traversal;
6093
6094 return mStatus_UnsupportedErr;
6095 }
6096
6097 mDNSexport mStatus mDNS_StopNATOperation_internal(mDNS *m, NATTraversalInfo *traversal)
6098 {
6099 (void) m;
6100 (void) traversal;
6101
6102 return mStatus_UnsupportedErr;
6103 }
6104
6105 mDNSexport void sendLLQRefresh(mDNS *m, DNSQuestion *q)
6106 {
6107 (void) m;
6108 (void) q;
6109 }
6110
6111 mDNSexport ZoneData *StartGetZoneData(mDNS *const m, const domainname *const name, const ZoneService target, ZoneDataCallback callback, void *ZoneDataContext)
6112 {
6113 (void) m;
6114 (void) name;
6115 (void) target;
6116 (void) callback;
6117 (void) ZoneDataContext;
6118
6119 return mDNSNULL;
6120 }
6121
6122 mDNSexport void RecordRegistrationGotZoneData(mDNS *const m, mStatus err, const ZoneData *zoneData)
6123 {
6124 (void) m;
6125 (void) err;
6126 (void) zoneData;
6127 }
6128
6129 mDNSexport uDNS_LLQType uDNS_recvLLQResponse(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *const end,
6130 const mDNSAddr *const srcaddr, const mDNSIPPort srcport, DNSQuestion **matchQuestion)
6131 {
6132 (void) m;
6133 (void) msg;
6134 (void) end;
6135 (void) srcaddr;
6136 (void) srcport;
6137 (void) matchQuestion;
6138
6139 return uDNS_LLQ_Not;
6140 }
6141
6142 mDNSexport void PenalizeDNSServer(mDNS *const m, DNSQuestion *q, mDNSOpaque16 responseFlags)
6143 {
6144 (void) m;
6145 (void) q;
6146 (void) responseFlags;
6147 }
6148
6149 mDNSexport void mDNS_AddSearchDomain(const domainname *const domain, mDNSInterfaceID InterfaceID)
6150 {
6151 (void) domain;
6152 (void) InterfaceID;
6153 }
6154
6155 mDNSexport void RetrySearchDomainQuestions(mDNS *const m)
6156 {
6157 (void) m;
6158 }
6159
6160 mDNSexport mStatus mDNS_SetSecretForDomain(mDNS *m, DomainAuthInfo *info, const domainname *domain, const domainname *keyname, const char *b64keydata, const domainname *hostname, mDNSIPPort *port, mDNSBool autoTunnel)
6161 {
6162 (void) m;
6163 (void) info;
6164 (void) domain;
6165 (void) keyname;
6166 (void) b64keydata;
6167 (void) hostname;
6168 (void) port;
6169 (void) autoTunnel;
6170
6171 return mStatus_UnsupportedErr;
6172 }
6173
6174 mDNSexport domainname *uDNS_GetNextSearchDomain(mDNSInterfaceID InterfaceID, mDNSs8 *searchIndex, mDNSBool ignoreDotLocal)
6175 {
6176 (void) InterfaceID;
6177 (void) searchIndex;
6178 (void) ignoreDotLocal;
6179
6180 return mDNSNULL;
6181 }
6182
6183 mDNSexport DomainAuthInfo *GetAuthInfoForName(mDNS *m, const domainname *const name)
6184 {
6185 (void) m;
6186 (void) name;
6187
6188 return mDNSNULL;
6189 }
6190
6191 mDNSexport mStatus mDNS_StartNATOperation(mDNS *const m, NATTraversalInfo *traversal)
6192 {
6193 (void) m;
6194 (void) traversal;
6195
6196 return mStatus_UnsupportedErr;
6197 }
6198
6199 mDNSexport mStatus mDNS_StopNATOperation(mDNS *const m, NATTraversalInfo *traversal)
6200 {
6201 (void) m;
6202 (void) traversal;
6203
6204 return mStatus_UnsupportedErr;
6205 }
6206
6207 mDNSexport DNSServer *mDNS_AddDNSServer(mDNS *const m, const domainname *d, const mDNSInterfaceID interface, const mDNSs32 serviceID, const mDNSAddr *addr,
6208 const mDNSIPPort port, mDNSu32 scoped, mDNSu32 timeout, mDNSBool cellIntf, mDNSBool isExpensive, mDNSu16 resGroupID,
6209 mDNSBool reqA, mDNSBool reqAAAA, mDNSBool reqDO)
6210 {
6211 (void) m;
6212 (void) d;
6213 (void) interface;
6214 (void) serviceID;
6215 (void) addr;
6216 (void) port;
6217 (void) scoped;
6218 (void) timeout;
6219 (void) cellIntf;
6220 (void) isExpensive;
6221 (void) resGroupID;
6222 (void) reqA;
6223 (void) reqAAAA;
6224 (void) reqDO;
6225
6226 return mDNSNULL;
6227 }
6228
6229 mDNSexport void uDNS_SetupWABQueries(mDNS *const m)
6230 {
6231 (void) m;
6232 }
6233
6234 mDNSexport void uDNS_StartWABQueries(mDNS *const m, int queryType)
6235 {
6236 (void) m;
6237 (void) queryType;
6238 }
6239
6240 mDNSexport void uDNS_StopWABQueries(mDNS *const m, int queryType)
6241 {
6242 (void) m;
6243 (void) queryType;
6244 }
6245
6246 mDNSexport void mDNS_AddDynDNSHostName(mDNS *m, const domainname *fqdn, mDNSRecordCallback *StatusCallback, const void *StatusContext)
6247 {
6248 (void) m;
6249 (void) fqdn;
6250 (void) StatusCallback;
6251 (void) StatusContext;
6252 }
6253 mDNSexport void mDNS_SetPrimaryInterfaceInfo(mDNS *m, const mDNSAddr *v4addr, const mDNSAddr *v6addr, const mDNSAddr *router)
6254 {
6255 (void) m;
6256 (void) v4addr;
6257 (void) v6addr;
6258 (void) router;
6259 }
6260
6261 mDNSexport void mDNS_RemoveDynDNSHostName(mDNS *m, const domainname *fqdn)
6262 {
6263 (void) m;
6264 (void) fqdn;
6265 }
6266
6267 mDNSexport void RecreateNATMappings(mDNS *const m, const mDNSu32 waitTicks)
6268 {
6269 (void) m;
6270 (void) waitTicks;
6271 }
6272
6273 mDNSexport mDNSBool IsGetZoneDataQuestion(DNSQuestion *q)
6274 {
6275 (void)q;
6276
6277 return mDNSfalse;
6278 }
6279
6280 mDNSexport void SubscribeToDNSPushNotificationServer(mDNS *m, DNSQuestion *q)
6281 {
6282 (void)m;
6283 (void)q;
6284 }
6285
6286 mDNSexport void UnSubscribeToDNSPushNotificationServer(mDNS *m, DNSQuestion *q)
6287 {
6288 (void)m;
6289 (void)q;
6290 }
6291
6292 mDNSexport void DiscoverDNSPushNotificationServer(mDNS *m, DNSQuestion *q)
6293 {
6294 (void)m;
6295 (void)q;
6296 }
6297
6298 #endif // !UNICAST_DISABLED
6299