1
0

tun_linux.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836
  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", 5000),
  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(t.l, 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. // Only the mtu changed. The routes are the same, parse them again so the ones without their own mtu pick up the
  223. // new default. Without this an mtu change would remove them all
  224. if !routeChange {
  225. _, routes, err = getAllRoutesFromConfig(t.l, c, t.vpnNetworks, true)
  226. if err != nil {
  227. return err
  228. }
  229. }
  230. routeTree, err := makeRouteTree(t.l, routes, true)
  231. if err != nil {
  232. return err
  233. }
  234. // Bring along any routes learned from the system route table on reload
  235. t.routesFromSystemLock.Lock()
  236. for dst, gw := range t.routesFromSystem {
  237. routeTree.Insert(dst, gw)
  238. }
  239. t.routesFromSystemLock.Unlock()
  240. oldDefaultMTU := t.DefaultMTU
  241. oldMaxMTU := t.MaxMTU
  242. newDefaultMTU := getMTU(t.l, c)
  243. newMaxMTU := newDefaultMTU
  244. for i, r := range routes {
  245. if r.MTU == 0 {
  246. routes[i].MTU = newDefaultMTU
  247. }
  248. if r.MTU > newMaxMTU {
  249. newMaxMTU = r.MTU
  250. }
  251. }
  252. t.MaxMTU = newMaxMTU
  253. t.DefaultMTU = newDefaultMTU
  254. // Teach nebula how to handle the routes before establishing them in the system table
  255. oldRoutes := t.Routes.Swap(&routes)
  256. t.routeTree.Store(routeTree)
  257. if !initial {
  258. if oldMaxMTU != newMaxMTU {
  259. t.setMTU()
  260. t.l.Info("Set max MTU", "mtu", t.MaxMTU, "oldMTU", oldMaxMTU)
  261. }
  262. if oldDefaultMTU != newDefaultMTU {
  263. for i := range t.vpnNetworks {
  264. err := t.setDefaultRoute(t.vpnNetworks[i])
  265. if err != nil {
  266. t.l.Warn(err.Error())
  267. } else {
  268. t.l.Info("Set default MTU", "mtu", t.DefaultMTU, "oldMTU", oldDefaultMTU)
  269. }
  270. }
  271. }
  272. // Remove first, if the system removes a wanted route hopefully it will be re-added next
  273. t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
  274. // Ensure any routes we actually want are installed
  275. err = t.addRoutes(true)
  276. if err != nil {
  277. // This should never be called since addRoutes should log its own errors in a reload condition
  278. util.LogWithContextIfNeeded("Failed to refresh routes", err, t.l)
  279. }
  280. }
  281. return nil
  282. }
  283. // Queues opens additional kernel multiqueue fds until the device has n queues, then returns them all.
  284. func (t *tun) Queues(n int) ([]tio.Queue, error) {
  285. for len(t.readers.Queues()) < n {
  286. if err := t.addQueue(); err != nil {
  287. return nil, err
  288. }
  289. }
  290. return t.readers.Queues(), nil
  291. }
  292. // addQueue opens one more IFF_MULTI_QUEUE fd on the device and adds it to the queue set.
  293. func (t *tun) addQueue() error {
  294. t.closeLock.Lock()
  295. defer t.closeLock.Unlock()
  296. fd, err := unix.Open("/dev/net/tun", os.O_RDWR, 0)
  297. if err != nil {
  298. return err
  299. }
  300. flags := uint16(unix.IFF_TUN | unix.IFF_NO_PI | unix.IFF_MULTI_QUEUE)
  301. if t.vnetHdr {
  302. flags |= unix.IFF_VNET_HDR
  303. }
  304. if _, err = tunSetIff(fd, t.Device, flags); err != nil {
  305. _ = unix.Close(fd)
  306. return err
  307. }
  308. if t.vnetHdr {
  309. if err = ioctl(uintptr(fd), unix.TUNSETOFFLOAD, uintptr(t.offloadFlags)); err != nil {
  310. _ = unix.Close(fd)
  311. return fmt.Errorf("failed to enable offload on multiqueue tun fd: %w", err)
  312. }
  313. }
  314. err = t.readers.Add(fd)
  315. if err != nil {
  316. _ = unix.Close(fd)
  317. return err
  318. }
  319. return nil
  320. }
  321. func (t *tun) RoutesFor(ip netip.Addr) routing.Gateways {
  322. r, _ := t.routeTree.Load().Lookup(ip)
  323. return r
  324. }
  325. func (t *tun) deviceBytes() (o [16]byte) {
  326. for i, c := range t.Device {
  327. o[i] = byte(c)
  328. }
  329. return
  330. }
  331. func hasNetlinkAddr(al []*netlink.Addr, x netlink.Addr) bool {
  332. for i := range al {
  333. if al[i].Equal(x) {
  334. return true
  335. }
  336. }
  337. return false
  338. }
  339. // addIPs uses netlink to add all addresses that don't exist, then it removes ones that should not be there
  340. func (t *tun) addIPs(link netlink.Link) error {
  341. newAddrs := make([]*netlink.Addr, len(t.vpnNetworks))
  342. for i := range t.vpnNetworks {
  343. newAddrs[i] = &netlink.Addr{
  344. IPNet: &net.IPNet{
  345. IP: t.vpnNetworks[i].Addr().AsSlice(),
  346. Mask: net.CIDRMask(t.vpnNetworks[i].Bits(), t.vpnNetworks[i].Addr().BitLen()),
  347. },
  348. Label: t.vpnNetworks[i].Addr().Zone(),
  349. }
  350. }
  351. //add all new addresses
  352. for i := range newAddrs {
  353. //AddrReplace still adds new IPs, but if their properties change it will change them as well
  354. if err := netlink.AddrReplace(link, newAddrs[i]); err != nil {
  355. return err
  356. }
  357. }
  358. //iterate over remainder, remove whoever shouldn't be there
  359. al, err := netlink.AddrList(link, netlink.FAMILY_ALL)
  360. if err != nil {
  361. //RTM_GETADDR dumps the whole system, so any concurrent address change
  362. //interrupts it - including the kernel's async tentative->preferred
  363. //flip of an IPv6 address the AddrReplace calls above just added,
  364. //which makes this a race against our own setup. Partial results are
  365. //still returned; the worst case is a stale address surviving until
  366. //the next config reload, which beats failing startup over it.
  367. if !errors.Is(err, netlink.ErrDumpInterrupted) {
  368. return fmt.Errorf("failed to get tun address list: %s", err)
  369. }
  370. t.l.Warn("tun address list dump was interrupted, stale addresses may remain")
  371. }
  372. for i := range al {
  373. if hasNetlinkAddr(newAddrs, al[i]) {
  374. continue
  375. }
  376. err = netlink.AddrDel(link, &al[i])
  377. if err != nil {
  378. t.l.Error("failed to remove address from tun address list", "error", err)
  379. } else {
  380. t.l.Info("removed address not listed in cert(s)", "removed", al[i].String())
  381. }
  382. }
  383. return nil
  384. }
  385. func (t *tun) Activate() error {
  386. devName := t.deviceBytes()
  387. if t.useSystemRoutes {
  388. t.watchRoutes()
  389. }
  390. s, err := unix.Socket(
  391. unix.AF_INET, //because everything we use t.ioctlFd for is address family independent, this is fine
  392. unix.SOCK_DGRAM,
  393. unix.IPPROTO_IP,
  394. )
  395. if err != nil {
  396. return err
  397. }
  398. t.ioctlFd = uintptr(s)
  399. // Set the device name
  400. ifrf := ifReq{Name: devName}
  401. if err = ioctl(t.ioctlFd, unix.SIOCGIFFLAGS, uintptr(unsafe.Pointer(&ifrf))); err != nil {
  402. return fmt.Errorf("failed to set tun device name: %s", err)
  403. }
  404. link, err := netlink.LinkByName(t.Device)
  405. if err != nil {
  406. return fmt.Errorf("failed to get tun device link: %s", err)
  407. }
  408. t.deviceIndex = link.Attrs().Index
  409. // Setup our default MTU
  410. t.setMTU()
  411. // Set the transmit queue length
  412. ifrq := ifreqQLEN{Name: devName, Value: int32(t.TXQueueLen)}
  413. if err = ioctl(t.ioctlFd, unix.SIOCSIFTXQLEN, uintptr(unsafe.Pointer(&ifrq))); err != nil {
  414. // If we can't set the queue length nebula will still work but it may lead to packet loss
  415. t.l.Error("Failed to set tun tx queue length", "error", err)
  416. }
  417. const modeNone = 1
  418. if err = netlink.LinkSetIP6AddrGenMode(link, modeNone); err != nil {
  419. t.l.Warn("Failed to disable link local address generation", "error", err)
  420. }
  421. if err = t.addIPs(link); err != nil {
  422. return err
  423. }
  424. // Bring up the interface
  425. ifrf.Flags = ifrf.Flags | unix.IFF_UP
  426. if err = ioctl(t.ioctlFd, unix.SIOCSIFFLAGS, uintptr(unsafe.Pointer(&ifrf))); err != nil {
  427. return fmt.Errorf("failed to bring the tun device up: %s", err)
  428. }
  429. //set route MTU
  430. for i := range t.vpnNetworks {
  431. if err = t.setDefaultRoute(t.vpnNetworks[i]); err != nil {
  432. return fmt.Errorf("failed to set default route MTU: %w", err)
  433. }
  434. }
  435. // Set the routes
  436. if err = t.addRoutes(false); err != nil {
  437. return err
  438. }
  439. // Run the interface
  440. ifrf.Flags = ifrf.Flags | unix.IFF_UP | unix.IFF_RUNNING
  441. if err = ioctl(t.ioctlFd, unix.SIOCSIFFLAGS, uintptr(unsafe.Pointer(&ifrf))); err != nil {
  442. return fmt.Errorf("failed to run tun device: %s", err)
  443. }
  444. return nil
  445. }
  446. func (t *tun) setMTU() {
  447. // Set the MTU on the device
  448. ifm := ifreqMTU{Name: t.deviceBytes(), MTU: int32(t.MaxMTU)}
  449. if err := ioctl(t.ioctlFd, unix.SIOCSIFMTU, uintptr(unsafe.Pointer(&ifm))); err != nil {
  450. // This is currently a non fatal condition because the route table must have the MTU set appropriately as well
  451. t.l.Error("Failed to set tun mtu", "error", err)
  452. }
  453. }
  454. func (t *tun) setDefaultRoute(cidr netip.Prefix) error {
  455. dr := &net.IPNet{
  456. IP: cidr.Masked().Addr().AsSlice(),
  457. Mask: net.CIDRMask(cidr.Bits(), cidr.Addr().BitLen()),
  458. }
  459. nr := netlink.Route{
  460. LinkIndex: t.deviceIndex,
  461. Dst: dr,
  462. MTU: t.DefaultMTU,
  463. AdvMSS: t.advMSS(Route{}),
  464. Scope: unix.RT_SCOPE_LINK,
  465. Src: net.IP(cidr.Addr().AsSlice()),
  466. Protocol: unix.RTPROT_KERNEL,
  467. Table: unix.RT_TABLE_MAIN,
  468. Type: unix.RTN_UNICAST,
  469. }
  470. // Match the metric the kernel uses for its auto-installed connected route,
  471. // so RouteReplace overwrites it in place instead of adding a second route at a worse metric.
  472. // IPv6 connected routes are installed at metric 256 (IP6_RT_PRIO_KERN); IPv4 uses 0.
  473. // Without this, the kernel route wins lookups and our MTU / AdvMSS / Features never apply on v6.
  474. if cidr.Addr().Is6() {
  475. nr.Priority = 256
  476. }
  477. err := netlink.RouteReplace(&nr)
  478. if err != nil {
  479. t.l.Warn("Failed to set default route MTU, retrying", "error", err, "cidr", cidr)
  480. //retry twice more -- on some systems there appears to be a race condition where if we set routes too soon, netlink says `invalid argument`
  481. for range 2 {
  482. time.Sleep(100 * time.Millisecond)
  483. err = netlink.RouteReplace(&nr)
  484. if err == nil {
  485. break
  486. } else {
  487. t.l.Warn("Failed to set default route MTU, retrying",
  488. "error", err,
  489. "cidr", cidr,
  490. "mtu", t.DefaultMTU,
  491. )
  492. }
  493. }
  494. if err != nil {
  495. return fmt.Errorf("failed to set mtu %v on the default route %v; %v", t.DefaultMTU, dr, err)
  496. }
  497. }
  498. return nil
  499. }
  500. func (t *tun) addRoutes(logErrors bool) error {
  501. // Path routes
  502. routes := *t.Routes.Load()
  503. for _, r := range routes {
  504. if !r.Install {
  505. continue
  506. }
  507. dr := &net.IPNet{
  508. IP: r.Cidr.Masked().Addr().AsSlice(),
  509. Mask: net.CIDRMask(r.Cidr.Bits(), r.Cidr.Addr().BitLen()),
  510. }
  511. nr := netlink.Route{
  512. LinkIndex: t.deviceIndex,
  513. Dst: dr,
  514. MTU: r.MTU,
  515. AdvMSS: t.advMSS(r),
  516. Scope: unix.RT_SCOPE_LINK,
  517. }
  518. if r.Metric > 0 {
  519. nr.Priority = r.Metric
  520. }
  521. err := netlink.RouteReplace(&nr)
  522. if err != nil {
  523. retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
  524. if logErrors {
  525. retErr.Log(t.l)
  526. } else {
  527. return retErr
  528. }
  529. } else {
  530. t.l.Info("Added route", "route", r)
  531. }
  532. }
  533. return nil
  534. }
  535. func (t *tun) removeRoutes(routes []Route) {
  536. for _, r := range routes {
  537. if !r.Install {
  538. continue
  539. }
  540. dr := &net.IPNet{
  541. IP: r.Cidr.Masked().Addr().AsSlice(),
  542. Mask: net.CIDRMask(r.Cidr.Bits(), r.Cidr.Addr().BitLen()),
  543. }
  544. nr := netlink.Route{
  545. LinkIndex: t.deviceIndex,
  546. Dst: dr,
  547. MTU: r.MTU,
  548. AdvMSS: t.advMSS(r),
  549. Scope: unix.RT_SCOPE_LINK,
  550. }
  551. if r.Metric > 0 {
  552. nr.Priority = r.Metric
  553. }
  554. err := netlink.RouteDel(&nr)
  555. if err != nil {
  556. t.l.Error("Failed to remove route", "error", err, "route", r)
  557. } else {
  558. t.l.Info("Removed route", "route", r)
  559. }
  560. }
  561. }
  562. func (t *tun) Name() string {
  563. return t.Device
  564. }
  565. func (t *tun) advMSS(r Route) int {
  566. mtu := r.MTU
  567. if r.MTU == 0 {
  568. mtu = t.DefaultMTU
  569. }
  570. // We only need to set advmss if the route MTU does not match the device MTU
  571. if mtu != t.MaxMTU {
  572. return mtu - 40
  573. }
  574. return 0
  575. }
  576. func (t *tun) watchRoutes() {
  577. rch := make(chan netlink.RouteUpdate)
  578. doneChan := make(chan struct{})
  579. netlinkOptions := netlink.RouteSubscribeOptions{
  580. ReceiveBufferSize: t.useSystemRoutesBufferSize,
  581. ReceiveBufferForceSize: t.useSystemRoutesBufferSize != 0,
  582. ErrorCallback: func(e error) { t.l.Error("netlink error", "error", e) },
  583. }
  584. if err := netlink.RouteSubscribeWithOptions(rch, doneChan, netlinkOptions); err != nil {
  585. t.l.Error("failed to subscribe to system route changes", "error", err)
  586. return
  587. }
  588. t.routeChan = doneChan
  589. go func() {
  590. for {
  591. select {
  592. case r, ok := <-rch:
  593. if ok {
  594. t.updateRoutes(r)
  595. } else {
  596. // may be should do something here as
  597. // netlink stops sending updates
  598. return
  599. }
  600. case <-doneChan:
  601. // netlink.RouteSubscriber will close the rch for us
  602. return
  603. }
  604. }
  605. }()
  606. }
  607. func (t *tun) isGatewayInVpnNetworks(gwAddr netip.Addr) bool {
  608. withinNetworks := false
  609. for i := range t.vpnNetworks {
  610. if t.vpnNetworks[i].Contains(gwAddr) {
  611. withinNetworks = true
  612. break
  613. }
  614. }
  615. return withinNetworks
  616. }
  617. func (t *tun) getGatewaysFromRoute(r *netlink.Route) routing.Gateways {
  618. var gateways routing.Gateways
  619. link, err := netlink.LinkByName(t.Device)
  620. if err != nil {
  621. t.l.Error("Ignoring route update: failed to get link by name", "deviceName", t.Device)
  622. return gateways
  623. }
  624. // If this route is relevant to our interface and there is a gateway then add it
  625. if r.LinkIndex == link.Attrs().Index {
  626. gwAddr, ok := getGatewayAddr(r.Gw, r.Via)
  627. if ok {
  628. if t.isGatewayInVpnNetworks(gwAddr) {
  629. gateways = append(gateways, routing.NewGateway(gwAddr, 1))
  630. } else {
  631. // Gateway isn't in our overlay network, ignore
  632. t.l.Debug("Ignoring route update, gateway is not in our network", "route", r)
  633. }
  634. } else {
  635. t.l.Debug("Ignoring route update, invalid gateway or via address", "route", r)
  636. }
  637. }
  638. for _, p := range r.MultiPath {
  639. // If this route is relevant to our interface and there is a gateway then add it
  640. if p.LinkIndex == link.Attrs().Index {
  641. gwAddr, ok := getGatewayAddr(p.Gw, p.Via)
  642. if ok {
  643. if t.isGatewayInVpnNetworks(gwAddr) {
  644. gateways = append(gateways, routing.NewGateway(gwAddr, p.Hops+1))
  645. } else {
  646. // Gateway isn't in our overlay network, ignore
  647. t.l.Debug("Ignoring route update, gateway is not in our network", "route", r)
  648. }
  649. } else {
  650. t.l.Debug("Ignoring route update, invalid gateway or via address", "route", r)
  651. }
  652. }
  653. }
  654. routing.CalculateBucketsForGateways(gateways)
  655. return gateways
  656. }
  657. func getGatewayAddr(gw net.IP, via netlink.Destination) (netip.Addr, bool) {
  658. // Try to use the old RTA_GATEWAY first
  659. gwAddr, ok := netip.AddrFromSlice(gw)
  660. if !ok {
  661. // Fallback to the new RTA_VIA
  662. rVia, ok := via.(*netlink.Via)
  663. if ok {
  664. gwAddr, ok = netip.AddrFromSlice(rVia.Addr)
  665. }
  666. }
  667. if gwAddr.IsValid() {
  668. gwAddr = gwAddr.Unmap()
  669. return gwAddr, true
  670. }
  671. return netip.Addr{}, false
  672. }
  673. func (t *tun) updateRoutes(r netlink.RouteUpdate) {
  674. gateways := t.getGatewaysFromRoute(&r.Route)
  675. if len(gateways) == 0 {
  676. // No gateways relevant to our network, no routing changes required.
  677. t.l.Debug("Ignoring route update, no gateways", "route", r)
  678. return
  679. }
  680. if r.Dst == nil {
  681. t.l.Debug("Ignoring route update, no destination address", "route", r)
  682. return
  683. }
  684. dstAddr, ok := netip.AddrFromSlice(r.Dst.IP)
  685. if !ok {
  686. t.l.Debug("Ignoring route update, invalid destination address", "route", r)
  687. return
  688. }
  689. ones, _ := r.Dst.Mask.Size()
  690. dst := netip.PrefixFrom(dstAddr, ones)
  691. newTree := t.routeTree.Load().Clone()
  692. t.routesFromSystemLock.Lock()
  693. if r.Type == unix.RTM_NEWROUTE {
  694. t.l.Info("Adding route", "destination", dst, "via", gateways)
  695. t.routesFromSystem[dst] = gateways
  696. newTree.Insert(dst, gateways)
  697. } else {
  698. t.l.Info("Removing route", "destination", dst, "via", gateways)
  699. delete(t.routesFromSystem, dst)
  700. newTree.Delete(dst)
  701. }
  702. t.routesFromSystemLock.Unlock()
  703. t.routeTree.Store(newTree)
  704. }
  705. func (t *tun) Close() error {
  706. t.closeLock.Lock()
  707. defer t.closeLock.Unlock()
  708. if t.routeChan != nil {
  709. close(t.routeChan)
  710. t.routeChan = nil
  711. }
  712. if t.ioctlFd > 0 {
  713. _ = unix.Close(int(t.ioctlFd))
  714. t.ioctlFd = 0
  715. }
  716. return t.readers.Close()
  717. }