knock

Documentation

Index

• Constants
• Variables
• func BuildKnock(other types.PeerID, self types.PeerID, secretKey ed25519.PrivateKey) []byte
• func VerifyKnock(self types.PeerID, knock []byte) (*types.PeerID, error)

Constants

const KnockSize = 1 + ed25519.PublicKeySize + ed25519.SignatureSize

knock = version (1 byte) || pk (ed25519.PublicKeySize) || sig (ed25519.SignatureSize)

Variables

var (
	ErrSizeMismatch     = fmt.Errorf("knock size mismatch")
	ErrFromSelfDial     = fmt.Errorf("knock from self-dial")
	ErrInvalidSignature = fmt.Errorf("knock has invalid signature")
)

Functions

func BuildKnock

func BuildKnock(other types.PeerID, self types.PeerID, secretKey ed25519.PrivateKey) []byte

Builds a knock message based on the PeerID of the node being dialed (other), the dialing node (self). The dialing node's secretKey is used for signing the message and must correspond to self.

Returns a knock message exactly KnockSize bytes long.

func VerifyKnock

func VerifyKnock(self types.PeerID, knock []byte) (*types.PeerID, error)

Verifies a knock message allegedly destined to self. If the message is valid, returns the PeerId of the sender. Otherwise returns nil and an error.