Rövid útmutató: Belső vezérlőprogram-rendszerképek feltöltése a Defender for IoT Firmware Analysisbe a Python használatával

Ez a cikk bemutatja, hogyan tölthet fel belső vezérlőprogram-lemezképeket Python-szkripttel a Defender for IoT Firmware Analysis szolgáltatásba.

Az IoT-vezérlőprogram-elemzéshez készült Defender egy eszköz, amely elemzi a belső vezérlőprogram lemezképeit, és a belső vezérlőprogram-rendszerképek biztonsági réseinek megértését biztosítja.

Előfeltételek

Ez a rövid útmutató feltételezi az IoT-vezérlőprogram-elemzéshez készült Defender alapszintű megértését. További információt az eszközkészítők belső vezérlőprogram-elemzésében talál. A támogatott fájlrendszerek listáját az IoT-vezérlőprogram-elemzéshez készült Defenderrel kapcsolatos gyakori kérdések című témakörben találja.

A környezet előkészítése

• A csomag használatához a Python 3.8+-os verziója szükséges. Futtassa a parancsot python --version a Python-verzió ellenőrzéséhez.
• Jegyezze fel az Azure-előfizetés azonosítóját, az erőforráscsoport nevét, ahová fel szeretné tölteni a rendszerképeket, a munkaterület nevét és a feltölteni kívánt belső vezérlőprogram-rendszerkép nevét.
• Győződjön meg arról, hogy az Azure-fiókja rendelkezik a belső vezérlőprogram-rendszerképek Azure-előfizetéshez készült Defender for IoT Firmware Analysisbe való feltöltéséhez szükséges engedélyekkel. A belső vezérlőprogram-rendszerképek feltöltéséhez tulajdonosnak, közreműködőnek, biztonsági Rendszergazda vagy belső vezérlőprogram-elemzési Rendszergazda kell lennie az előfizetés vagy az erőforráscsoport szintjén. További információ: Defender for IoT Firmware Analysis Roles, Scopes, and Capabilities.
• Győződjön meg arról, hogy a belső vezérlőprogram lemezképe ugyanabban a könyvtárban van tárolva, mint a Python-szkript.
• Telepítse a szkript futtatásához szükséges csomagokat:

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

• Jelentkezzen be az Azure-fiókjába a parancs futtatásával az login.

Futtassa a következő Python-szkriptet

Másolja a következő Python-szkriptet egy .py fájlba, és mentse a belső vezérlőprogram lemezképével megegyező könyvtárba. Cserélje le a subscription_id változót az Azure-előfizetés azonosítójára, az erőforráscsoport nevére, resource_group_name ahová fel szeretné tölteni a belső vezérlőprogram rendszerképét, valamint firmware_file a belső vezérlőprogram-rendszerkép nevét, amelyet a Rendszer a Python-szkripttel megegyező könyvtárba ment.

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())