def _showBulk(self):
self._bulk_nl_cnt = 0
self._bulk_in_cnt = 0
found = False
GRAY_COLOR = 1
RED_COLOR = 3
treeWordsTries = TreeWordsTries()
if self._connected:
image, wrapped = self._scr.getCookedImage() # Get the image
self._gui.setLineWrapped(wrapped)
screen_lines = self.dump_all_screen()
for c, f in self._lasted_highlighted:
self._scr.setBackgroundColor(c, f, 0)
image, wrapped = self._scr.getCookedImage() # Get the image
self._gui.setLineWrapped(wrapped)
self._lasted_highlighted = []
for y_position in xrange(len(screen_lines)):
l = screen_lines[y_position]
c_letters = 0
for w in l.split(' '):
if not w:
c_letters += 1
continue
n_w, deleted_begin, deleted_end = self.__clean_word(w)
wordsFound = treeWordsTries.isInTries(n_w)
if wordsFound:
comienzo = [c_letters + deleted_begin, y_position]
fin = [c_letters + deleted_begin + len(n_w) -1, y_position]
self._lasted_highlighted.append((comienzo, fin))
self._scr.setBackgroundColor(comienzo, fin, RED_COLOR)
found = True
c_letters += len(w)+1
if found:
image, wrapped = self._scr.getCookedImage() # Get the image
self._gui.setLineWrapped(wrapped)
self._gui.setImage(image, self._scr.lines, self._scr.columns) # Actual refresh
self._gui.setCursorPos(self._scr.getCursorX(), self._scr.getCursorY())
# FIXME: Check that we do not trigger other draw event here
self._gui.setScroll(self._scr.hist_cursor, self._scr.getHistLines())
#print "about to emit processOutput signal inside _showBulk"
#buf = self.getLastOutputFromScreenImage(1)
#print "buf = ", buf
#self.myemit('processOutput', (buf,)) # signal to pass it to plugins
self.updateLastCursorPos()
self.updateLastCursorPos(True, 1)
def __init__(self, security_manager, mappers_manager):
threading.Thread.__init__(self)
self.__sec = security_manager
self.mappers_manager = mappers_manager
# set as daemon
self.setDaemon(True)
#TODO: think of a good way to handle cross reference between hosts and
#categories
self._categories = {}
self._categories[CONF.getDefaultCategory()] = []
# dictionary with host ids as key
self._hosts = None
# flag to stop daemon thread
self._stop = False
# locks needed to make model thread-safe
self._hosts_lock = threading.RLock()
#TODO: check if it is better using collections.deque
# a performance analysis should be done
# http://docs.python.org/library/collections.html#collections.deque
# the actions queue
self._pending_actions = Queue.Queue()
# a reference to the ModelObjectFactory
self._object_factory = model.common.factory
self._registerObjectTypes()
# sync api request flag. This flag is used to let the model know
# there's some other object trying to use a sync api, and it should
# give priority to that and stop processing the queue
self._sync_api_request = False
# This flag & lock are used when the complete model is being persisted
self._saving_model_flag = False
self._saving_model_lock = threading.RLock()
self._actionDispatcher = None
self._setupActionDispatcher()
self.objects_with_updates = []
#used to highligthing
self.treeWordsTries = TreeWordsTries()
def createIndex(self, hosts):
self.treeWordsTries = TreeWordsTries()
self.treeWordsTries.clear()
for k in hosts.keys():
h = hosts[k]
self.treeWordsTries.addWord(h.getName())
for intr in h.getAllInterfaces():
ipv4 = intr.ipv4
ipv6 = intr.ipv6
if not ipv4['address'] in ["0.0.0.0", None]:
self.treeWordsTries.addWord(ipv4['address'])
if not ipv6['address'] in [
"0000:0000:0000:0000:0000:0000:0000:0000", None
]:
self.treeWordsTries.addWord(ipv6['address'])
for hostname in intr.getHostnames():
self.treeWordsTries.addWord(hostname)
def __init__(self, security_manager, mappers_manager):
threading.Thread.__init__(self)
self.__sec = security_manager
self.mappers_manager = mappers_manager
# set as daemon
self.setDaemon(True)
#TODO: think of a good way to handle cross reference between hosts and
#categories
self._categories = {}
self._categories[CONF.getDefaultCategory()] = []
# dictionary with host ids as key
self._hosts = None
# flag to stop daemon thread
self._stop = False
# locks needed to make model thread-safe
self._hosts_lock = threading.RLock()
#TODO: check if it is better using collections.deque
# a performance analysis should be done
# http://docs.python.org/library/collections.html#collections.deque
# the actions queue
self._pending_actions = Queue.Queue()
# a reference to the ModelObjectFactory
self._object_factory = model.common.factory
self._registerObjectTypes()
# sync api request flag. This flag is used to let the model know
# there's some other object trying to use a sync api, and it should
# give priority to that and stop processing the queue
self._sync_api_request = False
# This flag & lock are used when the complete model is being persisted
self._saving_model_flag = False
self._saving_model_lock = threading.RLock()
self._actionDispatcher = None
self._setupActionDispatcher()
self.objects_with_updates = []
#used to highligthing
self.treeWordsTries = TreeWordsTries()
def createIndex(self, hosts):
self.treeWordsTries = TreeWordsTries()
self.treeWordsTries.clear()
for k in hosts.keys():
h = hosts[k]
self.treeWordsTries.addWord(h.getName())
for intr in h.getAllInterfaces():
ipv4 = intr.ipv4
ipv6 = intr.ipv6
if not ipv4['address'] in ["0.0.0.0", None]:
self.treeWordsTries.addWord(ipv4['address'])
if not ipv6['address'] in ["0000:0000:0000:0000:0000:0000:0000:0000", None]:
self.treeWordsTries.addWord(ipv6['address'])
for hostname in intr.getHostnames():
self.treeWordsTries.addWord(hostname)
def _showBulk(self):
self._bulk_nl_cnt = 0
self._bulk_in_cnt = 0
found = False
GRAY_COLOR = 1
RED_COLOR = 3
treeWordsTries = TreeWordsTries()
if self._connected:
image, wrapped = self._scr.getCookedImage() # Get the image
self._gui.setLineWrapped(wrapped)
screen_lines = self.dump_all_screen()
for c, f in self._lasted_highlighted:
self._scr.setBackgroundColor(c, f, 0)
image, wrapped = self._scr.getCookedImage() # Get the image
self._gui.setLineWrapped(wrapped)
self._lasted_highlighted = []
for y_position in xrange(len(screen_lines)):
l = screen_lines[y_position]
c_letters = 0
for w in l.split(' '):
if not w:
c_letters += 1
continue
n_w, deleted_begin, deleted_end = self.__clean_word(w)
wordsFound = treeWordsTries.isInTries(n_w)
if wordsFound:
comienzo = [c_letters + deleted_begin, y_position]
fin = [
c_letters + deleted_begin + len(n_w) - 1,
y_position
]
self._lasted_highlighted.append((comienzo, fin))
self._scr.setBackgroundColor(comienzo, fin, RED_COLOR)
found = True
c_letters += len(w) + 1
if found:
image, wrapped = self._scr.getCookedImage() # Get the image
self._gui.setLineWrapped(wrapped)
self._gui.setImage(image, self._scr.lines,
self._scr.columns) # Actual refresh
self._gui.setCursorPos(self._scr.getCursorX(),
self._scr.getCursorY())
# FIXME: Check that we do not trigger other draw event here
self._gui.setScroll(self._scr.hist_cursor,
self._scr.getHistLines())
#print "about to emit processOutput signal inside _showBulk"
#buf = self.getLastOutputFromScreenImage(1)
#print "buf = ", buf
#self.myemit('processOutput', (buf,)) # signal to pass it to plugins
self.updateLastCursorPos()
self.updateLastCursorPos(True, 1)
def onDoubleClick(self, start_word_xy, end_word_xy):
word = self._getWordOnPosition(start_word_xy, end_word_xy)
treeWordsTries = TreeWordsTries()
self._gui.select_on_tree(word)
class ModelController(threading.Thread):
def __init__(self, mappers_manager):
threading.Thread.__init__(self)
self.mappers_manager = mappers_manager
# set as daemon
self.setDaemon(True)
# flag to stop daemon thread
self._stop = False
# locks needed to make model thread-safe
self._hosts_lock = threading.RLock()
# count of plugins sending actions
self.active_plugins_count = 0
self.active_plugins_count_lock = threading.RLock()
#TODO: check if it is better using collections.deque
# a performance analysis should be done
# http://docs.python.org/library/collections.html#collections.deque
# the actions queue
self._pending_actions = Queue.Queue()
# a reference to the ModelObjectFactory
self._object_factory = model.common.factory
self._registerObjectTypes()
# sync api request flag. This flag is used to let the model know
# there's some other object trying to use a sync api, and it should
# give priority to that and stop processing the queue
self._sync_api_request = False
# This flag & lock are used when the complete model is being persisted
self._saving_model_flag = False
self._saving_model_lock = threading.RLock()
self._actionDispatcher = None
self._setupActionDispatcher()
self.objects_with_updates = []
#used to highligthing
self.treeWordsTries = TreeWordsTries()
def __getattr__(self, name):
getLogger(self).debug("ModelObject attribute to refactor: %s" % name)
def __acquire_host_lock(self):
self._saving_model_lock.acquire()
self._saving_model_lock.release()
self._hosts_lock.acquire()
def __release_host_lock(self):
try:
self._hosts_lock.release()
except RuntimeError:
pass
def _registerObjectTypes(self):
"""
Registers in the factory all object types that can be created
"""
# This could be done in hosts module, but it seems easier to maintain
# if we have all in one place inside the controller
self._object_factory.register(model.hosts.Host)
self._object_factory.register(model.hosts.Interface)
self._object_factory.register(model.hosts.Service)
self._object_factory.register(model.hosts.HostApplication)
self._object_factory.register(model.common.ModelObjectVuln)
self._object_factory.register(model.common.ModelObjectVulnWeb)
self._object_factory.register(model.common.ModelObjectNote)
self._object_factory.register(model.common.ModelObjectCred)
def _setupActionDispatcher(self):
self._actionDispatcher = {
modelactions.ADDHOST: self.__add,
modelactions.DELHOST: self.__del,
modelactions.EDITHOST: self.__edit,
modelactions.ADDINTERFACE: self.__add,
modelactions.DELINTERFACE: self.__del,
modelactions.EDITINTERFACE: self.__edit,
modelactions.ADDSERVICEINT: self.__add,
modelactions.DELSERVICEINT: self.__del,
modelactions.EDITSERVICE: self.__edit,
#Vulnerability
modelactions.ADDVULNINT: self.__add,
modelactions.DELVULNINT: self.__del,
modelactions.ADDVULNHOST: self.__add,
modelactions.DELVULNHOST: self.__del,
modelactions.ADDVULNSRV: self.__add,
modelactions.DELVULNSRV: self.__del,
modelactions.ADDVULN: self.__add,
modelactions.DELVULN: self.__del,
modelactions.ADDVULNWEBSRV: self.__add,
modelactions.EDITVULN: self.__edit,
#Note
modelactions.ADDNOTEINT: self.__add,
modelactions.DELNOTEINT: self.__del,
modelactions.ADDNOTEHOST: self.__add,
modelactions.DELNOTEHOST: self.__del,
modelactions.ADDNOTESRV: self.__add,
modelactions.DELNOTESRV: self.__del,
modelactions.ADDNOTEVULN: self.__add,
modelactions.ADDNOTE: self.__add,
modelactions.DELNOTE: self.__del,
modelactions.ADDCREDSRV: self.__add,
modelactions.DELCREDSRV: self.__del,
modelactions.ADDNOTENOTE: self.__add,
modelactions.EDITNOTE: self.__edit,
modelactions.EDITCRED: self.__edit,
modelactions.ADDCRED: self.__add,
modelactions.DELCRED: self.__del,
# Plugin states
modelactions.PLUGINSTART: self._pluginStart,
modelactions.PLUGINEND: self._pluginEnd
}
def run(self):
return self._main()
def stop(self):
"""
Sets the flag to stop daemon
"""
self._stop = True
def _dispatchActionWithLock(self, action_callback, *args):
res = False
self.__acquire_host_lock()
try:
res = action_callback(*args)
except Exception:
api.log(
"An exception occurred while dispatching an action (%r(%r)\n%s"
% (action_callback, args, traceback.format_exc()), "ERROR")
finally:
self.__release_host_lock()
return res
def _processAction(self, action, parameters, sync=False):
"""
decodes and performs the action given
It works kind of a dispatcher
"""
if sync:
self._sync_api_request = True
api.devlog("_processAction - %s - parameters = %s" %
(action, str(parameters)))
action_callback = self._actionDispatcher[action]
res = self._dispatchActionWithLock(action_callback, *parameters)
# finally we notify the widgets about this change
#if res: # notify only if action was done successfuly
#self._notifyModelUpdated(*parameters)
#else:
if not res:
api.devlog("Action code %d failed. Parameters = %s" %
(action, str(parameters)))
if sync:
self._sync_api_request = False
def getConflicts(self):
conflicts = []
for obj in self.objects_with_updates:
conflicts += obj.getUpdates()
return conflicts
def resolveConflicts(self):
notifier.conflictResolution(self.getConflicts())
def resolveConflict(self, conflict, kwargs):
if self.__edit(conflict.getFirstObject(), **kwargs):
conflict.getFirstObject().updateResolved(conflict)
if conflict.getModelObjectType() == "Interface":
ipv4 = kwargs['ipv4']
ipv6 = kwargs['ipv6']
hostnames = kwargs['hostnames']
if not ipv4['address'] in ["0.0.0.0", None]:
self.treeWordsTries.removeWord(ipv4['address'])
self.treeWordsTries.addWord(ipv4['address'])
if not ipv6['address'] in [
"0000:0000:0000:0000:0000:0000:0000:0000", None
]:
self.treeWordsTries.removeWord(ipv6['address'])
self.treeWordsTries.addWord(ipv6['address'])
for h in hostnames:
if h is not None:
self.treeWordsTries.removeWord(h)
self.treeWordsTries.addWord(h)
notifier.conflictUpdate(-1)
#notifier.editHost(conflict.getFirstObject().getHost())
#self._notifyModelUpdated()
def removeConflictsByObject(self, obj):
if obj in self.objects_with_updates:
self.objects_with_updates.remove(obj)
notifier.conflictUpdate(-len(obj.getUpdates()))
def setSavingModel(self, value):
api.devlog("setSavingModel: %s" % value)
self._saving_model_flag = value
if value:
self._saving_model_lock.acquire()
else:
try:
self._saving_model_lock.release()
except RuntimeError:
pass
def _main(self):
"""
The main method for the thread.
The controller will be constantly checking a queue
to see if new actions were added.
This will make host addition and removal "thread-safe" and will
avoid locking components that need to interact with the model
"""
while True:
# check if thread must finish
# no plugin should be active to stop the controller
if self._stop and self.active_plugins_count == 0:
break
# first we check if there is a sync api request
# or if the model is being saved/sync'ed
# or if we have pending duplicated hosts that need to be
# merged by the userget
if not self._sync_api_request and not self._saving_model_flag:
self.processAction()
else:
# there is some object requesting for a sync api so we
# sleep the thread execution for a moment to let others work
# XXX: check if this time is not too much...
time.sleep(0.01)
def processAllPendingActions(self):
[self.processAction() for i in range(self._pending_actions.qsize())]
def processAction(self):
# check the queue for new actions
# if there is no new action it will block until timeout is reached
try:
# get new action or timeout (in secs)
#TODO: timeout should be set through config
current_action = self._pending_actions.get(timeout=2)
action = current_action[0]
parameters = current_action[1:]
# dispatch the action
self._processAction(action, parameters)
except Queue.Empty:
# if timeout was reached, just let the daemon run again
# this is done just to be able to test the stop flag
# because if we don't do it, the daemon will be blocked forever
pass
except Exception:
getLogger(self).debug(
"something strange happened... unhandled exception?")
getLogger(self).debug(traceback.format_exc())
def sync_lock(self):
self._sync_api_request = True
self.__acquire_host_lock()
def sync_unlock(self):
self._sync_api_request = False
self.__release_host_lock()
# TODO: >>> APIs <<< we have to know which plugin called the apis to store
# in the history
def __addPendingAction(self, *args):
"""
Adds a new pending action to the queue
Action is build with generic args tuple.
The caller of this function has to build the action in the right
way since no checks are preformed over args
"""
new_action = args
self._pending_actions.put(new_action)
def addUpdate(self, old_object, new_object):
# Returns True if the update was resolved without user interaction
res = True
try:
mergeAction = old_object.addUpdate(new_object)
if mergeAction:
if old_object not in self.objects_with_updates:
self.objects_with_updates.append(old_object)
notifier.conflictUpdate(1)
res = False
except:
res = False
api.devlog("(%s).addUpdate(%s, %s) - failed" %
(self, old_object, new_object))
return res
def find(self, obj_id):
return self.mappers_manager.find(obj_id)
def addHostASYNC(self,
host,
category=None,
update=False,
old_hostname=None):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
new host must be added to the model
"""
self.__addPendingAction(modelactions.ADDHOST, host, category, update,
old_hostname)
def addHostSYNC(self,
host,
category=None,
update=False,
old_hostname=None):
"""
SYNC API
Adds a host directly to the model
"""
self._processAction(modelactions.ADDHOST, [host, None], sync=True)
def __add(self, obj, parent_id=None, *args):
dataMapper = self.mappers_manager.getMapper(obj.class_signature)
old_obj = dataMapper.find(obj.getID())
if old_obj:
if not old_obj.needs_merge(obj):
# the object is exactly the same,
# so return and do nothing
return True
if not self.addUpdate(old_obj, obj):
return False
dataMapper.save(old_obj)
notifier.editHost(old_obj.getHost())
else:
object_parent = self.mappers_manager.find(parent_id)
if object_parent:
object_parent.addChild(obj)
# we have to make sure that certain objects have to have a parent
if (obj.class_signature in [
model.hosts.Interface.class_signature,
model.hosts.Service.class_signature,
model.common.ModelObjectNote.class_signature,
model.common.ModelObjectVuln.class_signature,
model.common.ModelObjectVulnWeb.class_signature,
model.common.ModelObjectCred.class_signature
] and object_parent is None):
# TODO: refactor log module. We need to log twice to see it in
# qt and in the terminal. Ugly.
msg = "A parent is needed for %s objects" % obj.class_signature
getLogger(self).error(msg)
return False
dataMapper.save(obj)
self.treeWordsTries.addWord(obj.getName())
if obj.class_signature == model.hosts.Host.class_signature:
notifier.addHost(obj)
else:
notifier.editHost(obj.getHost())
return True
def __edit(self, obj, *args, **kwargs):
dataMapper = self.mappers_manager.getMapper(obj.class_signature)
obj.updateAttributes(*args, **kwargs)
dataMapper.save(obj)
# self.treeWordsTries.addWord(obj.getName())
if obj.class_signature == model.hosts.Host.class_signature:
notifier.editHost(obj)
else:
notifier.editHost(obj.getHost())
return True
def __del(self, objId, *args):
obj = self.mappers_manager.find(objId)
if obj:
obj_parent = obj.getParent()
if obj_parent:
obj_parent.deleteChild(objId)
if obj.getName():
self.treeWordsTries.removeWord(obj.getName())
self.removeConflictsByObject(obj)
self.mappers_manager.remove(objId)
if obj.class_signature == model.hosts.Host.class_signature:
notifier.delHost(objId)
else:
notifier.editHost(obj.getHost())
return True
return False
def delHostASYNC(self, hostId):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
particular host must be removed from the model
"""
self.__addPendingAction(modelactions.DELHOST, hostId)
def delHostSYNC(self, hostId):
"""
SYNC API
Deletes a host from model
"""
self._processAction(modelactions.DELHOST, [hostId], sync=True)
def editHostSYNC(self, host, name, description, os, owned):
"""
SYNC API
Modifies a host from model
"""
self._processAction(modelactions.EDITHOST,
[host, name, description, os, owned],
sync=True)
def addInterfaceASYNC(self, hostid, interface, update=False):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
new interface must be added to a specific host
"""
self.__addPendingAction(modelactions.ADDINTERFACE, interface, hostid)
def addInterfaceSYNC(self, hostId, interface, update=False):
"""
SYNC API
Adds interface directly to the model
"""
self._processAction(modelactions.ADDINTERFACE, [interface, hostId],
sync=True)
def delInterfaceASYNC(self, hostId, interfaceId):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
particular host must be removed from the model
"""
self.__addPendingAction(modelactions.DELINTERFACE, interfaceId, hostId)
def delInterfaceSYNC(self, host, interface_id, *args):
"""
SYNC API
Deletes an interface from model
"""
self._processAction(modelactions.DELINTERFACE, [interface_id],
sync=True)
def editInterfaceSYNC(self, interface, name, description, hostnames, mac,
ipv4, ipv6, network_segment, amount_ports_opened,
amount_ports_closed, amount_ports_filtered, owned):
"""
SYNC API
Modifies an interface from model
"""
self._processAction(modelactions.EDITINTERFACE, [
interface, name, description, hostnames, mac, ipv4, ipv6,
network_segment, amount_ports_opened, amount_ports_closed,
amount_ports_filtered, owned
],
sync=True)
def addServiceToInterfaceASYNC(self, host, interfaceId, newService):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
new services must be added to a specific host in a specific interface
"""
self.__addPendingAction(modelactions.ADDSERVICEINT, newService,
interfaceId)
def addServiceToInterfaceSYNC(self, host_id, interface_id, newService):
"""
SYNC API
Adds a service to a specific host in a specific interface
directly to the model
"""
self._processAction(modelactions.ADDSERVICEINT,
[newService, interface_id],
sync=True)
def delServiceFromInterfaceASYNC(self, host, interfaceId, serviceId):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
particular service in a host and interface must be removed from the
model Interface parameter can be "ALL"
"""
self.__addPendingAction(modelactions.DELSERVICEINT, serviceId,
interfaceId)
def delServiceFromInterfaceSYNC(self, host, interfaceId, serviceId):
"""
SYNC API
Delete a service in a host and interface from the model
"""
self._processAction(modelactions.DELSERVICEINT, [serviceId], sync=True)
def delServiceFromApplicationASYNC(self, host, appname, service):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
particular service in a host and interface must be removed from the model
appname parameter can be "ALL"
"""
self.__addPendingAction(modelactions.DELSERVICEAPP, host, appname,
service)
def delServiceFromApplicationSYNC(self, host, appname, service):
"""
SYNC API
Delete a service in a host and application from the model
"""
self._processAction(modelactions.DELSERVICEAPP,
[host, appname, service],
sync=True)
def editServiceSYNC(self, service, name, description, protocol, ports,
status, version, owned):
"""
SYNC API
Modifies a host from model
"""
self._processAction(modelactions.EDITSERVICE, [
service, name, description, protocol, ports, status, version, owned
],
sync=True)
def editServiceASYNC(self, service, name, description, protocol, ports,
status, version, owned):
"""
ASYNC API
Modifies a service from model
"""
self.__addPendingAction(modelactions.EDITSERVICE, service, name,
description, protocol, ports, status, version,
owned)
def __editService(self,
service,
name=None,
description=None,
protocol=None,
ports=None,
status=None,
version=None,
owned=None):
res = False
if service is not None:
service.updateAttributes(name, description, protocol, ports,
status, version, owned)
notifier.editHost(service.getHost())
res = True
return res
def addPluginStart(self, name):
self.__addPendingAction(modelactions.PLUGINSTART, name)
def addPluginEnd(self, name):
self.__addPendingAction(modelactions.PLUGINEND, name)
def _pluginStart(self, name):
self.active_plugins_count_lock.acquire()
getLogger(self).info("Plugin Started: " + name)
self.active_plugins_count += 1
self.active_plugins_count_lock.release()
return True
def _pluginEnd(self, name):
self.active_plugins_count_lock.acquire()
getLogger(self).info("Plugin Ended: " + name)
self.active_plugins_count -= 1
self.active_plugins_count_lock.release()
return True
def addVulnToInterfaceASYNC(self, host, intId, newVuln):
self.__addPendingAction(modelactions.ADDVULNINT, newVuln, intId)
def addVulnToInterfaceSYNC(self, host, intId, newVuln):
self._processAction(modelactions.ADDVULNINT, [newVuln, intId],
sync=True)
def addVulnToApplicationASYNC(self, host, appname, newVuln):
self.__addPendingAction(modelactions.ADDVULNAPP, host, appname,
newVuln)
def addVulnToApplicationSYNC(self, host, appname, newVuln):
self._processAction(modelactions.ADDVULNAPP, [host, appname, newVuln],
sync=True)
def addVulnToHostASYNC(self, hostId, newVuln):
self.__addPendingAction(modelactions.ADDVULNHOST, newVuln, hostId)
def addVulnToHostSYNC(self, hostId, newVuln):
self._processAction(modelactions.ADDVULNHOST, [newVuln, hostId],
sync=True)
def addVulnToServiceASYNC(self, host, srvId, newVuln):
self.__addPendingAction(modelactions.ADDVULNSRV, newVuln, srvId)
def addVulnToServiceSYNC(self, host, srvId, newVuln):
self._processAction(modelactions.ADDVULNSRV, [newVuln, srvId],
sync=True)
def addVulnSYNC(self, modelObjectId, newVuln):
self._processAction(modelactions.ADDVULN, [newVuln, modelObjectId],
sync=True)
def addVulnWebToServiceASYNC(self, host, srvId, newVuln):
self.__addPendingAction(modelactions.ADDVULNWEBSRV, newVuln, srvId)
def addVulnWebToServiceSYNC(self, host, srvId, newVuln):
self._processAction(modelactions.ADDVULNWEBSRV, [newVuln, srvId],
sync=True)
def delVulnFromApplicationASYNC(self, hostname, appname, vuln):
self.__addPendingAction(modelactions.DELVULNAPP, hostname, appname,
vuln)
def delVulnFromApplicationSYNC(self, hostname, appname, vuln):
self._processAction(modelactions.DELVULNAPP, [hostname, appname, vuln],
sync=True)
def delVulnFromInterfaceASYNC(self, hostname, intname, vuln):
self.__addPendingAction(modelactions.DELVULNINT, hostname, intname,
vuln)
def delVulnFromInterfaceSYNC(self, hostname, intname, vuln):
self._processAction(modelactions.DELVULNINT, [hostname, intname, vuln],
sync=True)
def delVulnFromHostASYNC(self, hostId, vulnId):
self.__addPendingAction(modelactions.DELVULNHOST, vulnId)
def delVulnFromHostSYNC(self, hostname, vulnId):
self._processAction(modelactions.DELVULNHOST, [vulnId], sync=True)
def delVulnFromServiceASYNC(self, hostname, srvname, vulnId):
self.__addPendingAction(modelactions.DELVULNSRV, vulnId)
def delVulnFromServiceSYNC(self, hostname, srvname, vulnId):
self._processAction(modelactions.DELVULNSRV, [vulnId], sync=True)
def delVulnSYNC(self, model_object, vuln_id):
self._processAction(modelactions.DELVULN, [vuln_id], sync=True)
def editVulnSYNC(self, vuln, name, desc, severity, resolution, refs):
self._processAction(modelactions.EDITVULN,
[vuln, name, desc, severity, resolution, refs],
sync=True)
def editVulnASYNC(self, vuln, name, desc, severity, resolution, refs):
self.__addPendingAction(modelactions.EDITVULN, vuln, name, desc,
severity, resolution, refs)
def editVulnWebSYNC(self, vuln, name, desc, website, path, refs, severity,
resolution, request, response, method, pname, params,
query, category):
self._processAction(modelactions.EDITVULN, [
vuln, name, desc, website, path, refs, severity, resolution,
request, response, method, pname, params, query, category
],
sync=True)
def editVulnWebASYNC(self, vuln, name, desc, website, path, refs, severity,
resolution, request, response, method, pname, params,
query, category):
self.__addPendingAction(modelactions.EDITVULN, vuln, name, desc,
website, path, refs, severity, resolution,
request, response, method, pname, params,
query, category)
# Note
def addNoteToInterfaceASYNC(self, host, intId, newNote):
self.__addPendingAction(modelactions.ADDNOTEINT, newNote, intId)
def addNoteToInterfaceSYNC(self, host, intId, newNote):
self._processAction(modelactions.ADDNOTEINT, [newNote, intId],
sync=True)
def addNoteToApplicationASYNC(self, host, appname, newNote):
self.__addPendingAction(modelactions.ADDNOTEAPP, host, appname,
newNote)
def addNoteToApplicationSYNC(self, host, appname, newNote):
self._processAction(modelactions.ADDNOTEAPP, [host, appname, newNote],
sync=True)
def addNoteToHostASYNC(self, hostId, newNote):
self.__addPendingAction(modelactions.ADDNOTEHOST, newNote, hostId)
def addNoteToHostSYNC(self, hostId, newNote):
self._processAction(modelactions.ADDNOTEHOST, [newNote, hostId],
sync=True)
def addNoteToServiceASYNC(self, host, srvId, newNote):
self.__addPendingAction(modelactions.ADDNOTESRV, newNote, srvId)
def addNoteToNoteASYNC(self, host, srvname, note_id, newNote):
self.__addPendingAction(modelactions.ADDNOTENOTE, newNote, note_id)
def addNoteToNoteSYNC(self, noteId, newNote):
self._processAction(modelactions.ADDNOTENOTE, [newNote, noteId],
sync=True)
def addNoteToServiceSYNC(self, host, srvId, newNote):
self._processAction(modelactions.ADDNOTESRV, [newNote, srvId],
sync=True)
def addNoteSYNC(self, model_object, newNote):
self._processAction(modelactions.ADDNOTE, [newNote, model_object],
sync=True)
def delNoteFromApplicationASYNC(self, hostname, appname, note):
self.__addPendingAction(modelactions.DELNOTEAPP, hostname, appname,
note)
def delNoteFromApplicationSYNC(self, hostname, appname, note):
self._processAction(modelactions.DELNOTEAPP, [hostname, appname, note],
sync=True)
def delNoteFromInterfaceASYNC(self, hostname, intname, noteId):
self.__addPendingAction(modelactions.DELNOTEINT, noteId)
def delNoteFromInterfaceSYNC(self, hostname, intname, noteId):
self._processAction(modelactions.DELNOTEINT, [noteId], sync=True)
def delNoteFromHostASYNC(self, hostId, noteId):
self.__addPendingAction(modelactions.DELNOTEHOST, noteId)
def delNoteFromHostSYNC(self, hostname, noteId):
self._processAction(modelactions.DELNOTEHOST, [noteId], sync=True)
def delNoteFromServiceASYNC(self, hostId, srvId, noteId):
self.__addPendingAction(modelactions.DELNOTESRV, noteId)
def delNoteFromServiceSYNC(self, hostname, srvname, noteId):
self._processAction(modelactions.DELNOTESRV, [noteId], sync=True)
def delNoteSYNC(self, model_object, note_id):
self._processAction(modelactions.DELNOTE, [note_id], sync=True)
def addCredToServiceASYNC(self, host, srvId, newCred):
self.__addPendingAction(modelactions.ADDCREDSRV, newCred, srvId)
def addCredToServiceSYNC(self, host, srvId, newCred):
self._processAction(modelactions.ADDCREDSRV, [newCred, srvId],
sync=True)
def delCredFromServiceASYNC(self, hostname, srvname, credId):
self.__addPendingAction(modelactions.DELCREDSRV, credId)
def delCredFromServiceSYNC(self, hostname, srvname, credId):
self._processAction(modelactions.DELCREDSRV, [credId], sync=True)
def editNoteSYNC(self, note, name, text):
self._processAction(modelactions.EDITNOTE, [note, name, text],
sync=True)
def editNoteASYNC(self, note, name, text):
self.__addPendingAction(modelactions.EDITNOTE, note, name, text)
def editCredSYNC(self, cred, username, password):
self._processAction(modelactions.EDITCRED, [cred, username, password],
sync=True)
def editCredASYNC(self, cred, username, password):
self.__addPendingAction(modelactions.EDITCRED, cred, username,
password)
def addCredSYNC(self, model_object_id, newCred):
self._processAction(modelactions.ADDCRED, [newCred, model_object_id],
sync=True)
def delCredSYNC(self, model_object, cred_id):
self._processAction(modelactions.DELCRED, [cred_id], sync=True)
def newHost(self, name, os="Unknown"):
return model.common.factory.createModelObject(
model.hosts.Host.class_signature, name, os=os, parent_id=None)
def newInterface(self,
name,
mac="00:00:00:00:00:00",
ipv4_address="0.0.0.0",
ipv4_mask="0.0.0.0",
ipv4_gateway="0.0.0.0",
ipv4_dns=[],
ipv6_address="0000:0000:0000:0000:0000:0000:0000:0000",
ipv6_prefix="00",
ipv6_gateway="0000:0000:0000:0000:0000:0000:0000:0000",
ipv6_dns=[],
network_segment="",
hostname_resolution=[],
parent_id=None):
return model.common.factory.createModelObject(
model.hosts.Interface.class_signature,
name,
mac=mac,
ipv4_address=ipv4_address,
ipv4_mask=ipv4_mask,
ipv4_gateway=ipv4_gateway,
ipv4_dns=ipv4_dns,
ipv6_address=ipv6_address,
ipv6_prefix=ipv6_prefix,
ipv6_gateway=ipv6_gateway,
ipv6_dns=ipv6_dns,
network_segment=network_segment,
hostname_resolution=hostname_resolution,
parent_id=parent_id)
def newService(self,
name,
protocol="tcp?",
ports=[],
status="running",
version="unknown",
description="",
parent_id=None):
return model.common.factory.createModelObject(
model.hosts.Service.class_signature,
name,
protocol=protocol,
ports=ports,
status=status,
version=version,
description=description,
parent_id=parent_id)
def newVuln(self,
name,
desc="",
ref=None,
severity="",
resolution="",
confirmed=False,
parent_id=None):
return model.common.factory.createModelObject(
model.common.ModelObjectVuln.class_signature,
name,
desc=desc,
ref=ref,
severity=severity,
resolution=resolution,
confirmed=confirmed,
parent_id=parent_id)
def newVulnWeb(self,
name,
desc="",
ref=None,
severity="",
resolution="",
website="",
path="",
request="",
response="",
method="",
pname="",
params="",
query="",
category="",
confirmed=False,
parent_id=None):
return model.common.factory.createModelObject(
model.common.ModelObjectVulnWeb.class_signature,
name,
desc=desc,
ref=ref,
severity=severity,
resolution=resolution,
website=website,
path=path,
request=request,
response=response,
method=method,
pname=pname,
params=params,
query=query,
category=category,
confirmed=confirmed,
parent_id=parent_id)
def newNote(self, name, text, parent_id=None):
return model.common.factory.createModelObject(
model.common.ModelObjectNote.class_signature,
name,
text=text,
parent_id=parent_id)
def newCred(self, username, password, parent_id=None):
return model.common.factory.createModelObject(
model.common.ModelObjectCred.class_signature,
username,
password=password,
parent_id=parent_id)
def getHost(self, name):
hosts_mapper = self.mappers_manager.getMapper(
model.hosts.Host.class_signature)
return hosts_mapper.find(name)
def getAllHosts(self):
hosts = self.mappers_manager.getMapper(
model.hosts.Host.class_signature).getAll()
return hosts
def getWebVulns(self):
return self.mappers_manager.getMapper(
model.common.ModelObjectVulnWeb.class_signature).getAll()
def createIndex(self, hosts):
self.treeWordsTries = TreeWordsTries()
self.treeWordsTries.clear()
for k in hosts.keys():
h = hosts[k]
self.treeWordsTries.addWord(h.getName())
for intr in h.getAllInterfaces():
ipv4 = intr.ipv4
ipv6 = intr.ipv6
if not ipv4['address'] in ["0.0.0.0", None]:
self.treeWordsTries.addWord(ipv4['address'])
if not ipv6['address'] in [
"0000:0000:0000:0000:0000:0000:0000:0000", None
]:
self.treeWordsTries.addWord(ipv6['address'])
for hostname in intr.getHostnames():
self.treeWordsTries.addWord(hostname)
def getHostsCount(self):
hosts = model.hosts.Host.class_signature
return self.mappers_manager.getMapper(hosts).getCount()
def getServicesCount(self):
services = model.hosts.Service.class_signature
return self.mappers_manager.getMapper(services).getCount()
def getVulnsCount(self):
vulns = model.common.ModelObjectVuln.class_signature
web_vulns = model.common.ModelObjectVulnWeb.class_signature
return (self.mappers_manager.getMapper(vulns).getCount() +
self.mappers_manager.getMapper(web_vulns).getCount())
class ModelController(threading.Thread):
def __init__(self, security_manager, mappers_manager):
threading.Thread.__init__(self)
self.__sec = security_manager
self.mappers_manager = mappers_manager
# set as daemon
self.setDaemon(True)
#TODO: think of a good way to handle cross reference between hosts and
#categories
self._categories = {}
self._categories[CONF.getDefaultCategory()] = []
# dictionary with host ids as key
self._hosts = None
# flag to stop daemon thread
self._stop = False
# locks needed to make model thread-safe
self._hosts_lock = threading.RLock()
#TODO: check if it is better using collections.deque
# a performance analysis should be done
# http://docs.python.org/library/collections.html#collections.deque
# the actions queue
self._pending_actions = Queue.Queue()
# a reference to the ModelObjectFactory
self._object_factory = model.common.factory
self._registerObjectTypes()
# sync api request flag. This flag is used to let the model know
# there's some other object trying to use a sync api, and it should
# give priority to that and stop processing the queue
self._sync_api_request = False
# This flag & lock are used when the complete model is being persisted
self._saving_model_flag = False
self._saving_model_lock = threading.RLock()
self._actionDispatcher = None
self._setupActionDispatcher()
self.objects_with_updates = []
#used to highligthing
self.treeWordsTries = TreeWordsTries()
def __getattr__(self, name):
getLogger(self).debug("ModelObject attribute to refactor: %s" % name)
def __acquire_host_lock(self):
self._saving_model_lock.acquire()
self._saving_model_lock.release()
self._hosts_lock.acquire()
def __release_host_lock(self):
try:
self._hosts_lock.release()
except RuntimeError:
pass
def _registerObjectTypes(self):
"""
Registers in the factory all object types that can be created
"""
# This could be done in hosts module, but it seems easier to maintain
# if we have all in one place inside the controller
self._object_factory.register(model.hosts.Host)
self._object_factory.register(model.hosts.Interface)
self._object_factory.register(model.hosts.Service)
self._object_factory.register(model.hosts.HostApplication)
self._object_factory.register(model.common.ModelObjectVuln)
self._object_factory.register(model.common.ModelObjectVulnWeb)
self._object_factory.register(model.common.ModelObjectNote)
self._object_factory.register(model.common.ModelObjectCred)
def _setupActionDispatcher(self):
self._actionDispatcher = {
modelactions.ADDHOST: self.__add,
modelactions.DELHOST: self.__del,
modelactions.EDITHOST: self.__edit,
modelactions.ADDINTERFACE: self.__add,
modelactions.DELINTERFACE: self.__del,
modelactions.EDITINTERFACE: self.__edit,
modelactions.ADDSERVICEINT: self.__add,
modelactions.DELSERVICEINT: self.__del,
modelactions.EDITSERVICE: self.__edit,
#Vulnerability
modelactions.ADDVULNINT: self.__add,
modelactions.DELVULNINT: self.__del,
modelactions.ADDVULNHOST: self.__add,
modelactions.DELVULNHOST: self.__del,
modelactions.ADDVULNSRV: self.__add,
modelactions.DELVULNSRV: self.__del,
modelactions.ADDVULN: self.__add,
modelactions.DELVULN: self.__del,
modelactions.ADDVULNWEBSRV: self.__add,
modelactions.EDITVULN: self.__edit,
#Note
modelactions.ADDNOTEINT: self.__add,
modelactions.DELNOTEINT: self.__del,
modelactions.ADDNOTEHOST: self.__add,
modelactions.DELNOTEHOST: self.__del,
modelactions.ADDNOTESRV: self.__add,
modelactions.DELNOTESRV: self.__del,
modelactions.ADDNOTEVULN: self.__add,
modelactions.ADDNOTE: self.__add,
modelactions.DELNOTE: self.__del,
modelactions.ADDCREDSRV: self.__add,
modelactions.DELCREDSRV: self.__del,
modelactions.ADDNOTENOTE: self.__add,
modelactions.EDITNOTE: self.__edit,
modelactions.EDITCRED: self.__edit,
modelactions.ADDCRED: self.__add,
modelactions.DELCRED: self.__del
}
def run(self):
return self._main()
def stop(self):
"""
Sets the flag to stop daemon
"""
self._stop = True
def _dispatchActionWithLock(self, action_callback, *args):
res = False
self.__acquire_host_lock()
try:
res = action_callback(*args)
except Exception:
api.log("An exception occurred while dispatching an action (%r(%r)\n%s" %
(action_callback, args, traceback.format_exc()), "ERROR")
finally:
self.__release_host_lock()
return res
def _processAction(self, action, parameters, sync=False):
"""
decodes and performs the action given
It works kind of a dispatcher
"""
if sync:
self._sync_api_request = True
api.devlog("_processAction - %s - parameters = %s" %
(action, str(parameters)))
action_callback = self._actionDispatcher[action]
res = self._dispatchActionWithLock(action_callback, *parameters)
# finally we notify the widgets about this change
#if res: # notify only if action was done successfuly
#self._notifyModelUpdated(*parameters)
#else:
if not res:
api.devlog("Action code %d failed. Parameters = %s" %
(action, str(parameters)))
if sync:
self._sync_api_request = False
def getConflicts(self):
conflicts = []
for obj in self.objects_with_updates:
conflicts += obj.getUpdates()
return conflicts
def resolveConflicts(self):
notifier.conflictResolution(self.getConflicts())
def resolveConflict(self, conflict, kwargs):
if self.__edit(conflict.getFirstObject(), **kwargs):
conflict.getFirstObject().updateResolved(conflict)
if conflict.getModelObjectType() == "Interface":
ipv4 = kwargs['ipv4']
ipv6 = kwargs['ipv6']
hostnames = kwargs['hostnames']
if not ipv4['address'] in ["0.0.0.0", None]:
self.treeWordsTries.removeWord(ipv4['address'])
self.treeWordsTries.addWord(ipv4['address'])
if not ipv6['address'] in ["0000:0000:0000:0000:0000:0000:0000:0000", None]:
self.treeWordsTries.removeWord(ipv6['address'])
self.treeWordsTries.addWord(ipv6['address'])
for h in hostnames:
if h is not None:
self.treeWordsTries.removeWord(h)
self.treeWordsTries.addWord(h)
notifier.conflictUpdate(-1)
#notifier.editHost(conflict.getFirstObject().getHost())
#self._notifyModelUpdated()
def removeConflictsByObject(self, obj):
if obj in self.objects_with_updates:
self.objects_with_updates.remove(obj)
notifier.conflictUpdate(-len(obj.getUpdates()))
def setSavingModel(self, value):
api.devlog("setSavingModel: %s" % value)
self._saving_model_flag = value
if value:
self._saving_model_lock.acquire()
else:
try:
self._saving_model_lock.release()
except RuntimeError:
pass
def _main(self):
"""
The main method for the thread.
The controller will be constantly checking a queue
to see if new actions were added.
This will make host addition and removal "thread-safe" and will
avoid locking components that need to interact with the model
"""
while True:
# check if thread must finish
if self._stop:
return
# first we check if there is a sync api request
# or if the model is being saved/sync'ed
# or if we have pending duplicated hosts that need to be
# merged by the userget
if not self._sync_api_request and not self._saving_model_flag:
self.processAction()
else:
# there is some object requesting for a sync api so we
# sleep the thread execution for a moment to let others work
# XXX: check if this time is not too much...
time.sleep(0.01)
def processAllPendingActions(self):
[self.processAction() for i in range(self._pending_actions.qsize())]
def processAction(self):
# check the queue for new actions
# if there is no new action it will block until timeout is reached
try:
# get new action or timeout (in secs)
#TODO: timeout should be set through config
current_action = self._pending_actions.get(timeout=2)
action = current_action[0]
parameters = current_action[1:]
# dispatch the action
self._processAction(action, parameters)
except Queue.Empty:
# if timeout was reached, just let the daemon run again
# this is done just to be able to test the stop flag
# because if we don't do it, the daemon will be blocked forever
pass
except Exception:
getLogger(self).devlog("something strange happened... unhandled exception?")
getLogger(self).devlog(traceback.format_exc())
def sync_lock(self):
self._sync_api_request = True
self.__acquire_host_lock()
def sync_unlock(self):
self._sync_api_request = False
self.__release_host_lock()
# TODO: >>> APIs <<< we have to know which plugin called the apis to store
# in the history
def __addPendingAction(self, *args):
"""
Adds a new pending action to the queue
Action is build with generic args tuple.
The caller of this function has to build the action in the right
way since no checks are preformed over args
"""
new_action = args
self._pending_actions.put(new_action)
def addUpdate(self, old_object, new_object):
# Returns True if the update was resolved without user interaction
res = True
try:
mergeAction = old_object.addUpdate(new_object)
if mergeAction:
if old_object not in self.objects_with_updates:
self.objects_with_updates.append(old_object)
notifier.conflictUpdate(1)
res = False
except:
res = False
api.devlog("(%s).addUpdate(%s, %s) - failed" %
(self, old_object, new_object))
return res
def find(self, obj_id):
return self.mappers_manager.find(obj_id)
def addHostASYNC(self, host, category=None, update=False, old_hostname=None):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
new host must be added to the model
"""
self.__addPendingAction(modelactions.ADDHOST, host, category, update, old_hostname)
def addHostSYNC(self, host, category=None, update=False, old_hostname=None):
"""
SYNC API
Adds a host directly to the model
"""
self._processAction(modelactions.ADDHOST, [host, None], sync=True)
def __add(self, obj, parent_id=None, *args):
dataMapper = self.mappers_manager.getMapper(obj.class_signature)
old_obj = dataMapper.find(obj.getID())
if old_obj:
if not old_obj.needs_merge(obj):
# the object is exactly the same,
# so return and do nothing
return True
if not self.addUpdate(old_obj, obj):
return False
dataMapper.save(old_obj)
notifier.editHost(old_obj.getHost())
else:
object_parent = self.mappers_manager.find(parent_id)
if object_parent:
object_parent.addChild(obj)
# we have to make sure that certain objects have to have a parent
if (obj.class_signature in
[model.hosts.Interface.class_signature,
model.hosts.Service.class_signature,
model.common.ModelObjectNote.class_signature,
model.common.ModelObjectVuln.class_signature,
model.common.ModelObjectVulnWeb.class_signature,
model.common.ModelObjectCred.class_signature] and object_parent is None):
# TODO: refactor log module. We need to log twice to see it in
# qt and in the terminal. Ugly.
msg = "A parent is needed for %s objects" % obj.class_signature
getLogger(self).error(msg)
model.api.log(msg)
return False
dataMapper.save(obj)
self.treeWordsTries.addWord(obj.getName())
if obj.class_signature == model.hosts.Host.class_signature:
notifier.addHost(obj)
else:
notifier.editHost(obj.getHost())
return True
def __edit(self, obj, *args, **kwargs):
dataMapper = self.mappers_manager.getMapper(obj.class_signature)
obj.updateAttributes(*args, **kwargs)
dataMapper.save(obj)
# self.treeWordsTries.addWord(obj.getName())
if obj.class_signature == model.hosts.Host.class_signature:
notifier.editHost(obj)
else:
notifier.editHost(obj.getHost())
return True
def __del(self, objId, *args):
obj = self.mappers_manager.find(objId)
if obj:
obj_parent = obj.getParent()
if obj_parent:
obj_parent.deleteChild(objId)
if obj.getName():
self.treeWordsTries.removeWord(obj.getName())
self.removeConflictsByObject(obj)
self.mappers_manager.remove(objId)
if obj.class_signature == model.hosts.Host.class_signature:
notifier.delHost(objId)
else:
notifier.editHost(obj.getHost())
return True
return False
def delHostASYNC(self, hostId):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
particular host must be removed from the model
"""
self.__addPendingAction(modelactions.DELHOST, hostId)
def delHostSYNC(self, hostId):
"""
SYNC API
Deletes a host from model
"""
self._processAction(modelactions.DELHOST, [hostId], sync=True)
def editHostSYNC(self, host, name, description, os, owned):
"""
SYNC API
Modifies a host from model
"""
self._processAction(modelactions.EDITHOST, [host, name, description, os, owned], sync=True)
def addInterfaceASYNC(self, hostid, interface, update=False):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
new interface must be added to a specific host
"""
self.__addPendingAction(modelactions.ADDINTERFACE, interface, hostid)
def addInterfaceSYNC(self, hostId, interface, update=False):
"""
SYNC API
Adds interface directly to the model
"""
self._processAction(modelactions.ADDINTERFACE, [interface, hostId], sync=True)
def delInterfaceASYNC(self, hostId, interfaceId):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
particular host must be removed from the model
"""
self.__addPendingAction(modelactions.DELINTERFACE, interfaceId, hostId)
def delInterfaceSYNC(self, host, interface_id, *args):
"""
SYNC API
Deletes an interface from model
"""
self._processAction(modelactions.DELINTERFACE, [interface_id], sync=True)
def editInterfaceSYNC(self, interface, name, description, hostnames,
mac, ipv4, ipv6, network_segment,
amount_ports_opened, amount_ports_closed,
amount_ports_filtered, owned):
"""
SYNC API
Modifies an interface from model
"""
self._processAction(modelactions.EDITINTERFACE,
[interface, name, description, hostnames,
mac, ipv4, ipv6, network_segment,
amount_ports_opened, amount_ports_closed,
amount_ports_filtered, owned], sync=True)
def addServiceToInterfaceASYNC(self, host, interfaceId, newService):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
new services must be added to a specific host in a specific interface
"""
self.__addPendingAction(modelactions.ADDSERVICEINT, newService, interfaceId)
def addServiceToInterfaceSYNC(self, host_id, interface_id, newService):
"""
SYNC API
Adds a service to a specific host in a specific interface
directly to the model
"""
self._processAction(modelactions.ADDSERVICEINT, [newService, interface_id], sync=True)
def delServiceFromInterfaceASYNC(self, host, interfaceId, serviceId):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
particular service in a host and interface must be removed from the
model Interface parameter can be "ALL"
"""
self.__addPendingAction(modelactions.DELSERVICEINT, serviceId, interfaceId)
def delServiceFromInterfaceSYNC(self, host, interfaceId, serviceId):
"""
SYNC API
Delete a service in a host and interface from the model
"""
self._processAction(modelactions.DELSERVICEINT, [serviceId], sync=True)
def delServiceFromApplicationASYNC(self, host, appname, service):
"""
ASYNC API
Adds an action to the ModelController actions queue indicating a
particular service in a host and interface must be removed from the model
appname parameter can be "ALL"
"""
self.__addPendingAction(modelactions.DELSERVICEAPP, host, appname, service)
def delServiceFromApplicationSYNC(self, host, appname, service):
"""
SYNC API
Delete a service in a host and application from the model
"""
self._processAction(modelactions.DELSERVICEAPP, [host, appname, service], sync=True)
def editServiceSYNC(self, service, name, description, protocol, ports, status, version, owned):
"""
SYNC API
Modifies a host from model
"""
self._processAction(modelactions.EDITSERVICE, [service, name, description, protocol, ports, status, version, owned], sync=True)
def editServiceASYNC(self, service, name, description, protocol, ports, status, version, owned):
"""
ASYNC API
Modifies a service from model
"""
self.__addPendingAction(modelactions.EDITSERVICE, service, name, description, protocol, ports, status, version, owned)
def __editService(self, service, name=None, description=None,
protocol=None, ports=None, status=None,
version=None, owned=None):
res = False
if service is not None:
service.updateAttributes(name, description, protocol, ports, status, version, owned)
notifier.editHost(service.getHost())
res = True
return res
def addVulnToInterfaceASYNC(self, host, intId, newVuln):
self.__addPendingAction(modelactions.ADDVULNINT, newVuln, intId)
def addVulnToInterfaceSYNC(self, host, intId, newVuln):
self._processAction(modelactions.ADDVULNINT, [newVuln, intId], sync=True)
def addVulnToApplicationASYNC(self, host, appname, newVuln):
self.__addPendingAction(modelactions.ADDVULNAPP, host, appname, newVuln)
def addVulnToApplicationSYNC(self, host, appname, newVuln):
self._processAction(modelactions.ADDVULNAPP, [host, appname, newVuln], sync=True)
def addVulnToHostASYNC(self, hostId, newVuln):
self.__addPendingAction(modelactions.ADDVULNHOST, newVuln, hostId)
def addVulnToHostSYNC(self, hostId, newVuln):
self._processAction(modelactions.ADDVULNHOST, [newVuln, hostId], sync=True)
def addVulnToServiceASYNC(self, host, srvId, newVuln):
self.__addPendingAction(modelactions.ADDVULNSRV, newVuln, srvId)
def addVulnToServiceSYNC(self, host, srvId, newVuln):
self._processAction(modelactions.ADDVULNSRV, [newVuln, srvId], sync=True)
def addVulnSYNC(self, modelObjectId, newVuln):
self._processAction(modelactions.ADDVULN, [newVuln, modelObjectId], sync=True)
def addVulnWebToServiceASYNC(self, host, srvId, newVuln):
self.__addPendingAction(modelactions.ADDVULNWEBSRV, newVuln, srvId)
def addVulnWebToServiceSYNC(self, host, srvId, newVuln):
self._processAction(modelactions.ADDVULNWEBSRV, [newVuln, srvId], sync=True)
def delVulnFromApplicationASYNC(self, hostname, appname, vuln):
self.__addPendingAction(modelactions.DELVULNAPP, hostname, appname, vuln)
def delVulnFromApplicationSYNC(self, hostname, appname, vuln):
self._processAction(modelactions.DELVULNAPP, [hostname, appname, vuln], sync=True)
def delVulnFromInterfaceASYNC(self, hostname, intname, vuln):
self.__addPendingAction(modelactions.DELVULNINT, hostname, intname, vuln)
def delVulnFromInterfaceSYNC(self, hostname, intname, vuln):
self._processAction(modelactions.DELVULNINT, [hostname,intname, vuln], sync=True)
def delVulnFromHostASYNC(self, hostId, vulnId):
self.__addPendingAction(modelactions.DELVULNHOST, vulnId)
def delVulnFromHostSYNC(self, hostname, vulnId):
self._processAction(modelactions.DELVULNHOST, [vulnId], sync=True)
def delVulnFromServiceASYNC(self, hostname, srvname, vulnId):
self.__addPendingAction(modelactions.DELVULNSRV, vulnId)
def delVulnFromServiceSYNC(self, hostname, srvname, vulnId):
self._processAction(modelactions.DELVULNSRV, [vulnId], sync=True)
def delVulnSYNC(self, model_object, vuln_id):
self._processAction(modelactions.DELVULN, [vuln_id], sync=True)
def editVulnSYNC(self, vuln, name, desc, severity, resolution, refs):
self._processAction(modelactions.EDITVULN, [vuln, name, desc, severity, resolution, refs], sync=True)
def editVulnASYNC(self, vuln, name, desc, severity, resolution, refs):
self.__addPendingAction(modelactions.EDITVULN, vuln, name, desc, severity, resolution, refs)
def editVulnWebSYNC(self, vuln, name, desc, website, path, refs, severity, resolution,
request, response, method, pname, params, query,
category):
self._processAction(modelactions.EDITVULN,
[vuln, name, desc, website, path, refs, severity, resolution,
request, response, method, pname, params, query, category], sync=True)
def editVulnWebASYNC(self, vuln, name, desc, website, path, refs,
severity, resolution, request, response, method, pname,
params, query, category):
self.__addPendingAction(modelactions.EDITVULN,
vuln, name, desc, website, path, refs,
severity, resolution, request, response, method,
pname, params, query, category)
# Note
def addNoteToInterfaceASYNC(self, host, intId, newNote):
self.__addPendingAction(modelactions.ADDNOTEINT, newNote, intId)
def addNoteToInterfaceSYNC(self, host, intId, newNote):
self._processAction(modelactions.ADDNOTEINT, [newNote, intId], sync=True)
def addNoteToApplicationASYNC(self, host, appname, newNote):
self.__addPendingAction(modelactions.ADDNOTEAPP, host, appname, newNote)
def addNoteToApplicationSYNC(self, host, appname, newNote):
self._processAction(modelactions.ADDNOTEAPP, [host, appname, newNote], sync=True)
def addNoteToHostASYNC(self, hostId, newNote):
self.__addPendingAction(modelactions.ADDNOTEHOST, newNote, hostId)
def addNoteToHostSYNC(self, hostId, newNote):
self._processAction(modelactions.ADDNOTEHOST, [newNote, hostId], sync=True)
def addNoteToServiceASYNC(self, host, srvId, newNote):
self.__addPendingAction(modelactions.ADDNOTESRV, newNote, srvId)
def addNoteToNoteASYNC(self, host, srvname, note_id, newNote):
self.__addPendingAction(modelactions.ADDNOTENOTE, newNote, note_id)
def addNoteToNoteSYNC(self, noteId, newNote):
self._processAction(modelactions.ADDNOTENOTE, [newNote, noteId], sync=True)
def addNoteToServiceSYNC(self, host, srvId, newNote):
self._processAction(modelactions.ADDNOTESRV, [newNote, srvId], sync=True)
def addNoteSYNC(self, model_object, newNote):
self._processAction(modelactions.ADDNOTE, [newNote, model_object], sync=True)
def delNoteFromApplicationASYNC(self, hostname, appname, note):
self.__addPendingAction(modelactions.DELNOTEAPP, hostname, appname, note)
def delNoteFromApplicationSYNC(self, hostname, appname, note):
self._processAction(modelactions.DELNOTEAPP, [hostname, appname, note], sync=True)
def delNoteFromInterfaceASYNC(self, hostname, intname, noteId):
self.__addPendingAction(modelactions.DELNOTEINT, noteId)
def delNoteFromInterfaceSYNC(self, hostname, intname, noteId):
self._processAction(modelactions.DELNOTEINT, [noteId], sync=True)
def delNoteFromHostASYNC(self, hostId, noteId):
self.__addPendingAction(modelactions.DELNOTEHOST, noteId)
def delNoteFromHostSYNC(self, hostname, noteId):
self._processAction(modelactions.DELNOTEHOST, [noteId], sync=True)
def delNoteFromServiceASYNC(self, hostId, srvId, noteId):
self.__addPendingAction(modelactions.DELNOTESRV, noteId)
def delNoteFromServiceSYNC(self, hostname, srvname, noteId):
self._processAction(modelactions.DELNOTESRV, [noteId], sync=True)
def delNoteSYNC(self, model_object, note_id):
self._processAction(modelactions.DELNOTE, [note_id], sync=True)
def addCredToServiceASYNC(self, host, srvId, newCred):
self.__addPendingAction(modelactions.ADDCREDSRV, newCred, srvId)
def addCredToServiceSYNC(self, host, srvId, newCred):
self._processAction(modelactions.ADDCREDSRV, [newCred, srvId], sync=True)
def delCredFromServiceASYNC(self, hostname, srvname, credId):
self.__addPendingAction(modelactions.DELCREDSRV, credId)
def delCredFromServiceSYNC(self, hostname, srvname, credId):
self._processAction(modelactions.DELCREDSRV, [credId], sync=True)
def editNoteSYNC(self, note, name, text):
self._processAction(modelactions.EDITNOTE, [note, name, text], sync=True)
def editNoteASYNC(self, note, name, text):
self.__addPendingAction(modelactions.EDITNOTE, note, name, text)
def editCredSYNC(self, cred, username, password):
self._processAction(modelactions.EDITCRED, [cred, username, password], sync=True)
def editCredASYNC(self, cred, username, password):
self.__addPendingAction(modelactions.EDITCRED, cred, username, password)
def addCredSYNC(self, model_object_id, newCred):
self._processAction(modelactions.ADDCRED, [newCred, model_object_id], sync=True)
def delCredSYNC(self, model_object, cred_id):
self._processAction(modelactions.DELCRED, [cred_id], sync=True)
def newHost(self, name, os="Unknown"):
return model.common.factory.createModelObject(
model.hosts.Host.class_signature,
name, os=os, parent_id=None)
def newInterface(self, name, mac="00:00:00:00:00:00",
ipv4_address="0.0.0.0",
ipv4_mask="0.0.0.0", ipv4_gateway="0.0.0.0", ipv4_dns=[],
ipv6_address="0000:0000:0000:0000:0000:0000:0000:0000",
ipv6_prefix="00",
ipv6_gateway="0000:0000:0000:0000:0000:0000:0000:0000",
ipv6_dns=[], network_segment="", hostname_resolution=[],
parent_id=None):
return model.common.factory.createModelObject(
model.hosts.Interface.class_signature,
name, mac=mac, ipv4_address=ipv4_address,
ipv4_mask=ipv4_mask, ipv4_gateway=ipv4_gateway, ipv4_dns=ipv4_dns,
ipv6_address=ipv6_address, ipv6_prefix=ipv6_prefix,
ipv6_gateway=ipv6_gateway, ipv6_dns=ipv6_dns,
network_segment=network_segment,
hostname_resolution=hostname_resolution, parent_id=parent_id)
def newService(self, name, protocol="tcp?", ports=[], status="running",
version="unknown", description="", parent_id=None):
return model.common.factory.createModelObject(
model.hosts.Service.class_signature,
name, protocol=protocol, ports=ports, status=status,
version=version, description=description, parent_id=parent_id)
def newVuln(self, name, desc="", ref=None, severity="", resolution="", parent_id=None):
return model.common.factory.createModelObject(
model.common.ModelObjectVuln.class_signature,
name, desc=desc, ref=ref, severity=severity, resolution=resolution, parent_id=parent_id)
def newVulnWeb(self, name, desc="", ref=None, severity="", resolution="", website="",
path="", request="", response="", method="", pname="",
params="", query="", category="", parent_id=None):
return model.common.factory.createModelObject(
model.common.ModelObjectVulnWeb.class_signature,
name, desc=desc, ref=ref, severity=severity, resolution=resolution,
website=website, path=path, request=request, response=response,
method=method, pname=pname, params=params, query=query,
category=category, parent_id=parent_id)
def newNote(self, name, text, parent_id=None):
return model.common.factory.createModelObject(
model.common.ModelObjectNote.class_signature,
name, text=text, parent_id=parent_id)
def newCred(self, username, password, parent_id=None):
return model.common.factory.createModelObject(
model.common.ModelObjectCred.class_signature,
username, password=password, parent_id=parent_id)
def getHost(self, name):
hosts_mapper = self.mappers_manager.getMapper(model.hosts.Host.__name__)
return hosts_mapper.find(name)
def getHostsCount(self):
return len(self._hosts)
def getAllHosts(self):
hosts = self.mappers_manager.getMapper(
model.hosts.Host.__name__).getAll()
return hosts
def getWebVulns(self):
return self.mappers_manager.getMapper(
model.common.ModelObjectVulnWeb.class_signature).getAll()
def createIndex(self, hosts):
self.treeWordsTries = TreeWordsTries()
self.treeWordsTries.clear()
for k in hosts.keys():
h = hosts[k]
self.treeWordsTries.addWord(h.getName())
for intr in h.getAllInterfaces():
ipv4 = intr.ipv4
ipv6 = intr.ipv6
if not ipv4['address'] in ["0.0.0.0", None]:
self.treeWordsTries.addWord(ipv4['address'])
if not ipv6['address'] in ["0000:0000:0000:0000:0000:0000:0000:0000", None]:
self.treeWordsTries.addWord(ipv6['address'])
for hostname in intr.getHostnames():
self.treeWordsTries.addWord(hostname)
def checkPermissions(self, op):
## In order to use the decorator passPermissionsOrRaise
## The client should implement checkPermissions method.
self.__sec.checkPermissions(op)