A DNS Server and Client Implementation in Pure JavaScript with no dependencies.
Features
Server and Client
Lot of Type Supported
Extremely lightweight
DNS over UDP, TCP, HTTPS Supported
Installation
$ npm install dns2
DNS Client (default UDP)
Lookup any records available for the domain lsong.org.
DNS client will use UDP by default.
const dns2 = require('dns2');const options = { // nameServers: ['8.8.8.8'] — array of DNS server IPs (default: Google + 114dns) // port: 53 — DNS server port (number) // recursive: true — Recursion Desired flag (boolean, default true) // timeout: 3000 — per-name-server timeout in milliseconds};const dns = new dns2(options);(async () => { const result = await dns.resolveA('google.com'); console.log(result.answers);})();
The high-level DNS class exposes convenience methods for common record types:
For any record type not listed above, use dns.resolve(domain, 'TYPE') directly.
Every name server is queried in parallel and the first successful reply wins. If
all of them fail, the rejection names each server and its reason.
When a packet fails to decode
Packet.parse throws a Packet.DecodeError when a message cannot be decoded at
all — it is shorter than a 12-octet header, or not a Buffer:
try { Packet.parse(buffer);} catch (err) { // "message is 7 octets, too short for the 12-octet header (RFC 1035 §4.1.1)" console.error(err.message);}
Once the header decodes, a malformed record no longer disappears silently.
Records that cannot be decoded are dropped — a half-populated record would be
worse than none — and the reason is reported on packet.errors:
const packet = Packet.parse(buffer);for (const err of packet.errors) { console.error(err.message); // "answers[0] at offset 12: TXT decode: character-string of 10 octets // overruns RDATA (4 octets remaining)" err.section; // 'questions' | 'answers' | 'authorities' | 'additionals' err.index; // position within that section err.offset; // octet offset in the message where the record started err.recovered; // see below}
packet.errors is empty for a clean parse, so packet.errors.length is the test
for "did anything go wrong". Comparing a section's length against its header
count (packet.answers.length vs packet.header.ancount) shows how much of the
message survived.
err.recovered distinguishes the two kinds of failure:
true — the damage was confined to one record's RDATA. RDLENGTH says where
the next record begins, so decoding continued and later records are intact.
false — the failure left the reader misaligned (a truncated message, or a
name that ran off the end). Nothing after that point can be located, so
decoding stopped there instead of emitting junk records.
Servers surface the same information. A query that cannot be decoded at all
raises requestError; one that partially decodes reaches the handler with
request.errors populated, which is enough to answer FORMERR if you prefer:
FORMERR says "malformed" in four bits and nothing more. RFC 8914 Extended DNS
Errors add an EDNS option carrying an INFO-CODE plus free-form text, which is
where a decode reason belongs. Packet.EDE.INVALID_DATA (24) is the code for
data that could not be interpreted.
Packet.createErrorResponseFromRequest composes the whole reply:
Extended errors are additive — they annotate a response without changing its
RCODE, and appear on NOERROR responses too. Three details the builder handles:
The option is attached only when the request carried an OPT record
(RFC 8914 §3), since a client that didn't signal EDNS cannot be sent EDNS
options. A request too malformed to have a readable OPT gets a bare RCODE.
An OPT is added regardless when the RCODE exceeds 15, so its high byte
survives serialization — otherwise BADVERS would go out as NOERROR.
extraText is truncated to Packet.EDE_MAX_TEXT (256), because the reply
still has to fit the negotiated UDP payload size.
Packet.EDE holds the full registry of INFO-CODEs and Packet.EDE_NAME maps a
received code back to its name.
Example: SOA record lookup
SOA (Start of Authority) records contain the authoritative zone information for a domain.
If the authoritative nameserver returns the SOA record in the answer section, it will appear
in result.answers. Otherwise check result.authorities.
const dns2 = require('dns2');const dns = new dns2({ nameServers: ['8.8.8.8'] });(async () => { const result = await dns.resolveSOA('google.com'); const soa = result.answers[0] || result.authorities[0]; if (soa) { console.log(soa.primary); // ns1.google.com console.log(soa.admin); // dns-admin.google.com console.log(soa.serial); // zone serial number console.log(soa.refresh); // refresh interval (seconds)
Note that when implementing your own lookups, the contents of the query
will be found in request.questions[0].name.
Responding with DNS Error Codes
Use Packet.RCODE to send standard DNS error responses from your handler:
Constant
Value
Meaning
Packet.RCODE.NOERROR
0
No error
Packet.RCODE.FORMERR
1
Format error
Packet.RCODE.SERVFAIL
2
Server failure
Packet.RCODE.NXDOMAIN
3
Non-existent domain
Packet.RCODE.NOTIMP
4
Not implemented
Packet.RCODE.REFUSED
5
Query refused
Packet.RCODE.YXDOMAIN
6
Name exists when it should not
Codes above 15 do not fit the header's 4-bit RCODE field — their high byte
travels in an OPT record's TTL (RFC 6891 §6.1.3), so a response using one must
carry an OPT. Packet.createErrorResponseFromRequest attaches one for you.
Note that 16 has two names in the IANA registry: they share the code point on
the wire, and only context distinguishes them.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.