p20319658
/
monkey
forked from p34709852/monkey
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added documentation

This commit is contained in:
Shay Nehmad 2019-10-02 13:12:48 +03:00
parent 006c177abd
commit 19dcf689fe
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
monkey/monkey_island/cc/resources/root.py
View File

@ -20,6 +20,9 @@ logger = logging.getLogger(__name__)
class Root(flask_restful.Resource): class Root(flask_restful.Resource):
def __init__(self): def __init__(self):
# This lock will allow only one thread to generate a report at a time. Report generation can be quite
# slow if there is a lot of data, and the UI queries the Root service often; without the lock, these requests
# would accumulate, overload the server, eventually causing it to crash.
self.report_generating_lock = threading.Event() self.report_generating_lock = threading.Event()
def get(self, action=None): def get(self, action=None):
@ -39,8 +42,10 @@ class Root(flask_restful.Resource):
@jwt_required() @jwt_required()
def get_server_info(self): def get_server_info(self):
return jsonify(ip_addresses=local_ip_addresses(), mongo=str(mongo.db), return jsonify(
completed_steps=self.get_completed_steps()) ip_addresses=local_ip_addresses(),
mongo=str(mongo.db),
completed_steps=self.get_completed_steps())
@staticmethod @staticmethod
@jwt_required() @jwt_required()
@ -70,15 +75,16 @@ class Root(flask_restful.Resource):
report_done=report_done) report_done=report_done)
def generate_report(self): def generate_report(self):
# Set the event - enter the critical section # Set the event when entering the critical section
self.report_generating_lock.set() self.report_generating_lock.set()
# Not using the return value, as the get_report function also saves the report in the DB for later. # Not using the return value, as the get_report function also saves the report in the DB for later.
_ = ReportService.get_report() _ = ReportService.get_report()
_ = AttackReportService.get_latest_report() _ = AttackReportService.get_latest_report()
# Clear the event - exit the critical section # Clear the event when leaving the critical section
self.report_generating_lock.clear() self.report_generating_lock.clear()
def should_generate_report(self): def should_generate_report(self):
# If the lock is not set, that means no one is generating a report right now. # If the lock is not set, that means no one is generating a report right now.
is_any_thread_generating_a_report_right_now = not self.report_generating_lock.is_set() is_any_thread_generating_a_report_right_now = not self.report_generating_lock.is_set()
return is_any_thread_generating_a_report_right_now and not ReportService.is_latest_report_exists() is_there_a_need_for_a_new_report = not ReportService.is_latest_report_exists()
return is_any_thread_generating_a_report_right_now and is_there_a_need_for_a_new_report