tun_linux.go 20 KB

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