console

package

Go to main page

Versions in this module

v0

v0.12.0

Nov 2, 2026

v0.11.0

Nov 1, 2026

v0.10.0

Nov 1, 2026

v0.9.1

Oct 31, 2026

Changes in this version

+ var ErrPolicyOnly = errors.New("this console serves its policy only and approves no request")

+ var ErrPolicyOnlyHub = fmt.Errorf(...)

type AsyncApprover

+ func PolicyOnlyApprover(base Approver) AsyncApprover

type Options

+ PolicyOnly bool

v0.9.0

Oct 31, 2026

Changes in this version

+ var ErrNoHub = fmt.Errorf(...)

v0.8.1

Oct 31, 2026

v0.8.0

Oct 31, 2026

v0.7.2

Oct 31, 2026

v0.7.1

Oct 30, 2026

v0.7.0

Oct 30, 2026

Changes in this version

+ func PolicyPendingOf(env Env) bool

+ func StatusBoundaryRow(v StatusView) string

+ func StatusModeRow(v StatusView, w Words) string

+ func StatusPendingRow(v StatusView) string

+ func StatusResultsRow(v StatusView, w Words) string

+ func StatusUnmaskRow(v StatusView) string

type Asker

+ func AskerOf(env Env) (Asker, bool)

+ type ChangeFormatter interface

+ FormatChanges func(changes []config.Change) []string

+ type ConnectionComparer interface

+ ConnectionChanged func(old, next Policy) bool

type Credentials

+ Policy Policy

+ type EndError struct

+ Err error

+ Reason string

+ func (e *EndError) Error() string

+ func (e *EndError) Unwrap() error

+ type PolicyApplier interface

+ ApplyPolicy func(p Policy) error

type Server

+ func (s *Server) Asker() Asker

+ func (s *Server) PolicyRefused() bool

+ func (s *Server) WriteAudit(rec audit.Record) error

type ServerConfig

+ ReconnectPolicy func(ctx context.Context, p Policy) (Session, error)

type Session

+ func Unwrap(s Session) Session

+ type StatusAnswerer interface

+ StatusAnswer func(c StatusResult, s Session) any

+ type StatusLiner interface

+ StatusLineParts func(v StatusView) (suffix string, parts []string)

+ type StatusRower interface

+ StatusRows func(v StatusView) [][2]string

+ type StatusView struct

+ AllowUnmask bool

+ Auto bool

+ Boundary string

+ Level int

+ Pending bool

+ Policy Policy

+ Profile Profile

+ Requests int

+ Session Session

+ ShowResults bool

+ Status StatusResult

+ type Worder interface

+ Words func() Words

+ type Words struct

+ AutoOn string

+ AutoStart string

+ ChangeQueued func(change string) string

+ ConnLost string

+ Manual string

+ NoAutoHub string

+ NoAutoProduction string

+ ProductionChecks func(p Profile, findings []Finding) (line, reason string)

+ Reconnecting string

+ ResultsOn string

+ ReviewAuto string

+ StatusAuto string

+ StatusManual string

+ StatusResults string

+ TTLReached func(ttl time.Duration, credentials string) string

+ UnmaskAsk string

+ UnmaskOff string

v0.6.0

Oct 30, 2026

Changes in this version

type Options

+ OnHub func(*Hub)

v0.5.0

Oct 30, 2026

Changes in this version

type Hub

+ func (h *Hub) RenewResp(ctx context.Context, id int64, tk string, caller plans.Caller) ipc.Response

+ func (h *Hub) Requests(io IO, rec func(audit.Base))

type HubOptions

+ FacadeKeysFile string

v0.4.0

Oct 30, 2026

Changes in this version

+ const StandaloneReason

+ func TicketParam(params json.RawMessage) string

+ func WithdrawnResp(id int64, tk string) ipc.Response

type HubOptions

+ DevicesFile string

+ RequireDevice string

+ SealClear bool

+ func (h HubOptions) Args() []string

+ type Withdrawn struct

+ Instance string

+ Tickets []string

+ func WithdrawStandalone(p kit.Product, stateDir string) ([]Withdrawn, error)

v0.3.1

Oct 30, 2026

Changes in this version

type HubOptions

+ PlainHTTP bool

v0.3.0

Oct 29, 2026

Changes in this version

+ const HubApproval

+ func PendingResp(id int64, lock string, p Pending) ipc.Response

type Approval

+ Pending *Pending

+ type Ask struct

+ For string

+ Frame string

+ Production bool

+ Retype string

+ RetypeNote string

+ Screen *Screen

+ type Asker struct

+ Approver Approver

+ End func(reason string)

+ IO IO

+ Lock string

+ Profile string

+ Waiting func(on bool)

+ func (a Asker) Ask(ctx context.Context, id int64, q Ask, record func(audit.Base)) Approval

+ func (a Asker) Decide(ctx context.Context, d Decision) Result

+ type AsyncApprover interface

+ Submit func(ctx context.Context, d Decision) (Pending, error)

type Decision

+ For string

+ Screen *Screen

+ type Hub struct

+ Client *hubclient.Client

+ Instance string

+ Store *plans.Store

+ func HubOf(env Env) *Hub

+ func OpenHub(p kit.Product, o HubOptions, stateDir string, now func() time.Time) (*Hub, error)

+ func (h *Hub) Approver(base Approver) AsyncApprover

+ func (h *Hub) Close() error

+ func (h *Hub) Watch(ctx context.Context, io IO)

+ type HubOptions struct

+ Home string

+ Instance string

+ KeyFile string

+ URL string

+ func (h *HubOptions) Register(fs *flag.FlagSet)

+ func (h HubOptions) Enabled() bool

+ type HubTicket struct

+ Caller plans.Caller

+ Masked render.MaskedScreen

+ PlanID string

+ Requester ticket.Requester

+ Risk ticket.Risk

+ Workspace string

type Options

+ Hub HubOptions

+ type Pending struct

+ Instance string

+ Ticket string

type Screen

+ Hub *HubTicket

type Server

+ func (s *Server) Hub() *Hub

type ServerConfig

+ Hub *Hub

+ RefuseProduction func() error

+ type Withdrawer interface

+ Withdraw func(ctx context.Context, d Decision, ticket, reason string) error

v0.2.1

Oct 28, 2026

v0.2.0

Oct 28, 2026

v0.1.0

Oct 19, 2026

Changes in this version

+ const ApprovalTimeout

+ const CredentialsNone

+ const FingerDeadline

+ const PolicyPoll

+ const ResponseQuantum

+ var ErrConfig = errors.New("configuration error")

+ var ErrSecretTimeout = errors.New("console: no password entered")

+ var ErrTooManyNoMatch = errors.New("fingerprint: three consecutive non-matching fingers")

+ var Paint = ui.Painter

+ func Bell(io IO)

+ func CloseVerifier(v fingerprint.Verifier)

+ func Decode(req ipc.Request, v any) *ipc.Response

+ func DenyReason(ans string) string

+ func ErrResp(id int64, code int, msg string) ipc.Response

+ func FormatChanges(changes []config.Change) []string

+ func Harden() error — darwin/amd64, linux/amd64, windows/amd64

+ func Level(ctx context.Context, quantum time.Duration, start time.Time)

+ func Loosens(changes []config.Change) bool

+ func OKResp(id int64, v any) ipc.Response

+ func PeerFrom(ctx context.Context) (ipc.Cred, bool)

+ func PeerText(ctx context.Context) string

+ func ProcessText(pid int) string

+ func Run(ctx context.Context, p kit.Product, b Backend, o Options) error

+ func SameUserRefusal(p kit.Product) string

+ func SameUserRefused(p kit.Product, sys *sysconf.Config, allowSameUser bool) error

+ func StampPeer(ctx context.Context, b *audit.Base)

+ func WithPeer(ctx context.Context, c ipc.Cred) context.Context

+ type Approval struct

+ Approved bool

+ Auto bool

+ Refusal ipc.Response

+ Retype bool

+ type Approver interface

+ Approve func(ctx context.Context, d Decision) Result

+ Mode func() string

+ func NewDesktopTypedApprover(io IO) Approver

+ func NewFingerprintApprover(io IO, v fingerprint.Verifier, finger string, deadline time.Duration) Approver

+ func NewTypedApprover(io IO) Approver

+ type Backend interface

+ Checks func(ctx context.Context, s Session) []Finding

+ Connect func(ctx context.Context, c Credentials) (Session, error)

+ LoadPolicy func() (Policy, error)

+ Methods func() map[string]Handler

+ Status func(s Session) any

+ type Beller interface

+ Bell func()

+ type Credentials struct

+ Secret []byte

+ User string

+ type Decision struct

+ Expected string

+ Production bool

+ Prompt string

+ Retype string

+ type Env interface

+ Approve func(ctx context.Context, id int64, s Screen) Approval

+ Audit func(rec audit.Record)

+ AuditBase func(ctx context.Context, b audit.Base)

+ Auto func() bool

+ End func(reason string)

+ Level func(ctx context.Context, start time.Time)

+ Lost func()

+ Policy func() Policy

+ Println func(line string)

+ Safe func(s string) string

+ Sanitizer func() *sanitize.Sanitizer

+ Session func(ctx context.Context) (Session, error)

+ ShowResults func() bool

+ UnmaskAllowed func() bool

+ type Finding struct

+ Refuse bool

+ Text string

+ type Handler func(ctx context.Context, req ipc.Request, env Env) ipc.Response

+ type IO interface

+ Ask func(ctx context.Context, prompt string, timeout time.Duration) (string, bool)

+ AskSecret func(ctx context.Context, prompt string) ([]byte, error)

+ Println func(s string)

+ type Isolation struct

+ Desktop bool

+ Display sysconf.Display

+ GID int

+ Product kit.Product

+ Self int

+ Sys *sysconf.Config

+ Verifier fingerprint.Verifier

+ func CheckIsolation(p kit.Product, io IO, env IsolationEnv) (*Isolation, error)

+ func (iso *Isolation) Boundary() string

+ func (iso *Isolation) Level() int

+ func (iso *Isolation) Listen(path string) (net.Listener, error)

+ func (iso *Isolation) PeerCheck() func(ipc.Cred) bool

+ func (iso *Isolation) RefuseX11IfProduction(production bool) error

+ func (iso *Isolation) SocketPath(projectKey, profile string) (string, error)

+ type IsolationEnv struct

+ AccountExists func(uid int) bool

+ AllowSameUser bool

+ ClientAllowed func(sys *sysconf.Config, uid int) bool

+ ClientGID func(sys *sysconf.Config) (int, error)

+ DesktopEnv func() bool

+ Display func() sysconf.Display

+ DisplaySet func() bool

+ EnrolledTimeout time.Duration

+ LoadSys func() (*sysconf.Config, error)

+ LoginUID func() (int, bool)

+ MachinectlUIDs func() ([]int, bool)

+ NewVerifier func(user string) (fingerprint.Verifier, error)

+ ParentChain func() ([]sysconf.Proc, error)

+ Relay func() string

+ TerminalOwner func() (int, bool)

+ UID func() int

+ UserName func() (string, error)

+ func RealIsolationEnv(p kit.Product, tty *os.File) IsolationEnv

+ type Key int

+ const KeyCtrlO

+ const KeyShiftTab

+ type KeySource interface

+ Keys func() <-chan Key

+ SetKeyHandler func(func(Key))

+ type LineSource interface

+ Lines func() <-chan string

+ type Loop struct

+ Clear func()

+ Command func(ctx context.Context, line string)

+ End func(reason string)

+ Ended func() bool

+ Handle func(ctx context.Context, req ipc.Request) ipc.Response

+ IO IO

+ Key func(Key)

+ PeerAllowed func(ipc.Cred) bool

+ Poll func()

+ Refresh func()

+ Tick func()

+ func (l *Loop) Serve(ctx context.Context, ln net.Listener, lines <-chan string) error

+ type Options struct

+ AllowUnmask bool

+ Auto bool

+ Harden func() error

+ IO IO

+ Isolation *IsolationEnv

+ Keychain *secrets.Keychain

+ Now func() time.Time

+ Profile string

+ ProjectRoot string

+ Quantum time.Duration

+ Ready func(socket string)

+ Sanitizer *sanitize.Sanitizer

+ ShowResults bool

+ StateDir string

+ TTY *os.File

+ VaultRead func(ctx context.Context, path string) (*secrets.VaultCredentials, error)

+ type Outcome int

+ const Approved

+ const Denied

+ const NoFinger

+ const RetypeRequested

+ const Unanswered

+ type PIIBackend interface

+ CheckMask func(pattern string) (string, error)

+ PIIRules func(p Policy) (mask, allow []string)

+ SaveMask func(pattern string) error

+ WithMask func(p Policy, pattern string) Policy

+ type Policy interface

+ Profile func() Profile

+ type Profile struct

+ Credentials string

+ CredentialsTTL time.Duration

+ DefaultPort int

+ Host string

+ IdleTimeout time.Duration

+ MaxSession time.Duration

+ Name string

+ Port int

+ Production bool

+ User string

+ VaultPath string

+ Where string

+ type Result struct

+ Answer string

+ Err error

+ Outcome Outcome

+ type Screen struct

+ Body []string

+ Header string

+ NeverAuto bool

+ Note string

+ Production bool

+ Record func(audit.Base) audit.Record

+ Red bool

+ Requester string

+ Retype string

+ Warnings []string

+ type Server struct

+ func NewServer(cfg ServerConfig) (*Server, error)

+ func (s *Server) Approve(ctx context.Context, id int64, sc Screen) Approval

+ func (s *Server) Audit(rec audit.Record)

+ func (s *Server) AuditBase(ctx context.Context, b audit.Base)

+ func (s *Server) Auto() bool

+ func (s *Server) CheckPolicy()

+ func (s *Server) Close()

+ func (s *Server) Command(ctx context.Context, line string)

+ func (s *Server) End(reason string)

+ func (s *Server) Ended() (string, bool)

+ func (s *Server) Handle(ctx context.Context, req ipc.Request) ipc.Response

+ func (s *Server) Key(k Key)

+ func (s *Server) Level(ctx context.Context, start time.Time)

+ func (s *Server) Loop() *Loop

+ func (s *Server) Lost()

+ func (s *Server) Policy() Policy

+ func (s *Server) PolicyPending() bool

+ func (s *Server) Println(line string)

+ func (s *Server) Safe(text string) string

+ func (s *Server) Sanitizer() *sanitize.Sanitizer

+ func (s *Server) Session(ctx context.Context) (Session, error)

+ func (s *Server) ShowResults() bool

+ func (s *Server) Status() StatusResult

+ func (s *Server) Tick()

+ func (s *Server) UnmaskAllowed() bool

+ type ServerConfig struct

+ AllowUnmask bool

+ ApprovedKey string

+ Approver Approver

+ Audit *audit.Log

+ Auto bool

+ Backend Backend

+ Boundary string

+ IO IO

+ Level int

+ Now func() time.Time

+ PeerAllowed func(ipc.Cred) bool

+ Policy Policy

+ Product kit.Product

+ Quantum time.Duration

+ Reconnect func(ctx context.Context, p Profile) (Session, error)

+ Refused string

+ Sanitizer *sanitize.Sanitizer

+ Session Session

+ ShowResults bool

+ StateDir string

+ type Session interface

+ Close func() error

+ type Sized interface

+ Width func() int

+ type StatusLine interface

+ SetStatus func(string)

+ type StatusResult struct

+ AllowUnmask bool

+ AutoApprove bool

+ IdleTimeoutInS int

+ Level int

+ Product any

+ Production bool

+ Profile string

+ SessionEndsInS int

+ ShowResults bool

+ type Terminal struct

+ func NewTerminal(in *os.File, out io.Writer) *Terminal

+ func (t *Terminal) Ask(ctx context.Context, prompt string, timeout time.Duration) (string, bool)

+ func (t *Terminal) AskSecret(ctx context.Context, prompt string) ([]byte, error)

+ func (t *Terminal) Bell()

+ func (t *Terminal) Interactive() error

+ func (t *Terminal) Keys() <-chan Key

+ func (t *Terminal) Lines() <-chan string

+ func (t *Terminal) Println(s string)

+ func (t *Terminal) Restore()

+ func (t *Terminal) SetKeyHandler(f func(Key))

+ func (t *Terminal) SetStatus(s string)

+ func (t *Terminal) Width() int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL