security/fortify
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 31 Wiki Activity

system: document I methods
All checks were successful
Test / Create distribution (push) Successful in 25s
Details
Test / Run NixOS test (push) Successful in 3m21s
Details

Browse Source 
Signed-off-by: Ophestra <cat@gensokyo.uk>
This commit is contained in:
Ophestra 2025-02-21 19:51:12 +09:00
parent ff30a5ab5d
commit a9986aab6a
Signed by: cat
SSH Key Fingerprint: SHA256:gQ67O0enBZ7UdZypgtspB2FDM1g3GVw8nX0XSdcFw8Q
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
system/op.go
View File

@ -1,3 +1,4 @@
// Package system provides tools for safely interacting with the operating system.
package system package system
import ( import (
@ -14,6 +15,7 @@ const (
Process = Enablement(ELen + 1) Process = Enablement(ELen + 1)
) )
// Criteria specifies types of Op to revert.
type Criteria struct { type Criteria struct {
*Enablements *Enablements
} }
@ -42,6 +44,7 @@ type Op interface {
String() string String() string
} }
// TypeString returns the string representation of a type stored as an [Enablement].
func TypeString(e Enablement) string { func TypeString(e Enablement) string {
switch e { switch e {
case User: case User:
@ -64,6 +67,7 @@ func New(uid int) (sys *I) {
return return
} }
// An I provides indirect bulk operating system interaction. I must not be copied.
type I struct { type I struct {
uid int uid int
ops []Op ops []Op
@ -91,6 +95,7 @@ func (sys *I) wrapErrSuffix(err error, a ...any) error {
return sys.wrapErr(err, append(a, err)...) return sys.wrapErr(err, append(a, err)...)
} }
// Equal returns whether all [Op] instances held by v is identical to that of sys.
func (sys *I) Equal(v *I) bool { func (sys *I) Equal(v *I) bool {
if v == nil || sys.uid != v.uid || len(sys.ops) != len(v.ops) { if v == nil || sys.uid != v.uid || len(sys.ops) != len(v.ops) {
return false return false
@ -105,6 +110,8 @@ func (sys *I) Equal(v *I) bool {
return true return true
} }
// Commit applies all [Op] held by [I] and reverts successful [Op] on first error encountered.
// Commit must not be called more than once.
func (sys *I) Commit(ctx context.Context) error { func (sys *I) Commit(ctx context.Context) error {
sys.lock.Lock() sys.lock.Lock()
defer sys.lock.Unlock() defer sys.lock.Unlock()
@ -141,6 +148,7 @@ func (sys *I) Commit(ctx context.Context) error {
return nil return nil
} }
// Revert reverts all [Op] meeting [Criteria] held by [I].
func (sys *I) Revert(ec *Criteria) error { func (sys *I) Revert(ec *Criteria) error {
sys.lock.Lock() sys.lock.Lock()
defer sys.lock.Unlock() defer sys.lock.Unlock()