base

Documentation

Index

• type Envelope
  • func (e *Envelope) Content() (*signature.EnvelopeContent, error)
  • func (e *Envelope) Sign(req *signature.SignRequest) ([]byte, error)
  • func (e *Envelope) Verify() (*signature.EnvelopeContent, error)

Types

type Envelope

type Envelope struct {
	signature.Envelope        // internal envelope in a specific format (e.g. COSE, JWS)
	Raw                []byte // raw signature
}

Envelope represents a general envelope wrapping a raw signature and envelope in specific format. Envelope manipulates the common validation shared by internal envelopes.

func (*Envelope) Content

func (e *Envelope) Content() (*signature.EnvelopeContent, error)

Content returns the validated signature information and payload.

func (*Envelope) Sign

func (e *Envelope) Sign(req *signature.SignRequest) ([]byte, error)

Sign generates signature in terms of given SignRequest.

Reference: https://github.com/notaryproject/notaryproject/blob/main/specs/signing-and-verification-workflow.md#signing-steps

func (*Envelope) Verify

func (e *Envelope) Verify() (*signature.EnvelopeContent, error)

Verify performs integrity and other signature specification related validations. It returns envelope content containing the payload to be signed and SignerInfo object containing the information about the signature.

Reference: https://github.com/notaryproject/notaryproject/blob/main/specs/trust-store-trust-policy.md#steps