agentssh

Documentation

Index

• Constants
• func Bicopy(ctx context.Context, c1, c2 io.ReadWriteCloser)
• type ConnStats
• type Server
  • func NewServer(ctx context.Context, logger slog.Logger, ...) (*Server, error)
  • func (s *Server) Close() error
  • func (s *Server) ConnStats() ConnStats
  • func (s *Server) CreateCommand(ctx context.Context, script string, env []string) (*pty.Cmd, error)
  • func (s *Server) Serve(l net.Listener) (retErr error)
  • func (*Server) Shutdown(_ context.Context) error

Constants

const (
	// MagicSessionErrorCode indicates that something went wrong with the session, rather than the
	// command just returning a nonzero exit code, and is chosen as an arbitrary, high number
	// unlikely to shadow other exit codes, which are typically 1, 2, 3, etc.
	MagicSessionErrorCode = 229

	// MagicSessionTypeEnvironmentVariable is used to track the purpose behind an SSH connection.
	// This is stripped from any commands being executed, and is counted towards connection stats.
	MagicSessionTypeEnvironmentVariable = "CODER_SSH_SESSION_TYPE"
	// MagicSessionTypeVSCode is set in the SSH config by the VS Code extension to identify itself.
	MagicSessionTypeVSCode = "vscode"
	// MagicSessionTypeJetBrains is set in the SSH config by the JetBrains extension to identify itself.
	MagicSessionTypeJetBrains = "jetbrains"
)

Functions

func Bicopy

func Bicopy(ctx context.Context, c1, c2 io.ReadWriteCloser)

Bicopy copies all of the data between the two connections and will close them after one or both of them are done writing. If the context is canceled, both of the connections will be closed.

Types

type ConnStats

type ConnStats struct {
	Sessions  int64
	VSCode    int64
	JetBrains int64
}

type Server

type Server struct {
	Env           map[string]string
	AgentToken    func() string
	Manifest      *atomic.Pointer[agentsdk.Manifest]
	ServiceBanner *atomic.Pointer[codersdk.ServiceBannerConfig]
	// contains filtered or unexported fields
}

func NewServer

func NewServer(ctx context.Context, logger slog.Logger, prometheusRegistry *prometheus.Registry, fs afero.Fs, maxTimeout time.Duration, x11SocketDir string) (*Server, error)

func (*Server) Close

func (s *Server) Close() error

Close the server and all active connections. Server can be re-used after Close is done.

func (*Server) ConnStats

func (s *Server) ConnStats() ConnStats

func (*Server) CreateCommand

func (s *Server) CreateCommand(ctx context.Context, script string, env []string) (*pty.Cmd, error)

CreateCommand processes raw command input with OpenSSH-like behavior. If the script provided is empty, it will default to the users shell. This injects environment variables specified by the user at launch too.

func (*Server) Serve

func (s *Server) Serve(l net.Listener) (retErr error)

func (*Server) Shutdown

func (*Server) Shutdown(_ context.Context) error

Shutdown gracefully closes all active SSH connections and stops accepting new connections.

Shutdown is not implemented.