##// END OF EJS Templates
Use *args, **kwargs, log.warn
Kyle Kelley -
Show More
@@ -1,145 +1,145
1 """Tornado handlers for WebSocket <-> ZMQ sockets.
1 """Tornado handlers for WebSocket <-> ZMQ sockets.
2
2
3 Authors:
3 Authors:
4
4
5 * Brian Granger
5 * Brian Granger
6 """
6 """
7
7
8 #-----------------------------------------------------------------------------
8 #-----------------------------------------------------------------------------
9 # Copyright (C) 2008-2011 The IPython Development Team
9 # Copyright (C) 2008-2011 The IPython Development Team
10 #
10 #
11 # Distributed under the terms of the BSD License. The full license is in
11 # Distributed under the terms of the BSD License. The full license is in
12 # the file COPYING, distributed as part of this software.
12 # the file COPYING, distributed as part of this software.
13 #-----------------------------------------------------------------------------
13 #-----------------------------------------------------------------------------
14
14
15 #-----------------------------------------------------------------------------
15 #-----------------------------------------------------------------------------
16 # Imports
16 # Imports
17 #-----------------------------------------------------------------------------
17 #-----------------------------------------------------------------------------
18
18
19 try:
19 try:
20 from urllib.parse import urlparse # Py 3
20 from urllib.parse import urlparse # Py 3
21 except ImportError:
21 except ImportError:
22 from urlparse import urlparse # Py 2
22 from urlparse import urlparse # Py 2
23
23
24 try:
24 try:
25 from http.cookies import SimpleCookie # Py 3
25 from http.cookies import SimpleCookie # Py 3
26 except ImportError:
26 except ImportError:
27 from Cookie import SimpleCookie # Py 2
27 from Cookie import SimpleCookie # Py 2
28 import logging
28 import logging
29 from tornado import web
29 from tornado import web
30 from tornado import websocket
30 from tornado import websocket
31
31
32 from zmq.utils import jsonapi
32 from zmq.utils import jsonapi
33
33
34 from IPython.kernel.zmq.session import Session
34 from IPython.kernel.zmq.session import Session
35 from IPython.utils.jsonutil import date_default
35 from IPython.utils.jsonutil import date_default
36 from IPython.utils.py3compat import PY3, cast_unicode
36 from IPython.utils.py3compat import PY3, cast_unicode
37
37
38 from .handlers import IPythonHandler
38 from .handlers import IPythonHandler
39
39
40 #-----------------------------------------------------------------------------
40 #-----------------------------------------------------------------------------
41 # ZMQ handlers
41 # ZMQ handlers
42 #-----------------------------------------------------------------------------
42 #-----------------------------------------------------------------------------
43
43
44 class ZMQStreamHandler(websocket.WebSocketHandler):
44 class ZMQStreamHandler(websocket.WebSocketHandler):
45
45
46 def check_origin(self):
46 def check_origin(self):
47 """Check origin from headers."""
47 """Check origin from headers."""
48 origin_header = self.request.headers["Origin"]
48 origin_header = self.request.headers["Origin"]
49 host = self.request.headers["Host"]
49 host = self.request.headers["Host"]
50
50
51 parsed_origin = urlparse(origin_header)
51 parsed_origin = urlparse(origin_header)
52 origin = parsed_origin.netloc
52 origin = parsed_origin.netloc
53
53
54 # Check to see that origin matches host directly, including ports
54 # Check to see that origin matches host directly, including ports
55 if origin != host:
55 if origin != host:
56 self.log.critical("Cross Origin WebSocket Attempt.")
56 self.log.warn("Cross Origin WebSocket Attempt.")
57 raise web.HTTPError(404)
57 raise web.HTTPError(404)
58
58
59
59
60 def _execute(self, transforms, *args, **kwargs):
60 def _execute(self, *args, **kwargs):
61 """Wrap all calls to make sure origin gets checked."""
61 """Wrap all calls to make sure origin gets checked."""
62
62
63 # Check to see that origin matches host directly, including ports
63 # Check to see that origin matches host directly, including ports
64 self.check_origin()
64 self.check_origin()
65
65
66 # Pass on the rest of the handling by the WebSocketHandler
66 # Pass on the rest of the handling by the WebSocketHandler
67 super(ZMQStreamHandler, self)._execute(transforms, *args, **kwargs)
67 super(ZMQStreamHandler, self)._execute(*args, **kwargs)
68
68
69 def clear_cookie(self, *args, **kwargs):
69 def clear_cookie(self, *args, **kwargs):
70 """meaningless for websockets"""
70 """meaningless for websockets"""
71 pass
71 pass
72
72
73 def _reserialize_reply(self, msg_list):
73 def _reserialize_reply(self, msg_list):
74 """Reserialize a reply message using JSON.
74 """Reserialize a reply message using JSON.
75
75
76 This takes the msg list from the ZMQ socket, unserializes it using
76 This takes the msg list from the ZMQ socket, unserializes it using
77 self.session and then serializes the result using JSON. This method
77 self.session and then serializes the result using JSON. This method
78 should be used by self._on_zmq_reply to build messages that can
78 should be used by self._on_zmq_reply to build messages that can
79 be sent back to the browser.
79 be sent back to the browser.
80 """
80 """
81 idents, msg_list = self.session.feed_identities(msg_list)
81 idents, msg_list = self.session.feed_identities(msg_list)
82 msg = self.session.unserialize(msg_list)
82 msg = self.session.unserialize(msg_list)
83 try:
83 try:
84 msg['header'].pop('date')
84 msg['header'].pop('date')
85 except KeyError:
85 except KeyError:
86 pass
86 pass
87 try:
87 try:
88 msg['parent_header'].pop('date')
88 msg['parent_header'].pop('date')
89 except KeyError:
89 except KeyError:
90 pass
90 pass
91 msg.pop('buffers')
91 msg.pop('buffers')
92 return jsonapi.dumps(msg, default=date_default)
92 return jsonapi.dumps(msg, default=date_default)
93
93
94 def _on_zmq_reply(self, msg_list):
94 def _on_zmq_reply(self, msg_list):
95 # Sometimes this gets triggered when the on_close method is scheduled in the
95 # Sometimes this gets triggered when the on_close method is scheduled in the
96 # eventloop but hasn't been called.
96 # eventloop but hasn't been called.
97 if self.stream.closed(): return
97 if self.stream.closed(): return
98 try:
98 try:
99 msg = self._reserialize_reply(msg_list)
99 msg = self._reserialize_reply(msg_list)
100 except Exception:
100 except Exception:
101 self.log.critical("Malformed message: %r" % msg_list, exc_info=True)
101 self.log.critical("Malformed message: %r" % msg_list, exc_info=True)
102 else:
102 else:
103 self.write_message(msg)
103 self.write_message(msg)
104
104
105 def allow_draft76(self):
105 def allow_draft76(self):
106 """Allow draft 76, until browsers such as Safari update to RFC 6455.
106 """Allow draft 76, until browsers such as Safari update to RFC 6455.
107
107
108 This has been disabled by default in tornado in release 2.2.0, and
108 This has been disabled by default in tornado in release 2.2.0, and
109 support will be removed in later versions.
109 support will be removed in later versions.
110 """
110 """
111 return True
111 return True
112
112
113
113
114 class AuthenticatedZMQStreamHandler(ZMQStreamHandler, IPythonHandler):
114 class AuthenticatedZMQStreamHandler(ZMQStreamHandler, IPythonHandler):
115
115
116 def open(self, kernel_id):
116 def open(self, kernel_id):
117 self.kernel_id = cast_unicode(kernel_id, 'ascii')
117 self.kernel_id = cast_unicode(kernel_id, 'ascii')
118 self.session = Session(config=self.config)
118 self.session = Session(config=self.config)
119 self.save_on_message = self.on_message
119 self.save_on_message = self.on_message
120 self.on_message = self.on_first_message
120 self.on_message = self.on_first_message
121
121
122 def _inject_cookie_message(self, msg):
122 def _inject_cookie_message(self, msg):
123 """Inject the first message, which is the document cookie,
123 """Inject the first message, which is the document cookie,
124 for authentication."""
124 for authentication."""
125 if not PY3 and isinstance(msg, unicode):
125 if not PY3 and isinstance(msg, unicode):
126 # Cookie constructor doesn't accept unicode strings
126 # Cookie constructor doesn't accept unicode strings
127 # under Python 2.x for some reason
127 # under Python 2.x for some reason
128 msg = msg.encode('utf8', 'replace')
128 msg = msg.encode('utf8', 'replace')
129 try:
129 try:
130 identity, msg = msg.split(':', 1)
130 identity, msg = msg.split(':', 1)
131 self.session.session = cast_unicode(identity, 'ascii')
131 self.session.session = cast_unicode(identity, 'ascii')
132 except Exception:
132 except Exception:
133 logging.error("First ws message didn't have the form 'identity:[cookie]' - %r", msg)
133 logging.error("First ws message didn't have the form 'identity:[cookie]' - %r", msg)
134
134
135 try:
135 try:
136 self.request._cookies = SimpleCookie(msg)
136 self.request._cookies = SimpleCookie(msg)
137 except:
137 except:
138 self.log.warn("couldn't parse cookie string: %s",msg, exc_info=True)
138 self.log.warn("couldn't parse cookie string: %s",msg, exc_info=True)
139
139
140 def on_first_message(self, msg):
140 def on_first_message(self, msg):
141 self._inject_cookie_message(msg)
141 self._inject_cookie_message(msg)
142 if self.get_current_user() is None:
142 if self.get_current_user() is None:
143 self.log.warn("Couldn't authenticate WebSocket connection")
143 self.log.warn("Couldn't authenticate WebSocket connection")
144 raise web.HTTPError(403)
144 raise web.HTTPError(403)
145 self.on_message = self.save_on_message No newline at end of file
145 self.on_message = self.save_on_message
General Comments 0
You need to be logged in to leave comments. Login now