coredns/plugin/auto
Miek Gieben ba1efee4f1
Default to scrubbing replies in the server (#2012)
Every plugin needs to deal with EDNS0 and should call Scrub to make a
message fit the client's buffer. Move this functionality into the server
and wrapping the ResponseWriter into a ScrubWriter that handles these
bits for us. Result:

Less code and faster, because multiple chained plugins could all be
calling scrub and SizeAndDo - now there is just one place.

Most tests in file/* and dnssec/* needed adjusting because in those unit
tests you don't see OPT RRs anymore. The DNSSEC signer was also looking
at the returned OPT RR to see if it needed to sign - as those are now
added by the server (and thus later), this needed to change slightly.

Scrub itself still exist (for backward compat reasons), but has been
made a noop. Scrub has been renamed to scrub as it should not be used by
external plugins.

Fixes: #2010

Signed-off-by: Miek Gieben <miek@miek.nl>
2018-08-29 12:26:22 +01:00
..
auto.go Default to scrubbing replies in the server (#2012) 2018-08-29 12:26:22 +01:00
log_test.go Clean up tests logging (#1979) 2018-07-19 16:23:06 +01:00
OWNERS Add OWNERS file (#1486) 2018-02-08 10:55:51 +00:00
README.md Typo fixes (#2031) 2018-08-14 08:55:55 -07:00
regexp.go Remove the word middleware (#1067) 2017-09-14 09:36:06 +01:00
regexp_test.go Remove the word middleware (#1067) 2017-09-14 09:36:06 +01:00
setup.go plugin/forward: add REFUSED test (#1878) 2018-06-15 08:12:56 -07:00
setup_test.go Remove the word middleware (#1067) 2017-09-14 09:36:06 +01:00
walk.go Updating filepath in auto plugin if existing zone's file changes location (#1901) (#1910) 2018-07-03 11:20:39 +01:00
walk_test.go Update all plugins to use plugin/pkg/log (#1694) 2018-04-19 07:41:56 +01:00
watcher_test.go Updating filepath in auto plugin if existing zone's file changes location (#1901) (#1910) 2018-07-03 11:20:39 +01:00
zone.go plugin/file: shutdown reload goroutine (#1571) 2018-02-28 18:19:37 -08:00

auto

Name

auto - enables serving zone data from an RFC 1035-style master file, which is automatically picked up from disk.

Description

The auto plugin is used for an "old-style" DNS server. It serves from a preloaded file that exists on disk. If the zone file contains signatures (i.e. is signed, i.e. using DNSSEC) correct DNSSEC answers are returned. Only NSEC is supported! If you use this setup you are responsible for re-signing the zonefile. New or changed zones are automatically picked up from disk.

Syntax

auto [ZONES...] {
    directory DIR [REGEXP ORIGIN_TEMPLATE [TIMEOUT]]
    no_reload
    upstream [ADDRESS...]
}

ZONES zones it should be authoritative for. If empty, the zones from the configuration block are used.

  • directory loads zones from the specified DIR. If a file name matches REGEXP it will be used to extract the origin. ORIGIN_TEMPLATE will be used as a template for the origin. Strings like {<number>} are replaced with the respective matches in the file name, e.g. {1} is the first match, {2} is the second. The default is: db\.(.*) {1} i.e. from a file with the name db.example.com, the extracted origin will be example.com. TIMEOUT specifies how often CoreDNS should scan the directory; the default is every 60 seconds. This value is in seconds. The minimum value is 1 second.
  • no_reload by default CoreDNS will try to reload a zone every minute and reloads if the SOA's serial has changed. This option disables that behavior.
  • upstream defines upstream resolvers to be used resolve external names found (think CNAMEs) pointing to external names. ADDRESS can be an IP address, an IP:port or a string pointing to a file that is structured as /etc/resolv.conf. If no ADDRESS is given, CoreDNS will resolve CNAMEs against itself.

All directives from the file plugin are supported. Note that auto will load all zones found, even though the directive might only receive queries for a specific zone. I.e:

. {
    auto example.org {
        directory /etc/coredns/zones
    }
}

Will happily pick up a zone for example.COM, except it will never be queried, because the auto directive only is authoritative for example.ORG.

Examples

Load org domains from /etc/coredns/zones/org and allow transfers to the internet, but send notifies to 10.240.1.1

. {
    auto org {
        directory /etc/coredns/zones/org
        transfer to *
        transfer to 10.240.1.1
    }
}

Load org domains from /etc/coredns/zones/org and looks for file names as www.db.example.org, where example.org is the origin. Scan every 45 seconds.

org {
    auto {
        directory /etc/coredns/zones/org www\.db\.(.*) {1} 45
    }
}