net/unbound/files/README.md

   1 # Unbound Recursive DNS Server with UCI
   2
   3 ## Unbound Description
   4 Unbound is a validating, recursive, and caching DNS resolver. The C implementation of Unbound is developed and maintained by [NLnet Labs](https://www.unbound.net/). It is based on ideas and algorithms taken from a java prototype developed by Verisign labs, Nominet, Kirei and ep.net. Unbound is designed as a set of modular components, so that also DNSSEC (secure DNS) validation and stub-resolvers (that do not run as a server, but are linked into an application) are easily possible.
   5
   6 ## Package Overview
   7 Unbound may be useful on consumer grade embedded hardware. It is *intended* to be a recursive resolver only. [NLnet Labs NSD](https://www.nlnetlabs.nl/projects/nsd/) is *intended* for the authoritative task. This is different than [ISC Bind](https://www.isc.org/downloads/bind/) and its inclusive functions. Unbound configuration effort and memory consumption may be easier to control. A consumer could have their own recursive resolver, and remove potential issues from forwarding resolvers outside of their control.
   8
   9 This package builds on Unbounds capabilities with OpenWrt UCI. Not every Unbound option is in UCI, but rather, UCI simplifies the combination of related options. Unbounds native options are bundled and balanced within a smaller set of choices. Options include resources, DNSSEC, access control, and some TTL tweaking. The UCI also provides an escape option and work at the raw "unbound.conf" level.
  10
  11 ## Work with dnsmasq
  12 Some UCI options will help Unbound and dnsmasq work together in **parallel**. The default DHCP and DNS stub resolver in OpenWrt is dnsmasq, and it will continue to serve this purpose. The following actions will make Unbound the primary DNS server, and make dnsmasq only provide DNS to local DHCP.
  13
  14 - Set `unbound` UCI `option dnsmasq_link_dns` to true.
  15 - Set other `unbound` UCI options how you wish.
  16 - Set `dnsmasq` UCI `option noresolv` to true.
  17 - Set `dnsmasq` UCI `option resolvfile` to blank single-quotes.
  18 - Set `dnsmasq` UCI `option port` to 1053 or 5353.
  19 - Add to each `dhcp` UCI `list dhcp_option option:dns-server,0.0.0.0`
  20
  21 Alternatives are mentioned here for completeness. DHCP event scripts which write host records are difficult to formulate for Unbound, NSD, or Bind. These programs sometimes need to be forcefully reloaded with host configuration, and reloads can bust cache. **Serial** configuration between dnsmasq and Unbound can be made on 127.0.0.1 with an off-port like #1053. This may double cache storage and incur unnecessary transfer delay.
  22
  23 ## Back to Manual Configuration
  24 You don't want UCI, but don't worry. We have UCI for that. However, OpenWrt or LEDE are targeted at embedded machines with flash ROM. The initialization scripts do a few things to protect flash ROM.
  25
  26 All of `/etc/unbound` (persistent, ROM) is copied to `/var/lib/unbound` (tmpfs, RAM). Edit your manual `/etc/unbound/unbound.conf` to reference this `/var/lib/unbound` location for included files. Note in preparation for a jail, `/var/lib/unbound` is `chown unbound`. Configure for security in`/etc/unbound/unbound.conf` with options `username:unbound` and `chroot:/var/lib/unbound`.
  27
  28 Finally, `root.key` maintenance for DNSKEY RFC5011 would be hard on flash. Unbound natively updates frequently. It also creates and destroys working files in the process. In `/var/lib/unbound` this is no problem, but it would be gone at the next reboot. If you have DNSSEC (validator) active, then you should consider this UCI option. Choose how many days to copy from `/var/lib/unbound/root.key` (tmpfs) to `/etc/unbound/root.key` (flash). Keep the DNSKEY updated with your choice of flash activity.
  29
  30         config unbound
  31                 option manual_conf '1'
  32                 option root_age '30'
  33
  34 ## Complete List of UCI Options
  35 **/etc/config/unbound**:
  36
  37         config unbound
  38                 Currently only one instance is supported.
  39
  40         option dnsmasq_gate_name '0'
  41                 Boolean. Forward PTR records for interfaces not serving DHCP.
  42                 Assume these are WAN. Example dnsmasq option here to provide
  43                 logs with a name when your ISP won't link DHCP-DNS.
  44                 "dnsmasq.conf: interface-name=way-out.myrouter.lan,eth0.1"
  45
  46         option dnsmasq_link_dns '0'
  47                 Boolean. Master link to dnsmasq. Parse /etc/config/dhcp for dnsmasq
  48                 options. Forward domain such as "lan" and PTR records for DHCP
  49                 interfaces and their deligated subnets, IP4 and IP6.
  50
  51         option dnsmasq_only_local '0'
  52                 TODO: not yet implemented
  53                 Boolean. Restrict link to dnsmasq. DNS only to local host. Obscure
  54                 names of other connected hosts on the network. Example:
  55                 "drill -x 198.51.100.17  ~ IN PTR way-out.myrouter.lan"
  56                 "drill -x 192.168.10.1   ~ IN PTR guest-wifi.myrouter.lan"
  57                 "drill -x 192.168.10.201 ~ NODATA" (insted of james-laptop.lan)
  58
  59         option edns_size '1280'
  60                 Extended DNS is necessary for DNSSEC. However, it can run into MTU
  61                 issues. Use this size in bytes to manage drop outs.
  62
  63         option listen_port '53'
  64                 Port. Incoming. Where Unbound will listen for queries.
  65
  66         option localservice '1'
  67                 Boolean. Prevent DNS amplification attacks. Only provide access to
  68                 Unbound from subnets this machine has interfaces on.
  69
  70         option manual_conf '0'
  71                 Boolean. Skip all this UCI nonsense. Manually edit the
  72                 configuration. Make changes to /etc/unbound/unbound.conf.
  73
  74         option query_minimize '0'
  75                 Boolean. Enable a minor privacy option. Query only one name piece
  76                 at a time. Don't let each server know the next recursion.
  77
  78         option rebind_localhost '0'
  79                 Boolean. Prevent loopback "127.0.0.0/8" or "::1/128" responses.
  80                 These may used by black hole servers for good purposes like
  81                 ad-blocking or parental access control. Obviously these responses
  82                 also can be used to for bad purposes.
  83
  84         option rebind_protection '1'
  85                 Boolean. Prevent RFC 1918 Reponses from global DNS. Example a
  86                 poisoned reponse within "192.168.0.0/24" could be used to turn a
  87                 local browser into an external attack proxy server.
  88
  89         option recursion 'passive'
  90                 Unbound has numerous options for how it recurses. This UCI combines
  91                 them into "passive," "aggressive," or Unbound's own "default."
  92                 Passive is easy on resources, but slower until cache fills.
  93
  94         option resource 'small'
  95                 Unbound has numerous options for resources. This UCI gives "tiny,"
  96                 "small," "medium," and "large." Medium is most like the compiled
  97                 defaults with a bit of balancing. Tiny is close to the published
  98                 memory restricted configuration. Small 1/2 medium, and large 2x.
  99
 100         option root_age '30'
 101                 Days. >90 Disables. Age limit for Unbound root data like root
 102                 DNSSEC key. Unbound uses RFC 5011 to manage root key. This could
 103                 harm flash ROM. This activity is mapped to "tmpfs," but every so
 104                 often it needs to be copied back to flash for the next reboot.
 105
 106         option ttl_min '120'
 107                 Seconds. Minimum TTL in cache. Recursion can be expensive without
 108                 cache. A low TTL is normal for server migration. A low TTL can be
 109                 abused for snoop-vertising (DNS hit counts; recording query IP).
 110                 Typical to configure maybe 0~300, but 1800 is the maximum accepted.
 111
 112         option unbound_control '0'
 113                 Boolean. Enables unbound-control application access ports. Enabling
 114                 this without the unbound-control package installed is robust.
 115
 116         option validator '0'
 117                 Boolean. Enable DNSSEC. Unbound names this the "validator" module.
 118
 119         option validator_ntp '1'
 120                 Boolean. Disable DNSSEC time checks at boot. Once NTP confirms
 121                 global real time, then DNSSEC is restarted at full strength. Many
 122                 embedded devices don't have a real time power off clock. NTP needs
 123                 DNS to resolve servers. This works around the chicken-and-egg.
 124
 125         list domain_insecure
 126                 List. Domains or pointers that you wish to skip DNSSEC. Your DHCP
 127                 domains and pointers in dnsmasq will get this automatically.
 128