Thanks to visit codestin.com
Credit goes to pkg.go.dev

agentssh

package
v2.21.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 29, 2025 License: AGPL-3.0 Imports: 40 Imported by: 1

Documentation

Index

Constants

View Source
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

	// MagicProcessCmdlineJetBrains is a string in a process's command line that
	// uniquely identifies it as JetBrains software.
	MagicProcessCmdlineJetBrains = "idea.vendor.name=JetBrains"

	// BlockedFileTransferErrorCode indicates that SSH server restricted the raw command from performing
	// the file transfer.
	BlockedFileTransferErrorCode    = 65 // Error code: host not allowed to connect
	BlockedFileTransferErrorMessage = "File transfer has been disabled."
)
View Source
const (
	// 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"
	// ContainerEnvironmentVariable is used to specify the target container for an SSH connection.
	// This is stripped from any commands being executed.
	// Only available if CODER_AGENT_DEVCONTAINERS_ENABLE=true.
	ContainerEnvironmentVariable = "CODER_CONTAINER"
	// ContainerUserEnvironmentVariable is used to specify the container user for
	// an SSH connection.
	// Only available if CODER_AGENT_DEVCONTAINERS_ENABLE=true.
	ContainerUserEnvironmentVariable = "CODER_CONTAINER_USER"
)
View Source
const (
	// X11StartPort is the starting port for X11 forwarding, this is the
	// port used for "DISPLAY=localhost:0".
	X11StartPort = 6000
	// X11DefaultDisplayOffset is the default offset for X11 forwarding.
	X11DefaultDisplayOffset = 10
)

Variables

View Source
var BlockedFileTransferCommands = []string{"nc", "rsync", "scp", "sftp"}

BlockedFileTransferCommands contains a list of restricted file transfer commands.

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 CoderSigner added in v2.20.0

func CoderSigner(seed int64) (gossh.Signer, error)

CoderSigner generates a deterministic SSH signer based on the provided seed. It uses RSA with a key size of 2048 bits.

func NewJetbrainsChannelWatcher added in v2.5.0

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

Types

type ChannelOnClose added in v2.5.0

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

func (*ChannelOnClose) Close added in v2.5.0

func (c *ChannelOnClose) Close() error

type Config added in v2.9.0

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.
	AnnouncementBanners func() *[]codersdk.BannerConfig
	// 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
	// X11DisplayOffset is the offset to add to the X11 display number.
	// Default is 10.
	X11DisplayOffset *int
	// BlockFileTransfer restricts use of file transfer applications.
	BlockFileTransfer bool
	// ReportConnection.
	ReportConnection reportConnectionFunc
	// Experimental: allow connecting to running containers if
	// CODER_AGENT_DEVCONTAINERS_ENABLE=true.
	ExperimentalDevContainersEnabled bool
}

Config sets configuration parameters for the agent SSH server.

type ConnStats

type ConnStats struct {
	Sessions  int64
	VSCode    int64
	JetBrains int64
}

type JetbrainsChannelWatcher added in v2.5.0

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 added in v2.5.0

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

type MagicSessionType added in v2.20.0

type MagicSessionType string

MagicSessionType is a type that represents the type of session that is being established.

const (
	// MagicSessionTypeUnknown means the session type could not be determined.
	MagicSessionTypeUnknown MagicSessionType = "unknown"
	// MagicSessionTypeSSH is the default session type.
	MagicSessionTypeSSH MagicSessionType = "ssh"
	// MagicSessionTypeVSCode is set in the SSH config by the VS Code extension to identify itself.
	MagicSessionTypeVSCode MagicSessionType = "vscode"
	// MagicSessionTypeJetBrains is set in the SSH config by the JetBrains
	// extension to identify itself.
	MagicSessionTypeJetBrains MagicSessionType = "jetbrains"
)

MagicSessionType enums.

type Server

type Server struct {
	Execer agentexec.Execer
	// contains filtered or unexported fields
}

func NewServer

func NewServer(ctx context.Context, logger slog.Logger, prometheusRegistry *prometheus.Registry, fs afero.Fs, execer agentexec.Execer, 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, ei usershell.EnvInfoer) (*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. The final argument is an interface that allows the caller to provide alternative implementations for the dependencies of CreateCommand. This is useful when creating a command to be run in a separate environment (for example, a Docker container). Pass in nil to use the default.

func (*Server) Serve

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

Serve starts the server to handle incoming connections on the provided listener. It returns an error if no host keys are set or if there is an issue accepting connections.

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.

func (*Server) UpdateHostSigner added in v2.20.0

func (s *Server) UpdateHostSigner(seed int64) error

UpdateHostSigner updates the host signer with a new key generated from the provided seed. If an existing host key exists with the same algorithm, it is overwritten

Jump to

Keyboard shortcuts

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