coredns/plugin/dnssec
Francois Tur f9bdd382dd Ensure Re-register of metrics variables after a reload (#2080)
* - ensure plugins that use prometheus.MustRegister, re-register after reload
- removing once.Do on the startup function was simplest way to do it.

* - fix underscored names (advice of bot)

* - tune existing UT for reload, and add a test verifying failing reload does not prevent correct registering for metrics

* - ensure different ports for tests that can run in same time ..
2018-09-19 02:11:24 -07:00
..
black_lies.go plugin/dnssec: add per server metrics (#1743) 2018-04-27 19:37:31 +01:00
black_lies_bitmap_test.go plugin/dnssec: add per server metrics (#1743) 2018-04-27 19:37:31 +01:00
black_lies_test.go presubmit: Check errorf as well (#1845) 2018-06-02 11:48:39 -07:00
cache.go Move cache Keys to 64bit for a better dispersion and lower collision frequency (#2077) 2018-08-31 14:26:43 -07:00
cache_test.go presubmit: check for uppercase (#1774) 2018-05-07 23:47:25 +02:00
dnskey.go plugin/dnssec: add per server metrics (#1743) 2018-04-27 19:37:31 +01:00
dnssec.go Move cache Keys to 64bit for a better dispersion and lower collision frequency (#2077) 2018-08-31 14:26:43 -07:00
dnssec_test.go presubmit: check for uppercase (#1774) 2018-05-07 23:47:25 +02:00
handler.go Ensure Re-register of metrics variables after a reload (#2080) 2018-09-19 02:11:24 -07:00
handler_test.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 plugin/dnssec: add per server metrics (#1743) 2018-04-27 19:37:31 +01:00
responsewriter.go Default to scrubbing replies in the server (#2012) 2018-08-29 12:26:22 +01:00
rrsig.go plugin/dnssec; insert and sign DS records (#1153) 2017-10-20 09:22:02 +01:00
setup.go Ensure Re-register of metrics variables after a reload (#2080) 2018-09-19 02:11:24 -07:00
setup_test.go return an error for multiple use of some plugins (#1559) 2018-02-28 18:16:05 -08:00

dnssec

Name

dnssec - enable on-the-fly DNSSEC signing of served data.

Description

With dnssec any reply that doesn't (or can't) do DNSSEC will get signed on the fly. Authenticated denial of existence is implemented with NSEC black lies. Using ECDSA as an algorithm is preferred as this leads to smaller signatures (compared to RSA). NSEC3 is not supported.

This plugin can only be used once per Server Block.

Syntax

dnssec [ZONES... ] {
    key file KEY...
    cache_capacity CAPACITY
}

The specified key is used for all signing operations. The DNSSEC signing will treat this key as a CSK (common signing key), forgoing the ZSK/KSK split. All signing operations are done online. Authenticated denial of existence is implemented with NSEC black lies. Using ECDSA as an algorithm is preferred as this leads to smaller signatures (compared to RSA). NSEC3 is not supported.

If multiple dnssec plugins are specified in the same zone, the last one specified will be used (See bugs).

  • ZONES zones that should be signed. If empty, the zones from the configuration block are used.

  • key file indicates that KEY file(s) should be read from disk. When multiple keys are specified, RRsets will be signed with all keys. Generating a key can be done with dnssec-keygen: dnssec-keygen -a ECDSAP256SHA256 <zonename>. A key created for zone A can be safely used for zone B. The name of the key file can be specified in one of the following formats

    • basename of the generated key Kexample.org+013+45330
    • generated public key Kexample.org+013+45330.key
    • generated private key Kexample.org+013+45330.private
  • cache_capacity indicates the capacity of the cache. The dnssec plugin uses a cache to store RRSIGs. The default for CAPACITY is 10000.

Metrics

If monitoring is enabled (via the prometheus directive) then the following metrics are exported:

  • coredns_dnssec_cache_size{server, type} - total elements in the cache, type is "signature".
  • coredns_dnssec_cache_hits_total{server} - Counter of cache hits.
  • coredns_dnssec_cache_misses_total{server} - Counter of cache misses.

The label server indicated the server handling the request, see the metrics plugin for details.

Examples

Sign responses for example.org with the key "Kexample.org.+013+45330.key".

example.org {
    dnssec {
        key file Kexample.org.+013+45330
    }
    whoami
}

Sign responses for a kubernetes zone with the key "Kcluster.local+013+45129.key".

cluster.local {
    kubernetes
    dnssec {
      key file Kcluster.local+013+45129
    }
}