stepverify

package
v1.0.0-rc.2 Latest Latest
Warning

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

 Go to latest Published: Oct 6, 2026 License: AGPL-3.0, AGPL-3.0-or-later Imports: 23 Imported by: 0

Documentation

Overview

Package stepverify observes a quiescent, host-confined authoring step. Local digests and host assertions confer no execution authority or authentication.

Index

Constants

View Source 
const MaxDepth = 64
View Source 
const MaxEntries = 20_000
View Source 
const MaxFileBytes = 32 << 20
View Source 
const MaxRecordBytes = 32 << 20
View Source 
const MaxTotalBytes = 128 << 20

Variables

View Source 
var ErrDrift = errors.New("STEP_DRIFT")
View Source 
var ErrInput = errors.New("STEP_INPUT")
View Source 
var ErrUnsupported = errors.New("STEP_UNSUPPORTED")

Functions

func BoundedEncode 

func BoundedEncode(value any) ([]byte, error)

BoundedEncode refuses oversized records rather than silently dropping evidence.

func DeclarationDigest 

func DeclarationDigest(d Declaration) string

func Encode 

func Encode(value any) []byte

func ReadBoundInput 

func ReadBoundInput(ctx context.Context, path string, d Declaration, h Host, before State) ([]byte, error)

ReadBoundInput retains the trusted complete before-state authority boundary when post-step metadata is unavailable. Current discoverable boundaries are also excluded. This permits content findings without executing unadmitted Git.

func ReadInput 

func ReadInput(ctx context.Context, path string, d *Declaration) ([]byte, error)

ReadInput reads a bounded regular single-link host input through no-follow descriptors. When d is present, aliases of checkout/authority ancestry refuse.

Types

type Checkout 

type Checkout struct {
	ID   string `json:"id"`
	Root string `json:"root"`
}

type CheckoutState 

type CheckoutState struct {
	ID              string   `json:"id"`
	Root            string   `json:"root"`
	GitDir          string   `json:"git_dir"`
	CommonDir       string   `json:"common_dir"`
	Commit          string   `json:"commit"`
	Tree            string   `json:"tree"`
	IndexDigest     string   `json:"index_sha256"`
	ContentDigest   string   `json:"content_sha256"`
	AdminDigest     string   `json:"admin_sha256"`
	ContentComplete bool     `json:"content_complete"`
	Complete        bool     `json:"complete"`
	Entries         []Entry  `json:"entries"`
	AdminEntries    []Entry  `json:"admin_entries"`
	Unknowns        []string `json:"unknowns"`
}

type Declaration 

type Declaration struct {
	Profile      string           `json:"profile"`
	SessionID    string           `json:"session_id"`
	CapabilityID string           `json:"capability_id"`
	Author       Checkout         `json:"author"`
	ReadOnly     []Checkout       `json:"read_only"`
	WritePaths   []string         `json:"write_paths"`
	GuardPaths   []string         `json:"guard_paths"`
	Environment  []EnvironmentKey `json:"environment"`
}

func DecodeDeclaration 

func DecodeDeclaration(data []byte) (Declaration, error)

type Entry 

type Entry struct {
	Path     string `json:"path"`
	Kind     string `json:"kind"`
	Mode     uint32 `json:"mode"`
	Size     int64  `json:"size"`
	Digest   string `json:"sha256"`
	Identity string `json:"identity_sha256"`
}

type EnvironmentKey 

type EnvironmentKey struct {
	Key   string `json:"key"`
	Class string `json:"class"`
}

type EnvironmentReceipt 

type EnvironmentReceipt struct {
	Profile           string    `json:"profile"`
	DeclarationDigest string    `json:"declaration_sha256"`
	HostDigest        string    `json:"host_sha256"`
	Verdict           string    `json:"environment_verdict"`
	Findings          []Finding `json:"findings"`
	Unknowns          []string  `json:"unknowns"`
	Digest            string    `json:"sha256"`
}

EnvironmentReceipt records host-supplied key classifications, never values.

func Preflight 

func Preflight(d Declaration, h Host) (EnvironmentReceipt, int, error)

type Finding 

type Finding struct {
	Code     string `json:"code"`
	Checkout string `json:"checkout"`
	Path     string `json:"path"`
}

func Environment 

func Environment(d Declaration, h Host) (string, []Finding)

type Host 

type Host struct {
	Profile            string            `json:"profile"`
	ObserverID         string            `json:"observer_id"`
	SessionID          string            `json:"session_id"`
	CapabilityID       string            `json:"capability_id"`
	DeclarationDigest  string            `json:"declaration_sha256"`
	MetadataProtected  bool              `json:"metadata_protected"`
	FilesystemConfined bool              `json:"filesystem_confined"`
	GitBinary          string            `json:"git_binary"`
	GitBinaryDigest    string            `json:"git_binary_sha256"`
	Environment        *[]EnvironmentKey `json:"environment"`
}

func DecodeHost 

func DecodeHost(data []byte, d Declaration) (Host, error)

type Receipt 

type Receipt struct {
	Profile            string          `json:"profile"`
	DeclarationDigest  string          `json:"declaration_sha256"`
	HostDigest         string          `json:"host_sha256"`
	BeforeDigest       string          `json:"before_state_sha256"`
	AfterDigest        *string         `json:"post_state_sha256"`
	Before             []CheckoutState `json:"before"`
	After              []CheckoutState `json:"after"`
	WriteScopeVerdict  string          `json:"write_scope_verdict"`
	EnvironmentVerdict string          `json:"environment_verdict"`
	Findings           []Finding       `json:"findings"`
	Unknowns           []string        `json:"unknowns"`
	Digest             string          `json:"sha256"`
}

func Verify 

func Verify(ctx context.Context, d Declaration, h Host, before State) (Receipt, int, error)

Verify accepts a host-protected complete before state and recaptures the actual post-state. It never accepts an author's claimed post-state digest.

type State 

type State struct {
	Profile           string          `json:"profile"`
	DeclarationDigest string          `json:"declaration_sha256"`
	HostDigest        string          `json:"host_sha256"`
	SessionID         string          `json:"session_id"`
	CapabilityID      string          `json:"capability_id"`
	Checkouts         []CheckoutState `json:"checkouts"`
	Complete          bool            `json:"complete"`
	Digest            string          `json:"sha256"`
}

func DecodeState 

func DecodeState(data []byte, d Declaration, h Host) (State, error)

func Snapshot 

func Snapshot(ctx context.Context, d Declaration, h Host) (State, error)

Snapshot takes repeated observations of raw filesystem/admin state. Its race witnesses detect available drift; they do not make the capture atomic.

Source Files

View all Source files

Directories

Path Synopsis
SPDX-License-Identifier: AGPL-3.0-or-later Derived from internal/tasks/safeopen/at_linux.go at 25971bda1ca1664d8a546d751cb2bb9bbd454daf.
 SPDX-License-Identifier: AGPL-3.0-or-later Derived from internal/tasks/safeopen/at_linux.go at 25971bda1ca1664d8a546d751cb2bb9bbd454daf.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.