快速入門：使用 Python 將韌體映射上傳至韌體分析

本文說明如何使用 Python 腳本將韌體映像上傳至韌體分析。

韌體分析是一種工具 ，可分析韌體映像，並瞭解韌體映射中的安全性弱點。

必要條件

本快速入門假設對韌體分析有基本瞭解。 如需詳細資訊，請參閱裝置建立器的韌體分析。 如需支援的文件系統清單，請參閱 韌體分析的常見問題。

準備您的環境

1. 需要 Python 3.8+ 版才能使用此套件。 執行 命令 python --version 來檢查您的 Python 版本。
2. 記下您的 Azure 訂用帳戶標識碼、您想要上傳映射的資源群組名稱、工作區名稱，以及您想要上傳的韌體映像名稱。
3. 請確定您的 Azure 帳戶具有將韌體映像上傳至 Azure 訂用帳戶韌體分析的必要許可權。 您必須是訂用帳戶或資源群組層級的擁有者、參與者、安全性系統管理員或韌體分析管理員，才能上傳韌體映像。 如需詳細資訊，請瀏覽 韌體分析角色、範圍和功能。
4. 請確定您的韌體映像儲存在與 Python 腳本相同的目錄中。
5. 安裝執行此文稿所需的套件：

   pip install azure-mgmt-iotfirmwaredefense
   pip install azure-identity
   

6. 執行 命令 az login來登入您的 Azure 帳戶。

執行下列 Python 腳本

將下列 Python 腳本複製到檔案中，並將它儲存至 .py 與韌體映像相同的目錄。 將 subscription_id 變數取代為您的 Azure 訂用帳戶標識碼， resource_group_name 並將變數取代為您想要上傳韌體映射的資源群組名稱，並將 firmware_file 它儲存在與 Python 腳本相同的目錄中。

from azure.identity import AzureCliCredential
from azure.mgmt.iotfirmwaredefense import *
from azure.mgmt.iotfirmwaredefense.models import *
from azure.core.exceptions import *
from azure.storage.blob import BlobClient
import uuid
from time import sleep
from halo import Halo
from tabulate import tabulate

subscription_id = "subscription-id"
resource_group_name = "resource-group-name"
workspace_name = "default"
firmware_file = "firmware-image-name"

def main():
    firmware_id = str(uuid.uuid4())
    fw_client = init_connections(firmware_id)
    upload_firmware(fw_client, firmware_id)
    get_results(fw_client, firmware_id)

def init_connections(firmware_id):
    spinner = Halo(text=f"Creating client for firmware {firmware_id}")
    cli_credential = AzureCliCredential()
    client = IoTFirmwareDefenseMgmtClient(cli_credential, subscription_id, 'https://management.azure.com')
    spinner.succeed()
    return client

def upload_firmware(fw_client, firmware_id):
    spinner = Halo(text="Uploading firmware to Azure...", spinner="dots")
    spinner.start()
    token = fw_client.workspaces.generate_upload_url(resource_group_name, workspace_name, {"firmware_id": firmware_id})
    fw_client.firmwares.create(resource_group_name, workspace_name, firmware_id, {"properties": {"file_name": firmware_file, "vendor": "Contoso Ltd.", "model": "Wifi Router", "version": "1.0.1", "status": "Pending"}})
    bl_client = BlobClient.from_blob_url(token.url)
    with open(file=firmware_file, mode="rb") as data:
        bl_client.upload_blob(data=data)
    spinner.succeed()

def get_results(fw_client, firmware_id):
    fw = fw_client.firmwares.get(resource_group_name, workspace_name, firmware_id)

    spinner = Halo("Waiting for analysis to finish...", spinner="dots")
    spinner.start()
    while fw.properties.status != "Ready":
        sleep(5)
        fw = fw_client.firmwares.get(resource_group_name, workspace_name, firmware_id)
    spinner.succeed()

    print("-"*107)

    summary = fw_client.summaries.get(resource_group_name, workspace_name, firmware_id, summary_name=SummaryName.FIRMWARE)
    print_summary(summary.properties)
    print()

    components = fw_client.sbom_components.list_by_firmware(resource_group_name, workspace_name, firmware_id)
    if components is not None:
        print_components(components)
    else:
        print("No components found")

def print_summary(summary):
    table = [[summary.extracted_size, summary.file_size, summary.extracted_file_count, summary.component_count, summary.binary_count, summary.analysis_time_seconds, summary.root_file_systems]]
    header = ["Extracted Size", "File Size", "Extracted Files", "Components", "Binaries", "Analysis Time", "File Systems"]
    print(tabulate(table, header))

def print_components(components):
    table = []
    header = ["Component", "Version", "License", "Paths"]
    for com in components:
        table.append([com.properties.component_name, com.properties.version, com.properties.license, com.properties.file_paths])
    print(tabulate(table, header, maxcolwidths=[None, None, None, 57]))

if __name__ == "__main__":
    exit(main())