terminalservice

package

v0.28.2 Latest Latest Go to latest Published: Jun 7, 2026 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/contenox/runtime

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package terminalservice manages local PTY-backed shell sessions.

Index ¶

Constants
Variables
func CwdUnderRoot(allowedRoot, cwd string) error
func IsEnabled(v string) bool
func ResolveCwdUnderRoot(allowedRoot, cwd string) (string, error)
func ValidateShell(shell string) error
type Config
- func ParseEnv(...) (Config, error)
type CreateRequest
type CreateResponse
type ResizeMsg
type Service
type SessionInfo

Constants ¶

View Source

const DefaultIdleTimeout = 30 * time.Minute

Variables ¶

View Source

var (
	// ErrDisabled is returned when the terminal feature is off.
	ErrDisabled = errors.New("terminal: disabled")
	// ErrNotImplemented is returned on platforms without PTY support.
	ErrNotImplemented = errors.New("terminal: not implemented on this platform")
	// ErrSessionNotFound is returned for unknown session IDs.
	ErrSessionNotFound = errors.New("terminal: session not found")
	// ErrTooManySessions is returned when the per-process session slot is occupied.
	ErrTooManySessions = errors.New("terminal: too many concurrent sessions")
)

Functions ¶

func CwdUnderRoot ¶

func CwdUnderRoot(allowedRoot, cwd string) error

CwdUnderRoot ensures cwd is the same as allowedRoot or a subdirectory.

func IsEnabled ¶

func IsEnabled(v string) bool

IsEnabled returns true for accepted truthy terminal feature flag values.

func ResolveCwdUnderRoot ¶

func ResolveCwdUnderRoot(allowedRoot, cwd string) (string, error)

ResolveCwdUnderRoot returns a cleaned, real cwd after validating it is inside allowedRoot.

func ValidateShell ¶

func ValidateShell(shell string) error

Types ¶

type Config ¶

type Config struct {
	Enabled      bool
	AllowedRoot  string
	DefaultShell string
	// IdleTimeout is the maximum time a detached session is kept alive.
	// Zero disables idle reaping.
	IdleTimeout time.Duration
}

Config holds terminal service settings.

func ParseEnv ¶

func ParseEnv(terminalEnabled, terminalAllowedRoot, terminalShell, terminalIdleTimeout string) (Config, error)

ParseEnv builds a Config from raw env-backed string fields.

type CreateRequest ¶

type CreateRequest struct {
	CWD   string
	Cols  int
	Rows  int
	Shell string
}

type CreateResponse ¶

type CreateResponse struct {
	ID string
}

type ResizeMsg ¶

type ResizeMsg struct {
	Cols int
	Rows int
}

type Service ¶

type Service interface {
	Create(ctx context.Context, principal string, req CreateRequest) (*CreateResponse, error)
	Close(ctx context.Context, principal, id string) error
	CloseAll(ctx context.Context) error
	Attach(ctx context.Context, principal, id string, conn io.ReadWriteCloser, resizeCh <-chan ResizeMsg) error
	Get(ctx context.Context, principal, id string) (*SessionInfo, error)
	List(ctx context.Context, principal string, createdAtCursor *time.Time, limit int) ([]*SessionInfo, error)
	UpdateGeometry(ctx context.Context, principal, id string, cols, rows int) error
	ReapIdle(ctx context.Context) error
}

func New ¶

func New(cfg Config, db libdb.DBManager, nodeInstanceID string, workspaceID string) (Service, error)

func NewDisabled ¶

func NewDisabled() Service

func WithActivityTracker ¶

func WithActivityTracker(svc Service, tracker libtracker.ActivityTracker) Service

type SessionInfo ¶

type SessionInfo = terminalstore.Session

Source Files ¶

View all Source files

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