opensecurity: OpenSecurity/bin/opensecurityd.pyw@a4fb6694e6fe

     1 #!/bin/env python

     2 # -*- coding: utf-8 -*-

     4 # ------------------------------------------------------------

     5 # opensecurityd

6 #

     7 # the opensecurityd as RESTful server

8 #

     9 # Autor: Oliver Maurhart, <oliver.maurhart@ait.ac.at>

    10 #        Mihai Bartha, <mihai.bartha@ait.ac.at>

    11 #

    12 # Copyright (C) 2013 AIT Austrian Institute of Technology

    13 # AIT Austrian Institute of Technology GmbH

    14 # Donau-City-Strasse 1 | 1220 Vienna | Austria

    15 # http://www.ait.ac.at

    16 #

    17 # This program is free software; you can redistribute it and/or

    18 # modify it under the terms of the GNU General Public License

    19 # as published by the Free Software Foundation version 2.

    20 #

    21 # This program is distributed in the hope that it will be useful,

    22 # but WITHOUT ANY WARRANTY; without even the implied warranty of

    23 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    24 # GNU General Public License for more details.

    25 #

    26 # You should have received a copy of the GNU General Public License

    27 # along with this program; if not, write to the Free Software

    28 # Foundation, Inc., 51 Franklin Street, Fifth Floor,

    29 # Boston, MA  02110-1301, USA.

    30 # ------------------------------------------------------------

    33 # ------------------------------------------------------------

    34 # imports

    36 import json

    37 #import os

    38 import os.path

    39 #import subprocess

    40 import sys

    41 import tempfile

    42 import web

    44 import vmmanager

    46 # local

    47 import __init__ as opensecurity

    48 from cygwin import Cygwin

    49 from environment import Environment

    50 from opensecurity_util import logger, showTrayMessage

    54 # ------------------------------------------------------------

    55 # const

    57 """All the URLs we know mapping to class handler"""

    58 opensecurity_urls = (

    59     '/browsing',                        'os_browsing',          # http://localhost:8080/browsing                                GET

    60     '/fetch_initial_image',             'os_fetch_image',       # http://localhost:8080/fetch_initial_image                     GET

    61     '/init',                            'os_init',              # http://localhost:8080/init                                    GET

    62     '/initial_image',                   'os_initial_image',     # http://localhost:8080/initial_image                           GET

    63     '/sdvms',                           'os_sdvms',             # http://localhost:8080/sdvms                                   GET, PUT

    64     '/sdvms/(.*)/application/(.*)',     'os_sdvm_application',  # http://localhost:8080/sdvms/[VMNAME]/application/[COMMAND]    GET

    65     '/sdvms/(.*)/ip',                   'os_sdvm_ip',           # http://localhost:8080/sdvms/[VMNAME]/ip                       GET

    66     '/sdvms/(.*)/start',                'os_sdvm_start',        # http://localhost:8080/sdvms/[VMNAME]/start                    GET

    67     '/sdvms/(.*)/stop',                 'os_sdvm_stop',         # http://localhost:8080/sdvms/[VMNAME]/stop                     GET

    68     '/sdvms/(.*)',                      'os_sdvm',              # http://localhost:8080/sdvms/[VMNAME]                          GET, DELETE

    69     '/setup',                           'os_setup',             # http://localhost:8080/setup                                   GET

    70     '/vms',                             'os_vms',               # http://localhost:8080/vms                                     GET

    71     '/vms/(.*)',                        'os_vm',                # http://localhost:8080/vms/[VMNAME]                            GET

    72     '/update_template',                 'os_update_template',   # http://localhost:8080/update_template                         GET

    73     '/terminate',                       'os_terminate',         # http://localhost:8080/terminate                               GET

    74     '/initialize',                      'os_initialize',        # http://localhost:8080/initialize                               GET

    75     '/',                                'os_root'               # http://localhost:8080/                                        GET

    76 )

    79 # ------------------------------------------------------------

    80 # vars

    82 # Global VMManager instance

    83 gvm_mgr = None

    85 # server instance

    86 server = None

    89 # ------------------------------------------------------------

    90 # code

    93 class os_browsing:

    94     """OpenSecurity '/browsing' handler

    96     - GET: Start and prepare a new SecurityVM for Internet Browsing. Return the name of the VM.

    97     """

    99     def GET(self):

   100         args = web.input()

   101         log_call(web.ctx.environ)

   102         global gvm_mgr

   103         try:

   104             proxy = None

   105             wpad = None

   106             if 'ProxyServer' in args:

   107                 proxy = args['ProxyServer']

   108             if 'ProxyAutoConfigURL' in args:

   109                 wpad = args['ProxyAutoConfigURL']

   110             result = gvm_mgr.handleBrowsingRequest(proxy, wpad)

   111             return result

   112         except:

   113             raise web.internalerror()

   116 class os_fetch_image:

   117     """OpenSecurity '/fetch_initial_image' handler

   119     - GET: fetch the initial image from the X-Net Servers

   120             The initial image is stored in the

   121             Virtual Box default machine path.

   122             The result to this call is a temprary file

   123             which shows the progress (or error state)

   124             of this call.

   125     """

   127     def GET(self):

   129         log_call(web.ctx.environ)

   130         global gvm_mgr

   132         trace_file_name = os.path.join(Environment('OpenSecurity').log_path, 'OpenSecurity_fetch_image.log')

   133         trace_file = open(trace_file_name, 'w+')

   135         machine_folder = Cygwin.cygPath(gvm_mgr.getMachineFolder())

   136         download_initial_image_script = Cygwin.cygPath(os.path.abspath(os.path.join(os.path.split(__file__)[0], 'download_initial_image.sh')))

   137         Cygwin.bashExecute('\\"' + download_initial_image_script + '\\" \'' + machine_folder + '\'', wait_return = False, stdout = trace_file, stderr = trace_file)

   139         res = '{ "fetch_log": "' + trace_file_name.replace('\\', '\\\\') + '" }'

   140         return res

   143 class os_init:

   144     """OpenSecurity '/init' handler

   146     - GET: Do initial import of OsecVM.ova

   147     """

   149     def GET(self):

   150         global gvm_mgr

   151         log_call(web.ctx.environ)

   153         gvm_mgr.startInitialImport()

   154         res = '{ "init_log": "' + (Environment('OpenSecurity').log_path+'\\OpenSecurity_initial_import.log').replace('\\', '\\\\') + '" }'

   155         return res

   157 class os_update_template:

   158     """OpenSecurity '/update_template' handler

   160     - GET: update template vm

   161     """

   163     def GET(self):

   164         global gvm_mgr

   165         log_call(web.ctx.environ)

   167         gvm_mgr.startUpdateTemplate()

   168         res = '{ "init_log": "' + (Environment('OpenSecurity').log_path+'\\OpenSecurity_initial_import.log').replace('\\', '\\\\') + '" }'

   169         return res

   171 class os_initial_image:

   172     """OpenSecurity '/initial_image' handler

   174     - GET: Return what we have as initial image.

   175     """

   177     def GET(self):

   178         log_call(web.ctx.environ)

   179         global gvm_mgr

   180         t = os.path.join(gvm_mgr.systemProperties['Default machine folder'], 'OsecVM.ova')

   181         res = ''

   182         if os.path.isfile(t):

   183             res = '{"initial_template": { '

   184             res += '"name": "OsecVM.ova", '

   185             res += '"path": "' + t.replace('\\', '\\\\') + '", '

   186             res += '"size": ' + str(os.path.getsize(t)) + ', '

   187             res += '"date": ' + str(os.path.getmtime(t)) + ''

   188             res += '}}'

   189         return res

   191 class os_root:

   192     """OpenSecurity '/' handler

   194     - GET: give information about current installation.

   195     """

   197     def GET(self):

   198         log_call(web.ctx.environ)

   199         global gvm_mgr

   201         # create a json string and pretty print it

   202         res = '{"os_server": { '

   203         res += '"version": "' + opensecurity.__version__ + '" '

   204         res += ', "virtual box systemproperties": ' + str(gvm_mgr.systemProperties).replace("'", '"')

   205         res += ', "current temporary folder": "' + tempfile.gettempdir().replace('\\', '\\\\') + '"'

   206         res += ', "current log folder": "' + Environment('OpenSecurity').log_path.replace('\\', '\\\\') + '"'

   208         try:

   209             res += ', "whoami": "' + Cygwin.bashExecute('whoami')[1].strip() + '"'

   210         except:

   211             res += ', "whoami": "FAILED"'

   213         try:

   214             res += ', "mount": ' + str(Cygwin.bashExecute('mount')[1].split('\n')[:-1]).replace("'", '"')

   215         except:

   216             res += ', "mount": "FAILED"'

   218         try:

   219             res += ', "cygpath --windows ~": "' + Cygwin.bashExecute('cygpath --windows ~')[1].strip().replace('\\', '\\\\') + '"'

   220         except:

   221             res += ', "cygpath --windows ~": "FAILED"'

   224         res += ', "status message": "' + gvm_mgr.status_message.replace('"', "'") + '"'

   226         res += '}}'

   228         # loading it into json and print it again ensures

   229         # we really do have a valid RFC conform json string

   230         # created (as long as the python json module is RFC conform)

   231         return json.dumps(json.loads(res), indent = 4)

   235 class os_sdvm:

   236     """OpenSecurity '/sdvms/[VM]' handler

   238     - GET: Information about a specific SecurityVM

   239     - DELETE: Remove a specific

   240     """

   242     def GET(self, name):

   243         log_call(web.ctx.environ)

   244         global gvm_mgr

   245         return json.dumps(gvm_mgr.getVMInfo(name), indent = 4)

   247     def DELETE(self, name):

   248         log_call(web.ctx.environ)

   249         global gvm_mgr

   250         return gvm_mgr.removeVM(name)

   253 class os_sdvm_application:

   254     """OpenSecurity '/sdvms/[VM]/application/[CMD]' handler

   256     - GET: start application with given command in the VM.

   257     """

   259     def GET(self, name, command):

   260         log_call(web.ctx.environ)

   261         global gvm_mgr

   262         command = '/' + command

   263         showTrayMessage('Launching application in isolated VM...', 7000)

   264         Cygwin.sshExecuteX11(command, gvm_mgr.getHostOnlyIP(name), 'osecuser', Cygwin.cygPath(gvm_mgr.getMachineFolder()) + '/' + name + '/dvm_key'  )

   265         return 'Command ' + str(command) + ' started on VM "' + name + '" with IP ' + gvm_mgr.getHostOnlyIP(name)

   268 class os_sdvm_ip:

   269     """OpenSecurity '/sdvms/[VM]/ip' handler

   271     - GET: give IP of SecurityVM.

   272     """

   274     def GET(self, name):

   275         log_call(web.ctx.environ)

   276         global gvm_mgr

   277         return gvm_mgr.getHostOnlyIP(name)

   280 class os_sdvm_start:

   281     """OpenSecurity '/sdvms/[VM]/start' handler

   283     - GET: Start specific SecuirtyVM.

   284     """

   286     def GET(self, name):

   287         log_call(web.ctx.environ)

   288         global gvm_mgr

   289         return gvm_mgr.startVM(name)

   292 class os_sdvm_stop:

   293     """OpenSecurity '/sdvms/[VM]/stop' handler

   295     - GET: stop specific Secuirty VM.

   296     """

   298     def GET(self, name):

   299         log_call(web.ctx.environ)

   300         global gvm_mgr

   301         return gvm_mgr.stopVM(name)

   304 class os_sdvms:

   305     """OpenSecurity '/sdvms' handler

   307     - GET: list all available secuirty VMs.

   308     - POST: create new security vm.

   309     """

   311     def GET(self):

   312         """get the list of SDVMs"""

   313         log_call(web.ctx.environ)

   314         global gvm_mgr

   316         d = {}

   317         for sdvm in gvm_mgr.listSDVM():

   318             d[sdvm] = gvm_mgr.getHostOnlyIP(sdvm)

   320         return json.dumps(d, indent = 4)

   322     def POST(self):

   323         """create a new SDVM"""

   324         log_call(web.ctx.environ)

   325         global gvm_mgr

   327         # get a new vm-name

   328         name = gvm_mgr.generateSDVMName()

   329         try:

   330             gvm_mgr.createVM(name)

   331         except:

   332             raise web.internalerror()

   334         return name

   337 class os_setup:

   338     """OpenSecurity '/setup' handler

   340     - GET: Give user some info how to setup the OpenSecurity environment

   341     """

   343     def GET(self):

   345         log_call(web.ctx.environ)

   347         page = """

   348         <html>

   349         <body>

   350         <h1>Setup OpenSecurity</h1>

   351         In order to setup OpenSecurity an inital VM image has to be downloaded and imported:<br/>

   352         <ul>

   353             <li>Download initial VM image: <a href="/fetch_initial_image">fetch_initial_image</a>

   354             <li>Import initial VM: <a href="/init">init</a>

   355         </ul>

   356         </body>

   357         </html>

   358         """

   359         return page

   362 class os_terminate:

   363     """OpenSecurity '/terminate' handler

   365     - GET: terminate the opensecurityd.

   367     TODO: need to find a better way doing this, and not via the

   368           REST api. Maybe hack web.py server code?

   369     """

   371     def GET(self):

   372         log_call(web.ctx.environ)

   373         global gvm_mgr

   374         gvm_mgr.stop()

   375         gvm_mgr.cleanup()

   376         global server

   377         server.stop()

   378         return None

   380 class os_initialize:

   381     """OpenSecurity '/initialize' handler

   383     - GET: initialize / starts the vmmanager.

   385     """

   387     def GET(self):

   388         log_call(web.ctx.environ)

   389         global gvm_mgr

   390         gvm_mgr.cleanup()

   391         gvm_mgr.start()

   392         #global server

   393         #server.run()

   394         return None

   396 class os_vm:

   397     """OpenSecurity '/vms/[VM]' handler

   399     - GET: list information of arbitrary VM.

   400     """

   402     def GET(self, name):

   403         log_call(web.ctx.environ)

   404         global gvm_mgr

   405         return gvm_mgr.getVMInfo(name)

   408 class os_vms:

   409     """OpenSecurity '/vms' handler

   411     - GET: list all (also non Security) VMs.

   412     """

   414     def GET(self):

   415         log_call(web.ctx.environ)

   416         global gvm_mgr

   417         return str(gvm_mgr.listVM()).replace("'",'"')

   420 def log_call(web_environ):

   421     """log the incoming call to the REST api"""

   422     try:

   423         call = 'REST ' +  web_environ['REQUEST_METHOD'] + ' ' + web_environ['REQUEST_URI'] + ' from ' + web_environ['REMOTE_ADDR'] + ':' + web_environ['REMOTE_PORT']

   424         logger.debug(call)

   425     except:

   426         pass

   429 def main():

   430     """main startup for the opensecuirityd"""

   432     global gvm_mgr

   433     global server

   435     logger.debug('Starting OpenSecurity REST server')

   437     # ensure a VMManger is yet loaded

   438     gvm_mgr = vmmanager.VMManager.getInstance()

   439     gvm_mgr.start()

   440     # tweak sys.argv to control wep.py server start behavior

   441     sys.argv = [__file__, "8080"]

   442     server = web.application(opensecurity_urls, globals(), autoreload = False)

   443     server.run()

   445     logger.debug('Stopped OpenSecurity REST server')

   448 def stop():

   449     """stop the opensecuirityd"""

   451     # calling sys.exit() raises a SystemExit exception

   452     # of the WSGI Server to let it wind down

   453     # gracefully

   454     sys.exit(0)

   456 # start

   457 if __name__ == "__main__":

   458     main()

   459     sys.exit(0)

author	BarthaM@N3SIM1218.D03.arc.local
	Wed, 24 Sep 2014 16:40:43 +0100
changeset 223	a4fb6694e6fe
parent 221	853af9cfab6a
child 240	d7ef04254e9c
permissions	-rwxr-xr-x