OpenSecurity/bin/cygwin.py
author mb
Tue, 18 Mar 2014 16:28:15 +0100
changeset 95 cdebb7e0ba10
parent 90 bfd41c38d156
child 96 630b62946c9e
permissions -rwxr-xr-x
changed X11 start location
     1 #!/bin/env python
     2 # -*- coding: utf-8 -*-
     3 
     4 # ------------------------------------------------------------
     5 # cygwin command
     6 # 
     7 # executes a cygwin command inside the opensecurity project
     8 #
     9 # Autor: Mihai Bartha, <mihai.bartha@ait.ac.at>
    10 #        Oliver Maurhart, <oliver.maurhart@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 # ------------------------------------------------------------
    31 
    32 
    33 # ------------------------------------------------------------
    34 # imports
    35 
    36 import os
    37 import subprocess
    38 import sys
    39 import _winreg
    40 from subprocess import Popen, PIPE, call, STARTUPINFO, _subprocess
    41 import threading
    42 # local
    43 from environment import Environment
    44 from opensecurity_util import logger, setupLogger, OpenSecurityException
    45 
    46 # ------------------------------------------------------------
    47 # code
    48 
    49 def once(theClass):
    50     """get the path to our local cygwin installment"""
    51     home_drive = os.path.expandvars("%HOMEDRIVE%") + os.sep
    52     path_hint = [ 
    53         os.path.abspath(os.path.join(Environment('OpenSecurity').prefix_path, '..', 'cygwin')), 
    54         os.path.abspath(os.path.join(Environment('OpenSecurity').prefix_path, '..', 'cygwin64')), 
    55         os.path.abspath(os.path.join(home_drive, 'cygwin')),
    56         os.path.abspath(os.path.join(home_drive, 'cygwin64'))
    57     ]
    58     path_valid = [ p for p in path_hint if os.path.exists(p) ]
    59         
    60     theClass.cygwin_root = path_valid[0]
    61     theClass.cygwin_bin = os.path.join(theClass.cygwin_root, 'bin') + os.path.sep
    62     theClass.cygwin_bash = os.path.join(theClass.cygwin_bin, 'bash.exe')
    63     theClass.cygwin_ssh = os.path.join(theClass.cygwin_bin, 'ssh.exe')
    64     theClass.cygwin_x11 = os.path.join(theClass.cygwin_bin, 'XWin.exe')
    65     theClass.win_cmd = os.environ.get("COMSPEC", "cmd.exe") 
    66     """get the path to the VirtualBox installation on this system"""
    67     theClass.vbox_root = theClass.getRegEntry('SOFTWARE\Oracle\VirtualBox', 'InstallDir')[0]
    68     theClass.vbox_man = os.path.join(theClass.vbox_root, 'VBoxManage.exe')
    69     
    70     return theClass
    71 
    72 @once
    73 class Cygwin(object):
    74     cygwin_root = ''
    75     cygwin_bin = ''
    76     cygwin_bash = ''
    77     cygwin_ssh = ''
    78     cygwin_x11 = ''
    79     vbox_root = ''
    80     vbox_man = ''
    81     win_cmd = ''
    82     """Some nifty methods working with Cygwin"""
    83     
    84     def __call__(self, command, arguments, wait_return=True, window = False):
    85         """make an instance of this object act as a function"""
    86         return self.execute(command, arguments, wait_return, window)
    87 
    88     @staticmethod
    89     def getRegEntry(key, value):
    90         try:
    91             k = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE, key)
    92             value = _winreg.QueryValueEx(k, value)
    93             _winreg.CloseKey(k)
    94             return value
    95         except:
    96             pass
    97             
    98     @staticmethod
    99     def root():
   100         return Cygwin.cygwin_root
   101 
   102     @staticmethod
   103     def bin():
   104         return Cygwin.cygwin_bin
   105     
   106     @staticmethod
   107     def bash():
   108         return Cygwin.cygwin_bash
   109     
   110     @staticmethod    
   111     def ssh():
   112         return Cygwin.cygwin_ssh
   113 
   114     @staticmethod    
   115     def x11():
   116         return Cygwin.cygwin_x11
   117     
   118     @staticmethod
   119     def vboxman():
   120         return Cygwin.vbox_man
   121     
   122     @staticmethod
   123     def cmd():
   124         return Cygwin.win_cmd
   125     
   126     executeLock = threading.Lock()
   127     #executes command on host system
   128     @staticmethod
   129     def execute(program, arguments, wait_return=True, window = False):
   130         _startupinfo = STARTUPINFO()
   131         if not window:
   132             _startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
   133             _startupinfo.wShowWindow = _subprocess.SW_HIDE
   134 
   135             #logger.debug('trying to launch: ' + program + ' ' + ''.join(arguments))
   136         res_stderr = None
   137         try:
   138             process = Popen(executable=program, args=' ' + arguments, startupinfo = _startupinfo, stdin=PIPE, stdout=PIPE, stderr=PIPE, shell = False)
   139             logger.debug('Launched: ' + program + ' ' + ''.join(arguments))
   140             if not wait_return:
   141                 return [0, 'working in background', '']
   142             result = process.wait()
   143             res_stdout = process.stdout.read();
   144             res_stderr = process.stderr.read();
   145 
   146         except Exception as ex:
   147             res_stderr.join(ex.args)
   148             result = 1 
   149             
   150         return result, res_stdout, res_stderr
   151     
   152     @staticmethod
   153     def vboxExecute(command, wait_return=True, window = False, bash_opts=''):
   154         retry = 0
   155         result = None
   156         while retry < 3:
   157             if Cygwin.executeLock.acquire(True):
   158                 result = Cygwin.execute(Cygwin.vbox_man, command, wait_return, window)
   159                 Cygwin.executeLock.release()
   160                 if result[0] == 0:
   161                     return result
   162                 retry+=1
   163         return result
   164         
   165     
   166     @staticmethod
   167     def bashExecute(command, wait_return=True, window = False, bash_opts=''):
   168         command = bash_opts + ' -l -c '  + command
   169         return Cygwin.execute(Cygwin.cygwin_bash, command, wait_return, window)
   170     
   171     @staticmethod
   172     def cmdExecute(command, wait_return=True, window = False, bash_opts=''):
   173         command = ' /c ' + command 
   174         return Cygwin.execute(Cygwin.win_cmd, command, wait_return, window)
   175 
   176     # executes command over ssh on guest vm
   177     @staticmethod
   178     def sshExecute(command, address, user_name, certificate, wait_return=True, window = False):
   179         command = ' -v -i "' + certificate + '" ' + user_name + '@' + address + ' ' + command        
   180         return Cygwin.execute(Cygwin.cygwin_ssh, command, wait_return, window)     
   181     
   182     #machineFolder + '/' + vm_name + '/dvm_key
   183     #address = self.getHostOnlyIP(vm_name)
   184     #machineFolder = self.getDefaultMachineFolder()
   185     #machineFolder = Cygwin.cygwinPath(machineFolder)
   186     
   187     # executes command over ssh on guest vm with X forwarding
   188     @staticmethod
   189     def sshExecuteX11(command, address, user_name, certificate, wait_return=True):
   190         return Cygwin.bashExecute('"DISPLAY=:0.0 /usr/bin/ssh -v -Y -i \\"' + certificate +'\\" ' + user_name + '@' + address + ' ' + command + '\"')
   191 
   192     @staticmethod
   193     def is_X11_running():
   194         """check if we can connect to a X11 running instance"""
   195         p = Cygwin.bashExecute('"DISPLAY=:0 /usr/bin/xset -q"')
   196         return p[0] == 0
   197         
   198         
   199     @staticmethod
   200     def start_X11():
   201         """start X11 in the background (if not already running) on DISPLAY=:0"""
   202         # do not start if already running
   203         if Cygwin.is_X11_running():
   204             return           
   205         # launch X11 (forget output and return immediately)
   206         return Cygwin.execute(Cygwin.cygwin_x11, ':0 -multiwindow', wait_return = False, window = False)
   207         #return 0, None, None
   208     
   209     @staticmethod    
   210     def cygPath(path):
   211         return Cygwin.bashExecute('"/usr/bin/cygpath -u \\"' + path + '\\""')[1].rstrip('\n')
   212     
   213 # start
   214 if __name__ == "__main__":
   215     logger = setupLogger('Cygwin')
   216     c = Cygwin()
   217     logger.info(c.root())
   218     logger.info(c.bin())
   219     logger.info(c.bash())
   220     logger.info(c.ssh())
   221     
   222     c.cygPath('C:')
   223     c.start_X11()
   224     logger.info('X11 started')
   225     logger.info("X11 running: " + str(c.is_X11_running()))
   226