Documentation
¶
Overview ¶
Package wireguard manages kernel and user-space Wireguard interfaces.
Index ¶
- Constants
- func DeviceLogger(logger *zap.Logger) *device.Logger
- func GenerateRandomNodeAddr(prefix netip.Prefix) (netip.Prefix, error)
- func LinkUp(iface *net.Interface) error
- func NetworkPrefix(installationID string) netip.Prefix
- func SetupIPToInterface(address netip.Prefix, ifaceName string) (func() error, error)
- func UAPIOpen(interfaceName string) (net.Listener, error)
- func VirtualNetworkPrefix() netip.Prefix
- type Device
- type DeviceConfig
- type PeerEvent
- type PeerHandler
- type PeerSource
Constants ¶
const ( // PeerDownInterval is the time since last handshake when established peer is considered to be down. // // WG whitepaper defines a downed peer as being: // Handshake Timeout (180s) + Rekey Timeout (5s) + Rekey Attempt Timeout (90s) // // This interval is applied when the link is already established. PeerDownInterval = (180 + 5 + 90) * time.Second // LinkMTU is the suggested MTU of the link for Wireguard. // // Wireguard sets DF (Don't Fragment) bit on all packets, so the MTU of the link // should be so that with the overhead of the Wireguard header, the packet // is still smaller than the MTU of the link. // // To be on the safe side, we set the MTU to 1280, which is the minimum MTU // for IPv6. LinkMTU = 1280 // RecommendedPersistentKeepAliveInterval is the recommended interval for persistent keepalive. RecommendedPersistentKeepAliveInterval = 25 * time.Second )
const InterfaceName = "siderolink"
InterfaceName is the name of the WireGuard interface.
Variables ¶
This section is empty.
Functions ¶
func DeviceLogger ¶ added in v0.3.5
DeviceLogger returns a device.Logger that logs to the given zap.Logger.
func GenerateRandomNodeAddr ¶ added in v0.3.5
GenerateRandomNodeAddr generates a random node address within the last 8 bytes of the given prefix.
func NetworkPrefix ¶
NetworkPrefix returns IPv6 prefix for the SideroLink.
Server is using the first address in the block. Nodes are using random addresses from the /64 space.
func SetupIPToInterface ¶ added in v0.3.5
SetupIPToInterface sets up the IP address to the interface.
func VirtualNetworkPrefix ¶ added in v0.3.5
VirtualNetworkPrefix returns IPv6 prefix for the SideroLink over GRPC. Virtual nodes will use random addresses from the /64 space.
Types ¶
type Device ¶
type Device struct {
// contains filtered or unexported fields
}
Device manages Wireguard link.
func NewDevice ¶
func NewDevice(config DeviceConfig) (*Device, error)
NewDevice creates a new device with settings.
type DeviceConfig ¶ added in v0.3.5
type DeviceConfig struct {
// Bind is the bind configuration for the wireguard device. If nil the default bind is used.
Bind conn.Bind
// PeerHandler is the optional handler for peer events.
PeerHandler PeerHandler
// Logger is the logger to use.
Logger *zap.Logger
// ServerPrefix is the prefix to bind to the wireguard device.
ServerPrefix netip.Prefix
// PrivateKey is the server private key.
PrivateKey wgtypes.Key
// AutoPeerRemoveInterval is the checks interval to remove downed peers. If zero, it's disabled.
AutoPeerRemoveInterval time.Duration
// ListenPort is the port to listen on. If zero, a random port is used.
ListenPort uint16
// ForceUserspace forces the use of userspace wireguard implementation. If Bind is set this field is always true.
ForceUserspace bool
}
DeviceConfig is the configuration for the wireguard device.
type PeerEvent ¶
type PeerEvent struct {
PubKey wgtypes.Key
Remove bool
Endpoint string
Address netip.Addr
PersistentKeepAliveInterval *time.Duration
VirtualAddr netip.Addr
}
PeerEvent is the event about peer state change.
type PeerHandler ¶ added in v0.3.5
type PeerHandler interface {
HandlePeerAdded(event PeerEvent) error
HandlePeerRemoved(pubKey wgtypes.Key) error
}
PeerHandler is an interface for handling peer events.
type PeerSource ¶
type PeerSource interface {
EventCh() <-chan PeerEvent
}
PeerSource is the interface of the "database" providing SideroLink peer information.
Source Files