spec

package
v0.37.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 8, 2026 License: AGPL-3.0 Imports: 3 Imported by: 0

Documentation

Overview

Package spec defines the public semantic model for UDS bundles.

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrBundleAPIVersionRequired occurs when a bundle omits uds.bundle_api_version.
	ErrBundleAPIVersionRequired = errors.New("uds.bundle_api_version is required")
	// ErrMetadataNameRequired occurs when a bundle omits metadata.name.
	ErrMetadataNameRequired = errors.New("metadata.name is required")
	// ErrPackagesRequired occurs when a bundle contains no packages.
	ErrPackagesRequired = errors.New("at least one package is required")
)

Functions

This section is empty.

Types

type DuplicateOptionalComponentError

type DuplicateOptionalComponentError struct {
	Package   string
	Component string
}

DuplicateOptionalComponentError occurs when a package repeats an optional component name.

func (*DuplicateOptionalComponentError) Error

type DuplicatePackageNameError

type DuplicatePackageNameError struct {
	Index int
	Name  string
}

DuplicatePackageNameError occurs when multiple package blocks use the same name.

func (*DuplicatePackageNameError) Error

func (e *DuplicatePackageNameError) Error() string

type EmptyOptionalComponentError

type EmptyOptionalComponentError struct {
	Package string
}

EmptyOptionalComponentError occurs when a package contains an empty optional component name.

func (*EmptyOptionalComponentError) Error

type InvalidPackageNameError

type InvalidPackageNameError struct {
	Index int
	Name  string
}

InvalidPackageNameError occurs when a package name contains a path separator or is a dot path.

func (*InvalidPackageNameError) Error

func (e *InvalidPackageNameError) Error() string

type KeylessSignatureVerification

type KeylessSignatureVerification struct {
	CertificateIdentity         string
	CertificateIdentityRegexp   string
	CertificateOIDCIssuer       string
	CertificateOIDCIssuerRegexp string
	TrustedRoot                 string
	InsecureIgnoreTlog          bool
	InsecureIgnoreSCT           bool
	UseSignedTimestamps         bool
}

KeylessSignatureVerification constrains the keyless signer trusted for a package signature.

type Metadata

type Metadata struct {
	Name        string
	Description string
	Version     string
}

Metadata holds bundle-level identity and descriptive fields.

type Package

type Package struct {
	Name                  string
	Source                string
	Namespace             string
	DependsOn             []PackageRef
	ValuesFiles           []string
	OptionalComponents    []string
	SignatureVerification *PackageSignatureVerification
}

Package represents a Zarf package entry in a bundle.

type PackageNameRequiredError

type PackageNameRequiredError struct {
	Index int
}

PackageNameRequiredError occurs when a package block omits its name label.

func (*PackageNameRequiredError) Error

func (e *PackageNameRequiredError) Error() string

type PackageRef

type PackageRef struct {
	Name string
}

PackageRef identifies another package in the bundle.

type PackageSignatureVerification

type PackageSignatureVerification struct {
	Verify    *bool
	PublicKey string
	Keyless   *KeylessSignatureVerification
}

PackageSignatureVerification declares how a package signature is verified when the package enters a bundle.

type PackageSourceRequiredError

type PackageSourceRequiredError struct {
	Package string
}

PackageSourceRequiredError occurs when a package omits its source.

func (*PackageSourceRequiredError) Error

type SelfDependencyError

type SelfDependencyError struct {
	Package string
}

SelfDependencyError occurs when a package declares itself as a dependency.

func (*SelfDependencyError) Error

func (e *SelfDependencyError) Error() string

type UDSBlock

type UDSBlock struct {
	BundleAPIVersion string
}

UDSBlock contains tooling and schema constraints.

type UDSBundle

type UDSBundle struct {
	UDS      UDSBlock
	Metadata Metadata
	Packages []Package
}

UDSBundle represents a parsed UDS bundle definition.

func (*UDSBundle) Validate

func (b *UDSBundle) Validate() error

Validate checks that the bundle satisfies all required constraints.

type UnknownDependencyError

type UnknownDependencyError struct {
	Package    string
	Dependency string
}

UnknownDependencyError occurs when a package references a dependency absent from the bundle.

func (*UnknownDependencyError) Error

func (e *UnknownDependencyError) Error() string

type UnsupportedBundleAPIVersionError

type UnsupportedBundleAPIVersionError struct {
	Actual   string
	Expected string
}

UnsupportedBundleAPIVersionError occurs when a bundle uses an API version other than the supported version.

func (*UnsupportedBundleAPIVersionError) Error

Jump to

Keyboard shortcuts

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