]>
Commit | Line | Data |
---|---|---|
71aff188 YCH |
1 | # Public Domain SOCKS proxy protocol implementation |
2 | # Adapted from https://gist.github.com/bluec0re/cafd3764412967417fd3 | |
3 | ||
4350b745 | 4 | from __future__ import unicode_literals |
4350b745 | 5 | |
9e9cd724 YCH |
6 | # References: |
7 | # SOCKS4 protocol http://www.openssh.com/txt/socks4.protocol | |
8 | # SOCKS4A protocol http://www.openssh.com/txt/socks4a.protocol | |
9 | # SOCKS5 protocol https://tools.ietf.org/html/rfc1928 | |
10 | # SOCKS5 username/password authentication https://tools.ietf.org/html/rfc1929 | |
11 | ||
71aff188 YCH |
12 | import collections |
13 | import socket | |
4350b745 | 14 | |
71aff188 | 15 | from .compat import ( |
9e9cd724 | 16 | compat_ord, |
edaa23f8 YCH |
17 | compat_struct_pack, |
18 | compat_struct_unpack, | |
71aff188 | 19 | ) |
4350b745 | 20 | |
71aff188 | 21 | __author__ = 'Timo Schmid <coding@timoschmid.de>' |
4350b745 | 22 | |
9e9cd724 YCH |
23 | SOCKS4_VERSION = 4 |
24 | SOCKS4_REPLY_VERSION = 0x00 | |
25 | # Excerpt from SOCKS4A protocol: | |
26 | # if the client cannot resolve the destination host's domain name to find its | |
27 | # IP address, it should set the first three bytes of DSTIP to NULL and the last | |
28 | # byte to a non-zero value. | |
edaa23f8 | 29 | SOCKS4_DEFAULT_DSTIP = compat_struct_pack('!BBBB', 0, 0, 0, 0xFF) |
9e9cd724 YCH |
30 | |
31 | SOCKS5_VERSION = 5 | |
32 | SOCKS5_USER_AUTH_VERSION = 0x01 | |
33 | SOCKS5_USER_AUTH_SUCCESS = 0x00 | |
34 | ||
35 | ||
36 | class Socks4Command(object): | |
37 | CMD_CONNECT = 0x01 | |
38 | CMD_BIND = 0x02 | |
39 | ||
40 | ||
41 | class Socks5Command(Socks4Command): | |
42 | CMD_UDP_ASSOCIATE = 0x03 | |
43 | ||
44 | ||
45 | class Socks5Auth(object): | |
46 | AUTH_NONE = 0x00 | |
47 | AUTH_GSSAPI = 0x01 | |
48 | AUTH_USER_PASS = 0x02 | |
49 | AUTH_NO_ACCEPTABLE = 0xFF # For server response | |
50 | ||
51 | ||
52 | class Socks5AddressType(object): | |
53 | ATYP_IPV4 = 0x01 | |
54 | ATYP_DOMAINNAME = 0x03 | |
55 | ATYP_IPV6 = 0x04 | |
56 | ||
4350b745 | 57 | |
4bd7d9d4 | 58 | class ProxyError(socket.error): |
9e9cd724 YCH |
59 | ERR_SUCCESS = 0x00 |
60 | ||
61 | def __init__(self, code=None, msg=None): | |
62 | if code is not None and msg is None: | |
83442966 | 63 | msg = self.CODES.get(code) or 'unknown error' |
9e9cd724 YCH |
64 | super(ProxyError, self).__init__(code, msg) |
65 | ||
66 | ||
67 | class InvalidVersionError(ProxyError): | |
68 | def __init__(self, expected_version, got_version): | |
69 | msg = ('Invalid response version from server. Expected {0:02x} got ' | |
70 | '{1:02x}'.format(expected_version, got_version)) | |
71 | super(InvalidVersionError, self).__init__(0, msg) | |
4350b745 YCH |
72 | |
73 | ||
4350b745 | 74 | class Socks4Error(ProxyError): |
9e9cd724 YCH |
75 | ERR_SUCCESS = 90 |
76 | ||
4350b745 | 77 | CODES = { |
9e9cd724 | 78 | 91: 'request rejected or failed', |
a2406fce | 79 | 92: 'request rejected because SOCKS server cannot connect to identd on the client', |
9e9cd724 | 80 | 93: 'request rejected because the client program and identd report different user-ids' |
4350b745 | 81 | } |
71aff188 | 82 | |
4350b745 | 83 | |
9e9cd724 YCH |
84 | class Socks5Error(ProxyError): |
85 | ERR_GENERAL_FAILURE = 0x01 | |
71aff188 | 86 | |
4350b745 YCH |
87 | CODES = { |
88 | 0x01: 'general SOCKS server failure', | |
89 | 0x02: 'connection not allowed by ruleset', | |
90 | 0x03: 'Network unreachable', | |
91 | 0x04: 'Host unreachable', | |
92 | 0x05: 'Connection refused', | |
93 | 0x06: 'TTL expired', | |
94 | 0x07: 'Command not supported', | |
95 | 0x08: 'Address type not supported', | |
96 | 0xFE: 'unknown username or invalid password', | |
97 | 0xFF: 'all offered authentication methods were rejected' | |
98 | } | |
99 | ||
71aff188 YCH |
100 | |
101 | class ProxyType(object): | |
102 | SOCKS4 = 0 | |
4350b745 | 103 | SOCKS4A = 1 |
71aff188 | 104 | SOCKS5 = 2 |
4350b745 | 105 | |
582be358 | 106 | |
9e9cd724 YCH |
107 | Proxy = collections.namedtuple('Proxy', ( |
108 | 'type', 'host', 'port', 'username', 'password', 'remote_dns')) | |
4350b745 | 109 | |
4350b745 | 110 | |
71aff188 | 111 | class sockssocket(socket.socket): |
9e9cd724 YCH |
112 | def __init__(self, *args, **kwargs): |
113 | self._proxy = None | |
114 | super(sockssocket, self).__init__(*args, **kwargs) | |
115 | ||
116 | def setproxy(self, proxytype, addr, port, rdns=True, username=None, password=None): | |
117 | assert proxytype in (ProxyType.SOCKS4, ProxyType.SOCKS4A, ProxyType.SOCKS5) | |
118 | ||
119 | self._proxy = Proxy(proxytype, addr, port, username, password, rdns) | |
4350b745 YCH |
120 | |
121 | def recvall(self, cnt): | |
122 | data = b'' | |
123 | while len(data) < cnt: | |
124 | cur = self.recv(cnt - len(data)) | |
125 | if not cur: | |
4bd7d9d4 | 126 | raise EOFError('{0} bytes missing'.format(cnt - len(data))) |
4350b745 YCH |
127 | data += cur |
128 | return data | |
129 | ||
9e9cd724 YCH |
130 | def _recv_bytes(self, cnt): |
131 | data = self.recvall(cnt) | |
edaa23f8 | 132 | return compat_struct_unpack('!{0}B'.format(cnt), data) |
9e9cd724 YCH |
133 | |
134 | @staticmethod | |
135 | def _len_and_data(data): | |
edaa23f8 | 136 | return compat_struct_pack('!B', len(data)) + data |
9e9cd724 YCH |
137 | |
138 | def _check_response_version(self, expected_version, got_version): | |
139 | if got_version != expected_version: | |
140 | self.close() | |
141 | raise InvalidVersionError(expected_version, got_version) | |
4350b745 | 142 | |
9e9cd724 | 143 | def _resolve_address(self, destaddr, default, use_remote_dns): |
4350b745 | 144 | try: |
9e9cd724 | 145 | return socket.inet_aton(destaddr) |
4350b745 | 146 | except socket.error: |
9e9cd724 YCH |
147 | if use_remote_dns and self._proxy.remote_dns: |
148 | return default | |
4350b745 | 149 | else: |
9e9cd724 YCH |
150 | return socket.inet_aton(socket.gethostbyname(destaddr)) |
151 | ||
152 | def _setup_socks4(self, address, is_4a=False): | |
153 | destaddr, port = address | |
154 | ||
155 | ipaddr = self._resolve_address(destaddr, SOCKS4_DEFAULT_DSTIP, use_remote_dns=is_4a) | |
156 | ||
edaa23f8 | 157 | packet = compat_struct_pack('!BBH', SOCKS4_VERSION, Socks4Command.CMD_CONNECT, port) + ipaddr |
9e9cd724 YCH |
158 | |
159 | username = (self._proxy.username or '').encode('utf-8') | |
160 | packet += username + b'\x00' | |
4350b745 YCH |
161 | |
162 | if is_4a and self._proxy.remote_dns: | |
9e9cd724 | 163 | packet += destaddr.encode('utf-8') + b'\x00' |
4350b745 YCH |
164 | |
165 | self.sendall(packet) | |
166 | ||
edaa23f8 | 167 | version, resp_code, dstport, dsthost = compat_struct_unpack('!BBHI', self.recvall(8)) |
4350b745 | 168 | |
9e9cd724 | 169 | self._check_response_version(SOCKS4_REPLY_VERSION, version) |
4350b745 | 170 | |
9e9cd724 | 171 | if resp_code != Socks4Error.ERR_SUCCESS: |
4350b745 YCH |
172 | self.close() |
173 | raise Socks4Error(resp_code) | |
174 | ||
71aff188 YCH |
175 | return (dsthost, dstport) |
176 | ||
9e9cd724 YCH |
177 | def _setup_socks4a(self, address): |
178 | self._setup_socks4(address, is_4a=True) | |
4350b745 | 179 | |
9e9cd724 | 180 | def _socks5_auth(self): |
edaa23f8 | 181 | packet = compat_struct_pack('!B', SOCKS5_VERSION) |
4350b745 | 182 | |
9e9cd724 | 183 | auth_methods = [Socks5Auth.AUTH_NONE] |
4350b745 | 184 | if self._proxy.username and self._proxy.password: |
9e9cd724 YCH |
185 | auth_methods.append(Socks5Auth.AUTH_USER_PASS) |
186 | ||
edaa23f8 YCH |
187 | packet += compat_struct_pack('!B', len(auth_methods)) |
188 | packet += compat_struct_pack('!{0}B'.format(len(auth_methods)), *auth_methods) | |
4350b745 YCH |
189 | |
190 | self.sendall(packet) | |
191 | ||
9e9cd724 | 192 | version, method = self._recv_bytes(2) |
4350b745 | 193 | |
9e9cd724 | 194 | self._check_response_version(SOCKS5_VERSION, version) |
4350b745 | 195 | |
54f54fcc YCH |
196 | if method == Socks5Auth.AUTH_NO_ACCEPTABLE or ( |
197 | method == Socks5Auth.AUTH_USER_PASS and (not self._proxy.username or not self._proxy.password)): | |
4350b745 | 198 | self.close() |
54f54fcc | 199 | raise Socks5Error(Socks5Auth.AUTH_NO_ACCEPTABLE) |
4350b745 | 200 | |
9e9cd724 YCH |
201 | if method == Socks5Auth.AUTH_USER_PASS: |
202 | username = self._proxy.username.encode('utf-8') | |
203 | password = self._proxy.password.encode('utf-8') | |
edaa23f8 | 204 | packet = compat_struct_pack('!B', SOCKS5_USER_AUTH_VERSION) |
9e9cd724 | 205 | packet += self._len_and_data(username) + self._len_and_data(password) |
4350b745 YCH |
206 | self.sendall(packet) |
207 | ||
9e9cd724 | 208 | version, status = self._recv_bytes(2) |
4350b745 | 209 | |
9e9cd724 | 210 | self._check_response_version(SOCKS5_USER_AUTH_VERSION, version) |
4350b745 | 211 | |
9e9cd724 | 212 | if status != SOCKS5_USER_AUTH_SUCCESS: |
4350b745 | 213 | self.close() |
9e9cd724 | 214 | raise Socks5Error(Socks5Error.ERR_GENERAL_FAILURE) |
4350b745 | 215 | |
9e9cd724 YCH |
216 | def _setup_socks5(self, address): |
217 | destaddr, port = address | |
218 | ||
219 | ipaddr = self._resolve_address(destaddr, None, use_remote_dns=True) | |
220 | ||
221 | self._socks5_auth() | |
222 | ||
223 | reserved = 0 | |
edaa23f8 | 224 | packet = compat_struct_pack('!BBB', SOCKS5_VERSION, Socks5Command.CMD_CONNECT, reserved) |
4350b745 | 225 | if ipaddr is None: |
9e9cd724 | 226 | destaddr = destaddr.encode('utf-8') |
edaa23f8 | 227 | packet += compat_struct_pack('!B', Socks5AddressType.ATYP_DOMAINNAME) |
9e9cd724 | 228 | packet += self._len_and_data(destaddr) |
4350b745 | 229 | else: |
edaa23f8 YCH |
230 | packet += compat_struct_pack('!B', Socks5AddressType.ATYP_IPV4) + ipaddr |
231 | packet += compat_struct_pack('!H', port) | |
4350b745 YCH |
232 | |
233 | self.sendall(packet) | |
234 | ||
9e9cd724 | 235 | version, status, reserved, atype = self._recv_bytes(4) |
4350b745 | 236 | |
9e9cd724 | 237 | self._check_response_version(SOCKS5_VERSION, version) |
4350b745 | 238 | |
9e9cd724 | 239 | if status != Socks5Error.ERR_SUCCESS: |
4350b745 YCH |
240 | self.close() |
241 | raise Socks5Error(status) | |
242 | ||
9e9cd724 | 243 | if atype == Socks5AddressType.ATYP_IPV4: |
4350b745 | 244 | destaddr = self.recvall(4) |
9e9cd724 YCH |
245 | elif atype == Socks5AddressType.ATYP_DOMAINNAME: |
246 | alen = compat_ord(self.recv(1)) | |
4350b745 | 247 | destaddr = self.recvall(alen) |
9e9cd724 | 248 | elif atype == Socks5AddressType.ATYP_IPV6: |
4350b745 | 249 | destaddr = self.recvall(16) |
edaa23f8 | 250 | destport = compat_struct_unpack('!H', self.recvall(2))[0] |
71aff188 YCH |
251 | |
252 | return (destaddr, destport) | |
4350b745 YCH |
253 | |
254 | def _make_proxy(self, connect_func, address): | |
9e9cd724 | 255 | if not self._proxy: |
4350b745 YCH |
256 | return connect_func(self, address) |
257 | ||
9e9cd724 YCH |
258 | result = connect_func(self, (self._proxy.host, self._proxy.port)) |
259 | if result != 0 and result is not None: | |
260 | return result | |
261 | setup_funcs = { | |
262 | ProxyType.SOCKS4: self._setup_socks4, | |
263 | ProxyType.SOCKS4A: self._setup_socks4a, | |
264 | ProxyType.SOCKS5: self._setup_socks5, | |
265 | } | |
266 | setup_funcs[self._proxy.type](address) | |
267 | return result | |
268 | ||
4350b745 | 269 | def connect(self, address): |
71aff188 | 270 | self._make_proxy(socket.socket.connect, address) |
4350b745 YCH |
271 | |
272 | def connect_ex(self, address): | |
71aff188 | 273 | return self._make_proxy(socket.socket.connect_ex, address) |