fwhunt scan

FWHUNTコミュニティスキャナー

UEFIファームウェアを分析し、FWHUNTルールを使用してUEFIモジュールをチェックするツール。

依存関係

リジン（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画像を使用できます。

次のようにローカルで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