pinggy

README

Pinggy

Pinggy provides tunneling service over ssh. It provides different types of tunnel. This module provides a easy API for Pinggy.

This module is essentially a wrapper over golang.org/x/crypto/ssh. However, it makes tunnel creation as simple as

listener, _ := pinggy.Connect()

The sdk exposes multiple helpfull APIs. It allows users to use the special feature sshOverSsl.

Documentation

Index

• type Config
• type PinggyListener
  • func Connect() (PinggyListener, error)
  • func ConnectTcp(token string) (PinggyListener, error)
  • func ConnectTls(token string) (PinggyListener, error)
  • func ConnectToken(token string) (PinggyListener, error)
  • func ConnectWithConfig(conf Config) (PinggyListener, error)
• type TunnelType

Types

type Config

type Config struct {
	/*
		Token is a string. It identify an user. You can find a token at the https://dashboard.pinggy.io.
		Token is required to connect in TCP and TLS tunnel.
	*/
	Token string
	/*
		Tunnel type. It can be one of TCP or TLS or HTTP
	*/
	Type TunnelType

	/*
		This module log several thing. We use the Logger for this task. If Logger is `nil`, we use the default Logger.
	*/
	Logger *log.Logger

	/*
		Pinggy supports ssh over ssl when user is behind a firewall which does not allow anything but ssl.
		Simply enable this flag and this package would take care of this problem.
	*/
	SshOverSsl bool
	/*
		Pinggy server to connect to. Default value `a.pinggy.io`.
		Users are discouraged to use this.
	*/
	Server string
	// contains filtered or unexported fields
}

type PinggyListener

type PinggyListener interface {
	net.Listener

	RemoteUrls() []string

	InitiateWebDebug(addr string) error

	/*
	 */
	StartShell() error

	/*
		Start a webserver.
	*/
	ServeHttp(handler http.Handler) error

	/*
		Start a web server and serve file.
	*/
	ServerFileOverHttp(fs http.FileSystem) error

	Error
}

func Connect

func Connect() (PinggyListener, error)

func ConnectTcp

func ConnectTcp(token string) (PinggyListener, error)

func ConnectTls

func ConnectTls(token string) (PinggyListener, error)

func ConnectToken

func ConnectToken(token string) (PinggyListener, error)

func ConnectWithConfig

func ConnectWithConfig(conf Config) (PinggyListener, error)

type TunnelType

type TunnelType string

const (
	TCP    TunnelType = "tcp"
	TLS    TunnelType = "tls"
	HTTP   TunnelType = "http"
	TLSTCP TunnelType = "tlstcp"
)