@@ -246,22 +246,27 @@ Example:
246
246
247
247
# ## `verify`
248
248
249
- **Default**: `true `
249
+ **Default**: `false `
250
250
251
251
The `verify` setting controls whether or not the generated signatures and certificates are
252
252
verified with the `sigstore verify` subcommand after all files have been signed.
253
253
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.
256
257
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.
257
260
258
261
Example :
259
262
260
263
` ` ` yaml
261
264
- uses: sigstore/[email protected]
262
265
with:
263
266
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
265
270
` ` `
266
271
267
272
# ## `verify-cert-identity`
@@ -272,13 +277,19 @@ The `verify-cert-identity` setting controls whether to verify the Subject Altern
272
277
signing certificate after signing has taken place. If it is set, `sigstore-python` will compare the
273
278
certificate's SAN against the provided value.
274
279
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.
276
285
277
286
` ` ` yaml
278
287
- uses: sigstore/[email protected]
279
288
with:
280
289
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
282
293
` ` `
283
294
284
295
# ## `verify-oidc-issuer`
@@ -289,14 +300,20 @@ The `verify-oidc-issuer` setting controls whether to verify the issuer extension
289
300
certificate after signing has taken place. If it is set, `sigstore-python` will compare the
290
301
certificate's issuer extension against the provided value.
291
302
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.
293
308
294
309
Example :
295
310
296
311
` ` ` yaml
297
312
- uses: sigstore/[email protected]
298
313
with:
299
314
inputs: file.txt
315
+ verify: true
316
+ verify-cert-identity: [email protected]
300
317
verify-oidc-issuer: https://oauth2.sigstage.dev/auth
301
318
` ` `
302
319
0 commit comments