agentssh

Documentation

Index

• Constants
• func Bicopy(ctx context.Context, c1, c2 io.ReadWriteCloser)
• func NewJetbrainsChannelWatcher(ctx ssh.Context, logger slog.Logger, newChannel gossh.NewChannel, ...) gossh.NewChannel
• type ChannelOnClose
  • func (c *ChannelOnClose) Close() error
• type Config
• type ConnStats
• type JetbrainsChannelWatcher
  • func (w *JetbrainsChannelWatcher) Accept() (gossh.Channel, <-chan *gossh.Request, error)
• 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"
	// MagicProcessCmdlineJetBrains is a string in a process's command line that
	// uniquely identifies it as JetBrains software.
	MagicProcessCmdlineJetBrains = "idea.vendor.name=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.

func NewJetbrainsChannelWatcher

func NewJetbrainsChannelWatcher(ctx ssh.Context, logger slog.Logger, newChannel gossh.NewChannel, counter *atomic.Int64) gossh.NewChannel

Types

type ChannelOnClose

type ChannelOnClose struct {
	gossh.Channel
	// contains filtered or unexported fields
}

func (*ChannelOnClose) Close

func (c *ChannelOnClose) Close() error

type Config

type Config struct {
	// MaxTimeout sets the absolute connection timeout, none if empty. If set to
	// 3 seconds or more, keep alive will be used instead.
	MaxTimeout time.Duration
	// MOTDFile returns the path to the message of the day file. If set, the
	// file will be displayed to the user upon login.
	MOTDFile func() string
	// ServiceBanner returns the configuration for the Coder service banner.
	ServiceBanner func() *codersdk.ServiceBannerConfig
	// UpdateEnv updates the environment variables for the command to be
	// executed. It can be used to add, modify or replace environment variables.
	UpdateEnv func(current []string) (updated []string, err error)
	// WorkingDirectory sets the working directory for commands and defines
	// where users will land when they connect via SSH. Default is the home
	// directory of the user.
	WorkingDirectory func() string
	// X11SocketDir is the directory where X11 sockets are created. Default is
	// /tmp/.X11-unix.
	X11SocketDir string
}

Config sets configuration parameters for the agent SSH server.

type ConnStats

type ConnStats struct {
	Sessions  int64
	VSCode    int64
	JetBrains int64
}

type JetbrainsChannelWatcher

type JetbrainsChannelWatcher struct {
	gossh.NewChannel
	// contains filtered or unexported fields
}

JetbrainsChannelWatcher is used to track JetBrains port forwarded (Gateway) channels. If the port forward is something other than JetBrains, this struct is a noop.

func (*JetbrainsChannelWatcher) Accept

func (w *JetbrainsChannelWatcher) Accept() (gossh.Channel, <-chan *gossh.Request, error)

type Server

type Server struct {
	// contains filtered or unexported fields
}

func NewServer

func NewServer(ctx context.Context, logger slog.Logger, prometheusRegistry *prometheus.Registry, fs afero.Fs, config *Config) (*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.