slippers-proxy 0.3.0

No project description provided

Slippers is a lightweight, zero-dependency SOCKS5 proxy that runs locally and transparently forwards traffic to an upstream SOCKS5 proxy requiring authentication. It allows clients that don't support SOCKS5 authentication (like some browsers) to use an authenticated proxy indirectly.

Installation

pip install slippers-proxy

CLI Usage

python -m slippers "socks5://username:[e-mail]:1080"

By default, slippers listens on localhost:1080

You can now use your local unauthenticated SOCKS5 endpoint

curl --socks5-hostname "socks5://127.0.0.1:1080" https://ifconfig.io/country_code
US

python -m slippers "socks5://username:[e-mail]:1080"
16:04:07 [INFO] Listening on localhost:1080 (4)
16:04:09 [INFO] Tunnel from 127.0.0.1:64633 (7) to my-socks-server.net:1080 (8) established
16:04:10 [INFO] Tunnel from 127.0.0.1:64633 (7) to my-socks-server.net:1080 (8) closed

Programmatic Usage

import os
import slippers
from playwright.sync_api import sync_playwright

username = os.getenv("SOCKS_USERNAME")
password = os.getenv("SOCKS_PASSWORD")


def main():
    with (
        sync_playwright() as p,
        slippers.Proxy(
            f"socks5://{username}:{password}@my-socks-server.net:1080"
        ) as proxy,
    ):
        browser = p.chromium.launch(
            headless=True,
            proxy={"server": proxy.url(dns=True)},  # point to slippers local server
        )
        page = browser.new_page()
        page.goto("https://ifconfig.io/country_code", wait_until="domcontentloaded")
        print(page.text_content("body").strip())
        browser.close()


if __name__ == "__main__":
    main()

API

class slippers.Proxy(proxy: str, host: str = "localhost", port: int = 1080)

Create a handler for a local, unauthenticated SOCKS5 server which forwards traffic to an upstream authenticated SOCKS5 proxy.

    start() -> None

    Start the local proxy in a background process. Once started it can start accepting connections.

    stop() -> None

    Stop the background proxy process (if running).

    url(dns: bool = False) -> str

    Return the SOCKS5 URL string. If dns is True then the scheme will be socks5h which clients use to connect with DNS resolution from the upstream SOCKS5 server.

    __enter__() -> Self

    Start the proxy and return the Proxy object.

    __exit__(exc_type, exc_value, traceback) -> None

    Stop the proxy when exiting the with block.