Plugin/BIND - extend the syntax to allow multiple addresses (#1512)

* Extend bind to allow multiple addresses. UTs added. Changes the log for server starting, adding address when available

* update readme for bind

* fixes after review

* minor fix on readme

* accept multiple BIND directives in blocserver, consolidate the addresses

* fixes after review - format logging server address, variable names
This commit is contained in:
Francois Tur
2018-02-14 14:19:32 -05:00
committed by Miek Gieben
parent a0834b1dd5
commit 76455c6a0d
11 changed files with 279 additions and 47 deletions

View File

@@ -6,23 +6,46 @@
## Description
Normally, the listener binds to the wildcard host. However, you may force the listener to bind to
another IP instead. This directive accepts only an address, not a port.
Normally, the listener binds to the wildcard host. However, you may want the listener to bind to
another IP instead.
If several addresses are provided, a listener will be open on each of the IP provided.
Each address has to be an IP of one of the interfaces of the host.
## Syntax
~~~ txt
bind ADDRESS
bind ADDRESS ...
~~~
**ADDRESS** is the IP address to bind to.
**ADDRESS** is an IP address to bind to.
When several addresses are provided a listener will be opened on each of the addresses.
## Examples
To make your socket accessible only to that machine, bind to IP 127.0.0.1 (localhost):
~~~
~~~ corefile
. {
bind 127.0.0.1
}
~~~
To allow processing DNS requests only local host on both IPv4 and IPv6 stacks, use the syntax:
~~~ corefile
. {
bind 127.0.0.1 ::1
}
~~~
If the configuration comes up with several *bind* directives, all addresses are consolidated together:
The following sample is equivalent to the preceding:
~~~ corefile
. {
bind 127.0.0.1
bind ::1
}
~~~

View File

@@ -9,22 +9,38 @@ import (
)
func TestSetupBind(t *testing.T) {
c := caddy.NewTestController("dns", `bind 1.2.3.4`)
err := setupBind(c)
if err != nil {
t.Fatalf("Expected no errors, but got: %v", err)
}
cfg := dnsserver.GetConfig(c)
if got, want := cfg.ListenHost, "1.2.3.4"; got != want {
t.Errorf("Expected the config's ListenHost to be %s, was %s", want, got)
}
}
func TestBindAddress(t *testing.T) {
c := caddy.NewTestController("dns", `bind 1.2.3.bla`)
err := setupBind(c)
if err == nil {
t.Fatalf("Expected errors, but got none")
for i, test := range []struct {
config string
expected []string
failing bool
}{
{`bind 1.2.3.4`, []string{"1.2.3.4"}, false},
{`bind`, nil, true},
{`bind 1.2.3.invalid`, nil, true},
{`bind 1.2.3.4 ::5`, []string{"1.2.3.4", "::5"}, false},
{`bind ::1 1.2.3.4 ::5 127.9.9.0`, []string{"::1", "1.2.3.4", "::5", "127.9.9.0"}, false},
{`bind ::1 1.2.3.4 ::5 127.9.9.0 noone`, nil, true},
} {
c := caddy.NewTestController("dns", test.config)
err := setupBind(c)
if err != nil {
if !test.failing {
t.Fatalf("test %d, expected no errors, but got: %v", i, err)
}
continue
}
if test.failing {
t.Fatalf("test %d, expected to failed but did not, returned values", i)
}
cfg := dnsserver.GetConfig(c)
if len(cfg.ListenHosts) != len(test.expected) {
t.Errorf("test %d : expected the config's ListenHosts size to be %d, was %d", i, len(test.expected), len(cfg.ListenHosts))
continue
}
for i, v := range test.expected {
if got, want := cfg.ListenHosts[i], v; got != want {
t.Errorf("test %d : expected the config's ListenHost to be %s, was %s", i, want, got)
}
}
}
}

View File

@@ -12,13 +12,21 @@ import (
func setupBind(c *caddy.Controller) error {
config := dnsserver.GetConfig(c)
// addresses will be consolidated over all BIND directives available in that BlocServer
all := []string{}
for c.Next() {
if !c.Args(&config.ListenHost) {
return plugin.Error("bind", c.ArgErr())
addrs := c.RemainingArgs()
if len(addrs) == 0 {
return plugin.Error("bind", fmt.Errorf("at least one address is expected"))
}
for _, addr := range addrs {
if net.ParseIP(addr) == nil {
return plugin.Error("bind", fmt.Errorf("not a valid IP address: %s", addr))
}
}
all = append(all, addrs...)
}
if net.ParseIP(config.ListenHost) == nil {
return plugin.Error("bind", fmt.Errorf("not a valid IP address: %s", config.ListenHost))
}
config.ListenHosts = all
return nil
}