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, showTrayMessage
53 # ------------------------------------------------------------
56 """All the URLs we know mapping to class handler"""
58 '/browsing', 'os_browsing', # http://localhost:8080/browsing GET
59 '/fetch_initial_image', 'os_fetch_image', # http://localhost:8080/fetch_initial_image GET
60 '/init', 'os_init', # http://localhost:8080/init GET
61 '/initial_image', 'os_initial_image', # http://localhost:8080/initial_image GET
62 '/sdvms', 'os_sdvms', # http://localhost:8080/sdvms GET, PUT
63 '/sdvms/(.*)/application/(.*)', 'os_sdvm_application', # http://localhost:8080/sdvms/[VMNAME]/application/[COMMAND] GET
64 '/sdvms/(.*)/ip', 'os_sdvm_ip', # http://localhost:8080/sdvms/[VMNAME]/ip GET
65 '/sdvms/(.*)/start', 'os_sdvm_start', # http://localhost:8080/sdvms/[VMNAME]/start GET
66 '/sdvms/(.*)/stop', 'os_sdvm_stop', # http://localhost:8080/sdvms/[VMNAME]/stop GET
67 '/sdvms/(.*)', 'os_sdvm', # http://localhost:8080/sdvms/[VMNAME] GET, DELETE
68 '/setup', 'os_setup', # http://localhost:8080/setup GET
69 '/vms', 'os_vms', # http://localhost:8080/vms GET
70 '/vms/(.*)', 'os_vm', # http://localhost:8080/vms/[VMNAME] GET
71 '/update_template', 'os_update_template', # http://localhost:8080/update_template GET
72 '/terminate', 'os_terminate', # http://localhost:8080/terminate GET
73 '/', 'os_root' # http://localhost:8080/ GET
77 # ------------------------------------------------------------
80 # Global VMManager instance
87 # ------------------------------------------------------------
92 """OpenSecurity '/browsing' handler
94 - GET: Start and prepare a new SecurityVM for Internet Browsing. Return the name of the VM.
98 log_call(web.ctx.environ)
101 result = gvm_mgr.handleBrowsingRequest()
104 raise web.internalerror()
107 class os_fetch_image:
108 """OpenSecurity '/fetch_initial_image' handler
110 - GET: fetch the initial image from the X-Net Servers
111 The initial image is stored in the
112 Virtual Box default machine path.
113 The result to this call is a temprary file
114 which shows the progress (or error state)
120 log_call(web.ctx.environ)
123 trace_file_name = os.path.join(Environment('OpenSecurity').log_path, 'OpenSecurity_fetch_image.log')
124 trace_file = open(trace_file_name, 'w+')
126 machine_folder = Cygwin.cygPath(gvm_mgr.getMachineFolder())
127 download_initial_image_script = Cygwin.cygPath(os.path.abspath(os.path.join(os.path.split(__file__)[0], 'download_initial_image.sh')))
128 Cygwin.bashExecute('\\"' + download_initial_image_script + '\\" \'' + machine_folder + '\'', wait_return = False, stdout = trace_file, stderr = trace_file)
130 res = '{ "fetch_log": "' + trace_file_name.replace('\\', '\\\\') + '" }'
135 """OpenSecurity '/init' handler
137 - GET: Do initial import of OsecVM.ova
141 log_call(web.ctx.environ)
147 if gvm_mgr.vmRootName in gvm_mgr.listVM():
148 gvm_mgr.poweroffVM(gvm_mgr.vmRootName)
149 tmplateUUID = gvm_mgr.getTemplateUUID()
150 if tmplateUUID != None:
151 logger.debug('found parent uuid ' + tmplateUUID)
152 gvm_mgr.storageDetach(gvm_mgr.vmRootName)
153 gvm_mgr.removeSnapshots(tmplateUUID)
154 gvm_mgr.removeImage(tmplateUUID)
156 logger.debug('parent uuid not found')
157 gvm_mgr.removeVM(gvm_mgr.vmRootName)
159 trace_file_name = os.path.join(Environment('OpenSecurity').log_path, 'OpenSecurity_initial_import.log')
160 trace_file = open(trace_file_name, 'w+')
162 vm_image = Cygwin.cygPath(gvm_mgr.getMachineFolder()) + '/OsecVM.ova'
163 initial_import_script = Cygwin.cygPath(os.path.abspath(os.path.join(os.path.split(__file__)[0], 'initial_vm.sh')))
164 Cygwin.bashExecute('\\"' + initial_import_script + '\\" \'' + vm_image + '\'', wait_return = False, stdout = trace_file, stderr = trace_file)
166 res = '{ "init_log": "' + trace_file_name.replace('\\', '\\\\') + '" }'
170 class os_initial_image:
171 """OpenSecurity '/initial_image' handler
173 - GET: Return what we have as initial image.
177 log_call(web.ctx.environ)
179 t = os.path.join(gvm_mgr.systemProperties['Default machine folder'], 'OsecVM.ova')
181 if os.path.isfile(t):
182 res = '{"initial_template": { '
183 res += '"name": "OsecVM.ova", '
184 res += '"path": "' + t.replace('\\', '\\\\') + '", '
185 res += '"size": ' + str(os.path.getsize(t)) + ', '
186 res += '"date": ' + str(os.path.getmtime(t)) + ''
192 """OpenSecurity '/' handler
194 - GET: give information about current installation.
198 log_call(web.ctx.environ)
201 # create a json string and pretty print it
202 res = '{"os_server": { '
203 res += '"version": "' + opensecurity.__version__ + '" '
204 res += ', "virtual box systemproperties": ' + str(gvm_mgr.systemProperties).replace("'", '"')
205 res += ', "current temporary folder": "' + tempfile.gettempdir().replace('\\', '\\\\') + '"'
206 res += ', "current log folder": "' + Environment('OpenSecurity').log_path.replace('\\', '\\\\') + '"'
209 res += ', "whoami": "' + Cygwin.bashExecute('whoami')[1].strip() + '"'
211 res += ', "whoami": "FAILED"'
214 res += ', "mount": ' + str(Cygwin.bashExecute('mount')[1].split('\n')[:-1]).replace("'", '"')
216 res += ', "mount": "FAILED"'
219 res += ', "cygpath --windows ~": "' + Cygwin.bashExecute('cygpath --windows ~')[1].strip().replace('\\', '\\\\') + '"'
221 res += ', "cygpath --windows ~": "FAILED"'
224 res += ', "status message": "' + gvm_mgr.status_message.replace('"', "'") + '"'
228 # loading it into json and print it again ensures
229 # we really do have a valid RFC conform json string
230 # created (as long as the python json module is RFC conform)
231 return json.dumps(json.loads(res), indent = 4)
236 """OpenSecurity '/sdvms/[VM]' handler
238 - GET: Information about a specific SecurityVM
239 - DELETE: Remove a specific
243 log_call(web.ctx.environ)
245 return json.dumps(gvm_mgr.getVMInfo(name), indent = 4)
247 def DELETE(self, name):
248 log_call(web.ctx.environ)
250 return gvm_mgr.removeVM(name)
253 class os_sdvm_application:
254 """OpenSecurity '/sdvms/[VM]/application/[CMD]' handler
256 - GET: start application with given command in the VM.
259 def GET(self, name, command):
260 log_call(web.ctx.environ)
262 command = '/' + command
263 showTrayMessage('Launching application in isolated VM...', 7000)
264 result = Cygwin.sshExecuteX11(command, gvm_mgr.getHostOnlyIP(name), 'osecuser', Cygwin.cygPath(gvm_mgr.getMachineFolder()) + '/' + name + '/dvm_key' )
265 return 'Command ' + str(command) + ' started on VM "' + name + '" with IP ' + gvm_mgr.getHostOnlyIP(name)
269 """OpenSecurity '/sdvms/[VM]/ip' handler
271 - GET: give IP of SecurityVM.
275 log_call(web.ctx.environ)
277 return gvm_mgr.getHostOnlyIP(name)
281 """OpenSecurity '/sdvms/[VM]/start' handler
283 - GET: Start specific SecuirtyVM.
287 log_call(web.ctx.environ)
289 return gvm_mgr.startVM(name)
293 """OpenSecurity '/sdvms/[VM]/stop' handler
295 - GET: stop specific Secuirty VM.
299 log_call(web.ctx.environ)
301 return gvm_mgr.stopVM(name)
305 """OpenSecurity '/sdvms' handler
307 - GET: list all available secuirty VMs.
308 - POST: create new security vm.
312 """get the list of SDVMs"""
313 log_call(web.ctx.environ)
317 for sdvm in gvm_mgr.listSDVM():
318 d[sdvm] = gvm_mgr.getHostOnlyIP(sdvm)
320 return json.dumps(d, indent = 4)
323 """create a new SDVM"""
324 log_call(web.ctx.environ)
328 name = gvm_mgr.generateSDVMName()
330 gvm_mgr.createVM(name)
332 raise web.internalerror()
338 """OpenSecurity '/setup' handler
340 - GET: Give user some info how to setup the OpenSecurity environment
345 log_call(web.ctx.environ)
350 <h1>Setup OpenSecurity</h1>
351 In order to setup OpenSecurity an inital VM image has to be downloaded and imported:<br/>
353 <li>Download initial VM image: <a href="/fetch_initial_image">fetch_initial_image</a>
354 <li>Import initial VM: <a href="/init">init</a>
363 """OpenSecurity '/terminate' handler
365 - GET: terminate the opensecurityd.
367 TODO: need to find a better way doing this, and not via the
368 REST api. Maybe hack web.py server code?
372 log_call(web.ctx.environ)
381 class os_update_template:
382 """OpenSecurity '/update_template' handler
384 - GET: update template vm
388 #return gvm_mgr.guestExecute('SecurityDVM', 'sudo apt-get -y update')
390 log_call(web.ctx.environ)
391 return gvm_mgr.updateTemplate()
395 """OpenSecurity '/vms/[VM]' handler
397 - GET: list information of arbitrary VM.
401 log_call(web.ctx.environ)
403 return gvm_mgr.getVMInfo(name)
407 """OpenSecurity '/vms' handler
409 - GET: list all (also non Security) VMs.
413 log_call(web.ctx.environ)
415 return str(gvm_mgr.listVM()).replace("'",'"')
418 def log_call(web_environ):
419 """log the incoming call to the REST api"""
421 call = 'REST ' + web_environ['REQUEST_METHOD'] + ' ' + web_environ['REQUEST_URI'] + ' from ' + web_environ['REMOTE_ADDR'] + ':' + web_environ['REMOTE_PORT']
428 """main startup for the opensecuirityd"""
433 logger.debug('Starting OpenSecurity REST server')
435 # ensure a VMManger is yet loaded
436 gvm_mgr = vmmanager.VMManager.getInstance()
438 # tweak sys.argv to control wep.py server start behavior
439 sys.argv = [__file__, "8080"]
440 server = web.application(opensecurity_urls, globals(), autoreload = False)
443 logger.debug('Stopped OpenSecurity REST server')
447 """stop the opensecuirityd"""
449 # calling sys.exit() raises a SystemExit exception
450 # of the WSGI Server to let it wind down
455 if __name__ == "__main__":