123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847 |
- from base64 import b64encode
- try:
- from collections.abc import Callable
- except ImportError:
- from collections import Callable
- from errno import EOPNOTSUPP, EINVAL, EAGAIN
- import functools
- from io import BytesIO
- import logging
- import os
- from os import SEEK_CUR
- import socket
- import struct
- import sys
- __version__ = "1.7.1"
- if os.name == "nt" and sys.version_info < (3, 0):
- try:
- import win_inet_pton
- except ImportError:
- raise ImportError(
- "To run PySocks on Windows you must install win_inet_pton")
- log = logging.getLogger(__name__)
- PROXY_TYPE_SOCKS4 = SOCKS4 = 1
- PROXY_TYPE_SOCKS5 = SOCKS5 = 2
- PROXY_TYPE_HTTP = HTTP = 3
- PROXY_TYPES = {"SOCKS4": SOCKS4, "SOCKS5": SOCKS5, "HTTP": HTTP}
- PRINTABLE_PROXY_TYPES = dict(zip(PROXY_TYPES.values(), PROXY_TYPES.keys()))
- _orgsocket = _orig_socket = socket.socket
- def set_self_blocking(function):
- @functools.wraps(function)
- def wrapper(*args, **kwargs):
- self = args[0]
- try:
- _is_blocking = self.gettimeout()
- if _is_blocking == 0:
- self.setblocking(True)
- return function(*args, **kwargs)
- except Exception as e:
- raise
- finally:
- # set orgin blocking
- if _is_blocking == 0:
- self.setblocking(False)
- return wrapper
- class ProxyError(IOError):
- """Socket_err contains original socket.error exception."""
- def __init__(self, msg, socket_err=None):
- self.msg = msg
- self.socket_err = socket_err
- if socket_err:
- self.msg += ": {}".format(socket_err)
- def __str__(self):
- return self.msg
- class GeneralProxyError(ProxyError):
- pass
- class ProxyConnectionError(ProxyError):
- pass
- class SOCKS5AuthError(ProxyError):
- pass
- class SOCKS5Error(ProxyError):
- pass
- class SOCKS4Error(ProxyError):
- pass
- class HTTPError(ProxyError):
- pass
- SOCKS4_ERRORS = {
- 0x5B: "Request rejected or failed",
- 0x5C: ("Request rejected because SOCKS server cannot connect to identd on"
- " the client"),
- 0x5D: ("Request rejected because the client program and identd report"
- " different user-ids")
- }
- SOCKS5_ERRORS = {
- 0x01: "General SOCKS server failure",
- 0x02: "Connection not allowed by ruleset",
- 0x03: "Network unreachable",
- 0x04: "Host unreachable",
- 0x05: "Connection refused",
- 0x06: "TTL expired",
- 0x07: "Command not supported, or protocol error",
- 0x08: "Address type not supported"
- }
- DEFAULT_PORTS = {SOCKS4: 1080, SOCKS5: 1080, HTTP: 8080}
- def set_default_proxy(proxy_type=None, addr=None, port=None, rdns=True,
- username=None, password=None):
- """Sets a default proxy.
- All further socksocket objects will use the default unless explicitly
- changed. All parameters are as for socket.set_proxy()."""
- socksocket.default_proxy = (proxy_type, addr, port, rdns,
- username.encode() if username else None,
- password.encode() if password else None)
- def setdefaultproxy(*args, **kwargs):
- if "proxytype" in kwargs:
- kwargs["proxy_type"] = kwargs.pop("proxytype")
- return set_default_proxy(*args, **kwargs)
- def get_default_proxy():
- """Returns the default proxy, set by set_default_proxy."""
- return socksocket.default_proxy
- getdefaultproxy = get_default_proxy
- def wrap_module(module):
- """Attempts to replace a module's socket library with a SOCKS socket.
- Must set a default proxy using set_default_proxy(...) first. This will
- only work on modules that import socket directly into the namespace;
- most of the Python Standard Library falls into this category."""
- if socksocket.default_proxy:
- module.socket.socket = socksocket
- else:
- raise GeneralProxyError("No default proxy specified")
- wrapmodule = wrap_module
- def create_connection(dest_pair,
- timeout=None, source_address=None,
- proxy_type=None, proxy_addr=None,
- proxy_port=None, proxy_rdns=True,
- proxy_username=None, proxy_password=None,
- socket_options=None):
- """create_connection(dest_pair, *[, timeout], **proxy_args) -> socket object
- Like socket.create_connection(), but connects to proxy
- before returning the socket object.
- dest_pair - 2-tuple of (IP/hostname, port).
- **proxy_args - Same args passed to socksocket.set_proxy() if present.
- timeout - Optional socket timeout value, in seconds.
- source_address - tuple (host, port) for the socket to bind to as its source
- address before connecting (only for compatibility)
- """
- # Remove IPv6 brackets on the remote address and proxy address.
- remote_host, remote_port = dest_pair
- if remote_host.startswith("["):
- remote_host = remote_host.strip("[]")
- if proxy_addr and proxy_addr.startswith("["):
- proxy_addr = proxy_addr.strip("[]")
- err = None
- # Allow the SOCKS proxy to be on IPv4 or IPv6 addresses.
- for r in socket.getaddrinfo(proxy_addr, proxy_port, 0, socket.SOCK_STREAM):
- family, socket_type, proto, canonname, sa = r
- sock = None
- try:
- sock = socksocket(family, socket_type, proto)
- if socket_options:
- for opt in socket_options:
- sock.setsockopt(*opt)
- if isinstance(timeout, (int, float)):
- sock.settimeout(timeout)
- if proxy_type:
- sock.set_proxy(proxy_type, proxy_addr, proxy_port, proxy_rdns,
- proxy_username, proxy_password)
- if source_address:
- sock.bind(source_address)
- sock.connect((remote_host, remote_port))
- return sock
- except (socket.error, ProxyError) as e:
- err = e
- if sock:
- sock.close()
- sock = None
- if err:
- raise err
- raise socket.error("gai returned empty list.")
- class _BaseSocket(socket.socket):
- """Allows Python 2 delegated methods such as send() to be overridden."""
- def __init__(self, *pos, **kw):
- _orig_socket.__init__(self, *pos, **kw)
- self._savedmethods = dict()
- for name in self._savenames:
- self._savedmethods[name] = getattr(self, name)
- delattr(self, name) # Allows normal overriding mechanism to work
- _savenames = list()
- def _makemethod(name):
- return lambda self, *pos, **kw: self._savedmethods[name](*pos, **kw)
- for name in ("sendto", "send", "recvfrom", "recv"):
- method = getattr(_BaseSocket, name, None)
- # Determine if the method is not defined the usual way
- # as a function in the class.
- # Python 2 uses __slots__, so there are descriptors for each method,
- # but they are not functions.
- if not isinstance(method, Callable):
- _BaseSocket._savenames.append(name)
- setattr(_BaseSocket, name, _makemethod(name))
- class socksocket(_BaseSocket):
- """socksocket([family[, type[, proto]]]) -> socket object
- Open a SOCKS enabled socket. The parameters are the same as
- those of the standard socket init. In order for SOCKS to work,
- you must specify family=AF_INET and proto=0.
- The "type" argument must be either SOCK_STREAM or SOCK_DGRAM.
- """
- default_proxy = None
- def __init__(self, family=socket.AF_INET, type=socket.SOCK_STREAM,
- proto=0, *args, **kwargs):
- if type not in (socket.SOCK_STREAM, socket.SOCK_DGRAM):
- msg = "Socket type must be stream or datagram, not {!r}"
- raise ValueError(msg.format(type))
- super(socksocket, self).__init__(family, type, proto, *args, **kwargs)
- self._proxyconn = None # TCP connection to keep UDP relay alive
- if self.default_proxy:
- self.proxy = self.default_proxy
- else:
- self.proxy = (None, None, None, None, None, None)
- self.proxy_sockname = None
- self.proxy_peername = None
- self._timeout = None
- def _readall(self, file, count):
- """Receive EXACTLY the number of bytes requested from the file object.
- Blocks until the required number of bytes have been received."""
- data = b""
- while len(data) < count:
- d = file.read(count - len(data))
- if not d:
- raise GeneralProxyError("Connection closed unexpectedly")
- data += d
- return data
- def settimeout(self, timeout):
- self._timeout = timeout
- try:
- # test if we're connected, if so apply timeout
- peer = self.get_proxy_peername()
- super(socksocket, self).settimeout(self._timeout)
- except socket.error:
- pass
- def gettimeout(self):
- return self._timeout
- def setblocking(self, v):
- if v:
- self.settimeout(None)
- else:
- self.settimeout(0.0)
- def set_proxy(self, proxy_type=None, addr=None, port=None, rdns=True,
- username=None, password=None):
- """ Sets the proxy to be used.
- proxy_type - The type of the proxy to be used. Three types
- are supported: PROXY_TYPE_SOCKS4 (including socks4a),
- PROXY_TYPE_SOCKS5 and PROXY_TYPE_HTTP
- addr - The address of the server (IP or DNS).
- port - The port of the server. Defaults to 1080 for SOCKS
- servers and 8080 for HTTP proxy servers.
- rdns - Should DNS queries be performed on the remote side
- (rather than the local side). The default is True.
- Note: This has no effect with SOCKS4 servers.
- username - Username to authenticate with to the server.
- The default is no authentication.
- password - Password to authenticate with to the server.
- Only relevant when username is also provided."""
- self.proxy = (proxy_type, addr, port, rdns,
- username.encode() if username else None,
- password.encode() if password else None)
- def setproxy(self, *args, **kwargs):
- if "proxytype" in kwargs:
- kwargs["proxy_type"] = kwargs.pop("proxytype")
- return self.set_proxy(*args, **kwargs)
- def bind(self, *pos, **kw):
- """Implements proxy connection for UDP sockets.
- Happens during the bind() phase."""
- (proxy_type, proxy_addr, proxy_port, rdns, username,
- password) = self.proxy
- if not proxy_type or self.type != socket.SOCK_DGRAM:
- return _orig_socket.bind(self, *pos, **kw)
- if self._proxyconn:
- raise socket.error(EINVAL, "Socket already bound to an address")
- if proxy_type != SOCKS5:
- msg = "UDP only supported by SOCKS5 proxy type"
- raise socket.error(EOPNOTSUPP, msg)
- super(socksocket, self).bind(*pos, **kw)
- # Need to specify actual local port because
- # some relays drop packets if a port of zero is specified.
- # Avoid specifying host address in case of NAT though.
- _, port = self.getsockname()
- dst = ("0", port)
- self._proxyconn = _orig_socket()
- proxy = self._proxy_addr()
- self._proxyconn.connect(proxy)
- UDP_ASSOCIATE = b"\x03"
- _, relay = self._SOCKS5_request(self._proxyconn, UDP_ASSOCIATE, dst)
- # The relay is most likely on the same host as the SOCKS proxy,
- # but some proxies return a private IP address (10.x.y.z)
- host, _ = proxy
- _, port = relay
- super(socksocket, self).connect((host, port))
- super(socksocket, self).settimeout(self._timeout)
- self.proxy_sockname = ("0.0.0.0", 0) # Unknown
- def sendto(self, bytes, *args, **kwargs):
- if self.type != socket.SOCK_DGRAM:
- return super(socksocket, self).sendto(bytes, *args, **kwargs)
- if not self._proxyconn:
- self.bind(("", 0))
- address = args[-1]
- flags = args[:-1]
- header = BytesIO()
- RSV = b"\x00\x00"
- header.write(RSV)
- STANDALONE = b"\x00"
- header.write(STANDALONE)
- self._write_SOCKS5_address(address, header)
- sent = super(socksocket, self).send(header.getvalue() + bytes, *flags,
- **kwargs)
- return sent - header.tell()
- def send(self, bytes, flags=0, **kwargs):
- if self.type == socket.SOCK_DGRAM:
- return self.sendto(bytes, flags, self.proxy_peername, **kwargs)
- else:
- return super(socksocket, self).send(bytes, flags, **kwargs)
- def recvfrom(self, bufsize, flags=0):
- if self.type != socket.SOCK_DGRAM:
- return super(socksocket, self).recvfrom(bufsize, flags)
- if not self._proxyconn:
- self.bind(("", 0))
- buf = BytesIO(super(socksocket, self).recv(bufsize + 1024, flags))
- buf.seek(2, SEEK_CUR)
- frag = buf.read(1)
- if ord(frag):
- raise NotImplementedError("Received UDP packet fragment")
- fromhost, fromport = self._read_SOCKS5_address(buf)
- if self.proxy_peername:
- peerhost, peerport = self.proxy_peername
- if fromhost != peerhost or peerport not in (0, fromport):
- raise socket.error(EAGAIN, "Packet filtered")
- return (buf.read(bufsize), (fromhost, fromport))
- def recv(self, *pos, **kw):
- bytes, _ = self.recvfrom(*pos, **kw)
- return bytes
- def close(self):
- if self._proxyconn:
- self._proxyconn.close()
- return super(socksocket, self).close()
- def get_proxy_sockname(self):
- """Returns the bound IP address and port number at the proxy."""
- return self.proxy_sockname
- getproxysockname = get_proxy_sockname
- def get_proxy_peername(self):
- """
- Returns the IP and port number of the proxy.
- """
- return self.getpeername()
- getproxypeername = get_proxy_peername
- def get_peername(self):
- """Returns the IP address and port number of the destination machine.
- Note: get_proxy_peername returns the proxy."""
- return self.proxy_peername
- getpeername = get_peername
- def _negotiate_SOCKS5(self, *dest_addr):
- """Negotiates a stream connection through a SOCKS5 server."""
- CONNECT = b"\x01"
- self.proxy_peername, self.proxy_sockname = self._SOCKS5_request(
- self, CONNECT, dest_addr)
- def _SOCKS5_request(self, conn, cmd, dst):
- """
- Send SOCKS5 request with given command (CMD field) and
- address (DST field). Returns resolved DST address that was used.
- """
- proxy_type, addr, port, rdns, username, password = self.proxy
- writer = conn.makefile("wb")
- reader = conn.makefile("rb", 0) # buffering=0 renamed in Python 3
- try:
- # First we'll send the authentication packages we support.
- if username and password:
- # The username/password details were supplied to the
- # set_proxy method so we support the USERNAME/PASSWORD
- # authentication (in addition to the standard none).
- writer.write(b"\x05\x02\x00\x02")
- else:
- # No username/password were entered, therefore we
- # only support connections with no authentication.
- writer.write(b"\x05\x01\x00")
- # We'll receive the server's response to determine which
- # method was selected
- writer.flush()
- chosen_auth = self._readall(reader, 2)
- if chosen_auth[0:1] != b"\x05":
- # Note: string[i:i+1] is used because indexing of a bytestring
- # via bytestring[i] yields an integer in Python 3
- raise GeneralProxyError(
- "SOCKS5 proxy server sent invalid data")
- # Check the chosen authentication method
- if chosen_auth[1:2] == b"\x02":
- # Okay, we need to perform a basic username/password
- # authentication.
- if not (username and password):
- # Although we said we don't support authentication, the
- # server may still request basic username/password
- # authentication
- raise SOCKS5AuthError("No username/password supplied. "
- "Server requested username/password"
- " authentication")
- writer.write(b"\x01" + chr(len(username)).encode()
- + username
- + chr(len(password)).encode()
- + password)
- writer.flush()
- auth_status = self._readall(reader, 2)
- if auth_status[0:1] != b"\x01":
- # Bad response
- raise GeneralProxyError(
- "SOCKS5 proxy server sent invalid data")
- if auth_status[1:2] != b"\x00":
- # Authentication failed
- raise SOCKS5AuthError("SOCKS5 authentication failed")
- # Otherwise, authentication succeeded
- # No authentication is required if 0x00
- elif chosen_auth[1:2] != b"\x00":
- # Reaching here is always bad
- if chosen_auth[1:2] == b"\xFF":
- raise SOCKS5AuthError(
- "All offered SOCKS5 authentication methods were"
- " rejected")
- else:
- raise GeneralProxyError(
- "SOCKS5 proxy server sent invalid data")
- # Now we can request the actual connection
- writer.write(b"\x05" + cmd + b"\x00")
- resolved = self._write_SOCKS5_address(dst, writer)
- writer.flush()
- # Get the response
- resp = self._readall(reader, 3)
- if resp[0:1] != b"\x05":
- raise GeneralProxyError(
- "SOCKS5 proxy server sent invalid data")
- status = ord(resp[1:2])
- if status != 0x00:
- # Connection failed: server returned an error
- error = SOCKS5_ERRORS.get(status, "Unknown error")
- raise SOCKS5Error("{:#04x}: {}".format(status, error))
- # Get the bound address/port
- bnd = self._read_SOCKS5_address(reader)
- super(socksocket, self).settimeout(self._timeout)
- return (resolved, bnd)
- finally:
- reader.close()
- writer.close()
- def _write_SOCKS5_address(self, addr, file):
- """
- Return the host and port packed for the SOCKS5 protocol,
- and the resolved address as a tuple object.
- """
- host, port = addr
- proxy_type, _, _, rdns, username, password = self.proxy
- family_to_byte = {socket.AF_INET: b"\x01", socket.AF_INET6: b"\x04"}
- # If the given destination address is an IP address, we'll
- # use the IP address request even if remote resolving was specified.
- # Detect whether the address is IPv4/6 directly.
- for family in (socket.AF_INET, socket.AF_INET6):
- try:
- addr_bytes = socket.inet_pton(family, host)
- file.write(family_to_byte[family] + addr_bytes)
- host = socket.inet_ntop(family, addr_bytes)
- file.write(struct.pack(">H", port))
- return host, port
- except socket.error:
- continue
- # Well it's not an IP number, so it's probably a DNS name.
- if rdns:
- # Resolve remotely
- host_bytes = host.encode("idna")
- file.write(b"\x03" + chr(len(host_bytes)).encode() + host_bytes)
- else:
- # Resolve locally
- addresses = socket.getaddrinfo(host, port, socket.AF_UNSPEC,
- socket.SOCK_STREAM,
- socket.IPPROTO_TCP,
- socket.AI_ADDRCONFIG)
- # We can't really work out what IP is reachable, so just pick the
- # first.
- target_addr = addresses[0]
- family = target_addr[0]
- host = target_addr[4][0]
- addr_bytes = socket.inet_pton(family, host)
- file.write(family_to_byte[family] + addr_bytes)
- host = socket.inet_ntop(family, addr_bytes)
- file.write(struct.pack(">H", port))
- return host, port
- def _read_SOCKS5_address(self, file):
- atyp = self._readall(file, 1)
- if atyp == b"\x01":
- addr = socket.inet_ntoa(self._readall(file, 4))
- elif atyp == b"\x03":
- length = self._readall(file, 1)
- addr = self._readall(file, ord(length))
- elif atyp == b"\x04":
- addr = socket.inet_ntop(socket.AF_INET6, self._readall(file, 16))
- else:
- raise GeneralProxyError("SOCKS5 proxy server sent invalid data")
- port = struct.unpack(">H", self._readall(file, 2))[0]
- return addr, port
- def _negotiate_SOCKS4(self, dest_addr, dest_port):
- """Negotiates a connection through a SOCKS4 server."""
- proxy_type, addr, port, rdns, username, password = self.proxy
- writer = self.makefile("wb")
- reader = self.makefile("rb", 0) # buffering=0 renamed in Python 3
- try:
- # Check if the destination address provided is an IP address
- remote_resolve = False
- try:
- addr_bytes = socket.inet_aton(dest_addr)
- except socket.error:
- # It's a DNS name. Check where it should be resolved.
- if rdns:
- addr_bytes = b"\x00\x00\x00\x01"
- remote_resolve = True
- else:
- addr_bytes = socket.inet_aton(
- socket.gethostbyname(dest_addr))
- # Construct the request packet
- writer.write(struct.pack(">BBH", 0x04, 0x01, dest_port))
- writer.write(addr_bytes)
- # The username parameter is considered userid for SOCKS4
- if username:
- writer.write(username)
- writer.write(b"\x00")
- # DNS name if remote resolving is required
- # NOTE: This is actually an extension to the SOCKS4 protocol
- # called SOCKS4A and may not be supported in all cases.
- if remote_resolve:
- writer.write(dest_addr.encode("idna") + b"\x00")
- writer.flush()
- # Get the response from the server
- resp = self._readall(reader, 8)
- if resp[0:1] != b"\x00":
- # Bad data
- raise GeneralProxyError(
- "SOCKS4 proxy server sent invalid data")
- status = ord(resp[1:2])
- if status != 0x5A:
- # Connection failed: server returned an error
- error = SOCKS4_ERRORS.get(status, "Unknown error")
- raise SOCKS4Error("{:#04x}: {}".format(status, error))
- # Get the bound address/port
- self.proxy_sockname = (socket.inet_ntoa(resp[4:]),
- struct.unpack(">H", resp[2:4])[0])
- if remote_resolve:
- self.proxy_peername = socket.inet_ntoa(addr_bytes), dest_port
- else:
- self.proxy_peername = dest_addr, dest_port
- finally:
- reader.close()
- writer.close()
- def _negotiate_HTTP(self, dest_addr, dest_port):
- """Negotiates a connection through an HTTP server.
- NOTE: This currently only supports HTTP CONNECT-style proxies."""
- proxy_type, addr, port, rdns, username, password = self.proxy
- # If we need to resolve locally, we do this now
- addr = dest_addr if rdns else socket.gethostbyname(dest_addr)
- http_headers = [
- (b"CONNECT " + addr.encode("idna") + b":"
- + str(dest_port).encode() + b" HTTP/1.1"),
- b"Host: " + dest_addr.encode("idna")
- ]
- if username and password:
- http_headers.append(b"Proxy-Authorization: basic "
- + b64encode(username + b":" + password))
- http_headers.append(b"\r\n")
- self.sendall(b"\r\n".join(http_headers))
- # We just need the first line to check if the connection was successful
- fobj = self.makefile()
- status_line = fobj.readline()
- fobj.close()
- if not status_line:
- raise GeneralProxyError("Connection closed unexpectedly")
- try:
- proto, status_code, status_msg = status_line.split(" ", 2)
- except ValueError:
- raise GeneralProxyError("HTTP proxy server sent invalid response")
- if not proto.startswith("HTTP/"):
- raise GeneralProxyError(
- "Proxy server does not appear to be an HTTP proxy")
- try:
- status_code = int(status_code)
- except ValueError:
- raise HTTPError(
- "HTTP proxy server did not return a valid HTTP status")
- if status_code != 200:
- error = "{}: {}".format(status_code, status_msg)
- if status_code in (400, 403, 405):
- # It's likely that the HTTP proxy server does not support the
- # CONNECT tunneling method
- error += ("\n[*] Note: The HTTP proxy server may not be"
- " supported by PySocks (must be a CONNECT tunnel"
- " proxy)")
- raise HTTPError(error)
- self.proxy_sockname = (b"0.0.0.0", 0)
- self.proxy_peername = addr, dest_port
- _proxy_negotiators = {
- SOCKS4: _negotiate_SOCKS4,
- SOCKS5: _negotiate_SOCKS5,
- HTTP: _negotiate_HTTP
- }
- @set_self_blocking
- def connect(self, dest_pair, catch_errors=None):
- """
- Connects to the specified destination through a proxy.
- Uses the same API as socket's connect().
- To select the proxy server, use set_proxy().
- dest_pair - 2-tuple of (IP/hostname, port).
- """
- if len(dest_pair) != 2 or dest_pair[0].startswith("["):
- # Probably IPv6, not supported -- raise an error, and hope
- # Happy Eyeballs (RFC6555) makes sure at least the IPv4
- # connection works...
- raise socket.error("PySocks doesn't support IPv6: %s"
- % str(dest_pair))
- dest_addr, dest_port = dest_pair
- if self.type == socket.SOCK_DGRAM:
- if not self._proxyconn:
- self.bind(("", 0))
- dest_addr = socket.gethostbyname(dest_addr)
- # If the host address is INADDR_ANY or similar, reset the peer
- # address so that packets are received from any peer
- if dest_addr == "0.0.0.0" and not dest_port:
- self.proxy_peername = None
- else:
- self.proxy_peername = (dest_addr, dest_port)
- return
- (proxy_type, proxy_addr, proxy_port, rdns, username,
- password) = self.proxy
- # Do a minimal input check first
- if (not isinstance(dest_pair, (list, tuple))
- or len(dest_pair) != 2
- or not dest_addr
- or not isinstance(dest_port, int)):
- # Inputs failed, raise an error
- raise GeneralProxyError(
- "Invalid destination-connection (host, port) pair")
- # We set the timeout here so that we don't hang in connection or during
- # negotiation.
- super(socksocket, self).settimeout(self._timeout)
- if proxy_type is None:
- # Treat like regular socket object
- self.proxy_peername = dest_pair
- super(socksocket, self).settimeout(self._timeout)
- super(socksocket, self).connect((dest_addr, dest_port))
- return
- proxy_addr = self._proxy_addr()
- try:
- # Initial connection to proxy server.
- super(socksocket, self).connect(proxy_addr)
- except socket.error as error:
- # Error while connecting to proxy
- self.close()
- if not catch_errors:
- proxy_addr, proxy_port = proxy_addr
- proxy_server = "{}:{}".format(proxy_addr, proxy_port)
- printable_type = PRINTABLE_PROXY_TYPES[proxy_type]
- msg = "Error connecting to {} proxy {}".format(printable_type,
- proxy_server)
- log.debug("%s due to: %s", msg, error)
- raise ProxyConnectionError(msg, error)
- else:
- raise error
- else:
- # Connected to proxy server, now negotiate
- try:
- # Calls negotiate_{SOCKS4, SOCKS5, HTTP}
- negotiate = self._proxy_negotiators[proxy_type]
- negotiate(self, dest_addr, dest_port)
- except socket.error as error:
- if not catch_errors:
- # Wrap socket errors
- self.close()
- raise GeneralProxyError("Socket error", error)
- else:
- raise error
- except ProxyError:
- # Protocol error while negotiating with proxy
- self.close()
- raise
-
- @set_self_blocking
- def connect_ex(self, dest_pair):
- """ https://docs.python.org/3/library/socket.html#socket.socket.connect_ex
- Like connect(address), but return an error indicator instead of raising an exception for errors returned by the C-level connect() call (other problems, such as "host not found" can still raise exceptions).
- """
- try:
- self.connect(dest_pair, catch_errors=True)
- return 0
- except OSError as e:
- # If the error is numeric (socket errors are numeric), then return number as
- # connect_ex expects. Otherwise raise the error again (socket timeout for example)
- if e.errno:
- return e.errno
- else:
- raise
- def _proxy_addr(self):
- """
- Return proxy address to connect to as tuple object
- """
- (proxy_type, proxy_addr, proxy_port, rdns, username,
- password) = self.proxy
- proxy_port = proxy_port or DEFAULT_PORTS.get(proxy_type)
- if not proxy_port:
- raise GeneralProxyError("Invalid proxy type")
- return proxy_addr, proxy_port
|