identity

package module

Go to main page

Versions in this module

v0

v0.5.1

Oct 19, 2026

Changes in this version

+ var ErrPeerPending = fmt.Errorf("%w: no descriptor holder was observed for the connected socket", ErrPeerGone)

v0.5.0

Oct 18, 2026

Changes in this version

+ var ErrBeyondLoopback = errors.New("identity: process tree listens beyond loopback")

+ var ErrNotHelper = errors.New("identity: peer is not this account's elevated helper")

+ var ErrNotLocalFile = errors.New("identity: not an absolute path on a local drive")

+ var ErrNotLocalPath = errors.New("identity: the path is not on a local drive")

+ func AdmitServerQueries(...string) (func() error, error) — darwin/amd64, js/wasm, linux/amd64

+ func AdmitServerQueries(containers ...string) (func() error, error) — windows/amd64

+ func CheckElevatedHelper(peer *Peer, self User, program string) error

+ func CheckLoopbackOnly(sockets []Socket, owned func(pid int) bool, listener netip.AddrPort) error

+ func CheckTreeLoopback(listener netip.AddrPort, contains TreeContains) error

+ func FileKey(path string) (string, error)

+ func FileKeyOf(f *os.File) (string, error) — windows/amd64

+ func HasShortNameComponent(path string) bool

+ func Inside(path, folder string) bool

+ func InsideRel(path, folder string) (string, bool, error)

+ func LocalPath(path string) error

+ func ObserveOpens(observe func(path string)) (stop func(), ok bool)

+ func OwnedByTree(contains TreeContains) func(pid int) bool

+ func PathNameKey(p string) string

+ func PathNameWithin(path, folder string) bool

+ func PlaceKey(path string) (string, error)

+ func ProgramKey(program string) string

+ func SameFile(a, b string) (bool, error)

+ func SameNormalizedSubjectProgram(a, b string) bool

+ func SameNormalizedSubjectProgramKeyed(a, b string, keyA, keyB func() string) bool

+ func SamePathName(a, b string) bool

+ func TreatDriveAsNetwork(letter byte) (restore func())

+ func TreatVolumeAsNetwork(folder string) (restore func()) — darwin/amd64, linux/amd64

+ func UnresolvedShortName(path string) bool

+ func VerifyFile(path string, opts *Options) (Code, Proof, error)

+ func Within(path, folder string) (bool, error)

+ func WithinRel(path, folder string) (string, bool, error)

type Binding

+ func BindLoopbackServer(c net.Conn, opts *Options) (*Binding, error)

+ func BindUnixServer(c net.Conn, opts *Options) (*Binding, error)

type Code

+ Description string

+ OriginalName string

+ type NotLocalPathError struct

+ Path string

+ Reason string

+ func (e *NotLocalPathError) Error() string

+ func (e *NotLocalPathError) Is(target error) bool

+ type Socket struct

+ Addr netip.Addr

+ PID int

+ Port int

+ Proto string

+ func AllSockets() ([]Socket, error)

+ func Sockets() ([]Socket, error)

+ type TreeContains func(pid int, started time.Time) (bool, error)

type User

+ Restricted bool

+ func Self() (User, error)

v0.4.2

Sep 28, 2026

Changes in this version

+ func NormalizeSubjectProgram(program string) string

+ func SameSubjectProgram(a, b string) bool

v0.4.1

Sep 28, 2026

v0.4.0

Sep 27, 2026

Changes in this version

+ func CanonicalProgramPath(path string) string

type Binding — darwin/amd64

+ func BindXPCRequest(request *XPCRequest) (*Binding, error)

+ func (b *Binding) EvidenceValidUntil() time.Time

type Limits

+ func CeilingFor(transport Transport) (Limits, error)

+ func (l Limits) CanEver(n Need) error

+ type Transport string

+ const TransportNamedPipe

+ const TransportNative

+ const TransportUnix

+ const TransportXPC

+ type XPCClient struct — darwin/amd64

+ func OpenXPCClient(ctx context.Context, service, expectedProgram string, expectedEUID uint32, ...) (*XPCClient, error)

+ func (c *XPCClient) Call(ctx context.Context, frame []byte, oneWay bool) ([]byte, int, error)

+ func (c *XPCClient) Close() error

+ type XPCListener struct — darwin/amd64

+ func OpenXPCListener(service string, maxFrame uint32) (*XPCListener, error)

+ func (l *XPCListener) Accept() (*XPCRequest, error)

+ func (l *XPCListener) Close() error

+ type XPCProofRefusal struct — darwin/amd64

+ Attribute uint8

+ Required Proof

+ func (e *XPCProofRefusal) Error() string

+ func (e *XPCProofRefusal) Is(target error) bool

+ type XPCRequest struct — darwin/amd64

+ func (r *XPCRequest) Close() error

+ func (r *XPCRequest) Done() <-chan struct{}

+ func (r *XPCRequest) Frame() []byte

+ func (r *XPCRequest) RefuseUnmetProof(attribute uint8, required Proof) error

+ func (r *XPCRequest) Reply(frame []byte) error

v0.3.0

Sep 20, 2026

Changes in this version

+ const PackagedProgramPrefix

+ const TransportLoopback

+ func PackageFamily(fullName string) (string, bool)

+ func SubjectProgram(p *Peer, pathProof Proof) (string, error)

+ func ValidSubjectProgram(program string) bool

type Binding

+ func BindLoopback(c net.Conn, opts *Options) (*Binding, error)

+ func (b *Binding) Shared() *Binding

type Limits

+ func LoopbackCeiling() Limits

type Peer

+ func (p *Peer) Rung() string

v0.2.2

Sep 15, 2026

v0.2.1

Sep 15, 2026

Changes in this version

type Binding

+ func BindServer(h Handle, opts *Options) (*Binding, error)

+ func BindServerConn(c net.Conn, opts *Options) (*Binding, error)

v0.2.0

Sep 9, 2026

Changes in this version

type Proof

+ const ProofInvalid

+ const ProofUnmet

+ const ProofUnsigned

v0.1.0

Sep 9, 2026

Changes in this version

+ var ErrImpersonationStuck = errors.New("identity: could not revert impersonation; thread abandoned")

+ var ErrMustReadFirst = errors.New(...)

+ var ErrNoBinding = errors.New("identity: this machine cannot bind a peer to a connection")

+ var ErrNotProven = errors.New("identity: not proven to the required level")

+ var ErrNotServerEnd = errors.New("identity: handle is not the end of the connection the service accepted")

+ var ErrPeerGone = errors.New("identity: there is no live peer to bind to")

+ var ErrPeerMoved = errors.New(...)

+ var ErrRemotePeer = errors.New("identity: peer is not on this machine")

+ var ErrUnimplemented = errors.New("identity: not implemented on this platform")

+ var ErrUnsupportedConn = errors.New("identity: connection carries no peer credentials")

+ func CanEver(n Need) error

+ type Attr struct

+ func (a Attr[T]) AtLeast(min Proof) (T, error)

+ func (a Attr[T]) Get() (T, Proof)

+ func (a Attr[T]) Known() bool

+ func (a Attr[T]) Name() string

+ func (a Attr[T]) Proof() Proof

+ func (a Attr[T]) String() string

+ func (a Attr[T]) Why() string

+ type Binding struct

+ func Bind(h Handle, opts *Options) (*Binding, error)

+ func BindConn(c net.Conn, opts *Options) (*Binding, error)

+ func (b *Binding) Alive() (bool, error)

+ func (b *Binding) BoundAt() time.Time

+ func (b *Binding) Captured() *Peer

+ func (b *Binding) Check(n Need) error

+ func (b *Binding) Close() error

+ func (b *Binding) Peer() (*Peer, error)

+ type Code struct

+ Catalog bool

+ Issuer string

+ Status string

+ Subject string

+ TeamID string

+ Trusted bool

+ func (c Code) String() string

+ type Handle uintptr

+ type Limits struct

+ Best Need

+ Bindable bool

+ Binding string

+ Platform string

+ Stronger string

+ Transport string

+ Why map[string]string

+ func Ceiling() Limits

+ func (l Limits) String() string

+ type Need struct

+ Code Proof

+ Package Proof

+ Path Proof

+ Process Proof

+ User Proof

+ type Options struct

+ CheckRevocation bool

+ CodeRequirement string

+ ConnectedAt time.Time

+ SkipCodeSignature bool

+ type Peer struct

+ Code Attr[Code]

+ Notes []string

+ ObservedAt time.Time

+ Package Attr[string]

+ Path Attr[string]

+ Platform string

+ Process Attr[Process]

+ Transport string

+ User Attr[User]

+ func OfConn(c net.Conn, opts *Options) (*Peer, error)

+ func OfHandle(h Handle, opts *Options) (*Peer, error)

+ func (p *Peer) Check(n Need) error

+ func (p *Peer) String() string

+ type Process struct

+ Generation uint32

+ PID int

+ Recycled bool

+ StartTime time.Time

+ func (p Process) String() string

+ type Proof uint8

+ const ProofBound

+ const ProofClaimed

+ const ProofKernel

+ const ProofNone

+ const ProofPID

+ const ProofSigned

+ func (p Proof) String() string

+ type ProofError struct

+ Attribute string

+ Got Proof

+ Want Proof

+ Why string

+ func (e *ProofError) Error() string

+ func (e *ProofError) Is(target error) bool

+ type User struct

+ AuditSessionID uint32

+ Domain string

+ Elevated bool

+ GID int

+ Integrity string

+ IntegrityRID uint32

+ Kind string

+ Name string

+ SID string

+ SecurityContext string

+ UID int

+ func (u User) String() string

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