Zum Inhalt springen
Trainingslager IT-Trainingslager

Tag 4: .sops.yaml und creation_rules

Ziel: Eine .sops.yaml im Repo legt fest, welche Datei für wen und wie verschlüsselt wird – niemand tippt mehr --age oder --encrypted-regex, und dev und prod haben getrennte Schlüssel. · Dauer: ca. 60 min · Voraussetzung: Tag 3

Briefing

  • .sops.yaml enthält creation_rules: eine Liste von Regeln, jede mit path_regex und den Schlüsseln (age, pgp, hc_vault_transit_uri, …) plus Optionen wie encrypted_regex.
  • sops sucht die Datei vom aktuellen Verzeichnis aufwärts. path_regex wird gegen den Pfad relativ zur .sops.yaml geprüft. Die erste passende Regel gewinnt.
  • Die Regeln gelten beim Anlegen (und bei updatekeys, Tag 5). Eine bereits verschlüsselte Datei trägt ihre Recipients selbst im Block sops:.
  • Wer entschlüsselt, braucht keine .sops.yaml – nur eine passende Identity.
 ~/sops/repo/.sops.yaml
   ^prod/.*\.yaml$   → age1r025… (Pipeline-Schlüssel prod)   nur data/stringData
   ^dev/.*\.yaml$    → age126j… (ich)                       nur data/stringData
   ^notes/.*         → age126j… (ich)

Drill 1: Ein zweiter Schlüssel und die erste Regeldatei

prod bekommt einen eigenen Schlüssel – später hat ihn nur der Cluster bzw. die Pipeline.

# auf argo
mkdir -p ~/sops/tag04 && cd ~/sops/tag04
age-keygen -o prod.key
ICH=$(age-keygen -y ~/.config/sops/age/keys.txt)
PROD=$(age-keygen -y prod.key)
cd ~/sops/repo
cat > .sops.yaml <<EOF
creation_rules:
  - path_regex: ^prod/.*\.yaml$
    encrypted_regex: ^(data|stringData)$
    age: $PROD
  - path_regex: ^dev/.*\.yaml$
    encrypted_regex: ^(data|stringData)$
    age: $ICH
  - path_regex: ^notes/.*
    age: $ICH
EOF
cat .sops.yaml

Erwartet:

Public key: age1r025nv6kv083tjhqa7xpslvkc0m8qm2jljd0aqn55nzr859xqe7q4798ks
creation_rules:
  - path_regex: ^prod/.*\.yaml$
    encrypted_regex: ^(data|stringData)$
    age: age1r025nv6kv083tjhqa7xpslvkc0m8qm2jljd0aqn55nzr859xqe7q4798ks
  - path_regex: ^dev/.*\.yaml$
    encrypted_regex: ^(data|stringData)$
    age: age126j96yd6te036uya83l76w0afmlaj9vyyluxrmdeheew3u0wzdmslw69y2
  - path_regex: ^notes/.*
    age: age126j96yd6te036uya83l76w0afmlaj9vyyluxrmdeheew3u0wzdmslw69y2

Der Heredoc ist bewusst ohne Anführungszeichen (<<EOF): Die Shell setzt $PROD und $ICH ein, \. bleibt stehen. Mehrere Recipients trennst du in age: mit Kommas (Tag 5).

Fortschritt speichern? Kostenlos registrieren

Drill 2: Verschlüsseln ohne Optionen

# auf argo
cd ~/sops/repo
mkdir -p dev prod
for e in dev prod; do
  kubectl create secret generic notes-db -n notes-$e \
    --from-literal=password=lab-db-$e-123 --dry-run=client -o yaml > $e/notes-db.yaml
done
sops encrypt -i dev/notes-db.yaml
sops encrypt -i prod/notes-db.yaml
yq '.sops.age[].recipient' dev/notes-db.yaml prod/notes-db.yaml
yq '.kind, .data.password' prod/notes-db.yaml | cut -c1-40

Erwartet:

age126j96yd6te036uya83l76w0afmlaj9vyyluxrmdeheew3u0wzdmslw69y2
---
age1r025nv6kv083tjhqa7xpslvkc0m8qm2jljd0aqn55nzr859xqe7q4798ks
Secret
ENC[AES256_GCM,data:qJhs0Ct2YVuBXOKbIKY4

-i (in place) ersetzt den Klartext in der Datei durch die verschlüsselte Fassung. Recipients und encrypted_regex kommen aus der Regel, die zum Pfad passt.

Achtung: -i überschreibt nur die Datei selbst. Kopien, Editor-Backups und das, was schon in git add stand, bleiben Klartext – Klartextdateien deshalb nie stagen (Tag 9).

Fortschritt speichern? Kostenlos registrieren

Drill 3: Der fehlende Schlüssel und wo sops sucht

Symptom: Mit deinem Schlüssel lässt sich prod nicht öffnen.

# auf argo
cd ~/sops/repo
sops decrypt prod/notes-db.yaml 2>&1 | head -9

Erwartet:

Failed to get the data key required to decrypt the SOPS file.

Group 0: FAILED
  age1r025nv6kv083tjhqa7xpslvkc0m8qm2jljd0aqn55nzr859xqe7q4798ks: FAILED
    - | failed to create reader for decrypting sops data key with
      | age: no identity matched any of the recipients. Did not find
      | keys in locations 'SOPS_AGE_SSH_PRIVATE_KEY_FILE',
      | 'SOPS_AGE_SSH_PRIVATE_KEY_CMD', '/home/ubuntu/.ssh/id_rsa',
      | 'SOPS_AGE_KEY', 'SOPS_AGE_KEY_FILE', and 'SOPS_AGE_KEY_CMD'.

Die Meldung nennt den Recipient, für den ein Schlüssel fehlt, und alle Orte, an denen sops gesucht hat. Gefunden hat es nur ~/.config/sops/age/keys.txt – und der passt nicht. Drei Wege, sops einen anderen Schlüssel zu geben:

# auf argo
cd ~/sops/repo
SOPS_AGE_KEY_FILE=~/sops/tag04/prod.key sops decrypt prod/notes-db.yaml \
  | grep password
SOPS_AGE_KEY_CMD="cat $HOME/sops/tag04/prod.key" sops decrypt prod/notes-db.yaml \
  | grep -c password
SOPS_AGE_KEY=$(grep AGE-SECRET ~/sops/tag04/prod.key) \
  sops decrypt prod/notes-db.yaml | grep -c password

Erwartet:

    password: bGFiLWRiLXByb2QtMTIz
1
1
Variable Inhalt typischer Einsatz
SOPS_AGE_KEY_FILE Pfad zu einer Identity-Datei Laptop, Pipeline mit Datei
SOPS_AGE_KEY die Identity selbst CI-Variable
SOPS_AGE_KEY_CMD Befehl, der die Identity ausgibt Passwort-Manager

Die Standarddatei keys.txt liest sops zusätzlich – auch wenn eine der Variablen gesetzt ist. Und ein SSH-Schlüssel unter ~/.ssh/id_ed25519 bzw. id_rsa zählt ebenfalls als Identity (Tag 1, Drill 5).

Fortschritt speichern? Kostenlos registrieren

Drill 4: Die erste passende Regel gewinnt

Einbauen: Jemand ergänzt „zur Sicherheit“ eine Regel für alle YAML-Dateien – oben.

# auf argo
cd ~/sops/repo
cp .sops.yaml ~/sops/tag04/sops.yaml.gut
ICH=$(age-keygen -y ~/.config/sops/age/keys.txt)
yq -i '.creation_rules = [{"path_regex": "\\.yaml$", "age": "'$ICH'"}]
  + .creation_rules' .sops.yaml
head -4 .sops.yaml
kubectl create secret generic z --from-literal=k=lab-z-123 --dry-run=client \
  -o yaml > prod/z.yaml
sops encrypt -i prod/z.yaml

Symptom:

# auf argo
cd ~/sops/repo
yq '.sops.age[].recipient, .apiVersion' prod/z.yaml | cut -c1-40

Erwartet:

creation_rules:
  - path_regex: \.yaml$
    age: age126j96yd6te036uya83l76w0afmlaj9vyyluxrmdeheew3u0wzdmslw69y2
  - path_regex: ^prod/.*\.yaml$
age126j96yd6te036uya83l76w0afmlaj9vyylux
ENC[AES256_GCM,data:Wbg=,iv:xyfhbqSe4rID

Ursache: Die neue Regel passt auf jede YAML-Datei und steht vorn. Die prod-Datei ist deshalb für den falschen Schlüssel verschlüsselt (die Pipeline kann sie nicht lesen) und komplett, auch apiVersion.

Fix und Nachweis: Spezielle Regeln nach oben, allgemeine nach unten – oder die allgemeine ganz weglassen.

# auf argo
cd ~/sops/repo
rm prod/z.yaml
cp ~/sops/tag04/sops.yaml.gut .sops.yaml
yq '.creation_rules[].path_regex' .sops.yaml

Erwartet:

^prod/.*\.yaml$
^dev/.*\.yaml$
^notes/.*

Fortschritt speichern? Kostenlos registrieren

Drill 5: Keine Regel, keine Konfiguration

# auf argo
cd ~/sops/repo
printf 'a: b\n' > lose.yaml
sops encrypt -i lose.yaml; echo "rc=$?"
rm lose.yaml
cd /tmp
kubectl create secret generic y --from-literal=k=lab-y-123 --dry-run=client \
  -o yaml > ~/sops/repo/dev/y.yaml
sops encrypt -i ~/sops/repo/dev/y.yaml; echo "rc=$?"

Erwartet:

error loading config: no matching creation rules found
rc=1
config file not found, or has no creation rules, and no keys provided through command
line options
rc=1

Die erste Meldung ist ein Schutz: Eine Datei ohne Regel wird nicht mit irgendeinem Schlüssel verschlüsselt. Die zweite ist eine Falle: Aus /tmp findet sops die .sops.yaml nicht, denn es sucht vom aktuellen Verzeichnis aus, nicht vom Dateipfad. Abhilfe: im Repo arbeiten oder die Konfiguration nennen – --config ist eine globale Option und steht vor dem Unterbefehl.

# auf argo
cd /tmp
sops --config ~/sops/repo/.sops.yaml encrypt -i ~/sops/repo/dev/y.yaml
yq '.sops.age[].recipient' ~/sops/repo/dev/y.yaml
rm ~/sops/repo/dev/y.yaml

Erwartet:

age126j96yd6te036uya83l76w0afmlaj9vyyluxrmdeheew3u0wzdmslw69y2

Aus einem Unterordner des Repos (cd prod) findet sops die Datei dagegen, und der path_regex wird trotzdem gegen prod/… geprüft.

Fortschritt speichern? Kostenlos registrieren

Drill 6: Den MAC auf verschlüsselte Werte beschränken

Tag 3 hat gezeigt: Schon eine Änderung am Namespace bricht den MAC. In Repos, in denen Werkzeuge wie Renovate oder kustomize edit Klartextfelder (Labels, Annotationen) anpassen, kann das stören. Die Option mac_only_encrypted gibt es nur in .sops.yaml:

# auf argo
cd ~/sops/repo
yq -i '.creation_rules[1].mac_only_encrypted = true' .sops.yaml
kubectl create secret generic m --from-literal=k=lab-m-123 --dry-run=client \
  -o yaml > dev/m.yaml
sops encrypt -i dev/m.yaml
yq '.sops.mac_only_encrypted' dev/m.yaml
sed -i 's/name: m$/name: umbenannt/' dev/m.yaml
sops decrypt dev/m.yaml | grep -E 'name|k:'

Erwartet:

true
    k: bGFiLW0tMTIz
    name: umbenannt

Kein MAC mismatch: Der Name ist umbenannt, der verschlüsselte Wert unverändert. Der Preis: Niemand merkt mehr, wenn ein verschlüsselter Wert in einen anderen Namespace oder unter einen anderen Namen wandert. Im Buch bleibt deshalb der Standard.

# auf argo
cd ~/sops/repo
rm dev/m.yaml
cp ~/sops/tag04/sops.yaml.gut .sops.yaml

Fortschritt speichern? Kostenlos registrieren

Drill 7: Regeln und Dateien ins Repo

# auf argo
cd ~/sops/repo
for f in dev/notes-db.yaml prod/notes-db.yaml notes/app.enc.yaml; do
  printf '%s ' $f; sops filestatus $f; done
git add .sops.yaml dev prod
git commit -q -m "tag04: creation_rules, notes-db für dev und prod"
git push -q
git log --oneline | head -1
git ls-files

Erwartet:

dev/notes-db.yaml {"encrypted":true}
prod/notes-db.yaml {"encrypted":true}
notes/app.enc.yaml {"encrypted":true}
6fb50ed tag04: creation_rules, notes-db für dev und prod
.sops.yaml
README.md
dev/notes-db.yaml
notes/app.enc.yaml
prod/notes-db.yaml

.sops.yaml gehört ins Repo: Sie enthält nur öffentliche Schlüssel und dokumentiert, wer was lesen darf. prod.key gehört nicht hinein.

Fortschritt speichern? Kostenlos registrieren

Übung: Speed-Drills

  1. Zeig alle path_regex der Regeldatei. Zeitziel: 10 s
  2. Zeig das prod-Passwort im Klartext (Base64 dekodiert). Zeitziel: 40 s
  3. Zeig, welche Regel bei dev/x.yaml greifen würde, ohne etwas zu verschlüsseln. Zeitziel: 30 s

Lösung

# auf argo
cd ~/sops/repo
yq '.creation_rules[].path_regex' .sops.yaml
SOPS_AGE_KEY_FILE=~/sops/tag04/prod.key sops decrypt \
  --extract '["data"]["password"]' prod/notes-db.yaml | base64 -d; echo
for r in $(yq '.creation_rules[].path_regex' .sops.yaml); do
  echo dev/x.yaml | grep -qE "$r" && { echo "$r"; break; }; done

Erwartet:

^prod/.*\.yaml$
^dev/.*\.yaml$
^notes/.*
lab-db-prod-123
^dev/.*\.yaml$

Die Schleife bildet „erste passende Regel gewinnt“ mit grep -E nach – sops nutzt Go-Regex, für einfache Muster ist das gleichwertig.

Fortschritt speichern? Kostenlos registrieren

Kontrollpunkt

# auf argo
cd ~/sops/repo && git status -sb
sops decrypt dev/notes-db.yaml | yq '.data.password' | base64 -d; echo
yq '.creation_rules | length' .sops.yaml
ls ~/sops/tag04/prod.key

Erwartet:

## main...origin/main
lab-db-dev-123
3
/home/ubuntu/sops/tag04/prod.key

Challenge

Ergänze eine Regel, mit der eine dotenv-Datei dev/app.env mit deinem Schlüssel verschlüsselt wird (alle Werte), lege die Datei mit API_KEY=lab-key-123 an, verschlüssele sie in place und committe beides.

Hinweis: encrypted_regex: ^(data|stringData)$ würde in dotenv nichts verschlüsseln – die neue Regel braucht keinen Regex und muss nicht vor der YAML-Regel stehen, weil sich die Muster nicht überschneiden.

Lösung

# auf argo
cd ~/sops/repo
ICH=$(age-keygen -y ~/.config/sops/age/keys.txt)
yq -i '.creation_rules += [{"path_regex": "^dev/.*\\.env$", "age": "'$ICH'"}]' \
  .sops.yaml
printf 'API_KEY=lab-key-123\n' > dev/app.env
sops encrypt -i dev/app.env
cut -c1-40 dev/app.env | head -1
git add .sops.yaml dev/app.env
git commit -q -m "tag04: dotenv-Regel für dev" && git push -q
sops decrypt dev/app.env

Erwartet:

API_KEY=ENC[AES256_GCM,data:N1skRIiKsUbbn
API_KEY=lab-key-123

Fortschritt speichern? Kostenlos registrieren

Interview-Notiz

  • Was steht in .sops.yaml und wer liest sie? creation_rules mit path_regex, Schlüsseln und Optionen. sops liest sie beim Verschlüsseln und bei updatekeys, nicht beim Entschlüsseln. Die erste passende Regel gewinnt.
  • Wie trennst du Umgebungen? Eine Regel pro Umgebung mit eigenen Recipients – die prod-Pipeline hat nur den prod-Schlüssel, Entwickler nur dev.

Enterprise-Notiz

  • .sops.yaml per CODEOWNERS schützen: Wer die Regeln ändert, ändert, wer künftig Secrets lesen kann.
  • Statt einzelner Personen-Schlüssel in prod: KMS oder OpenBao Transit (Tag 7) plus ein Notfallschlüssel im Tresor.
  • Keine Auffangregel \.yaml$ am Ende ohne Grund – lieber scheitert eine Datei mit „no matching creation rules“, als dass sie für die falschen Leute verschlüsselt wird.
  • SOPS_AGE_KEY_CMD verbindet sops mit dem Passwort-Manager der Firma, ohne dass der Schlüssel als Datei auf dem Laptop liegt.