Quickstart: Firmware-installatiekopieën uploaden naar firmwareanalyse met behulp van Python

In dit artikel wordt uitgelegd hoe u een Python-script gebruikt om firmware-installatiekopieën te uploaden naar firmwareanalyse.

Firmwareanalyse is een hulpprogramma dat firmware-installatiekopieën analyseert en inzicht biedt in beveiligingsproblemen in de firmware-installatiekopieën.

Vereisten

In deze quickstart wordt ervan uitgegaan dat u basiskennis hebt van firmwareanalyse. Zie Firmwareanalyse voor apparaatbouwers voor meer informatie. Zie Veelgestelde vragen over firmwareanalyse voor een lijst met ondersteunde bestandssystemen.

Uw omgeving voorbereiden

1. Python versie 3.8+ is vereist voor het gebruik van dit pakket. Voer de opdracht python --version uit om uw Python-versie te controleren.
2. Noteer uw Azure-abonnements-id, de naam van uw resourcegroep waar u uw afbeeldingen, de naam van uw werkruimte en de naam van de firmware-installatiekopieën wilt uploaden die u wilt uploaden.
3. Zorg ervoor dat uw Azure-account over de benodigde machtigingen beschikt om firmware-installatiekopieën te uploaden naar firmwareanalyse voor uw Azure-abonnement. U moet eigenaar, inzender, beveiligingsbeheerder of firmwareanalysebeheerder zijn op abonnements- of resourcegroepniveau om firmware-installatiekopieën te kunnen uploaden. Ga naar Rollen, bereiken en mogelijkheden voor firmwareanalyse voor meer informatie.
4. Zorg ervoor dat uw firmware-installatiekopieën zijn opgeslagen in dezelfde map als het Python-script.
5. Installeer de pakketten die nodig zijn om dit script uit te voeren:

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

6. Meld u aan bij uw Azure-account door de opdracht az loginuit te voeren.

Voer het volgende Python-script uit

Kopieer het volgende Python-script naar een .py bestand en sla het op in dezelfde map als uw firmware-installatiekopie. Vervang de subscription_id variabele door uw Azure-abonnements-id, resource_group_name door de naam van uw resourcegroep waar u de firmware-installatiekopieën wilt uploaden en firmware_file door de naam van uw firmware-installatiekopieën, die worden opgeslagen in dezelfde map als het Python-script.

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