This will dynamically block all hosts that exceeded 20 queries/s as measured over the past 10 seconds, and the dynamic block will last for 60 seconds.
+The dynamic eBPF blocks and the number of queries they blocked can be seen in the web interface and retrieved from the API. Note however that eBPF dynamic objects need to be registered before they appear in the web interface or the API, using the :func:`registerDynBPFFilter` function::
+
+ registerDynBPFFilter(dbpf)
+
+They can be unregistered at a later point using the :func:`unregisterDynBPFFilter` function.
+
This feature has been successfully tested on Arch Linux, Arch Linux ARM, Fedora Core 23 and Ubuntu Xenial
* :class:`QPSLimiter`: implements a QPS-based filter
* :class:`SuffixMatchNode`: represents a group of domain suffixes for rapid testing of membership
* :class:`DNSHeader`: represents the header of a DNS packet
+* :class:`ClientState`: sometimes also called Bind or Frontend, represents the addresses and ports dnsdist is listening on
The existence of most of these objects can mostly be ignored, unless you plan to write your own hooks and policies, but it helps to understand an expressions like:
Return the number of entries in the Packet Cache, and the maximum number of entries
+Client State
+------------
+
+Also called frontend or bind, the Client State object returned by :func:`getBind` and listed with :func:`showBinds` represents an address and port dnsdist is listening on.
+
+.. function:: getBind(index) -> ClientState
+
+ Return a ClientState object.
+
+ :param int index: The object index
+
+ClientState functions
+~~~~~~~~~~~~~~~~~~~~~
+
+.. class:: ClientState
+
+ This object represents an address and port dnsdist is listening on. When ``reuseport`` is in use, several ClientState objects can be present for the same address and port.
+
+.. classmethod:: Server:addPool(pool)
+
+ Add this server to a pool.
+
+ :param str pool: The pool to add the server to
+
+.. classmethod:: ClientState:attachFilter(filter)
+
+ Attach a BPF filter to this frontend.
+
+ :param BPFFilter filter: The filter to attach to this frontend
+
+.. classmethod:: ClientState:detachFilter()
+
+ Remove the BPF filter associated to this frontend, if any.
+
+.. classmethod:: ClientState:toString() -> string
+
+ Return the address and port this frontend is listening on.
+
+ :returns: The address and port this frontend is listening on
+
+Attributes
+~~~~~~~~~~
+
+.. attribute:: ClientState.muted
+
+ If set to true, queries received on this frontend will be normally processed and sent to a backend if needed, but no response will be ever be sent to the client over UDP. TCP queries are processed normally and responses sent to the client.
+
Status, Statistics and More
---------------------------
These are all the functions, objects and methods related to the :doc:`../advanced/ebpf`.
+.. function:: addBPFFilterDynBlocks(addresses, dynbpf[, seconds=10])
+
+ This is the eBPF equivalent of :func:`addDynBlocks`, blocking a set of addresses for (optionally) a number of seconds, using an eBPF dynamic filter.
+ The default number of seconds to block for is 10.
+
+ :param addresses: set of Addresses as returned by an exceed function
+ :param DynBPFFilter: The dynamic eBPF filter to use
+ :param int seconds: The number of seconds this block to expire
+
.. function:: newBPFFilter(maxV4, maxV6, maxQNames) -> BPFFilter
Return a new eBPF socket filter with a maximum of maxV4 IPv4, maxV6 IPv6 and maxQNames qname entries in the block table.
:param int maxV6: Maximum number of IPv6 entries in this filter
:param int maxQNames: Maximum number of QName entries in this filter
+.. function:: newDynBPFFilter(bpf) -> DynBPFFilter
+
+ Return a new dynamic eBPF filter associated to a given BPF Filter.
+
+ :param BPFFilter bpf: The underlying eBPF filter
+
.. function:: setDefaultBPFFilter(filter)
When used at configuration time, the corresponding BPFFilter will be attached to every bind.
- :param BPFFilter filter: The filter ro attach
+ :param BPFFilter filter: The filter to attach
+
+.. function:: registerDynBPFFilter(dynbpf)
+
+ Register a DynBPFFilter filter so that it appears in the web interface and the API.
+
+ :param DynBPFFilter dynbpf: The dynamic eBPF filter to register
+
+.. function:: unregisterDynBPFFilter(dynbpf)
+
+ Remove a DynBPFFilter filter from the web interface and the API.
+
+ :param DynBPFFilter dynbpf: The dynamic eBPF filter to unregister
.. class:: BPFFilter
:param DNSName name: the name to unblock
:param int qtype: The qtype to unblock
+
+.. class:: DynBPFFilter
+
+ Represents an dynamic eBPF filter, allowing the use of ephemeral rules to an existing eBPF filter.
+
+.. classmethod:: BPFFilter:purgeExpired()
+
+ Remove the expired ephemeral rules associated with this filter.
+
+
projects / pdns / commitdiff