OpenSecurity/bin/opensecurityd.pyw
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
Added WPAD proxy support.
Not fully tested
mb@63
     1
#!/bin/env python
mb@63
     2
# -*- coding: utf-8 -*-
mb@63
     3
mb@63
     4
# ------------------------------------------------------------
mb@63
     5
# opensecurityd
BarthaM@212
     6
#   
mb@63
     7
# the opensecurityd as RESTful server
mb@63
     8
#
mb@63
     9
# Autor: Oliver Maurhart, <oliver.maurhart@ait.ac.at>
BarthaM@212
    10
#        Mihai Bartha, <mihai.bartha@ait.ac.at>       
mb@63
    11
#
mb@63
    12
# Copyright (C) 2013 AIT Austrian Institute of Technology
mb@63
    13
# AIT Austrian Institute of Technology GmbH
mb@63
    14
# Donau-City-Strasse 1 | 1220 Vienna | Austria
mb@63
    15
# http://www.ait.ac.at
mb@63
    16
#
mb@63
    17
# This program is free software; you can redistribute it and/or
mb@63
    18
# modify it under the terms of the GNU General Public License
mb@63
    19
# as published by the Free Software Foundation version 2.
mb@63
    20
# 
mb@63
    21
# This program is distributed in the hope that it will be useful,
mb@63
    22
# but WITHOUT ANY WARRANTY; without even the implied warranty of
mb@63
    23
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
mb@63
    24
# GNU General Public License for more details.
mb@63
    25
# 
mb@63
    26
# You should have received a copy of the GNU General Public License
mb@63
    27
# along with this program; if not, write to the Free Software
mb@63
    28
# Foundation, Inc., 51 Franklin Street, Fifth Floor, 
mb@63
    29
# Boston, MA  02110-1301, USA.
mb@63
    30
# ------------------------------------------------------------
mb@63
    31
mb@63
    32
mb@63
    33
# ------------------------------------------------------------
mb@63
    34
# imports
mb@63
    35
oliver@130
    36
import json
BarthaM@223
    37
#import os
mb@63
    38
import os.path
BarthaM@223
    39
#import subprocess
mb@63
    40
import sys
oliver@91
    41
import tempfile
mb@63
    42
import web
mb@63
    43
oliver@87
    44
import vmmanager
mb@63
    45
mb@63
    46
# local
oliver@144
    47
import __init__ as opensecurity
oliver@91
    48
from cygwin import Cygwin
oliver@147
    49
from environment import Environment
oliver@193
    50
from opensecurity_util import logger, showTrayMessage
oliver@193
    51
mb@63
    52
mb@63
    53
mb@63
    54
# ------------------------------------------------------------
mb@63
    55
# const
mb@63
    56
mb@63
    57
"""All the URLs we know mapping to class handler"""
mb@63
    58
opensecurity_urls = (
mb@63
    59
    '/browsing',                        'os_browsing',          # http://localhost:8080/browsing                                GET
oliver@91
    60
    '/fetch_initial_image',             'os_fetch_image',       # http://localhost:8080/fetch_initial_image                     GET
oliver@91
    61
    '/init',                            'os_init',              # http://localhost:8080/init                                    GET
oliver@107
    62
    '/initial_image',                   'os_initial_image',     # http://localhost:8080/initial_image                           GET
mb@63
    63
    '/sdvms',                           'os_sdvms',             # http://localhost:8080/sdvms                                   GET, PUT
mb@63
    64
    '/sdvms/(.*)/application/(.*)',     'os_sdvm_application',  # http://localhost:8080/sdvms/[VMNAME]/application/[COMMAND]    GET
mb@63
    65
    '/sdvms/(.*)/ip',                   'os_sdvm_ip',           # http://localhost:8080/sdvms/[VMNAME]/ip                       GET
mb@63
    66
    '/sdvms/(.*)/start',                'os_sdvm_start',        # http://localhost:8080/sdvms/[VMNAME]/start                    GET
mb@63
    67
    '/sdvms/(.*)/stop',                 'os_sdvm_stop',         # http://localhost:8080/sdvms/[VMNAME]/stop                     GET
mb@63
    68
    '/sdvms/(.*)',                      'os_sdvm',              # http://localhost:8080/sdvms/[VMNAME]                          GET, DELETE
oliver@93
    69
    '/setup',                           'os_setup',             # http://localhost:8080/setup                                   GET
mb@63
    70
    '/vms',                             'os_vms',               # http://localhost:8080/vms                                     GET
mb@63
    71
    '/vms/(.*)',                        'os_vm',                # http://localhost:8080/vms/[VMNAME]                            GET
oliver@87
    72
    '/update_template',                 'os_update_template',   # http://localhost:8080/update_template                         GET
oliver@87
    73
    '/terminate',                       'os_terminate',         # http://localhost:8080/terminate                               GET
BarthaM@212
    74
    '/initialize',                      'os_initialize',        # http://localhost:8080/initialize                               GET
oliver@87
    75
    '/',                                'os_root'               # http://localhost:8080/                                        GET
mb@63
    76
)
mb@63
    77
oliver@87
    78
mb@66
    79
# ------------------------------------------------------------
mb@63
    80
# vars
mb@63
    81
mb@63
    82
# Global VMManager instance
oliver@86
    83
gvm_mgr = None
oliver@86
    84
oliver@138
    85
# server instance
oliver@138
    86
server = None
oliver@138
    87
oliver@138
    88
mb@63
    89
# ------------------------------------------------------------
mb@63
    90
# code
mb@63
    91
mb@63
    92
mb@63
    93
class os_browsing:
mb@63
    94
    """OpenSecurity '/browsing' handler
mb@63
    95
    
mb@63
    96
    - GET: Start and prepare a new SecurityVM for Internet Browsing. Return the name of the VM.
mb@63
    97
    """
mb@63
    98
    
mb@63
    99
    def GET(self):
BarthaM@213
   100
        args = web.input()
oliver@74
   101
        log_call(web.ctx.environ)
oliver@87
   102
        global gvm_mgr
mb@63
   103
        try:
BarthaM@213
   104
            proxy = None
BarthaM@223
   105
            wpad = None
BarthaM@213
   106
            if 'ProxyServer' in args:
BarthaM@213
   107
                proxy = args['ProxyServer']
BarthaM@223
   108
            if 'ProxyAutoConfigURL' in args:
BarthaM@223
   109
                wpad = args['ProxyAutoConfigURL']
BarthaM@223
   110
            result = gvm_mgr.handleBrowsingRequest(proxy, wpad)
mb@90
   111
            return result
mb@63
   112
        except:
mb@63
   113
            raise web.internalerror()
mb@63
   114
oliver@87
   115
       
oliver@91
   116
class os_fetch_image:
oliver@91
   117
    """OpenSecurity '/fetch_initial_image' handler
oliver@91
   118
    
oliver@91
   119
    - GET: fetch the initial image from the X-Net Servers
oliver@91
   120
            The initial image is stored in the
oliver@91
   121
            Virtual Box default machine path.
oliver@91
   122
            The result to this call is a temprary file
oliver@91
   123
            which shows the progress (or error state)
oliver@91
   124
            of this call.
oliver@91
   125
    """
oliver@91
   126
    
oliver@91
   127
    def GET(self):
oliver@91
   128
        
oliver@91
   129
        log_call(web.ctx.environ)
oliver@91
   130
        global gvm_mgr
oliver@91
   131
oliver@147
   132
        trace_file_name = os.path.join(Environment('OpenSecurity').log_path, 'OpenSecurity_fetch_image.log')
oliver@91
   133
        trace_file = open(trace_file_name, 'w+')
oliver@91
   134
oliver@91
   135
        machine_folder = Cygwin.cygPath(gvm_mgr.getMachineFolder()) 
oliver@164
   136
        download_initial_image_script = Cygwin.cygPath(os.path.abspath(os.path.join(os.path.split(__file__)[0], 'download_initial_image.sh')))
BarthaM@170
   137
        Cygwin.bashExecute('\\"' + download_initial_image_script + '\\" \'' + machine_folder + '\'', wait_return = False, stdout = trace_file, stderr = trace_file) 
oliver@91
   138
oliver@116
   139
        res = '{ "fetch_log": "' + trace_file_name.replace('\\', '\\\\') + '" }'
oliver@115
   140
        return res
oliver@91
   141
oliver@147
   142
oliver@91
   143
class os_init:
oliver@91
   144
    """OpenSecurity '/init' handler
oliver@91
   145
    
oliver@91
   146
    - GET: Do initial import of OsecVM.ova
oliver@91
   147
    """
oliver@91
   148
    
oliver@91
   149
    def GET(self):
BarthaM@221
   150
        global gvm_mgr
oliver@91
   151
        log_call(web.ctx.environ)
oliver@91
   152
BarthaM@221
   153
        gvm_mgr.startInitialImport()
BarthaM@221
   154
        res = '{ "init_log": "' + (Environment('OpenSecurity').log_path+'\\OpenSecurity_initial_import.log').replace('\\', '\\\\') + '" }'
oliver@115
   155
        return res
oliver@91
   156
BarthaM@221
   157
class os_update_template:
BarthaM@221
   158
    """OpenSecurity '/update_template' handler
BarthaM@221
   159
    
BarthaM@221
   160
    - GET: update template vm
BarthaM@221
   161
    """
BarthaM@221
   162
    
BarthaM@221
   163
    def GET(self):
BarthaM@221
   164
        global gvm_mgr
BarthaM@221
   165
        log_call(web.ctx.environ)
oliver@91
   166
BarthaM@221
   167
        gvm_mgr.startUpdateTemplate()
BarthaM@221
   168
        res = '{ "init_log": "' + (Environment('OpenSecurity').log_path+'\\OpenSecurity_initial_import.log').replace('\\', '\\\\') + '" }'
BarthaM@221
   169
        return res
BarthaM@221
   170
    
oliver@107
   171
class os_initial_image:
oliver@107
   172
    """OpenSecurity '/initial_image' handler
oliver@107
   173
    
oliver@107
   174
    - GET: Return what we have as initial image.
oliver@107
   175
    """
oliver@107
   176
    
oliver@107
   177
    def GET(self):
oliver@107
   178
        log_call(web.ctx.environ)
oliver@107
   179
        global gvm_mgr
oliver@107
   180
        t = os.path.join(gvm_mgr.systemProperties['Default machine folder'], 'OsecVM.ova')
oliver@107
   181
        res = ''
oliver@107
   182
        if os.path.isfile(t):
oliver@107
   183
            res = '{"initial_template": { '
oliver@107
   184
            res += '"name": "OsecVM.ova", '
oliver@107
   185
            res += '"path": "' + t.replace('\\', '\\\\') + '", '
oliver@107
   186
            res += '"size": ' + str(os.path.getsize(t)) + ', ' 
oliver@107
   187
            res += '"date": ' + str(os.path.getmtime(t)) + ''
oliver@112
   188
            res += '}}'
oliver@107
   189
        return res
BarthaM@221
   190
    
oliver@87
   191
class os_root:
oliver@87
   192
    """OpenSecurity '/' handler
oliver@87
   193
    
oliver@87
   194
    - GET: give information about current installation.
oliver@87
   195
    """
oliver@87
   196
    
oliver@87
   197
    def GET(self):
oliver@87
   198
        log_call(web.ctx.environ)
oliver@87
   199
        global gvm_mgr
oliver@130
   200
oliver@130
   201
        # create a json string and pretty print it
oliver@107
   202
        res = '{"os_server": { '
oliver@144
   203
        res += '"version": "' + opensecurity.__version__ + '" '
oliver@130
   204
        res += ', "virtual box systemproperties": ' + str(gvm_mgr.systemProperties).replace("'", '"') 
oliver@130
   205
        res += ', "current temporary folder": "' + tempfile.gettempdir().replace('\\', '\\\\') + '"'
oliver@147
   206
        res += ', "current log folder": "' + Environment('OpenSecurity').log_path.replace('\\', '\\\\') + '"'
oliver@130
   207
oliver@130
   208
        try:
oliver@130
   209
            res += ', "whoami": "' + Cygwin.bashExecute('whoami')[1].strip() + '"'
oliver@130
   210
        except:
oliver@130
   211
            res += ', "whoami": "FAILED"'
oliver@130
   212
oliver@130
   213
        try:
oliver@130
   214
            res += ', "mount": ' + str(Cygwin.bashExecute('mount')[1].split('\n')[:-1]).replace("'", '"')
oliver@130
   215
        except:
oliver@130
   216
            res += ', "mount": "FAILED"'
oliver@130
   217
oliver@130
   218
        try:
oliver@130
   219
            res += ', "cygpath --windows ~": "' + Cygwin.bashExecute('cygpath --windows ~')[1].strip().replace('\\', '\\\\') + '"'
oliver@130
   220
        except:
oliver@130
   221
            res += ', "cygpath --windows ~": "FAILED"'
oliver@130
   222
oliver@131
   223
oliver@131
   224
        res += ', "status message": "' + gvm_mgr.status_message.replace('"', "'") + '"'
oliver@131
   225
oliver@107
   226
        res += '}}'
oliver@130
   227
oliver@130
   228
        # loading it into json and print it again ensures
oliver@130
   229
        # we really do have a valid RFC conform json string
oliver@130
   230
        # created (as long as the python json module is RFC conform)
oliver@130
   231
        return json.dumps(json.loads(res), indent = 4)
oliver@87
   232
oliver@87
   233
oliver@204
   234
mb@63
   235
class os_sdvm:
mb@63
   236
    """OpenSecurity '/sdvms/[VM]' handler
mb@63
   237
    
mb@63
   238
    - GET: Information about a specific SecurityVM
mb@63
   239
    - DELETE: Remove a specific
mb@63
   240
    """
mb@63
   241
    
mb@63
   242
    def GET(self, name):
oliver@74
   243
        log_call(web.ctx.environ)
oliver@87
   244
        global gvm_mgr
oliver@203
   245
        return json.dumps(gvm_mgr.getVMInfo(name), indent = 4)
mb@63
   246
mb@63
   247
    def DELETE(self, name):
oliver@74
   248
        log_call(web.ctx.environ)
oliver@87
   249
        global gvm_mgr
oliver@87
   250
        return gvm_mgr.removeVM(name)
mb@63
   251
            
mb@63
   252
mb@63
   253
class os_sdvm_application:
mb@63
   254
    """OpenSecurity '/sdvms/[VM]/application/[CMD]' handler
mb@63
   255
    
mb@63
   256
    - GET: start application with given command in the VM.
mb@63
   257
    """
mb@63
   258
    
mb@63
   259
    def GET(self, name, command):
oliver@74
   260
        log_call(web.ctx.environ)
oliver@87
   261
        global gvm_mgr
mb@63
   262
        command = '/' + command
oliver@193
   263
        showTrayMessage('Launching application in isolated VM...', 7000)
BarthaM@223
   264
        Cygwin.sshExecuteX11(command, gvm_mgr.getHostOnlyIP(name), 'osecuser', Cygwin.cygPath(gvm_mgr.getMachineFolder()) + '/' + name + '/dvm_key'  )
oliver@165
   265
        return 'Command ' + str(command) + ' started on VM "' + name + '" with IP ' + gvm_mgr.getHostOnlyIP(name)
mb@63
   266
    
mb@63
   267
mb@63
   268
class os_sdvm_ip:
mb@63
   269
    """OpenSecurity '/sdvms/[VM]/ip' handler
mb@63
   270
    
mb@63
   271
    - GET: give IP of SecurityVM.
mb@63
   272
    """
mb@63
   273
    
mb@63
   274
    def GET(self, name):
oliver@74
   275
        log_call(web.ctx.environ)
oliver@87
   276
        global gvm_mgr
oliver@87
   277
        return gvm_mgr.getHostOnlyIP(name)
mb@63
   278
            
mb@63
   279
mb@63
   280
class os_sdvm_start:
mb@63
   281
    """OpenSecurity '/sdvms/[VM]/start' handler
mb@63
   282
    
mb@63
   283
    - GET: Start specific SecuirtyVM.
mb@63
   284
    """
mb@63
   285
    
mb@63
   286
    def GET(self, name):
oliver@74
   287
        log_call(web.ctx.environ)
oliver@87
   288
        global gvm_mgr
oliver@87
   289
        return gvm_mgr.startVM(name)
mb@63
   290
            
mb@63
   291
mb@63
   292
class os_sdvm_stop:
mb@63
   293
    """OpenSecurity '/sdvms/[VM]/stop' handler
mb@63
   294
    
mb@63
   295
    - GET: stop specific Secuirty VM.
mb@63
   296
    """
mb@63
   297
    
mb@63
   298
    def GET(self, name):
oliver@74
   299
        log_call(web.ctx.environ)
oliver@87
   300
        global gvm_mgr
oliver@87
   301
        return gvm_mgr.stopVM(name)
mb@63
   302
            
mb@63
   303
mb@63
   304
class os_sdvms:
mb@63
   305
    """OpenSecurity '/sdvms' handler
mb@63
   306
    
mb@63
   307
    - GET: list all available secuirty VMs.
mb@63
   308
    - POST: create new security vm.
mb@63
   309
    """
mb@63
   310
    
mb@63
   311
    def GET(self):
mb@63
   312
        """get the list of SDVMs"""
oliver@74
   313
        log_call(web.ctx.environ)
oliver@87
   314
        global gvm_mgr
oliver@204
   315
oliver@204
   316
        d = {}
oliver@204
   317
        for sdvm in gvm_mgr.listSDVM():
oliver@204
   318
            d[sdvm] = gvm_mgr.getHostOnlyIP(sdvm)
oliver@204
   319
oliver@204
   320
        return json.dumps(d, indent = 4)
mb@63
   321
            
mb@63
   322
    def POST(self):
mb@63
   323
        """create a new SDVM"""
oliver@74
   324
        log_call(web.ctx.environ)
oliver@87
   325
        global gvm_mgr
oliver@74
   326
        
mb@63
   327
        # get a new vm-name
oliver@87
   328
        name = gvm_mgr.generateSDVMName()
mb@63
   329
        try:
oliver@87
   330
            gvm_mgr.createVM(name)
mb@63
   331
        except:
mb@63
   332
            raise web.internalerror()
mb@63
   333
            
mb@63
   334
        return name
mb@63
   335
            
oliver@87
   336
oliver@93
   337
class os_setup:
oliver@93
   338
    """OpenSecurity '/setup' handler
oliver@93
   339
    
BarthaM@172
   340
    - GET: Give user some info how to setup the OpenSecurity environment
oliver@93
   341
    """
oliver@93
   342
    
oliver@93
   343
    def GET(self):
oliver@93
   344
oliver@93
   345
        log_call(web.ctx.environ)
oliver@93
   346
oliver@93
   347
        page = """
oliver@93
   348
        <html>
oliver@93
   349
        <body>
oliver@93
   350
        <h1>Setup OpenSecurity</h1>
oliver@93
   351
        In order to setup OpenSecurity an inital VM image has to be downloaded and imported:<br/>
oliver@93
   352
        <ul>
oliver@93
   353
            <li>Download initial VM image: <a href="/fetch_initial_image">fetch_initial_image</a>
oliver@93
   354
            <li>Import initial VM: <a href="/init">init</a>
oliver@93
   355
        </ul>
oliver@93
   356
        </body>
oliver@93
   357
        </html>
oliver@93
   358
        """
oliver@93
   359
        return page
oliver@93
   360
oliver@93
   361
oliver@87
   362
class os_terminate:
oliver@87
   363
    """OpenSecurity '/terminate' handler
oliver@87
   364
    
oliver@87
   365
    - GET: terminate the opensecurityd.
oliver@87
   366
oliver@87
   367
    TODO: need to find a better way doing this, and not via the
oliver@87
   368
          REST api. Maybe hack web.py server code?
oliver@87
   369
    """
oliver@87
   370
    
oliver@87
   371
    def GET(self):
oliver@87
   372
        log_call(web.ctx.environ)
oliver@139
   373
        global gvm_mgr
BarthaM@170
   374
        gvm_mgr.stop()
oliver@139
   375
        gvm_mgr.cleanup()
oliver@138
   376
        global server
oliver@138
   377
        server.stop()
oliver@87
   378
        return None
oliver@87
   379
BarthaM@212
   380
class os_initialize:
BarthaM@212
   381
    """OpenSecurity '/initialize' handler
BarthaM@212
   382
    
BarthaM@212
   383
    - GET: initialize / starts the vmmanager.
BarthaM@212
   384
BarthaM@212
   385
    """
BarthaM@212
   386
    
BarthaM@212
   387
    def GET(self):
BarthaM@212
   388
        log_call(web.ctx.environ)
BarthaM@212
   389
        global gvm_mgr
BarthaM@212
   390
        gvm_mgr.cleanup()
BarthaM@212
   391
        gvm_mgr.start()
BarthaM@221
   392
        #global server
BarthaM@221
   393
        #server.run()
BarthaM@212
   394
        return None
oliver@87
   395
mb@63
   396
class os_vm:
mb@63
   397
    """OpenSecurity '/vms/[VM]' handler
mb@63
   398
    
mb@63
   399
    - GET: list information of arbitrary VM.
mb@63
   400
    """
mb@63
   401
    
mb@63
   402
    def GET(self, name):
oliver@74
   403
        log_call(web.ctx.environ)
oliver@87
   404
        global gvm_mgr
oliver@87
   405
        return gvm_mgr.getVMInfo(name)
mb@63
   406
            
mb@63
   407
mb@63
   408
class os_vms:
mb@63
   409
    """OpenSecurity '/vms' handler
mb@63
   410
    
mb@63
   411
    - GET: list all (also non Security) VMs.
mb@63
   412
    """
mb@63
   413
    
mb@63
   414
    def GET(self):
oliver@74
   415
        log_call(web.ctx.environ)
oliver@87
   416
        global gvm_mgr
oliver@112
   417
        return str(gvm_mgr.listVM()).replace("'",'"')
mb@63
   418
            
mb@63
   419
oliver@74
   420
def log_call(web_environ):
oliver@74
   421
    """log the incoming call to the REST api"""
oliver@74
   422
    try:
oliver@74
   423
        call = 'REST ' +  web_environ['REQUEST_METHOD'] + ' ' + web_environ['REQUEST_URI'] + ' from ' + web_environ['REMOTE_ADDR'] + ':' + web_environ['REMOTE_PORT']
oliver@74
   424
        logger.debug(call)
oliver@74
   425
    except:
oliver@74
   426
        pass
oliver@74
   427
oliver@86
   428
oliver@86
   429
def main():
oliver@86
   430
    """main startup for the opensecuirityd"""
oliver@87
   431
oliver@139
   432
    global gvm_mgr
oliver@139
   433
    global server
oliver@139
   434
oliver@87
   435
    logger.debug('Starting OpenSecurity REST server')
oliver@87
   436
oliver@87
   437
    # ensure a VMManger is yet loaded
oliver@87
   438
    gvm_mgr = vmmanager.VMManager.getInstance()
BarthaM@212
   439
    gvm_mgr.start()
oliver@98
   440
    # tweak sys.argv to control wep.py server start behavior
oliver@98
   441
    sys.argv = [__file__, "8080"]
oliver@87
   442
    server = web.application(opensecurity_urls, globals(), autoreload = False)
mb@63
   443
    server.run()
oliver@87
   444
    
oliver@87
   445
    logger.debug('Stopped OpenSecurity REST server')
oliver@86
   446
oliver@86
   447
oliver@88
   448
def stop():
oliver@88
   449
    """stop the opensecuirityd"""
oliver@88
   450
oliver@88
   451
    # calling sys.exit() raises a SystemExit exception
oliver@88
   452
    # of the WSGI Server to let it wind down
oliver@89
   453
    # gracefully
oliver@88
   454
    sys.exit(0)
oliver@88
   455
oliver@86
   456
# start
oliver@86
   457
if __name__ == "__main__":
oliver@86
   458
    main()
BarthaM@170
   459
    sys.exit(0)
oliver@86
   460