sdk

package

Go to main page

Versions in this module

v0

v0.1.0

Dec 1, 2025

Changes in this version

+ var ErrAuditFoundIssues = errors.New("audit found issues")

+ var ErrAuditSourceRequired = errors.New("audit requires either dockerfile or image")

+ var ErrBuildContextRequired = errors.New("build context is required")

+ var ErrBuildNodeEndpointRequired = errors.New("buildnode endpoint is required")

+ var ErrBuildNodePlatformRequired = errors.New("buildnode platform is required")

+ var ErrBuildNodeRequired = errors.New("at least one build node is required")

+ var ErrBuildTagRequired = errors.New("build tag is required")

+ var ErrDigestMismatch = errors.New("DIGEST MISMATCH (possible tag mutation or supply chain attack)")

+ var ErrEnvVarNotSet = errors.New("required environment variable not set")

+ var ErrFieldNotFound = secrets.ErrFieldNotFound

+ var ErrFieldsEmpty = secrets.ErrFieldsEmpty

+ var ErrImageDigestRequired = errors.New("cannot create digest reference without digest")

+ var ErrImageNameRequired = errors.New("image name is required")

+ var ErrImageNotSigned = errors.New("image is not signed")

+ var ErrImageVersionRequired = errors.New("cannot create tag reference without version")

+ var ErrInvalidAuditRuleSet = errors.New("invalid audit rule set")

+ var ErrInvalidImageDigest = errors.New("invalid image digest format")

+ var ErrInvalidScanAction = errors.New("invalid scan action")

+ var ErrInvalidScanFormat = errors.New("invalid scan format")

+ var ErrInvalidScanSeverity = errors.New("invalid scan severity")

+ var ErrMustSpecifyTagOrDigest = errors.New("must specify at least tag or digest")

+ var ErrNoBuildNodesConfigured = errors.New("no build nodes configured")

+ var ErrNoTrustPolicy = errors.New("no trust policy configured: add TrustSigner to plan or SignedBy to image")

+ var ErrReferenceEmpty = secrets.ErrReferenceEmpty

+ var ErrReferenceEmptyParts = secrets.ErrReferenceEmptyParts

+ var ErrReferenceInvalidFormat = secrets.ErrReferenceInvalidFormat

+ var ErrScanImageRequired = errors.New("scan image is required")

+ var ErrScanMustHaveDigest = errors.New("scan image MUST have digest specified (scanning by tag alone is not allowed)")

+ var ErrSignatureDigestMismatch = errors.New("signature digest mismatch")

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

+ var ErrSignerNotTrusted = errors.New("signer not trusted")

+ var ErrSyncDestinationRequired = errors.New("sync destination image is required")

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

+ var ErrSyncSourceRequired = errors.New("sync source image is required")

+ var ErrTagDrift = errors.New("tag drift detected")

+ var ErrVersionCheckImageRequired = errors.New("version check image is required")

+ var ErrVersionCheckLatestNotSupported = errors.New("version check not supported for 'latest' tag")

+ var ErrVersionCheckVersionRequired = errors.New("version check image must have version specified")

+ var ErrVulnerabilitiesFound = errors.New("vulnerabilities found at or above threshold")

+ type AuditArgs struct

+ Description string

+ Dockerfile string

+ IgnoreChecks []string

+ RuleSet AuditRuleSet

+ Source *Image

+ Timeout time.Duration

type AuditRuleSet

+ func (r *AuditRuleSet) MarshalJSON() ([]byte, error)

+ func (r *AuditRuleSet) String() string

+ func (r *AuditRuleSet) UnmarshalJSON(data []byte) error

+ type BuildArgs struct

+ Context string

+ Dockerfile string

+ Name string

+ Nodes []*BuildNode

+ Tag string

+ Timeout time.Duration

type BuildNode

+ func NewBuildNode(args *BuildNodeOpts) (*BuildNode, error)

+ type BuildNodeOpts struct

+ Endpoint string

+ Name string

+ Platform Platform

+ type Handle struct

+ func (h *Handle) After(deps ...*Handle) *Handle

+ func (h *Handle) Audit(args *AuditArgs) (*Handle, error)

+ func (h *Handle) Build(args *BuildArgs) (*Handle, error)

+ func (h *Handle) CheckVersion(name string, source *Image, force bool) (*Handle, error)

+ func (h *Handle) Scan(args *ScanArgs) (*Handle, error)

+ func (h *Handle) Sync(args *SyncArgs) (*Handle, error)

+ func (h *Handle) VersionCheckResult() *VersionCheckResult

type Image

+ func (img *Image) Path() string

+ func (img *Image) SetDigest(digestStr string) error

+ func (img *Image) SetVersion(version string)

+ func (img *Image) String() string

+ type ImageOpts struct

+ Digest string

+ Domain string

+ InsecureNoSignature bool

+ Name string

+ SignedBy []SignerIdentity

+ Version string

type Plan

+ func (plan *Plan) AddBuildNode(node *BuildNode)

+ func (plan *Plan) AddRegistry(reg *Registry)

+ func (plan *Plan) CheckVersion(name string, source *Image, force bool) (*Handle, error)

+ func (plan *Plan) GetDigest(ctx context.Context, image *Image) (string, error)

+ func (plan *Plan) ListTags(ctx context.Context, image *Image) ([]string, error)

+ func (plan *Plan) TrustSigner(signer SignerIdentity)

type Registry

+ func NewRegistry(args *RegistryOpts) *Registry

+ func (r *Registry) Domain() string

+ func (r *Registry) Token() string

+ type RegistryOpts struct

+ Domain string

+ Token string

+ Username string

type ScanAction

+ func (a *ScanAction) MarshalJSON() ([]byte, error)

+ func (a *ScanAction) String() string

+ func (a *ScanAction) UnmarshalJSON(data []byte) error

+ type ScanArgs struct

+ Description string

+ Format ScanFormat

+ SeverityChecks []ScanSeverityCheck

+ Source *Image

+ Timeout time.Duration

type ScanFormat

+ func (f *ScanFormat) MarshalJSON() ([]byte, error)

+ func (f *ScanFormat) String() string

+ func (f *ScanFormat) UnmarshalJSON(data []byte) error

type ScanSeverity

+ func (s *ScanSeverity) MarshalJSON() ([]byte, error)

+ func (s *ScanSeverity) String() string

+ func (s *ScanSeverity) UnmarshalJSON(data []byte) error

type ScanSeverityCheck

+ Action ScanAction

+ Threshold ScanSeverity

+ type SignerIdentity struct

+ Issuer string

+ Subject string

+ func (s SignerIdentity) Matches(actualSubject, actualIssuer string) bool

+ type SyncArgs struct

+ Description string

+ Destination *Image

+ Platforms []Platform

+ Source *Image

+ type VersionCheckResult struct

+ CurrentVersion string

+ LatestDigest string

+ LatestVersion string

+ UpdateAvailable bool

v0.0.1

Oct 28, 2025

Changes in this version

+ var ErrDocumentEmpty = errors.New("document resolved to empty content")

+ var ErrDocumentReferenceEmpty = errors.New("document reference cannot be empty")

+ var ErrDocumentReferenceEmptyParts = errors.New("document reference vault and item cannot be empty")

+ var ErrDocumentReferenceInvalidFormat = errors.New("invalid document reference format")

+ var ErrDocumentReferenceInvalidPrefix = errors.New("document reference must start with 'op://'")

+ var ErrItemFieldNotFound = errors.New("field not found in item")

+ var ErrItemFieldsEmpty = errors.New("fields list cannot be empty")

+ var ErrItemReferenceEmpty = errors.New("item reference cannot be empty")

+ var ErrItemReferenceEmptyParts = errors.New("item reference vault and item cannot be empty")

+ var ErrItemReferenceInvalidFormat = errors.New("invalid item reference format")

+ var ErrItemReferenceInvalidPrefix = errors.New("item reference must start with 'op://'")

+ func AuthenticateOp(ctx context.Context) error

+ func ConfigureDefaultLogger(ctx context.Context, level ...zerolog.Level)

+ func GetEnv(key string) string

+ func GetEnvDefault(key, defaultValue string) string

+ func GetSecret(ctx context.Context, itemRef string, fields []string) (map[string]string, error)

+ func GetSecretDocument(ctx context.Context, reference string) ([]byte, error)

+ func LoadEnv(path string) error

+ type Audit struct

+ type AuditBuilder struct

+ func (builder *AuditBuilder) Build() *Audit

+ func (builder *AuditBuilder) Dockerfile(dockerfile string) *AuditBuilder

+ func (builder *AuditBuilder) IgnoreChecks(checks ...string) *AuditBuilder

+ func (builder *AuditBuilder) RuleSet(ruleSet AuditRuleSet) *AuditBuilder

+ func (builder *AuditBuilder) Source(image *Image) *AuditBuilder

+ type AuditRuleSet string

+ const RuleSetMinimal

+ const RuleSetRecommended

+ const RuleSetStrict

+ type Build struct

+ type BuildBuilder struct

+ func (builder *BuildBuilder) Build() *Build

+ func (builder *BuildBuilder) Context(buildContext string) *BuildBuilder

+ func (builder *BuildBuilder) Dockerfile(dockerfile string) *BuildBuilder

+ func (builder *BuildBuilder) Node(node *BuildNode) *BuildBuilder

+ func (builder *BuildBuilder) Registry(registry *Registry) *BuildBuilder

+ func (builder *BuildBuilder) Tag(tag string) *BuildBuilder

+ type BuildNode struct

+ func (node *BuildNode) Endpoint() string

+ func (node *BuildNode) Name() string

+ func (node *BuildNode) Platform() Platform

+ type BuildNodeBuilder struct

+ func (builder *BuildNodeBuilder) Build() *BuildNode

+ func (builder *BuildNodeBuilder) Endpoint(endpoint string) *BuildNodeBuilder

+ func (builder *BuildNodeBuilder) Platform(platform Platform) *BuildNodeBuilder

+ type Image struct

+ func (img *Image) Digest() string

+ func (img *Image) Domain() string

+ func (img *Image) Name() string

+ func (img *Image) Version() string

+ type ImageBuilder struct

+ func NewImage(name string) *ImageBuilder

+ func (builder *ImageBuilder) Build() *Image

+ func (builder *ImageBuilder) Digest(digest string) *ImageBuilder

+ func (builder *ImageBuilder) Domain(domain string) *ImageBuilder

+ func (builder *ImageBuilder) Version(version string) *ImageBuilder

+ type Plan struct

+ func NewPlan(name string) *Plan

+ func (plan *Plan) Audit(name string) *AuditBuilder

+ func (plan *Plan) Build(name string) *BuildBuilder

+ func (plan *Plan) BuildNode(name string) *BuildNodeBuilder

+ func (plan *Plan) DryRun() error

+ func (plan *Plan) Execute(ctx context.Context) error

+ func (plan *Plan) Registry(host string) *RegistryBuilder

+ func (plan *Plan) Scan(name string) *ScanBuilder

+ func (plan *Plan) Sync(name string) *SyncBuilder

+ func (plan *Plan) VersionCheck(name string) *VersionCheckBuilder

+ type Platform string

+ const PlatformAMD64

+ const PlatformARM64

+ func (platform Platform) String() string

+ type Registry struct

+ func (reg *Registry) GetDigest(imageRef string) (string, error)

+ func (reg *Registry) Host() string

+ func (reg *Registry) ListTags(repository string) ([]string, error)

+ func (reg *Registry) Password() string

+ func (reg *Registry) Username() string

+ type RegistryBuilder struct

+ func (builder *RegistryBuilder) Build() *Registry

+ func (builder *RegistryBuilder) Password(password string) *RegistryBuilder

+ func (builder *RegistryBuilder) Username(username string) *RegistryBuilder

+ type Scan struct

+ type ScanAction string

+ const ActionError

+ const ActionInfo

+ const ActionWarn

+ type ScanBuilder struct

+ func (builder *ScanBuilder) Build() *Scan

+ func (builder *ScanBuilder) Format(format ScanFormat) *ScanBuilder

+ func (builder *ScanBuilder) Severity(threshold ScanSeverity, action ...ScanAction) *ScanBuilder

+ func (builder *ScanBuilder) Source(image *Image) *ScanBuilder

+ type ScanFormat string

+ const FormatJSON

+ const FormatSARIF

+ const FormatTable

+ type ScanSeverity string

+ const SeverityCritical

+ const SeverityHigh

+ const SeverityLow

+ const SeverityMedium

+ const SeverityUnknown

+ type ScanSeverityCheck struct

+ type Sync struct

+ func (sync *Sync) DestDigest() string

+ type SyncBuilder struct

+ func (builder *SyncBuilder) Build() *Image

+ func (builder *SyncBuilder) Destination(image *Image) *SyncBuilder

+ func (builder *SyncBuilder) Platforms(platforms ...Platform) *SyncBuilder

+ func (builder *SyncBuilder) Source(image *Image) *SyncBuilder

+ type VersionCheck struct

+ func (check *VersionCheck) CurrentVersion() string

+ func (check *VersionCheck) Executed() bool

+ func (check *VersionCheck) LatestDigest() string

+ func (check *VersionCheck) LatestVersion() string

+ func (check *VersionCheck) UpdateAvailable() bool

+ type VersionCheckBuilder struct

+ func (builder *VersionCheckBuilder) Build() *VersionCheck

+ func (builder *VersionCheckBuilder) Source(image *Image) *VersionCheckBuilder

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