app

Documentation

Overview

Package app defines the generic App interface.

Index

• Variables
• func NewAppID(id *ID) error
• func ParseAppID(id *ID, s string) error
• type App
• type ID
  • func (a *ID) String() string
• type Paths
• type RunState
  • func (rs *RunState) SetStart()
• type SealedApp

Variables

var (
	ErrInvalidLength = errors.New("string representation must have a length of 32")
)

Functions

func NewAppID

func NewAppID(id *ID) error

func ParseAppID

func ParseAppID(id *ID, s string) error

Types

type App

type App interface {
	// ID returns a copy of [ID] held by App.
	ID() ID

	// Seal determines the outcome of config as a [SealedApp].
	// The value of config might be overwritten and must not be used again.
	Seal(config *fst.Config) (SealedApp, error)

	String() string
}

type ID

type ID [16]byte

func (*ID) String

func (a *ID) String() string

type Paths

type Paths struct {
	// path to shared directory (usually `/tmp/fortify.%d`)
	SharePath string `json:"share_path"`
	// XDG_RUNTIME_DIR value (usually `/run/user/%d`)
	RuntimePath string `json:"runtime_path"`
	// application runtime directory (usually `/run/user/%d/fortify`)
	RunDirPath string `json:"run_dir_path"`
}

Paths contains environment-dependent paths used by fortify.

type RunState

type RunState struct {
	// Time is the exact point in time where the process was created.
	// Location must be set to UTC.
	//
	// Time is nil if no process was ever created.
	Time *time.Time
	// RevertErr is stored by the deferred revert call.
	RevertErr error
	// WaitErr is the generic error value created by the standard library.
	WaitErr error

	syscall.WaitStatus
}

RunState stores the outcome of a call to [SealedApp.Run].

func (*RunState) SetStart

func (rs *RunState) SetStart()

SetStart stores the current time in RunState once.

type SealedApp

type SealedApp interface {
	// Run commits sealed system setup and starts the app process.
	Run(rs *RunState) error
}