Skip to content

Commit 5c570db

Browse files
WyriHaximusWyriHaximus
authored
Merge pull request #104 from clue-labs/any
Add support for Message::TYPE_ANY, support parsing NS records and parse unknown types as binary data
2 parents 75ae328 + 77f8d0a commit 5c570db

6 files changed

Lines changed: 145 additions & 3 deletions

File tree

examples/04-query-a-and-aaaa.php renamed to examples/10-query-a-and-aaaa.php

File renamed without changes.

‎examples/11-query-any.php‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<?php
2+
3+
use React\Dns\Model\Message;
4+
use React\Dns\Model\Record;
5+
use React\Dns\Query\Query;
6+
use React\Dns\Query\UdpTransportExecutor;
7+
use React\EventLoop\Factory;
8+
9+
require __DIR__ . '/../vendor/autoload.php';
10+
11+
$loop = Factory::create();
12+
$executor = new UdpTransportExecutor($loop);
13+
14+
$name = isset($argv[1]) ? $argv[1] : 'google.com';
15+
16+
$any = new Query($name, Message::TYPE_ANY, Message::CLASS_IN);
17+
18+
$executor->query('8.8.8.8:53', $any)->then(function (Message $message) {
19+
foreach ($message->answers as $answer) {
20+
/* @var $answer Record */
21+
22+
$data = $answer->data;
23+
24+
switch ($answer->type) {
25+
case Message::TYPE_A:
26+
$type = 'A';
27+
break;
28+
case Message::TYPE_AAAA:
29+
$type = 'AAAA';
30+
break;
31+
case Message::TYPE_NS:
32+
$type = 'NS';
33+
break;
34+
case Message::TYPE_PTR:
35+
$type = 'PTR';
36+
break;
37+
case Message::TYPE_CNAME:
38+
$type = 'CNAME';
39+
break;
40+
default:
41+
// unknown type uses HEX format
42+
$type = 'Type ' . $answer->type;
43+
$data = wordwrap(strtoupper(bin2hex($data)), 2, ' ', true);
44+
}
45+
46+
echo $type . ': ' . $data . PHP_EOL;
47+
}
48+
}, 'printf');
49+
50+
$loop->run();

‎src/Model/Message.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ class Message
1414
const TYPE_MX = 15;
1515
const TYPE_TXT = 16;
1616
const TYPE_AAAA = 28;
17+
const TYPE_ANY = 255;
1718

1819
const CLASS_IN = 1;
1920

‎src/Model/Record.php‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,49 @@
44

55
class Record
66
{
7+
/**
8+
* @var string hostname without trailing dot, for example "reactphp.org"
9+
*/
710
public $name;
11+
12+
/**
13+
* @var int see Message::TYPE_* constants (UINT16)
14+
*/
815
public $type;
16+
17+
/**
18+
* @var int see Message::CLASS_IN constant (UINT16)
19+
*/
920
public $class;
21+
22+
/**
23+
* @var int maximum TTL in seconds (UINT16)
24+
*/
1025
public $ttl;
26+
27+
/**
28+
* The payload data for this record
29+
*
30+
* The payload data format depends on the record type. As a rule of thumb,
31+
* this library will try to express this in a way that can be consumed
32+
* easily without having to worry about DNS internals and its binary transport:
33+
*
34+
* - A:
35+
* IPv4 address string, for example "192.168.1.1".
36+
* - AAAA:
37+
* IPv6 address string, for example "::1".
38+
* - CNAME / PTR / NS:
39+
* The hostname without trailing dot, for example "reactphp.org".
40+
* - Any other unknown type:
41+
* An opaque binary string containing the RDATA as transported in the DNS
42+
* record. For forwards compatibility, you should not rely on this format
43+
* for unknown types. Future versions may add support for new types and
44+
* this may then parse the payload data appropriately - this will not be
45+
* considered a BC break. See the format definition of known types above
46+
* for more details.
47+
*
48+
* @var string
49+
*/
1150
public $data;
1251

1352
public function __construct($name, $type, $class, $ttl = 0, $data = null)

‎src/Protocol/Parser.php‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,12 +164,14 @@ public function parseAnswer(Message $message)
164164
$consumed += $rdLength;
165165

166166
$rdata = inet_ntop($ip);
167-
}
168-
169-
if (Message::TYPE_CNAME === $type || Message::TYPE_PTR === $type) {
167+
} elseif (Message::TYPE_CNAME === $type || Message::TYPE_PTR === $type || Message::TYPE_NS === $type) {
170168
list($bodyLabels, $consumed) = $this->readLabels($message->data, $consumed);
171169

172170
$rdata = implode('.', $bodyLabels);
171+
} else {
172+
// unknown types simply parse rdata as an opaque binary string
173+
$rdata = substr($message->data, $consumed, $rdLength);
174+
$consumed += $rdLength;
173175
}
174176

175177
$message->consumed = $consumed;

‎tests/Protocol/ParserTest.php‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,31 @@ public function testParseAnswerWithInlineData()
157157
$this->assertSame('178.79.169.131', $response->answers[0]->data);
158158
}
159159

160+
public function testParseAnswerWithUnknownType()
161+
{
162+
$data = "";
163+
$data .= "04 69 67 6f 72 02 69 6f 00"; // answer: igor.io
164+
$data .= "23 28 00 01"; // answer: type 9000, class IN
165+
$data .= "00 01 51 80"; // answer: ttl 86400
166+
$data .= "00 05"; // answer: rdlength 5
167+
$data .= "68 65 6c 6c 6f"; // answer: rdata "hello"
168+
169+
$data = $this->convertTcpDumpToBinary($data);
170+
171+
$response = new Message();
172+
$response->header->set('anCount', 1);
173+
$response->data = $data;
174+
175+
$this->parser->parseAnswer($response);
176+
177+
$this->assertCount(1, $response->answers);
178+
$this->assertSame('igor.io', $response->answers[0]->name);
179+
$this->assertSame(9000, $response->answers[0]->type);
180+
$this->assertSame(Message::CLASS_IN, $response->answers[0]->class);
181+
$this->assertSame(86400, $response->answers[0]->ttl);
182+
$this->assertSame('hello', $response->answers[0]->data);
183+
}
184+
160185
public function testParseResponseWithCnameAndOffsetPointers()
161186
{
162187
$data = "";
@@ -273,6 +298,31 @@ public function testParseResponseWithTwoAnswers()
273298
$this->assertSame('193.223.78.152', $response->answers[1]->data);
274299
}
275300

301+
public function testParseNSResponse()
302+
{
303+
$data = "";
304+
$data .= "04 69 67 6f 72 02 69 6f 00"; // answer: igor.io
305+
$data .= "00 02 00 01"; // answer: type NS, class IN
306+
$data .= "00 01 51 80"; // answer: ttl 86400
307+
$data .= "00 07"; // answer: rdlength 7
308+
$data .= "05 68 65 6c 6c 6f 00"; // answer: rdata hello
309+
310+
$data = $this->convertTcpDumpToBinary($data);
311+
312+
$response = new Message();
313+
$response->header->set('anCount', 1);
314+
$response->data = $data;
315+
316+
$this->parser->parseAnswer($response);
317+
318+
$this->assertCount(1, $response->answers);
319+
$this->assertSame('igor.io', $response->answers[0]->name);
320+
$this->assertSame(Message::TYPE_NS, $response->answers[0]->type);
321+
$this->assertSame(Message::CLASS_IN, $response->answers[0]->class);
322+
$this->assertSame(86400, $response->answers[0]->ttl);
323+
$this->assertSame('hello', $response->answers[0]->data);
324+
}
325+
276326
public function testParsePTRResponse()
277327
{
278328
$data = "";

0 commit comments

Comments
 (0)