sshtest

README

go-sshtest

This code must helps you to test your ssh client.

Documentation

Index

• Constants
• func DebugOff()
• func DebugOn()
• func NewRSAKey(bitSize int) *rsa.PrivateKey
• func NewSSHKeyPair(bitSize int) (private *rsa.PrivateKey, public ssh.PublicKey)
• type Channel
  • func NewChannel(channel ssh.NewChannel, mockData *MockData) *Channel
  • func (s *Channel) Requests() []interface{}
• type ChannelStat
• type Connection
  • func NewConnection(conn net.Conn, mockData *MockData) *Connection
  • func (s *Connection) ServedChannels() []*Channel
• type ConnectionStat
• type MockData
  • func NewMockData() *MockData
  • func (m *MockData) MockExecResult(command, result string, timeout time.Duration, exitStatus uint32)
• type Server
  • func NewMockedServer() (server *Server)
  • func NewServer(listenAddr string, serverKey ssh.Signer) (server *Server)
  • func (s *Server) AddAuthorizedKey(key ssh.PublicKey)
  • func (s *Server) ServedConnections() []*Connection
  • func (s *Server) Start() (address string, port uint16, err error)
  • func (s *Server) Stop()
  • func (s *Server) Wait()

Examples

• NewSSHKeyPair

Constants

const (
	ServerVersion = "SSH-2.0-ServerMock 1.0"
)

Functions

func DebugOff

func DebugOff()

func DebugOn

func DebugOn()

func NewRSAKey

func NewRSAKey(bitSize int) *rsa.PrivateKey

func NewSSHKeyPair

func NewSSHKeyPair(bitSize int) (private *rsa.PrivateKey, public ssh.PublicKey)

NewSSHKeyPair generate new key pair

Example

// prepare keys
privateKey, publicKey := sshtest.NewSSHKeyPair(2048)

// auth in your client with agent
myAgent := agent.NewKeyring()
_ = myAgent.Add(agent.AddedKey{PrivateKey: privateKey})
_ = &ssh.ClientConfig{
	Auth: []ssh.AuthMethod{
		ssh.PublicKeysCallback(func() (signers []ssh.Signer, err error) {
			return myAgent.Signers()
		}),
	},
}

// auth in your client with signer from key
signer, _ := ssh.NewSignerFromKey(privateKey)
_ = &ssh.ClientConfig{
	Auth: []ssh.AuthMethod{
		ssh.PublicKeysCallback(func() (signers []ssh.Signer, err error) {
			return []ssh.Signer{signer}, nil
		}),
	},
}

// publicKeyCallback in your server
_ = &ssh.ServerConfig{
	PublicKeyCallback: func(c ssh.ConnMetadata, pubKey ssh.PublicKey) (*ssh.Permissions, error) {
		if string(publicKey.Marshal()) == string(pubKey.Marshal()) {
			return &ssh.Permissions{
				// Record the public key used for authentication.
				Extensions: map[string]string{
					"pubkey-fp": ssh.FingerprintSHA256(pubKey),
				},
			}, nil

		}
		return nil, fmt.Errorf("unknown public key for %q", c.User())
	},
}

Types

type Channel

type Channel struct {
	ssh.Channel
	Type string
	// contains filtered or unexported fields
}

func NewChannel

func NewChannel(channel ssh.NewChannel, mockData *MockData) *Channel

func (*Channel) Requests

func (s *Channel) Requests() []interface{}

type ChannelStat

type ChannelStat struct {
}

type Connection

type Connection struct {
	net.Conn
	ClientConn *ssh.ServerConn
	// contains filtered or unexported fields
}

func NewConnection

func NewConnection(conn net.Conn, mockData *MockData) *Connection

func (*Connection) ServedChannels

func (s *Connection) ServedChannels() []*Channel

type ConnectionStat

type ConnectionStat struct {
}

type MockData

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

func NewMockData

func NewMockData() *MockData

func (*MockData) MockExecResult

func (m *MockData) MockExecResult(command, result string, timeout time.Duration, exitStatus uint32)

type Server

type Server struct {
	// ssh server config
	*ssh.ServerConfig

	*MockData

	// timeout before force disconnect all clients when server is stopping
	StopTimeout time.Duration
	// contains filtered or unexported fields
}

func NewMockedServer

func NewMockedServer() (server *Server)

func NewServer

func NewServer(listenAddr string, serverKey ssh.Signer) (server *Server)

func (*Server) AddAuthorizedKey

func (s *Server) AddAuthorizedKey(key ssh.PublicKey)

func (*Server) ServedConnections

func (s *Server) ServedConnections() []*Connection

func (*Server) Start

func (s *Server) Start() (address string, port uint16, err error)

func (*Server) Stop

func (s *Server) Stop()

func (*Server) Wait

func (s *Server) Wait()