1
0

tun_linux.go 22 KB

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