feat: Multiple resolvers continued

pull/2/head
Karan Sharma 2020-12-16 18:38:34 +05:30
parent b46b64c1ae
commit 53e7f2e59c
11 changed files with 253 additions and 214 deletions

View File

@ -8,12 +8,13 @@
- [x] Parse output into separate fields - [x] Parse output into separate fields
- [ ] Test IPv6/IPv4 only options - [ ] Test IPv6/IPv4 only options
- [x] Add DOH support - [x] Add DOH support
- [x] Add DOT support - [ ] Add DOT support
- [x] Add DNS protocol on TCP mode support. - [ ] Add DNS protocol on TCP mode support.
- [ ] Change lookup method.
- [x] Major records supported - [x] Major records supported
- [x] Support multiple resolvers - [x] Support multiple resolvers
- [x] Take multiple transport options and initialise resolvers accordingly. - [x] Take multiple transport options and initialise resolvers accordingly.
- [ ] Add timeout support - [x] Add timeout support
## CLI Features ## CLI Features
- [x] `ndots` support - [x] `ndots` support
@ -42,7 +43,6 @@
- [ ] Add meaningful comments where required. - [ ] Add meaningful comments where required.
- [ ] Meaningful error messages - [ ] Meaningful error messages
- [ ] Better debug logs - [ ] Better debug logs
- [ ]
## Tests ## Tests
- [ ] Add tests for Command Line Usage. - [ ] Add tests for Command Line Usage.

View File

@ -1,6 +1,7 @@
package main package main
import ( import (
"fmt"
"os" "os"
"github.com/knadh/koanf" "github.com/knadh/koanf"
@ -78,6 +79,36 @@ func main() {
hub.Logger.WithError(err).Error("error parsing flags/arguments") hub.Logger.WithError(err).Error("error parsing flags/arguments")
hub.Logger.Exit(2) hub.Logger.Exit(2)
} }
// Load Nameservers
for _, srv := range hub.QueryFlags.Nameservers {
ns, err := initNameserver(srv)
if err != nil {
hub.Logger.WithError(err).Errorf("error parsing nameserver: %s", ns)
hub.Logger.Exit(2)
}
if ns.Address != "" && ns.Type != "" {
fmt.Println("appending", ns.Address, ns.Type)
hub.Nameservers = append(hub.Nameservers, ns)
}
}
// fallback to system nameserver
if len(hub.Nameservers) == 0 {
ns, err := getDefaultServers()
if err != nil {
hub.Logger.WithError(err).Errorf("error fetching system default nameserver")
hub.Logger.Exit(2)
}
hub.Nameservers = ns
}
// Load Resolvers
err = hub.initResolver()
if err != nil {
hub.Logger.WithError(err).Error("error loading resolver")
hub.Logger.Exit(2)
}
// Start App // Start App
if len(hub.QueryFlags.QNames) == 0 { if len(hub.QueryFlags.QNames) == 0 {
f.Usage() f.Usage()

View File

@ -16,6 +16,7 @@ type Hub struct {
FreeArgs []string FreeArgs []string
Questions []dns.Question Questions []dns.Question
Resolver []resolvers.Resolver Resolver []resolvers.Resolver
Nameservers []Nameserver
} }
// QueryFlags is used store the value of CLI flags. // QueryFlags is used store the value of CLI flags.
@ -38,6 +39,13 @@ type QueryFlags struct {
Timeout time.Duration `koanf:"timeout"` Timeout time.Duration `koanf:"timeout"`
} }
// Nameserver represents the type of Nameserver
// along with it's address.
type Nameserver struct {
Address string
Type string
}
// NewHub initializes an instance of Hub which holds app wide configuration. // NewHub initializes an instance of Hub which holds app wide configuration.
func NewHub(logger *logrus.Logger, buildVersion string) *Hub { func NewHub(logger *logrus.Logger, buildVersion string) *Hub {
// Initialise Resolver // Initialise Resolver
@ -50,6 +58,7 @@ func NewHub(logger *logrus.Logger, buildVersion string) *Hub {
QClasses: []string{}, QClasses: []string{},
Nameservers: []string{}, Nameservers: []string{},
}, },
Nameservers: []Nameserver{},
} }
return hub return hub
} }

View File

@ -78,7 +78,7 @@ func (hub *Hub) prepareQuestions() error {
} }
func fetchDomainList(d string, ndots int) ([]string, int, error) { func fetchDomainList(d string, ndots int) ([]string, int, error) {
cfg, err := dns.ClientConfigFromFile(resolvers.DefaultResolvConfPath) cfg, err := dns.ClientConfigFromFile(DefaultResolvConfPath)
if err != nil { if err != nil {
return nil, 0, err return nil, 0, err
} }

View File

@ -124,10 +124,6 @@ func (hub *Hub) outputTerminal(out []Output) {
// on the output format specified displays the information. // on the output format specified displays the information.
func (hub *Hub) Output(responses [][]resolvers.Response) { func (hub *Hub) Output(responses [][]resolvers.Response) {
out := collectOutput(responses) out := collectOutput(responses)
if len(out) == 0 {
hub.Logger.Info("No records found")
hub.Logger.Exit(0)
}
if hub.QueryFlags.ShowJSON { if hub.QueryFlags.ShowJSON {
hub.outputJSON(out) hub.outputJSON(out)
} else { } else {
@ -142,6 +138,29 @@ func collectOutput(responses [][]resolvers.Response) []Output {
// get the response // get the response
for _, r := range rslvr { for _, r := range rslvr {
var addr string var addr string
if r.Message.Rcode != dns.RcodeSuccess {
for _, ns := range r.Message.Ns {
blah, ok := ns.(*dns.SOA)
fmt.Println(blah, ok)
blah.String()
h := ns.Header()
name := h.Name
qclass := dns.Class(h.Class).String()
ttl := strconv.FormatInt(int64(h.Ttl), 10) + "s"
qtype := dns.Type(h.Rrtype).String()
rtt := fmt.Sprintf("%dms", r.RTT.Milliseconds())
o := Output{
Name: name,
Type: qtype,
TTL: ttl,
Class: qclass,
Address: addr,
TimeTaken: rtt,
Nameserver: r.Nameserver,
}
out = append(out, o)
}
}
for _, a := range r.Message.Answer { for _, a := range r.Message.Answer {
switch t := a.(type) { switch t := a.(type) {
case *dns.A: case *dns.A:

View File

@ -15,10 +15,6 @@ func (hub *Hub) loadQueryArgs() error {
if err != nil { if err != nil {
return err return err
} }
err = hub.initResolver()
if err != nil {
return err
}
hub.loadFallbacks() hub.loadFallbacks()
return nil return nil
} }

View File

@ -1,18 +1,34 @@
package main package main
import ( import (
"errors"
"fmt"
"net"
"net/url"
"runtime"
"time" "time"
"github.com/miekg/dns"
"github.com/mr-karan/doggo/pkg/resolvers" "github.com/mr-karan/doggo/pkg/resolvers"
) )
const (
//DefaultResolvConfPath specifies path to default resolv config file on UNIX.
DefaultResolvConfPath = "/etc/resolv.conf"
// DefaultTLSPort specifies the default port for a DNS server connecting over TCP over TLS
DefaultTLSPort = "853"
// DefaultUDPPort specifies the default port for a DNS server connecting over UDP
DefaultUDPPort = "53"
)
// initResolver checks for various flags and initialises // initResolver checks for various flags and initialises
// the correct resolver based on the config. // the correct resolver based on the config.
func (hub *Hub) initResolver() error { func (hub *Hub) initResolver() error {
// check if DOH flag is set. // for each nameserver, initialise the correct resolver
if hub.QueryFlags.IsDOH { for _, ns := range hub.Nameservers {
if ns.Type == "doh" {
hub.Logger.Debug("initiating DOH resolver") hub.Logger.Debug("initiating DOH resolver")
rslvr, err := resolvers.NewDOHResolver(hub.QueryFlags.Nameservers, resolvers.DOHResolverOpts{ rslvr, err := resolvers.NewDOHResolver(ns.Address, resolvers.DOHResolverOpts{
Timeout: hub.QueryFlags.Timeout * time.Second, Timeout: hub.QueryFlags.Timeout * time.Second,
}) })
if err != nil { if err != nil {
@ -20,9 +36,9 @@ func (hub *Hub) initResolver() error {
} }
hub.Resolver = append(hub.Resolver, rslvr) hub.Resolver = append(hub.Resolver, rslvr)
} }
if hub.QueryFlags.IsTCP { if ns.Type == "tcp" {
hub.Logger.Debug("initiating TCP resolver") hub.Logger.Debug("initiating TCP resolver")
rslvr, err := resolvers.NewTCPResolver(hub.QueryFlags.Nameservers, resolvers.TCPResolverOpts{ rslvr, err := resolvers.NewTCPResolver(ns.Address, resolvers.TCPResolverOpts{
IPv4Only: hub.QueryFlags.UseIPv4, IPv4Only: hub.QueryFlags.UseIPv4,
IPv6Only: hub.QueryFlags.UseIPv6, IPv6Only: hub.QueryFlags.UseIPv6,
Timeout: hub.QueryFlags.Timeout * time.Second, Timeout: hub.QueryFlags.Timeout * time.Second,
@ -32,10 +48,9 @@ func (hub *Hub) initResolver() error {
} }
hub.Resolver = append(hub.Resolver, rslvr) hub.Resolver = append(hub.Resolver, rslvr)
} }
// If so far no resolver has been set, then fallback to UDP. if ns.Type == "udp" {
if hub.QueryFlags.IsUDP || len(hub.Resolver) == 0 {
hub.Logger.Debug("initiating UDP resolver") hub.Logger.Debug("initiating UDP resolver")
rslvr, err := resolvers.NewUDPResolver(hub.QueryFlags.Nameservers, resolvers.UDPResolverOpts{ rslvr, err := resolvers.NewUDPResolver(ns.Address, resolvers.UDPResolverOpts{
IPv4Only: hub.QueryFlags.UseIPv4, IPv4Only: hub.QueryFlags.UseIPv4,
IPv6Only: hub.QueryFlags.UseIPv6, IPv6Only: hub.QueryFlags.UseIPv6,
Timeout: hub.QueryFlags.Timeout * time.Second, Timeout: hub.QueryFlags.Timeout * time.Second,
@ -45,5 +60,70 @@ func (hub *Hub) initResolver() error {
} }
hub.Resolver = append(hub.Resolver, rslvr) hub.Resolver = append(hub.Resolver, rslvr)
} }
}
return nil return nil
} }
func getDefaultServers() ([]Nameserver, error) {
if runtime.GOOS == "windows" {
// TODO: Add a method for reading system default nameserver in windows.
return nil, errors.New(`unable to read default nameservers in this machine`)
}
// if no nameserver is provided, take it from `resolv.conf`
cfg, err := dns.ClientConfigFromFile(DefaultResolvConfPath)
if err != nil {
return nil, err
}
servers := make([]Nameserver, 0, len(cfg.Servers))
for _, s := range cfg.Servers {
ip := net.ParseIP(s)
// handle IPv6
if ip != nil && ip.To4() != nil {
ns := Nameserver{
Type: "udp",
Address: fmt.Sprintf("%s:%s", s, cfg.Port),
}
servers = append(servers, ns)
} else {
ns := Nameserver{
Type: "udp",
Address: fmt.Sprintf("[%s]:%s", s, cfg.Port),
}
servers = append(servers, ns)
}
}
return servers, nil
}
func initNameserver(n string) (Nameserver, error) {
// Instantiate a dumb UDP resolver as a fallback.
ns := Nameserver{
Type: "udp",
Address: n,
}
u, err := url.Parse(n)
if err != nil {
return ns, err
}
if u.Scheme == "https" {
ns.Address = u.String()
ns.Type = "doh"
}
if u.Scheme == "tcp" {
if i := net.ParseIP(n); i != nil {
// if no port specified in nameserver, append defaults.
n = net.JoinHostPort(n, DefaultTLSPort)
}
ns.Address = u.String()
ns.Type = "tcp"
}
if u.Scheme == "udp" {
ns.Type = "udp"
if u.Port() == "" {
ns.Address = net.JoinHostPort(u.Hostname(), DefaultUDPPort)
} else {
ns.Address = net.JoinHostPort(u.Hostname(), u.Port())
}
}
return ns, nil
}

View File

@ -2,7 +2,6 @@ package resolvers
import ( import (
"bytes" "bytes"
"errors"
"fmt" "fmt"
"io/ioutil" "io/ioutil"
"net/http" "net/http"
@ -15,33 +14,29 @@ import (
// DOHResolver represents the config options for setting up a DOH based resolver. // DOHResolver represents the config options for setting up a DOH based resolver.
type DOHResolver struct { type DOHResolver struct {
client *http.Client client *http.Client
servers []string server string
} }
type DOHResolverOpts struct { type DOHResolverOpts struct {
Timeout time.Duration Timeout time.Duration
} }
// NewDOHResolver accepts a list of nameservers and configures a DOH based resolver. // NewDOHResolver accepts a nameserver address and configures a DOH based resolver.
func NewDOHResolver(servers []string, opts DOHResolverOpts) (Resolver, error) { func NewDOHResolver(server string, opts DOHResolverOpts) (Resolver, error) {
if len(servers) == 0 { // do basic validation
return nil, errors.New(`no DOH server specified`) u, err := url.ParseRequestURI(server)
}
for _, s := range servers {
u, err := url.ParseRequestURI(s)
if err != nil { if err != nil {
return nil, fmt.Errorf("%s is not a valid HTTPS nameserver", s) return nil, fmt.Errorf("%s is not a valid HTTPS nameserver", server)
} }
if u.Scheme != "https" { if u.Scheme != "https" {
return nil, fmt.Errorf("missing https in %s", s) return nil, fmt.Errorf("missing https in %s", server)
}
} }
httpClient := &http.Client{ httpClient := &http.Client{
Timeout: opts.Timeout, Timeout: opts.Timeout,
} }
return &DOHResolver{ return &DOHResolver{
client: httpClient, client: httpClient,
servers: servers, server: server,
}, nil }, nil
} }
@ -57,10 +52,9 @@ func (d *DOHResolver) Lookup(questions []dns.Question) ([]Response, error) {
if err != nil { if err != nil {
return nil, err return nil, err
} }
for _, srv := range d.servers {
now := time.Now() now := time.Now()
// Make an HTTP POST request to the DNS server with the DNS message as wire format bytes in the body. // Make an HTTP POST request to the DNS server with the DNS message as wire format bytes in the body.
resp, err := d.client.Post(srv, "application/dns-message", bytes.NewBuffer(b)) resp, err := d.client.Post(d.server, "application/dns-message", bytes.NewBuffer(b))
if err != nil { if err != nil {
return nil, err return nil, err
} }
@ -81,10 +75,9 @@ func (d *DOHResolver) Lookup(questions []dns.Question) ([]Response, error) {
rsp := Response{ rsp := Response{
Message: msg, Message: msg,
RTT: rtt, RTT: rtt,
Nameserver: srv, Nameserver: d.server,
} }
responses = append(responses, rsp) responses = append(responses, rsp)
} }
}
return responses, nil return responses, nil
} }

View File

@ -1,21 +1,15 @@
package resolvers package resolvers
import ( import (
"net"
"time" "time"
"github.com/miekg/dns" "github.com/miekg/dns"
) )
const (
// DefaultTLSPort specifies the default port for a DNS server connecting over TCP over TLS
DefaultTLSPort = "853"
)
// TCPResolver represents the config options for setting up a Resolver. // TCPResolver represents the config options for setting up a Resolver.
type TCPResolver struct { type TCPResolver struct {
client *dns.Client client *dns.Client
servers []string server string
} }
// TCPResolverOpts represents the config options for setting up a TCPResolver. // TCPResolverOpts represents the config options for setting up a TCPResolver.
@ -26,31 +20,10 @@ type TCPResolverOpts struct {
} }
// NewTCPResolver accepts a list of nameservers and configures a DNS resolver. // NewTCPResolver accepts a list of nameservers and configures a DNS resolver.
func NewTCPResolver(servers []string, opts TCPResolverOpts) (Resolver, error) { func NewTCPResolver(server string, opts TCPResolverOpts) (Resolver, error) {
client := &dns.Client{ client := &dns.Client{
Timeout: opts.Timeout, Timeout: opts.Timeout,
} }
var nameservers []string
// load list of nameservers to the config
if len(servers) == 0 {
ns, err := getDefaultServers()
if err != nil {
return nil, err
}
nameservers = ns
} else {
// load the list of servers that user specified.
for _, srv := range servers {
if i := net.ParseIP(srv); i != nil {
// if no port specified in nameserver, append defaults.
nameservers = append(nameservers, net.JoinHostPort(srv, DefaultTLSPort))
} else {
// use the port user specified.
nameservers = append(nameservers, srv)
}
}
}
client.Net = "tcp" client.Net = "tcp"
if opts.IPv4Only { if opts.IPv4Only {
@ -61,7 +34,7 @@ func NewTCPResolver(servers []string, opts TCPResolverOpts) (Resolver, error) {
} }
return &TCPResolver{ return &TCPResolver{
client: client, client: client,
servers: nameservers, server: server,
}, nil }, nil
} }
@ -75,8 +48,7 @@ func (r *TCPResolver) Lookup(questions []dns.Question) ([]Response, error) {
) )
for _, msg := range messages { for _, msg := range messages {
for _, srv := range r.servers { in, rtt, err := r.client.Exchange(&msg, r.server)
in, rtt, err := r.client.Exchange(&msg, srv)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@ -84,10 +56,9 @@ func (r *TCPResolver) Lookup(questions []dns.Question) ([]Response, error) {
rsp := Response{ rsp := Response{
Message: msg, Message: msg,
RTT: rtt, RTT: rtt,
Nameserver: srv, Nameserver: r.server,
} }
responses = append(responses, rsp) responses = append(responses, rsp)
} }
}
return responses, nil return responses, nil
} }

View File

@ -1,23 +1,15 @@
package resolvers package resolvers
import ( import (
"net"
"time" "time"
"github.com/miekg/dns" "github.com/miekg/dns"
) )
const (
// DefaultUDPPort specifies the default port for a DNS server connecting over UDP
DefaultUDPPort = "53"
//DefaultResolvConfPath specifies path to default resolv config file on UNIX.
DefaultResolvConfPath = "/etc/resolv.conf"
)
// UDPResolver represents the config options for setting up a Resolver. // UDPResolver represents the config options for setting up a Resolver.
type UDPResolver struct { type UDPResolver struct {
client *dns.Client client *dns.Client
servers []string server string
} }
// UDPResolverOpts holds options for setting up a Classic resolver. // UDPResolverOpts holds options for setting up a Classic resolver.
@ -28,31 +20,10 @@ type UDPResolverOpts struct {
} }
// NewUDPResolver accepts a list of nameservers and configures a DNS resolver. // NewUDPResolver accepts a list of nameservers and configures a DNS resolver.
func NewUDPResolver(servers []string, opts UDPResolverOpts) (Resolver, error) { func NewUDPResolver(server string, opts UDPResolverOpts) (Resolver, error) {
client := &dns.Client{ client := &dns.Client{
Timeout: opts.Timeout, Timeout: opts.Timeout,
} }
var nameservers []string
// load list of nameservers to the config
if len(servers) == 0 {
ns, err := getDefaultServers()
if err != nil {
return nil, err
}
nameservers = ns
} else {
// load the list of servers that user specified.
for _, srv := range servers {
if i := net.ParseIP(srv); i != nil {
// if no port specified in nameserver, append defaults.
nameservers = append(nameservers, net.JoinHostPort(srv, DefaultUDPPort))
} else {
// use the port user specified.
nameservers = append(nameservers, srv)
}
}
}
client.Net = "udp" client.Net = "udp"
if opts.IPv4Only { if opts.IPv4Only {
@ -63,33 +34,30 @@ func NewUDPResolver(servers []string, opts UDPResolverOpts) (Resolver, error) {
} }
return &UDPResolver{ return &UDPResolver{
client: client, client: client,
servers: nameservers, server: server,
}, nil }, nil
} }
// Lookup prepare a list of DNS messages to be sent to the server. // Lookup prepare a list of DNS messages to be sent to the server.
// It's possible to send multiple question in one message // It's possible to send multiple question in one message
// but some nameservers are not able to // but some nameservers are not able to
func (c *UDPResolver) Lookup(questions []dns.Question) ([]Response, error) { func (r *UDPResolver) Lookup(questions []dns.Question) ([]Response, error) {
var ( var (
messages = prepareMessages(questions) messages = prepareMessages(questions)
responses []Response responses []Response
) )
for _, msg := range messages { for _, msg := range messages {
for _, srv := range c.servers { in, rtt, err := r.client.Exchange(&msg, r.server)
in, rtt, err := c.client.Exchange(&msg, srv)
if err != nil { if err != nil {
return nil, err return nil, err
} }
msg.Answer = in.Answer
rsp := Response{ rsp := Response{
Message: msg, Message: *in,
RTT: rtt, RTT: rtt,
Nameserver: srv, Nameserver: r.server,
} }
responses = append(responses, rsp) responses = append(responses, rsp)
} }
}
return responses, nil return responses, nil
} }

View File

@ -1,11 +1,6 @@
package resolvers package resolvers
import ( import (
"errors"
"fmt"
"net"
"runtime"
"github.com/miekg/dns" "github.com/miekg/dns"
) )
@ -23,26 +18,3 @@ func prepareMessages(questions []dns.Question) []dns.Msg {
} }
return messages return messages
} }
func getDefaultServers() ([]string, error) {
if runtime.GOOS == "windows" {
// TODO: Add a method for reading system default nameserver in windows.
return nil, errors.New(`unable to read default nameservers in this machine`)
}
// if no nameserver is provided, take it from `resolv.conf`
cfg, err := dns.ClientConfigFromFile(DefaultResolvConfPath)
if err != nil {
return nil, err
}
servers := make([]string, 0, len(cfg.Servers))
for _, s := range cfg.Servers {
ip := net.ParseIP(s)
// handle IPv6
if ip != nil && ip.To4() != nil {
servers = append(servers, fmt.Sprintf("%s:%s", s, cfg.Port))
} else {
servers = append(servers, fmt.Sprintf("[%s]:%s", s, cfg.Port))
}
}
return servers, nil
}