backend

README

ContainerSSH Backend Library

This library handles SSH requests and routes them to a container or other backends.

Note: This is a developer documentation.
The user documentation for ContainerSSH is located at containerssh.github.io.

Using this library

This library can be used in conjunction with the sshserver to route SSH connections to containers.

You can create a new backend handler like this:

handler, err := backend.New(
    config,
    logger,
    loggerFactory,
    authBehavior,
)

This method accepts the following parameters:

config : The AppConfig struct from the configuration library. This is needed because this library performs a call to the config server if configured to fetch a connection-specific information.

logger : This variable is a logger from the log library.

loggerFactory : This is a logger factory used by the backend to create a logger for the instantiated backends after fetching the connection-specific configuration.

authBehavior : This variable can contain one of sshserver.AuthResponseSuccess, sshserver.AuthResponseFailure, or sshserver.AuthResponseUnavailable to indicate how the backend should react to authenticatio requests. Normally, this can be set to sshserver.AuthResponseUnavailable since the auth integration library will take care of the authentication.

The handler can be passed to the sshserver or to another overlay as a backend, for example auth integration.

Documentation

Index

• Constants
• func New(config configuration.AppConfig, logger log.Logger, ...) (sshserver.Handler, error)

Constants

const MetricHelpBackendError = "The number of failed requests to the backend."

MetricHelpBackendError is the help text of backend errors

const MetricHelpBackendRequests = "The number of requests to the backend."

MetricHelpBackendError is the help text of backend errors

const MetricLabelBackend = "backend"

MetricLabelBackend is the name for the backend label

const MetricNameBackendError = "containerssh_backend_errors"

MetricNameBackendError is the number of errors in the backend

const MetricNameBackendRequests = "containerssh_backend_requests"

MetricNameBackendError is the number of errors in the backend

const MetricUnitBackendError = "requests"

MetricUnitBackendError is the unit of backend errors

const MetricUnitBackendRequests = "requests"

MetricUnitBackendError is the unit of backend errors

Functions

func New

func New(
	config configuration.AppConfig,
	logger log.Logger,
	loggerFactory log.LoggerFactory,
	metricsCollector metrics.Collector,
	defaultAuthResponse sshserver.AuthResponse,
) (sshserver.Handler, error)

New creates a new backend handler.