src/resolve/resolved-dns-packet.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2014 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22  ***/
  23
  24
  25 #include "macro.h"
  26 #include "sparse-endian.h"
  27 #include "hashmap.h"
  28 #include "in-addr-util.h"
  29
  30 typedef struct DnsPacketHeader DnsPacketHeader;
  31 typedef struct DnsPacket DnsPacket;
  32
  33 #include "resolved-dns-rr.h"
  34 #include "resolved-dns-question.h"
  35 #include "resolved-dns-answer.h"
  36 #include "resolved-def.h"
  37
  38 typedef enum DnsProtocol {
  39         DNS_PROTOCOL_DNS,
  40         DNS_PROTOCOL_MDNS,
  41         DNS_PROTOCOL_LLMNR,
  42         _DNS_PROTOCOL_MAX,
  43         _DNS_PROTOCOL_INVALID = -1
  44 } DnsProtocol;
  45
  46 struct DnsPacketHeader {
  47         uint16_t id;
  48         be16_t flags;
  49         be16_t qdcount;
  50         be16_t ancount;
  51         be16_t nscount;
  52         be16_t arcount;
  53 };
  54
  55 #define DNS_PACKET_HEADER_SIZE sizeof(DnsPacketHeader)
  56
  57 /* The various DNS protocols deviate in how large a packet can grow,
  58    but the TCP transport has a 16bit size field, hence that appears to
  59    be the absolute maximum. */
  60 #define DNS_PACKET_SIZE_MAX 0xFFFF
  61
  62 /* RFC 1035 say 512 is the maximum, for classic unicast DNS */
  63 #define DNS_PACKET_UNICAST_SIZE_MAX 512
  64
  65 #define DNS_PACKET_SIZE_START 512
  66
  67 struct DnsPacket {
  68         int n_ref;
  69         DnsProtocol protocol;
  70         size_t size, allocated, rindex;
  71         void *_data; /* don't access directly, use DNS_PACKET_DATA()! */
  72         Hashmap *names; /* For name compression */
  73
  74         /* Parsed data */
  75         DnsQuestion *question;
  76         DnsAnswer *answer;
  77
  78         /* Packet reception meta data */
  79         int ifindex;
  80         int family, ipproto;
  81         union in_addr_union sender, destination;
  82         uint16_t sender_port, destination_port;
  83         uint32_t ttl;
  84
  85         bool extracted;
  86 };
  87
  88 static inline uint8_t* DNS_PACKET_DATA(DnsPacket *p) {
  89         if (_unlikely_(!p))
  90                 return NULL;
  91
  92         if (p->_data)
  93                 return p->_data;
  94
  95         return ((uint8_t*) p) + ALIGN(sizeof(DnsPacket));
  96 }
  97
  98 #define DNS_PACKET_HEADER(p) ((DnsPacketHeader*) DNS_PACKET_DATA(p))
  99 #define DNS_PACKET_ID(p) DNS_PACKET_HEADER(p)->id
 100 #define DNS_PACKET_QR(p) ((be16toh(DNS_PACKET_HEADER(p)->flags) >> 15) & 1)
 101 #define DNS_PACKET_OPCODE(p) ((be16toh(DNS_PACKET_HEADER(p)->flags) >> 11) & 15)
 102 #define DNS_PACKET_RCODE(p) (be16toh(DNS_PACKET_HEADER(p)->flags) & 15)
 103 #define DNS_PACKET_TC(p) ((be16toh(DNS_PACKET_HEADER(p)->flags) >> 9) & 1)
 104 #define DNS_PACKET_C(p) ((be16toh(DNS_PACKET_HEADER(p)->flags) >> 10) & 1)
 105 #define DNS_PACKET_T(p) ((be16toh(DNS_PACKET_HEADER(p)->flags) >> 8) & 1)
 106 #define DNS_PACKET_QDCOUNT(p) be16toh(DNS_PACKET_HEADER(p)->qdcount)
 107 #define DNS_PACKET_ANCOUNT(p) be16toh(DNS_PACKET_HEADER(p)->ancount)
 108 #define DNS_PACKET_NSCOUNT(p) be16toh(DNS_PACKET_HEADER(p)->nscount)
 109 #define DNS_PACKET_ARCOUNT(p) be16toh(DNS_PACKET_HEADER(p)->arcount)
 110
 111 #define DNS_PACKET_MAKE_FLAGS(qr, opcode, aa, tc, rd, ra, ad, cd, rcode) \
 112         (((uint16_t) !!qr << 15) |  \
 113          ((uint16_t) (opcode & 15) << 11) | \
 114          ((uint16_t) !!aa << 10) | \
 115          ((uint16_t) !!tc << 9) | \
 116          ((uint16_t) !!rd << 8) | \
 117          ((uint16_t) !!ra << 7) | \
 118          ((uint16_t) !!ad << 5) | \
 119          ((uint16_t) !!cd << 4) | \
 120          ((uint16_t) (rcode & 15)))
 121
 122 static inline unsigned DNS_PACKET_RRCOUNT(DnsPacket *p) {
 123         return
 124                 (unsigned) DNS_PACKET_ANCOUNT(p) +
 125                 (unsigned) DNS_PACKET_NSCOUNT(p) +
 126                 (unsigned) DNS_PACKET_ARCOUNT(p);
 127 }
 128
 129 int dns_packet_new(DnsPacket **p, DnsProtocol protocol, size_t mtu);
 130 int dns_packet_new_query(DnsPacket **p, DnsProtocol protocol, size_t mtu);
 131
 132 DnsPacket *dns_packet_ref(DnsPacket *p);
 133 DnsPacket *dns_packet_unref(DnsPacket *p);
 134
 135 DEFINE_TRIVIAL_CLEANUP_FUNC(DnsPacket*, dns_packet_unref);
 136
 137 int dns_packet_validate(DnsPacket *p);
 138 int dns_packet_validate_reply(DnsPacket *p);
 139 int dns_packet_validate_query(DnsPacket *p);
 140
 141 int dns_packet_append_blob(DnsPacket *p, const void *d, size_t sz, size_t *start);
 142 int dns_packet_append_uint8(DnsPacket *p, uint8_t v, size_t *start);
 143 int dns_packet_append_uint16(DnsPacket *p, uint16_t v, size_t *start);
 144 int dns_packet_append_uint32(DnsPacket *p, uint32_t v, size_t *start);
 145 int dns_packet_append_string(DnsPacket *p, const char *s, size_t *start);
 146 int dns_packet_append_label(DnsPacket *p, const char *s, size_t l, size_t *start);
 147 int dns_packet_append_name(DnsPacket *p, const char *name,
 148                            bool allow_compression, size_t *start);
 149 int dns_packet_append_key(DnsPacket *p, const DnsResourceKey *key, size_t *start);
 150 int dns_packet_append_rr(DnsPacket *p, const DnsResourceRecord *rr, size_t *start);
 151
 152 int dns_packet_read(DnsPacket *p, size_t sz, const void **ret, size_t *start);
 153 int dns_packet_read_blob(DnsPacket *p, void *d, size_t sz, size_t *start);
 154 int dns_packet_read_uint8(DnsPacket *p, uint8_t *ret, size_t *start);
 155 int dns_packet_read_uint16(DnsPacket *p, uint16_t *ret, size_t *start);
 156 int dns_packet_read_uint32(DnsPacket *p, uint32_t *ret, size_t *start);
 157 int dns_packet_read_string(DnsPacket *p, char **ret, size_t *start);
 158 int dns_packet_read_name(DnsPacket *p, char **ret,
 159                          bool allow_compression, size_t *start);
 160 int dns_packet_read_key(DnsPacket *p, DnsResourceKey **ret, size_t *start);
 161 int dns_packet_read_rr(DnsPacket *p, DnsResourceRecord **ret, size_t *start);
 162
 163 void dns_packet_rewind(DnsPacket *p, size_t idx);
 164
 165 int dns_packet_skip_question(DnsPacket *p);
 166 int dns_packet_extract(DnsPacket *p);
 167
 168 enum {
 169         DNS_RCODE_SUCCESS = 0,
 170         DNS_RCODE_FORMERR = 1,
 171         DNS_RCODE_SERVFAIL = 2,
 172         DNS_RCODE_NXDOMAIN = 3,
 173         DNS_RCODE_NOTIMP = 4,
 174         DNS_RCODE_REFUSED = 5,
 175         DNS_RCODE_YXDOMAIN = 6,
 176         DNS_RCODE_YXRRSET = 7,
 177         DNS_RCODE_NXRRSET = 8,
 178         DNS_RCODE_NOTAUTH = 9,
 179         DNS_RCODE_NOTZONE = 10,
 180         DNS_RCODE_BADVERS = 16,
 181         DNS_RCODE_BADSIG = 16, /* duplicate value! */
 182         DNS_RCODE_BADKEY = 17,
 183         DNS_RCODE_BADTIME = 18,
 184         DNS_RCODE_BADMODE = 19,
 185         DNS_RCODE_BADNAME = 20,
 186         DNS_RCODE_BADALG = 21,
 187         DNS_RCODE_BADTRUNC = 22,
 188         _DNS_RCODE_MAX_DEFINED
 189 };
 190
 191 const char* dns_rcode_to_string(int i) _const_;
 192 int dns_rcode_from_string(const char *s) _pure_;
 193
 194 const char* dns_protocol_to_string(DnsProtocol p) _const_;
 195 DnsProtocol dns_protocol_from_string(const char *s) _pure_;
 196
 197 #define LLMNR_MULTICAST_IPV4_ADDRESS ((struct in_addr) { .s_addr = htobe32(224U << 24 | 252U) })
 198 #define LLMNR_MULTICAST_IPV6_ADDRESS ((struct in6_addr) { .s6_addr = { 0xFF, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x03 } })
 199
 200 #define DNSKEY_FLAG_ZONE_KEY (1u << 8)
 201 #define DNSKEY_FLAG_SEP      (1u << 0)
 202
 203 static inline uint16_t dnskey_to_flags(const DnsResourceRecord *rr) {
 204         return (rr->dnskey.zone_key_flag * DNSKEY_FLAG_ZONE_KEY |
 205                 rr->dnskey.sep_flag * DNSKEY_FLAG_SEP);
 206 }
 207
 208 /* http://tools.ietf.org/html/rfc4034#appendix-A.1 */
 209 enum {
 210         DNSSEC_ALGORITHM_RSAMD5 = 1,
 211         DNSSEC_ALGORITHM_DH,
 212         DNSSEC_ALGORITHM_DSA,
 213         DNSSEC_ALGORITHM_ECC,
 214         DNSSEC_ALGORITHM_RSASHA1,
 215         DNSSEC_ALGORITHM_INDIRECT = 252,
 216         DNSSEC_ALGORITHM_PRIVATEDNS,
 217         DNSSEC_ALGORITHM_PRIVATEOID,
 218         _DNSSEC_ALGORITHM_MAX_DEFINED
 219 };
 220
 221 const char* dnssec_algorithm_to_string(int i) _const_;
 222 int dnssec_algorithm_from_string(const char *s) _pure_;
 223
 224 static inline uint64_t SD_RESOLVED_FLAGS_MAKE(DnsProtocol protocol, int family) {
 225
 226         /* Converts a protocol + family into a flags field as used in queries */
 227
 228         if (protocol == DNS_PROTOCOL_DNS)
 229                 return SD_RESOLVED_DNS;
 230
 231         if (protocol == DNS_PROTOCOL_LLMNR)
 232                 return family == AF_INET6 ? SD_RESOLVED_LLMNR_IPV6 : SD_RESOLVED_LLMNR_IPV4;
 233
 234         return 0;
 235 }