git

Documentation

Index

• func Sign(ctx context.Context, ident *fulcio.Identity, data []byte, ...) ([]byte, *x509.Certificate, error)
• type Claim
  • func NewClaim(c ClaimCondition, ok bool) Claim
• type ClaimCondition
• type VerificationSummary
  • func Verify(ctx context.Context, data, sig []byte) (*VerificationSummary, error)

Functions

func Sign

func Sign(ctx context.Context, ident *fulcio.Identity, data []byte, opts signature.SignOptions) ([]byte, *x509.Certificate, error)

Types

type Claim

type Claim struct {
	Key   ClaimCondition
	Value bool
}

Claim is a k/v pair representing the status of a given ClaimCondition.

func NewClaim

func NewClaim(c ClaimCondition, ok bool) Claim

type ClaimCondition

type ClaimCondition string

const (
	ClaimParsedSignature     ClaimCondition = "Parsed Git signature"
	ClaimValidatedSignature  ClaimCondition = "Validated Git signature"
	ClaimLocatedRekorEntry   ClaimCondition = "Located Rekor entry"
	ClaimValidatedRekorEntry ClaimCondition = "Validated Rekor entry"
)

type VerificationSummary

type VerificationSummary struct {
	// Certificate used to sign the commit.
	Cert *x509.Certificate
	// Rekor log entry of the commit.
	LogEntry *models.LogEntryAnon
	// List of claims about what succeeded / failed during validation.
	// This can be used to get details on what succeeded / failed during
	// validation. This is not an exhaustive list - claims may be missing
	// if validation ended early.
	Claims []Claim
}

func Verify

func Verify(ctx context.Context, data, sig []byte) (*VerificationSummary, error)