@i2labs/dns

Dependency free, browser compatible, NodeJS dns library replacement. Implements RFC8484 and RFC1035. Supports most DNS over HTTPS servers.

Why would you want to make DNS requests from a browser? DNS has numerous functions other than mapping domain names to IP addresses. SRV and TXT records offer the ability to do service discovery and distribute information such as public keys.

This library uses AbortController, which is not compatible with Internet Explorer. A polyfill may be available, but is not included.

See the NodeJS dns documentation for information on how to use this library. The caveats mentioned in the documentation regarding lookup, lookupService and reverse do not apply. These functions call system operations not available to the browser. In this implementation lookup simply aliases resolve, lookupService and reverse will throw errors when called. hints and verbatim arguments of lookup are ignored. The errors are thrown in a way that any proper error handling that would normally be present while using the NodeJS dns library should also handle these errors. setLocalAddress is a no-op function. getServers and setServers return/accept a list of strings containing the hostnames of the 'DNS over HTTPS' providers that the resolver makes requests against.

Resolver.resolve() is extended to support most record types. If you want to bypass the modifications made to the response values by the NodeJS dns specification, you can pass {raw: true} in the options object argument to get the full response object. A best attempt to parse record data as much as possible was made. Due to an inconsistent mix of available documentation for the record type data layouts, not all are complete. See rfc_rdata.ts for the RDATA layout descriptions. Any type that is marked as 'opaque' may change in the future with contributions to extend the parsing of that record type.

This library is able to function by using any 'DNS over HTTPS' services. The default resolver host is CloudFlare using cloudflare-dns.com. Support for any of the providers listed under 'DNS over HTTPS' at https://en.wikipedia.org/wiki/Public_recursive_name_server can be added. Currently, only providers (most of them) that implement RFC8484 are supported. Contributions are welcome.

dns.Resolver is implemented as a wrapper around the Promise based resolvers to support the callback interface. Pass an instantiated Promise resolver to the constructor to wrap different provider resolvers:

import dns from 'dns'
import RFCResolver from 'dns/rfc8484'

const resolver = new dns.Resolver(new RFCResolver({timeout: 30}));

All methods exported by the library use the RFC8484 resolver. Instantiate a resolver imported for the specific provider submodule to use that provider. class Resolver implementations export lookup and lookupService in addition to the methods defined in the NodeJS dns documentation.

Use

import * as dns from 'dns'
dns.promises.resolve('example.i2labs.ca').then(result=>console.log(result))

Webpack

// webpack.config.js
module.exports = {
    alias: {
        'dns': '@i2labs/dns'
    }
}

Browserify

browserify -r '@i2labs/dns:dns' ...

Alternatives

| Alternative | DoH Servers | NodeJS dns | RFC1035 | Dependencies | | ----------- | ----------- | ---------- | ------- | ------------ | | doh-js-client | google cloudflare cleanbrowsing | ✗ | ✗ | ✓ | | http-dns | google | dns.resolveSrv() only | ✗ | ✓ | | fetch-dns | ? | ✓ | ✗ | ✓ | | dohc | ? | ✗ | ✗ | ✓ | | google-dns | google | ✗ | ✗ | ✓ | | dns-over-https / alternate | google | ✗ | ✗ | ✓ | | dns-over-http | ? | ✗ | ✗ | ✓ | | chrome-dns | google | Chrome plugin only | ✗ | ✓ | | jsdns | ? | ✗ | ✗ | ✓ |

dns-packet-typescript - Alternate RFC1035 deserializer