4b22b9337f359bfd063322244f5336cc7c6ffcfars/* -*- Mode: C; tab-width: 4 -*-
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome * Copyright (c) 2002-2015 Apple Inc. All rights reserved.
4b22b9337f359bfd063322244f5336cc7c6ffcfars * Licensed under the Apache License, Version 2.0 (the "License");
4b22b9337f359bfd063322244f5336cc7c6ffcfars * you may not use this file except in compliance with the License.
4b22b9337f359bfd063322244f5336cc7c6ffcfars * You may obtain a copy of the License at
4b22b9337f359bfd063322244f5336cc7c6ffcfars * Unless required by applicable law or agreed to in writing, software
4b22b9337f359bfd063322244f5336cc7c6ffcfars * distributed under the License is distributed on an "AS IS" BASIS,
4b22b9337f359bfd063322244f5336cc7c6ffcfars * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
4b22b9337f359bfd063322244f5336cc7c6ffcfars * See the License for the specific language governing permissions and
4b22b9337f359bfd063322244f5336cc7c6ffcfars * limitations under the License.
4b22b9337f359bfd063322244f5336cc7c6ffcfars If you're building an application that uses DNS Service Discovery
4b22b9337f359bfd063322244f5336cc7c6ffcfars this is probably NOT the header file you're looking for.
4b22b9337f359bfd063322244f5336cc7c6ffcfars In most cases you will want to use /usr/include/dns_sd.h instead.
4b22b9337f359bfd063322244f5336cc7c6ffcfars This header file defines the lowest level raw interface to mDNSCore,
4b22b9337f359bfd063322244f5336cc7c6ffcfars which is appropriate *only* on tiny embedded systems where everything
4b22b9337f359bfd063322244f5336cc7c6ffcfars runs in a single address space and memory is extremely constrained.
4b22b9337f359bfd063322244f5336cc7c6ffcfars All the APIs here are malloc-free, which means that the caller is
4b22b9337f359bfd063322244f5336cc7c6ffcfars responsible for passing in a pointer to the relevant storage that
4b22b9337f359bfd063322244f5336cc7c6ffcfars will be used in the execution of that call, and (when called with
4b22b9337f359bfd063322244f5336cc7c6ffcfars correct parameters) all the calls are guaranteed to succeed. There
4b22b9337f359bfd063322244f5336cc7c6ffcfars is never a case where a call can suffer intermittent failures because
4b22b9337f359bfd063322244f5336cc7c6ffcfars the implementation calls malloc() and sometimes malloc() returns NULL
4b22b9337f359bfd063322244f5336cc7c6ffcfars because memory is so limited that no more is available.
4b22b9337f359bfd063322244f5336cc7c6ffcfars This is primarily for devices that need to have precisely known fixed
4b22b9337f359bfd063322244f5336cc7c6ffcfars memory requirements, with absolutely no uncertainty or run-time variation,
4b22b9337f359bfd063322244f5336cc7c6ffcfars but that certainty comes at a cost of more difficult programming.
4b22b9337f359bfd063322244f5336cc7c6ffcfars For applications running on general-purpose desktop operating systems
4b22b9337f359bfd063322244f5336cc7c6ffcfars (Mac OS, Linux, Solaris, Windows, etc.) the API you should use is
4b22b9337f359bfd063322244f5336cc7c6ffcfars /usr/include/dns_sd.h, which defines the API by which multiple
4b22b9337f359bfd063322244f5336cc7c6ffcfars independent client processes communicate their DNS Service Discovery
4b22b9337f359bfd063322244f5336cc7c6ffcfars requests to a single "mdnsd" daemon running in the background.
4b22b9337f359bfd063322244f5336cc7c6ffcfars Even on platforms that don't run multiple independent processes in
4b22b9337f359bfd063322244f5336cc7c6ffcfars multiple independent address spaces, you can still use the preferred
4b22b9337f359bfd063322244f5336cc7c6ffcfars dns_sd.h APIs by linking in "dnssd_clientshim.c", which implements
4b22b9337f359bfd063322244f5336cc7c6ffcfars the standard "dns_sd.h" API calls, allocates any required storage
4b22b9337f359bfd063322244f5336cc7c6ffcfars using malloc(), and then calls through to the low-level malloc-free
4b22b9337f359bfd063322244f5336cc7c6ffcfars mDNSCore routines defined here. This has the benefit that even though
4b22b9337f359bfd063322244f5336cc7c6ffcfars you're running on a small embedded system with a single address space,
4b22b9337f359bfd063322244f5336cc7c6ffcfars you can still use the exact same client C code as you'd use on a
4b22b9337f359bfd063322244f5336cc7c6ffcfars general-purpose desktop system.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#if defined(EFI32) || defined(EFI64) || defined(EFIX64)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// EFI doesn't have stdarg.h unless it's building with GCC.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#include <stdarg.h> // stdarg.h is required for for va_list support for the mDNS_vsnprintf declaration
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// ***************************************************************************
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Feature removal compile options & limited resource targets
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The following compile options are responsible for removing certain features from mDNSCore to reduce the
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// memory footprint for use in embedded systems with limited resources.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// UNICAST_DISABLED - disables unicast DNS functionality, including Wide Area Bonjour
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// ANONYMOUS_DISABLED - disables anonymous functionality
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// DNSSEC_DISABLED - disables DNSSEC functionality
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// SPC_DISABLED - disables Bonjour Sleep Proxy client
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// IDLESLEEPCONTROL_DISABLED - disables sleep control for Bonjour Sleep Proxy clients
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// In order to disable the above features pass the option to your compiler, e.g. -D UNICAST_DISABLED
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome// Additionally, the LIMITED_RESOURCES_TARGET compile option will reduce the maximum DNS message sizes.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Don't support jumbo frames
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome// 40 (IPv6 header) + 8 (UDP header) + 12 (DNS message header) + 1440 (DNS message body) = 1500 total
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// StandardAuthRDSize is 264 (256+8), which is large enough to hold a maximum-sized SRV record (6 + 256 bytes)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Function scope indicators
4b22b9337f359bfd063322244f5336cc7c6ffcfars// If you see "mDNSlocal" before a function name in a C file, it means the function is not callable outside this file
4b22b9337f359bfd063322244f5336cc7c6ffcfars// If you see "mDNSexport" before a symbol in a C file, it means the symbol is exported for use by clients
4b22b9337f359bfd063322244f5336cc7c6ffcfars// For every "mDNSexport" in a C file, there needs to be a corresponding "extern" declaration in some header file
4b22b9337f359bfd063322244f5336cc7c6ffcfars// (When a C file #includes a header file, the "extern" declarations tell the compiler:
4b22b9337f359bfd063322244f5336cc7c6ffcfars// "This symbol exists -- but not necessarily in this C file.")
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Explanation: These local/export markers are a little habit of mine for signaling the programmers' intentions.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// When "mDNSlocal" is just a synonym for "static", and "mDNSexport" is a complete no-op, you could be
4b22b9337f359bfd063322244f5336cc7c6ffcfars// forgiven for asking what purpose they serve. The idea is that if you see "mDNSexport" in front of a
4b22b9337f359bfd063322244f5336cc7c6ffcfars// function definition it means the programmer intended it to be exported and callable from other files
4b22b9337f359bfd063322244f5336cc7c6ffcfars// in the project. If you see "mDNSlocal" in front of a function definition it means the programmer
4b22b9337f359bfd063322244f5336cc7c6ffcfars// intended it to be private to that file. If you see neither in front of a function definition it
4b22b9337f359bfd063322244f5336cc7c6ffcfars// means the programmer forgot (so you should work out which it is supposed to be, and fix it).
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Using "mDNSlocal" instead of "static" makes it easier to do a textual searches for one or the other.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// For example you can do a search for "static" to find if any functions declare any local variables as "static"
4b22b9337f359bfd063322244f5336cc7c6ffcfars// (generally a bad idea unless it's also "const", because static storage usually risks being non-thread-safe)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// without the results being cluttered with hundreds of matches for functions declared static.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// - Stuart Cheshire
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Structure packing macro
4b22b9337f359bfd063322244f5336cc7c6ffcfars// If we're not using GNUC, it's not fatal.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Most compilers naturally pack the on-the-wire structures correctly anyway, so a plain "struct" is usually fine.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// In the event that structures are not packed correctly, mDNS_Init() will detect this and report an error, so the
4b22b9337f359bfd063322244f5336cc7c6ffcfars// developer will know what's wrong, and can investigate what needs to be done on that compiler to provide proper packing.
4b22b9337f359bfd063322244f5336cc7c6ffcfars #if ((__GNUC__ > 2) || ((__GNUC__ == 2) && (__GNUC_MINOR__ >= 9)))
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars#pragma mark - DNS Resource Record class and type constants
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef enum // From RFC 1035
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSClass_NONE = 254, // Used in DNS UPDATE [RFC 2136]
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSClass_Mask = 0x7FFF, // Multicast DNS uses the bottom 15 bits to identify the record class...
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSClass_UniqueRRSet = 0x8000, // ... and the top bit indicates that all other cached records are now invalid
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSQClass_ANY = 255, // Not a DNS class, but a DNS query class, meaning "all classes"
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSQClass_UnicastResponse = 0x8000 // Top bit set in a question means "unicast response acceptable"
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef enum // From RFC 1035
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSType_NSAP_PTR, // 23 Reverse NSAP lookup (deprecated)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSType_GPOS, // 27 Geographical position (withdrawn)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSType_DNAME, // 39 Non-terminal DNAME (for IPv6)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSType_SINK, // 40 Kitchen sink (experimental)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSType_NSEC3, // 50 Hashed Authenticated Denial of Existence
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSType_NSEC3PARAM, // 51 Hashed Authenticated Denial of Existence
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSType_HIP = 55, // 55 Host Identity Protocol
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSType_SPF = 99, // 99 Sender Policy Framework for E-Mail
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSType_IXFR, // 251 Incremental zone transfer
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSType_AXFR, // 252 Transfer zone of authority
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSType_MAILB, // 253 Transfer mailbox records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSType_MAILA, // 254 Transfer mail agent records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSQType_ANY // Not a DNS type, but a DNS query type, meaning "all types"
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNS defines its own names for these common types to simplify portability across
4b22b9337f359bfd063322244f5336cc7c6ffcfars// multiple platforms that may each have their own (different) names for these types.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Source: http://www.unix.org/version2/whatsnew/lp64_wp.html
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// http://software.intel.com/sites/products/documentation/hpc/mkl/lin/MKL_UG_structure/Support_for_ILP64_Programming.htm
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// It can be safely assumed that int is 32bits on the platform
4b22b9337f359bfd063322244f5336cc7c6ffcfars// To enforce useful type checking, we make mDNSInterfaceID be a pointer to a dummy struct
4b22b9337f359bfd063322244f5336cc7c6ffcfars// This way, mDNSInterfaceIDs can be assigned, and compared with each other, but not with other types
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Declaring the type to be the typical generic "void *" would lack this type checking
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef struct mDNSInterfaceID_dummystruct { void *dummy; } *mDNSInterfaceID;
4b22b9337f359bfd063322244f5336cc7c6ffcfars// These types are for opaque two- and four-byte identifiers.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// The "NotAnInteger" fields of the unions allow the value to be conveniently passed around in a
4b22b9337f359bfd063322244f5336cc7c6ffcfars// register for the sake of efficiency, and compared for equality or inequality, but don't forget --
4b22b9337f359bfd063322244f5336cc7c6ffcfars// just because it is in a register doesn't mean it is an integer. Operations like greater than,
4b22b9337f359bfd063322244f5336cc7c6ffcfars// less than, add, multiply, increment, decrement, etc., are undefined for opaque identifiers,
4b22b9337f359bfd063322244f5336cc7c6ffcfars// and if you make the mistake of trying to do those using the NotAnInteger field, then you'll
4b22b9337f359bfd063322244f5336cc7c6ffcfars// find you get code that doesn't work consistently on big-endian and little-endian machines.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef union { mDNSu8 b[ 2]; mDNSu16 NotAnInteger; } mDNSOpaque16;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef union { mDNSu8 b[ 4]; mDNSu32 NotAnInteger; } mDNSOpaque32;
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef packedunion { mDNSu8 b[ 6]; mDNSu16 w[3]; mDNSu32 l[1]; } mDNSOpaque48;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef union { mDNSu8 b[ 8]; mDNSu16 w[4]; mDNSu32 l[2]; } mDNSOpaque64;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef union { mDNSu8 b[16]; mDNSu16 w[8]; mDNSu32 l[4]; } mDNSOpaque128;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef mDNSOpaque16 mDNSIPPort; // An IP port is a two-byte opaque identifier (not an integer)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef mDNSOpaque32 mDNSv4Addr; // An IP address is a four-byte opaque identifier (not an integer)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef mDNSOpaque128 mDNSv6Addr; // An IPv6 address is a 16-byte opaque identifier (not an integer)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef mDNSOpaque48 mDNSEthAddr; // An Ethernet address is a six-byte opaque identifier (not an integer)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Bit operations for opaque 64 bit quantity. Uses the 32 bit quantity(l[2]) to set and clear bits
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define bit_set_opaque64(op64, index) (op64.l[((index))/(sizeof(mDNSu32) * mDNSNBBY)] |= (1 << ((index) % (sizeof(mDNSu32) * mDNSNBBY))))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define bit_clr_opaque64(op64, index) (op64.l[((index))/(sizeof(mDNSu32) * mDNSNBBY)] &= ~(1 << ((index) % (sizeof(mDNSu32) * mDNSNBBY))))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define bit_get_opaque64(op64, index) (op64.l[((index))/(sizeof(mDNSu32) * mDNSNBBY)] & (1 << ((index) % (sizeof(mDNSu32) * mDNSNBBY))))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSAddrType_Unknown = ~0 // Special marker value used in known answer list recording
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // mDNS return values are in the range FFFE FF00 (-65792) to FFFE FFFF (-65537)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // The top end of the range (FFFE FFFF) is used for error codes;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // the bottom end of the range (FFFE FF00) is used for non-error values;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Error codes:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mStatus_UnknownErr = -65537, // First value: 0xFFFE FFFF
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mStatus_BadSig = -65560, // while we define this per RFC 2845, BIND 9 returns Refused for bad/missing signatures
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mStatus_TransientErr = -65562, // transient failures, e.g. sending packets shortly after a network transition or wake from sleep
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mStatus_ServiceNotRunning = -65563, // Background daemon not running
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mStatus_NATPortMappingUnsupported = -65564, // NAT doesn't support PCP, NAT-PMP or UPnP
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mStatus_NATPortMappingDisabled = -65565, // NAT supports PCP, NAT-PMP or UPnP, but it's disabled by the administrator
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // -65568 to -65786 currently unused; available for allocation
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // tcp connection status
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Non-error values:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mStatus_MemFree = -65792 // Last value: 0xFFFE FF00
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // mStatus_MemFree is the last legal mDNS error code, at the end of the range allocated for mDNS
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define MaxIp 5 // Needs to be consistent with MaxInputIf in dns_services.h
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef enum { reg_stop = 0, reg_start } reg_state;
4b22b9337f359bfd063322244f5336cc7c6ffcfars// RFC 1034/1035 specify that a domain label consists of a length byte plus up to 63 characters
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct { mDNSu8 c[ 64]; } domainlabel; // One label: length byte and up to 63 characters
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// RFC 1034/1035/2181 specify that a domain name (length bytes and data bytes) may be up to 255 bytes long,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// plus the terminating zero at the end makes 256 bytes total in the on-the-wire format.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct { mDNSu8 c[256]; } domainname; // Up to 256 bytes of length-prefixed domainlabels
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct { mDNSu8 c[256]; } UTF8str255; // Null-terminated C string
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The longest legal textual form of a DNS name is 1009 bytes, including the C-string terminating NULL at the end.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Explanation:
4b22b9337f359bfd063322244f5336cc7c6ffcfars// When a native domainname object is converted to printable textual form using ConvertDomainNameToCString(),
4b22b9337f359bfd063322244f5336cc7c6ffcfars// non-printing characters are represented in the conventional DNS way, as '\ddd', where ddd is a three-digit decimal number.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The longest legal domain name is 256 bytes, in the form of four labels as shown below:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Length byte, 63 data bytes, length byte, 63 data bytes, length byte, 63 data bytes, length byte, 62 data bytes, zero byte.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Each label is encoded textually as characters followed by a trailing dot.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// If every character has to be represented as a four-byte escape sequence, then this makes the maximum textual form four labels
4b22b9337f359bfd063322244f5336cc7c6ffcfars// plus the C-string terminating NULL as shown below:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 63*4+1 + 63*4+1 + 63*4+1 + 62*4+1 + 1 = 1009.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Note that MAX_ESCAPED_DOMAIN_LABEL is not normally used: If you're only decoding a single label, escaping is usually not required.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// It is for domain names, where dots are used as label separators, that proper escaping is vital.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// MAX_REVERSE_MAPPING_NAME
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// For IPv4: "123.123.123.123.in-addr.arpa." 30 bytes including terminating NUL
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// For IPv6: "x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.x.ip6.arpa." 74 bytes including terminating NUL
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Most records have a TTL of 75 minutes, so that their 80% cache-renewal query occurs once per hour.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// For records containing a hostname (in the name on the left, or in the rdata on the right),
4b22b9337f359bfd063322244f5336cc7c6ffcfars// like A, AAAA, reverse-mapping PTR, and SRV, we use a two-minute TTL by default, because we don't want
4b22b9337f359bfd063322244f5336cc7c6ffcfars// them to hang around for too long in the cache if the host in question crashes or otherwise goes away.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Some applications want to register their SRV records with a lower ttl so that in case the server
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// using a dynamic port number restarts, the clients will not have stale information for more than
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 10 seconds
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Multicast DNS uses announcements (gratuitous responses) to update peer caches.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// This means it is feasible to use relatively larger TTL values than we might otherwise
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// use, because we have a cache coherency protocol to keep the peer caches up to date.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// With Unicast DNS, once an authoritative server gives a record with a certain TTL value to a client
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// or caching server, that client or caching server is entitled to hold onto the record until its TTL
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// expires, and has no obligation to contact the authoritative server again until that time arrives.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// This means that whereas Multicast DNS can use announcements to pre-emptively update stale data
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// before it would otherwise have expired, standard Unicast DNS (not using LLQs) has no equivalent
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// mechanism, and TTL expiry is the *only* mechanism by which stale data gets deleted. Because of this,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// we currently limit the TTL to ten seconds in such cases where no dynamic cache updating is possible.
4b22b9337f359bfd063322244f5336cc7c6ffcfars#define DefaultTTLforRRType(X) (((X) == kDNSType_A || (X) == kDNSType_AAAA || (X) == kDNSType_SRV) ? kHostNameTTL : kStandardTTL)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNS_KeepaliveRecord(rr) ((rr)->rrtype == kDNSType_NULL && SameDomainLabel(SecondLabel((rr)->name)->c, (mDNSu8 *)"\x0A_keepalive"))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Number of times keepalives are sent if no ACK is received before waking up the system
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// this is analogous to net.inet.tcp.keepcnt
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The frequency at which keepalives are retried if no ACK is received
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct ServiceRecordSet_struct ServiceRecordSet;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct mDNS_PlatformSupport_struct mDNS_PlatformSupport;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct NATTraversalInfo_struct NATTraversalInfo;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct ResourceRecord_struct ResourceRecord;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Structure to abstract away the differences between TCP/SSL sockets, and one for UDP sockets
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The actual definition of these structures appear in the appropriate platform support code
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars// We can send and receive packets up to 9000 bytes (Ethernet Jumbo Frame size, if that ever becomes widely used)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// However, in the normal case we try to limit packets to 1500 bytes so that we don't get IP fragmentation on standard Ethernet
4b22b9337f359bfd063322244f5336cc7c6ffcfars// 40 (IPv6 header) + 8 (UDP header) + 12 (DNS message header) + 1440 (DNS message body) = 1500 total
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 data[AbsoluteMaxDNSMessageData]; // 40 (IPv6) + 8 (UDP) + 12 (DNS header) + 8940 (data) = 9000
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// ***************************************************************************
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 protocol; // Payload type: 0x06 = TCP, 0x11 = UDP
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 vcf; // Version, Traffic Class, Flow Label
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 pro; // Type of next header: 0x06 = TCP, 0x11 = UDP, 0x3A = ICMPv6
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef union
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 len; // Length including UDP header (i.e. minimum value is 8 bytes)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 type; // 0x87 == Neighbor Solicitation, 0x88 == Neighbor Advertisement
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 flags_res; // R/S/O flags and reserved bits
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Typically 8 bytes of options are also present
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome} IPv6NDP; // 24 bytes or more; IP protocol type 0x3A
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef union
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Authoritative Resource Records:
4b22b9337f359bfd063322244f5336cc7c6ffcfars// There are four basic types: Shared, Advisory, Unique, Known Unique
4b22b9337f359bfd063322244f5336cc7c6ffcfars// * Shared Resource Records do not have to be unique
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- Shared Resource Records are used for DNS-SD service PTRs
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- It is okay for several hosts to have RRs with the same name but different RDATA
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- We use a random delay on responses to reduce collisions when all the hosts respond to the same query
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- These RRs typically have moderately high TTLs (e.g. one hour)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- These records are announced on startup and topology changes for the benefit of passive listeners
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- These records send a goodbye packet when deregistering
4b22b9337f359bfd063322244f5336cc7c6ffcfars// * Advisory Resource Records are like Shared Resource Records, except they don't send a goodbye packet
4b22b9337f359bfd063322244f5336cc7c6ffcfars// * Unique Resource Records should be unique among hosts within any given mDNS scope
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- The majority of Resource Records are of this type
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- If two entities on the network have RRs with the same name but different RDATA, this is a conflict
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- Responses may be sent immediately, because only one host should be responding to any particular query
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- These RRs typically have low TTLs (e.g. a few minutes)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- On startup and after topology changes, a host issues queries to verify uniqueness
4b22b9337f359bfd063322244f5336cc7c6ffcfars// * Known Unique Resource Records are treated like Unique Resource Records, except that mDNS does
4b22b9337f359bfd063322244f5336cc7c6ffcfars// not have to verify their uniqueness because this is already known by other means (e.g. the RR name
4b22b9337f359bfd063322244f5336cc7c6ffcfars// is derived from the host's IP or Ethernet address, which is already known to be a unique identifier).
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Summary of properties of different record types:
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Probe? Does this record type send probes before announcing?
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Conflict? Does this record type react if we observe an apparent conflict?
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Goodbye? Does this record type send a goodbye packet on departure?
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Probe? Conflict? Goodbye? Notes
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Unregistered Should not appear in any list (sanity check value)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Shared No No Yes e.g. Service PTR record
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Deregistering No No Yes Shared record about to announce its departure and leave the list
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Advisory No No No
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Unique Yes Yes No Record intended to be unique -- will probe to verify
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Verified Yes Yes No Record has completed probing, and is verified unique
4b22b9337f359bfd063322244f5336cc7c6ffcfars// KnownUnique No Yes No Record is assumed by other means to be unique
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Valid lifecycle of a record:
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Unregistered -> Shared -> Deregistering -(goodbye)-> Unregistered
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Unregistered -> Advisory -> Unregistered
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Unregistered -> Unique -(probe)-> Verified -> Unregistered
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Unregistered -> KnownUnique -> Unregistered
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Each Authoritative kDNSRecordType has only one bit set. This makes it easy to quickly see if a record
4b22b9337f359bfd063322244f5336cc7c6ffcfars// is one of a particular set of types simply by performing the appropriate bitwise masking operation.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Cache Resource Records (received from the network):
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// There are four basic types: Answer, Unique Answer, Additional, Unique Additional
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Bit 7 (the top bit) of kDNSRecordType is always set for Cache Resource Records; always clear for Authoritative Resource Records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Bit 6 (value 0x40) is set for answer records; clear for authority/additional records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Bit 5 (value 0x20) is set for records received with the kDNSClass_UniqueRRSet
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypeUnregistered = 0x00, // Not currently in any list
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypeDeregistering = 0x01, // Shared record about to announce its departure and leave the list
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypeUnique = 0x02, // Will become a kDNSRecordTypeVerified when probing is complete
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypeAdvisory = 0x04, // Like Shared, but no goodbye packet
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypeShared = 0x08, // Shared means record name does not have to be unique -- use random delay on responses
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypeVerified = 0x10, // Unique means mDNS should check that name is unique (and then send immediate responses)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypeKnownUnique = 0x20, // Known Unique means mDNS can assume name is unique without checking
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // For Dynamic Update records, Known Unique means the record must already exist on the server.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypeUniqueMask = (kDNSRecordTypeUnique | kDNSRecordTypeVerified | kDNSRecordTypeKnownUnique),
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypeActiveSharedMask = (kDNSRecordTypeAdvisory | kDNSRecordTypeShared),
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypeActiveUniqueMask = (kDNSRecordTypeVerified | kDNSRecordTypeKnownUnique),
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypeActiveMask = (kDNSRecordTypeActiveSharedMask | kDNSRecordTypeActiveUniqueMask),
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypePacketAdd = 0x80, // Received in the Additional Section of a DNS Response
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypePacketAddUnique = 0x90, // Received in the Additional Section of a DNS Response with kDNSClass_UniqueRRSet set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypePacketAuth = 0xA0, // Received in the Authorities Section of a DNS Response
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypePacketAuthUnique = 0xB0, // Received in the Authorities Section of a DNS Response with kDNSClass_UniqueRRSet set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypePacketAns = 0xC0, // Received in the Answer Section of a DNS Response
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypePacketAnsUnique = 0xD0, // Received in the Answer Section of a DNS Response with kDNSClass_UniqueRRSet set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypePacketNegative = 0xF0, // Pseudo-RR generated to cache non-existence results like NXDomain
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kDNSRecordTypePacketUniqueMask = 0x10 // True for PacketAddUnique, PacketAnsUnique, PacketAuthUnique, kDNSRecordTypePacketNegative
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef packedstruct { mDNSu16 priority; mDNSu16 weight; mDNSIPPort port; domainname target; } rdataSRV;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef packedstruct { mDNSu16 preference; domainname exchange; } rdataMX;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef packedstruct { domainname mbox; domainname txt; } rdataRP;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef packedstruct { mDNSu16 preference; domainname map822; domainname mapx400; } rdataPX;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 serial; // Modular counter; increases when zone changes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 refresh; // Time in seconds that a slave waits after successful replication of the database before it attempts replication again
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 retry; // Time in seconds that a slave waits after an unsuccessful replication attempt before it attempts replication again
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 expire; // Time in seconds that a slave holds on to old data while replication attempts remain unsuccessful
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 min; // Nominally the minimum record TTL for this zone, in seconds; also used for negative caching.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// http://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Algorithm used for RRSIG, DS and DNS KEY
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// alg - same as in RRSIG, DNS KEY or DS.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// RFC 4034 defines SHA1
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// RFC 4509 defines SHA256
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Note: NSEC3 also uses 1 for SHA1 and hence we will reuse for now till a new
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// value is assigned.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// We need support for base64 and base32 encoding for displaying KEY, NSEC3
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// To make this platform agnostic, we define two types which the platform
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// needs to support
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome//size of rdataRRSIG excluding signerName and signature (which are variable fields)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // mDNSu8 *signature
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// RFC 4034: For DNS Key RR
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// flags - the valid value for DNSSEC is 256 (Zone signing key - ZSK) and 257 (Secure Entry Point) which also
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// includes the ZSK bit
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// proto - the only valid value for protocol is 3 (See RFC 4034)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// alg - The only mandatory algorithm that we support is RSA/SHA-1
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// DNSSEC_RSA_SHA1_ALG
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // hashLength, nxt, bitmap
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// In the multicast usage of NSEC3, we know the actual size of RData
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 4 bytes : HashAlg, Flags,Iterations
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 5 bytes : Salt Length 1 byte, Salt 4 bytes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 21 bytes : HashLength 1 byte, Hash 20 bytes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 34 bytes : Window number, Bitmap length, Type bit map to include the first 256 types
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Base32 encoding takes 5 bytes of the input and encodes as 8 bytes of output.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// For example, SHA-1 hash of 20 bytes will be encoded as 20/5 * 8 = 32 base32
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// bytes. For a max domain name size of 255 bytes of base32 encoding : (255/8)*5
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// is the max hash length possible.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// In NSEC3, the names are hashed and stored in the first label and hence cannot exceed label
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// We define it here instead of dnssec.h so that these values can be used
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// in files without bringing in all of dnssec.h unnecessarily.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSSEC_Secure = 1, // Securely validated and has a chain up to the trust anchor
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSSEC_Insecure, // Cannot build a chain up to the trust anchor
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSSEC_NoResponse // No DNSSEC records to start with
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define DNSSECRecordType(rrtype) (((rrtype) == kDNSType_RRSIG) || ((rrtype) == kDNSType_NSEC) || ((rrtype) == kDNSType_DNSKEY) || ((rrtype) == kDNSType_DS) || \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome platform_NonApple // Non-Apple (Windows, POSIX) Platform
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// EDNS Option Code registrations are recorded in the "DNS EDNS0 Options" section of
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// <http://www.iana.org/assignments/dns-parameters>
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define kDNSOpt_Trace 65001 // 65001-65534 Reserved for Local/Experimental Use
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 err; // Or UDP reply port, in setup request
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Note: In the in-memory form, there's typically a two-byte space here, so that the following 64-bit id is word-aligned
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 vers; // Version number of this Owner OPT record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSEthAddr HMAC; // Host's primary identifier (e.g. MAC of on-board Ethernet)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSEthAddr IMAC; // Interface's MAC address (if different to primary MAC)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 platf; // Running platform (see enum Platform_t)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 mDNSv; // mDNSResponder Version (DNS_SD_H defined in dns_sd.h)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Note: rdataOPT format may be repeated an arbitrary number of times in a single resource record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome union { LLQOptData llq; mDNSu32 updatelease; OwnerOptData owner; TracerOptData tracer; } u;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Space needed to put OPT records into a packet:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Header 11 bytes (name 1, type 2, class 2, TTL 4, length 2)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// LLQ rdata 18 bytes (opt 2, len 2, vers 2, op 2, err 2, id 8, lease 4)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Lease rdata 8 bytes (opt 2, len 2, lease 4)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Owner rdata 12-24 bytes (opt 2, len 2, owner 8-20)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Trace rdata 9 bytes (opt 2, len 2, platf 1, mDNSv 4)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define DNSOpt_LLQData_Space (4 + 2 + 2 + 2 + 8 + 4)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define DNSOpt_OwnerData_ID_Wake_Space (4 + 2 + 6 + 6)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define DNSOpt_OwnerData_ID_Wake_PW4_Space (4 + 2 + 6 + 6 + 4)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define DNSOpt_OwnerData_ID_Wake_PW6_Space (4 + 2 + 6 + 6 + 6)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define ValidOwnerLength(X) ( (X) == DNSOpt_OwnerData_ID_Space - 4 || \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (X) == DNSOpt_OwnerData_ID_Wake_PW4_Space - 4 || \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (X) == DNSOpt_OwnerData_ID_Wake_PW6_Space - 4 )
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define DNSOpt_Owner_Space(A,B) (mDNSSameEthAddress((A),(B)) ? DNSOpt_OwnerData_ID_Space : DNSOpt_OwnerData_ID_Wake_Space)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (O)->opt == kDNSOpt_LLQ ? DNSOpt_LLQData_Space : \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (O)->opt == kDNSOpt_Lease ? DNSOpt_LeaseData_Space : \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (O)->opt == kDNSOpt_Trace ? DNSOpt_TraceData_Space : \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (O)->opt == kDNSOpt_Owner ? DNSOpt_Owner_Space(&(O)->u.owner.HMAC, &(O)->u.owner.IMAC) : 0x10000)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// NSEC record is defined in RFC 4034.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 16 bit RRTYPE space is split into 256 windows and each window has 256 bits (32 bytes).
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// If we create a structure for NSEC, it's size would be:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 256 bytes domainname 'nextname'
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// + 256 * 34 = 8704 bytes of bitmap data
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// = 8960 bytes total
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// This would be a waste, as types about 256 are not very common. But it would be odd, if we receive
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// a type above 256 (.US zone had TYPE65534 when this code was written) and not able to handle it.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Hence, we handle any size by not fixing a strucure in place. The following is just a placeholder
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// and never used anywhere.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainname *next; //placeholders are uncommented because C89 in Windows requires that a struct has at least a member.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// StandardAuthRDSize is 264 (256+8), which is large enough to hold a maximum-sized SRV record (6 + 256 bytes)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// MaximumRDSize is 8K the absolute maximum we support (at least for now)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// InlineCacheRDSize is 68
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Records received from the network with rdata this size or less have their rdata stored right in the CacheRecord object
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Records received from the network with rdata larger than this have additional storage allocated for the rdata
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// A quick unscientific sample from a busy network at Apple with lots of machines revealed this:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 1461 records in cache
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 292 were one-byte TXT records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 136 were four-byte A records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 184 were sixteen-byte AAAA records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 780 were various PTR, TXT and SRV records from 12-64 bytes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Only 69 records had rdata bigger than 64 bytes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Note that since CacheRecord object and a CacheGroup object are allocated out of the same pool, it's sensible to
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// have them both be the same size. Making one smaller without making the other smaller won't actually save any memory.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The RDataBody union defines the common rdata types that fit into our 264-byte limit
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef union
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome rdataOPT opt[2]; // For EDNS0 OPT record; RDataBody may contain multiple variable-length rdataOPT objects packed together
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The RDataBody2 union is the same as above, except it includes fields for the larger types like soa, rp, px
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef union
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome rdataSOA soa; // This is large; not included in the normal RDataBody definition
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome rdataRP rp; // This is large; not included in the normal RDataBody definition
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome rdataPX px; // This is large; not included in the normal RDataBody definition
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome rdataOPT opt[2]; // For EDNS0 OPT record; RDataBody may contain multiple variable-length rdataOPT objects packed together
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 MaxRDLength; // Amount of storage allocated for rdata (usually sizeof(RDataBody))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 padding; // So that RDataBody is aligned on 32-bit boundary
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// sizeofRDataHeader should be 4 bytes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define sizeofRDataHeader (sizeof(RData) - sizeof(RDataBody))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// RData_small is a smaller version of the RData object, used for inline data storage embedded in a CacheRecord_struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 MaxRDLength; // Storage allocated for data (may be greater than InlineCacheRDSize if additional storage follows this object)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 padding; // So that data is aligned on 32-bit boundary
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Note: Within an mDNSRecordCallback mDNS all API calls are legal except mDNS_Init(), mDNS_Exit(), mDNS_Execute()
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void mDNSRecordCallback (mDNS *const m, AuthRecord *const rr, mStatus result);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Restrictions: An mDNSRecordUpdateCallback may not make any mDNS API calls.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The intent of this callback is to allow the client to free memory, if necessary.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The internal data structures of the mDNS code may not be in a state where mDNS API calls may be made safely.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void mDNSRecordUpdateCallback (mDNS *const m, AuthRecord *const rr, RData *OldRData, mDNSu16 OldRDLen);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// ***************************************************************************
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#pragma mark - NAT Traversal structures and constants
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define NATMAP_MAX_RETRY_INTERVAL ((mDNSPlatformOneSecond * 60) * 15) // Max retry interval is 15 minutes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define NATMAP_MIN_RETRY_INTERVAL (mDNSPlatformOneSecond * 2) // Min retry interval is 2 seconds
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define NATMAP_INIT_RETRY (mDNSPlatformOneSecond / 4) // start at 250ms w/ exponential decay
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define NATMAP_DEFAULT_LEASE (60 * 60 * 2) // 2 hour lease life in seconds
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 upseconds; // Time since last NAT engine reboot, in seconds
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 upseconds; // Time since last NAT engine reboot, in seconds
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// PCP Support for IPv4 mappings
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// LNT Support
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome NATTraversalInfo *parentNATInfo; // pointer back to the parent NATTraversalInfo
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome LNTOp_t op; // operation performed using this connection
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome unsigned long nread; // number of bytes read so far
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome int retries; // number of times we've tried to do this port mapping
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void (*NATTraversalClientCallback)(mDNS *m, NATTraversalInfo *n);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// if m->timenow < ExpiryTime then we have an active mapping, and we'll renew halfway to expiry
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// if m->timenow >= ExpiryTime then our mapping has expired, and we're trying to create one
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Internal state fields. These are used internally by mDNSCore; the client layer needn't be concerned with them.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 ExpiryTime; // Time this mapping expires, or zero if no mapping
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 retryInterval; // Current interval, between last packet we sent and the next one
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 retryPortMap; // If Protocol is nonzero, time to send our next mapping packet
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mStatus NewResult; // New error code; will be copied to Result just prior to invoking callback
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome NATTProtocol lastSuccessfulProtocol; // To send correct deletion request & update non-PCP external address operations
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool sentNATPMP; // Whether we just sent a NAT-PMP packet, so we won't send another if
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // we receive another NAT-PMP "Unsupported Version" packet
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome tcpLNTInfo tcpInfo; // Legacy NAT traversal (UPnP) TCP connection
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Result fields: When the callback is invoked these fields contain the answers the client is looking for
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // When the callback is invoked ExternalPort is *usually* set to be the same the same as RequestedPort, except:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // (a) When we're behind a NAT gateway with port mapping disabled, ExternalPort is reported as zero to
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // indicate that we don't currently have a working mapping (but RequestedPort retains the external port
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // we'd like to get, the next time we meet an accomodating NAT gateway willing to give us one).
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // (b) When we have a routable non-RFC1918 address, we don't *need* a port mapping, so ExternalPort
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // is reported as the same as our InternalPort, since that is effectively our externally-visible port too.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Again, RequestedPort retains the external port we'd like to get the next time we find ourself behind a NAT gateway.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // To improve stability of port mappings, RequestedPort is updated any time we get a successful
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // mapping response from the PCP, NAT-PMP or UPnP gateway. For example, if we ask for port 80, and
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // get assigned port 81, then thereafter we'll contine asking for port 81.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSv4Addr ExternalAddress; // Initially set to onesIPv4Addr, until first callback
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSv4Addr NewAddress; // May be updated with actual value assigned by gateway
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Client API fields: The client must set up these fields *before* making any NAT traversal API calls
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 Protocol; // NATOp_MapUDP or NATOp_MapTCP, or zero if just requesting the external IP address
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSIPPort IntPort; // Client's internal port number (doesn't change)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSIPPort RequestedPort; // Requested external port; may be updated with actual value assigned by gateway
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 NATLease; // Requested lifetime in seconds (doesn't change)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// ***************************************************************************
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#pragma mark - DNSServer & McastResolver structures and constants
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 flags; // Set when we're planning to delete this from the list
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 timeout; // timeout value for questions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// scoped values for DNSServer matching
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kScopeNone = 0, // DNS server used by unscoped questions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kScopeInterfaceID = 1, // Scoped DNS server used only by scoped questions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome kScopeServiceID = 2 // Service specific DNS server used only by questions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // have a matching serviceID
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Note: DNSSECAware is set if we are able to get a valid response to
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// a DNSSEC question. In some cases it is possible that the proxy
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// strips the EDNS0 option and we just get a plain response with no
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// signatures. But we still mark DNSSECAware in that case. As DNSSECAware
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// is only used to determine whether DNSSEC_VALIDATION_SECURE_OPTIONAL
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// should be turned off or not, it is sufficient that we are getting
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// responses back.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID interface; // DNS requests should be sent on this interface
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 flags; // Set when we're planning to delete this from the list
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 teststate; // Have we sent bug-detection query to this server?
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 lasttest; // Time we sent last bug-detection query to this server
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainname domain; // name->server matching for "split dns"
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 penaltyTime; // amount of time this server is penalized
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 timeout; // timeout value for questions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool cellIntf; // Resolver from Cellular Interface ?
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 resGroupID; // ID of the resolver group that contains this DNSServer
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool req_A; // If set, send v4 query (DNSConfig allows A queries)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool req_AAAA; // If set, send v6 query (DNSConfig allows AAAA queries)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool req_DO; // If set, okay to send DNSSEC queries (EDNS DO bit is supported)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool retransDO; // Total Retransmissions for queries sent with DO option
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool DNSSECAware; // set if we are able to receive a response to a request
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // sent with DO option.
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID SendNow; // The interface ID that this record should be sent on
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 rdlength; // Size of the raw rdata, in bytes, in the on-the-wire format
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // (In-memory storage may be larger, for structures containing 'holes', like SOA)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 rdestimate; // Upper bound on on-the-wire size of rdata after name compression
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 namehash; // Name-based (i.e. case-insensitive) hash of name
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 rdatahash; // For rdata containing domain name (e.g. PTR, SRV, CNAME etc.), case-insensitive name hash
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // else, for all other rdata, 32-bit hash of the raw rdata
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Note: This requirement is important. Various routines like AddAdditionalsToResponseList(),
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // ReconfirmAntecedents(), etc., use rdatahash as a pre-flight check to see
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // whether it's worth doing a full SameDomainName() call. If the rdatahash
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // is not a correct case-insensitive name hash, they'll get false negatives.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Grouping pointers together at the end of the structure improves the memory layout efficiency
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID InterfaceID; // Set if this RR is specific to one interface
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // For records received off the wire, InterfaceID is *always* set to the receiving interface
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // For our authoritative records, InterfaceID is usually zero, except for those few records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // that are interface-specific (e.g. address records, especially linklocal addresses)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome RData *rdata; // Pointer to storage for this rdata
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome DNSServer *rDNSServer; // Unicast DNS server authoritative for this entry; null for multicast
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AnonymousInfo *AnonInfo; // Anonymous Information
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Unless otherwise noted, states may apply to either independent record registrations or service registrations
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef enum
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome regState_Pending = 1, // update sent, reply not received
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome regState_Registered = 2, // update sent, reply received
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome regState_DeregPending = 3, // dereg sent, reply not received
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome regState_Refresh = 5, // outstanding refresh (or target change) message
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome regState_NATMap = 6, // establishing NAT port mapping
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome regState_UpdatePending = 7, // update in flight as result of mDNS_Update call
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome regState_NoTarget = 8, // SRV Record registration pending registration of hostname
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome regState_NATError = 9 // unable to complete NAT traversal
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mergeState_DontMerge = 1 // Set on fatal error conditions to disable merging
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomestruct AuthGroup_struct // Header object for a list of AuthRecords with the same name
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthGroup *next; // Next AuthGroup object in this hash table bucket
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 namehash; // Name-based (i.e. case insensitive) hash of name
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord *members; // List of CacheRecords with this same name
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord **rrauth_tail; // Tail end of that list
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainname *name; // Common name for all AuthRecords in this list
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome for ((SLOT) = 0; (SLOT) < AUTH_HASH_SLOTS; (SLOT)++) \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome for ((AG)=m->rrauth.rrauth_hash[(SLOT)]; (AG); (AG)=(AG)->next) \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome for ((AR) = (AG)->members; (AR); (AR)=(AR)->next)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeunion AuthEntity_union { AuthEntity *next; AuthGroup ag; };
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct {
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 rrauth_size; // Total number of available auth entries
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 rrauth_totalused; // Number of auth entries currently occupied
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 rrauth_lock; // For debugging: Set at times when these lists may not be modified
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// AuthRecordAny includes mDNSInterface_Any and interface specific auth records.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecordAny, // registered for *Any, NOT including P2P interfaces
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecordAnyIncludeP2P, // registered for *Any, including P2P interfaces
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecordAnyIncludeAWDL, // registered for *Any, including AWDL interface
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecordAnyIncludeAWDLandP2P, // registered for *Any, including AWDL and P2P interfaces
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecordP2P // discovered over D2D/P2P framework
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // For examples of how to set up this structure for use in mDNS_Register(),
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // see mDNS_AdvertiseInterface() or mDNS_RegisterService().
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Basically, resrec and persistent metadata need to be set up before calling mDNS_Register().
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // mDNS_SetupResourceRecord() is avaliable as a helper routine to set up most fields to sensible default values for you
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord *next; // Next in list; first element of structure for efficiency reasons
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Field Group 1: Common ResourceRecord fields
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome ResourceRecord resrec; // 36 bytes when compiling for 32-bit; 48 when compiling for 64-bit (now 44/64)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Field Group 2: Persistent metadata for Authoritative Records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord *Additional1; // Recommended additional record to include in response (e.g. SRV for PTR record)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord *Additional2; // Another additional (e.g. TXT for PTR record)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord *DependentOn; // This record depends on another for its uniqueness checking
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord *RRSet; // This unique record is part of an RRSet
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSRecordCallback *RecordCallback; // Callback function to call for state changes, and to free memory asynchronously on deregistration
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome void *RecordContext; // Context parameter for the callback function
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 AutoTarget; // Set if the target of this record (PTR, CNAME, SRV, etc.) is our host name
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 AllowRemoteQuery; // Set if we allow hosts not on the local link to query this record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 ForceMCast; // Set by client to advertise solely via multicast, even for apparently unicast names
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome OwnerOptData WakeUp; // WakeUp.HMAC.l[0] nonzero indicates that this is a Sleep Proxy record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSAddr AddressProxy; // For reverse-mapping Sleep Proxy PTR records, address in question
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecType ARType; // LocalOnly, P2P or Normal ?
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 KATimeExpire; // In platform time units: time to send keepalive packet for the proxy record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Field Group 3: Transient state for Authoritative Records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 Acknowledged; // Set if we've given the success callback to the client
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 ProbeRestartCount; // Number of times we have restarted probing
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 ProbeCount; // Number of probes remaining before this record is valid (kDNSRecordTypeUnique)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 AnnounceCount; // Number of announcements remaining (kDNSRecordTypeShared)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 RequireGoodbye; // Set if this RR has been announced on the wire and will require a goodbye packet
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 AnsweredLocalQ; // Set if this AuthRecord has been delivered to any local question (LocalOnly or mDNSInterface_Any)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 IncludeInProbe; // Set if this RR is being put into a probe right now
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 ImmedUnicast; // Set if we may send our response directly via unicast to the requester
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID SendNSECNow; // Set if we need to generate associated NSEC data for this rrname
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID ImmedAnswer; // Someone on this interface issued a query we need to answer (all-ones for all interfaces)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID ImmedAdditional; // Hint that we might want to also send this record, just to be helpful
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID SendRNow; // The interface this query is being sent on right now
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSv4Addr v4Requester; // Recent v4 query for this record, or all-ones if more than one recent query
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSv6Addr v6Requester; // Recent v6 query for this record, or all-ones if more than one recent query
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord *NextResponse; // Link to the next element in the chain of responses to generate
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const mDNSu8 *NR_AnswerTo; // Set if this record was selected by virtue of being a direct answer to a question
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord *NR_AdditionalTo; // Set if this record was selected by virtue of being additional to another
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 ThisAPInterval; // In platform time units: Current interval for announce/probe
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 LastAPTime; // In platform time units: Last time we sent announcement/probe
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 LastMCTime; // Last time we multicast this record (used to guard against packet-storm attacks)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID LastMCInterface; // Interface this record was multicast on at the time LastMCTime was recorded
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome RData *NewRData; // Set if we are updating this record with new rdata
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 newrdlength; // ... and the length of the new RData
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 UpdateCredits; // Token-bucket rate limiting of excessive updates
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextUpdateCredit; // Time next token is added to bucket
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 UpdateBlocked; // Set if update delaying is in effect
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Field Group 4: Transient uDNS state for Authoritative Records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome regState_t state; // Maybe combine this with resrec.RecordType state? Right now it's ambiguous and confusing.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // e.g. rr->resrec.RecordType can be kDNSRecordTypeUnregistered,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // and rr->state can be regState_Unregistered
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // What if we find one of those statements is true and the other false? What does that mean?
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool uselease; // dynamic update contains (should contain) lease option
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 expire; // In platform time units: expiration of lease (-1 for static)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool Private; // If zone is private, DNS updates may have to be encrypted to prevent eavesdropping
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSOpaque16 updateid; // Identifier to match update request and response -- also used when transferring records to Sleep Proxy
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSOpaque64 updateIntID; // Interface IDs (one bit per interface index)to which updates have been sent
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const domainname *zone; // the zone that is updated
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool SRVChanged; // temporarily deregistered service because its SRV target or port changed
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mergeState_t mState; // Unicast Record Registrations merge state
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 refreshCount; // Number of refreshes to the server
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mStatus updateError; // Record update resulted in Error ?
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // uDNS_UpdateRecord support fields
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Do we really need all these in *addition* to NewRData and newrdlength above?
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome void *UpdateContext; // Context parameter for the update callback function
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 OrigRDLen; // previously registered, being deleted
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 InFlightRDLen; // currently being registered
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 QueuedRDLen; // pending operation (re-transmitting if necessary) THEN register the queued update
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Field Group 5: Large data objects go at the end
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome RData rdatastorage; // Normally the storage is right here, except for oversized records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // rdatastorage MUST be the last thing in the structure -- when using oversized AuthRecords, extra bytes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // are appended after the end of the AuthRecord, logically augmenting the size of the rdatastorage
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // DO NOT ADD ANY MORE FIELDS HERE
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// IsLocalDomain alone is not sufficient to determine that a record is mDNS or uDNS. By default domain names within
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// the "local" pseudo-TLD (and within the IPv4 and IPv6 link-local reverse mapping domains) are automatically treated
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// as mDNS records, but it is also possible to force any record (even those not within one of the inherently local
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// domains) to be handled as an mDNS record by setting the ForceMCast flag, or by setting a non-zero InterfaceID.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// For example, the reverse-mapping PTR record created in AdvertiseInterface sets the ForceMCast flag, since it points to
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// a dot-local hostname, and therefore it would make no sense to register this record with a wide-area Unicast DNS server.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The same applies to Sleep Proxy records, which we will answer for when queried via mDNS, but we never want to try
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// to register them with a wide-area Unicast DNS server -- and we probably don't have the required credentials anyway.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Currently we have no concept of a wide-area uDNS record scoped to a particular interface, so if the InterfaceID is
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// nonzero we treat this the same as ForceMCast.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Note: Question_uDNS(Q) is used in *only* one place -- on entry to mDNS_StartQuery_internal, to decide whether to set TargetQID.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Everywhere else in the code, the determination of whether a question is unicast is made by checking to see if TargetQID is nonzero.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define AuthRecord_uDNS(R) ((R)->resrec.InterfaceID == mDNSInterface_Any && !(R)->ForceMCast && !IsLocalDomain((R)->resrec.name))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define Question_uDNS(Q) ((Q)->InterfaceID == mDNSInterface_Unicast || (Q)->ProxyQuestion || \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((Q)->InterfaceID != mDNSInterface_LocalOnly && (Q)->InterfaceID != mDNSInterface_P2P && !(Q)->ForceMCast && !IsLocalDomain(&(Q)->qname)))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define RRLocalOnly(rr) ((rr)->ARType == AuthRecordLocalOnly || (rr)->ARType == AuthRecordP2P)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define RRAny(rr) ((rr)->ARType == AuthRecordAny || (rr)->ARType == AuthRecordAnyIncludeP2P || (rr)->ARType == AuthRecordAnyIncludeAWDL || (rr)->ARType == AuthRecordAnyIncludeAWDLandP2P)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Question (A or AAAA) that is suppressed currently because IPv4 or IPv6 address
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// is not available locally for A or AAAA question respectively. Also, if the
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// query is disallowed for the "pid" that we are sending on behalf of, suppress it.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define QuerySuppressed(Q) (((Q)->SuppressUnusable && (Q)->SuppressQuery) || ((Q)->DisallowPID))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define PrivateQuery(Q) ((Q)->AuthInfo && (Q)->AuthInfo->AutoTunnel)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Normally we always lookup the cache and /etc/hosts before sending the query on the wire. For single label
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// queries (A and AAAA) that are unqualified (indicated by AppendSearchDomains), we want to append search
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// domains before we try them as such
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define ApplySearchDomainsFirst(q) ((q)->AppendSearchDomains && (CountLabels(&((q)->qname))) == 1)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Wrapper struct for Auth Records for higher-level code that cannot use the AuthRecord's ->next pointer field
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord ar; // Note: Must be last element of structure, to accomodate oversized AuthRecords
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome CacheRecord *next; // Next in list; first element of structure for efficiency reasons
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome ResourceRecord resrec; // 36 bytes when compiling for 32-bit; 48 when compiling for 64-bit (now 44/64)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Transient state for Cache Records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome CacheRecord *NextInKAList; // Link to the next element in the chain of known answers to send
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 DelayDelivery; // Set if we want to defer delivery of this answer to local clients
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextRequiredQuery; // In platform time units
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSQuestion *CRActiveQuestion; // Points to an active question referencing this answer. Can never point to a NewQuestion.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 LastUnansweredTime; // In platform time units; last time we incremented UnansweredQueries
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 UnansweredQueries; // Number of times we've issued a query for this record without getting an answer
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 CRDNSSECQuestion; // Set to 1 if this was created in response to a DNSSEC question
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSOpaque16 responseFlags; // Second 16 bit in the DNS response
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 MPUnansweredQ; // Multi-packet query handling: Number of times we've seen a query for this record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 MPLastUnansweredQT; // Multi-packet query handling: Last time we incremented MPUnansweredQ
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 MPUnansweredKA; // Multi-packet query handling: Number of times we've seen this record in a KA list
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool MPExpectingKA; // Multi-packet query handling: Set when we increment MPUnansweredQ; allows one KA
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome CacheRecord *NextInCFList; // Set if this is in the list of records we just received with the cache flush bit set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome CacheRecord *nsec; // NSEC records needed for non-existence proofs
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome CacheRecord *soa; // SOA record to return for proxy questions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSAddr sourceAddress; // node from which we received this record
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome // Size to here is 76 bytes when compiling 32-bit; 104 bytes when compiling 64-bit (now 160 bytes for 64-bit)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome RData_small smallrdatastorage; // Storage for small records is right here (4 bytes header + 68 bytes data = 72 bytes)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Should match the CacheGroup_struct members, except namestorage[]. Only used to calculate
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome// the size of the namestorage array in CacheGroup_struct so that sizeof(CacheGroup) == sizeof(CacheRecord)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomestruct CacheGroup_struct // Header object for a list of CacheRecords with the same name
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome CacheGroup *next; // Next CacheGroup object in this hash table bucket
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 namehash; // Name-based (i.e. case insensitive) hash of name
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome CacheRecord *members; // List of CacheRecords with this same name
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome CacheRecord **rrcache_tail; // Tail end of that list
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainname *name; // Common name for all CacheRecords in this list
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 namestorage[sizeof(CacheRecord) - sizeof(struct CacheGroup_base)]; // match sizeof(CacheRecord)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Storage sufficient to hold either a CacheGroup header or a CacheRecord
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// -- for best efficiency (to avoid wasted unused storage) they should be the same size
4b22b9337f359bfd063322244f5336cc7c6ffcfarsunion CacheEntity_union { CacheEntity *next; CacheGroup cg; CacheRecord cr; };
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 _extradata[MaximumRDSize-InlineCacheRDSize]; // Glue on the necessary number of extra bytes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainname namestorage; // Needs to go *after* the extra rdata bytes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord arv4; // registered IPv4 address record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord arv6; // registered IPv6 address record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSRecordCallback *StatusCallback; // callback to deliver success or error code to client layer
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef struct ExtraResourceRecord_struct ExtraResourceRecord;
4b22b9337f359bfd063322244f5336cc7c6ffcfars mDNSu32 ClientID; // Opaque ID field to be used by client to map an AddRecord call to a set of Extra records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Note: Add any additional fields *before* the AuthRecord in this structure, not at the end.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // In some cases clients can allocate larger chunks of memory and set r->rdata->MaxRDLength to indicate
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // that this extra memory is available, which would result in any fields after the AuthRecord getting smashed
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Note: Within an mDNSServiceCallback mDNS all API calls are legal except mDNS_Init(), mDNS_Exit(), mDNS_Execute()
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void mDNSServiceCallback (mDNS *const m, ServiceRecordSet *const sr, mStatus result);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// A ServiceRecordSet has no special meaning to the core code of the Multicast DNS protocol engine;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// it is just a convenience structure to group together the records that make up a standard service
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// registration so that they can be allocted and deallocted together as a single memory object.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// It contains its own ServiceCallback+ServiceContext to report aggregate results up to the next layer of software above.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// It also contains:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// * the basic PTR/SRV/TXT triplet used to represent any DNS-SD service
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// * the "_services" PTR record for service enumeration
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// * the optional list of SubType PTR records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// * the optional list of additional records attached to the service set (e.g. iChat pictures)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // These internal state fields are used internally by mDNSCore; the client layer needn't be concerned with them.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // No fields need to be set up by the client prior to calling mDNS_RegisterService();
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // all required data is passed as parameters to that function.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool Conflict; // Set if this record set was forcibly deregistered because of a conflict
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ExtraResourceRecord *Extras; // Optional list of extra AuthRecords attached to this service registration
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 flags; // saved for subsequent calls to mDNS_RegisterService() if records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // need to be re-registered.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord RR_ADV; // e.g. _services._dns-sd._udp.local. PTR _printer._tcp.local.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord RR_PTR; // e.g. _printer._tcp.local. PTR Name._printer._tcp.local.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord RR_SRV; // e.g. Name._printer._tcp.local. SRV 0 0 port target
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord RR_TXT; // e.g. Name._printer._tcp.local. TXT PrintQueueName
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Don't add any fields after AuthRecord RR_TXT.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // This is where the implicit extra space goes if we allocate a ServiceRecordSet containing an oversized RR_TXT record
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars// We record the last eight instances of each duplicate query
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// This gives us v4/v6 on each of Ethernet, AirPort and Firewire, and two free slots "for future expansion"
4b22b9337f359bfd063322244f5336cc7c6ffcfars// If the host has more active interfaces that this it is not fatal -- duplicate question suppression will degrade gracefully.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Since we will still remember the last eight, the busiest interfaces will still get the effective duplicate question suppression.
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef struct
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef enum
4b22b9337f359bfd063322244f5336cc7c6ffcfars// LLQ constants
4b22b9337f359bfd063322244f5336cc7c6ffcfars#define kLLQ_MAX_TRIES 3 // retry an operation 3 times max
4b22b9337f359bfd063322244f5336cc7c6ffcfars#define kLLQ_INIT_RESEND 2 // resend an un-ack'd packet after 2 seconds, then double for each additional
4b22b9337f359bfd063322244f5336cc7c6ffcfars// LLQ Operation Codes
4b22b9337f359bfd063322244f5336cc7c6ffcfars// LLQ Errror Codes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeenum { NoAnswer_Normal = 0, NoAnswer_Suspended = 1, NoAnswer_Fail = 2 };
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (X)->AutoTunnelHostRecord.resrec.RecordType == kDNSRecordTypeUnregistered && \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (X)->AutoTunnelTarget.resrec.RecordType == kDNSRecordTypeUnregistered && \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (X)->AutoTunnelDeviceInfo.resrec.RecordType == kDNSRecordTypeUnregistered && \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (X)->AutoTunnelService.resrec.RecordType == kDNSRecordTypeUnregistered && \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (X)->AutoTunnel6Record.resrec.RecordType == kDNSRecordTypeUnregistered )
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Internal data structure to maintain authentication information
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 deltime; // If we're planning to delete this DomainAuthInfo, the time we want it deleted
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool AutoTunnel; // Whether this is AutoTunnel
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord AutoTunnelHostRecord; // User-visible hostname; used as SRV target for AutoTunnel services
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord AutoTunnelTarget; // Opaque hostname of tunnel endpoint; used as SRV target for AutoTunnelService record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord AutoTunnelDeviceInfo; // Device info of tunnel endpoint
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord AutoTunnelService; // Service record (possibly NAT-Mapped) of IKE daemon implementing tunnel endpoint
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord AutoTunnel6Record; // AutoTunnel AAAA Record obtained from awacsd
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool AutoTunnelServiceStarted; // Whether a service has been registered in this domain
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 keydata_ipad[HMAC_LEN]; // padded key for inner hash rounds
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 keydata_opad[HMAC_LEN]; // padded key for outer hash rounds
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Note: Within an mDNSQuestionCallback mDNS all API calls are legal except mDNS_Init(), mDNS_Exit(), mDNS_Execute()
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Note: Any value other than QC_rmv i.e., any non-zero value will result in kDNSServiceFlagsAdd to the application
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// layer. These values are used within mDNSResponder and not sent across to the application. QC_addnocache is for
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// delivering a response without adding to the cache. QC_forceresponse is superset of QC_addnocache where in
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// addition to not entering in the cache, it also forces the negative response through.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef enum { QC_rmv = 0, QC_add, QC_addnocache, QC_forceresponse, QC_dnssec , QC_nodnssec, QC_suppressed } QC_result;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void mDNSQuestionCallback (mDNS *const m, DNSQuestion *question, const ResourceRecord *const answer, QC_result AddRecord);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void AsyncDispatchFunc(mDNS *const m, void *context);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void DNSSECAuthInfoFreeCallback(mDNS *const m, void *context);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformDispatchAsync(mDNS *const m, void *context, AsyncDispatchFunc func);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define NextQSendTime(Q) ((Q)->LastQTime + (Q)->ThisQInterval)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define ActiveQuestion(Q) ((Q)->ThisQInterval > 0 && !(Q)->DuplicateOf)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define TimeToSendThisQuestion(Q,time) (ActiveQuestion(Q) && (time) - NextQSendTime(Q) >= 0)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// q->ValidationStatus is either DNSSECValNotRequired or DNSSECValRequired and then moves onto DNSSECValInProgress.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// When Validation is done, we mark all "DNSSECValInProgress" questions "DNSSECValDone". If we are answering
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// questions from /etc/hosts, then we go straight to DNSSECValDone from the initial state.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef enum { DNSSECValNotRequired = 0, DNSSECValRequired, DNSSECValInProgress, DNSSECValDone } DNSSECValState;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// ValidationRequired can be set to the following values:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// SECURE validation is set to determine whether something is secure or bogus
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// INSECURE validation is set internally by dnssec code to indicate that it is currently proving something
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// is insecure
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// For both ValidationRequired and ValidatingResponse question, we validate DNSSEC responses.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// For ProxyQuestion with DNSSECOK, we just receive the DNSSEC records to pass them along without
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// validation and if the CD bit is not set, we also validate.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define DNSSECQuestion(q) ((q)->ValidationRequired || (q)->ValidatingResponse || ((q)->ProxyQuestion && (q)->ProxyDNSSECOK))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// ValidatingQuestion is used when we need to know whether we are validating the DNSSEC responses for a question
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define ValidatingQuestion(q) ((q)->ValidationRequired || (q)->ValidatingResponse)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define DNSSECOptionalQuestion(q) ((q)->ValidationRequired == DNSSEC_VALIDATION_SECURE_OPTIONAL)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Given the resource record and the question, should we follow the CNAME ?
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define FollowCNAME(q, rr, AddRecord) (AddRecord && (q)->qtype != kDNSType_CNAME && \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (rr)->RecordType != kDNSRecordTypePacketNegative && \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// RFC 4122 defines it to be 16 bytes
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soometypedef struct
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome domainname * originalQName; // Name of original A/AAAA record if this question is for a CNAME record.
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome mDNSu32 querySendCount; // Number of queries that have been sent to DNS servers so far.
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome mDNSs32 firstQueryTime; // The time when the first query was sent to a DNS server.
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome mDNSBool answered; // Has this question been answered?
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Internal state fields. These are used internally by mDNSCore; the client layer needn't be concerned with them.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 DelayAnswering; // Set if we want to defer answering this question until the cache settles
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 LastQTime; // Last scheduled transmission of this Q on *all* applicable interfaces
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 ThisQInterval; // LastQTime + ThisQInterval is the next scheduled transmission of this Q
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // ThisQInterval > 0 for an active question;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // ThisQInterval = 0 for a suspended question that's still in the list
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // ThisQInterval = -1 for a cancelled question (should not still be in list)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 ExpectUnicastResp; // Set when we send a query with the kDNSQClass_UnicastResponse bit set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 LastAnswerPktNum; // The sequence number of the last response packet containing an answer to this Q
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 RecentAnswerPkts; // Number of answers since the last time we sent this query
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 CurrentAnswers; // Number of records currently in the cache that answer this question
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 BrowseThreshold; // If we have received at least this number of answers,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // set the next question interval to MaxQuestionInterval
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 LargeAnswers; // Number of answers with rdata > 1024 bytes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 UniqueAnswers; // Number of answers received with kDNSClass_UniqueRRSet bit set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID FlappingInterface1; // Set when an interface goes away, to flag if remove events are delivered for this Q
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID FlappingInterface2; // Set when an interface goes away, to flag if remove events are delivered for this Q
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DomainAuthInfo *AuthInfo; // Non-NULL if query is currently being done using Private DNS
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AnonymousInfo *AnonInfo; // Anonymous Information
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DupSuppressInfo DupSuppress[DupSuppressInfoSize];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID SendQNow; // The interface this query is being sent on right now
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool SendOnAll; // Set if we're sending this question on all active interfaces
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool CachedAnswerNeedsUpdate; // See SendQueries(). Set if we're sending this question
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // because a cached answer needs to be refreshed.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 RequestUnicast; // Non-zero if we want to send query with kDNSQClass_UnicastResponse bit set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 LastQTxTime; // Last time this Q was sent on one (but not necessarily all) interfaces
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 CNAMEReferrals; // Count of how many CNAME redirections we've done
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool SuppressQuery; // This query should be suppressed and not sent on the wire
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 LOAddressAnswers; // Number of answers from the local only auth records that are
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // answering A, AAAA, CNAME, or PTR (/etc/hosts)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 WakeOnResolveCount; // Number of wakes that should be sent on resolve
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 StopTime; // Time this question should be stopped by giving them a negative answer
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // DNSSEC fields
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSSECValState ValidationState; // Current state of the Validation process
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSSECStatus ValidationStatus; // Validation status for "ValidationRequired" questions (dnssec)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 ValidatingResponse; // Question trying to validate a response (dnssec) on behalf of
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // ValidationRequired question
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Wide Area fields. These are used internally by the uDNS core (Unicast)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // |-> DNS Configuration related fields used in uDNS (Subset of Wide Area/Unicast fields)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSServer *qDNSServer; // Caching server for this query (in the absence of an SRV saying otherwise)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSOpaque64 validDNSServers; // Valid DNSServers for this question
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 noServerResponse; // At least one server did not respond.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 triedAllServersOnce; // Tried all DNS servers once
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 unansweredQueries; // The number of unanswered queries to this server
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ZoneData *nta; // Used for getting zone data for private or LLQ query
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSAddr servAddr; // Address and port learned from _dns-llq, _dns-llq-tls or _dns-query-tls SRV query
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSIPPort tcpSrcPort; // Local Port TCP packet received on;need this as tcp struct is disposed
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // by tcpCallback before calling into mDNSCoreReceive
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 NoAnswer; // Set if we want to suppress answers until tunnel setup has completed
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 Restart; // This question should be restarted soon
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // LLQ-specific fields. These fields are only meaningful when LongLived flag is set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs16 ntries; // for UDP: the number of packets sent for this LLQ state
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // for TCP: there is some ambiguity in the use of this variable, but in general, it is
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // the number of TCP/TLS connection attempts for this LLQ state, or
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // the number of packets sent for this TCP/TLS connection
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // DNS Proxy fields
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSOpaque16 responseFlags; // Temporary place holder for the error we get back from the DNS server
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // till we populate in the cache
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool DisallowPID; // Is the query allowed for the "PID" that we are sending on behalf of ?
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 ServiceID; // Service identifier to match against the DNS server
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Client API fields: The client must set up these fields *before* calling mDNS_StartQuery()
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID InterfaceID; // Non-zero if you want to issue queries only on a single specific IP interface
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 flags; // flags from original DNSService*() API request.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSAddr Target; // Non-zero if you want to direct queries to a specific unicast target address
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSIPPort TargetPort; // Must be set if Target is set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSOpaque16 TargetQID; // Must be set if Target is set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool LongLived; // Set by client for calls to mDNS_StartQuery to indicate LLQs to unicast layer.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool ExpectUnique; // Set by client if it's expecting unique RR(s) for this question, not shared RRs
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool ForceMCast; // Set by client to force mDNS query, even for apparently uDNS names
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool ReturnIntermed; // Set by client to request callbacks for intermediate CNAME/NXDOMAIN results
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool SuppressUnusable; // Set by client to suppress unusable queries to be sent on the wire
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool DenyOnCellInterface; // Set by client to suppress uDNS queries on cellular interface
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool DenyOnExpInterface; // Set by client to suppress uDNS queries on expensive interface
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 RetryWithSearchDomains; // Retry with search domains if there is no entry in the cache or AuthRecords
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 TimeoutQuestion; // Timeout this question if there is no reply in configured time
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 WakeOnResolve; // Send wakeup on resolve
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 UseBackgroundTrafficClass; // Set by client to use background traffic class for request
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs8 SearchListIndex; // Index into SearchList; Used by the client layer but not touched by core
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs8 AppendSearchDomains; // Search domains can be appended for this query
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs8 AppendLocalSearchDomains; // Search domains ending in .local can be appended for this query
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 ValidationRequired; // Requires DNSSEC validation.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 ProxyDNSSECOK; // Proxy Question with EDNS0 DNSSEC OK bit set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 pid; // Process ID of the client that is requesting the question
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 uuid[UUID_SIZE]; // Unique ID of the client that is requesting the question (valid only if pid is zero)
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome mDNSu32 euid; // Effective User Id of the client that is requesting the question
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainname *qnameOrig; // Copy of the original question name if it is not fully qualified
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome uDNSMetrics metrics; // Data used for collecting unicast DNS query metrics.
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Client API fields: The client must set up name and InterfaceID *before* calling mDNS_StartResolveService()
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // When the callback is invoked, ip, port, TXTlen and TXTinfo will have been filled in with the results learned from the network.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID InterfaceID; // ID of the interface the response was received on
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSAddr ip; // Remote (destination) IP address where this service can be accessed
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSIPPort port; // Port where this service can be accessed
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 TXTinfo[2048]; // Additional demultiplexing information (e.g. LPR queue name)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Note: Within an mDNSServiceInfoQueryCallback mDNS all API calls are legal except mDNS_Init(), mDNS_Exit(), mDNS_Execute()
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void mDNSServiceInfoQueryCallback (mDNS *const m, ServiceInfoQuery *query);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Internal state fields. These are used internally by mDNSCore; the client layer needn't be concerned with them.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // No fields need to be set up by the client prior to calling mDNS_StartResolveService();
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // all required data is passed as parameters to that function.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // The ServiceInfoQuery structure memory is working storage for mDNSCore to discover the requested information
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // and place it in the ServiceInfo structure. After the client has called mDNS_StopResolveService(), it may
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // dispose of the ServiceInfoQuery structure while retaining the results in the ServiceInfo structure.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSServiceInfoQueryCallback *ServiceInfoQueryCallback;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef enum { ZoneServiceUpdate, ZoneServiceQuery, ZoneServiceLLQ } ZoneService;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void ZoneDataCallback (mDNS *const m, mStatus err, const ZoneData *result);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainname ChildName; // Name for which we're trying to find the responsible server
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ZoneService ZoneService; // Which service we're seeking for this zone (update, query, or LLQ)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainname *CurrentSOA; // Points to somewhere within ChildName
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainname ZoneName; // Discovered result: Left-hand-side of SOA record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 ZoneClass; // Discovered result: DNS Class from SOA record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainname Host; // Discovered result: Target host from SRV record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSIPPort Port; // Discovered result: Update port, query port, or LLQ port from SRV record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSAddr Addr; // Discovered result: Address of Target host from SRV record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool ZonePrivate; // Discovered result: Does zone require encrypted queries?
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ZoneDataCallback *ZoneDataCallback; // Caller-specified function to be called upon completion
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSQuestion question; // Storage for any active question
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern ZoneData *StartGetZoneData(mDNS *const m, const domainname *const name, const ZoneService target, ZoneDataCallback callback, void *callbackInfo);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void CancelGetZoneData(mDNS *const m, ZoneData *nta);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool IsGetZoneDataQuestion(DNSQuestion *q);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Different states that we go through locating the peer
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define TC_STATE_AAAA_PEER 0x000000001 /* Peer's BTMM IPv6 address */
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define TC_STATE_AAAA_PEER_RELAY 0x000000002 /* Peer's IPv6 Relay address */
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define TC_STATE_SRV_PEER 0x000000003 /* Peer's SRV Record corresponding to IPv4 address */
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define TC_STATE_ADDR_PEER 0x000000004 /* Peer's IPv4 address */
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct NetworkInterfaceInfo_struct NetworkInterfaceInfo;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// A NetworkInterfaceInfo_struct serves two purposes:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 1. It holds the address, PTR and HINFO records to advertise a given IP address on a given physical interface
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 2. It tells mDNSCore which physical interfaces are available; each physical interface has its own unique InterfaceID.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Since there may be multiple IP addresses on a single physical interface,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// there may be multiple NetworkInterfaceInfo_structs with the same InterfaceID.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// In this case, to avoid sending the same packet n times, when there's more than one
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// struct with the same InterfaceID, mDNSCore picks one member of the set to be the
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// active representative of the set; all others have the 'InterfaceActive' flag unset.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Internal state fields. These are used internally by mDNSCore; the client layer needn't be concerned with them.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 InterfaceActive; // Set if interface is sending & receiving packets (see comment above)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 IPv4Available; // If InterfaceActive, set if v4 available on this InterfaceID
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 IPv6Available; // If InterfaceActive, set if v6 available on this InterfaceID
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSQuestion NetWakeResolve[3]; // For fault-tolerance, we try up to three Sleep Proxies
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextSPSAttempt; // -1 if we're not currently attempting to register with any Sleep Proxy
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Standard AuthRecords that every Responder host should have (one per active IP address)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord RR_A; // 'A' or 'AAAA' (address) record for our ".local" name
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord RR_PTR; // PTR (reverse lookup) record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Client API fields: The client must set up these fields *before* calling mDNS_RegisterInterface()
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID InterfaceID; // Identifies physical interface; MUST NOT be 0, -1, or -2
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSAddr ip; // The IPv4 or IPv6 address to advertise
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char ifname[64]; // Windows uses a GUID string for the interface name, which doesn't fit in 16 bytes
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 Advertise; // False if you are only searching on this interface
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 McastTxRx; // Send/Receive multicast on this { InterfaceID, address family } ?
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 NetWake; // Set if Wake-On-Magic-Packet is enabled on this interface
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 Loopback; // Set if this is the loopback interface
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 IgnoreIPv4LL; // Set if IPv4 Link-Local addresses have to be ignored.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 SendGoodbyes; // Send goodbyes on this interface while sleeping
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool DirectLink; // a direct link, indicating we can skip the probe for
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // address records
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome mDNSBool SupportsUnicastMDNSResponse; // Indicates that the interface supports unicast responses
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome // to Bonjour queries. Generally true for an interface.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define SLE_WAB_LBROWSE_QUERY_STARTED 0x00000004
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// For domain enumeration and automatic browsing
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// This is the user's DNS search list.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// In each of these domains we search for our special pointer records (lb._dns-sd._udp.<domain>, etc.)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// to discover recommended domains for domain enumeration (browse, default browse, registration,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// default registration) and possibly one or more recommended automatic browsing domains.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern SearchListElem *SearchList; // This really ought to be part of mDNS_struct -- SC
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars#pragma mark - Main mDNS object, used to hold all the mDNS state
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void mDNSCallback (mDNS *const m, mStatus result);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 NumProbesSent; // Number of probes sent
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 MsgSize0; // DNSSEC message size <= 1024
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 MsgSize1; // DNSSEC message size <= 2048
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 MsgSize2; // DNSSEC message size > 2048
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef struct
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 NameConflicts; // Normal Name conflicts
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 KnownUniqueNameConflicts; // Name Conflicts for KnownUnique Records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 DupQuerySuppressions; // Duplicate query suppressions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 KnownAnswerSuppressions; // Known Answer suppressions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 KnownAnswerMultiplePkts; // Known Answer in queries spannign multiple packets
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 PoofCacheDeletions; // Number of times the cache was deleted due to POOF
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 UnicastBitInQueries; // Queries with QU bit set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 NormalQueries; // Queries with QU bit not set
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 MatchingAnswersForQueries; // Queries for which we had a response
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 UnicastResponses; // Unicast responses to queries
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 MulticastResponses; // Multicast responses to queries
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 UnicastDemotedToMulticast; // Number of times unicast demoted to multicast
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 InterfaceUp; // Total Interface UP events
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 InterfaceUpFlap; // Total Interface UP events with flaps
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 InterfaceDown; // Total Interface Down events
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 InterfaceDownFlap; // Total Interface Down events with flaps
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 CacheRefreshQueries; // Number of queries that we sent for refreshing cache
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 CacheRefreshed; // Number of times the cache was refreshed due to a response
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 WakeOnResolves; // Number of times we did a wake on resolve
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Internal state fields. These hold the main internal state of mDNSCore;
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // the client layer needn't be concerned with them.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // No fields need to be set up by the client prior to calling mDNS_Init();
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // all required data is passed as parameters to that function.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNS_PlatformSupport *p; // Pointer to platform-specific data of indeterminite size
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool DivertMulticastAdvertisements; // from interfaces that do not advertise local addresses to local-only
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSEthAddr PrimaryMAC; // Used as unique host ID
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // For debugging: To catch and report locking failures
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 mDNS_busy; // Incremented between mDNS_Lock/mDNS_Unlock section
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 mDNS_reentrancy; // Incremented when calling a client callback
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 lock_rrcache; // For debugging: Set at times when these lists may not be modified
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char MsgBuffer[MaxMsg]; // Temp storage used while building error log messages
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Task Scheduling variables
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 timenow_adjust; // Correction applied if we ever discover time went backwards
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 timenow; // The time that this particular activation of the mDNS code started
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 timenow_last; // The time the last time we ran
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextScheduledEvent; // Derived from values below
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 ShutdownTime; // Set when we're shutting down; allows us to skip some unnecessary steps
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 SuppressSending; // Don't send local-link mDNS packets during this time
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextCacheCheck; // Next time to refresh cache record before it expires
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextScheduledQuery; // Next time to send query in its exponential backoff sequence
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextScheduledProbe; // Next time to probe for new authoritative record
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextScheduledResponse; // Next time to send authoritative record(s) in responses
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextScheduledNATOp; // Next time to send NAT-traversal packets
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextScheduledSPS; // Next time to purge expiring Sleep Proxy records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextScheduledKA; // Next time to send Keepalive packets (SPS)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 RandomQueryDelay; // For de-synchronization of query packets on the wire
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 RandomReconfirmDelay; // For de-synchronization of reconfirmation queries on the wire
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 PktNum; // Unique sequence number assigned to each received packet
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 MPktNum; // Unique sequence number assigned to each received Multicast packet
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 LocalRemoveEvents; // Set if we may need to deliver remove events for local-only questions and/or local-only records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 SleepSeqNum; // "Epoch number" of our current period of wakefulness
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 SystemWakeOnLANEnabled; // Set if we want to register with a Sleep Proxy before going to sleep
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 SentSleepProxyRegistration; // Set if we registered (or tried to register) with a Sleep Proxy
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 SystemSleepOnlyIfWakeOnLAN; // Set if we may only sleep if we managed to register with a Sleep Proxy
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 AnnounceOwner; // After waking from sleep, include OWNER option in packets until this time
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 DelaySleep; // To inhibit re-sleeping too quickly right after wake
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 SleepLimit; // Time window to allow deregistrations, etc.,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // during which underying platform layer should inhibit system sleep
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 StatStartTime; // Time we started gathering statistics during this interval.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextStatLogTime; // Next time to log statistics.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 ActiveStatTime; // Total time awake/gathering statistics for this log period.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 UnicastPacketsSent; // Number of unicast packets sent.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 MulticastPacketsSent; // Number of multicast packets sent.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 RemoteSubnet; // Multicast packets received from outside our subnet.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextScheduledSPRetry; // Time next sleep proxy registration action is required.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Only valid if SleepLimit is nonzero and DelaySleep is zero.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextScheduledStopTime; // Next time to stop a question
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // These fields only required for mDNS Searcher...
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSQuestion *Questions; // List of all registered questions, active and inactive
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSQuestion *NewQuestions; // Fresh questions not yet answered from cache
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSQuestion *CurrentQuestion; // Next question about to be examined in AnswerLocalQuestions()
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSQuestion *LocalOnlyQuestions; // Questions with InterfaceID set to mDNSInterface_LocalOnly or mDNSInterface_P2P
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSQuestion *NewLocalOnlyQuestions; // Fresh local-only or P2P questions not yet answered
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSQuestion *RestartQuestion; // Questions that are being restarted (stop followed by start)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSQuestion *ValidationQuestion; // Questions that are being validated (dnssec)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 rrcache_size; // Total number of available cache entries
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 rrcache_totalused; // Number of cache entries currently occupied
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 rrcache_totalused_unicast; // Number of cache entries currently occupied by unicast
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 rrcache_active; // Number of cache entries currently occupied by records that answer active questions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Fields below only required for mDNS Responder...
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainlabel nicelabel; // Rich text label encoded using canonically precomposed UTF-8
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainlabel hostlabel; // Conforms to RFC 1034 "letter-digit-hyphen" ARPANET host name rules
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainname MulticastHostname; // Fully Qualified "dot-local" Host Name, e.g. "Foo.local."
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord *DuplicateRecords; // Records currently 'on hold' because they are duplicates of existing records
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord *NewLocalRecords; // Fresh AuthRecords (public) not yet delivered to our local-only questions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord *CurrentRecord; // Next AuthRecord about to be examined
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool NewLocalOnlyRecords; // Fresh AuthRecords (local only) not yet delivered to our local questions
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome Platform_t mDNS_plat; // Why is this here in the “only required for mDNS Responder” section? -- SC
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Unicast-specific data
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 NextSRVUpdate; // Time to perform delayed update
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome McastResolver *McastResolvers; // list of Mcast Resolvers
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSAddr AdvertisedV4; // IPv4 address pointed to by hostname
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSAddr AdvertisedV6; // IPv6 address pointed to by hostname
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DomainAuthInfo *AuthInfoList; // list of domains requiring authentication for updates
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSQuestion ReverseMap; // Reverse-map query to find static hostname for service target
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome domainname StaticHostname; // Current answer to reverse-map query
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome HostnameInfo *Hostnames; // List of registered hostnames + hostname metadata
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome NATTraversalInfo AutoTunnelNAT; // Shared between all AutoTunnel DomainAuthInfo structs
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 WABBrowseQueriesCount; // Number of WAB Browse domain enumeration queries (b, db) callers
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 WABLBrowseQueriesCount; // Number of legacy WAB Browse domain enumeration queries (lb) callers
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 WABRegQueriesCount; // Number of WAB Registration domain enumeration queries (r, dr) callers
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // NAT-Traversal fields
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome NATTraversalInfo LLQNAT; // Single shared NAT Traversal to receive inbound LLQ notifications
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 retryIntervalGetAddr; // delta between time sent and retry for NAT-PMP & UPnP/IGD external address request
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 retryGetAddr; // absolute time when we retry for NAT-PMP & UPnP/IGD external address request
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSv4Addr ExtAddress; // the external address discovered via NAT-PMP or UPnP/IGD
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome UDPSocket *NATMcastRecvskt; // For receiving PCP & NAT-PMP announcement multicasts from router on port 5350
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 LastNATupseconds; // NAT engine uptime in seconds, from most recent NAT packet
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSs32 LastNATReplyLocalTime; // Local time in ticks when most recent NAT packet was received
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 LastNATMapResultCode; // Most recent error code for mappings
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome tcpLNTInfo tcpAddrInfo; // legacy NAT traversal TCP connection info for external address
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome tcpLNTInfo tcpDeviceInfo; // legacy NAT traversal TCP connection info for device info
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome tcpLNTInfo *tcpInfoUnmapList; // list of pending unmap requests
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome UDPSocket *SSDPSocket; // For SSDP request/response
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool SSDPWANPPPConnection; // whether we should send the SSDP query for WANIPConnection or WANPPPConnection
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSIPPort UPnPRouterPort; // port we send discovery messages to
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSIPPort UPnPSOAPPort; // port we send SOAP messages to
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool UPnPWANPPPConnection; // whether we're using WANIPConnection or WANPPPConnection
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 *UPnPSOAPURL; // router's SOAP control URL string
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 *UPnPRouterAddressString; // holds both the router's address and port
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 *UPnPSOAPAddressString; // holds both address and port for SOAP messages
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Sleep Proxy client fields
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome AuthRecord *SPSRRSet; // To help the client keep track of the records registered with the sleep proxy
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Sleep Proxy Server fields
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 SPSType; // 0 = off, 10-99 encodes desirability metric
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 SPSFeatureFlags; // Features supported. Currently 1 = TCP KeepAlive supported.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu8 SPSState; // 0 = off, 1 = running, 2 = shutting down, 3 = suspended during sleep
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSQuestionCallback *SPSBrowseCallback; // So the platform layer can do something useful with SPS browse results
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome int ProxyRecords; // Total number of records we're holding as proxy
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome #define MAX_PROXY_RECORDS 10000 /* DOS protection: 400 machines at 25 records each */
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // DNS Proxy fields
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 dp_ipintf[MaxIp]; // input interface index list from the DNS Proxy Client
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 dp_opintf; // output interface index from the DNS Proxy Client
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome int uds_listener_skt; // Listening socket for incoming UDS clients. This should not be here -- it's private to uds_daemon.c and nothing to do with mDNSCore -- SC
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu32 AutoTargetServices; // # of services that have AutoTarget set
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome mDNSu32 NumAllInterfaceRecords; // Right now we count *all* multicast records here. Later we may want to change to count interface-specific records separately. (This count includes records on the DuplicateRecords list too.)
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome mDNSu32 NumAllInterfaceQuestions; // Right now we count *all* multicast questions here. Later we may want to change to count interface-specific questions separately.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Fixed storage, to avoid creating large objects on the stack
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // The imsg is declared as a union with a pointer type to enforce CPU-appropriate alignment
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome union { DNSMessage m; void *p; } imsg; // Incoming message received from wire
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNSMessage omsg; // Outgoing message we're building
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome LargeCacheRecord rec; // Resource Record extracted from received message
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome for ((SLOT) = 0; (SLOT) < CACHE_HASH_SLOTS; (SLOT)++) \
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome for ((CG)=m->rrcache_hash[(SLOT)]; (CG); (CG)=(CG)->next) \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome for ((CR) = (CG)->members; (CR); (CR)=(CR)->next)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern const mDNSInterfaceID mDNSInterface_Any; // Zero
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern const mDNSInterfaceID mDNSInterface_LocalOnly; // Special value
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern const mDNSInterfaceID mDNSInterface_Unicast; // Special value
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern const mDNSInterfaceID mDNSInterfaceMark; // Special value
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern const mDNSInterfaceID mDNSInterface_P2P; // Special value
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern const mDNSInterfaceID uDNSInterfaceMark; // Special value
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define localdomain (*(const domainname *)"\x5" "local")
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define DeviceInfoName (*(const domainname *)"\xC" "_device-info" "\x4" "_tcp")
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define LocalDeviceInfoName (*(const domainname *)"\xC" "_device-info" "\x4" "_tcp" "\x5" "local")
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define SleepProxyServiceType (*(const domainname *)"\xC" "_sleep-proxy" "\x4" "_udp")
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars#if (defined(_MSC_VER))
4b22b9337f359bfd063322244f5336cc7c6ffcfars#elif ((__GNUC__ > 2) || ((__GNUC__ == 2) && (__GNUC_MINOR__ >= 9)))
4b22b9337f359bfd063322244f5336cc7c6ffcfars// If we're not doing inline functions, then this header needs to have the extern declarations
4b22b9337f359bfd063322244f5336cc7c6ffcfars#if !defined(mDNSinline)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// If we're compiling the particular C file that instantiates our inlines, then we
4b22b9337f359bfd063322244f5336cc7c6ffcfars// define "mDNSinline" (to empty string) so that we generate code in the following section
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas SoomemDNSinline mDNSs32 NonZeroTime(mDNSs32 t) { if (t) return(t);else return(1);}
4b22b9337f359bfd063322244f5336cc7c6ffcfarsmDNSinline mDNSu16 mDNSVal16(mDNSOpaque16 x) { return((mDNSu16)((mDNSu16)x.b[0] << 8 | (mDNSu16)x.b[1])); }
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Every client should call mDNS_Init, passing in storage for the mDNS object and the mDNS_PlatformSupport object.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Clients that are only advertising services should use mDNS_Init_NoCache and mDNS_Init_ZeroCacheSize.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Clients that plan to perform queries (mDNS_StartQuery, mDNS_StartBrowse, mDNS_StartResolveService, etc.)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// need to provide storage for the resource record cache, or the query calls will return 'mStatus_NoCache'.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// The rrcachestorage parameter is the address of memory for the resource record cache, and
4b22b9337f359bfd063322244f5336cc7c6ffcfars// the rrcachesize parameter is the number of entries in the CacheRecord array passed in.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// (i.e. the size of the cache memory needs to be sizeof(CacheRecord) * rrcachesize).
4b22b9337f359bfd063322244f5336cc7c6ffcfars// OS X 10.3 Panther uses an initial cache size of 64 entries, and then mDNSCore sends an
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mStatus_GrowCache message if it needs more.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Most clients should use mDNS_Init_AdvertiseLocalAddresses. This causes mDNSCore to automatically
4b22b9337f359bfd063322244f5336cc7c6ffcfars// create the correct address records for all the hosts interfaces. If you plan to advertise
4b22b9337f359bfd063322244f5336cc7c6ffcfars// services being offered by the local machine, this is almost always what you want.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// There are two cases where you might use mDNS_Init_DontAdvertiseLocalAddresses:
4b22b9337f359bfd063322244f5336cc7c6ffcfars// 1. A client-only device, that browses for services but doesn't advertise any of its own.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// 2. A proxy-registration service, that advertises services being offered by other machines, and takes
4b22b9337f359bfd063322244f5336cc7c6ffcfars// the appropriate steps to manually create the correct address records for those other machines.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// In principle, a proxy-like registration service could manually create address records for its own machine too,
4b22b9337f359bfd063322244f5336cc7c6ffcfars// but this would be pointless extra effort when using mDNS_Init_AdvertiseLocalAddresses does that for you.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Note that a client-only device that wishes to prohibit multicast advertisements (e.g. from
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// higher-layer API calls) must also set DivertMulticastAdvertisements in the mDNS structure and
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// advertise local address(es) on a loopback interface.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// When mDNS has finished setting up the client's callback is called
4b22b9337f359bfd063322244f5336cc7c6ffcfars// A client can also spin and poll the mDNSPlatformStatus field to see when it changes from mStatus_Waiting to mStatus_NoError
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Call mDNS_StartExit to tidy up before exiting
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Because exiting may be an asynchronous process (e.g. if unicast records need to be deregistered)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// client layer may choose to wait until mDNS_ExitNow() returns true before calling mDNS_FinalExit().
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Call mDNS_Register with a completed AuthRecord object to register a resource record
4b22b9337f359bfd063322244f5336cc7c6ffcfars// If the resource record type is kDNSRecordTypeUnique (or kDNSknownunique) then if a conflicting resource record is discovered,
4b22b9337f359bfd063322244f5336cc7c6ffcfars// the resource record's mDNSRecordCallback will be called with error code mStatus_NameConflict. The callback should deregister
4b22b9337f359bfd063322244f5336cc7c6ffcfars// the record, and may then try registering the record again after picking a new name (e.g. by automatically appending a number).
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Following deregistration, the RecordCallback will be called with result mStatus_MemFree to signal that it is safe to deallocate
4b22b9337f359bfd063322244f5336cc7c6ffcfars// the record's storage (memory must be freed asynchronously to allow for goodbye packets and dynamic update deregistration).
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Call mDNS_StartQuery to initiate a query. mDNS will proceed to issue Multicast DNS query packets, and any time a response
4b22b9337f359bfd063322244f5336cc7c6ffcfars// is received containing a record which matches the question, the DNSQuestion's mDNSAnswerCallback function will be called
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Call mDNS_StopQuery when no more answers are required
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Care should be taken on multi-threaded or interrupt-driven environments.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// The main mDNS routines call mDNSPlatformLock() on entry and mDNSPlatformUnlock() on exit;
4b22b9337f359bfd063322244f5336cc7c6ffcfars// each platform layer needs to implement these appropriately for its respective platform.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// For example, if the support code on a particular platform implements timer callbacks at interrupt time, then
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNSPlatformLock/Unlock need to disable interrupts or do similar concurrency control to ensure that the mDNS
4b22b9337f359bfd063322244f5336cc7c6ffcfars// code is not entered by an interrupt-time timer callback while in the middle of processing a client call.
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_Init (mDNS *const m, mDNS_PlatformSupport *const p,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome CacheEntity *rrcachestorage, mDNSu32 rrcachesize,
4b22b9337f359bfd063322244f5336cc7c6ffcfars// See notes above on use of NoCache/ZeroCacheSize
4b22b9337f359bfd063322244f5336cc7c6ffcfars// See notes above on use of Advertise/DontAdvertiseLocalAddresses
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern void mDNS_GrowCache (mDNS *const m, CacheEntity *storage, mDNSu32 numrecords);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNS_Close(m) do { mDNS_StartExit(m); mDNS_FinalExit(m); } while(0)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNS_ExitNow(m, now) ((now) - (m)->ShutdownTime >= 0 || (!(m)->ResourceRecords))
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_Register (mDNS *const m, AuthRecord *const rr);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_Update (mDNS *const m, AuthRecord *const rr, mDNSu32 newttl,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const mDNSu16 newrdlength, RData *const newrdata, mDNSRecordUpdateCallback *Callback);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_Deregister(mDNS *const m, AuthRecord *const rr);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_StartQuery(mDNS *const m, DNSQuestion *const question);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_StopQuery (mDNS *const m, DNSQuestion *const question);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNS_StopQueryWithRemoves(mDNS *const m, DNSQuestion *const question);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_Reconfirm (mDNS *const m, CacheRecord *const cacherr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNS_Reconfirm_internal(mDNS *const m, CacheRecord *const rr, mDNSu32 interval);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_ReconfirmByValue(mDNS *const m, ResourceRecord *const rr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNS_PurgeCacheResourceRecord(mDNS *const m, CacheRecord *rr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNS_StartNATOperation(mDNS *const m, NATTraversalInfo *traversal);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNS_StopNATOperation(mDNS *const m, NATTraversalInfo *traversal);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNS_StopNATOperation_internal(mDNS *m, NATTraversalInfo *traversal);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern DomainAuthInfo *GetAuthInfoForName(mDNS *m, const domainname *const name);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNS_UpdateAllowSleep(mDNS *const m);
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars#pragma mark - Platform support functions that are accessible to the client layer too
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// mDNS_Dereg_normal is used for most calls to mDNS_Deregister_internal
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// mDNS_Dereg_rapid is used to send one goodbye instead of three, when we want the memory available for reuse sooner
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// mDNS_Dereg_conflict is used to indicate that this record is being forcibly deregistered because of a conflict
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// mDNS_Dereg_repeat is used when cleaning up, for records that may have already been forcibly deregistered
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef enum { mDNS_Dereg_normal, mDNS_Dereg_rapid, mDNS_Dereg_conflict, mDNS_Dereg_repeat } mDNS_Dereg_type;
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNS_RegisterService is a single call to register the set of resource records associated with a given named service.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNS_StartResolveService is single call which is equivalent to multiple calls to mDNS_StartQuery,
4b22b9337f359bfd063322244f5336cc7c6ffcfars// to find the IP address, port number, and demultiplexing information for a given named service.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// As with mDNS_StartQuery, it executes asynchronously, and calls the ServiceInfoQueryCallback when the answer is
4b22b9337f359bfd063322244f5336cc7c6ffcfars// found. After the service is resolved, the client should call mDNS_StopResolveService to complete the transaction.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// The client can also call mDNS_StopResolveService at any time to abort the transaction.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNS_AddRecordToService adds an additional record to a Service Record Set. This record may be deregistered
4b22b9337f359bfd063322244f5336cc7c6ffcfars// via mDNS_RemoveRecordFromService, or by deregistering the service. mDNS_RemoveRecordFromService is passed a
4b22b9337f359bfd063322244f5336cc7c6ffcfars// callback to free the memory associated with the extra RR when it is safe to do so. The ExtraResourceRecord
4b22b9337f359bfd063322244f5336cc7c6ffcfars// object can be found in the record's context pointer.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNS_GetBrowseDomains is a special case of the mDNS_StartQuery call, where the resulting answers
4b22b9337f359bfd063322244f5336cc7c6ffcfars// are a list of PTR records indicating (in the rdata) domains that are recommended for browsing.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// After getting the list of domains to browse, call mDNS_StopQuery to end the search.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNS_GetDefaultBrowseDomain returns the name of the domain that should be highlighted by default.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNS_GetRegistrationDomains and mDNS_GetDefaultRegistrationDomain are the equivalent calls to get the list
4b22b9337f359bfd063322244f5336cc7c6ffcfars// of one or more domains that should be offered to the user as choices for where they may register their service,
4b22b9337f359bfd063322244f5336cc7c6ffcfars// and the default domain in which to register in the case where the user has made no selection.
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern void mDNS_SetupResourceRecord(AuthRecord *rr, RData *RDataStorage, mDNSInterfaceID InterfaceID,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSu16 rrtype, mDNSu32 ttl, mDNSu8 RecordType, AuthRecType artype, mDNSRecordCallback Callback, void *Context);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// mDNS_RegisterService() flags parameter bit definitions.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Note these are only defined to transfer the corresponding DNSServiceFlags settings into mDNSCore routines,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// since code in mDNSCore does not include the DNSServiceFlags definitions in dns_sd.h.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome coreFlagIncludeP2P = 0x1, // include P2P interfaces when using mDNSInterface_Any
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome coreFlagIncludeAWDL = 0x2, // include AWDL interface when using mDNSInterface_Any
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome coreFlagKnownUnique = 0x4, // client guarantees that SRV and TXT record names are unique
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome coreFlagWakeOnly = 0x8 // Service won't be registered with sleep proxy
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_RegisterService (mDNS *const m, ServiceRecordSet *sr,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const domainlabel *const name, const domainname *const type, const domainname *const domain,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const domainname *const host, mDNSIPPort port, const mDNSu8 txtinfo[], mDNSu16 txtlen,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID InterfaceID, mDNSServiceCallback Callback, void *Context, mDNSu32 flags);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNS_AddRecordToService(mDNS *const m, ServiceRecordSet *sr, ExtraResourceRecord *extra, RData *rdata, mDNSu32 ttl, mDNSu32 flags);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_RemoveRecordFromService(mDNS *const m, ServiceRecordSet *sr, ExtraResourceRecord *extra, mDNSRecordCallback MemFreeCallback, void *Context);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_RenameAndReregisterService(mDNS *const m, ServiceRecordSet *const sr, const domainlabel *newname);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNS_DeregisterService_drt(mDNS *const m, ServiceRecordSet *sr, mDNS_Dereg_type drt);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNS_DeregisterService(M,S) mDNS_DeregisterService_drt((M), (S), mDNS_Dereg_normal)
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_RegisterNoSuchService(mDNS *const m, AuthRecord *const rr,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const domainlabel *const name, const domainname *const type, const domainname *const domain,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const mDNSInterfaceID InterfaceID, mDNSRecordCallback Callback, void *Context, mDNSu32 flags);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNS_SetupQuestion(DNSQuestion *const q, const mDNSInterfaceID InterfaceID, const domainname *const name,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const mDNSu16 qtype, mDNSQuestionCallback *const callback, void *const context);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_StartBrowse(mDNS *const m, DNSQuestion *const question,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const domainname *const srv, const domainname *const domain, const mDNSu8 *anondata,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const mDNSInterfaceID InterfaceID, mDNSu32 flags,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSBool ForceMCast, mDNSBool useBackgroundTrafficClass,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSQuestionCallback *Callback, void *Context);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_StartResolveService(mDNS *const m, ServiceInfoQuery *query, ServiceInfo *info, mDNSServiceInfoQueryCallback *Callback, void *Context);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern void mDNS_StopResolveService (mDNS *const m, ServiceInfoQuery *query);
4b22b9337f359bfd063322244f5336cc7c6ffcfarstypedef enum
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern const char *const mDNS_DomainTypeNames[];
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_GetDomains(mDNS *const m, DNSQuestion *const question, mDNS_DomainType DomainType, const domainname *dom,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const mDNSInterfaceID InterfaceID, mDNSQuestionCallback *Callback, void *Context);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_AdvertiseDomains(mDNS *const m, AuthRecord *rr, mDNS_DomainType DomainType, const mDNSInterfaceID InterfaceID, char *domname);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSOpaque16 mDNS_NewMessageID(mDNS *const m);
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soomeextern mDNSBool mDNS_AddressIsLocalSubnet(mDNS *const m, const mDNSInterfaceID InterfaceID, const mDNSAddr *addr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern DNSServer *GetServerForQuestion(mDNS *m, DNSQuestion *question);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSu32 SetValidDNSServers(mDNS *m, DNSQuestion *question);
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars// In order to expose the full capabilities of the DNS protocol (which allows any arbitrary eight-bit values
4b22b9337f359bfd063322244f5336cc7c6ffcfars// in domain name labels, including unlikely characters like ascii nulls and even dots) all the mDNS APIs
4b22b9337f359bfd063322244f5336cc7c6ffcfars// work with DNS's native length-prefixed strings. For convenience in C, the following utility functions
4b22b9337f359bfd063322244f5336cc7c6ffcfars// are provided for converting between C's null-terminated strings and DNS's length-prefixed strings.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Assignment
4b22b9337f359bfd063322244f5336cc7c6ffcfars// A simple C structure assignment of a domainname can cause a protection fault by accessing unmapped memory,
4b22b9337f359bfd063322244f5336cc7c6ffcfars// because that object is defined to be 256 bytes long, but not all domainname objects are truly the full size.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// This macro uses mDNSPlatformMemCopy() to make sure it only touches the actual bytes that are valid.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define AssignDomainName(DST, SRC) do { mDNSu16 len__ = DomainNameLength((SRC)); \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome if (len__ <= MAX_DOMAIN_NAME) mDNSPlatformMemCopy((DST)->c, (SRC)->c, len__);else (DST)->c[0] = 0;} while(0)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Comparison functions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define SameDomainLabelCS(A,B) ((A)[0] == (B)[0] && mDNSPlatformMemSame((A)+1, (B)+1, (A)[0]))
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSBool SameDomainLabel(const mDNSu8 *a, const mDNSu8 *b);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSBool SameDomainName(const domainname *const d1, const domainname *const d2);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool SameDomainNameCS(const domainname *const d1, const domainname *const d2);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef mDNSBool DomainNameComparisonFn (const domainname *const d1, const domainname *const d2);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSBool IsLocalDomain(const domainname *d); // returns true for domains that by default should be looked up using link-local multicast
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define StripFirstLabel(X) ((const domainname *)& (X)->c[(X)->c[0] ? 1 + (X)->c[0] : 0])
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define FirstLabel(X) ((const domainlabel *)(X))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define SecondLabel(X) ((const domainlabel *)StripFirstLabel(X))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define ThirdLabel(X) ((const domainlabel *)StripFirstLabel(StripFirstLabel(X)))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern const mDNSu8 *LastLabel(const domainname *d);
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Get total length of domain name, in native DNS format, including terminal root label
4b22b9337f359bfd063322244f5336cc7c6ffcfars// (e.g. length of "com." is 5 (length byte, three data bytes, final zero)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSu16 DomainNameLengthLimit(const domainname *const name, const mDNSu8 *limit);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define DomainNameLength(name) DomainNameLengthLimit((name), (name)->c + MAX_DOMAIN_NAME)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Append functions to append one or more labels to an existing native format domain name:
4b22b9337f359bfd063322244f5336cc7c6ffcfars// AppendLiteralLabelString adds a single label from a literal C string, with no escape character interpretation.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// AppendDNSNameString adds zero or more labels from a C string using conventional DNS dots-and-escaping interpretation
4b22b9337f359bfd063322244f5336cc7c6ffcfars// AppendDomainLabel adds a single label from a native format domainlabel
4b22b9337f359bfd063322244f5336cc7c6ffcfars// AppendDomainName adds zero or more labels from a native format domainname
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSu8 *AppendLiteralLabelString(domainname *const name, const char *cstr);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSu8 *AppendDNSNameString (domainname *const name, const char *cstr);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSu8 *AppendDomainLabel (domainname *const name, const domainlabel *const label);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSu8 *AppendDomainName (domainname *const name, const domainname *const append);
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Convert from null-terminated string to native DNS format:
4b22b9337f359bfd063322244f5336cc7c6ffcfars// The DomainLabel form makes a single label from a literal C string, with no escape character interpretation.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// The DomainName form makes native format domain name from a C string using conventional DNS interpretation:
4b22b9337f359bfd063322244f5336cc7c6ffcfars// dots separate labels, and within each label, '\.' represents a literal dot, '\\' represents a literal
4b22b9337f359bfd063322244f5336cc7c6ffcfars// backslash and backslash with three decimal digits (e.g. \000) represents an arbitrary byte value.
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSBool MakeDomainLabelFromLiteralString(domainlabel *const label, const char *cstr);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSu8 *MakeDomainNameFromDNSNameString (domainname *const name, const char *cstr);
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Convert native format domainlabel or domainname back to C string format
4b22b9337f359bfd063322244f5336cc7c6ffcfars// IMPORTANT:
4b22b9337f359bfd063322244f5336cc7c6ffcfars// When using ConvertDomainLabelToCString, the target buffer must be MAX_ESCAPED_DOMAIN_LABEL (254) bytes long
4b22b9337f359bfd063322244f5336cc7c6ffcfars// to guarantee there will be no buffer overrun. It is only safe to use a buffer shorter than this in rare cases
4b22b9337f359bfd063322244f5336cc7c6ffcfars// where the label is known to be constrained somehow (for example, if the label is known to be either "_tcp" or "_udp").
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Similarly, when using ConvertDomainNameToCString, the target buffer must be MAX_ESCAPED_DOMAIN_NAME (1009) bytes long.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// See definitions of MAX_ESCAPED_DOMAIN_LABEL and MAX_ESCAPED_DOMAIN_NAME for more detailed explanation.
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern char *ConvertDomainLabelToCString_withescape(const domainlabel *const name, char *cstr, char esc);
4b22b9337f359bfd063322244f5336cc7c6ffcfars#define ConvertDomainLabelToCString_unescaped(D,C) ConvertDomainLabelToCString_withescape((D), (C), 0)
4b22b9337f359bfd063322244f5336cc7c6ffcfars#define ConvertDomainLabelToCString(D,C) ConvertDomainLabelToCString_withescape((D), (C), '\\')
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern char *ConvertDomainNameToCString_withescape(const domainname *const name, char *cstr, char esc);
4b22b9337f359bfd063322244f5336cc7c6ffcfars#define ConvertDomainNameToCString_unescaped(D,C) ConvertDomainNameToCString_withescape((D), (C), 0)
4b22b9337f359bfd063322244f5336cc7c6ffcfars#define ConvertDomainNameToCString(D,C) ConvertDomainNameToCString_withescape((D), (C), '\\')
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern void ConvertUTF8PstringToRFC1034HostLabel(const mDNSu8 UTF8Name[], domainlabel *const hostlabel);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSu8 *ConstructServiceName(domainname *const fqdn, const domainlabel *name, const domainname *type, const domainname *const domain);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSBool DeconstructServiceName(const domainname *const fqdn, domainlabel *const name, domainname *const type, domainname *const domain);
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Note: Some old functions have been replaced by more sensibly-named versions.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// You can uncomment the hash-defines below if you don't want to have to change your source code right away.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// When updating your code, note that (unlike the old versions) *all* the new routines take the target object
4b22b9337f359bfd063322244f5336cc7c6ffcfars// as their first parameter.
4b22b9337f359bfd063322244f5336cc7c6ffcfars//#define ConvertCStringToDomainName(SRC,DST) MakeDomainNameFromDNSNameString((DST),(SRC))
4b22b9337f359bfd063322244f5336cc7c6ffcfars//#define ConvertCStringToDomainLabel(SRC,DST) MakeDomainLabelFromLiteralString((DST),(SRC))
4b22b9337f359bfd063322244f5336cc7c6ffcfars//#define AppendStringLabelToName(DST,SRC) AppendLiteralLabelString((DST),(SRC))
4b22b9337f359bfd063322244f5336cc7c6ffcfars//#define AppendStringNameToName(DST,SRC) AppendDNSNameString((DST),(SRC))
4b22b9337f359bfd063322244f5336cc7c6ffcfars//#define AppendDomainLabelToName(DST,SRC) AppendDomainLabel((DST),(SRC))
4b22b9337f359bfd063322244f5336cc7c6ffcfars//#define AppendDomainNameToName(DST,SRC) AppendDomainName((DST),(SRC))
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNS_vsnprintf/snprintf return the number of characters written, excluding the final terminating null.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// The output is always null-terminated: for example, if the output turns out to be exactly buflen long,
4b22b9337f359bfd063322244f5336cc7c6ffcfars// then the output will be truncated by one character to allow space for the terminating null.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Unlike standard C vsnprintf/snprintf, they return the number of characters *actually* written,
4b22b9337f359bfd063322244f5336cc7c6ffcfars// not the number of characters that *would* have been printed were buflen unlimited.
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSu32 mDNS_vsnprintf(char *sbuffer, mDNSu32 buflen, const char *fmt, va_list arg);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSu32 mDNS_snprintf(char *sbuffer, mDNSu32 buflen, const char *fmt, ...) IS_A_PRINTF_STYLE_FUNCTION(3,4);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSu32 NumCacheRecordsForInterfaceID(const mDNS *const m, mDNSInterfaceID id);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern char *GetRRDisplayString_rdb(const ResourceRecord *const rr, const RDataBody *const rd1, char *const buffer);
4b22b9337f359bfd063322244f5336cc7c6ffcfars#define RRDisplayString(m, rr) GetRRDisplayString_rdb(rr, &(rr)->rdata->u, (m)->MsgBuffer)
4b22b9337f359bfd063322244f5336cc7c6ffcfars#define ARDisplayString(m, rr) GetRRDisplayString_rdb(&(rr)->resrec, &(rr)->resrec.rdata->u, (m)->MsgBuffer)
4b22b9337f359bfd063322244f5336cc7c6ffcfars#define CRDisplayString(m, rr) GetRRDisplayString_rdb(&(rr)->resrec, &(rr)->resrec.rdata->u, (m)->MsgBuffer)
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSBool mDNSSameAddress(const mDNSAddr *ip1, const mDNSAddr *ip2);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern void IncrementLabelSuffix(domainlabel *name, mDNSBool RichText);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNSv4AddrIsRFC1918(const mDNSv4Addr * const addr); // returns true for RFC1918 private addresses
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSAddrIsRFC1918(X) ((X)->type == mDNSAddrType_IPv4 && mDNSv4AddrIsRFC1918(&(X)->ip.v4))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSAddrMapIPv4toIPv6(mDNSv4Addr* in, mDNSv6Addr* out);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNSAddrIPv4FromMappedIPv6(mDNSv6Addr *in, mDNSv4Addr *out);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSSameIPPort(A,B) ((A).NotAnInteger == (B).NotAnInteger)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSSameOpaque16(A,B) ((A).NotAnInteger == (B).NotAnInteger)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSSameOpaque32(A,B) ((A).NotAnInteger == (B).NotAnInteger)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSSameOpaque64(A,B) ((A)->l[0] == (B)->l[0] && (A)->l[1] == (B)->l[1])
4b22b9337f359bfd063322244f5336cc7c6ffcfars#define mDNSSameIPv4Address(A,B) ((A).NotAnInteger == (B).NotAnInteger)
4b22b9337f359bfd063322244f5336cc7c6ffcfars#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])
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSSameIPv6NetworkPart(A,B) ((A).l[0] == (B).l[0] && (A).l[1] == (B).l[1])
4b22b9337f359bfd063322244f5336cc7c6ffcfars#define mDNSSameEthAddress(A,B) ((A)->w[0] == (B)->w[0] && (A)->w[1] == (B)->w[1] && (A)->w[2] == (B)->w[2])
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSIPPortIsZero(A) ((A).NotAnInteger == 0)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSOpaque16IsZero(A) ((A).NotAnInteger == 0)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSOpaque64IsZero(A) (((A)->l[0] | (A)->l[1] ) == 0)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSIPv4AddressIsZero(A) ((A).NotAnInteger == 0)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSIPv6AddressIsZero(A) (((A).l[0] | (A).l[1] | (A).l[2] | (A).l[3]) == 0)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSEthAddressIsZero(A) (((A).w[0] | (A).w[1] | (A).w[2] ) == 0)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSIPv4AddressIsOnes(A) ((A).NotAnInteger == 0xFFFFFFFF)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSIPv6AddressIsOnes(A) (((A).l[0] & (A).l[1] & (A).l[2] & (A).l[3]) == 0xFFFFFFFF)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv4 && mDNSSameIPv4Address((X)->ip.v4, AllDNSLinkGroup_v4.ip.v4)) || \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv6 && mDNSSameIPv6Address((X)->ip.v6, AllDNSLinkGroup_v6.ip.v6)) )
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv4 && mDNSIPv4AddressIsZero((X)->ip.v4)) || \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv6 && mDNSIPv6AddressIsZero((X)->ip.v6)) )
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv4 && !mDNSIPv4AddressIsZero((X)->ip.v4)) || \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv6 && !mDNSIPv6AddressIsZero((X)->ip.v6)) )
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv4 && mDNSIPv4AddressIsOnes((X)->ip.v4)) || \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv6 && mDNSIPv6AddressIsOnes((X)->ip.v6)) )
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv4) ? !(mDNSIPv4AddressIsZero((X)->ip.v4) || mDNSIPv4AddressIsOnes((X)->ip.v4)) : \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv6) ? !(mDNSIPv6AddressIsZero((X)->ip.v6) || mDNSIPv6AddressIsOnes((X)->ip.v6)) : mDNSfalse)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSv4AddressIsLinkLocal(X) ((X)->b[0] == 169 && (X)->b[1] == 254)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSv6AddressIsLinkLocal(X) ((X)->b[0] == 0xFE && ((X)->b[1] & 0xC0) == 0x80)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv4) ? mDNSv4AddressIsLinkLocal(&(X)->ip.v4) : \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv6) ? mDNSv6AddressIsLinkLocal(&(X)->ip.v6) : mDNSfalse)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSv4AddressIsLoopback(X) ((X)->b[0] == 127 && (X)->b[1] == 0 && (X)->b[2] == 0 && (X)->b[3] == 1)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSv6AddressIsLoopback(X) ((((X)->l[0] | (X)->l[1] | (X)->l[2]) == 0) && ((X)->b[12] == 0 && (X)->b[13] == 0 && (X)->b[14] == 0 && (X)->b[15] == 1))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv4) ? mDNSv4AddressIsLoopback(&(X)->ip.v4) : \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)->type == mDNSAddrType_IPv6) ? mDNSv6AddressIsLoopback(&(X)->ip.v6) : mDNSfalse)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Unicast DNS and Dynamic Update specific Client Calls
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// mDNS_SetSecretForDomain tells the core to authenticate (via TSIG with an HMAC_MD5 hash of the shared secret)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// when dynamically updating a given zone (and its subdomains). The key used in authentication must be in
4b22b9337f359bfd063322244f5336cc7c6ffcfars// domain name format. The shared secret must be a null-terminated base64 encoded string. A minimum size of
4b22b9337f359bfd063322244f5336cc7c6ffcfars// 16 bytes (128 bits) is recommended for an MD5 hash as per RFC 2485.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Calling this routine multiple times for a zone replaces previously entered values. Call with a NULL key
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// to disable authentication for the zone. A non-NULL autoTunnelPrefix means this is an AutoTunnel domain,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// and the value is prepended to the IPSec identifier (used for key lookup)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNS_SetSecretForDomain(mDNS *m, DomainAuthInfo *info,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const domainname *domain, const domainname *keyname, const char *b64keydata, const domainname *hostname, mDNSIPPort *port, mDNSBool autoTunnel);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void RecreateNATMappings(mDNS *const m, const mDNSu32 waitTicks);
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Hostname/Unicast Interface Configuration
4b22b9337f359bfd063322244f5336cc7c6ffcfars// All hostnames advertised point to one IPv4 address and/or one IPv6 address, set via SetPrimaryInterfaceInfo. Invoking this routine
4b22b9337f359bfd063322244f5336cc7c6ffcfars// updates all existing hostnames to point to the new address.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// A hostname is added via AddDynDNSHostName, which points to the primary interface's v4 and/or v6 addresss
4b22b9337f359bfd063322244f5336cc7c6ffcfars// The status callback is invoked to convey success or failure codes - the callback should not modify the AuthRecord or free memory.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Added hostnames may be removed (deregistered) via mDNS_RemoveDynDNSHostName.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Host domains added prior to specification of the primary interface address and computer name will be deferred until
4b22b9337f359bfd063322244f5336cc7c6ffcfars// these values are initialized.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// DNS servers used to resolve unicast queries are specified by mDNS_AddDNSServer.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// For "split" DNS configurations, in which queries for different domains are sent to different servers (e.g. VPN and external),
4b22b9337f359bfd063322244f5336cc7c6ffcfars// a domain may be associated with a DNS server. For standard configurations, specify the root label (".") or NULL.
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern void mDNS_AddDynDNSHostName(mDNS *m, const domainname *fqdn, mDNSRecordCallback *StatusCallback, const void *StatusContext);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern void mDNS_RemoveDynDNSHostName(mDNS *m, const domainname *fqdn);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern void mDNS_SetPrimaryInterfaceInfo(mDNS *m, const mDNSAddr *v4addr, const mDNSAddr *v6addr, const mDNSAddr *router);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern DNSServer *mDNS_AddDNSServer(mDNS *const m, const domainname *d, const mDNSInterfaceID interface, mDNSs32 serviceID, const mDNSAddr *addr,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const mDNSIPPort port, mDNSu32 scoped, mDNSu32 timeout, mDNSBool cellIntf, mDNSu16 resGroupID, mDNSBool reqA,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void PenalizeDNSServer(mDNS *const m, DNSQuestion *q, mDNSOpaque16 responseFlags);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNS_AddSearchDomain(const domainname *const domain, mDNSInterfaceID InterfaceID);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern McastResolver *mDNS_AddMcastResolver(mDNS *const m, const domainname *d, const mDNSInterfaceID interface, mDNSu32 timeout);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// We use ((void *)0) here instead of mDNSNULL to avoid compile warnings on gcc 4.2
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome do { domainname d__; if (((X) != (void*)0) && MakeDomainNameFromDNSNameString(&d__, (X)) && d__.c[0]) mDNS_AddSearchDomain(&d__, I);} while(0)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Routines called by the core, exported by DNSDigest.c
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Convert an arbitrary base64 encoded key key into an HMAC key (stored in AuthInfo struct)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSs32 DNSDigest_ConstructHMACKeyfromBase64(DomainAuthInfo *info, const char *b64key);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// sign a DNS message. The message must be complete, with all values in network byte order. end points to the end
4b22b9337f359bfd063322244f5336cc7c6ffcfars// of the message, and is modified by this routine. numAdditionals is a pointer to the number of additional
4b22b9337f359bfd063322244f5336cc7c6ffcfars// records in HOST byte order, which is incremented upon successful completion of this routine. The function returns
4b22b9337f359bfd063322244f5336cc7c6ffcfars// the new end pointer on success, and NULL on failure.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void DNSDigest_SignMessage(DNSMessage *msg, mDNSu8 **end, DomainAuthInfo *info, mDNSu16 tcode);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (M)->h.numQuestions = (mDNSu16)((mDNSu8 *)&(M)->h.numQuestions )[0] << 8 | ((mDNSu8 *)&(M)->h.numQuestions )[1]; \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (M)->h.numAnswers = (mDNSu16)((mDNSu8 *)&(M)->h.numAnswers )[0] << 8 | ((mDNSu8 *)&(M)->h.numAnswers )[1]; \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (M)->h.numAuthorities = (mDNSu16)((mDNSu8 *)&(M)->h.numAuthorities)[0] << 8 | ((mDNSu8 *)&(M)->h.numAuthorities)[1]; \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (M)->h.numAdditionals = (mDNSu16)((mDNSu8 *)&(M)->h.numAdditionals)[0] << 8 | ((mDNSu8 *)&(M)->h.numAdditionals)[1]; \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define DNSDigest_SignMessageHostByteOrder(M,E,INFO) \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome do { SwapDNSHeaderBytes(M); DNSDigest_SignMessage((M), (E), (INFO), 0); SwapDNSHeaderBytes(M); } while (0)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// verify a DNS message. The message must be complete, with all values in network byte order. end points to the
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// end of the record. tsig is a pointer to the resource record that contains the TSIG OPT record. info is
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// the matching key to use for verifying the message. This function expects that the additionals member
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// of the DNS message header has already had one subtracted from it.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool DNSDigest_VerifyMessage(DNSMessage *msg, mDNSu8 *end, LargeCacheRecord *tsig, DomainAuthInfo *info, mDNSu16 *rcode, mDNSu16 *tcode);
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars// This section defines the interface to the Platform Support layer.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Normal client code should not use any of types defined here, or directly call any of the functions defined here.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// The definitions are placed here because sometimes clients do use these calls indirectly, via other supported client operations.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// For example, AssignDomainName is a macro defined using mDNSPlatformMemCopy()
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Every platform support module must provide the following functions.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNSPlatformInit() typically opens a communication endpoint, and starts listening for mDNS packets.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// When Setup is complete, the platform support layer calls mDNSCoreInitComplete().
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNSPlatformSendUDP() sends one UDP packet
4b22b9337f359bfd063322244f5336cc7c6ffcfars// When a packet is received, the PlatformSupport code calls mDNSCoreReceive()
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNSPlatformClose() tidies up on exit
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Note: mDNSPlatformMemAllocate/mDNSPlatformMemFree are only required for handling oversized resource records and unicast DNS.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// If your target platform has a well-defined specialized application, and you know that all the records it uses
4b22b9337f359bfd063322244f5336cc7c6ffcfars// are InlineCacheRDSize or less, then you can just make a simple mDNSPlatformMemAllocate() stub that always returns
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// NULL. InlineCacheRDSize is a compile-time constant, which is set by default to 68. If you need to handle records
4b22b9337f359bfd063322244f5336cc7c6ffcfars// a little larger than this and you don't want to have to implement run-time allocation and freeing, then you
4b22b9337f359bfd063322244f5336cc7c6ffcfars// can raise the value of this constant to a suitable value (at the expense of increased memory usage).
4b22b9337f359bfd063322244f5336cc7c6ffcfars// USE CAUTION WHEN CALLING mDNSPlatformRawTime: The m->timenow_adjust correction factor needs to be added
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Generally speaking:
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Code that's protected by the main mDNS lock should just use the m->timenow value
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Code outside the main mDNS lock should use mDNS_TimeNow(m) to get properly adjusted time
4b22b9337f359bfd063322244f5336cc7c6ffcfars// In certain cases there may be reasons why it's necessary to get the time without taking the lock first
4b22b9337f359bfd063322244f5336cc7c6ffcfars// (e.g. inside the routines that are doing the locking and unlocking, where a call to get the lock would result in a
4b22b9337f359bfd063322244f5336cc7c6ffcfars// recursive loop); in these cases use mDNS_TimeNow_NoLock(m) to get mDNSPlatformRawTime with the proper correction factor added.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNSPlatformUTC returns the time, in seconds, since Jan 1st 1970 UTC and is required for generating TSIG records
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNSPlatformSendUDP(const mDNS *const m, const void *const msg, const mDNSu8 *const end,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID InterfaceID, UDPSocket *src, const mDNSAddr *dst,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSIPPort dstport, mDNSBool useBackgroundTrafficClass);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNSPlatformPeekUDP (mDNS *const m, UDPSocket *src);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformStrCopy ( void *dst, const void *src);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSu32 mDNSPlatformStrLen ( const void *src);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformMemCopy ( void *dst, const void *src, mDNSu32 len);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNSPlatformMemSame (const void *dst, const void *src, mDNSu32 len);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern int mDNSPlatformMemCmp (const void *dst, const void *src, mDNSu32 len);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformMemZero ( void *dst, mDNSu32 len);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformQsort (void *base, int nel, int width, int (*compar)(const void *, const void *));
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#if APPLE_OSX_mDNSResponder && MACOSX_MDNS_MALLOC_DEBUGGING
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSPlatformMemAllocate(X) mallocL(# X, X)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// If the platform doesn't have a strong PRNG, we define a naive multiply-and-add based on a seed
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// from the platform layer. Long-term, we should embed an arc4 implementation, but the strength
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// will still depend on the randomness of the seed.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#if !defined(_PLATFORM_HAS_STRONG_PRNG_) && (_BUILDING_XCODE_PROJECT_ || defined(_WIN32))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#endif // _PLATFORM_HAS_STRONG_PRNG_
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNS_TimeNow_NoLock(m) (mDNSPlatformRawTime() + (m)->timenow_adjust)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformWriteDebugMsg(const char *msg);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformWriteLogMsg(const char *ident, const char *msg, mDNSLogLevel_t loglevel);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Utility function for ASL logging
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas SoomemDNSexport void mDNSASLLog(uuid_t *uuid, const char *subdomain, const char *result, const char *signature, const char *fmt, ...);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Log unicast and multicast traffic statistics once a day. Also used for DNSSEC statistics.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define kDefaultNextStatsticsLogTime (24 * 60 * 60)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#endif // APPLE_OSX_mDNSResponder
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Platform support modules should provide the following functions to map between opaque interface IDs
4b22b9337f359bfd063322244f5336cc7c6ffcfars// and interface indexes in order to support the DNS-SD API. If your target platform does not support
4b22b9337f359bfd063322244f5336cc7c6ffcfars// multiple interfaces and/or does not support the DNS-SD API, these functions can be empty.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSInterfaceID mDNSPlatformInterfaceIDfromInterfaceIndex(mDNS *const m, mDNSu32 ifindex);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSu32 mDNSPlatformInterfaceIndexfromInterfaceID(mDNS *const m, mDNSInterfaceID id, mDNSBool suppressNetworkChange);
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Every platform support module must provide the following functions if it is to support unicast DNS
4b22b9337f359bfd063322244f5336cc7c6ffcfars// and Dynamic Update.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// All TCP socket operations implemented by the platform layer MUST NOT BLOCK.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNSPlatformTCPConnect initiates a TCP connection with a peer, adding the socket descriptor to the
4b22b9337f359bfd063322244f5336cc7c6ffcfars// main event loop. The return value indicates whether the connection succeeded, failed, or is pending
4b22b9337f359bfd063322244f5336cc7c6ffcfars// (i.e. the call would block.) On return, the descriptor parameter is set to point to the connected socket.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// The TCPConnectionCallback is subsequently invoked when the connection
4b22b9337f359bfd063322244f5336cc7c6ffcfars// completes (in which case the ConnectionEstablished parameter is true), or data is available for
4b22b9337f359bfd063322244f5336cc7c6ffcfars// reading on the socket (indicated by the ConnectionEstablished parameter being false.) If the connection
4b22b9337f359bfd063322244f5336cc7c6ffcfars// asynchronously fails, the TCPConnectionCallback should be invoked as usual, with the error being
4b22b9337f359bfd063322244f5336cc7c6ffcfars// returned in subsequent calls to PlatformReadTCP or PlatformWriteTCP. (This allows for platforms
4b22b9337f359bfd063322244f5336cc7c6ffcfars// with limited asynchronous error detection capabilities.) PlatformReadTCP and PlatformWriteTCP must
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// return the number of bytes read/written, 0 if the call would block, and -1 if an error. PlatformReadTCP
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// should set the closed argument if the socket has been closed.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// PlatformTCPCloseConnection must close the connection to the peer and remove the descriptor from the
4b22b9337f359bfd063322244f5336cc7c6ffcfars// event loop. CloseConnectin may be called at any time, including in a ConnectionCallback.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void (*TCPConnectionCallback)(TCPSocket *sock, void *context, mDNSBool ConnectionEstablished, mStatus err);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern TCPSocket *mDNSPlatformTCPSocket(mDNS *const m, TCPSocketFlags flags, mDNSIPPort *port, mDNSBool useBackgroundTrafficClass); // creates a TCP socket
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern TCPSocket *mDNSPlatformTCPAccept(TCPSocketFlags flags, int sd);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern int mDNSPlatformTCPGetFD(TCPSocket *sock);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNSPlatformTCPConnect(TCPSocket *sock, const mDNSAddr *dst, mDNSOpaque16 dstport, domainname *hostname,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID InterfaceID, TCPConnectionCallback callback, void *context);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformTCPCloseConnection(TCPSocket *sock);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern long mDNSPlatformReadTCP(TCPSocket *sock, void *buf, unsigned long buflen, mDNSBool *closed);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern long mDNSPlatformWriteTCP(TCPSocket *sock, const char *msg, unsigned long len);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern UDPSocket *mDNSPlatformUDPSocket(mDNS *const m, const mDNSIPPort requestedport);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSu16 mDNSPlatformGetUDPPort(UDPSocket *sock);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformUDPClose(UDPSocket *sock);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformReceiveBPF_fd(mDNS *const m, int fd);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformUpdateProxyList(mDNS *const m, const mDNSInterfaceID InterfaceID);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformSendRawPacket(const void *const msg, const mDNSu8 *const end, mDNSInterfaceID InterfaceID);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformSetLocalAddressCacheEntry(mDNS *const m, const mDNSAddr *const tpa, const mDNSEthAddr *const tha, mDNSInterfaceID InterfaceID);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformSourceAddrForDest(mDNSAddr *const src, const mDNSAddr *const dst);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformSendKeepalive(mDNSAddr *sadd, mDNSAddr *dadd, mDNSIPPort *lport, mDNSIPPort *rport, mDNSu32 seq, mDNSu32 ack, mDNSu16 win);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNSPlatformRetrieveTCPInfo(mDNS *const m, mDNSAddr *laddr, mDNSIPPort *lport, mDNSAddr *raddr, mDNSIPPort *rport, mDNSTCPInfo *mti);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNSPlatformGetRemoteMacAddr(mDNS *const m, mDNSAddr *raddr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNSPlatformStoreSPSMACAddr(mDNSAddr *spsaddr, char *ifname);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNSPlatformClearSPSMACAddr(void);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// mDNSPlatformTLSSetupCerts/mDNSPlatformTLSTearDownCerts used by dnsextd
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Platforms that support unicast browsing and dynamic update registration for clients who do not specify a domain
4b22b9337f359bfd063322244f5336cc7c6ffcfars// in browse/registration calls must implement these routines to get the "default" browse/registration list.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNSPlatformSetDNSConfig(mDNS *const m, mDNSBool setservers, mDNSBool setsearch, domainname *const fqdn, DNameListElem **RegDomains,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome DNameListElem **BrowseDomains, mDNSBool ackConfig);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus mDNSPlatformGetPrimaryInterface(mDNS *const m, mDNSAddr *v4, mDNSAddr *v6, mDNSAddr *router);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformDynDNSHostNameStatusChanged(const domainname *const dname, const mStatus status);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformSetAllowSleep(mDNS *const m, mDNSBool allowSleep, const char *reason);
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soomeextern void mDNSPlatformPreventSleep(mDNS *const m, mDNSu32 timeout, const char *reason);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformSendWakeupPacket(mDNS *const m, mDNSInterfaceID InterfaceID, char *EthAddr, char *IPAddr, int iteration);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNSPlatformInterfaceIsD2D(mDNSInterfaceID InterfaceID);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNSPlatformInterfaceIsAWDL(const NetworkInterfaceInfo *intf);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNSPlatformValidRecordForQuestion(const ResourceRecord *const rr, const DNSQuestion *const q);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNSPlatformValidRecordForInterface(AuthRecord *rr, const NetworkInterfaceInfo *intf);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNSPlatformValidQuestionForInterface(DNSQuestion *q, const NetworkInterfaceInfo *intf);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformFormatTime(unsigned long t, mDNSu8 *buf, int bufsize);
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Support for legacy NAT traversal protocols, implemented by the platform layer and callable by the core.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void LNT_ConfigureRouterInfo(mDNS *m, const mDNSInterfaceID InterfaceID, const mDNSu8 *const data, const mDNSu16 len);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus LNT_MapPort(mDNS *m, NATTraversalInfo *const n);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus LNT_UnmapPort(mDNS *m, NATTraversalInfo *const n);
4b22b9337f359bfd063322244f5336cc7c6ffcfars#endif // _LEGACY_NAT_TRAVERSAL_
4b22b9337f359bfd063322244f5336cc7c6ffcfars// The core mDNS code provides these functions, for the platform support code to call at appropriate times
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNS_SetFQDN() is called once on startup (typically from mDNSPlatformInit())
4b22b9337f359bfd063322244f5336cc7c6ffcfars// and then again on each subsequent change of the host name.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNS_RegisterInterface() is used by the platform support layer to inform mDNSCore of what
4b22b9337f359bfd063322244f5336cc7c6ffcfars// physical and/or logical interfaces are available for sending and receiving packets.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Typically it is called on startup for each available interface, but register/deregister may be
4b22b9337f359bfd063322244f5336cc7c6ffcfars// called again later, on multiple occasions, to inform the core of interface configuration changes.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// If set->Advertise is set non-zero, then mDNS_RegisterInterface() also registers the standard
4b22b9337f359bfd063322244f5336cc7c6ffcfars// resource records that should be associated with every publicised IP address/interface:
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- Name-to-address records (A/AAAA)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- Address-to-name records (PTR)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// -- Host information (HINFO)
4b22b9337f359bfd063322244f5336cc7c6ffcfars// IMPORTANT: The specified mDNSInterfaceID MUST NOT be 0, -1, or -2; these values have special meaning
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNS_RegisterInterface does not result in the registration of global hostnames via dynamic update -
4b22b9337f359bfd063322244f5336cc7c6ffcfars// see mDNS_SetPrimaryInterfaceInfo, mDNS_AddDynDNSHostName, etc. for this purpose.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Note that the set may be deallocated immediately after it is deregistered via mDNS_DeegisterInterface.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNS_RegisterDNS() is used by the platform support layer to provide the core with the addresses of
4b22b9337f359bfd063322244f5336cc7c6ffcfars// available domain name servers for unicast queries/updates. RegisterDNS() should be called once for
4b22b9337f359bfd063322244f5336cc7c6ffcfars// each name server, typically at startup, or when a new name server becomes available. DeregiterDNS()
4b22b9337f359bfd063322244f5336cc7c6ffcfars// must be called whenever a registered name server becomes unavailable. DeregisterDNSList deregisters
4b22b9337f359bfd063322244f5336cc7c6ffcfars// all registered servers. mDNS_DNSRegistered() returns true if one or more servers are registered in the core.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNSCoreInitComplete() is called when the platform support layer is finished.
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Typically this is at the end of mDNSPlatformInit(), but may be later
4b22b9337f359bfd063322244f5336cc7c6ffcfars// (on platforms like OT that allow asynchronous initialization of the networking stack).
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNSCoreReceive() is called when a UDP packet is received
4b22b9337f359bfd063322244f5336cc7c6ffcfars// mDNSCoreMachineSleep() is called when the machine sleeps or wakes
4b22b9337f359bfd063322244f5336cc7c6ffcfars// (This refers to heavyweight laptop-style sleep/wake that disables network access,
4b22b9337f359bfd063322244f5336cc7c6ffcfars// not lightweight second-by-second CPU power management modes.)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNS_ActivateNetWake_internal (mDNS *const m, NetworkInterfaceInfo *set);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNS_DeactivateNetWake_internal(mDNS *const m, NetworkInterfaceInfo *set);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mStatus mDNS_RegisterInterface (mDNS *const m, NetworkInterfaceInfo *set, mDNSBool flapping);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern void mDNS_DeregisterInterface(mDNS *const m, NetworkInterfaceInfo *set, mDNSBool flapping);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern void mDNSCoreInitComplete(mDNS *const m, mStatus result);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern void mDNSCoreReceive(mDNS *const m, void *const msg, const mDNSu8 *const end,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const mDNSAddr *const srcaddr, const mDNSIPPort srcport,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const mDNSAddr *dstaddr, const mDNSIPPort dstport, const mDNSInterfaceID InterfaceID);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSCoreRestartQueries(mDNS *const m);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSCoreRestartQuestion(mDNS *const m, DNSQuestion *q);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSCoreRestartRegistration(mDNS *const m, AuthRecord *rr, int announceCount);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void (*CallbackBeforeStartQuery)(mDNS *const m, void *context);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSCoreRestartAddressQueries(mDNS *const m, mDNSBool SearchDomainsChanged, FlushCache flushCacheRecords,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome CallbackBeforeStartQuery beforeQueryStart, void *context);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNSCoreHaveAdvertisedMulticastServices(mDNS *const m);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern void mDNSCoreMachineSleep(mDNS *const m, mDNSBool wake);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNSCoreReadyForSleep(mDNS *m, mDNSs32 now);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSs32 mDNSCoreIntervalToNextWake(mDNS *const m, mDNSs32 now);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSCoreReceiveRawPacket (mDNS *const m, const mDNSu8 *const p, const mDNSu8 *const end, const mDNSInterfaceID InterfaceID);
4b22b9337f359bfd063322244f5336cc7c6ffcfarsextern mDNSBool mDNSAddrIsDNSMulticast(const mDNSAddr *ip);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern CacheRecord *CreateNewCacheEntry(mDNS *const m, const mDNSu32 slot, CacheGroup *cg, mDNSs32 delay, mDNSBool Add, const mDNSAddr *sourceAddress);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern CacheGroup *CacheGroupForName(const mDNS *const m, const mDNSu32 slot, const mDNSu32 namehash, const domainname *const name);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void ReleaseCacheRecord(mDNS *const m, CacheRecord *r);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void ScheduleNextCacheCheckTime(mDNS *const m, const mDNSu32 slot, const mDNSs32 event);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void SetNextCacheCheckTimeForRecord(mDNS *const m, CacheRecord *const rr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void GrantCacheExtensions(mDNS *const m, DNSQuestion *q, mDNSu32 lease);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void MakeNegativeCacheRecord(mDNS *const m, CacheRecord *const cr,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const domainname *const name, const mDNSu32 namehash, const mDNSu16 rrtype, const mDNSu16 rrclass, mDNSu32 ttl_seconds,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNSInterfaceID InterfaceID, DNSServer *dnsserver);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void CompleteDeregistration(mDNS *const m, AuthRecord *rr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void AnswerCurrentQuestionWithResourceRecord(mDNS *const m, CacheRecord *const rr, const QC_result AddRecord);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void AnswerQuestionByFollowingCNAME(mDNS *const m, DNSQuestion *q, ResourceRecord *rr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern char *InterfaceNameForID(mDNS *const m, const mDNSInterfaceID InterfaceID);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void DNSServerChangeForQuestion(mDNS *const m, DNSQuestion *q, DNSServer *newServer);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void ActivateUnicastRegistration(mDNS *const m, AuthRecord *const rr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void CheckSuppressUnusableQuestions(mDNS *const m);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void RetrySearchDomainQuestions(mDNS *const m);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool DomainEnumQuery(const domainname *qname);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mStatus UpdateKeepaliveRData(mDNS *const m, AuthRecord *rr, NetworkInterfaceInfo *const intf, mDNSBool updateMac, char *ethAddr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void UpdateKeepaliveRMACAsync(mDNS *const m, void *context);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void UpdateRMACCallback(mDNS *const m, void *context);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Used only in logging to restrict the number of /etc/hosts entries printed
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void FreeEtcHosts(mDNS *const m, AuthRecord *const rr, mStatus result);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// exported for using the hash for /etc/hosts AuthRecords
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern AuthGroup *AuthGroupForName(AuthHash *r, const mDNSu32 slot, const mDNSu32 namehash, const domainname *const name);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern AuthGroup *AuthGroupForRecord(AuthHash *r, const mDNSu32 slot, const ResourceRecord *const rr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern AuthGroup *InsertAuthRecord(mDNS *const m, AuthHash *r, AuthRecord *rr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern AuthGroup *RemoveAuthRecord(mDNS *const m, AuthHash *r, AuthRecord *rr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool mDNS_CheckForCacheRecord(mDNS *const m, DNSQuestion *q, mDNSu16 qtype);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// For now this AutoTunnel stuff is specific to Mac OS X.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// In the future, if there's demand, we may see if we can abstract it out cleanly into the platform layer
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void AutoTunnelCallback(mDNS *const m, DNSQuestion *question, const ResourceRecord *const answer, QC_result AddRecord);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void AddNewClientTunnel(mDNS *const m, DNSQuestion *const q);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void StartServerTunnel(mDNS *const m, DomainAuthInfo *const info);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void UpdateAutoTunnelDomainStatuses(const mDNS *const m);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void RemoveAutoTunnel6Record(mDNS *const m);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool RecordReadyForSleep(mDNS *const m, AuthRecord *rr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// For now this LocalSleepProxy stuff is specific to Mac OS X.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// In the future, if there's demand, we may see if we can abstract it out cleanly into the platform layer
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soomeextern mStatus ActivateLocalProxy(mDNS *const m, NetworkInterfaceInfo *const intf, mDNSBool *keepaliveOnly);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformUpdateDNSStatus(mDNS *const m, DNSQuestion *q);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformTriggerDNSRetry(mDNS *const m, DNSQuestion *v4q, DNSQuestion *v6q);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformLogToFile(int log_level, const char *buffer);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSBool SupportsInNICProxy(NetworkInterfaceInfo *const intf);
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soomeextern mStatus SymptomReporterDNSServerReachable(mDNS *const m, const mDNSAddr *addr);
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soomeextern mStatus SymptomReporterDNSServerUnreachable(DNSServer *s);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soometypedef void ProxyCallback (mDNS *const m, void *socket, void *const msg, const mDNSu8 *const end, const mDNSAddr *const srcaddr,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome const mDNSIPPort srcport, const mDNSAddr *dstaddr, const mDNSIPPort dstport, const mDNSInterfaceID InterfaceID, void *context);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformInitDNSProxySkts(mDNS *const m, ProxyCallback *UDPCallback, ProxyCallback *TCPCallback);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformCloseDNSProxySkts(mDNS *const m);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformDisposeProxyContext(void *context);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern mDNSu8 *DNSProxySetAttributes(DNSQuestion *q, DNSMessageHeader *h, DNSMessage *msg, mDNSu8 *start, mDNSu8 *limit);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Sleep Assertions are specific to Mac OS X
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformSleepAssertion(mDNS *const m, double timeout);
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soomeextern void mDNSPlatformGetDNSRoutePolicy(mDNS *const m, DNSQuestion *q, mDNSBool *isBlocked);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSPlatformSetuDNSSocktOpt(UDPSocket *src, const mDNSAddr *dst, DNSQuestion *q);
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soomeextern mDNSBool mDNSValidKeepAliveRecord(AuthRecord *rr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// ***************************************************************************
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Sleep Proxy Server Property Encoding
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Sleep Proxy Servers are advertised using a structured service name, consisting of four
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// metrics followed by a human-readable name. The metrics assist clients in deciding which
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Sleep Proxy Server(s) to use when multiple are available on the network. Each metric
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// is a two-digit decimal number in the range 10-99. Lower metrics are generally better.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// AA-BB-CC-DD.FF Name
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// AA = Intent
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// BB = Portability
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// CC = Marginal Power
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// DD = Total Power
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// FF = Features Supported (Currently TCP Keepalive only)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// ** Intent Metric **
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 20 = Dedicated Sleep Proxy Server -- a device, permanently powered on,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// installed for the express purpose of providing Sleep Proxy Service.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 30 = Primary Network Infrastructure Hardware -- a router, DHCP server, NAT gateway,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// or similar permanently installed device which is permanently powered on.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// This is hardware designed for the express purpose of being network
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// infrastructure, and for most home users is typically a single point
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// of failure for the local network -- e.g. most home users only have
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// a single NAT gateway / DHCP server. Even though in principle the
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// hardware might technically be capable of running different software,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// a typical user is unlikely to do that. e.g. AirPort base station.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 40 = Primary Network Infrastructure Software -- a general-purpose computer
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// (e.g. Mac, Windows, Linux, etc.) which is currently running DHCP server
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// or NAT gateway software, but the user could choose to turn that off
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// fairly easily. e.g. iMac running Internet Sharing
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 50 = Secondary Network Infrastructure Hardware -- like primary infrastructure
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// hardware, except not a single point of failure for the entire local network.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// For example, an AirPort base station in bridge mode. This may have clients
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// associated with it, and if it goes away those clients will be inconvenienced,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// but unlike the NAT gateway / DHCP server, the entire local network is not
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// dependent on it.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 60 = Secondary Network Infrastructure Software -- like 50, but in a general-
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// purpose CPU.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 70 = Incidentally Available Hardware -- a device which has no power switch
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// and is generally left powered on all the time. Even though it is not a
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// part of what we conventionally consider network infrastructure (router,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// DHCP, NAT, DNS, etc.), and the rest of the network can operate fine
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// without it, since it's available and unlikely to be turned off, it is a
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// reasonable candidate for providing Sleep Proxy Service e.g. Apple TV,
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// or an AirPort base station in client mode, associated with an existing
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// wireless network (e.g. AirPort Express connected to a music system, or
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// being used to share a USB printer).
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 80 = Incidentally Available Software -- a general-purpose computer which
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// happens at this time to be set to "never sleep", and as such could be
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// useful as a Sleep Proxy Server, but has not been intentionally provided
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// for this purpose. Of all the Intent Metric categories this is the
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// one most likely to be shut down or put to sleep without warning.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// However, if nothing else is availalable, it may be better than nothing.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// e.g. Office computer in the workplace which has been set to "never sleep"
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// ** Portability Metric **
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Inversely related to mass of device, on the basis that, all other things
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// being equal, heavier devices are less likely to be moved than lighter devices.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// E.g. A MacBook running Internet Sharing is probably more likely to be
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// put to sleep and taken away than a Mac Pro running Internet Sharing.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The Portability Metric is a logarithmic decibel scale, computed by taking the
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// (approximate) mass of the device in milligrammes, taking the base 10 logarithm
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// of that, multiplying by 10, and subtracting the result from 100:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Portability Metric = 100 - (log10(mg) * 10)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The Portability Metric is not necessarily computed literally from the actual
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// mass of the device; the intent is just that lower numbers indicate more
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// permanent devices, and higher numbers indicate devices more likely to be
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// removed from the network, e.g., in order of increasing portability:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Mac Pro < iMac < Laptop < iPhone
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Example values:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 10 = 1 metric tonne
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// ** Marginal Power and Total Power Metrics **
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The Marginal Power Metric is the power difference between sleeping and staying awake
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// to be a Sleep Proxy Server.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The Total Power Metric is the total power consumption when being Sleep Proxy Server.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// The Power Metrics use a logarithmic decibel scale, computed as ten times the
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// base 10 logarithm of the (approximate) power in microwatts:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Power Metric = log10(uW) * 10
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Higher values indicate higher power consumption. Example values:
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 10 = 10 uW
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// 20 = 100 uW
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNS_NoWake = 0, // System does not support Wake on LAN
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNS_WakeOnAC = 1, // System supports Wake on LAN when connected to AC power only
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome mDNS_WakeOnBattery = 2 // System supports Wake on LAN on battery
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void mDNSCoreBeSleepProxyServer_internal(mDNS *const m, mDNSu8 sps, mDNSu8 port, mDNSu8 marginalpower, mDNSu8 totpower, mDNSu8 features);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define mDNSCoreBeSleepProxyServer(M,S,P,MP,TP,F) \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome do { mDNS_Lock(m); mDNSCoreBeSleepProxyServer_internal((M),(S),(P),(MP),(TP),(F)); mDNS_Unlock(m); } while(0)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void FindSPSInCache(mDNS *const m, const DNSQuestion *const q, const CacheRecord *sps[3]);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define PrototypeSPSName(X) ((X)[0] >= 11 && (X)[3] == '-' && (X)[ 4] == '9' && (X)[ 5] == '9' && \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (X)[6] == '-' && (X)[ 7] == '9' && (X)[ 8] == '9' && \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome (X)[9] == '-' && (X)[10] == '9' && (X)[11] == '9' )
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define ValidSPSName(X) ((X)[0] >= 5 && mDNSIsDigit((X)[1]) && mDNSIsDigit((X)[2]) && mDNSIsDigit((X)[4]) && mDNSIsDigit((X)[5]))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define SPSMetric(X) (!ValidSPSName(X) || PrototypeSPSName(X) ? 1000000 : \
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome ((X)[1]-'0') * 100000 + ((X)[2]-'0') * 10000 + ((X)[4]-'0') * 1000 + ((X)[5]-'0') * 100 + ((X)[7]-'0') * 10 + ((X)[8]-'0'))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define LocalSPSMetric(X) ( (X)->SPSType * 10000 + (X)->SPSPortability * 100 + (X)->SPSMarginalPower)
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define SPSFeatures(X) ((X)[0] >= 13 && (X)[12] =='.' ? ((X)[13]-'0') : 0 )
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define MD5_DIGEST_LENGTH 16 /* digest length in bytes */
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define MD5_BLOCK_BYTES 64 /* block size in bytes */
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome#define MD5_BLOCK_LONG (MD5_BLOCK_BYTES / sizeof(mDNSu32))
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern int MD5_Update(MD5_CTX *c, const void *data, unsigned long len);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern int MD5_Final(unsigned char *md, MD5_CTX *c);
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************
4b22b9337f359bfd063322244f5336cc7c6ffcfars// Some C compiler cleverness. We can make the compiler check certain things for
4b22b9337f359bfd063322244f5336cc7c6ffcfars// us, and report compile-time errors if anything is wrong. The usual way to do
4b22b9337f359bfd063322244f5336cc7c6ffcfars// this would be to use a run-time "if" statement, but then you don't find out
4b22b9337f359bfd063322244f5336cc7c6ffcfars// what's wrong until you run the software. This way, if the assertion condition
4b22b9337f359bfd063322244f5336cc7c6ffcfars// is false, the array size is negative, and the complier complains immediately.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Check that the compiler generated our on-the-wire packet format structure definitions
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // properly packed, without adding padding bytes to align fields on 32-bit or 64-bit boundaries.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assert0[(sizeof(rdataSRV) == 262 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assert1[(sizeof(DNSMessageHeader) == 12 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assert2[(sizeof(DNSMessage) == 12+AbsoluteMaxDNSMessageData) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assert5[(sizeof(mDNSs16) == 2 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assert6[(sizeof(mDNSu16) == 2 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assert7[(sizeof(mDNSs32) == 4 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assert8[(sizeof(mDNSu32) == 4 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assert9[(sizeof(mDNSOpaque16) == 2 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assertA[(sizeof(mDNSOpaque32) == 4 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assertB[(sizeof(mDNSOpaque128) == 16 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assertC[(sizeof(CacheRecord ) == sizeof(CacheGroup) ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assertE[(StandardAuthRDSize >= 256 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assertF[(sizeof(EthernetHeader) == 14 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assertG[(sizeof(ARP_EthIP ) == 28 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assertH[(sizeof(IPv4Header ) == 20 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assertI[(sizeof(IPv6Header ) == 40 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assertJ[(sizeof(IPv6NDP ) == 24 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assertK[(sizeof(UDPHeader ) == 8 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assertL[(sizeof(IKEHeader ) == 28 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char assertM[(sizeof(TCPHeader ) == 20 ) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // Check our structures are reasonable sizes. Including overly-large buffers, or embedding
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // other overly-large structures instead of having a pointer to them, can inadvertently
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome // cause structure sizes (and therefore memory usage) to balloon unreasonably.
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char sizecheck_RDataBody [(sizeof(RDataBody) == 264) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char sizecheck_ResourceRecord [(sizeof(ResourceRecord) <= 72) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char sizecheck_AuthRecord [(sizeof(AuthRecord) <= 1208) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char sizecheck_CacheRecord [(sizeof(CacheRecord) <= 232) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char sizecheck_CacheGroup [(sizeof(CacheGroup) <= 232) ? 1 : -1];
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome char sizecheck_DNSQuestion [(sizeof(DNSQuestion) <= 864) ? 1 : -1];
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome char sizecheck_ZoneData [(sizeof(ZoneData) <= 1700) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char sizecheck_NATTraversalInfo [(sizeof(NATTraversalInfo) <= 200) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char sizecheck_HostnameInfo [(sizeof(HostnameInfo) <= 3050) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char sizecheck_DNSServer [(sizeof(DNSServer) <= 340) ? 1 : -1];
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome char sizecheck_NetworkInterfaceInfo[(sizeof(NetworkInterfaceInfo) <= 7184) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char sizecheck_ServiceRecordSet [(sizeof(ServiceRecordSet) <= 5540) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome char sizecheck_DomainAuthInfo [(sizeof(DomainAuthInfo) <= 7888) ? 1 : -1];
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome char sizecheck_ServiceInfoQuery [(sizeof(ServiceInfoQuery) <= 3488) ? 1 : -1];
cda73f64f20b8a0afc4909f5ea1f055ec7913856Toomas Soome char sizecheck_ClientTunnel [(sizeof(ClientTunnel) <= 1208) ? 1 : -1];
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soome// Routine to initialize device-info TXT record contents
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas SoomemDNSu32 initializeDeviceInfoTXT(mDNS *m, mDNSu8 *ptr);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void D2D_start_advertising_interface(NetworkInterfaceInfo *interface);
5ffb0c9b03b5149ff4f5821a62be4a52408ada2aToomas Soomeextern void D2D_stop_advertising_interface(NetworkInterfaceInfo *interface);
4b22b9337f359bfd063322244f5336cc7c6ffcfars// ***************************************************************************