peer

Documentation

Index

• func IsPublicIP(ip net.IP) bool
• func NewConnectionAlreadyClosed(peer string) error
• func NewConnectionClosedError(peer string) error
• func NewConnectionDisconnectedError(peer string) error
• func NewConnectionTimeoutError(peer string, timeout time.Duration) error
• type Conn
  • func NewConn(config ConnConfig, statusRecorder *nbStatus.Status) (*Conn, error)
  • func (conn *Conn) Close() error
  • func (conn *Conn) GetConf() ConnConfig
  • func (conn *Conn) GetKey() string
  • func (conn *Conn) OnRemoteAnswer(answer OfferAnswer) bool
  • func (conn *Conn) OnRemoteCandidate(candidate ice.Candidate)
  • func (conn *Conn) OnRemoteOffer(offer OfferAnswer) bool
  • func (conn *Conn) Open() error
  • func (conn *Conn) SetSignalAnswer(handler func(answer OfferAnswer) error)
  • func (conn *Conn) SetSignalCandidate(handler func(candidate ice.Candidate) error)
  • func (conn *Conn) SetSignalOffer(handler func(offer OfferAnswer) error)
  • func (conn *Conn) Status() ConnStatus
  • func (conn *Conn) UpdateConf(conf ConnConfig)
• type ConnConfig
• type ConnStatus
  • func (s ConnStatus) String() string
• type ConnectionAlreadyClosedError
  • func (e *ConnectionAlreadyClosedError) Error() string
• type ConnectionClosedError
  • func (e *ConnectionClosedError) Error() string
• type ConnectionDisconnectedError
  • func (e *ConnectionDisconnectedError) Error() string
• type ConnectionTimeoutError
  • func (e *ConnectionTimeoutError) Error() string
• type IceCredentials
• type OfferAnswer

Functions

func IsPublicIP

func IsPublicIP(ip net.IP) bool

IsPublicIP indicates whether IP is public or not.

func NewConnectionAlreadyClosed

func NewConnectionAlreadyClosed(peer string) error

NewConnectionAlreadyClosed creates a new ConnectionAlreadyClosedError error

func NewConnectionClosedError

func NewConnectionClosedError(peer string) error

NewConnectionClosedError creates a new ConnectionClosedError error

func NewConnectionDisconnectedError

func NewConnectionDisconnectedError(peer string) error

NewConnectionDisconnectedError creates a new ConnectionDisconnectedError error

func NewConnectionTimeoutError

func NewConnectionTimeoutError(peer string, timeout time.Duration) error

NewConnectionTimeoutError creates a new ConnectionTimeoutError error

Types

type Conn

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

func NewConn

func NewConn(config ConnConfig, statusRecorder *nbStatus.Status) (*Conn, error)

NewConn creates a new not opened Conn to the remote peer. To establish a connection run Conn.Open

func (*Conn) Close

func (conn *Conn) Close() error

Close closes this peer Conn issuing a close event to the Conn closeCh

func (*Conn) GetConf

func (conn *Conn) GetConf() ConnConfig

GetConf returns the connection config

func (*Conn) GetKey

func (conn *Conn) GetKey() string

func (*Conn) OnRemoteAnswer

func (conn *Conn) OnRemoteAnswer(answer OfferAnswer) bool

OnRemoteAnswer handles an offer from the remote peer and returns true if the message was accepted, false otherwise doesn't block, discards the message if connection wasn't ready

func (*Conn) OnRemoteCandidate

func (conn *Conn) OnRemoteCandidate(candidate ice.Candidate)

OnRemoteCandidate Handles ICE connection Candidate provided by the remote peer.

func (*Conn) OnRemoteOffer

func (conn *Conn) OnRemoteOffer(offer OfferAnswer) bool

OnRemoteOffer handles an offer from the remote peer and returns true if the message was accepted, false otherwise doesn't block, discards the message if connection wasn't ready

func (*Conn) Open

func (conn *Conn) Open() error

Open opens connection to the remote peer starting ICE candidate gathering process. Blocks until connection has been closed or connection timeout. ConnStatus will be set accordingly

func (*Conn) SetSignalAnswer

func (conn *Conn) SetSignalAnswer(handler func(answer OfferAnswer) error)

SetSignalAnswer sets a handler function to be triggered by Conn when a new connection answer has to be signalled to the remote peer

func (*Conn) SetSignalCandidate

func (conn *Conn) SetSignalCandidate(handler func(candidate ice.Candidate) error)

SetSignalCandidate sets a handler function to be triggered by Conn when a new ICE local connection candidate has to be signalled to the remote peer

func (*Conn) SetSignalOffer

func (conn *Conn) SetSignalOffer(handler func(offer OfferAnswer) error)

SetSignalOffer sets a handler function to be triggered by Conn when a new connection offer has to be signalled to the remote peer

func (*Conn) Status

func (conn *Conn) Status() ConnStatus

Status returns current status of the Conn

func (*Conn) UpdateConf

func (conn *Conn) UpdateConf(conf ConnConfig)

UpdateConf updates the connection config

type ConnConfig

type ConnConfig struct {

	// Key is a public key of a remote peer
	Key string
	// LocalKey is a public key of a local peer
	LocalKey string

	// StunTurn is a list of STUN and TURN URLs
	StunTurn []*ice.URL

	// InterfaceBlackList is a list of machine interfaces that should be filtered out by ICE Candidate gathering
	// (e.g. if eth0 is in the list, host candidate of this interface won't be used)
	InterfaceBlackList []string

	Timeout time.Duration

	ProxyConfig proxy.Config

	UDPMux      ice.UDPMux
	UDPMuxSrflx ice.UniversalUDPMux

	LocalWgPort int
}

ConnConfig is a peer Connection configuration

type ConnStatus

type ConnStatus int

const (
	StatusConnected ConnStatus = iota
	StatusConnecting
	StatusDisconnected
)

func (ConnStatus) String

func (s ConnStatus) String() string

type ConnectionAlreadyClosedError

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

ConnectionAlreadyClosedError is an error indicating that a peer Conn has been already closed and the invocation of the Close() method has been performed over a closed connection

func (*ConnectionAlreadyClosedError) Error

func (e *ConnectionAlreadyClosedError) Error() string

type ConnectionClosedError

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

ConnectionClosedError is an error indicating that a peer Conn has been forcefully closed

func (*ConnectionClosedError) Error

func (e *ConnectionClosedError) Error() string

type ConnectionDisconnectedError

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

ConnectionDisconnectedError is an error indicating that a peer Conn has ctx from the remote

func (*ConnectionDisconnectedError) Error

func (e *ConnectionDisconnectedError) Error() string

type ConnectionTimeoutError

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

ConnectionTimeoutError is an error indicating that a peer Conn has been timed out

func (*ConnectionTimeoutError) Error

func (e *ConnectionTimeoutError) Error() string

type IceCredentials

type IceCredentials struct {
	UFrag string
	Pwd   string
}

IceCredentials ICE protocol credentials struct

type OfferAnswer

type OfferAnswer struct {
	IceCredentials IceCredentials
	// WgListenPort is a remote WireGuard listen port.
	// This field is used when establishing a direct WireGuard connection without any proxy.
	// We can set the remote peer's endpoint with this port.
	WgListenPort int

	// Version of NetBird Agent
	Version string
}

OfferAnswer represents a session establishment offer or answer