147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt/* -*- Mode: C; tab-width: 4 -*- 247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * 347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * Copyright (c) 2002-2003 Apple Computer, Inc. All rights reserved. 447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * 547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * Licensed under the Apache License, Version 2.0 (the "License"); 647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * you may not use this file except in compliance with the License. 747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * You may obtain a copy of the License at 847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * 947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * http://www.apache.org/licenses/LICENSE-2.0 1047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * 1147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * Unless required by applicable law or agreed to in writing, software 1247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * distributed under the License is distributed on an "AS IS" BASIS, 1347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * See the License for the specific language governing permissions and 1547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt * limitations under the License. 1647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt */ 1747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 1847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#ifndef __UDNS_H_ 1947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define __UDNS_H_ 2047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 2147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#include "mDNSEmbeddedAPI.h" 2247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#include "DNSCommon.h" 2347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 2447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#ifdef __cplusplus 2547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt extern "C" { 2647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#endif 2747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 2847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define RESTART_GOODBYE_DELAY (6 * mDNSPlatformOneSecond) // delay after restarting LLQ before nuking previous known answers (avoids flutter if we restart before we have networking up) 2947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define INIT_UCAST_POLL_INTERVAL (3 * mDNSPlatformOneSecond) // this interval is used after send failures on network transitions 3047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt // which typically heal quickly, so we start agressively and exponentially back off 3147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define MAX_UCAST_POLL_INTERVAL (60 * 60 * mDNSPlatformOneSecond) 3247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt//#define MAX_UCAST_POLL_INTERVAL (1 * 60 * mDNSPlatformOneSecond) 3347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define LLQ_POLL_INTERVAL (15 * 60 * mDNSPlatformOneSecond) // Polling interval for zones w/ an advertised LLQ port (ie not static zones) if LLQ fails due to NAT, etc. 3447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define RESPONSE_WINDOW (60 * mDNSPlatformOneSecond) // require server responses within one minute of request 3547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define MAX_UCAST_UNANSWERED_QUERIES 2 // the number of unanswered queries from any one uDNS server before trying another server 3647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define DNSSERVER_PENALTY_TIME (60 * mDNSPlatformOneSecond) // number of seconds for which new questions don't pick this server 3747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 3847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define DEFAULT_UPDATE_LEASE 7200 3947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 4047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define QuestionIntervalStep 3 4147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define QuestionIntervalStep2 (QuestionIntervalStep*QuestionIntervalStep) 4247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define QuestionIntervalStep3 (QuestionIntervalStep*QuestionIntervalStep*QuestionIntervalStep) 4347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define InitialQuestionInterval ((mDNSPlatformOneSecond + QuestionIntervalStep-1) / QuestionIntervalStep) 4447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 4547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// For Unicast record registrations, we initialize the interval to 1 second. When we send any query for 4647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// the record registration e.g., GetZoneData, we always back off by QuestionIntervalStep 4747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// so that the first retry does not happen until 3 seconds which should be enough for TCP/TLS to be done. 4847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define INIT_RECORD_REG_INTERVAL (1 * mDNSPlatformOneSecond) 4947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define MAX_RECORD_REG_INTERVAL (15 * 60 * mDNSPlatformOneSecond) 5047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define MERGE_DELAY_TIME (1 * mDNSPlatformOneSecond) 5147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 5247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// If we are refreshing, we do it at least 5 times with a min update frequency of 5347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// 5 minutes 5447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define MAX_UPDATE_REFRESH_COUNT 5 5547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define MIN_UPDATE_REFRESH_TIME (5 * 60 * mDNSPlatformOneSecond) 5647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 5747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// For questions that use kDNSServiceFlagsTimeout and we don't have a matching resolver e.g., no dns servers, 5847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// then use the default value of 30 seconds 5947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define DEFAULT_UDNS_TIMEOUT 30 // in seconds 6047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 6147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// Entry points into unicast-specific routines 6247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 6347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void LLQGotZoneData(mDNS *const m, mStatus err, const ZoneData *zoneInfo); 6447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void startLLQHandshake(mDNS *m, DNSQuestion *q); 6547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void sendLLQRefresh(mDNS *m, DNSQuestion *q); 6647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 6747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void SleepRecordRegistrations(mDNS *m); 6847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 6947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// uDNS_UpdateRecord 7047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// following fields must be set, and the update validated, upon entry. 7147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// rr->NewRData 7247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// rr->newrdlength 7347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// rr->UpdateCallback 7447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 7547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern mStatus uDNS_UpdateRecord(mDNS *m, AuthRecord *rr); 7647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 7747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void SetNextQueryTime(mDNS *const m, const DNSQuestion *const q); 7847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern CacheGroup *CacheGroupForName(const mDNS *const m, const mDNSu32 slot, const mDNSu32 namehash, const domainname *const name); 7947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern mStatus mDNS_Register_internal(mDNS *const m, AuthRecord *const rr); 8047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern mStatus mDNS_Deregister_internal(mDNS *const m, AuthRecord *const rr, mDNS_Dereg_type drt); 8147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern mStatus mDNS_StartQuery_internal(mDNS *const m, DNSQuestion *const question); 8247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern mStatus mDNS_StopQuery_internal(mDNS *const m, DNSQuestion *const question); 8347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern mStatus mDNS_StartNATOperation_internal(mDNS *const m, NATTraversalInfo *traversal); 8447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 8547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void RecordRegistrationGotZoneData(mDNS *const m, mStatus err, const ZoneData *zoneData); 8647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern mStatus uDNS_DeregisterRecord(mDNS *const m, AuthRecord *const rr); 8747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern const domainname *GetServiceTarget(mDNS *m, AuthRecord *const rr); 8847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void uDNS_CheckCurrentQuestion(mDNS *const m); 8947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 9047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// integer fields of msg header must be in HOST byte order before calling this routine 9147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void uDNS_ReceiveMsg(mDNS *const m, DNSMessage *const msg, const mDNSu8 *const end, 9247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt const mDNSAddr *const srcaddr, const mDNSIPPort srcport); 9347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 9447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void uDNS_Tasks(mDNS *const m); 9547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void UpdateAllSRVRecords(mDNS *m); 9647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void CheckNATMappings(mDNS *m); 9747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 9847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern mStatus uDNS_SetupDNSConfig(mDNS *const m); 9947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 10047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// uDNS_SetupSearchDomains by default adds search domains. It also can be called with one or 10147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// more values for "action" which does the following: 10247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// 10347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// -UDNS_START_WAB_QUERY - start Wide Area Bonjour (domain enumeration) queries 10447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 10547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#define UDNS_START_WAB_QUERY 0x00000001 10647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 10747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern mStatus uDNS_SetupSearchDomains(mDNS *const m, int action); 10847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern domainname *uDNS_GetNextSearchDomain(mDNS *const m, mDNSInterfaceID InterfaceID, mDNSs8 *searchIndex, mDNSBool ignoreDotLocal); 10947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 11047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalttypedef enum 11147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt { 11247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt uDNS_LLQ_Not = 0, // Normal uDNS answer: Flush any stale records from cache, and respect record TTL 11347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt uDNS_LLQ_Ignore, // LLQ initial challenge packet: ignore -- has no useful records for us 11447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt uDNS_LLQ_Entire, // LLQ initial set of answers: Flush any stale records from cache, but assume TTL is 2 x LLQ refresh interval 11547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt uDNS_LLQ_Events // LLQ event packet: don't flush cache; assume TTL is 2 x LLQ refresh interval 11647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt } uDNS_LLQType; 11747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 11847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern uDNS_LLQType uDNS_recvLLQResponse(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *const end, const mDNSAddr *const srcaddr, const mDNSIPPort srcport, DNSQuestion **matchQuestion); 11947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern DomainAuthInfo *GetAuthInfoForName_internal(mDNS *m, const domainname *const name); 12047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern DomainAuthInfo *GetAuthInfoForQuestion(mDNS *m, const DNSQuestion *const q); 12147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void DisposeTCPConn(struct tcpInfo_t *tcp); 12247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 12347e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt// NAT traversal 12447e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void uDNS_ReceiveNATPMPPacket(mDNS *m, const mDNSInterfaceID InterfaceID, mDNSu8 *pkt, mDNSu16 len); // Called for each received NAT-PMP packet 12547e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void natTraversalHandleAddressReply(mDNS *const m, mDNSu16 err, mDNSv4Addr ExtAddr); 12647e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwaltextern void natTraversalHandlePortMapReply(mDNS *const m, NATTraversalInfo *n, const mDNSInterfaceID InterfaceID, mDNSu16 err, mDNSIPPort extport, mDNSu32 lease); 12747e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 12847e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#ifdef __cplusplus 12947e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt } 13047e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#endif 13147e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt 13247e4cebad7397422144bb03a21f3f7682c062c4aRobert Greenwalt#endif // __UDNS_H_ 133