server

Jan 27, 2026

Changes in this version

+ type PrivilegeDropperOption func(*PrivilegeDropper) — darwin/amd64, linux/amd64, windows/amd64

+ func WithLogger(logger *log.Entry) PrivilegeDropperOption

Jan 16, 2026

Changes in this version

type JWTConfig

+ Audiences []string

Jan 7, 2026

Changes in this version

type Server

+ func (s *Server) Addr() net.Addr

type SessionInfo

+ PortForwards []string

Dec 29, 2025

Changes in this version

type Server

+ func (s *Server) UpdateSSHAuth(config *sshauth.Config)

Nov 18, 2025

Changes in this version

+ const DefaultJWTMaxTokenAge

+ const DefaultSSHPort

+ const ExitCodeCreateProcessFail — windows/amd64

+ const ExitCodeLogonFail — windows/amd64

+ const ExitCodePrivilegeDropFail — darwin/amd64, linux/amd64

+ const ExitCodeShellExecFail — darwin/amd64, linux/amd64, windows/amd64

+ const ExitCodeSuccess — darwin/amd64, linux/amd64, windows/amd64

+ const ExitCodeValidationFail — darwin/amd64, linux/amd64, windows/amd64

+ const ExitCodeWorkingDirFail — windows/amd64

+ const FeatureSFTP

+ const FeatureSSHLogin

+ const InternalSSHPort

+ const KerbS4ULogonType — windows/amd64

+ const MicrosoftKerberosNameA — windows/amd64

+ const Msv10packagename — windows/amd64

+ const Msv10s4ulogontype — windows/amd64

+ const NameCanonical — windows/amd64

+ const NameSamCompatible — windows/amd64

+ const NameUserPrincipal — windows/amd64

+ const StatusSuccess — windows/amd64

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

+ var ErrPrivilegedUserDisabled = errors.New(msgPrivilegedUserDisabled)

+ var ErrPrivilegedUserSwitch = errors.New("cannot switch to privileged user - current user lacks required privileges")

+ var ErrUserNotFound = errors.New("user not found")

+ func StartTestServer(t *testing.T, server *Server) string

+ type Config struct

+ HostKeyPEM []byte

+ JWT *JWTConfig

+ type ConnectionKey string

+ type ExecutorConfig struct — darwin/amd64, linux/amd64

+ Command string

+ GID uint32

+ Groups []uint32

+ PTY bool

+ Shell string

+ UID uint32

+ WorkingDir string

+ type ForwardKey string

+ type JWTConfig struct

+ Audience string

+ Issuer string

+ KeysLocation string

+ MaxTokenAge int64

+ type PrivilegeCheckRequest struct

+ FeatureName string

+ FeatureSupportsUserSwitch bool

+ RequestedUsername string

+ type PrivilegeCheckResult struct

+ Allowed bool

+ Error error

+ RequiresUserSwitching bool

+ UsedFallback bool

+ User *user.User

+ type PrivilegeDropper struct — darwin/amd64, linux/amd64, windows/amd64

+ func NewPrivilegeDropper() *PrivilegeDropper

+ func (pd *PrivilegeDropper) CreateExecutorCommand(ctx context.Context, config ExecutorConfig) (*exec.Cmd, error)

+ func (pd *PrivilegeDropper) CreateWindowsExecutorCommand(ctx context.Context, config WindowsExecutorConfig) (*exec.Cmd, windows.Token, error)

+ func (pd *PrivilegeDropper) CreateWindowsProcessAsUser(ctx context.Context, executablePath string, args []string, ...) (*exec.Cmd, windows.Token, error)

+ func (pd *PrivilegeDropper) DropPrivileges(targetUID, targetGID uint32, supplementaryGroups []uint32) error

+ func (pd *PrivilegeDropper) ExecuteWithPrivilegeDrop(ctx context.Context, config ExecutorConfig)

+ type PrivilegedUserError struct

+ Username string

+ func (e *PrivilegedUserError) Error() string

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

+ type PtyExecutionRequest struct — windows/amd64

+ Command string

+ Domain string

+ Height int

+ Shell string

+ Username string

+ Width int

+ type Server struct

+ func New(config *Config) *Server

+ func (s *Server) CheckPrivileges(req PrivilegeCheckRequest) PrivilegeCheckResult

+ func (s *Server) GetStatus() (enabled bool, sessions []SessionInfo)

+ func (s *Server) SetAllowLocalPortForwarding(allow bool)

+ func (s *Server) SetAllowRemotePortForwarding(allow bool)

+ func (s *Server) SetAllowRootLogin(allow bool)

+ func (s *Server) SetAllowSFTP(allow bool)

+ func (s *Server) SetNetstackNet(net *netstack.Net)

+ func (s *Server) SetNetworkValidation(addr wgaddr.Address)

+ func (s *Server) Start(ctx context.Context, addr netip.AddrPort) error

+ func (s *Server) Stop() error

+ type SessionInfo struct

+ Command string

+ JWTUsername string

+ RemoteAddress string

+ Username string

+ type SessionKey string

+ type UserNotFoundError struct

+ Cause error

+ Username string

+ func (e *UserNotFoundError) Error() string

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

+ func (e *UserNotFoundError) Unwrap() error

+ type WindowsExecutorConfig struct — windows/amd64

+ Args []string

+ Command string

+ Domain string

+ Interactive bool

+ Pty bool

+ PtyHeight int

+ PtyWidth int

+ Shell string

+ Username string

+ WorkingDir string