corprelayv4

Documentation

Overview

Package corprelayv4 implements the corp-relay-v4@google.com protocol, see https://chromium.googlesource.com/apps/libapps/+/HEAD/nassh/doc/relay-protocol.md#corp-relay-v4.

Index

• Variables
• type Session
  • func New(ssh io.ReadWriteCloser, role session.Role) *Session
  • func (s *Session) Close() error
  • func (s *Session) Done() <-chan struct{}
  • func (s *Session) Run(ws *websocket.Conn) error
  • func (s *Session) SID() uuid.UUID
  • func (s Session) String() string
  • func (s *Session) Version() session.ProtocolVersion

Variables

var (
	// ErrInvalidSession is returned when a session is in an invalid state.
	ErrInvalidSession = errors.New("invalid session")
)

Types

type Session

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

A Session is a V4 SSH-over-Websocket Relay session. TODO: Implement reconnect logic.

func New

func New(ssh io.ReadWriteCloser, role session.Role) *Session

New creates a *Session from a given SSH connection.

func (*Session) Close

func (s *Session) Close() error

Close closes the SSH connection, causing the Session to be invalid.

func (*Session) Done

func (s *Session) Done() <-chan struct{}

Done notifies when a session has terminated.

func (*Session) Run

func (s *Session) Run(ws *websocket.Conn) error

Run starts a new session between the WebSocket and SSH connections.

func (*Session) SID

func (s *Session) SID() uuid.UUID

SID returns the Session ID.

func (Session) String

func (s Session) String() string

func (*Session) Version

func (s *Session) Version() session.ProtocolVersion

Version returns the protocol version in use for the session.