Zum Inhalt
HALOWERK

Sicherwerk

sbom

Parses package-lock.json, package.json, requirements.txt, go.mod and Cargo.lock and emits a bill of materials in CycloneDX 1.5 or SPDX 2.3, with a package URL per component. The distinction that decides whether the document is worth anything is made explicit: a lockfile names the versions actually installed, a manifest only names ranges, and a bill of materials built from ranges describes what might be installed rather than what is.

POST https://sicher.halowerk.com/v1/sbom

Eingaben

Felder des veröffentlichten Eingabeschemas
FeldTypPflichtBeschreibung
filesarrayJaThe manifest or lock files.
formatstringNeinOutput format.
include_devbooleanNeinInclude development-only dependencies.
project_namestringNeinName for the document metadata.
Vollständiges Eingabeschema anzeigen
{
  "type": "object",
  "required": [
    "files"
  ],
  "additionalProperties": false,
  "properties": {
    "files": {
      "type": "array",
      "minItems": 1,
      "maxItems": 10,
      "description": "The manifest or lock files.",
      "items": {
        "type": "object",
        "required": [
          "content"
        ],
        "additionalProperties": false,
        "properties": {
          "filename": {
            "type": "string",
            "maxLength": 300,
            "description": "File name; the type is detected from content if absent."
          },
          "content": {
            "type": "string",
            "maxLength": 4194304,
            "description": "File contents as text."
          }
        }
      }
    },
    "format": {
      "type": "string",
      "enum": [
        "cyclonedx",
        "spdx",
        "plain"
      ],
      "default": "cyclonedx",
      "description": "Output format."
    },
    "include_dev": {
      "type": "boolean",
      "default": false,
      "description": "Include development-only dependencies."
    },
    "project_name": {
      "type": "string",
      "maxLength": 200,
      "default": "unnamed-project",
      "description": "Name for the document metadata."
    }
  }
}

Originalschema öffnen

Veröffentlichtes Eingabebeispiel

{
  "files": [
    {
      "filename": "package-lock.json",
      "content": "{\"name\": \"synthetic-example\", \"lockfileVersion\": 3, \"packages\": {\"\": {\"name\": \"synthetic-example\"}, \"node_modules/lodash\": {\"version\": \"4.17.21\"}}}"
    }
  ],
  "format": "cyclonedx",
  "project_name": "synthetic-example"
}

Ergebnis & Dokumentation

Veröffentlichtes Ergebnisschema anzeigen
{
  "$ref": "https://sicher.halowerk.com/v1/sbom/schema#/outputSchema"
}

Veröffentlichtes Ergebnisbeispiel öffnen

Maschinenlesbare Dokumentation dieses Hubs

Quelle dieser Seite: der veröffentlichte HALOWERK-Katalog. Stand: 2026-11-01, 15:19 UTC.

Weitere Endpunkte dieses Hubs

Alle Endpunkte dieses Hubs →