tun_linux.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940
  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. // Validate the device name up front so a bad tun.dev fails fast, before we
  228. // open /dev/net/tun or leak a file descriptor. A single %d in the name is
  229. // substituted by the kernel during TUNSETIFF (dev_alloc_name) with the
  230. // lowest number that yields an unused device name. Resolving the template
  231. // in the kernel keeps the pick-a-name/create-the-device pair atomic, so
  232. // concurrent callers can never race each other to the same name.
  233. tunName := c.GetString("tun.dev", "nebula%d")
  234. if err := validateTunName(tunName); err != nil {
  235. return nil, err
  236. }
  237. fd, err := unix.Open("/dev/net/tun", os.O_RDWR, 0)
  238. if err != nil {
  239. // If /dev/net/tun doesn't exist, try to create it (will happen in docker)
  240. if os.IsNotExist(err) {
  241. err = os.MkdirAll("/dev/net", 0755)
  242. if err != nil {
  243. return nil, fmt.Errorf("/dev/net/tun doesn't exist, failed to mkdir -p /dev/net: %w", err)
  244. }
  245. err = unix.Mknod("/dev/net/tun", unix.S_IFCHR|0600, int(unix.Mkdev(10, 200)))
  246. if err != nil {
  247. return nil, fmt.Errorf("failed to create /dev/net/tun: %w", err)
  248. }
  249. fd, err = unix.Open("/dev/net/tun", os.O_RDWR, 0)
  250. if err != nil {
  251. return nil, fmt.Errorf("created /dev/net/tun, but still failed: %w", err)
  252. }
  253. } else {
  254. return nil, err
  255. }
  256. }
  257. var req ifReq
  258. req.Flags = uint16(unix.IFF_TUN | unix.IFF_NO_PI)
  259. if multiqueue {
  260. req.Flags |= unix.IFF_MULTI_QUEUE
  261. }
  262. copy(req.Name[:], tunName)
  263. if err = ioctl(uintptr(fd), uintptr(unix.TUNSETIFF), uintptr(unsafe.Pointer(&req))); err != nil {
  264. _ = unix.Close(fd)
  265. return nil, &NameError{
  266. Name: tunName,
  267. Underlying: err,
  268. }
  269. }
  270. name := strings.Trim(string(req.Name[:]), "\x00")
  271. t, err := newTunGeneric(c, l, fd, vpnNetworks)
  272. if err != nil {
  273. return nil, err
  274. }
  275. t.Device = name
  276. return t, nil
  277. }
  278. func validateTunName(tunName string) error {
  279. if !strings.Contains(tunName, "%d") {
  280. if len(tunName) >= unix.IFNAMSIZ {
  281. return fmt.Errorf("tun.dev %q is not shorter than the maximum device name length of %d", tunName, unix.IFNAMSIZ)
  282. }
  283. return nil
  284. }
  285. if strings.Count(tunName, "%d") > 1 {
  286. return fmt.Errorf("tun.dev template %q may only contain a single %%d", tunName)
  287. }
  288. if tunName == "%d" {
  289. return errors.New("please don't name your tun device '%d'")
  290. }
  291. // The kernel substitutes the %d itself and requires the template, like a
  292. // literal name, to be NUL-terminated within IFNAMSIZ bytes.
  293. if len(tunName) >= unix.IFNAMSIZ {
  294. return fmt.Errorf("tun.dev template %q is not shorter than the maximum device name length of %d", tunName, unix.IFNAMSIZ)
  295. }
  296. return nil
  297. }
  298. // newTunGeneric does all the stuff common to different tun initialization paths. It will close your files on error.
  299. func newTunGeneric(c *config.C, l *slog.Logger, fd int, vpnNetworks []netip.Prefix) (*tun, error) {
  300. tfd, err := newTunFd(fd)
  301. if err != nil {
  302. _ = unix.Close(fd)
  303. return nil, err
  304. }
  305. t := &tun{
  306. tunFile: tfd,
  307. readers: []*tunFile{tfd},
  308. closeLock: sync.Mutex{},
  309. vpnNetworks: vpnNetworks,
  310. TXQueueLen: c.GetInt("tun.tx_queue", 500),
  311. useSystemRoutes: c.GetBool("tun.use_system_route_table", false),
  312. useSystemRoutesBufferSize: c.GetInt("tun.use_system_route_table_buffer_size", 0),
  313. routesFromSystem: map[netip.Prefix]routing.Gateways{},
  314. l: l,
  315. }
  316. if err = t.reload(c, true); err != nil {
  317. _ = t.Close()
  318. return nil, err
  319. }
  320. c.RegisterReloadCallback(func(c *config.C) {
  321. err := t.reload(c, false)
  322. if err != nil {
  323. util.LogWithContextIfNeeded("failed to reload tun device", err, t.l)
  324. }
  325. })
  326. return t, nil
  327. }
  328. func (t *tun) reload(c *config.C, initial bool) error {
  329. routeChange, routes, err := getAllRoutesFromConfig(c, t.vpnNetworks, initial)
  330. if err != nil {
  331. return err
  332. }
  333. if !initial && !routeChange && !c.HasChanged("tun.mtu") {
  334. return nil
  335. }
  336. routeTree, err := makeRouteTree(t.l, routes, true)
  337. if err != nil {
  338. return err
  339. }
  340. // Bring along any routes learned from the system route table on reload
  341. t.routesFromSystemLock.Lock()
  342. for dst, gw := range t.routesFromSystem {
  343. routeTree.Insert(dst, gw)
  344. }
  345. t.routesFromSystemLock.Unlock()
  346. oldDefaultMTU := t.DefaultMTU
  347. oldMaxMTU := t.MaxMTU
  348. newDefaultMTU := c.GetInt("tun.mtu", DefaultMTU)
  349. newMaxMTU := newDefaultMTU
  350. for i, r := range routes {
  351. if r.MTU == 0 {
  352. routes[i].MTU = newDefaultMTU
  353. }
  354. if r.MTU > t.MaxMTU {
  355. newMaxMTU = r.MTU
  356. }
  357. }
  358. t.MaxMTU = newMaxMTU
  359. t.DefaultMTU = newDefaultMTU
  360. // Teach nebula how to handle the routes before establishing them in the system table
  361. oldRoutes := t.Routes.Swap(&routes)
  362. t.routeTree.Store(routeTree)
  363. if !initial {
  364. if oldMaxMTU != newMaxMTU {
  365. t.setMTU()
  366. t.l.Info("Set max MTU", "mtu", t.MaxMTU, "oldMTU", oldMaxMTU)
  367. }
  368. if oldDefaultMTU != newDefaultMTU {
  369. for i := range t.vpnNetworks {
  370. err := t.setDefaultRoute(t.vpnNetworks[i])
  371. if err != nil {
  372. t.l.Warn(err.Error())
  373. } else {
  374. t.l.Info("Set default MTU", "mtu", t.DefaultMTU, "oldMTU", oldDefaultMTU)
  375. }
  376. }
  377. }
  378. // Remove first, if the system removes a wanted route hopefully it will be re-added next
  379. t.removeRoutes(findRemovedRoutes(routes, *oldRoutes))
  380. // Ensure any routes we actually want are installed
  381. err = t.addRoutes(true)
  382. if err != nil {
  383. // This should never be called since addRoutes should log its own errors in a reload condition
  384. util.LogWithContextIfNeeded("Failed to refresh routes", err, t.l)
  385. }
  386. }
  387. return nil
  388. }
  389. func (t *tun) SupportsMultiqueue() bool {
  390. return true
  391. }
  392. func (t *tun) NewMultiQueueReader() (io.ReadWriteCloser, error) {
  393. t.closeLock.Lock()
  394. defer t.closeLock.Unlock()
  395. fd, err := unix.Open("/dev/net/tun", os.O_RDWR, 0)
  396. if err != nil {
  397. return nil, err
  398. }
  399. var req ifReq
  400. req.Flags = uint16(unix.IFF_TUN | unix.IFF_NO_PI | unix.IFF_MULTI_QUEUE)
  401. copy(req.Name[:], t.Device)
  402. if err = ioctl(uintptr(fd), uintptr(unix.TUNSETIFF), uintptr(unsafe.Pointer(&req))); err != nil {
  403. _ = unix.Close(fd)
  404. return nil, err
  405. }
  406. out, err := t.tunFile.newFriend(fd)
  407. if err != nil {
  408. _ = unix.Close(fd)
  409. return nil, err
  410. }
  411. t.readers = append(t.readers, out)
  412. return out, nil
  413. }
  414. func (t *tun) RoutesFor(ip netip.Addr) routing.Gateways {
  415. r, _ := t.routeTree.Load().Lookup(ip)
  416. return r
  417. }
  418. func (t *tun) deviceBytes() (o [16]byte) {
  419. for i, c := range t.Device {
  420. o[i] = byte(c)
  421. }
  422. return
  423. }
  424. func hasNetlinkAddr(al []*netlink.Addr, x netlink.Addr) bool {
  425. for i := range al {
  426. if al[i].Equal(x) {
  427. return true
  428. }
  429. }
  430. return false
  431. }
  432. // addIPs uses netlink to add all addresses that don't exist, then it removes ones that should not be there
  433. func (t *tun) addIPs(link netlink.Link) error {
  434. newAddrs := make([]*netlink.Addr, len(t.vpnNetworks))
  435. for i := range t.vpnNetworks {
  436. newAddrs[i] = &netlink.Addr{
  437. IPNet: &net.IPNet{
  438. IP: t.vpnNetworks[i].Addr().AsSlice(),
  439. Mask: net.CIDRMask(t.vpnNetworks[i].Bits(), t.vpnNetworks[i].Addr().BitLen()),
  440. },
  441. Label: t.vpnNetworks[i].Addr().Zone(),
  442. }
  443. }
  444. //add all new addresses
  445. for i := range newAddrs {
  446. //AddrReplace still adds new IPs, but if their properties change it will change them as well
  447. if err := netlink.AddrReplace(link, newAddrs[i]); err != nil {
  448. return err
  449. }
  450. }
  451. //iterate over remainder, remove whoever shouldn't be there
  452. al, err := netlink.AddrList(link, netlink.FAMILY_ALL)
  453. if err != nil {
  454. return fmt.Errorf("failed to get tun address list: %s", err)
  455. }
  456. for i := range al {
  457. if hasNetlinkAddr(newAddrs, al[i]) {
  458. continue
  459. }
  460. err = netlink.AddrDel(link, &al[i])
  461. if err != nil {
  462. t.l.Error("failed to remove address from tun address list", "error", err)
  463. } else {
  464. t.l.Info("removed address not listed in cert(s)", "removed", al[i].String())
  465. }
  466. }
  467. return nil
  468. }
  469. func (t *tun) Activate() error {
  470. devName := t.deviceBytes()
  471. if t.useSystemRoutes {
  472. t.watchRoutes()
  473. }
  474. s, err := unix.Socket(
  475. unix.AF_INET, //because everything we use t.ioctlFd for is address family independent, this is fine
  476. unix.SOCK_DGRAM,
  477. unix.IPPROTO_IP,
  478. )
  479. if err != nil {
  480. return err
  481. }
  482. t.ioctlFd = uintptr(s)
  483. // Set the device name
  484. ifrf := ifReq{Name: devName}
  485. if err = ioctl(t.ioctlFd, unix.SIOCGIFFLAGS, uintptr(unsafe.Pointer(&ifrf))); err != nil {
  486. return fmt.Errorf("failed to set tun device name: %s", err)
  487. }
  488. link, err := netlink.LinkByName(t.Device)
  489. if err != nil {
  490. return fmt.Errorf("failed to get tun device link: %s", err)
  491. }
  492. t.deviceIndex = link.Attrs().Index
  493. // Setup our default MTU
  494. t.setMTU()
  495. // Set the transmit queue length
  496. ifrq := ifreqQLEN{Name: devName, Value: int32(t.TXQueueLen)}
  497. if err = ioctl(t.ioctlFd, unix.SIOCSIFTXQLEN, uintptr(unsafe.Pointer(&ifrq))); err != nil {
  498. // If we can't set the queue length nebula will still work but it may lead to packet loss
  499. t.l.Error("Failed to set tun tx queue length", "error", err)
  500. }
  501. const modeNone = 1
  502. if err = netlink.LinkSetIP6AddrGenMode(link, modeNone); err != nil {
  503. t.l.Warn("Failed to disable link local address generation", "error", err)
  504. }
  505. if err = t.addIPs(link); err != nil {
  506. return err
  507. }
  508. // Bring up the interface
  509. ifrf.Flags = ifrf.Flags | unix.IFF_UP
  510. if err = ioctl(t.ioctlFd, unix.SIOCSIFFLAGS, uintptr(unsafe.Pointer(&ifrf))); err != nil {
  511. return fmt.Errorf("failed to bring the tun device up: %s", err)
  512. }
  513. //set route MTU
  514. for i := range t.vpnNetworks {
  515. if err = t.setDefaultRoute(t.vpnNetworks[i]); err != nil {
  516. return fmt.Errorf("failed to set default route MTU: %w", err)
  517. }
  518. }
  519. // Set the routes
  520. if err = t.addRoutes(false); err != nil {
  521. return err
  522. }
  523. // Run the interface
  524. ifrf.Flags = ifrf.Flags | unix.IFF_UP | unix.IFF_RUNNING
  525. if err = ioctl(t.ioctlFd, unix.SIOCSIFFLAGS, uintptr(unsafe.Pointer(&ifrf))); err != nil {
  526. return fmt.Errorf("failed to run tun device: %s", err)
  527. }
  528. return nil
  529. }
  530. func (t *tun) setMTU() {
  531. // Set the MTU on the device
  532. ifm := ifreqMTU{Name: t.deviceBytes(), MTU: int32(t.MaxMTU)}
  533. if err := ioctl(t.ioctlFd, unix.SIOCSIFMTU, uintptr(unsafe.Pointer(&ifm))); err != nil {
  534. // This is currently a non fatal condition because the route table must have the MTU set appropriately as well
  535. t.l.Error("Failed to set tun mtu", "error", err)
  536. }
  537. }
  538. func (t *tun) setDefaultRoute(cidr netip.Prefix) error {
  539. dr := &net.IPNet{
  540. IP: cidr.Masked().Addr().AsSlice(),
  541. Mask: net.CIDRMask(cidr.Bits(), cidr.Addr().BitLen()),
  542. }
  543. nr := netlink.Route{
  544. LinkIndex: t.deviceIndex,
  545. Dst: dr,
  546. MTU: t.DefaultMTU,
  547. AdvMSS: t.advMSS(Route{}),
  548. Scope: unix.RT_SCOPE_LINK,
  549. Src: net.IP(cidr.Addr().AsSlice()),
  550. Protocol: unix.RTPROT_KERNEL,
  551. Table: unix.RT_TABLE_MAIN,
  552. Type: unix.RTN_UNICAST,
  553. }
  554. err := netlink.RouteReplace(&nr)
  555. if err != nil {
  556. t.l.Warn("Failed to set default route MTU, retrying", "error", err, "cidr", cidr)
  557. //retry twice more -- on some systems there appears to be a race condition where if we set routes too soon, netlink says `invalid argument`
  558. for i := 0; i < 2; i++ {
  559. time.Sleep(100 * time.Millisecond)
  560. err = netlink.RouteReplace(&nr)
  561. if err == nil {
  562. break
  563. } else {
  564. t.l.Warn("Failed to set default route MTU, retrying",
  565. "error", err,
  566. "cidr", cidr,
  567. "mtu", t.DefaultMTU,
  568. )
  569. }
  570. }
  571. if err != nil {
  572. return fmt.Errorf("failed to set mtu %v on the default route %v; %v", t.DefaultMTU, dr, err)
  573. }
  574. }
  575. return nil
  576. }
  577. func (t *tun) addRoutes(logErrors bool) error {
  578. // Path routes
  579. routes := *t.Routes.Load()
  580. for _, r := range routes {
  581. if !r.Install {
  582. continue
  583. }
  584. dr := &net.IPNet{
  585. IP: r.Cidr.Masked().Addr().AsSlice(),
  586. Mask: net.CIDRMask(r.Cidr.Bits(), r.Cidr.Addr().BitLen()),
  587. }
  588. nr := netlink.Route{
  589. LinkIndex: t.deviceIndex,
  590. Dst: dr,
  591. MTU: r.MTU,
  592. AdvMSS: t.advMSS(r),
  593. Scope: unix.RT_SCOPE_LINK,
  594. }
  595. if r.Metric > 0 {
  596. nr.Priority = r.Metric
  597. }
  598. err := netlink.RouteReplace(&nr)
  599. if err != nil {
  600. retErr := util.NewContextualError("Failed to add route", map[string]any{"route": r}, err)
  601. if logErrors {
  602. retErr.Log(t.l)
  603. } else {
  604. return retErr
  605. }
  606. } else {
  607. t.l.Info("Added route", "route", r)
  608. }
  609. }
  610. return nil
  611. }
  612. func (t *tun) removeRoutes(routes []Route) {
  613. for _, r := range routes {
  614. if !r.Install {
  615. continue
  616. }
  617. dr := &net.IPNet{
  618. IP: r.Cidr.Masked().Addr().AsSlice(),
  619. Mask: net.CIDRMask(r.Cidr.Bits(), r.Cidr.Addr().BitLen()),
  620. }
  621. nr := netlink.Route{
  622. LinkIndex: t.deviceIndex,
  623. Dst: dr,
  624. MTU: r.MTU,
  625. AdvMSS: t.advMSS(r),
  626. Scope: unix.RT_SCOPE_LINK,
  627. }
  628. if r.Metric > 0 {
  629. nr.Priority = r.Metric
  630. }
  631. err := netlink.RouteDel(&nr)
  632. if err != nil {
  633. t.l.Error("Failed to remove route", "error", err, "route", r)
  634. } else {
  635. t.l.Info("Removed route", "route", r)
  636. }
  637. }
  638. }
  639. func (t *tun) Name() string {
  640. return t.Device
  641. }
  642. func (t *tun) advMSS(r Route) int {
  643. mtu := r.MTU
  644. if r.MTU == 0 {
  645. mtu = t.DefaultMTU
  646. }
  647. // We only need to set advmss if the route MTU does not match the device MTU
  648. if mtu != t.MaxMTU {
  649. return mtu - 40
  650. }
  651. return 0
  652. }
  653. func (t *tun) watchRoutes() {
  654. rch := make(chan netlink.RouteUpdate)
  655. doneChan := make(chan struct{})
  656. netlinkOptions := netlink.RouteSubscribeOptions{
  657. ReceiveBufferSize: t.useSystemRoutesBufferSize,
  658. ReceiveBufferForceSize: t.useSystemRoutesBufferSize != 0,
  659. ErrorCallback: func(e error) { t.l.Error("netlink error", "error", e) },
  660. }
  661. if err := netlink.RouteSubscribeWithOptions(rch, doneChan, netlinkOptions); err != nil {
  662. t.l.Error("failed to subscribe to system route changes", "error", err)
  663. return
  664. }
  665. t.routeChan = doneChan
  666. go func() {
  667. for {
  668. select {
  669. case r, ok := <-rch:
  670. if ok {
  671. t.updateRoutes(r)
  672. } else {
  673. // may be should do something here as
  674. // netlink stops sending updates
  675. return
  676. }
  677. case <-doneChan:
  678. // netlink.RouteSubscriber will close the rch for us
  679. return
  680. }
  681. }
  682. }()
  683. }
  684. func (t *tun) isGatewayInVpnNetworks(gwAddr netip.Addr) bool {
  685. withinNetworks := false
  686. for i := range t.vpnNetworks {
  687. if t.vpnNetworks[i].Contains(gwAddr) {
  688. withinNetworks = true
  689. break
  690. }
  691. }
  692. return withinNetworks
  693. }
  694. func (t *tun) getGatewaysFromRoute(r *netlink.Route) routing.Gateways {
  695. var gateways routing.Gateways
  696. link, err := netlink.LinkByName(t.Device)
  697. if err != nil {
  698. t.l.Error("Ignoring route update: failed to get link by name", "deviceName", t.Device)
  699. return gateways
  700. }
  701. // If this route is relevant to our interface and there is a gateway then add it
  702. if r.LinkIndex == link.Attrs().Index {
  703. gwAddr, ok := getGatewayAddr(r.Gw, r.Via)
  704. if ok {
  705. if t.isGatewayInVpnNetworks(gwAddr) {
  706. gateways = append(gateways, routing.NewGateway(gwAddr, 1))
  707. } else {
  708. // Gateway isn't in our overlay network, ignore
  709. t.l.Debug("Ignoring route update, gateway is not in our network", "route", r)
  710. }
  711. } else {
  712. t.l.Debug("Ignoring route update, invalid gateway or via address", "route", r)
  713. }
  714. }
  715. for _, p := range r.MultiPath {
  716. // If this route is relevant to our interface and there is a gateway then add it
  717. if p.LinkIndex == link.Attrs().Index {
  718. gwAddr, ok := getGatewayAddr(p.Gw, p.Via)
  719. if ok {
  720. if t.isGatewayInVpnNetworks(gwAddr) {
  721. gateways = append(gateways, routing.NewGateway(gwAddr, p.Hops+1))
  722. } else {
  723. // Gateway isn't in our overlay network, ignore
  724. t.l.Debug("Ignoring route update, gateway is not in our network", "route", r)
  725. }
  726. } else {
  727. t.l.Debug("Ignoring route update, invalid gateway or via address", "route", r)
  728. }
  729. }
  730. }
  731. routing.CalculateBucketsForGateways(gateways)
  732. return gateways
  733. }
  734. func getGatewayAddr(gw net.IP, via netlink.Destination) (netip.Addr, bool) {
  735. // Try to use the old RTA_GATEWAY first
  736. gwAddr, ok := netip.AddrFromSlice(gw)
  737. if !ok {
  738. // Fallback to the new RTA_VIA
  739. rVia, ok := via.(*netlink.Via)
  740. if ok {
  741. gwAddr, ok = netip.AddrFromSlice(rVia.Addr)
  742. }
  743. }
  744. if gwAddr.IsValid() {
  745. gwAddr = gwAddr.Unmap()
  746. return gwAddr, true
  747. }
  748. return netip.Addr{}, false
  749. }
  750. func (t *tun) updateRoutes(r netlink.RouteUpdate) {
  751. gateways := t.getGatewaysFromRoute(&r.Route)
  752. if len(gateways) == 0 {
  753. // No gateways relevant to our network, no routing changes required.
  754. t.l.Debug("Ignoring route update, no gateways", "route", r)
  755. return
  756. }
  757. if r.Dst == nil {
  758. t.l.Debug("Ignoring route update, no destination address", "route", r)
  759. return
  760. }
  761. dstAddr, ok := netip.AddrFromSlice(r.Dst.IP)
  762. if !ok {
  763. t.l.Debug("Ignoring route update, invalid destination address", "route", r)
  764. return
  765. }
  766. ones, _ := r.Dst.Mask.Size()
  767. dst := netip.PrefixFrom(dstAddr, ones)
  768. newTree := t.routeTree.Load().Clone()
  769. t.routesFromSystemLock.Lock()
  770. if r.Type == unix.RTM_NEWROUTE {
  771. t.l.Info("Adding route", "destination", dst, "via", gateways)
  772. t.routesFromSystem[dst] = gateways
  773. newTree.Insert(dst, gateways)
  774. } else {
  775. t.l.Info("Removing route", "destination", dst, "via", gateways)
  776. delete(t.routesFromSystem, dst)
  777. newTree.Delete(dst)
  778. }
  779. t.routesFromSystemLock.Unlock()
  780. t.routeTree.Store(newTree)
  781. }
  782. func (t *tun) Close() error {
  783. t.closeLock.Lock()
  784. defer t.closeLock.Unlock()
  785. if t.routeChan != nil {
  786. close(t.routeChan)
  787. t.routeChan = nil
  788. }
  789. // Signal all readers blocked in poll to wake up and exit
  790. _ = t.tunFile.wakeForShutdown()
  791. if t.ioctlFd > 0 {
  792. _ = unix.Close(int(t.ioctlFd))
  793. t.ioctlFd = 0
  794. }
  795. for i := range t.readers {
  796. if i == 0 {
  797. continue //we want to close the zeroth reader last
  798. }
  799. err := t.readers[i].Close()
  800. if err != nil {
  801. t.l.Error("error closing tun reader", "reader", i, "error", err)
  802. } else {
  803. t.l.Info("closed tun reader", "reader", i)
  804. }
  805. }
  806. //this is t.readers[0] too
  807. err := t.tunFile.Close()
  808. if err != nil {
  809. t.l.Error("error closing tun reader", "reader", 0, "error", err)
  810. } else {
  811. t.l.Info("closed tun reader", "reader", 0)
  812. }
  813. return err
  814. }