Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reklatsmasters/dnscrypt
dnscrypt - authenticated and encrypted dns client for nodejs
https://github.com/reklatsmasters/dnscrypt
chacha20 dns dnscrypt js nodejs salsa20
Last synced: 24 days ago
JSON representation
dnscrypt - authenticated and encrypted dns client for nodejs
- Host: GitHub
- URL: https://github.com/reklatsmasters/dnscrypt
- Owner: reklatsmasters
- License: mit
- Created: 2019-11-16T20:45:12.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-26T17:27:32.000Z (about 4 years ago)
- Last Synced: 2024-09-05T16:43:00.585Z (2 months ago)
- Topics: chacha20, dns, dnscrypt, js, nodejs, salsa20
- Language: JavaScript
- Homepage:
- Size: 857 KB
- Stars: 14
- Watchers: 3
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# dnscrypt
[](https://github.com/emersion/stability-badges#unstable)
[](https://travis-ci.com/reklatsmasters/dnscrypt)
[](https://npmjs.org/package/dnscrypt)
[](https://npmjs.org/package/dnscrypt)
[](https://npmjs.org/package/dnscrypt)
[](https://npmjs.org/package/dnscrypt)
[](https://coveralls.io/github/reklatsmasters/dnscrypt?branch=master)
DNSCrypt - authenticated and encrypted DNS client for nodejs
## Usage
```js
const dnscrypt = require('dnscrypt');
dnscrypt.resolve('example.com', (err, addresses) => {
if (err) {
console.error(err);
} else {
console.log(addresses);
}
});
// Supports both callback and promise-based styles.
await dnscrypt.resolve4('example.com');
const resolver = dnscrypt.createResolver({ timeout: 1e3 });
```
## How to
* Use global api `dnscrypt.resolve` for single looking up.
* Use resolver api `dnscrypt.createResolver()` for multiple lookups (_to avoid repeated certificate requests_).
## API
* *`dnscrypt.resolve(hostname[, rrtype], callback): void`*
* *`dnscrypt.resolve(hostname[, rrtype]): Promise`*
See [dns.resolve](https://nodejs.org/dist/latest-v12.x/docs/api/dns.html#dns_dns_resolve_hostname_rrtype_callback).
* *`dnscrypt.resolve4(hostname[, options], callback): void`*
* *`dnscrypt.resolve4(hostname[, options]): Promise`*
See [dns.resolve4](https://nodejs.org/dist/latest-v12.x/docs/api/dns.html#dns_dns_resolve4_hostname_options_callback).
* *`dnscrypt.resolve6(hostname[, options], callback): void`*
* *`dnscrypt.resolve6(hostname[, options]): Promise`*
See [dns.resolve6](https://nodejs.org/dist/latest-v12.x/docs/api/dns.html#dns_dns_resolve6_hostname_options_callback).
* *`dnscrypt.resolveCname(hostname, callback): void`*
* *`dnscrypt.resolveCname(hostname): Promise`*
See [dns.resolveCname](https://nodejs.org/dist/latest-v12.x/docs/api/dns.html#dns_dns_resolvecname_hostname_callback).
* *`dnscrypt.resolveMx(hostname, callback): void`*
* *`dnscrypt.resolveMx(hostname): Promise`*
See [dns.resolveMx](https://nodejs.org/dist/latest-v12.x/docs/api/dns.html#dns_dns_resolvemx_hostname_callback).
* *`dnscrypt.resolveNs(hostname, callback): void`*
* *`dnscrypt.resolveNs(hostname): Promise`*
See [dns.resolveNs](https://nodejs.org/dist/latest-v12.x/docs/api/dns.html#dns_dns_resolvens_hostname_callback).
* *`dnscrypt.resolvePtr(hostname, callback): void`*
* *`dnscrypt.resolvePtr(hostname): Promise`*
See [dns.resolvePtr](https://nodejs.org/dist/latest-v12.x/docs/api/dns.html#dns_dns_resolveptr_hostname_callback).
* *`dnscrypt.resolveSoa(hostname, callback): void`*
* *`dnscrypt.resolveSoa(hostname): Promise`*
See [dns.resolveSoa](https://nodejs.org/dist/latest-v12.x/docs/api/dns.html#dns_dns_resolvesoa_hostname_callback).
* *`dnscrypt.resolveSrv(hostname, callback): void`*
* *`dnscrypt.resolveSrv(hostname): Promise`*
See [dns.resolveSrv](https://nodejs.org/dist/latest-v12.x/docs/api/dns.html#dns_dns_resolvesrv_hostname_callback).
* *`dnscrypt.resolveTxt(hostname, callback): void`*
* *`dnscrypt.resolveTxt(hostname): Promise`*
See [dns.resolveTxt](https://nodejs.org/dist/latest-v12.x/docs/api/dns.html#dns_dns_resolvetxt_hostname_callback).
* *`dnscrypt.getServers(): DNSStamp[]`*
Returns an array of active DNS servers.
* *`dnscrypt.createResolver([options]): Resolver`*
Create a new independent resolver for DNS requests.
- `options.timeout: number` - The number of milliseconds before a request times out, 2s default.
- `options.unref: bool` - Call `.unref()` on internal dgram socket.
- `options.sdns: string` - Use secure DNS resolver instead of default one.
The following methods from the `dnscrypt` module are available:
* *`resolver.resolve(hostname[, rrtype], callback): void`*
* *`resolver.resolve(hostname[, rrtype]): Promise`*
* *`resolver.resolve4(hostname[, options], callback): void`*
* *`resolver.resolve4(hostname[, options]): Promise`*
* *`resolver.resolve6(hostname[, options], callback): void`*
* *`resolver.resolve6(hostname[, options]): Promise`*
* *`resolver.resolveCname(hostname, callback): void`*
* *`resolver.resolveCname(hostname): Promise`*
* *`resolver.resolveMx(hostname, callback): void`*
* *`resolver.resolveMx(hostname): Promise`*
* *`resolver.resolveNs(hostname, callback): void`*
* *`resolver.resolveNs(hostname): Promise`*
* *`resolver.resolvePtr(hostname, callback): void`*
* *`resolver.resolvePtr(hostname): Promise`*
* *`resolver.resolveSoa(hostname, callback): void`*
* *`resolver.resolveSoa(hostname): Promise`*
* *`resolver.resolveSrv(hostname, callback): void`*
* *`resolver.resolveSrv(hostname): Promise`*
* *`resolver.resolveTxt(hostname, callback): void`*
* *`resolver.resolveTxt(hostname): Promise`*
* *`resolver.getServers(): DNSStamp[]`*
* *`resolver.setServers(sdns): void`*
Change the address of internal secure DNS server.
* *`resolver.close(): void`*
Close encrypted DNS session.
## License
MIT, 2019 (c) Dmitriy Tsvettsikh