1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
|
/*
* Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
*
* Portions copyright (C) 2004 Anselm M. Hoffmeister
* <stockholm@users.sourceforge.net>.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or any later version.
*
* This program 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
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
FILE_LICENCE ( GPL2_OR_LATER );
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <errno.h>
#include <byteswap.h>
#include <gpxe/refcnt.h>
#include <gpxe/xfer.h>
#include <gpxe/open.h>
#include <gpxe/resolv.h>
#include <gpxe/retry.h>
#include <gpxe/tcpip.h>
#include <gpxe/settings.h>
#include <gpxe/features.h>
#include <gpxe/dns.h>
/** @file
*
* DNS protocol
*
*/
FEATURE ( FEATURE_PROTOCOL, "DNS", DHCP_EB_FEATURE_DNS, 1 );
/** The DNS server */
static struct sockaddr_tcpip nameserver = {
.st_port = htons ( DNS_PORT ),
};
/** The local domain */
static char *localdomain;
/** A DNS request */
struct dns_request {
/** Reference counter */
struct refcnt refcnt;
/** Name resolution interface */
struct resolv_interface resolv;
/** Data transfer interface */
struct xfer_interface socket;
/** Retry timer */
struct retry_timer timer;
/** Socket address to fill in with resolved address */
struct sockaddr sa;
/** Current query packet */
struct dns_query query;
/** Location of query info structure within current packet
*
* The query info structure is located immediately after the
* compressed name.
*/
struct dns_query_info *qinfo;
/** Recursion counter */
unsigned int recursion;
};
/**
* Mark DNS request as complete
*
* @v dns DNS request
* @v rc Return status code
*/
static void dns_done ( struct dns_request *dns, int rc ) {
/* Stop the retry timer */
stop_timer ( &dns->timer );
/* Close data transfer interface */
xfer_nullify ( &dns->socket );
xfer_close ( &dns->socket, rc );
/* Mark name resolution as complete */
resolv_done ( &dns->resolv, &dns->sa, rc );
}
/**
* Compare DNS reply name against the query name from the original request
*
* @v dns DNS request
* @v reply DNS reply
* @v rname Reply name
* @ret zero Names match
* @ret non-zero Names do not match
*/
static int dns_name_cmp ( struct dns_request *dns,
const struct dns_header *reply,
const char *rname ) {
const char *qname = dns->query.payload;
int i;
while ( 1 ) {
/* Obtain next section of rname */
while ( ( *rname ) & 0xc0 ) {
rname = ( ( ( char * ) reply ) +
( ntohs( *((uint16_t *)rname) ) & ~0xc000 ));
}
/* Check that lengths match */
if ( *rname != *qname )
return -1;
/* If length is zero, we have reached the end */
if ( ! *qname )
return 0;
/* Check that data matches */
for ( i = *qname + 1; i > 0 ; i-- ) {
if ( *(rname++) != *(qname++) )
return -1;
}
}
}
/**
* Skip over a (possibly compressed) DNS name
*
* @v name DNS name
* @ret name Next DNS name
*/
static const char * dns_skip_name ( const char *name ) {
while ( 1 ) {
if ( ! *name ) {
/* End of name */
return ( name + 1);
}
if ( *name & 0xc0 ) {
/* Start of a compressed name */
return ( name + 2 );
}
/* Uncompressed name portion */
name += *name + 1;
}
}
/**
* Find an RR in a reply packet corresponding to our query
*
* @v dns DNS request
* @v reply DNS reply
* @ret rr DNS RR, or NULL if not found
*/
static union dns_rr_info * dns_find_rr ( struct dns_request *dns,
const struct dns_header *reply ) {
int i, cmp;
const char *p = ( ( char * ) reply ) + sizeof ( struct dns_header );
union dns_rr_info *rr_info;
/* Skip over the questions section */
for ( i = ntohs ( reply->qdcount ) ; i > 0 ; i-- ) {
p = dns_skip_name ( p ) + sizeof ( struct dns_query_info );
}
/* Process the answers section */
for ( i = ntohs ( reply->ancount ) ; i > 0 ; i-- ) {
cmp = dns_name_cmp ( dns, reply, p );
p = dns_skip_name ( p );
rr_info = ( ( union dns_rr_info * ) p );
if ( cmp == 0 )
return rr_info;
p += ( sizeof ( rr_info->common ) +
ntohs ( rr_info->common.rdlength ) );
}
return NULL;
}
/**
* Append DHCP domain name if available and name is not fully qualified
*
* @v string Name as a NUL-terminated string
* @ret fqdn Fully-qualified domain name, malloc'd copy
*
* The caller must free fqdn which is allocated even if the name is already
* fully qualified.
*/
static char * dns_qualify_name ( const char *string ) {
char *fqdn;
/* Leave unchanged if already fully-qualified or no local domain */
if ( ( ! localdomain ) || ( strchr ( string, '.' ) != 0 ) )
return strdup ( string );
/* Append local domain to name */
return grub_xasprintf ( "%s.%s", string, localdomain );
}
/**
* Convert a standard NUL-terminated string to a DNS name
*
* @v string Name as a NUL-terminated string
* @v buf Buffer in which to place DNS name
* @ret next Byte following constructed DNS name
*
* DNS names consist of "<length>element" pairs.
*/
static char * dns_make_name ( const char *string, char *buf ) {
char *length_byte = buf++;
char c;
while ( ( c = *(string++) ) ) {
if ( c == '.' ) {
*length_byte = buf - length_byte - 1;
length_byte = buf;
}
*(buf++) = c;
}
*length_byte = buf - length_byte - 1;
*(buf++) = '\0';
return buf;
}
/**
* Convert an uncompressed DNS name to a NUL-terminated string
*
* @v name DNS name
* @ret string NUL-terminated string
*
* Produce a printable version of a DNS name. Used only for debugging.
*/
static inline char * dns_unmake_name ( char *name ) {
char *p;
unsigned int len;
p = name;
while ( ( len = *p ) ) {
*(p++) = '.';
p += len;
}
return name + 1;
}
/**
* Decompress a DNS name
*
* @v reply DNS replay
* @v name DNS name
* @v buf Buffer into which to decompress DNS name
* @ret next Byte following decompressed DNS name
*/
static char * dns_decompress_name ( const struct dns_header *reply,
const char *name, char *buf ) {
int i, len;
do {
/* Obtain next section of name */
while ( ( *name ) & 0xc0 ) {
name = ( ( char * ) reply +
( ntohs ( *((uint16_t *)name) ) & ~0xc000 ) );
}
/* Copy data */
len = *name;
for ( i = len + 1 ; i > 0 ; i-- ) {
*(buf++) = *(name++);
}
} while ( len );
return buf;
}
/**
* Send next packet in DNS request
*
* @v dns DNS request
*/
static int dns_send_packet ( struct dns_request *dns ) {
static unsigned int qid = 0;
size_t qlen;
/* Increment query ID */
dns->query.dns.id = htons ( ++qid );
DBGC ( dns, "DNS %p sending query ID %d\n", dns, qid );
/* Start retransmission timer */
start_timer ( &dns->timer );
/* Send the data */
qlen = ( ( ( void * ) dns->qinfo ) - ( ( void * ) &dns->query )
+ sizeof ( dns->qinfo ) );
return xfer_deliver_raw ( &dns->socket, &dns->query, qlen );
}
/**
* Handle DNS retransmission timer expiry
*
* @v timer Retry timer
* @v fail Failure indicator
*/
static void dns_timer_expired ( struct retry_timer *timer, int fail ) {
struct dns_request *dns =
container_of ( timer, struct dns_request, timer );
if ( fail ) {
dns_done ( dns, -ETIMEDOUT );
} else {
dns_send_packet ( dns );
}
}
/**
* Receive new data
*
* @v socket UDP socket
* @v data DNS reply
* @v len Length of DNS reply
* @ret rc Return status code
*/
static int dns_xfer_deliver_raw ( struct xfer_interface *socket,
const void *data, size_t len ) {
struct dns_request *dns =
container_of ( socket, struct dns_request, socket );
const struct dns_header *reply = data;
union dns_rr_info *rr_info;
struct sockaddr_in *sin;
unsigned int qtype = dns->qinfo->qtype;
/* Sanity check */
if ( len < sizeof ( *reply ) ) {
DBGC ( dns, "DNS %p received underlength packet length %zd\n",
dns, len );
return -EINVAL;
}
/* Check reply ID matches query ID */
if ( reply->id != dns->query.dns.id ) {
DBGC ( dns, "DNS %p received unexpected reply ID %d "
"(wanted %d)\n", dns, ntohs ( reply->id ),
ntohs ( dns->query.dns.id ) );
return -EINVAL;
}
DBGC ( dns, "DNS %p received reply ID %d\n", dns, ntohs ( reply->id ));
/* Stop the retry timer. After this point, each code path
* must either restart the timer by calling dns_send_packet(),
* or mark the DNS operation as complete by calling
* dns_done()
*/
stop_timer ( &dns->timer );
/* Search through response for useful answers. Do this
* multiple times, to take advantage of useful nameservers
* which send us e.g. the CNAME *and* the A record for the
* pointed-to name.
*/
while ( ( rr_info = dns_find_rr ( dns, reply ) ) ) {
switch ( rr_info->common.type ) {
case htons ( DNS_TYPE_A ):
/* Found the target A record */
DBGC ( dns, "DNS %p found address %s\n",
dns, inet_ntoa ( rr_info->a.in_addr ) );
sin = ( struct sockaddr_in * ) &dns->sa;
sin->sin_family = AF_INET;
sin->sin_addr = rr_info->a.in_addr;
/* Mark operation as complete */
dns_done ( dns, 0 );
return 0;
case htons ( DNS_TYPE_CNAME ):
/* Found a CNAME record; update query and recurse */
DBGC ( dns, "DNS %p found CNAME\n", dns );
dns->qinfo = ( void * ) dns_decompress_name ( reply,
rr_info->cname.cname,
dns->query.payload );
dns->qinfo->qtype = htons ( DNS_TYPE_A );
dns->qinfo->qclass = htons ( DNS_CLASS_IN );
/* Terminate the operation if we recurse too far */
if ( ++dns->recursion > DNS_MAX_CNAME_RECURSION ) {
DBGC ( dns, "DNS %p recursion exceeded\n",
dns );
dns_done ( dns, -ELOOP );
return 0;
}
break;
default:
DBGC ( dns, "DNS %p got unknown record type %d\n",
dns, ntohs ( rr_info->common.type ) );
break;
}
}
/* Determine what to do next based on the type of query we
* issued and the reponse we received
*/
switch ( qtype ) {
case htons ( DNS_TYPE_A ):
/* We asked for an A record and got nothing;
* try the CNAME.
*/
DBGC ( dns, "DNS %p found no A record; trying CNAME\n", dns );
dns->qinfo->qtype = htons ( DNS_TYPE_CNAME );
dns_send_packet ( dns );
return 0;
case htons ( DNS_TYPE_CNAME ):
/* We asked for a CNAME record. If we got a response
* (i.e. if the next A query is already set up), then
* issue it, otherwise abort.
*/
if ( dns->qinfo->qtype == htons ( DNS_TYPE_A ) ) {
dns_send_packet ( dns );
return 0;
} else {
DBGC ( dns, "DNS %p found no CNAME record\n", dns );
dns_done ( dns, -ENXIO );
return 0;
}
default:
assert ( 0 );
dns_done ( dns, -EINVAL );
return 0;
}
}
/**
* Receive new data
*
* @v socket UDP socket
* @v rc Reason for close
*/
static void dns_xfer_close ( struct xfer_interface *socket, int rc ) {
struct dns_request *dns =
container_of ( socket, struct dns_request, socket );
if ( ! rc )
rc = -ECONNABORTED;
dns_done ( dns, rc );
}
/** DNS socket operations */
static struct xfer_interface_operations dns_socket_operations = {
.close = dns_xfer_close,
.vredirect = xfer_vreopen,
.window = unlimited_xfer_window,
.alloc_iob = default_xfer_alloc_iob,
.deliver_iob = xfer_deliver_as_raw,
.deliver_raw = dns_xfer_deliver_raw,
};
/**
* Resolve name using DNS
*
* @v resolv Name resolution interface
* @v name Name to resolve
* @v sa Socket address to fill in
* @ret rc Return status code
*/
static int dns_resolv ( struct resolv_interface *resolv,
const char *name, struct sockaddr *sa ) {
struct dns_request *dns;
char *fqdn;
int rc;
/* Fail immediately if no DNS servers */
if ( ! nameserver.st_family ) {
DBG ( "DNS not attempting to resolve \"%s\": "
"no DNS servers\n", name );
rc = -ENXIO;
goto err_no_nameserver;
}
/* Ensure fully-qualified domain name if DHCP option was given */
fqdn = dns_qualify_name ( name );
if ( ! fqdn ) {
rc = -ENOMEM;
goto err_qualify_name;
}
/* Allocate DNS structure */
dns = zalloc ( sizeof ( *dns ) );
if ( ! dns ) {
rc = -ENOMEM;
goto err_alloc_dns;
}
resolv_init ( &dns->resolv, &null_resolv_ops, &dns->refcnt );
xfer_init ( &dns->socket, &dns_socket_operations, &dns->refcnt );
dns->timer.expired = dns_timer_expired;
memcpy ( &dns->sa, sa, sizeof ( dns->sa ) );
/* Create query */
dns->query.dns.flags = htons ( DNS_FLAG_QUERY | DNS_FLAG_OPCODE_QUERY |
DNS_FLAG_RD );
dns->query.dns.qdcount = htons ( 1 );
dns->qinfo = ( void * ) dns_make_name ( fqdn, dns->query.payload );
dns->qinfo->qtype = htons ( DNS_TYPE_A );
dns->qinfo->qclass = htons ( DNS_CLASS_IN );
/* Open UDP connection */
if ( ( rc = xfer_open_socket ( &dns->socket, SOCK_DGRAM,
( struct sockaddr * ) &nameserver,
NULL ) ) != 0 ) {
DBGC ( dns, "DNS %p could not open socket: %s\n",
dns, strerror ( rc ) );
goto err_open_socket;
}
/* Send first DNS packet */
dns_send_packet ( dns );
/* Attach parent interface, mortalise self, and return */
resolv_plug_plug ( &dns->resolv, resolv );
ref_put ( &dns->refcnt );
free ( fqdn );
return 0;
err_open_socket:
err_alloc_dns:
ref_put ( &dns->refcnt );
err_qualify_name:
free ( fqdn );
err_no_nameserver:
return rc;
}
/** DNS name resolver */
struct resolver dns_resolver __resolver ( RESOLV_NORMAL ) = {
.name = "DNS",
.resolv = dns_resolv,
};
/******************************************************************************
*
* Settings
*
******************************************************************************
*/
/** DNS server setting */
struct setting dns_setting __setting = {
.name = "dns",
.description = "DNS server",
.tag = DHCP_DNS_SERVERS,
.type = &setting_type_ipv4,
};
/** Domain name setting */
struct setting domain_setting __setting = {
.name = "domain",
.description = "Local domain",
.tag = DHCP_DOMAIN_NAME,
.type = &setting_type_string,
};
/**
* Apply DNS settings
*
* @ret rc Return status code
*/
static int apply_dns_settings ( void ) {
struct sockaddr_in *sin_nameserver =
( struct sockaddr_in * ) &nameserver;
int len;
if ( ( len = fetch_ipv4_setting ( NULL, &dns_setting,
&sin_nameserver->sin_addr ) ) >= 0 ){
sin_nameserver->sin_family = AF_INET;
DBG ( "DNS using nameserver %s\n",
inet_ntoa ( sin_nameserver->sin_addr ) );
}
/* Get local domain DHCP option */
if ( ( len = fetch_string_setting_copy ( NULL, &domain_setting,
&localdomain ) ) >= 0 )
DBG ( "DNS local domain %s\n", localdomain );
return 0;
}
/** DNS settings applicator */
struct settings_applicator dns_applicator __settings_applicator = {
.apply = apply_dns_settings,
};
|