protect

package

Go to main page

Versions in this module

v1

v1.138.1

Sep 11, 2026

Changes in this version

+ const AnnotationAttestation

+ const AnnotationPredicateType

+ const EnvelopeMediaType

+ const PayloadType

+ const PredicateTypePublication

+ const StatementType

+ var ErrMalformedAttestation = errors.New("malformed attestation annotation")

+ var ErrStatementMismatch = errors.New("attestation does not describe this artifact")

+ var ErrSubjectMismatch = errors.New("attested subject does not match the reference being read")

+ var ErrUnknownStatementType = errors.New("unsupported in-toto statement type")

+ func SubjectDigest(data []byte) map[string]string

+ type Envelope struct

+ Payload string

+ PayloadType string

+ Signatures []Signature

+ func ParseEnvelope(raw []byte) (Envelope, error)

type Key

+ func (k *Key) SignStatement(stmt Statement) (Envelope, error)

+ func (k *Key) VerifyEnvelope(env Envelope) ([]byte, error)

+ type Predicate struct

+ Created string

+ Registry string

+ Repository string

+ Tag string

+ Unknown map[string]string

+ type Signature struct

+ KeyID string

+ Sig string

+ type Statement struct

+ Predicate Predicate

+ PredicateRaw json.RawMessage

+ PredicateType string

+ PredicateUnderstood bool

+ Subject []Subject

+ Type string

+ func NewStatement(ref string, data []byte, created time.Time) (Statement, error)

+ func ParseStatement(raw []byte) (Statement, error)

+ func (s Statement) Digest() string

+ func (s Statement) Marshal() ([]byte, error)

+ func (s Statement) String() string

+ func (s Statement) SubjectName() string

+ type Subject struct

+ Digest map[string]string

+ Name string

type Verification

+ Statement Statement

+ func (v Verification) CheckSubject(ref string) error

+ func (v Verification) SignatureAlgorithmSummary() string

v1.138.0

Sep 10, 2026

v1.137.0

Sep 9, 2026

v1.136.0

Sep 8, 2026

v1.135.0

Sep 8, 2026

v1.134.0

Sep 7, 2026

v1.133.0

Sep 4, 2026

Changes in this version

+ const FilePrefix

type Key

+ func ResolveKey(value string) (*Key, error)

v1.132.0

Sep 4, 2026

Changes in this version

+ const AlgAESGCM

+ const AlgECDSASHA256

+ const AlgEd25519

+ const AlgHMACSHA256

+ const AlgRSAOAEP

+ const AlgRSAPSSSHA256

+ const AnnotationEncrypted

+ const AnnotationEncryptedAlgorithm

+ const AnnotationSignature

+ const AnnotationSignatureAlgorithm

+ const MinRSABits

+ const MinSecretLen

+ var ErrAlgorithmMism = errors.New("algorithm mismatch")

+ var ErrCannotDecrypt = errors.New("key cannot decrypt: a private key or secret is required")

+ var ErrCannotEncrypt = errors.New("key cannot encrypt")

+ var ErrCannotSign = errors.New("key cannot sign: a private key or secret is required")

+ var ErrCannotVerify = errors.New("key cannot verify signatures")

+ var ErrDecryption = errors.New("decryption failed")

+ var ErrEncryptNeedsPriv = errors.New(...)

+ var ErrInvalidSignature = errors.New("signature verification failed")

+ var ErrNotEncrypted = errors.New("artifact has no encrypted copy")

+ var ErrNotProtected = errors.New("artifact is neither signed nor encrypted")

+ var ErrNotSigned = errors.New(...)

+ var ErrSecretTooShort = fmt.Errorf(...)

+ var ErrTampered = errors.New("encrypted copy does not match the artifact content")

+ func IsProtected(annotations map[string]string) bool

+ type Key struct

+ func LoadKey(path string) (*Key, error)

+ func ParseKey(data []byte) (*Key, error)

+ func (k *Key) CanDecrypt() bool

+ func (k *Key) CanEncrypt() bool

+ func (k *Key) CanSign() bool

+ func (k *Key) CanVerify() bool

+ func (k *Key) Decrypt(blob []byte) ([]byte, error)

+ func (k *Key) Describe() string

+ func (k *Key) Encrypt(data []byte) ([]byte, error)

+ func (k *Key) EncryptAlgorithm() string

+ func (k *Key) Fingerprint() string

+ func (k *Key) Identity() string

+ func (k *Key) Private() bool

+ func (k *Key) Protect(annotations map[string]string, data []byte, mode Mode) error

+ func (k *Key) Recover(annotations map[string]string) ([]byte, error)

+ func (k *Key) Sign(data []byte) ([]byte, error)

+ func (k *Key) SignAlgorithm() string

+ func (k *Key) Supports(mode Mode) error

+ func (k *Key) Symmetric() bool

+ func (k *Key) Verify(data, sig []byte) error

+ func (k *Key) VerifyAnnotations(annotations map[string]string, data []byte) (Verification, error)

+ type Mode string

+ const ModeEncrypt

+ const ModeSign

+ type Verification struct

+ EncryptedAlgorithm string

+ SignatureAlgorithm string

+ func (v Verification) String() string

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