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
• func OpenNetwork(logger *slog.Logger, conf *latestconfig.Config) (network.Network, error)
• type Addr
  • func (a *Addr) PublicKey() types.NoisePublicKey
• type Conn
  • func (c *Conn) RemoteAddr() stdnet.Addr
• type NoisySocketsNetwork
  • func (net *NoisySocketsNetwork) AddPeer(peerConf latestconfig.PeerConfig) error
  • func (net *NoisySocketsNetwork) AddRoute(destination netip.Prefix, viaPeerName string) error
  • func (net *NoisySocketsNetwork) Close() error
  • func (net *NoisySocketsNetwork) Dial(network, address string) (stdnet.Conn, error)
  • func (net *NoisySocketsNetwork) DialContext(ctx context.Context, network, address string) (stdnet.Conn, error)
  • func (net *NoisySocketsNetwork) GetPeer(publicKey types.NoisePublicKey) (*Peer, bool)
  • func (net *NoisySocketsNetwork) HasIPv4() bool
  • func (net *NoisySocketsNetwork) HasIPv6() bool
  • func (net *NoisySocketsNetwork) Hostname() (string, error)
  • func (net *NoisySocketsNetwork) ListPeers() []types.NoisePublicKey
  • func (net *NoisySocketsNetwork) Listen(network, address string) (stdnet.Listener, error)
  • func (net *NoisySocketsNetwork) ListenPacket(network, address string) (stdnet.PacketConn, error)
  • func (net *NoisySocketsNetwork) LookupHost(host string) ([]string, error)
  • func (net *NoisySocketsNetwork) RemovePeer(publicKey types.NoisePublicKey) error
  • func (net *NoisySocketsNetwork) RemoveRoute(destination netip.Prefix) error
• type Peer
  • func (p *Peer) AddAddresses(addrs ...netip.Addr)
  • func (p *Peer) AddDestinationPrefixes(prefixes ...netip.Prefix)
  • func (p *Peer) Addresses() []netip.Addr
  • func (p *Peer) DestinationForPrefixes() []netip.Prefix
  • func (p *Peer) GetEndpoint() (netip.AddrPort, error)
  • func (p *Peer) Name() string
  • func (p *Peer) PublicKey() types.NoisePublicKey
  • func (p *Peer) RemoveAddresses(addrs ...netip.Addr)
  • func (p *Peer) RemoveDestinationPrefixes(prefixes ...netip.Prefix)
  • func (p *Peer) SetEndpoint(endpoint netip.AddrPort)

Variables

var (
	ErrCanceled          = fmt.Errorf("operation was canceled")
	ErrTimeout           = fmt.Errorf("i/o timeout")
	ErrNumericPort       = fmt.Errorf("port must be numeric")
	ErrNoSuitableAddress = fmt.Errorf("no suitable address found")
	ErrMissingAddress    = fmt.Errorf("missing address")
	ErrUnknownPeer       = fmt.Errorf("unknown peer")
)

var (
	ErrNoEndpoint = fmt.Errorf("no known endpoint for peer")
)

Functions

func OpenNetwork

func OpenNetwork(logger *slog.Logger, conf *latestconfig.Config) (network.Network, 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.

Types

type Addr

type Addr struct {
	stdnet.Addr
	// contains filtered or unexported fields
}

Addr is a wrapper around net.Addr that includes the source NoisePublicKey.

func (*Addr) PublicKey

func (a *Addr) PublicKey() types.NoisePublicKey

PublicKey returns the NoisePublicKey of the peer.

type Conn

type Conn struct {
	stdnet.Conn
	// contains filtered or unexported fields
}

Conn is a wrapper around net.Conn that includes the source NoisePublicKey.

func (*Conn) RemoteAddr

func (c *Conn) RemoteAddr() stdnet.Addr

type NoisySocketsNetwork

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

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(destination netip.Prefix, viaPeerName string) error

AddRoute adds a routing table entry for the network.

func (*NoisySocketsNetwork) Close

func (net *NoisySocketsNetwork) Close() error

func (*NoisySocketsNetwork) Dial

func (net *NoisySocketsNetwork) Dial(network, address string) (stdnet.Conn, error)

func (*NoisySocketsNetwork) DialContext

func (net *NoisySocketsNetwork) DialContext(ctx context.Context, network, address string) (stdnet.Conn, error)

func (*NoisySocketsNetwork) GetPeer

func (net *NoisySocketsNetwork) GetPeer(publicKey types.NoisePublicKey) (*Peer, bool)

GetPeer returns a peer by its public key.

func (*NoisySocketsNetwork) HasIPv4

func (net *NoisySocketsNetwork) HasIPv4() bool

func (*NoisySocketsNetwork) HasIPv6

func (net *NoisySocketsNetwork) HasIPv6() bool

func (*NoisySocketsNetwork) Hostname

func (net *NoisySocketsNetwork) Hostname() (string, error)

func (*NoisySocketsNetwork) ListPeers

func (net *NoisySocketsNetwork) ListPeers() []types.NoisePublicKey

ListPeers returns a list of the public keys of all known peers.

func (*NoisySocketsNetwork) Listen

func (net *NoisySocketsNetwork) Listen(network, address string) (stdnet.Listener, error)

func (*NoisySocketsNetwork) ListenPacket

func (net *NoisySocketsNetwork) ListenPacket(network, address string) (stdnet.PacketConn, error)

func (*NoisySocketsNetwork) LookupHost

func (net *NoisySocketsNetwork) LookupHost(host string) ([]string, error)

func (*NoisySocketsNetwork) RemovePeer

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

RemovePeer removes a wireguard peer from the network.

func (*NoisySocketsNetwork) RemoveRoute

func (net *NoisySocketsNetwork) RemoveRoute(destination netip.Prefix) error

RemoveRoute removes a routing table entry for the network.

type Peer

type Peer struct {
	*transport.Peer
	// contains filtered or unexported fields
}

Peer represents a wireguard peer in the network.

func (*Peer) AddAddresses

func (p *Peer) AddAddresses(addrs ...netip.Addr)

AddAddress adds one or more addresses to the peer.

func (*Peer) AddDestinationPrefixes

func (p *Peer) AddDestinationPrefixes(prefixes ...netip.Prefix)

AddDestinationForPrefix adds one or more prefixes the peer is the destination for.

func (*Peer) Addresses

func (p *Peer) Addresses() []netip.Addr

Addresses returns the list of addresses of the peer.

func (*Peer) DestinationForPrefixes

func (p *Peer) DestinationForPrefixes() []netip.Prefix

DestinationForPrefixes returns the list of prefixes the peer is the destination for.

func (*Peer) GetEndpoint

func (p *Peer) GetEndpoint() (netip.AddrPort, error)

GetEndpoint returns the endpoint (public address) of the peer.

func (*Peer) Name

func (p *Peer) Name() string

Name returns the human friendly name of the peer.

func (*Peer) PublicKey

func (p *Peer) PublicKey() types.NoisePublicKey

PublicKey returns the public key of the peer.

func (*Peer) RemoveAddresses

func (p *Peer) RemoveAddresses(addrs ...netip.Addr)

RemoveAddress removes one or more addresses from the peer.

func (*Peer) RemoveDestinationPrefixes

func (p *Peer) RemoveDestinationPrefixes(prefixes ...netip.Prefix)

RemoveDestinationForPrefix removes one or more prefixes the peer is the destination for.

func (*Peer) SetEndpoint

func (p *Peer) SetEndpoint(endpoint netip.AddrPort)

SetEndpoint sets the endpoint (public address) of the peer.