Skip to content

Commit

Permalink
Update docs for Sigstore sign/verify CLI
Browse files Browse the repository at this point in the history
Signed-off-by: Ivan Font <ifont@redhat.com>
  • Loading branch information
font committed Oct 3, 2024
1 parent b4f09bc commit 6be059e
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.model_signing.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ are supported:

* Bring your own key pair
* Bring your own PKI
- Keyless signing using Sigstore with Fulcio root
* Skip signing (only hash and create a bundle)

The signing part creates a [sigstore bundle](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto)
Expand Down Expand Up @@ -68,13 +69,13 @@ $ source .venv/bin/activate
## Sign

```bash
(.venv) $ python3 sign.py --model_path ${MODEL_PATH} --sig_out ${OUTPUT_PATH} --method {private-key, pki} {additional parameters depending on method}
(.venv) $ python3 sign.py --model_path ${MODEL_PATH} --sig_out ${OUTPUT_PATH} --method {private-key, pki, sigstore} {additional parameters depending on method}
```

## Verify

```bash
(.venv) $ python3 verify.py --model_path ${MODEL_PATH} --method {private-key, pki} {additional parameters depending on method}
(.venv) $ python3 verify.py --model_path ${MODEL_PATH} --sig_path ${SIG_PATH} --method {private-key, pki, sigstore} {additional parameters depending on method}
```

### Examples
Expand Down Expand Up @@ -122,9 +123,21 @@ $ ROOT_CERTS='/path/to/root/certs'
...
```

## Sigstore ID providers
#### Keyless signing using Sigstore

For developers signing models, there are three identity providers that can
```bash
$ MODEL_PATH='/path/to/your/model'
# SIGN
(.venv) $ python3 sign.py --model_path ${MODEL_PATH} --method sigstore
...
#VERIFY
(.venv) $ python3 verify.py --model_path ${MODEL_PATH} --sig_path ./model.sig --method sigstore --identity name@example.com --identity-provider https://accounts.example.com
...
```

### Sigstore ID providers

For developers signing models with Sigstore, there are three identity providers that can
be used at the moment:

* Google's provider is `https://accounts.google.com`.
Expand Down

0 comments on commit 6be059e

Please sign in to comment.