[thirdparty/systemd.git] / src / resolve / resolved-dns-rr.h

/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/

#pragma once

/***
  This file is part of systemd.

  Copyright 2014 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
 ***/

#include <netinet/in.h>

#include "bitmap.h"
#include "hashmap.h"
#include "in-addr-util.h"
#include "dns-type.h"

typedef struct DnsResourceKey DnsResourceKey;
typedef struct DnsResourceRecord DnsResourceRecord;

/* DNS record classes, see RFC 1035 */
enum {
        DNS_CLASS_IN   = 0x01,
        DNS_CLASS_ANY  = 0xFF,
        _DNS_CLASS_MAX,
        _DNS_CLASS_INVALID = -1
};

struct DnsResourceKey {
        unsigned n_ref;
        uint16_t class, type;
        char *_name; /* don't access directy, use DNS_RESOURCE_KEY_NAME()! */
};

struct DnsResourceRecord {
        unsigned n_ref;
        DnsResourceKey *key;
        uint32_t ttl;
        bool unparseable;
        union {
                struct {
                        void *data;
                        size_t size;
                } generic;

                struct {
                        uint16_t priority;
                        uint16_t weight;
                        uint16_t port;
                        char *name;
                } srv;

                struct {
                        char *name;
                } ptr, ns, cname, dname;

                struct {
                        char *cpu;
                        char *os;
                } hinfo;

                struct {
                        char **strings;
                } txt, spf;

                struct {
                        struct in_addr in_addr;
                } a;

                struct {
                        struct in6_addr in6_addr;
                } aaaa;

                struct {
                        char *mname;
                        char *rname;
                        uint32_t serial;
                        uint32_t refresh;
                        uint32_t retry;
                        uint32_t expire;
                        uint32_t minimum;
                } soa;

                struct {
                        uint16_t priority;
                        char *exchange;
                } mx;

                struct {
                        uint8_t version;
                        uint8_t size;
                        uint8_t horiz_pre;
                        uint8_t vert_pre;
                        uint32_t latitude;
                        uint32_t longitude;
                        uint32_t altitude;
                } loc;

                struct {
                        uint16_t key_tag;
                        uint8_t algorithm;
                        uint8_t digest_type;
                        void *digest;
                        size_t digest_size;
                } ds;

                /* https://tools.ietf.org/html/rfc4255#section-3.1 */
                struct {
                        uint8_t algorithm;
                        uint8_t fptype;
                        void *fingerprint;
                        size_t fingerprint_size;
                } sshfp;

                /* http://tools.ietf.org/html/rfc4034#section-2.1 */
                struct {
                        bool zone_key_flag:1;
                        bool sep_flag:1;
                        uint8_t algorithm;
                        void* key;
                        size_t key_size;
                } dnskey;

                /* http://tools.ietf.org/html/rfc4034#section-3.1 */
                struct {
                        uint16_t type_covered;
                        uint8_t algorithm;
                        uint8_t labels;
                        uint32_t original_ttl;
                        uint32_t expiration;
                        uint32_t inception;
                        uint16_t key_tag;
                        char *signer;
                        void *signature;
                        size_t signature_size;
                } rrsig;

                struct {
                        char *next_domain_name;
                        Bitmap *types;
                } nsec;

                struct {
                        uint8_t algorithm;
                        uint8_t flags;
                        uint16_t iterations;
                        void *salt;
                        size_t salt_size;
                        void *next_hashed_name;
                        size_t next_hashed_name_size;
                        Bitmap *types;
                } nsec3;
        };
};

static inline const char* DNS_RESOURCE_KEY_NAME(const DnsResourceKey *key) {
        if (_unlikely_(!key))
                return NULL;

        if (key->_name)
                return key->_name;

        return (char*) key + sizeof(DnsResourceKey);
}

DnsResourceKey* dns_resource_key_new(uint16_t class, uint16_t type, const char *name);
DnsResourceKey* dns_resource_key_new_consume(uint16_t class, uint16_t type, char *name);
DnsResourceKey* dns_resource_key_ref(DnsResourceKey *key);
DnsResourceKey* dns_resource_key_unref(DnsResourceKey *key);
int dns_resource_key_equal(const DnsResourceKey *a, const DnsResourceKey *b);
int dns_resource_key_match_rr(const DnsResourceKey *key, const DnsResourceRecord *rr);
int dns_resource_key_match_cname(const DnsResourceKey *key, const DnsResourceRecord *rr);
int dns_resource_key_to_string(const DnsResourceKey *key, char **ret);
DEFINE_TRIVIAL_CLEANUP_FUNC(DnsResourceKey*, dns_resource_key_unref);

DnsResourceRecord* dns_resource_record_new(DnsResourceKey *key);
DnsResourceRecord* dns_resource_record_new_full(uint16_t class, uint16_t type, const char *name);
DnsResourceRecord* dns_resource_record_ref(DnsResourceRecord *rr);
DnsResourceRecord* dns_resource_record_unref(DnsResourceRecord *rr);
int dns_resource_record_new_reverse(DnsResourceRecord **ret, int family, const union in_addr_union *address, const char *name);
int dns_resource_record_new_address(DnsResourceRecord **ret, int family, const union in_addr_union *address, const char *name);
int dns_resource_record_equal(const DnsResourceRecord *a, const DnsResourceRecord *b);
int dns_resource_record_to_string(const DnsResourceRecord *rr, char **ret);
DEFINE_TRIVIAL_CLEANUP_FUNC(DnsResourceRecord*, dns_resource_record_unref);

const char *dns_class_to_string(uint16_t type);
int dns_class_from_string(const char *name, uint16_t *class);

extern const struct hash_ops dns_resource_key_hash_ops;
Commit	Line	Data
74b2466e LP	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
74b2466e LP	24	#include <netinet/in.h>
74b2466e LP	25
50f1e641	26	#include "bitmap.h"
322345fd	27	#include "hashmap.h"
623a4c97	28	#include "in-addr-util.h"
7263f724	29	#include "dns-type.h"
74b2466e LP	30
	31	typedef struct DnsResourceKey DnsResourceKey;
	32	typedef struct DnsResourceRecord DnsResourceRecord;
	33
	34	/* DNS record classes, see RFC 1035 */
	35	enum {
	36	DNS_CLASS_IN = 0x01,
322345fd	37	DNS_CLASS_ANY = 0xFF,
b93312f5 ZJS	38	_DNS_CLASS_MAX,
b93312f5 ZJS	39	_DNS_CLASS_INVALID = -1
74b2466e LP	40	};
74b2466e LP	41
74b2466e	42	struct DnsResourceKey {
faa133f3 LP	43	unsigned n_ref;
	44	uint16_t class, type;
	45	char _name; / don't access directy, use DNS_RESOURCE_KEY_NAME()! */
74b2466e LP	46	};
	47
	48	struct DnsResourceRecord {
	49	unsigned n_ref;
faa133f3	50	DnsResourceKey *key;
74b2466e	51	uint32_t ttl;
0dae31d4	52	bool unparseable;
74b2466e LP	53	union {
	54	struct {
	55	void *data;
f5430a3e	56	size_t size;
74b2466e LP	57	} generic;
74b2466e LP	58
9c92ce6d LP	59	struct {
	60	uint16_t priority;
	61	uint16_t weight;
	62	uint16_t port;
	63	char *name;
	64	} srv;
74b2466e LP	65
	66	struct {
	67	char *name;
8ac4e9e1	68	} ptr, ns, cname, dname;
74b2466e LP	69
	70	struct {
	71	char *cpu;
	72	char *os;
	73	} hinfo;
	74
2e276efc ZJS	75	struct {
2e276efc ZJS	76	char **strings;
c0eb11cf	77	} txt, spf;
74b2466e LP	78
	79	struct {
	80	struct in_addr in_addr;
	81	} a;
	82
	83	struct {
	84	struct in6_addr in6_addr;
	85	} aaaa;
7e8e0422 LP	86
	87	struct {
	88	char *mname;
	89	char *rname;
	90	uint32_t serial;
	91	uint32_t refresh;
	92	uint32_t retry;
	93	uint32_t expire;
	94	uint32_t minimum;
	95	} soa;
946c7094 ZJS	96
	97	struct {
	98	uint16_t priority;
	99	char *exchange;
	100	} mx;
0dae31d4 ZJS	101
	102	struct {
	103	uint8_t version;
	104	uint8_t size;
	105	uint8_t horiz_pre;
	106	uint8_t vert_pre;
	107	uint32_t latitude;
	108	uint32_t longitude;
	109	uint32_t altitude;
	110	} loc;
42cc2eeb	111
abf126a3 TG	112	struct {
	113	uint16_t key_tag;
	114	uint8_t algorithm;
	115	uint8_t digest_type;
	116	void *digest;
	117	size_t digest_size;
	118	} ds;
	119
549c1a25	120	/* https://tools.ietf.org/html/rfc4255#section-3.1 */
42cc2eeb LP	121	struct {
	122	uint8_t algorithm;
	123	uint8_t fptype;
549c1a25 TG	124	void *fingerprint;
549c1a25 TG	125	size_t fingerprint_size;
42cc2eeb	126	} sshfp;
8db0d2f5 ZJS	127
	128	/* http://tools.ietf.org/html/rfc4034#section-2.1 */
	129	struct {
	130	bool zone_key_flag:1;
	131	bool sep_flag:1;
	132	uint8_t algorithm;
	133	void* key;
	134	size_t key_size;
	135	} dnskey;
151226ab ZJS	136
	137	/* http://tools.ietf.org/html/rfc4034#section-3.1 */
	138	struct {
	139	uint16_t type_covered;
	140	uint8_t algorithm;
	141	uint8_t labels;
	142	uint32_t original_ttl;
	143	uint32_t expiration;
	144	uint32_t inception;
	145	uint16_t key_tag;
	146	char *signer;
	147	void *signature;
	148	size_t signature_size;
	149	} rrsig;
50f1e641 TG	150
	151	struct {
	152	char *next_domain_name;
	153	Bitmap *types;
	154	} nsec;
5d45a880 TG	155
	156	struct {
	157	uint8_t algorithm;
	158	uint8_t flags;
	159	uint16_t iterations;
	160	void *salt;
	161	size_t salt_size;
	162	void *next_hashed_name;
	163	size_t next_hashed_name_size;
	164	Bitmap *types;
	165	} nsec3;
74b2466e LP	166	};
	167	};
	168
faa133f3 LP	169	static inline const char* DNS_RESOURCE_KEY_NAME(const DnsResourceKey *key) {
	170	if (_unlikely_(!key))
	171	return NULL;
	172
	173	if (key->_name)
	174	return key->_name;
	175
	176	return (char*) key + sizeof(DnsResourceKey);
	177	}
74b2466e	178
faa133f3 LP	179	DnsResourceKey* dns_resource_key_new(uint16_t class, uint16_t type, const char *name);
	180	DnsResourceKey* dns_resource_key_new_consume(uint16_t class, uint16_t type, char *name);
	181	DnsResourceKey* dns_resource_key_ref(DnsResourceKey *key);
	182	DnsResourceKey* dns_resource_key_unref(DnsResourceKey *key);
	183	int dns_resource_key_equal(const DnsResourceKey a, const DnsResourceKey b);
	184	int dns_resource_key_match_rr(const DnsResourceKey key, const DnsResourceRecord rr);
	185	int dns_resource_key_match_cname(const DnsResourceKey key, const DnsResourceRecord rr);
2d4c5cbc	186	int dns_resource_key_to_string(const DnsResourceKey key, char *ret);
faa133f3	187	DEFINE_TRIVIAL_CLEANUP_FUNC(DnsResourceKey*, dns_resource_key_unref);
322345fd	188
faa133f3	189	DnsResourceRecord* dns_resource_record_new(DnsResourceKey *key);
8bf52d3d	190	DnsResourceRecord* dns_resource_record_new_full(uint16_t class, uint16_t type, const char *name);
74b2466e LP	191	DnsResourceRecord* dns_resource_record_ref(DnsResourceRecord *rr);
74b2466e LP	192	DnsResourceRecord* dns_resource_record_unref(DnsResourceRecord *rr);
623a4c97	193	int dns_resource_record_new_reverse(DnsResourceRecord *ret, int family, const union in_addr_union address, const char *name);
78c6a153	194	int dns_resource_record_new_address(DnsResourceRecord *ret, int family, const union in_addr_union address, const char *name);
322345fd	195	int dns_resource_record_equal(const DnsResourceRecord a, const DnsResourceRecord b);
2d4c5cbc	196	int dns_resource_record_to_string(const DnsResourceRecord rr, char *ret);
faa133f3	197	DEFINE_TRIVIAL_CLEANUP_FUNC(DnsResourceRecord*, dns_resource_record_unref);
322345fd	198
322345fd	199	const char *dns_class_to_string(uint16_t type);
2d4c5cbc	200	int dns_class_from_string(const char name, uint16_t class);
d5099efc MS	201
d5099efc MS	202	extern const struct hash_ops dns_resource_key_hash_ops;