DEV Community

Kittipat.po
Kittipat.po

Posted on • Updated on

Encrypting your files using Mozilla SOPS

SOPS: Secrets OPerationS

sops is an editor of encrypted files that supports YAML, JSON, ENV, INI and BINARY formats and encrypts with AWS KMS, GCP KMS, Azure Key Vault, age, and PGP.

Installing

Encrypting using PGP

1. Generate a key 

export GPG_NAME="my-key"
export GPG_COMMENT="sops secrets"

gpg --batch --full-generate-key <<EOF
%no-protection
Key-Type: 1
Key-Length: 4096
Subkey-Type: 1
Subkey-Length: 4096
Expire-Date: 0
Name-Comment: ${GPG_COMMENT}
Name-Real: ${GPG_NAME}
EOF
Enter fullscreen mode Exit fullscreen mode
  • Retrieve the key name 
gpg --list-secret-keys "${GPG_NAME}"
sec   rsa4096 2022-09-15 [SCEA]
      0076DA32A6523CABC384933A8C755EF5C4FB4CC5
uid           [ultimate] my-key (sops secrets)
ssb   rsa4096 2022-09-15 [SEA]
Enter fullscreen mode Exit fullscreen mode
  • Store the GPG key fingerprint as an environment variable 
export GPG_ID=0076DA32A6523CABC384933A8C755EF5C4FB4CC5
Enter fullscreen mode Exit fullscreen mode

If your team need to use SOPS to encrypt or decrypt the secrets locally

public key using for encrypt
private key using for decrypt

  • To export key 
gpg --export -a "${GPG_ID}" > public.key
gpg --export-secret-key -a "${GPG_ID}" > private.key
Enter fullscreen mode Exit fullscreen mode
  • To import key 
gpg --import public.key
gpg --import private.key
Enter fullscreen mode Exit fullscreen mode

2 Let's encrypt a dummy kube secret

secret.yaml

apiVersion: v1
kind: Secret
metadata:
  name: mysecret
type: Opaque
data:
  username: YWRtaW4=
  password: MWYyZDFlMmU2N2Rm
Enter fullscreen mode Exit fullscreen mode

Encrypt 

sops -e secrets.yaml > secrets.enc.yaml
Enter fullscreen mode Exit fullscreen mode

If there are multiple GPG keys, there are 3 ways

  • Use the SOPS_PGP_FP env variable 
export SOPS_PGP_FP=0076DA32A6523CABC384933A8C755EF5C4FB4CC5
Enter fullscreen mode Exit fullscreen mode
  • Set up a .sops.yaml (root level of your project dir) 
creation_rules:
        - pgp: '0076DA32A6523CABC384933A8C755EF5C4FB4CC5'
Enter fullscreen mode Exit fullscreen mode
  • Specify GPG key id to encrypt 
sops -e -p 0076DA32A6523CABC384933A8C755EF5C4FB4CC5 secrets.yaml > secrets.enc.yaml
Enter fullscreen mode Exit fullscreen mode

Decrypt 

sops -d secrets.enc.yaml > secrets.yaml
Enter fullscreen mode Exit fullscreen mode

Encrypting using AWS KMS

Pre-requistes for this are:

  • A ready to use KMS key.

AWS KMS

[default]
aws_access_key_id = <access-key-id>
aws_secret_access_key = <access-key>

[kmsuser]
aws_access_key_id = <kmsuser-access-key-id>
aws_secret_access_key = <kmsuer-access-key>
Enter fullscreen mode Exit fullscreen mode

Set up your sops configuration

There are 3 ways to set up your sops configuration, which means telling sops which key to use, possibly what profile and what role to use.

  • Use the SOPS_KMS_ARN env variable 
export SOPS_KMS_ARN="arn:aws:kms:us-east-2:270179619257:key/d8bf4685-590e-49b6-8c05-abfabff7aa96"
Enter fullscreen mode Exit fullscreen mode
  • Set up a .sops.yaml (root level of your project dir) 
creation_rules:
        - kms: 'arn:aws:kms:us-east-2:270179619257:key/d8bf4685-590e-49b6-8c05-abfabff7aa96'
Enter fullscreen mode Exit fullscreen mode
  • Specify kms arn to encrypt 
sops -e --kms "arn:aws:kms:us-east-2:270179619257:key/d8bf4685-590e-49b6-8c05-abfabff7aa96" secrets.yaml > secrets.enc.yaml
Enter fullscreen mode Exit fullscreen mode

Encrypt 

sops -e secrets.yaml > secrets.enc.yaml
Enter fullscreen mode Exit fullscreen mode

Decrypt 

sops -d secrets.enc.yaml > secrets.yaml
Enter fullscreen mode Exit fullscreen mode

CI

There are a number of ways to use sops encrypted secrets in your CI workflow.

The most basic way is to install sops, decrypt and apply the decrypted file to your cluster. Simple Demo here

Github action 

- name: Sops Binary Installer
  uses: mdgreenwald/mozilla-sops-action@v1.4.1
  with:
    version: '<version>' # default is latest stable
  id: install
Enter fullscreen mode Exit fullscreen mode

Then

run: |
  sops -d secrets.enc.yaml | kubectl apply -f -
Enter fullscreen mode Exit fullscreen mode

However, it's most like you're using some kind of manifest management tool and will want secrets to work within that ecosystem. To achieve this there are some wrappers for sops:

Argo CD Integration

Ref

Top comments (0)

Read next

ricivolsenci profile image

🤔 Looking for advice on integrating SportDevs API for futsal data?

Rici -

lambdatestteam profile image

AI-Empowered Software Testing [Spartans Summit 2024]

LambdaTest Team -

lambdatestteam profile image

Clash of the Testing Titans: LambdaTest Spartans Summit 2024 Welcomes You!

LambdaTest Team -

jamescantor38 profile image

How to Create a Winning Test Automation Strategy

Jamescarton -