bicep_utils package

Subpackages

• bicep_utils.fastapi package
  • Submodules
  • bicep_utils.fastapi.dependencies module
    • get_analysis_start_time()
    • get_analysis_stop_time()
    • get_ids_instance()
  • bicep_utils.fastapi.routes module
    • add_to_ensemble()
    • configure()
    • healthcheck()
    • network_analysis()
    • remove_from_ensemble()
    • ruleset()
    • static_analysis()
    • stop_analysis()
  • bicep_utils.fastapi.utils module
    • alert_stream()
• bicep_utils.models package
  • Submodules
  • bicep_utils.models.ids_base module
    • Alert
      • Alert.__init__()
      • Alert.__str__()
      • Alert.from_json()
      • Alert.to_dict()
      • Alert.to_json()
    • IDSBase
      • IDSBase.__init__()
      • IDSBase.configuration_location
      • IDSBase.configure()
      • IDSBase.configure_ruleset()
      • IDSBase.execute_network_analysis_command()
      • IDSBase.execute_static_analysis_command()
      • IDSBase.finish_static_analysis_in_background()
      • IDSBase.get_default_interface_name()
      • IDSBase.log_location
      • IDSBase.parser
      • IDSBase.send_alerts_to_core()
      • IDSBase.send_alerts_to_core_periodically()
      • IDSBase.start_network_analysis()
      • IDSBase.start_static_analysis()
      • IDSBase.stop_all_processes()
      • IDSBase.stop_analysis()
      • IDSBase.tell_core_analysis_has_finished()
    • IDSParser
      • IDSParser.alert_file_location
      • IDSParser.normalize_threat_levels()
      • IDSParser.parse_alerts()
      • IDSParser.parse_line()
      • IDSParser.timestamp_format
• bicep_utils.tests package
  • Submodules
  • bicep_utils.tests.test_general_utilities module
    • temp_file()
    • test_create_and_activate_network_interface()
    • test_get_env_variable()
    • test_mirror_network_traffic_to_interface()
    • test_remove_network_interface()
    • test_save_file()
    • test_stop_process()
    • test_wait_for_process_completion()
  • bicep_utils.tests.test_model module
    • MockIDS
      • MockIDS.configuration_location()
      • MockIDS.configure()
      • MockIDS.configure_ruleset()
      • MockIDS.execute_network_analysis_command()
      • MockIDS.execute_static_analysis_command()
      • MockIDS.log_location()
      • MockIDS.parser()
    • mock_alert_list()
    • mock_ids()
    • test_alerts_from_json_with_double_quotes()
    • test_finish_static_analysis_in_background()
    • test_send_alerts_to_core()
    • test_send_alerts_to_core_ensemble()
    • test_send_alerts_to_core_periodically()
    • test_send_alerts_to_core_periodically_ensemble()
    • test_send_alerts_to_core_periodically_exception()
    • test_start_network_analysis()
    • test_start_static_analysis()
    • test_start_static_analysis_if_no_other_analysis_task_running_in_background()
    • test_stop_all_processes()
    • test_stop_all_processes_without_process_numbers()
    • test_stop_network_analysis()
    • test_stop_static_analysis()
    • test_tell_core_analysis_has_finished()
    • test_tell_core_analysis_has_finished_for_ensemble()
  • bicep_utils.tests.test_routes module
    • mock_ids()
    • test_add_to_ensemble()
    • test_add_to_ensemble_with_incorrect_id()
    • test_configuration()
    • test_configuration_file_is_none()
    • test_healthcheck()
    • test_network_analysis()
    • test_network_analysis_for_ensemble()
    • test_remove_from_ensemble()
    • test_ruleset()
    • test_ruleset_file_is_none()
    • test_static_analysis()
    • test_static_analysis_no_file_provided()
    • test_stop_analysis()

Submodules

bicep_utils.general_utilities module

class app.bicep_utils.general_utilities.ANALYSIS_MODES(*values)

Bases: Enum

NETWORK = 'network'

STATIC = 'static'

async app.bicep_utils.general_utilities.create_and_activate_network_interface(tap_interface_name)

async app.bicep_utils.general_utilities.execute_command_async(command, cwd=None, suppress_output: bool = True, raise_on_error: bool = False)

async app.bicep_utils.general_utilities.get_env_variable(name: str)

async app.bicep_utils.general_utilities.mirror_network_traffic_to_interface(tap_interface: str, default_interface: str = 'eth0')

async app.bicep_utils.general_utilities.normalize_timestamp_for_alert(timestamp_string: str)

async app.bicep_utils.general_utilities.remove_network_interface(tap_interface_name)

async app.bicep_utils.general_utilities.save_dataset(dataset, path)

async app.bicep_utils.general_utilities.save_file(file, path)

async app.bicep_utils.general_utilities.stop_process(pid: int)

async app.bicep_utils.general_utilities.wait_for_process_completion(pid)