FitConnect.Helper.Cli 3.2.4

FIT-Connect Helper CLI

Dieses Tool unterstützt Entwickler bei der Integration von FIT-Connect, insbesondere bei der Zertifikatsprüfung, der Destination-Inspektion und dem Versand von Nachrichten über den ZBP-Adapter (Zentrales Bürgerpostfach).

Voraussetzungen

• .NET SDK: Mindestens Version 8.0 (optimiert für .NET 10.0).
• FIT-Connect Credentials: ClientId und ClientSecret für die jeweilige Umgebung (Test, Stage, Prod).
• ZBP-Zertifikate: Für den send-zbp Befehl werden ein Author-Zertifikat (.cer) und der dazugehörige Private Key (.key) benötigt.
• Projekt-Referenzen: Die CLI benötigt Zugriff auf die Projekte FitConnect und FitConnect.Zbp.

Installation

Navigiere in das Stammverzeichnis des SDKs und stelle sicher, dass alle Abhängigkeiten geladen sind:

dotnet restore

Verwendung

Die CLI verwendet ein Subcommand-System. Die Umgebung steht bei allen Befehlen an erster Stelle nach dem Kommando.

dotnet run --project FitConnect.Helper.Cli <command> <environment> [parameter]

Globale Optionen

• -v, --verbose: Aktiviert maximales Logging (Trace). In diesem Modus werden alle API-Anfragen, Antworten und internen SDK-Vorgänge auf der Konsole ausgegeben. Ideal zum Debuggen.
• Auto-Umgebung: Bei den Befehlen check und inspect kann anstelle einer festen Umgebung (test, stage, prod) das Schlüsselwort auto verwendet werden. Die CLI sucht dann automatisch in allen bekannten Umgebungen nach der angegebenen Destination.

1. Zertifikatsprüfung (check)

Prüft die öffentlichen Schlüssel einer Destination auf Gültigkeit, Schlüssellänge und die korrekte Zertifikatskette gegen die FIT-Connect Root-Zertifikate.

Syntax:

dotnet run --project FitConnect.Helper.Cli check <prod|stage|test|auto> <DestinationId>

Beispiel (Auto):

dotnet run --project FitConnect.Helper.Cli check auto aa3704d6-8bd7-4d40-a8af-501851f93934

2. Destination Inspektion (inspect)

Lädt Informationen über eine Destination. Wenn ClientId und ClientSecret angegeben werden, werden zusätzlich die Attachment-Limits geladen. Ohne Credentials erfolgt eine anonyme Abfrage der öffentlichen Daten.

Syntax:

dotnet run --project FitConnect.Helper.Cli inspect <prod|stage|test|auto> <DestinationId> [ClientId] [ClientSecret]

Beispiel (Auto):

dotnet run --project FitConnect.Helper.Cli inspect auto aa3704d6-8bd7-4d40-a8af-501851f93934

3. ZBP-Nachricht senden (send-zbp)

Erstellt eine Submission mit dem ZBP-Reply-Channel und sendet diese an den ZBP-Adapter. Das Tool wartet anschließend auf die Bestätigung (Accept) durch den Adapter.

Syntax:

dotnet run --project FitConnect.Helper.Cli send-zbp <prod|stage|test> <ClientId> <ClientSecret> <MailboxGuid> [certPath] [keyPath] [DestinationId]

Parameter:

• <ClientId> / <ClientSecret>: Deine FIT-Connect Zugangsdaten.
• <MailboxGuid>: Die Ziel-Mailbox-ID im ZBP (Empfänger).
• [certPath] (Optional): Pfad zum Author-Zertifikat (.cer).
• [keyPath] (Optional): Pfad zum Private Key (.key).
• [DestinationId] (Optional): Die Destination-ID des ZBP-Adapters. Falls nicht angegeben, wird für test die Standard-ID b21c51d0-324b-4df4-ae6c-c0568a2bb067 verwendet.

Hinweis zu Zertifikaten: Werden certPath und keyPath weggelassen, generiert die CLI automatisch ein temporäres, selbstsigniertes Zertifikat. Dies funktioniert jedoch nur, wenn der Ziel-Adapter solche Zertifikate zu Testzwecken akzeptiert.

Beispiel (mit Zertifikaten):

dotnet run --project FitConnect.Helper.Cli send-zbp test my-client-id my-secret b3500e62-347c-4553-93f6-9149fd71d9db ./private/author.cer ./private/author.key

Struktur des Projekts

• Program.cs: Einstiegspunkt und Argument-Parsing.
• CertificateChecker.cs: Logik zur Validierung von Destination-Keys.
• Inspector.cs: Logik zur Abfrage von Destination-Details.
• ZbpSender.cs: Logik zum Erstellen und Übermitteln von ZBP-Nachrichten.
• ConsoleLogger.cs: Hilfsklasse für formatierte Log-Ausgaben.