[Python-modules-commits] [python-socksipy] 01/10: Import python-socksipy_1.5.6.orig.tar.gz
Ondřej Nový
onovy-guest at moszumanska.debian.org
Sat Apr 30 20:58:45 UTC 2016
This is an automated email from the git hooks/post-receive script.
onovy-guest pushed a commit to branch master
in repository python-socksipy.
commit 9c35952cf9ce55438e3d12921c691d7a4f676f55
Author: Ondřej Nový <novy at ondrej.org>
Date: Sat Apr 30 22:20:27 2016 +0200
Import python-socksipy_1.5.6.orig.tar.gz
---
LICENSE | 22 --
PKG-INFO | 11 +
README.md | 292 ---------------------------
setup.py | 8 +-
socks.py | 560 +++++++++++++++++++++++++++++++++++----------------
sockshandler.py | 60 +++++-
test/README | 5 -
test/httpproxy.py | 137 -------------
test/mocks.conf | 104 ----------
test/socks4server.py | 14 --
test/sockstest.py | 174 ----------------
test/test.sh | 17 --
12 files changed, 449 insertions(+), 955 deletions(-)
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index 04b6b1f..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,22 +0,0 @@
-Copyright 2006 Dan-Haim. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
-1. Redistributions of source code must retain the above copyright notice, this
- list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
-3. Neither the name of Dan Haim nor the names of his contributors may be used
- to endorse or promote products derived from this software without specific
- prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY DAN HAIM "AS IS" AND ANY EXPRESS OR IMPLIED
-WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
-EVENT SHALL DAN HAIM OR HIS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
-INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA
-OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
-OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMANGE.
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..8c9058e
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,11 @@
+Metadata-Version: 1.0
+Name: PySocks
+Version: 1.5.6
+Summary: A Python SOCKS client module. See https://github.com/Anorov/PySocks for more information.
+Home-page: https://github.com/Anorov/PySocks
+Author: Anorov
+Author-email: anorov.vorona at gmail.com
+License: BSD
+Description: UNKNOWN
+Keywords: socks,proxy
+Platform: UNKNOWN
diff --git a/README.md b/README.md
deleted file mode 100644
index ad8ce9f..0000000
--- a/README.md
+++ /dev/null
@@ -1,292 +0,0 @@
-PySocks
-=======
-
-Updated version of SocksiPy. Many old bugs fixed, and overall code cleanup.
-
-**Version:** 1.5.0
-
-----------------
-
-Features
-========
-
-* Fully supports Python 2.6 - 3.4
-
-* SocksiPyHandler, courtesy e000, was also added as an example of how this module can be used with urllib2. See example code in sockshandler.py.
-
-* Bugs in the original SocksiPy were fixed, including two that could lead to infinite hanging when communicating with bad proxy servers.
-
-* urllib3, which powers the requests module, is working on integrating SOCKS proxy support based on this branch
-
-* `SOCKS5`, `SOCKS4`, and `HTTP` are now aliases for `PROXY_TYPE_SOCKS5`, `PROXY_TYPE_SOCKS4`, and `PROXY_TYPE_HTTP`
-
-* Tests added
-
-* Various style and performance improvements; codebase simplified
-
-* Actively maintained
-
-Installation
-============
-
- pip install PySocks
-
-Or download the tarball / `git clone` and...
-
- python setup.py install
-
-Alternatively, include just `socks.py` in your project.
-
---------------------------------------------
-
-*Warning:* PySocks/SocksiPy only supports HTTP proxies that use CONNECT tunneling. Certain HTTP proxies may not work with this library. If you wish to use HTTP proxies (and not SOCKS proxies), it is recommended that you rely on your HTTP client's native proxy support (`proxies` dict for `requests`, or `urllib2.ProxyHandler` for `urllib2`) instead.
-
---------------------------------------------
-
-Usage
-=====
-
-## Example ##
-
- import socks
-
- s = socks.socksocket()
-
- s.set_proxy(socks.SOCKS5, "localhost") # SOCKS4 and SOCKS5 use port 1080 by default
- # Or
- s.set_proxy(socks.SOCKS4, "localhost", 4444)
- # Or
- s.set_proxy(socks.HTTP, "5.5.5.5", 8888)
-
- # Can be treated identical to a regular socket object
- s.connect(("www.test.com", 80))
- s.sendall("GET / ...")
- print s.recv(4096)
-
-
-To monkeypatch the entire standard library with a single default proxy:
-
- import socket
- import socks
- import urllib2
-
- socks.set_default_proxy(socks.SOCKS5, "localhost")
- socket.socket = socks.socksocket
-
- urllib2.urlopen("http://...") # All requests will pass through the SOCKS proxy
-
-Note that monkeypatching may not work for all standard modules or for all third party modules, and generally isn't recommended.
-
---------------------------------------------
-
-Original SocksiPy README attached below, amended to reflect API changes.
-
---------------------------------------------
-
-SocksiPy - version 1.5.0
-
-A Python SOCKS module.
-
-(C) 2006 Dan-Haim. All rights reserved.
-
-See LICENSE file for details.
-
-
-*WHAT IS A SOCKS PROXY?*
-
-A SOCKS proxy is a proxy server at the TCP level. In other words, it acts as
-a tunnel, relaying all traffic going through it without modifying it.
-SOCKS proxies can be used to relay traffic using any network protocol that
-uses TCP.
-
-*WHAT IS SOCKSIPY?*
-
-This Python module allows you to create TCP connections through a SOCKS
-proxy without any special effort.
-
-*PROXY COMPATIBILITY*
-
-SocksiPy is compatible with three different types of proxies:
-1. SOCKS Version 4 (SOCKS4), including the SOCKS4a extension.
-2. SOCKS Version 5 (SOCKS5).
-3. HTTP Proxies which support tunneling using the CONNECT method.
-
-*SYSTEM REQUIREMENTS*
-
-Being written in Python, SocksiPy can run on any platform that has a Python
-interpreter and TCP/IP support.
-This module has been tested with Python 2.3 and should work with greater versions
-just as well.
-
-
-INSTALLATION
--------------
-
-Simply copy the file "socks.py" to your Python's `lib/site-packages` directory,
-and you're ready to go. [Editor's note: it is better to use `python setup.py install` for PySocks]
-
-
-USAGE
-------
-
-First load the socks module with the command:
-
- >>> import socks
- >>>
-
-The socks module provides a class called `socksocket`, which is the base to
-all of the module's functionality.
-The `socksocket` object has the same initialization parameters as the normal socket
-object to ensure maximal compatibility, however it should be noted that `socksocket`
-will only function with family being `AF_INET` and type being `SOCK_STREAM`.
-Generally, it is best to initialize the `socksocket` object with no parameters
-
- >>> s = socks.socksocket()
- >>>
-
-The `socksocket` object has an interface which is very similiar to socket's (in fact
-the `socksocket` class is derived from socket) with a few extra methods.
-To select the proxy server you would like to use, use the `set_proxy` method, whose
-syntax is:
-
- set_proxy(proxy_type, addr[, port[, rdns[, username[, password]]]])
-
-Explanation of the parameters:
-
-`proxy_type` - The type of the proxy server. This can be one of three possible
-choices: `PROXY_TYPE_SOCKS4`, `PROXY_TYPE_SOCKS5` and `PROXY_TYPE_HTTP` for SOCKS4,
-SOCKS5 and HTTP servers respectively. `SOCKS4`, `SOCKS5`, and `HTTP` are all aliases, respectively.
-
-`addr` - The IP address or DNS name of the proxy server.
-
-`port` - The port of the proxy server. Defaults to 1080 for socks and 8080 for http.
-
-`rdns` - This is a boolean flag than modifies the behavior regarding DNS resolving.
-If it is set to True, DNS resolving will be preformed remotely, on the server.
-If it is set to False, DNS resolving will be preformed locally. Please note that
-setting this to True with SOCKS4 servers actually use an extension to the protocol,
-called SOCKS4a, which may not be supported on all servers (SOCKS5 and http servers
-always support DNS). The default is True.
-
-`username` - For SOCKS5 servers, this allows simple username / password authentication
-with the server. For SOCKS4 servers, this parameter will be sent as the userid.
-This parameter is ignored if an HTTP server is being used. If it is not provided,
-authentication will not be used (servers may accept unauthenticated requests).
-
-`password` - This parameter is valid only for SOCKS5 servers and specifies the
-respective password for the username provided.
-
-Example of usage:
-
- >>> s.set_proxy(socks.SOCKS5, "socks.example.com") # uses default port 1080
- >>> s.set_proxy(socks.SOCKS4, "socks.test.com", 1081)
-
-After the set_proxy method has been called, simply call the connect method with the
-traditional parameters to establish a connection through the proxy:
-
- >>> s.connect(("www.sourceforge.net", 80))
- >>>
-
-Connection will take a bit longer to allow negotiation with the proxy server.
-Please note that calling connect without calling `set_proxy` earlier will connect
-without a proxy (just like a regular socket).
-
-Errors: Any errors in the connection process will trigger exceptions. The exception
-may either be generated by the underlying socket layer or may be custom module
-exceptions, whose details follow:
-
-class `ProxyError` - This is a base exception class. It is not raised directly but
-rather all other exception classes raised by this module are derived from it.
-This allows an easy way to catch all proxy-related errors. It descends from `IOError`.
-
-All `ProxyError` exceptions have an attribute `socket_err`, which will contain either a
-caught `socket.error` exception, or `None` if there wasn't any.
-
-class `GeneralProxyError` - When thrown, it indicates a problem which does not fall
-into another category.
-
-* `Sent invalid data` - This error means that unexpected data has been received from
-the server. The most common reason is that the server specified as the proxy is
-not really a SOCKS4/SOCKS5/HTTP proxy, or maybe the proxy type specified is wrong.
-
-* `Connection closed unexpectedly` - The proxy server unexpectedly closed the connection.
-This may indicate that the proxy server is experiencing network or software problems.
-
-* `Bad proxy type` - This will be raised if the type of the proxy supplied to the
-set_proxy function was not one of `SOCKS4`/`SOCKS5`/`HTTP`.
-
-* `Bad input` - This will be raised if the `connect()` method is called with bad input
-parameters.
-
-class `SOCKS5AuthError` - This indicates that the connection through a SOCKS5 server
-failed due to an authentication problem.
-
-* `Authentication is required` - This will happen if you use a SOCKS5 server which
-requires authentication without providing a username / password at all.
-
-* `All offered authentication methods were rejected` - This will happen if the proxy
-requires a special authentication method which is not supported by this module.
-
-* `Unknown username or invalid password` - Self descriptive.
-
-class `SOCKS5Error` - This will be raised for SOCKS5 errors which are not related to
-authentication. The parameter is a tuple containing a code and a description of the
-error, as given by the server. The possible errors, according to the RFC are:
-
-`0x01` - General SOCKS server failure - If for any reason the proxy server is unable to
-fulfill your request (internal server error).
-`0x02` - connection not allowed by ruleset - If the address you're trying to connect to
-is blacklisted on the server or requires authentication.
-`0x03` - Network unreachable - The target could not be contacted. A router on the network
-had replied with a destination net unreachable error.
-`0x04` - Host unreachable - The target could not be contacted. A router on the network
-had replied with a destination host unreachable error.
-`0x05` - Connection refused - The target server has actively refused the connection
-(the requested port is closed).
-`0x06` - TTL expired - The TTL value of the SYN packet from the proxy to the target server
-has expired. This usually means that there are network problems causing the packet
-to be caught in a router-to-router "ping-pong".
-`0x07` - Command not supported - The client has issued an invalid command. When using this
-module, this error should not occur.
-`0x08` - Address type not supported - The client has provided an invalid address type.
-When using this module, this error should not occur.
-
-class `SOCKS4Error` - This will be raised for SOCKS4 errors. The parameter is a tuple
-containing a code and a description of the error, as given by the server. The
-possible error, according to the specification are:
-
-`0x5B` - Request rejected or failed - Will be raised in the event of an failure for any
-reason other then the two mentioned next.
-`0x5C` - request rejected because SOCKS server cannot connect to identd on the client -
-The Socks server had tried an ident lookup on your computer and has failed. In this
-case you should run an identd server and/or configure your firewall to allow incoming
-connections to local port 113 from the remote server.
-`0x5D` - request rejected because the client program and identd report different user-ids -
-The Socks server had performed an ident lookup on your computer and has received a
-different userid than the one you have provided. Change your userid (through the
-username parameter of the set_proxy method) to match and try again.
-
-class `HTTPError` - This will be raised for HTTP errors. The message will contain
-the HTTP status code and provided error message.
-
-After establishing the connection, the object behaves like a standard socket.
-Methods like `makefile()` and `settimeout()` should behave just like regular sockets.
-Call the `close()` method to close the connection.
-
-In addition to the `socksocket` class, an additional function worth mentioning is the
-`set_default_proxy` function. The parameters are the same as the `set_proxy` method.
-This function will set default proxy settings for newly created `socksocket` objects,
-in which the proxy settings haven't been changed via the `set_proxy` method.
-This is quite useful if you wish to force 3rd party modules to use a SOCKS proxy,
-by overriding the socket object.
-For example:
-
- >>> socks.set_default_proxy(socks.SOCKS5, "socks.example.com")
- >>> socket.socket = socks.socksocket
- >>> urllib.urlopen("http://www.sourceforge.net/")
-
-
-PROBLEMS
----------
-
-Please open a GitHub issue at https://github.com/Anorov/PySocks
diff --git a/setup.py b/setup.py
index 068aef9..0a1c6cb 100755
--- a/setup.py
+++ b/setup.py
@@ -1,17 +1,17 @@
#!/usr/bin/env python
from distutils.core import setup
-VERSION = "1.5.0"
+VERSION = "1.5.6"
setup(
name = "PySocks",
version = VERSION,
- description = "A Python SOCKS module",
+ description = "A Python SOCKS client module. See https://github.com/Anorov/PySocks for more information.",
url = "https://github.com/Anorov/PySocks",
- download_url = "https://github.com/Anorov/PySocks/tarball/1.5.0",
license = "BSD",
+ author = "Anorov",
author_email = "anorov.vorona at gmail.com",
keywords = ["socks", "proxy"],
- py_modules=["socks"]
+ py_modules=["socks", "sockshandler"]
)
diff --git a/socks.py b/socks.py
index ca5ee1c..56bfca8 100644
--- a/socks.py
+++ b/socks.py
@@ -1,6 +1,6 @@
"""
SocksiPy - Python SOCKS module.
-Version 1.5.0
+Version 1.5.6
Copyright 2006 Dan-Haim. All rights reserved.
@@ -14,7 +14,7 @@ are permitted provided that the following conditions are met:
3. Neither the name of Dan Haim nor the names of his contributors may be used
to endorse or promote products derived from this software without specific
prior written permission.
-
+
THIS SOFTWARE IS PROVIDED BY DAN HAIM "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
@@ -40,7 +40,7 @@ mainly to merge bug fixes found in Sourceforge
Modifications made by Anorov (https://github.com/Anorov)
-Forked and renamed to PySocks
-Fixed issue with HTTP proxy failure checking (same bug that was in the old ___recvall() method)
--Included SocksiPyHandler (sockshandler.py), to be used as a urllib2 handler,
+-Included SocksiPyHandler (sockshandler.py), to be used as a urllib2 handler,
courtesy of e000 (https://github.com/e000): https://gist.github.com/869791#file_socksipyhandler.py
-Re-styled code to make it readable
-Aliased PROXY_TYPE_SOCKS5 -> SOCKS5 etc.
@@ -52,16 +52,21 @@ Modifications made by Anorov (https://github.com/Anorov)
-Various small bug fixes
"""
-__version__ = "1.5.0"
+__version__ = "1.5.6"
import socket
import struct
+from errno import EOPNOTSUPP, EINVAL, EAGAIN
+from io import BytesIO
+from os import SEEK_CUR
+from collections import Callable
PROXY_TYPE_SOCKS4 = SOCKS4 = 1
PROXY_TYPE_SOCKS5 = SOCKS5 = 2
PROXY_TYPE_HTTP = HTTP = 3
-PRINTABLE_PROXY_TYPES = {SOCKS4: "SOCKS4", SOCKS5: "SOCKS5", HTTP: "HTTP"}
+PROXY_TYPES = {"SOCKS4": SOCKS4, "SOCKS5": SOCKS5, "HTTP": HTTP}
+PRINTABLE_PROXY_TYPES = dict(zip(PROXY_TYPES.values(), PROXY_TYPES.keys()))
_orgsocket = _orig_socket = socket.socket
@@ -74,7 +79,7 @@ class ProxyError(IOError):
self.socket_err = socket_err
if socket_err:
- self.msg = msg + ": {}".format(socket_err)
+ self.msg += ": {0}".format(socket_err)
def __str__(self):
return self.msg
@@ -111,9 +116,9 @@ def set_default_proxy(proxy_type=None, addr=None, port=None, rdns=True, username
set_default_proxy(proxy_type, addr[, port[, rdns[, username, password]]])
Sets a default proxy which all further socksocket objects will use,
- unless explicitly changed.
+ unless explicitly changed. All parameters are as for socket.set_proxy().
"""
- socksocket.default_proxy = (proxy_type, addr.encode(), port, rdns,
+ socksocket.default_proxy = (proxy_type, addr, port, rdns,
username.encode() if username else None,
password.encode() if password else None)
@@ -141,39 +146,82 @@ def wrap_module(module):
wrapmodule = wrap_module
-def create_connection(dest_pair, proxy_type=None, proxy_addr=None,
- proxy_port=None, proxy_username=None,
- proxy_password=None, timeout=None):
- """create_connection(dest_pair, **proxy_args) -> socket object
+def create_connection(dest_pair, proxy_type=None, proxy_addr=None,
+ proxy_port=None, proxy_rdns=True,
+ proxy_username=None, proxy_password=None,
+ timeout=None, source_address=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().
+ **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)
"""
sock = socksocket()
+ if socket_options is not None:
+ for opt in socket_options:
+ sock.setsockopt(*opt)
if isinstance(timeout, (int, float)):
sock.settimeout(timeout)
- sock.set_proxy(proxy_type, proxy_addr, proxy_port,
- proxy_username, proxy_password)
+ if proxy_type is not None:
+ sock.set_proxy(proxy_type, proxy_addr, proxy_port, proxy_rdns,
+ proxy_username, proxy_password)
+ if source_address is not None:
+ sock.bind(source_address)
+
sock.connect(dest_pair)
return sock
-class socksocket(socket.socket):
+class _BaseSocket(socket.socket):
+ """Allows Python 2's "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, type=SOCK_STREAM and proto=0.
+ 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, _sock=None):
- _orig_socket.__init__(self, family, type, proto, _sock)
-
+ 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))
+
+ _BaseSocket.__init__(self, 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:
@@ -181,19 +229,14 @@ class socksocket(socket.socket):
self.proxy_sockname = None
self.proxy_peername = None
- self.proxy_negotiators = { SOCKS4: self._negotiate_SOCKS4,
- SOCKS5: self._negotiate_SOCKS5,
- HTTP: self._negotiate_HTTP
- }
-
- def _recvall(self, count):
+ def _readall(self, file, count):
"""
- Receive EXACTLY the number of bytes requested from the socket.
+ 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 = self.recv(count - len(data))
+ d = file.read(count - len(data))
if not d:
raise GeneralProxyError("Connection closed unexpectedly")
data += d
@@ -217,12 +260,102 @@ class socksocket(socket.socket):
password - Password to authenticate with to the server.
Only relevant when username is also provided.
"""
- self.proxy = (proxy_type, addr.encode(), port, rdns,
+ self.proxy = (proxy_type, addr, port, rdns,
username.encode() if username else None,
password.encode() if password else None)
setproxy = set_proxy
+ def bind(self, *pos, **kw):
+ """
+ Implements proxy connection for UDP sockets,
+ which 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)
+ _BaseSocket.bind(self, *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
+ _BaseSocket.connect(self, (host, port))
+ self.proxy_sockname = ("0.0.0.0", 0) # Unknown
+
+ def sendto(self, bytes, *args, **kwargs):
+ if self.type != socket.SOCK_DGRAM:
+ return _BaseSocket.sendto(self, 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 = _BaseSocket.send(self, 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 _BaseSocket.send(self, bytes, flags, **kwargs)
+
+ def recvfrom(self, bufsize, flags=0):
+ if self.type != socket.SOCK_DGRAM:
+ return _BaseSocket.recvfrom(self, bufsize, flags)
+ if not self._proxyconn:
+ self.bind(("", 0))
+
+ buf = BytesIO(_BaseSocket.recv(self, bufsize, 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(), (fromhost, fromport))
+
+ def recv(self, *pos, **kw):
+ bytes, _ = self.recvfrom(*pos, **kw)
+ return bytes
+
+ def close(self):
+ if self._proxyconn:
+ self._proxyconn.close()
+ return _BaseSocket.close(self)
+
def get_proxy_sockname(self):
"""
Returns the bound IP address and port number at the proxy.
@@ -235,7 +368,7 @@ class socksocket(socket.socket):
"""
Returns the IP and port number of the proxy.
"""
- return _orig_socket.getpeername(self)
+ return _BaseSocket.getpeername(self)
getproxypeername = get_proxy_peername
@@ -248,106 +381,137 @@ class socksocket(socket.socket):
getpeername = get_peername
- def _negotiate_SOCKS5(self, dest_addr, dest_port):
+ def _negotiate_SOCKS5(self, *dest_addr):
"""
- Negotiates a connection through a SOCKS5 server.
+ 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
- # 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).
- self.sendall(b"\x05\x02\x00\x02")
- else:
- # No username/password were entered, therefore we
- # only support connections with no authentication.
- self.sendall(b"\x05\x01\x00")
-
- # We'll receive the server's response to determine which
- # method was selected
- chosen_auth = self._recvall(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.
- self.sendall(b"\x01" + chr(len(username)).encode()
- + username
- + chr(len(password)).encode()
- + password)
- auth_status = self._recvall(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")
+ 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.
+ 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")
-
- # Now we can request the actual connection
- req = b"\x05\x01\x00"
+
+ status = ord(resp[1:2])
+ if status != 0x00:
+ # Connection failed: server returned an error
+ error = SOCKS5_ERRORS.get(status, "Unknown error")
+ raise SOCKS5Error("{0:#04x}: {1}".format(status, error))
+
+ # Get the bound address/port
+ bnd = self._read_SOCKS5_address(reader)
+ 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
+
# If the given destination address is an IP address, we'll
# use the IPv4 address request even if remote resolving was specified.
try:
- addr_bytes = socket.inet_aton(dest_addr)
- req += b"\x01" + addr_bytes
+ addr_bytes = socket.inet_aton(host)
+ file.write(b"\x01" + addr_bytes)
+ host = socket.inet_ntoa(addr_bytes)
except socket.error:
# Well it's not an IP number, so it's probably a DNS name.
if rdns:
# Resolve remotely
- addr_bytes = None
- req += b"\x03" + chr(len(dest_addr)).encode() + dest_addr.encode()
+ host_bytes = host.encode('idna')
+ file.write(b"\x03" + chr(len(host_bytes)).encode() + host_bytes)
else:
# Resolve locally
- addr_bytes = socket.inet_aton(socket.gethostbyname(dest_addr))
- req += b"\x01" + addr_bytes
-
- req += struct.pack(">H", dest_port)
- self.sendall(req)
-
- # Get the response
- resp = self._recvall(4)
- 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
- if resp[3:4] == b"\x01":
- bound_addr = self._recvall(4)
- elif resp[3:4] == b"\x03":
- resp += self.recv(1)
- bound_addr = self._recvall(ord(resp[4:5]))
+ addr_bytes = socket.inet_aton(socket.gethostbyname(host))
+ file.write(b"\x01" + addr_bytes)
+ host = socket.inet_ntoa(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))
else:
raise GeneralProxyError("SOCKS5 proxy server sent invalid data")
-
- bound_port = struct.unpack(">H", self._recvall(2))[0]
- self.proxy_sockname = bound_addr, bound_port
- if addr_bytes:
- self.proxy_peername = socket.inet_ntoa(addr_bytes), dest_port
- else:
- self.proxy_peername = dest_addr, dest_port
+
+ port = struct.unpack(">H", self._readall(file, 2))[0]
+ return addr, port
def _negotiate_SOCKS4(self, dest_addr, dest_port):
"""
@@ -355,51 +519,58 @@ class socksocket(socket.socket):
"""
proxy_type, addr, port, rdns, username, password = self.proxy
- # Check if the destination address provided is an IP address
- remote_resolve = False
+ writer = self.makefile("wb")
+ reader = self.makefile("rb", 0) # buffering=0 renamed in Python 3
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
+ # 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("{0:#04x}: {1}".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:
- addr_bytes = socket.inet_aton(socket.gethostbyname(dest_addr))
-
- # Construct the request packet
- req = struct.pack(">BBH", 0x04, 0x01, dest_port) + addr_bytes
-
- # The username parameter is considered userid for SOCKS4
- if username:
- req += username
- req += 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:
- req += dest_addr.encode() + b"\x00"
- self.sendall(req)
-
- # Get the response from the server
- resp = self._recvall(8)
- if resp[0:1] != b"\x00":
- # Bad data
- raise GeneralProxyError("SOCKS4 proxy server sent invalid data")
-
- status = ord(resp[1:2])
... 743 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-socksipy.git
More information about the Python-modules-commits
mailing list