ospkg

Documentation

Index

• Constants
• type Descriptor
  • func DescriptorFromBytes(data []byte) (*Descriptor, error)
  • func (d *Descriptor) Bytes() ([]byte, error)
  • func (d *Descriptor) GetPkgURL(base *url.URL) (*url.URL, error)
  • func (d *Descriptor) Validate() error
• type FetchMethod
  • func (f FetchMethod) IsValid() bool
  • func (f FetchMethod) MarshalJSON() ([]byte, error)
  • func (f FetchMethod) String() string
  • func (f *FetchMethod) UnmarshalJSON(data []byte) error
• type OSManifest
  • func OSManifestFromBytes(data []byte) (*OSManifest, error)
  • func (m *OSManifest) Bytes() ([]byte, error)
  • func (m *OSManifest) Validate() error
• type OSPackage
  • func CreateOSPackage(label, pkgURL, kernel, initramfs, cmdline string) (*OSPackage, error)
  • func CreateOSPackageCtx(ctx context.Context, label, pkgURL, kernel, initramfs, cmdline string) (*OSPackage, error)
  • func NewOSPackage(archiveZIP, descriptorJSON []byte) (*OSPackage, error)
  • func (osp *OSPackage) ArchiveBytes() ([]byte, error)
  • func (osp *OSPackage) ArchiveHash() [32]byte
  • func (osp *OSPackage) DescriptorBytes() ([]byte, error)
  • func (osp *OSPackage) DescriptorHash() [32]byte
  • func (osp *OSPackage) LinuxImage() (boot.LinuxImage, error)
  • func (osp *OSPackage) Sign(signer crypto.Signer, certDER []byte) error
  • func (osp *OSPackage) Verify(rootCert *x509.Certificate) (found, valid int, err error)

Constants

const (
	DescriptorVersion int = 1
	// DescriptorExt is the file extension of OS package descriptor file.
	DescriptorExt string = ".json"
)

const (
	ManifestVersion int = 1
	// ManifestName is the name of OS packages' internal configuration file.
	ManifestName string = "manifest.json"
)

const (
	// DefaultOSPackageName is the file name of the archive, which is expected to contain
	// the stboot configuration file along with the corresponding files.
	DefaultOSPackageName string = "ospkg.zip"
	// OSPackageExt is the file extension of OS packages.
	OSPackageExt string = ".zip"
)

Types

type Descriptor

type Descriptor struct {
	Version int    `json:"version"`
	PkgURL  string `json:"os_pkg_url"`

	Certificates [][]byte `json:"certificates"`
	Signatures   [][]byte `json:"signatures"`
}

Descriptor represents the descriptor JSON file of an OS package.

func DescriptorFromBytes

func DescriptorFromBytes(data []byte) (*Descriptor, error)

DescriptorFromBytes parses a manifest from a byte slice.

func (*Descriptor) Bytes

func (d *Descriptor) Bytes() ([]byte, error)

Bytes serializes a manifest stuct into a byte slice.

func (*Descriptor) GetPkgURL

func (d *Descriptor) GetPkgURL(base *url.URL) (*url.URL, error)

func (*Descriptor) Validate

func (d *Descriptor) Validate() error

Validate returns true if d has valid content.

type FetchMethod

type FetchMethod int

FetchMethod controls where to load the OS package from.

const (
	FetchFromNetwork FetchMethod = iota + 1
	FetchFromInitramfs
)

Supported methods to fetch an OS package.

func (FetchMethod) IsValid

func (f FetchMethod) IsValid() bool

IsValid returns true if b is a defined FetchMethod value.

func (FetchMethod) MarshalJSON

func (f FetchMethod) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (FetchMethod) String

func (f FetchMethod) String() string

String implements fmt.Stringer.

func (*FetchMethod) UnmarshalJSON

func (f *FetchMethod) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler.

type OSManifest

type OSManifest struct {
	Version int    `json:"version"`
	Label   string `json:"label"`

	KernelPath    string `json:"kernel"`
	InitramfsPath string `json:"initramfs"`
	Cmdline       string `json:"cmdline"`
}

OSManifest describes the content and configuration of an OS package loaded by stboot.

func OSManifestFromBytes

func OSManifestFromBytes(data []byte) (*OSManifest, error)

OSManifestFromBytes parses a manifest from a byte slice.

func (*OSManifest) Bytes

func (m *OSManifest) Bytes() ([]byte, error)

Bytes serializes a manifest stuct into a byte slice.

func (*OSManifest) Validate

func (m *OSManifest) Validate() error

Validate returns no.

type OSPackage

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

OSPackage represents an OS package ZIP archive and related data.

func CreateOSPackage

func CreateOSPackage(label, pkgURL, kernel, initramfs, cmdline string) (*OSPackage, error)

CreateOSPackage constructs a OSPackage from the passed files.

func CreateOSPackageCtx

func CreateOSPackageCtx(ctx context.Context, label, pkgURL, kernel, initramfs, cmdline string) (*OSPackage, error)

func NewOSPackage

func NewOSPackage(archiveZIP, descriptorJSON []byte) (*OSPackage, error)

NewOSPackage constructs a new OSPackage initialized with raw bytes and valid internal state.

func (*OSPackage) ArchiveBytes

func (osp *OSPackage) ArchiveBytes() ([]byte, error)

ArchiveBytes returns the zip compressed archive part of osp.

func (*OSPackage) ArchiveHash

func (osp *OSPackage) ArchiveHash() [32]byte

func (*OSPackage) DescriptorBytes

func (osp *OSPackage) DescriptorBytes() ([]byte, error)

DescriptorBytes returns the descriptor part of osp as serialized bytes.

func (*OSPackage) DescriptorHash

func (osp *OSPackage) DescriptorHash() [32]byte

func (*OSPackage) LinuxImage

func (osp *OSPackage) LinuxImage() (boot.LinuxImage, error)

OSImage returns a LinuxImage from osp. LinuxImage implements boot.

func (*OSPackage) Sign

func (osp *OSPackage) Sign(signer crypto.Signer, certDER []byte) error

Signs osp.HashValue. Both the signature and the certificate are stored into the OSPackage.

func (*OSPackage) Verify

func (osp *OSPackage) Verify(rootCert *x509.Certificate) (found, valid int, err error)

Verify determines the number of unique certificates that chain up to (or is the) root certificate and which also produced valid OS package signatures.