tun_linux.go 22 KB

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