getsops/sops v3.8.1 on GitHub

Note from the Maintainers

In this release of SOPS, we have focused on landing a variety of bug fixes to improve the overall user experience.

For a comprehensive list of changes, please refer to CHANGELOG.rst.

Important Information for SOPS SDK Users

With the project transitioning from the Mozilla Foundation to the CNCF, the Go module path has been updated to reflect this change in ownership. If you use go.mozilla.org/sops/v3 as a library, going forward, import the Go Module using github.com/getsops/sops/v3. Apart from this small adjustment, the SDK's API remains fully backward compatible.

For a one-liner to quickly implement this change throughout your codebase, please refer to: #1246 (comment)

Installation

To install sops, download one of the pre-built binaries provided for your platform from the artifacts attached to this release.

For instance, if you are using Linux on an AMD64 architecture:

# Download the binary
curl -LO https://github.com/getsops/sops/releases/download/v3.8.1/sops-v3.8.1.linux.amd64

# Move the binary in to your PATH
mv sops-v3.8.1.linux.amd64 /usr/local/bin/sops

# Make the binary executable
chmod +x /usr/local/bin/sops

Verify checksums file signature

The checksums file provided within the artifacts attached to this release is signed using Cosign with GitHub OIDC. To validate the signature of this file, run the following commands:

# Download the checksums file, certificate and signature
curl -LO https://github.com/getsops/sops/releases/download/v3.8.1/sops-v3.8.1.checksums.txt
curl -LO https://github.com/getsops/sops/releases/download/v3.8.1/sops-v3.8.1.checksums.pem
curl -LO https://github.com/getsops/sops/releases/download/v3.8.1/sops-v3.8.1.checksums.sig

# Verify the checksums file
cosign verify-blob sops-v3.8.1.checksums.txt \
  --certificate sops-v3.8.1.checksums.pem \
  --signature sops-v3.8.1.checksums.sig \
  --certificate-identity-regexp=https://github.com/getsops \
  --certificate-oidc-issuer=https://token.actions.githubusercontent.com

Verify binary integrity

To verify the integrity of the downloaded binary, you can utilize the checksums file after having validated its signature:

# Verify the binary using the checksums file
sha256sum -c sops-v3.8.1.checksums.txt --ignore-missing

Verify artifact provenance

The SLSA provenance of the binaries, packages, and SBOMs can be found within the artifacts associated with this release. It is presented through an in-toto link metadata file named sops-v3.8.1.intoto.jsonl. To verify the provenance of an artifact, you can utilize the slsa-verifier tool:

# Download the metadata file
curl -LO  https://github.com/getsops/sops/releases/download/v3.8.1/sops-v3.8.1.intoto.jsonl

# Verify the provenance of the artifact
slsa-verifier verify-artifact <artifact> \
  --provenance-path sops-v3.8.1.intoto.jsonl \
  --source-uri github.com/getsops/sops \
  --source-tag v3.8.1

Container Images

The sops binaries are also available as container images, based on Debian (slim) and Alpine Linux. The Debian-based container images include any dependencies which may be required to make use of certain key services, such as GnuPG, AWS KMS, Azure Key Vault, and Google Cloud KMS. The Alpine-based container images are smaller in size, but do not include these dependencies.

These container images are available for the following architectures: linux/amd64 and linux/arm64.

GitHub Container Registry

ghcr.io/getsops/sops:v3.8.1
ghcr.io/getsops/sops:v3.8.1-alpine

Quay.io

quay.io/getsops/sops:v3.8.1
quay.io/getsops/sops:v3.8.1-alpine

Verify container image signature

The container images are signed using Cosign with GitHub OIDC. To validate the signature of an image, run the following command:

cosign verify ghcr.io/getsops/sops:v3.8.1 \
  --certificate-identity-regexp=https://github.com/getsops \
  --certificate-oidc-issuer=https://token.actions.githubusercontent.com \
  -o text

Verify container image provenance

The container images include SLSA provenance attestations. For more information around the verification of this, please refer to the slsa-verifier documentation.

Software Bill of Materials

The Software Bill of Materials (SBOM) for each binary is accessible within the artifacts enclosed with this release. It is presented as an SPDX JSON file, formatted as <binary>.spdx.sbom.json.

What's Changed

build(deps): Bump the ci group with 3 updates by @dependabot in #1295
pgp: improve handling of GnuPG home dir by @hiddeco in #1298
Delete sops encrypted file we don't have keys for by @felixfontein in #1288
Improve handling of errors when binary store handles bad data by @felixfontein in #1289
On macOS, prefer XDG_CONFIG_HOME over os.UserConfigDir() by @felixfontein in #1291
Do not crash if an empty YAML file is encrypted by @felixfontein in #1290
Fix descriptions of unencrypted-regex and encrypted-regex flags, and ensure unencrypted_regex is considered in config validation by @mitar in #1300
build(deps): Bump the go group with 4 updates by @dependabot in #1306
build(deps): Bump the ci group with 1 update by @dependabot in #1301
Handle return values of dec.Token() to improve error messages by @felixfontein in #1307
pgp: make error the last return value by @felixfontein in #1310
pgp: do not require abs path for SopsGpgExecEnv by @holiman in #1309
decrypt: fix dropped error by @alrs in #1304
Handle errors by @felixfontein in #1311
Report key rotation errors by @felixfontein in #1317
cmd/sops/main.go: make sure to wrap raw errors with toExitError() by @felixfontein in #1318
build(deps): Bump the go group with 7 updates by @dependabot in #1319
Enrich AWS authentication documentation by @nsantiago2719 in #1272
Better error reporting for missing gpg binary by @makkes in #1286
Improve RST and MD files by @felixfontein in #1320
Add linting for RST and MD files by @felixfontein in #1287
Update dependencies by @hiddeco in #1325
Prepare v3.8.1 by @hiddeco in #1324

New Contributors

@mitar made their first contribution in #1300
@holiman made their first contribution in #1309
@alrs made their first contribution in #1304
@nsantiago2719 made their first contribution in #1272
@makkes made their first contribution in #1286

Full Changelog: v3.8.0...v3.8.1