
Użytkownicy OVHcloud mają powód do radości: Szyfrowanie stanu OpenTofu współpracuje teraz z OVHcloud KMS, dzięki czemu możesz chronić pliki stanu i planu za pomocą zarządzanych kluczy.
Gdy mowa o infrastrukturze jako kodzie, pierwszym narzędziem, które przychodzi na myśl, jest często Terraform. Jednak od czasu powstania forka OpenTofu projekt znacznie się rozwinął i zyskał funkcje, które go wyróżniają.
Jedną z najważniejszych nowości jest szyfrowanie stanu i planu, czyli funkcja, o którą społeczność prosiła od lat.
OpenTofu obsługuje teraz szyfrowanie plików stanu i planu w spoczynku, niezależnie od tego, czy są przechowywane lokalnie, czy w zdalnym backendzie. Pomaga to zespołom chronić poufne metadane infrastruktury, dane uwierzytelniające i szczegóły konfiguracji, które w przeciwnym razie mogłyby zostać ujawnione za pośrednictwem plików stanu. W celu zarządzania kluczami szyfrowania OpenTofu integruje się z kilkoma usługami zarządzania kluczami (KMS), w tym OpenBao, AWS KMS, Google Cloud KMS i Azure Key Vault.
Użytkownicy OVHcloud również mogą teraz z tego korzystać dzięki utrzymywanemu przez OVHcloud zewnętrznemu dostawcy kluczy OpenTofu dla OVHcloud KMS. Pozwala on zabezpieczać stan infrastruktury za pomocą zarządzanych kluczy szyfrowania.
W tym artykule na blogu pokażę, jak zaszyfrować pliki stanu i planu OpenTofu za pomocą OVHcloud KMS, aby zwiększyć bezpieczeństwo Twoich procesów zarządzania infrastrukturą jako kodem.
Przed czym chroni szyfrowanie?
Gdy szyfrowanie jest włączone, OpenTofu szyfruje dane stanu w spoczynku, co pomaga chronić poufne informacje w pliku stanu przed nieuprawnionym dostępem.
Szyfrowanie nie zastępuje jednak tworzenia kopii zapasowych, wersjonowania ani mechanizmów zarządzania stanem. Nie zapobiega utracie danych i samo w sobie nie chroni przed wszystkimi formami uszkodzenia stanu ani atakami powtórzeniowymi wykorzystującymi starsze pliki stanu lub planu. Nie uniemożliwia też użytkownikom uruchamiającym polecenie tofu dostępu do poufnych wartości, ponieważ muszą oni mieć możliwość odczytania odszyfrowanego stanu.
⚠️ Pamiętaj, że po włączeniu szyfrowania nie odzyskasz plików stanu i planu bez odpowiedniego klucza szyfrowania.
Wymagania wstępne
Przed rozpoczęciem upewnij się, że spełniasz następujące wymagania:
- Konto OVHcloud
- Domena OKMS (OVHcloud Key Management Service) (w tym artykule np. „305db938-1234-5678-9012-3a0a29291661”)
- Klucz Service Key typu „AES”, przeznaczony do operacji „Wrap/Unwrap” (w tym artykule np. „16491ef8-aaaa-bbbb-cccc-50ac90ab8e56”)
- Lokalny użytkownik w usłudze IAM (Identity and Access Management) (w tym artykule np. „kms-305db938-1234-5678-9012-3a0a29291661”)
- Zainstalowany interfejs OVHcloud CLI
- Zainstalowany interfejs OpenTofu CLI (w wersji 1.13 lub nowszej, w której zewnętrzni dostawcy kluczy nie są już funkcją eksperymentalną)
💡 Dostawca kluczy OVHcloud KMS obsługuje zarówno uwierzytelnianie za pomocą tokenu, jak i wzajemne uwierzytelnianie TLS (mTLS). W tym artykule na blogu skorzystamy z uwierzytelniania za pomocą tokenu. Jeśli chcesz korzystać z uwierzytelniania mTLS, postępuj zgodnie z oficjalnym przewodnikiem dostawcy kluczy.
Skonfiguruj dostawcę kluczy
Zainstaluj dostawcę kluczy
Zainstaluj dostawcę kluczy lokalnie:
curl -fsSL https://raw.githubusercontent.com/ovh/opentofu-kms-ovhcloud/main/install.sh | sh⚠️ Plik binarny jest domyślnie instalowany w katalogu $HOME/.local/bin (zostanie utworzony, jeśli nie istnieje). Upewnij się, że ten katalog znajduje się w zmiennej PATH.
Możesz też skorzystać z innych metod instalacji.
Możesz już korzystać z dostawcy kluczy OVHcloud KMS 🎉.
Znajdź swój identyfikator OKMS
Wyświetl listę domen OKMS:
$ ovhcloud okms list
┌──────────────────────────────────────┬─────────────┐
│ id │ region │
├──────────────────────────────────────┼─────────────┤
│ 305db938-1234-5678-9012-3a0a29291661 │ eu-west-par │
│ xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx │ eu-west-par │
└──────────────────────────────────────┴─────────────┘Zapisz identyfikator OKMS w zmiennej środowiskowej:
export KMS_RESTAPI_OKMSID="305db938-1234-5678-9012-3a0a29291661"Wygeneruj token (tylko w przypadku uwierzytelniania za pomocą tokenu)
Funkcja szyfrowania OpenTofu wymaga uprawnień do dostępu do kluczy OVHcloud KMS i korzystania z nich.
Jeśli chcesz korzystać z uwierzytelniania za pomocą tokenu, potrzebujesz osobistego tokenu dostępu (PAT). Możesz to zrobić za pomocą OVHcloud CLI:
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_TOKENWynik powinien wyglądać podobnie do tego:
$ 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-BwZapisz informacje o KMS
Zapisz ustawienia w zmiennych środowiskowych. Na przykład:
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)Wyświetl zapisane informacje:
$ 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...BIoHCAWłącz szyfrowanie stanu OpenTofu
Utwórz plik provider.tf o następującej zawartości:
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
}
}
}
W tym przykładzie utworzymy plik my-null-resource.tf o następującej zawartości:
resource "null_resource" "test" {}💡 Uwaga: w rzeczywistym projekcie użyj istniejących plików „*.tf” zamiast tego przykładowego zasobu.
Zainicjuj projekt OpenTofu:
$ 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.Zastosuj konfigurację:
$ 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.
Wyświetl plik stanu:
$ 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"
}Stan jest teraz zaszyfrowany 🎉.
💡 Pamiętaj, że przy każdym wykonaniu polecenia tofu plan lub tofu apply generowany jest nowy tymczasowy klucz danych, chroniony za pomocą Twojego klucza Service Key OVHcloud.
Podsumowanie
W tym artykule pokazano, jak skonfigurować szyfrowanie stanu OpenTofu za pomocą OVHcloud KMS, aby chronić zarówno pliki stanu, jak i planu.
Dzięki dostawcy kluczy OVHcloud KMS możesz włączyć zarządzane klucze szyfrowania bezpośrednio do swoich procesów IaC (infrastruktury jako kodu).
Nasz zespół pracuje nad kilkoma innymi integracjami. W międzyczasie wypróbuj dostawcę kluczy i, jak zawsze, podziel się z nami opinią w repozytorium GitHub!