]> git.saurik.com Git - apple/mdnsresponder.git/blob - mDNSCore/DNSCommon.h
52169dea4f8c82d3c14a85b91e993c3b2cbb70c9
[apple/mdnsresponder.git] / mDNSCore / DNSCommon.h
1 /* -*- Mode: C; tab-width: 4 -*-
2 *
3 * Copyright (c) 2002-2003 Apple Computer, Inc. All rights reserved.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16
17 Change History (most recent first):
18
19 $Log: DNSCommon.h,v $
20 Revision 1.60 2008/07/24 20:23:03 cheshire
21 <rdar://problem/3988320> Should use randomized source ports and transaction IDs to avoid DNS cache poisoning
22
23 Revision 1.59 2008/03/14 19:58:38 mcguire
24 <rdar://problem/5500969> BTMM: Need ability to identify version of mDNSResponder client
25 Make sure we add the record when sending LLQ refreshes
26
27 Revision 1.58 2008/03/06 21:26:10 cheshire
28 Moved duplicated STRINGIFY macro from individual C files to DNSCommon.h
29
30 Revision 1.57 2007/12/13 20:20:17 cheshire
31 Minor efficiency tweaks -- converted IdenticalResourceRecord, IdenticalSameNameRecord, and
32 SameRData from functions to macros, which allows the code to be inlined (the compiler can't
33 inline a function defined in a different compilation unit) and therefore optimized better.
34
35 Revision 1.56 2007/12/13 00:13:03 cheshire
36 Simplified RDataHashValue to take a single ResourceRecord pointer, instead of separate rdlength and RDataBody
37
38 Revision 1.55 2007/12/13 00:09:28 cheshire
39 For completeness added MX, AFSDB, RT, KX to list of RRTYPES that are considered to have a target domainname in their rdata
40
41 Revision 1.54 2007/10/05 17:56:10 cheshire
42 Move CountLabels and SkipLeadingLabels to DNSCommon.c so they're callable from other files
43
44 Revision 1.53 2007/09/27 17:42:49 cheshire
45 Fix naming: for consistency, "kDNSFlag1_RC" should be "kDNSFlag1_RC_Mask"
46
47 Revision 1.52 2007/09/26 00:49:46 cheshire
48 Improve packet logging to show sent and received packets,
49 transport protocol (UDP/TCP/TLS) and source/destination address:port
50
51 Revision 1.51 2007/09/21 21:12:36 cheshire
52 <rdar://problem/5498009> BTMM: Need to log updates and query packet contents
53
54 Revision 1.50 2007/09/20 01:12:06 cheshire
55 Moved HashSlot(X) from mDNS.c to DNSCommon.h so it's usable in other files
56
57 Revision 1.49 2007/08/30 00:31:20 cheshire
58 Improve "locking failure" debugging messages to show function name using __func__ macro
59
60 Revision 1.48 2007/05/25 00:25:44 cheshire
61 <rdar://problem/5227737> Need to enhance putRData to output all current known types
62
63 Revision 1.47 2007/05/01 21:46:31 cheshire
64 Move GetLLQOptData/GetPktLease from uDNS.c into DNSCommon.c so that dnsextd can use them
65
66 Revision 1.46 2007/04/22 20:18:10 cheshire
67 Add comment about mDNSRandom()
68
69 Revision 1.45 2007/04/22 06:02:02 cheshire
70 <rdar://problem/4615977> Query should immediately return failure when no server
71
72 Revision 1.44 2007/03/28 01:20:05 cheshire
73 <rdar://problem/4883206> Improve/create logging for secure browse
74
75 Revision 1.43 2007/03/20 17:07:15 cheshire
76 Rename "struct uDNS_TCPSocket_struct" to "TCPSocket", "struct uDNS_UDPSocket_struct" to "UDPSocket"
77
78 Revision 1.42 2007/03/10 03:26:44 cheshire
79 <rdar://problem/4961667> uDNS: LLQ refresh response packet causes cached records to be removed from cache
80
81 Revision 1.41 2007/01/18 23:18:17 cheshire
82 Source code tidying: Delete extraneous white space
83
84 Revision 1.40 2007/01/05 08:30:40 cheshire
85 Trim excessive "$Log" checkin history from before 2006
86 (checkin history still available via "cvs log ..." of course)
87
88 Revision 1.39 2007/01/04 21:45:20 cheshire
89 Added mDNS_DropLockBeforeCallback/mDNS_ReclaimLockAfterCallback macros,
90 to do additional lock sanity checking around callback invocations
91
92 Revision 1.38 2006/12/22 20:59:49 cheshire
93 <rdar://problem/4742742> Read *all* DNS keys from keychain,
94 not just key for the system-wide default registration domain
95
96 Revision 1.37 2006/08/14 23:24:22 cheshire
97 Re-licensed mDNSResponder daemon source code under Apache License, Version 2.0
98
99 Revision 1.36 2006/07/05 22:56:07 cheshire
100 <rdar://problem/4472014> Add Private DNS client functionality to mDNSResponder
101 Update mDNSSendDNSMessage() to use uDNS_TCPSocket type instead of "int"
102
103 Revision 1.35 2006/06/29 07:42:14 cheshire
104 <rdar://problem/3922989> Performance: Remove unnecessary SameDomainName() checks
105
106 Revision 1.34 2006/03/18 21:47:56 cheshire
107 <rdar://problem/4073825> Improve logic for delaying packets after repeated interface transitions
108
109 Revision 1.33 2006/03/10 21:51:41 cheshire
110 <rdar://problem/4111464> After record update, old record sometimes remains in cache
111 Split out SameRDataBody() into a separate routine so it can be called from other code
112
113 */
114
115 #ifndef __DNSCOMMON_H_
116 #define __DNSCOMMON_H_
117
118 #include "mDNSEmbeddedAPI.h"
119
120 #ifdef __cplusplus
121 extern "C" {
122 #endif
123
124 //*************************************************************************************************************
125 // Macros
126
127 // Note: The C preprocessor stringify operator ('#') makes a string from its argument, without macro expansion
128 // e.g. If "version" is #define'd to be "4", then STRINGIFY_AWE(version) will return the string "version", not "4"
129 // To expand "version" to its value before making the string, use STRINGIFY(version) instead
130 #define STRINGIFY_ARGUMENT_WITHOUT_EXPANSION(s) #s
131 #define STRINGIFY(s) STRINGIFY_ARGUMENT_WITHOUT_EXPANSION(s)
132
133 // ***************************************************************************
134 #if COMPILER_LIKES_PRAGMA_MARK
135 #pragma mark - DNS Protocol Constants
136 #endif
137
138 typedef enum
139 {
140 kDNSFlag0_QR_Mask = 0x80, // Query or response?
141 kDNSFlag0_QR_Query = 0x00,
142 kDNSFlag0_QR_Response = 0x80,
143
144 kDNSFlag0_OP_Mask = 0x78, // Operation type
145 kDNSFlag0_OP_StdQuery = 0x00,
146 kDNSFlag0_OP_Iquery = 0x08,
147 kDNSFlag0_OP_Status = 0x10,
148 kDNSFlag0_OP_Unused3 = 0x18,
149 kDNSFlag0_OP_Notify = 0x20,
150 kDNSFlag0_OP_Update = 0x28,
151
152 kDNSFlag0_QROP_Mask = kDNSFlag0_QR_Mask | kDNSFlag0_OP_Mask,
153
154 kDNSFlag0_AA = 0x04, // Authoritative Answer?
155 kDNSFlag0_TC = 0x02, // Truncated?
156 kDNSFlag0_RD = 0x01, // Recursion Desired?
157 kDNSFlag1_RA = 0x80, // Recursion Available?
158
159 kDNSFlag1_Zero = 0x40, // Reserved; must be zero
160 kDNSFlag1_AD = 0x20, // Authentic Data [RFC 2535]
161 kDNSFlag1_CD = 0x10, // Checking Disabled [RFC 2535]
162
163 kDNSFlag1_RC_Mask = 0x0F, // Response code
164 kDNSFlag1_RC_NoErr = 0x00,
165 kDNSFlag1_RC_FmtErr = 0x01,
166 kDNSFlag1_RC_SrvErr = 0x02,
167 kDNSFlag1_RC_NXDomain = 0x03,
168 kDNSFlag1_RC_NotImpl = 0x04,
169 kDNSFlag1_RC_Refused = 0x05,
170 kDNSFlag1_RC_YXDomain = 0x06,
171 kDNSFlag1_RC_YXRRSet = 0x07,
172 kDNSFlag1_RC_NXRRSet = 0x08,
173 kDNSFlag1_RC_NotAuth = 0x09,
174 kDNSFlag1_RC_NotZone = 0x0A
175 } DNS_Flags;
176
177 typedef enum
178 {
179 TSIG_ErrBadSig = 16,
180 TSIG_ErrBadKey = 17,
181 TSIG_ErrBadTime = 18
182 } TSIG_ErrorCode;
183
184 // ***************************************************************************
185 #if COMPILER_LIKES_PRAGMA_MARK
186 #pragma mark -
187 #pragma mark - General Utility Functions
188 #endif
189
190 extern const NetworkInterfaceInfo *GetFirstActiveInterface(const NetworkInterfaceInfo *intf);
191 extern mDNSInterfaceID GetNextActiveInterfaceID(const NetworkInterfaceInfo *intf);
192
193 extern mDNSu32 mDNSRandom(mDNSu32 max); // Returns pseudo-random result from zero to max inclusive
194 extern mDNSu32 mDNSRandomFromFixedSeed(mDNSu32 seed, mDNSu32 max);
195
196 // ***************************************************************************
197 #if COMPILER_LIKES_PRAGMA_MARK
198 #pragma mark -
199 #pragma mark - Domain Name Utility Functions
200 #endif
201
202 #define mdnsIsDigit(X) ((X) >= '0' && (X) <= '9')
203 #define mDNSIsUpperCase(X) ((X) >= 'A' && (X) <= 'Z')
204 #define mDNSIsLowerCase(X) ((X) >= 'a' && (X) <= 'z')
205 #define mdnsIsLetter(X) (mDNSIsUpperCase(X) || mDNSIsLowerCase(X))
206
207 #define mdnsValidHostChar(X, notfirst, notlast) (mdnsIsLetter(X) || mdnsIsDigit(X) || ((notfirst) && (notlast) && (X) == '-') )
208
209 extern mDNSu16 CompressedDomainNameLength(const domainname *const name, const domainname *parent);
210 extern int CountLabels(const domainname *d);
211 extern const domainname *SkipLeadingLabels(const domainname *d, int skip);
212
213 extern mDNSu32 TruncateUTF8ToLength(mDNSu8 *string, mDNSu32 length, mDNSu32 max);
214 extern mDNSBool LabelContainsSuffix(const domainlabel *const name, const mDNSBool RichText);
215 extern mDNSu32 RemoveLabelSuffix(domainlabel *name, mDNSBool RichText);
216 extern void AppendLabelSuffix(domainlabel *name, mDNSu32 val, mDNSBool RichText);
217 #define ValidateDomainName(N) (DomainNameLength(N) <= MAX_DOMAIN_NAME)
218
219 // ***************************************************************************
220 #if COMPILER_LIKES_PRAGMA_MARK
221 #pragma mark -
222 #pragma mark - Resource Record Utility Functions
223 #endif
224
225 // IdenticalResourceRecord returns true if two resources records have
226 // the same name, type, class, and identical rdata (InterfaceID and TTL may differ)
227
228 // IdenticalSameNameRecord is the same, except it skips the expensive SameDomainName() check,
229 // which is at its most expensive and least useful in cases where we know in advance that the names match
230
231 // Note: The dominant use of IdenticalResourceRecord is from ProcessQuery(), handling known-answer lists. In this case
232 // it's common to have a whole bunch or records with exactly the same name (e.g. "_http._tcp.local") but different RDATA.
233 // The SameDomainName() check is expensive when the names match, and in this case *all* the names match, so we
234 // used to waste a lot of CPU time verifying that the names match, only then to find that the RDATA is different.
235 // We observed mDNSResponder spending 30% of its total CPU time on this single task alone.
236 // By swapping the checks so that we check the RDATA first, we can quickly detect when it's different
237 // (99% of the time) and then bail out before we waste time on the expensive SameDomainName() check.
238
239 #define IdenticalResourceRecord(r1,r2) ( \
240 (r1)->rrtype == (r2)->rrtype && \
241 (r1)->rrclass == (r2)->rrclass && \
242 (r1)->namehash == (r2)->namehash && \
243 (r1)->rdlength == (r2)->rdlength && \
244 (r1)->rdatahash == (r2)->rdatahash && \
245 SameRDataBody((r1), &(r2)->rdata->u) && \
246 SameDomainName((r1)->name, (r2)->name))
247
248 #define IdenticalSameNameRecord(r1,r2) ( \
249 (r1)->rrtype == (r2)->rrtype && \
250 (r1)->rrclass == (r2)->rrclass && \
251 (r1)->rdlength == (r2)->rdlength && \
252 (r1)->rdatahash == (r2)->rdatahash && \
253 SameRDataBody((r1), &(r2)->rdata->u))
254
255 extern mDNSu32 RDataHashValue(const ResourceRecord *const rr);
256 extern mDNSBool SameRDataBody(const ResourceRecord *const r1, const RDataBody *const r2);
257 #define SameRData(r1,r2) ((r1)->rrtype == (r2)->rrtype && (r1)->rdlength == (r2)->rdlength && (r1)->rdatahash == (r2)->rdatahash && SameRDataBody((r1), &(r2)->rdata->u))
258 extern mDNSBool ResourceRecordAnswersQuestion(const ResourceRecord *const rr, const DNSQuestion *const q);
259 extern mDNSBool SameNameRecordAnswersQuestion(const ResourceRecord *const rr, const DNSQuestion *const q);
260 extern mDNSu16 GetRDLength(const ResourceRecord *const rr, mDNSBool estimate);
261 extern mDNSBool ValidateRData(const mDNSu16 rrtype, const mDNSu16 rdlength, const RData *const rd);
262
263 #define GetRRDomainNameTarget(RR) ( \
264 ((RR)->rrtype == kDNSType_NS || (RR)->rrtype == kDNSType_CNAME || (RR)->rrtype == kDNSType_PTR || (RR)->rrtype == kDNSType_DNAME) ? &(RR)->rdata->u.name : \
265 ((RR)->rrtype == kDNSType_MX || (RR)->rrtype == kDNSType_AFSDB || (RR)->rrtype == kDNSType_RT || (RR)->rrtype == kDNSType_KX ) ? &(RR)->rdata->u.mx.exchange : \
266 ((RR)->rrtype == kDNSType_SRV ) ? &(RR)->rdata->u.srv.target : mDNSNULL )
267
268 #define LocalRecordReady(X) ((X)->resrec.RecordType != kDNSRecordTypeUnique && (X)->resrec.RecordType != kDNSRecordTypeDeregistering)
269
270 // ***************************************************************************
271 #if COMPILER_LIKES_PRAGMA_MARK
272 #pragma mark -
273 #pragma mark - DNS Message Creation Functions
274 #endif
275
276 extern void InitializeDNSMessage(DNSMessageHeader *h, mDNSOpaque16 id, mDNSOpaque16 flags);
277 extern const mDNSu8 *FindCompressionPointer(const mDNSu8 *const base, const mDNSu8 *const end, const mDNSu8 *const domname);
278 extern mDNSu8 *putDomainNameAsLabels(const DNSMessage *const msg, mDNSu8 *ptr, const mDNSu8 *const limit, const domainname *const name);
279 extern mDNSu8 *putRData(const DNSMessage *const msg, mDNSu8 *ptr, const mDNSu8 *const limit, const ResourceRecord *const rr);
280
281 // If we have a single large record to put in the packet, then we allow the packet to be up to 9K bytes,
282 // but in the normal case we try to keep the packets below 1500 to avoid IP fragmentation on standard Ethernet
283 extern mDNSu8 *PutResourceRecordTTLWithLimit(DNSMessage *const msg, mDNSu8 *ptr, mDNSu16 *count, ResourceRecord *rr, mDNSu32 ttl, const mDNSu8 *limit);
284 #define PutResourceRecordTTL(msg, ptr, count, rr, ttl) PutResourceRecordTTLWithLimit((msg), (ptr), (count), (rr), (ttl), \
285 ((msg)->h.numAnswers || (msg)->h.numAuthorities || (msg)->h.numAdditionals) ? (msg)->data + NormalMaxDNSMessageData : (msg)->data + AbsoluteMaxDNSMessageData)
286 #define PutResourceRecordTTLJumbo(msg, ptr, count, rr, ttl) PutResourceRecordTTLWithLimit((msg), (ptr), (count), (rr), (ttl), \
287 (msg)->data + AbsoluteMaxDNSMessageData)
288 extern mDNSu8 *PutResourceRecordCappedTTL(DNSMessage *const msg, mDNSu8 *ptr, mDNSu16 *count, ResourceRecord *rr, mDNSu32 maxttl);
289 extern mDNSu8 *putEmptyResourceRecord(DNSMessage *const msg, mDNSu8 *ptr, const mDNSu8 *const limit, mDNSu16 *count, const AuthRecord *rr);
290
291 extern mDNSu8 *putQuestion(DNSMessage *const msg, mDNSu8 *ptr, const mDNSu8 *const limit, const domainname *const name, mDNSu16 rrtype, mDNSu16 rrclass);
292 extern mDNSu8 *putZone(DNSMessage *const msg, mDNSu8 *ptr, mDNSu8 *limit, const domainname *zone, mDNSOpaque16 zoneClass);
293 extern mDNSu8 *putPrereqNameNotInUse(const domainname *const name, DNSMessage *msg, mDNSu8 *ptr, mDNSu8 *end);
294 extern mDNSu8 *putDeletionRecord(DNSMessage *msg, mDNSu8 *ptr, ResourceRecord *rr);
295 extern mDNSu8 *putDeleteRRSet(DNSMessage *msg, mDNSu8 *ptr, const domainname *name, mDNSu16 rrtype);
296 extern mDNSu8 *putDeleteAllRRSets(DNSMessage *msg, mDNSu8 *ptr, const domainname *name);
297 extern mDNSu8 *putUpdateLease(DNSMessage *msg, mDNSu8 *end, mDNSu32 lease);
298 #define PutResourceRecord(MSG, P, C, RR) PutResourceRecordTTL((MSG), (P), (C), (RR), (RR)->rroriginalttl)
299
300 extern mDNSu8 *putHINFO(const mDNS *const m, DNSMessage *const msg, mDNSu8 *end, DomainAuthInfo *authInfo);
301
302 // ***************************************************************************
303 #if COMPILER_LIKES_PRAGMA_MARK
304 #pragma mark -
305 #pragma mark - DNS Message Parsing Functions
306 #endif
307
308 #define HashSlot(X) (DomainNameHashValue(X) % CACHE_HASH_SLOTS)
309 extern mDNSu32 DomainNameHashValue(const domainname *const name);
310 extern void SetNewRData(ResourceRecord *const rr, RData *NewRData, mDNSu16 rdlength);
311 extern const mDNSu8 *skipDomainName(const DNSMessage *const msg, const mDNSu8 *ptr, const mDNSu8 *const end);
312 extern const mDNSu8 *getDomainName(const DNSMessage *const msg, const mDNSu8 *ptr, const mDNSu8 *const end,
313 domainname *const name);
314 extern const mDNSu8 *skipResourceRecord(const DNSMessage *msg, const mDNSu8 *ptr, const mDNSu8 *end);
315 extern const mDNSu8 *GetLargeResourceRecord(mDNS *const m, const DNSMessage * const msg, const mDNSu8 *ptr,
316 const mDNSu8 * end, const mDNSInterfaceID InterfaceID, mDNSu8 RecordType, LargeCacheRecord *largecr);
317 extern const mDNSu8 *skipQuestion(const DNSMessage *msg, const mDNSu8 *ptr, const mDNSu8 *end);
318 extern const mDNSu8 *getQuestion(const DNSMessage *msg, const mDNSu8 *ptr, const mDNSu8 *end, const mDNSInterfaceID InterfaceID,
319 DNSQuestion *question);
320 extern const mDNSu8 *LocateAnswers(const DNSMessage *const msg, const mDNSu8 *const end);
321 extern const mDNSu8 *LocateAuthorities(const DNSMessage *const msg, const mDNSu8 *const end);
322 extern const mDNSu8 *LocateAdditionals(const DNSMessage *const msg, const mDNSu8 *const end);
323 extern const mDNSu8 *LocateLLQOptData(const DNSMessage *const msg, const mDNSu8 *const end);
324 extern const rdataOPT *GetLLQOptData(mDNS *const m, const DNSMessage *const msg, const mDNSu8 *const end);
325 extern const mDNSu8 *LocateLeaseOptData(const DNSMessage *const msg, const mDNSu8 *const end);
326 extern mDNSu32 GetPktLease(mDNS *m, DNSMessage *msg, const mDNSu8 *end);
327 extern void DumpPacket(mDNS *const m, mDNSBool sent, char *transport,
328 const mDNSAddr *srcaddr, mDNSIPPort srcport,
329 const mDNSAddr *dstaddr, mDNSIPPort dstport, const DNSMessage *const msg, const mDNSu8 *const end);
330
331 // ***************************************************************************
332 #if COMPILER_LIKES_PRAGMA_MARK
333 #pragma mark -
334 #pragma mark - Packet Sending Functions
335 #endif
336
337 extern mStatus mDNSSendDNSMessage(mDNS *const m, DNSMessage *const msg, mDNSu8 *end,
338 mDNSInterfaceID InterfaceID, UDPSocket *src, const mDNSAddr *dst, mDNSIPPort dstport, TCPSocket *sock, DomainAuthInfo *authInfo);
339
340 // ***************************************************************************
341 #if COMPILER_LIKES_PRAGMA_MARK
342 #pragma mark -
343 #pragma mark - RR List Management & Task Management
344 #endif
345
346 extern void mDNS_Lock_(mDNS *const m);
347 extern void mDNS_Unlock_(mDNS *const m);
348
349 #define mDNS_Lock(X) do { \
350 if ((X)->mDNS_busy != (X)->mDNS_reentrancy) LogMsg("%s: mDNS_Lock locking failure! mDNS_busy (%ld) != mDNS_reentrancy (%ld)", __func__, (X)->mDNS_busy, (X)->mDNS_reentrancy); \
351 mDNS_Lock_(X); } while (0)
352
353 #define mDNS_Unlock(X) do { mDNS_Unlock_(X); \
354 if ((X)->mDNS_busy != (X)->mDNS_reentrancy) LogMsg("%s: mDNS_Unlock locking failure! mDNS_busy (%ld) != mDNS_reentrancy (%ld)", __func__, (X)->mDNS_busy, (X)->mDNS_reentrancy); \
355 } while (0)
356
357 #define mDNS_DropLockBeforeCallback() do { m->mDNS_reentrancy++; \
358 if (m->mDNS_busy != m->mDNS_reentrancy) LogMsg("%s: Locking Failure! mDNS_busy (%ld) != mDNS_reentrancy (%ld)", __func__, m->mDNS_busy, m->mDNS_reentrancy); \
359 } while (0)
360
361 #define mDNS_ReclaimLockAfterCallback() do { \
362 if (m->mDNS_busy != m->mDNS_reentrancy) LogMsg("%s: Unlocking Failure! mDNS_busy (%ld) != mDNS_reentrancy (%ld)", __func__, m->mDNS_busy, m->mDNS_reentrancy); \
363 m->mDNS_reentrancy--; } while (0)
364
365 #ifdef __cplusplus
366 }
367 #endif
368
369 #endif // __DNSCOMMON_H_