You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit bcd7435
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: internal/updater/README.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,14 +26,20 @@ The configuration for those is spread across the repository and the GitHub Actio
26
26
A new release is published by pushing a version tag (`v*`) to the repository. Once that happens the GHA workflow `autorelease.yml` is kicked off. It is configured in `.github/workflows/autorelease.yml` and through a number of injected environment variables from the GHA settings. Most importantly `GPG_PRIVATE_KEY` which contains the armored
27
27
GPG private part of the current release signing key and the respective passphrase in `PASSPHRASE`.
28
28
29
-
GoReleaser is controlled by `.goreleaser.yml` in the root of this repository. The relevant sections there are `checksum` to ensure a checksum file is generated and the `signs` section to sign the checksum file using the provided `GPG_FINGERPRINT` in the workflow.
29
+
GoReleaser is controlled by `.goreleaser.yml` in the root of this repository. The relevant sections there are `checksum` to ensure a checksum file is generated and the `signs` section to sign the checksum file. We currently publish both a GPG signature for the updater (`SHA256SUMS.sig`) and a keyless cosign bundle (`SHA256SUMS.sigstore.json`) for external verification.
30
+
31
+
For maintainers running local snapshot releases: signing is skipped unless the
32
+
required release credentials are available. Set `GPG_FINGERPRINT` to produce the
33
+
GPG checksum signature locally, and set `COSIGN_KEY` to produce a local cosign
34
+
bundle. Keyless cosign signing only runs in GitHub Actions where OIDC identity
35
+
is available.
30
36
31
37
## Managing keys and related assets
32
38
33
39
The relase signing key is set to expire every other year, so we need to follow a certain key rotation protocol to allow for a seamless key rotation.
34
40
35
41
* At T-6 Month we should notice that `TestGPGVerifyIn6Months` starts to fail.
36
-
* There is likely a loss obstrusive way to achieve that, but I'll leave it at that for now.
42
+
* There is likely a loss obstrusive way to achieve that, but I'll leave it at that for now.
37
43
* We should then create an issue to track the key rollover (this should never happen in secret). The entire security posture isn't perfect but that's the best I can do with my resources. Help always appreciated.
38
44
* For the actual rollout we first need to generate a new key. That needs to be done by exactly one core maintainer with write access to the repo and the GHA secrets since only they can inject the new key, fingerprint and passphrase.
39
45
* To generate the key run: `gpg --expert --full-generate-key` and select `RSA and RSA`, `3072` (bits) and a validity of `2y`. Use `Gopass Release Signing Key YYYY` as the name, `GitHub Actions only` as the comment and `release@gopass.pw` as the email.
@@ -52,9 +58,9 @@ The relase signing key is set to expire every other year, so we need to follow a
52
58
* Create a file that contains `gopass-sign-test\n` and run `gpg -u 0xKEYID --armor --output /tmp/testdata.sig --detatch-sign testdata`. Use the correct KEYID (the one of the NEW key).
53
59
* Hint: Make sure the input only contains one line break, not two.
54
60
* Paste the content of /tmp/testdata.sig into the `testSignature` in `verify_test.go`. Make sure all tests pass.
55
-
* Navigate to https://github.com/gopasspw/gopass/settings/secrets/actions
56
-
* Paste the armored private part of the new key into the existing `GPG_PRIVATE_KEY` secret.
57
-
* Paste the corresponding passphrase into `PASSPHRASE`.
61
+
* Navigate to <https://github.com/gopasspw/gopass/settings/secrets/actions>
62
+
* Paste the armored private part of the new key into the existing `GPG_PRIVATE_KEY` secret.
63
+
* Paste the corresponding passphrase into `PASSPHRASE`.
58
64
* At this point you should be able to safely delete the old public key from verify.go and kick off a new release.
59
65
* At the very end upload the new key to some keyservers: `gpg --send-keys 0xKEYID` and possibly `gpg --keyserver pgp.mit.edu --send-keys 0xKEYID`.
60
66
* In case you mess up during key generation you might need to start over and you don't want to have conflicting keys on a keyserver where you can't delete them.
0 commit comments