OpenSecurity/bin/opensecurity_client_restful_server.py added join to wait for netmount /umount thread finish
2 # -*- coding: utf-8 -*-
4 # ------------------------------------------------------------
7 # the opensecurityd as RESTful server
9 # Autor: Oliver Maurhart, <oliver.maurhart@ait.ac.at>
11 # Copyright (C) 2013 AIT Austrian Institute of Technology
12 # AIT Austrian Institute of Technology GmbH
13 # Donau-City-Strasse 1 | 1220 Vienna | Austria
14 # http://www.ait.ac.at
16 # This program is free software; you can redistribute it and/or
17 # modify it under the terms of the GNU General Public License
18 # as published by the Free Software Foundation version 2.
20 # This program is distributed in the hope that it will be useful,
21 # but WITHOUT ANY WARRANTY; without even the implied warranty of
22 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 # GNU General Public License for more details.
25 # You should have received a copy of the GNU General Public License
26 # along with this program; if not, write to the Free Software
27 # Foundation, Inc., 51 Franklin Street, Fifth Floor,
28 # Boston, MA 02110-1301, USA.
29 # ------------------------------------------------------------
32 # ------------------------------------------------------------
46 import __init__ as opensecurity
47 from cygwin import Cygwin
48 from environment import Environment
49 from opensecurity_util import logger
52 # ------------------------------------------------------------
55 """All the URLs we know mapping to class handler"""
57 '/browsing', 'os_browsing', # http://localhost:8080/browsing GET
58 '/fetch_initial_image', 'os_fetch_image', # http://localhost:8080/fetch_initial_image GET
59 '/init', 'os_init', # http://localhost:8080/init GET
60 '/initial_image', 'os_initial_image', # http://localhost:8080/initial_image GET
61 '/sdvms', 'os_sdvms', # http://localhost:8080/sdvms GET, PUT
62 '/sdvms/(.*)/application/(.*)', 'os_sdvm_application', # http://localhost:8080/sdvms/[VMNAME]/application/[COMMAND] GET
63 '/sdvms/(.*)/ip', 'os_sdvm_ip', # http://localhost:8080/sdvms/[VMNAME]/ip GET
64 '/sdvms/(.*)/start', 'os_sdvm_start', # http://localhost:8080/sdvms/[VMNAME]/start GET
65 '/sdvms/(.*)/stop', 'os_sdvm_stop', # http://localhost:8080/sdvms/[VMNAME]/stop GET
66 '/sdvms/(.*)', 'os_sdvm', # http://localhost:8080/sdvms/[VMNAME] GET, DELETE
67 '/setup', 'os_setup', # http://localhost:8080/setup GET
68 '/vms', 'os_vms', # http://localhost:8080/vms GET
69 '/vms/(.*)', 'os_vm', # http://localhost:8080/vms/[VMNAME] GET
70 '/update_template', 'os_update_template', # http://localhost:8080/update_template GET
71 '/terminate', 'os_terminate', # http://localhost:8080/terminate GET
72 '/', 'os_root' # http://localhost:8080/ GET
76 # ------------------------------------------------------------
79 # Global VMManager instance
86 # ------------------------------------------------------------
91 """OpenSecurity '/browsing' handler
93 - GET: Start and prepare a new SecurityVM for Internet Browsing. Return the name of the VM.
97 log_call(web.ctx.environ)
100 result = gvm_mgr.handleBrowsingRequest()
103 raise web.internalerror()
106 class os_fetch_image:
107 """OpenSecurity '/fetch_initial_image' handler
109 - GET: fetch the initial image from the X-Net Servers
110 The initial image is stored in the
111 Virtual Box default machine path.
112 The result to this call is a temprary file
113 which shows the progress (or error state)
119 log_call(web.ctx.environ)
122 trace_file_name = os.path.join(Environment('OpenSecurity').log_path, 'OpenSecurity_fetch_image.log')
123 trace_file = open(trace_file_name, 'w+')
125 machine_folder = Cygwin.cygPath(gvm_mgr.getMachineFolder())
126 download_initial_image_script = '/OpenSecurity/bin/download_initial_image.sh \'' + machine_folder + '\''
127 Cygwin.bashExecute(download_initial_image_script, wait_return = False, stdout = trace_file, stderr = trace_file)
129 res = '{ "fetch_log": "' + trace_file_name.replace('\\', '\\\\') + '" }'
134 """OpenSecurity '/init' handler
136 - GET: Do initial import of OsecVM.ova
140 log_call(web.ctx.environ)
143 trace_file_name = os.path.join(Environment('OpenSecurity').log_path, 'OpenSecurity_initial_import.log')
144 trace_file = open(trace_file_name, 'w+')
146 vm_image = Cygwin.cygPath(gvm_mgr.getMachineFolder()) + '/OsecVM.ova'
147 initial_import_script = '/OpenSecurity/bin/initial_vm.sh \'' + vm_image + '\''
148 Cygwin.bashExecute(initial_import_script, wait_return = False, stdout = trace_file, stderr = trace_file)
150 res = '{ "init_log": "' + trace_file_name.replace('\\', '\\\\') + '" }'
154 class os_initial_image:
155 """OpenSecurity '/initial_image' handler
157 - GET: Return what we have as initial image.
161 log_call(web.ctx.environ)
163 t = os.path.join(gvm_mgr.systemProperties['Default machine folder'], 'OsecVM.ova')
165 if os.path.isfile(t):
166 res = '{"initial_template": { '
167 res += '"name": "OsecVM.ova", '
168 res += '"path": "' + t.replace('\\', '\\\\') + '", '
169 res += '"size": ' + str(os.path.getsize(t)) + ', '
170 res += '"date": ' + str(os.path.getmtime(t)) + ''
176 """OpenSecurity '/' handler
178 - GET: give information about current installation.
182 log_call(web.ctx.environ)
185 # create a json string and pretty print it
186 res = '{"os_server": { '
187 res += '"version": "' + opensecurity.__version__ + '" '
188 res += ', "virtual box systemproperties": ' + str(gvm_mgr.systemProperties).replace("'", '"')
189 res += ', "current temporary folder": "' + tempfile.gettempdir().replace('\\', '\\\\') + '"'
190 res += ', "current log folder": "' + Environment('OpenSecurity').log_path.replace('\\', '\\\\') + '"'
193 res += ', "whoami": "' + Cygwin.bashExecute('whoami')[1].strip() + '"'
195 res += ', "whoami": "FAILED"'
198 res += ', "mount": ' + str(Cygwin.bashExecute('mount')[1].split('\n')[:-1]).replace("'", '"')
200 res += ', "mount": "FAILED"'
203 res += ', "cygpath --windows ~": "' + Cygwin.bashExecute('cygpath --windows ~')[1].strip().replace('\\', '\\\\') + '"'
205 res += ', "cygpath --windows ~": "FAILED"'
208 res += ', "status message": "' + gvm_mgr.status_message.replace('"', "'") + '"'
212 # loading it into json and print it again ensures
213 # we really do have a valid RFC conform json string
214 # created (as long as the python json module is RFC conform)
215 return json.dumps(json.loads(res), indent = 4)
219 """OpenSecurity '/sdvms/[VM]' handler
221 - GET: Information about a specific SecurityVM
222 - DELETE: Remove a specific
226 log_call(web.ctx.environ)
228 return gvm_mgr.getVMInfo(name)
230 def DELETE(self, name):
231 log_call(web.ctx.environ)
233 return gvm_mgr.removeVM(name)
236 class os_sdvm_application:
237 """OpenSecurity '/sdvms/[VM]/application/[CMD]' handler
239 - GET: start application with given command in the VM.
242 def GET(self, name, command):
243 log_call(web.ctx.environ)
245 command = '/' + command
246 result = Cygwin.sshExecuteX11(command, gvm_mgr.getHostOnlyIP(name), 'osecuser', Cygwin.cygPath(gvm_mgr.getMachineFolder()) + '/' + name + '/dvm_key' )
247 self.poweroffVM(name)
248 return gvm_mgr.removeVM(name)
252 """OpenSecurity '/sdvms/[VM]/ip' handler
254 - GET: give IP of SecurityVM.
258 log_call(web.ctx.environ)
260 return gvm_mgr.getHostOnlyIP(name)
264 """OpenSecurity '/sdvms/[VM]/start' handler
266 - GET: Start specific SecuirtyVM.
270 log_call(web.ctx.environ)
272 return gvm_mgr.startVM(name)
276 """OpenSecurity '/sdvms/[VM]/stop' handler
278 - GET: stop specific Secuirty VM.
282 log_call(web.ctx.environ)
284 return gvm_mgr.stopVM(name)
288 """OpenSecurity '/sdvms' handler
290 - GET: list all available secuirty VMs.
291 - POST: create new security vm.
295 """get the list of SDVMs"""
296 log_call(web.ctx.environ)
298 return gvm_mgr.listSDVM()
301 """create a new SDVM"""
302 log_call(web.ctx.environ)
306 name = gvm_mgr.generateSDVMName()
308 gvm_mgr.createVM(name)
310 raise web.internalerror()
316 """OpenSecurity '/setup' handler
318 - GET: Give user some info how to setup the OpenSecurity envvironment
323 log_call(web.ctx.environ)
328 <h1>Setup OpenSecurity</h1>
329 In order to setup OpenSecurity an inital VM image has to be downloaded and imported:<br/>
331 <li>Download initial VM image: <a href="/fetch_initial_image">fetch_initial_image</a>
332 <li>Import initial VM: <a href="/init">init</a>
341 """OpenSecurity '/terminate' handler
343 - GET: terminate the opensecurityd.
345 TODO: need to find a better way doing this, and not via the
346 REST api. Maybe hack web.py server code?
350 log_call(web.ctx.environ)
358 class os_update_template:
359 """OpenSecurity '/update_template' handler
361 - GET: update template vm
365 #return gvm_mgr.guestExecute('SecurityDVM', 'sudo apt-get -y update')
367 log_call(web.ctx.environ)
368 return gvm_mgr.updateTemplate()
372 """OpenSecurity '/vms/[VM]' handler
374 - GET: list information of arbitrary VM.
378 log_call(web.ctx.environ)
380 return gvm_mgr.getVMInfo(name)
384 """OpenSecurity '/vms' handler
386 - GET: list all (also non Security) VMs.
390 log_call(web.ctx.environ)
392 return str(gvm_mgr.listVM()).replace("'",'"')
395 def log_call(web_environ):
396 """log the incoming call to the REST api"""
398 call = 'REST ' + web_environ['REQUEST_METHOD'] + ' ' + web_environ['REQUEST_URI'] + ' from ' + web_environ['REMOTE_ADDR'] + ':' + web_environ['REMOTE_PORT']
405 """main startup for the opensecuirityd"""
410 logger.debug('Starting OpenSecurity REST server')
412 # ensure a VMManger is yet loaded
413 gvm_mgr = vmmanager.VMManager.getInstance()
415 # tweak sys.argv to control wep.py server start behavior
416 sys.argv = [__file__, "8080"]
417 server = web.application(opensecurity_urls, globals(), autoreload = False)
420 logger.debug('Stopped OpenSecurity REST server')
424 """stop the opensecuirityd"""
426 # calling sys.exit() raises a SystemExit exception
427 # of the WSGI Server to let it wind down
434 if __name__ == "__main__":