1
0

tun_linux.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827
  1. //go:build !android && !e2e_testing
  2. package overlay
  3. import (
  4. "errors"
  5. "fmt"
  6. "log/slog"
  7. "net"
  8. "net/netip"
  9. "os"
  10. "strings"
  11. "sync"
  12. "sync/atomic"
  13. "time"
  14. "unsafe"
  15. "github.com/DefinedNet/netlink"
  16. "github.com/gaissmai/bart"
  17. "github.com/slackhq/nebula/config"
  18. "github.com/slackhq/nebula/overlay/tio"
  19. "github.com/slackhq/nebula/routing"
  20. "github.com/slackhq/nebula/util"
  21. "golang.org/x/sys/unix"
  22. )
  23. type tun struct {
  24. readers tio.QueueSet
  25. closeLock sync.Mutex
  26. Device string
  27. vpnNetworks []netip.Prefix
  28. MaxMTU int
  29. DefaultMTU int
  30. TXQueueLen int
  31. deviceIndex int
  32. ioctlFd uintptr
  33. vnetHdr bool
  34. offloadFlags uint
  35. Routes atomic.Pointer[[]Route]
  36. routeTree atomic.Pointer[bart.Table[routing.Gateways]]
  37. routeChan chan struct{}
  38. useSystemRoutes bool
  39. useSystemRoutesBufferSize int
  40. // These are routes learned from `tun.use_system_route_table`
  41. // stored here to make it easier to restore them after a reload
  42. routesFromSystem map[netip.Prefix]routing.Gateways
  43. routesFromSystemLock sync.Mutex
  44. l *slog.Logger
  45. }
  46. func (t *tun) Networks() []netip.Prefix {
  47. return t.vpnNetworks
  48. }
  49. type ifReq struct {
  50. Name [16]byte
  51. Flags uint16
  52. pad [8]byte
  53. }
  54. type ifreqMTU struct {
  55. Name [16]byte
  56. MTU int32
  57. pad [8]byte
  58. }
  59. type ifreqQLEN struct {
  60. Name [16]byte
  61. Value int32
  62. pad [8]byte
  63. }
  64. func newTunFromFd(c *config.C, l *slog.Logger, deviceFd int, vpnNetworks []netip.Prefix) (*tun, error) {
  65. // We don't know what flags the caller opened this fd with and can't turn
  66. // on IFF_VNET_HDR after TUNSETIFF, so skip offload on inherited fds.
  67. return newTunGeneric(c, l, deviceFd, false, 0, vpnNetworks, "tun0")
  68. }
  69. // openTunDev opens /dev/net/tun, creating the device node first if it's
  70. // missing (docker containers occasionally omit it).
  71. func openTunDev() (int, error) {
  72. fd, err := unix.Open("/dev/net/tun", os.O_RDWR, 0)
  73. if err == nil {
  74. return fd, nil
  75. }
  76. if !os.IsNotExist(err) {
  77. return -1, err
  78. }
  79. if err = os.MkdirAll("/dev/net", 0755); err != nil {
  80. return -1, fmt.Errorf("/dev/net/tun doesn't exist, failed to mkdir -p /dev/net: %w", err)
  81. }
  82. if err = unix.Mknod("/dev/net/tun", unix.S_IFCHR|0600, int(unix.Mkdev(10, 200))); err != nil {
  83. return -1, fmt.Errorf("failed to create /dev/net/tun: %w", err)
  84. }
  85. fd, err = unix.Open("/dev/net/tun", os.O_RDWR, 0)
  86. if err != nil {
  87. return -1, fmt.Errorf("created /dev/net/tun, but still failed: %w", err)
  88. }
  89. return fd, nil
  90. }
  91. // tunSetIff runs TUNSETIFF with the given flags and returns the kernel-chosen device name on success.
  92. func tunSetIff(fd int, name string, flags uint16) (string, error) {
  93. var req ifReq
  94. req.Flags = flags
  95. copy(req.Name[:], name)
  96. if err := ioctl(uintptr(fd), uintptr(unix.TUNSETIFF), uintptr(unsafe.Pointer(&req))); err != nil {
  97. return "", err
  98. }
  99. return strings.Trim(string(req.Name[:]), "\x00"), nil
  100. }
  101. // tsoOffloadFlags are the TUN_F_* bits we ask the kernel to enable when a TSO-capable TUN is available.
  102. const tsoOffloadFlags = unix.TUN_F_CSUM | unix.TUN_F_TSO4 | unix.TUN_F_TSO6 | unix.TUN_F_TSO_ECN
  103. // usoAndTSOOffloadFlags adds UDP Segmentation Offload to tsoOffloadFlags.
  104. // Requires Linux >= 6.2; older kernels reject it and we fall back to TCP-only TSO
  105. const usoAndTSOOffloadFlags = tsoOffloadFlags | unix.TUN_F_USO4 | unix.TUN_F_USO6
  106. func offloadUSOEnabled(offloadFlags uint) bool {
  107. return offloadFlags&(unix.TUN_F_USO4|unix.TUN_F_USO6) != 0
  108. }
  109. func newTun(c *config.C, l *slog.Logger, vpnNetworks []netip.Prefix, multiqueue bool) (*tun, error) {
  110. var err error
  111. // IFF_TUN_EXCL prevents us from attaching to an already-running tun
  112. baseFlags := uint16(unix.IFF_TUN | unix.IFF_NO_PI | unix.IFF_TUN_EXCL)
  113. if multiqueue {
  114. baseFlags |= unix.IFF_MULTI_QUEUE
  115. }
  116. nameStr := c.GetString("tun.dev", "")
  117. useOffloads := c.GetBool("tun.use_offloads", false)
  118. var fd int
  119. var name string
  120. var offloadFlags uint
  121. if useOffloads {
  122. fd, err = openTunDev()
  123. if err != nil {
  124. return nil, err
  125. }
  126. // First try to enable IFF_VNET_HDR via TUNSETIFF and negotiate TUN_F_* offloads
  127. // We try TSO+USO first, fall back to TSO-only on kernels without USO (Linux < 6.2),
  128. // and finally give up on virtio headers entirely and reopen as a plain TUN if neither offload mask is accepted.
  129. // offloadFlags is the exact TUN_F_* mask the kernel accepted.
  130. // We save it so addQueue can replay the identical device-wide mask on added queues
  131. name, err = tunSetIff(fd, nameStr, baseFlags|unix.IFF_VNET_HDR)
  132. if err != nil {
  133. _ = unix.Close(fd)
  134. useOffloads = false
  135. } else {
  136. if err = ioctl(uintptr(fd), unix.TUNSETOFFLOAD, uintptr(usoAndTSOOffloadFlags)); err == nil {
  137. offloadFlags = usoAndTSOOffloadFlags
  138. } else if err = ioctl(uintptr(fd), unix.TUNSETOFFLOAD, uintptr(tsoOffloadFlags)); err == nil {
  139. offloadFlags = tsoOffloadFlags
  140. } else {
  141. l.Warn("Failed to enable TUN offload (TSO); proceeding without virtio headers", "error", err)
  142. _ = unix.Close(fd)
  143. useOffloads = false
  144. }
  145. }
  146. }
  147. if !useOffloads {
  148. fd, err = openTunDev()
  149. if err != nil {
  150. return nil, err
  151. }
  152. name, err = tunSetIff(fd, nameStr, baseFlags)
  153. if err != nil {
  154. _ = unix.Close(fd)
  155. return nil, &NameError{Name: nameStr, Underlying: err}
  156. }
  157. }
  158. l.Info("TUN offload status", "tso", useOffloads, "uso", offloadUSOEnabled(offloadFlags))
  159. t, err := newTunGeneric(c, l, fd, useOffloads, offloadFlags, vpnNetworks, name)
  160. if err != nil {
  161. return nil, err
  162. }
  163. t.Device = name
  164. return t, nil
  165. }
  166. // newTunGeneric does all the stuff common to different tun initialization paths.
  167. // It will close your files on error.
  168. // offloadFlags is the TUN_F_* mask newTun negotiated (ignored when vnetHdr is false)
  169. func newTunGeneric(c *config.C, l *slog.Logger, fd int, vnetHdr bool, offloadFlags uint, vpnNetworks []netip.Prefix, name string) (*tun, error) {
  170. var qs tio.QueueSet
  171. var err error
  172. if vnetHdr {
  173. qs, err = tio.NewOffloadQueueSet(offloadUSOEnabled(offloadFlags), l)
  174. } else {
  175. qs, err = tio.NewPollQueueSet()
  176. }
  177. if err != nil {
  178. _ = unix.Close(fd)
  179. return nil, err
  180. }
  181. err = qs.Add(fd)
  182. if err != nil {
  183. // Add only appends on success, so closing the set here can't
  184. // double-close fd; it releases the set's shutdown eventfd.
  185. _ = unix.Close(fd)
  186. _ = qs.Close()
  187. return nil, err
  188. }
  189. t := &tun{
  190. Device: name,
  191. readers: qs,
  192. closeLock: sync.Mutex{},
  193. vnetHdr: vnetHdr,
  194. offloadFlags: offloadFlags,
  195. vpnNetworks: vpnNetworks,
  196. TXQueueLen: c.GetInt("tun.tx_queue", 500),
  197. useSystemRoutes: c.GetBool("tun.use_system_route_table", false),
  198. useSystemRoutesBufferSize: c.GetInt("tun.use_system_route_table_buffer_size", 0),
  199. routesFromSystem: map[netip.Prefix]routing.Gateways{},
  200. l: l,
  201. }
  202. if err = t.reload(c, true); err != nil {
  203. _ = t.Close()
  204. return nil, err
  205. }
  206. c.RegisterReloadCallback(func(c *config.C) {
  207. err := t.reload(c, false)
  208. if err != nil {
  209. util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
  210. }
  211. })
  212. return t, nil
  213. }
  214. func (t *tun) reload(c *config.C, initial bool) error {
  215. routeChange, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
  216. if err != nil {
  217. return err
  218. }
  219. if !initial && !routeChange && !c.HasChanged("tun.mtu") {
  220. return nil
  221. }
  222. routeTree, err := makeRouteTree(t.l, routes, true)
  223. if err != nil {
  224. return err
  225. }
  226. // Bring along any routes learned from the system route table on reload
  227. t.routesFromSystemLock.Lock()
  228. for dst, gw := range t.routesFromSystem {
  229. routeTree.Insert(dst, gw)
  230. }
  231. t.routesFromSystemLock.Unlock()
  232. oldDefaultMTU := t.DefaultMTU
  233. oldMaxMTU := t.MaxMTU
  234. newDefaultMTU := c.GetInt("tun.mtu", DefaultMTU)
  235. newMaxMTU := newDefaultMTU
  236. for i, r := range routes {
  237. if r.MTU == 0 {
  238. routes[i].MTU = newDefaultMTU
  239. }
  240. if r.MTU > t.MaxMTU {
  241. newMaxMTU = r.MTU
  242. }
  243. }
  244. t.MaxMTU = newMaxMTU
  245. t.DefaultMTU = newDefaultMTU
  246. // Teach nebula how to handle the routes before establishing them in the system table
  247. oldRoutes := t.Routes.Swap(&routes)
  248. t.routeTree.Store(routeTree)
  249. if !initial {
  250. if oldMaxMTU != newMaxMTU {
  251. t.setMTU()
  252. t.l.Info("Set max MTU", "mtu", t.MaxMTU, "oldMTU", oldMaxMTU)
  253. }
  254. if oldDefaultMTU != newDefaultMTU {
  255. for i := range t.vpnNetworks {
  256. err := t.setDefaultRoute(t.vpnNetworks[i])
  257. if err != nil {
  258. t.l.Warn(err.Error())
  259. } else {
  260. t.l.Info("Set default MTU", "mtu", t.DefaultMTU, "oldMTU", oldDefaultMTU)
  261. }
  262. }
  263. }
  264. // Remove first, if the system removes a wanted route hopefully it will be re-added next
  265. t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
  266. // Ensure any routes we actually want are installed
  267. err = t.addRoutes(true)
  268. if err != nil {
  269. // This should never be called since addRoutes should log its own errors in a reload condition
  270. util.LogWithContextIfNeeded("Failed to refresh routes", err, t.l)
  271. }
  272. }
  273. return nil
  274. }
  275. // Queues opens additional kernel multiqueue fds until the device has n queues, then returns them all.
  276. func (t *tun) Queues(n int) ([]tio.Queue, error) {
  277. for len(t.readers.Queues()) < n {
  278. if err := t.addQueue(); err != nil {
  279. return nil, err
  280. }
  281. }
  282. return t.readers.Queues(), nil
  283. }
  284. // addQueue opens one more IFF_MULTI_QUEUE fd on the device and adds it to the queue set.
  285. func (t *tun) addQueue() error {
  286. t.closeLock.Lock()
  287. defer t.closeLock.Unlock()
  288. fd, err := unix.Open("/dev/net/tun", os.O_RDWR, 0)
  289. if err != nil {
  290. return err
  291. }
  292. flags := uint16(unix.IFF_TUN | unix.IFF_NO_PI | unix.IFF_MULTI_QUEUE)
  293. if t.vnetHdr {
  294. flags |= unix.IFF_VNET_HDR
  295. }
  296. if _, err = tunSetIff(fd, t.Device, flags); err != nil {
  297. _ = unix.Close(fd)
  298. return err
  299. }
  300. if t.vnetHdr {
  301. if err = ioctl(uintptr(fd), unix.TUNSETOFFLOAD, uintptr(t.offloadFlags)); err != nil {
  302. _ = unix.Close(fd)
  303. return fmt.Errorf("failed to enable offload on multiqueue tun fd: %w", err)
  304. }
  305. }
  306. err = t.readers.Add(fd)
  307. if err != nil {
  308. _ = unix.Close(fd)
  309. return err
  310. }
  311. return nil
  312. }
  313. func (t *tun) RoutesFor(ip netip.Addr) routing.Gateways {
  314. r, _ := t.routeTree.Load().Lookup(ip)
  315. return r
  316. }
  317. func (t *tun) deviceBytes() (o [16]byte) {
  318. for i, c := range t.Device {
  319. o[i] = byte(c)
  320. }
  321. return
  322. }
  323. func hasNetlinkAddr(al []*netlink.Addr, x netlink.Addr) bool {
  324. for i := range al {
  325. if al[i].Equal(x) {
  326. return true
  327. }
  328. }
  329. return false
  330. }
  331. // addIPs uses netlink to add all addresses that don't exist, then it removes ones that should not be there
  332. func (t *tun) addIPs(link netlink.Link) error {
  333. newAddrs := make([]*netlink.Addr, len(t.vpnNetworks))
  334. for i := range t.vpnNetworks {
  335. newAddrs[i] = &netlink.Addr{
  336. IPNet: &net.IPNet{
  337. IP: t.vpnNetworks[i].Addr().AsSlice(),
  338. Mask: net.CIDRMask(t.vpnNetworks[i].Bits(), t.vpnNetworks[i].Addr().BitLen()),
  339. },
  340. Label: t.vpnNetworks[i].Addr().Zone(),
  341. }
  342. }
  343. //add all new addresses
  344. for i := range newAddrs {
  345. //AddrReplace still adds new IPs, but if their properties change it will change them as well
  346. if err := netlink.AddrReplace(link, newAddrs[i]); err != nil {
  347. return err
  348. }
  349. }
  350. //iterate over remainder, remove whoever shouldn't be there
  351. al, err := netlink.AddrList(link, netlink.FAMILY_ALL)
  352. if err != nil {
  353. //RTM_GETADDR dumps the whole system, so any concurrent address change
  354. //interrupts it - including the kernel's async tentative->preferred
  355. //flip of an IPv6 address the AddrReplace calls above just added,
  356. //which makes this a race against our own setup. Partial results are
  357. //still returned; the worst case is a stale address surviving until
  358. //the next config reload, which beats failing startup over it.
  359. if !errors.Is(err, netlink.ErrDumpInterrupted) {
  360. return fmt.Errorf("failed to get tun address list: %s", err)
  361. }
  362. t.l.Warn("tun address list dump was interrupted, stale addresses may remain")
  363. }
  364. for i := range al {
  365. if hasNetlinkAddr(newAddrs, al[i]) {
  366. continue
  367. }
  368. err = netlink.AddrDel(link, &al[i])
  369. if err != nil {
  370. t.l.Error("failed to remove address from tun address list", "error", err)
  371. } else {
  372. t.l.Info("removed address not listed in cert(s)", "removed", al[i].String())
  373. }
  374. }
  375. return nil
  376. }
  377. func (t *tun) Activate() error {
  378. devName := t.deviceBytes()
  379. if t.useSystemRoutes {
  380. t.watchRoutes()
  381. }
  382. s, err := unix.Socket(
  383. unix.AF_INET, //because everything we use t.ioctlFd for is address family independent, this is fine
  384. unix.SOCK_DGRAM,
  385. unix.IPPROTO_IP,
  386. )
  387. if err != nil {
  388. return err
  389. }
  390. t.ioctlFd = uintptr(s)
  391. // Set the device name
  392. ifrf := ifReq{Name: devName}
  393. if err = ioctl(t.ioctlFd, unix.SIOCGIFFLAGS, uintptr(unsafe.Pointer(&ifrf))); err != nil {
  394. return fmt.Errorf("failed to set tun device name: %s", err)
  395. }
  396. link, err := netlink.LinkByName(t.Device)
  397. if err != nil {
  398. return fmt.Errorf("failed to get tun device link: %s", err)
  399. }
  400. t.deviceIndex = link.Attrs().Index
  401. // Setup our default MTU
  402. t.setMTU()
  403. // Set the transmit queue length
  404. ifrq := ifreqQLEN{Name: devName, Value: int32(t.TXQueueLen)}
  405. if err = ioctl(t.ioctlFd, unix.SIOCSIFTXQLEN, uintptr(unsafe.Pointer(&ifrq))); err != nil {
  406. // If we can't set the queue length nebula will still work but it may lead to packet loss
  407. t.l.Error("Failed to set tun tx queue length", "error", err)
  408. }
  409. const modeNone = 1
  410. if err = netlink.LinkSetIP6AddrGenMode(link, modeNone); err != nil {
  411. t.l.Warn("Failed to disable link local address generation", "error", err)
  412. }
  413. if err = t.addIPs(link); err != nil {
  414. return err
  415. }
  416. // Bring up the interface
  417. ifrf.Flags = ifrf.Flags | unix.IFF_UP
  418. if err = ioctl(t.ioctlFd, unix.SIOCSIFFLAGS, uintptr(unsafe.Pointer(&ifrf))); err != nil {
  419. return fmt.Errorf("failed to bring the tun device up: %s", err)
  420. }
  421. //set route MTU
  422. for i := range t.vpnNetworks {
  423. if err = t.setDefaultRoute(t.vpnNetworks[i]); err != nil {
  424. return fmt.Errorf("failed to set default route MTU: %w", err)
  425. }
  426. }
  427. // Set the routes
  428. if err = t.addRoutes(false); err != nil {
  429. return err
  430. }
  431. // Run the interface
  432. ifrf.Flags = ifrf.Flags | unix.IFF_UP | unix.IFF_RUNNING
  433. if err = ioctl(t.ioctlFd, unix.SIOCSIFFLAGS, uintptr(unsafe.Pointer(&ifrf))); err != nil {
  434. return fmt.Errorf("failed to run tun device: %s", err)
  435. }
  436. return nil
  437. }
  438. func (t *tun) setMTU() {
  439. // Set the MTU on the device
  440. ifm := ifreqMTU{Name: t.deviceBytes(), MTU: int32(t.MaxMTU)}
  441. if err := ioctl(t.ioctlFd, unix.SIOCSIFMTU, uintptr(unsafe.Pointer(&ifm))); err != nil {
  442. // This is currently a non fatal condition because the route table must have the MTU set appropriately as well
  443. t.l.Error("Failed to set tun mtu", "error", err)
  444. }
  445. }
  446. func (t *tun) setDefaultRoute(cidr netip.Prefix) error {
  447. dr := &net.IPNet{
  448. IP: cidr.Masked().Addr().AsSlice(),
  449. Mask: net.CIDRMask(cidr.Bits(), cidr.Addr().BitLen()),
  450. }
  451. nr := netlink.Route{
  452. LinkIndex: t.deviceIndex,
  453. Dst: dr,
  454. MTU: t.DefaultMTU,
  455. AdvMSS: t.advMSS(Route{}),
  456. Scope: unix.RT_SCOPE_LINK,
  457. Src: net.IP(cidr.Addr().AsSlice()),
  458. Protocol: unix.RTPROT_KERNEL,
  459. Table: unix.RT_TABLE_MAIN,
  460. Type: unix.RTN_UNICAST,
  461. }
  462. // Match the metric the kernel uses for its auto-installed connected route,
  463. // so RouteReplace overwrites it in place instead of adding a second route at a worse metric.
  464. // IPv6 connected routes are installed at metric 256 (IP6_RT_PRIO_KERN); IPv4 uses 0.
  465. // Without this, the kernel route wins lookups and our MTU / AdvMSS / Features never apply on v6.
  466. if cidr.Addr().Is6() {
  467. nr.Priority = 256
  468. }
  469. err := netlink.RouteReplace(&nr)
  470. if err != nil {
  471. t.l.Warn("Failed to set default route MTU, retrying", "error", err, "cidr", cidr)
  472. //retry twice more -- on some systems there appears to be a race condition where if we set routes too soon, netlink says `invalid argument`
  473. for range 2 {
  474. time.Sleep(100 * time.Millisecond)
  475. err = netlink.RouteReplace(&nr)
  476. if err == nil {
  477. break
  478. } else {
  479. t.l.Warn("Failed to set default route MTU, retrying",
  480. "error", err,
  481. "cidr", cidr,
  482. "mtu", t.DefaultMTU,
  483. )
  484. }
  485. }
  486. if err != nil {
  487. return fmt.Errorf("failed to set mtu %v on the default route %v; %v", t.DefaultMTU, dr, err)
  488. }
  489. }
  490. return nil
  491. }
  492. func (t *tun) addRoutes(logErrors bool) error {
  493. // Path routes
  494. routes := *t.Routes.Load()
  495. for _, r := range routes {
  496. if !r.Install {
  497. continue
  498. }
  499. dr := &net.IPNet{
  500. IP: r.Cidr.Masked().Addr().AsSlice(),
  501. Mask: net.CIDRMask(r.Cidr.Bits(), r.Cidr.Addr().BitLen()),
  502. }
  503. nr := netlink.Route{
  504. LinkIndex: t.deviceIndex,
  505. Dst: dr,
  506. MTU: r.MTU,
  507. AdvMSS: t.advMSS(r),
  508. Scope: unix.RT_SCOPE_LINK,
  509. }
  510. if r.Metric > 0 {
  511. nr.Priority = r.Metric
  512. }
  513. err := netlink.RouteReplace(&nr)
  514. if err != nil {
  515. retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
  516. if logErrors {
  517. retErr.Log(t.l)
  518. } else {
  519. return retErr
  520. }
  521. } else {
  522. t.l.Info("Added route", "route", r)
  523. }
  524. }
  525. return nil
  526. }
  527. func (t *tun) removeRoutes(routes []Route) {
  528. for _, r := range routes {
  529. if !r.Install {
  530. continue
  531. }
  532. dr := &net.IPNet{
  533. IP: r.Cidr.Masked().Addr().AsSlice(),
  534. Mask: net.CIDRMask(r.Cidr.Bits(), r.Cidr.Addr().BitLen()),
  535. }
  536. nr := netlink.Route{
  537. LinkIndex: t.deviceIndex,
  538. Dst: dr,
  539. MTU: r.MTU,
  540. AdvMSS: t.advMSS(r),
  541. Scope: unix.RT_SCOPE_LINK,
  542. }
  543. if r.Metric > 0 {
  544. nr.Priority = r.Metric
  545. }
  546. err := netlink.RouteDel(&nr)
  547. if err != nil {
  548. t.l.Error("Failed to remove route", "error", err, "route", r)
  549. } else {
  550. t.l.Info("Removed route", "route", r)
  551. }
  552. }
  553. }
  554. func (t *tun) Name() string {
  555. return t.Device
  556. }
  557. func (t *tun) advMSS(r Route) int {
  558. mtu := r.MTU
  559. if r.MTU == 0 {
  560. mtu = t.DefaultMTU
  561. }
  562. // We only need to set advmss if the route MTU does not match the device MTU
  563. if mtu != t.MaxMTU {
  564. return mtu - 40
  565. }
  566. return 0
  567. }
  568. func (t *tun) watchRoutes() {
  569. rch := make(chan netlink.RouteUpdate)
  570. doneChan := make(chan struct{})
  571. netlinkOptions := netlink.RouteSubscribeOptions{
  572. ReceiveBufferSize: t.useSystemRoutesBufferSize,
  573. ReceiveBufferForceSize: t.useSystemRoutesBufferSize != 0,
  574. ErrorCallback: func(e error) { t.l.Error("netlink error", "error", e) },
  575. }
  576. if err := netlink.RouteSubscribeWithOptions(rch, doneChan, netlinkOptions); err != nil {
  577. t.l.Error("failed to subscribe to system route changes", "error", err)
  578. return
  579. }
  580. t.routeChan = doneChan
  581. go func() {
  582. for {
  583. select {
  584. case r, ok := <-rch:
  585. if ok {
  586. t.updateRoutes(r)
  587. } else {
  588. // may be should do something here as
  589. // netlink stops sending updates
  590. return
  591. }
  592. case <-doneChan:
  593. // netlink.RouteSubscriber will close the rch for us
  594. return
  595. }
  596. }
  597. }()
  598. }
  599. func (t *tun) isGatewayInVpnNetworks(gwAddr netip.Addr) bool {
  600. withinNetworks := false
  601. for i := range t.vpnNetworks {
  602. if t.vpnNetworks[i].Contains(gwAddr) {
  603. withinNetworks = true
  604. break
  605. }
  606. }
  607. return withinNetworks
  608. }
  609. func (t *tun) getGatewaysFromRoute(r *netlink.Route) routing.Gateways {
  610. var gateways routing.Gateways
  611. link, err := netlink.LinkByName(t.Device)
  612. if err != nil {
  613. t.l.Error("Ignoring route update: failed to get link by name", "deviceName", t.Device)
  614. return gateways
  615. }
  616. // If this route is relevant to our interface and there is a gateway then add it
  617. if r.LinkIndex == link.Attrs().Index {
  618. gwAddr, ok := getGatewayAddr(r.Gw, r.Via)
  619. if ok {
  620. if t.isGatewayInVpnNetworks(gwAddr) {
  621. gateways = append(gateways, routing.NewGateway(gwAddr, 1))
  622. } else {
  623. // Gateway isn't in our overlay network, ignore
  624. t.l.Debug("Ignoring route update, gateway is not in our network", "route", r)
  625. }
  626. } else {
  627. t.l.Debug("Ignoring route update, invalid gateway or via address", "route", r)
  628. }
  629. }
  630. for _, p := range r.MultiPath {
  631. // If this route is relevant to our interface and there is a gateway then add it
  632. if p.LinkIndex == link.Attrs().Index {
  633. gwAddr, ok := getGatewayAddr(p.Gw, p.Via)
  634. if ok {
  635. if t.isGatewayInVpnNetworks(gwAddr) {
  636. gateways = append(gateways, routing.NewGateway(gwAddr, p.Hops+1))
  637. } else {
  638. // Gateway isn't in our overlay network, ignore
  639. t.l.Debug("Ignoring route update, gateway is not in our network", "route", r)
  640. }
  641. } else {
  642. t.l.Debug("Ignoring route update, invalid gateway or via address", "route", r)
  643. }
  644. }
  645. }
  646. routing.CalculateBucketsForGateways(gateways)
  647. return gateways
  648. }
  649. func getGatewayAddr(gw net.IP, via netlink.Destination) (netip.Addr, bool) {
  650. // Try to use the old RTA_GATEWAY first
  651. gwAddr, ok := netip.AddrFromSlice(gw)
  652. if !ok {
  653. // Fallback to the new RTA_VIA
  654. rVia, ok := via.(*netlink.Via)
  655. if ok {
  656. gwAddr, ok = netip.AddrFromSlice(rVia.Addr)
  657. }
  658. }
  659. if gwAddr.IsValid() {
  660. gwAddr = gwAddr.Unmap()
  661. return gwAddr, true
  662. }
  663. return netip.Addr{}, false
  664. }
  665. func (t *tun) updateRoutes(r netlink.RouteUpdate) {
  666. gateways := t.getGatewaysFromRoute(&r.Route)
  667. if len(gateways) == 0 {
  668. // No gateways relevant to our network, no routing changes required.
  669. t.l.Debug("Ignoring route update, no gateways", "route", r)
  670. return
  671. }
  672. if r.Dst == nil {
  673. t.l.Debug("Ignoring route update, no destination address", "route", r)
  674. return
  675. }
  676. dstAddr, ok := netip.AddrFromSlice(r.Dst.IP)
  677. if !ok {
  678. t.l.Debug("Ignoring route update, invalid destination address", "route", r)
  679. return
  680. }
  681. ones, _ := r.Dst.Mask.Size()
  682. dst := netip.PrefixFrom(dstAddr, ones)
  683. newTree := t.routeTree.Load().Clone()
  684. t.routesFromSystemLock.Lock()
  685. if r.Type == unix.RTM_NEWROUTE {
  686. t.l.Info("Adding route", "destination", dst, "via", gateways)
  687. t.routesFromSystem[dst] = gateways
  688. newTree.Insert(dst, gateways)
  689. } else {
  690. t.l.Info("Removing route", "destination", dst, "via", gateways)
  691. delete(t.routesFromSystem, dst)
  692. newTree.Delete(dst)
  693. }
  694. t.routesFromSystemLock.Unlock()
  695. t.routeTree.Store(newTree)
  696. }
  697. func (t *tun) Close() error {
  698. t.closeLock.Lock()
  699. defer t.closeLock.Unlock()
  700. if t.routeChan != nil {
  701. close(t.routeChan)
  702. t.routeChan = nil
  703. }
  704. if t.ioctlFd > 0 {
  705. _ = unix.Close(int(t.ioctlFd))
  706. t.ioctlFd = 0
  707. }
  708. return t.readers.Close()
  709. }