searx.network.client Namespace Reference

Classes
class	AsyncHTTPTransportNoHttp
class	AsyncProxyTransportFixed

Functions
	shuffle_ciphers (ssl_context)
	get_sslcontexts (proxy_url=None, cert=None, verify=True, trust_env=True, http2=False)
	get_transport_for_socks_proxy (verify, http2, local_address, proxy_url, limit, retries)
	get_transport (verify, http2, local_address, proxy_url, limit, retries)
	new_client (enable_http, verify, enable_http2, max_connections, max_keepalive_connections, keepalive_expiry, proxies, local_address, retries, max_redirects, hook_log_response)
	get_loop ()
	init ()

Variables
	logger = logger.getChild('searx.network.client')
	LOOP = None
dict	SSLCONTEXTS = {}

Function Documentation

get_loop()

searx.network.client.get_loop

(

)

Definition at line 201 of file client.py.

def get_loop():
    return LOOP
 
 

get_sslcontexts()

searx.network.client.get_sslcontexts	(		proxy_url = None,
			cert = None,
			verify = True,
			trust_env = True,
			http2 = False )

Definition at line 50 of file client.py.

def get_sslcontexts(proxy_url=None, cert=None, verify=True, trust_env=True, http2=False):
    key = (proxy_url, cert, verify, trust_env, http2)
    if key not in SSLCONTEXTS:
        SSLCONTEXTS[key] = httpx.create_ssl_context(cert, verify, trust_env, http2)
    shuffle_ciphers(SSLCONTEXTS[key])
    return SSLCONTEXTS[key]
 
 

References searx.network.client.shuffle_ciphers().

Referenced by searx.network.client.get_transport(), and searx.network.client.get_transport_for_socks_proxy().

Here is the call graph for this function:

Here is the caller graph for this function:

get_transport()

searx.network.client.get_transport	(		verify,
			http2,
			local_address,
			proxy_url,
			limit,
			retries )

Definition at line 140 of file client.py.

def get_transport(verify, http2, local_address, proxy_url, limit, retries):
    verify = get_sslcontexts(None, None, verify, True, http2) if verify is True else verify
    return httpx.AsyncHTTPTransport(
        # pylint: disable=protected-access
        verify=verify,
        http2=http2,
        limits=limit,
        proxy=httpx._config.Proxy(proxy_url) if proxy_url else None,
        local_address=local_address,
        retries=retries,
    )
 
 

References searx.network.client.get_sslcontexts().

Referenced by searx.network.client.new_client().

Here is the call graph for this function:

Here is the caller graph for this function:

get_transport_for_socks_proxy()

searx.network.client.get_transport_for_socks_proxy	(		verify,
			http2,
			local_address,
			proxy_url,
			limit,
			retries )

Definition at line 111 of file client.py.

def get_transport_for_socks_proxy(verify, http2, local_address, proxy_url, limit, retries):
    # support socks5h (requests compatibility):
    # https://requests.readthedocs.io/en/master/user/advanced/#socks
    # socks5://   hostname is resolved on client side
    # socks5h://  hostname is resolved on proxy side
    rdns = False
    socks5h = 'socks5h://'
    if proxy_url.startswith(socks5h):
        proxy_url = 'socks5://' + proxy_url[len(socks5h) :]
        rdns = True
 
    proxy_type, proxy_host, proxy_port, proxy_username, proxy_password = parse_proxy_url(proxy_url)
    verify = get_sslcontexts(proxy_url, None, verify, True, http2) if verify is True else verify
    return AsyncProxyTransportFixed(
        proxy_type=proxy_type,
        proxy_host=proxy_host,
        proxy_port=proxy_port,
        username=proxy_username,
        password=proxy_password,
        rdns=rdns,
        loop=get_loop(),
        verify=verify,
        http2=http2,
        local_address=local_address,
        limits=limit,
        retries=retries,
    )
 
 

References searx.network.client.get_sslcontexts().

Referenced by searx.network.client.new_client().

Here is the call graph for this function:

Here is the caller graph for this function:

init()

searx.network.client.init

(

)

Definition at line 205 of file client.py.

def init():
    # log
    for logger_name in (
        'httpx',
        'httpcore.proxy',
        'httpcore.connection',
        'httpcore.http11',
        'httpcore.http2',
        'hpack.hpack',
        'hpack.table',
    ):
        logging.getLogger(logger_name).setLevel(logging.WARNING)
 
    # loop
    def loop_thread():
        global LOOP
        LOOP = asyncio.new_event_loop()
        LOOP.run_forever()
 
    thread = threading.Thread(
        target=loop_thread,
        name='asyncio_loop',
        daemon=True,
    )
    thread.start()
 
 

new_client()

searx.network.client.new_client	(		enable_http,
			verify,
			enable_http2,
			max_connections,
			max_keepalive_connections,
			keepalive_expiry,
			proxies,
			local_address,
			retries,
			max_redirects,
			hook_log_response )

Definition at line 153 of file client.py.

):
    limit = httpx.Limits(
        max_connections=max_connections,
        max_keepalive_connections=max_keepalive_connections,
        keepalive_expiry=keepalive_expiry,
    )
    # See https://www.python-httpx.org/advanced/#routing
    mounts = {}
    for pattern, proxy_url in proxies.items():
        if not enable_http and pattern.startswith('http://'):
            continue
        if proxy_url.startswith('socks4://') or proxy_url.startswith('socks5://') or proxy_url.startswith('socks5h://'):
            mounts[pattern] = get_transport_for_socks_proxy(
                verify, enable_http2, local_address, proxy_url, limit, retries
            )
        else:
            mounts[pattern] = get_transport(verify, enable_http2, local_address, proxy_url, limit, retries)
 
    if not enable_http:
        mounts['http://'] = AsyncHTTPTransportNoHttp()
 
    transport = get_transport(verify, enable_http2, local_address, None, limit, retries)
 
    event_hooks = None
    if hook_log_response:
        event_hooks = {'response': [hook_log_response]}
 
    return httpx.AsyncClient(
        transport=transport,
        mounts=mounts,
        max_redirects=max_redirects,
        event_hooks=event_hooks,
    )
 
 

References searx.network.client.get_transport(), and searx.network.client.get_transport_for_socks_proxy().

Here is the call graph for this function:

shuffle_ciphers()

searx.network.client.shuffle_ciphers

(

ssl_context

)

Shuffle httpx's default ciphers of a SSL context randomly.

From `What Is TLS Fingerprint and How to Bypass It`_

> When implementing TLS fingerprinting, servers can't operate based on a
> locked-in whitelist database of fingerprints.  New fingerprints appear
> when web clients or TLS libraries release new versions. So, they have to
> live off a blocklist database instead.
> ...
> It's safe to leave the first three as is but shuffle the remaining ciphers
> and you can bypass the TLS fingerprint check.

.. _What Is TLS Fingerprint and How to Bypass It:
   https://www.zenrows.com/blog/what-is-tls-fingerprint#how-to-bypass-tls-fingerprinting

Definition at line 27 of file client.py.

def shuffle_ciphers(ssl_context):
    """Shuffle httpx's default ciphers of a SSL context randomly.
 
    From `What Is TLS Fingerprint and How to Bypass It`_
 
    > When implementing TLS fingerprinting, servers can't operate based on a
    > locked-in whitelist database of fingerprints.  New fingerprints appear
    > when web clients or TLS libraries release new versions. So, they have to
    > live off a blocklist database instead.
    > ...
    > It's safe to leave the first three as is but shuffle the remaining ciphers
    > and you can bypass the TLS fingerprint check.
 
    .. _What Is TLS Fingerprint and How to Bypass It:
       https://www.zenrows.com/blog/what-is-tls-fingerprint#how-to-bypass-tls-fingerprinting
 
    """
    c_list = httpx._config.DEFAULT_CIPHERS.split(':')  # pylint: disable=protected-access
    sc_list, c_list = c_list[:3], c_list[3:]
    random.shuffle(c_list)
    ssl_context.set_ciphers(":".join(sc_list + c_list))
 
 

Referenced by searx.network.client.get_sslcontexts().

Here is the caller graph for this function:

Variable Documentation

logger

searx.network.client.logger = logger.getChild('searx.network.client')

Definition at line 22 of file client.py.

LOOP

searx.network.client.LOOP = None

Definition at line 23 of file client.py.

SSLCONTEXTS

dict searx.network.client.SSLCONTEXTS = {}

Definition at line 24 of file client.py.