Zum Hauptinhalt springen

Passwork CLI

Passwork CLI ist ein Befehlszeilentool zum Abrufen von Passwörtern aus Passwork und zur sicheren Arbeit mit Skripten, Automatisierung und CI/CD.

Hauptbetriebsmodi

  • exec — ruft Passwörter aus Elementen oder Shortcuts ab, speichert sie in Umgebungsvariablen und führt den angegebenen Befehl mit diesen Variablen aus.
  • get — ruft den Feldwert eines Elements oder Shortcuts ab, entschlüsselt ihn lokal und leitet ihn an STDOUT weiter.
  • update — aktualisiert sicher ein Feld eines Elements oder Shortcuts über die CLI.
  • api — ermöglicht die Ausführung beliebiger Passwork-API-Methoden und den Empfang einer Antwort im JSON-Format.

Wofür Passwork CLI eingesetzt wird

  • Sichere Verbindung zu Datenbanken und Diensten — Passwörter werden nicht auf der Festplatte gespeichert, erscheinen nicht im Befehlsverlauf und werden nur während der Befehlsausführung eingesetzt.
  • Deployment-Automatisierung und CI/CD — Geheimnisse aus Passwork sind automatisch in Pipelines verfügbar.
  • Serveradministration — Aufgaben werden mit temporären Umgebungsvariablen ausgeführt.
  • Integration mit DevOps-Tools — schnelles Abrufen von Passwörtern für Skripte, Ansible, Terraform und andere Tools.

Weitere Vorteile von Passwork CLI

  • Zugriff auf Passwörter nur während der Prozessausführung
  • Unterstützung selbstsignierter Zertifikate
  • Flexible Filterung von Elementen nach Tags, Ordnern und Tresoren
  • Alle Daten werden clientseitig verschlüsselt (wenn der clientseitige Verschlüsselungsmodus aktiviert ist)

Installation

Sie können das Paket direkt von Github installieren:

pip install git+ssh://[email protected]:passwork-me/passwork-python.git

oder

pip install git+https://github.com/passwork-me/passwork-python.git

Anwendungsbeispiele

EXEC-Modus — Befehle mit angegebenen Umgebungsvariablen ausführen

Starten einer Datenbank mit dem Passwort aus einem Element:

passwork-cli exec --password-id "db_password_id" \
mysql -u admin -h localhost -p"$DB_PASSWORD" database_name

GET-Modus — Datenabruf

Passwort eines Elements anhand der ID abrufen:

passwork-cli get --password-id "68793e13dfc88d879e0f2e39"

UPDATE-Modus — Daten aktualisieren

Passwort eines Elements aktualisieren:

passwork-cli update \
--password-id "68793e13dfc88d879e0f2e39" \
--password "new-password-value"

API-Modus — direkte API-Aufrufe

Liste aller Tresore abrufen:

passwork-cli api --method GET --endpoint "v1/vaults"
warnung

Es wird empfohlen, Umgebungsvariablen zum Speichern von Tokens und Masterschlüsseln zu verwenden

Technische Dokumentation

Technische Dokumentation für Passwork CLI einsehen