rrda

command module

v0.0.0-...-201a0f9 Latest Latest Go to latest Published: Feb 17, 2017 License: BSD-2-Clause Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

README ¶

                                ______  ____________________.
                               /     / /                    |
                              /     . /                     |  R
               ________  ____/___  __/_____   _____         |
         __  __\__    /__\__    /__\__    /__\\__  \__      |  R
          ///   _/   //   _/   //   |/    \\    ._    \     |
          _/    \    \_   \    \_   '     /_    |/    //    |  D
          \_____/_____/___/_____/__________/____/    /_     |
       <---------h7/dS!---- \      . \ -------\\______/     |  A
                             \      \ \                     |
                              \______\ \____________________|

Description

RRDA is a REST API written in Go allowing to perform DNS queries over HTTP, and to get reverse PTR records for both IPv4 and IPv6 addresses. It outputs JSON-encoded DNS responses.

The API allows to specify which name server to query (either recursive or authoritative), and can be used as a foundation to build DNS looking glasses.

RRDA is a recursive acronym for "RRDA REST DNS API".

Requirements

RRDA requires the following Go libraries:

dns: DNS library in Go - https://github.com/miekg/dns
pat: pattern muxer for Go - https://github.com/bmizerany/pat

Installation

Build and install with the go tool, all dependencies will be automatically fetched and compiled:

go get -d -v ./... && go build -v ./...
go install rrda

Usage

By default, RRDA will bind on localhost, port 8080, in HTTP mode.

USAGE:
  -fastcgi
        Enable FastCGI mode
  -host string
        Set the server host (default "127.0.0.1")
  -port string
        Set the server port (default "8080")
  -version
        Display version

Running RRDA at boot time

Debian init script

RRDA is bundled with a Debian init script, see: debian/rrda

Copy the debian/rrda file in /etc/init.d and modify the line containing DAEMON=rrda to specify the path to your RRDA binary.

To launch the daemon at startup, run:

update-rc.d rrda defaults

FreeBSD rc.d script

RRDA is bundled with a FreeBSD rc.d script, see: freebsd/rrda

Copy the freebsd/rrda file in /usr/local/etc/rc.d and the RRDA binary in /usr/local/sbin.

To launch the daemon at startup, add the following line in /etc/rc.conf:

rrda_enable="YES"

Making Queries

The following examples assume there is a resolver on localhost listening on port 53.

Getting Resources Records

URL Scheme: http://server:port/resolver:port/domain/querytype

Example (using an IPv4 resolver): http://127.0.0.1:8080/127.0.0.1:53/example.org/ns
Example (using an IPv6 resolver): http://127.0.0.1:8080/[::1]:53/example.org/ns

Getting Reverse PTR Records (for both IPv4 and IPv6 addresses)

URL Scheme: http://server:port/resolver:port/x/ip

Example (IPv4): http://127.0.0.1:8080/127.0.0.1:53/x/193.0.6.139
Example (IPv6): http://127.0.0.1:8080/127.0.0.1:53/x/2001:67c:2e8:22::c100:68b

JSONP Support

RRDA supports JSONP callbacks.

Example: http://127.0.0.1:8080/127.0.0.1:53/example.org/ns?callback=rrda

JSON Output Schema

The output is a JSON object containing the following arrays, representing the appropriate sections of DNS packets:

question
answer
authority (omitted if empty)
additional (omitted if empty)

Question section

name
type
class

Answer, Authority, Additional sections

name
type
class
ttl
rdlength
rdata

Client Errors

When incorrect user input is entered, the server returns an HTTP 400 Error (Bad Request), along with a JSON-encoded error message.

Code 401: Input string could not be parsed
Code 402: Input string is not a well-formed domain name
Code 403: Input string is not a valid IP address
Code 404: Invalid DNS query type

Examples

curl http://127.0.0.1:8080/:53/statdns..net/a
{"code":402,"message":"Input string is not a well-formed domain name"}

curl http://127.0.0.1:8080/:53/x/127.0
{"code":403,"message":"Input string is not a valid IP address"}

curl http://127.0.0.1:8080/:53/statdns.net/error
{"code":404,"message":"Invalid DNS query type"}

Server Errors

When the DNS server cannot be reached or returns an error, the server returns an HTTP 500 Error (Internal Server Error), along with a JSON-encoded error message.

Code 501: DNS server could not be reached
Code 502: The name server encountered an internal failure while processing this request (SERVFAIL)
Code 503: Some name that ought to exist, does not exist (NXDOMAIN)
Code 505: The name server refuses to perform the specified operation for policy or security reasons (REFUSED)

Examples

curl http://127.0.0.1:8080/127.0.0.2:53/statdns.net/a
{"code":501,"message":"DNS server could not be reached"}

curl http://127.0.0.1:8080/:53/lame2.broken-on-purpose.generic-nic.net/soa
{"code":502,"message":"The name server encountered an internal failure while processing this request (SERVFAIL)"}

curl http://127.0.0.1:8080/:53/statdns.nete/a
{"code":503,"message":"Some name that ought to exist, does not exist (NXDOMAIN)"}

curl http://127.0.0.1:8080/:53/lame.broken-on-purpose.generic-nic.net/soa
{"code":505,"message":"The name server refuses to perform the specified operation for policy or security reasons (REFUSED)"}