How to use SOPS + age

Le contenu de cette page n'est pas encore traduit dans votre langue. Vous pouvez consulter la version originale en anglais.

As we saw earlier, SOPS supports multiple formats and encryption backends. In this guide, we will focus on using SOPS with age for encrypting sensitive files like *.tfvars, terraform.tfstate, and other secrets.

Generate an age Key Pair

mkdir $env:APPDATA\sops\age
age-keygen -o $env:APPDATA\sops\age\keys.txt

mkdir -p "$HOME/Library/Application Support/sops/age"
age-keygen -o "$HOME/Library/Application Support/sops/age/keys.txt"

mkdir -p ~/.config/sops/age
age-keygen -o ~/.config/sops/age/keys.txt

Grab your public key:

grep public /path/to/keys.txt
# public key: age1xxxx...

Encrypting with sops

There are multiple ways to encrypt a file using age with SOPS:

Using the age flag

sops -e --age age1xxxx...,age1yyyy... opentofu.auto.tfvars > opentofu.auto.tfvars.enc

This encrypts the file using the provided public age keys.

Using an environment variable

export SOPS_AGE_RECIPIENTS="age1xxxx...,age1yyyy..."
sops -e opentofu.auto.tfvars > opentofu.auto.tfvars.enc

This is useful when scripting or storing your recipient key in an environment configuration.

Using sops config file

You can also specify the recipient in a .sops.yaml file in your repository:

1
creation_rules:
2
  - path_regex: \.tfvars(\.json)?$
3
    encrypted_regex: "^(.*)$"
4
    age: "age1xxxx...,age1yyyy..."

Using .sops.yaml is best for projects as it avoids setting env variables or using the age flag, enabling consistent, automatic encryption config.

When encrypting files, you need to specify the input type. This is crucial for SOPS to understand how to handle the file correctly.

This is important to ensure that the file is encrypted correctly and can be decrypted later without issues.

For binary files, you can use the default command:

sops encrypt opentofu.auto.tfvars > opentofu.auto.tfvars.enc

For JSON files, specify the input type as JSON:

sops encrypt --input-type json opentofu.auto.tfvars.json > opentofu.auto.tfvars.json.enc

For YAML files, specify the input type as YAML:

sops encrypt --input-type yaml secrets.yaml > secrets.yaml.enc

For environment variable files, specify the input type as dotenv:

sops encrypt --input-type dotenv .env > .env.enc

Decrypting with sops

Basic usage examples

View decrypted content:

sops -d opentofu.auto.tfvars.enc

Save decrypted file:

sops -d opentofu.auto.tfvars.enc > opentofu.auto.tfvars

As with encryption, you need to specify the input type when decrypting files. This ensures that SOPS knows how to handle the file correctly.

For binary files, you can use the default command:

sops decrypt opentofu.auto.tfvars.enc > opentofu.auto.tfvars

For JSON files, specify the input and output type as JSON:

sops decrypt --input-type json --output-type json opentofu.auto.tfvars.json.enc > opentofu.auto.tfvars.json

For YAML files, specify the input and output type as YAML:

sops decrypt --input-type yaml --output-type yaml secrets.yaml.enc > secrets.yaml

For environment variable files, specify the input and output type as dotenv:

sops decrypt --input-type dotenv --output-type dotenv .env.enc > .env

Bonus: Using SSH keys to encrypt/decrypt

You can also use SSH keys for encryption and decryption. This is particularly useful if you already manage SSH keys for other purposes.

Encrypting with SSH keys

sops -e --age "$(cat ~/.ssh/id_ed25519.pub)" opentofu.auto.tfvars > opentofu.auto.tfvars.enc

Decrypting with SSH keys

By default, SOPS will try to decrypt using the following SSH private keys (in order):

~/.ssh/id_ed25519
~/.ssh/id_rsa

If your private key is stored in a custom location or if you manage multiple keys, you can explicitly specify which one to use:

export SOPS_AGE_SSH_PRIVATE_KEY_FILE=~/.ssh/id_rsa
sops -d opentofu.auto.tfvars.enc > opentofu.auto.tfvars

To avoid setting the environment variable separately, you can combine everything in one command:

SOPS_AGE_SSH_PRIVATE_KEY_FILE=~/.ssh/id_rsa sops -d opentofu.auto.tfvars.enc > opentofu.auto.tfvars

This is especially handy in scripts or continuous deployment pipelines.

Best Practices

Never commit decrypted files (*.tfvars, *.tfstate, secrets.json, secrets.yaml, .env etc.)
Use .gitignore to exclude them
Always encrypt before pushing
Share only the public key
Store private keys securely (e.g., in a password manager or vault)

References