Software Bill of Materials Dateien mit einer REST-API werden hochgeladen

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 1 Minute Lesedauer

    • Überprüfen Sie die folgenden Informationen, bevor Sie Software Bill of Materials -Dateien mit einer API hochladen.

    REST-API

    Um Daten mit einer API hochzuladen, verwenden Sie den folgenden geskripteten REST-Endpunkt. Die Rolle sn_sbom_core.sbom_ingest ist erforderlich.

    <host_name/api/sbom/core/upload.
    Hinweis:
    <host_name>ist Ihr Instanzname ServiceNow .

    Nachdem SBOM erfolgreich verarbeitet wurde, hängt es von den verwendeten Anwendungen ab, wo Sie die hochgeladenen Datensätze anzeigen.

    • Wenn Sie SBOM Response verwenden, wird der Datensatz der Stücklistenentität in der Liste SBOM „ Ingestion Status“ (Erfassungsstatus) im Modul „BOM-Warteschlange“ im Arbeitsbereich SBOM angezeigt.
    • Wenn Sie SBOM Core verwenden, navigieren Sie zu SBOM-Core > Stücklisten-Erfassungsstatus.

    Verwenden der REST-API

    Sie können nur SBOM Dateien im JSON-Format „CycloneDX“ hochladen.

    Wenn der aufrufende Benutzer erfolgreich authentifiziert wurde und die Rolle sn_sbom_core.sbom_ingest in Ihrer Instanz ServiceNow hat, können Sie von außerhalb Ihrer Instanz auf die API zugreifen, um die Daten SBOM hochzuladen.

    SBOM -Inhalt kann entweder als Text der HTTP-Anforderung oder über eine Befehlszeilenanforderung mit einer SBOM -Datendatei an die API gesendet werden. Beispielsweise können Sie das Befehlszeilentool curl verwenden, sofern Ihre Benutzer über einen eigenen Prozess zum Verwalten der Dateien verfügen.

    Darüber hinaus können Sie die sys_id des Produktmodells und die Geschäftsanwendung in Ihre Abfrageparameter aufnehmen. Die Stücklistenentität wird diesen Parametern zugeordnet, wenn Sie sie einbeziehen. Die folgenden Parameter werden unterstützt:

    • produktModellId
    • Geschäftsanwendungs-ID

    Jeder API-Aufruf wird in die Warteschlange gestellt, und eine sys_id des Datensatzes in der Warteschlange wird als API-Antwort zurückgegeben.

    Über die REST-API werden die Daten SBOM an Ihre Instanz Now Platform ] gesendet.

    Nachdem die Daten hochgeladen wurden, werden sie analysiert. Bevor Daten analysiert werden, werden die folgenden Anforderungen überprüft:

    • Bei eingehenden Daten wird überprüft, ob es sich um gültige JSON-Daten handelt.
    • Das Stücklistenformat wird unterstützt. Für diese Integration wird nur das Format „CycloneDX“ unterstützt.
    • Die Mindestanzahl von Feldern ist verfügbar, damit Daten analysiert werden können.

    Nachdem diese Prüfungen verifiziert wurden, erfolgt ein Eintrag in der Tabelle „Stückliste“ [sn_sbom_doc] mit eingehenden SBOM Daten als Anhang.

    Die Geschäftsregel Process BOM file wird automatisch als Ergebnis der Datensatzeinfügung und Datenanalyse ausgelöst.
    Hinweis:
    Diese Geschäftsregel wird während der Installation von SBOM Core standardmäßig aktiviert.

    Alle in einem SBOM aufgeführten Komponenten haben einen definierten Typ.

    • Komponenten, für die SBOM Dateien hochgeladen wurden, werden als Stücklistenentitäten betrachtet.
    • Komponenten, die als type=library aufgeführt sind, werden als Komponenten von Drittparteien betrachtet.