lighthouse.go 41 KB

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