'''

Created on Nov 19, 2013

@author: BarthaM

'''

import os

import os.path

from subprocess import Popen, PIPE, call, STARTUPINFO, _subprocess

import subprocess

import sys

import re

from cygwin import Cygwin

from environment import Environment

import threading

import time

import string

import shutil

import stat

import tempfile

from opensecurity_util import logger, setupLogger, OpenSecurityException

DEBUG = True

class VMManagerException(Exception):

    def __init__(self, value):

        self.value = value

    def __str__(self):

        return repr(self.value)

class USBFilter:

    vendorid = ""

    productid = ""

    revision = ""

    def __init__(self, vendorid, productid, revision):

        self.vendorid = vendorid.lower()

        self.productid = productid.lower()

        self.revision = revision.lower()

        return

    def __eq__(self, other):

        return self.vendorid == other.vendorid and self.productid == other.productid and self.revision == other.revision

    def __hash__(self):

        return hash(self.vendorid) ^ hash(self.productid) ^ hash(self.revision)

    def __repr__(self):

        return "VendorId = \'" + str(self.vendorid) + "\' ProductId = \'" + str(self.productid) + "\' Revision = \'" + str(self.revision) + "\'"

class VMManager(object):

    vmRootName = "SecurityDVM"

    systemProperties = None

    startNotifications = list()

    _instance = None

    machineFolder = ''

    def __init__(self):

        self.systemProperties = self.getSystemProperties()

        self.machineFolder = self.systemProperties["Default machine folder"]

        self.cleanup()

        return

    @staticmethod

    def getInstance():

        if VMManager._instance == None:

            VMManager._instance = VMManager()

        return VMManager._instance

    def cleanup(self):

        self.unmapNetworkDrive('G:')

        self.unmapNetworkDrive('H:')

        for vm in self.listSDVM():

            self.poweroffVM(vm)

            self.removeVM(vm)

    def putStartNotification(self, ip):

        self.startNotifications.append(ip)

    def isSDVMStarted(self, ip):

        return self.startNotifications.contains(ip)

    # return hosty system properties

    def getSystemProperties(self):

        result = Cygwin.vboxExecute('list systemproperties')

        if result[1]=='':

            return None

        props = dict((k.strip(),v.strip().strip('"')) for k,v in (line.split(':', 1) for line in result[1].strip().splitlines()))

        logger.debug(props)

        return props

    # return the folder containing the guest VMs     

    def getMachineFolder(self):

        return self.machineFolder

    #list the hostonly IFs exposed by the VBox host

    def getHostOnlyIFs(self):

        result = Cygwin.vboxExecute('list hostonlyifs')[1]

        if result=='':

            return None

        props = dict((k.strip(),v.strip().strip('"')) for k,v in (line.split(':', 1) for line in result.strip().splitlines()))

        return props

    def listRSDS(self):

        results = Cygwin.vboxExecute('list usbhost')[1]

        results = results.split('Host USB Devices:')[1].strip()

        items = list( "UUID:"+result for result in results.split('UUID:') if result != '')

        rsds = dict()   

        for item in items:

            props = dict()

            for line in item.splitlines():

                if line != "":         

                    k,v = line[:line.index(':')].strip(), line[line.index(':')+1:].strip()

                    props[k] = v

            if 'Product' in props.keys() and props['Product'] == 'Mass Storage':

                usb_filter = USBFilter( re.search(r"\((?P<vid>[0-9A-Fa-f]+)\)", props['VendorId']).groupdict()['vid'], 

                                        re.search(r"\((?P<pid>[0-9A-Fa-f]+)\)", props['ProductId']).groupdict()['pid'],

                                        re.search(r"\((?P<rev>[0-9A-Fa-f]+)\)", props['Revision']).groupdict()['rev'] )

                rsds[props['UUID']] = usb_filter;

                logger.debug(usb_filter)

        return rsds

    # list all existing VMs registered with VBox

    def listVM(self):

        result = Cygwin.vboxExecute('list vms')[1]

        vms = list(k.strip().strip('"') for k,_ in (line.split(' ') for line in result.splitlines()))

        return vms

    # list running VMs

    def listRunningVMS(self):

        result = Cygwin.vboxExecute('list runningvms')[1]

        vms = list(k.strip().strip('"') for k,_ in (line.split(' ') for line in result.splitlines()))

        return vms

    # list existing SDVMs

    def listSDVM(self):

        vms = self.listVM()

        svdms = []

        for vm in vms:

            if vm.startswith(self.vmRootName) and vm != self.vmRootName:

                svdms.append(vm)

        return svdms

    # generate valid (not already existing SDVM name). necessary for creating a new VM

    def generateSDVMName(self):

        vms = self.listVM()

        for i in range(0,999):

            if(not self.vmRootName+str(i) in vms):

                return self.vmRootName+str(i)

        return ''

    # return the RSDs attached to all existing SDVMs

    def getAttachedRSDs(self):

        vms = self.listSDVM()

        attached_devices = dict()

        for vm in vms:

            rsd_filter = self.getUSBFilter(vm)

            if rsd_filter != None:

                attached_devices[vm] = rsd_filter

        return attached_devices

    # configures hostonly networking and DHCP server. requires admin rights

    def configureHostNetworking(self):

        #cmd = 'vboxmanage list hostonlyifs'

        #Cygwin.vboxExecute(cmd)

        #cmd = 'vboxmanage hostonlyif remove \"VirtualBox Host-Only Ethernet Adapter\"'

        #Cygwin.vboxExecute(cmd)

        #cmd = 'vboxmanage hostonlyif create'

        #Cygwin.vboxExecute(cmd)

        Cygwin.vboxExecute('hostonlyif ipconfig \"VirtualBox Host-Only Ethernet Adapter\" --ip 192.168.56.1 --netmask 255.255.255.0')

        #cmd = 'vboxmanage dhcpserver add'

        #Cygwin.vboxExecute(cmd)

        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')

    #create new virtual machine instance based on template vm named SecurityDVM (\SecurityDVM\SecurityDVM.vmdk)

    def createVM(self, vm_name):

        hostonly_if = self.getHostOnlyIFs()

        Cygwin.vboxExecute('createvm --name ' + vm_name + ' --ostype Debian --register')

        Cygwin.vboxExecute('modifyvm ' + vm_name + ' --memory 512 --vram 10 --cpus 1 --usb on --usbehci on --nic1 hostonly --hostonlyadapter1 \"' + hostonly_if['Name'] + '\" --nic2 nat')

        Cygwin.vboxExecute('storagectl ' + vm_name + ' --name SATA --add sata --portcount 2')

        return

    # attach storage image to controller

    def storageAttach(self, vm_name):

        if self.isStorageAttached(vm_name):

            self.storageDetach(vm_name)

        Cygwin.vboxExecute('storageattach ' + vm_name + ' --storagectl SATA --port 0 --device 0 --type hdd --medium \"'+ self.machineFolder + '\SecurityDVM\SecurityDVM.vmdk\"')

        return

    # return true if storage is attached 

    def isStorageAttached(self, vm_name):

        info = self.getVMInfo(vm_name)

        return (info['SATA-0-0']!='none')

    # detach storage from controller

    def storageDetach(self, vm_name):

        if self.isStorageAttached(vm_name):

            Cygwin.vboxExecute('storageattach ' + vm_name + ' --storagectl SATA --port 0 --device 0 --type hdd --medium none')

        return

    def changeStorageType(self, filename, storage_type):

        Cygwin.vboxExecute('modifyhd \"' + filename + '\" --type ' + storage_type)

        return

    # list storage snaphots for VM

    def updateTemplate(self):

        self.poweroffVM('SecurityDVM')

        self.waitShutdown('SecurityDVM')

        # check for updates

        self.genCertificateISO('SecurityDVM')

        self.attachCertificateISO('SecurityDVM')

        self.storageDetach('SecurityDVM')

        results = Cygwin.vboxExecute('list hdds')[1]

        results = results.replace('Parent UUID', 'Parent')

        items = list( "UUID:"+result for result in results.split('UUID:') if result != '')

        snaps = dict()   

        for item in items:

            props = dict()

            for line in item.splitlines():

                if line != "":         

                    k,v = line[:line.index(':')].strip(), line[line.index(':')+1:].strip()

                    props[k] = v;

            snaps[props['UUID']] = props

        template_storage = self.machineFolder + '\SecurityDVM\SecurityDVM.vmdk'

        # find template uuid

        template_uuid = ''

        for hdd in snaps.values():

            if hdd['Location'] == template_storage:

                template_uuid = hdd['UUID']

        logger.debug('found parent uuid ' + template_uuid)

        # remove snapshots 

        for hdd in snaps.values():

            if hdd['Parent'] == template_uuid:

                #template_uuid = hdd['UUID']

                logger.debug('removing snapshot ' + hdd['UUID'])

                results = Cygwin.vboxExecute('closemedium disk {' + hdd['UUID'] + '} --delete')[1]

                # parse result 0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%

        self.changeStorageType(template_storage,'normal')

        self.storageAttach('SecurityDVM')

        self.startVM('SecurityDVM')

        self.waitStartup('SecurityDVM')

        Cygwin.sshExecute('sudo apt-get -y update', VMManager.getHostOnlyIP('SecurityDVM'), 'osecuser', Cygwin.cygPath(self.machineFolder) + '/' + 'SecurityDVM' + '/dvm_key'  )

        Cygwin.sshExecute('sudo apt-get -y upgrade', VMManager.getHostOnlyIP('SecurityDVM'), 'osecuser', Cygwin.cygPath(self.machineFolder) + '/' + 'SecurityDVM' + '/dvm_key'  )

        self.stopVM('SecurityDVM')

        self.waitShutdown('SecurityDVM')

        self.storageDetach('SecurityDVM')

        self.changeStorageType(template_storage,'immutable')

        self.storageAttach('SecurityDVM')

    #remove VM from the system. should be used on VMs returned by listSDVMs    

    def removeVM(self, vm_name):

        logger.info('Removing ' + vm_name)

        Cygwin.vboxExecute('unregistervm ' + vm_name + ' --delete')

        machineFolder = Cygwin.cygPath(self.machineFolder)

        Cygwin.bashExecute('"/usr/bin/rm -rf ' + machineFolder + '/' + vm_name + '"')

    # start VM

    def startVM(self, vm_name):

        logger.info('Starting ' +  vm_name)

        result = Cygwin.vboxExecute('startvm ' + vm_name + ' --type headless' )

        while not string.find(str(result), 'successfully started',):

            logger.error("Failed to start SDVM: " + vm_name + " retrying")

            time.sleep(1)

            result = Cygwin.vboxExecute('startvm ' + vm_name + ' --type headless')

        return result[0]

    # return wether VM is running or not

    def isVMRunning(self, vm_name):

        return vm_name in self.listRunningVMS()    

    # stop VM

    def stopVM(self, vm_name):

        logger.info('Sending shutdown signal to ' + vm_name)

        Cygwin.sshExecute( 'sudo shutdown -h now', VMManager.getHostOnlyIP(vm_name), 'osecuser', Cygwin.cygPath(self.machineFolder) + '/' + vm_name + '/dvm_key' )

    # poweroff VM

    def poweroffVM(self, vm_name):

        if not self.isVMRunning(vm_name):

            return

        logger.info('Powering off ' + vm_name)

        return Cygwin.vboxExecute('controlvm ' + vm_name + ' poweroff')

    # return the hostOnly IP for a running guest

    @staticmethod    

    def getHostOnlyIP(vm_name):

        logger.info('Gettting hostOnly IP address ' + vm_name)

        result = Cygwin.vboxExecute('guestproperty get ' + vm_name + ' /VirtualBox/GuestInfo/Net/0/V4/IP')

        if result=='':

            return None

        result = result[1]

        if result.startswith('No value set!'):

            return None

        return result[result.index(':')+1:].strip()

    # attach removable storage device to VM by provision of filter

    def attachRSD(self, vm_name, rsd_filter):

        return Cygwin.vboxExecute('usbfilter add 0 --target ' + vm_name + ' --name OpenSecurityRSD --vendorid ' + rsd_filter.vendorid + ' --productid ' + rsd_filter.productid + ' --revision ' + rsd_filter.revision)

    # detach removable storage from VM by 

    def detachRSD(self, vm_name):

        return Cygwin.vboxExecute('usbfilter remove 0 --target ' + vm_name )

    # return the description set for an existing VM

    def getVMInfo(self, vm_name):

        results = Cygwin.vboxExecute('showvminfo ' + vm_name + ' --machinereadable')[1]

        props = dict((k.strip().strip('"'),v.strip().strip('"')) for k,v in (line.split('=', 1) for line in results.splitlines()))

        logger.debug(props)

        return props

    # return the configured USB filter for an existing VM 

    def getUSBFilter(self, vm_name):

        props = self.getVMInfo(vm_name)

        keys = set(['USBFilterVendorId1', 'USBFilterProductId1', 'USBFilterRevision1'])

        keyset = set(props.keys())

        usb_filter = None

        if keyset.issuperset(keys):

            usb_filter = USBFilter(props['USBFilterVendorId1'], props['USBFilterProductId1'], props['USBFilterRevision1'])

        return usb_filter

    #generates ISO containing authorized_keys for use with guest VM

    def genCertificateISO(self, vm_name):

        machineFolder = Cygwin.cygPath(self.machineFolder)

        # remove .ssh folder if exists

        cmd = '\"/usr/bin/rm -rf \\\"' + machineFolder + '/' + vm_name + '/.ssh\\\"\"'

        Cygwin.bashExecute(cmd)

        # remove .ssh folder if exists

        Cygwin.bashExecute('\"/usr/bin/rm -rf \\\"' + machineFolder + '/' + vm_name + '/dvm_key\\\"\"')

        # create .ssh folder in vm_name

        Cygwin.bashExecute('\"/usr/bin/mkdir -p \\\"' + machineFolder + '/' + vm_name + '/.ssh\\\"\"')

        # generate dvm_key pair in vm_name / .ssh     

        Cygwin.bashExecute('\"/usr/bin/ssh-keygen -q -t rsa -N \\"\\" -C \\\"' + vm_name + '\\\" -f \\\"' + machineFolder + '/' + vm_name + '/.ssh/dvm_key\\\"\"')

        # move out private key

        Cygwin.bashExecute('\"/usr/bin/mv \\\"' + machineFolder + '/' + vm_name + '/.ssh/dvm_key\\\" \\\"' + machineFolder + '/' + vm_name + '\\\"')

        # set permissions for private key

        Cygwin.bashExecute('\"/usr/bin/chmod 500 \\\"' + machineFolder + '/' + vm_name + '/dvm_key\\\"\"')

        # rename public key to authorized_keys

        Cygwin.bashExecute('\"/usr/bin/mv \\\"' + machineFolder + '/' + vm_name + '/.ssh/dvm_key.pub\\\" \\\"' + machineFolder + '/' + vm_name + '/.ssh/authorized_keys\\\"')

        # set permissions for authorized_keys

        Cygwin.bashExecute('\"/usr/bin/chmod 500 \\\"' + machineFolder + '/' + vm_name + '/.ssh/authorized_keys\\\"\"')

        # generate iso image with .ssh/authorized keys

        Cygwin.bashExecute('\"/usr/bin/genisoimage -J -R -o \\\"' + machineFolder + '/' + vm_name + '/'+ vm_name + '.iso\\\" \\\"' + machineFolder + '/' + vm_name + '/.ssh\\\"\"')

    # attaches generated ssh public cert to guest vm

    def attachCertificateISO(self, vm_name):

        result = Cygwin.vboxExecute('storageattach ' + vm_name + ' --storagectl SATA --port 1 --device 0 --type dvddrive --mtype readonly --medium \"' + self.machineFolder + '\\' + vm_name + '\\'+ vm_name + '.iso\"')

        return result

    handleDeviceChangeLock = threading.Lock()

    # handles device change events

    def handleDeviceChange(self):

        if VMManager.handleDeviceChangeLock.acquire(True):

            #destroy unused vms

            new_ip = None

            attached_devices = self.getAttachedRSDs()

            connected_devices = self.listRSDS()

            for vm_name in attached_devices.keys():

                if attached_devices[vm_name] not in connected_devices.values():

                    self.unmapNetworkDrive('h:')

                    #self.stopVM(vm_name)

                    self.detachRSD(vm_name)

                    self.poweroffVM(vm_name)

                    self.removeVM(vm_name)

            #create new vm for attached device if any

            attached_devices = self.getAttachedRSDs()

            connected_devices = self.listRSDS()

            for connected_device in connected_devices.values():

                if (attached_devices and False) or (connected_device not in attached_devices.values()):

                    new_sdvm = self.generateSDVMName()

                    self.createVM(new_sdvm)

                    self.storageAttach(new_sdvm)

                    self.attachRSD(new_sdvm, connected_device)

                    self.startVM(new_sdvm)

                    new_ip = self.waitStartup(new_sdvm)

                    if new_ip != None:

                        self.mapNetworkDrive('h:', '\\\\' + new_ip + '\\USB', None, None)

                    #TODO: cleanup notifications somwhere else (eg. machine shutdown)

                    self.startNotifications.remove(new_ip)

            VMManager.handleDeviceChangeLock.release()

            return new_ip

    # wait for machine to come up

    def waitStartup(self, vm_name): 

        new_ip = None

        while new_ip == None:

            time.sleep(1)

            new_ip = VMManager.getHostOnlyIP(vm_name)

        while new_ip not in self.startNotifications:

            time.sleep(1)

        return new_ip

    # wait for machine to shutdown

    def waitShutdown(self, vm_name):

        while vm_name in self.listRunningVMS():

            time.sleep(1)

        return

    # handles browsing request    

    def handleBrowsingRequest(self):

        if VMManager.handleDeviceChangeLock.acquire(True):

            new_sdvm = self.generateSDVMName()

            self.createVM(new_sdvm)

            self.storageAttach(new_sdvm)

            self.genCertificateISO(new_sdvm)

            self.attachCertificateISO(new_sdvm)

            self.startVM(new_sdvm)

            new_ip = self.waitStartup(new_sdvm)

            if new_ip != None:

                self.mapNetworkDrive('g:', '\\\\' + new_ip + '\\Download', None, None)

            #TODO: cleanup notifications somwhere else (eg. machine shutdown)

            self.startNotifications.remove(new_ip)

            VMManager.handleDeviceChangeLock.release()

        return new_sdvm

    #Small function to check the availability of network resource.

    def isAvailable(self, path):

        result = Cygwin.cmdExecute('IF EXIST "' + path + '" echo YES')

        return string.find(result[1], 'YES',)

    #Small function to check if the mention location is a directory

    def isDirectory(self, path):

        result = Cygwin.cmdExecute('dir ' + path + ' | FIND ".."')

        return string.find(result[1], 'DIR',)

    def mapNetworkDrive(self, drive, networkPath, user, password):

        self.unmapNetworkDrive(drive)

        #Check for drive availability

        if self.isAvailable(drive) > -1:

            logger.error("Drive letter is already in use: " + drive)

            return -1

        #Check for network resource availability

        while self.isAvailable(networkPath) == -1:

            time.sleep(1)

            logger.info("Path not accessible: " + networkPath + " retrying")

            #return -1

        command = 'USE ' + drive + ' ' + networkPath

        if user != None:

            command += ' ' + password + ' /User' + user

        #TODO: Execute 'NET USE' command with authentication

        result = Cygwin.execute('C:\\Windows\\system32\\net.exe', command)

        if string.find(result[1], 'successfully',) == -1:

            logger.error("Failed: NET " + command)

            return -1

        return 1

    def unmapNetworkDrive(self, drive):

        if self.isAvailable(drive) == -1:

            return -1

        result = Cygwin.execute('C:\\Windows\\system32\\net.exe', 'USE ' + drive + ' /DELETE /YES')

        if string.find(str(result), 'successfully',) == -1:

            return -1

        return 1

if __name__ == '__main__':

    man = VMManager.getInstance()

    #man.listVM()

    print man.listRSDS()

    #man.listVM()

    #man.listVM()

    #man.listVM()

    #man.listVM()

    #man.genCertificateISO('SecurityDVM0')

    #man.guestExecute('SecurityDVM0', '/bin/ls -la')

    #logger = setupLogger('VMManager')

    c = Cygwin()

    #man.sshExecute('/bin/ls -la', 'SecurityDVM0')

    #man.sshExecuteX11('/usr/bin/iceweasel', 'SecurityDVM0')

    #man.removeVM('SecurityDVM0')

    #man.netUse('192.168.56.134', 'USB\\')

    #ip = '192.168.56.139'

    #man.cygwin_path = 'c:\\cygwin64\\bin\\'

    #man.handleDeviceChange()

    #print man.listSDVM()

    #man.configureHostNetworking()

    #new_vm = man.generateSDVMName()

    #man.createVM(new_vm)

    #print Cygwin.cmd()

    #man.isAvailable('c:')

    #ip = man.getHostOnlyIP('SecurityDVM0')

    #man.mapNetworkDrive('h:', '\\\\' + ip + '\Download', None, None)

    #man.genCertificateISO(new_vm)

    #man.attachCertificateISO(new_vm)

    #man.attachCertificateISO(vm_name)

    #man.guestExecute(vm_name, "ls")

    #man.sshGuestX11Execute('SecurityDVM1', '/usr/bin/iceweasel')

    #time.sleep(60)

    #print man.cygwinPath("C:\Users\BarthaM\VirtualBox VMs\SecurityDVM\.ssh\*")

    #man.genCertificateISO('SecurityDVM')

    #man.attachCertificateISO('SecurityDVM')

    #man.isStorageAttached('SecurityDVM')

    #man.guestExecute('SecurityDVM', 'sudo apt-get -y update')

    #man.guestExecute('SecurityDVM', 'sudo apt-get -y upgrade' )

    #man.stopVM('SecurityDVM')

    #man.storageDetach('SecurityDVM')

    #man.changeStorageType('C:\Users\BarthaM\VirtualBox VMs\SecurityDVM\SecurityDVM.vmdk','immutable')

    #man.storageAttach('SecurityDVM')

    #cmd = "c:\\cygwin64\\bin\\bash.exe --login -c \"/bin/ls\""

    #man.execute(cmd)