Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Handle errors #1311

Merged
merged 4 commits into from
Oct 3, 2023
Merged

Handle errors #1311

merged 4 commits into from
Oct 3, 2023

Conversation

felixfontein
Copy link
Contributor

Fixes some things reported by make staticcheck. This needs more testing and potentially tests, thus I marked it as a draft for now.

@felixfontein felixfontein marked this pull request as ready for review September 29, 2023 19:55
felixfontein
felixfontein commented Sep 29, 2023
View reviewed changes
Copy link
Contributor Author

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've now went through all ignored errors. This is ready for reviewing!

cmd/sops/common/common.go
@@ -89,6 +89,9 @@ func DecryptTree(opts DecryptTreeOpts) (dataKey []byte, err error) {
}
fileMac, err := opts.Cipher.Decrypt(opts.Tree.Metadata.MessageAuthenticationCode, dataKey, opts.Tree.Metadata.LastModified.Format(time.RFC3339))
if !opts.IgnoreMac {
if err != nil {
return nil, NewExitError(fmt.Sprintf("Cannot decrypt MAC: %s", err), codes.MacMismatch)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If err != nil, then decryption failed for some reason we should tell the user, instead of just saying that there was a MAC mismatch, with the file having a MAC of nil.

stores/yaml/store.go
@@ -131,6 +131,10 @@ func (store Store) appendYamlNodeToTreeBranch(node *yaml.Node, branch sops.TreeB
return nil, fmt.Errorf("YAML documents that are values are not supported")
case yaml.AliasNode:
branch, err = store.appendYamlNodeToTreeBranch(node.Alias, branch, false)
if err != nil {
// This should never happen since node.Alias was already successfully decoded before
return nil, err
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure this should never happen, but it definitely won't hurt to still pass on the error if it actually does.

stores/yaml/store.go
@@ -204,9 +208,9 @@ func (store *Store) appendSequence(in []interface{}, sequence *yaml.Node) {
}
if len(comments) > 0 {
if beginning {
comments = store.addCommentsHead(sequence, comments)
store.addCommentsHead(sequence, comments)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The return value is always nil. It's mainly returned so you can write comments = store.addCommentsHead(xx, comments) and continue using comments later on. But we have no "later" here, so removing the assignment is best (and makes the linter happy).

stores/yaml/store_test.go
foo: bar
baz: bam
key4: *bar
`)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having a test with anchors and aliases surely doesn't hurt.

@felixfontein felixfontein requested a review from a team September 29, 2023 19:58
@felixfontein felixfontein mentioned this pull request Oct 3, 2023
Closed
hiddeco
hiddeco approved these changes Oct 3, 2023
View reviewed changes
Copy link
Member

@hiddeco hiddeco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @felixfontein 🙏

@felixfontein @hiddeco
Ignore irrelevant return value (it is always nil).
a27e1bd 
Signed-off-by: Felix Fontein <felix@fontein.de>
@felixfontein @hiddeco
Handle unhandled errors.
38ec3f7 
Signed-off-by: Felix Fontein <felix@fontein.de>
@felixfontein @hiddeco
Defer only after checking err.
f668c71 
Signed-off-by: Felix Fontein <felix@fontein.de>
@felixfontein @hiddeco
Check err for nil in tests.
dd59dc1 
Signed-off-by: Felix Fontein <felix@fontein.de>
@hiddeco hiddeco merged commit 0fd3c72 into getsops:main Oct 3, 2023
9 checks passed
@hiddeco hiddeco added this to the v3.8.1 milestone Oct 3, 2023
@felixfontein felixfontein deleted the errors branch October 8, 2023 13:24
mergify bot pushed a commit to dbsystel/cdk-sops-secrets that referenced this pull request Oct 11, 2023
@renovate
fix(deps): update module github.com/getsops/sops/v3 to v3.8.1 (#878)
218ddf3 
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [github.com/getsops/sops/v3](https://togithub.com/getsops/sops) | require | patch | `v3.8.0` -> `v3.8.1` |

---

### Release Notes

<details>
<summary>getsops/sops (github.com/getsops/sops/v3)</summary>

### [`v3.8.1`](https://togithub.com/getsops/sops/releases/tag/v3.8.1)

[Compare Source](https://togithub.com/getsops/sops/compare/v3.8.0...v3.8.1)

#### 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`](https://togithub.com/getsops/sops/blob/v3.8.1/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: [getsops/sops#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:

```shell

### 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](https://docs.sigstore.dev/cosign/overview/) with GitHub OIDC. To validate the signature of this file, run the following commands:

```shell

### 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:

```shell

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

##### Verify artifact provenance

The [SLSA provenance](https://slsa.dev/provenance/v0.2) of the binaries, packages, and SBOMs can be found within the artifacts associated with this release. It is presented through an [in-toto](https://in-toto.io/) link metadata file named `sops-v3.8.1.intoto.jsonl`. To verify the provenance of an artifact, you can utilize the [`slsa-verifier`](https://togithub.com/slsa-framework/slsa-verifier#artifacts) tool:

```shell

### 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](https://docs.sigstore.dev/cosign/overview/) with GitHub OIDC. To validate the signature of an image, run the following command:

```shell
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](https://slsa.dev/provenance/v0.2) attestations. For more information around the verification of this, please refer to the [`slsa-verifier` documentation](https://togithub.com/slsa-framework/slsa-verifier#containers).

#### 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](https://spdx.dev/) JSON file, formatted as `<binary>.spdx.sbom.json`.

#### What's Changed

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

#### New Contributors

-   [@&#8203;mitar](https://togithub.com/mitar) made their first contribution in [getsops/sops#1300
-   [@&#8203;holiman](https://togithub.com/holiman) made their first contribution in [getsops/sops#1309
-   [@&#8203;alrs](https://togithub.com/alrs) made their first contribution in [getsops/sops#1304
-   [@&#8203;nsantiago2719](https://togithub.com/nsantiago2719) made their first contribution in [getsops/sops#1272
-   [@&#8203;makkes](https://togithub.com/makkes) made their first contribution in [getsops/sops#1286

**Full Changelog**: getsops/sops@v3.8.0...v3.8.1

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/markussiebert/cdk-sops-secrets).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hiddeco hiddeco hiddeco approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.8.1
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@felixfontein @hiddeco