fwhunt scan

เครื่องสแกนชุมชน fwhunt

เครื่องมือสำหรับการวิเคราะห์เฟิร์มแวร์ UEFI และตรวจสอบโมดูล UEFI ด้วยกฎ FWHUNT

การพึ่งพาอาศัยกัน

Rizin (v0.6.2)

การติดตั้ง

ติดตั้งด้วย pip (ทดสอบบน python3.6 ขึ้นไป):

 $ python -m pip install fwhunt-scan

ติดตั้งด้วยตนเอง:

 $ git clone https://github.com/binarly-io/fwhunt-scan.git && cd fwhunt-scan
$ python setup.py install

ตัวอย่าง

ด้วยสคริปต์

วิเคราะห์/สแกนโมดูลแยกต่างหาก:

 $ python3 fwhunt_scan_analyzer.py analyze-module {image_path} -o out.json
$ python3 fwhunt_scan_analyzer.py scan-module --rule {rule_path} {image_path}

สแกนภาพเฟิร์มแวร์ทั้งหมด:

 $ python3 fwhunt_scan_analyzer.py scan-firmware -r rules/BRLY-2021-001.yml -r rules/BRLY-2021-004.yml -r rules/RsbStuffingCheck.yml test/fw.bin

กับ Docker

เพื่อหลีกเลี่ยงการติดตั้งการพึ่งพาคุณสามารถใช้อิมเมจนักเทียบท่า

คุณสามารถสร้างอิมเมจนักเทียบท่าได้ในพื้นที่ดังนี้:

 docker build -t fwhunt_scan .

หรือดึงภาพล่าสุดจาก GHCR

ตัวอย่างการใช้งาน:

 docker run --rm -it -v {module_path}:/tmp/image:ro 
  fwhunt_scan analyze-module /tmp/image # to analyze EFI module

docker run --rm -it -v {module_path}:/tmp/image:ro -v {rule_path}:/tmp/rule.yml:ro 
  fwhunt_scan scan-module /tmp/image -r /tmp/rule.yml # to scan EFI module with specified FwHunt rule

docker run --rm -it -v {module_path}:/tmp/image:ro -v {rule_path}:/tmp/rule.yml:ro 
  fwhunt_scan scan-firmware /tmp/image -r /tmp/rule.yml # to scan firmware image with specified FwHunt rule

docker run --rm -it -v {module_path}:/tmp/image:ro -v {rules_directory}:/tmp/rules:ro 
  fwhunt_scan scan-firmware /tmp/image --rules_dir /tmp/rules # to scan firmware image with specified rules directory

ขั้นตอนทั้งหมดเหล่านี้เป็นไปโดยอัตโนมัติในสคริปต์ fwhunt_scan_docker.py :

 python3 fwhunt_scan_docker.py analyze-module {module_path} # to analyze EFI module

python3 fwhunt_scan_docker.py scan-module -r {rule_path} {module_path} # to scan EFI module with specified FwHunt rule

python3 fwhunt_scan_docker.py scan-firmware -r {rule_path} {firmware_path} # to scan firmware image with specified FwHunt rule

python3 fwhunt_scan_docker.py scan-firmware --rules_dir {rules_directory} {firmware_path} # to scan firmware image with specified rules directory

จากรหัส

Uefianalyzer

ตัวอย่างการใช้งานพื้นฐาน:

 from fwhunt_scan import UefiAnalyzer

...
uefi_analyzer = UefiAnalyzer ( image_path = module_path )
print ( uefi_analyzer . get_summary ())
uefi_analyzer . close ()

 from fwhunt_scan import UefiAnalyzer

...
with UefiAnalyzer ( image_path = module_path ) as uefi_analyzer :
    print ( uefi_analyzer . get_summary ())

บนแพลตฟอร์ม Linux คุณสามารถผ่าน Blob สำหรับการวิเคราะห์แทนไฟล์:

 from fwhunt_scan import UefiAnalyzer

...
with UefiAnalyzer ( blob = data ) as uefi_analyzer :
    print ( uefi_analyzer . get_summary ())

uefiscanner

 from fwhunt_scan import UefiAnalyzer , UefiRule , UefiScanner

...
uefi_analyzer = UefiAnalyzer ( module_path )

# rule1 and rule2 - contents of the rules on YAML format
uefi_rules = [ UefiRule ( rule1 ), UefiRule ( rule2 )]

scanner = UefiScanner ( uefi_analyzer , uefi_rules )
result = scanner . result