oci

Documentation

Index

• type Anonymous
  • func (a Anonymous) Resolve(_ authn.Resource) (authn.Authenticator, error)
• type CosignVerifier
  • func NewCosignVerifier(ctx context.Context, opts ...Options) (*CosignVerifier, error)
  • func (v *CosignVerifier) Verify(ctx context.Context, ref name.Reference) (bool, error)
  • func (v *CosignVerifier) VerifyImageSignatures(ctx context.Context, ref name.Reference) ([]oci.Signature, bool, error)
• type Options
  • func WithPublicKey(publicKey []byte) Options
  • func WithRemoteOptions(opts ...remote.Option) Options
• type Verifier

Types

type Anonymous

type Anonymous authn.AuthConfig

Anonymous is an authn.AuthConfig that always returns an anonymous authenticator. It is useful for registries that do not require authentication or when the credentials are not known. It implements authn.Keychain `Resolve` method and can be used as a keychain.

func (Anonymous) Resolve

func (a Anonymous) Resolve(_ authn.Resource) (authn.Authenticator, error)

Resolve implements authn.Keychain.

type CosignVerifier

type CosignVerifier struct {
	// contains filtered or unexported fields
}

CosignVerifier is a struct which is responsible for executing verification logic.

func NewCosignVerifier

func NewCosignVerifier(ctx context.Context, opts ...Options) (*CosignVerifier, error)

NewCosignVerifier initializes a new CosignVerifier.

func (*CosignVerifier) Verify

func (v *CosignVerifier) Verify(ctx context.Context, ref name.Reference) (bool, error)

Verify verifies the authenticity of the given ref OCI image. It returns a boolean indicating if the verification was successful. It returns an error if the verification fails, nil otherwise.

func (*CosignVerifier) VerifyImageSignatures

func (v *CosignVerifier) VerifyImageSignatures(ctx context.Context, ref name.Reference) ([]oci.Signature, bool, error)

VerifyImageSignatures verify the authenticity of the given ref OCI image.

type Options

type Options func(opts *options)

Options is a function that configures the options applied to a Verifier.

func WithPublicKey

func WithPublicKey(publicKey []byte) Options

WithPublicKey sets the public key.

func WithRemoteOptions

func WithRemoteOptions(opts ...remote.Option) Options

WithRemoteOptions is a functional option for overriding the default remote options used by the verifier.

type Verifier

type Verifier interface {
	Verify(ctx context.Context, ref name.Reference) (bool, error)
}

Verifier is an interface for verifying the authenticity of an OCI image.