handshake

package
v1.18.2 Latest Latest
Warning

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

 Go to latest Published: Dec 14, 2023 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// ProtocolName is the text of the name of the handshake protocol.
	ProtocolName = "handshake"
	// ProtocolVersion is the current handshake protocol version.
	ProtocolVersion = "11.0.0"
	// StreamName is the name of the stream used for handshake purposes.
	StreamName = "handshake"
	// MaxWelcomeMessageLength is maximum number of characters allowed in the welcome message.
	MaxWelcomeMessageLength = 140
)

Variables

View Source 
var (
	// ErrNetworkIDIncompatible is returned if response from the other peer does not have valid networkID.
	ErrNetworkIDIncompatible = errors.New("incompatible network ID")

	// ErrInvalidAck is returned if data in received in ack is not valid (invalid signature for example).
	ErrInvalidAck = errors.New("invalid ack")

	// ErrInvalidSyn is returned if observable address in ack is not a valid..
	ErrInvalidSyn = errors.New("invalid syn")

	// ErrWelcomeMessageLength is returned if the welcome message is longer than the maximum length
	ErrWelcomeMessageLength = fmt.Errorf("handshake welcome message longer than maximum of %d characters", MaxWelcomeMessageLength)

	// ErrPicker is returned if the picker (kademlia) rejects the peer
	ErrPicker = errors.New("picker rejection")
)

Functions

This section is empty.

Types

type AdvertisableAddressResolver 

type AdvertisableAddressResolver interface {
	Resolve(observedAddress ma.Multiaddr) (ma.Multiaddr, error)
}

AdvertisableAddressResolver can Resolve a Multiaddress.

type Info 

type Info struct {
	BzzAddress *bzz.Address
	FullNode   bool
}

Info contains the information received from the handshake.

func (*Info) LightString added in v0.6.0 

func (i *Info) LightString() string

type Service 

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

Service can perform initiate or handle a handshake between peers.

func New 

func New(signer crypto.Signer, advertisableAddresser AdvertisableAddressResolver, overlay swarm.Address, networkID uint64, fullNode bool, nonce []byte, welcomeMessage string, validateOverlay bool, ownPeerID libp2ppeer.ID, logger log.Logger) (*Service, error)

New creates a new handshake Service.

func (*Service) GetWelcomeMessage added in v0.2.0 

func (s *Service) GetWelcomeMessage() string

GetWelcomeMessage returns the the current handshake welcome message.

func (*Service) Handle 

func (s *Service) Handle(ctx context.Context, stream p2p.Stream, remoteMultiaddr ma.Multiaddr, remotePeerID libp2ppeer.ID) (i *Info, err error)

Handle handles an incoming handshake from a peer.

func (*Service) Handshake 

func (s *Service) Handshake(ctx context.Context, stream p2p.Stream, peerMultiaddr ma.Multiaddr, peerID libp2ppeer.ID) (i *Info, err error)

Handshake initiates a handshake with a peer.

func (*Service) Metrics added in v1.2.0 

func (s *Service) Metrics() []prometheus.Collector

Metrics returns set of prometheus collectors.

func (*Service) SetPicker added in v1.2.0 

func (s *Service) SetPicker(n p2p.Picker)

func (*Service) SetWelcomeMessage added in v0.2.0 

func (s *Service) SetWelcomeMessage(msg string) (err error)

SetWelcomeMessage sets the new handshake welcome message.

Source Files

View all Source files

Directories

Path Synopsis
Package pb holds only Protocol Buffer definitions and generated code.
 Package pb holds only Protocol Buffer definitions and generated code.

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.