2009-11-25 Yuzo Fujishima <yuzo@google.com>
[WebKit-https.git] / WebKitTools / pywebsocket / mod_pywebsocket / handshake.py
1 # Copyright 2009, Google Inc.
2 # All rights reserved.
3 #
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are
6 # met:
7 #
8 #     * Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 #     * Redistributions in binary form must reproduce the above
11 # copyright notice, this list of conditions and the following disclaimer
12 # in the documentation and/or other materials provided with the
13 # distribution.
14 #     * Neither the name of Google Inc. nor the names of its
15 # contributors may be used to endorse or promote products derived from
16 # this software without specific prior written permission.
17 #
18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30
31 """Web Socket handshaking.
32
33 Note: request.connection.write/read are used in this module, even though
34 mod_python document says that they should be used only in connection handlers.
35 Unfortunately, we have no other options. For example, request.write/read are
36 not suitable because they don't allow direct raw bytes writing/reading.
37 """
38
39
40 import re
41
42
43 _DEFAULT_WEB_SOCKET_PORT = 80
44 _DEFAULT_WEB_SOCKET_SECURE_PORT = 443
45 _WEB_SOCKET_SCHEME = 'ws'
46 _WEB_SOCKET_SECURE_SCHEME = 'wss'
47
48 _METHOD_LINE = re.compile(r'^GET ([^ ]+) HTTP/1.1\r\n$')
49
50 _MANDATORY_HEADERS = [
51     # key, expected value or None
52     ['Upgrade', 'WebSocket'],
53     ['Connection', 'Upgrade'],
54     ['Host', None],
55     ['Origin', None],
56 ]
57
58
59 def _default_port(is_secure):
60     if is_secure:
61         return _DEFAULT_WEB_SOCKET_SECURE_PORT
62     else:
63         return _DEFAULT_WEB_SOCKET_PORT
64
65
66 class HandshakeError(Exception):
67     """Exception in Web Socket Handshake."""
68
69     pass
70
71
72 def _validate_protocol(protocol):
73     """Validate WebSocket-Protocol string."""
74
75     if not protocol:
76         raise HandshakeError('Invalid WebSocket-Protocol: empty')
77     for c in protocol:
78         if not 0x21 <= ord(c) <= 0x7e:
79             raise HandshakeError('Illegal character in protocol: %r' % c)
80
81
82 class Handshaker(object):
83     """This class performs Web Socket handshake."""
84
85     def __init__(self, request, dispatcher):
86         """Construct an instance.
87
88         Args:
89             request: mod_python request.
90             dispatcher: Dispatcher (dispatch.Dispatcher).
91
92         Handshaker will add attributes such as ws_resource in performing
93         handshake.
94         """
95
96         self._request = request
97         self._dispatcher = dispatcher
98
99     def do_handshake(self):
100         """Perform Web Socket Handshake."""
101
102         self._check_header_lines()
103         self._set_resource()
104         self._set_origin()
105         self._set_location()
106         self._set_protocol()
107         self._dispatcher.do_extra_handshake(self._request)
108         self._send_handshake()
109
110     def _set_resource(self):
111         self._request.ws_resource = self._request.uri
112
113     def _set_origin(self):
114         self._request.ws_origin = self._request.headers_in['Origin']
115
116     def _set_location(self):
117         location_parts = []
118         if self._request.is_https():
119             location_parts.append(_WEB_SOCKET_SECURE_SCHEME)
120         else:
121             location_parts.append(_WEB_SOCKET_SCHEME)
122         location_parts.append('://')
123         host, port = self._parse_host_header()
124         connection_port = self._request.connection.local_addr[1]
125         if port != connection_port:
126             raise HandshakeError('Header/connection port mismatch: %d/%d' %
127                                  (port, connection_port))
128         location_parts.append(host)
129         if (port != _default_port(self._request.is_https())):
130             location_parts.append(':')
131             location_parts.append(str(port))
132         location_parts.append(self._request.uri)
133         self._request.ws_location = ''.join(location_parts)
134
135     def _parse_host_header(self):
136         fields = self._request.headers_in['Host'].split(':', 1)
137         if len(fields) == 1:
138             return fields[0], _default_port(self._request.is_https())
139         try:
140             return fields[0], int(fields[1])
141         except ValueError, e:
142             raise HandshakeError('Invalid port number format: %r' % e)
143
144     def _set_protocol(self):
145         protocol = self._request.headers_in.get('WebSocket-Protocol')
146         if protocol is not None:
147             _validate_protocol(protocol)
148         self._request.ws_protocol = protocol
149
150     def _send_handshake(self):
151         self._request.connection.write(
152                 'HTTP/1.1 101 Web Socket Protocol Handshake\r\n')
153         self._request.connection.write('Upgrade: WebSocket\r\n')
154         self._request.connection.write('Connection: Upgrade\r\n')
155         self._request.connection.write('WebSocket-Origin: ')
156         self._request.connection.write(self._request.ws_origin)
157         self._request.connection.write('\r\n')
158         self._request.connection.write('WebSocket-Location: ')
159         self._request.connection.write(self._request.ws_location)
160         self._request.connection.write('\r\n')
161         if self._request.ws_protocol:
162             self._request.connection.write('WebSocket-Protocol: ')
163             self._request.connection.write(self._request.ws_protocol)
164             self._request.connection.write('\r\n')
165         self._request.connection.write('\r\n')
166
167     def _check_header_lines(self):
168         for key, expected_value in _MANDATORY_HEADERS:
169             actual_value = self._request.headers_in.get(key)
170             if not actual_value:
171                 raise HandshakeError('Header %s is not defined' % key)
172             if expected_value:
173                 if actual_value != expected_value:
174                     raise HandshakeError('Illegal value for header %s: %s' %
175                                          (key, actual_value))
176
177
178 # vi:sts=4 sw=4 et