coredns/plugin/file
Nathan Currier 626333a1b3
Fix zone parser error handling (#6680)
Signed-off-by: Nathan Currier <nathan.currier@broadcom.com>
2024-07-01 11:27:50 -04:00
..
rrutil plugin/file: optimize cname get rr by type (#5080) 2022-01-21 15:05:11 -08:00
tree Fix temp file close error (#6068) 2023-05-03 13:53:48 -04:00
apex_test.go plugin/file: document wrong behavior in lookup fox Apex (#4376) 2021-01-11 09:21:54 +01:00
closest.go add golangci-lint linter (#5499) 2022-07-10 11:06:33 -07:00
closest_test.go presubmit: check for uppercase (#1774) 2018-05-07 23:47:25 +02:00
delegation_test.go Fix query for SOA record for delegated zone (#3875) 2020-05-11 07:51:02 -07:00
delete_test.go plugin/file: Rename do to walk and cleanup and document (#2987) 2019-07-18 17:44:47 +00:00
dname.go K8s remove string ops (#2119) 2018-09-22 15:12:02 +01:00
dname_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00
dnssec_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00
dnssex_test.go Remove the word middleware (#1067) 2017-09-14 09:36:06 +01:00
ds_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00
ent_test.go typo fixes (#3169) 2019-08-21 16:08:55 -04:00
example_org.go Remove the word middleware (#1067) 2017-09-14 09:36:06 +01:00
file.go Fix zone parser error handling (#6680) 2024-07-01 11:27:50 -04:00
file_test.go Fix zone parser error handling (#6680) 2024-07-01 11:27:50 -04:00
fuzz.go update all +build statements (#5271) 2022-03-18 07:11:14 -07:00
glue_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00
include_test.go add golangci-lint linter (#5499) 2022-07-10 11:06:33 -07:00
log_test.go Clean up tests logging (#1979) 2018-07-19 16:23:06 +01:00
lookup.go add golangci-lint linter (#5499) 2022-07-10 11:06:33 -07:00
lookup_test.go plugin/file: unified NoData result (#5086) 2022-04-25 12:05:24 -04:00
notify.go Cherry-pick: Implement notifies for transfer plugin (#3972) (#4142) 2020-09-24 20:30:39 +02:00
nsec3_test.go presubmit: check for uppercase (#1774) 2018-05-07 23:47:25 +02:00
README.md plugin/file: add small zonefile example (#4509) 2021-03-08 12:15:20 +01:00
reload.go Fix security scans by cleaning up file path (#5185) 2022-02-14 11:24:21 -05:00
reload_test.go cleanup deprecated package io/ioutil (#4920) 2021-10-13 09:30:31 +02:00
secondary.go add golangci-lint linter (#5499) 2022-07-10 11:06:33 -07:00
secondary_test.go Cherry-pick: Implement notifies for transfer plugin (#3972) (#4142) 2020-09-24 20:30:39 +02:00
setup.go plugin/file: fix file leak (#5687) 2022-10-11 20:49:52 +02:00
setup_test.go For caddy v1 in our org (#4018) 2020-09-24 18:14:41 +02:00
shutdown.go Configurable zone reload interval in file plugin (#2110) 2018-09-29 16:50:49 +01:00
wildcard.go fix some comments (#6052) 2023-04-25 11:25:07 -04:00
wildcard_test.go replace reviewdog fully by golangci-lint (#6139) 2023-06-09 18:08:23 +02:00
xfr.go Cherry-pick: Implement notifies for transfer plugin (#3972) (#4142) 2020-09-24 20:30:39 +02:00
xfr_test.go transfer: reply with refused (#4510) 2021-03-09 12:17:34 -08:00
zone.go Cherry-pick: Implement notifies for transfer plugin (#3972) (#4142) 2020-09-24 20:30:39 +02:00
zone_test.go Stop importing testing in the main binary (#2479) 2019-01-19 11:23:13 +00:00

file

Name

file - enables serving zone data from an RFC 1035-style master file.

Description

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

Syntax

file DBFILE [ZONES...]
  • DBFILE the database file to read and parse. If the path is relative, the path from the root plugin will be prepended to it.
  • ZONES zones it should be authoritative for. If empty, the zones from the configuration block are used.

If you want to round-robin A and AAAA responses look at the loadbalance plugin.

file DBFILE [ZONES... ] {
    reload DURATION
}
  • reload interval to perform a reload of the zone if the SOA version changes. Default is one minute. Value of 0 means to not scan for changes and reload. For example, 30s checks the zonefile every 30 seconds and reloads the zone when serial changes.

If you need outgoing zone transfers, take a look at the transfer plugin.

Examples

Load the example.org zone from db.example.org and allow transfers to the internet, but send notifies to 10.240.1.1

example.org {
    file db.example.org
    transfer {
        to * 10.240.1.1
    }
}

Where db.example.org would contain RRSets (https://tools.ietf.org/html/rfc7719#section-4) in the (text) presentation format from RFC 1035:

$ORIGIN example.org.
@	3600 IN	SOA sns.dns.icann.org. noc.dns.icann.org. 2017042745 7200 3600 1209600 3600
	3600 IN NS a.iana-servers.net.
	3600 IN NS b.iana-servers.net.

www     IN A     127.0.0.1
        IN AAAA  ::1

Or use a single zone file for multiple zones:

. {
    file example.org.signed example.org example.net
    transfer example.org example.net {
        to * 10.240.1.1
    }
}

Note that if you have a configuration like the following you may run into a problem of the origin not being correctly recognized:

. {
    file db.example.org
}

We omit the origin for the file db.example.org, so this references the zone in the server block, which, in this case, is the root zone. Any contents of db.example.org will then read with that origin set; this may or may not do what you want. It's better to be explicit here and specify the correct origin. This can be done in two ways:

. {
    file db.example.org example.org
}

Or

example.org {
    file db.example.org
}

See Also

See the loadbalance plugin if you need simple record shuffling. And the transfer plugin for zone transfers. Lastly the root plugin can help you specify the location of the zone files.

See RFC 1035 for more info on how to structure zone files.