socks_router.models

Attributes

`SOCKS_VERSION`
`PackingSequence`
`RecursiveMapping`
`PACKABLE_DEFERRED_FORMAT`
`PACKABLE_VARIABLE_LENGTH_DECLARATION_FORMAT`
`Address`
`RoutingEntry`
`RoutingTable`
`Socks5Addresses`
`Socks5AddressTypes`
`Upstream`

Classes

`Packable`	Base class for protocol classes.
`SupportsUnbytes`	Base class for protocol classes.
`SocketAddress`
`IPv4`
`IPv6`
`Host`
`Socks5Method`	SEE: https://datatracker.ietf.org/doc/html/rfc1928#section-3
`Socks5Command`	SEE: https://datatracker.ietf.org/doc/html/rfc1928#section-4
`Socks5AddressType`	SEE: https://datatracker.ietf.org/doc/html/rfc1928#section-4
`Socks5MethodSelectionRequest`	Socks5 Header.
`Socks5MethodSelectionResponse`	Socks5 Method Selection Response
`Socks5Address`
`Socks5Request`	SEE: https://datatracker.ietf.org/doc/html/rfc1928#section-4
`Socks5ReplyType`	SEE: https://datatracker.ietf.org/doc/html/rfc1928#section-6
`Socks5Reply`	Socks5 Reply
`Socks5State`	Enum where members are also (and must be) strings
`Pattern`
`UpstreamScheme`	Enum where members are also (and must be) strings
`UpstreamAddress`
`SSHUpstream`
`ProxyUpstream`
`RetryOptions`
`ApplicationContext`

Module Contents

SOCKS_VERSION: Literal[5] = 5

PackingSequence: TypeAlias = str | tuple[str, str]

RecursiveMapping: TypeAlias = Mapping[K, V | RecursiveMapping[K, V]]

PACKABLE_DEFERRED_FORMAT: Final[str] = '&'

PACKABLE_VARIABLE_LENGTH_DECLARATION_FORMAT: Final[str] = '%*'

class Packable[source]

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

classmethod __pack_format__() → str[source]

class SupportsUnbytes[source]

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

classmethod __unbytes__(input: bytes) → Self[source]

Abstractmethod:

class SocketAddress[source]

address: Any

port: Annotated[Optional[int], !H] = None

__str__()[source]

property sockaddr: tuple[str, int]

with_port(port: int | None) → Self[source]

with_default_port(port: int) → Self[source]

property url_literal: str

class IPv4(address: str | IPv4, *argv, **kwargs)[source]

Bases: SocketAddress

address: IPv4

class IPv4Address(address)[source]

Bases: ipaddress.IPv4Address

Represent and manipulate single IPv4 Addresses.

classmethod __pack_format__() → str[source]

__bytes__() → bytes[source]

classmethod __unbytes__(input: bytes) → Self[source]

class IPv6(address: str | IPv6, *argv, **kwargs)[source]

Bases: SocketAddress

address: IPv6

class IPv6Address(address)[source]

Bases: ipaddress.IPv6Address

Represent and manipulate single IPv6 Addresses.

classmethod __pack_format__() → str[source]

__bytes__() → bytes[source]

classmethod __unbytes__(input: bytes) → Self[source]

property url_literal: str

//www.ietf.org/rfc/rfc2732.txt

Type:: SEE
Type:: https

class Host[source]

Bases: SocketAddress

address: Annotated[str, !B%*s]

Address: TypeAlias = IPv4 | IPv6 | Host

class Socks5Method[source]

Bases: enum.IntEnum

SEE: https://datatracker.ietf.org/doc/html/rfc1928#section-3

NO_AUTHENTICATION_REQUIRED = 0

GSSAPI = 1

USERNAME_PASSWORD = 2

NO_ACCEPTABLE_METHODS = 255

classmethod __pack_format__() → str[source]

class Socks5Command[source]

Bases: enum.IntEnum

SEE: https://datatracker.ietf.org/doc/html/rfc1928#section-4

CONNECT = 1

BIND = 2

UDP_ASSOCIATE = 3

classmethod __pack_format__() → str[source]

class Socks5AddressType[source]

Bases: enum.IntEnum

SEE: https://datatracker.ietf.org/doc/html/rfc1928#section-4

IPv4 = 1

DOMAINNAME = 3

IPv6 = 4

classmethod __pack_format__() → str[source]

class Socks5MethodSelectionRequest[source]

version: Annotated[int, !B]

methods: Annotated[list[int], !B%*B]

class Socks5MethodSelectionResponse[source]

version: Annotated[int, !B]

method: Socks5Method

class Socks5Address[source]

classmethod address_type(type: Literal[Socks5AddressType]) → Type[IPv4][source]
classmethod address_type(type: Literal[Socks5AddressType]) → Type[Host]
classmethod address_type(type: Literal[Socks5AddressType]) → Type[IPv6]