tun_linux.go 22 KB

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