iso

Documentation

Overview

Package iso contains functions for creating ISO images.

Index

• func Label(version string, secureboot bool) string
• func VolumeID(label string) string
• type ExecutorOptions
  • func (e *ExecutorOptions) Generate() error
• type Generator
• type Options
  • func (options Options) CreateGRUB(printf func(string, ...any)) (Generator, error)
  • func (options Options) CreateHybrid(printf func(string, ...any)) (Generator, error)
  • func (options Options) CreateUEFI(printf func(string, ...any)) (Generator, error)
• type UEFIOptions

Functions

func Label

func Label(version string, secureboot bool) string

Label returns an ISO full label for a given version.

func VolumeID

func VolumeID(label string) string

VolumeID returns a valid volume ID for the given label.

Types

type ExecutorOptions

type ExecutorOptions struct {
	Command   string
	Version   string
	Arguments []string
}

ExecutorOptions defines the iso generation options.

func (*ExecutorOptions) Generate

func (e *ExecutorOptions) Generate() error

Generate creates an ISO image.

type Generator

type Generator interface {
	Generate() error
}

Generator is an interface for executing the iso generation.

type Options

type Options struct {
	KernelPath    string
	InitramfsPath string
	Cmdline       string

	UKIPath    string
	SDBootPath string

	Arch    string
	Version string

	// A value in loader.conf secure-boot-enroll: off, manual, if-safe, force.
	SDBootSecureBootEnrollKeys string

	// UKISigningCertDer is the DER encoded UKI signing certificate.
	UKISigningCertDerPath string

	// optional, for auto-enrolling secureboot keys
	PlatformKeyPath    string
	KeyExchangeKeyPath string
	SignatureKeyPath   string

	ScratchDir string
	OutPath    string
}

Options describe the input generating different types of ISOs.

func (Options) CreateGRUB

func (options Options) CreateGRUB(printf func(string, ...any)) (Generator, error)

CreateGRUB creates a GRUB-based ISO image.

This iso supports both BIOS and UEFI booting.

func (Options) CreateHybrid

func (options Options) CreateHybrid(printf func(string, ...any)) (Generator, error)

CreateHybrid creates an ISO image that supports both BIOS and UEFI booting.

func (Options) CreateUEFI

func (options Options) CreateUEFI(printf func(string, ...any)) (Generator, error)

CreateUEFI creates an iso using a UKI, systemd-boot.

The ISO created supports only booting in UEFI mode, and supports SecureBoot.

type UEFIOptions

type UEFIOptions struct {
	UKIPath    string
	SDBootPath string

	// A value in loader.conf secure-boot-enroll: off, manual, if-safe, force.
	SDBootSecureBootEnrollKeys string

	// UKISigningCertDer is the DER encoded UKI signing certificate.
	UKISigningCertDerPath string

	// optional, for auto-enrolling secureboot keys
	PlatformKeyPath    string
	KeyExchangeKeyPath string
	SignatureKeyPath   string

	Arch    string
	Version string

	ScratchDir string
	OutPath    string
}

UEFIOptions describe the input for the CreateUEFI function.