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 typedef struct DnsPacketHeader DnsPacketHeader;
  25 typedef struct DnsPacket DnsPacket;
  26
  27 #include <inttypes.h>
  28
  29 #include "macro.h"
  30 #include "sparse-endian.h"
  31 #include "hashmap.h"
  32 #include "resolved-dns-rr.h"
  33 #include "resolved-dns-question.h"
  34 #include "resolved-dns-answer.h"
  35
  36 typedef enum DnsProtocol {
  37         DNS_PROTOCOL_DNS,
  38         DNS_PROTOCOL_MDNS,
  39         DNS_PROTOCOL_LLMNR,
  40         _DNS_PROTOCOL_MAX,
  41         _DNS_PROTOCOL_INVALID = -1
  42 } DnsProtocol;
  43
  44 struct DnsPacketHeader {
  45         uint16_t id;
  46         be16_t flags;
  47         be16_t qdcount;
  48         be16_t ancount;
  49         be16_t nscount;
  50         be16_t arcount;
  51 };
  52
  53 #define DNS_PACKET_HEADER_SIZE sizeof(DnsPacketHeader)
  54
  55 /* The various DNS protocols deviate in how large a packet can grow,
  56    but the TCP transport has a 16bit size field, hence that appears to
  57    be the absolute maximum. */
  58 #define DNS_PACKET_SIZE_MAX 0xFFFF
  59
  60 /* RFC 1035 say 512 is the maximum, for classic unicast DNS */
  61 #define DNS_PACKET_UNICAST_SIZE_MAX 512
  62
  63 #define DNS_PACKET_SIZE_START 512
  64
  65 struct DnsPacket {
  66         int n_ref;
  67         DnsProtocol protocol;
  68         size_t size, allocated, rindex;
  69         void *_data; /* don't access directly, use DNS_PACKET_DATA()! */
  70         Hashmap *names; /* For name compression */
  71
  72         /* Parsed data */
  73         DnsQuestion *question;
  74         DnsAnswer *answer;
  75
  76         /* Packet reception meta data */
  77         int ifindex;
  78         int family;
  79         union in_addr_union sender, destination;
  80         uint32_t ttl;
  81 };
  82
  83 static inline uint8_t* DNS_PACKET_DATA(DnsPacket *p) {
  84         if (_unlikely_(!p))
  85                 return NULL;
  86
  87         if (p->_data)
  88                 return p->_data;
  89
  90         return ((uint8_t*) p) + ALIGN(sizeof(DnsPacket));
  91 }
  92
  93 #define DNS_PACKET_HEADER(p) ((DnsPacketHeader*) DNS_PACKET_DATA(p))
  94 #define DNS_PACKET_ID(p) DNS_PACKET_HEADER(p)->id
  95 #define DNS_PACKET_QR(p) ((be16toh(DNS_PACKET_HEADER(p)->flags) >> 15) & 1)
  96 #define DNS_PACKET_OPCODE(p) ((be16toh(DNS_PACKET_HEADER(p)->flags) >> 11) & 15)
  97 #define DNS_PACKET_RCODE(p) (be16toh(DNS_PACKET_HEADER(p)->flags) & 15)
  98 #define DNS_PACKET_TC(p) ((be16toh(DNS_PACKET_HEADER(p)->flags) >> 9) & 1)
  99 #define DNS_PACKET_QDCOUNT(p) be16toh(DNS_PACKET_HEADER(p)->qdcount)
 100 #define DNS_PACKET_ANCOUNT(p) be16toh(DNS_PACKET_HEADER(p)->ancount)
 101 #define DNS_PACKET_NSCOUNT(p) be16toh(DNS_PACKET_HEADER(p)->nscount)
 102 #define DNS_PACKET_ARCOUNT(p) be16toh(DNS_PACKET_HEADER(p)->arcount)
 103
 104 #define DNS_PACKET_MAKE_FLAGS(qr, opcode, aa, tc, rd, ra, ad, cd, rcode) \
 105         (((uint16_t) !!qr << 15) |  \
 106          ((uint16_t) (opcode & 15) << 11) | \
 107          ((uint16_t) !!aa << 10) | \
 108          ((uint16_t) !!tc << 9) | \
 109          ((uint16_t) !!rd << 8) | \
 110          ((uint16_t) !!ra << 7) | \
 111          ((uint16_t) !!ad << 5) | \
 112          ((uint16_t) !!cd << 4) | \
 113          ((uint16_t) (rcode & 15)))
 114
 115 static inline unsigned DNS_PACKET_RRCOUNT(DnsPacket *p) {
 116         return
 117                 (unsigned) DNS_PACKET_ANCOUNT(p) +
 118                 (unsigned) DNS_PACKET_NSCOUNT(p) +
 119                 (unsigned) DNS_PACKET_ARCOUNT(p);
 120 }
 121
 122 int dns_packet_new(DnsPacket **p, DnsProtocol protocol, size_t mtu);
 123 int dns_packet_new_query(DnsPacket **p, DnsProtocol protocol, size_t mtu);
 124
 125 DnsPacket *dns_packet_ref(DnsPacket *p);
 126 DnsPacket *dns_packet_unref(DnsPacket *p);
 127
 128 DEFINE_TRIVIAL_CLEANUP_FUNC(DnsPacket*, dns_packet_unref);
 129
 130 int dns_packet_validate(DnsPacket *p);
 131 int dns_packet_validate_reply(DnsPacket *p);
 132
 133 int dns_packet_append_uint8(DnsPacket *p, uint8_t v, size_t *start);
 134 int dns_packet_append_uint16(DnsPacket *p, uint16_t v, size_t *start);
 135 int dns_packet_append_string(DnsPacket *p, const char *s, size_t *start);
 136 int dns_packet_append_label(DnsPacket *p, const char *s, size_t l, size_t *start);
 137 int dns_packet_append_name(DnsPacket *p, const char *name, size_t *start);
 138 int dns_packet_append_key(DnsPacket *p, const DnsResourceKey *k, size_t *start);
 139
 140 int dns_packet_read(DnsPacket *p, size_t sz, const void **ret, size_t *start);
 141 int dns_packet_read_uint8(DnsPacket *p, uint8_t *ret, size_t *start);
 142 int dns_packet_read_uint16(DnsPacket *p, uint16_t *ret, size_t *start);
 143 int dns_packet_read_uint32(DnsPacket *p, uint32_t *ret, size_t *start);
 144 int dns_packet_read_string(DnsPacket *p, char **ret, size_t *start);
 145 int dns_packet_read_name(DnsPacket *p, char **ret, size_t *start);
 146 int dns_packet_read_key(DnsPacket *p, DnsResourceKey **ret, size_t *start);
 147 int dns_packet_read_rr(DnsPacket *p, DnsResourceRecord **ret, size_t *start);
 148
 149 void dns_packet_rewind(DnsPacket *p, size_t idx);
 150
 151 int dns_packet_skip_question(DnsPacket *p);
 152 int dns_packet_extract(DnsPacket *p);
 153
 154 enum {
 155         DNS_RCODE_SUCCESS = 0,
 156         DNS_RCODE_FORMERR = 1,
 157         DNS_RCODE_SERVFAIL = 2,
 158         DNS_RCODE_NXDOMAIN = 3,
 159         DNS_RCODE_NOTIMP = 4,
 160         DNS_RCODE_REFUSED = 5,
 161         DNS_RCODE_YXDOMAIN = 6,
 162         DNS_RCODE_YXRRSET = 7,
 163         DNS_RCODE_NXRRSET = 8,
 164         DNS_RCODE_NOTAUTH = 9,
 165         DNS_RCODE_NOTZONE = 10,
 166         DNS_RCODE_BADVERS = 16,
 167         DNS_RCODE_BADSIG = 16, /* duplicate value! */
 168         DNS_RCODE_BADKEY = 17,
 169         DNS_RCODE_BADTIME = 18,
 170         DNS_RCODE_BADMODE = 19,
 171         DNS_RCODE_BADNAME = 20,
 172         DNS_RCODE_BADALG = 21,
 173         DNS_RCODE_BADTRUNC = 22,
 174         _DNS_RCODE_MAX_DEFINED
 175 };
 176
 177 const char* dns_rcode_to_string(int i) _const_;
 178 int dns_rcode_from_string(const char *s) _pure_;
 179
 180 const char* dns_protocol_to_string(DnsProtocol p) _const_;
 181 DnsProtocol dns_protocol_from_string(const char *s) _pure_;
 182
 183 #define LLMNR_MULTICAST_IPV4_ADDRESS ((struct in_addr) { .s_addr = htobe32(224U << 24 | 252U) })
 184 #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 } })