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
  • bicep_utils.tests.test_model module
  • bicep_utils.tests.test_routes module

Submodules

bicep_utils.general_utilities module

class bicep_utils.general_utilities.ANALYSIS_MODES(*values)

Bases: Enum

NETWORK = 'network'

STATIC = 'static'

async bicep_utils.general_utilities.create_and_activate_network_interface(tap_interface_name)

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

async bicep_utils.general_utilities.get_env_variable(name: str)

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

async bicep_utils.general_utilities.normalize_timestamp_for_alert(timestamp_string: str)

async bicep_utils.general_utilities.remove_network_interface(tap_interface_name)

async bicep_utils.general_utilities.save_dataset(dataset, path)

async bicep_utils.general_utilities.save_file(file, path)

async bicep_utils.general_utilities.stop_process(pid: int)

async bicep_utils.general_utilities.wait_for_process_completion(pid)