542d885874
Due to a bug in python < 2.7.4, urlparse won't parse a query string
in a URL where the scheme is not recognized:
http://bugs.python.org/issue9374
Commit 1dda5ef75a added some tests for
websocketproxy that uses urlparse to get a token but these don't work
on python < 2.7.4 since the scheme in the tests is "ws://".
In the actual code, raise an exception if python < 2.7.4 and an
unsupported URL scheme is used.
DocImpact: The "getting-started-with-vnc-proxy" page in the
"admin-guide-cloud" docs should be updated with a note that the web
proxy console URLs do not support the websocket protocol scheme (ws://)
on python versions less than 2.7.4.
Change-Id: Ib6e0fc4e50c1ea144a9c538099e23597d66b429b
Closes-Bug: #1376078
122 lines
4.3 KiB
Python
122 lines
4.3 KiB
Python
# Copyright (c) 2012 OpenStack Foundation
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
|
|
'''
|
|
Websocket proxy that is compatible with OpenStack Nova.
|
|
Leverages websockify.py by Joel Martin
|
|
'''
|
|
|
|
import Cookie
|
|
import socket
|
|
import sys
|
|
import urlparse
|
|
|
|
import websockify
|
|
|
|
from nova.consoleauth import rpcapi as consoleauth_rpcapi
|
|
from nova import context
|
|
from nova import exception
|
|
from nova.i18n import _
|
|
from nova.openstack.common import log as logging
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class NovaProxyRequestHandlerBase(object):
|
|
def new_websocket_client(self):
|
|
"""Called after a new WebSocket connection has been established."""
|
|
# Reopen the eventlet hub to make sure we don't share an epoll
|
|
# fd with parent and/or siblings, which would be bad
|
|
from eventlet import hubs
|
|
hubs.use_hub()
|
|
|
|
# The nova expected behavior is to have token
|
|
# passed to the method GET of the request
|
|
parse = urlparse.urlparse(self.path)
|
|
if parse.scheme not in ('http', 'https'):
|
|
# From a bug in urlparse in Python < 2.7.4 we cannot support
|
|
# special schemes (cf: http://bugs.python.org/issue9374)
|
|
if sys.version_info < (2, 7, 4):
|
|
raise exception.NovaException(
|
|
_("We do not support scheme '%s' under Python < 2.7.4, "
|
|
"please use http or https") % parse.scheme)
|
|
|
|
query = parse.query
|
|
token = urlparse.parse_qs(query).get("token", [""]).pop()
|
|
if not token:
|
|
# NoVNC uses it's own convention that forward token
|
|
# from the request to a cookie header, we should check
|
|
# also for this behavior
|
|
hcookie = self.headers.getheader('cookie')
|
|
if hcookie:
|
|
cookie = Cookie.SimpleCookie()
|
|
cookie.load(hcookie)
|
|
if 'token' in cookie:
|
|
token = cookie['token'].value
|
|
|
|
ctxt = context.get_admin_context()
|
|
rpcapi = consoleauth_rpcapi.ConsoleAuthAPI()
|
|
connect_info = rpcapi.check_token(ctxt, token=token)
|
|
|
|
if not connect_info:
|
|
raise exception.InvalidToken(token=token)
|
|
|
|
self.msg(_('connect info: %s'), str(connect_info))
|
|
host = connect_info['host']
|
|
port = int(connect_info['port'])
|
|
|
|
# Connect to the target
|
|
self.msg(_("connecting to: %(host)s:%(port)s") % {'host': host,
|
|
'port': port})
|
|
tsock = self.socket(host, port, connect=True)
|
|
|
|
# Handshake as necessary
|
|
if connect_info.get('internal_access_path'):
|
|
tsock.send("CONNECT %s HTTP/1.1\r\n\r\n" %
|
|
connect_info['internal_access_path'])
|
|
while True:
|
|
data = tsock.recv(4096, socket.MSG_PEEK)
|
|
if data.find("\r\n\r\n") != -1:
|
|
if data.split("\r\n")[0].find("200") == -1:
|
|
raise Exception(_("Invalid Connection Info"))
|
|
tsock.recv(len(data))
|
|
break
|
|
|
|
# Start proxying
|
|
try:
|
|
self.do_proxy(tsock)
|
|
except Exception:
|
|
if tsock:
|
|
tsock.shutdown(socket.SHUT_RDWR)
|
|
tsock.close()
|
|
self.vmsg(_("%(host)s:%(port)s: Target closed") %
|
|
{'host': host, 'port': port})
|
|
raise
|
|
|
|
|
|
class NovaProxyRequestHandler(NovaProxyRequestHandlerBase,
|
|
websockify.ProxyRequestHandler):
|
|
def __init__(self, *args, **kwargs):
|
|
websockify.ProxyRequestHandler.__init__(self, *args, **kwargs)
|
|
|
|
def socket(self, *args, **kwargs):
|
|
return websockify.WebSocketServer.socket(*args, **kwargs)
|
|
|
|
|
|
class NovaWebSocketProxy(websockify.WebSocketProxy):
|
|
@staticmethod
|
|
def get_logger():
|
|
return LOG
|