Skip to content

Commit 84e7fdb

Browse files
committed
document --ca-roots flag for 'cosign verify'
Related to sigstore/cosign#3462. Document the new 'cosign verify' --ca-roots flag and its difference to the --certificate-chain flag. List the supported and currently unsupported use cases (single/multiple CA(s), intermediate CAs). Signed-off-by: Dmitry S <dsavints@gmail.com>
1 parent eaf6977 commit 84e7fdb

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

content/en/verifying/verify.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,25 @@ $ cosign verify --certificate cosign.crt --certificate-chain chain.crt user/demo
8080
```
8181

8282
## Verify image with user-provided trusted chain
83-
Verify image with the provided certificate chain and identity parameters (intended for
84-
a "bring your own PKI" use case):
85-
83+
Verify image with the provided certificate chain(s) and identity parameters (intended for
84+
"bring your own PKI" use cases).
85+
* with a single certificate chain file - which may contain one or several intermediate
86+
certificates followed by the root CA certificate - use the `--certificate-chain` parameter:
8687
```shell
8788
$ cosign verify --certificate-chain chain.crt --certificate-oidc-issuer https://issuer.example.com --certificate-identity foo@example.com user/demo
8889
```
90+
* with a certificate bundle PEM file containing several CA roots (but without
91+
intermediate certificate), use the `--ca-roots` parameter:
92+
```shell
93+
$ cosign verify --ca-roots ca-roots.pem --certificate-oidc-issuer https://issuer.example.com --certificate-identity foo@example.com user/demo
94+
```
95+
96+
The `--ca-roots` and `--certificate-chain` flags are mutually exclusive.
97+
98+
Note that the hypothetical use case of "multiple chains with multiple CA roots and intermediate
99+
certificates" is not yet supported. There are plans to add the `--ca-intermediates` parameter
100+
(see [issue #3462](https://github.com/sigstore/cosign/issues/3462)). If you need this,
101+
please open an issue and mention it on the Sigstore #cosign Slack.
89102

90103
## Verify an image on the transparency log
91104

0 commit comments

Comments
 (0)