OpenSecurity/bin/vmmanager.pyw
author Oliver Maurhart <oliver.maurhart@ait.ac.at>
Fri, 25 Apr 2014 13:23:20 +0200
changeset 133 6649faffb63c
parent 131 8b4df474e577
child 135 c9499f5166c7
permissions -rwxr-xr-x
run download and import even as Non-Admin
mb@90
     1
'''
mb@90
     2
Created on Nov 19, 2013
mb@90
     3
mb@90
     4
@author: BarthaM
mb@90
     5
'''
mb@90
     6
import os
mb@90
     7
import os.path
mb@90
     8
from subprocess import Popen, PIPE, call, STARTUPINFO, _subprocess
mb@90
     9
import sys
mb@90
    10
import re
mb@90
    11
mb@90
    12
from cygwin import Cygwin
mb@90
    13
from environment import Environment
mb@90
    14
import threading
mb@90
    15
import time
mb@90
    16
import string
mb@90
    17
mb@90
    18
import shutil
mb@90
    19
import stat
mb@90
    20
import tempfile
mb@90
    21
from opensecurity_util import logger, setupLogger, OpenSecurityException
mb@90
    22
import ctypes
mb@90
    23
import itertools
mb@90
    24
import _winreg
mb@90
    25
DEBUG = True
mb@90
    26
mb@90
    27
class VMManagerException(Exception):
mb@90
    28
    def __init__(self, value):
mb@90
    29
        self.value = value
mb@90
    30
    def __str__(self):
mb@90
    31
        return repr(self.value)
mb@90
    32
mb@90
    33
class USBFilter:
mb@90
    34
    vendorid = ""
mb@90
    35
    productid = ""
mb@90
    36
    revision = ""
mb@90
    37
    
mb@90
    38
    def __init__(self, vendorid, productid, revision):
mb@90
    39
        self.vendorid = vendorid.lower()
mb@90
    40
        self.productid = productid.lower()
mb@90
    41
        self.revision = revision.lower()
mb@90
    42
        return
mb@90
    43
    
mb@90
    44
    def __eq__(self, other):
mb@90
    45
        return self.vendorid == other.vendorid and self.productid == other.productid and self.revision == other.revision
mb@90
    46
    
mb@90
    47
    def __hash__(self):
mb@90
    48
        return hash(self.vendorid) ^ hash(self.productid) ^ hash(self.revision)
mb@90
    49
    
mb@90
    50
    def __repr__(self):
mb@90
    51
        return "VendorId = \'" + str(self.vendorid) + "\' ProductId = \'" + str(self.productid) + "\' Revision = \'" + str(self.revision) + "\'"
mb@90
    52
    
mb@90
    53
    #def __getitem__(self, item):
mb@90
    54
    #    return self.coords[item]
mb@90
    55
 
mb@90
    56
class VMManager(object):
oliver@131
    57
mb@90
    58
    vmRootName = "SecurityDVM"
mb@90
    59
    systemProperties = None
mb@90
    60
    _instance = None
mb@90
    61
    machineFolder = ''
mb@90
    62
    rsdHandler = None
oliver@131
    63
    status_message = 'Starting up...'
oliver@131
    64
oliver@131
    65
 
oliver@131
    66
    def __init__(self):
oliver@131
    67
oliver@131
    68
        self.systemProperties = self.getSystemProperties()
oliver@133
    69
        self.machineFolder = self.systemProperties["Default machine folder"]
oliver@131
    70
oliver@131
    71
        # only proceed if we have a working background environment
oliver@131
    72
        if self.backend_ok():
oliver@131
    73
            self.cleanup()
oliver@131
    74
            self.rsdHandler = DeviceHandler(self)
oliver@131
    75
            self.rsdHandler.start()
oliver@131
    76
        else:
oliver@131
    77
            logger.critical(self.status_message)
mb@90
    78
    
oliver@131
    79
mb@90
    80
    @staticmethod
mb@90
    81
    def getInstance():
mb@90
    82
        if VMManager._instance == None:
mb@90
    83
            VMManager._instance = VMManager()
mb@90
    84
        return VMManager._instance
mb@90
    85
    
oliver@131
    86
oliver@131
    87
    def backend_ok(self):
oliver@131
    88
oliver@131
    89
        """check if the backend (VirtualBox) is sufficient for our task"""
oliver@131
    90
oliver@131
    91
        # ensure we have our system props
oliver@131
    92
        if self.systemProperties == None:
oliver@131
    93
            self.systemProperties = self.getSystemProperties()
oliver@131
    94
        if self.systemProperties == None:
oliver@131
    95
            self.status_message = 'Failed to get backend system properties. Is Backend (VirtualBox?) installed?'
oliver@131
    96
            return False
oliver@131
    97
oliver@131
    98
        # check for existing Extension pack
oliver@131
    99
        if not 'Remote desktop ExtPack' in self.systemProperties:
oliver@131
   100
            self.status_message = 'No remote desktop extension pack found. Please install the "Oracle VM VirtualBox Extension Pack" from https://www.virtualbox.org/wiki/Downloads.'
oliver@131
   101
            return False
oliver@131
   102
        if self.systemProperties['Remote desktop ExtPack'] == 'Oracle VM VirtualBox Extension Pack ':
oliver@131
   103
            self.status_message = 'Unsure if suitable extension pack is installed. Please install the "Oracle VM VirtualBox Extension Pack" from https://www.virtualbox.org/wiki/Downloads.'
oliver@131
   104
            return False
oliver@131
   105
oliver@131
   106
        # check if we do have our root VMs installed
oliver@131
   107
        vms = self.listVM()
oliver@131
   108
        if not self.vmRootName in vms:
oliver@131
   109
            self.status_message = 'Unable to locate root SecurityDVM. Please download and setup the initial image.'
oliver@131
   110
            return False
oliver@131
   111
oliver@131
   112
        # basically all seems nice and ready to rumble
oliver@131
   113
        self.status_message = 'All is ok.'
oliver@131
   114
oliver@131
   115
        return True
oliver@131
   116
oliver@131
   117
mb@90
   118
    def cleanup(self):
mb@90
   119
        if self.rsdHandler != None:
mb@90
   120
            self.rsdHandler.stop()
mb@90
   121
            self.rsdHandler.join()
mb@90
   122
        drives = self.getNetworkDrives()
mb@90
   123
        for drive in drives.keys():
mb@90
   124
            self.unmapNetworkDrive(drive)
mb@90
   125
        for vm in self.listSDVM():
mb@90
   126
            self.poweroffVM(vm)
mb@90
   127
            self.removeVM(vm)
mb@90
   128
        
mb@90
   129
    # return hosty system properties
mb@90
   130
    def getSystemProperties(self):
mb@90
   131
        result = checkResult(Cygwin.vboxExecute('list systemproperties'))
mb@90
   132
        if result[1]=='':
mb@90
   133
            return None
mb@90
   134
        props = dict((k.strip(),v.strip().strip('"')) for k,v in (line.split(':', 1) for line in result[1].strip().splitlines()))
mb@90
   135
        return props
mb@90
   136
    
mb@90
   137
    # return the folder containing the guest VMs     
mb@90
   138
    def getMachineFolder(self):
mb@90
   139
        return self.machineFolder
mb@90
   140
mb@90
   141
    # list all existing VMs registered with VBox
mb@90
   142
    def listVM(self):
mb@90
   143
        result = checkResult(Cygwin.vboxExecute('list vms'))[1]
mb@90
   144
        vms = list(k.strip().strip('"') for k,_ in (line.split(' ') for line in result.splitlines()))
mb@90
   145
        return vms
mb@90
   146
    
mb@90
   147
    # list running VMs
mb@90
   148
    def listRunningVMS(self):
mb@90
   149
        result = checkResult(Cygwin.vboxExecute('list runningvms'))[1]
mb@90
   150
        vms = list(k.strip().strip('"') for k,_ in (line.split(' ') for line in result.splitlines()))
mb@90
   151
        return vms
mb@90
   152
    
mb@90
   153
    # list existing SDVMs
mb@90
   154
    def listSDVM(self):
mb@90
   155
        vms = self.listVM()
mb@90
   156
        svdms = []
mb@90
   157
        for vm in vms:
mb@90
   158
            if vm.startswith(self.vmRootName) and vm != self.vmRootName:
mb@90
   159
                svdms.append(vm)
mb@90
   160
        return svdms
mb@90
   161
    
mb@90
   162
    # generate valid (not already existing SDVM name). necessary for creating a new VM
mb@90
   163
    def generateSDVMName(self):
mb@90
   164
        vms = self.listVM()
mb@90
   165
        for i in range(0,999):
mb@90
   166
            if(not self.vmRootName+str(i) in vms):
mb@90
   167
                return self.vmRootName+str(i)
mb@90
   168
        return ''
mb@90
   169
    
mb@90
   170
    # check if the device is mass storage type
mb@90
   171
    @staticmethod
mb@90
   172
    def isMassStorageDevice(device):
mb@90
   173
        keyname = 'SYSTEM\CurrentControlSet\Enum\USB' + '\VID_' + device.vendorid+'&'+'PID_'+ device.productid
mb@90
   174
        key = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE, keyname)
mb@90
   175
        #subkeys = _winreg.QueryInfoKey(key)[0]
mb@90
   176
        #for i in range(0, subkeys):
mb@90
   177
        #    print _winreg.EnumKey(key, i)     
mb@90
   178
        devinfokeyname = _winreg.EnumKey(key, 0)
mb@90
   179
        _winreg.CloseKey(key)
mb@90
   180
mb@90
   181
        devinfokey = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE, keyname+'\\'+devinfokeyname)
mb@90
   182
        value = _winreg.QueryValueEx(devinfokey, 'SERVICE')[0]
mb@90
   183
        _winreg.CloseKey(devinfokey)
mb@90
   184
        
mb@90
   185
        return 'USBSTOR' in value
mb@90
   186
    
mb@90
   187
    # return the RSDs connected to the host
mb@90
   188
    @staticmethod
mb@90
   189
    def getConnectedRSDS():
mb@90
   190
        results = checkResult(Cygwin.vboxExecute('list usbhost'))[1]
mb@90
   191
        results = results.split('Host USB Devices:')[1].strip()
mb@90
   192
        
mb@90
   193
        items = list( "UUID:"+result for result in results.split('UUID:') if result != '')
mb@90
   194
        rsds = dict()   
mb@90
   195
        for item in items:
mb@90
   196
            props = dict()
mb@90
   197
            for line in item.splitlines():
mb@90
   198
                if line != "":         
mb@90
   199
                    k,v = line[:line.index(':')].strip(), line[line.index(':')+1:].strip()
mb@90
   200
                    props[k] = v
mb@90
   201
            
mb@90
   202
            #if 'Product' in props.keys() and props['Product'] == 'Mass Storage':
mb@90
   203
            
mb@90
   204
            usb_filter = USBFilter( re.search(r"\((?P<vid>[0-9A-Fa-f]+)\)", props['VendorId']).groupdict()['vid'], 
mb@90
   205
                                    re.search(r"\((?P<pid>[0-9A-Fa-f]+)\)", props['ProductId']).groupdict()['pid'],
mb@90
   206
                                    re.search(r"\((?P<rev>[0-9A-Fa-f]+)\)", props['Revision']).groupdict()['rev'] )
mb@90
   207
            if VMManager.isMassStorageDevice(usb_filter):
mb@90
   208
                rsds[props['UUID']] = usb_filter;
mb@90
   209
                logger.debug(usb_filter)
mb@90
   210
        return rsds
mb@90
   211
    
mb@90
   212
    # return the RSDs attached to all existing SDVMs
mb@90
   213
    def getAttachedRSDs(self):
mb@90
   214
        vms = self.listSDVM()
mb@90
   215
        attached_devices = dict()
mb@90
   216
        for vm in vms:
mb@90
   217
            rsd_filter = self.getUSBFilter(vm)
mb@90
   218
            if rsd_filter != None:
mb@90
   219
                attached_devices[vm] = rsd_filter
mb@90
   220
        return attached_devices
mb@90
   221
    
mb@90
   222
    # configures hostonly networking and DHCP server. requires admin rights
mb@90
   223
    def configureHostNetworking(self):
mb@90
   224
        #cmd = 'vboxmanage list hostonlyifs'
mb@90
   225
        #Cygwin.vboxExecute(cmd)
mb@90
   226
        #cmd = 'vboxmanage hostonlyif remove \"VirtualBox Host-Only Ethernet Adapter\"'
mb@90
   227
        #Cygwin.vboxExecute(cmd)
mb@90
   228
        #cmd = 'vboxmanage hostonlyif create'
mb@90
   229
        #Cygwin.vboxExecute(cmd)
mb@90
   230
        checkResult(Cygwin.vboxExecute('hostonlyif ipconfig \"VirtualBox Host-Only Ethernet Adapter\" --ip 192.168.56.1 --netmask 255.255.255.0'))
mb@90
   231
        #cmd = 'vboxmanage dhcpserver add'
mb@90
   232
        #Cygwin.vboxExecute(cmd)
mb@90
   233
        checkResult(Cygwin.vboxExecute('dhcpserver modify --ifname \"VirtualBox Host-Only Ethernet Adapter\" --ip 192.168.56.100 --netmask 255.255.255.0 --lowerip 192.168.56.101 --upperip 192.168.56.200'))
mb@90
   234
    
BarthaM@125
   235
    def isSDVMExisting(self, vm_name):
BarthaM@125
   236
        sdvms = self.listSDVM()
BarthaM@125
   237
        return vm_name in sdvms
BarthaM@125
   238
        
mb@90
   239
    #create new virtual machine instance based on template vm named SecurityDVM (\SecurityDVM\SecurityDVM.vmdk)
mb@90
   240
    def createVM(self, vm_name):
BarthaM@125
   241
        if self.isSDVMExisting(vm_name):
BarthaM@125
   242
            return
BarthaM@125
   243
        #remove eventually existing SDVM folder
BarthaM@125
   244
        machineFolder = Cygwin.cygPath(self.machineFolder)
BarthaM@125
   245
        checkResult(Cygwin.bashExecute('/usr/bin/rm -rf \\\"' + machineFolder + '/' + vm_name + '\\\"'))
mb@90
   246
        hostonly_if = self.getHostOnlyIFs()
mb@90
   247
        checkResult(Cygwin.vboxExecute('createvm --name ' + vm_name + ' --ostype Debian --register'))
mb@90
   248
        checkResult(Cygwin.vboxExecute('modifyvm ' + vm_name + ' --memory 512 --vram 10 --cpus 1 --usb on --usbehci on --nic1 hostonly --hostonlyadapter1 \"' + hostonly_if['Name'] + '\" --nic2 nat'))
mb@90
   249
        checkResult(Cygwin.vboxExecute('storagectl ' + vm_name + ' --name SATA --add sata --portcount 2'))
mb@90
   250
        return
mb@90
   251
    
mb@90
   252
    # attach storage image to controller
mb@90
   253
    def storageAttach(self, vm_name):
mb@90
   254
        if self.isStorageAttached(vm_name):
mb@90
   255
            self.storageDetach(vm_name)
mb@90
   256
        checkResult(Cygwin.vboxExecute('storageattach ' + vm_name + ' --storagectl SATA --port 0 --device 0 --type hdd --medium \"'+ self.machineFolder + '\SecurityDVM\SecurityDVM.vmdk\"'))
mb@90
   257
    
mb@90
   258
    # return true if storage is attached 
mb@90
   259
    def isStorageAttached(self, vm_name):
mb@90
   260
        info = self.getVMInfo(vm_name)
mb@90
   261
        return (info['SATA-0-0']!='none')
mb@90
   262
    
mb@90
   263
    # detach storage from controller
mb@90
   264
    def storageDetach(self, vm_name):
mb@90
   265
        if self.isStorageAttached(vm_name):
mb@90
   266
            checkResult(Cygwin.vboxExecute('storageattach ' + vm_name + ' --storagectl SATA --port 0 --device 0 --type hdd --medium none'))
mb@90
   267
    
mb@90
   268
    def changeStorageType(self, filename, storage_type):
mb@90
   269
        checkResult(Cygwin.vboxExecute('modifyhd \"' + filename + '\" --type ' + storage_type))
mb@90
   270
    
mb@90
   271
    # list storage snaphots for VM
mb@90
   272
    def updateTemplate(self):
mb@95
   273
mb@90
   274
        self.cleanup()
mb@90
   275
        self.poweroffVM('SecurityDVM')
mb@90
   276
        self.waitShutdown('SecurityDVM')
mb@90
   277
        
mb@90
   278
        # check for updates
mb@90
   279
        self.genCertificateISO('SecurityDVM')
mb@90
   280
        self.attachCertificateISO('SecurityDVM')
mb@90
   281
        
mb@90
   282
        self.storageDetach('SecurityDVM')
mb@90
   283
        results = checkResult(Cygwin.vboxExecute('list hdds'))[1]
mb@90
   284
        results = results.replace('Parent UUID', 'Parent')
mb@90
   285
        items = list( "UUID:"+result for result in results.split('UUID:') if result != '')
mb@90
   286
        
mb@90
   287
        snaps = dict()   
mb@90
   288
        for item in items:
mb@90
   289
            props = dict()
mb@90
   290
            for line in item.splitlines():
mb@90
   291
                if line != "":         
mb@90
   292
                    k,v = line[:line.index(':')].strip(), line[line.index(':')+1:].strip()
mb@90
   293
                    props[k] = v;
mb@90
   294
            snaps[props['UUID']] = props
mb@90
   295
        
mb@90
   296
        
mb@90
   297
        template_storage = self.machineFolder + '\SecurityDVM\SecurityDVM.vmdk'
mb@90
   298
        
mb@90
   299
        # find template uuid
mb@90
   300
        template_uuid = ''
mb@90
   301
        for hdd in snaps.values():
mb@90
   302
            if hdd['Location'] == template_storage:
mb@90
   303
                template_uuid = hdd['UUID']
mb@90
   304
        logger.debug('found parent uuid ' + template_uuid)
mb@90
   305
        
mb@90
   306
        # remove snapshots 
mb@90
   307
        for hdd in snaps.values():
mb@90
   308
            if hdd['Parent'] == template_uuid:
mb@90
   309
                #template_uuid = hdd['UUID']
mb@90
   310
                logger.debug('removing snapshot ' + hdd['UUID'])
mb@90
   311
                checkResult(Cygwin.vboxExecute('closemedium disk {' + hdd['UUID'] + '} --delete'))#[1]
mb@90
   312
                # parse result 0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
mb@90
   313
        
mb@90
   314
        self.changeStorageType(template_storage,'normal')
mb@90
   315
        self.storageAttach('SecurityDVM')
mb@90
   316
        self.startVM('SecurityDVM')
mb@90
   317
        self.waitStartup('SecurityDVM')
mb@90
   318
        checkResult(Cygwin.sshExecute('"sudo apt-get -y update"', VMManager.getHostOnlyIP('SecurityDVM'), 'osecuser', Cygwin.cygPath(self.machineFolder) + '/' + 'SecurityDVM' + '/dvm_key'))
mb@90
   319
        checkResult(Cygwin.sshExecute('"sudo apt-get -y upgrade"', VMManager.getHostOnlyIP('SecurityDVM'), 'osecuser', Cygwin.cygPath(self.machineFolder) + '/' + 'SecurityDVM' + '/dvm_key'))
mb@90
   320
        #self.stopVM('SecurityDVM')
mb@90
   321
        self.hibernateVM('SecurityDVM')
mb@90
   322
        self.waitShutdown('SecurityDVM')
mb@90
   323
        self.storageDetach('SecurityDVM')
mb@90
   324
        self.changeStorageType(template_storage,'immutable')
mb@90
   325
        self.storageAttach('SecurityDVM')
mb@90
   326
        self.rsdHandler = DeviceHandler(self)
mb@90
   327
        self.rsdHandler.start()
mb@90
   328
    
mb@90
   329
    #remove VM from the system. should be used on VMs returned by listSDVMs    
mb@90
   330
    def removeVM(self, vm_name):
mb@90
   331
        logger.info('Removing ' + vm_name)
mb@90
   332
        checkResult(Cygwin.vboxExecute('unregistervm ' + vm_name + ' --delete'))
mb@90
   333
        machineFolder = Cygwin.cygPath(self.machineFolder)
mb@97
   334
        checkResult(Cygwin.bashExecute('/usr/bin/rm -rf \\\"' + machineFolder + '/' + vm_name + '\\\"'))
mb@90
   335
    
mb@90
   336
    # start VM
mb@90
   337
    def startVM(self, vm_name):
mb@90
   338
        logger.info('Starting ' +  vm_name)
mb@90
   339
        result = checkResult(Cygwin.vboxExecute('startvm ' + vm_name + ' --type headless' ))
mb@90
   340
        while 'successfully started' not in result[1]:
mb@90
   341
            logger.error("Failed to start SDVM: " + vm_name + " retrying")
oliver@129
   342
            logger.error("Command returned:\n" + result[2])
mb@90
   343
            time.sleep(1)
mb@90
   344
            result = checkResult(Cygwin.vboxExecute('startvm ' + vm_name + ' --type headless'))
mb@90
   345
        return result[0]
mb@90
   346
    
mb@90
   347
    # return wether VM is running or not
mb@90
   348
    def isVMRunning(self, vm_name):
mb@90
   349
        return vm_name in self.listRunningVMS()    
mb@90
   350
    
mb@90
   351
    # stop VM
mb@90
   352
    def stopVM(self, vm_name):
mb@90
   353
        logger.info('Sending shutdown signal to ' + vm_name)
mb@90
   354
        checkResult(Cygwin.sshExecute( '"sudo shutdown -h now"', VMManager.getHostOnlyIP(vm_name), 'osecuser', Cygwin.cygPath(self.machineFolder) + '/' + vm_name + '/dvm_key' ))
mb@90
   355
    
mb@90
   356
    # stop VM
mb@90
   357
    def hibernateVM(self, vm_name):
mb@95
   358
        logger.info('Sending hibernate-disk signal to ' + vm_name)
mb@90
   359
        checkResult(Cygwin.sshExecute( '"sudo hibernate-disk&"', VMManager.getHostOnlyIP(vm_name), 'osecuser', Cygwin.cygPath(self.machineFolder) + '/' + vm_name + '/dvm_key', wait_return=False))
mb@90
   360
            
mb@90
   361
    # poweroff VM
mb@90
   362
    def poweroffVM(self, vm_name):
mb@90
   363
        if not self.isVMRunning(vm_name):
mb@90
   364
            return
mb@90
   365
        logger.info('Powering off ' + vm_name)
mb@90
   366
        return checkResult(Cygwin.vboxExecute('controlvm ' + vm_name + ' poweroff'))
mb@90
   367
    
mb@90
   368
    #list the hostonly IFs exposed by the VBox host
mb@90
   369
    @staticmethod    
mb@90
   370
    def getHostOnlyIFs():
mb@90
   371
        result = Cygwin.vboxExecute('list hostonlyifs')[1]
mb@90
   372
        if result=='':
mb@90
   373
            return None
mb@90
   374
        props = dict((k.strip(),v.strip().strip('"')) for k,v in (line.split(':', 1) for line in result.strip().splitlines()))
mb@90
   375
        return props
mb@90
   376
    
mb@90
   377
    # return the hostOnly IP for a running guest or the host
mb@90
   378
    @staticmethod    
mb@90
   379
    def getHostOnlyIP(vm_name):
mb@90
   380
        if vm_name == None:
oliver@129
   381
            logger.info('Getting hostOnly IP address for Host')
mb@90
   382
            return VMManager.getHostOnlyIFs()['IPAddress']
mb@90
   383
        else:
oliver@129
   384
            logger.info('Getting hostOnly IP address ' + vm_name)
mb@90
   385
            result = checkResult(Cygwin.vboxExecute('guestproperty get ' + vm_name + ' /VirtualBox/GuestInfo/Net/0/V4/IP'))
mb@90
   386
            if result=='':
mb@90
   387
                return None
mb@90
   388
            result = result[1]
mb@90
   389
            if result.startswith('No value set!'):
mb@90
   390
                return None
mb@90
   391
            return result[result.index(':')+1:].strip()
mb@90
   392
            
mb@90
   393
    # attach removable storage device to VM by provision of filter
mb@90
   394
    def attachRSD(self, vm_name, rsd_filter):
mb@90
   395
        return checkResult(Cygwin.vboxExecute('usbfilter add 0 --target ' + vm_name + ' --name OpenSecurityRSD --vendorid ' + rsd_filter.vendorid + ' --productid ' + rsd_filter.productid + ' --revision ' + rsd_filter.revision))
mb@90
   396
    
mb@90
   397
    # detach removable storage from VM by 
mb@90
   398
    def detachRSD(self, vm_name):
mb@90
   399
        return checkResult(Cygwin.vboxExecute('usbfilter remove 0 --target ' + vm_name))
mb@90
   400
        
mb@90
   401
    # return the description set for an existing VM
mb@90
   402
    def getVMInfo(self, vm_name):
mb@90
   403
        results = checkResult(Cygwin.vboxExecute('showvminfo ' + vm_name + ' --machinereadable'))[1]
mb@90
   404
        props = dict((k.strip().strip('"'),v.strip().strip('"')) for k,v in (line.split('=', 1) for line in results.splitlines()))
mb@90
   405
        return props
mb@90
   406
    
mb@90
   407
    # return the configured USB filter for an existing VM 
mb@90
   408
    def getUSBFilter(self, vm_name):
mb@90
   409
        props = self.getVMInfo(vm_name)
mb@90
   410
        keys = set(['USBFilterVendorId1', 'USBFilterProductId1', 'USBFilterRevision1'])
mb@90
   411
        keyset = set(props.keys())
mb@90
   412
        usb_filter = None
mb@90
   413
        if keyset.issuperset(keys):
mb@90
   414
            usb_filter = USBFilter(props['USBFilterVendorId1'], props['USBFilterProductId1'], props['USBFilterRevision1'])
mb@90
   415
        return usb_filter
mb@90
   416
    
mb@90
   417
    #generates ISO containing authorized_keys for use with guest VM
mb@90
   418
    def genCertificateISO(self, vm_name):
mb@90
   419
        machineFolder = Cygwin.cygPath(self.machineFolder)
mb@90
   420
        # remove .ssh folder if exists
mb@97
   421
        checkResult(Cygwin.bashExecute('/usr/bin/rm -rf \\\"' + machineFolder + '/' + vm_name + '/.ssh\\\"'))
mb@90
   422
        # remove .ssh folder if exists
mb@97
   423
        checkResult(Cygwin.bashExecute('/usr/bin/rm -rf \\\"' + machineFolder + '/' + vm_name + '/dvm_key\\\"'))
mb@90
   424
        # create .ssh folder in vm_name
mb@97
   425
        checkResult(Cygwin.bashExecute('/usr/bin/mkdir -p \\\"' + machineFolder + '/' + vm_name + '/.ssh\\\"'))
mb@90
   426
        # generate dvm_key pair in vm_name / .ssh     
mb@97
   427
        checkResult(Cygwin.bashExecute('/usr/bin/ssh-keygen -q -t rsa -N \\\"\\\" -C \\\"' + vm_name + '\\\" -f \\\"' + machineFolder + '/' + vm_name + '/.ssh/dvm_key\\\"'))
mb@90
   428
        # move out private key
mb@97
   429
        checkResult(Cygwin.bashExecute('/usr/bin/mv \\\"' + machineFolder + '/' + vm_name + '/.ssh/dvm_key\\\" \\\"' + machineFolder + '/' + vm_name + '\\\"'))
mb@90
   430
        # set permissions for private key
mb@97
   431
        checkResult(Cygwin.bashExecute('/usr/bin/chmod 500 \\\"' + machineFolder + '/' + vm_name + '/dvm_key\\\"'))
mb@90
   432
        # rename public key to authorized_keys
mb@97
   433
        checkResult(Cygwin.bashExecute('/usr/bin/mv \\\"' + machineFolder + '/' + vm_name + '/.ssh/dvm_key.pub\\\" \\\"' + machineFolder + '/' + vm_name + '/.ssh/authorized_keys\\\"'))
mb@90
   434
        # set permissions for authorized_keys
mb@97
   435
        checkResult(Cygwin.bashExecute('/usr/bin/chmod 500 \\\"' + machineFolder + '/' + vm_name + '/.ssh/authorized_keys\\\"'))
mb@90
   436
        # generate iso image with .ssh/authorized keys
mb@97
   437
        checkResult(Cygwin.bashExecute('/usr/bin/genisoimage -J -R -o \\\"' + machineFolder + '/' + vm_name + '/'+ vm_name + '.iso\\\" \\\"' + machineFolder + '/' + vm_name + '/.ssh\\\"'))
mb@90
   438
    
mb@90
   439
    # attaches generated ssh public cert to guest vm
mb@90
   440
    def attachCertificateISO(self, vm_name):
mb@90
   441
        result = checkResult(Cygwin.vboxExecute('storageattach ' + vm_name + ' --storagectl SATA --port 1 --device 0 --type dvddrive --mtype readonly --medium \"' + self.machineFolder + '\\' + vm_name + '\\'+ vm_name + '.iso\"'))
mb@90
   442
        return result
mb@90
   443
    
mb@90
   444
    # wait for machine to come up
mb@90
   445
    def waitStartup(self, vm_name, timeout_ms = 30000):
mb@90
   446
        checkResult(Cygwin.vboxExecute('guestproperty wait ' + vm_name + ' SDVMStarted --timeout ' + str(timeout_ms) + ' --fail-on-timeout'))
mb@90
   447
        return VMManager.getHostOnlyIP(vm_name)
mb@90
   448
    
mb@90
   449
    # wait for machine to shutdown
mb@90
   450
    def waitShutdown(self, vm_name):
mb@90
   451
        while vm_name in self.listRunningVMS():
mb@90
   452
            time.sleep(1)
mb@90
   453
        return
mb@90
   454
        
mb@90
   455
    # handles browsing request    
mb@90
   456
    def handleBrowsingRequest(self):
mb@90
   457
        handler = BrowsingHandler(self)
mb@90
   458
        handler.start()
mb@90
   459
        return 'ok'
mb@90
   460
    
mb@90
   461
    #Small function to check the availability of network resource.
mb@90
   462
    #def isAvailable(self, path):
mb@90
   463
        #return os.path.exists(path)
mb@90
   464
        #result = Cygwin.cmdExecute('IF EXIST "' + path + '" echo YES')
mb@90
   465
        #return string.find(result[1], 'YES',)
mb@90
   466
    
mb@90
   467
    #Small function to check if the mention location is a directory
mb@90
   468
    def isDirectory(self, path):
mb@90
   469
        result = checkResult(Cygwin.cmdExecute('dir ' + path + ' | FIND ".."'))
mb@90
   470
        return string.find(result[1], 'DIR',)
mb@90
   471
mb@90
   472
    def mapNetworkDrive(self, drive, networkPath, user, password):
mb@90
   473
        self.unmapNetworkDrive(drive)
mb@90
   474
        #Check for drive availability
mb@90
   475
        if os.path.exists(drive):
mb@90
   476
            logger.error("Drive letter is already in use: " + drive)
mb@90
   477
            return -1
mb@90
   478
        #Check for network resource availability
mb@90
   479
        retry = 5
mb@90
   480
        while not os.path.exists(networkPath):
mb@90
   481
            time.sleep(1)
mb@90
   482
            if retry == 0:
mb@90
   483
                return -1
mb@90
   484
            logger.info("Path not accessible: " + networkPath + " retrying")
mb@90
   485
            retry-=1
mb@90
   486
            #return -1
mb@90
   487
    
mb@90
   488
        command = 'USE ' + drive + ' ' + networkPath + ' /PERSISTENT:NO'
mb@90
   489
        if user != None:
mb@90
   490
            command += ' ' + password + ' /User' + user
mb@90
   491
    
mb@90
   492
        #TODO: Execute 'NET USE' command with authentication
mb@90
   493
        result = checkResult(Cygwin.execute('C:\\Windows\\system32\\net.exe', command))
mb@90
   494
        if string.find(result[1], 'successfully',) == -1:
mb@90
   495
            logger.error("Failed: NET " + command)
mb@90
   496
            return -1
mb@90
   497
        return 1
mb@90
   498
    
mb@90
   499
    def unmapNetworkDrive(self, drive):
mb@90
   500
        drives = self.getNetworkDrives()
mb@90
   501
        if drive not in drives.keys():
mb@90
   502
            return 1 
mb@90
   503
        result = checkResult(Cygwin.execute('C:\\Windows\\system32\\net.exe', 'USE ' + drive + ' /DELETE /YES'))
mb@90
   504
        if string.find(str(result[1]), 'successfully',) == -1:
mb@90
   505
            logger.error(result[2])
mb@90
   506
            return -1
mb@90
   507
        return 1
mb@90
   508
    
mb@90
   509
    def getNetworkDrives(self):
mb@90
   510
        ip = VMManager.getHostOnlyIP(None)
mb@90
   511
        ip = ip[:ip.rindex('.')]
mb@90
   512
        drives = dict()    
mb@90
   513
        result = checkResult(Cygwin.execute('C:\\Windows\\system32\\net.exe', 'USE'))
mb@90
   514
        for line in result[1].splitlines():
mb@90
   515
            if ip in line:
mb@90
   516
                parts = line.split()
mb@90
   517
                drives[parts[1]] = parts[2]
mb@90
   518
        return drives
mb@90
   519
            
mb@90
   520
    def genNetworkDrive(self):
mb@90
   521
        network_drives = self.getNetworkDrives()
mb@90
   522
        logical_drives = VMManager.getLogicalDrives()
mb@90
   523
        drives = list(map(chr, range(68, 91)))  
mb@90
   524
        for drive in drives:
mb@90
   525
            if drive+':' not in network_drives and drive not in logical_drives:
mb@90
   526
                return drive+':'
mb@90
   527
mb@90
   528
    def getNetworkDrive(self, vm_name):
mb@90
   529
        ip = self.getHostOnlyIP(vm_name)
mb@90
   530
        result = checkResult(Cygwin.execute('C:\\Windows\\system32\\net.exe', 'USE'))
mb@90
   531
        for line in result[1].splitlines():
mb@90
   532
            if line != None and ip in line:
mb@90
   533
                parts = line.split()
mb@90
   534
                return parts[0]
mb@90
   535
    @staticmethod
mb@90
   536
    def getLogicalDrives():
mb@90
   537
        drive_bitmask = ctypes.cdll.kernel32.GetLogicalDrives()
mb@90
   538
        return list(itertools.compress(string.ascii_uppercase,  map(lambda x:ord(x) - ord('0'), bin(drive_bitmask)[:1:-1])))
mb@90
   539
    
mb@90
   540
    @staticmethod
mb@90
   541
    def getDriveType(drive):
mb@90
   542
        return ctypes.cdll.kernel32.GetDriveTypeW(u"%s:\\"%drive)
mb@90
   543
    
mb@90
   544
    @staticmethod
mb@90
   545
    def getVolumeInfo(drive):
mb@90
   546
        volumeNameBuffer = ctypes.create_unicode_buffer(1024)
mb@90
   547
        fileSystemNameBuffer = ctypes.create_unicode_buffer(1024)
mb@90
   548
        serial_number = None
mb@90
   549
        max_component_length = None
mb@90
   550
        file_system_flags = None
mb@90
   551
        
mb@90
   552
        rc = ctypes.cdll.kernel32.GetVolumeInformationW(
mb@90
   553
            #ctypes.c_wchar_p("F:\\"),
mb@90
   554
            u"%s:\\"%drive,
mb@90
   555
            volumeNameBuffer,
mb@90
   556
            ctypes.sizeof(volumeNameBuffer),
mb@90
   557
            serial_number,
mb@90
   558
            max_component_length,
mb@90
   559
            file_system_flags,
mb@90
   560
            fileSystemNameBuffer,
mb@90
   561
            ctypes.sizeof(fileSystemNameBuffer)
mb@90
   562
        )
mb@90
   563
        
mb@90
   564
        return volumeNameBuffer.value, fileSystemNameBuffer.value
mb@90
   565
mb@90
   566
def checkResult(result):
mb@90
   567
    if result[0] != 0:
oliver@129
   568
        logger.error('Command failed:\n' + result[2])
mb@90
   569
        raise OpenSecurityException('Command failed:' + ''.join(result[2]))
mb@90
   570
    return result
mb@90
   571
mb@110
   572
mb@110
   573
            
mb@90
   574
# handles browsing request                    
mb@95
   575
class BrowsingHandler(threading.Thread):   
mb@90
   576
    vmm = None
mb@110
   577
    #Cygwin.start_X11()
mb@90
   578
    def __init__(self, vmmanager):
mb@90
   579
        threading.Thread.__init__(self)
mb@90
   580
        self.vmm = vmmanager
mb@90
   581
     
mb@90
   582
    def run(self):
mb@97
   583
        drive = None
mb@90
   584
        try:
mb@90
   585
            new_sdvm = self.vmm.generateSDVMName()
mb@90
   586
            self.vmm.createVM(new_sdvm)
mb@90
   587
            self.vmm.storageAttach(new_sdvm)
mb@90
   588
            self.vmm.genCertificateISO(new_sdvm)
mb@90
   589
            self.vmm.attachCertificateISO(new_sdvm)
mb@90
   590
            self.vmm.startVM(new_sdvm)
mb@90
   591
            new_ip = self.vmm.waitStartup(new_sdvm)
BarthaM@125
   592
            drive = self.vmm.genNetworkDrive()
BarthaM@125
   593
            if new_ip != None:
BarthaM@125
   594
                self.vmm.mapNetworkDrive(drive, '\\\\' + new_ip + '\\Download', None, None)
mb@95
   595
            #browser = '/usr/bin/iceweasel'
mb@95
   596
            #browser = '/usr/bin/midori'
mb@110
   597
            #browser = '/usr/bin/chromium '
mb@110
   598
            browser = '\\\"/usr/bin/chromium; pidof dbus-launch | xargs kill\\\"'
mb@110
   599
            Cygwin.start_X11()
mb@110
   600
           
mb@110
   601
            #if Cygwin.is_X11_running()==True:
mb@110
   602
            #result = checkResult(Cygwin.bashExecute('DISPLAY=:0 xhost '+new_ip))
mb@95
   603
            result = checkResult(Cygwin.sshExecuteX11(browser, new_ip, 'osecuser', Cygwin.cygPath(self.vmm.getMachineFolder()) + '/' + new_sdvm + '/dvm_key'))
mb@90
   604
        except:
mb@90
   605
            logger.error("BrowsingHandler failed. Cleaning up")
mb@97
   606
        if drive != None:    
mb@97
   607
            self.vmm.unmapNetworkDrive(drive)
mb@90
   608
        self.vmm.poweroffVM(new_sdvm)
mb@90
   609
        self.vmm.removeVM(new_sdvm)
mb@90
   610
                
mb@90
   611
class DeviceHandler(threading.Thread): 
mb@90
   612
    vmm = None
mb@90
   613
    attachedRSDs = None  
mb@90
   614
    connectedRSDs = None
mb@90
   615
    running = True
mb@90
   616
    def __init__(self, vmmanger): 
mb@90
   617
        threading.Thread.__init__(self)
mb@90
   618
        self.vmm = vmmanger
mb@90
   619
 
mb@90
   620
    def stop(self):
mb@90
   621
        self.running = False
mb@90
   622
        
mb@90
   623
    def run(self):
mb@90
   624
        self.connectedRSDs = dict()
mb@90
   625
        while self.running:
mb@90
   626
            tmp_rsds = self.vmm.getConnectedRSDS()
mb@95
   627
            
mb@95
   628
            self.attachedRSDs = self.vmm.getAttachedRSDs()
mb@95
   629
            for vm_name in self.attachedRSDs.keys():
mb@95
   630
                if self.attachedRSDs[vm_name] not in tmp_rsds.values():
mb@95
   631
                    drive = self.vmm.getNetworkDrive(vm_name)
mb@95
   632
                    self.vmm.unmapNetworkDrive(drive)
mb@95
   633
                    #self.stopVM(vm_name)
mb@95
   634
                    self.vmm.detachRSD(vm_name)
mb@95
   635
                    self.vmm.poweroffVM(vm_name)
mb@95
   636
                    self.vmm.removeVM(vm_name)
mb@95
   637
                    break
mb@95
   638
                    
mb@95
   639
                    
mb@90
   640
            if tmp_rsds.keys() == self.connectedRSDs.keys():
mb@90
   641
                logger.debug("Nothing's changed. sleep(3)")
mb@90
   642
                time.sleep(3)
mb@90
   643
                continue
mb@90
   644
            
mb@90
   645
            logger.info("Something's changed")          
mb@90
   646
            self.connectedRSDs = tmp_rsds
mb@90
   647
            
mb@95
   648
            
mb@95
   649
            
mb@90
   650
            #create new vm for attached device if any
mb@90
   651
            self.attachedRSDs = self.vmm.getAttachedRSDs()
mb@90
   652
            self.connectedRSDs = self.vmm.getConnectedRSDS()
mb@90
   653
            
mb@90
   654
            new_ip = None
mb@90
   655
            for connected_device in self.connectedRSDs.values():
mb@90
   656
                if (self.attachedRSDs and False) or (connected_device not in self.attachedRSDs.values()):
mb@90
   657
                    new_sdvm = self.vmm.generateSDVMName()
mb@90
   658
                    self.vmm.createVM(new_sdvm)
mb@90
   659
                    self.vmm.storageAttach(new_sdvm)
mb@90
   660
                    self.vmm.attachRSD(new_sdvm, connected_device)
mb@90
   661
                    self.vmm.startVM(new_sdvm)
mb@90
   662
                    new_ip = self.vmm.waitStartup(new_sdvm)
mb@90
   663
                    drive = self.vmm.genNetworkDrive()
mb@90
   664
                    if new_ip != None:
mb@90
   665
                        self.vmm.mapNetworkDrive(drive, '\\\\' + new_ip + '\\USB', None, None)
mb@90
   666
mb@90
   667
if __name__ == '__main__':
mb@90
   668
    #man = VMManager.getInstance()
mb@90
   669
    #man.listVM()
mb@90
   670
    #print man.getConnectedRSDs()
mb@90
   671
    #print man.getNetworkDrives()
mb@90
   672
    #man.genNetworkDrive()
mb@90
   673
    #drive_bitmask = ctypes.cdll.kernel32.GetLogicalDrives()
mb@90
   674
    #print list(itertools.compress(string.ascii_uppercase,  map(lambda x:ord(x) - ord('0'), bin(drive_bitmask)[:1:-1])))
mb@90
   675
    #print list(map(chr, range(68, 91))) 
mb@90
   676
    #print Cygwin.getRegEntry('SYSTEM\CurrentControlSet\Enum\USB', 'VID_1058&PID_0704')[0]
mb@90
   677
    #devices = VMManager.getConnectedRSDS()
mb@90
   678
    #print devices
mb@90
   679
    
mb@90
   680
    drives = VMManager.getLogicalDrives()
mb@90
   681
    print drives
mb@90
   682
    print VMManager.getDriveType("E")
mb@90
   683
    print VMManager.getVolumeInfo("E")
mb@90
   684
    #for device in devices.values():
mb@90
   685
    #    #print device
mb@90
   686
    #    if VMManager.isMassStorageDevice(device):
mb@90
   687
    #        print device
mb@90
   688
        
mb@90
   689
    
mb@90
   690
    
mb@90
   691
    #time.sleep(-1)
mb@90
   692
    #man.listVM()
mb@90
   693
    #man.listVM()
mb@90
   694
    #man.listVM()
mb@90
   695
    #man.listVM()
mb@90
   696
    #man.genCertificateISO('SecurityDVM0')
mb@90
   697
    #man.guestExecute('SecurityDVM0', '/bin/ls -la')
mb@90
   698
    #logger = setupLogger('VMManager')
mb@90
   699
    #c = Cygwin()
mb@90
   700
    
mb@90
   701
    #man.sshExecute('/bin/ls -la', 'SecurityDVM0')
mb@90
   702
    #man.sshExecuteX11('/usr/bin/iceweasel', 'SecurityDVM0')
mb@90
   703
    #man.removeVM('SecurityDVM0')
mb@90
   704
    #man.netUse('192.168.56.134', 'USB\\')
mb@90
   705
    #ip = '192.168.56.139'
mb@90
   706
    
mb@90
   707
    #man.cygwin_path = 'c:\\cygwin64\\bin\\'
mb@90
   708
    #man.handleDeviceChange()
mb@90
   709
    #print man.listSDVM()
mb@90
   710
    #man.configureHostNetworking()
mb@90
   711
    #new_vm = man.generateSDVMName()
mb@90
   712
    #man.createVM(new_vm)
mb@90
   713
    
mb@90
   714
    #print Cygwin.cmd()
mb@90
   715
    #man.isAvailable('c:')
mb@90
   716
    #ip = man.getHostOnlyIP('SecurityDVM0')
mb@90
   717
    #man.mapNetworkDrive('h:', '\\\\' + ip + '\Download', None, None)
mb@90
   718
    
mb@90
   719
    #man.genCertificateISO(new_vm)
mb@90
   720
    #man.attachCertificateISO(new_vm)
mb@90
   721
    
mb@90
   722
    #man.attachCertificateISO(vm_name)
mb@90
   723
    #man.guestExecute(vm_name, "ls")
mb@90
   724
    #man.sshGuestX11Execute('SecurityDVM1', '/usr/bin/iceweasel')
mb@90
   725
    #time.sleep(60)
mb@90
   726
    #print man.cygwinPath("C:\Users\BarthaM\VirtualBox VMs\SecurityDVM\.ssh\*")
mb@90
   727
    #man.genCertificateISO('SecurityDVM')
mb@90
   728
    #man.attachCertificateISO('SecurityDVM')
mb@90
   729
    #man.isStorageAttached('SecurityDVM')
mb@90
   730
    #man.guestExecute('SecurityDVM', 'sudo apt-get -y update')
mb@90
   731
    #man.guestExecute('SecurityDVM', 'sudo apt-get -y upgrade' )
mb@90
   732
    
mb@90
   733
    #man.stopVM('SecurityDVM')
mb@90
   734
    #man.storageDetach('SecurityDVM')
mb@90
   735
    #man.changeStorageType('C:\Users\BarthaM\VirtualBox VMs\SecurityDVM\SecurityDVM.vmdk','immutable')
mb@90
   736
    #man.storageAttach('SecurityDVM')
mb@90
   737
    
mb@90
   738
    
mb@90
   739
    #cmd = "c:\\cygwin64\\bin\\bash.exe --login -c \"/bin/ls\""
mb@90
   740
    #man.execute(cmd)