Skip to main content

How To Use

General​

After installation, the Firmware_Vault UI can be accessed by visiting the URL http://localhost:80.

Software Components & Their Functions​

Firmware Vault​

  • Manages firmware selection and analysis
  • Users can browse, select and configure jobs to analyze firmware using tools like binwalk, cve-bin-tool and firmwalker
  • Executes SQL queries to filter firmware data dynamically

Data Explorer​

  • Provides a SQL query builder and execution interface
  • Users can select tables and columns to dynamically generate SQL queries
  • Runs queries on the database and displays results in a structured table

Job Dashboard​

Jobs Component​

  • Displays job history and allows users to filter/search for specific jobs
  • Provides an interface to track job execution status and manage running jobs

Job Details Component​

  • Displays detailed execution logs and tasks related to a specific job
  • Allows users to toggle job status and view output logs

Firmware Vault​

Firmware Vault

Selecting Firmware​

  • Browse, select and deselect the available firmware in the Firmware Vault section (1)
  • Selected items can be viewed in the Selected Firmware Section (4) by pressing the Show Selected button on the bottom right corner
  • The entire group of selected items can be unselected with the Clear All button in the Selected Firmware Section (4)
  • The Selected Firmware Section (4) can be collapsed by pressing the Hide Selected button
  • All available firmware images can be selected with the Select All button in the top right corner

Configuring Jobs​

The Job Configuration Section (2) allows the following inputs:

  • Job Name in the name field
  • One Analysis Tool can be selected at a time:
  • A Cron Expression can be defined in the cron field to schedule the analysis jobs (optional)
  • If needed, the reanalyze checkbox can be enabled

The specified job will be executed, or queued if a cron expression is given, when the start job button (3) is pressed. The execution of the tasks is done in parallel. Output of the analysis tool is placed into an output.txt in the file system (volume: executor).

Additional information about the Firmware Vault UI can be found on the Firmware Vault documentation page.

For information on cron expressions visit this google documentation.

For help on how to use cron expressions a cron expression generator can be used.

Data Explorer​

Data Explorer

Selecting Data​

The database can be searched using the SQL Query field, Selected Tables and Selected Columns menus (1)

  • It is possible to directly type SQL queries into the SQL Query field
  • Tables can be selected from the Selected Tables Dropdown menu
  • Columns can be selected from the Selected Columns Dropdown menu
  • The SQL Query Editor dynamically updates to reflect selections
  • You can manually edit the SQL query in the editor

Query Execution​

  • Clicking the Search button (2) button sends the query to the backend (image.service.ts)
  • The results will be displayed in a structured table

Reset Functionality​

  • Clicking the Reset button (3) clears all selected tables, columns, and queries

Additional information about the Data Explorer can be found on the Data Explorer documentation page.

Job Dashboard​

Job Dashboard

Jobs​

The job Dashboard provides a history of jobs and their status

  • Jobs can be searched with the Search for Job name field
  • Jobs can be filtered by "Single execution" or "continuous execution" with the Filter dropdown menu
  • The filter can be reset by pressing the Reset Filter button
  • Even more filter options are provided via the column search fields

Job Information​

To view details of a job the Open button in the Actions Column can be pressed

  • View tasks associated with a job, including execution time and results
  • With the Toggle Job button job execution can be enabled or disabled
  • Expand job logs by clicking on the Full Output section

Job Information

Additional information about the Job Dashboard can be found on the Job Dashboard documentation page.