config

Documentation

Index

• type Config
  • func Get() (*Config, error)
• type RekorVerificationMode

Types

type Config

type Config struct {
	// Address of Fulcio server
	Fulcio string
	// Path to PEM encoded certificate root for Fulcio.
	FulcioRoot string

	// Address of Rekor server
	Rekor string
	// Rekor storage mode to operate in. One of [online, offline] (default: online)
	// online - Commit SHAs are stored in Rekor, requiring online verification for all commit objects.
	// offline - Hashed commit content is stored in Rekor, with Rekor attributes
	// necessary for offline verification being stored in the commit itself.
	// Note: online verification will be deprecated in favor of offline in the future.
	RekorMode string

	// OIDC client ID for application
	ClientID string
	// OIDC Redirect URL
	RedirectURL string
	// OIDC provider to be used to issue ID token
	Issuer string
	// Optional Connector ID to use when fetching Dex OIDC token.
	// See https://github.com/sigstore/sigstore/blob/c645ceb9d075499f3a4b3f183d3a6864640fa956/pkg/oauthflow/flow.go#L49-L53
	// for more details.
	ConnectorID string
	// TokenProviders select a OIDC token provider to use to fetch tokens. If not set, all providers are attempted.
	// See https://github.com/sigstore/cosign/tree/main/pkg/providers for more details.
	// Valid values are: [interactive, spiffe, google-workload-identity, google-impersonation, github-actions, filesystem, buildkite-agent]
	TokenProvider string

	// Timestamp Authority address to use to get a trusted timestamp
	TimestampURL string
	// Timestamp Authority PEM encoded cert(s) to use for verification.
	TimestampCert string

	// Path to log status output. Helpful for debugging when no TTY is available in the environment.
	LogPath string

	// Committer details
	CommitterName  string
	CommitterEmail string
	MatchCommitter bool

	// Autoclose specifies whether to close window after successful authentication
	Autoclose bool
	// AutocloseTimeout specifies the time to wait before closing the window
	AutocloseTimeout int
}

Config represents configuration options for gitsign.

func Get

func Get() (*Config, error)

Get fetches the gitsign config options for the repo in the current working directory.

type RekorVerificationMode

type RekorVerificationMode int

const (
	RekorVerificationOnline RekorVerificationMode = iota
	RekorVerificationOffline
)