//go:build !e2e_testing // +build !e2e_testing package overlay import ( "bytes" "errors" "fmt" "io" "io/fs" "net" "os" "os/exec" "strconv" "sync/atomic" "syscall" "unsafe" "github.com/sirupsen/logrus" "github.com/slackhq/nebula/cidr" "github.com/slackhq/nebula/config" "github.com/slackhq/nebula/iputil" "github.com/slackhq/nebula/util" ) const ( // FIODGNAME is defined in sys/sys/filio.h on FreeBSD // For 32-bit systems, use FIODGNAME_32 (not defined in this file: 0x80086678) FIODGNAME = 0x80106678 ) type fiodgnameArg struct { length int32 pad [4]byte buf unsafe.Pointer } type ifreqRename struct { Name [16]byte Data uintptr } type ifreqDestroy struct { Name [16]byte pad [16]byte } type tun struct { Device string cidr *net.IPNet MTU int Routes atomic.Pointer[[]Route] routeTree atomic.Pointer[cidr.Tree4[iputil.VpnIp]] l *logrus.Logger io.ReadWriteCloser } func (t *tun) Close() error { if t.ReadWriteCloser != nil { if err := t.ReadWriteCloser.Close(); err != nil { return err } s, err := syscall.Socket(syscall.AF_INET, syscall.SOCK_DGRAM, syscall.IPPROTO_IP) if err != nil { return err } defer syscall.Close(s) ifreq := ifreqDestroy{Name: t.deviceBytes()} // Destroy the interface err = ioctl(uintptr(s), syscall.SIOCIFDESTROY, uintptr(unsafe.Pointer(&ifreq))) return err } return nil } func newTunFromFd(_ *config.C, _ *logrus.Logger, _ int, _ *net.IPNet) (*tun, error) { return nil, fmt.Errorf("newTunFromFd not supported in FreeBSD") } func newTun(c *config.C, l *logrus.Logger, cidr *net.IPNet, _ bool) (*tun, error) { // Try to open existing tun device var file *os.File var err error deviceName := c.GetString("tun.dev", "") if deviceName != "" { file, err = os.OpenFile("/dev/"+deviceName, os.O_RDWR, 0) } if errors.Is(err, fs.ErrNotExist) || deviceName == "" { // If the device doesn't already exist, request a new one and rename it file, err = os.OpenFile("/dev/tun", os.O_RDWR, 0) } if err != nil { return nil, err } rawConn, err := file.SyscallConn() if err != nil { return nil, fmt.Errorf("SyscallConn: %v", err) } var name [16]byte var ctrlErr error rawConn.Control(func(fd uintptr) { // Read the name of the interface arg := fiodgnameArg{length: 16, buf: unsafe.Pointer(&name)} ctrlErr = ioctl(fd, FIODGNAME, uintptr(unsafe.Pointer(&arg))) }) if ctrlErr != nil { return nil, err } ifName := string(bytes.TrimRight(name[:], "\x00")) if deviceName == "" { deviceName = ifName } // If the name doesn't match the desired interface name, rename it now if ifName != deviceName { s, err := syscall.Socket( syscall.AF_INET, syscall.SOCK_DGRAM, syscall.IPPROTO_IP, ) if err != nil { return nil, err } defer syscall.Close(s) fd := uintptr(s) var fromName [16]byte var toName [16]byte copy(fromName[:], ifName) copy(toName[:], deviceName) ifrr := ifreqRename{ Name: fromName, Data: uintptr(unsafe.Pointer(&toName)), } // Set the device name ioctl(fd, syscall.SIOCSIFNAME, uintptr(unsafe.Pointer(&ifrr))) } t := &tun{ ReadWriteCloser: file, Device: deviceName, cidr: cidr, MTU: c.GetInt("tun.mtu", DefaultMTU), l: l, } err = t.reload(c, true) if err != nil { return nil, err } c.RegisterReloadCallback(func(c *config.C) { err := t.reload(c, false) if err != nil { util.LogWithContextIfNeeded("failed to reload tun device", err, t.l) } }) return t, nil } func (t *tun) Activate() error { var err error // TODO use syscalls instead of exec.Command cmd := exec.Command("/sbin/ifconfig", t.Device, t.cidr.String(), t.cidr.IP.String()) t.l.Debug("command: ", cmd.String()) if err = cmd.Run(); err != nil { return fmt.Errorf("failed to run 'ifconfig': %s", err) } cmd = exec.Command("/sbin/route", "-n", "add", "-net", t.cidr.String(), "-interface", t.Device) t.l.Debug("command: ", cmd.String()) if err = cmd.Run(); err != nil { return fmt.Errorf("failed to run 'route add': %s", err) } cmd = exec.Command("/sbin/ifconfig", t.Device, "mtu", strconv.Itoa(t.MTU)) t.l.Debug("command: ", cmd.String()) if err = cmd.Run(); err != nil { return fmt.Errorf("failed to run 'ifconfig': %s", err) } // Unsafe path routes return t.addRoutes(false) } func (t *tun) reload(c *config.C, initial bool) error { change, routes, err := getAllRoutesFromConfig(c, t.cidr, initial) if err != nil { return err } if !initial && !change { return nil } routeTree, err := makeRouteTree(t.l, routes, false) if err != nil { return err } // Teach nebula how to handle the routes before establishing them in the system table oldRoutes := t.Routes.Swap(&routes) t.routeTree.Store(routeTree) if !initial { // Remove first, if the system removes a wanted route hopefully it will be re-added next err := t.removeRoutes(findRemovedRoutes(routes, *oldRoutes)) if err != nil { util.LogWithContextIfNeeded("Failed to remove routes", err, t.l) } // Ensure any routes we actually want are installed err = t.addRoutes(true) if err != nil { // Catch any stray logs util.LogWithContextIfNeeded("Failed to add routes", err, t.l) } } return nil } func (t *tun) RouteFor(ip iputil.VpnIp) iputil.VpnIp { _, r := t.routeTree.Load().MostSpecificContains(ip) return r } func (t *tun) Cidr() *net.IPNet { return t.cidr } func (t *tun) Name() string { return t.Device } func (t *tun) NewMultiQueueReader() (io.ReadWriteCloser, error) { return nil, fmt.Errorf("TODO: multiqueue not implemented for freebsd") } func (t *tun) addRoutes(logErrors bool) error { routes := *t.Routes.Load() for _, r := range routes { if r.Via == nil || !r.Install { // We don't allow route MTUs so only install routes with a via continue } cmd := exec.Command("/sbin/route", "-n", "add", "-net", r.Cidr.String(), "-interface", t.Device) t.l.Debug("command: ", cmd.String()) if err := cmd.Run(); err != nil { retErr := util.NewContextualError("failed to run 'route add' for unsafe_route", map[string]interface{}{"route": r}, err) if logErrors { retErr.Log(t.l) } else { return retErr } } } return nil } func (t *tun) removeRoutes(routes []Route) error { for _, r := range routes { if !r.Install { continue } cmd := exec.Command("/sbin/route", "-n", "delete", "-net", r.Cidr.String(), "-interface", t.Device) t.l.Debug("command: ", cmd.String()) if err := cmd.Run(); err != nil { t.l.WithError(err).WithField("route", r).Error("Failed to remove route") } else { t.l.WithField("route", r).Info("Removed route") } } return nil } func (t *tun) deviceBytes() (o [16]byte) { for i, c := range t.Device { o[i] = byte(c) } return }