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

• func ServeFile(path string)
• func ServeFileWithConfig(conf FileServerConfig)
• func ServeFileWithToken(token string, path string)
• type Config
• type FileServerConfig
• 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

Functions

func ServeFile

func ServeFile(path string)

func ServeFileWithConfig

func ServeFileWithConfig(conf FileServerConfig)

func ServeFileWithToken

func ServeFileWithToken(token string, path string)

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

	/*
		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
	// contains filtered or unexported fields
}

type FileServerConfig

type FileServerConfig struct {
	Conf            Config
	Path            string
	WebDebugEnabled bool
	WebDebugPort    int
}

type PinggyListener

type PinggyListener interface {
	net.Listener
	/*
		Return the remote urls to access the tunnels.
	*/
	RemoteUrls() []string
	/*
		Start webdebugger. This can not be call multiple time. Once the debugger started, it cannot be closed.
		Also, the debugger is not available in case of `tls` and `tcp` tunnel
	*/
	InitiateWebDebug(addr string) 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"
)