Index

A

AbstractPluginInstaller (class in plugins.installer) add_analysis_task() (test.unit.conftest.CommonIntercomMock method) add_binary_search_request() (test.unit.conftest.CommonIntercomMock static method) add_compare_task() (test.unit.conftest.CommonIntercomMock method) add_included_file() (objects.file.FileObject method) add_re_analyze_task() (test.unit.conftest.CommonIntercomMock method) admin_pw (config.Common.Postgres attribute) admin_secret (config.Frontend.Hasura attribute) admin_user (config.Common.Postgres attribute) ajax_stats_reload_time (config.Frontend attribute) ALL (helperFunctions.tag.TagColor attribute) analysis.plugin.plugin module analysis_exception (objects.file.FileObject attribute)

analysis_plugin() (in module conftest) analysis_preset (config.Common attribute) analysis_tags (objects.file.FileObject attribute) AnalysisExceptionError AnalysisFailedError AnalysisPluginTestConfig (class in conftest) AnalysisPluginV0 (class in analysis.plugin.plugin) AnalysisPluginV0.MetaData (class in analysis.plugin.plugin) AnalysisScheduler (class in scheduler.analysis.scheduler) analyze() (analysis.plugin.plugin.AnalysisPluginV0 method) apply_filters_to_query() (in module helperFunctions.web_interface) apt_install_packages() (in module helperFunctions.install) apt_remove_packages() (in module helperFunctions.install) apt_update_sources() (in module helperFunctions.install) authentication (config.Frontend attribute)

B

Backend (class in config) backend() (in module config) Backend.BinarySearch (class in config) Backend.Plugin (class in config) Backend.PluginDefaults (class in config) Backend.Unpacking (class in config) backend_config() (in module conftest) base_path (plugins.installer.AbstractPluginInstaller attribute)

base_port (config.Backend.Unpacking attribute) binary (objects.file.FileObject attribute) binary_search (config.Backend attribute) block_delay (config.Backend attribute) BLUE (helperFunctions.logging.TerminalColors attribute) (helperFunctions.tag.TagColor attribute) BOLD (helperFunctions.logging.TerminalColors attribute) build() (plugins.installer.AbstractPluginInstaller method) build_pdf_report() (in module helperFunctions.pdf)

C

cap_length_of_element() (in module helperFunctions.web_interface) check_distribution() (in module helperFunctions.install) check_exceptions() (scheduler.analysis.scheduler.AnalysisScheduler method) check_for_errors() (in module helperFunctions.task_conversion) check_if_command_in_path() (in module helperFunctions.install) check_worker_exceptions() (in module helperFunctions.process) collector_worker_count (config.Backend attribute) color (analysis.plugin.plugin.Tag attribute) color_string() (in module helperFunctions.logging) ColoringFormatter (class in helperFunctions.logging) comments (objects.file.FileObject attribute) Common (class in config) common() (in module config) Common.AnalysisPreset (class in config) Common.Logging (class in config) Common.Postgres (class in config) Common.Redis (class in config)

common_config() (in module conftest) CommonIntercomMock (class in test.unit.conftest) communication_timeout (config.Frontend attribute) complete_shutdown() (in module helperFunctions.process) config module conftest module convert_analysis_task_to_fw_obj() (in module helperFunctions.task_conversion) convert_compare_id_to_list() (in module helperFunctions.data_conversion) convert_str_to_bool() (in module helperFunctions.data_conversion) convert_time_to_str() (in module helperFunctions.data_conversion) convert_uid_list_to_compare_id() (in module helperFunctions.data_conversion) create_analysis_task() (in module helperFunctions.task_conversion) create_binary_from_path() (objects.file.FileObject method) create_meta_dict() (in module helperFunctions.object_conversion) create_re_analyze_task() (in module helperFunctions.task_conversion) create_uid() (in module helperFunctions.uid)

D

DARK (helperFunctions.tag.TagColor attribute) database (config.Common.Postgres attribute) database_mock_class (test.unit.conftest.WebInterfaceUnitTestConfig attribute) del_pw (config.Common.Postgres attribute) del_user (config.Common.Postgres attribute) delay (config.Backend.Unpacking attribute) dependencies (analysis.plugin.plugin.AnalysisPluginV0.MetaData attribute) (scheduler.analysis.plugin.PluginRunner.Task attribute) depth (objects.file.FileObject attribute)

description (analysis.plugin.plugin.AnalysisPluginV0.MetaData attribute) device_class (objects.firmware.Firmware attribute) device_name (objects.firmware.Firmware attribute) discover_analysis_plugins() (in module helperFunctions.plugin) discover_compare_plugins() (in module helperFunctions.plugin) dnf_install_packages() (in module helperFunctions.install) dnf_remove_packages() (in module helperFunctions.install) dnf_update_sources() (in module helperFunctions.install) docker_mount_base_dir (config.Common attribute) docker_mount_base_dir() (in module conftest)

E

enabled (config.Frontend.Authentication attribute) ENDC (helperFunctions.logging.TerminalColors attribute)

error_message() (in module web_interface.rest.helper) exception (helperFunctions.process.ExceptionSafeProcess property) ExceptionSafeProcess (class in helperFunctions.process)

F

fact_db (config.Common.Redis attribute) FAIL (helperFunctions.logging.TerminalColors attribute) file_backend (config.Common.Logging attribute) file_database (config.Common.Logging attribute) file_frontend (config.Common.Logging attribute) file_is_empty() (in module helperFunctions.fileSystem) file_name (objects.file.FileObject attribute) file_path (objects.file.FileObject attribute) FileObject (class in objects.file) files_included (objects.file.FileObject attribute) filter_out_illegal_characters() (in module helperFunctions.web_interface) filter_vpf_dict() (in module helperFunctions.virtual_file_path)

Firmware (class in objects.firmware) firmware_file_storage_directory (config.Backend attribute) format() (helperFunctions.logging.ColoringFormatter method) format_time() (in module helperFunctions.web_interface) from_json() (objects.file.FileObject class method) (objects.firmware.Firmware class method) Frontend (class in config) frontend() (in module config) Frontend.Authentication (class in config) Frontend.Hasura (class in config) frontend_config() (in module conftest) FrontendDatabaseMock (class in test.unit.conftest)

G

get_active_worker_count() (scheduler.analysis.plugin.PluginRunner method) get_alternating_color_list() (in module helperFunctions.web_interface) get_analysis() (analysis.plugin.plugin.AnalysisPluginV0 method) get_analysis_status() (test.unit.conftest.StatusInterfaceMock method) get_available_analysis_plugins() (test.unit.conftest.CommonIntercomMock method) get_binary_and_filename() (test.unit.conftest.CommonIntercomMock static method) get_binary_search_result() (helperFunctions.yara_binary_search.YaraBinarySearchScanner method) (test.unit.conftest.CommonIntercomMock static method) get_boolean_from_request() (in module web_interface.rest.helper) get_color_list() (in module helperFunctions.web_interface) get_combined_analysis_workload() (scheduler.analysis.scheduler.AnalysisScheduler method) get_config_dir() (in module helperFunctions.fileSystem) get_current_gmt() (in module web_interface.rest.helper) get_file_name_and_binary_from_request() (in module helperFunctions.task_conversion) get_hash() (in module helperFunctions.hash) get_hid() (objects.file.FileObject method) (objects.firmware.Firmware method) get_imphash() (in module helperFunctions.hash) get_md5() (in module helperFunctions.hash) get_paging() (in module web_interface.rest.helper) get_paths_for_all_parents() (in module helperFunctions.virtual_file_path) get_plugin_dict() (scheduler.analysis.scheduler.AnalysisScheduler method)

get_query() (in module web_interface.rest.helper) get_queue_len() (scheduler.analysis.plugin.PluginRunner method) get_relative_object_path() (in module helperFunctions.fileSystem) get_repacked_binary_and_file_name() (test.unit.conftest.CommonIntercomMock static method) get_scheduled_workload() (scheduler.analysis.scheduler.AnalysisScheduler method) get_sha256() (in module helperFunctions.hash) get_shared_session() (in module helperFunctions.database) get_some_vfp() (in module helperFunctions.virtual_file_path) get_src_dir() (in module helperFunctions.fileSystem) get_ssdeep() (in module helperFunctions.hash) get_tags() (analysis.plugin.plugin.AnalysisPluginV0 method) get_template_as_string() (in module helperFunctions.web_interface) get_template_dir() (in module helperFunctions.fileSystem) get_tlsh() (in module helperFunctions.hash) get_tlsh_comparison() (in module helperFunctions.hash) get_update() (in module web_interface.rest.helper) get_value_of_first_key() (in module helperFunctions.data_conversion) get_virtual_paths_for_all_uids() (objects.file.FileObject method) get_yara_error() (in module helperFunctions.yara_binary_search) GRAY (helperFunctions.tag.TagColor attribute) GREEN (helperFunctions.logging.TerminalColors attribute) (helperFunctions.tag.TagColor attribute)

H

hasura (config.Frontend attribute) HEADER (helperFunctions.logging.TerminalColors attribute) helperFunctions.compare_sets module helperFunctions.data_conversion module helperFunctions.database module helperFunctions.docker module helperFunctions.fileSystem module helperFunctions.hash module helperFunctions.install module helperFunctions.logging module helperFunctions.merge_generators module helperFunctions.object_conversion module

helperFunctions.pdf module helperFunctions.plugin module helperFunctions.process module helperFunctions.program_setup module helperFunctions.tag module helperFunctions.task_conversion module helperFunctions.uid module helperFunctions.virtual_file_path module helperFunctions.web_interface module helperFunctions.yara_binary_search module host (config.Common.Redis attribute)

I

init_kwargs (conftest.AnalysisPluginTestConfig attribute) install() (plugins.installer.AbstractPluginInstaller method) install_docker_images() (plugins.installer.AbstractPluginInstaller method) install_files() (plugins.installer.AbstractPluginInstaller method) install_github_project() (in module helperFunctions.install) install_other_packages() (plugins.installer.AbstractPluginInstaller method) install_pip_packages() (in module helperFunctions.install) (plugins.installer.AbstractPluginInstaller method) install_system_packages() (plugins.installer.AbstractPluginInstaller method)

InstallationError intercom_mock_class (test.unit.conftest.WebInterfaceUnitTestConfig attribute) intercom_poll_delay (config.Backend attribute) intercom_task_list() (in module test.unit.conftest) is_list_of_uids() (in module helperFunctions.uid) is_uid() (in module helperFunctions.uid) is_valid_yara_rule_file() (in module helperFunctions.yara_binary_search) is_virtualenv() (in module helperFunctions.install) is_working() (scheduler.analysis.plugin.Worker method) iter_element_and_rest() (in module helperFunctions.compare_sets)

L

level (config.Common.Logging attribute) LIGHT (helperFunctions.tag.TagColor attribute) LIGHT_BLUE (helperFunctions.tag.TagColor attribute) list_of_all_included_files (objects.file.FileObject attribute)

load() (in module config) log_current_packages() (in module helperFunctions.install) LOG_LEVEL_COLORS (helperFunctions.logging.ColoringFormatter attribute) logging (config.Common attribute)

M

make_bytes() (in module helperFunctions.data_conversion) make_unicode_string() (in module helperFunctions.data_conversion) max_depth (config.Backend.Unpacking attribute) max_elements_per_chart (config.Frontend attribute) max_strings_per_match (config.Backend.BinarySearch attribute) memory_limit (config.Backend.Unpacking attribute) mime_blacklist (analysis.plugin.plugin.AnalysisPluginV0.MetaData attribute) mime_whitelist (analysis.plugin.plugin.AnalysisPluginV0.MetaData attribute) module analysis.plugin.plugin config conftest helperFunctions.compare_sets helperFunctions.data_conversion helperFunctions.database helperFunctions.docker helperFunctions.fileSystem helperFunctions.hash helperFunctions.install helperFunctions.logging helperFunctions.merge_generators helperFunctions.object_conversion helperFunctions.pdf helperFunctions.plugin helperFunctions.process helperFunctions.program_setup helperFunctions.tag helperFunctions.task_conversion helperFunctions.uid helperFunctions.virtual_file_path helperFunctions.web_interface helperFunctions.yara_binary_search objects.file objects.firmware plugins.installer scheduler.analysis.plugin scheduler.analysis.scheduler test.unit.conftest web_interface.rest.helper

N

name (analysis.plugin.plugin.AnalysisPluginV0.MetaData attribute) (analysis.plugin.plugin.Tag attribute) (config.Backend.Plugin attribute) (config.Common.AnalysisPreset attribute)

new_worker_was_started() (in module helperFunctions.process) none_to_none() (in module helperFunctions.data_conversion) normalize_compare_id() (in module helperFunctions.data_conversion) normalize_lief_items() (in module helperFunctions.hash) number_of_latest_firmwares_to_display (config.Frontend attribute)

O

objects.file module objects.firmware module

OKBLUE (helperFunctions.logging.TerminalColors attribute) OKGREEN (helperFunctions.logging.TerminalColors attribute) OperateInDirectory (class in helperFunctions.install) ORANGE (helperFunctions.tag.TagColor attribute) out_queue (scheduler.analysis.plugin.PluginRunner attribute)

P

parent_firmware_uids (objects.file.FileObject attribute) parents (objects.file.FileObject attribute) part (objects.firmware.Firmware attribute) password (config.Common.Redis attribute) password_is_legal() (in module helperFunctions.web_interface) password_salt (config.Frontend.Authentication attribute) patch_config() (in module conftest) path (scheduler.analysis.plugin.PluginRunner.Task attribute) peek_in_binary() (test.unit.conftest.CommonIntercomMock static method) plugin (config.Backend attribute) plugin_class (conftest.AnalysisPluginTestConfig attribute) plugin_defaults (config.Backend attribute) PluginRunner (class in scheduler.analysis.plugin) PluginRunner.Config (class in scheduler.analysis.plugin)

PluginRunner.Task (class in scheduler.analysis.plugin) plugins (config.Common.AnalysisPreset attribute) plugins.installer module port (config.Common.Postgres attribute) (config.Common.Redis attribute) (config.Frontend.Hasura attribute) postgres (config.Common attribute) process_count (scheduler.analysis.plugin.PluginRunner.Config attribute) processed_analysis (objects.file.FileObject attribute) processes (config.Backend.PluginDefaults attribute) (config.Backend.Unpacking attribute) propagate (analysis.plugin.plugin.Tag attribute) PURPLE (helperFunctions.logging.TerminalColors attribute)

Q

queue_analysis() (scheduler.analysis.plugin.PluginRunner method)

R

radare2_url (config.Frontend attribute) read_package_list_from_file() (in module helperFunctions.install) RED (helperFunctions.logging.TerminalColors attribute) (helperFunctions.tag.TagColor attribute) redis (config.Common attribute) release_date (objects.firmware.Firmware attribute) remove_duplicates_from_list() (in module helperFunctions.compare_sets) remove_folder() (in module helperFunctions.install) results_per_page (config.Frontend attribute)

ro_pw (config.Common.Postgres attribute) ro_user (config.Common.Postgres attribute) root_uid (objects.file.FileObject attribute) run() (helperFunctions.process.ExceptionSafeProcess method) (scheduler.analysis.plugin.Worker method) run_cmd_with_logging() (in module helperFunctions.install) run_docker_container() (in module helperFunctions.docker) rw_pw (config.Common.Postgres attribute) rw_user (config.Common.Postgres attribute)

S

scheduled_analysis (objects.file.FileObject attribute) scheduler.analysis.plugin module scheduler.analysis.scheduler module scheduler_state (scheduler.analysis.plugin.PluginRunner.Task attribute) scheduling_worker_count (config.Backend attribute) Schema (analysis.plugin.plugin.AnalysisPluginV0 attribute) (analysis.plugin.plugin.AnalysisPluginV0.MetaData attribute) server (config.Common.Postgres attribute) set_analysis_status() (test.unit.conftest.StatusInterfaceMock method) set_binary() (objects.file.FileObject method) (objects.firmware.Firmware method) set_part_name() (objects.firmware.Firmware method) set_tag() (objects.firmware.Firmware method) setup_argparser() (in module helperFunctions.program_setup) setup_logging() (in module helperFunctions.program_setup) sha256 (objects.file.FileObject attribute) shuffled() (in module helperFunctions.merge_generators)

shutdown() (scheduler.analysis.plugin.PluginRunner method) (scheduler.analysis.scheduler.AnalysisScheduler method) (test.unit.conftest.CommonIntercomMock method) SIGTERM_TIMEOUT (scheduler.analysis.plugin.Worker attribute) size (objects.file.FileObject attribute) ssdeep_ignore (config.Backend attribute) start() (scheduler.analysis.plugin.PluginRunner method) (scheduler.analysis.scheduler.AnalysisScheduler method) start_analysis_of_object() (scheduler.analysis.scheduler.AnalysisScheduler method) start_processes (conftest.AnalysisPluginTestConfig attribute) start_single_worker() (in module helperFunctions.process) status_mock_class (test.unit.conftest.WebInterfaceUnitTestConfig attribute) StatusInterfaceMock (class in test.unit.conftest) stop_process() (in module helperFunctions.process) stop_processes() (in module helperFunctions.process) substring_is_in_list() (in module helperFunctions.compare_sets) success_message() (in module web_interface.rest.helper) summarize() (analysis.plugin.plugin.AnalysisPluginV0 method) system_version (analysis.plugin.plugin.AnalysisPluginV0.MetaData attribute)

T

Tag (class in analysis.plugin.plugin) TagColor (class in helperFunctions.tag) tags (objects.firmware.Firmware attribute) task_list (test.unit.conftest.CommonIntercomMock attribute) temp_dir_path (config.Common attribute) temporary_data (objects.file.FileObject attribute) TerminalColors (class in helperFunctions.logging) terminate_process_and_children() (in module helperFunctions.process) test.unit.conftest module

test_client() (in module test.unit.conftest) test_database (config.Common.Postgres attribute) test_db (config.Common.Redis attribute) throttle_limit (config.Backend.Unpacking attribute) throw_exceptions (config.Backend attribute) timeout (analysis.plugin.plugin.AnalysisPluginV0.MetaData attribute) (scheduler.analysis.plugin.PluginRunner.Config attribute) (scheduler.analysis.plugin.Worker.Config attribute) to_json() (objects.file.FileObject method) (objects.firmware.Firmware method)

U

uid (objects.file.FileObject property) UNDERLINE (helperFunctions.logging.TerminalColors attribute) unpacking (config.Backend attribute)

update_analysis_of_object_and_children() (scheduler.analysis.scheduler.AnalysisScheduler method) update_analysis_of_single_object() (scheduler.analysis.scheduler.AnalysisScheduler method) user_database (config.Frontend.Authentication attribute)

V

value (analysis.plugin.plugin.Tag attribute) vendor (objects.firmware.Firmware attribute) version (analysis.plugin.plugin.AnalysisPluginV0.MetaData attribute) (objects.firmware.Firmware attribute)

virtual_file_path (objects.file.FileObject attribute) (scheduler.analysis.plugin.PluginRunner.Task attribute)

W

WARNING (helperFunctions.logging.TerminalColors attribute) web_frontend() (in module test.unit.conftest) web_interface.rest.helper module WebInterfaceUnitTestConfig (class in test.unit.conftest)

whitelist (config.Backend.Unpacking attribute) Worker (class in scheduler.analysis.plugin) Worker.Config (class in scheduler.analysis.plugin) Worker.CrashedError Worker.TimeoutError

Y

YaraBinarySearchScanner (class in helperFunctions.yara_binary_search)

YELLOW (helperFunctions.logging.TerminalColors attribute)