updated pre_templates and included missing pre_module_reporter function

2026-10-12 02:13:21 +00:00 · 2023-12-01 09:57:38 -05:00
parent 40086d6940
commit 33d280b288
62 changed files with 67 additions and 59 deletions
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "The firmware diffing and information gathering module analyzes and compares two firmware binaries, calculating MD5 checksums, generating filde details, creating entropy graphs and detecting binary components."
+print_output "The firmware diffing and information gathering module analyzes and compares two firmware binaries, calculating MD5 checksums, generating filde details, creating entropy graphs and detecting binary components."
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+print_output "The firmware diffing extractor module is designed to extract, compare and anaylze two firmware images, checking for their identity and providing detailed analyses and reports if they differ."
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+print_output "The firmware diffing module performs differential analysis between tow firmware images, using tools like ssdeep and radare2 to identiy, analyze and report differences in fiels and functions within the firmware."
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+print_output "The qs resolver module integrates OpenAIs GPT responses into a reporting system, updating output files and HTML reports with AI-generated answers to specific questions, while handling file links and anchor resolutions."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "EMBA was able to identify the shown software components with ${ORANGE}license details${NC}. These details should be checked for license violations."
+print_output "EMBA was able to identify the shown software components with ${ORANGE}license details${NC}. These details should be checked for license violations."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module collects license details and creates a details on the identified binaries, versions and the corresponding license (if available). The license details are maintained in the configuration file config/bin_version_strings.cfg."
+print_output "This module collects license details and creates a details on the identified binaries, versions and the corresponding license (if available). The license details are maintained in the configuration file config/bin_version_strings.cfg."
@@ -1,4 +1,4 @@
 #!/bin/bash

 print_output "This module aggregates all found version numbers together from S06, S08, S09, S24, S25 and S115 and searches with cve-search for known vulnerabilities."
-print_output "Additionally the identified CVE details are matched with public exploit databases."
+print_output "Additionally the identified CVE details are matched with public exploit databases."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "The CycloneX SBOM module generates a Software Bill of Materials (SBOM) in JSON format by processing vulnerability data through CycloneDX and then logging and storing the SBOM in the log directory."
+print_output "The CycloneX SBOM module generates a Software Bill of Materials (SBOM) in JSON format by processing vulnerability data through CycloneDX."
@@ -2,4 +2,4 @@

 print_output "This module builds and emulates Linux firmware - this module is based on the great work of firmadyne"
 print_output "Check out the original firmadyne project at https://github.com/firmadyne"
-print_output "${MAGENTA}Warning:${NC} This module changes your network configuration and it could happen that your system looses network connectivity."
+print_output "${MAGENTA}Warning:${NC} This module changes your network configuration and it could happen that your system looses network connectivity."
@@ -2,4 +2,4 @@

 print_output "This module builds and emulates Linux firmware - this module is based on the great work of firmadyne"
 print_output "Check out the original firmadyne project at https://github.com/firmadyne"
-print_output "${MAGENTA}Warning:${NC} This module changes your network configuration and it could happen that your system looses network connectivity."
+print_output "${MAGENTA}Warning:${NC} This module changes your network configuration and it could happen that your system looses network connectivity."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "The L22_upnp_hnap_checks module conducts live tests on UPnP, HNAP and JNAP services, using upncp and curl commands to enumerate and log responses from these services on identified HTTP and HTTPs ports."
+print_output "The upnp hnap checks module conducts live tests on UPnP, HNAP and JNAP services, using upncp and curl commands to enumerate and log responses from these services on identified HTTP and HTTPs ports."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module is designed to test the security of an emulated device using the Metasploit framework. It performs Metasploit checks by launching attacks against open ports on the device. It identifies vulnerabilitys and attempts to verify them."
+print_output "The Metasploit module is designed to test the security of an emulated device using the Metasploit framework. It performs Metasploit checks by launching attacks against open ports on the device. It identifies vulnerabilitys and attempts to verify them via active exploitation in the emulated environment."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "The P02_firmware_bin_file_check module conducts an analysis of binary firmware files, extracting key details like checksums and entropy, generating visual entropy graphs and identifying specific firmware types such as UEFI/BIOS, AVM or D-Link encrypted"
+print_output "The firmware bin file check module conducts an analysis of binary firmware files, extracting key details like checksums and entropy, generating visual entropy graphs and identifying specific firmware types such as UEFI/BIOS, AVM or D-Link encrypted"
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module extracts zip, tar, tgz firmware images with patool."
+print_output "This module extracts zip, tar, tgz firmware images with patool."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module extracts zip, tar, tgz firmware images with patool."
+print_output "The patools module extracts zip, tar, tgz firmware images with patool."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module extracts encrypted firmware images from D-Link (See https://github.com/0xricksanchez/dlink-decrypt)"
+print_output "This module extracts encrypted firmware images from D-Link (See https://github.com/0xricksanchez/dlink-decrypt)"
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module extracts AVM firmware images with Freetz-NG (see https://github.com/Freetz-NG/freetz-ng.git)"
+print_output "This module extracts AVM firmware images with Freetz-NG (see https://github.com/Freetz-NG/freetz-ng.git)"
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module shows several details of a Uboot image."
+print_output "The uboot mkimage module shows several details of a Uboot image."
@@ -1,3 +0,0 @@
-#!/bin/bash
-
-print_output "This module mounts and extracts ext2/3 images (currently binwalk destroys the permissions and the symlinks)."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module mounts and extracts ext2/3 images (currently binwalk destroys the permissions and the symlinks)."
+print_output "The ext mounter module mounts and extracts ext2/3 images (currently binwalk destroys the permissions and the symlinks)."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module extracts UBI filesystems via ubireader_extract_images and ubireader_extract_files."
+print_output "The ubi extractor module extracts UBI filesystems via ubireader_extract_images and ubireader_extract_files."
@@ -2,4 +2,4 @@

 print_output "EMBA was able to identify an encrypted ${ORANGE}EnGenius${NC} firmware image. This firmware image was protected with leaked key material and it is possible to decrypt the firmware for further analysis."
 print_ln
-print_output "The original firmware was decrypted to ${ORANGE}${EXTRACTION_FILE}${NC}"
+print_output "The original firmware was decrypted to ${ORANGE}${EXTRACTION_FILE}${NC}"
@@ -2,4 +2,4 @@

 print_output "This module extracts encrypted firmware images from EnGenius reported by @ryancdotorg"
 print_output "See https://twitter.com/ryancdotorg/status/1473807312242442240 and https://gist.github.com/ryancdotorg/914f3ad05bfe0c359b79716f067eaa99 for further details."
-print_ln
+print_ln
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "Extracts gpg compressed (not encrypted) firmware images. This technique is used by multiple Linksys/Belkin firmware images"
+print_output "Extracts gpg compressed (not encrypted) firmware images. This technique is used by multiple Linksys/Belkin firmware images"
@@ -2,4 +2,4 @@

 print_output "EMBA was able to identify an encrypted ${ORANGE}QNAP${NC} firmware image. This firmware image was protected with leaked key material and it is possible to decrypt the firmware for further analysis."
 print_ln
-print_output "The original firmware was decrypted to ${ORANGE}${EXTRACTION_FILE}${NC}"
+print_output "The original firmware was decrypted to ${ORANGE}${EXTRACTION_FILE}${NC}"
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module extracts encrypted firmware images from QNAP as shown here: https://github.com/max-boehm/qnap-utils"
+print_output "The qnap decryptor module extracts encrypted firmware images from QNAP as shown here: https://github.com/max-boehm/qnap-utils"
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "The Android OTA extraction module extracts data from Android OTA payload.bin files using the payload_dumper.py script."
+print_output "The Android OTA extraction module extracts data from Android OTA payload.bin files using the external/payload_dumper/payload_dumper.py script."
@@ -1,5 +1,3 @@
 #!/bin/bash

-print_output "The UEFI extractor module is responsible for analyzing and extracting data from UEFI firmware 
-images, including NVARS, drivers, and architecture details, using the uefi-firmware-parser and 
-UEFITool tools."
+print_output "The UEFI extractor module is responsible for analyzing and extracting data from UEFI firmware images, including NVARS, drivers, and architecture details, using the uefi-firmware-parser and UEFITool tools."
@@ -1,4 +1,4 @@
 #!/bin/bash

 print_output "This module extracts firmware with all available extractors and checks if a root filesystem can be found."
-print_output "As last resort EMBA will try to extract every available file multiple times."
+print_output "As last resort EMBA will try to extract every available file multiple times."
@@ -1,4 +1,4 @@
 #!/bin/bash

 print_output "This module tries to identify the operating system. Currently, it tries to identify VxWorks, eCos, Adonis, Siprotec, uC/OS and Linux."
-print_output "If no Linux operating system is found, then it also tries to identify the target architecture (currently with binwalk only). For Linux operating systems later analysis will do this task."
+print_output "If no Linux operating system is found, then it also tries to identify the target architecture (currently with binwalk only). For Linux operating systems later analysis will do this task."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "The analyzer preparation module  performs essential checks and preparations to ensure successful firmware analysis."
+print_output "The analyzer preparation module performs essential checks and preparations to ensure successful firmware analysis."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module tries to identify the used operating system via simple counting of different keywords and doing some basic heuristics."
+print_output "The firmware bin base analyzer module tries to identify the used operating system via simple counting of different keywords and doing some basic heuristics."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module is responsible for providing details about the firmware and testing information. It detects the number of files and directories present in the firmware, offers insights into release/vetsion information and generates a filesystem tree to visualize the directory structure."
+print_output "The firmware details module is responsible for providing details about the firmware and testing information. It detects the number of files and directories present in the firmware, offers insights into release/vetsion information and generates a filesystem tree to visualize the directory structure."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module tries to identify the main Linux system (e.g. Kali Linux, Debian, Fedora, ...)"
+print_output "The distribution identification module tries to identify the main Linux system (e.g. Kali Linux, Debian, Fedora, ...)"
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module extracts package information from Debian, OpenWRT and RPM packaging systems, including package names and versions."
+print_output "The package mgmt extractor module extracts package information from Debian, OpenWRT and RPM packaging systems, including package names and versions."
@@ -2,4 +2,4 @@

 print_output "This module extracts version and license details from the firmware files."
 print_output "On Linux based systems all binaries are analysed for version details."
-print_output "On Non Linux systems all files are analysed for version details."
+print_output "On Non Linux systems all files are analysed for version details."
@@ -2,4 +2,4 @@

 print_output "This module identifies the usage of critical binary functions in firmware via ${ORANGE}readelf${NC}."
 print_output "Examples of binary functions are system, strcpy, printf and strcat. These functions are listed in the configuration"
-print_output "file config/functions.cfg."
+print_output "file config/functions.cfg."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module extracts version and license details from the results of the user-mode emulation module (s115)."
+print_output "This module extracts version and license details from the results of the user-mode emulation module (s115)."
@@ -3,4 +3,4 @@
 print_output "Modern Linux distributions offer different mitigation techniques to make it harder to exploit software vulnerabilities reliably."
 print_output "Mitigations such as RELRO, NoExecute (NX), Stack Canaries, Address Space Layout Randomization (ASLR) and Position Independent Executables (PIE) have made reliably exploiting any vulnerabilities that do exist far more challenging."
 print_output "Source: https://www.trapkit.de/tools/checksec/"
-print_output "RELRO: https://www.trapkit.de/articles/relro/"
+print_output "RELRO: https://www.trapkit.de/articles/relro/"
@@ -4,4 +4,4 @@ print_output "This module identifies the usage of critical binary functions in f
 print_output "Examples of binary functions are system, strcpy, printf and strcat. These functions are configured in the configuration"
 print_output "file config/functions.cfg. The module counts the usages per binary. For strcpy functions it also counts strlen functions"
 print_output "right before the strcpy function. Additionally it checks if the binary is a known Linux binary or unknown and probably"
-print_output "a vendor binary."
+print_output "a vendor binary."
@@ -4,4 +4,4 @@ print_output "This module identifies the usage of critical binary functions in f
 print_output "Examples of binary functions are system, strcpy, printf and strcat. These functions are configured in the configuration"
 print_output "file config/functions.cfg. The module counts the usages per binary. For strcpy functions it also counts strlen functions"
 print_output "right before the strcpy function. Additionally it checks if the binary is a known Linux binary or unknown and probably"
-print_output "a vendor binary."
+print_output "a vendor binary."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module tries to identify shell scripts and analyses them with shellcheck - https://www.shellcheck.net/."
+print_output "This module tries to identify shell scripts and analyses them with shellcheck - https://www.shellcheck.net/."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module tries to identify the Linux kernel version and the init command line."
+print_output "This module tries to identify the Linux kernel version and the init command line."
@@ -7,4 +7,4 @@ print_output "$(indent "- Identified kernel modules in .o format")"
 print_output "$(indent "- Filesytem path of kernel modules - e.g.: /lib/modules/1.2.3/bla")"
 print_ln
 print_output "Additionally it checks the identified kernel version with the linux-exploit-suggester (https://github.com/mzet-/linux-exploit-suggester) for known exploits."
-print_output "Finally it tests the kernel modules for interesting combination of closed source modules with debugging information. E.g. Non open source modules with debugging information included."
+print_output "Finally it tests the kernel modules for interesting combination of closed source modules with debugging information. E.g. Non open source modules with debugging information included."
@@ -12,4 +12,4 @@ write_link "https://packetstormsecurity.com/files/tags/exploit/"
 print_output "$(indent "${ORANGE}SNYK${NC} - PoC code found on Snyk vulnerability database")"
 write_link "https://security.snyk.io/vuln"
 print_output "$(indent "${ORANGE}EXP${NC} - Vulnerability is known as exploited")"
-write_link "https://www.cisa.gov/known-exploited-vulnerabilities-catalog"
+write_link "https://www.cisa.gov/known-exploited-vulnerabilities-catalog"
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module tries to identify httpd-related files including Nginx, Apache, httpd, lighttpd, cherokee and php.ini files."
+print_output "This module tries to identify httpd-related files including Nginx, Apache, httpd, lighttpd, cherokee and php.ini files."
@@ -9,4 +9,4 @@ write_link "https://redmine.lighttpd.net/projects/lighttpd/wiki/Docs_SSL"
 print_output "$(indent "$(orange "- Alpine Linux - Lighttpd Advanced security")")"
 write_link "https://wiki.alpinelinux.org/wiki/Lighttpd_Advanced_security"
 print_output "$(indent "$(orange "- Hardening guide for lighttpd 1.4.26 on redhat Linux")")"
-write_link "https://security-24-7.com/hardening-guide-for-lighttpd-1-4-26-on-redhat-5-5-64bit-edition/"
+write_link "https://security-24-7.com/hardening-guide-for-lighttpd-1-4-26-on-redhat-5-5-64bit-edition/"
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module tries to identify password related files and analyses found password files for hashes, users and other configuration weaknesses."
+print_output "This module tries to identify password related files and analyses found password files for hashes, users and other configuration weaknesses."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module tries to identify certificate files and checks the validity of the identified certificates."
+print_output "This module tries to identify certificate files and checks the validity of the identified certificates."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module tries to identify different kind of configuration files."
+print_output "This module tries to identify different kind of configuration files."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module tries to identify hidden Linux files."
+print_output "This module tries to identify hidden Linux files."
@@ -1,3 +1,3 @@
 #!/bin/bash

-print_output "This module tries to identify ssh-related files and analyses found sshd configuration files with sshdcc - https://github.com/sektioneins/sshdcc."
+print_output "This module tries to identify ssh-related files and analyses found sshd configuration files with sshdcc - https://github.com/sektioneins/sshdcc."
@@ -1,4 +1,3 @@
 #!/bin/bash

-print_output "This modules searches for interesting binaries like gcc or gdb. Additionally it also searches binaries that could be useful for post exploitation tasks like wget or ftp."
-
+print_output "This modules searches for interesting binaries like gcc or gdb. Additionally it also searches binaries that could be useful for post exploitation tasks like wget or ftp."
@@ -1,4 +1,4 @@
 #!/bin/bash

 print_output "This module tries to identify interesting areas within the firmware with the tool grepit from the CRASS (code review audit script scanner) toolbox."
-print_output "The grepit module name starts with a priority value between 1-9, where 1 is more interesting (low false positive rate, certainty of vulnerability) and 9 is only something you might want to have a look when you are desperately looking for vulnerabilities"
+print_output "The grepit module name starts with a priority value between 1-9, where 1 is more interesting (low false positive rate, certainty of vulnerability) and 9 is only something you might want to have a look when you are desperately looking for vulnerabilities"
@@ -25,6 +25,7 @@ D02_firmware_diffing_bin_details() {

  module_log_init "${FUNCNAME[0]}"
  module_title "Firmware differ - binary details"
+  pre_module_reporter "${FUNCNAME[0]}"
  local NEG_LOG=0

  if ! [[ -f "${FIRMWARE_PATH}" ]]; then
@@ -25,6 +25,7 @@ export PRE_THREAD_ENA=0
 D05_firmware_diffing_extractor() {
  module_log_init "${FUNCNAME[0]}"
  module_title "Firmware diffing - extractor module"
+  pre_module_reporter "${FUNCNAME[0]}"
  local NEG_LOG=0

  local MD5_FW_BIN1=""
@@ -18,7 +18,7 @@
 F21_cyclonedx_sbom() {
  module_log_init "${FUNCNAME[0]}"
  module_title "CycloneDX SBOM converter"
-
+  pre_module_reporter "${FUNCNAME[0]}"
  local F20_LOG="${CSV_DIR}""/f20_vul_aggregator.csv"
  local BIN_VER_SBOM_ARR=()
  local BIN_VER_SBOM_ENTRY=""
@@ -19,6 +19,7 @@
 F50_base_aggregator() {
  module_log_init "${FUNCNAME[0]}"
  module_title "Final aggregator"
+  pre_module_reporter "${FUNCNAME[0]}"

  CVE_AGGREGATOR_LOG="f20_vul_aggregator.txt"
  F20_EXPLOITS_LOG="${LOG_DIR}"/f20_vul_aggregator/exploits-overview.txt
@@ -20,7 +20,7 @@ export PRE_THREAD_ENA=0
 P02_firmware_bin_file_check() {
  module_log_init "${FUNCNAME[0]}"
  module_title "Binary firmware file analyzer"
-
+  pre_module_reporter "${FUNCNAME[0]}"
  set_p02_default_exports

  local FILE_BIN_OUT
@@ -22,6 +22,7 @@ P10_vmdk_extractor() {
  if [[ "${VMDK_DETECTED-0}" -eq 1 ]]; then
    module_log_init "${FUNCNAME[0]}"
    module_title "VMDK (Virtual Machine Disk) extractor"
+    pre_module_reporter "${FUNCNAME[0]}"
    EXTRACTION_DIR="${LOG_DIR}"/firmware/vmdk_extractor/

    vmdk_extractor "${FIRMWARE_PATH}" "${EXTRACTION_DIR}"
@@ -20,6 +20,7 @@ Q02_openai_question() {
    module_log_init "${FUNCNAME[0]}"
    # Prints title to CLI and into log
    module_title "AI analysis via OpenAI"
+    pre_module_reporter "${FUNCNAME[0]}"
    export CHATGPT_RESULT_CNT=0

    # we wait until there arer entries in the question csv
@@ -19,7 +19,7 @@
 S17_apk_check() {
  module_log_init "${FUNCNAME[0]}"
  module_title "Android apk checks"
-
+  pre_module_reporter "${FUNCNAME[0]}"
  apk_identifier
  apk_checker