p2pforwarder

README

P2P Forwarder

A tool for farwarding ports. Made using libp2p.

How it works

• A: opens desired ports ports inside P2P Forwarder
• A: shares it's id from P2P Forwarder with B
• B: connects to A's id inside P2P Forwarder
• B: connect to opened ports on A's machine using address like 127.0.89.N:PORT_ON_A's_MACHINE

P.S. every edit field handles Ctrl+C and Ctrl+V. To exit the program, press Ctrl+Q

Project status

Project is on early beta stage. I recommend you to use it only for personal purposes like playing Minecraft with friends.

Current uis are cli and tui (clui).

Feel free to contribute to this project by opening an issue (it may be a question) or creating a pull request

Star this project if you liked it or found it useful for you :3

Documentation

Index

• Variables
• func OnError(fn func(error))
• func OnInfo(fn func(string))
• type Forwarder
  • func NewForwarder() (*Forwarder, context.CancelFunc, error)
  • func (f *Forwarder) Connect(id string) (listenip string, cancel context.CancelFunc, err error)
  • func (f *Forwarder) ID() string
  • func (f *Forwarder) OpenPort(networkType string, port uint16) (cancel func(), err error)

Variables

var (
	// ErrMaxConnections = error "Max connections reached"
	ErrMaxConnections = errors.New("Max connections reached")
	// ErrPortAlreadyOpened = error "Port already opened"
	ErrPortAlreadyOpened = errors.New("Port already opened")
	// ErrUnknownNetworkType = error "Unknown network type, it must be \"tcp\" or \"udp\""
	ErrUnknownNetworkType = errors.New("Unknown network type, it must be \"tcp\" or \"udp\"")
	// ErrConnectionExists = error "You are already connected to specified host"
	ErrConnectionExists = errors.New("You are already connected to specified host")
)

var ErrConnReset = errors.New("Connection reset")

ErrConnReset = error Connection reset

Functions

func OnError

func OnError(fn func(error))

OnError sets function which be called on error inside this package

func OnInfo

func OnInfo(fn func(string))

OnInfo sets function which be called on information inside this package

Types

type Forwarder

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

Forwarder - instance of P2P Forwarder

func NewForwarder

func NewForwarder() (*Forwarder, context.CancelFunc, error)

NewForwarder - instances Forwarder and connects it to libp2p network

func (*Forwarder) Connect

func (f *Forwarder) Connect(id string) (listenip string, cancel context.CancelFunc, err error)

Connect starts forwarding connections to `listenip`:`PORT` to passed id`:`PORT`

func (*Forwarder) ID

func (f *Forwarder) ID() string

ID returns id of Forwarder

func (*Forwarder) OpenPort

func (f *Forwarder) OpenPort(networkType string, port uint16) (cancel func(), err error)

OpenPort opens port in specified networkType - "tcp" or "udp"