dnsinfo/dnsinfo.h

   1 /*
   2  * Copyright (c) 2004-2006, 2008, 2009, 2011-2013, 2015-2018 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef __DNSINFO_H__
  25 #define __DNSINFO_H__
  26
  27 /*
  28  * These routines provide access to the systems DNS configuration
  29  */
  30
  31 #include <os/availability.h>
  32 #include <sys/cdefs.h>
  33 #include <stdint.h>
  34 #include <sys/types.h>
  35 #include <sys/socket.h>
  36 #include <netinet/in.h>
  37
  38 #define DNSINFO_VERSION         20170629
  39
  40 #define DEFAULT_SEARCH_ORDER    200000   /* search order for the "default" resolver domain name */
  41
  42 #define DNS_PTR(type, name)                             \
  43         union {                                         \
  44                 type            name;                   \
  45                 uint64_t        _ ## name ## _p;        \
  46         }
  47
  48 #define DNS_VAR(type, name)                             \
  49         type    name
  50
  51
  52 #pragma pack(4)
  53 typedef struct {
  54         struct in_addr  address;
  55         struct in_addr  mask;
  56 } dns_sortaddr_t;
  57 #pragma pack()
  58
  59
  60 #pragma pack(4)
  61 typedef struct {
  62         DNS_PTR(char *,                 domain);        /* domain */
  63         DNS_VAR(int32_t,                n_nameserver);  /* # nameserver */
  64         DNS_PTR(struct sockaddr **,     nameserver);
  65         DNS_VAR(uint16_t,               port);          /* port (in host byte order) */
  66         DNS_VAR(int32_t,                n_search);      /* # search */
  67         DNS_PTR(char **,                search);
  68         DNS_VAR(int32_t,                n_sortaddr);    /* # sortaddr */
  69         DNS_PTR(dns_sortaddr_t **,      sortaddr);
  70         DNS_PTR(char *,                 options);       /* options */
  71         DNS_VAR(uint32_t,               timeout);       /* timeout */
  72         DNS_VAR(uint32_t,               search_order);  /* search_order */
  73         DNS_VAR(uint32_t,               if_index);
  74         DNS_VAR(uint32_t,               flags);
  75         DNS_VAR(uint32_t,               reach_flags);   /* SCNetworkReachabilityFlags */
  76         DNS_VAR(uint32_t,               service_identifier);
  77         DNS_PTR(char *,                 cid);           /* configuration identifer */
  78         DNS_PTR(char *,                 if_name);       /* if_index interface name */
  79 } dns_resolver_t;
  80 #pragma pack()
  81
  82
  83 #define DNS_RESOLVER_FLAGS_REQUEST_A_RECORDS    0x0002          /* always requesting for A dns records in queries */
  84 #define DNS_RESOLVER_FLAGS_REQUEST_AAAA_RECORDS 0x0004          /* always requesting for AAAA dns records in queries */
  85
  86 #define DNS_RESOLVER_FLAGS_REQUEST_ALL_RECORDS  \
  87         (DNS_RESOLVER_FLAGS_REQUEST_A_RECORDS | DNS_RESOLVER_FLAGS_REQUEST_AAAA_RECORDS)
  88
  89 #define DNS_RESOLVER_FLAGS_SCOPED               0x1000          /* configuration is for scoped questions */
  90 #define DNS_RESOLVER_FLAGS_SERVICE_SPECIFIC     0x2000          /* configuration is service-specific */
  91 #define DNS_RESOLVER_FLAGS_SUPPLEMENTAL         0x4000          /* supplemental match configuration */
  92
  93
  94 #pragma pack(4)
  95 typedef struct {
  96         DNS_VAR(int32_t,                n_resolver);            /* resolver configurations */
  97         DNS_PTR(dns_resolver_t **,      resolver);
  98         DNS_VAR(int32_t,                n_scoped_resolver);     /* "scoped" resolver configurations */
  99         DNS_PTR(dns_resolver_t **,      scoped_resolver);
 100         DNS_VAR(uint64_t,               generation);
 101         DNS_VAR(int32_t,                n_service_specific_resolver);
 102         DNS_PTR(dns_resolver_t **,      service_specific_resolver);
 103         DNS_VAR(uint32_t,               version);
 104 } dns_config_t;
 105 #pragma pack()
 106
 107
 108 __BEGIN_DECLS
 109
 110 /*
 111  * DNS configuration access APIs
 112  */
 113 const char *
 114 dns_configuration_notify_key    (void)                          API_AVAILABLE(macos(10.4), ios(2.0));
 115
 116 dns_config_t *
 117 dns_configuration_copy          (void)                          API_AVAILABLE(macos(10.4), ios(2.0));
 118
 119 void
 120 dns_configuration_free          (dns_config_t   *config)        API_AVAILABLE(macos(10.4), ios(2.0));
 121
 122 void
 123 _dns_configuration_ack          (dns_config_t   *config,
 124                                  const char     *bundle_id)     API_AVAILABLE(macos(10.8), ios(6.0));
 125
 126 __END_DECLS
 127
 128 #endif  /* __DNSINFO_H__ */