forked from fiorix/cyclone
/
websocket.py
322 lines (265 loc) · 11 KB
/
websocket.py
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
# coding: utf-8
#
# Copyright 2010 Alexandre Fiori
# based on the original Tornado by Facebook
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import base64
import hashlib
import struct
import cyclone
import cyclone.web
import cyclone.escape
from twisted.python import log
class WebSocketHandler(cyclone.web.RequestHandler):
def __init__(self, application, request):
cyclone.web.RequestHandler.__init__(self, application, request)
self.application = application
self.request = request
self.transport = request.connection.transport
self.ws_protocol = None;
def headersReceived(self):
pass
def connectionMade(self, *args, **kwargs):
pass
def connectionLost(self, reason):
pass
def messageReceived(self, message):
pass
def sendMessage(self, message):
if isinstance(message, dict):
message = cyclone.escape.json_encode(message)
if isinstance(message, unicode):
message = message.encode("utf-8")
assert isinstance(message, str)
self.ws_protocol.sendMessage(message)
def _rawDataReceived(self, data):
self.ws_protocol.handleRawData(data)
def _execute(self, transforms, *args, **kwargs):
self._transforms = transforms or list()
try:
assert self.request.headers["Upgrade"].lower() == "websocket"
#assert self.request.headers["Connection"].lower() == "upgrade"
except:
return self.forbidConnection("Expected WebSocket Headers")
if self.request.headers.has_key('Sec-Websocket-Version') and \
self.request.headers['Sec-Websocket-Version'] in ('7', '8', '13'):
self.ws_protocol = WebSocketProtocol17(self)
elif self.request.headers.has_key("Sec-WebSocket-Version"):
self.transport.write(cyclone.escape.utf8(
"HTTP/1.1 426 Upgrade Required\r\n"
"Sec-WebSocket-Version: 8\r\n\r\n"))
self.transport.loseConnection()
else:
self.ws_protocol = WebSocketProtocol76(self)
self.request.connection.setRawMode()
self.request.connection.rawDataReceived = self.ws_protocol.rawDataReceived
self.ws_protocol.acceptConnection()
self.connectionMade(*args, **kwargs)
def forbidConnection(self, message):
self.transport.write(
"HTTP/1.1 403 Forbidden\r\nContent-Length: %s\r\n\r\n%s" % \
(str(len(message)), message))
return self.transport.loseConnection()
class WebSocketProtocol(object):
def __init__(self, handler):
self.handler = handler
self.request = handler.request
self.transport = handler.transport
def acceptConnection(self):
pass
def rawDataReceived(self, data):
pass
def sendMessage(self, message):
pass
class WebSocketProtocol17(WebSocketProtocol):
def __init__(self, handler):
WebSocketProtocol.__init__(self, handler)
self._partial_data = None
self._frame_fin = None
self._frame_rsv = None
self._frame_ops = None
self._frame_mask = None
self._frame_payload_length = None
self._frame_header_length = None
self._raw_data_length = None
self._header_index = None
self._message_buffer = ""
def acceptConnection(self):
log.msg('Using ws spec (draft 17)')
# The difference between version 8 and 13 is that in 8 the
# client sends a "Sec-Websocket-Origin" header and in 13 it's
# simply "Origin".
if 'Origin' in self.request.headers:
origin = self.request.headers['Origin']
else:
origin = self.request.headers['Sec-Websocket-Origin']
key = self.request.headers['Sec-Websocket-Key']
accept = base64.b64encode(hashlib.sha1("%s%s" % \
(key, '258EAFA5-E914-47DA-95CA-C5AB0DC85B11')).digest())
self.transport.write(
"HTTP/1.1 101 Web Socket Protocol Handshake\r\n"
"Upgrade: WebSocket\r\n"
"Connection: Upgrade\r\n"
"Sec-WebSocket-Accept: %s\r\n"
"Server: cyclone/%s\r\n"
"WebSocket-Origin: %s\r\n"
"WebSocket-Location: ws://%s%s\r\n\r\n" % \
(accept, cyclone.version, origin,
self.request.host, self.request.path))
def rawDataReceived(self, data):
self._raw_data_len = len(data)
if self._partial_data:
data = self._partial_data + data
self._partial_data = None
self._processFrameHeader(data)
if (self._raw_data_len - self._header_index) < self._frame_payload_len:
self._partial_data = data
return
self._message_buffer += self._extractMessageFromFrame(data)
if self._frame_fin:
if self._frame_ops == 8:
self.sendMessage(self._message_buffer, code=0x88)
self.handler.connectionLost(self._message_buffer)
elif self._frame_ops == 9:
self.sendMessage(self._message_buffer, code=0x8A)
else:
self.handler.messageReceived(self._message_buffer)
self._message_buffer = ""
# if there is still data after this frame, process again
current_len = self._frame_header_len + self._frame_payload_len
if current_len < self._raw_data_len:
self.rawDataReceived(data[current_len:])
def _processFrameHeader(self, data):
# first byte contains fin, rsv and ops
b = ord(data[0])
self._frame_fin = (b & 0x80) != 0
self._frame_rsv = (b & 0x70) >> 4
self._frame_ops = b & 0x0f
# second byte contains mask and payload length
b = ord(data[1])
self._frame_mask = (b & 0x80) != 0
frame_payload_len1 = b & 0x7f
if (self._frame_mask):
mask_len = 4
else:
mask_len = 0
# i is frame index. It's at 2 here because we've already processed the
# first 2 bytes of the frame.
i = 2
if frame_payload_len1 < 126:
self._frame_header_len = i + mask_len
self._frame_payload_len = frame_payload_len1
elif frame_payload_len1 == 126:
self._frame_header_len = i + 2 + mask_len
self._frame_payload_len = struct.unpack("!H", data[i:i+2])[0]
i += 2
elif frame_payload_len1 == 127:
self._frame_header_len = i + 8 + mask_len
self._frame_payload_len = struct.unpack("!Q", data[i:i+8])[0]
i += 8
self._header_index = i
def _extractMessageFromFrame(self, data):
i = self._header_index
# when payload is masked, extract frame mask
frame_mask = None
frame_mask_array = []
if self._frame_mask:
frame_mask = data[i:i+4]
for j in range(0, 4):
frame_mask_array.append(ord(frame_mask[j]))
i += 4
payload = bytearray(data[i:i+self._frame_payload_len])
for k in xrange(0, self._frame_payload_len):
payload[k] ^= frame_mask_array[k % 4]
return str(payload)
def sendMessage(self, message, code=0x81):
message = unicode(message, "utf-8")
length = len(message)
newFrame = []
newFrame.append(code)
newFrame = bytearray(newFrame)
if length <= 125:
newFrame.append(length)
elif length > 125 and length < 65536:
newFrame.append(126)
newFrame += struct.pack('!H', length)
elif length >= 65536:
newFrame.append(127)
newFrame += struct.pack('!Q', length)
newFrame += message.encode('utf-8')
self.transport.write(str(newFrame))
class WebSocketProtocol76(WebSocketProtocol):
def __init__(self, handler):
WebSocketProtocol.__init__(self, handler)
self._k1 = None
self._k2 = None
self._nonce = None
self._postheader = False
self._protocol = None
def acceptConnection(self):
if self.request.headers.has_key('Sec-Websocket-Key1') == False or \
self.request.headers.has_key('Sec-Websocket-Key2') == False:
log.msg('Using old ws spec (draft 75)')
self.transport.write(
"HTTP/1.1 101 Web Socket Protocol Handshake\r\n"
"Upgrade: WebSocket\r\n"
"Connection: Upgrade\r\n"
"Server: cyclone/%s\r\n"
"WebSocket-Origin: %s\r\n"
"WebSocket-Location: ws://%s%s\r\n\r\n" % \
(cyclone.version, self.request.headers["Origin"],
self.request.host, self.request.path))
self._protocol = 75
else:
log.msg('Using ws draft 76 header exchange')
self._k1 = self.request.headers["Sec-WebSocket-Key1"]
self._k2 = self.request.headers["Sec-WebSocket-Key2"]
self._protocol = 76
self._postheader = True
def rawDataReceived(self, data):
if self._postheader == True and self._protocol >= 76 and len(data) == 8:
self._nonce = data.strip()
token = self._calculate_token(self._k1, self._k2, self._nonce)
self.transport.write(
"HTTP/1.1 101 Web Socket Protocol Handshake\r\n"
"Upgrade: WebSocket\r\n"
"Connection: Upgrade\r\n"
"Server: cyclone/%s\r\n"
"Sec-WebSocket-Origin: %s\r\n"
"Sec-WebSocket-Location: ws://%s%s\r\n\r\n%s\r\n\r\n" % \
(cyclone.version, self.request.headers["Origin"],
self.request.host, self.request.path, token))
self._postheader = False
self.handler.flush()
return
try:
messages = data.split('\xff')
for message in messages[:-1]:
self.handler.messageReceived(message[1:])
except Exception, e:
log.msg("Invalid WebSocket Message: %s" % repr(data))
self._handle_request_exception(e)
def sendMessage(self, message):
self.transport.write("\x00" + message + "\xff")
def _calculate_token(self, k1, k2, k3):
token = struct.pack('>II8s', self._filterella(k1), self._filterella(k2), k3)
return hashlib.md5(token).digest()
def _filterella(self, w):
nums = []
spaces = 0
for l in w:
if l.isdigit(): nums.append(l)
if l.isspace(): spaces = spaces + 1
x = int(''.join(nums))/spaces
return x