tun_linux.go 22 KB

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