README
¶
ContainerSSH Security Library
This library provides a security overlay for the sshserver library.
⚠⚠⚠ Warning: This is a developer documentation. ⚠⚠⚠
The user documentation for ContainerSSH is located at containerssh.io.
Using this library
This library is intended as a tie-in to an existing module and does not implement a full SSH backend. Instead, you can use the New() function to create a network connection handler with an appropriate backend:
security, err := security.New(
config,
backend
)
The backend should implement the sshserver.NetworkConnectionHandler interface from the sshserver library. For the details of the configuration structure please see config.go.
Documentation
¶
Index ¶
- func New(config config.SecurityConfig, backend sshserver.NetworkConnectionHandler, ...) (sshserver.NetworkConnectionHandler, error)
- type ErrTooManySessions
- func (e *ErrTooManySessions) Code() string
- func (e *ErrTooManySessions) Error() string
- func (e *ErrTooManySessions) Explanation() string
- func (e *ErrTooManySessions) Label(name message.LabelName, value message.LabelValue) message.Message
- func (e *ErrTooManySessions) Labels() message.Labels
- func (e *ErrTooManySessions) Message() string
- func (e *ErrTooManySessions) Reason() ssh.RejectionReason
- func (e *ErrTooManySessions) String() string
- func (e *ErrTooManySessions) UserMessage() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func New ¶
func New( config config.SecurityConfig, backend sshserver.NetworkConnectionHandler, logger log.Logger, ) (sshserver.NetworkConnectionHandler, error)
New creates a new security backend proxy.
Types ¶
type ErrTooManySessions ¶
type ErrTooManySessions struct {
// contains filtered or unexported fields
}
ErrTooManySessions indicates that too many sessions were opened in the same connection.
func (*ErrTooManySessions) Code ¶
func (e *ErrTooManySessions) Code() string
Code returns the error code.
func (*ErrTooManySessions) Error ¶
func (e *ErrTooManySessions) Error() string
Error contains the error for the logs.
func (*ErrTooManySessions) Explanation ¶
func (e *ErrTooManySessions) Explanation() string
Explanation is the message intended for the administrator.
func (*ErrTooManySessions) Label ¶
func (e *ErrTooManySessions) Label(name message.LabelName, value message.LabelValue) message.Message
Label adds a label to the message.
func (*ErrTooManySessions) Labels ¶
func (e *ErrTooManySessions) Labels() message.Labels
Labels returns the list of labels for this message.
func (*ErrTooManySessions) Message ¶
func (e *ErrTooManySessions) Message() string
Message contains a message intended for the user.
func (*ErrTooManySessions) Reason ¶
func (e *ErrTooManySessions) Reason() ssh.RejectionReason
Reason contains the rejection code.
func (*ErrTooManySessions) String ¶
func (e *ErrTooManySessions) String() string
String returns the string representation of this message.
func (*ErrTooManySessions) UserMessage ¶
func (e *ErrTooManySessions) UserMessage() string
UserMessage contains a message intended for the user.
Source Files