Hacking Tools

Adding A Hardware Profile : A Step-by-Step Tutorial For System Configuration

If you need to add new hardware you have to follow the following process:

  1. Create a hardware profile {name}.yaml file and name it as you wish. For example, default.yaml which should be stored in the hardware directory
  2. Then add variables to the profile description using YAML. Each variable has its role during processing. They are described in “Hardware parameters documentation”
name: "default"
description: "Default Linux/ubuntu profile"
setup_verification: ""
needs_setup_verification: false
working_directory: null
bt_version_min: 1.0
bt_version_max: 5.3
  1. Only If your hardware profile needs setup verification and you set needs_setup_verification: true, then you need to add code that would verify the hardware setup.
    1. As the toolkit is written in Python 3 it should be Python 3 code, but if have already a code snippet that verifies your hardware, then you could use it and just add code that would call your verification tool from the toolkit and then distinguish between “available” and “not available” hardware.
    2. The only file that should be modified is setupverification/setupverfication.py
    3. First you need to add a static method that would return a boolean value to the SetupVerifier class, change {YOURHARDWARENAME} to your hardware profile name, and add your code to {YOUR CODE}
@staticmethod
def check_setup_{YOURHARDWARENAME}() -> bool:
 try:
  {YOUR CODE}
  return True
 except Exception as e:
  logging.info("SetupVerfier -> Error during checking setup")
 return False
  1. Then you need to add your newly created static method to the hardware_verifier dictionary variable, as in the example below.
    • You need to change {YOURHARDWARENAME} to the name of the hardware profile you used. Also don’t forget to add a comma where needed.
hardware_verfier = {
"esp32": SetupVerifier.check_setup_esp32,
"nexus5": SetupVerifier.check_setup_nexus5,
"{YOURHARDWARENAME}": SetupVerfiier.check_setup_{YOURHARDWARENAME}
}
Varshini

Varshini is a Cyber Security expert in Threat Analysis, Vulnerability Assessment, and Research. Passionate about staying ahead of emerging Threats and Technologies.

Recent Posts

Nmap cheat sheet for beginners

Nmap (Network Mapper) is a free tool that helps you find devices on a network,…

23 hours ago

Understanding the Model Context Protocol (MCP) and How It Works

Introduction to the Model Context Protocol (MCP) The Model Context Protocol (MCP) is an open…

1 week ago

The file Command – Quickly Identify File Contents in Linux

While file extensions in Linux are optional and often misleading, the file command helps decode what a…

1 week ago

How to Use the touch Command in Linux

The touch command is one of the quickest ways to create new empty files or update timestamps…

1 week ago

How to Search Files and Folders in Linux Using the find Command

Handling large numbers of files is routine for Linux users, and that’s where the find command shines.…

1 week ago

How to Move and Rename Files in Linux with the mv Command

Managing files and directories is foundational for Linux workflows, and the mv (“move”) command makes it easy…

1 week ago