58221f55db
* Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages.
125 lines
3.4 KiB
Groff
125 lines
3.4 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "COREDNS\-DNSSEC" "7" "January 2018" "CoreDNS" "CoreDNS plugins"
|
|
.
|
|
.SH "NAME"
|
|
\fIdnssec\fR \- enable on\-the\-fly DNSSEC signing of served data\.
|
|
.
|
|
.SH "DESCRIPTION"
|
|
With \fIdnssec\fR 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 \fInot\fR supported\.
|
|
.
|
|
.SH "SYNTAX"
|
|
.
|
|
.nf
|
|
|
|
dnssec [ZONES\.\.\. ] {
|
|
key file KEY\.\.\.
|
|
cache_capacity CAPACITY
|
|
}
|
|
.
|
|
.fi
|
|
.
|
|
.P
|
|
The specified key is used for all signing operations\. The DNSSEC signing will treat this key 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 \fInot\fR supported\.
|
|
.
|
|
.P
|
|
If multiple \fIdnssec\fR plugins are specified in the same zone, the last one specified will be used (See \fIbugs\fR)\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBZONES\fR zones that should be signed\. If empty, the zones from the configuration block are used\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBkey file\fR indicates that \fBKEY\fR 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 \fBdnssec\-keygen\fR: \fBdnssec\-keygen \-a ECDSAP256SHA256 <zonename>\fR\. A key created for zone \fIA\fR can be safely used for zone \fIB\fR\. The name of the key file can be specified as one of the following formats
|
|
.
|
|
.IP "\(bu" 4
|
|
basename of the generated key \fBKexample\.org+013+45330\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
generated public key \fBKexample\.org+013+45330\.key\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
generated private key \fBKexample\.org+013+45330\.private\fR
|
|
.
|
|
.IP "" 0
|
|
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBcache_capacity\fR indicates the capacity of the cache\. The dnssec plugin uses a cache to store RRSIGs\. The default for \fBCAPACITY\fR is 10000\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "METRICS"
|
|
If monitoring is enabled (via the \fIprometheus\fR directive) then the following metrics are exported:
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBcoredns_dnssec_cache_size{type}\fR \- total elements in the cache, type is "signature"\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBcoredns_dnssec_cache_capacity{type}\fR \- total capacity of the cache, type is "signature"\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBcoredns_dnssec_cache_hits_total{}\fR \- Counter of cache hits\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBcoredns_dnssec_cache_misses_total{}\fR \- Counter of cache misses\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "EXAMPLES"
|
|
Sign responses for \fBexample\.org\fR with the key "Kexample\.org\.+013+45330\.key"\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
example\.org {
|
|
dnssec {
|
|
key file Kexample\.org\.+013+45330
|
|
}
|
|
whoami
|
|
}
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
Sign responses for a kubernetes zone with the key "Kcluster\.local+013+45129\.key"\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
cluster\.local {
|
|
kubernetes
|
|
dnssec {
|
|
key file Kcluster\.local+013+45129
|
|
}
|
|
}
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "BUGS"
|
|
Multiple \fIdnssec\fR plugins inside one server stanza will silently overwrite earlier ones, here \fBexample\.org\fR will overwrite the one for \fBcluster\.local\fR\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
\&\. {
|
|
kubernetes cluster\.local
|
|
dnssec cluster\.local {
|
|
key file Kcluster\.local+013+45129
|
|
}
|
|
dnssec example\.org {
|
|
key file Kexample\.org\.+013+45330
|
|
}
|
|
}
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
|