Zurück

OpenTofu-Statusverschlüsselung mit OVHcloud KMS

Aurélie Vache, Elena Luoto6 Minuten Lesezeit

OpenTofu-Statusverschlüsselung mit OVHcloud KMS

Nutzer:innen von OVHcloud dürfen sich freuen: Die OpenTofu-Statusverschlüsselung ist jetzt mit OVHcloud KMS kompatibel, sodass Status- und Plan-Dateien mit verwalteten Schlüsseln geschützt werden können.

Wenn man an Infrastructure as Code denkt, ist Terraform oft das erste Tool, das einem in den Sinn kommt. Seit dem Fork, aus dem OpenTofu hervorgegangen ist, hat sich das Projekt jedoch erheblich weiterentwickelt und Funktionen eingeführt, die ihm echte Alleinstellungsmerkmale verleihen.

Eine der bemerkenswertesten Neuerungen ist die Verschlüsselung von Status- und Plan-Dateien – eine Funktion, die die Community über Jahre hinweg gefordert hatte.

OpenTofu unterstützt jetzt die Verschlüsselung von Status- und Plan-Dateien im Ruhezustand – unabhängig davon, ob sie lokal oder in einem Remote-Backend gespeichert sind. Dies hilft Teams dabei, sensible Infrastruktur-Metadaten, Anmeldedaten und Konfigurationsdetails zu schützen, die andernfalls durch Status-Dateien offengelegt werden könnten. Zur Verwaltung von Verschlüsselungsschlüsseln lässt sich OpenTofu in verschiedene Key Management Services (KMS) integrieren, darunter OpenBao, AWS KMS, Google Cloud KMS und Azure Key Vault.

Nutzer:innen von OVHcloud haben diese Möglichkeit jetzt ebenfalls – dank des von OVHcloud gewarteten externen OpenTofu Schlüsselanbieters für OVHcloud KMS. Damit können sie verwaltete Verschlüsselungsschlüssel zur Sicherung ihres Infrastruktur-Status verwenden.

In diesem Blogbeitrag erfahren Sie, wie Sie OVHcloud KMS verwenden können, um Ihre OpenTofu-Status- und Plan-Dateien zu verschlüsseln und so die Sicherheit Ihrer Infrastructure-as-Code-Workflows zu verbessern.

Wovor schützt die Verschlüsselung?

Wenn OpenTofu aktiviert ist, werden Status-Daten im Ruhezustand verschlüsselt. Damit wird dazu beigetragen, sensible Informationen in der Status-Datei vor unbefugtem Zugriff zu schützen.

Die Verschlüsselung ist jedoch kein Ersatz für Backup-, Versionierungs- oder State-Management-Mechanismen. Sie verhindert keinen Datenverlust und kann für sich allein nicht vor allen Formen von Status-Beschädigungen oder Replay-Angriffen schützen, die ältere Status- oder Plan-Dateien betreffen. Sie kann auch nicht verhindern, dass Benutzer:innen, die den „tofu“-Befehl ausführen, auf sensible Werte zugreifen, da sie in der Lage sein müssen, den entschlüsselten Status zu lesen.

⚠️ Bitte beachten Sie, dass Ihre Status- und Plandateien nach der Aktivierung der Verschlüsselung ohne den entsprechenden Verschlüsselungsschlüssel nicht mehr wiederherstellbar sind.

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass Sie über Folgendes verfügen:

  • Einen OVHcloud Account
  • Eine OKMS (OVHcloud Key Management Service)-Domain (in diesem Blogbeitrag zum Beispiel „305db938-1234-5678-9012-3a0a29291661“)
  • Einen Dienstschlüssel vom Typ „AES“ mit der Verwendung „Wrap/Unwrap“ (in diesem Blogbeitrag zum Beispiel „16491ef8-aaaa-bbbb-cccc-50ac90ab8e56“)
  • Einen lokalen IAM-Benutzer (Identitäts- und Zugriffsmanagement) (in diesem Blogbeitrag zum Beispiel „kms-305db938-1234-5678-9012-3a0a29291661“)
  • Die OVHcloud CLI in installiertem Zustand
  • Die OpenTofu CLI in installiertem Zustand (v1.13+, wobei externe Schlüsselanbieter nicht mehr experimentell sind)

💡 Der OVHcloud KMS-Schlüsselanbieter unterstützt sowohl Token- als auch gegenseitige TLS-Authentifizierung (mTLS). In diesem Blogbeitrag verwenden wir den Token-Authentifizierungsmodus. Bitte folgen Sie der offiziellen Schlüsselanbieter-Anleitung, wenn Sie den mTLS-Authentifizierungsmodus verwenden möchten.

Einrichten des Schlüsselanbieters

Installieren des Schlüsselanbieters

Lokale Installation des Schlüsselanbieters:

bash
curl -fsSL https://raw.githubusercontent.com/ovh/opentofu-kms-ovhcloud/main/install.sh | sh

⚠️ Die Binärdatei wird standardmäßig in $HOME/.local/bin installiert (wird erstellt, falls nicht existent). Stellen Sie sicher, dass sich dieses Verzeichnis in Ihrem PATH befindet.

Ansonsten können Sie die anderen Installationsmethoden befolgen.

Jetzt können Sie den OVHcloud KMS-Schlüsselanbieter verwenden 🎉.

Suchen Ihrer OKMS-ID

Auflisten der OKMS-Domains:

bash
$ ovhcloud okms list
┌──────────────────────────────────────┬─────────────┐
│ id │ region │
├──────────────────────────────────────┼─────────────┤
│ 305db938-1234-5678-9012-3a0a29291661 │ eu-west-par │
│ xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx │ eu-west-par │
└──────────────────────────────────────┴─────────────┘

Speichern der OKMS-ID in einer Umgebungsvariablen:

bash
export KMS_RESTAPI_OKMSID="305db938-1234-5678-9012-3a0a29291661"

Generieren eines Tokens (nur Token-Authentifizierung)

Die OpenTofu-Verschlüsselungsfunktion erfordert die Berechtigung zum Zugriff auf und zur Verwendung von Schlüsseln von OVHcloud KMS.

Wenn Sie die Token-Authentifizierung verwenden möchten, benötigen Sie ein persönliches Zugriffstoken (PAT). Sie können dazu die OVHcloud CLI verwenden:

bash
KMS_RESTAPI_TOKEN=$(ovhcloud iam user token create <iam-local-user-name> --name pat-opentofu-<iam-local-user-name> --description "PAT opentofu for domain $KMS_RESTAPI_OKMSID" -o json | jq .details.token | tr -d '"')

echo $KMS_RESTAPI_TOKEN

Sie sollten ein Ergebnis wie dieses erhalten:

bash
$ KMS_RESTAPI_TOKEN=$(ovhcloud iam user token create kms-305db938-1234-5678-9012-3a0a29291661 --name pat-opentofu-kms-305db938-1234-5678-9012-3a0a29291661 --description "PAT opentofu for domain 305db938-1234-5678-9012-3a0a29291661" -o json | jq .details.token | tr -d '"')
2026/05/07 08:48:34 Final parameters:
{
 "description": "PAT opentofu for domain 305db938-1234-5678-9012-3a0a29291661",
 "name": "pat-opentofu-kms-305db938-1234-5678-9012-3a0a29291661"
}

$ echo $KMS_RESTAPI_TOKEN
eyJhbGciOiJFZE...ASgXy55_DDFHdy4Z5uSq8lww-Bw

Speichern der KMS-Informationen

Speichern der Einstellungen in Umgebungsvariablen. Zum Beispiel:

bash
export KMS_RESTAPI_TYPE=token
export KMS_KEY_ID="<your_service_key_id>"
export KMS_RESTAPI_ENDPOINT=$(ovhcloud okms get $KMS_RESTAPI_OKMSID -o json | jq .restEndpoint | xargs)

Die gespeicherten Informationen anzeigen:

bash
$ echo $KMS_RESTAPI_TYPE
token

$ echo $KMS_RESTAPI_ENDPOINT
https://eu-west-par.okms.ovh.net

$ echo $KMS_KEY_ID
16491ef8-aaaa-bbbb-cccc-50ac90ab8e56

$ echo $KMS_RESTAPI_TOKEN
eyJ...BIoHCA

Aktivieren der OpenTofu-Statusverschlüsselung

Eine provider.tf-Datei mit folgendem Inhalt erstellen:

bash
terraform {
  encryption {
    key_provider "external" "ovhcloud" {
      command = [
        "opentofu-kms-ovhcloud",
        # Key ID, of the service key used to wrap/unwrap the data key, will be automatically filled with the $KMS_KEY_ID environment variable
# RestAPI Token will be automatically filled with the $KMS_RESTAPI_TOKEN environment variable
        # OKMS ID will be automatically filled with $KMS_RESTAPI_OKMSID environment variable
      ]
    }
    method "aes_gcm" "ovhcloud" {
      keys = key_provider.external.ovhcloud
    }
    state {
      method = method.aes_gcm.ovhcloud
    }
    plan {
      method = method.aes_gcm.ovhcloud
    }
  }
}

In diesem Beispiel erstellen wir eine my-null-resource.tf-Datei mit folgendem Inhalt:

bash
resource "null_resource" "test" {}

💡 Hinweis: Verwenden Sie in einem echten Projekt Ihre bestehenden „*.tf“-Dateien statt dieser Beispielressource.

OpenTofu-Projekt initialisieren:

bash
$ tofu init

Initializing the backend...

Initializing provider plugins...
- Finding latest version of hashicorp/null...
- Installing hashicorp/null v3.3.2...
- Installed hashicorp/null v3.3.2 (signed, key ID 0C0AF313E5FD9F80)

Providers are signed by their developers.
If you'd like to know more about provider signing, you can read about it here:
https://opentofu.org/docs/cli/plugins/signing/

OpenTofu has created a lock file .terraform.lock.hcl to record the provider
selections it made above. Include this file in your version control repository
so that OpenTofu can guarantee to make the same selections by default when
you run "tofu init" in the future.

OpenTofu has been successfully initialized!

You may now begin working with OpenTofu. Try running "tofu plan" to see
any changes that are required for your infrastructure. All OpenTofu commands
should now work.

If you ever set or change modules or backend configuration for OpenTofu,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.

Anwenden:

bash
$ tofu apply

OpenTofu used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  + create

OpenTofu will perform the following actions:

  # null_resource.test will be created
  + resource "null_resource" "test" {
      + id = (known after apply)
    }

Plan: 1 to add, 0 to change, 0 to destroy.

Do you want to perform these actions?
  OpenTofu will perform the actions described above.
  Only 'yes' will be accepted to approve.

  Enter a value: yes

null_resource.test: Creating...
null_resource.test: Creation complete after 0s [id=5663203269009606061]

Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

Statusdatei anzeigen:

bash
$ cat terraform.tfstate | jq
{
  "serial": 1,
  "lineage": "ba70b37d-aaaa-bbbb-cccc-25cd80b64d26",
  "meta": {
    "key_provider.external.ovhcloud": "eyJleHRlcm5………idyJ9fQ=="
  },
  "encrypted_data": "EXCFfXjgFmevAs..b……………………………fHz8mXkE/Oh3qMip7l3D7TX5vt",
  "encryption_version": "v0"
}

Der Status ist jetzt verschlüsselt 🎉.

💡 Beachten Sie, dass bei jeder Ausführung der Befehle „tofu plan“ oder „tofu apply“ ein neuer flüchtiger Datenschlüssel generiert und mit Ihrem OVHcloud-Dienstschlüssel geschützt wird.

Fazit

In diesem Beitrag wurde gezeigt, wie Sie die OpenTofu-Statusverschlüsselung mit OVHcloud KMS einrichten, sodass sowohl Ihre Status- als auch Ihre Plandateien geschützt sind.

Mit dem OVHcloud KMS-Schlüsselanbieter können Sie verwaltete Verschlüsselungsschlüssel direkt in Ihre Infrastructure-as-Code (IaC)-Workflows einbinden.

Unser Team arbeitet derzeit an mehreren weiteren Integrationen. Probieren Sie in der Zwischenzeit den Schlüsselanbieter aus. Und wie immer freuen wir uns über Ihr Feedback im GitHub-Repository!


Teilen auf: