sigstore-go

https://pkg.go.dev/github.com/sigstore/sigstore-go
Admin
sigstore-go is a minimal and friendly Go client library for Sigstore that provides signing and...
Tokens:53,951
Snippets:573
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Build sigstore-go-verification Example

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/examples/sigstore-go-verification

Builds the sigstore-go-verification example executable. The built executable will be located in the examples/ directory.

```bash
go build -C ./examples/sigstore-go-verification -o sigstore-go-verification .
```

--------------------------------

### List Executable Examples

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/examples/sigstore-go-verification

Finds and lists all executable files within the examples directory, sorted alphabetically.

```bash
find examples -type f -perm -u+x | sort
```

--------------------------------

### Initialize Default TUF Client

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

Creates a new Sigstore TUF client for the public good instance. This is the recommended way to get started.

```go
func DefaultClient() (*Client, error)
```

--------------------------------

### sigstore-go-verification Output Example

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/examples/sigstore-go-verification

Example output from a successful verification using the sigstore-go-verification CLI, including a success message and a JSON statement.

```json
Verification successful!
{
   "version": 20230823,
   "statement": {
      "_type": "https://in-toto.io/Statement/v0.1",
      "predicateType": "https://slsa.dev/provenance/v0.2",
      "subject": ...
    },
    ...
}
```

--------------------------------

### sigstore-go-verification CLI Usage

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/examples/sigstore-go-verification

Verifies a Sigstore bundle using the sigstore-go-verification CLI. This example specifies artifact digest, issuer, and SAN, and points to a bundle file.

```bash
./sigstore-go-verification \
  -artifact-digest 76176ffa33808b54602c7c35de5c6e9a4deb96066dba6533f50ac234f4f1f4c6b3527515dc17c06fbe2860030f410eee69ea20079bd3a2c6f3dcf3b329b10751 \
  -artifact-digest-algorithm sha512 \
  -expectedIssuer https://token.actions.githubusercontent.com \
  -expectedSAN https://github.com/sigstore/sigstore-js/.github/workflows/release.yml@refs/heads/main \
  ../bundle-provenance.json
```

--------------------------------

### Get Signature

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tlog

Retrieves the signature of the transparency log entry.

```go
func (entry *Entry) Signature() []byte
```

--------------------------------

### Get Entry Body

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tlog

Retrieves the body of the transparency log entry.

```go
func (entry *Entry) Body() any
```

--------------------------------

### Get Rekor Logs

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves the Rekor logs from the trusted root.

```go
func (l *LiveTrustedRoot) RekorLogs() map[string]*TransparencyLog
```

--------------------------------

### Get Signing Configuration from TUF Client

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Fetches the public-good Sigstore signing configuration target from TUF using a provided client.

```go
func GetSigningConfig(c *tuf.Client) (*SigningConfig, error)
```

--------------------------------

### Get CTLogs from LiveTrustedRoot

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Returns a map of transparency logs associated with the live trusted root.

```go
func (l *LiveTrustedRoot) CTLogs() map[string]*TransparencyLog
```

--------------------------------

### Get Transparency Log Entry Proto

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tlog

Retrieves the underlying v1.TransparencyLogEntry proto from the Entry object.

```go
func (entry *Entry) TransparencyLogEntry() *v1.TransparencyLogEntry
```

--------------------------------

### Get Log Index

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tlog

Retrieves the log index of the transparency log entry.

```go
func (entry *Entry) LogIndex() int64
```

--------------------------------

### Get Public Key

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tlog

Retrieves the public key associated with the transparency log entry.

```go
func (entry *Entry) PublicKey() any
```

--------------------------------

### Get Staging TUF Root Certificate

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

Retrieves the root.json for the staging TUF instance.

```go
func StagingRoot() []byte
```

--------------------------------

### Fulcio: Get Certificate - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Retrieves a DER-encoded code signing certificate using the provided keypair and options.

```go
func (f *Fulcio) GetCertificate(ctx context.Context, keypair Keypair, opts *CertificateProviderOptions) ([]byte, error)
```

--------------------------------

### Get CTLogs from BaseTrustedMaterial

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Returns a map of transparency logs associated with the base trusted material.

```go
func (b *BaseTrustedMaterial) CTLogs() map[string]*TransparencyLog
```

--------------------------------

### Transparency Interface Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Interface for interacting with a transparency log, defining a method to get a transparency log entry.

```go
type Transparency interface {
	GetTransparencyLogEntry(context.Context, []byte, *protobundle.Bundle) error
}
```

--------------------------------

### Rekor: Get Transparency Log Entry - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Retrieves a transparency log entry from Rekor using the provided key/certificate PEM and bundle.

```go
func (r *Rekor) GetTransparencyLogEntry(ctx context.Context, keyOrCertPEM []byte, b *protobundle.Bundle) error
```

--------------------------------

### Get Default TUF Client Options

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

DefaultOptions returns an options struct for the public good instance. Use this for a standard configuration.

```go
func DefaultOptions() *Options
```

--------------------------------

### sigstore-go-signing CLI Help

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/examples/sigstore-go-verification

Displays the help text for the sigstore-go-signing CLI, outlining options for signing Sigstore bundles.

```bash
./sigstore-go-signing -h
```

--------------------------------

### Create Signing Configuration from File Path

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Creates a Sigstore signing configuration from a file specified by its path.

```go
func NewSigningConfigFromPath(path string) (*SigningConfig, error)
```

--------------------------------

### Get Target File from TUF Repository

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

Retrieves a specific target file from the TUF repository using the client. Ensure the client is properly initialized.

```go
func (c *Client) GetTarget(target string) ([]byte, error)
```

--------------------------------

### NewFulcio Client - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Initializes a new Fulcio client with the provided options.

```go
func NewFulcio(opts *FulcioOptions) *Fulcio
```

--------------------------------

### Get Timestamping Authorities

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves the timestamping authorities from the trusted root.

```go
func (l *LiveTrustedRoot) TimestampingAuthorities() []TimestampingAuthority
```

--------------------------------

### Create New Service

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Initializes a Service object from a protobuf Service.

```go
func NewService(s *prototrustroot.Service) Service
```

--------------------------------

### TimestampAuthority: Get Timestamp - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Retrieves a timestamp for the given signature.

```go
func (ta *TimestampAuthority) GetTimestamp(ctx context.Context, signature []byte) ([]byte, error)
```

--------------------------------

### EphemeralKeypair: Get Public Key - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Returns the public key.

```go
func (e *EphemeralKeypair) GetPublicKey() crypto.PublicKey
```

--------------------------------

### Fetch Signing Configuration with Options

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Fetches the public-good Sigstore signing configuration from TUF using specified options.

```go
func FetchSigningConfigWithOptions(opts *tuf.Options) (*SigningConfig, error)
```

--------------------------------

### EphemeralKeypair: Get Hint - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Returns the fingerprint of the public key.

```go
func (e *EphemeralKeypair) GetHint() []byte
```

--------------------------------

### Create SigningConfig from JSON

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Creates a Sigstore signing configuration as a protobuf from JSON byte slice.

```go
func NewSigningConfigProtobuf(scJSON []byte) (*prototrustroot.SigningConfig, error)
```

--------------------------------

### Initialize Custom TUF Client

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

Creates a new Sigstore TUF client with custom options. Use this to configure caching, repository URLs, or root certificates.

```go
func New(opts *Options) (*Client, error)
```

--------------------------------

### EphemeralKeypair: Get Signing Algorithm - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Returns the signing algorithm of the key.

```go
func (e *EphemeralKeypair) GetSigningAlgorithm() protocommon.PublicKeyDetails
```

--------------------------------

### Create Signing Configuration from Protobuf

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Creates a Sigstore signing configuration from a protobuf SigningConfig object.

```go
func NewSigningConfigFromProtobuf(sc *prototrustroot.SigningConfig) (*SigningConfig, error)
```

--------------------------------

### Get Integrated Time

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tlog

Retrieves the integrated time of the transparency log entry.

```go
func (entry *Entry) IntegratedTime() time.Time
```

--------------------------------

### Run Tests with Makefile

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go

Tests are invoked using the standard Go testing framework. A helper exists in the Makefile also.

```bash
make test

```

--------------------------------

### Create Signing Configuration from JSON

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Creates a Sigstore signing configuration from a JSON byte slice.

```go
func NewSigningConfigFromJSON(rootJSON []byte) (*SigningConfig, error)
```

--------------------------------

### Get PublicKeyVerifier

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves a time-constrained public key verifier for a given key ID.

```go
func (l *LiveTrustedRoot) PublicKeyVerifier(keyID string) (TimeConstrainedVerifier, error)
```

--------------------------------

### Get Fulcio Certificate Authorities

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves the Fulcio certificate authorities from the trusted root.

```go
func (l *LiveTrustedRoot) FulcioCertificateAuthorities() []CertificateAuthority
```

--------------------------------

### Fetch Signing Configuration

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Fetches the public-good Sigstore signing configuration from TUF.

```go
func FetchSigningConfig() (*SigningConfig, error)
```

--------------------------------

### BundleOptions Struct

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Options for creating a signed bundle. Configure certificate providers, timestamp authorities, transparency logs, and trusted roots.

```go
type BundleOptions struct {
	// Optional certificate provider to get code signing certificate from.
	//
	// Typically a Fulcio instance; resulting bundle will contain a certificate
	// for its verification material content instead of a public key.
	CertificateProvider CertificateProvider
	// Optional options for certificate provider
	//
	// Some certificate authorities may require options to be set
	CertificateProviderOptions *CertificateProviderOptions
	// Optional list of timestamp authorities to contact for inclusion in bundle
	TimestampAuthorities []*TimestampAuthority
	// Optional list of Rekor instances to get transparency log entry from.
	//
	// Supports hashedrekord and dsse entry types.
	TransparencyLogs []Transparency
	// Optional context for retrying network requests
	Context context.Context
	// Optional trusted root to verify signed bundle
	TrustedRoot root.TrustedMaterial
}
```

--------------------------------

### Create New Signing Configuration

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Initializes a SigningConfig object with provided services and configurations for Fulcio, OIDC, Rekor, and timestamping authorities.

```go
func NewSigningConfig(mediaType string,
	fulcioCertificateAuthorities []Service,
	oidcProviders []Service,
	rekorLogs []Service,
	rekorLogsConfig ServiceConfiguration,
	timestampAuthorities []Service,
	timestampAuthoritiesConfig ServiceConfiguration) (*SigningConfig, error)
```

--------------------------------

### NewSigningConfigProtobuf

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Creates a Sigstore signing configuration from JSON bytes, returning it as a protobuf object.

```APIDOC
## NewSigningConfigProtobuf

### Description

This function takes a byte slice representing a Sigstore signing configuration in JSON format and converts it into a protobuf representation.

### Signature

```go
func NewSigningConfigProtobuf(scJSON []byte) (*prototrustroot.SigningConfig, error)
```

### Parameters

- **scJSON** ([]byte) - The signing configuration in JSON format.

### Returns

- (*prototrustroot.SigningConfig) - The signing configuration as a protobuf object.
- (error) - An error if the conversion fails.
```

--------------------------------

### Get Timestamping Authorities from TrustedRoot

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves a list of timestamping authorities from a TrustedRoot. Added in v0.3.0.

```go
func (tr *TrustedRoot) TimestampingAuthorities() []TimestampingAuthority
```

--------------------------------

### Get Timestamping Authorities from TrustedMaterialCollection

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves a list of timestamping authorities from a TrustedMaterialCollection. Added in v0.3.0.

```go
func (tmc TrustedMaterialCollection) TimestampingAuthorities() []TimestampingAuthority
```

--------------------------------

### Create TrustedRoot from File Path

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Loads and initializes a TrustedRoot object from a file path.

```go
func NewTrustedRootFromPath(path string) (*TrustedRoot, error)
```

--------------------------------

### Get Fulcio Certificate Authorities from TrustedMaterialCollection

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves the list of Fulcio certificate authorities from a TrustedMaterialCollection.

```go
func (tmc TrustedMaterialCollection) FulcioCertificateAuthorities() []CertificateAuthority
```

--------------------------------

### FetchSigningConfigWithOptions

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Fetches the public-good Sigstore signing configuration from TUF with specified options.

```APIDOC
## FetchSigningConfigWithOptions

### Description
Fetches the public-good Sigstore signing configuration from TUF with the given options.

### Method
FetchSigningConfigWithOptions(opts *tuf.Options)

### Parameters
#### Path Parameters
- **opts** (*tuf.Options) - Required - Options to customize the TUF client behavior.

### Returns
- *SigningConfig: A pointer to the fetched SigningConfig object.
- error: An error if the configuration cannot be fetched.
```

--------------------------------

### Create New TrustedPublicKeyMaterial

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Initializes a new TrustedPublicKeyMaterial with a provided public key verifier function.

```go
func NewTrustedPublicKeyMaterial(publicKeyVerifier func(string) (TimeConstrainedVerifier, error)) *TrustedPublicKeyMaterial
```

--------------------------------

### Get TimestampingAuthorities from BaseTrustedMaterial

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Returns a slice of timestamping authorities managed by the base trusted material.

```go
func (b *BaseTrustedMaterial) TimestampingAuthorities() []TimestampingAuthority
```

--------------------------------

### oci-image-verification CLI Help

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/examples/sigstore-go-verification

Displays the help text for the oci-image-verification CLI, showing all available options for verifying signatures on OCI images.

```bash
./oci-image-verification -h
```

--------------------------------

### Get RekorLogs from BaseTrustedMaterial

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Returns a map of Rekor logs associated with the base trusted material.

```go
func (b *BaseTrustedMaterial) RekorLogs() map[string]*TransparencyLog
```

--------------------------------

### Options Methods

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

Methods for configuring Sigstore TUF client options.

```APIDOC
## func (*Options) WithCachePath

WithCachePath sets the location on disk for TUF cache.

### Parameters
- **path** (string) - The desired cache path.

### Returns
- *Options - The updated Options struct.
```

```APIDOC
## func (*Options) WithCacheValidity

WithCacheValidity sets the cache validity period in days.

### Parameters
- **days** (int) - The number of days the cache should be considered valid.

### Returns
- *Options - The updated Options struct.
```

```APIDOC
## func (*Options) WithDisableConsistentSnapshot

WithDisableConsistentSnapshot sets the client to disable consistent snapshot.

### Returns
- *Options - The updated Options struct.
```

```APIDOC
## func (*Options) WithDisableLocalCache

WithDisableLocalCache sets the client to work on a read-only file system.

### Returns
- *Options - The updated Options struct.
```

```APIDOC
## func (*Options) WithFetcher

WithFetcher sets the metadata fetcher.

### Parameters
- **f** (fetcher.Fetcher) - The fetcher implementation to use.

### Returns
- *Options - The updated Options struct.
```

```APIDOC
## func (*Options) WithForceCache

WithForceCache forces the client to use the cache without updating.

### Returns
- *Options - The updated Options struct.
```

```APIDOC
## func (*Options) WithRepositoryBaseURL

WithRepositoryBaseURL sets the TUF repository location URL.

### Parameters
- **url** (string) - The repository base URL.

### Returns
- *Options - The updated Options struct.
```

```APIDOC
## func (*Options) WithRoot

WithRoot sets the TUF trust anchor.

### Parameters
- **root** ([]byte) - The TUF trust anchor data.

### Returns
- *Options - The updated Options struct.
```

--------------------------------

### Get PublicKeyVerifier from BaseTrustedMaterial

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves a time-constrained public key verifier for a given key ID.

```go
func (b *BaseTrustedMaterial) PublicKeyVerifier(_ string) (TimeConstrainedVerifier, error)
```

--------------------------------

### Create LiveTrustedRoot

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Initializes a LiveTrustedRoot that periodically refreshes its trusted root from TUF.

```go
func NewLiveTrustedRoot(opts *tuf.Options) (*LiveTrustedRoot, error)
```

--------------------------------

### Get FulcioCertificateAuthorities from BaseTrustedMaterial

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Returns a slice of certificate authorities managed by the base trusted material.

```go
func (b *BaseTrustedMaterial) FulcioCertificateAuthorities() []CertificateAuthority
```

--------------------------------

### Create TrustedRoot from JSON

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Creates a Sigstore trusted root as a protobuf from a JSON byte slice.

```go
func NewTrustedRootProtobuf(rootJSON []byte) (*prototrustroot.TrustedRoot, error)
```

--------------------------------

### NewSigningConfigFromPath

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Creates a Sigstore signing configuration from a file path.

```APIDOC
## NewSigningConfigFromPath

### Description
Creates a Sigstore signing configuration from a file path.

### Method
NewSigningConfigFromPath(path string)

### Parameters
#### Path Parameters
- **path** (string) - Required - The file path to the signing configuration.

### Returns
- *SigningConfig: A pointer to the created SigningConfig object.
- error: An error if the file cannot be read or parsed.
```

--------------------------------

### ConstructUserAgent

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/util

Constructs a user agent string for Sigstore clients.

```APIDOC
## func ConstructUserAgent()

### Description
Constructs a user agent string that can be used by Sigstore clients.

### Signature
```go
func ConstructUserAgent() string
```

### Returns
A string representing the user agent.
```

--------------------------------

### EphemeralKeypair: Get Public Key PEM - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Returns the public key formatted as PEM.

```go
func (e *EphemeralKeypair) GetPublicKeyPem() (string, error)
```

--------------------------------

### NewRekor Client - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Initializes a new Rekor client with the provided options.

```go
func NewRekor(opts *RekorOptions) *Rekor
```

--------------------------------

### Get Default TUF Root Certificate

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

Retrieves the root.json for the public good TUF instance.

```go
func DefaultRoot() []byte
```

--------------------------------

### Create LiveTrustedRoot from Target

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Initializes a LiveTrustedRoot that refreshes from a specific TUF target.

```go
func NewLiveTrustedRootFromTarget(opts *tuf.Options, target string) (*LiveTrustedRoot, error)
```

--------------------------------

### Get Rekor Logs from TrustedRoot

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves a map of Rekor transparency logs from a TrustedRoot. Added in v0.3.0.

```go
func (tr *TrustedRoot) RekorLogs() map[string]*TransparencyLog
```

--------------------------------

### FetchSigningConfig

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Fetches the public-good Sigstore signing configuration from TUF.

```APIDOC
## FetchSigningConfig

### Description
Fetches the public-good Sigstore signing configuration from TUF.

### Method
FetchSigningConfig()

### Returns
- *SigningConfig: A pointer to the fetched SigningConfig object.
- error: An error if the configuration cannot be fetched.
```

--------------------------------

### Get Fulcio Certificate Authorities from TrustedRoot

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves the list of Fulcio certificate authorities configured in the TrustedRoot.

```go
func (tr *TrustedRoot) FulcioCertificateAuthorities() []CertificateAuthority
```

--------------------------------

### NewSigningConfigFromProtobuf

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Creates a Sigstore signing configuration from a protobuf SigningConfig object.

```APIDOC
## NewSigningConfigFromProtobuf

### Description
Creates a Sigstore signing configuration from a protobuf SigningConfig object.

### Method
NewSigningConfigFromProtobuf(sc *prototrustroot.SigningConfig)

### Parameters
#### Path Parameters
- **sc** (*prototrustroot.SigningConfig) - Required - The protobuf SigningConfig object.

### Returns
- *SigningConfig: A pointer to the created SigningConfig object.
- error: An error if the protobuf object is invalid.
```

--------------------------------

### Get CT Logs from TrustedRoot

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves a map of Certificate Transparency logs from a TrustedRoot. Added in v0.3.0.

```go
func (tr *TrustedRoot) CTLogs() map[string]*TransparencyLog
```

--------------------------------

### Get PublicKeyVerifier from TrustedPublicKeyMaterial

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves a time-constrained public key verifier for a specific key ID from a TrustedPublicKeyMaterial.

```go
func (tr *TrustedPublicKeyMaterial) PublicKeyVerifier(keyID string) (TimeConstrainedVerifier, error)
```

--------------------------------

### CertificateProviderOptions Struct

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Options for the CertificateProvider. Use IDToken for authentication with providers like Fulcio.

```go
type CertificateProviderOptions struct {
	// Optional OIDC JWT to send to certificate provider; required for Fulcio
	IDToken string
}
```

--------------------------------

### GetSigningConfig

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Fetches the public-good Sigstore signing configuration target from TUF using a provided client.

```APIDOC
## GetSigningConfig

### Description
Fetches the public-good Sigstore signing configuration target from TUF using a provided client.

### Method
GetSigningConfig(c *tuf.Client)

### Parameters
#### Path Parameters
- **c** (*tuf.Client) - Required - The TUF client to use for fetching.

### Returns
- *SigningConfig: A pointer to the fetched SigningConfig object.
- error: An error if the configuration cannot be fetched.
```

--------------------------------

### Get Rekor Logs from TrustedMaterialCollection

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves a map of Rekor transparency logs from a TrustedMaterialCollection. Added in v0.3.0.

```go
func (tmc TrustedMaterialCollection) RekorLogs() map[string]*TransparencyLog
```

--------------------------------

### Bundle Function

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Creates a signed bundle from content and a keypair. Use this to generate a verifiable artifact containing the signature and associated metadata.

```go
func Bundle(content Content, keypair Keypair, opts BundleOptions) (*protobundle.Bundle, error)
```

--------------------------------

### EphemeralKeypair: Get Hash Algorithm - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Returns the hash algorithm used for computing the digest to be signed.

```go
func (e *EphemeralKeypair) GetHashAlgorithm() protocommon.HashAlgorithm
```

--------------------------------

### NewTlogEntry

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tlog

Creates a new `Entry` from a `v1.TransparencyLogEntry` protobuf object.

```APIDOC
## NewTlogEntry

### Description
Creates a new `Entry` from a `v1.TransparencyLogEntry` protobuf object.

### Function Signature
```go
func NewTlogEntry(tle *v1.TransparencyLogEntry) (*Entry, error)
```

### Parameters
* **tle** (*v1.TransparencyLogEntry) - The transparency log entry protobuf object.

### Returns
* (*Entry) - A pointer to the newly created `Entry`.
* (error) - An error if the creation fails.
```

--------------------------------

### Get Log Key ID

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tlog

Retrieves the log key ID associated with the transparency log entry.

```go
func (entry *Entry) LogKeyID() string
```

--------------------------------

### Create TrustedRoot from Protobuf

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Converts a protobuf TrustedRoot object into a Sigstore Go TrustedRoot object.

```go
func NewTrustedRootFromProtobuf(protobufTrustedRoot *prototrustroot.TrustedRoot) (trustedRoot *TrustedRoot, err error)
```

--------------------------------

### NewSigningConfigFromJSON

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Creates a Sigstore signing configuration from a JSON byte slice.

```APIDOC
## NewSigningConfigFromJSON

### Description
Creates a Sigstore signing configuration from a JSON byte slice.

### Method
NewSigningConfigFromJSON(rootJSON []byte)

### Parameters
#### Path Parameters
- **rootJSON** ([]byte) - Required - The JSON data representing the signing configuration.

### Returns
- *SigningConfig: A pointer to the created SigningConfig object.
- error: An error if the JSON is invalid or cannot be parsed.
```

--------------------------------

### PlainData: Bundle Method - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Bundles data into a protobundle.Bundle with signature, digest, and hash algorithm.

```go
func (pd *PlainData) Bundle(bundle *protobundle.Bundle, signature, digest []byte, hashAlgorithm protocommon.HashAlgorithm)
```

--------------------------------

### Get TrustedRoot using TUF Client

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Returns the trusted root using an existing TUF client. Added in v0.2.0.

```go
func GetTrustedRoot(c *tuf.Client) (*TrustedRoot, error)
```

--------------------------------

### PlainData PreAuthEncoding Method

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Returns the pre-authentication encoding of the plain data. This is the data that will be signed.

```go
func (pd *PlainData) PreAuthEncoding() []byte
```

--------------------------------

### EphemeralKeypair: Get Key Algorithm - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Returns the top-level key algorithm, used in requests to Fulcio. Prefer PublicKeyDetails for more precision.

```go
func (e *EphemeralKeypair) GetKeyAlgorithm() string
```

--------------------------------

### NewSigningConfig

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Initializes a SigningConfig object from various Sigstore service components.

```APIDOC
## NewSigningConfig

### Description
Initializes a SigningConfig object from a mediaType string, Fulcio certificate authority URLs, OIDC provider URLs, Rekor transparency log URLs, timestamp authorities URLs, and selection criteria for Rekor logs and TSAs.

### Method
NewSigningConfig(mediaType string, fulcioCertificateAuthorities []Service, oidcProviders []Service, rekorLogs []Service, rekorLogsConfig ServiceConfiguration, timestampAuthorities []Service, timestampAuthoritiesConfig ServiceConfiguration)

### Parameters
#### Path Parameters
- **mediaType** (string) - Required - The media type of the configuration.
- **fulcioCertificateAuthorities** ([]Service) - Required - A slice of Fulcio Service objects.
- **oidcProviders** ([]Service) - Required - A slice of OIDC Provider Service objects.
- **rekorLogs** ([]Service) - Required - A slice of Rekor Service objects.
- **rekorLogsConfig** (ServiceConfiguration) - Required - Configuration for selecting Rekor logs.
- **timestampAuthorities** ([]Service) - Required - A slice of Timestamping Authority Service objects.
- **timestampAuthoritiesConfig** (ServiceConfiguration) - Required - Configuration for selecting Timestamping Authorities.

### Returns
- *SigningConfig: A pointer to the newly created SigningConfig object.
- error: An error if the configuration cannot be initialized.
```

--------------------------------

### Define TUF Client Options

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

Options represent the various configuration settings for a Sigstore TUF Client. Use this struct to customize client behavior.

```go
type Options struct {
	// CacheValidity period in days (default 0). The client will persist a
	// timestamp with the cache after refresh. Note that the client will
	// always refresh the cache if the metadata is expired or if the client is
	// unable to find a persisted timestamp, so this is not an optimal control
	// for air-gapped environments. Use const MaxCache to update the cache when
	// the metadata is expired, though the first initialization will still
	// refresh the cache.
	CacheValidity int
	// ForceCache controls if the cache should be used without update
	// as long as the metadata is valid. Use ForceCache over CacheValidity
	// if you want to always use the cache up until its expiration. Note that
	// the client will refresh the cache once the metadata has expired, so this
	// is not an optimal control for air-gapped environments. Clients instead
	// should provide a trust root file directly to the client to bypass TUF.
	ForceCache bool
	// Root is the TUF trust anchor
	Root []byte
	// CachePath is the location on disk for TUF cache
	// (default $HOME/.sigstore/tuf)
	CachePath string
	// RepositoryBaseURL is the TUF repository location URL
	// (default https://tuf-repo-cdn.sigstore.dev)
	RepositoryBaseURL string
	// DisableLocalCache mode allows a client to work on a read-only
	// files system if this is set, cache path is ignored.
	DisableLocalCache bool
	// DisableConsistentSnapshot
	DisableConsistentSnapshot bool
	// Fetcher is the metadata fetcher
	Fetcher fetcher.Fetcher
}
```

--------------------------------

### Fetch TrustedRoot with Options

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Fetches the Sigstore trusted root from TUF using specified options. Added in v0.2.0.

```go
func FetchTrustedRootWithOptions(opts *tuf.Options) (*TrustedRoot, error)
```

--------------------------------

### Get PublicKeyVerifier from TrustedMaterialCollection

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves a time-constrained public key verifier for a given key ID from a TrustedMaterialCollection. Returns an error if the verifier cannot be found.

```go
func (tmc TrustedMaterialCollection) PublicKeyVerifier(keyID string) (TimeConstrainedVerifier, error)
```

--------------------------------

### FetchTrustedRoot

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Fetches the trusted root information from the default source. This function is a convenient way to get the necessary trust material for verifying signatures.

```APIDOC
## func FetchTrustedRoot() (*TrustedRoot, error)

### Description
Fetches the trusted root information from the default source.

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **TrustedRoot** (*TrustedRoot) - A pointer to the fetched TrustedRoot object.
- **error** (error) - An error if fetching fails.

#### Response Example
None
```

--------------------------------

### Create New Transparency Log Entry

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tlog

Creates a new transparency log entry from a v1.TransparencyLogEntry proto.

```go
func NewTlogEntry(tle *v1.TransparencyLogEntry) (*Entry, error)
```

--------------------------------

### Options Struct

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

Options represent the various settings for a Sigstore TUF Client.

```APIDOC
## type Options

Options represent the various options for a Sigstore TUF Client.

### Fields
- **CacheValidity** (int) - The period in days for which the cache is considered valid. Defaults to 0.
- **ForceCache** (bool) - Controls if the cache should be used without an update as long as the metadata is valid.
- **Root** ([]byte) - The TUF trust anchor.
- **CachePath** (string) - The location on disk for the TUF cache. Defaults to $HOME/.sigstore/tuf.
- **RepositoryBaseURL** (string) - The TUF repository location URL. Defaults to https://tuf-repo-cdn.sigstore.dev.
- **DisableLocalCache** (bool) - Allows a client to work on a read-only file system; the cache path is ignored if set.
- **DisableConsistentSnapshot** (bool) - Disables the consistent snapshot feature.
- **Fetcher** (fetcher.Fetcher) - The metadata fetcher implementation.
```

--------------------------------

### NewTimestampAuthority Client - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Initializes a new Timestamp Authority client with the provided options.

```go
func NewTimestampAuthority(opts *TimestampAuthorityOptions) *TimestampAuthority
```

--------------------------------

### BaseSignedEntity VerificationContent Method

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/verify

Implements the VerificationContent method for BaseSignedEntity.

```go
func (b *BaseSignedEntity) VerificationContent() (VerificationContent, error)
```

--------------------------------

### Convert Service to Protobuf

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Converts a Service object to its protobuf representation.

```go
func (s Service) ToServiceProtobuf() *prototrustroot.Service
```

--------------------------------

### NewPolicy Constructor

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/verify

Initializes a new PolicyBuilder with artifact policy options and other policy options.

```go
func NewPolicy(artifactOpt ArtifactPolicyOption, options ...PolicyOption) PolicyBuilder
```

--------------------------------

### Create LiveTrustedRoot from Target with Period

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Initializes a LiveTrustedRoot that refreshes from a specific TUF target with a defined refresh period.

```go
func NewLiveTrustedRootFromTargetWithPeriod(opts *tuf.Options, target string, rfPeriod time.Duration) (*LiveTrustedRoot, error)
```

--------------------------------

### MediaTypeString Function

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/bundle

Returns a media type string for a given bundle version. Validates the resulting string.

```go
func MediaTypeString(version string) (string, error)
```

--------------------------------

### Create New TrustedRoot

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Initializes a TrustedRoot object from various components including media type, certificate authorities, transparency logs, and timestamp authorities. Added in v0.6.1.

```go
func NewTrustedRoot(mediaType string,
	certificateAuthorities []CertificateAuthority,
	certificateTransparencyLogs map[string]*TransparencyLog,
	timestampAuthorities []TimestampingAuthority,
	transparencyLogs map[string]*TransparencyLog) (*TrustedRoot, error)
```

--------------------------------

### Options

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

Options for configuring the TUF client.

```APIDOC
## Options

### Description
Options for configuring the TUF client.

### Methods
#### DefaultOptions()

##### Description
Returns default options for the TUF client.

##### Signature
```go
func DefaultOptions() *Options
```

#### WithCachePath(path string)

##### Description
Sets the cache path for the TUF client.

##### Signature
```go
func (o *Options) WithCachePath(path string) *Options
```

#### WithCacheValidity(days int)

##### Description
Sets the cache validity in days for the TUF client.

##### Signature
```go
func (o *Options) WithCacheValidity(days int) *Options
```

#### WithDisableConsistentSnapshot()

##### Description
Disables consistent snapshot for the TUF client.

##### Signature
```go
func (o *Options) WithDisableConsistentSnapshot() *Options
```

#### WithDisableLocalCache()

##### Description
Disables the local cache for the TUF client.

##### Signature
```go
func (o *Options) WithDisableLocalCache() *Options
```

#### WithFetcher(f fetcher.Fetcher)

##### Description
Sets a custom fetcher for the TUF client.

##### Signature
```go
func (o *Options) WithFetcher(f fetcher.Fetcher) *Options
```

#### WithForceCache()

##### Description
Forces the use of the cache for the TUF client.

##### Signature
```go
func (o *Options) WithForceCache() *Options
```

#### WithRepositoryBaseURL(url string)

##### Description
Sets the repository base URL for the TUF client.

##### Signature
```go
func (o *Options) WithRepositoryBaseURL(url string) *Options
```

#### WithRoot(root []byte)

##### Description
Sets the root certificate for the TUF client.

##### Signature
```go
func (o *Options) WithRoot(root []byte) *Options
```
```

--------------------------------

### Convert ServiceConfiguration to Protobuf

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Converts a ServiceConfiguration object to its protobuf representation.

```go
func (sc ServiceConfiguration) ToConfigProtobuf() *prototrustroot.ServiceConfiguration
```

--------------------------------

### NewService

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Constructs a Service object from a protobuf Service definition.

```APIDOC
## NewService

### Description
Constructs a Service object from a protobuf Service definition.

### Method
NewService(s *prototrustroot.Service) Service

### Parameters
#### Path Parameters
- **s** (*prototrustroot.Service) - Required - The protobuf Service definition.

### Returns
- Service: The constructed Service object.
```

--------------------------------

### NewBundle Function

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/bundle

Creates a new Bundle from a protobuf bundle.

```go
func NewBundle(pbundle *protobundle.Bundle) (*Bundle, error)
```

--------------------------------

### Client

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

Client is a Sigstore TUF client.

```APIDOC
## Client

### Description
Client is a Sigstore TUF client.

### Methods
#### DefaultClient()

##### Description
DefaultClient returns a Sigstore TUF client for the public good instance.

##### Signature
```go
func DefaultClient() (*Client, error)
```

#### New(opts *Options)

##### Description
New returns a new client with custom options.

##### Signature
```go
func New(opts *Options) (*Client, error)
```

#### GetTarget(target string)

##### Description
GetTarget returns a target file from the TUF repository.

##### Signature
```go
func (c *Client) GetTarget(target string) ([]byte, error)
```

#### Refresh()

##### Description
Refresh forces a refresh of the underlying TUF client. As the tuf client updater does not support multiple refreshes during its life-time, this will replace the TUF client updater with a new one.

##### Signature
```go
func (c *Client) Refresh() error
```
```

--------------------------------

### Construct User Agent String

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/util

This function constructs a user agent string. It is typically used for identifying the client making requests to Sigstore services.

```go
func ConstructUserAgent() string
```

--------------------------------

### Create TrustedRoot from JSON

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Parses a byte slice containing JSON to create a Sigstore trusted root object.

```go
func NewTrustedRootFromJSON(rootJSON []byte) (*TrustedRoot, error)
```

--------------------------------

### RekorClient Interface - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Interface for creating log entries in Rekor.

```go
type RekorClient interface {
	CreateLogEntry(params *entries.CreateLogEntryParams, opts ...entries.ClientOption) (*entries.CreateLogEntryCreated, error)
}
```

--------------------------------

### Create TrustedPublicKeyMaterial from Mapping

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Creates a TrustedPublicKeyMaterial from a map where keys are key IDs and values are ExpiringKeys. This is useful for initializing with a predefined set of trusted keys.

```go
func NewTrustedPublicKeyMaterialFromMapping(trustedPublicKeys map[string]*ExpiringKey) *TrustedPublicKeyMaterial
```

--------------------------------

### Content Interface

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Interface for data that can be signed and bundled. Implement this to define how your data is encoded and included in a bundle.

```go
type Content interface {
	// Return the data to be signed
	PreAuthEncoding() []byte
	// Add something that satisfies protobundle.isBundle_Content to bundle
	Bundle(bundle *protobundle.Bundle, signature, digest []byte, hashAlgorithm protocommon.HashAlgorithm)
}
```

--------------------------------

### String

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Returns a string representation of the SigningConfig. This is useful for debugging and logging.

```APIDOC
## func (SigningConfig) String

### Description
Returns a string representation of the SigningConfig.

### Signature
```go
func (sc SigningConfig) String() string
```

### Returns
* `string` - A string representation of the SigningConfig.
```

--------------------------------

### BuildConfig Method for PolicyBuilder

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/verify

Builds and returns a PolicyConfig based on the PolicyBuilder's configuration.

```go
func (pc PolicyBuilder) BuildConfig() (*PolicyConfig, error)
```

--------------------------------

### ServiceConfiguration.ToConfigProtobuf

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Converts a ServiceConfiguration object into its protobuf representation.

```APIDOC
## ToConfigProtobuf

### Description
Converts a ServiceConfiguration object into its protobuf representation.

### Method
(sc ServiceConfiguration) ToConfigProtobuf()

### Returns
- *prototrustroot.ServiceConfiguration: The protobuf representation of the ServiceConfiguration object.
```

--------------------------------

### CertificateProvider Interface

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Interface for obtaining a code signing certificate. Implement this to integrate custom certificate providers.

```go
type CertificateProvider interface {
	GetCertificate(context.Context, Keypair, *CertificateProviderOptions) ([]byte, error)
}
```

--------------------------------

### Define SigningConfigMediaType Constant

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Defines the media type for Sigstore signing configurations in version 0.2.

```go
const SigningConfigMediaType02 = "application/vnd.dev.sigstore.signingconfig.v0.2+json"
```

--------------------------------

### Bundle

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/testing/data

Bundle reads a file from the embedded file system and returns a *bundle.Bundle.

```APIDOC
## Bundle

### Description
Bundle reads a file from the embedded file system and returns a *bundle.Bundle.

### Signature
```go
func Bundle(t *testing.T, filename string) (b *bundle.Bundle)
```

### Parameters
#### Path Parameters
- **t** (*testing.T) - Description not available.
- **filename** (string) - The name of the file to read.

### Returns
- **b** (*bundle.Bundle) - The parsed bundle object.
```

--------------------------------

### NewBundle

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/bundle

Creates a new Bundle from a protobuf bundle.

```APIDOC
## NewBundle

### Description
Creates a new Bundle from a protobuf bundle.

### Signature
```go
func NewBundle(pbundle *protobundle.Bundle) (*Bundle, error)
```

### Parameters
#### Path Parameters
- **pbundle** (*protobundle.Bundle) - Required - The protobuf bundle to convert.
```

--------------------------------

### NewShortCertificateIdentity Constructor

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/verify

Provides a convenient way to initialize a CertificateIdentity with a SAN and Issuer OID extension. Use NewCertificateIdentity for more complex extension matching.

```go
func NewShortCertificateIdentity(issuer, issuerRegex, sanValue, sanRegex string) (CertificateIdentity, error)
```

--------------------------------

### Select Multiple Services

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Selects multiple service endpoints based on supported API versions, current time, and a ServiceConfiguration. The configuration determines the selection strategy (ALL, ANY, EXACT) and the number of services to return. It selects services from the highest supported API versions, ensuring distinct operators and at most one service per operator.

```go
func SelectServices(services []Service, config ServiceConfiguration, supportedAPIVersions []uint32, currentTime time.Time) ([]Service, error)
```

--------------------------------

### NewVerifier

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/verify

Creates a new Verifier instance with the provided trusted material and options. This is the primary way to initialize a Verifier for verifying signed artifacts.

```APIDOC
## NewVerifier

### Description
Initializes a new Verifier with the given trusted material and optional configuration.

### Function Signature
func NewVerifier(trustedMaterial root.TrustedMaterial, options ...VerifierOption) (*Verifier, error)

### Parameters
- **trustedMaterial** (root.TrustedMaterial) - The trusted root material to use for verification.
- **options** (...VerifierOption) - Optional configuration options for the Verifier.

### Returns
- **(*Verifier, error)** - A pointer to the Verifier instance and an error if initialization fails.
```

--------------------------------

### Bundle Type

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/bundle

Represents a signed data bundle, embedding a protobuf bundle.

```go
type Bundle struct {
	*protobundle.Bundle
	// contains filtered or unexported fields
}
```

--------------------------------

### FulcioOptions Struct - Go

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/sign

Configuration options for the Fulcio client, including base URL, timeout, retries, and transport.

```go
type FulcioOptions struct {
	// URL of Fulcio instance
	BaseURL string
	// Optional timeout for network requests (default 30s; use negative value for no timeout)
	Timeout time.Duration
	// Optional number of times to retry on HTTP 5XX
	Retries uint
	// Optional Transport (for dependency injection)
	Transport http.RoundTripper
}
```

--------------------------------

### Verify SET with Multiple Verifiers

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tlog

Verifies a Signed Entry Timestamp (SET) using a map of transparency log verifiers.

```go
func VerifySET(entry *Entry, verifiers map[string]*root.TransparencyLog) error
```

--------------------------------

### NewCertificate

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/bundle

Creates a new Certificate wrapper.

```APIDOC
## NewCertificate

### Description
Creates a new Certificate wrapper.

### Signature
```go
func NewCertificate(cert *x509.Certificate) *Certificate
```

### Parameters
#### Path Parameters
- **cert** (*x509.Certificate) - Required - The x509 certificate to wrap.
```

--------------------------------

### Define TrustedRootMediaType Constant

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Defines the media type for Sigstore trusted roots in version 0.1.

```go
const TrustedRootMediaType01 = "application/vnd.dev.sigstore.trustedroot+json;version=0.1"
```

--------------------------------

### BaseSignedEntity Version Method

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/verify

Implements the Version method for BaseSignedEntity.

```go
func (b *BaseSignedEntity) Version() (string, error)
```

--------------------------------

### Summary Structure

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/fulcio/certificate

The `Summary` struct aggregates key information from a certificate, including the certificate issuer, subject alternative name, and all custom Fulcio extensions.

```APIDOC
## type Summary

```go
type Summary struct {
	CertificateIssuer      string `json:"certificateIssuer"`
	SubjectAlternativeName string `json:"subjectAlternativeName"`
	Extensions
}
```
```

--------------------------------

### Create New Entry (Deprecated)

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tlog

Deprecated: Use NewTlogEntry. This function only parses a Rekor v1 entry.

```go
func NewEntry(body []byte, integratedTime int64, logIndex int64, logID []byte, signedEntryTimestamp []byte, inclusionProof *models.InclusionProof) (*Entry, error)
```

--------------------------------

### Load TUF Configuration

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

Loads the TUF client configuration from a specified file path. This is useful for persisting and resuming client state.

```go
func LoadConfig(p string) (*Config, error)
```

--------------------------------

### Convert URL to Path

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tuf

Converts a given URL into a string compatible with filenames.

```go
func URLToPath(url string) string
```

--------------------------------

### Check for Inclusion Proof

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/tlog

Determines if the entry has an inclusion proof.

```go
func (entry *Entry) HasInclusionProof() bool
```

--------------------------------

### LiveTrustedRoot.RekorLogs

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Retrieves the configured Rekor logs from the live trusted root.

```APIDOC
## RekorLogs

### Description
Retrieves the configured Rekor logs.

### Method
LiveTrustedRoot.RekorLogs()

### Returns
- map[string]*TransparencyLog: A map where keys are log identifiers and values are TransparencyLog objects.
```

--------------------------------

### ServiceConfiguration Struct Definition

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Defines the configuration for selecting services, including the selector type and count.

```go
type ServiceConfiguration struct {
	Selector prototrustroot.ServiceSelector
	Count    uint32
}
```

--------------------------------

### WithOIDCProviderURLs

Source: https://pkg.go.dev/github.com/sigstore/sigstore-go/pkg/root

Sets the OIDC provider URLs for the SigningConfig. This is a fluent setter method.

```APIDOC
## func (*SigningConfig) WithOIDCProviderURLs

### Description
Sets the OIDC provider URLs for the SigningConfig.

### Signature
```go
func (sc *SigningConfig) WithOIDCProviderURLs(oidcURLs ...Service) *SigningConfig
```

### Parameters
* `oidcURLs` (...Service) - A variadic list of Service objects representing OIDC provider URLs.

### Returns
* `*SigningConfig` - The modified SigningConfig object.
```
Tokens:
Raw