¡@

Home 

OpenStack Study: xvp_proxy.py

OpenStack Index

**** CubicPower OpenStack Study ****

#!/usr/bin/env 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.

"""Eventlet WSGI Services to proxy VNC for XCP protocol."""

import socket

import webob

import eventlet

import eventlet.green

import eventlet.greenio

import eventlet.wsgi

from oslo.config import cfg

from nova.consoleauth import rpcapi as consoleauth_rpcapi

from nova import context

from nova.openstack.common.gettextutils import _

from nova.openstack.common import log as logging

from nova import version

from nova import wsgi

LOG = logging.getLogger(__name__)

xvp_proxy_opts = [

cfg.IntOpt('xvpvncproxy_port',

default=6081,

help='Port that the XCP VNC proxy should bind to'),

cfg.StrOpt('xvpvncproxy_host',

default='0.0.0.0',

help='Address that the XCP VNC proxy should bind to'),

]

CONF = cfg.CONF

CONF.register_opts(xvp_proxy_opts)

**** CubicPower OpenStack Study ****

class XCPVNCProxy(object):

"""Class to use the xvp auth protocol to proxy instance vnc consoles."""

**** CubicPower OpenStack Study ****

    def one_way_proxy(self, source, dest):

        """Proxy tcp connection from source to dest."""

        while True:

            try:

                d = source.recv(32384)

            except Exception:

                d = None

            # If recv fails, send a write shutdown the other direction

            if d is None or len(d) == 0:

                dest.shutdown(socket.SHUT_WR)

                break

            # If send fails, terminate proxy in both directions

            try:

                # sendall raises an exception on write error, unlike send

                dest.sendall(d)

            except Exception:

                source.close()

                dest.close()

                break

**** CubicPower OpenStack Study ****

    def handshake(self, req, connect_info, sockets):

        """Execute hypervisor-specific vnc auth handshaking (if needed)."""

        host = connect_info['host']

        port = int(connect_info['port'])

        server = eventlet.connect((host, port))

        # Handshake as necessary

        if connect_info.get('internal_access_path'):

            server.sendall("CONNECT %s HTTP/1.1\r\n\r\n" %

                        connect_info['internal_access_path'])

            data = ""

            while True:

                b = server.recv(1)

                if b:

                    data += b

                    if data.find("\r\n\r\n") != -1:

                        if not data.split("\r\n")[0].find("200"):

                            LOG.audit(_("Error in handshake: %s"), data)

                            return

                        break

                if not b or len(data) > 4096:

                    LOG.audit(_("Error in handshake: %s"), data)

                    return

        client = req.environ['eventlet.input'].get_socket()

        client.sendall("HTTP/1.1 200 OK\r\n\r\n")

        sockets['client'] = client

        sockets['server'] = server

**** CubicPower OpenStack Study ****

    def proxy_connection(self, req, connect_info, start_response):

        """Spawn bi-directional vnc proxy."""

        sockets = {}

        t0 = eventlet.spawn(self.handshake, req, connect_info, sockets)

        t0.wait()

        if not sockets.get('client') or not sockets.get('server'):

            LOG.audit(_("Invalid request: %s"), req)

            start_response('400 Invalid Request',

                           [('content-type', 'text/html')])

            return "Invalid Request"

        client = sockets['client']

        server = sockets['server']

        t1 = eventlet.spawn(self.one_way_proxy, client, server)

        t2 = eventlet.spawn(self.one_way_proxy, server, client)

        t1.wait()

        t2.wait()

        # Make sure our sockets are closed

        server.close()

        client.close()

**** CubicPower OpenStack Study ****

    def __call__(self, environ, start_response):

        try:

            req = webob.Request(environ)

            LOG.audit(_("Request: %s"), req)

            token = req.params.get('token')

            if not token:

                LOG.audit(_("Request made with missing token: %s"), req)

                start_response('400 Invalid Request',

                               [('content-type', 'text/html')])

                return "Invalid Request"

            ctxt = context.get_admin_context()

            api = consoleauth_rpcapi.ConsoleAuthAPI()

            connect_info = api.check_token(ctxt, token)

            if not connect_info:

                LOG.audit(_("Request made with invalid token: %s"), req)

                start_response('401 Not Authorized',

                               [('content-type', 'text/html')])

                return "Not Authorized"

            return self.proxy_connection(req, connect_info, start_response)

        except Exception as e:

            LOG.audit(_("Unexpected error: %s"), e)

**** CubicPower OpenStack Study ****

class SafeHttpProtocol(eventlet.wsgi.HttpProtocol):

"""HttpProtocol wrapper to suppress IOErrors.

The proxy code above always shuts down client connections, so we catch

the IOError that raises when the SocketServer tries to flush the

connection.

"""

**** CubicPower OpenStack Study ****

    def finish(self):

        try:

            eventlet.green.BaseHTTPServer.BaseHTTPRequestHandler.finish(self)

        except IOError:

            pass

        eventlet.greenio.shutdown_safe(self.connection)

        self.connection.close()

def get_wsgi_server():

    LOG.audit(_("Starting nova-xvpvncproxy node (version %s)"),

              version.version_string_with_package())

    return wsgi.Server("XCP VNC Proxy",

                       XCPVNCProxy(),

                       protocol=SafeHttpProtocol,

                       host=CONF.xvpvncproxy_host,

                       port=CONF.xvpvncproxy_port)

**** CubicPower OpenStack Study ****

def get_wsgi_server():

    LOG.audit(_("Starting nova-xvpvncproxy node (version %s)"),

              version.version_string_with_package())

    return wsgi.Server("XCP VNC Proxy",

                       XCPVNCProxy(),

                       protocol=SafeHttpProtocol,

                       host=CONF.xvpvncproxy_host,

                       port=CONF.xvpvncproxy_port)