tun_linux.go 21 KB

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