wireguard

type Interface interface {
	// Interface is the underlying system interface.
	system.Interface

	// Configure configures the wireguard interface to use the given key and listen port.
	Configure(ctx context.Context, key crypto.PrivateKey) error
	// ListenPort returns the current listen port of the wireguard interface.
	ListenPort() (int, error)
	// PutPeer updates a peer in the wireguard configuration.
	PutPeer(ctx context.Context, peer *Peer) error
	// DeletePeer removes a peer from the wireguard configuration.
	DeletePeer(ctx context.Context, id string) error
	// Peers returns the list of peers in the wireguard configuration.
	Peers() map[string]Peer
	// Metrics returns the metrics for the wireguard interface and the host.
	Metrics() (*v1.InterfaceMetrics, error)
	// Close closes the wireguard interface and all client connections.
	Close(ctx context.Context) error
}

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

type Options struct {
	// NodeID is the ID of the node. This is only used for metrics.
	NodeID types.NodeID
	// ListenPort is the port to listen on.
	ListenPort int
	// NetNs is the network namespace to use for the interface.
	// This is only used on Linux.
	NetNs string
	// Name is the name of the interface.
	Name string
	// ForceName forces the use of the given name by deleting
	// any pre-existing interface with the same name.
	ForceName bool
	// ForceTUN forces the use of a TUN interface.
	ForceTUN bool
	// PersistentKeepAlive is the interval at which to send keepalive packets
	// to peers. If unset, keepalive packets will automatically be sent to publicly
	// accessible peers when this instance is behind a NAT. Otherwise, no keep-alive
	// packets are sent.
	PersistentKeepAlive time.Duration
	// MTU is the MTU to use for the interface.
	MTU int
	// AddressV4 is the private IPv4 address of this interface.
	AddressV4 netip.Prefix
	// AddressV6 is the private IPv6 address of this interface.
	AddressV6 netip.Prefix
	// NetworkV4 is the IPv4 network of this interface.
	NetworkV4 netip.Prefix
	// NetworkV6 is the IPv6 network of this interface.
	NetworkV6 netip.Prefix
	// Metrics is true if prometheus metrics should be enabled.
	Metrics bool
	// MetricsInterval is the interval at which to update metrics.
	// Defaults to 15 seconds.
	MetricsInterval time.Duration
	// DisableIPv4 disables IPv4 on the interface.
	DisableIPv4 bool
	// DisableIPv6 disables IPv6 on the interface.
	DisableIPv6 bool
	// DisableFullTunnel will ignore routes for a default gateway.
	DisableFullTunnel bool
	// IgnoreRoutes are additional routes to ignore.
	IgnoreRoutes []netip.Prefix
}

type Peer struct {
	// ID is the ID of the peer.
	ID string `json:"id"`
	// GRPCPort is the gRPC port of the peer.
	GRPCPort int `json:"grpcPort"`
	// StorageProvider indicates if the peer is a able to provide storage.
	StorageProvider bool `json:"storageProvider"`
	// PublicKey is the public key of the peer.
	PublicKey crypto.PublicKey `json:"publicKey"`
	// Multiaddrs is the list of multiaddrs for this peer.
	Multiaddrs []multiaddr.Multiaddr `json:"multiaddrs"`
	// Endpoint is the endpoint of this peer, if applicable.
	Endpoint netip.AddrPort `json:"endpoint"`
	// PrivateIPv4 is the private IPv4 address of this peer, if applicable.
	PrivateIPv4 netip.Prefix `json:"privateIPv4"`
	// PrivateIPv6 is the private IPv6 address of this peer, if applicable.
	PrivateIPv6 netip.Prefix `json:"privateIPv6"`
	// AllowedIPs is the list of allowed IPs for this peer.
	AllowedIPs []netip.Prefix `json:"allowedIPs"`
	// AllowedRoutes is the list of allowed routes for this peer.
	AllowedRoutes []netip.Prefix `json:"allowedRoutes"`
}