]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
policy TLS_FORWARD: documentation improvements
authorTomas Krizek <tomas.krizek@nic.cz>
Thu, 18 Jan 2018 11:19:55 +0000 (12:19 +0100)
committerPetr Špaček <petr.spacek@nic.cz>
Thu, 18 Jan 2018 12:20:11 +0000 (13:20 +0100)
daemon/README.rst
modules/policy/README.rst

index 4222cc3cd7ceb31d66ed194e66ea2bb51b576a0f..c7979012231767c2bfcad273ea39db7ff5510979 100644 (file)
@@ -509,8 +509,6 @@ For when listening on ``localhost`` just doesn't cut it.
 
    Enable/disable using IPv4 for recursion.
 
-.. _tls-server-config:
-
 .. function:: net.listen(addresses, [port = 53, flags = {tls = (port == 853)}])
 
    :return: boolean
@@ -597,6 +595,8 @@ For when listening on ``localhost`` just doesn't cut it.
       > net.tcp_pipeline(50)
       50
 
+.. _tls-server-config:
+
 .. function:: net.tls([cert_path], [key_path])
 
    Get/set path to a server TLS certificate and private key for DNS/TLS.
index c4e16504b3f6dcfa95a5dd9cd8ce649395b1b2d2..32ab5cf0d986f6aaf5d1313ae48022f82c292420 100644 (file)
@@ -46,12 +46,14 @@ Most actions stop the policy matching on the query, but "chain actions" allow to
 
 Forwarding over TLS protocol (DNS-over-TLS)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Policy `TLS_FORWARD` allows you to forward queries using `Transport Layer Security`_ protocol, which hides content of your queries before attacker observing network traffic. Further details about this protocol can be found in `RFC 7858`_ and `IETF draft dprive-dtls-and-tls-profiles`_.
+Policy `TLS_FORWARD` allows you to forward queries using `Transport Layer Security`_ protocol, which hides the content of your queries from an attacker observing the network traffic. Further details about this protocol can be found in `RFC 7858`_ and `IETF draft dprive-dtls-and-tls-profiles`_.
 
-Queries affected by `TLS_FORWARD` policy will always be resolved over TLS connection. Knot Resolver does not implement fallback to non-TLS connection, so if TLS connection cannot be established or authenticated according to configuration, the resolution will fail.
+Queries affected by `TLS_FORWARD` policy will always be resolved over TLS connection. Knot Resolver does not implement fallback to non-TLS connection, so if TLS connection cannot be established or authenticated according to the configuration, the resolution will fail.
 
 To test this feature you need to either :ref:`configure Knot Resolver as DNS-over-TLS server <tls-server-config>`, or pick some public DNS-over-TLS server. Please see `DNS Privacy Project`_ homepage for list of public servers.
 
+When multiple servers are specified, the one with the lowest round-trip time is used.
+
 TLS Examples
 ~~~~~~~~~~~~
 
@@ -63,6 +65,8 @@ TLS Examples
        -- for brevity, other TLS examples omit policy.add(policy.all())
        -- single server authenticated using its certificate pin
          policy.TLS_FORWARD({{'192.0.2.1', pin='YQ=='}})  -- pin is base64-encoded
+       -- single server using non-standard port
+         policy.TLS_FORWARD({{'192.0.2.1@443', pin='YQ=='}})  -- use @ or # to specify port
        -- single server with multiple valid pins (e.g. anycast)
          policy.TLS_FORWARD({{'192.0.2.1', pin={'YQ==', 'Wg=='}})
        -- multiple servers, each with own authenticator