dohdec-cli/README.md

DNS over HTTPS and DNS over TLS

# dohdec

Retrieve and decode DNS records using
[DNS-over-HTTPS](https://tools.ietf.org/html/rfc8484) (DoH) or
[DNS-over-TLS](https://tools.ietf.org/html/rfc7858) (DoT) from the command line.

## Install

```bash
npm install -g dohdec-cli
```

## Command Line Usage

```txt
Usage: dohdec [options] [name] [rrtype]

Arguments:
  name                          DNS name to look up (e.g. domain name) or IP
                                address to reverse lookup.  If not specified, a
                                read-execute-print loop (REPL) is started.
  rrtype                        Resource record name or number (default: "A")

Options:
  -V, --version                 output the version number
  -c, --contentType <type>      MIME type for POST (default:
                                "application/dns-message")
  -d, --dns                     Use DNS format instead of JSON (ignored for
                                TLS)
  -s, --dnssec                  Request DNSsec records
  -k, --dnssecCheckingDisabled  Disable DNSsec validation
  -e, --ecs <number>            Use this many bits for EDNS Client Subnet (ECS)
  -b, --ecsSubnet <address>     Use this IP address for EDNS Client Subnet
                                (ECS)
  -f, --full                    Full response, not just answers
  -g, --get                     Force http GET for DNS-format lookups
  -n, --no-decode               Do not decode JSON or DNS wire format
  -2, --no-http2                Disable http2 support
  -t, --tls                     Use DNS-over-TLS instead of DNS-over-HTTPS
  -i, --tlsServer <serverIP>    Connect to this DNS-over-TLS server (default:
                                "1.1.1.1")
  -p, --tlsPort <number>        Connect to this TCP port for DNS-over-TLS
                                (default: 853)
  -u, --url <URL>               The URL of the DoH service (default:
                                "https://cloudflare-dns.com/dns-query")
  -v, --verbose                 Increase verbosity of debug information.  May
                                be specified multiple times.
  -h, --help                    display help for command

For more debug information:

  $ NODE_DEBUG=http,https,http2 dohdec -v [arguments]
```

## API Usage

See the [`dohdec`](../dohdec) package.

## Notes

- All queries will be padded to the next multiple of 128 bytes (see [RFC 8467](https://datatracker.ietf.org/doc/html/rfc8467#section-4.1))
- The JSON protocols are not standardized.  The best we have is Google's [documentation](https://developers.google.com/speed/public-dns/docs/doh/json), which Cloudflare seems to have followed.

## License

[MPL-2.0](https://www.mozilla.org/en-US/MPL/2.0/)

[![Tests](https://github.com/hildjj/dohdec/actions/workflows/node.js.yml/badge.svg)](https://github.com/hildjj/dohdec/actions/workflows/node.js.yml)
[![codecov](https://codecov.io/gh/hildjj/dohdec/branch/main/graph/badge.svg?token=qYy1UyK9S5)](https://codecov.io/gh/hildjj/dohdec)