🌍 DNS Records

dns-records is a DNS helper tool for Node.js than can quickly discover and retrieve all DNS records for a domain.

Uses dig command to make DNS requests, has a built-in list of subdomains to test for and support for auto-discovering more subdomains based on records found.

→ See it in action here https://dmns.app

Highlights

Retrieves really fast DNS records for a domain
Discovers all A, AAAA and CNAME for a domain
Provides results in a easy-to-use format

Roadmap

Aiming to have these features:

Retrieve DNS records for a domain -> dnsRecords.getDnsRecords()
Discover common subdomains for a domain -> dnsRecords.getAllRecords()
NS test: all Name Servers are synchronised and reply with same data
NS extra info: response time, NS IP location & ISP

Getting Started

Requirements

dig command for DNS lookups. https://linux.die.net/man/1/dig
time command to measure response times. https://linux.die.net/man/1/time

Installation

npm i @layered/dns-records

Usage

The library has a simple API. Use dnsRecords.getAllRecords(query) to retrieve all DNS records for a domain OR request specific record types with dnsRecords.getDnsRecords(domain, 'TXT')

Example

const dnsRecords = require('@layered/dns-records');

const txtRecords = dnsRecords.getDnsRecords('google.com', 'TXT')
const detailedNs = dnsRecords.getNameServers('x.com')
const allRecords = dnsRecords.getAllRecords('x.com')

Client API

dnsRecords.getDnsRecords(names, types, ns) - Get DNS records for a hostname
dnsRecords.getNameServers(domain) - Get detailed info about domain's Name servers
dnsRecords.getAllRecords(hostname) - Get ALL DNS records for a domain

DNS Records by type

dnsRecords.getDnsRecords(names, types, ns): Promise<Array>

Params	type	default	description
names	string or array		hostname or array of hostnames. Ex: `'x.com'`, `['t.co', 'twitter.com']`
types	string or array	`A`	record type or array of record types: Ex: `'TXT'`, `['A', 'TXT', 'MX']`
ns	string	first discovered NS	DNS server to query (optional)

const dnsRecords = require('@layered/dns-records');

(async () => {
  const records1 = await dnsRecords.getDnsRecords('google.com')
  console.log('DNS A records', records1)

  const records2 = await dnsRecords.getDnsRecords('google.com', ['TXT', 'MX'])
  console.log('DNS TXT & MX records', records2)
})()

Returns a promise which resolves with an Array of records found:

[ { name: 'google.com.',
    ttl: '608',
    type: 'TXT',
    value: '"v=spf1 include:_spf.google.com ~all"' },
  ...
]

Detailed NS records

Requires time command!

dnsRecords.getNameServers(domain): Promise<Array>

Params	type	default	description
domain	string		Domain name, ex: `'google.com'`

const dnsRecords = require('./index.js');

(async () => {
  const NSRecords = await dnsRecords.getNameServers('fb.com')
  console.log('NS servers info', NSRecords)
})()

Returns a promise which resolves with an Array of NS info:

[
  {
    ns: 'a.ns.facebook.com.',
    soaSerial: '1565080527',
    IPv4: [ '69.171.239.12' ],
    IPv6: [ '2a03:2880:fffe:c:face:b00c::35' ],
    responseTimev4: [ 53 ],
    responseTimev6: [ 75 ]
  },
  {
    ns: 'b.ns.facebook.com.',
    soaSerial: '1565080527',
    IPv4: [ '69.171.255.12' ],
    IPv6: [ '2a03:2880:ffff:c:face:b00c::35' ],
    responseTimev4: [ 57 ],
    responseTimev6: [ 83 ]
  }
]

All DNS records

dnsRecords.getAllRecords(domain): Promise<Object<Array>>

Params	type	default	description
domain	string		Domain name, ex: `'google.com'`

const dnsRecords = require('./index.js');

(async () => {
  const allRecords = await dnsRecords.getAllRecords('x.com')
  console.log('DNS all records', allRecords)
})()

Returns a promise which resolves with an Array of records found, grouped by type:

{
  NS:
   [ { name: 'x.com.',
       ttl: '3600',
       type: 'NS',
       value: 'ns71.domaincontrol.com.' },
     { name: 'x.com.',
       ttl: '3600',
       type: 'NS',
       value: 'ns72.domaincontrol.com.' } ],
  SOA:
   [ { name: 'x.com.',
       ttl: '600',
       type: 'SOA',
       value:
        'ns71.domaincontrol.com. dns.jomax.net. 2018071100 28800 7200 604800 600' } ],
  CAA: [],
  DNSKEY: [],
  A:
   [ { name: 'x.com.', ttl: '600', type: 'A', value: '160.153.63.10' },
     { name: 'x.com.', ttl: '600', type: 'A', value: '160.153.63.10' } ],
  AAAA: [],
  CNAME:
   [ { name: 'www.x.com.',
       ttl: '3600',
       type: 'CNAME',
       value: 'x.com.' } ],
  MX:
   [ { name: 'x.com.',
       ttl: '3600',
       type: 'MX',
       value: '10 mx-van.mail.am0.yahoodns.net.' } ],
  TXT: []
}

Please report any issues here on GitHub. Any contributions are welcome

License

MIT

humantree / dns-records