PySocks-1.5.0/0000755000175500017550000000000012640076220012641 5ustar debacledebaclePySocks-1.5.0/README.md0000644000175500017550000002711412261133055014124 0ustar debacledebaclePySocks ======= 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 PySocks-1.5.0/test/0000755000175500017550000000000012640076352013626 5ustar debacledebaclePySocks-1.5.0/test/httpproxy.py0000755000175500017550000001116112261133055016255 0ustar debacledebacle#!/usr/bin/env python # # Simple asynchronous HTTP proxy with tunnelling (CONNECT). # # GET/POST proxying based on # http://groups.google.com/group/python-tornado/msg/7bea08e7a049cf26 # # Copyright (C) 2012 Senko Rasic # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. import sys import socket import tornado.httpserver import tornado.ioloop import tornado.iostream import tornado.web import tornado.httpclient __all__ = ['ProxyHandler', 'run_proxy'] class ProxyHandler(tornado.web.RequestHandler): SUPPORTED_METHODS = ['GET', 'POST', 'CONNECT'] @tornado.web.asynchronous def get(self): def handle_response(response): if response.error and not isinstance(response.error, tornado.httpclient.HTTPError): self.set_status(500) self.write('Internal server error:\n' + str(response.error)) self.finish() else: self.set_status(response.code) for header in ('Date', 'Cache-Control', 'Server', 'Content-Type', 'Location'): v = response.headers.get(header) if v: self.set_header(header, v) if response.body: self.write(response.body) self.finish() req = tornado.httpclient.HTTPRequest(url=self.request.uri, method=self.request.method, body=self.request.body, headers=self.request.headers, follow_redirects=False, allow_nonstandard_methods=True) client = tornado.httpclient.AsyncHTTPClient() try: client.fetch(req, handle_response) except tornado.httpclient.HTTPError as e: if hasattr(e, 'response') and e.response: self.handle_response(e.response) else: self.set_status(500) self.write('Internal server error:\n' + str(e)) self.finish() @tornado.web.asynchronous def post(self): return self.get() @tornado.web.asynchronous def connect(self): host, port = self.request.uri.split(':') client = self.request.connection.stream def read_from_client(data): upstream.write(data) def read_from_upstream(data): client.write(data) def client_close(data=None): if upstream.closed(): return if data: upstream.write(data) upstream.close() def upstream_close(data=None): if client.closed(): return if data: client.write(data) client.close() def start_tunnel(): client.read_until_close(client_close, read_from_client) upstream.read_until_close(upstream_close, read_from_upstream) client.write(b'HTTP/1.0 200 Connection established\r\n\r\n') s = socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) upstream = tornado.iostream.IOStream(s) upstream.connect((host, int(port)), start_tunnel) def run_proxy(port=8080, start_ioloop=True): """ Run proxy on the specified port. If start_ioloop is True (default), the tornado IOLoop will be started immediately. """ app = tornado.web.Application([ (r'.*', ProxyHandler), ]) app.listen(port, address="127.0.0.1") ioloop = tornado.ioloop.IOLoop.instance() if start_ioloop: ioloop.start() if __name__ == '__main__': port = 8081 if len(sys.argv) > 1: port = int(sys.argv[1]) print ("Running HTTP proxy server") run_proxy(port) PySocks-1.5.0/test/socks4server.py0000755000175500017550000000060612261133055016633 0ustar debacledebacle#!/usr/bin/env python from twisted.internet import reactor from twisted.protocols.socks import SOCKSv4Factory def run_proxy(): reactor.listenTCP(1080, SOCKSv4Factory("/dev/null"), interface="127.0.0.1") try: reactor.run() except (KeyboardInterrupt, SystemExit): reactor.stop() if __name__ == "__main__": print "Running SOCKS4 proxy server" run_proxy() PySocks-1.5.0/test/sockstest.py0000644000175500017550000001211112640076265016221 0ustar debacledebacleimport sys sys.path.append("..") import socks import socket PY3K = sys.version_info.major == 3 if PY3K: import urllib.request as urllib2 else: import sockshandler import urllib2 def raw_HTTP_request(): req = "GET /ip HTTP/1.1\r\n" req += "Host: ifconfig.me\r\n" req += "User-Agent: Mozilla\r\n" req += "Accept: text/html\r\n" req += "\r\n" return req.encode() def socket_HTTP_test(): s = socks.socksocket() s.set_proxy(socks.HTTP, "127.0.0.1", 8081) s.connect(("ifconfig.me", 80)) s.sendall(raw_HTTP_request()) status = s.recv(2048).splitlines()[0] assert status.startswith(b"HTTP/1.1 200") def socket_SOCKS4_test(): s = socks.socksocket() s.set_proxy(socks.SOCKS4, "127.0.0.1", 1080) s.connect(("ifconfig.me", 80)) s.sendall(raw_HTTP_request()) status = s.recv(2048).splitlines()[0] assert status.startswith(b"HTTP/1.1 200") def socket_SOCKS5_test(): s = socks.socksocket() s.set_proxy(socks.SOCKS5, "127.0.0.1", 1081) s.connect(("ifconfig.me", 80)) s.sendall(raw_HTTP_request()) status = s.recv(2048).splitlines()[0] assert status.startswith(b"HTTP/1.1 200") def SOCKS5_connect_timeout_test(): s = socks.socksocket() s.settimeout(0.0001) s.set_proxy(socks.SOCKS5, "8.8.8.8", 80) try: s.connect(("ifconfig.me", 80)) except socks.ProxyConnectionError as e: assert str(e.socket_err) == "timed out" def SOCKS5_timeout_test(): s = socks.socksocket() s.settimeout(0.0001) s.set_proxy(socks.SOCKS5, "127.0.0.1", 1081) try: s.connect(("ifconfig.me", 4444)) except socks.GeneralProxyError as e: assert str(e.socket_err) == "timed out" def socket_SOCKS5_auth_test(): # TODO: add support for this test. Will need a better SOCKS5 server. s = socks.socksocket() s.set_proxy(socks.SOCKS5, "127.0.0.1", 1081, username="a", password="b") s.connect(("ifconfig.me", 80)) s.sendall(raw_HTTP_request()) status = s.recv(2048).splitlines()[0] assert status.startswith(b"HTTP/1.1 200") def socket_HTTP_IP_test(): s = socks.socksocket() s.set_proxy(socks.HTTP, "127.0.0.1", 8081) s.connect(("133.242.129.236", 80)) s.sendall(raw_HTTP_request()) status = s.recv(2048).splitlines()[0] assert status.startswith(b"HTTP/1.1 200") def socket_SOCKS4_IP_test(): s = socks.socksocket() s.set_proxy(socks.SOCKS4, "127.0.0.1", 1080) s.connect(("133.242.129.236", 80)) s.sendall(raw_HTTP_request()) status = s.recv(2048).splitlines()[0] assert status.startswith(b"HTTP/1.1 200") def socket_SOCKS5_IP_test(): s = socks.socksocket() s.set_proxy(socks.SOCKS5, "127.0.0.1", 1081) s.connect(("133.242.129.236", 80)) s.sendall(raw_HTTP_request()) status = s.recv(2048).splitlines()[0] assert status.startswith(b"HTTP/1.1 200") def urllib2_HTTP_test(): socks.set_default_proxy(socks.HTTP, "127.0.0.1", 8081) socks.wrap_module(urllib2) status = urllib2.urlopen("http://ifconfig.me/ip").getcode() assert status == 200 def urllib2_SOCKS5_test(): socks.set_default_proxy(socks.SOCKS5, "127.0.0.1", 1081) socks.wrap_module(urllib2) status = urllib2.urlopen("http://ifconfig.me/ip").getcode() assert status == 200 def urllib2_handler_HTTP_test(): opener = urllib2.build_opener(sockshandler.SocksiPyHandler(socks.HTTP, "127.0.0.1", 8081)) status = opener.open("http://ifconfig.me/ip").getcode() assert status == 200 def urllib2_handler_SOCKS5_test(): opener = urllib2.build_opener(sockshandler.SocksiPyHandler(socks.SOCKS5, "127.0.0.1", 1081)) status = opener.open("http://ifconfig.me/ip").getcode() assert status == 200 def global_override_HTTP_test(): socks.set_default_proxy(socks.HTTP, "127.0.0.1", 8081) good = socket.socket socket.socket = socks.socksocket status = urllib2.urlopen("http://ifconfig.me/ip").getcode() socket.socket = good assert status == 200 def global_override_SOCKS5_test(): default_proxy = (socks.SOCKS5, "127.0.0.1", 1081) socks.set_default_proxy(*default_proxy) good = socket.socket socket.socket = socks.socksocket status = urllib2.urlopen("http://ifconfig.me/ip").getcode() socket.socket = good assert status == 200 assert socks.get_default_proxy()[1].decode() == default_proxy[1] def main(): print("Running tests...") socket_HTTP_test() print("1/12") socket_SOCKS4_test() print("2/12") socket_SOCKS5_test() print("3/12") if not PY3K: urllib2_handler_HTTP_test() print("3.33/12") urllib2_handler_SOCKS5_test() print("3.66/12") socket_HTTP_IP_test() print("4/12") socket_SOCKS4_IP_test() print("5/12") socket_SOCKS5_IP_test() print("6/12") SOCKS5_connect_timeout_test() print("7/12") SOCKS5_timeout_test() print("8/12") urllib2_HTTP_test() print("9/12") urllib2_SOCKS5_test() print("10/12") global_override_HTTP_test() print("11/12") global_override_SOCKS5_test() print("12/12") print("All tests ran successfully") if __name__ == "__main__": main() PySocks-1.5.0/test/README0000644000175500017550000000016512261133055014501 0ustar debacledebacleVery rudimentary tests for Python 2 and Python 3. Requirements: tornado, twisted (available through pip) ./test.sh PySocks-1.5.0/test/mocks.conf0000644000175500017550000000777612261133055015623 0ustar debacledebacle################################################# # # # Sample configuration file for MOCKS 0.0.2 # # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ # # # # I recommend reading the examples in this file # # and then extending it to suite your needs. # # # ################################################# ######################### # # General daemon config # ~~~~~~~~~~~~~~~~~~~~~ # ######################### PORT = 1081 # Port MOCKS is to listen to MOCKS_ADDR = 127.0.0.1 # IP adress MOCKS is to bind to LOG_FILE = mocks.log # MOCKS log file PID_FILE = mocks.pid # File holding MOCKS's process ID BUFFER_SIZE = 65536 # Traffic buffer size in bytes BACKLOG = 5 # Backlog for listen() NEGOTIATION_TIMEOUT = 5 CONNECTION_IDLE_TIMEOUT = 300 BIND_TIMEOUT = 30 SHUTDOWN_TIMEOUT = 3 MAX_CONNECTIONS = 50 ########################################################################## # # Client filter config # ~~~~~~~~~~~~~~~~~~~~ # # Client filtering means sorting out which clients are allowed # connection and which are not. This is basically done like this: # MOCKS has a default behaviour regarding filtering client # connections. This behaviour is called the 'policy' and can either # be to ALLOW or to DENY the connection. After setting the policy # you can specify a list of exceptions. The action MOCKS takes # for a client matching any of these exceptions is the opposite # of the policy (that is, if the policy is set to ALLOW the exceptions # are denied and if the policy is set to DENY the exceptions are allowed). # An exception is specified in the form ip_address/mask, where mask # is optional and is an integer ranging from 0 to 32 identifying the # number of common heading bits that ip_address and the client's IP # address must have in order to yield a match. If mask is missing, # 32 will be assumed. For instance, 192.168.1.0/24 will match any IP # ranging from 192.168.1.1 to 192.168.1.255. # # Let's take two examples, one for each type of policy. Let's say we # only want to allow IPs 10.12.0.0 through 10.12.255.255, 172.23.2.5 and # 192.168.52.26 to use MOCKS. What we have to to is this: # # FILTER_POLICY = DENY # FILTER_EXCEPTION = 10.12.0.0/16 # FILTER_EXCEPTION = 172.23.2.5 # implied /32 # FILTER_EXCEPTION = 192.168.52.26 # implied /32 # # Now, let's say this is a public proxy server, but for some reason # you don't want to let any IP ranging from 192.168.1.1 to 192.168.1.255 # and neither 10.2.5.13 to connect to it: # # FILTER_POLICY = ALLOW # FILTER_EXCEPTION = 192.168.1.0/24 # FILTER_EXCEPTION = 10.2.5.13 # ########################################################################### FILTER_POLICY = ALLOW ############################################################################# # # Upstream proxy config # ~~~~~~~~~~~~~~~~~~~~~ # # You can choose to further relay traffic through another proxy server. # MOCKS supports upstream HTTP CONNECT, SOCKS4 and SOCKS5 proxies. You # must specify the proxy type (one of HTTPCONNECT, SOCKS4 or SOCKS5), the # proxy address and the proxy port. Optionally you can specify an user # name and a password used to authenicate to the upstream proxy. This is # pretty straight forward, so let's just take an example. Let's say you # want to use the HTTP CONNECT server at httpconnectproxy.com, on port 3128, # using the username 'foo' and the password 'bar'. You do it like this: # # UP_PROXY_TYPE = HTTPCONNECT # UP_PROXY_ADDR = httpconnectproxy.com # UP_PROXY_PORT = 3128 # UP_PROXY_USER = foo # These two can be missing if you # UP_PROXY_PASSWD = bar # are not required to authenticate # ############################################################################# # UP_PROXY_TYPE = HTTPCONNECT # UP_PROXY_ADDR = 192.168.1.12 # UP_PROXY_PORT = 3128 PySocks-1.5.0/test/test.sh0000755000175500017550000000054112261133055015135 0ustar debacledebacle#!/bin/bash echo "Starting proxy servers..." python socks4server.py > /dev/null 2>&1 & python httpproxy.py > /dev/null 2>&1 & ./mocks start >/dev/null 2>&1 & sleep 2 echo "Python 2.x tests" python sockstest.py sleep 2 echo "Python 3.x tests" python3 sockstest.py pkill python > /dev/null 2>&1 ./mocks shutdown >/dev/null 2>&1 & echo "Finished tests" PySocks-1.5.0/socks.py0000644000175500017550000004711212640076220014342 0ustar debacledebacle""" SocksiPy - Python SOCKS module. Version 1.5.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. This module provides a standard socket-like interface for Python for tunneling connections through SOCKS proxies. =============================================================================== Minor modifications made by Christopher Gilbert (http://motomastyle.com/) for use in PyLoris (http://pyloris.sourceforge.net/) Minor modifications made by Mario Vilas (http://breakingcode.wordpress.com/) 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, 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. -Improved exception handling and output -Removed irritating use of sequence indexes, replaced with tuple unpacked variables -Fixed up Python 3 bytestring handling - chr(0x03).encode() -> b"\x03" -Other general fixes -Added clarification that the HTTP proxy connection method only supports CONNECT-style tunneling HTTP proxies -Various small bug fixes """ __version__ = "1.5.0" import socket import struct PROXY_TYPE_SOCKS4 = SOCKS4 = 1 PROXY_TYPE_SOCKS5 = SOCKS5 = 2 PROXY_TYPE_HTTP = HTTP = 3 PRINTABLE_PROXY_TYPES = {SOCKS4: "SOCKS4", SOCKS5: "SOCKS5", HTTP: "HTTP"} _orgsocket = _orig_socket = socket.socket 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 = 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): """ set_default_proxy(proxy_type, addr[, port[, rdns[, username, password]]]) Sets a default proxy which all further socksocket objects will use, unless explicitly changed. """ socksocket.default_proxy = (proxy_type, addr.encode(), port, rdns, username.encode() if username else None, password.encode() if password else None) setdefaultproxy = set_default_proxy 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, 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 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(). timeout - Optional socket timeout value, in seconds. """ sock = socksocket() if isinstance(timeout, (int, float)): sock.settimeout(timeout) sock.set_proxy(proxy_type, proxy_addr, proxy_port, proxy_username, proxy_password) sock.connect(dest_pair) return sock class socksocket(socket.socket): """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. """ 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) 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.proxy_negotiators = { SOCKS4: self._negotiate_SOCKS4, SOCKS5: self._negotiate_SOCKS5, HTTP: self._negotiate_HTTP } def _recvall(self, count): """ Receive EXACTLY the number of bytes requested from the socket. Blocks until the required number of bytes have been received. """ data = b"" while len(data) < count: d = self.recv(count - len(data)) if not d: raise GeneralProxyError("Connection closed unexpectedly") data += d return data def set_proxy(self, proxy_type=None, addr=None, port=None, rdns=True, username=None, password=None): """set_proxy(proxy_type, addr[, port[, rdns[, username[, password]]]]) 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.encode(), port, rdns, username.encode() if username else None, password.encode() if password else None) setproxy = set_proxy 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 _orig_socket.getpeername(self) 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, dest_port): """ Negotiates a connection through a SOCKS5 server. """ 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") else: raise GeneralProxyError("SOCKS5 proxy server sent invalid data") # Now we can request the actual connection req = b"\x05\x01\x00" # 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 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() 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])) 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 def _negotiate_SOCKS4(self, dest_addr, dest_port): """ Negotiates a connection through a SOCKS4 server. """ proxy_type, addr, port, rdns, username, password = self.proxy # 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 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]) 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 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) self.sendall(b"CONNECT " + addr.encode() + b":" + str(dest_port).encode() + b" HTTP/1.1\r\n" + b"Host: " + dest_addr.encode() + b"\r\n\r\n") # 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 def connect(self, dest_pair): """ 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). """ proxy_type, proxy_addr, proxy_port, rdns, username, password = self.proxy dest_addr, dest_port = dest_pair # Do a minimal input check first if (not isinstance(dest_pair, (list, tuple)) or len(dest_pair) != 2 or not isinstance(dest_addr, type("")) or not isinstance(dest_port, int)): raise GeneralProxyError("Invalid destination-connection (host, port) pair") if proxy_type is None: # Treat like regular socket object _orig_socket.connect(self, (dest_addr, dest_port)) return proxy_port = proxy_port or DEFAULT_PORTS.get(proxy_type) if not proxy_port: raise GeneralProxyError("Invalid proxy type") try: # Initial connection to proxy server _orig_socket.connect(self, (proxy_addr, proxy_port)) except socket.error as error: # Error while connecting to proxy self.close() proxy_server = "{}:{}".format(proxy_addr.decode(), proxy_port) printable_type = PRINTABLE_PROXY_TYPES[proxy_type] msg = "Error connecting to {} proxy {}".format(printable_type, proxy_server) raise ProxyConnectionError(msg, error) else: # Connected to proxy server, now negotiate try: # Calls negotiate_{SOCKS4, SOCKS5, HTTP} self.proxy_negotiators[proxy_type](dest_addr, dest_port) except socket.error as error: # Wrap socket errors self.close() raise GeneralProxyError("Socket error", error) except ProxyError: # Protocol error while negotiating with proxy self.close() raise PySocks-1.5.0/setup.py0000755000175500017550000000064112261133055014356 0ustar debacledebacle#!/usr/bin/env python from distutils.core import setup VERSION = "1.5.0" setup( name = "PySocks", version = VERSION, description = "A Python SOCKS module", url = "https://github.com/Anorov/PySocks", download_url = "https://github.com/Anorov/PySocks/tarball/1.5.0", license = "BSD", author_email = "anorov.vorona@gmail.com", keywords = ["socks", "proxy"], py_modules=["socks"] ) PySocks-1.5.0/LICENSE0000644000175500017550000000257112261133055013652 0ustar debacledebacleCopyright 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. PySocks-1.5.0/sockshandler.py0000644000175500017550000000275012261133055015676 0ustar debacledebacle""" SocksiPy + urllib2 handler version: 0.2 author: e 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 urllib2 import httplib import socks 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): self.sock = socks.socksocket() self.sock.setproxy(*self.proxyargs) if type(self.timeout) in (int, float): self.sock.settimeout(self.timeout) self.sock.connect((self.host, self.port)) class SocksiPyHandler(urllib2.HTTPHandler): 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, strict=None, timeout=0): conn = SocksiPyConnection(*self.args, host=host, port=port, strict=strict, timeout=timeout, **self.kw) return conn return self.do_open(build, req) if __name__ == "__main__": opener = urllib2.build_opener(SocksiPyHandler(socks.PROXY_TYPE_SOCKS4, "localhost", 9050)) print opener.open("http://whatismyip.org/").read()