]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
dnsdist: Document that our `Regex` is Posix Extended Regular Expressions-compatible
authorRemi Gacogne <remi.gacogne@powerdns.com>
Fri, 24 Oct 2025 12:35:20 +0000 (14:35 +0200)
committerRemi Gacogne <remi.gacogne@powerdns.com>
Thu, 6 Nov 2025 08:09:01 +0000 (09:09 +0100)
Signed-off-by: Remi Gacogne <remi.gacogne@powerdns.com>
pdns/dnsdistdist/dnsdist-selectors-definitions.yml
pdns/dnsdistdist/docs/reference/selectors.rst

index 5714ff6cf557b18e4158711f3bd7a6b8b8d69e2b..9131dbb496743c0d6383aad0bef837cafc1a8266 100644 (file)
@@ -48,7 +48,7 @@
       rust-type: "String"
       description: "The full 16bit RCode will be matched. If no EDNS OPT RR is present, the upper 12 bits are treated as 0"
 - name: "HTTPHeader"
-  description: "Matches DNS over HTTPS queries with a HTTP header name whose content matches the supplied regular expression. It is necessary to set the ``keepIncomingHeaders`` to :func:`addDOHLocal()` to use this rule"
+  description: "Matches DNS over HTTPS queries with a HTTP header name whose content matches the supplied regular expression in Posix Extended Regular Expressions format. It is necessary to set the ``keepIncomingHeaders`` to :func:`addDOHLocal()` to use this rule"
   parameters:
     - name: "header"
       type: "String"
@@ -70,7 +70,7 @@
   parameters:
     - name: "expression"
       type: "String"
-      description: "The regex to match on"
+      description: "The regex to match on, in Posix Extended Regular Expressions format"
 - name: "IncomingProtocol"
   description: "Matches queries received over a specific protocol"
   version_added: 2.1.0
@@ -392,7 +392,7 @@ Set the ``source`` parameter to ``false`` to match against destination address i
   parameters:
     - name: "expression"
       type: "String"
-      description: "The regular expression to match the QNAME"
+      description: "The regular expression to match the QNAME, in Posix Extended Regular Expressions format"
 - name: "SNI"
   description: "Matches against the TLS Server Name Indication value sent by the client, if any. Only makes sense for DoT or DoH, and for that last one matching on the HTTP Host header using :ref:`yaml-settings-HTTPHeaderSelector` might provide more consistent results"
   parameters:
index 4f1b9911bbe79d1f6be36f88a3cea4dec52ff3ba..d1be6964bbb1a07c0ffa6a73b0c7703654badbfa 100644 (file)
@@ -59,7 +59,7 @@ Selectors can be combined via :func:`AndRule`, :func:`OrRule` and :func:`NotRule
   .. versionchanged:: 1.8.0
      see ``keepIncomingHeaders`` on :func:`addDOHLocal`
 
-  Matches DNS over HTTPS queries with a HTTP header ``name`` whose content matches the regular expression ``regex``.
+  Matches DNS over HTTPS queries with a HTTP header ``name`` whose content matches the regular expression ``regex`` in Posix Extended Regular Expressions format.
   Since 1.8.0 it is necessary to set the ``keepIncomingHeaders`` option to true on :func:`addDOHLocal` to be able to use this rule.
 
   :param str name: The case-insensitive name of the HTTP header to match on
@@ -69,7 +69,7 @@ Selectors can be combined via :func:`AndRule`, :func:`OrRule` and :func:`NotRule
 
   .. versionadded:: 1.4.0
 
-  Matches DNS over HTTPS queries with a HTTP path matching the regular expression supplied in ``regex``. For example, if the query has been sent to the https://192.0.2.1:443/PowerDNS?dns=... URL, the path would be '/PowerDNS'.
+  Matches DNS over HTTPS queries with a HTTP path matching the regular expression supplied in ``regex`` in Posix Extended Regular Expressions format. For example, if the query has been sent to the https://192.0.2.1:443/PowerDNS?dns=... URL, the path would be '/PowerDNS'.
   Only valid DNS over HTTPS queries are matched. If you want to match all HTTP queries, see :meth:`DOHFrontend:setResponsesMap` instead.
 
   :param str regex: The regex to match on
@@ -302,7 +302,7 @@ Selectors can be combined via :func:`AndRule`, :func:`OrRule` and :func:`NotRule
 
 .. function:: RegexRule(regex)
 
-  Matches the query name against the ``regex``.
+  Matches the query name against the ``regex`` in Posix Extended Regular Expressions format.
 
   .. code-block:: Lua