mirror of
https://github.com/searxng/searxng
synced 2024-01-01 19:24:07 +01:00
523a875f1e
In PR-2894[1] we isolated botdetection from the limiter, this PR isolates the botdetection from the SearXNG core code. This PR also fixes the issue [2] that the ``server.public_instance`` option needs to activate the limiter. - [1] https://github.com/searxng/searxng/pull/2894 - [2] https://github.com/searxng/searxng/issues/2975 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
80 lines
2.1 KiB
Python
80 lines
2.1 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
# lint: pylint
|
|
""".. _botdetection.ip_lists:
|
|
|
|
Method ``ip_lists``
|
|
-------------------
|
|
|
|
The ``ip_lists`` method implements IP :py:obj:`block- <block_ip>` and
|
|
:py:obj:`pass-lists <pass_ip>`.
|
|
|
|
|
|
Config
|
|
~~~~~~
|
|
|
|
.. 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
|
|
]
|
|
|
|
|
|
Implementations
|
|
~~~~~~~~~~~~~~~
|
|
|
|
"""
|
|
# pylint: disable=unused-argument
|
|
|
|
from __future__ import annotations
|
|
from typing import Tuple
|
|
from ipaddress import (
|
|
ip_network,
|
|
IPv4Address,
|
|
IPv6Address,
|
|
)
|
|
|
|
from . import config
|
|
from ._helpers import logger
|
|
|
|
logger = logger.getChild('ip_limit')
|
|
|
|
|
|
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.
|
|
"""
|
|
return ip_is_subnet_of_member_in_list(real_ip, 'botdetection.ip_lists.pass_ip', cfg)
|
|
|
|
|
|
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
|
|
|
|
|
|
def ip_is_subnet_of_member_in_list(
|
|
real_ip: IPv4Address | IPv6Address, list_name: str, cfg: config.Config
|
|
) -> 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"
|