Skip to content

Commit fd5d24c

Browse files
committed
More details about Cosign
1 parent 55c47ac commit fd5d24c

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,12 @@ By default, this template uses the base image `quay.io/almalinuxorg/atomic-deskt
2222

2323
To switch images, change the `FROM` line in the [Dockerfile](Dockerfile). If your image use a different signing key, download the new Cosign public key and specify its name in the `upstream-public-key` parameter in `.github/workflows/build.yml`, or remove the parameter to disable key verification.
2424

25-
### Setting up Cosign (Optional)
25+
### Setting up Cosign (Optional, highly recommended)
26+
27+
Container signing is important for end-user security and is fully supported by
28+
the CI. By default, the CI will check the signature of your base image to make
29+
sure it hasn't been tampered with. You can also sign your own image to give
30+
your users the same security guarantees.
2631

2732
If you'd like to sign your images using Cosign:
2833

@@ -31,8 +36,11 @@ If you'd like to sign your images using Cosign:
3136
podman run --rm -it -v /tmp:/cosign-keys bitnami/cosign generate-key-pair
3237
```
3338
Leave the password blank. The keys will be in `/tmp/cosign.{key,pub}`.
34-
2. Add `cosign.pub` to the repository as `/cosign.pub`, commit, and push. This file is public and needed for signature verification.
35-
3. In GitHub repo settings, go to "Secrets and variables" > "Actions". Create a secret called `SIGNING_SECRET` and paste the contents of `cosign.key`. Store `cosign.key` securely and delete it from `/tmp`.
39+
2. Add `cosign.pub` to the repository as `/cosign.pub`, commit, and push. This file is public and needed for signature verification. **NEVER** commit your `cosign.key` to the repo!!
40+
3. In GitHub repo settings, go to "Secrets and variables" > "Actions". Create a secret called `SIGNING_SECRET` and paste the contents of `cosign.key`. Store `cosign.key` securely and delete it from `/tmp`. You can also do this via the GitHub CLI:
41+
```bash
42+
gh secret set SIGNING_SECRET < cosign.key
43+
```
3644

3745
## Customizing your respin
3846

0 commit comments

Comments
 (0)