lighthouse.go 41 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447
  1. package nebula
  2. import (
  3. "context"
  4. "encoding/binary"
  5. "errors"
  6. "fmt"
  7. "net"
  8. "net/netip"
  9. "slices"
  10. "strconv"
  11. "sync/atomic"
  12. "time"
  13. "github.com/gaissmai/bart"
  14. "github.com/rcrowley/go-metrics"
  15. "github.com/sirupsen/logrus"
  16. "github.com/slackhq/nebula/cert"
  17. "github.com/slackhq/nebula/config"
  18. "github.com/slackhq/nebula/header"
  19. "github.com/slackhq/nebula/udp"
  20. "github.com/slackhq/nebula/util"
  21. "github.com/wadey/synctrace"
  22. )
  23. var ErrHostNotKnown = errors.New("host not known")
  24. type LightHouse struct {
  25. //TODO: We need a timer wheel to kick out vpnAddrs that haven't reported in a long time
  26. synctrace.RWMutex //Because we concurrently read and write to our maps
  27. ctx context.Context
  28. amLighthouse bool
  29. myVpnNetworks []netip.Prefix
  30. myVpnNetworksTable *bart.Lite
  31. punchConn udp.Conn
  32. punchy *Punchy
  33. // Local cache of answers from light houses
  34. // map of vpn addr to answers
  35. addrMap map[netip.Addr]*RemoteList
  36. // filters remote addresses allowed for each host
  37. // - When we are a lighthouse, this filters what addresses we store and
  38. // respond with.
  39. // - When we are not a lighthouse, this filters which addresses we accept
  40. // from lighthouses.
  41. remoteAllowList atomic.Pointer[RemoteAllowList]
  42. // filters local addresses that we advertise to lighthouses
  43. localAllowList atomic.Pointer[LocalAllowList]
  44. // used to trigger the HandshakeManager when we receive HostQueryReply
  45. handshakeTrigger chan<- netip.Addr
  46. // staticList exists to avoid having a bool in each addrMap entry
  47. // since static should be rare
  48. staticList atomic.Pointer[map[netip.Addr]struct{}]
  49. lighthouses atomic.Pointer[map[netip.Addr]struct{}]
  50. interval atomic.Int64
  51. updateCancel context.CancelFunc
  52. ifce EncWriter
  53. nebulaPort uint32 // 32 bits because protobuf does not have a uint16
  54. advertiseAddrs atomic.Pointer[[]netip.AddrPort]
  55. // Addr's of relays that can be used by peers to access me
  56. relaysForMe atomic.Pointer[[]netip.Addr]
  57. queryChan chan netip.Addr
  58. calculatedRemotes atomic.Pointer[bart.Table[[]*calculatedRemote]] // Maps VpnAddr to []*calculatedRemote
  59. metrics *MessageMetrics
  60. metricHolepunchTx metrics.Counter
  61. l *logrus.Logger
  62. }
  63. // NewLightHouseFromConfig will build a Lighthouse struct from the values provided in the config object
  64. // addrMap should be nil unless this is during a config reload
  65. func NewLightHouseFromConfig(ctx context.Context, l *logrus.Logger, c *config.C, cs *CertState, pc udp.Conn, p *Punchy) (*LightHouse, error) {
  66. amLighthouse := c.GetBool("lighthouse.am_lighthouse", false)
  67. nebulaPort := uint32(c.GetInt("listen.port", 0))
  68. if amLighthouse && nebulaPort == 0 {
  69. return nil, util.NewContextualError("lighthouse.am_lighthouse enabled on node but no port number is set in config", nil, nil)
  70. }
  71. // If port is dynamic, discover it
  72. if nebulaPort == 0 && pc != nil {
  73. uPort, err := pc.LocalAddr()
  74. if err != nil {
  75. return nil, util.NewContextualError("Failed to get listening port", nil, err)
  76. }
  77. nebulaPort = uint32(uPort.Port())
  78. }
  79. h := LightHouse{
  80. RWMutex: synctrace.NewRWMutex("lighthouse"),
  81. ctx: ctx,
  82. amLighthouse: amLighthouse,
  83. myVpnNetworks: cs.myVpnNetworks,
  84. myVpnNetworksTable: cs.myVpnNetworksTable,
  85. addrMap: make(map[netip.Addr]*RemoteList),
  86. nebulaPort: nebulaPort,
  87. punchConn: pc,
  88. punchy: p,
  89. queryChan: make(chan netip.Addr, c.GetUint32("handshakes.query_buffer", 64)),
  90. l: l,
  91. }
  92. lighthouses := make(map[netip.Addr]struct{})
  93. h.lighthouses.Store(&lighthouses)
  94. staticList := make(map[netip.Addr]struct{})
  95. h.staticList.Store(&staticList)
  96. if c.GetBool("stats.lighthouse_metrics", false) {
  97. h.metrics = newLighthouseMetrics()
  98. h.metricHolepunchTx = metrics.GetOrRegisterCounter("messages.tx.holepunch", nil)
  99. } else {
  100. h.metricHolepunchTx = metrics.NilCounter{}
  101. }
  102. err := h.reload(c, true)
  103. if err != nil {
  104. return nil, err
  105. }
  106. c.RegisterReloadCallback(func(c *config.C) {
  107. err := h.reload(c, false)
  108. switch v := err.(type) {
  109. case *util.ContextualError:
  110. v.Log(l)
  111. case error:
  112. l.WithError(err).Error("failed to reload lighthouse")
  113. }
  114. })
  115. h.startQueryWorker()
  116. return &h, nil
  117. }
  118. func (lh *LightHouse) GetStaticHostList() map[netip.Addr]struct{} {
  119. return *lh.staticList.Load()
  120. }
  121. func (lh *LightHouse) GetLighthouses() map[netip.Addr]struct{} {
  122. return *lh.lighthouses.Load()
  123. }
  124. func (lh *LightHouse) GetRemoteAllowList() *RemoteAllowList {
  125. return lh.remoteAllowList.Load()
  126. }
  127. func (lh *LightHouse) GetLocalAllowList() *LocalAllowList {
  128. return lh.localAllowList.Load()
  129. }
  130. func (lh *LightHouse) GetAdvertiseAddrs() []netip.AddrPort {
  131. return *lh.advertiseAddrs.Load()
  132. }
  133. func (lh *LightHouse) GetRelaysForMe() []netip.Addr {
  134. return *lh.relaysForMe.Load()
  135. }
  136. func (lh *LightHouse) getCalculatedRemotes() *bart.Table[[]*calculatedRemote] {
  137. return lh.calculatedRemotes.Load()
  138. }
  139. func (lh *LightHouse) GetUpdateInterval() int64 {
  140. return lh.interval.Load()
  141. }
  142. func (lh *LightHouse) reload(c *config.C, initial bool) error {
  143. if initial || c.HasChanged("lighthouse.advertise_addrs") {
  144. rawAdvAddrs := c.GetStringSlice("lighthouse.advertise_addrs", []string{})
  145. advAddrs := make([]netip.AddrPort, 0)
  146. for i, rawAddr := range rawAdvAddrs {
  147. host, sport, err := net.SplitHostPort(rawAddr)
  148. if err != nil {
  149. return util.NewContextualError("Unable to parse lighthouse.advertise_addrs entry", m{"addr": rawAddr, "entry": i + 1}, err)
  150. }
  151. addrs, err := net.DefaultResolver.LookupNetIP(context.Background(), "ip", host)
  152. if err != nil {
  153. return util.NewContextualError("Unable to lookup lighthouse.advertise_addrs entry", m{"addr": rawAddr, "entry": i + 1}, err)
  154. }
  155. if len(addrs) == 0 {
  156. return util.NewContextualError("Unable to lookup lighthouse.advertise_addrs entry", m{"addr": rawAddr, "entry": i + 1}, nil)
  157. }
  158. port, err := strconv.Atoi(sport)
  159. if err != nil {
  160. return util.NewContextualError("Unable to parse port in lighthouse.advertise_addrs entry", m{"addr": rawAddr, "entry": i + 1}, err)
  161. }
  162. if port == 0 {
  163. port = int(lh.nebulaPort)
  164. }
  165. //TODO: we could technically insert all returned addrs instead of just the first one if a dns lookup was used
  166. addr := addrs[0].Unmap()
  167. if lh.myVpnNetworksTable.Contains(addr) {
  168. lh.l.WithField("addr", rawAddr).WithField("entry", i+1).
  169. Warn("Ignoring lighthouse.advertise_addrs report because it is within the nebula network range")
  170. continue
  171. }
  172. advAddrs = append(advAddrs, netip.AddrPortFrom(addr, uint16(port)))
  173. }
  174. lh.advertiseAddrs.Store(&advAddrs)
  175. if !initial {
  176. lh.l.Info("lighthouse.advertise_addrs has changed")
  177. }
  178. }
  179. if initial || c.HasChanged("lighthouse.interval") {
  180. lh.interval.Store(int64(c.GetInt("lighthouse.interval", 10)))
  181. if !initial {
  182. lh.l.Infof("lighthouse.interval changed to %v", lh.interval.Load())
  183. if lh.updateCancel != nil {
  184. // May not always have a running routine
  185. lh.updateCancel()
  186. }
  187. lh.StartUpdateWorker()
  188. }
  189. }
  190. if initial || c.HasChanged("lighthouse.remote_allow_list") || c.HasChanged("lighthouse.remote_allow_ranges") {
  191. ral, err := NewRemoteAllowListFromConfig(c, "lighthouse.remote_allow_list", "lighthouse.remote_allow_ranges")
  192. if err != nil {
  193. return util.NewContextualError("Invalid lighthouse.remote_allow_list", nil, err)
  194. }
  195. lh.remoteAllowList.Store(ral)
  196. if !initial {
  197. lh.l.Info("lighthouse.remote_allow_list and/or lighthouse.remote_allow_ranges has changed")
  198. }
  199. }
  200. if initial || c.HasChanged("lighthouse.local_allow_list") {
  201. lal, err := NewLocalAllowListFromConfig(c, "lighthouse.local_allow_list")
  202. if err != nil {
  203. return util.NewContextualError("Invalid lighthouse.local_allow_list", nil, err)
  204. }
  205. lh.localAllowList.Store(lal)
  206. if !initial {
  207. lh.l.Info("lighthouse.local_allow_list has changed")
  208. }
  209. }
  210. if initial || c.HasChanged("lighthouse.calculated_remotes") {
  211. cr, err := NewCalculatedRemotesFromConfig(c, "lighthouse.calculated_remotes")
  212. if err != nil {
  213. return util.NewContextualError("Invalid lighthouse.calculated_remotes", nil, err)
  214. }
  215. lh.calculatedRemotes.Store(cr)
  216. if !initial {
  217. lh.l.Info("lighthouse.calculated_remotes has changed")
  218. }
  219. }
  220. //NOTE: many things will get much simpler when we combine static_host_map and lighthouse.hosts in config
  221. if initial || c.HasChanged("static_host_map") || c.HasChanged("static_map.cadence") || c.HasChanged("static_map.network") || c.HasChanged("static_map.lookup_timeout") {
  222. // Clean up. Entries still in the static_host_map will be re-built.
  223. // Entries no longer present must have their (possible) background DNS goroutines stopped.
  224. if existingStaticList := lh.staticList.Load(); existingStaticList != nil {
  225. lh.RLock()
  226. for staticVpnAddr := range *existingStaticList {
  227. if am, ok := lh.addrMap[staticVpnAddr]; ok && am != nil {
  228. am.hr.Cancel()
  229. }
  230. }
  231. lh.RUnlock()
  232. }
  233. // Build a new list based on current config.
  234. staticList := make(map[netip.Addr]struct{})
  235. err := lh.loadStaticMap(c, staticList)
  236. if err != nil {
  237. return err
  238. }
  239. lh.staticList.Store(&staticList)
  240. if !initial {
  241. if c.HasChanged("static_host_map") {
  242. lh.l.Info("static_host_map has changed")
  243. }
  244. if c.HasChanged("static_map.cadence") {
  245. lh.l.Info("static_map.cadence has changed")
  246. }
  247. if c.HasChanged("static_map.network") {
  248. lh.l.Info("static_map.network has changed")
  249. }
  250. if c.HasChanged("static_map.lookup_timeout") {
  251. lh.l.Info("static_map.lookup_timeout has changed")
  252. }
  253. }
  254. }
  255. if initial || c.HasChanged("lighthouse.hosts") {
  256. lhMap := make(map[netip.Addr]struct{})
  257. err := lh.parseLighthouses(c, lhMap)
  258. if err != nil {
  259. return err
  260. }
  261. lh.lighthouses.Store(&lhMap)
  262. if !initial {
  263. //NOTE: we are not tearing down existing lighthouse connections because they might be used for non lighthouse traffic
  264. lh.l.Info("lighthouse.hosts has changed")
  265. }
  266. }
  267. if initial || c.HasChanged("relay.relays") {
  268. switch c.GetBool("relay.am_relay", false) {
  269. case true:
  270. // Relays aren't allowed to specify other relays
  271. if len(c.GetStringSlice("relay.relays", nil)) > 0 {
  272. lh.l.Info("Ignoring relays from config because am_relay is true")
  273. }
  274. relaysForMe := []netip.Addr{}
  275. lh.relaysForMe.Store(&relaysForMe)
  276. case false:
  277. relaysForMe := []netip.Addr{}
  278. for _, v := range c.GetStringSlice("relay.relays", nil) {
  279. configRIP, err := netip.ParseAddr(v)
  280. if err != nil {
  281. lh.l.WithField("relay", v).WithError(err).Warn("Parse relay from config failed")
  282. } else {
  283. lh.l.WithField("relay", v).Info("Read relay from config")
  284. relaysForMe = append(relaysForMe, configRIP)
  285. }
  286. }
  287. lh.relaysForMe.Store(&relaysForMe)
  288. }
  289. }
  290. return nil
  291. }
  292. func (lh *LightHouse) parseLighthouses(c *config.C, lhMap map[netip.Addr]struct{}) error {
  293. lhs := c.GetStringSlice("lighthouse.hosts", []string{})
  294. if lh.amLighthouse && len(lhs) != 0 {
  295. lh.l.Warn("lighthouse.am_lighthouse enabled on node but upstream lighthouses exist in config")
  296. }
  297. for i, host := range lhs {
  298. addr, err := netip.ParseAddr(host)
  299. if err != nil {
  300. return util.NewContextualError("Unable to parse lighthouse host entry", m{"host": host, "entry": i + 1}, err)
  301. }
  302. if !lh.myVpnNetworksTable.Contains(addr) {
  303. return util.NewContextualError("lighthouse host is not in our networks, invalid", m{"vpnAddr": addr, "networks": lh.myVpnNetworks}, nil)
  304. }
  305. lhMap[addr] = struct{}{}
  306. }
  307. if !lh.amLighthouse && len(lhMap) == 0 {
  308. lh.l.Warn("No lighthouse.hosts configured, this host will only be able to initiate tunnels with static_host_map entries")
  309. }
  310. staticList := lh.GetStaticHostList()
  311. for lhAddr, _ := range lhMap {
  312. if _, ok := staticList[lhAddr]; !ok {
  313. return fmt.Errorf("lighthouse %s does not have a static_host_map entry", lhAddr)
  314. }
  315. }
  316. return nil
  317. }
  318. func getStaticMapCadence(c *config.C) (time.Duration, error) {
  319. cadence := c.GetString("static_map.cadence", "30s")
  320. d, err := time.ParseDuration(cadence)
  321. if err != nil {
  322. return 0, err
  323. }
  324. return d, nil
  325. }
  326. func getStaticMapLookupTimeout(c *config.C) (time.Duration, error) {
  327. lookupTimeout := c.GetString("static_map.lookup_timeout", "250ms")
  328. d, err := time.ParseDuration(lookupTimeout)
  329. if err != nil {
  330. return 0, err
  331. }
  332. return d, nil
  333. }
  334. func getStaticMapNetwork(c *config.C) (string, error) {
  335. network := c.GetString("static_map.network", "ip4")
  336. if network != "ip" && network != "ip4" && network != "ip6" {
  337. return "", fmt.Errorf("static_map.network must be one of ip, ip4, or ip6")
  338. }
  339. return network, nil
  340. }
  341. func (lh *LightHouse) loadStaticMap(c *config.C, staticList map[netip.Addr]struct{}) error {
  342. d, err := getStaticMapCadence(c)
  343. if err != nil {
  344. return err
  345. }
  346. network, err := getStaticMapNetwork(c)
  347. if err != nil {
  348. return err
  349. }
  350. lookupTimeout, err := getStaticMapLookupTimeout(c)
  351. if err != nil {
  352. return err
  353. }
  354. shm := c.GetMap("static_host_map", map[string]any{})
  355. i := 0
  356. for k, v := range shm {
  357. vpnAddr, err := netip.ParseAddr(fmt.Sprintf("%v", k))
  358. if err != nil {
  359. return util.NewContextualError("Unable to parse static_host_map entry", m{"host": k, "entry": i + 1}, err)
  360. }
  361. if !lh.myVpnNetworksTable.Contains(vpnAddr) {
  362. return util.NewContextualError("static_host_map key is not in our network, invalid", m{"vpnAddr": vpnAddr, "networks": lh.myVpnNetworks, "entry": i + 1}, nil)
  363. }
  364. vals, ok := v.([]any)
  365. if !ok {
  366. vals = []any{v}
  367. }
  368. remoteAddrs := []string{}
  369. for _, v := range vals {
  370. remoteAddrs = append(remoteAddrs, fmt.Sprintf("%v", v))
  371. }
  372. err = lh.addStaticRemotes(i, d, network, lookupTimeout, vpnAddr, remoteAddrs, staticList)
  373. if err != nil {
  374. return err
  375. }
  376. i++
  377. }
  378. return nil
  379. }
  380. func (lh *LightHouse) Query(vpnAddr netip.Addr) *RemoteList {
  381. if !lh.IsLighthouseAddr(vpnAddr) {
  382. lh.QueryServer(vpnAddr)
  383. }
  384. lh.RLock()
  385. if v, ok := lh.addrMap[vpnAddr]; ok {
  386. lh.RUnlock()
  387. return v
  388. }
  389. lh.RUnlock()
  390. return nil
  391. }
  392. // QueryServer is asynchronous so no reply should be expected
  393. func (lh *LightHouse) QueryServer(vpnAddr netip.Addr) {
  394. // Don't put lighthouse addrs in the query channel because we can't query lighthouses about lighthouses
  395. if lh.amLighthouse || lh.IsLighthouseAddr(vpnAddr) {
  396. return
  397. }
  398. synctrace.ChanDebugSend("lighthouse-querychan")
  399. lh.queryChan <- vpnAddr
  400. }
  401. func (lh *LightHouse) QueryCache(vpnAddrs []netip.Addr) *RemoteList {
  402. lh.RLock()
  403. if v, ok := lh.addrMap[vpnAddrs[0]]; ok {
  404. lh.RUnlock()
  405. return v
  406. }
  407. lh.RUnlock()
  408. lh.Lock()
  409. defer lh.Unlock()
  410. // Add an entry if we don't already have one
  411. return lh.unlockedGetRemoteList(vpnAddrs)
  412. }
  413. // queryAndPrepMessage is a lock helper on RemoteList, assisting the caller to build a lighthouse message containing
  414. // details from the remote list. It looks for a hit in the addrMap and a hit in the RemoteList under the owner vpnAddr
  415. // If one is found then f() is called with proper locking, f() must return result of n.MarshalTo()
  416. func (lh *LightHouse) queryAndPrepMessage(vpnAddr netip.Addr, f func(*cache) (int, error)) (bool, int, error) {
  417. lh.RLock()
  418. // Do we have an entry in the main cache?
  419. if v, ok := lh.addrMap[vpnAddr]; ok {
  420. // Swap lh lock for remote list lock
  421. v.RLock()
  422. defer v.RUnlock()
  423. lh.RUnlock()
  424. // We may be asking about a non primary address so lets get the primary address
  425. if slices.Contains(v.vpnAddrs, vpnAddr) {
  426. vpnAddr = v.vpnAddrs[0]
  427. }
  428. c := v.cache[vpnAddr]
  429. // Make sure we have
  430. if c != nil {
  431. n, err := f(c)
  432. return true, n, err
  433. }
  434. return false, 0, nil
  435. }
  436. lh.RUnlock()
  437. return false, 0, nil
  438. }
  439. func (lh *LightHouse) DeleteVpnAddrs(allVpnAddrs []netip.Addr) {
  440. // First we check the static mapping
  441. // and do nothing if it is there
  442. if _, ok := lh.GetStaticHostList()[allVpnAddrs[0]]; ok {
  443. return
  444. }
  445. lh.Lock()
  446. rm, ok := lh.addrMap[allVpnAddrs[0]]
  447. if ok {
  448. for _, addr := range allVpnAddrs {
  449. srm := lh.addrMap[addr]
  450. if srm == rm {
  451. delete(lh.addrMap, addr)
  452. if lh.l.Level >= logrus.DebugLevel {
  453. lh.l.Debugf("deleting %s from lighthouse.", addr)
  454. }
  455. }
  456. }
  457. }
  458. lh.Unlock()
  459. }
  460. // AddStaticRemote adds a static host entry for vpnAddr as ourselves as the owner
  461. // We are the owner because we don't want a lighthouse server to advertise for static hosts it was configured with
  462. // And we don't want a lighthouse query reply to interfere with our learned cache if we are a client
  463. // NOTE: this function should not interact with any hot path objects, like lh.staticList, the caller should handle it
  464. func (lh *LightHouse) addStaticRemotes(i int, d time.Duration, network string, timeout time.Duration, vpnAddr netip.Addr, toAddrs []string, staticList map[netip.Addr]struct{}) error {
  465. lh.Lock()
  466. am := lh.unlockedGetRemoteList([]netip.Addr{vpnAddr})
  467. am.Lock()
  468. defer am.Unlock()
  469. ctx := lh.ctx
  470. lh.Unlock()
  471. hr, err := NewHostnameResults(ctx, lh.l, d, network, timeout, toAddrs, func() {
  472. // This callback runs whenever the DNS hostname resolver finds a different set of addr's
  473. // in its resolution for hostnames.
  474. am.Lock()
  475. defer am.Unlock()
  476. am.shouldRebuild = true
  477. })
  478. if err != nil {
  479. return util.NewContextualError("Static host address could not be parsed", m{"vpnAddr": vpnAddr, "entry": i + 1}, err)
  480. }
  481. am.unlockedSetHostnamesResults(hr)
  482. for _, addrPort := range hr.GetAddrs() {
  483. if !lh.shouldAdd(vpnAddr, addrPort.Addr()) {
  484. continue
  485. }
  486. switch {
  487. case addrPort.Addr().Is4():
  488. am.unlockedPrependV4(lh.myVpnNetworks[0].Addr(), netAddrToProtoV4AddrPort(addrPort.Addr(), addrPort.Port()))
  489. case addrPort.Addr().Is6():
  490. am.unlockedPrependV6(lh.myVpnNetworks[0].Addr(), netAddrToProtoV6AddrPort(addrPort.Addr(), addrPort.Port()))
  491. }
  492. }
  493. // Mark it as static in the caller provided map
  494. staticList[vpnAddr] = struct{}{}
  495. return nil
  496. }
  497. // addCalculatedRemotes adds any calculated remotes based on the
  498. // lighthouse.calculated_remotes configuration. It returns true if any
  499. // calculated remotes were added
  500. func (lh *LightHouse) addCalculatedRemotes(vpnAddr netip.Addr) bool {
  501. tree := lh.getCalculatedRemotes()
  502. if tree == nil {
  503. return false
  504. }
  505. calculatedRemotes, ok := tree.Lookup(vpnAddr)
  506. if !ok {
  507. return false
  508. }
  509. var calculatedV4 []*V4AddrPort
  510. var calculatedV6 []*V6AddrPort
  511. for _, cr := range calculatedRemotes {
  512. if vpnAddr.Is4() {
  513. c := cr.ApplyV4(vpnAddr)
  514. if c != nil {
  515. calculatedV4 = append(calculatedV4, c)
  516. }
  517. } else if vpnAddr.Is6() {
  518. c := cr.ApplyV6(vpnAddr)
  519. if c != nil {
  520. calculatedV6 = append(calculatedV6, c)
  521. }
  522. }
  523. }
  524. lh.Lock()
  525. am := lh.unlockedGetRemoteList([]netip.Addr{vpnAddr})
  526. am.Lock()
  527. defer am.Unlock()
  528. lh.Unlock()
  529. if len(calculatedV4) > 0 {
  530. am.unlockedSetV4(lh.myVpnNetworks[0].Addr(), vpnAddr, calculatedV4, lh.unlockedShouldAddV4)
  531. }
  532. if len(calculatedV6) > 0 {
  533. am.unlockedSetV6(lh.myVpnNetworks[0].Addr(), vpnAddr, calculatedV6, lh.unlockedShouldAddV6)
  534. }
  535. return len(calculatedV4) > 0 || len(calculatedV6) > 0
  536. }
  537. // unlockedGetRemoteList
  538. // assumes you have the lh lock
  539. func (lh *LightHouse) unlockedGetRemoteList(allAddrs []netip.Addr) *RemoteList {
  540. am, ok := lh.addrMap[allAddrs[0]]
  541. if !ok {
  542. am = NewRemoteList(allAddrs, func(a netip.Addr) bool { return lh.shouldAdd(allAddrs[0], a) })
  543. for _, addr := range allAddrs {
  544. lh.addrMap[addr] = am
  545. }
  546. }
  547. return am
  548. }
  549. func (lh *LightHouse) shouldAdd(vpnAddr netip.Addr, to netip.Addr) bool {
  550. allow := lh.GetRemoteAllowList().Allow(vpnAddr, to)
  551. if lh.l.Level >= logrus.TraceLevel {
  552. lh.l.WithField("vpnAddr", vpnAddr).WithField("udpAddr", to).WithField("allow", allow).
  553. Trace("remoteAllowList.Allow")
  554. }
  555. if !allow {
  556. return false
  557. }
  558. if lh.myVpnNetworksTable.Contains(to) {
  559. return false
  560. }
  561. return true
  562. }
  563. // unlockedShouldAddV4 checks if to is allowed by our allow list
  564. func (lh *LightHouse) unlockedShouldAddV4(vpnAddr netip.Addr, to *V4AddrPort) bool {
  565. udpAddr := protoV4AddrPortToNetAddrPort(to)
  566. allow := lh.GetRemoteAllowList().Allow(vpnAddr, udpAddr.Addr())
  567. if lh.l.Level >= logrus.TraceLevel {
  568. lh.l.WithField("vpnAddr", vpnAddr).WithField("udpAddr", udpAddr).WithField("allow", allow).
  569. Trace("remoteAllowList.Allow")
  570. }
  571. if !allow {
  572. return false
  573. }
  574. if lh.myVpnNetworksTable.Contains(udpAddr.Addr()) {
  575. return false
  576. }
  577. return true
  578. }
  579. // unlockedShouldAddV6 checks if to is allowed by our allow list
  580. func (lh *LightHouse) unlockedShouldAddV6(vpnAddr netip.Addr, to *V6AddrPort) bool {
  581. udpAddr := protoV6AddrPortToNetAddrPort(to)
  582. allow := lh.GetRemoteAllowList().Allow(vpnAddr, udpAddr.Addr())
  583. if lh.l.Level >= logrus.TraceLevel {
  584. lh.l.WithField("vpnAddr", vpnAddr).WithField("udpAddr", udpAddr).WithField("allow", allow).
  585. Trace("remoteAllowList.Allow")
  586. }
  587. if !allow {
  588. return false
  589. }
  590. if lh.myVpnNetworksTable.Contains(udpAddr.Addr()) {
  591. return false
  592. }
  593. return true
  594. }
  595. func (lh *LightHouse) IsLighthouseAddr(vpnAddr netip.Addr) bool {
  596. if _, ok := lh.GetLighthouses()[vpnAddr]; ok {
  597. return true
  598. }
  599. return false
  600. }
  601. // TODO: CERT-V2 IsLighthouseAddr should be sufficient, we just need to update the vpnAddrs for lighthouses after a handshake
  602. // so that we know all the lighthouse vpnAddrs, not just the ones we were configured to talk to initially
  603. func (lh *LightHouse) IsAnyLighthouseAddr(vpnAddr []netip.Addr) bool {
  604. l := lh.GetLighthouses()
  605. for _, a := range vpnAddr {
  606. if _, ok := l[a]; ok {
  607. return true
  608. }
  609. }
  610. return false
  611. }
  612. func (lh *LightHouse) startQueryWorker() {
  613. if lh.amLighthouse {
  614. return
  615. }
  616. go func() {
  617. nb := make([]byte, 12, 12)
  618. out := make([]byte, mtu)
  619. synctrace.ChanDebugRecvLock("lighthouse-querychan")
  620. for {
  621. select {
  622. case <-lh.ctx.Done():
  623. synctrace.ChanDebugRecvUnlock("lighthouse-querychan")
  624. return
  625. case addr := <-lh.queryChan:
  626. lh.innerQueryServer(addr, nb, out)
  627. }
  628. }
  629. }()
  630. }
  631. func (lh *LightHouse) innerQueryServer(addr netip.Addr, nb, out []byte) {
  632. if lh.IsLighthouseAddr(addr) {
  633. return
  634. }
  635. msg := &NebulaMeta{
  636. Type: NebulaMeta_HostQuery,
  637. Details: &NebulaMetaDetails{},
  638. }
  639. var v1Query, v2Query []byte
  640. var err error
  641. var v cert.Version
  642. queried := 0
  643. lighthouses := lh.GetLighthouses()
  644. for lhVpnAddr := range lighthouses {
  645. hi := lh.ifce.GetHostInfo(lhVpnAddr)
  646. if hi != nil {
  647. v = hi.ConnectionState.myCert.Version()
  648. } else {
  649. v = lh.ifce.GetCertState().initiatingVersion
  650. }
  651. if v == cert.Version1 {
  652. if !addr.Is4() {
  653. lh.l.WithField("queryVpnAddr", addr).WithField("lighthouseAddr", lhVpnAddr).
  654. Error("Can't query lighthouse for v6 address using a v1 protocol")
  655. continue
  656. }
  657. if v1Query == nil {
  658. b := addr.As4()
  659. msg.Details.VpnAddr = nil
  660. msg.Details.OldVpnAddr = binary.BigEndian.Uint32(b[:])
  661. v1Query, err = msg.Marshal()
  662. if err != nil {
  663. lh.l.WithError(err).WithField("queryVpnAddr", addr).
  664. WithField("lighthouseAddr", lhVpnAddr).
  665. Error("Failed to marshal lighthouse v1 query payload")
  666. continue
  667. }
  668. }
  669. lh.ifce.SendMessageToVpnAddr(header.LightHouse, 0, lhVpnAddr, v1Query, nb, out)
  670. queried++
  671. } else if v == cert.Version2 {
  672. if v2Query == nil {
  673. msg.Details.OldVpnAddr = 0
  674. msg.Details.VpnAddr = netAddrToProtoAddr(addr)
  675. v2Query, err = msg.Marshal()
  676. if err != nil {
  677. lh.l.WithError(err).WithField("queryVpnAddr", addr).
  678. WithField("lighthouseAddr", lhVpnAddr).
  679. Error("Failed to marshal lighthouse v2 query payload")
  680. continue
  681. }
  682. }
  683. lh.ifce.SendMessageToVpnAddr(header.LightHouse, 0, lhVpnAddr, v2Query, nb, out)
  684. queried++
  685. } else {
  686. lh.l.Debugf("Can not query lighthouse for %v using unknown protocol version: %v", addr, v)
  687. continue
  688. }
  689. }
  690. lh.metricTx(NebulaMeta_HostQuery, int64(queried))
  691. }
  692. func (lh *LightHouse) StartUpdateWorker() {
  693. interval := lh.GetUpdateInterval()
  694. if lh.amLighthouse || interval == 0 {
  695. return
  696. }
  697. clockSource := time.NewTicker(time.Second * time.Duration(interval))
  698. updateCtx, cancel := context.WithCancel(lh.ctx)
  699. lh.updateCancel = cancel
  700. go func() {
  701. defer clockSource.Stop()
  702. for {
  703. lh.SendUpdate()
  704. select {
  705. case <-updateCtx.Done():
  706. return
  707. case <-clockSource.C:
  708. continue
  709. }
  710. }
  711. }()
  712. }
  713. func (lh *LightHouse) SendUpdate() {
  714. var v4 []*V4AddrPort
  715. var v6 []*V6AddrPort
  716. for _, e := range lh.GetAdvertiseAddrs() {
  717. if e.Addr().Is4() {
  718. v4 = append(v4, netAddrToProtoV4AddrPort(e.Addr(), e.Port()))
  719. } else {
  720. v6 = append(v6, netAddrToProtoV6AddrPort(e.Addr(), e.Port()))
  721. }
  722. }
  723. lal := lh.GetLocalAllowList()
  724. for _, e := range localAddrs(lh.l, lal) {
  725. if lh.myVpnNetworksTable.Contains(e) {
  726. continue
  727. }
  728. // Only add addrs that aren't my VPN/tun networks
  729. if e.Is4() {
  730. v4 = append(v4, netAddrToProtoV4AddrPort(e, uint16(lh.nebulaPort)))
  731. } else {
  732. v6 = append(v6, netAddrToProtoV6AddrPort(e, uint16(lh.nebulaPort)))
  733. }
  734. }
  735. nb := make([]byte, 12, 12)
  736. out := make([]byte, mtu)
  737. var v1Update, v2Update []byte
  738. var err error
  739. updated := 0
  740. lighthouses := lh.GetLighthouses()
  741. for lhVpnAddr := range lighthouses {
  742. var v cert.Version
  743. hi := lh.ifce.GetHostInfo(lhVpnAddr)
  744. if hi != nil {
  745. v = hi.ConnectionState.myCert.Version()
  746. } else {
  747. v = lh.ifce.GetCertState().initiatingVersion
  748. }
  749. if v == cert.Version1 {
  750. if v1Update == nil {
  751. if !lh.myVpnNetworks[0].Addr().Is4() {
  752. lh.l.WithField("lighthouseAddr", lhVpnAddr).
  753. Warn("cannot update lighthouse using v1 protocol without an IPv4 address")
  754. continue
  755. }
  756. var relays []uint32
  757. for _, r := range lh.GetRelaysForMe() {
  758. if !r.Is4() {
  759. continue
  760. }
  761. b := r.As4()
  762. relays = append(relays, binary.BigEndian.Uint32(b[:]))
  763. }
  764. b := lh.myVpnNetworks[0].Addr().As4()
  765. msg := NebulaMeta{
  766. Type: NebulaMeta_HostUpdateNotification,
  767. Details: &NebulaMetaDetails{
  768. V4AddrPorts: v4,
  769. V6AddrPorts: v6,
  770. OldRelayVpnAddrs: relays,
  771. OldVpnAddr: binary.BigEndian.Uint32(b[:]),
  772. },
  773. }
  774. v1Update, err = msg.Marshal()
  775. if err != nil {
  776. lh.l.WithError(err).WithField("lighthouseAddr", lhVpnAddr).
  777. Error("Error while marshaling for lighthouse v1 update")
  778. continue
  779. }
  780. }
  781. lh.ifce.SendMessageToVpnAddr(header.LightHouse, 0, lhVpnAddr, v1Update, nb, out)
  782. updated++
  783. } else if v == cert.Version2 {
  784. if v2Update == nil {
  785. var relays []*Addr
  786. for _, r := range lh.GetRelaysForMe() {
  787. relays = append(relays, netAddrToProtoAddr(r))
  788. }
  789. msg := NebulaMeta{
  790. Type: NebulaMeta_HostUpdateNotification,
  791. Details: &NebulaMetaDetails{
  792. V4AddrPorts: v4,
  793. V6AddrPorts: v6,
  794. RelayVpnAddrs: relays,
  795. VpnAddr: netAddrToProtoAddr(lh.myVpnNetworks[0].Addr()),
  796. },
  797. }
  798. v2Update, err = msg.Marshal()
  799. if err != nil {
  800. lh.l.WithError(err).WithField("lighthouseAddr", lhVpnAddr).
  801. Error("Error while marshaling for lighthouse v2 update")
  802. continue
  803. }
  804. }
  805. lh.ifce.SendMessageToVpnAddr(header.LightHouse, 0, lhVpnAddr, v2Update, nb, out)
  806. updated++
  807. } else {
  808. lh.l.Debugf("Can not update lighthouse using unknown protocol version: %v", v)
  809. continue
  810. }
  811. }
  812. lh.metricTx(NebulaMeta_HostUpdateNotification, int64(updated))
  813. }
  814. type LightHouseHandler struct {
  815. lh *LightHouse
  816. nb []byte
  817. out []byte
  818. pb []byte
  819. meta *NebulaMeta
  820. l *logrus.Logger
  821. }
  822. func (lh *LightHouse) NewRequestHandler() *LightHouseHandler {
  823. lhh := &LightHouseHandler{
  824. lh: lh,
  825. nb: make([]byte, 12, 12),
  826. out: make([]byte, mtu),
  827. l: lh.l,
  828. pb: make([]byte, mtu),
  829. meta: &NebulaMeta{
  830. Details: &NebulaMetaDetails{},
  831. },
  832. }
  833. return lhh
  834. }
  835. func (lh *LightHouse) metricRx(t NebulaMeta_MessageType, i int64) {
  836. lh.metrics.Rx(header.MessageType(t), 0, i)
  837. }
  838. func (lh *LightHouse) metricTx(t NebulaMeta_MessageType, i int64) {
  839. lh.metrics.Tx(header.MessageType(t), 0, i)
  840. }
  841. // This method is similar to Reset(), but it re-uses the pointer structs
  842. // so that we don't have to re-allocate them
  843. func (lhh *LightHouseHandler) resetMeta() *NebulaMeta {
  844. details := lhh.meta.Details
  845. lhh.meta.Reset()
  846. // Keep the array memory around
  847. details.V4AddrPorts = details.V4AddrPorts[:0]
  848. details.V6AddrPorts = details.V6AddrPorts[:0]
  849. details.RelayVpnAddrs = details.RelayVpnAddrs[:0]
  850. details.OldRelayVpnAddrs = details.OldRelayVpnAddrs[:0]
  851. details.OldVpnAddr = 0
  852. details.VpnAddr = nil
  853. lhh.meta.Details = details
  854. return lhh.meta
  855. }
  856. func (lhh *LightHouseHandler) HandleRequest(rAddr netip.AddrPort, fromVpnAddrs []netip.Addr, p []byte, w EncWriter) {
  857. n := lhh.resetMeta()
  858. err := n.Unmarshal(p)
  859. if err != nil {
  860. lhh.l.WithError(err).WithField("vpnAddrs", fromVpnAddrs).WithField("udpAddr", rAddr).
  861. Error("Failed to unmarshal lighthouse packet")
  862. return
  863. }
  864. if n.Details == nil {
  865. lhh.l.WithField("vpnAddrs", fromVpnAddrs).WithField("udpAddr", rAddr).
  866. Error("Invalid lighthouse update")
  867. return
  868. }
  869. lhh.lh.metricRx(n.Type, 1)
  870. switch n.Type {
  871. case NebulaMeta_HostQuery:
  872. lhh.handleHostQuery(n, fromVpnAddrs, rAddr, w)
  873. case NebulaMeta_HostQueryReply:
  874. lhh.handleHostQueryReply(n, fromVpnAddrs)
  875. case NebulaMeta_HostUpdateNotification:
  876. lhh.handleHostUpdateNotification(n, fromVpnAddrs, w)
  877. case NebulaMeta_HostMovedNotification:
  878. case NebulaMeta_HostPunchNotification:
  879. lhh.handleHostPunchNotification(n, fromVpnAddrs, w)
  880. case NebulaMeta_HostUpdateNotificationAck:
  881. // noop
  882. }
  883. }
  884. func (lhh *LightHouseHandler) handleHostQuery(n *NebulaMeta, fromVpnAddrs []netip.Addr, addr netip.AddrPort, w EncWriter) {
  885. // Exit if we don't answer queries
  886. if !lhh.lh.amLighthouse {
  887. if lhh.l.Level >= logrus.DebugLevel {
  888. lhh.l.Debugln("I don't answer queries, but received from: ", addr)
  889. }
  890. return
  891. }
  892. useVersion := cert.Version1
  893. var queryVpnAddr netip.Addr
  894. if n.Details.OldVpnAddr != 0 {
  895. b := [4]byte{}
  896. binary.BigEndian.PutUint32(b[:], n.Details.OldVpnAddr)
  897. queryVpnAddr = netip.AddrFrom4(b)
  898. useVersion = 1
  899. } else if n.Details.VpnAddr != nil {
  900. queryVpnAddr = protoAddrToNetAddr(n.Details.VpnAddr)
  901. useVersion = 2
  902. } else {
  903. if lhh.l.Level >= logrus.DebugLevel {
  904. lhh.l.WithField("from", fromVpnAddrs).WithField("details", n.Details).Debugln("Dropping malformed HostQuery")
  905. }
  906. return
  907. }
  908. found, ln, err := lhh.lh.queryAndPrepMessage(queryVpnAddr, func(c *cache) (int, error) {
  909. n = lhh.resetMeta()
  910. n.Type = NebulaMeta_HostQueryReply
  911. if useVersion == cert.Version1 {
  912. if !queryVpnAddr.Is4() {
  913. return 0, fmt.Errorf("invalid vpn addr for v1 handleHostQuery")
  914. }
  915. b := queryVpnAddr.As4()
  916. n.Details.OldVpnAddr = binary.BigEndian.Uint32(b[:])
  917. } else {
  918. n.Details.VpnAddr = netAddrToProtoAddr(queryVpnAddr)
  919. }
  920. lhh.coalesceAnswers(useVersion, c, n)
  921. return n.MarshalTo(lhh.pb)
  922. })
  923. if !found {
  924. return
  925. }
  926. if err != nil {
  927. lhh.l.WithError(err).WithField("vpnAddrs", fromVpnAddrs).Error("Failed to marshal lighthouse host query reply")
  928. return
  929. }
  930. lhh.lh.metricTx(NebulaMeta_HostQueryReply, 1)
  931. w.SendMessageToVpnAddr(header.LightHouse, 0, fromVpnAddrs[0], lhh.pb[:ln], lhh.nb, lhh.out[:0])
  932. lhh.sendHostPunchNotification(n, fromVpnAddrs, queryVpnAddr, w)
  933. }
  934. // sendHostPunchNotification signals the other side to punch some zero byte udp packets
  935. func (lhh *LightHouseHandler) sendHostPunchNotification(n *NebulaMeta, fromVpnAddrs []netip.Addr, punchNotifDest netip.Addr, w EncWriter) {
  936. whereToPunch := fromVpnAddrs[0]
  937. found, ln, err := lhh.lh.queryAndPrepMessage(whereToPunch, func(c *cache) (int, error) {
  938. n = lhh.resetMeta()
  939. n.Type = NebulaMeta_HostPunchNotification
  940. targetHI := lhh.lh.ifce.GetHostInfo(punchNotifDest)
  941. var useVersion cert.Version
  942. if targetHI == nil {
  943. useVersion = lhh.lh.ifce.GetCertState().initiatingVersion
  944. } else {
  945. crt := targetHI.GetCert().Certificate
  946. useVersion = crt.Version()
  947. // we can only retarget if we have a hostinfo
  948. newDest, ok := findNetworkUnion(crt.Networks(), fromVpnAddrs)
  949. if ok {
  950. whereToPunch = newDest
  951. } else {
  952. //TODO: CERT-V2 this means the destination will have no addresses in common with the punch-ee
  953. //choosing to do nothing for now, but maybe we return an error?
  954. }
  955. }
  956. if useVersion == cert.Version1 {
  957. if !whereToPunch.Is4() {
  958. return 0, fmt.Errorf("invalid vpn addr for v1 handleHostQuery")
  959. }
  960. b := whereToPunch.As4()
  961. n.Details.OldVpnAddr = binary.BigEndian.Uint32(b[:])
  962. } else if useVersion == cert.Version2 {
  963. n.Details.VpnAddr = netAddrToProtoAddr(whereToPunch)
  964. } else {
  965. return 0, errors.New("unsupported version")
  966. }
  967. lhh.coalesceAnswers(useVersion, c, n)
  968. return n.MarshalTo(lhh.pb)
  969. })
  970. if !found {
  971. return
  972. }
  973. if err != nil {
  974. lhh.l.WithError(err).WithField("vpnAddrs", fromVpnAddrs).Error("Failed to marshal lighthouse host was queried for")
  975. return
  976. }
  977. lhh.lh.metricTx(NebulaMeta_HostPunchNotification, 1)
  978. w.SendMessageToVpnAddr(header.LightHouse, 0, punchNotifDest, lhh.pb[:ln], lhh.nb, lhh.out[:0])
  979. }
  980. func (lhh *LightHouseHandler) coalesceAnswers(v cert.Version, c *cache, n *NebulaMeta) {
  981. if c.v4 != nil {
  982. if c.v4.learned != nil {
  983. n.Details.V4AddrPorts = append(n.Details.V4AddrPorts, c.v4.learned)
  984. }
  985. if c.v4.reported != nil && len(c.v4.reported) > 0 {
  986. n.Details.V4AddrPorts = append(n.Details.V4AddrPorts, c.v4.reported...)
  987. }
  988. }
  989. if c.v6 != nil {
  990. if c.v6.learned != nil {
  991. n.Details.V6AddrPorts = append(n.Details.V6AddrPorts, c.v6.learned)
  992. }
  993. if c.v6.reported != nil && len(c.v6.reported) > 0 {
  994. n.Details.V6AddrPorts = append(n.Details.V6AddrPorts, c.v6.reported...)
  995. }
  996. }
  997. if c.relay != nil {
  998. if v == cert.Version1 {
  999. b := [4]byte{}
  1000. for _, r := range c.relay.relay {
  1001. if !r.Is4() {
  1002. continue
  1003. }
  1004. b = r.As4()
  1005. n.Details.OldRelayVpnAddrs = append(n.Details.OldRelayVpnAddrs, binary.BigEndian.Uint32(b[:]))
  1006. }
  1007. } else if v == cert.Version2 {
  1008. for _, r := range c.relay.relay {
  1009. n.Details.RelayVpnAddrs = append(n.Details.RelayVpnAddrs, netAddrToProtoAddr(r))
  1010. }
  1011. } else {
  1012. //TODO: CERT-V2 don't panic
  1013. panic("unsupported version")
  1014. }
  1015. }
  1016. }
  1017. func (lhh *LightHouseHandler) handleHostQueryReply(n *NebulaMeta, fromVpnAddrs []netip.Addr) {
  1018. if !lhh.lh.IsAnyLighthouseAddr(fromVpnAddrs) {
  1019. return
  1020. }
  1021. lhh.lh.Lock()
  1022. var certVpnAddr netip.Addr
  1023. if n.Details.OldVpnAddr != 0 {
  1024. b := [4]byte{}
  1025. binary.BigEndian.PutUint32(b[:], n.Details.OldVpnAddr)
  1026. certVpnAddr = netip.AddrFrom4(b)
  1027. } else if n.Details.VpnAddr != nil {
  1028. certVpnAddr = protoAddrToNetAddr(n.Details.VpnAddr)
  1029. }
  1030. relays := n.Details.GetRelays()
  1031. am := lhh.lh.unlockedGetRemoteList([]netip.Addr{certVpnAddr})
  1032. am.Lock()
  1033. lhh.lh.Unlock()
  1034. am.unlockedSetV4(fromVpnAddrs[0], certVpnAddr, n.Details.V4AddrPorts, lhh.lh.unlockedShouldAddV4)
  1035. am.unlockedSetV6(fromVpnAddrs[0], certVpnAddr, n.Details.V6AddrPorts, lhh.lh.unlockedShouldAddV6)
  1036. am.unlockedSetRelay(fromVpnAddrs[0], relays)
  1037. am.Unlock()
  1038. // Non-blocking attempt to trigger, skip if it would block
  1039. select {
  1040. case lhh.lh.handshakeTrigger <- certVpnAddr:
  1041. default:
  1042. }
  1043. }
  1044. func (lhh *LightHouseHandler) handleHostUpdateNotification(n *NebulaMeta, fromVpnAddrs []netip.Addr, w EncWriter) {
  1045. if !lhh.lh.amLighthouse {
  1046. if lhh.l.Level >= logrus.DebugLevel {
  1047. lhh.l.Debugln("I am not a lighthouse, do not take host updates: ", fromVpnAddrs)
  1048. }
  1049. return
  1050. }
  1051. var detailsVpnAddr netip.Addr
  1052. useVersion := cert.Version1
  1053. if n.Details.OldVpnAddr != 0 {
  1054. b := [4]byte{}
  1055. binary.BigEndian.PutUint32(b[:], n.Details.OldVpnAddr)
  1056. detailsVpnAddr = netip.AddrFrom4(b)
  1057. useVersion = cert.Version1
  1058. } else if n.Details.VpnAddr != nil {
  1059. detailsVpnAddr = protoAddrToNetAddr(n.Details.VpnAddr)
  1060. useVersion = cert.Version2
  1061. } else {
  1062. if lhh.l.Level >= logrus.DebugLevel {
  1063. lhh.l.WithField("details", n.Details).Debugf("dropping invalid HostUpdateNotification")
  1064. }
  1065. return
  1066. }
  1067. //TODO: CERT-V2 hosts with only v2 certs cannot provide their ipv6 addr when contacting the lighthouse via v4?
  1068. //TODO: CERT-V2 why do we care about the vpnAddr in the packet? We know where it came from, right?
  1069. //Simple check that the host sent this not someone else
  1070. if !slices.Contains(fromVpnAddrs, detailsVpnAddr) {
  1071. if lhh.l.Level >= logrus.DebugLevel {
  1072. lhh.l.WithField("vpnAddrs", fromVpnAddrs).WithField("answer", detailsVpnAddr).Debugln("Host sent invalid update")
  1073. }
  1074. return
  1075. }
  1076. relays := n.Details.GetRelays()
  1077. lhh.lh.Lock()
  1078. am := lhh.lh.unlockedGetRemoteList(fromVpnAddrs)
  1079. am.Lock()
  1080. lhh.lh.Unlock()
  1081. am.unlockedSetV4(fromVpnAddrs[0], detailsVpnAddr, n.Details.V4AddrPorts, lhh.lh.unlockedShouldAddV4)
  1082. am.unlockedSetV6(fromVpnAddrs[0], detailsVpnAddr, n.Details.V6AddrPorts, lhh.lh.unlockedShouldAddV6)
  1083. am.unlockedSetRelay(fromVpnAddrs[0], relays)
  1084. am.Unlock()
  1085. n = lhh.resetMeta()
  1086. n.Type = NebulaMeta_HostUpdateNotificationAck
  1087. if useVersion == cert.Version1 {
  1088. if !fromVpnAddrs[0].Is4() {
  1089. lhh.l.WithField("vpnAddrs", fromVpnAddrs).Error("Can not send HostUpdateNotificationAck for a ipv6 vpn ip in a v1 message")
  1090. return
  1091. }
  1092. vpnAddrB := fromVpnAddrs[0].As4()
  1093. n.Details.OldVpnAddr = binary.BigEndian.Uint32(vpnAddrB[:])
  1094. } else if useVersion == cert.Version2 {
  1095. n.Details.VpnAddr = netAddrToProtoAddr(fromVpnAddrs[0])
  1096. } else {
  1097. lhh.l.WithField("useVersion", useVersion).Error("invalid protocol version")
  1098. return
  1099. }
  1100. ln, err := n.MarshalTo(lhh.pb)
  1101. if err != nil {
  1102. lhh.l.WithError(err).WithField("vpnAddrs", fromVpnAddrs).Error("Failed to marshal lighthouse host update ack")
  1103. return
  1104. }
  1105. lhh.lh.metricTx(NebulaMeta_HostUpdateNotificationAck, 1)
  1106. w.SendMessageToVpnAddr(header.LightHouse, 0, fromVpnAddrs[0], lhh.pb[:ln], lhh.nb, lhh.out[:0])
  1107. }
  1108. func (lhh *LightHouseHandler) handleHostPunchNotification(n *NebulaMeta, fromVpnAddrs []netip.Addr, w EncWriter) {
  1109. //It's possible the lighthouse is communicating with us using a non primary vpn addr,
  1110. //which means we need to compare all fromVpnAddrs against all configured lighthouse vpn addrs.
  1111. //maybe one day we'll have a better idea, if it matters.
  1112. if !lhh.lh.IsAnyLighthouseAddr(fromVpnAddrs) {
  1113. return
  1114. }
  1115. empty := []byte{0}
  1116. punch := func(vpnPeer netip.AddrPort) {
  1117. if !vpnPeer.IsValid() {
  1118. return
  1119. }
  1120. go func() {
  1121. time.Sleep(lhh.lh.punchy.GetDelay())
  1122. lhh.lh.metricHolepunchTx.Inc(1)
  1123. lhh.lh.punchConn.WriteTo(empty, vpnPeer)
  1124. }()
  1125. if lhh.l.Level >= logrus.DebugLevel {
  1126. var logVpnAddr netip.Addr
  1127. if n.Details.OldVpnAddr != 0 {
  1128. b := [4]byte{}
  1129. binary.BigEndian.PutUint32(b[:], n.Details.OldVpnAddr)
  1130. logVpnAddr = netip.AddrFrom4(b)
  1131. } else if n.Details.VpnAddr != nil {
  1132. logVpnAddr = protoAddrToNetAddr(n.Details.VpnAddr)
  1133. }
  1134. lhh.l.Debugf("Punching on %v for %v", vpnPeer, logVpnAddr)
  1135. }
  1136. }
  1137. for _, a := range n.Details.V4AddrPorts {
  1138. punch(protoV4AddrPortToNetAddrPort(a))
  1139. }
  1140. for _, a := range n.Details.V6AddrPorts {
  1141. punch(protoV6AddrPortToNetAddrPort(a))
  1142. }
  1143. // This sends a nebula test packet to the host trying to contact us. In the case
  1144. // of a double nat or other difficult scenario, this may help establish
  1145. // a tunnel.
  1146. if lhh.lh.punchy.GetRespond() {
  1147. var queryVpnAddr netip.Addr
  1148. if n.Details.OldVpnAddr != 0 {
  1149. b := [4]byte{}
  1150. binary.BigEndian.PutUint32(b[:], n.Details.OldVpnAddr)
  1151. queryVpnAddr = netip.AddrFrom4(b)
  1152. } else if n.Details.VpnAddr != nil {
  1153. queryVpnAddr = protoAddrToNetAddr(n.Details.VpnAddr)
  1154. }
  1155. go func() {
  1156. time.Sleep(lhh.lh.punchy.GetRespondDelay())
  1157. if lhh.l.Level >= logrus.DebugLevel {
  1158. lhh.l.Debugf("Sending a nebula test packet to vpn addr %s", queryVpnAddr)
  1159. }
  1160. //NOTE: we have to allocate a new output buffer here since we are spawning a new goroutine
  1161. // for each punchBack packet. We should move this into a timerwheel or a single goroutine
  1162. // managed by a channel.
  1163. w.SendMessageToVpnAddr(header.Test, header.TestRequest, queryVpnAddr, []byte(""), make([]byte, 12, 12), make([]byte, mtu))
  1164. }()
  1165. }
  1166. }
  1167. func protoAddrToNetAddr(addr *Addr) netip.Addr {
  1168. b := [16]byte{}
  1169. binary.BigEndian.PutUint64(b[:8], addr.Hi)
  1170. binary.BigEndian.PutUint64(b[8:], addr.Lo)
  1171. return netip.AddrFrom16(b).Unmap()
  1172. }
  1173. func protoV4AddrPortToNetAddrPort(ap *V4AddrPort) netip.AddrPort {
  1174. b := [4]byte{}
  1175. binary.BigEndian.PutUint32(b[:], ap.Addr)
  1176. return netip.AddrPortFrom(netip.AddrFrom4(b), uint16(ap.Port))
  1177. }
  1178. func protoV6AddrPortToNetAddrPort(ap *V6AddrPort) netip.AddrPort {
  1179. b := [16]byte{}
  1180. binary.BigEndian.PutUint64(b[:8], ap.Hi)
  1181. binary.BigEndian.PutUint64(b[8:], ap.Lo)
  1182. return netip.AddrPortFrom(netip.AddrFrom16(b), uint16(ap.Port))
  1183. }
  1184. func netAddrToProtoAddr(addr netip.Addr) *Addr {
  1185. b := addr.As16()
  1186. return &Addr{
  1187. Hi: binary.BigEndian.Uint64(b[:8]),
  1188. Lo: binary.BigEndian.Uint64(b[8:]),
  1189. }
  1190. }
  1191. func netAddrToProtoV4AddrPort(addr netip.Addr, port uint16) *V4AddrPort {
  1192. v4Addr := addr.As4()
  1193. return &V4AddrPort{
  1194. Addr: binary.BigEndian.Uint32(v4Addr[:]),
  1195. Port: uint32(port),
  1196. }
  1197. }
  1198. func netAddrToProtoV6AddrPort(addr netip.Addr, port uint16) *V6AddrPort {
  1199. v6Addr := addr.As16()
  1200. return &V6AddrPort{
  1201. Hi: binary.BigEndian.Uint64(v6Addr[:8]),
  1202. Lo: binary.BigEndian.Uint64(v6Addr[8:]),
  1203. Port: uint32(port),
  1204. }
  1205. }
  1206. func (d *NebulaMetaDetails) GetRelays() []netip.Addr {
  1207. var relays []netip.Addr
  1208. if len(d.OldRelayVpnAddrs) > 0 {
  1209. b := [4]byte{}
  1210. for _, r := range d.OldRelayVpnAddrs {
  1211. binary.BigEndian.PutUint32(b[:], r)
  1212. relays = append(relays, netip.AddrFrom4(b))
  1213. }
  1214. }
  1215. if len(d.RelayVpnAddrs) > 0 {
  1216. for _, r := range d.RelayVpnAddrs {
  1217. relays = append(relays, protoAddrToNetAddr(r))
  1218. }
  1219. }
  1220. return relays
  1221. }
  1222. // FindNetworkUnion returns the first netip.Addr contained in the list of provided netip.Prefix, if able
  1223. func findNetworkUnion(prefixes []netip.Prefix, addrs []netip.Addr) (netip.Addr, bool) {
  1224. for i := range prefixes {
  1225. for j := range addrs {
  1226. if prefixes[i].Contains(addrs[j]) {
  1227. return addrs[j], true
  1228. }
  1229. }
  1230. }
  1231. return netip.Addr{}, false
  1232. }