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
|
import base64
import hashlib
import re
import socketserver
from collections import OrderedDict
import paho.mqtt.client as client
import pytest
from paho.mqtt.client import WebsocketConnectionError
from tests.testsupport.broker import fake_websocket_broker # noqa: F401
@pytest.fixture
def init_response_headers():
# "Normal" websocket response from server
response_headers = OrderedDict([
("Upgrade", "websocket"),
("Connection", "Upgrade"),
("Sec-WebSocket-Accept", "testwebsocketkey"),
("Sec-WebSocket-Protocol", "chat"),
])
return response_headers
def get_websocket_response(response_headers):
""" Takes headers and constructs HTTP response
'HTTP/1.1 101 Switching Protocols' is the headers for the response,
as expected in client.py
"""
response = "\r\n".join([
"HTTP/1.1 101 Switching Protocols",
"\r\n".join(f"{i}: {j}" for i, j in response_headers.items()),
"\r\n",
]).encode("utf8")
return response
@pytest.mark.parametrize("proto_ver,proto_name", [
(client.MQTTv31, "MQIsdp"),
(client.MQTTv311, "MQTT"),
])
class TestInvalidWebsocketResponse:
def test_unexpected_response(self, proto_ver, proto_name, fake_websocket_broker):
""" Server responds with a valid code, but it's not what the client expected """
mqttc = client.Client(
client.CallbackAPIVersion.VERSION1,
"test_unexpected_response",
protocol=proto_ver,
transport="websockets"
)
class WebsocketHandler(socketserver.BaseRequestHandler):
def handle(_self):
# Respond with data passed in to serve()
_self.request.sendall(b"200 OK")
with fake_websocket_broker.serve(WebsocketHandler), pytest.raises(WebsocketConnectionError) as exc:
mqttc.connect("localhost", fake_websocket_broker.port, keepalive=10)
assert str(exc.value) == "WebSocket handshake error"
@pytest.mark.parametrize("proto_ver,proto_name", [
(client.MQTTv31, "MQIsdp"),
(client.MQTTv311, "MQTT"),
])
class TestBadWebsocketHeaders:
""" Testing for basic functionality in checking for headers """
def _get_basic_handler(self, response_headers):
""" Get a basic BaseRequestHandler which returns the information in
self._response_headers
"""
response = get_websocket_response(response_headers)
class WebsocketHandler(socketserver.BaseRequestHandler):
def handle(_self):
self.data = _self.request.recv(1024).strip()
print('Received', self.data.decode('utf8'))
# Respond with data passed in to serve()
_self.request.sendall(response)
return WebsocketHandler
def test_no_upgrade(self, proto_ver, proto_name, fake_websocket_broker,
init_response_headers):
""" Server doesn't respond with 'connection: upgrade' """
mqttc = client.Client(
client.CallbackAPIVersion.VERSION1,
"test_no_upgrade",
protocol=proto_ver,
transport="websockets"
)
init_response_headers["Connection"] = "bad"
response = self._get_basic_handler(init_response_headers)
with fake_websocket_broker.serve(response), pytest.raises(WebsocketConnectionError) as exc:
mqttc.connect("localhost", fake_websocket_broker.port, keepalive=10)
assert str(exc.value) == "WebSocket handshake error, connection not upgraded"
def test_bad_secret_key(self, proto_ver, proto_name, fake_websocket_broker,
init_response_headers):
""" Server doesn't give anything after connection: upgrade """
mqttc = client.Client(
client.CallbackAPIVersion.VERSION1,
"test_bad_secret_key",
protocol=proto_ver,
transport="websockets"
)
response = self._get_basic_handler(init_response_headers)
with fake_websocket_broker.serve(response), pytest.raises(WebsocketConnectionError) as exc:
mqttc.connect("localhost", fake_websocket_broker.port, keepalive=10)
assert str(exc.value) == "WebSocket handshake error, invalid secret key"
@pytest.mark.parametrize("proto_ver,proto_name", [
(client.MQTTv31, "MQIsdp"),
(client.MQTTv311, "MQTT"),
])
class TestValidHeaders:
""" Testing for functionality in request/response headers """
def _get_callback_handler(self, response_headers, check_request=None):
""" Get a basic BaseRequestHandler which returns the information in
self._response_headers
"""
class WebsocketHandler(socketserver.BaseRequestHandler):
def handle(_self):
self.data = _self.request.recv(1024).strip()
print('Received', self.data.decode('utf8'))
decoded = self.data.decode("utf8")
if check_request is not None:
check_request(decoded)
# Create server hash
GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
key = re.search("sec-websocket-key: ([A-Za-z0-9+/=]*)", decoded, re.IGNORECASE).group(1)
to_hash = f"{key:s}{GUID:s}"
hashed = hashlib.sha1(to_hash.encode("utf8")) # noqa: S324
encoded = base64.b64encode(hashed.digest()).decode("utf8")
response_headers["Sec-WebSocket-Accept"] = encoded
# Respond with the correct hash
response = get_websocket_response(response_headers)
_self.request.sendall(response)
return WebsocketHandler
def test_successful_connection(self, proto_ver, proto_name,
fake_websocket_broker,
init_response_headers):
""" Connect successfully, on correct path """
mqttc = client.Client(
client.CallbackAPIVersion.VERSION1,
"test_successful_connection",
protocol=proto_ver,
transport="websockets"
)
response = self._get_callback_handler(init_response_headers)
with fake_websocket_broker.serve(response):
mqttc.connect("localhost", fake_websocket_broker.port, keepalive=10)
mqttc.disconnect()
@pytest.mark.parametrize("mqtt_path", [
"/mqtt"
"/special",
None,
])
def test_correct_path(self, proto_ver, proto_name, fake_websocket_broker,
mqtt_path, init_response_headers):
""" Make sure it can connect on user specified paths """
mqttc = client.Client(
client.CallbackAPIVersion.VERSION1,
"test_correct_path",
protocol=proto_ver,
transport="websockets"
)
mqttc.ws_set_options(
path=mqtt_path,
)
def check_path_correct(decoded):
# Make sure it connects to the right path
if mqtt_path:
assert re.search(f"GET {mqtt_path} HTTP/1.1", decoded, re.IGNORECASE) is not None
response = self._get_callback_handler(
init_response_headers,
check_request=check_path_correct,
)
with fake_websocket_broker.serve(response):
mqttc.connect("localhost", fake_websocket_broker.port, keepalive=10)
mqttc.disconnect()
@pytest.mark.parametrize("auth_headers", [
{"Authorization": "test123"},
{"Authorization": "test123", "auth2": "abcdef"},
# Won't be checked, but make sure it still works even if the user passes it
None,
])
def test_correct_auth(self, proto_ver, proto_name, fake_websocket_broker,
auth_headers, init_response_headers):
""" Make sure it sends the right auth headers """
mqttc = client.Client(
client.CallbackAPIVersion.VERSION1,
"test_correct_path",
protocol=proto_ver,
transport="websockets"
)
mqttc.ws_set_options(
headers=auth_headers,
)
def check_headers_used(decoded):
# Make sure it connects to the right path
if auth_headers:
for k, v in auth_headers.items():
assert f"{k}: {v}" in decoded
response = self._get_callback_handler(
init_response_headers,
check_request=check_headers_used,
)
with fake_websocket_broker.serve(response):
mqttc.connect("localhost", fake_websocket_broker.port, keepalive=10)
mqttc.disconnect()
|
