Removed checkResult method from cygwin.py.
Created additional tests and force removal of certificate image.
Modified the updateTemplate method.
Fixed VM startup wait method.
2 # -*- coding: utf-8 -*-
4 # ------------------------------------------------------------
7 # executes a cygwin command inside the opensecurity project
9 # Autor: Mihai Bartha, <mihai.bartha@ait.ac.at>
10 # Oliver Maurhart, <oliver.maurhart@ait.ac.at>
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
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.
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.
26 # You should have received a copy of the GNU General Public License
27 # along with this program; if not, write to the Free Software
28 # Foundation, Inc., 51 Franklin Street, Fifth Floor,
29 # Boston, MA 02110-1301, USA.
30 # ------------------------------------------------------------
33 # ------------------------------------------------------------
40 from subprocess import Popen, PIPE, STARTUPINFO, _subprocess
44 from environment import Environment
45 from opensecurity_util import logger, setupLogger, OpenSecurityException
49 # ------------------------------------------------------------
53 """get the path to our local cygwin installment"""
54 home_drive = os.path.expandvars("%HOMEDRIVE%") + os.sep
55 e = Environment('OpenSecurity')
57 os.path.abspath(os.path.join(e.prefix_path, 'cygwin')),
58 os.path.abspath(os.path.join(e.prefix_path, 'cygwin64')),
59 os.path.abspath(os.path.join(home_drive, 'cygwin')),
60 os.path.abspath(os.path.join(home_drive, 'cygwin64'))
62 path_valid = [ p for p in path_hint if os.path.exists(p) ]
63 theClass.cygwin_root = path_valid[0]
64 theClass.cygwin_bin = os.path.join(theClass.cygwin_root, 'bin') + os.path.sep
65 theClass.cygwin_bash = os.path.join(theClass.cygwin_bin, 'bash.exe')
66 theClass.cygwin_ssh = os.path.join(theClass.cygwin_bin, 'ssh.exe')
67 theClass.cygwin_scp = os.path.join(theClass.cygwin_bin, 'scp.exe')
68 theClass.cygwin_x11 = os.path.join(theClass.cygwin_bin, 'XWin.exe')
69 theClass.win_cmd = os.environ.get("COMSPEC", "cmd.exe")
70 """get the path to the VirtualBox installation on this system"""
71 theClass.vbox_root = theClass.getRegEntry('SOFTWARE\Oracle\VirtualBox', 'InstallDir')[0]
72 theClass.vbox_man = os.path.join(theClass.vbox_root, 'VBoxManage.exe')
73 #theClass.user_home = os.path.expanduser("~")
74 theClass.user_home = os.environ['APPDATA']#os.path.expandvars("%APPDATA%")
90 """Some nifty methods working with Cygwin"""
92 def __call__(self, command, arguments, wait_return=True, window = False):
93 """make an instance of this object act as a function"""
94 return self.execute(command, arguments, wait_return, window)
97 def getRegEntry(key, value):
99 k = _winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE, key)
100 value = _winreg.QueryValueEx(k, value)
109 return Cygwin.cygwin_root
113 return Cygwin.cygwin_bin
117 return Cygwin.cygwin_bash
121 return Cygwin.cygwin_ssh
125 return Cygwin.cygwin_scp
129 return Cygwin.cygwin_x11
133 return Cygwin.vbox_man
137 return Cygwin.win_cmd
141 return Cygwin.user_home
143 executeLock = threading.Lock()
144 #executes command on host system
146 def execute(program, arguments, wait_return=True, window = False, stdin = PIPE, stdout = PIPE, stderr = PIPE):
147 _startupinfo = STARTUPINFO()
149 _startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
150 _startupinfo.wShowWindow = _subprocess.SW_HIDE
151 #logger.debug('trying to launch: ' + program + ' ' + ''.join(arguments))
153 result, res_stdout, res_stderr = None, None, None
155 # quote the executable otherwise we run into troubles
156 # when the path contains spaces and additional arguments
157 # are presented as well.
158 # special: invoking bash as login shell here with
159 # an unquoted command does not execute /etc/profile
160 args = '"' + program + '" ' + arguments
161 logger.debug('Launching: ' + program + ' ' + ''.join(arguments))
162 process = Popen(args, startupinfo = _startupinfo, stdin = stdin, stdout = stdout, stderr = stderr, shell = False)
164 return [0, 'working in background', '']
166 res_stdout, res_stderr = process.communicate()
167 result = process.returncode
168 logger.debug('Finished: ' + program + ' ' + ''.join(arguments))
170 except Exception as ex:
171 res_stderr = ''.join(str(ex.args))
175 logger.error('Command failed:' + ''.join(res_stderr))
176 raise OpenSecurityException('Command failed:' + ''.join(res_stderr))
178 return result, res_stdout, res_stderr
181 def vboxExecute(command, wait_return=True, window = False, bash_opts='', try_count = 3):
184 while retry < try_count:
185 if Cygwin.executeLock.acquire(True):
187 result = Cygwin.execute(Cygwin.vbox_man, command, wait_return, window)
188 except Exception as ex:
189 Cygwin.executeLock.release()
190 if (retry+1) == try_count:
193 Cygwin.executeLock.release()
196 raise OpenSecurityException('Command max retry reached: ' + ''.join(command))
200 def bashExecute(command, wait_return=True, window = False, bash_opts='', stdin = PIPE, stdout = PIPE, stderr = PIPE):
201 # for some reason, the '-l' is ignored when started via python
202 # so the same behavior is triggered by calling /etc/profile
204 command = bash_opts + ' -l -c "' + command + '"'
205 return Cygwin.execute(Cygwin.cygwin_bash, command, wait_return, window, stdin = stdin, stdout = stdout, stderr = stderr)
208 def cmdExecute(command, wait_return=True, window = False):
209 command = ' /c ' + command
210 return Cygwin.execute(Cygwin.win_cmd, command, wait_return, window)
212 # executes command over ssh on guest vm
214 def sshExecute(command, address, user_name, certificate, wait_return=True, window = False):
215 if command == None or address == None or user_name == None or certificate == None:
216 raise OpenSecurityException('Invalid parameter value')
217 command = ' -v -o StrictHostKeyChecking=no -i "' + certificate + '" ' + user_name + '@' + address + ' ' + command
218 return Cygwin.execute(Cygwin.cygwin_ssh, command, wait_return, window)
220 # executes command over ssh on guest vm
222 def sshBackgroundExecute(command, address, user_name, certificate, wait_return=True, window = False):
223 command = ' -f -v -o StrictHostKeyChecking=no -i "' + certificate + '" ' + user_name + '@' + address + ' ' + command
224 return Cygwin.execute(Cygwin.cygwin_ssh, command, wait_return, window)
226 #machineFolder + '/' + vm_name + '/dvm_key
227 #address = self.getHostOnlyIP(vm_name)
228 #machineFolder = self.getDefaultMachineFolder()
229 #machineFolder = Cygwin.cygwinPath(machineFolder)
231 # executes command over ssh on guest vm with X forwarding
233 def sshExecuteX11(command, address, user_name, certificate, wait_return=True):
234 return Cygwin.bashExecute('DISPLAY=:0.0 ssh -Y -o StrictHostKeyChecking=no -i \\\"' + certificate +'\\\" ' + user_name + '@' + address + ' ' + command + '')
237 def is_X11_running():
238 """check if we can connect to a X11 running instance"""
239 p = Cygwin.bashExecute('xset -display :0 q', wait_return = True, window = False)
244 """start X11 in the background (if not already running) on DISPLAY=:0
246 If there is already a X11 running then exit silently, calling this
247 method as often as needed.
249 Popen('"' + Cygwin.cygwin_x11 + '" :0 -multiwindow -resize -silent-dup-error')
250 return (0, None, None)
254 cmd = 'cygpath -u \'' + path + '\''
255 return Cygwin.bashExecute(cmd)[1].rstrip('\n')
258 def checkResult(result):
260 # logger.error('Command failed:' + ''.join(result[2]))
261 # raise OpenSecurityException('Command failed:' + ''.join(result[2]))
270 if __name__ == "__main__":
271 logger = setupLogger('Cygwin')
273 logger.info(c.root())
275 logger.info(c.bash())
278 logger.info(c.home())
281 #tasklist /v /fo list /fi "IMAGENAME eq explorer.exe"
291 #print (Cygwin.is_X11_running())
292 #print (Cygwin.is_X11_running())
293 #new_sdvm = 'SecurityDVM0'
294 #new_ip = Cygwin.vboxExecute('guestproperty get ' + new_sdvm + ' /VirtualBox/GuestInfo/Net/0/V4/IP')[1]
295 #new_ip = new_ip[new_ip.index(':')+1:].strip()
297 #result = Cygwin.bashExecute('DISPLAY=:0.0 xhost '+new_ip)
298 #browser = '/usr/bin/midori '
299 #print(Cygwin.sshExecuteX11(browser, new_ip, 'osecuser', '/cygdrive/c/Users/BarthaM/VirtualBox VMs' + '/' + new_sdvm + '/dvm_key'))
301 #print(Cygwin.bashExecute('echo $PATH')[1])
302 #print(Cygwin.cygPath('C:'))
303 #print('C:\\Program Files\\OpenSecurity: ' + c.cygPath('C:\\Program Files\\OpenSecurity'))