OSIRIS JSON Producers

OSIRIS Producers sind schreibgeschützte Snapshot-Werkzeuge, die sich mit Infrastrukturplattformen verbinden, Topologie- und Konfigurationsdaten erfassen und ein standardkonformes OSIRIS-JSON-Dokument ausgeben. Jeder Producer ist auf einen bestimmten Anbieter oder eine bestimmte Cloud-Plattform ausgerichtet.

Was Producers tun

Ein Producer führt vier Schritte aus:

Verfügbare Producers

Producers werden schrittweise veröffentlicht. Cisco ist der erste verfügbare Producer, weitere sind geplant und werden folgen.

Installation

Producers werden als Go-Binärdateien verteilt. Sie benötigen Go 1.25+.

Installieren Sie alles (Core-Dispatcher + alle verfügbaren Anbieter-Producers):

go install go.osirisjson.org/producers/cmd/...@latest

Oder installieren Sie nur, was Sie benötigen: den Core-Dispatcher und einen bestimmten Anbieter-Producer:

go install go.osirisjson.org/producers/cmd/osirisjson-producer@latest
go install go.osirisjson.org/producers/cmd/osirisjson-producer-cisco@latest

Die folgende Tabelle listet alle installierbaren Packages auf:

Der Core-Dispatcher (osirisjson-producer) erkennt Anbieter-Binärdateien in Ihrem PATH und leitet den Befehl an die richtige weiter. Ohne ihn müssen Sie die Anbieter-Binärdatei direkt mit ihrem vollständigen Namen aufrufen, zum Beispiel osirisjson-producer-cisco statt osirisjson-producer cisco.

Stellen Sie sicher, dass $GOPATH/bin (oder $HOME/go/bin) in Ihrem PATH enthalten ist.

Form der Producer-CLI

Alle Producers verwenden eine Dispatcher-CLI:

osirisjson-producer <vendor> [subcommand] [flags]

Die Ausgabe wird anschließend immer über die OSIRIS-JSON-CLI validiert, zum Beispiel:

osirisjson-producer <vendor> <subcommand> --host device.example.com > snapshot.json
npx @osirisjson/cli validate --profile strict snapshot.json

Typischer Workflow

Für Solution Architects und Auditoren wird folgender Workflow empfohlen:

1. Führen Sie den Producer aus auf Ihrer Zielplattform mit den passenden Anmeldedaten.
2. Validieren Sie die Ausgabe mit @osirisjson/cli und dem Profil strict.
3. Prüfen Sie den Snapshot als Architekturartefakt, speichern Sie ihn, vergleichen Sie ihn über die Zeit und fügen Sie ihn Audits hinzu.

# Generate snapshot
osirisjson-producer cisco apic -h apic.example.com -u admin > snapshot.json

# Validate
npx @osirisjson/cli validate --profile strict snapshot.json

# Compare with previous snapshot
diff <(jq -S . previous.json) <(jq -S . snapshot.json)

Sicherheit

Der Quellcode der Producers wird kontinuierlich von SonarCloud auf Schwachstellen, Code Smells und Sicherheits-Hotspots analysiert. Jeder Pull Request muss ein Quality Gate bestehen, das eine A security rating erzwingt, bevor er zusammengeführt werden kann.

Zusätzlich enthalten Producers integrierte Sicherheitsleitplanken:

• Secret redaction - die Flag --safe-failure-mode (Standard: fail-closed) verhindert, dass Anmeldedaten und sensible Werte in die JSON-Ausgabe gelangen.
• Read-only access - Producers ändern niemals die Gerätekonfiguration. Alle API-Aufrufe und NETCONF-RPCs sind schreibgeschützte Operationen.
• No persistent storage - Producers cachen keine Anmeldedaten und speichern keine Daten über die ausgegebene JSON-Datei hinaus.

Was Sie als Nächstes lesen sollten

• Lesen Sie die anbieterspezifischen Producer-Seiten für Details zu Installation, Quellsystemen, Authentifizierung und Ausgabebereich.
• Lesen Sie den Validierungsleitfaden, um zu verstehen, wie die Producer-Ausgabe überprüft wird.
• Sehen Sie sich das IT-Infrastrukturbeispiel und das OT-Infrastrukturbeispiel für ein vollständiges Beispiel eines OSIRIS-JSON-Dokuments an.