dsse

package

v0.4.5 Latest Latest Go to latest Published: Apr 17, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/carabiner-dev/signer

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type DefaultSigner ¶

type DefaultSigner struct{}

func (*DefaultSigner) PaeEncode ¶

func (ds *DefaultSigner) PaeEncode(env *sdsse.Envelope) ([]byte, error)

PaeEncode implements the signing sequence according to the DSSE protocol

func (*DefaultSigner) Sign ¶

func (ds *DefaultSigner) Sign(env *sdsse.Envelope, keys []key.PrivateKeyProvider) error

Sign encodes the payload of a DSSE envelope and signs it. If the envelope already has signatures in it, the new signatures are appended to the exisiting ones.

func (*DefaultSigner) WrapPayload ¶

func (ds *DefaultSigner) WrapPayload(payloadType string, payload []byte) (*sdsse.Envelope, error)

WrapPayload wraps the contents in a DSSE envelope and sets the type

type DefaultVerifier ¶

type DefaultVerifier struct{}

func (*DefaultVerifier) BuildKeyVerifier ¶

func (dv *DefaultVerifier) BuildKeyVerifier(opts *options.Verifier) (*key.Verifier, error)

BuildKeyVerifier builds a key verifier used to check the DSSE signatures

func (*DefaultVerifier) OpenEnvelope ¶

func (dv *DefaultVerifier) OpenEnvelope(path string) (*sdsse.Envelope, error)

OpenEnvelope parses a DSSE envelope

func (*DefaultVerifier) RunVerification ¶

func (dv *DefaultVerifier) RunVerification(
	opts *options.Verifier, kv *key.Verifier, env *sdsse.Envelope, keys []key.PublicKeyProvider,
) (*key.VerificationResult, error)

RunVerification verifies the DSSE envelope

type Signer ¶

type Signer interface {
	WrapPayload(string, []byte) (*sdsse.Envelope, error)
	// PaeEncode(*sdsse.Envelope) ([]byte, error)
	Sign(*sdsse.Envelope, []key.PrivateKeyProvider) error
}

Signer signs content and wrapps them in DSSE

func NewSigner ¶ added in v0.3.1

func NewSigner() Signer

type SignerOptions ¶

type SignerOptions struct {
	Keys []key.PrivateKeyProvider
}

SignerOptions captures the options to sign

type Verifier ¶

type Verifier interface {
	RunVerification(*options.Verifier, *key.Verifier, *sdsse.Envelope, []key.PublicKeyProvider) (*key.VerificationResult, error)
	BuildKeyVerifier(*options.Verifier) (*key.Verifier, error)
	OpenEnvelope(string) (*sdsse.Envelope, error)
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
dssefakes Code generated by counterfeiter.	Code generated by counterfeiter.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL