sshxmlrpc.py 16.2 KB
Newer Older
1 2 3 4 5
#
# EMULAB-COPYRIGHT
# Copyright (c) 2004 University of Utah and the Flux Group.
# All rights reserved.
#
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
# Permission to use, copy, modify and distribute this software is hereby
# granted provided that (1) source code retains these copyright, permission,
# and disclaimer notices, and (2) redistributions including binaries
# reproduce the notices in supporting documentation.
#
# THE UNIVERSITY OF UTAH ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
# CONDITION.  THE UNIVERSITY OF UTAH DISCLAIMS ANY LIABILITY OF ANY KIND
# FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
#
############################################################################
# Some bits of this file are from xmlrpclib.py, which is:
# --------------------------------------------------------------------
# Copyright (c) 1999-2002 by Secret Labs AB
# Copyright (c) 1999-2002 by Fredrik Lundh
#
# By obtaining, using, and/or copying this software and/or its
# associated documentation, you agree that you have read, understood,
# and will comply with the following terms and conditions:
#
# Permission to use, copy, modify, and distribute this software and
# its associated documentation for any purpose and without fee is
# hereby granted, provided that the above copyright notice appears in
# all copies, and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of
# Secret Labs AB or the author not be used in advertising or publicity
# pertaining to distribution of the software without specific, written
# prior permission.
#
# SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
# TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT-
# ABILITY AND FITNESS.  IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR
# BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
# DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
# WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
# ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
# OF THIS SOFTWARE.
# --------------------------------------------------------------------
#
44
import os
45 46 47 48
import sys
import types
import urllib
import popen2
49
import rfc822
50
import xmlrpclib
51 52 53 54
import syslog

# XXX This should come from configure.
LOG_TESTBED = syslog.LOG_LOCAL5;
55

56 57
import traceback

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
##
# Base class for exceptions in this module.
#
class SSHException(Exception):
    pass

##
# Indicates a poorly formatted response from the server.
#
class BadResponse(SSHException):

    ##
    # @param host The server host name.
    # @param handler The handler being accessed on the server.
    # @param arg Description of the problem.
    #
    def __init__(self, host, handler, msg):
        self.args = host, handler, msg,
        return
    
    pass

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
##
# Indicates a poorly formatted request from the client.
#
class BadRequest(SSHException):

    ##
    # @param host The client host name.
    # @param arg Description of the problem.
    #
    def __init__(self, host, msg):
        self.args = host, msg,
        return
    
    pass

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
##
# Class used to decode headers.
#
class SSHMessage(rfc822.Message):
    pass

##
# An SSH based connection class.
#
class SSHConnection:

    ##
    # @param host The peer host name.
    # @param handler The handler being accessed.
    # @param streams A pair containing the input and output files respectively.
    # If this value is not given, ssh will be used to connect to the host.
    # @param ssh_config The ssh config file to use when initiating a new
    # connection.
    # 
    def __init__(self, host, handler, streams=None, ssh_config=None):
        # Store information about the peer and
        self.handler = handler
        self.host = host

        # ... initialize the read and write file objects.
        if streams:
            self.myChild = None
            self.rfile = streams[0]
            self.wfile = streams[1]
            pass
        else:
126
            self.user, ssh_host = urllib.splituser(self.host)
127
            # print self.user + " " + self.host + " " + handler
128 129 130 131 132 133 134 135
            
            flags = ""
            if self.user:
                flags = flags + " -l " + self.user
                pass
            if ssh_config:
                flags = flags + " -F " + ssh_config
                pass
136
            self.myChild = popen2.Popen3("ssh -x -C -o 'CompressionLevel 5' "
137 138
                                         + flags
                                         + " "
139
                                         + ssh_host
140 141
                                         + " "
                                         + handler,
142
                                         0)
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
            self.rfile = self.myChild.fromchild
            self.wfile = self.myChild.tochild
            pass
        return

    ##
    # @param len The amount of data to read. (Default: 1024)
    # @return The amount of data read.
    #
    def read(self, len=1024):
        return self.rfile.read(len)

    ##
    # @return A line of data or None if there is no more input.
    #
    def readline(self):
        return self.rfile.readline()

    ##
    # @param stuff The data to send to the other side.
    # @return The amount of data written.
    #
    def write(self, stuff):
        return self.wfile.write(stuff)

    ##
    # Flush any write buffers.
    #
    def flush(self):
        self.wfile.flush()
        return

    ##
    # Close the connection.
    #
    def close(self):
        self.rfile.close()
        self.wfile.close()
        if self.myChild:
            self.myChild.wait()
            self.myChild = None
            pass
        return

    ##
    # Send an rfc822 style header to the other side.
    #
    # @param key The header key.
    # @param value The value paired with the given key.
    #
    def putheader(self, key, value):
        self.write("%s: %s\r\n" % (key, str(value)))
        return

    ##
    # Terminate the list of headers so the body can follow.
    #
    def endheaders(self):
        self.write("\r\n")
        self.flush()
        return

    def __repr__(self):
        return "<SSHConnection %s%s>" % (self.host, self.handler)

    __str__ = __repr__

    pass

212 213 214 215
##
# Use SSH to transport XML-RPC requests/responses
#
class SSHTransport:
216 217 218

    ##
    # @param ssh_config The ssh config file to use when making new connections.
219 220
    # @param user_agent Symbolic name for the program acting on behalf of the
    #   user.
221
    #
222
    def __init__(self, ssh_config=None, user_agent=None):
223 224
        self.connections = {}
        self.ssh_config = ssh_config
225
        self.user_agent = user_agent
226
        return
227 228 229 230 231
    
    ##
    # Send a request to the destination.
    #
    # @param host The host name on which to execute the request
232
    # @param handler The python file that will handle the request.
233 234 235 236
    # @param request_body The XML-RPC encoded request.
    # @param verbose unused.
    # @return The value returned 
    #
237
    def request(self, host, handler, request_body, verbose=0, path=None):
238
        # Strip the leading slash in the handler, if there is one.
239 240 241 242
        if path:
            handler = path + handler
            pass
        elif handler.startswith('/'):
243 244
            handler = handler[1:]
            pass
245

246 247
        # Try to get a new connection,
        if not self.connections.has_key((host,handler)):
248 249 250 251 252
            if verbose:
                sys.stderr.write("New connection for %s %s\n" %
                                 (host, handler))
                pass
            
253 254 255
            self.connections[(host,handler)] = SSHConnection(host, handler)
            pass
        connection = self.connections[(host,handler)]
256

257
        # ... send our request, and
258 259 260
        if self.user_agent:
            connection.putheader("user-agent", self.user_agent)
            pass
261
        connection.putheader("content-length", len(request_body))
262
        connection.putheader("content-type", "text/xml")
263 264 265
        connection.endheaders()
        connection.write(request_body)
        connection.flush()
266

267 268
        # ... parse the response.
        retval = self.parse_response(connection)
269 270 271 272 273 274 275 276 277

        return retval

    ##
    # @return A tuple containing the parser and unmarshaller, in that order
    #
    def getparser(self):
        return xmlrpclib.getparser()

278 279 280 281 282 283 284 285
    ##
    # @param connection The connection to drop.
    #
    def drop_connection(self, connection):
        del self.connections[(connection.host,connection.handler)]
        connection.close()
        return
    
286 287 288 289 290
    ##
    # Parse the response from the server.
    #
    # @return The python value returned by the server method.
    #
291
    def parse_response(self, connection):
292 293
        parser, unmarshaller = self.getparser()

294 295 296
        try:
            # Get the headers,
            headers = SSHMessage(connection, False)
297 298 299 300 301
            if headers.status != "":
                self.drop_connection(connection)
                raise BadResponse(connection.host,
                                  connection.handler,
                                  headers.status)
302 303 304 305
            # ... the length of the body, and
            length = int(headers['content-length'])
            # ... read in the body.
            response = connection.read(length)
306
            pass
307 308
        except KeyError, e:
            # Bad header, drop the connection, and
309
            self.drop_connection(connection)
310
            # ... tell the user.
311
            raise BadResponse(connection.host, connection.handler, e.args[0])
312 313
        
        parser.feed(response)
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332

        return unmarshaller.close()
    
    pass


##
# A wrapper for objects that should be exported via an XML-RPC interface.  Any
# method calls received via XML-RPC will automatically be translated into real
# python calls.
#
class SSHServerWrapper:

    ##
    # Initialize this object.
    #
    # @param object The object to wrap.
    #
    def __init__(self, object):
333
        self.ssh_connection = os.environ['SSH_CONNECTION'].split()
334
        self.myObject = object
335 336 337 338 339 340 341 342 343

        #
        # Init syslog
        #
        syslog.openlog("sshxmlrpc", syslog.LOG_PID, LOG_TESTBED);
        syslog.syslog(syslog.LOG_INFO,
                      "Connect by " + os.environ['USER'] + " from " +
                      self.ssh_connection[0]);
                      
344 345 346 347 348 349 350
        return

    ##
    # Handle a single request from a client.  The method will read the request
    # from the client, dispatch the method, and write the response back to the
    # client.
    #
351
    # @param connection An initialized SSHConnection object.
352
    #
353 354
    def handle_request(self, connection):
        retval = False
355 356
        try:
            # Read the request,
357
            hdrs = SSHMessage(connection, False)
358 359 360 361 362 363 364 365 366 367 368 369 370 371
            if hdrs.status != "":
                #sys.stderr.write("server error: Expecting rfc822 headers.\n");
                raise BadRequest(connection.host, hdrs.status)
            if not hdrs.has_key('content-length'):
                sys.stderr.write("server error: "
                                 + "expecting content-length header\n")
                raise BadRequest(connection.host,
                                 "missing content-length header")
            if hdrs.has_key('user-agent'):
                user_agent = hdrs['user-agent']
                pass
            else:
                user_agent = "unknown"
                pass
372 373
            length = int(hdrs['content-length'])
            params, method = xmlrpclib.loads(connection.read(length))
374 375 376 377 378
            syslog.syslog(syslog.LOG_INFO,
                          "Calling method '"
                          + method
                          + "'; user-agent="
                          + user_agent);
379 380 381 382 383 384 385 386 387 388 389 390 391 392
            try:
                # ... find the corresponding method in the wrapped object,
                meth = getattr(self.myObject, method)
                # ... dispatch the method, and
                if type(meth) == type(self.handle_request):
                    response = apply(meth, params) # It is really a method.
                    pass
                else:
                    response = str(meth) # Is is just a plain variable.
                    pass
                # ... ensure there was a valid response.
                if type(response) != type((  )):
                    response = (response,)
                    pass
393
                pass
394
            except:
395
                traceback.print_exc()
396 397 398 399
                # Some other exception happened, convert it to an XML-RPC fault
                response = xmlrpclib.dumps(
                    xmlrpclib.Fault(1,
                                    "%s:%s" % (sys.exc_type, sys.exc_value)))
400
                pass
401 402 403
            else:
                # Everything worked, encode the real response.
                response = xmlrpclib.dumps(response, methodresponse=1)
404 405 406 407 408
                pass
            pass
        except xmlrpclib.Fault, faultobj:
            # An XML-RPC related fault occurred, just encode the response.
            response = xmlrpclib.dumps(faultobj)
409
            retval = True
410 411 412 413 414
            pass
        except:
            # Some other exception happened, convert it to an XML-RPC fault.
            response = xmlrpclib.dumps(
                xmlrpclib.Fault(1, "%s:%s" % (sys.exc_type, sys.exc_value)))
415
            retval = True
416 417 418
            pass

        # Finally, send the reply to the client.
419 420 421 422
        connection.putheader("content-length", len(response))
        connection.endheaders()
        connection.write(response)
        connection.flush()
423

424
        return retval
425

426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
    ##
    # Handle all of the user requests.
    #
    # @param streams A pair containing the input and output streams.
    #
    def serve_forever(self, streams):
        # Make a new connection from the streams and handle requests until the
        # streams are closed or there is a protocol error.
        connection = SSHConnection(self.ssh_connection[0], '', streams=streams)
        try:
            done = False
            while not done:
                done = self.handle_request(connection)
                pass
            pass
        finally:
            connection.close()
443 444
            syslog.syslog(syslog.LOG_INFO, "Connection closed");
            syslog.closelog()
445 446 447
            pass
        return
    
448 449 450 451
    pass


##
452
# A client-side proxy for XML-RPC servers that are accessible via SSH.
453 454 455 456 457 458 459 460 461 462 463
#
class SSHServerProxy:

    ##
    # Initialize the object.
    #
    # @param uri The URI for the server.  Must start with 'ssh'.
    # @param transport A python object that implements the Transport interface.
    # The default is to use a new SSHTransport object.
    # @param encoding Content encoding.
    # @param verbose unused.
464 465
    # @param user_agent Symbolic name for the program acting on behalf of the
    #   user.
466
    #
467 468 469 470 471 472 473
    def __init__(self,
                 uri,
                 transport=None,
                 encoding=None,
                 verbose=0,
                 path=None,
                 user_agent=None):
474 475 476 477 478 479 480
        type, uri = urllib.splittype(uri)
        if type not in ("ssh", ):
            raise IOError, "unsupported XML-RPC protocol"

        self.__host, self.__handler = urllib.splithost(uri)

        if transport is None:
481
            transport = SSHTransport(user_agent=user_agent)
482 483 484 485 486 487
            pass
        
        self.__transport = transport

        self.__encoding = encoding
        self.__verbose = verbose
488
        self.__path = path
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
        return

    ##
    # Send a request to the server.
    #
    # @param methodname The name of the method.
    # @param params The parameters for the method.
    #
    def __request(self, methodname, params):
        # Convert the method name and parameters to a string,
        request = xmlrpclib.dumps(params, methodname, encoding=self.__encoding)

        # ... use the transport to send the request and receive the reply, and
        response = self.__transport.request(
            self.__host,
            self.__handler,
            request,
506 507
            verbose=self.__verbose,
            path=self.__path
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
            )

        # ... ensure there was a valid reply.
        if len(response) == 1:
            response = response[0]
            pass

        return response

    def __repr__(self):
        return (
            "<ServerProxy for %s%s>" %
            (self.__host, self.__handler)
            )

    __str__ = __repr__

    def __getattr__(self, name):
        # magic method dispatcher
        return xmlrpclib._Method(self.__request, name)
528

529
    pass