identity

Documentation

Index

• type Handshaker
• type Result

Types

type Handshaker

type Handshaker interface {
	// Execute executes the handshake with a context.
	// Returning an error cancels the attempt.
	Execute(ctx context.Context) (*Result, error)
	// Handle handles an incoming packet.
	// The buffer will be re-used after the func returns.
	// Returns if we expect more handshake packets.
	Handle(data []byte) bool
	// Close cleans up any resources allocated by the handshake.
	Close()
}

Handshaker performs an identity handshake.

type Result

type Result struct {
	// Secret is the negotiated secret.
	Secret [32]byte
	// Peer is the public key of the remote peer.
	Peer crypto.PubKey
	// ExtraData is the extra data the remote peer sent.
	ExtraData []byte
}

Result is the outcome of the handshake.