Functions
Tuple[bool, str]	pass_ip (IPv4Address\|IPv6Address real_ip, config.Config cfg)
Tuple[bool, str]	block_ip (IPv4Address\|IPv6Address real_ip, config.Config cfg)
Tuple[bool, str]	ip_is_subnet_of_member_in_list (IPv4Address\|IPv6Address real_ip, str list_name, config.Config cfg)

Variables
	logger = logger.getChild('ip_limit')
list	SEARXNG_ORG

Detailed Description

.. _botdetection.ip_lists:

Method ``ip_lists``
-------------------

The ``ip_lists`` method implements :py:obj:`block-list <block_ip>` and
:py:obj:`pass-list <pass_ip>`.

.. code:: toml

   [botdetection.ip_lists]

   pass_ip = [
     '167.235.158.251', # IPv4 of check.searx.space
     '192.168.0.0/16',  # IPv4 private network
     'fe80::/10',       # IPv6 linklocal
   ]

   block_ip = [
     '93.184.216.34',   # IPv4 of example.org
     '257.1.1.1',       # invalid IP --> will be ignored, logged in ERROR class
   ]

Function Documentation

◆ block_ip()

Tuple[bool, str] searx.botdetection.ip_lists.block_ip	(	IPv4Address \| IPv6Address	real_ip,
		config.Config	cfg )

Checks if the IP on the subnet is in one of the members of the
``botdetection.ip_lists.block_ip`` list.

Definition at line 62 of file ip_lists.py.

def block_ip(real_ip: IPv4Address | IPv6Address, cfg: config.Config) -> Tuple[bool, str]:
    """Checks if the IP on the subnet is in one of the members of the
    ``botdetection.ip_lists.block_ip`` list.
    """
 
    block, msg = ip_is_subnet_of_member_in_list(real_ip, 'botdetection.ip_lists.block_ip', cfg)
    if block:
        msg += " To remove IP from list, please contact the maintainer of the service."
    return block, msg
 
 

References ip_is_subnet_of_member_in_list().

Here is the call graph for this function:

◆ ip_is_subnet_of_member_in_list()

Tuple[bool, str] searx.botdetection.ip_lists.ip_is_subnet_of_member_in_list	(	IPv4Address \| IPv6Address	real_ip,
		str	list_name,
		config.Config	cfg )

Definition at line 73 of file ip_lists.py.

) -> Tuple[bool, str]:
    for net in cfg.get(list_name, default=[]):
        try:
            net = ip_network(net, strict=False)
        except ValueError:
            logger.error("invalid IP %s in %s", net, list_name)
            continue
        if real_ip.version == net.version and real_ip in net:
            return True, f"IP matches {net.compressed} in {list_name}."
    return False, f"IP is not a member of an item in the f{list_name} list"

Referenced by block_ip(), and pass_ip().

Here is the caller graph for this function:

◆ pass_ip()

Tuple[bool, str] searx.botdetection.ip_lists.pass_ip	(	IPv4Address \| IPv6Address	real_ip,
		config.Config	cfg )

Checks if the IP on the subnet is in one of the members of the
``botdetection.ip_lists.pass_ip`` list.

Definition at line 49 of file ip_lists.py.

def pass_ip(real_ip: IPv4Address | IPv6Address, cfg: config.Config) -> Tuple[bool, str]:
    """Checks if the IP on the subnet is in one of the members of the
    ``botdetection.ip_lists.pass_ip`` list.
    """
 
    if cfg.get('botdetection.ip_lists.pass_searxng_org', default=True):
        for net in SEARXNG_ORG:
            net = ip_network(net, strict=False)
            if real_ip.version == net.version and real_ip in net:
                return True, f"IP matches {net.compressed} in SEARXNG_ORG list."
    return ip_is_subnet_of_member_in_list(real_ip, 'botdetection.ip_lists.pass_ip', cfg)
 
 

References ip_is_subnet_of_member_in_list().

Here is the call graph for this function:

Variable Documentation

◆ logger

searx.botdetection.ip_lists.logger = logger.getChild('ip_limit')

Definition at line 39 of file ip_lists.py.

◆ SEARXNG_ORG

list searx.botdetection.ip_lists.SEARXNG_ORG

Initial value:

=  [
    # https://github.com/searxng/searxng/pull/2484#issuecomment-1576639195
    '167.235.158.251',  # IPv4 check.searx.space
    '2a01:04f8:1c1c:8fc2::/64',  # IPv6 check.searx.space
]

Definition at line 41 of file ip_lists.py.

Functions

Variables