modes

Documentation

Overview

Package mode defines the interfaces used by the server to determine how to handle authentication and sessions.

Index

• type Authenticator
• type Mode
• type Sessioner
• type Subsystemer

Types

type Authenticator

type Authenticator interface {
	// Password must be implemented to deal with password authentication.
	Password(ctx gliderssh.Context, user string, password string) bool
	// PublicKey must be implemented to deal with public key authentication.
	PublicKey(ctx gliderssh.Context, user string, key gliderssh.PublicKey) bool
}

Authenticator defines the authentication methods used by the SSH's server.

type Mode

type Mode string

Mode defines the SSH's server mode type.

const (
	// HostMode represents the SSH's server host mode.
	//
	// HostMode mode means that the SSH's server runs in the host machine, using the host "/etc/passwd", "/etc/shadow",
	// redirecting the SSH's connection to the device sdin, stdout and stderr and etc.
	HostMode Mode = "host"
	// ConnectorMode represents the SSH's server connector mode.
	//
	// ConnectorMode mode means that the SSH's server runs in the host machine, but redirect the IO to a specific docker
	// container, maning its authentication through the container's "/etc/passwd", "/etc/shadow" and etc.
	ConnectorMode Mode = "connector"
)

type Sessioner

type Sessioner interface {
	Subsystemer
	// Shell must be implemented to deal with shell session.
	Shell(session gliderssh.Session) error
	// Heredoc must be implemented to deal with heredoc session.
	//
	// heredoc is special block of code that contains multi-line strings that will be redirected to a stdin of a shell.
	// It request a shell, but doesn't allocate a pty.
	//
	// An example of heredoc is:
	//  cat <<EOF
	//      test123
	//  EOF
	Heredoc(session gliderssh.Session) error
	// Exec must be implemented to deal with exec session.
	Exec(session gliderssh.Session) error
}

Sessioner defines the session methods used by the SSH's server to deal wihth determining the type of session.

type Subsystemer

type Subsystemer interface {
	// SFTP must be implemented to deal with SFTP session.
	SFTP(session gliderssh.Session) error
}

Subsystemer defines the subsystem methods used by the SSH's server to deal with determining the type of subsystem.

Subsystemer is a subset of the Sessioner interface.