mirror of
				https://github.com/searxng/searxng.git
				synced 2025-11-04 03:27:06 -05:00 
			
		
		
		
	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
		
			
				
	
	
		
			61 lines
		
	
	
		
			1.9 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			61 lines
		
	
	
		
			1.9 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
# SPDX-License-Identifier: AGPL-3.0-or-later
 | 
						|
# pylint: disable=missing-module-docstring, missing-class-docstring
 | 
						|
from __future__ import annotations
 | 
						|
import typing
 | 
						|
 | 
						|
import re
 | 
						|
from ipaddress import ip_address
 | 
						|
 | 
						|
from flask_babel import gettext
 | 
						|
 | 
						|
from searx.result_types import EngineResults
 | 
						|
 | 
						|
from . import Plugin, PluginInfo
 | 
						|
 | 
						|
if typing.TYPE_CHECKING:
 | 
						|
    from searx.search import SearchWithPlugins
 | 
						|
    from searx.extended_types import SXNG_Request
 | 
						|
    from . import PluginCfg
 | 
						|
 | 
						|
 | 
						|
class SXNGPlugin(Plugin):
 | 
						|
    """Simple plugin that displays information about user's request, including
 | 
						|
    the IP or HTTP User-Agent.  The information is displayed in area for the
 | 
						|
    "answers".
 | 
						|
    """
 | 
						|
 | 
						|
    id = "self_info"
 | 
						|
    keywords = ["ip", "user-agent"]
 | 
						|
 | 
						|
    def __init__(self, plg_cfg: "PluginCfg"):
 | 
						|
        super().__init__(plg_cfg)
 | 
						|
 | 
						|
        self.ip_regex = re.compile(r"^ip", re.IGNORECASE)
 | 
						|
        self.ua_regex = re.compile(r"^user-agent", re.IGNORECASE)
 | 
						|
 | 
						|
        self.info = PluginInfo(
 | 
						|
            id=self.id,
 | 
						|
            name=gettext("Self Information"),
 | 
						|
            description=gettext(
 | 
						|
                """Displays your IP if the query is "ip" and your user agent if the query is "user-agent"."""
 | 
						|
            ),
 | 
						|
            preference_section="query",
 | 
						|
        )
 | 
						|
 | 
						|
    def post_search(self, request: "SXNG_Request", search: "SearchWithPlugins") -> EngineResults:
 | 
						|
        """Returns a result list only for the first page."""
 | 
						|
        results = EngineResults()
 | 
						|
 | 
						|
        if search.search_query.pageno > 1:
 | 
						|
            return results
 | 
						|
 | 
						|
        if self.ip_regex.search(search.search_query.query) and request.remote_addr:
 | 
						|
            results.add(
 | 
						|
                results.types.Answer(answer=gettext("Your IP is: ") + ip_address(request.remote_addr).compressed)
 | 
						|
            )
 | 
						|
 | 
						|
        if self.ua_regex.match(search.search_query.query):
 | 
						|
            results.add(results.types.Answer(answer=gettext("Your user-agent is: ") + str(request.user_agent)))
 | 
						|
 | 
						|
        return results
 |