tun_linux.go 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920
  1. //go:build !android && !e2e_testing
  2. // +build !android,!e2e_testing
  3. package overlay
  4. import (
  5. "fmt"
  6. "io"
  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/sirupsen/logrus"
  17. "github.com/slackhq/nebula/config"
  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. io.ReadWriteCloser
  25. fd int
  26. Device string
  27. vpnNetworks []netip.Prefix
  28. MaxMTU int
  29. DefaultMTU int
  30. TXQueueLen int
  31. deviceIndex int
  32. ioctlFd uintptr
  33. nonBlocking bool // true if fd is in non-blocking mode
  34. Routes atomic.Pointer[[]Route]
  35. routeTree atomic.Pointer[bart.Table[routing.Gateways]]
  36. routeChan chan struct{}
  37. useSystemRoutes bool
  38. useSystemRoutesBufferSize int
  39. // These are routes learned from `tun.use_system_route_table`
  40. // stored here to make it easier to restore them after a reload
  41. routesFromSystem map[netip.Prefix]routing.Gateways
  42. routesFromSystemLock sync.Mutex
  43. l *logrus.Logger
  44. }
  45. func (t *tun) Networks() []netip.Prefix {
  46. return t.vpnNetworks
  47. }
  48. type ifReq struct {
  49. Name [16]byte
  50. Flags uint16
  51. pad [8]byte
  52. }
  53. type ifreqMTU struct {
  54. Name [16]byte
  55. MTU int32
  56. pad [8]byte
  57. }
  58. type ifreqQLEN struct {
  59. Name [16]byte
  60. Value int32
  61. pad [8]byte
  62. }
  63. func newTunFromFd(c *config.C, l *logrus.Logger, deviceFd int, vpnNetworks []netip.Prefix) (*tun, error) {
  64. file := os.NewFile(uintptr(deviceFd), "/dev/net/tun")
  65. t, err := newTunGeneric(c, l, file, vpnNetworks)
  66. if err != nil {
  67. return nil, err
  68. }
  69. t.Device = "tun0"
  70. return t, nil
  71. }
  72. func newTun(c *config.C, l *logrus.Logger, vpnNetworks []netip.Prefix, multiqueue bool) (*tun, error) {
  73. fd, err := unix.Open("/dev/net/tun", os.O_RDWR, 0)
  74. if err != nil {
  75. // If /dev/net/tun doesn't exist, try to create it (will happen in docker)
  76. if os.IsNotExist(err) {
  77. err = os.MkdirAll("/dev/net", 0755)
  78. if err != nil {
  79. return nil, fmt.Errorf("/dev/net/tun doesn't exist, failed to mkdir -p /dev/net: %w", err)
  80. }
  81. err = unix.Mknod("/dev/net/tun", unix.S_IFCHR|0600, int(unix.Mkdev(10, 200)))
  82. if err != nil {
  83. return nil, 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 nil, fmt.Errorf("created /dev/net/tun, but still failed: %w", err)
  88. }
  89. } else {
  90. return nil, err
  91. }
  92. }
  93. var req ifReq
  94. req.Flags = uint16(unix.IFF_TUN | unix.IFF_NO_PI)
  95. if multiqueue {
  96. req.Flags |= unix.IFF_MULTI_QUEUE
  97. }
  98. nameStr := c.GetString("tun.dev", "")
  99. copy(req.Name[:], nameStr)
  100. if err = ioctl(uintptr(fd), uintptr(unix.TUNSETIFF), uintptr(unsafe.Pointer(&req))); err != nil {
  101. return nil, &NameError{
  102. Name: nameStr,
  103. Underlying: err,
  104. }
  105. }
  106. name := strings.Trim(string(req.Name[:]), "\x00")
  107. file := os.NewFile(uintptr(fd), "/dev/net/tun")
  108. t, err := newTunGeneric(c, l, file, vpnNetworks)
  109. if err != nil {
  110. return nil, err
  111. }
  112. t.Device = name
  113. return t, nil
  114. }
  115. func newTunGeneric(c *config.C, l *logrus.Logger, file *os.File, vpnNetworks []netip.Prefix) (*tun, error) {
  116. t := &tun{
  117. ReadWriteCloser: file,
  118. fd: int(file.Fd()),
  119. vpnNetworks: vpnNetworks,
  120. TXQueueLen: c.GetInt("tun.tx_queue", 500),
  121. useSystemRoutes: c.GetBool("tun.use_system_route_table", false),
  122. useSystemRoutesBufferSize: c.GetInt("tun.use_system_route_table_buffer_size", 0),
  123. routesFromSystem: map[netip.Prefix]routing.Gateways{},
  124. l: l,
  125. }
  126. err := t.reload(c, true)
  127. if err != nil {
  128. return nil, err
  129. }
  130. c.RegisterReloadCallback(func(c *config.C) {
  131. err := t.reload(c, false)
  132. if err != nil {
  133. util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
  134. }
  135. })
  136. return t, nil
  137. }
  138. func (t *tun) reload(c *config.C, initial bool) error {
  139. routeChange, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
  140. if err != nil {
  141. return err
  142. }
  143. if !initial && !routeChange && !c.HasChanged("tun.mtu") {
  144. return nil
  145. }
  146. routeTree, err := makeRouteTree(t.l, routes, true)
  147. if err != nil {
  148. return err
  149. }
  150. // Bring along any routes learned from the system route table on reload
  151. t.routesFromSystemLock.Lock()
  152. for dst, gw := range t.routesFromSystem {
  153. routeTree.Insert(dst, gw)
  154. }
  155. t.routesFromSystemLock.Unlock()
  156. oldDefaultMTU := t.DefaultMTU
  157. oldMaxMTU := t.MaxMTU
  158. newDefaultMTU := c.GetInt("tun.mtu", DefaultMTU)
  159. newMaxMTU := newDefaultMTU
  160. for i, r := range routes {
  161. if r.MTU == 0 {
  162. routes[i].MTU = newDefaultMTU
  163. }
  164. if r.MTU > t.MaxMTU {
  165. newMaxMTU = r.MTU
  166. }
  167. }
  168. t.MaxMTU = newMaxMTU
  169. t.DefaultMTU = newDefaultMTU
  170. // Teach nebula how to handle the routes before establishing them in the system table
  171. oldRoutes := t.Routes.Swap(&routes)
  172. t.routeTree.Store(routeTree)
  173. if !initial {
  174. if oldMaxMTU != newMaxMTU {
  175. t.setMTU()
  176. t.l.Infof("Set max MTU to %v was %v", t.MaxMTU, oldMaxMTU)
  177. }
  178. if oldDefaultMTU != newDefaultMTU {
  179. for i := range t.vpnNetworks {
  180. err := t.setDefaultRoute(t.vpnNetworks[i])
  181. if err != nil {
  182. t.l.Warn(err)
  183. } else {
  184. t.l.Infof("Set default MTU to %v was %v", t.DefaultMTU, oldDefaultMTU)
  185. }
  186. }
  187. }
  188. // Remove first, if the system removes a wanted route hopefully it will be re-added next
  189. t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
  190. // Ensure any routes we actually want are installed
  191. err = t.addRoutes(true)
  192. if err != nil {
  193. // This should never be called since addRoutes should log its own errors in a reload condition
  194. util.LogWithContextIfNeeded("Failed to refresh routes", err, t.l)
  195. }
  196. }
  197. return nil
  198. }
  199. func (t *tun) SupportsMultiqueue() bool {
  200. return true
  201. }
  202. func (t *tun) NewMultiQueueReader() (io.ReadWriteCloser, error) {
  203. fd, err := unix.Open("/dev/net/tun", os.O_RDWR|unix.O_NONBLOCK, 0)
  204. if err != nil {
  205. return nil, err
  206. }
  207. var req ifReq
  208. req.Flags = uint16(unix.IFF_TUN | unix.IFF_NO_PI | unix.IFF_MULTI_QUEUE)
  209. copy(req.Name[:], t.Device)
  210. if err = ioctl(uintptr(fd), uintptr(unix.TUNSETIFF), uintptr(unsafe.Pointer(&req))); err != nil {
  211. return nil, err
  212. }
  213. return &tunBatchReader{fd: fd, device: t.Device}, nil
  214. }
  215. // tunBatchReader implements BatchReader for efficient batch packet reading
  216. type tunBatchReader struct {
  217. fd int
  218. device string
  219. }
  220. func (r *tunBatchReader) Read(b []byte) (int, error) {
  221. // Use poll to wait for data, then read
  222. for {
  223. n, err := unix.Read(r.fd, b)
  224. if err == nil {
  225. return n, nil
  226. }
  227. if err == unix.EAGAIN || err == unix.EWOULDBLOCK {
  228. // Wait for data
  229. pfds := []unix.PollFd{{Fd: int32(r.fd), Events: unix.POLLIN}}
  230. _, err = unix.Poll(pfds, -1)
  231. if err != nil {
  232. if err == unix.EINTR {
  233. continue
  234. }
  235. return 0, err
  236. }
  237. continue
  238. }
  239. return n, err
  240. }
  241. }
  242. func (r *tunBatchReader) Write(b []byte) (int, error) {
  243. return unix.Write(r.fd, b)
  244. }
  245. func (r *tunBatchReader) Close() error {
  246. return unix.Close(r.fd)
  247. }
  248. // ReadBatch reads up to len(packets) packets from the TUN device.
  249. // It drains all available packets without blocking, using poll() only
  250. // when no packets have been read yet.
  251. func (r *tunBatchReader) ReadBatch(packets [][]byte, sizes []int) (int, error) {
  252. count := 0
  253. maxPackets := len(packets)
  254. if len(sizes) < maxPackets {
  255. maxPackets = len(sizes)
  256. }
  257. for count < maxPackets {
  258. n, err := unix.Read(r.fd, packets[count])
  259. if err == nil && n > 0 {
  260. sizes[count] = n
  261. count++
  262. continue
  263. }
  264. if err == unix.EAGAIN || err == unix.EWOULDBLOCK {
  265. // No more packets available
  266. if count > 0 {
  267. // We have some packets, return them
  268. return count, nil
  269. }
  270. // No packets yet, wait for at least one
  271. pfds := []unix.PollFd{{Fd: int32(r.fd), Events: unix.POLLIN}}
  272. _, err = unix.Poll(pfds, -1)
  273. if err != nil {
  274. if err == unix.EINTR {
  275. continue
  276. }
  277. return 0, err
  278. }
  279. continue
  280. }
  281. if err != nil {
  282. if count > 0 {
  283. // Return what we have
  284. return count, nil
  285. }
  286. return 0, err
  287. }
  288. if n == 0 {
  289. if count > 0 {
  290. return count, nil
  291. }
  292. return 0, io.EOF
  293. }
  294. }
  295. return count, nil
  296. }
  297. func (t *tun) RoutesFor(ip netip.Addr) routing.Gateways {
  298. r, _ := t.routeTree.Load().Lookup(ip)
  299. return r
  300. }
  301. func (t *tun) Write(b []byte) (int, error) {
  302. var nn int
  303. maximum := len(b)
  304. for {
  305. n, err := unix.Write(t.fd, b[nn:maximum])
  306. if n > 0 {
  307. nn += n
  308. }
  309. if nn == len(b) {
  310. return nn, err
  311. }
  312. if err != nil {
  313. return nn, err
  314. }
  315. if n == 0 {
  316. return nn, io.ErrUnexpectedEOF
  317. }
  318. }
  319. }
  320. // EnableBatchReading sets the TUN fd to non-blocking mode to enable batch reading.
  321. // This should be called before using ReadBatch.
  322. func (t *tun) EnableBatchReading() error {
  323. if t.nonBlocking {
  324. return nil
  325. }
  326. err := unix.SetNonblock(t.fd, true)
  327. if err != nil {
  328. return err
  329. }
  330. t.nonBlocking = true
  331. return nil
  332. }
  333. // Read overrides the default Read to handle non-blocking mode
  334. func (t *tun) Read(b []byte) (int, error) {
  335. if !t.nonBlocking {
  336. // Use the embedded ReadWriteCloser for blocking reads
  337. return t.ReadWriteCloser.Read(b)
  338. }
  339. // Non-blocking read with poll
  340. for {
  341. n, err := unix.Read(t.fd, b)
  342. if err == nil {
  343. return n, nil
  344. }
  345. if err == unix.EAGAIN || err == unix.EWOULDBLOCK {
  346. // Wait for data
  347. pfds := []unix.PollFd{{Fd: int32(t.fd), Events: unix.POLLIN}}
  348. _, err = unix.Poll(pfds, -1)
  349. if err != nil {
  350. if err == unix.EINTR {
  351. continue
  352. }
  353. return 0, err
  354. }
  355. continue
  356. }
  357. return n, err
  358. }
  359. }
  360. // ReadBatch reads up to len(packets) packets from the TUN device.
  361. // EnableBatchReading must be called first.
  362. func (t *tun) ReadBatch(packets [][]byte, sizes []int) (int, error) {
  363. if !t.nonBlocking {
  364. // Fallback to single read if non-blocking not enabled
  365. n, err := t.ReadWriteCloser.Read(packets[0])
  366. if err != nil {
  367. return 0, err
  368. }
  369. sizes[0] = n
  370. return 1, nil
  371. }
  372. count := 0
  373. maxPackets := len(packets)
  374. if len(sizes) < maxPackets {
  375. maxPackets = len(sizes)
  376. }
  377. for count < maxPackets {
  378. n, err := unix.Read(t.fd, packets[count])
  379. if err == nil && n > 0 {
  380. sizes[count] = n
  381. count++
  382. continue
  383. }
  384. if err == unix.EAGAIN || err == unix.EWOULDBLOCK {
  385. // No more packets available
  386. if count > 0 {
  387. return count, nil
  388. }
  389. // No packets yet, wait for at least one
  390. pfds := []unix.PollFd{{Fd: int32(t.fd), Events: unix.POLLIN}}
  391. _, err = unix.Poll(pfds, -1)
  392. if err != nil {
  393. if err == unix.EINTR {
  394. continue
  395. }
  396. return 0, err
  397. }
  398. continue
  399. }
  400. if err != nil {
  401. if count > 0 {
  402. return count, nil
  403. }
  404. return 0, err
  405. }
  406. if n == 0 {
  407. if count > 0 {
  408. return count, nil
  409. }
  410. return 0, io.EOF
  411. }
  412. }
  413. return count, nil
  414. }
  415. func (t *tun) deviceBytes() (o [16]byte) {
  416. for i, c := range t.Device {
  417. o[i] = byte(c)
  418. }
  419. return
  420. }
  421. func hasNetlinkAddr(al []*netlink.Addr, x netlink.Addr) bool {
  422. for i := range al {
  423. if al[i].Equal(x) {
  424. return true
  425. }
  426. }
  427. return false
  428. }
  429. // addIPs uses netlink to add all addresses that don't exist, then it removes ones that should not be there
  430. func (t *tun) addIPs(link netlink.Link) error {
  431. newAddrs := make([]*netlink.Addr, len(t.vpnNetworks))
  432. for i := range t.vpnNetworks {
  433. newAddrs[i] = &netlink.Addr{
  434. IPNet: &net.IPNet{
  435. IP: t.vpnNetworks[i].Addr().AsSlice(),
  436. Mask: net.CIDRMask(t.vpnNetworks[i].Bits(), t.vpnNetworks[i].Addr().BitLen()),
  437. },
  438. Label: t.vpnNetworks[i].Addr().Zone(),
  439. }
  440. }
  441. //add all new addresses
  442. for i := range newAddrs {
  443. //AddrReplace still adds new IPs, but if their properties change it will change them as well
  444. if err := netlink.AddrReplace(link, newAddrs[i]); err != nil {
  445. return err
  446. }
  447. }
  448. //iterate over remainder, remove whoever shouldn't be there
  449. al, err := netlink.AddrList(link, netlink.FAMILY_ALL)
  450. if err != nil {
  451. return fmt.Errorf("failed to get tun address list: %s", err)
  452. }
  453. for i := range al {
  454. if hasNetlinkAddr(newAddrs, al[i]) {
  455. continue
  456. }
  457. err = netlink.AddrDel(link, &al[i])
  458. if err != nil {
  459. t.l.WithError(err).Error("failed to remove address from tun address list")
  460. } else {
  461. t.l.WithField("removed", al[i].String()).Info("removed address not listed in cert(s)")
  462. }
  463. }
  464. return nil
  465. }
  466. func (t *tun) Activate() error {
  467. devName := t.deviceBytes()
  468. if t.useSystemRoutes {
  469. t.watchRoutes()
  470. }
  471. s, err := unix.Socket(
  472. unix.AF_INET, //because everything we use t.ioctlFd for is address family independent, this is fine
  473. unix.SOCK_DGRAM,
  474. unix.IPPROTO_IP,
  475. )
  476. if err != nil {
  477. return err
  478. }
  479. t.ioctlFd = uintptr(s)
  480. // Set the device name
  481. ifrf := ifReq{Name: devName}
  482. if err = ioctl(t.ioctlFd, unix.SIOCGIFFLAGS, uintptr(unsafe.Pointer(&ifrf))); err != nil {
  483. return fmt.Errorf("failed to set tun device name: %s", err)
  484. }
  485. link, err := netlink.LinkByName(t.Device)
  486. if err != nil {
  487. return fmt.Errorf("failed to get tun device link: %s", err)
  488. }
  489. t.deviceIndex = link.Attrs().Index
  490. // Setup our default MTU
  491. t.setMTU()
  492. // Set the transmit queue length
  493. ifrq := ifreqQLEN{Name: devName, Value: int32(t.TXQueueLen)}
  494. if err = ioctl(t.ioctlFd, unix.SIOCSIFTXQLEN, uintptr(unsafe.Pointer(&ifrq))); err != nil {
  495. // If we can't set the queue length nebula will still work but it may lead to packet loss
  496. t.l.WithError(err).Error("Failed to set tun tx queue length")
  497. }
  498. const modeNone = 1
  499. if err = netlink.LinkSetIP6AddrGenMode(link, modeNone); err != nil {
  500. t.l.WithError(err).Warn("Failed to disable link local address generation")
  501. }
  502. if err = t.addIPs(link); err != nil {
  503. return err
  504. }
  505. // Bring up the interface
  506. ifrf.Flags = ifrf.Flags | unix.IFF_UP
  507. if err = ioctl(t.ioctlFd, unix.SIOCSIFFLAGS, uintptr(unsafe.Pointer(&ifrf))); err != nil {
  508. return fmt.Errorf("failed to bring the tun device up: %s", err)
  509. }
  510. //set route MTU
  511. for i := range t.vpnNetworks {
  512. if err = t.setDefaultRoute(t.vpnNetworks[i]); err != nil {
  513. return fmt.Errorf("failed to set default route MTU: %w", err)
  514. }
  515. }
  516. // Set the routes
  517. if err = t.addRoutes(false); err != nil {
  518. return err
  519. }
  520. // Run the interface
  521. ifrf.Flags = ifrf.Flags | unix.IFF_UP | unix.IFF_RUNNING
  522. if err = ioctl(t.ioctlFd, unix.SIOCSIFFLAGS, uintptr(unsafe.Pointer(&ifrf))); err != nil {
  523. return fmt.Errorf("failed to run tun device: %s", err)
  524. }
  525. return nil
  526. }
  527. func (t *tun) setMTU() {
  528. // Set the MTU on the device
  529. ifm := ifreqMTU{Name: t.deviceBytes(), MTU: int32(t.MaxMTU)}
  530. if err := ioctl(t.ioctlFd, unix.SIOCSIFMTU, uintptr(unsafe.Pointer(&ifm))); err != nil {
  531. // This is currently a non fatal condition because the route table must have the MTU set appropriately as well
  532. t.l.WithError(err).Error("Failed to set tun mtu")
  533. }
  534. }
  535. func (t *tun) setDefaultRoute(cidr netip.Prefix) error {
  536. dr := &net.IPNet{
  537. IP: cidr.Masked().Addr().AsSlice(),
  538. Mask: net.CIDRMask(cidr.Bits(), cidr.Addr().BitLen()),
  539. }
  540. nr := netlink.Route{
  541. LinkIndex: t.deviceIndex,
  542. Dst: dr,
  543. MTU: t.DefaultMTU,
  544. AdvMSS: t.advMSS(Route{}),
  545. Scope: unix.RT_SCOPE_LINK,
  546. Src: net.IP(cidr.Addr().AsSlice()),
  547. Protocol: unix.RTPROT_KERNEL,
  548. Table: unix.RT_TABLE_MAIN,
  549. Type: unix.RTN_UNICAST,
  550. }
  551. err := netlink.RouteReplace(&nr)
  552. if err != nil {
  553. t.l.WithError(err).WithField("cidr", cidr).Warn("Failed to set default route MTU, retrying")
  554. //retry twice more -- on some systems there appears to be a race condition where if we set routes too soon, netlink says `invalid argument`
  555. for i := 0; i < 2; i++ {
  556. time.Sleep(100 * time.Millisecond)
  557. err = netlink.RouteReplace(&nr)
  558. if err == nil {
  559. break
  560. } else {
  561. t.l.WithError(err).WithField("cidr", cidr).WithField("mtu", t.DefaultMTU).Warn("Failed to set default route MTU, retrying")
  562. }
  563. }
  564. if err != nil {
  565. return fmt.Errorf("failed to set mtu %v on the default route %v; %v", t.DefaultMTU, dr, err)
  566. }
  567. }
  568. return nil
  569. }
  570. func (t *tun) addRoutes(logErrors bool) error {
  571. // Path routes
  572. routes := *t.Routes.Load()
  573. for _, r := range routes {
  574. if !r.Install {
  575. continue
  576. }
  577. dr := &net.IPNet{
  578. IP: r.Cidr.Masked().Addr().AsSlice(),
  579. Mask: net.CIDRMask(r.Cidr.Bits(), r.Cidr.Addr().BitLen()),
  580. }
  581. nr := netlink.Route{
  582. LinkIndex: t.deviceIndex,
  583. Dst: dr,
  584. MTU: r.MTU,
  585. AdvMSS: t.advMSS(r),
  586. Scope: unix.RT_SCOPE_LINK,
  587. }
  588. if r.Metric > 0 {
  589. nr.Priority = r.Metric
  590. }
  591. err := netlink.RouteReplace(&nr)
  592. if err != nil {
  593. retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
  594. if logErrors {
  595. retErr.Log(t.l)
  596. } else {
  597. return retErr
  598. }
  599. } else {
  600. t.l.WithField("route", r).Info("Added route")
  601. }
  602. }
  603. return nil
  604. }
  605. func (t *tun) removeRoutes(routes []Route) {
  606. for _, r := range routes {
  607. if !r.Install {
  608. continue
  609. }
  610. dr := &net.IPNet{
  611. IP: r.Cidr.Masked().Addr().AsSlice(),
  612. Mask: net.CIDRMask(r.Cidr.Bits(), r.Cidr.Addr().BitLen()),
  613. }
  614. nr := netlink.Route{
  615. LinkIndex: t.deviceIndex,
  616. Dst: dr,
  617. MTU: r.MTU,
  618. AdvMSS: t.advMSS(r),
  619. Scope: unix.RT_SCOPE_LINK,
  620. }
  621. if r.Metric > 0 {
  622. nr.Priority = r.Metric
  623. }
  624. err := netlink.RouteDel(&nr)
  625. if err != nil {
  626. t.l.WithError(err).WithField("route", r).Error("Failed to remove route")
  627. } else {
  628. t.l.WithField("route", r).Info("Removed route")
  629. }
  630. }
  631. }
  632. func (t *tun) Name() string {
  633. return t.Device
  634. }
  635. func (t *tun) advMSS(r Route) int {
  636. mtu := r.MTU
  637. if r.MTU == 0 {
  638. mtu = t.DefaultMTU
  639. }
  640. // We only need to set advmss if the route MTU does not match the device MTU
  641. if mtu != t.MaxMTU {
  642. return mtu - 40
  643. }
  644. return 0
  645. }
  646. func (t *tun) watchRoutes() {
  647. rch := make(chan netlink.RouteUpdate)
  648. doneChan := make(chan struct{})
  649. netlinkOptions := netlink.RouteSubscribeOptions{
  650. ReceiveBufferSize: t.useSystemRoutesBufferSize,
  651. ReceiveBufferForceSize: t.useSystemRoutesBufferSize != 0,
  652. ErrorCallback: func(e error) { t.l.WithError(e).Errorf("netlink error") },
  653. }
  654. if err := netlink.RouteSubscribeWithOptions(rch, doneChan, netlinkOptions); err != nil {
  655. t.l.WithError(err).Errorf("failed to subscribe to system route changes")
  656. return
  657. }
  658. t.routeChan = doneChan
  659. go func() {
  660. for {
  661. select {
  662. case r, ok := <-rch:
  663. if ok {
  664. t.updateRoutes(r)
  665. } else {
  666. // may be should do something here as
  667. // netlink stops sending updates
  668. return
  669. }
  670. case <-doneChan:
  671. // netlink.RouteSubscriber will close the rch for us
  672. return
  673. }
  674. }
  675. }()
  676. }
  677. func (t *tun) isGatewayInVpnNetworks(gwAddr netip.Addr) bool {
  678. withinNetworks := false
  679. for i := range t.vpnNetworks {
  680. if t.vpnNetworks[i].Contains(gwAddr) {
  681. withinNetworks = true
  682. break
  683. }
  684. }
  685. return withinNetworks
  686. }
  687. func (t *tun) getGatewaysFromRoute(r *netlink.Route) routing.Gateways {
  688. var gateways routing.Gateways
  689. link, err := netlink.LinkByName(t.Device)
  690. if err != nil {
  691. t.l.WithField("deviceName", t.Device).Error("Ignoring route update: failed to get link by name")
  692. return gateways
  693. }
  694. // If this route is relevant to our interface and there is a gateway then add it
  695. if r.LinkIndex == link.Attrs().Index {
  696. gwAddr, ok := getGatewayAddr(r.Gw, r.Via)
  697. if ok {
  698. if t.isGatewayInVpnNetworks(gwAddr) {
  699. gateways = append(gateways, routing.NewGateway(gwAddr, 1))
  700. } else {
  701. // Gateway isn't in our overlay network, ignore
  702. t.l.WithField("route", r).Debug("Ignoring route update, gateway is not in our network")
  703. }
  704. } else {
  705. t.l.WithField("route", r).Debug("Ignoring route update, invalid gateway or via address")
  706. }
  707. }
  708. for _, p := range r.MultiPath {
  709. // If this route is relevant to our interface and there is a gateway then add it
  710. if p.LinkIndex == link.Attrs().Index {
  711. gwAddr, ok := getGatewayAddr(p.Gw, p.Via)
  712. if ok {
  713. if t.isGatewayInVpnNetworks(gwAddr) {
  714. gateways = append(gateways, routing.NewGateway(gwAddr, p.Hops+1))
  715. } else {
  716. // Gateway isn't in our overlay network, ignore
  717. t.l.WithField("route", r).Debug("Ignoring route update, gateway is not in our network")
  718. }
  719. } else {
  720. t.l.WithField("route", r).Debug("Ignoring route update, invalid gateway or via address")
  721. }
  722. }
  723. }
  724. routing.CalculateBucketsForGateways(gateways)
  725. return gateways
  726. }
  727. func getGatewayAddr(gw net.IP, via netlink.Destination) (netip.Addr, bool) {
  728. // Try to use the old RTA_GATEWAY first
  729. gwAddr, ok := netip.AddrFromSlice(gw)
  730. if !ok {
  731. // Fallback to the new RTA_VIA
  732. rVia, ok := via.(*netlink.Via)
  733. if ok {
  734. gwAddr, ok = netip.AddrFromSlice(rVia.Addr)
  735. }
  736. }
  737. if gwAddr.IsValid() {
  738. gwAddr = gwAddr.Unmap()
  739. return gwAddr, true
  740. }
  741. return netip.Addr{}, false
  742. }
  743. func (t *tun) updateRoutes(r netlink.RouteUpdate) {
  744. gateways := t.getGatewaysFromRoute(&r.Route)
  745. if len(gateways) == 0 {
  746. // No gateways relevant to our network, no routing changes required.
  747. t.l.WithField("route", r).Debug("Ignoring route update, no gateways")
  748. return
  749. }
  750. if r.Dst == nil {
  751. t.l.WithField("route", r).Debug("Ignoring route update, no destination address")
  752. return
  753. }
  754. dstAddr, ok := netip.AddrFromSlice(r.Dst.IP)
  755. if !ok {
  756. t.l.WithField("route", r).Debug("Ignoring route update, invalid destination address")
  757. return
  758. }
  759. ones, _ := r.Dst.Mask.Size()
  760. dst := netip.PrefixFrom(dstAddr, ones)
  761. newTree := t.routeTree.Load().Clone()
  762. t.routesFromSystemLock.Lock()
  763. if r.Type == unix.RTM_NEWROUTE {
  764. t.l.WithField("destination", dst).WithField("via", gateways).Info("Adding route")
  765. t.routesFromSystem[dst] = gateways
  766. newTree.Insert(dst, gateways)
  767. } else {
  768. t.l.WithField("destination", dst).WithField("via", gateways).Info("Removing route")
  769. delete(t.routesFromSystem, dst)
  770. newTree.Delete(dst)
  771. }
  772. t.routesFromSystemLock.Unlock()
  773. t.routeTree.Store(newTree)
  774. }
  775. func (t *tun) Close() error {
  776. if t.routeChan != nil {
  777. close(t.routeChan)
  778. }
  779. if t.ReadWriteCloser != nil {
  780. _ = t.ReadWriteCloser.Close()
  781. }
  782. if t.ioctlFd > 0 {
  783. _ = os.NewFile(t.ioctlFd, "ioctlFd").Close()
  784. t.ioctlFd = 0
  785. }
  786. return nil
  787. }