Indietro

Crittografia dello state di OpenTofu con OVHcloud KMS

Aurélie Vache, Elena Luoto7 min. di lettura

Crittografia dello state di OpenTofu con OVHcloud KMS

Buone notizie per gli utenti OVHcloud: la crittografia dello state di OpenTofu è da ora disponibile con OVHcloud KMS. Puoi proteggere i tuoi file di state e di plan con chiavi gestite.

Quando si parla di Infrastructure as Code, solitamente il primo strumento che viene in mente è Terraform. Tuttavia, dal momento del fork che ha portato a OpenTofu, il progetto si è evoluto significativamente e ha introdotto caratteristiche che lo rendono unico.

Tra queste, una delle più notevoli è la crittografia dei file di state e di plan, una funzionalità che la community richiedeva da anni.

OpenTofu supporta la crittografia dei file di state e di plan a riposo, indipendentemente dal fatto che siano salvati localmente o in un backend remoto. In questo modo, i team possono proteggere i metadati delle infrastrutture sensibili, le credenziali e i dettagli di configurazione che potrebbero essere esposti tramite i file di state. Per gestire le chiavi di chiave di crittografia, OpenTofu si integra con diversi servizi di gestione delle chiavi (KMS), tra cui OpenBao, AWS KMS, Google Cloud KMS e Azure Key Vault.

Ora anche gli utenti OVHcloud dispongono di questa opzione grazie al provider di chiavi esterno OpenTofu per KMS di OVHcloud, mantenuto da OVHcloud. Questa soluzione permette loro di utilizzare chiavi di crittografia gestite per proteggere lo stato della loro infrastruttura.

In questo articolo ti mostreremo come utilizzare OVHcloud KMS per cifrare i file di state e di plan di OpenTofu, migliorando la sicurezza dei tuoi flussi di lavoro di Infrastructure as Code.

Da cosa protegge la crittografia?

Quando viene abilitato, OpenTofu esegue la crittografia dei dati a riposo, contribuendo a proteggere le informazioni sensibili nel file di state da accessi non autorizzati.

Tuttavia, la crittografia non sostituisce i meccanismi di backup, versioning e gestione dello state. Inoltre, non impedisce la perdita di dati e, da sola, non può proteggere da tutte le forme di corruzione dello state o attacchi di replay che coinvolgono file di state e plan più vecchi. Infine, non può impedire agli utenti che eseguono il comando tofu di accedere a valori sensibili, perché devono poter leggere lo stato decriptato.

⚠️ NB: quando attivi la crittografia, i file di plan e di state diventano irrecuperabili senza la chiave di crittografia adeguata.

Prerequisiti

Prima di iniziare, assicurati di possedere questi prerequisiti:

  • Un account OVHcloud
  • Un dominio OKMS (OVHcloud Key Management Service) (ad esempio, in questo post: “305db938-1234-5678-9012-3a0a29291661”)
  • Una Service Key di tipo “AES” con utilizzo “Wrap/Unwrap” (ad esempio, in questo post: “16491ef8-aaaa-bbbb-cccc-50ac90ab8e56”)
  • Un utente IAM (Identity and Access Management) locale (ad esempio, in questo post: “kms-305db938-1234-5678-9012-3a0a29291661”)
  • La CLI OVHcloud, installata
  • La CLI OpenTofu, installata (v1.13+, dove i provider di chiavi esterni non sono più sperimentali)

💡 Il provider di chiavi KMS di OVHcloud supporta sia l'autenticazione con token che quella mTLS (mutual TLS). In questo articolo utilizzeremo la modalità di autenticazione con token. Se preferisci utilizzare la modalità di autenticazione mTLS, consulta la guida del provider di chiavi ufficiale.

Imposta il provider di chiavi

Installa il provider di chiavi

Installa il provider di chiavi localmente:

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

⚠️ Il binario è installato in $HOME/.local/bin di default (creato se non esiste). Assicurati che questa directory sia nel tuo PATH.

Altrimenti, puoi seguire gli altri metodi di installazione.

Ora puoi utilizzare il provider di chiavi KMS di OVHcloud 🎉.

Trova il tuo ID OKMS

Elenca i domini OKMS:

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

Salva l'ID OKMS in una variabile d'ambiente:

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

Genera un token (solo per autenticazione con token)

La funzione di crittografia di OpenTofu richiede l'autorizzazione per accedere e utilizzare le chiavi del KMS di OVHcloud.

Se vuoi utilizzare l'autenticazione con token, avrai bisogno di un token di accesso personale (PAT). Per farlo, puoi utilizzare la CLI OVHcloud:

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

Dovresti ottenere un risultato simile a questo:

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

Salva le informazioni del KMS

Salva i parametri in variabili d'ambiente. Per esempio:

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)

Visualizza le informazioni salvate:

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

Abilita la crittografia dello state di OpenTofu

Crea un file provider.tf con il contenuto seguente:

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 questo esempio creeremo un file my-null-resource.tf con il contenuto seguente:

bash
resource "null_resource" "test" {}

💡 NB: in un progetto reale, usa i tuoi file “*.tf” esistenti invece di questa risorsa di esempio.

Avvia il progetto OpenTofu:

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.

Applicalo:

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.

Visualizza lo state file:

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"
}

Lo state è crittografato 🎉.

💡 NB: ogni volta che esegui i comandi tofu plan o tofu apply, viene generata una nuova chiave di dati effimera, protetta grazie alla tua Service Key OVHcloud.

Conclusioni

In questo articolo ti abbiamo mostrato come configurare la crittografia dello state di OpenTofu con OVHcloud KMS, che ti permette di proteggere sia i file di state che di plan.

Con il provider di chiavi KMS di OVHcloud, puoi portare le chiavi di crittografia gestite direttamente nei tuoi flussi di lavoro di Infrastructure as Code (IaC).

Il nostro team sta lavorando a nuove integrazioni. Nel frattempo, testa il provider di chiavi e come sempre, non esitare a condividere un feedback sul repository GitHub!


Condividi su::