handshake

package

v0.1.0 Latest Latest Go to latest Published: Aug 3, 2021 License: BSD-3-Clause Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/newswarm-lab/new-bee

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type AdvertisableAddressResolver
type Info
- func (i *Info) LightString() string
type SenderMatcher
type Service
- func New(signer crypto.Signer, advertisableAddresser AdvertisableAddressResolver, ...) (*Service, error)

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 = "4.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")

	// ErrHandshakeDuplicate is returned  if the handshake response has been received by an already processed peer.
	ErrHandshakeDuplicate = errors.New("duplicate handshake")

	// 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)
)

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 ¶

func (i *Info) LightString() string

type SenderMatcher ¶

type SenderMatcher interface {
	Matches(ctx context.Context, tx []byte, networkID uint64, senderOverlay swarm.Address) ([]byte, error)
}

type Service ¶

type Service struct {
	network.Notifiee // handshake service can be the receiver for network.Notify
	// contains filtered or unexported fields
}

Service can perform initiate or handle a handshake between peers.

func New ¶

func New(signer crypto.Signer, advertisableAddresser AdvertisableAddressResolver, isSender SenderMatcher, overlay swarm.Address, networkID uint64, fullNode bool, transaction []byte, welcomeMessage string, logger logging.Logger) (*Service, error)

New creates a new handshake Service.

func (*Service) Disconnected ¶

func (s *Service) Disconnected(_ network.Network, c network.Conn)

Disconnected is called when the peer disconnects.

func (*Service) GetWelcomeMessage ¶

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) SetWelcomeMessage ¶

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

SetWelcomeMessage sets the new handshake welcome message.

Source Files ¶

View all Source files

handshake.go

Directories ¶

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

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL