mirror of
				https://github.com/coredns/coredns.git
				synced 2025-11-03 18:53:13 -05:00 
			
		
		
		
	each readme starts with the plugin's name as a header, this needs to be chopped off to provide a good manual page. Signed-off-by: Miek Gieben <miek@miek.nl>
		
			
				
	
	
		
			78 lines
		
	
	
		
			1.7 KiB
		
	
	
	
		
			Groff
		
	
	
	
	
	
			
		
		
	
	
			78 lines
		
	
	
		
			1.7 KiB
		
	
	
	
		
			Groff
		
	
	
	
	
	
.\" Generated by Mmark Markdown Processer - mmark.nl
 | 
						|
.TH "COREDNS-TLS" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
 | 
						|
 | 
						|
.SH NAME
 | 
						|
.PP
 | 
						|
\fItls\fP - allows you to configure the server certificates for the TLS and gRPC servers.
 | 
						|
 | 
						|
.SH DESCRIPTION
 | 
						|
.PP
 | 
						|
CoreDNS supports queries that are encrypted using TLS (DNS over Transport Layer Security, RFC 7858)
 | 
						|
or are using gRPC (https://grpc.io/
 | 
						|
\[la]https://grpc.io/\[ra], not an IETF standard). Normally DNS traffic isn't encrypted at
 | 
						|
all (DNSSEC only signs resource records).
 | 
						|
 | 
						|
.PP
 | 
						|
The \fItls\fP "plugin" allows you to configure the cryptographic keys that are needed for both
 | 
						|
DNS-over-TLS and DNS-over-gRPC. If the \fB\fCtls\fR directive is omitted, then no encryption takes place.
 | 
						|
 | 
						|
.PP
 | 
						|
The gRPC protobuffer is defined in \fB\fCpb/dns.proto\fR. It defines the proto as a simple wrapper for the
 | 
						|
wire data of a DNS message.
 | 
						|
 | 
						|
.SH SYNTAX
 | 
						|
.PP
 | 
						|
.RS
 | 
						|
 | 
						|
.nf
 | 
						|
tls CERT KEY [CA]
 | 
						|
 | 
						|
.fi
 | 
						|
.RE
 | 
						|
 | 
						|
.PP
 | 
						|
Parameter CA is optional. If not set, system CAs can be used to verify the client certificate
 | 
						|
 | 
						|
.SH EXAMPLES
 | 
						|
.PP
 | 
						|
Start a DNS-over-TLS server that picks up incoming DNS-over-TLS queries on port 5553 and uses the
 | 
						|
nameservers defined in \fB\fC/etc/resolv.conf\fR to resolve the query. This proxy path uses plain old DNS.
 | 
						|
 | 
						|
.PP
 | 
						|
.RS
 | 
						|
 | 
						|
.nf
 | 
						|
tls://.:5553 {
 | 
						|
	tls cert.pem key.pem ca.pem
 | 
						|
	forward . /etc/resolv.conf
 | 
						|
}
 | 
						|
 | 
						|
.fi
 | 
						|
.RE
 | 
						|
 | 
						|
.PP
 | 
						|
Start a DNS-over-gRPC server that is similar to the previous example, but using DNS-over-gRPC for
 | 
						|
incoming queries.
 | 
						|
 | 
						|
.PP
 | 
						|
.RS
 | 
						|
 | 
						|
.nf
 | 
						|
grpc://. {
 | 
						|
	tls cert.pem key.pem ca.pem
 | 
						|
	forward . /etc/resolv.conf
 | 
						|
}
 | 
						|
 | 
						|
.fi
 | 
						|
.RE
 | 
						|
 | 
						|
.PP
 | 
						|
Only Knot DNS' \fB\fCkdig\fR supports DNS-over-TLS queries, no command line client supports gRPC making
 | 
						|
debugging these transports harder than it should be.
 | 
						|
 | 
						|
.SH ALSO SEE
 | 
						|
.PP
 | 
						|
RFC 7858 and https://grpc.io
 | 
						|
\[la]https://grpc.io\[ra].
 | 
						|
 |