]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
Document that XPF is deprecated and wil be removed. 11398/head
authorOtto Moerbeek <otto.moerbeek@open-xchange.com>
Mon, 7 Mar 2022 15:39:21 +0000 (16:39 +0100)
committerOtto Moerbeek <otto.moerbeek@open-xchange.com>
Mon, 7 Mar 2022 15:40:14 +0000 (16:40 +0100)
pdns/dnsdistdist/docs/advanced/passing-source-address.rst
pdns/dnsdistdist/docs/reference/config.rst
pdns/recursordist/docs/settings.rst

index 54f54c65d4c2aed293dbbc746ea867be0ad98b44..97b80510699d850d88b17f937e71b240174878a5 100644 (file)
@@ -49,6 +49,9 @@ In addition to the drawback that it can only pass the source IP address, and the
 X-Proxied-For
 -------------
 
+.. note::
+  This is a deprecated feature that will be removed in the near future.
+
 The experimental XPF record (from `draft-bellis-dnsop-xpf <https://datatracker.ietf.org/doc/draft-bellis-dnsop-xpf/>`_) is an alternative to the use of EDNS Client Subnet which has the advantages of preserving any existing EDNS Client Subnet value sent by the client, and of passing along the original destination address, as well as the initial source and destination ports.
 
 In order to provide the downstream server with the address of the real client, or at least the one talking to dnsdist, the ``addXPF`` parameter can be used when creating a :func:`new server <newServer>`.
index 63dc4c0a05e36ff0a6b6fbd2aa2850049ad93309..122e731ba3ec5984f6beb40823065f339ab6d0ae 100644 (file)
@@ -574,7 +574,7 @@ Servers
                                 --   "interface name", e.g. "eth0"
                                 --   "address@interface", e.g. "192.0.2.2@eth0"
       addXPF=NUM,               -- Add the client's IP address and port to the query, along with the original destination address and port,
-                                -- using the experimental XPF record from `draft-bellis-dnsop-xpf <https://datatracker.ietf.org/doc/draft-bellis-dnsop-xpf/>`_ and the specified option code. Default is disabled (0)
+                                -- using the experimental XPF record from `draft-bellis-dnsop-xpf <https://datatracker.ietf.org/doc/draft-bellis-dnsop-xpf/>`_ and the specified option code. Default is disabled (0). This is a deprecated feature that will be removed in the near future.
       sockets=NUM,              -- Number of UDP sockets (and thus source ports) used toward the backend server, defaults to a single one. Note that for backends which are multithreaded, this setting will have an effect on the number of cores that will be used to process traffic from dnsdist. For example you may want to set 'sockets' to a number somewhat higher than the number of worker threads configured in the backend, particularly if the Linux kernel is being used to distribute traffic to multiple threads listening on the same socket (via `reuseport`).
       disableZeroScope=BOOL,    -- Disable the EDNS Client Subnet 'zero scope' feature, which does a cache lookup for an answer valid for all subnets (ECS scope of 0) before adding ECS information to the query and doing the regular lookup. This requires the ``parseECS`` option of the corresponding cache to be set to true
       rise=NUM,                 -- Require NUM consecutive successful checks before declaring the backend up, default: 1
index 1a0faaf49e038685df067ee90c0b5706d27c60f8..87adce2454af1ab519b71d63f8f78aa914e890e4 100644 (file)
@@ -2354,6 +2354,7 @@ If a PID file should be written to `socket-dir`_
 
 .. note::
   This is an experimental implementation of `draft-bellis-dnsop-xpf <https://datatracker.ietf.org/doc/draft-bellis-dnsop-xpf/>`_.
+  This is a deprecated feature that will be removed in the near future.
 
 The server will trust XPF records found in queries sent from those netmasks (both IPv4 and IPv6),
 and will adjust queries' source and destination accordingly. This is especially useful when the recursor
@@ -2372,6 +2373,7 @@ should be done on the proxy.
 
 .. note::
   This is an experimental implementation of `draft-bellis-dnsop-xpf <https://datatracker.ietf.org/doc/draft-bellis-dnsop-xpf/>`_.
+  This is a deprecated feature that will be removed in the near future.
 
 This option sets the resource record code to use for XPF records, as long as an official code has not been assigned to it.
 0 means that XPF is disabled.