noisysockets

README

Noisy Sockets

Noisy Sockets is a secure service-to-service communications library based on the Noise Protocol Framework. Endpoints are identified by Curve25519 public keys, traffic is encrypted and authenticated using ChaCha20-Poly1305, and sent/received as UDP packets. Noisy Sockets is wire compatible with WireGuard.

Noisy Sockets implements a drop-in replacement for the Go net package, allowing it to be used with any existing code. This is implemented using a userspace TCP/IP stack based on Netstack from the gVisor project.

Usage

Examples of how to use Noisy Sockets can be found in the examples directory.

Performance

Surprisingly decent, I've been able to saturate a 1Gbps link with approximately two CPU cores and a single noisy socket. Interestingly it appears to outperform the kernel implementation of WireGuard.

Some preliminary benchmark results can be found in the benchmarks respository.

Credits

Noisy Sockets is based on code originally from the wireguard-go project by Jason A. Donenfeld.

WireGuard is a registered trademark of Jason A. Donenfeld.

Documentation

Index

• Variables
• type NoisySocketsNetwork
  • func OpenNetwork(logger *slog.Logger, conf *latestconfig.Config) (*NoisySocketsNetwork, error)
  • func (net *NoisySocketsNetwork) AddPeer(peerConf latestconfig.PeerConfig) error
  • func (net *NoisySocketsNetwork) AddRoute(routeConf *latestconfig.RouteConfig) error
  • func (net *NoisySocketsNetwork) Close() error
  • func (net *NoisySocketsNetwork) RemovePeer(publicKey types.NoisePublicKey) error

Variables

var (
	ErrUnknownPeer = errors.New("unknown peer")
)

Types

type NoisySocketsNetwork

type NoisySocketsNetwork struct {
	*network.UserspaceNetwork
	// contains filtered or unexported fields
}

NoisySocketsNetwork is a wrapper around a userspace WireGuard peer.

func OpenNetwork

func OpenNetwork(logger *slog.Logger, conf *latestconfig.Config) (*NoisySocketsNetwork, error)

OpenNetwork creates a new network using the provided configuration. The returned network is a userspace WireGuard peer that exposes Dial() and Listen() methods compatible with the net package.

func (*NoisySocketsNetwork) AddPeer

func (net *NoisySocketsNetwork) AddPeer(peerConf latestconfig.PeerConfig) error

AddPeer adds a wireguard peer to the network.

func (*NoisySocketsNetwork) AddRoute

func (net *NoisySocketsNetwork) AddRoute(routeConf *latestconfig.RouteConfig) error

AddRoute adds a route to the network.

func (*NoisySocketsNetwork) Close

func (net *NoisySocketsNetwork) Close() error

Close closes the network.

func (*NoisySocketsNetwork) RemovePeer

func (net *NoisySocketsNetwork) RemovePeer(publicKey types.NoisePublicKey) error

RemovePeer removes a wireguard peer from the network.