1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
|
# Copyright 2012-2014, Damian Johnson and The Tor Project
# See LICENSE for licensing information
"""
Helper functions and classes to support tests which need to connect through
the tor network.
::
ProxyError - Base error for proxy issues.
+- SocksError - Reports problems returned by the SOCKS proxy.
Socks - Communicate through a SOCKS5 proxy with a socket interface
SocksPatch - Force socket-using code to use test.network.Socks
"""
import functools
import socket
import struct
import stem.util.connection
import stem.util.str_tools
from stem import ProtocolError, SocketError
# Store a reference to the original class so we can find it after
# monkey patching.
_socket_socket = socket.socket
SOCKS5_NOAUTH_GREETING = (0x05, 0x01, 0x00)
SOCKS5_NOAUTH_RESPONSE = (0x05, 0x00)
SOCKS5_CONN_BY_IPV4 = (0x05, 0x01, 0x00, 0x01)
SOCKS5_CONN_BY_NAME = (0x05, 0x01, 0x00, 0x03)
error_msgs = {
0x5a: 'SOCKS4A request granted',
0x5b: 'SOCKS4A request rejected or failed',
0x5c: 'SOCKS4A request failed because client is not running identd (or not reachable from the server)',
0x5d: "SOCKS4A request failed because client's identd could not confirm the user ID string in the request",
}
ip_request = """GET /ip HTTP/1.0
Host: ifconfig.me
Accept-Encoding: identity
"""
class ProxyError(Exception):
'Base error for proxy issues.'
class SocksError(ProxyError):
"""
Exception raised for any problems returned by the SOCKS proxy.
:var int code: error code returned by the SOCKS proxy
"""
# Error messages copied from http://en.wikipedia.org/wiki/SOCKS,
# retrieved 2012-12-15 17:09:21.
_ERROR_MESSAGE = {
0x01: 'general failure',
0x02: 'connection not allowed by ruleset',
0x03: 'network unreachable',
0x04: 'host unreachable',
0x05: 'connection refused by destination host',
0x06: 'TTL expired',
0x07: 'command not supported / protocol error',
0x08: 'address type not supported',
}
def __init__(self, code):
self.code = code
def __str__(self):
code = 0x01
if self.code in self._ERROR_MESSAGE:
code = self.code
return '[%s] %s' % (code, self._ERROR_MESSAGE[code])
class Socks(_socket_socket):
"""
A **socket.socket**-like interface through a SOCKS5 proxy connection.
Tor does not support proxy authentication, so neither does this class.
This class supports the context manager protocol. When used this way, the
socket will automatically close when leaving the context. An example:
::
from test.network import Socks
with Socks(('127.0.0.1', 9050)) as socks:
socks.settimeout(2)
socks.connect(('www.torproject.org', 443))
"""
def __init__(self, proxy_addr, family = socket.AF_INET,
type_ = socket.SOCK_STREAM, proto = 0, _sock = None):
"""
Creates a SOCKS5-aware socket which will route connections through the
proxy_addr SOCKS5 proxy. Currently, only IPv4 TCP connections are
supported, so the defaults for family and type_ are your best option.
:param tuple proxy_addr: address of the SOCKS5 proxy, for IPv4 this
contains (host, port)
:param int family: address family of the socket
:param int type_: address type of the socket (see **socket.socket** for
more information about family and type_)
:returns: :class:`~test.network.Socks`
"""
_socket_socket.__init__(self, family, type_, proto, _sock)
self._proxy_addr = proxy_addr
def __enter__(self, *args, **kwargs):
return self
def __exit__(self, exit_type, value, traceback):
self.close()
return False
def _recvall(self, expected_size):
"""
Returns expected number bytes from the socket, or dies trying.
:param int expected_size: number of bytes to return
:returns:
* **str** in Python 2 (bytes is str)
* **bytes** in Python 3
:raises:
* :class:`socket.error` for socket errors
* :class:`test.SocksError` if the received data was more that expected
"""
while True:
response = self.recv(expected_size * 2)
if len(response) == 0:
raise socket.error('socket closed unexpectedly?')
elif len(response) == expected_size:
return response
elif len(response) > expected_size:
raise SocksError(0x01)
def _ints_to_bytes(self, integers):
"""
Returns a byte string converted from integers.
:param list integers: list of ints to convert
:returns:
* **str** in Python 2 (bytes is str)
* **bytes** in Python 3
"""
if bytes is str:
bytes_ = ''.join([chr(x) for x in integers]) # Python 2
else:
bytes_ = bytes(integers) # Python 3
return bytes_
def _bytes_to_ints(self, bytes_):
"""
Returns a tuple of integers converted from a string (Python 2) or
bytes (Python 3).
:param str,bytes bytes_: byte string to convert
:returns: **list** of ints
"""
try:
integers = [ord(x) for x in bytes_] # Python 2
except TypeError:
integers = [x for x in bytes_] # Python 3
return tuple(integers)
def _pack_string(self, string_):
"""
Returns a packed string for sending over a socket.
:param str string_: string to convert
:returns:
* **str** in Python 2 (bytes is str)
* **bytes** in Python 3
"""
try:
return struct.pack('>%ss' % len(string_), string_)
except struct.error:
# Python 3: encode str to bytes
return struct.pack('>%ss' % len(string_), string_.encode())
def connect(self, address):
"""
Establishes a connection to address through the SOCKS5 proxy.
:param tuple address: target address, for IPv4 this contains
(host, port)
:raises: :class:`test.SocksError` for any errors
"""
_socket_socket.connect(self, (self._proxy_addr[0], self._proxy_addr[1]))
# ask for non-authenticated connection
self.sendall(self._ints_to_bytes(SOCKS5_NOAUTH_GREETING))
response = self._bytes_to_ints(self._recvall(2))
if response != SOCKS5_NOAUTH_RESPONSE:
raise SocksError(0x01)
if stem.util.connection.is_valid_ipv4_address(address[0]):
header = self._ints_to_bytes(SOCKS5_CONN_BY_IPV4)
header = header + socket.inet_aton(address[0])
else:
# As a last gasp, try connecting by name
header = self._ints_to_bytes(SOCKS5_CONN_BY_NAME)
header = header + self._ints_to_bytes([len(address[0])])
header = header + self._pack_string(address[0])
header = header + struct.pack('>H', address[1])
self.sendall(header)
response = self._bytes_to_ints(self._recvall(10))
# check the status byte
if response[1] != 0x00:
raise SocksError(response[1])
def connect_ex(self, address):
"""
Not Implemented.
"""
raise NotImplementedError
class SocksPatch(object):
"""
Monkey-patch **socket.socket** to use :class:`~test.network.Socks`, instead.
Classes in the patched context (e.g. urllib.urlopen in the example below)
do not use the SOCKS5 proxy for domain name resolution and such information
may be leaked.
::
import urllib
from test.network import SocksPatch
with SocksPatch(('127.0.0.1', 9050)):
with urllib.urlopen('https://www.torproject.org') as f:
for line in f.readline():
print line
"""
def __init__(self, *args, **kwargs):
self._partial = functools.partial(Socks, *args, **kwargs)
def __enter__(self):
socket.socket = self._partial
return self
def __exit__(self, exit_type, value, traceback):
socket.socket = _socket_socket
def external_ip(host, port):
"""
Returns the externally visible IP address when using a SOCKS4a proxy.
Negotiates the socks connection, connects to ipconfig.me and requests
http://ifconfig.me/ip to find out the externally visible IP.
Supports only SOCKS4a proxies.
:param str host: hostname/IP of the proxy server
:param int port: port on which the proxy server is listening
:returns: externally visible IP address, or None if it isn't able to
:raises: :class:`stem.socket.SocketError`: unable to connect a socket to the socks server
"""
try:
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.connect((host, int(port)))
except Exception as exc:
raise SocketError('Failed to connect to the socks server: ' + str(exc))
try:
negotiate_socks(sock, 'ifconfig.me', 80)
sock.sendall(ip_request)
response = sock.recv(1000)
# everything after the blank line is the 'data' in a HTTP response
# The response data for our request for request should be an IP address + '\n'
return response[response.find('\r\n\r\n'):].strip()
except Exception as exc:
return None
def negotiate_socks(sock, host, port):
"""
Negotiate with a socks4a server. Closes the socket and raises an exception on
failure.
:param socket sock: socket connected to socks4a server
:param str host: hostname/IP to connect to
:param int port: port to connect to
:raises: :class:`stem.ProtocolError` if the socks server doesn't grant our request
:returns: a list with the IP address and the port that the proxy connected to
"""
# SOCKS4a request here - http://en.wikipedia.org/wiki/SOCKS#Protocol
request = b'\x04\x01' + struct.pack('!H', port) + b'\x00\x00\x00\x01' + b'\x00' + stem.util.str_tools._to_bytes(host) + b'\x00'
sock.sendall(request)
response = sock.recv(8)
if len(response) != 8 or response[0:2] != b'\x00\x5a':
sock.close()
raise ProtocolError(error_msgs.get(response[1], 'SOCKS server returned unrecognized error code'))
return [socket.inet_ntoa(response[4:]), struct.unpack('!H', response[2:4])[0]]
|