Depthcharge documentation

This is the official documentation for NCC Group’s free and open source Depthcharge project.

Source code and releases can be found here:

https://github.com/nccgroup/depthcharge

If you’re new to the project, we recommend starting with the introduction section to get up to speed. For some additional context and inspiration, check out the following blog posts and talks:

• NCC Group Blog Post: Sinking U-Boots with Depthcharge

• Hardwear.io Webinar: …Effective Exploitation of Boot-time Security Debt

• NCC Group Blog Post: …U-Boot Configuration Auditing Introduced in Depthcharge v0.2.0

• OSFC 2020 Talk: Guiding Engineering Teams Toward a More Secure Usage of U-Boot

Contents:

• Introduction
  • What is Depthcharge?
  • Why did we create this?
  • Will this be useful for my situation?
  • What are some of its key features?
  • How do I get started?
• Python Scripts
  • depthcharge-audit-config
  • depthcharge-inspect
  • depthcharge-print
  • depthcharge-read-mem
  • depthcharge-write-mem
  • depthcharge-find-cmd
  • depthcharge-find-env
  • depthcharge-mkenv
  • depthcharge-find-fdt
  • depthcharge-stratagem
• Python API
  • depthcharge
  • depthcharge.cmdline
  • depthcharge.checker
  • depthcharge.executor
  • depthcharge.hunter
  • deptcharge.log
  • depthcharge.memory
  • depthcharge.monitor
  • depthcharge.register
  • depthcharge.string
  • depthcharge.uboot
• Companion Firmware
  • Overview
  • Implementation
  • Command Set
• Troubleshooting
  • Debug Log Output
  • Monitor Log
  • Console Quirks