Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sagi/node-dns-over-tls
DNS-over-TLS API for Node.js
https://github.com/sagi/node-dns-over-tls
dns dns-over-tls dnstls nodejs privacy security tls
Last synced: 3 months ago
JSON representation
DNS-over-TLS API for Node.js
- Host: GitHub
- URL: https://github.com/sagi/node-dns-over-tls
- Owner: sagi
- License: mit
- Created: 2018-08-27T22:26:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T21:14:14.000Z (almost 2 years ago)
- Last Synced: 2024-09-25T16:06:16.985Z (5 months ago)
- Topics: dns, dns-over-tls, dnstls, nodejs, privacy, security, tls
- Language: TypeScript
- Homepage:
- Size: 1.79 MB
- Stars: 19
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dns-over-tls
[`dns-over-tls`](https://www.npmjs.com/package/dns-over-tls) is a Node.js DNS-over-TLS API. Here's a [blog post](https://sagi.io/2018/09/dns-over-tls---thoughts-and-implementation/) that explains how it works.
[](https://circleci.com/gh/sagi/node-dns-over-tls)
[](https://coveralls.io/github/sagi/node-dns-over-tls?branch=master)
[](http://opensource.org/licenses/MIT)
[](http://npm.im/dns-over-tls)
## Installation
~~~
$ npm install dns-over-tls
~~~
## API
We import as follows:
~~~js
const dnstls = require('dns-over-tls')
~~~
All API usages return a `Promise` that resolves to a `DNS` response object.
#### dnstls.query(name)
~~~js
(async () => {
const dnsResponse = await dnstls.query('sagi.io')
})()
~~~
Sends a DNS-over-TLS request of `domain name` `'sagi.io'` to
[Cloudflare](https://developers.cloudflare.com/1.1.1.1/dns-over-tls/)'s
`dns-over-tls` server (`host` is `'1.1.1.1'` and `servername` is `'cloudflare-dns.com'`).
#### dnstls.query(host, servername, name)
~~~js
(async () => {
const dnsResponse = await dnstls.query('9.9.9.9', 'dns.quad9.net', 'sagi.io')
})()
~~~
Sends a DNS-over-TLS request of `domain name` `'sagi.io'` to `host` `'9.9.9.9'` with
`servername` `'dns.quad9.net'`.
#### dnstls.query({ host, servername, name, klass = 'IN', type = 'A', port = 853 })
Allows for more advanced `DNS` queries.
~~~js
(async () => {
const options = {
name: 'authors.bind',
host: '145.100.185.15',
servername: 'dnsovertls.sinodun.com',
klass: 'CH',
type: 'TXT'
};
const dnsResponse = await dnstls.query(options)
})
~~~
Sends a DNS-over-TLS request of `domain name` `'authors.bind'` to `host` `'145.100.185.15'` with
`servername` `'dnsovertls.sinodun.com'`, `class` `'CH'` and type `'TXT'`.
## Example
Say we'd like to get the `NS` records of domain `sagi.io`:
~~~js
const options = {
name: 'sagi.io',
host: '1.1.1.1',
servername: 'cloudflare-dns.com',
type: 'NS',
};
const dnsResponse = await dnstls.query(options);
console.log(JSON.stringify(dnsResponse, null, 2));
~~~
Code from [`example`](https://github.com/sagi/node-dns-over-tls/tree/master/example).
Output:
~~~json
{
"id": 46597,
"type": "response",
"flags": 384,
"flag_qr": true,
"opcode": "QUERY",
"flag_aa": false,
"flag_tc": false,
"flag_rd": true,
"flag_ra": true,
"flag_z": false,
"flag_ad": false,
"flag_cd": false,
"rcode": "NOERROR",
"questions": [
{
"name": "sagi.io",
"type": "NS",
"class": "IN"
}
],
"answers": [
{
"name": "sagi.io",
"type": "NS",
"ttl": 10703,
"class": "IN",
"flush": false,
"data": "cass.ns.cloudflare.com"
},
{
"name": "sagi.io",
"type": "NS",
"ttl": 10703,
"class": "IN",
"flush": false,
"data": "dave.ns.cloudflare.com"
}
],
"authorities": [],
"additionals": []
}
~~~
## License
MIT