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
|
"""
Integration tests for the stem.response.ControlMessage class.
"""
import re
import unittest
import stem.socket
import stem.version
import test.runner
class TestControlMessage(unittest.TestCase):
def test_unestablished_socket(self):
"""
Checks message parsing when we have a valid but unauthenticated socket.
"""
if test.runner.require_control(self):
return
# If an unauthenticated connection gets a message besides AUTHENTICATE or
# PROTOCOLINFO then tor will give an 'Authentication required.' message and
# hang up.
control_socket = test.runner.get_runner().get_tor_socket(False)
control_socket.send('GETINFO version')
auth_required_response = control_socket.recv()
self.assertEquals('Authentication required.', str(auth_required_response))
self.assertEquals(['Authentication required.'], list(auth_required_response))
self.assertEquals('514 Authentication required.\r\n', auth_required_response.raw_content())
self.assertEquals([('514', ' ', 'Authentication required.')], auth_required_response.content())
# The socket's broken but doesn't realize it yet. These use cases are
# checked in more depth by the ControlSocket integ tests.
self.assertTrue(control_socket.is_alive())
self.assertRaises(stem.SocketClosed, control_socket.recv)
self.assertFalse(control_socket.is_alive())
# Additional socket usage should fail, and pulling more responses will fail
# with more closed exceptions.
self.assertRaises(stem.SocketError, control_socket.send, 'GETINFO version')
self.assertRaises(stem.SocketClosed, control_socket.recv)
self.assertRaises(stem.SocketClosed, control_socket.recv)
self.assertRaises(stem.SocketClosed, control_socket.recv)
# The socket connection is already broken so calling close shouldn't have
# an impact.
control_socket.close()
self.assertRaises(stem.SocketClosed, control_socket.send, 'GETINFO version')
self.assertRaises(stem.SocketClosed, control_socket.recv)
def test_invalid_command(self):
"""
Parses the response for a command which doesn't exist.
"""
if test.runner.require_control(self):
return
with test.runner.get_runner().get_tor_socket() as control_socket:
control_socket.send('blarg')
unrecognized_command_response = control_socket.recv()
self.assertEquals('Unrecognized command "blarg"', str(unrecognized_command_response))
self.assertEquals(['Unrecognized command "blarg"'], list(unrecognized_command_response))
self.assertEquals('510 Unrecognized command "blarg"\r\n', unrecognized_command_response.raw_content())
self.assertEquals([('510', ' ', 'Unrecognized command "blarg"')], unrecognized_command_response.content())
def test_invalid_getinfo(self):
"""
Parses the response for a GETINFO query which doesn't exist.
"""
if test.runner.require_control(self):
return
with test.runner.get_runner().get_tor_socket() as control_socket:
control_socket.send('GETINFO blarg')
unrecognized_key_response = control_socket.recv()
self.assertEquals('Unrecognized key "blarg"', str(unrecognized_key_response))
self.assertEquals(['Unrecognized key "blarg"'], list(unrecognized_key_response))
self.assertEquals('552 Unrecognized key "blarg"\r\n', unrecognized_key_response.raw_content())
self.assertEquals([('552', ' ', 'Unrecognized key "blarg"')], unrecognized_key_response.content())
def test_getinfo_config_file(self):
"""
Parses the 'GETINFO config-file' response.
"""
if test.runner.require_control(self):
return
runner = test.runner.get_runner()
torrc_dst = runner.get_torrc_path()
with runner.get_tor_socket() as control_socket:
control_socket.send('GETINFO config-file')
config_file_response = control_socket.recv()
self.assertEquals('config-file=%s\nOK' % torrc_dst, str(config_file_response))
self.assertEquals(['config-file=%s' % torrc_dst, 'OK'], list(config_file_response))
self.assertEquals('250-config-file=%s\r\n250 OK\r\n' % torrc_dst, config_file_response.raw_content())
self.assertEquals([('250', '-', 'config-file=%s' % torrc_dst), ('250', ' ', 'OK')], config_file_response.content())
def test_getinfo_config_text(self):
"""
Parses the 'GETINFO config-text' response.
"""
if test.runner.require_control(self):
return
elif test.runner.require_version(self, stem.version.Requirement.GETINFO_CONFIG_TEXT):
return
runner = test.runner.get_runner()
# We can't be certain of the order, and there may be extra config-text
# entries as per...
# https://trac.torproject.org/projects/tor/ticket/2362
#
# so we'll just check that the response is a superset of our config
torrc_contents = []
for line in runner.get_torrc_contents().splitlines():
line = line.strip()
if line and not line.startswith('#'):
torrc_contents.append(line)
with runner.get_tor_socket() as control_socket:
control_socket.send('GETINFO config-text')
config_text_response = control_socket.recv()
# the response should contain two entries, the first being a data response
self.assertEqual(2, len(list(config_text_response)))
self.assertEqual('OK', list(config_text_response)[1])
self.assertEqual(('250', ' ', 'OK'), config_text_response.content()[1])
self.assertTrue(config_text_response.raw_content().startswith('250+config-text=\r\n'))
self.assertTrue(config_text_response.raw_content().endswith('\r\n.\r\n250 OK\r\n'))
self.assertTrue(str(config_text_response).startswith('config-text=\n'))
self.assertTrue(str(config_text_response).endswith('\nOK'))
for torrc_entry in torrc_contents:
self.assertTrue('\n%s\n' % torrc_entry in str(config_text_response))
self.assertTrue(torrc_entry in list(config_text_response)[0])
self.assertTrue('%s\r\n' % torrc_entry in config_text_response.raw_content())
self.assertTrue('%s' % torrc_entry in config_text_response.content()[0][2])
def test_bw_event(self):
"""
Issues 'SETEVENTS BW' and parses a couple events.
"""
if test.runner.require_control(self):
return
with test.runner.get_runner().get_tor_socket() as control_socket:
control_socket.send('SETEVENTS BW')
setevents_response = control_socket.recv()
self.assertEquals('OK', str(setevents_response))
self.assertEquals(['OK'], list(setevents_response))
self.assertEquals('250 OK\r\n', setevents_response.raw_content())
self.assertEquals([('250', ' ', 'OK')], setevents_response.content())
# Tor will emit a BW event once per second. Parsing two of them.
for _ in range(2):
bw_event = control_socket.recv()
self.assertTrue(re.match('BW [0-9]+ [0-9]+', str(bw_event)))
self.assertTrue(re.match('650 BW [0-9]+ [0-9]+\r\n', bw_event.raw_content()))
self.assertEquals(('650', ' '), bw_event.content()[0][:2])
|
