sops-age-secrets
Original:🇺🇸 English
Translated
SOPS and age encryption for secrets management in git repositories. Use when: (1) Setting up encrypted secrets in a project (initial .sops.yaml configuration) (2) Encrypting/decrypting YAML, JSON, ENV, or INI files with age keys (3) Managing age keys (generation, distribution, rotation) (4) Configuring path-based encryption rules for different environments (5) Integrating SOPS decryption in CI/CD pipelines (GitHub Actions, GitLab CI) (6) Troubleshooting SOPS decryption failures or key issues (7) Selective encryption with encrypted_regex patterns
37installs
Sourcedimdasci/vps-setup
Added on
NPX Install
npx skill4agent add dimdasci/vps-setup sops-age-secretsTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →SOPS + age Secrets Management
Encrypt secrets in git with SOPS using age keys. Values are encrypted with AES256-GCM; keys are simple X25519 keypairs.
Quick Reference
| Task | Command |
|---|---|
| Generate age key | |
| Extract public key | |
| Encrypt file | |
| Decrypt file | |
| Edit encrypted file | |
| Update recipients | |
| Rotate data key | |
Initial Setup
1. Generate Keys
bash
# Create key directory
mkdir -p ~/.config/sops/age
# Generate keypair
age-keygen -o ~/.config/sops/age/keys.txt
# Output: public key: age1abc123...2. Create .sops.yaml
At repository root:
yaml
creation_rules:
- age: age1yourpublickeyhere...3. Encrypt First File
bash
sops encrypt config/secrets.yaml > config/secrets.enc.yaml
rm config/secrets.yaml
git add config/secrets.enc.yaml .sops.yamlCore Workflows
Encrypt New File
bash
# Create plaintext file
cat > secrets.yaml << 'EOF'
database:
password: secret123
api_key: abc-xyz
EOF
# Encrypt (uses .sops.yaml rules)
sops encrypt secrets.yaml > secrets.enc.yaml
rm secrets.yamlEdit Encrypted File
bash
# Opens decrypted in $EDITOR, re-encrypts on save
sops edit secrets.enc.yamlDecrypt for Use
bash
# To stdout
sops decrypt secrets.enc.yaml
# To file
sops decrypt secrets.enc.yaml > secrets.yaml
# Extract single value
sops decrypt --extract '["database"]["password"]' secrets.enc.yamlPass to Process (No File)
bash
# As environment variables
sops exec-env secrets.enc.yaml './deploy.sh'
# As temporary file
sops exec-file secrets.enc.yaml 'source {}'Multi-Environment Configuration
yaml
# .sops.yaml
creation_rules:
# Production - admin + CI only
- path_regex: ^config/secrets/prod\..*
age: >-
age1admin...,
age1cicd...
# Staging/Dev - broader access
- path_regex: ^config/secrets/.*
age: >-
age1admin...,
age1cicd...,
age1dev...Selective Encryption
Only encrypt sensitive keys (keeps file readable):
yaml
creation_rules:
- age: age1...
encrypted_regex: ^(password|secret|token|key|api_key|private)$Result:
yaml
database:
host: localhost # plaintext
password: ENC[AES256_GCM,data:...,type:str] # encryptedCI/CD Integration
GitHub Actions
yaml
- name: Decrypt secrets
env:
SOPS_AGE_KEY: ${{ secrets.SOPS_AGE_KEY }}
run: sops decrypt config/secrets.enc.yaml > secrets.yamlStore in repository secrets as .
AGE-SECRET-KEY-1...SOPS_AGE_KEYEnvironment Variables
bash
# Key file location
export SOPS_AGE_KEY_FILE=/path/to/keys.txt
# Key value directly (CI/CD)
export SOPS_AGE_KEY="AGE-SECRET-KEY-1..."Key Management
Add New Recipient
- Update with new public key
.sops.yaml - Re-encrypt existing files:
bash
sops updatekeys -y file.enc.yaml
Remove Recipient
- Remove from
.sops.yaml - Re-encrypt and rotate:
bash
sops updatekeys -y file.enc.yaml sops rotate -i file.enc.yaml
Key Locations
| Platform | Default Path |
|---|---|
| Linux | |
| macOS | |
Reference Files
| File | When to Read |
|---|---|
| age-keys.md | Key generation, storage, distribution patterns |
| sops-config.md | .sops.yaml syntax, path rules, key groups |
| cli-reference.md | Full command reference, all flags |
| ci-cd-patterns.md | GitHub Actions, GitLab CI, Docker integration |
| troubleshooting.md | Common errors and solutions |
Common Issues
| Problem | Solution |
|---|---|
| "could not decrypt data key" | Wrong key - check |
| "no matching keys found" | File uses Shamir key groups - need multiple keys |
| Run from repo root or ensure file is in parent directory |
| path_regex not matching | Use regex syntax ( |
Security Notes
- Never commit private keys - Add ,
keys.txtto*.agekey.gitignore - Use dedicated CI keys - Easier to rotate, limit scope
- Rotate data keys - Run periodically
sops rotate - Limit recipients - Production files should have minimal access
Official Documentation
| Topic | URL |
|---|---|
| SOPS | https://getsops.io/docs/ |
| SOPS GitHub | https://github.com/getsops/sops |
| age | https://github.com/FiloSottile/age |