Skip to content

Commit b290ffb

Browse files
committed
README: clarify use of verification settings
Signed-off-by: William Woodruff <[email protected]>
1 parent 6a002ec commit b290ffb

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -246,22 +246,27 @@ Example:
246246

247247
### `verify`
248248

249-
**Default**: `true`
249+
**Default**: `false`
250250

251251
The `verify` setting controls whether or not the generated signatures and certificates are
252252
verified with the `sigstore verify` subcommand after all files have been signed.
253253

254-
This is not strictly necessary but can act as a smoke test to ensure that all signing artifacts were
255-
generated properly and the signature was properly submitted to Rekor.
254+
This is **not strictly necessary** but can act as a smoke test to ensure that all
255+
signing artifacts were generated properly and the signature was properly
256+
submitted to Rekor.
256257

258+
If `verify` is enabled, then you **must** also pass the `verify-cert-identity`
259+
and `verify-oidc-issuer` settings. Failing to pass these will produce an error.
257260

258261
Example:
259262

260263
```yaml
261264
- uses: sigstore/[email protected]
262265
with:
263266
inputs: file.txt
264-
verify: false
267+
verify: true
268+
verify-oidc-issuer: https://some-oidc-issuer.example.com
269+
verify-cert-identity: some-identity
265270
```
266271

267272
### `verify-cert-identity`
@@ -272,13 +277,19 @@ The `verify-cert-identity` setting controls whether to verify the Subject Altern
272277
signing certificate after signing has taken place. If it is set, `sigstore-python` will compare the
273278
certificate's SAN against the provided value.
274279

275-
This setting only applies if `verify` is set to `true`.
280+
This setting only applies if `verify` is set to `true`. Supplying it without `verify: true`
281+
will produce an error.
282+
283+
This setting may only be used in conjunction with `verify-oidc-issuer`.
284+
Supplying it without `verify-oidc-issuer` will produce an error.
276285

277286
```yaml
278287
- uses: sigstore/[email protected]
279288
with:
280289
inputs: file.txt
281-
verify-cert-identity: [email protected]
290+
verify: true
291+
verify-cert-identity: [email protected]
292+
verify-oidc-issuer: https://oauth2.sigstage.dev/auth
282293
```
283294

284295
### `verify-oidc-issuer`
@@ -289,14 +300,20 @@ The `verify-oidc-issuer` setting controls whether to verify the issuer extension
289300
certificate after signing has taken place. If it is set, `sigstore-python` will compare the
290301
certificate's issuer extension against the provided value.
291302

292-
This setting only applies if `verify` is set to `true`.
303+
This setting only applies if `verify` is set to `true`. Supplying it without `verify: true`
304+
will produce an error.
305+
306+
This setting may only be used in conjunction with `verify-cert-identity`.
307+
Supplying it without `verify-cert-identity` will produce an error.
293308

294309
Example:
295310

296311
```yaml
297312
- uses: sigstore/[email protected]
298313
with:
299314
inputs: file.txt
315+
verify: true
316+
verify-cert-identity: [email protected]
300317
verify-oidc-issuer: https://oauth2.sigstage.dev/auth
301318
```
302319

0 commit comments

Comments
 (0)