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
|
# -*- coding: utf-8 -*-
from __future__ import absolute_import
from __future__ import print_function
from __future__ import unicode_literals
from __future__ import with_statement
from datetime import datetime
from .util import NetLocation
from .util import basestring
def hexIdFromHash(thehash):
"""
From the base-64 encoded hashes Tor uses, this produces the longer
hex-encoded hashes.
"""
return "$" + (thehash + "=").decode("base64").encode("hex").upper()
def hashFromHexId(hexid):
"""
From a hex fingerprint id, convert back to base-64 encoded value.
"""
if hexid[0] == '$':
hexid = hexid[1:]
return hexid.decode("hex").encode("base64")[:-2]
class PortRange(object):
"""
Represents a range of ports for Router policies.
"""
def __init__(self, a, b):
self.min = a
self.max = b
def __cmp__(self, b):
if b >= self.min and b <= self.max:
return 0
return 1
def __str__(self):
return "%d-%d" % (self.min, self.max)
class Router(object):
"""
Represents a Tor Router, including location.
The controller you pass in is really only used to do get_info
calls for ip-to-country/IP in case the
:class:`txtorcon.util.NetLocation` stuff fails to find a country.
After an .update() call, the id_hex attribute contains a
hex-encoded long hash (suitable, for example, to use in a
``GETINFO ns/id/*`` call).
After setting the policy property you may call accepts_port() to
find out if the router will accept a given port. This works with
the reject or accept based policies.
"""
def __init__(self, controller):
self.controller = controller
self._flags = []
self.bandwidth = 0
self.name_is_unique = False
self.accepted_ports = None
self.rejected_ports = None
self.id_hex = None
self._location = None
self.from_consensus = False
self.ip = 'unknown'
self.ip_v6 = [] # most routers have no IPv6 addresses
unique_name = property(lambda x: x.name_is_unique and x.name or x.id_hex)
"has the hex id if this router's name is not unique, or its name otherwise"
@property
def modified(self):
if self._modified is None:
self._modified = datetime.strptime(
self._modified_unparsed,
'%Y-%m-%f %H:%M:%S'
)
return self._modified
def update(self, name, idhash, orhash, modified, ip, orport, dirport):
self.name = name
self.id_hash = idhash
self.or_hash = orhash
# modified is lazy-parsed, approximately doubling router-parsing time
self._modified_unparsed = modified
self._modified = None
self.ip = ip
self.or_port = orport
self.dir_port = dirport
self._location = None
self.id_hex = hexIdFromHash(self.id_hash)
@property
def location(self):
"""
A NetLocation instance with some GeoIP or pygeoip information
about location, asn, city (if available).
"""
if self._location:
return self._location
if self.ip != 'unknown':
self._location = NetLocation(self.ip)
else:
self._location = NetLocation(None)
if not self._location.countrycode and self.ip != 'unknown':
# see if Tor is magic and knows more...
d = self.controller.get_info_raw('ip-to-country/' + self.ip)
d.addCallback(self._set_country)
# ignore errors (e.g. "GeoIP Information not loaded")
d.addErrback(lambda _: None)
return self._location
@property
def flags(self):
"""
A list of all the flags for this Router, each one an
all-lower-case string.
"""
return self._flags
@flags.setter
def flags(self, flags):
"""
It might be nice to make flags not a list of strings. This is
made harder by the control-spec: `...controllers MUST tolerate
unrecognized flags and lines...`
There is some current work in Twisted for open-ended constants
(enums) support however, it seems.
"""
if isinstance(flags, basestring):
flags = flags.split()
self._flags = [x.lower() for x in flags]
self.name_is_unique = 'named' in self._flags
@property
def bandwidth(self):
"""The reported bandwidth of this Router."""
return self._bandwidth
@bandwidth.setter
def bandwidth(self, bw):
self._bandwidth = int(bw)
@property
def policy(self):
"""
Port policies for this Router.
:return: a string describing the policy
"""
if self.accepted_ports:
return 'accept ' + ','.join(map(str, self.accepted_ports))
elif self.rejected_ports:
return 'reject ' + ','.join(map(str, self.rejected_ports))
else:
return ''
@policy.setter
def policy(self, args):
"""
setter for the policy descriptor
"""
word = args[0]
if word == 'reject':
self.accepted_ports = None
self.rejected_ports = []
target = self.rejected_ports
elif word == 'accept':
self.accepted_ports = []
self.rejected_ports = None
target = self.accepted_ports
else:
raise RuntimeError("Don't understand policy word \"%s\"" % word)
for port in args[1].split(','):
if '-' in port:
(a, b) = port.split('-')
target.append(PortRange(int(a), int(b)))
else:
target.append(int(port))
def accepts_port(self, port):
"""
Query whether this Router will accept the given port.
"""
if self.rejected_ports is None and self.accepted_ports is None:
raise RuntimeError("policy hasn't been set yet")
if self.rejected_ports:
for x in self.rejected_ports:
if port == x:
return False
return True
for x in self.accepted_ports:
if port == x:
return True
return False
def _set_country(self, c):
"""
callback if we used Tor's GETINFO ip-to-country
"""
self.location.countrycode = c.split()[0].split('=')[1].strip().upper()
def __repr__(self):
n = self.id_hex
if self.name_is_unique:
n = self.name
return "<Router %s %s %s>" % (n, self.location.countrycode,
self.policy)
|