lighthouse.go 41 KB

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