summaryrefslogtreecommitdiffstats
path: root/contrib/python/PySocks
diff options
context:
space:
mode:
authoralexv-smirnov <[email protected]>2023-12-01 12:02:50 +0300
committeralexv-smirnov <[email protected]>2023-12-01 13:28:10 +0300
commit0e578a4c44d4abd539d9838347b9ebafaca41dfb (patch)
treea0c1969c37f818c830ebeff9c077eacf30be6ef8 /contrib/python/PySocks
parent84f2d3d4cc985e63217cff149bd2e6d67ae6fe22 (diff)
Change "ya.make"
Diffstat (limited to 'contrib/python/PySocks')
-rw-r--r--contrib/python/PySocks/py2/.dist-info/METADATA321
-rw-r--r--contrib/python/PySocks/py2/.dist-info/top_level.txt2
-rw-r--r--contrib/python/PySocks/py2/LICENSE22
-rw-r--r--contrib/python/PySocks/py2/README.md300
-rw-r--r--contrib/python/PySocks/py2/socks.py847
-rw-r--r--contrib/python/PySocks/py2/sockshandler.py111
-rw-r--r--contrib/python/PySocks/py2/ya.make23
-rw-r--r--contrib/python/PySocks/py3/LICENSE22
-rw-r--r--contrib/python/PySocks/py3/README.md300
-rw-r--r--contrib/python/PySocks/ya.make18
10 files changed, 1966 insertions, 0 deletions
diff --git a/contrib/python/PySocks/py2/.dist-info/METADATA b/contrib/python/PySocks/py2/.dist-info/METADATA
new file mode 100644
index 00000000000..ae2ae3419c9
--- /dev/null
+++ b/contrib/python/PySocks/py2/.dist-info/METADATA
@@ -0,0 +1,321 @@
+Metadata-Version: 2.1
+Name: PySocks
+Version: 1.7.1
+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: [email protected]
+License: BSD
+Keywords: socks,proxy
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
+Description-Content-Type: text/markdown
+
+PySocks
+=======
+
+PySocks lets you send traffic through SOCKS and HTTP proxy servers. It is a modern fork of [SocksiPy](http://socksipy.sourceforge.net/) with bug fixes and extra features.
+
+Acts as a drop-in replacement to the socket module. Seamlessly configure SOCKS proxies for any socket object by calling `socket_object.set_proxy()`.
+
+----------------
+
+Features
+========
+
+* SOCKS proxy client for Python 2.7 and 3.4+
+* TCP supported
+* UDP mostly supported (issues may occur in some edge cases)
+* HTTP proxy client included but not supported or recommended (you should use urllib2's or requests' own HTTP proxy interface)
+* urllib2 handler included. `pip install` / `setup.py install` will automatically install the `sockshandler` module.
+
+Installation
+============
+
+ pip install PySocks
+
+Or download the tarball / `git clone` and...
+
+ python setup.py install
+
+These will install both the `socks` and `sockshandler` modules.
+
+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 (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
+=====
+
+## socks.socksocket ##
+
+ import socks
+
+ s = socks.socksocket() # Same API as socket.socket in the standard lib
+
+ 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.somesite.com", 80))
+ s.sendall("GET / HTTP/1.1 ...")
+ print s.recv(4096)
+
+## Monkeypatching ##
+
+To monkeypatch the entire standard library with a single default proxy:
+
+ import urllib2
+ import socket
+ import socks
+
+ socks.set_default_proxy(socks.SOCKS5, "localhost")
+ socket.socket = socks.socksocket
+
+ urllib2.urlopen("http://www.somesite.com/") # 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. Monkeypatching is usually an anti-pattern in Python.
+
+## urllib2 Handler ##
+
+Example use case with the `sockshandler` urllib2 handler. Note that you must import both `socks` and `sockshandler`, as the handler is its own module separate from PySocks. The module is included in the PyPI package.
+
+ import urllib2
+ import socks
+ from sockshandler import SocksiPyHandler
+
+ opener = urllib2.build_opener(SocksiPyHandler(socks.SOCKS5, "127.0.0.1", 9050))
+ print opener.open("http://www.somesite.com/") # All requests made by the opener will pass through the SOCKS proxy
+
+--------------------------------------------
+
+Original SocksiPy README attached below, amended to reflect API changes.
+
+--------------------------------------------
+
+SocksiPy
+
+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.
+It also supports relaying UDP packets with a SOCKS5 proxy.
+
+*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 either `SOCK_STREAM` or `SOCK_DGRAM`.
+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, as given by the server,
+and a description of the
+error. 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 - For instance if the server does not support UDP.
+* `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/contrib/python/PySocks/py2/.dist-info/top_level.txt b/contrib/python/PySocks/py2/.dist-info/top_level.txt
new file mode 100644
index 00000000000..9476163ae51
--- /dev/null
+++ b/contrib/python/PySocks/py2/.dist-info/top_level.txt
@@ -0,0 +1,2 @@
+socks
+sockshandler
diff --git a/contrib/python/PySocks/py2/LICENSE b/contrib/python/PySocks/py2/LICENSE
new file mode 100644
index 00000000000..04b6b1f37c4
--- /dev/null
+++ b/contrib/python/PySocks/py2/LICENSE
@@ -0,0 +1,22 @@
+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/contrib/python/PySocks/py2/README.md b/contrib/python/PySocks/py2/README.md
new file mode 100644
index 00000000000..0035b7d1a4a
--- /dev/null
+++ b/contrib/python/PySocks/py2/README.md
@@ -0,0 +1,300 @@
+PySocks
+=======
+
+PySocks lets you send traffic through SOCKS and HTTP proxy servers. It is a modern fork of [SocksiPy](http://socksipy.sourceforge.net/) with bug fixes and extra features.
+
+Acts as a drop-in replacement to the socket module. Seamlessly configure SOCKS proxies for any socket object by calling `socket_object.set_proxy()`.
+
+----------------
+
+Features
+========
+
+* SOCKS proxy client for Python 2.7 and 3.4+
+* TCP supported
+* UDP mostly supported (issues may occur in some edge cases)
+* HTTP proxy client included but not supported or recommended (you should use urllib2's or requests' own HTTP proxy interface)
+* urllib2 handler included. `pip install` / `setup.py install` will automatically install the `sockshandler` module.
+
+Installation
+============
+
+ pip install PySocks
+
+Or download the tarball / `git clone` and...
+
+ python setup.py install
+
+These will install both the `socks` and `sockshandler` modules.
+
+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 (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
+=====
+
+## socks.socksocket ##
+
+ import socks
+
+ s = socks.socksocket() # Same API as socket.socket in the standard lib
+
+ 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.somesite.com", 80))
+ s.sendall("GET / HTTP/1.1 ...")
+ print s.recv(4096)
+
+## Monkeypatching ##
+
+To monkeypatch the entire standard library with a single default proxy:
+
+ import urllib2
+ import socket
+ import socks
+
+ socks.set_default_proxy(socks.SOCKS5, "localhost")
+ socket.socket = socks.socksocket
+
+ urllib2.urlopen("http://www.somesite.com/") # 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. Monkeypatching is usually an anti-pattern in Python.
+
+## urllib2 Handler ##
+
+Example use case with the `sockshandler` urllib2 handler. Note that you must import both `socks` and `sockshandler`, as the handler is its own module separate from PySocks. The module is included in the PyPI package.
+
+ import urllib2
+ import socks
+ from sockshandler import SocksiPyHandler
+
+ opener = urllib2.build_opener(SocksiPyHandler(socks.SOCKS5, "127.0.0.1", 9050))
+ print opener.open("http://www.somesite.com/") # All requests made by the opener will pass through the SOCKS proxy
+
+--------------------------------------------
+
+Original SocksiPy README attached below, amended to reflect API changes.
+
+--------------------------------------------
+
+SocksiPy
+
+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.
+It also supports relaying UDP packets with a SOCKS5 proxy.
+
+*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 either `SOCK_STREAM` or `SOCK_DGRAM`.
+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, as given by the server,
+and a description of the
+error. 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 - For instance if the server does not support UDP.
+* `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/contrib/python/PySocks/py2/socks.py b/contrib/python/PySocks/py2/socks.py
new file mode 100644
index 00000000000..83b1435dfaa
--- /dev/null
+++ b/contrib/python/PySocks/py2/socks.py
@@ -0,0 +1,847 @@
+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
diff --git a/contrib/python/PySocks/py2/sockshandler.py b/contrib/python/PySocks/py2/sockshandler.py
new file mode 100644
index 00000000000..6a2ed81ceef
--- /dev/null
+++ b/contrib/python/PySocks/py2/sockshandler.py
@@ -0,0 +1,111 @@
+#!/usr/bin/env python
+"""
+SocksiPy + urllib2 handler
+
+version: 0.3
+author: e<[email protected]>
+
+This module provides a Handler which you can use with urllib2 to allow it to tunnel your connection through a socks.sockssocket socket, with out monkey patching the original socket...
+"""
+import socket
+import ssl
+
+try:
+ import urllib2
+ import httplib
+except ImportError: # Python 3
+ import urllib.request as urllib2
+ import http.client as httplib
+
+import socks # $ pip install PySocks
+
+def merge_dict(a, b):
+ d = a.copy()
+ d.update(b)
+ return d
+
+def is_ip(s):
+ try:
+ if ':' in s:
+ socket.inet_pton(socket.AF_INET6, s)
+ elif '.' in s:
+ socket.inet_aton(s)
+ else:
+ return False
+ except:
+ return False
+ else:
+ return True
+
+socks4_no_rdns = set()
+
+class SocksiPyConnection(httplib.HTTPConnection):
+ def __init__(self, proxytype, proxyaddr, proxyport=None, rdns=True, username=None, password=None, *args, **kwargs):
+ self.proxyargs = (proxytype, proxyaddr, proxyport, rdns, username, password)
+ httplib.HTTPConnection.__init__(self, *args, **kwargs)
+
+ def connect(self):
+ (proxytype, proxyaddr, proxyport, rdns, username, password) = self.proxyargs
+ rdns = rdns and proxyaddr not in socks4_no_rdns
+ while True:
+ try:
+ sock = socks.create_connection(
+ (self.host, self.port), self.timeout, None,
+ proxytype, proxyaddr, proxyport, rdns, username, password,
+ ((socket.IPPROTO_TCP, socket.TCP_NODELAY, 1),))
+ break
+ except socks.SOCKS4Error as e:
+ if rdns and "0x5b" in str(e) and not is_ip(self.host):
+ # Maybe a SOCKS4 server that doesn't support remote resolving
+ # Let's try again
+ rdns = False
+ socks4_no_rdns.add(proxyaddr)
+ else:
+ raise
+ self.sock = sock
+
+class SocksiPyConnectionS(httplib.HTTPSConnection):
+ def __init__(self, proxytype, proxyaddr, proxyport=None, rdns=True, username=None, password=None, *args, **kwargs):
+ self.proxyargs = (proxytype, proxyaddr, proxyport, rdns, username, password)
+ httplib.HTTPSConnection.__init__(self, *args, **kwargs)
+
+ def connect(self):
+ SocksiPyConnection.connect(self)
+ self.sock = self._context.wrap_socket(self.sock, server_hostname=self.host)
+ if not self._context.check_hostname and self._check_hostname:
+ try:
+ ssl.match_hostname(self.sock.getpeercert(), self.host)
+ except Exception:
+ self.sock.shutdown(socket.SHUT_RDWR)
+ self.sock.close()
+ raise
+
+class SocksiPyHandler(urllib2.HTTPHandler, urllib2.HTTPSHandler):
+ def __init__(self, *args, **kwargs):
+ self.args = args
+ self.kw = kwargs
+ urllib2.HTTPHandler.__init__(self)
+
+ def http_open(self, req):
+ def build(host, port=None, timeout=0, **kwargs):
+ kw = merge_dict(self.kw, kwargs)
+ conn = SocksiPyConnection(*self.args, host=host, port=port, timeout=timeout, **kw)
+ return conn
+ return self.do_open(build, req)
+
+ def https_open(self, req):
+ def build(host, port=None, timeout=0, **kwargs):
+ kw = merge_dict(self.kw, kwargs)
+ conn = SocksiPyConnectionS(*self.args, host=host, port=port, timeout=timeout, **kw)
+ return conn
+ return self.do_open(build, req)
+
+if __name__ == "__main__":
+ import sys
+ try:
+ port = int(sys.argv[1])
+ except (ValueError, IndexError):
+ port = 9050
+ opener = urllib2.build_opener(SocksiPyHandler(socks.PROXY_TYPE_SOCKS5, "localhost", port))
+ print("HTTP: " + opener.open("http://httpbin.org/ip").read().decode())
+ print("HTTPS: " + opener.open("https://httpbin.org/ip").read().decode())
diff --git a/contrib/python/PySocks/py2/ya.make b/contrib/python/PySocks/py2/ya.make
new file mode 100644
index 00000000000..28970a07701
--- /dev/null
+++ b/contrib/python/PySocks/py2/ya.make
@@ -0,0 +1,23 @@
+# Generated by devtools/yamaker (pypi).
+
+PY2_LIBRARY()
+
+VERSION(1.7.1)
+
+LICENSE(BSD-3-Clause)
+
+NO_LINT()
+
+PY_SRCS(
+ TOP_LEVEL
+ socks.py
+ sockshandler.py
+)
+
+RESOURCE_FILES(
+ PREFIX contrib/python/PySocks/py2/
+ .dist-info/METADATA
+ .dist-info/top_level.txt
+)
+
+END()
diff --git a/contrib/python/PySocks/py3/LICENSE b/contrib/python/PySocks/py3/LICENSE
new file mode 100644
index 00000000000..04b6b1f37c4
--- /dev/null
+++ b/contrib/python/PySocks/py3/LICENSE
@@ -0,0 +1,22 @@
+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/contrib/python/PySocks/py3/README.md b/contrib/python/PySocks/py3/README.md
new file mode 100644
index 00000000000..0035b7d1a4a
--- /dev/null
+++ b/contrib/python/PySocks/py3/README.md
@@ -0,0 +1,300 @@
+PySocks
+=======
+
+PySocks lets you send traffic through SOCKS and HTTP proxy servers. It is a modern fork of [SocksiPy](http://socksipy.sourceforge.net/) with bug fixes and extra features.
+
+Acts as a drop-in replacement to the socket module. Seamlessly configure SOCKS proxies for any socket object by calling `socket_object.set_proxy()`.
+
+----------------
+
+Features
+========
+
+* SOCKS proxy client for Python 2.7 and 3.4+
+* TCP supported
+* UDP mostly supported (issues may occur in some edge cases)
+* HTTP proxy client included but not supported or recommended (you should use urllib2's or requests' own HTTP proxy interface)
+* urllib2 handler included. `pip install` / `setup.py install` will automatically install the `sockshandler` module.
+
+Installation
+============
+
+ pip install PySocks
+
+Or download the tarball / `git clone` and...
+
+ python setup.py install
+
+These will install both the `socks` and `sockshandler` modules.
+
+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 (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
+=====
+
+## socks.socksocket ##
+
+ import socks
+
+ s = socks.socksocket() # Same API as socket.socket in the standard lib
+
+ 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.somesite.com", 80))
+ s.sendall("GET / HTTP/1.1 ...")
+ print s.recv(4096)
+
+## Monkeypatching ##
+
+To monkeypatch the entire standard library with a single default proxy:
+
+ import urllib2
+ import socket
+ import socks
+
+ socks.set_default_proxy(socks.SOCKS5, "localhost")
+ socket.socket = socks.socksocket
+
+ urllib2.urlopen("http://www.somesite.com/") # 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. Monkeypatching is usually an anti-pattern in Python.
+
+## urllib2 Handler ##
+
+Example use case with the `sockshandler` urllib2 handler. Note that you must import both `socks` and `sockshandler`, as the handler is its own module separate from PySocks. The module is included in the PyPI package.
+
+ import urllib2
+ import socks
+ from sockshandler import SocksiPyHandler
+
+ opener = urllib2.build_opener(SocksiPyHandler(socks.SOCKS5, "127.0.0.1", 9050))
+ print opener.open("http://www.somesite.com/") # All requests made by the opener will pass through the SOCKS proxy
+
+--------------------------------------------
+
+Original SocksiPy README attached below, amended to reflect API changes.
+
+--------------------------------------------
+
+SocksiPy
+
+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.
+It also supports relaying UDP packets with a SOCKS5 proxy.
+
+*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 either `SOCK_STREAM` or `SOCK_DGRAM`.
+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, as given by the server,
+and a description of the
+error. 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 - For instance if the server does not support UDP.
+* `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/contrib/python/PySocks/ya.make b/contrib/python/PySocks/ya.make
new file mode 100644
index 00000000000..1d7ecb60a19
--- /dev/null
+++ b/contrib/python/PySocks/ya.make
@@ -0,0 +1,18 @@
+PY23_LIBRARY()
+
+LICENSE(Service-Py23-Proxy)
+
+IF (PYTHON2)
+ PEERDIR(contrib/python/PySocks/py2)
+ELSE()
+ PEERDIR(contrib/python/PySocks/py3)
+ENDIF()
+
+NO_LINT()
+
+END()
+
+RECURSE(
+ py2
+ py3
+)