xref: /openbsd-src/lib/libc/asr/asr_private.h (revision abe78e0284f7775d363a13655878a3554e377e0c)
1 /*	$OpenBSD: asr_private.h,v 1.44 2017/02/27 10:44:46 jca Exp $	*/
2 /*
3  * Copyright (c) 2012 Eric Faurot <eric@openbsd.org>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 
18 #include <stdio.h>
19 
20 #define QR_MASK		(0x1 << 15)
21 #define OPCODE_MASK	(0xf << 11)
22 #define AA_MASK		(0x1 << 10)
23 #define TC_MASK		(0x1 <<  9)
24 #define RD_MASK		(0x1 <<  8)
25 #define RA_MASK		(0x1 <<  7)
26 #define Z_MASK		(0x7 <<  4)
27 #define RCODE_MASK	(0xf)
28 
29 #define OPCODE(v)	((v) & OPCODE_MASK)
30 #define RCODE(v)	((v) & RCODE_MASK)
31 
32 
33 struct asr_pack {
34 	char		*buf;
35 	size_t		 len;
36 	size_t		 offset;
37 	int		 err;
38 };
39 
40 struct asr_unpack {
41 	const char	*buf;
42 	size_t		 len;
43 	size_t		 offset;
44 	int		 err;
45 };
46 
47 struct asr_dns_header {
48 	uint16_t	id;
49 	uint16_t	flags;
50 	uint16_t	qdcount;
51 	uint16_t	ancount;
52 	uint16_t	nscount;
53 	uint16_t	arcount;
54 };
55 
56 struct asr_dns_query {
57 	char		q_dname[MAXDNAME];
58 	uint16_t	q_type;
59 	uint16_t	q_class;
60 };
61 
62 struct asr_dns_rr {
63 	char		rr_dname[MAXDNAME];
64 	uint16_t	rr_type;
65 	uint16_t	rr_class;
66 	uint32_t	rr_ttl;
67 	union {
68 		struct {
69 			char	cname[MAXDNAME];
70 		} cname;
71 		struct {
72 			uint16_t	preference;
73 			char		exchange[MAXDNAME];
74 		} mx;
75 		struct {
76 			char	nsname[MAXDNAME];
77 		} ns;
78 		struct {
79 			char	ptrname[MAXDNAME];
80 		} ptr;
81 		struct {
82 			char		mname[MAXDNAME];
83 			char		rname[MAXDNAME];
84 			uint32_t	serial;
85 			uint32_t	refresh;
86 			uint32_t	retry;
87 			uint32_t	expire;
88 			uint32_t	minimum;
89 		} soa;
90 		struct {
91 			struct in_addr	addr;
92 		} in_a;
93 		struct {
94 			struct in6_addr	addr6;
95 		} in_aaaa;
96 		struct {
97 			uint16_t	 rdlen;
98 			const void	*rdata;
99 		} other;
100 	} rr;
101 };
102 
103 
104 #define ASR_MAXNS	5
105 #define ASR_MAXDB	3
106 #define ASR_MAXDOM	10
107 
108 enum async_type {
109 	ASR_SEND,
110 	ASR_SEARCH,
111 	ASR_GETRRSETBYNAME,
112 	ASR_GETHOSTBYNAME,
113 	ASR_GETHOSTBYADDR,
114 	ASR_GETNETBYNAME,
115 	ASR_GETNETBYADDR,
116 	ASR_GETADDRINFO,
117 	ASR_GETNAMEINFO,
118 };
119 
120 #define	ASR_DB_FILE	'f'
121 #define	ASR_DB_DNS	'b'
122 
123 struct asr_ctx {
124 	int		 ac_refcount;
125 	int		 ac_options;
126 	int		 ac_ndots;
127 	char		*ac_domain;
128 	int		 ac_domcount;
129 	char		*ac_dom[ASR_MAXDOM];
130 	int		 ac_dbcount;
131 	char		 ac_db[ASR_MAXDB + 1];
132 	int		 ac_family[3];
133 
134 	int		 ac_nscount;
135 	int		 ac_nstimeout;
136 	int		 ac_nsretries;
137 	struct sockaddr *ac_ns[ASR_MAXNS];
138 
139 };
140 
141 struct asr {
142 	pid_t		 a_pid;
143 	time_t		 a_mtime;
144 	time_t		 a_rtime;
145 	struct asr_ctx	*a_ctx;
146 };
147 
148 #define ASYNC_COND		0
149 #define ASYNC_DONE		1
150 
151 #define	ASYNC_DOM_FQDN		0x00000001
152 #define	ASYNC_DOM_NDOTS		0x00000002
153 #define	ASYNC_DOM_DOMAIN	0x00000004
154 #define ASYNC_DOM_ASIS		0x00000008
155 
156 #define	ASYNC_NODATA		0x00000100
157 #define	ASYNC_AGAIN		0x00000200
158 
159 #define	ASYNC_EXTOBUF		0x00002000
160 
161 #define	ASYNC_NO_INET		0x00010000
162 #define	ASYNC_NO_INET6		0x00020000
163 
164 struct asr_query {
165 	int		(*as_run)(struct asr_query *, struct asr_result *);
166 	struct asr_ctx	*as_ctx;
167 	int		 as_type;
168 	int		 as_flags;
169 	int		 as_state;
170 
171 	/* cond */
172 	int		 as_timeout;
173 	int		 as_fd;
174 	struct asr_query *as_subq;
175 
176 	/* loop indices in ctx */
177 	int		 as_dom_step;
178 	int		 as_dom_idx;
179 	int		 as_dom_flags;
180 	int		 as_family_idx;
181 	int		 as_db_idx;
182 
183 	int		 as_count;
184 
185 	union {
186 		struct {
187 			uint16_t	 reqid;
188 			int		 class;
189 			int		 type;
190 			char		*dname;		/* not fqdn! */
191 			int		 rcode;		/* response code */
192 			int		 ancount;	/* answer count */
193 
194 			int		 nsidx;
195 			int		 nsloop;
196 
197 			/* io buffers for query/response */
198 			unsigned char	*obuf;
199 			size_t		 obuflen;
200 			size_t		 obufsize;
201 			unsigned char	*ibuf;
202 			size_t		 ibuflen;
203 			size_t		 ibufsize;
204 			size_t		 datalen; /* for tcp io */
205 			uint16_t	 pktlen;
206 		} dns;
207 
208 		struct {
209 			int		 class;
210 			int		 type;
211 			char		*name;
212 			int		 saved_h_errno;
213 		} search;
214 
215 		struct {
216 			int		 flags;
217 			int		 class;
218 			int		 type;
219 			char		*name;
220 		} rrset;
221 
222 		struct {
223 			char		*name;
224 			int		 family;
225 			char		 addr[16];
226 			int		 addrlen;
227 			int		 subq_h_errno;
228 		} hostnamadr;
229 
230 		struct {
231 			char		*name;
232 			int		 family;
233 			in_addr_t	 addr;
234 		} netnamadr;
235 
236 		struct {
237 			char		*hostname;
238 			char		*servname;
239 			int		 port_tcp;
240 			int		 port_udp;
241 			union {
242 				struct sockaddr		sa;
243 				struct sockaddr_in	sain;
244 				struct sockaddr_in6	sain6;
245 			}		 sa;
246 
247 			struct addrinfo	 hints;
248 			char		*fqdn;
249 			struct addrinfo	*aifirst;
250 			struct addrinfo	*ailast;
251 		} ai;
252 
253 		struct {
254 			char		*hostname;
255 			char		*servname;
256 			size_t		 hostnamelen;
257 			size_t		 servnamelen;
258 			union {
259 				struct sockaddr		sa;
260 				struct sockaddr_in	sain;
261 				struct sockaddr_in6	sain6;
262 			}		 sa;
263 			int		 flags;
264 		} ni;
265 #define MAXTOKEN 10
266 	} as;
267 
268 };
269 
270 #define AS_DB(p) ((p)->as_ctx->ac_db[(p)->as_db_idx - 1])
271 #define AS_FAMILY(p) ((p)->as_ctx->ac_family[(p)->as_family_idx])
272 
273 enum asr_state {
274 	ASR_STATE_INIT,
275 	ASR_STATE_NEXT_DOMAIN,
276 	ASR_STATE_NEXT_DB,
277 	ASR_STATE_SAME_DB,
278 	ASR_STATE_NEXT_FAMILY,
279 	ASR_STATE_NEXT_NS,
280 	ASR_STATE_UDP_SEND,
281 	ASR_STATE_UDP_RECV,
282 	ASR_STATE_TCP_WRITE,
283 	ASR_STATE_TCP_READ,
284 	ASR_STATE_PACKET,
285 	ASR_STATE_SUBQUERY,
286 	ASR_STATE_NOT_FOUND,
287 	ASR_STATE_HALT,
288 };
289 
290 #define MAXPACKETSZ	4096
291 
292 __BEGIN_HIDDEN_DECLS
293 
294 /* asr_utils.c */
295 void _asr_pack_init(struct asr_pack *, char *, size_t);
296 int _asr_pack_header(struct asr_pack *, const struct asr_dns_header *);
297 int _asr_pack_query(struct asr_pack *, uint16_t, uint16_t, const char *);
298 int _asr_pack_edns0(struct asr_pack *, uint16_t);
299 void _asr_unpack_init(struct asr_unpack *, const char *, size_t);
300 int _asr_unpack_header(struct asr_unpack *, struct asr_dns_header *);
301 int _asr_unpack_query(struct asr_unpack *, struct asr_dns_query *);
302 int _asr_unpack_rr(struct asr_unpack *, struct asr_dns_rr *);
303 int _asr_sockaddr_from_str(struct sockaddr *, int, const char *);
304 ssize_t _asr_dname_from_fqdn(const char *, char *, size_t);
305 ssize_t _asr_addr_as_fqdn(const char *, int, char *, size_t);
306 
307 /* asr.c */
308 void _asr_resolver_done(void *);
309 struct asr_ctx *_asr_use_resolver(void *);
310 struct asr_ctx *_asr_no_resolver(void);
311 void _asr_ctx_unref(struct asr_ctx *);
312 struct asr_query *_asr_async_new(struct asr_ctx *, int);
313 void _asr_async_free(struct asr_query *);
314 size_t _asr_make_fqdn(const char *, const char *, char *, size_t);
315 char *_asr_strdname(const char *, char *, size_t);
316 int _asr_iter_db(struct asr_query *);
317 int _asr_parse_namedb_line(FILE *, char **, int, char *, size_t);
318 
319 /* *_async.c */
320 struct asr_query *_res_query_async_ctx(const char *, int, int, struct asr_ctx *);
321 struct asr_query *_res_search_async_ctx(const char *, int, int, struct asr_ctx *);
322 struct asr_query *_gethostbyaddr_async_ctx(const void *, socklen_t, int,
323     struct asr_ctx *);
324 
325 int _asr_iter_domain(struct asr_query *, const char *, char *, size_t);
326 
327 #ifdef DEBUG
328 
329 #define DPRINT(...)		do { if(_asr_debug) {		\
330 		fprintf(_asr_debug, __VA_ARGS__);		\
331 	} } while (0)
332 #define DPRINT_PACKET(n, p, s)	do { if(_asr_debug) {		\
333 		fprintf(_asr_debug, "----- %s -----\n", n);	\
334 		_asr_dump_packet(_asr_debug, (p), (s));		\
335 		fprintf(_asr_debug, "--------------\n");		\
336 	} } while (0)
337 
338 #else /* DEBUG */
339 
340 #define DPRINT(...)
341 #define DPRINT_PACKET(...)
342 
343 #endif /* DEBUG */
344 
345 const char *_asr_querystr(int);
346 const char *_asr_statestr(int);
347 const char *_asr_transitionstr(int);
348 const char *_asr_print_sockaddr(const struct sockaddr *, char *, size_t);
349 void _asr_dump_config(FILE *, struct asr *);
350 void _asr_dump_packet(FILE *, const void *, size_t);
351 
352 extern FILE *_asr_debug;
353 
354 #define async_set_state(a, s) do {		\
355 	DPRINT("asr: [%s@%p] %s -> %s\n",	\
356 		_asr_querystr((a)->as_type),	\
357 		as,				\
358 		_asr_statestr((a)->as_state),	\
359 		_asr_statestr((s)));		\
360 	(a)->as_state = (s); } while (0)
361 
362 __END_HIDDEN_DECLS
363