]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/resolve/resolved-dns-rr.h
resolved: add DNS_RESOURCE_KEY_REPLACE
[thirdparty/systemd.git] / src / resolve / resolved-dns-rr.h
CommitLineData
db9ecf05 1/* SPDX-License-Identifier: LGPL-2.1-or-later */
74b2466e
LP
2#pragma once
3
74b2466e
LP
4#include <netinet/in.h>
5
50f1e641 6#include "bitmap.h"
98e80bf9 7#include "dns-def.h"
71d35b6b 8#include "dns-type.h"
322345fd 9#include "hashmap.h"
623a4c97 10#include "in-addr-util.h"
2001c805 11#include "list.h"
1c02e7ba 12#include "string-util.h"
ca78ad1d 13#include "time-util.h"
74b2466e
LP
14
15typedef struct DnsResourceKey DnsResourceKey;
16typedef struct DnsResourceRecord DnsResourceRecord;
2001c805 17typedef struct DnsTxtItem DnsTxtItem;
74b2466e 18
8730bccf 19/* DNSKEY RR flags */
82d39576
SB
20#define DNSKEY_FLAG_SEP (UINT16_C(1) << 0)
21#define DNSKEY_FLAG_REVOKE (UINT16_C(1) << 7)
22#define DNSKEY_FLAG_ZONE_KEY (UINT16_C(1) << 8)
8730bccf 23
23502de3 24/* mDNS RR flags */
82d39576 25#define MDNS_RR_CACHE_FLUSH_OR_QU (UINT16_C(1) << 15)
23502de3 26
8730bccf
LP
27/* DNSSEC algorithm identifiers, see
28 * http://tools.ietf.org/html/rfc4034#appendix-A.1 and
29 * https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml */
30enum {
31 DNSSEC_ALGORITHM_RSAMD5 = 1,
32 DNSSEC_ALGORITHM_DH,
33 DNSSEC_ALGORITHM_DSA,
34 DNSSEC_ALGORITHM_ECC,
35 DNSSEC_ALGORITHM_RSASHA1,
36 DNSSEC_ALGORITHM_DSA_NSEC3_SHA1,
37 DNSSEC_ALGORITHM_RSASHA1_NSEC3_SHA1,
6f717d08
LP
38 DNSSEC_ALGORITHM_RSASHA256 = 8, /* RFC 5702 */
39 DNSSEC_ALGORITHM_RSASHA512 = 10, /* RFC 5702 */
40 DNSSEC_ALGORITHM_ECC_GOST = 12, /* RFC 5933 */
e0240c64
LP
41 DNSSEC_ALGORITHM_ECDSAP256SHA256 = 13, /* RFC 6605 */
42 DNSSEC_ALGORITHM_ECDSAP384SHA384 = 14, /* RFC 6605 */
cb9eeb06
MCO
43 DNSSEC_ALGORITHM_ED25519 = 15, /* RFC 8080 */
44 DNSSEC_ALGORITHM_ED448 = 16, /* RFC 8080 */
8730bccf
LP
45 DNSSEC_ALGORITHM_INDIRECT = 252,
46 DNSSEC_ALGORITHM_PRIVATEDNS,
47 DNSSEC_ALGORITHM_PRIVATEOID,
48 _DNSSEC_ALGORITHM_MAX_DEFINED
49};
50
51/* DNSSEC digest identifiers, see
52 * https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml */
53enum {
54 DNSSEC_DIGEST_SHA1 = 1,
6f717d08
LP
55 DNSSEC_DIGEST_SHA256 = 2, /* RFC 4509 */
56 DNSSEC_DIGEST_GOST_R_34_11_94 = 3, /* RFC 5933 */
57 DNSSEC_DIGEST_SHA384 = 4, /* RFC 6605 */
8730bccf
LP
58 _DNSSEC_DIGEST_MAX_DEFINED
59};
60
d15ad742
LP
61/* DNSSEC NSEC3 hash algorithms, see
62 * https://www.iana.org/assignments/dnssec-nsec3-parameters/dnssec-nsec3-parameters.xhtml */
63enum {
64 NSEC3_ALGORITHM_SHA1 = 1,
65 _NSEC3_ALGORITHM_MAX_DEFINED
66};
67
74b2466e 68struct DnsResourceKey {
f57e3cd5 69 unsigned n_ref; /* (unsigned -1) for const keys, see below */
faa133f3 70 uint16_t class, type;
96d49011 71 char *_name; /* don't access directly, use dns_resource_key_name()! */
74b2466e
LP
72};
73
1b4f6e79
LP
74/* Creates a temporary resource key. This is only useful to quickly
75 * look up something, without allocating a full DnsResourceKey object
76 * for it. Note that it is not OK to take references to this kind of
77 * resource key object. */
78#define DNS_RESOURCE_KEY_CONST(c, t, n) \
79 ((DnsResourceKey) { \
f5fbe71d 80 .n_ref = UINT_MAX, \
1b4f6e79
LP
81 .class = c, \
82 .type = t, \
83 ._name = (char*) n, \
84 })
85
2001c805
LP
86struct DnsTxtItem {
87 size_t length;
88 LIST_FIELDS(DnsTxtItem, items);
89 uint8_t data[];
90};
91
74b2466e
LP
92struct DnsResourceRecord {
93 unsigned n_ref;
a6e890d4
ZJS
94 uint32_t ttl;
95 usec_t expiry; /* RRSIG signature expiry */
96
faa133f3 97 DnsResourceKey *key;
97c67192 98
7b50eb2e 99 char *to_string;
97c67192 100
97c67192 101 /* How many labels to strip to determine "signer" of the RRSIG (aka, the zone). -1 if not signed. */
98e80bf9 102 uint8_t n_skip_labels_signer;
97c67192 103 /* How many labels to strip to determine "synthesizing source" of this RR, i.e. the wildcard's immediate parent. -1 if not signed. */
98e80bf9 104 uint8_t n_skip_labels_source;
97c67192 105
a6e890d4
ZJS
106 bool unparsable;
107 bool wire_format_canonical;
97c67192 108
a8812dd7
LP
109 void *wire_format;
110 size_t wire_format_size;
111 size_t wire_format_rdata_offset;
97c67192 112
74b2466e
LP
113 union {
114 struct {
115 void *data;
a43a068a 116 size_t data_size;
d75acfb0 117 } generic, opt;
74b2466e 118
9c92ce6d 119 struct {
a6e890d4 120 char *name;
9c92ce6d
LP
121 uint16_t priority;
122 uint16_t weight;
123 uint16_t port;
9c92ce6d 124 } srv;
74b2466e
LP
125
126 struct {
127 char *name;
8ac4e9e1 128 } ptr, ns, cname, dname;
74b2466e
LP
129
130 struct {
131 char *cpu;
132 char *os;
133 } hinfo;
134
2e276efc 135 struct {
2001c805 136 DnsTxtItem *items;
c0eb11cf 137 } txt, spf;
74b2466e
LP
138
139 struct {
140 struct in_addr in_addr;
141 } a;
142
143 struct {
144 struct in6_addr in6_addr;
145 } aaaa;
7e8e0422
LP
146
147 struct {
148 char *mname;
149 char *rname;
150 uint32_t serial;
151 uint32_t refresh;
152 uint32_t retry;
153 uint32_t expire;
154 uint32_t minimum;
155 } soa;
946c7094
ZJS
156
157 struct {
946c7094 158 char *exchange;
a6e890d4 159 uint16_t priority;
946c7094 160 } mx;
0dae31d4 161
6af47493 162 /* https://tools.ietf.org/html/rfc1876 */
0dae31d4
ZJS
163 struct {
164 uint8_t version;
165 uint8_t size;
166 uint8_t horiz_pre;
167 uint8_t vert_pre;
168 uint32_t latitude;
169 uint32_t longitude;
170 uint32_t altitude;
171 } loc;
42cc2eeb 172
549c1a25 173 /* https://tools.ietf.org/html/rfc4255#section-3.1 */
42cc2eeb 174 struct {
549c1a25
TG
175 void *fingerprint;
176 size_t fingerprint_size;
a6e890d4
ZJS
177
178 uint8_t algorithm;
179 uint8_t fptype;
42cc2eeb 180 } sshfp;
8db0d2f5
ZJS
181
182 /* http://tools.ietf.org/html/rfc4034#section-2.1 */
183 struct {
a6e890d4
ZJS
184 void* key;
185 size_t key_size;
186
f91dc240
LP
187 uint16_t flags;
188 uint8_t protocol;
8db0d2f5 189 uint8_t algorithm;
8db0d2f5 190 } dnskey;
151226ab
ZJS
191
192 /* http://tools.ietf.org/html/rfc4034#section-3.1 */
193 struct {
a6e890d4
ZJS
194 char *signer;
195 void *signature;
196 size_t signature_size;
197
151226ab
ZJS
198 uint16_t type_covered;
199 uint8_t algorithm;
200 uint8_t labels;
201 uint32_t original_ttl;
202 uint32_t expiration;
203 uint32_t inception;
204 uint16_t key_tag;
151226ab 205 } rrsig;
50f1e641 206
9ead3519 207 /* https://tools.ietf.org/html/rfc4034#section-4.1 */
50f1e641
TG
208 struct {
209 char *next_domain_name;
210 Bitmap *types;
211 } nsec;
5d45a880 212
6af47493
LP
213 /* https://tools.ietf.org/html/rfc4034#section-5.1 */
214 struct {
a6e890d4
ZJS
215 void *digest;
216 size_t digest_size;
217
6af47493
LP
218 uint16_t key_tag;
219 uint8_t algorithm;
220 uint8_t digest_type;
6af47493
LP
221 } ds;
222
5d45a880 223 struct {
a6e890d4 224 Bitmap *types;
5d45a880
TG
225 void *salt;
226 size_t salt_size;
227 void *next_hashed_name;
228 size_t next_hashed_name_size;
a6e890d4
ZJS
229
230 uint8_t algorithm;
231 uint8_t flags;
232 uint16_t iterations;
5d45a880 233 } nsec3;
48d45d2b
ZJS
234
235 /* https://tools.ietf.org/html/draft-ietf-dane-protocol-23 */
236 struct {
a6e890d4
ZJS
237 void *data;
238 size_t data_size;
239
48d45d2b
ZJS
240 uint8_t cert_usage;
241 uint8_t selector;
242 uint8_t matching_type;
48d45d2b 243 } tlsa;
95052df3
ZJS
244
245 /* https://tools.ietf.org/html/rfc6844 */
246 struct {
95052df3
ZJS
247 char *tag;
248 void *value;
249 size_t value_size;
a6e890d4
ZJS
250
251 uint8_t flags;
95052df3 252 } caa;
74b2466e 253 };
a6e890d4
ZJS
254
255 /* Note: fields should be ordered to minimize alignment gaps. Use pahole! */
74b2466e
LP
256};
257
98e80bf9
ZJS
258/* We use uint8_t for label counts above, and UINT8_MAX/-1 has special meaning. */
259assert_cc(DNS_N_LABELS_MAX < UINT8_MAX);
260
93bab288 261static inline const void* DNS_RESOURCE_RECORD_RDATA(const DnsResourceRecord *rr) {
85aeaccc
LP
262 if (!rr)
263 return NULL;
264
265 if (!rr->wire_format)
266 return NULL;
267
268 assert(rr->wire_format_rdata_offset <= rr->wire_format_size);
269 return (uint8_t*) rr->wire_format + rr->wire_format_rdata_offset;
270}
271
93bab288 272static inline size_t DNS_RESOURCE_RECORD_RDATA_SIZE(const DnsResourceRecord *rr) {
85aeaccc
LP
273 if (!rr)
274 return 0;
275 if (!rr->wire_format)
276 return 0;
277
278 assert(rr->wire_format_rdata_offset <= rr->wire_format_size);
279 return rr->wire_format_size - rr->wire_format_rdata_offset;
280}
281
93bab288 282static inline uint8_t DNS_RESOURCE_RECORD_OPT_VERSION_SUPPORTED(const DnsResourceRecord *rr) {
b30bf55d
LP
283 assert(rr);
284 assert(rr->key->type == DNS_TYPE_OPT);
285
286 return ((rr->ttl >> 16) & 0xFF) == 0;
287}
288
faa133f3 289DnsResourceKey* dns_resource_key_new(uint16_t class, uint16_t type, const char *name);
36d9205d 290DnsResourceKey* dns_resource_key_new_redirect(const DnsResourceKey *key, const DnsResourceRecord *cname);
801ad6a6 291int dns_resource_key_new_append_suffix(DnsResourceKey **ret, DnsResourceKey *key, char *name);
faa133f3
LP
292DnsResourceKey* dns_resource_key_new_consume(uint16_t class, uint16_t type, char *name);
293DnsResourceKey* dns_resource_key_ref(DnsResourceKey *key);
294DnsResourceKey* dns_resource_key_unref(DnsResourceKey *key);
57318441
ZJS
295
296#define DNS_RESOURCE_KEY_REPLACE(a, b) \
297 do { \
298 typeof(a)* _a = &(a); \
299 typeof(b) _b = (b); \
300 dns_resource_key_unref(*_a); \
301 *_a = _b; \
302 } while(0)
303
1c02e7ba 304const char* dns_resource_key_name(const DnsResourceKey *key);
28b9b764 305bool dns_resource_key_is_address(const DnsResourceKey *key);
a2bf8a19 306bool dns_resource_key_is_dnssd_ptr(const DnsResourceKey *key);
faa133f3 307int dns_resource_key_equal(const DnsResourceKey *a, const DnsResourceKey *b);
105e1512 308int dns_resource_key_match_rr(const DnsResourceKey *key, DnsResourceRecord *rr, const char *search_domain);
5d27351f 309int dns_resource_key_match_cname_or_dname(const DnsResourceKey *key, const DnsResourceKey *cname, const char *search_domain);
547973de 310int dns_resource_key_match_soa(const DnsResourceKey *key, const DnsResourceKey *soa);
202b76ae
ZJS
311
312/* _DNS_{CLASS,TYPE}_STRING_MAX include one byte for NUL, which we use for space instead below.
313 * DNS_HOSTNAME_MAX does not include the NUL byte, so we need to add 1. */
314#define DNS_RESOURCE_KEY_STRING_MAX (_DNS_CLASS_STRING_MAX + _DNS_TYPE_STRING_MAX + DNS_HOSTNAME_MAX + 1)
315
316char* dns_resource_key_to_string(const DnsResourceKey *key, char *buf, size_t buf_size);
2e74028a
ZJS
317ssize_t dns_resource_record_payload(DnsResourceRecord *rr, void **out);
318
faa133f3 319DEFINE_TRIVIAL_CLEANUP_FUNC(DnsResourceKey*, dns_resource_key_unref);
322345fd 320
7778dfff
DM
321static inline bool dns_key_is_shared(const DnsResourceKey *key) {
322 return IN_SET(key->type, DNS_TYPE_PTR);
323}
324
f57e3cd5
LP
325bool dns_resource_key_reduce(DnsResourceKey **a, DnsResourceKey **b);
326
faa133f3 327DnsResourceRecord* dns_resource_record_new(DnsResourceKey *key);
8bf52d3d 328DnsResourceRecord* dns_resource_record_new_full(uint16_t class, uint16_t type, const char *name);
74b2466e
LP
329DnsResourceRecord* dns_resource_record_ref(DnsResourceRecord *rr);
330DnsResourceRecord* dns_resource_record_unref(DnsResourceRecord *rr);
7daeec3e
ZJS
331
332#define DNS_RR_REPLACE(a, b) \
333 do { \
334 typeof(a)* _a = &(a); \
335 typeof(b) _b = (b); \
336 dns_resource_record_unref(*_a); \
337 *_a = _b; \
338 } while(0)
339
623a4c97 340int dns_resource_record_new_reverse(DnsResourceRecord **ret, int family, const union in_addr_union *address, const char *name);
78c6a153 341int dns_resource_record_new_address(DnsResourceRecord **ret, int family, const union in_addr_union *address, const char *name);
322345fd 342int dns_resource_record_equal(const DnsResourceRecord *a, const DnsResourceRecord *b);
51969a58
ZJS
343int dns_resource_record_payload_equal(const DnsResourceRecord *a, const DnsResourceRecord *b);
344
7b50eb2e 345const char* dns_resource_record_to_string(DnsResourceRecord *rr);
17c8de63 346DnsResourceRecord *dns_resource_record_copy(DnsResourceRecord *rr);
faa133f3 347DEFINE_TRIVIAL_CLEANUP_FUNC(DnsResourceRecord*, dns_resource_record_unref);
322345fd 348
a8812dd7
LP
349int dns_resource_record_to_wire_format(DnsResourceRecord *rr, bool canonical);
350
97c67192
LP
351int dns_resource_record_signer(DnsResourceRecord *rr, const char **ret);
352int dns_resource_record_source(DnsResourceRecord *rr, const char **ret);
353int dns_resource_record_is_signer(DnsResourceRecord *rr, const char *zone);
ab481675 354int dns_resource_record_is_synthetic(DnsResourceRecord *rr);
97c67192 355
17c8de63
LP
356int dns_resource_record_clamp_ttl(DnsResourceRecord **rr, uint32_t max_ttl);
357
48662847
LP
358bool dns_resource_record_is_link_local_address(DnsResourceRecord *rr);
359
d1f8fbea
LP
360int dns_resource_record_get_cname_target(DnsResourceKey *key, DnsResourceRecord *cname, char **ret);
361
2001c805
LP
362DnsTxtItem *dns_txt_item_free_all(DnsTxtItem *i);
363bool dns_txt_item_equal(DnsTxtItem *a, DnsTxtItem *b);
17c8de63 364DnsTxtItem *dns_txt_item_copy(DnsTxtItem *i);
ebb779dc 365int dns_txt_item_new_empty(DnsTxtItem **ret);
2001c805 366
7a08d314 367void dns_resource_record_hash_func(const DnsResourceRecord *i, struct siphash *state);
ae45e1a3 368int dns_resource_record_compare_func(const DnsResourceRecord *x, const DnsResourceRecord *y);
6d99904f 369
d5099efc 370extern const struct hash_ops dns_resource_key_hash_ops;
c9c72065 371extern const struct hash_ops dns_resource_record_hash_ops;
8730bccf 372
8e54f5d9 373int dnssec_algorithm_to_string_alloc(int i, char **ret);
8730bccf
LP
374int dnssec_algorithm_from_string(const char *s) _pure_;
375
8e54f5d9 376int dnssec_digest_to_string_alloc(int i, char **ret);
8730bccf 377int dnssec_digest_from_string(const char *s) _pure_;