summaryrefslogtreecommitdiff
path: root/searx/botdetection/valkeydb.py
diff options
context:
space:
mode:
authorIvan Gabaldon <igabaldon@inetol.net>2025-08-09 23:03:30 +0200
committerGitHub <noreply@github.com>2025-08-09 23:03:30 +0200
commitce8929cabe27c7cf0bfb21b47786c7442ffb3712 (patch)
tree8b478698e812efee8e457d34cef8fbd43d2da024 /searx/botdetection/valkeydb.py
parent341d718c7f8557e03e184102f63b2f4a4364b939 (diff)
[mod] limiter: trusted proxies (#4911)
Replaces `x_for` functionality with `trusted_proxies`. This allows defining which IP / ranges to trust extracting the client IP address from X-Forwarded-For and X-Real-IP headers. We don't know if the proxy chain will give us the proper client address (REMOTE_ADDR in the WSGI environment), so we rely on reading the headers of the proxy before SearXNG (if there is one, in that case it must be added to trusted_proxies) hoping it has done the proper checks. In case a proxy in the chain does not check the client address correctly, integrity is compromised and this should be fixed by whoever manages the proxy, not us. Closes: - https://github.com/searxng/searxng/issues/4940 - https://github.com/searxng/searxng/issues/4939 - https://github.com/searxng/searxng/issues/4907 - https://github.com/searxng/searxng/issues/3632 - https://github.com/searxng/searxng/issues/3191 - https://github.com/searxng/searxng/issues/1237 Related: - https://github.com/searxng/searxng-docker/issues/386 - https://github.com/inetol-infrastructure/searxng-container/issues/81
Diffstat (limited to 'searx/botdetection/valkeydb.py')
-rw-r--r--searx/botdetection/valkeydb.py22
1 files changed, 22 insertions, 0 deletions
diff --git a/searx/botdetection/valkeydb.py b/searx/botdetection/valkeydb.py
new file mode 100644
index 000000000..3b8699786
--- /dev/null
+++ b/searx/botdetection/valkeydb.py
@@ -0,0 +1,22 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""Providing a Valkey database for the botdetection methods."""
+
+from __future__ import annotations
+
+import valkey
+
+__all__ = ["set_valkey_client", "get_valkey_client"]
+
+CLIENT: valkey.Valkey | None = None
+"""Global Valkey DB connection (Valkey client object)."""
+
+
+def set_valkey_client(valkey_client: valkey.Valkey):
+ global CLIENT # pylint: disable=global-statement
+ CLIENT = valkey_client
+
+
+def get_valkey_client() -> valkey.Valkey:
+ if CLIENT is None:
+ raise ValueError("No connection to the Valkey database has been established.")
+ return CLIENT