@olliv/bindns

Fast DNS library, server and client for Node.js based on libbind-6

Showing:

Popularity

Downloads/wk

3

GitHub Stars

15

Maintenance

Last Commit

1yr ago

Contributors

12

Package

Dependencies

0

Size (min+gzip)

9.3KB

License

ISC

Type Definitions

Tree-Shakeable

No?

Categories

Readme

bindns: Fast DNS library, server and client for Node.js based on libbind-6

A DNS client and server built from a port of libbind with zero dependencies. It's very fast: it has about the same throughput as a server written with the evldns C library (~50k QPS on a 4.0 GHz i7-6700k CPU), and given that it's a port of libbind, hopefully it's low on bugs.

See history at the bottom for info on all of the forks of ndns and how this library came to be. See CHANGELOG.md for recent changes.

This module isn't published to npm yet, so install it from github: yarn add primitybio/bindns.

Example

An example DNS server which responds with a "Hello World" TXT record:

const bindns = require("bindns");

const server = new bindns.Server("udp4", (req, res) => {
    res.header.aa = 1; // Authoritative for this zone.
    res.header.rcode = bindns.ns_rcode.noerror; // NOERROR response code
    res.addRR(
        bindns.ns_sect.an,    // answer section
        req.question[0].name, // host name
        bindns.ns_type.txt,   // TXT record
        bindns.ns_class.in,   // IN
        3600,                 // TTL
        "hello, world"        // data
    );
    res.send();
});

server.on("listening", () => console.log("Server running at 0.0.0.0:5300"));

server.bind(5300);

See the examples folder for two additional examples.

API

DNS request and response messages are represented by an object like this:

ServerRequest {
    header: MessageHeader {
        id: 39545,
        qr: 0,
        opcode: 0,
        aa: 0,
        tc: 0,
        rd: 1,
        ra: 0,
        z: 0,
        ad: 0,
        cd: 0,
        rcode: 0,
        qdcount: 1,
        ancount: 0,
        nscount: 0,
        arcount: 1
    },
    question: [
        MessageQuestion {
            name: "example.com",
            type: 1,
            class: 1
        }
    ],
    answer: [],
    authoritative: [],
    additional: [
        MessageRR {
            name: ".",
            type: 41,
            class: 4096,
            ttl: 0,
            rdata: [ ... ]
        }
    ],
    socket: dgram.Socket { ... },
    rinfo: {
        address: "127.0.0.1",
        family: "IPv4",
        port: 52289,
        size: 41
    }
})

There are several enums that you need to construct a response, including the common ones listed below. See [lib/nameser.js] for the full list.

  • ns_rcode - Response codes
  • ns_sect - Section constants
  • ns_class - Values for the class field
  • ns_type - Values for the type field. To convert an ns_type number to its corresponding string, use ns_type_str(ns_type_t).
  • ns_flag - Flag constants

Server

new Server(type: "udp4"|"udp6", listener?: (req, res) => void)
  • listener - Optional listener for the "request" event.

Event: "request"

function (request: ServerRequest, response: ServerResponse) {}

Emitted when the server receives a request. Add your response to the response object.

Event: "listening"

Inherited from dgram.Socket.

Event: "close"

Inherited from dgram.Socket.

Event: "error"

Inherited from dgram.Socket.

ServerRequest

This object is created internally by a DNS server as the result of a DNS query, not by the user, and passed as the first argument to a 'request' listener. Note: answer, authoritative and additional properties are present, but are meaningless in queries.

This object is an instance of MessageHeader. Properties:

  • id (read-only) ID of query.
  • qr (read-only) Query/response flag.
  • opcode (read-only) Operation code (one of ns_opcode).
  • aa (N/A for queries) Authoritative answer.
  • tc (N/A for queries) Truncation flag.
  • rd (read-only) Recursion desired.
  • ra (N/A for queries) Recursion available.
  • z (read-only) Three bits set to zero.
  • ad (N/A for queries) Authentic data (DNSSEC).
  • cd (read-only) Checking disabled (DNSSEC).
  • rcode Response code (one of ns_rcode).
  • qdcount, ancount, nscount and arcount (read-only) The number of questions, answers, name servers and additional records, respectively. Only qdcount should be non-zero for queries.

question

An array of MessageQuestions.

ServerResponse

This object is created internally by a DNS server, not by the user. It is passed as the second argument to the 'request' event.

header

This object is an instance of MessageHeader. Properties:

  • id (read-only) ID of query, copied from the request.
  • qr (read-only) Query/response flag, set to 1 for responses.
  • opcode (read-only) Operation code, copied from the request (one of ns_opcode).
  • aa Authoritative answer.
  • tc Truncation flag.
  • rd (read-only) Recursion desired, copied from the request.
  • ra Recursion available.
  • z (read-only) Three bits set to zero.
  • ad Authentic data (DNSSEC).
  • cd (read-only) Checking disabled (DNSSEC), copied from the request.
  • rcode Response code (one of ns_rcode).
  • qdcount, ancount, nscount and arcount (read-only) The number of questions, answers, name servers and additional records, respectively. These are incremented when you call response.addRR().

answer

An array of MessageRRs.

authoritative

An array of MessageRRs.

additional

An array of MessageRRs.

addRR()

Adds an RR to the message.

res.addRR(sect: number, name: string, type: number, klass: number, ttl: number, ...info: string[])
  • sect - An ns_sect value.
  • name - Hostname.
  • type - An ns_type value.
  • klass - An ns_class value.
  • ttl - TTL.
  • info - Response information (e.g. IP addresses).

send()

Sends the response.

Client

Client for making DNS lookup requests

See examples/simple-client.js for an example usage.

new Client(type: "udp4"|"udp6" = "udp4", responseListener?: (res: ClientResponse) => void)
  • type - UDP socket type.
  • responseListener - Optional listener for "response" events.

Event: "response"

on("response", (err: Error|null, res?: ClientResponse) => {})

Emitted on every response. You do not need to listen to this if you add response listeners to your requests.

Event: "error"

on("error", (err: Error) => {})

Emitted when a request that does not have a response listener times out, or when the underlying socket has an error.

request()

Creates a new ClientRequest.

client.request(port: number, address: string, cb: RequestCallback): ClientRequest;
client.request(options: RequestOptions, cb: RequestCallback): ClientRequest;
  • port - Port of DNS server to query.
  • address - Address of DNS server to query.
  • cb - Request callback containing response.

bind()

Binds the socket so it can listen for responses. This must be called before sending a request.

client.bind(port?: number, address?: string)
  • port - If not specified or if 0, will bind a random port.
  • address - If not specified, will listen on all addresses.

close()

Closes the client. You must call this to allow Node.js to exit.

client.close()

ClientRequest

This object is created by client.request(port, host, callback).

header

This object is an instance of MessageHeader. Properties:

  • id (read-only) ID of query.
  • qr (read-only) Query/response flag.
  • opcode Operation code (one of ns_opcode).
  • aa (N/A for queries) Authoritative answer.
  • tc (N/A for queries) Truncation flag.
  • rd Recursion desired. It is typical to set this flag.
  • ra (N/A for queries) Recursion available.
  • z (read-only) Three bits set to zero.
  • ad (N/A for queries) Authentic data (DNSSEC).
  • cd (read-only) Checking disabled (DNSSEC).
  • rcode (N/A for queries) Response code (one of ns_rcode).
  • qdcount, ancount, nscount and arcount (read-only) The number of questions, answers, name servers and additional records, respectively. Only qdcount should be non-zero for queries.

addQuestion()

Adds a question.

req.addQuestion(qname: string, qtype: number, qclass?: number)
  • qname - Query hostname.
  • qtype - Query type. Must be a value from bindns.ns_type.
  • qclass - Optional query class. Must be a value from bindns.ns_class. Defaults to in.

send()

Sends the request.

Utilities

getRcodeError()

Returns a descriptive error for the RCODE of the response. Only those codes in RFC1035 and RFC6891 (EDNS) are handled. If the RCODE is 0 (no error), returns undefined.

DnsError extends Error and includes a code property that will not change across semver minor versions.

getRcodeError(response: ClientResponse): DnsError

Benchmarks and Other Libraries

Check out https://github.com/zbjornson/node-dnsperf for benchmarking.

LibraryThroughput (QPS)Latency (ms)Notes
this library50,2951.9
https://github.com/raybellis/evldns50,5701.9C library
https://github.com/tjfontaine/node-dns
(published to npm as native-dns)
35,0422.8Working. No longer maintained. Many forks exist.
https://github.com/trevoro/node-named
or the fork
https://github.com/kaija/dns-express
24,3004.1Some bugs and not a lot of maintenance activity.
https://github.com/jhs/dnsd18,0005.7Working and simple, but doesn't appear to be maintained.
https://github.com/chjj/bns12,9006.9Not fully working

To-Do List and Technical Details

  • There is no TCP fallback support.
  • I haven't looked yet if the truncation flag is set automatically on overflow.
  • Improve test suite (see test.js for info).
  • DNSSEC - the flags are here for it, but I've never used it and don't know what a full implementation looks like.

History

As far as I can tell... the original source of this was jsjohnst/ndns. The ndns module published to npm is from someone named "skmplr" or "skampler" (can't find their source repo). The fork at atrniv/ndns has some changes to the original source.

This module pulls from all three, and has some additional significant changes:

  • Code organization, ES6-ification, JSDoc.
    • Split code into separate files, following the organization of libbind.
    • Restored some of the names back to the original ones used in libbind (e.g. ns_f -> ns_flag).
    • Added JSDoc with type annotations, taking from libbind. VSCode's analyzer reports no type errors.
  • Code errors fixed.
    • errno consistently set to numbers.
    • Remove use of reserved word class.
    • Remove usage of node's deprecated sys module.
    • Remove freelist dependency.
    • Some typos ("authorative" -> "authoritative", "buffer.Length" -> "buffer.length")
    • ClientRequest sets an ID automatically.
    • ClientRequest increments qdcount automatically when adding a question.
    • client.request now accepts a callback. While you can still listen to the "response" event on the client, I'm not sure what the utility would be. Might remove that functionality.
    • Don't make globals.
    • Fix possible infinite loop (https://github.com/primitybio/bindns/issues/1).
  • Docs and examples updated.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100