mDNSCore/DNSCommon.h

   1 /*
   2  * Copyright (c) 2002-2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24
  25     Change History (most recent first):
  26
  27 $Log: DNSCommon.h,v $
  28 Revision 1.14  2004/05/28 23:42:36  ksekar
  29 <rdar://problem/3258021>: Feature: DNS server->client notification on record changes (#7805)
  30
  31 Revision 1.13  2004/05/18 23:51:25  cheshire
  32 Tidy up all checkin comments to use consistent "<rdar://problem/xxxxxxx>" format for bug numbers
  33
  34 Revision 1.12  2004/04/22 04:03:59  cheshire
  35 Headers should use "extern" declarations, not "mDNSexport"
  36
  37 Revision 1.11  2004/04/14 23:09:28  ksekar
  38 Support for TSIG signed dynamic updates.
  39
  40 Revision 1.10  2004/03/13 01:57:33  ksekar
  41 <rdar://problem/3192546>: DynDNS: Dynamic update of service records
  42
  43 Revision 1.9  2004/02/21 08:56:58  bradley
  44 Wrap prototypes with extern "C" for C++ builds.
  45
  46 Revision 1.8  2004/02/06 23:04:18  ksekar
  47 Basic Dynamic Update support via mDNS_Register (dissabled via
  48 UNICAST_REGISTRATION #define)
  49
  50 Revision 1.7  2004/02/03 19:47:36  ksekar
  51 Added an asyncronous state machine mechanism to uDNS.c, including
  52 calls to find the parent zone for a domain name.  Changes include code
  53 in repository previously dissabled via "#if 0 //incomplete".  Codepath
  54 is currently unused, and will be called to create update records, etc.
  55
  56 Revision 1.6  2004/01/27 20:15:22  cheshire
  57 <rdar://problem/3541288>: Time to prune obsolete code for listening on port 53
  58
  59 Revision 1.5  2004/01/24 03:40:56  cheshire
  60 Move mDNSAddrIsDNSMulticast() from DNSCommon.h to mDNSClientAPI.h so clients can use it
  61
  62 Revision 1.4  2004/01/24 03:38:27  cheshire
  63 Fix minor syntactic error: Headers should use "extern" declarations, not "mDNSexport"
  64
  65 Revision 1.3  2004/01/23 23:23:14  ksekar
  66 Added TCP support for truncated unicast messages.
  67
  68 Revision 1.2  2004/01/21 21:12:23  cheshire
  69 Add missing newline at end of file to make Unix tools happier
  70
  71 Revision 1.1  2003/12/13 03:05:27  ksekar
  72 <rdar://problem/3192548>: DynDNS: Unicast query of service records
  73
  74
  75  */
  76
  77 #ifndef __DNSCOMMON_H_
  78 #define __DNSCOMMON_H_
  79
  80 #include "mDNSClientAPI.h"
  81
  82 #ifdef  __cplusplus
  83         extern "C" {
  84 #endif
  85
  86 // ***************************************************************************
  87 #if COMPILER_LIKES_PRAGMA_MARK
  88 #pragma mark - DNS Protocol Constants
  89 #endif
  90
  91 typedef enum
  92         {
  93         kDNSFlag0_QR_Mask     = 0x80,           // Query or response?
  94         kDNSFlag0_QR_Query    = 0x00,
  95         kDNSFlag0_QR_Response = 0x80,
  96
  97         kDNSFlag0_OP_Mask     = 0x78,           // Operation type
  98         kDNSFlag0_OP_StdQuery = 0x00,
  99         kDNSFlag0_OP_Iquery   = 0x08,
 100         kDNSFlag0_OP_Status   = 0x10,
 101         kDNSFlag0_OP_Unused3  = 0x18,
 102         kDNSFlag0_OP_Notify   = 0x20,
 103         kDNSFlag0_OP_Update   = 0x28,
 104
 105         kDNSFlag0_QROP_Mask   = kDNSFlag0_QR_Mask | kDNSFlag0_OP_Mask,
 106
 107         kDNSFlag0_AA          = 0x04,           // Authoritative Answer?
 108         kDNSFlag0_TC          = 0x02,           // Truncated?
 109         kDNSFlag0_RD          = 0x01,           // Recursion Desired?
 110         kDNSFlag1_RA          = 0x80,           // Recursion Available?
 111
 112         kDNSFlag1_Zero        = 0x40,           // Reserved; must be zero
 113         kDNSFlag1_AD          = 0x20,           // Authentic Data [RFC 2535]
 114         kDNSFlag1_CD          = 0x10,           // Checking Disabled [RFC 2535]
 115
 116         kDNSFlag1_RC          = 0x0F,           // Response code
 117         kDNSFlag1_RC_NoErr    = 0x00,
 118         kDNSFlag1_RC_FmtErr   = 0x01,
 119         kDNSFlag1_RC_SrvErr   = 0x02,
 120         kDNSFlag1_RC_NXDomain = 0x03,
 121         kDNSFlag1_RC_NotImpl  = 0x04,
 122         kDNSFlag1_RC_Refused  = 0x05,
 123         kDNSFlag1_RC_YXDomain = 0x06,
 124         kDNSFlag1_RC_YXRRSet  = 0x07,
 125         kDNSFlag1_RC_NXRRSet  = 0x08,
 126         kDNSFlag1_RC_NotAuth  = 0x09,
 127         kDNSFlag1_RC_NotZone  = 0x0A
 128         } DNS_Flags;
 129
 130 // ***************************************************************************
 131 #if COMPILER_LIKES_PRAGMA_MARK
 132 #pragma mark -
 133 #pragma mark - General Utility Functions
 134 #endif
 135
 136 extern const NetworkInterfaceInfo *GetFirstActiveInterface(const NetworkInterfaceInfo *intf);
 137 extern mDNSInterfaceID GetNextActiveInterfaceID(const NetworkInterfaceInfo *intf);
 138
 139 extern mDNSu32 mDNSRandom(mDNSu32 max);
 140
 141 #define mDNSSameIPv4Address(A,B) ((A).NotAnInteger == (B).NotAnInteger)
 142 #define mDNSSameIPv6Address(A,B) ((A).l[0] == (B).l[0] && (A).l[1] == (B).l[1] && (A).l[2] == (B).l[2] && (A).l[3] == (B).l[3])
 143
 144 #define mDNSIPv4AddressIsZero(A) mDNSSameIPv4Address((A), zeroIPAddr)
 145 #define mDNSIPv6AddressIsZero(A) mDNSSameIPv6Address((A), zerov6Addr)
 146
 147 #define mDNSIPv4AddressIsOnes(A) mDNSSameIPv4Address((A), onesIPv4Addr)
 148 #define mDNSIPv6AddressIsOnes(A) mDNSSameIPv6Address((A), onesIPv6Addr)
 149
 150 #define mDNSAddressIsZero(X) (                                              \
 151         ((X)->type == mDNSAddrType_IPv4 && mDNSIPv4AddressIsZero((X)->ip.v4)) || \
 152         ((X)->type == mDNSAddrType_IPv6 && mDNSIPv6AddressIsZero((X)->ip.v6))    )
 153
 154 #define mDNSAddressIsOnes(X) (                                              \
 155         ((X)->type == mDNSAddrType_IPv4 && mDNSIPv4AddressIsOnes((X)->ip.v4)) || \
 156         ((X)->type == mDNSAddrType_IPv6 && mDNSIPv6AddressIsOnes((X)->ip.v6))    )
 157
 158 #define mDNSAddressIsValid(X) (                                                                                             \
 159         ((X)->type == mDNSAddrType_IPv4) ? !(mDNSIPv4AddressIsZero((X)->ip.v4) || mDNSIPv4AddressIsOnes((X)->ip.v4)) :          \
 160         ((X)->type == mDNSAddrType_IPv6) ? !(mDNSIPv6AddressIsZero((X)->ip.v6) || mDNSIPv6AddressIsOnes((X)->ip.v6)) : mDNSfalse)
 161
 162
 163
 164 // ***************************************************************************
 165 #if COMPILER_LIKES_PRAGMA_MARK
 166 #pragma mark -
 167 #pragma mark - Domain Name Utility Functions
 168 #endif
 169
 170 #define mdnsIsDigit(X)     ((X) >= '0' && (X) <= '9')
 171 #define mDNSIsUpperCase(X) ((X) >= 'A' && (X) <= 'Z')
 172 #define mDNSIsLowerCase(X) ((X) >= 'a' && (X) <= 'z')
 173 #define mdnsIsLetter(X)    (mDNSIsUpperCase(X) || mDNSIsLowerCase(X))
 174
 175
 176 #define mdnsValidHostChar(X, notfirst, notlast) (mdnsIsLetter(X) || mdnsIsDigit(X) || ((notfirst) && (notlast) && (X) == '-') )
 177
 178 extern mDNSu16 CompressedDomainNameLength(const domainname *const name, const domainname *parent);
 179
 180 extern mDNSBool LabelContainsSuffix(const domainlabel *const name, const mDNSBool RichText);
 181 extern mDNSu32 RemoveLabelSuffix(domainlabel *name, mDNSBool RichText);
 182 extern void AppendLabelSuffix(domainlabel *name, mDNSu32 val, mDNSBool RichText);
 183 extern void mDNS_HostNameCallback(mDNS *const m, AuthRecord *const rr, mStatus result);
 184 #define ValidateDomainName(N) (DomainNameLength(N) <= MAX_DOMAIN_NAME)
 185
 186
 187 // ***************************************************************************
 188 #if COMPILER_LIKES_PRAGMA_MARK
 189 #pragma mark -
 190 #pragma mark - Resource Record Utility Functions
 191 #endif
 192
 193 extern mDNSu32 RDataHashValue(mDNSu16 const rdlength, const RDataBody *const rdb);
 194
 195 extern mDNSBool SameRData(const ResourceRecord *const r1, const ResourceRecord *const r2);
 196
 197 extern mDNSBool ResourceRecordAnswersQuestion(const ResourceRecord *const rr, const DNSQuestion *const q);
 198
 199
 200 extern mDNSu16 GetRDLength(const ResourceRecord *const rr, mDNSBool estimate);
 201
 202 #define GetRRDomainNameTarget(RR) (                                                                          \
 203         ((RR)->rrtype == kDNSType_CNAME || (RR)->rrtype == kDNSType_PTR || (RR)->rrtype == kDNSType_NS)          \
 204                                                                          ? &(RR)->rdata->u.name       :          \
 205         ((RR)->rrtype == kDNSType_SRV                                  ) ? &(RR)->rdata->u.srv.target : mDNSNULL )
 206
 207 extern mDNSBool ValidateRData(const mDNSu16 rrtype, const mDNSu16 rdlength, const RData *const rd);
 208
 209
 210 // ***************************************************************************
 211 #if COMPILER_LIKES_PRAGMA_MARK
 212 #pragma mark -
 213 #pragma mark -
 214 #pragma mark - DNS Message Creation Functions
 215 #endif
 216
 217 extern void InitializeDNSMessage(DNSMessageHeader *h, mDNSOpaque16 id, mDNSOpaque16 flags);
 218 extern const mDNSu8 *FindCompressionPointer(const mDNSu8 *const base, const mDNSu8 *const end, const mDNSu8 *const domname);
 219
 220 extern mDNSu8 *putDomainNameAsLabels(const DNSMessage *const msg, mDNSu8 *ptr, const mDNSu8 *const limit, const domainname *const name);
 221
 222 extern mDNSu8 *putRData(const DNSMessage *const msg, mDNSu8 *ptr, const mDNSu8 *const limit, ResourceRecord *rr);
 223
 224 extern mDNSu8 *PutResourceRecordTTL(DNSMessage *const msg, mDNSu8 *ptr, mDNSu16 *count, ResourceRecord *rr, mDNSu32 ttl);
 225
 226 extern mDNSu8 *PutResourceRecordCappedTTL(DNSMessage *const msg, mDNSu8 *ptr, mDNSu16 *count, ResourceRecord *rr, mDNSu32 maxttl);
 227
 228 extern mDNSu8 *putEmptyResourceRecord(DNSMessage *const msg, mDNSu8 *ptr, const mDNSu8 *const limit, mDNSu16 *count, const AuthRecord *rr);
 229
 230 extern mDNSu8 *putQuestion(DNSMessage *const msg, mDNSu8 *ptr, const mDNSu8 *const limit, const domainname *const name, mDNSu16 rrtype, mDNSu16 rrclass);
 231
 232 #define PutResourceRecord(MSG, P, C, RR) PutResourceRecordTTL((MSG), (P), (C), (RR), (RR)->rroriginalttl)
 233
 234
 235 // ***************************************************************************
 236 #if COMPILER_LIKES_PRAGMA_MARK
 237 #pragma mark -
 238 #pragma mark - DNS Message Parsing Functions
 239 #endif
 240
 241 extern mDNSu32 DomainNameHashValue(const domainname *const name);
 242
 243 extern void SetNewRData(ResourceRecord *const rr, RData *NewRData, mDNSu16 rdlength);
 244
 245
 246 extern const mDNSu8 *skipDomainName(const DNSMessage *const msg, const mDNSu8 *ptr, const mDNSu8 *const end);
 247
 248 extern const mDNSu8 *getDomainName(const DNSMessage *const msg, const mDNSu8 *ptr, const mDNSu8 *const end,
 249         domainname *const name);
 250
 251 extern const mDNSu8 *skipResourceRecord(const DNSMessage *msg, const mDNSu8 *ptr, const mDNSu8 *end);
 252
 253 extern const mDNSu8 *GetResourceRecord(mDNS *const m, const DNSMessage * const msg, const mDNSu8 *ptr,
 254     const mDNSu8 * const end, const mDNSInterfaceID InterfaceID, mDNSu8 RecordType, CacheRecord *rr, RData *RDataStorage);
 255
 256 extern const mDNSu8 *skipQuestion(const DNSMessage *msg, const mDNSu8 *ptr, const mDNSu8 *end);
 257
 258 extern const mDNSu8 *getQuestion(const DNSMessage *msg, const mDNSu8 *ptr, const mDNSu8 *end, const mDNSInterfaceID InterfaceID,
 259         DNSQuestion *question);
 260
 261 extern const mDNSu8 *LocateAnswers(const DNSMessage *const msg, const mDNSu8 *const end);
 262
 263 extern const mDNSu8 *LocateAuthorities(const DNSMessage *const msg, const mDNSu8 *const end);
 264
 265 extern const mDNSu8 *LocateAdditionals(const DNSMessage *const msg, const mDNSu8 *const end);
 266
 267 #define GetLargeResourceRecord(m, msg, p, e, i, t, L) \
 268         (((L)->r.rdatastorage.MaxRDLength = MaximumRDSize), GetResourceRecord((m), (msg), (p), (e), (i), (t), &(L)->r, (RData*)&(L)->r.rdatastorage))
 269
 270 // ***************************************************************************
 271 #if COMPILER_LIKES_PRAGMA_MARK
 272 #pragma mark -
 273 #pragma mark -
 274 #pragma mark - Packet Sending Functions
 275 #endif
 276
 277 extern mStatus mDNSSendDNSMessage(const mDNS *const m, DNSMessage *const msg, mDNSu8 * end, mDNSInterfaceID InterfaceID, const mDNSAddr *dst, mDNSIPPort dstport);
 278 extern mStatus mDNSSendDNSMessage_tcp(const mDNS *const m, DNSMessage *const msg, mDNSu8 * end, int sd);
 279 extern mStatus mDNSSendSignedDNSMessage(const mDNS *const m, DNSMessage *const msg, mDNSu8 *end,
 280     mDNSInterfaceID InterfaceID, const mDNSAddr *dst, mDNSIPPort dstport, uDNS_AuthInfo *authInfo);
 281 extern mStatus mDNSSendSignedDNSMessage_tcp(const mDNS *const m, DNSMessage *const msg, mDNSu8 * end, int sd, uDNS_AuthInfo *authInfo);
 282
 283 #ifdef  __cplusplus
 284         }
 285 #endif
 286
 287 #endif // __DNSCOMMON_H_