Migrationsskript

Mit

der öffentlichen Bitwarden-API
können Administratoren administrative Aufgaben mithilfe von Skripten automatisieren. Das in diesem Artikel dokumentierte Skript wurde geschrieben, um Bitwarden-Kunden bei der Migration ihres bestehenden Setups von einer früheren Bitwarden Password Manager-Umgebung in eine neue Organisation zu unterstützen. Es bietet eine Möglichkeit, Organisations-Tresordaten, Gruppen und zugehörige Berechtigungen von Gruppen und Mitgliedern auf eine neue Installation zu migrieren.

Das Skript ist in Python geschrieben und kann auf jedem Betriebssystem mit installiertem Python v3 ausgeführt werden. Laden Sie das Skript und einen Beispielkonfigurationsdateityp herunter: asset-hyperlink id: 76zQs7igKMkSy7W2lpgbGv.

Installation und Einrichtung

Systemanforderungen

Abgesehen von den Standardbibliotheken, die mit den meisten Python-Distributionen ausgeliefert werden, die standardmäßig unter Linux und macOS enthalten und für Windows

verfügbar sind
), erfordert dieses Skript die Installation eines zusätzlichen Moduls namens Requests, bevor das Skript erfolgreich ausgeführt werden kann.

Ein gängiges Tool zum Installieren von Python-Modulen heißt Pip. So installieren Sie das Modul mithilfe von Pip:

Bash
pip3 install requests
note

pip3 - Auf einigen Computern sind mehrere Python-Versionen installiert. Die Verwendung von pip3 anstelle von nur pip gibt an, dass Sie Anforderungen mit Python v3 installieren. Wenn auf Ihrem Computer nur eine Python-Version installiert ist, verwenden Sie stattdessen Pip.

Erforderliche Dateien

Der obige Download enthält zwei Dateien:

  • bwAdminTools.py: Dies ist das Skript, das Sie zum Ausführen der Migration benötigen. Es wird eine vollständig konfigurierte Konfigurationsdatei benötigt.

  • config-example.cfg: Dies ist die für die Migration erforderliche Konfigurationsdatei, die Sie erstellen und einrichten müssen, bevor Sie das Skript ausführen.

Entpacken Sie die .zip-Datei und speichern Sie diese Dateien im selben Verzeichnis. Sobald Sie dies getan haben, fügen Sie die folgenden Dateien zum selben Verzeichnis hinzu:

Zielorganisation erstellen

Bevor Sie fortfahren können, müssen Sie die Zielorganisation erstellen, zu der Sie migrieren möchten.

Erfahren Sie, wie Sie eine Organisation erstellen
.

note

Wir empfehlen, Benutzer einzuladen, bevor Sie das Migrationsskript ausführen. Benutzer müssen sich mindestens in einem eingeladenen Zustand befinden, um Gruppen- und Berechtigungseinstellungen zu migrieren.

Umgebungskonfiguration

Bevor Sie bwAdminTools.py-Skriptfunktionen

ausführen
, müssen Sie eine Konfigurationsdatei erstellen. Kopieren Sie den Inhalt von config-example.cfg in eine neue config.cfg-Datei im selben Verzeichnis und geben Sie die folgenden Variablen ein. Beachten Sie, dass Variablen in dieser Dokumentation in Quell- und Zielgruppen unterteilt werden, da es sich um ein Migrationsskript handelt:

Quellorganisationsvariable

Variablenbeschreibung

bw_vault_uri=

FQDN Ihres Quell-Web-Tresors, z. B. https://company.bitwarden.com, wenn Sie selbst hosten, oder https://vault.bitwarden.com, wenn Sie die in den USA ansässigen Bitwarden-Cloud-Dienste verwenden.

bw_org_client_id=

Quellorganisation API-Schlüssel Client-ID.

Erfahre, wo du sie findest
.

bw_org_client_secret=

Quellorganisation API-Schlüssel Client Secret.

Erfahre, wo du sie findest
.

bw_org_id=

GUID der Quellorganisation. Kopieren Sie the_client_id= value und entfernen Sie das organisationsstück.

bw_acc_client_id

Persönliche API-Schlüssel-Client-ID der Quellorganisation des Administrators oder Eigentümers.

Erfahre, wo du sie findest
.

bw_acc_client_secret=

Client-Geheimnis des persönlichen API-Schlüssels des Administrators oder Eigentümers der Quellorganisation.

Erfahre, wo du sie findest
.

Zielorganisationsvariable

Variablenbeschreibung

dest_bw_vault_uri=

FQDN Ihres Quell-Web-Tresors, z. B. https://company.bitwarden.com, wenn Sie Self-Hosting betreiben möchten, oder https://vault.bitwarden.eu, wenn Sie EU-basierte Bitwarden-Cloud-Dienste nutzen möchten.

dest_bw_org_client_id=

Zielorganisation API-Schlüssel Client-ID.

Erfahre, wo du sie findest
.

dest_bw_org_client_secret=

Zielorganisation API-Schlüssel Client Secret.

Erfahre, wo du sie findest
.

dest_bw_org_id=

GUID der Zielorganisation. Kopieren Sie the_client_id= value und entfernen Sie das organisationsstück.

dest_bw_acc_client_id=

Persönliche API-Schlüssel-Client-ID der Zielorganisation des Administrators oder Eigentümers.

Erfahre, wo du sie findest
.

dest_bw_ac_client_secret=

Persönlicher API-Schlüssel des Zielunternehmens - Client-Geheimnis des Administrators oder Eigentümers.

Erfahre, wo du sie findest
.

Sobald Sie diese Variablen eingerichtet haben, können Sie die Migration mit den Skriptfunktionen

bwAdminTools.py
starten.

Skriptfunktionen

Aus dem Verzeichnis, in dem Sie Ihre Datei bwAdminTools.py, die Datei config.cfg und die ausführbare Datei Password Manager CLI gespeichert haben, können Sie die folgenden Befehle ausführen:

note

python3 - Auf einigen Computern sind mehrere Python-Versionen installiert. Die Verwendung von Python3 anstelle von nur Python gibt an, dass Befehle mit Python v3 ausgeführt werden. Wenn auf Ihrem Computer nur eine Python-Version installiert ist, verwenden Sie stattdessen Python. Einige Distributionen werden auch eine Python anstelle von Python3-Binär für v3 haben.

  • So drucken Sie Skript-Hilfstext:

    Bash
    python3 bwAdminTools.py -h

  • So vergleichen Sie Quell- und Zielorganisationen:

    Bash
    python3 bwAdminTools.py -c diffbw

  • So migrieren Sie Organisations-Tresordaten, Gruppen und Gruppenberechtigungen von einer Quellorganisation zu einer Zielorganisation:

    Bash
    python3 bwAdminTools.py -c migratebw

    Benutzer müssen sich in der Zielorganisation mindestens in einem eingeladenen Zustand befinden, damit migratebw erfolgreich ist.

  • So migrieren Sie die Berechtigungen von Mitgliedern (außerhalb von Gruppen) von einer Quellorganisation zu einer Zielorganisation:

    Bash
    python3 bwAdminTools.py -c migratebwusers

    Benutzer müssen sich in der Zielorganisation mindestens in einem eingeladenen Zustand befinden, damit migratebwusers erfolgreich ist.

  • So löschen Sie alle Sammlungen aus der Quellorganisation:

    Bash
    python3 bwAdminTools.py -c purgecol

  • So löschen Sie alle Sammlungen aus der Zielorganisation:

    Bash
    python3 bwAdminTools.py -c purgecoldest

  • So löschen Sie alle Gruppen aus der Quellorganisation:

    Bash
    python3 bwAdminTools.py -c purgegroup

  • So löschen Sie alle Gruppen aus der Zielorganisation:

    Bash
    python3 bwAdminTools.py -c purgegroupdest