Skip to content

Commit

Permalink
docs: minor edits to docs (#370)
Browse files Browse the repository at this point in the history
* minor edits to docs

Signed-off-by: Trishank Karthik Kuppusamy <[email protected]>

* Update verification.md

Signed-off-by: Trishank Karthik Kuppusamy <[email protected]>

* Update verification.md

Signed-off-by: Trishank Karthik Kuppusamy <[email protected]>

* Update signed_entity.go

`WithoutAnyObserverTimestampsUnsafe` doesn't seem to exist anymore

Signed-off-by: Trishank Karthik Kuppusamy <[email protected]>

---------

Signed-off-by: Trishank Karthik Kuppusamy <[email protected]>
  • Loading branch information
trishankatdatadog authored Jan 24, 2025
1 parent 729246f commit 9c466a8
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/signing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This document will walk you through using `sigstore-go` to generate a Sigstore b
Clone this repository and run the following command:

```shell
$ make examples
$ make build-examples
$ go install ./examples/sigstore-go-signing
```

Expand Down
12 changes: 2 additions & 10 deletions docs/verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,8 @@ Going through this step-by-step, we'll start by loading the trusted root from th
if err != nil {
panic(err)
}
trustedrootJSON, err := client.GetTarget("trusted_root.json")
if err != nil {
panic(err)
}

trustedMaterial, err := root.NewTrustedRootFromJSON(trustedrootJSON)
trustedMaterial, err := root.GetTrustedRoot(client)
if err != nil {
panic(err)
}
Expand Down Expand Up @@ -201,12 +197,8 @@ func main() {
if err != nil {
panic(err)
}
trustedrootJSON, err := client.GetTarget("trusted_root.json")
if err != nil {
panic(err)
}

trustedMaterial, err := root.NewTrustedRootFromJSON(trustedrootJSON)
trustedMaterial, err := root.GetTrustedRoot(client)
if err != nil {
panic(err)
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/verify/signed_entity.go
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ func WithCurrentTime() VerifierOption {
func (c *VerifierConfig) Validate() error {
if !c.requireObserverTimestamps && !c.requireSignedTimestamps && !c.requireIntegratedTimestamps && !c.useCurrentTime {
return errors.New("when initializing a new SignedEntityVerifier, you must specify at least one of " +
"WithObserverTimestamps(), WithSignedTimestamps(), WithIntegratedTimestamps(), or WithoutAnyObserverTimestampsUnsafe()")
"WithObserverTimestamps(), WithSignedTimestamps(), or WithIntegratedTimestamps()")
}

return nil
Expand Down

0 comments on commit 9c466a8

Please sign in to comment.