tun_linux.go 21 KB

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