autonat

package module
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 3, 2022 License: MIT Imports: 20 Imported by: 22

README

DEPRECATION NOTICE

This package has moved into go-libp2p as a sub-package, github.com/libp2p/go-libp2p/p2p/host/autonat.

go-libp2p-autonat

Discourse posts

Ambient NAT discovery

This package provides an ambient NAT autodiscovery service. It allows peers to figure out their NAT dialability situation by using test dial backs through peers providing the AutoNAT service.

Documentation

See https://godoc.org/github.com/libp2p/go-libp2p-autonat

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

License

MIT

Documentation

Overview

Deprecated: This package has moved into go-libp2p as a sub-package: github.com/libp2p/go-libp2p/p2p/host/autonat.

Index

Constants

View Source 
const AutoNATProto = "/libp2p/autonat/1.0.0"

AutoNATProto identifies the autonat service protocol

Variables

This section is empty.

Functions

func IsDialError 

func IsDialError(e error) bool

IsDialError returns true if the AutoNAT peer signalled an error dialing back

func IsDialRefused 

func IsDialRefused(e error) bool

IsDialRefused returns true if the AutoNAT peer signalled refusal to dial back

Types

type AddrFunc added in v0.2.0 

type AddrFunc func() []ma.Multiaddr

AddrFunc is a function returning the candidate addresses for the local host.

type AmbientAutoNAT 

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

AmbientAutoNAT is the implementation of ambient NAT autodiscovery

func (*AmbientAutoNAT) Close added in v0.5.0 

func (as *AmbientAutoNAT) Close() error

func (*AmbientAutoNAT) ClosedStream 

func (as *AmbientAutoNAT) ClosedStream(net network.Network, s network.Stream)

ClosedStream is part of the network.Notifiee interface

func (*AmbientAutoNAT) Connected 

func (as *AmbientAutoNAT) Connected(net network.Network, c network.Conn)

Connected is part of the network.Notifiee interface

func (*AmbientAutoNAT) Disconnected 

func (as *AmbientAutoNAT) Disconnected(net network.Network, c network.Conn)

Disconnected is part of the network.Notifiee interface

func (*AmbientAutoNAT) Listen 

func (as *AmbientAutoNAT) Listen(net network.Network, a ma.Multiaddr)

Listen is part of the network.Notifiee interface

func (*AmbientAutoNAT) ListenClose 

func (as *AmbientAutoNAT) ListenClose(net network.Network, a ma.Multiaddr)

ListenClose is part of the network.Notifiee interface

func (*AmbientAutoNAT) OpenedStream 

func (as *AmbientAutoNAT) OpenedStream(net network.Network, s network.Stream)

OpenedStream is part of the network.Notifiee interface

func (*AmbientAutoNAT) PublicAddr 

func (as *AmbientAutoNAT) PublicAddr() (ma.Multiaddr, error)

PublicAddr returns the publicly connectable Multiaddr of this node if one is known.

func (*AmbientAutoNAT) Status 

func (as *AmbientAutoNAT) Status() network.Reachability

Status returns the AutoNAT observed reachability status.

type AutoNAT 

type AutoNAT interface {
	// Status returns the current NAT status
	Status() network.Reachability
	// PublicAddr returns the public dial address when NAT status is public and an
	// error otherwise
	PublicAddr() (ma.Multiaddr, error)
	io.Closer
}

AutoNAT is the interface for NAT autodiscovery

func New added in v0.2.0 

func New(h host.Host, options ...Option) (AutoNAT, error)

New creates a new NAT autodiscovery system attached to a host

type Client added in v0.2.0 

type Client interface {
	// DialBack requests from a peer providing AutoNAT services to test dial back
	// and report the address on a successful connection.
	DialBack(ctx context.Context, p peer.ID) (ma.Multiaddr, error)
}

Client is a stateless client interface to AutoNAT peers

func NewAutoNATClient 

func NewAutoNATClient(h host.Host, addrFunc AddrFunc) Client

NewAutoNATClient creates a fresh instance of an AutoNATClient If addrFunc is nil, h.Addrs will be used

type Error added in v0.2.3 

type Error struct {
	Status pb.Message_ResponseStatus
	Text   string
}

Error wraps errors signalled by AutoNAT services

func (Error) Error added in v0.2.3 

func (e Error) Error() string

func (Error) IsDialError added in v0.2.3 

func (e Error) IsDialError() bool

IsDialError returns true if the error was due to a dial back failure

func (Error) IsDialRefused added in v0.2.3 

func (e Error) IsDialRefused() bool

IsDialRefused returns true if the error was due to a refusal to dial back

type Option added in v0.2.0 

type Option func(*config) error

Option is an Autonat option for configuration

func EnableService added in v0.2.0 

func EnableService(dialer network.Network) Option

EnableService specifies that AutoNAT should be allowed to run a NAT service to help other peers determine their own NAT status. The provided Network should not be the default network/dialer of the host passed to `New`, as the NAT system will need to make parallel connections, and as such will modify both the associated peerstore and terminate connections of this dialer. The dialer provided should be compatible (TCP/UDP) however with the transports of the libp2p network.

func UsingAddresses added in v0.2.0 

func UsingAddresses(addrFunc AddrFunc) Option

UsingAddresses allows overriding which Addresses the AutoNAT client believes are "its own". Useful for testing, or for more exotic port-forwarding scenarios where the host may be listening on different ports than it wants to externally advertise or verify connectability on.

func WithPeerThrottling added in v0.2.0 

func WithPeerThrottling(amount int) Option

WithPeerThrottling specifies a limit for the maximum number of IP checks this node will provide to an individual peer in each `interval`.

func WithReachability added in v0.2.0 

func WithReachability(reachability network.Reachability) Option

WithReachability overrides autonat to simply report an over-ridden reachability status.

func WithSchedule added in v0.2.0 

func WithSchedule(retryInterval, refreshInterval time.Duration) Option

WithSchedule configures how agressively probes will be made to verify the address of the host. retryInterval indicates how often probes should be made when the host lacks confident about its address, while refresh interval is the schedule of periodic probes when the host believes it knows its steady-state reachability.

func WithThrottling added in v0.2.0 

func WithThrottling(amount int, interval time.Duration) Option

WithThrottling specifies how many peers (`amount`) it is willing to help ever `interval` amount of time when acting as a server.

func WithoutStartupDelay added in v0.2.0 

func WithoutStartupDelay() Option

WithoutStartupDelay removes the initial delay the NAT subsystem typically uses as a buffer for ensuring that connectivity and guesses as to the hosts local interfaces have settled down during startup.

func WithoutThrottling added in v0.2.0 

func WithoutThrottling() Option

WithoutThrottling indicates that this autonat service should not place restrictions on how many peers it is willing to help when acting as a server.

type StaticAutoNAT added in v0.2.0 

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

StaticAutoNAT is a simple AutoNAT implementation when a single NAT status is desired.

func (*StaticAutoNAT) Close added in v0.5.0 

func (s *StaticAutoNAT) Close() error

func (*StaticAutoNAT) PublicAddr added in v0.2.0 

func (s *StaticAutoNAT) PublicAddr() (ma.Multiaddr, error)

PublicAddr returns the publicly connectable Multiaddr of this node if one is known.

func (*StaticAutoNAT) Status added in v0.2.0 

func (s *StaticAutoNAT) Status() network.Reachability

Status returns the AutoNAT observed reachability status.

Source Files

View all Source files

Directories

Path Synopsis
test module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.