lighthouse.go 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440
  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. return !found
  561. }
  562. // unlockedShouldAddV4 checks if to is allowed by our allow list
  563. func (lh *LightHouse) unlockedShouldAddV4(vpnAddr netip.Addr, to *V4AddrPort) bool {
  564. udpAddr := protoV4AddrPortToNetAddrPort(to)
  565. allow := lh.GetRemoteAllowList().Allow(vpnAddr, udpAddr.Addr())
  566. if lh.l.Level >= logrus.TraceLevel {
  567. lh.l.WithField("vpnAddr", vpnAddr).WithField("udpAddr", udpAddr).WithField("allow", allow).
  568. Trace("remoteAllowList.Allow")
  569. }
  570. if !allow {
  571. return false
  572. }
  573. _, found := lh.myVpnNetworksTable.Lookup(udpAddr.Addr())
  574. return !found
  575. }
  576. // unlockedShouldAddV6 checks if to is allowed by our allow list
  577. func (lh *LightHouse) unlockedShouldAddV6(vpnAddr netip.Addr, to *V6AddrPort) bool {
  578. udpAddr := protoV6AddrPortToNetAddrPort(to)
  579. allow := lh.GetRemoteAllowList().Allow(vpnAddr, udpAddr.Addr())
  580. if lh.l.Level >= logrus.TraceLevel {
  581. lh.l.WithField("vpnAddr", vpnAddr).WithField("udpAddr", udpAddr).WithField("allow", allow).
  582. Trace("remoteAllowList.Allow")
  583. }
  584. if !allow {
  585. return false
  586. }
  587. _, found := lh.myVpnNetworksTable.Lookup(udpAddr.Addr())
  588. return !found
  589. }
  590. func (lh *LightHouse) IsLighthouseAddr(vpnAddr netip.Addr) bool {
  591. if _, ok := lh.GetLighthouses()[vpnAddr]; ok {
  592. return true
  593. }
  594. return false
  595. }
  596. // TODO: CERT-V2 IsLighthouseAddr should be sufficient, we just need to update the vpnAddrs for lighthouses after a handshake
  597. // so that we know all the lighthouse vpnAddrs, not just the ones we were configured to talk to initially
  598. func (lh *LightHouse) IsAnyLighthouseAddr(vpnAddr []netip.Addr) bool {
  599. l := lh.GetLighthouses()
  600. for _, a := range vpnAddr {
  601. if _, ok := l[a]; ok {
  602. return true
  603. }
  604. }
  605. return false
  606. }
  607. func (lh *LightHouse) startQueryWorker() {
  608. if lh.amLighthouse {
  609. return
  610. }
  611. go func() {
  612. nb := make([]byte, 12)
  613. out := make([]byte, mtu)
  614. for {
  615. select {
  616. case <-lh.ctx.Done():
  617. return
  618. case addr := <-lh.queryChan:
  619. lh.innerQueryServer(addr, nb, out)
  620. }
  621. }
  622. }()
  623. }
  624. func (lh *LightHouse) innerQueryServer(addr netip.Addr, nb, out []byte) {
  625. if lh.IsLighthouseAddr(addr) {
  626. return
  627. }
  628. msg := &NebulaMeta{
  629. Type: NebulaMeta_HostQuery,
  630. Details: &NebulaMetaDetails{},
  631. }
  632. var v1Query, v2Query []byte
  633. var err error
  634. var v cert.Version
  635. queried := 0
  636. lighthouses := lh.GetLighthouses()
  637. for lhVpnAddr := range lighthouses {
  638. hi := lh.ifce.GetHostInfo(lhVpnAddr)
  639. if hi != nil {
  640. v = hi.ConnectionState.myCert.Version()
  641. } else {
  642. v = lh.ifce.GetCertState().initiatingVersion
  643. }
  644. if v == cert.Version1 {
  645. if !addr.Is4() {
  646. lh.l.WithField("queryVpnAddr", addr).WithField("lighthouseAddr", lhVpnAddr).
  647. Error("Can't query lighthouse for v6 address using a v1 protocol")
  648. continue
  649. }
  650. if v1Query == nil {
  651. b := addr.As4()
  652. msg.Details.VpnAddr = nil
  653. msg.Details.OldVpnAddr = binary.BigEndian.Uint32(b[:])
  654. v1Query, err = msg.Marshal()
  655. if err != nil {
  656. lh.l.WithError(err).WithField("queryVpnAddr", addr).
  657. WithField("lighthouseAddr", lhVpnAddr).
  658. Error("Failed to marshal lighthouse v1 query payload")
  659. continue
  660. }
  661. }
  662. lh.ifce.SendMessageToVpnAddr(header.LightHouse, 0, lhVpnAddr, v1Query, nb, out)
  663. queried++
  664. } else if v == cert.Version2 {
  665. if v2Query == nil {
  666. msg.Details.OldVpnAddr = 0
  667. msg.Details.VpnAddr = netAddrToProtoAddr(addr)
  668. v2Query, err = msg.Marshal()
  669. if err != nil {
  670. lh.l.WithError(err).WithField("queryVpnAddr", addr).
  671. WithField("lighthouseAddr", lhVpnAddr).
  672. Error("Failed to marshal lighthouse v2 query payload")
  673. continue
  674. }
  675. }
  676. lh.ifce.SendMessageToVpnAddr(header.LightHouse, 0, lhVpnAddr, v2Query, nb, out)
  677. queried++
  678. } else {
  679. lh.l.Debugf("Can not query lighthouse for %v using unknown protocol version: %v", addr, v)
  680. continue
  681. }
  682. }
  683. lh.metricTx(NebulaMeta_HostQuery, int64(queried))
  684. }
  685. func (lh *LightHouse) StartUpdateWorker() {
  686. interval := lh.GetUpdateInterval()
  687. if lh.amLighthouse || interval == 0 {
  688. return
  689. }
  690. clockSource := time.NewTicker(time.Second * time.Duration(interval))
  691. updateCtx, cancel := context.WithCancel(lh.ctx)
  692. lh.updateCancel = cancel
  693. go func() {
  694. defer clockSource.Stop()
  695. for {
  696. lh.SendUpdate()
  697. select {
  698. case <-updateCtx.Done():
  699. return
  700. case <-clockSource.C:
  701. continue
  702. }
  703. }
  704. }()
  705. }
  706. func (lh *LightHouse) SendUpdate() {
  707. var v4 []*V4AddrPort
  708. var v6 []*V6AddrPort
  709. for _, e := range lh.GetAdvertiseAddrs() {
  710. if e.Addr().Is4() {
  711. v4 = append(v4, netAddrToProtoV4AddrPort(e.Addr(), e.Port()))
  712. } else {
  713. v6 = append(v6, netAddrToProtoV6AddrPort(e.Addr(), e.Port()))
  714. }
  715. }
  716. lal := lh.GetLocalAllowList()
  717. for _, e := range localAddrs(lh.l, lal) {
  718. _, found := lh.myVpnNetworksTable.Lookup(e)
  719. if found {
  720. continue
  721. }
  722. // Only add addrs that aren't my VPN/tun networks
  723. if e.Is4() {
  724. v4 = append(v4, netAddrToProtoV4AddrPort(e, uint16(lh.nebulaPort)))
  725. } else {
  726. v6 = append(v6, netAddrToProtoV6AddrPort(e, uint16(lh.nebulaPort)))
  727. }
  728. }
  729. nb := make([]byte, 12)
  730. out := make([]byte, mtu)
  731. var v1Update, v2Update []byte
  732. var err error
  733. updated := 0
  734. lighthouses := lh.GetLighthouses()
  735. for lhVpnAddr := range lighthouses {
  736. var v cert.Version
  737. hi := lh.ifce.GetHostInfo(lhVpnAddr)
  738. if hi != nil {
  739. v = hi.ConnectionState.myCert.Version()
  740. } else {
  741. v = lh.ifce.GetCertState().initiatingVersion
  742. }
  743. if v == cert.Version1 {
  744. if v1Update == nil {
  745. if !lh.myVpnNetworks[0].Addr().Is4() {
  746. lh.l.WithField("lighthouseAddr", lhVpnAddr).
  747. Warn("cannot update lighthouse using v1 protocol without an IPv4 address")
  748. continue
  749. }
  750. var relays []uint32
  751. for _, r := range lh.GetRelaysForMe() {
  752. if !r.Is4() {
  753. continue
  754. }
  755. b := r.As4()
  756. relays = append(relays, binary.BigEndian.Uint32(b[:]))
  757. }
  758. b := lh.myVpnNetworks[0].Addr().As4()
  759. msg := NebulaMeta{
  760. Type: NebulaMeta_HostUpdateNotification,
  761. Details: &NebulaMetaDetails{
  762. V4AddrPorts: v4,
  763. V6AddrPorts: v6,
  764. OldRelayVpnAddrs: relays,
  765. OldVpnAddr: binary.BigEndian.Uint32(b[:]),
  766. },
  767. }
  768. v1Update, err = msg.Marshal()
  769. if err != nil {
  770. lh.l.WithError(err).WithField("lighthouseAddr", lhVpnAddr).
  771. Error("Error while marshaling for lighthouse v1 update")
  772. continue
  773. }
  774. }
  775. lh.ifce.SendMessageToVpnAddr(header.LightHouse, 0, lhVpnAddr, v1Update, nb, out)
  776. updated++
  777. } else if v == cert.Version2 {
  778. if v2Update == nil {
  779. var relays []*Addr
  780. for _, r := range lh.GetRelaysForMe() {
  781. relays = append(relays, netAddrToProtoAddr(r))
  782. }
  783. msg := NebulaMeta{
  784. Type: NebulaMeta_HostUpdateNotification,
  785. Details: &NebulaMetaDetails{
  786. V4AddrPorts: v4,
  787. V6AddrPorts: v6,
  788. RelayVpnAddrs: relays,
  789. VpnAddr: netAddrToProtoAddr(lh.myVpnNetworks[0].Addr()),
  790. },
  791. }
  792. v2Update, err = msg.Marshal()
  793. if err != nil {
  794. lh.l.WithError(err).WithField("lighthouseAddr", lhVpnAddr).
  795. Error("Error while marshaling for lighthouse v2 update")
  796. continue
  797. }
  798. }
  799. lh.ifce.SendMessageToVpnAddr(header.LightHouse, 0, lhVpnAddr, v2Update, nb, out)
  800. updated++
  801. } else {
  802. lh.l.Debugf("Can not update lighthouse using unknown protocol version: %v", v)
  803. continue
  804. }
  805. }
  806. lh.metricTx(NebulaMeta_HostUpdateNotification, int64(updated))
  807. }
  808. type LightHouseHandler struct {
  809. lh *LightHouse
  810. nb []byte
  811. out []byte
  812. pb []byte
  813. meta *NebulaMeta
  814. l *logrus.Logger
  815. }
  816. func (lh *LightHouse) NewRequestHandler() *LightHouseHandler {
  817. lhh := &LightHouseHandler{
  818. lh: lh,
  819. nb: make([]byte, 12),
  820. out: make([]byte, mtu),
  821. l: lh.l,
  822. pb: make([]byte, mtu),
  823. meta: &NebulaMeta{
  824. Details: &NebulaMetaDetails{},
  825. },
  826. }
  827. return lhh
  828. }
  829. func (lh *LightHouse) metricRx(t NebulaMeta_MessageType, i int64) {
  830. lh.metrics.Rx(header.MessageType(t), 0, i)
  831. }
  832. func (lh *LightHouse) metricTx(t NebulaMeta_MessageType, i int64) {
  833. lh.metrics.Tx(header.MessageType(t), 0, i)
  834. }
  835. // This method is similar to Reset(), but it re-uses the pointer structs
  836. // so that we don't have to re-allocate them
  837. func (lhh *LightHouseHandler) resetMeta() *NebulaMeta {
  838. details := lhh.meta.Details
  839. lhh.meta.Reset()
  840. // Keep the array memory around
  841. details.V4AddrPorts = details.V4AddrPorts[:0]
  842. details.V6AddrPorts = details.V6AddrPorts[:0]
  843. details.RelayVpnAddrs = details.RelayVpnAddrs[:0]
  844. details.OldRelayVpnAddrs = details.OldRelayVpnAddrs[:0]
  845. details.OldVpnAddr = 0
  846. details.VpnAddr = nil
  847. lhh.meta.Details = details
  848. return lhh.meta
  849. }
  850. func (lhh *LightHouseHandler) HandleRequest(rAddr netip.AddrPort, fromVpnAddrs []netip.Addr, p []byte, w EncWriter) {
  851. n := lhh.resetMeta()
  852. err := n.Unmarshal(p)
  853. if err != nil {
  854. lhh.l.WithError(err).WithField("vpnAddrs", fromVpnAddrs).WithField("udpAddr", rAddr).
  855. Error("Failed to unmarshal lighthouse packet")
  856. return
  857. }
  858. if n.Details == nil {
  859. lhh.l.WithField("vpnAddrs", fromVpnAddrs).WithField("udpAddr", rAddr).
  860. Error("Invalid lighthouse update")
  861. return
  862. }
  863. lhh.lh.metricRx(n.Type, 1)
  864. switch n.Type {
  865. case NebulaMeta_HostQuery:
  866. lhh.handleHostQuery(n, fromVpnAddrs, rAddr, w)
  867. case NebulaMeta_HostQueryReply:
  868. lhh.handleHostQueryReply(n, fromVpnAddrs)
  869. case NebulaMeta_HostUpdateNotification:
  870. lhh.handleHostUpdateNotification(n, fromVpnAddrs, w)
  871. case NebulaMeta_HostMovedNotification:
  872. case NebulaMeta_HostPunchNotification:
  873. lhh.handleHostPunchNotification(n, fromVpnAddrs, w)
  874. case NebulaMeta_HostUpdateNotificationAck:
  875. // noop
  876. }
  877. }
  878. func (lhh *LightHouseHandler) handleHostQuery(n *NebulaMeta, fromVpnAddrs []netip.Addr, addr netip.AddrPort, w EncWriter) {
  879. // Exit if we don't answer queries
  880. if !lhh.lh.amLighthouse {
  881. if lhh.l.Level >= logrus.DebugLevel {
  882. lhh.l.Debugln("I don't answer queries, but received from: ", addr)
  883. }
  884. return
  885. }
  886. useVersion := cert.Version1
  887. var queryVpnAddr netip.Addr
  888. if n.Details.OldVpnAddr != 0 {
  889. b := [4]byte{}
  890. binary.BigEndian.PutUint32(b[:], n.Details.OldVpnAddr)
  891. queryVpnAddr = netip.AddrFrom4(b)
  892. useVersion = 1
  893. } else if n.Details.VpnAddr != nil {
  894. queryVpnAddr = protoAddrToNetAddr(n.Details.VpnAddr)
  895. useVersion = 2
  896. } else {
  897. if lhh.l.Level >= logrus.DebugLevel {
  898. lhh.l.WithField("from", fromVpnAddrs).WithField("details", n.Details).Debugln("Dropping malformed HostQuery")
  899. }
  900. return
  901. }
  902. found, ln, err := lhh.lh.queryAndPrepMessage(queryVpnAddr, func(c *cache) (int, error) {
  903. n = lhh.resetMeta()
  904. n.Type = NebulaMeta_HostQueryReply
  905. if useVersion == cert.Version1 {
  906. if !queryVpnAddr.Is4() {
  907. return 0, fmt.Errorf("invalid vpn addr for v1 handleHostQuery")
  908. }
  909. b := queryVpnAddr.As4()
  910. n.Details.OldVpnAddr = binary.BigEndian.Uint32(b[:])
  911. } else {
  912. n.Details.VpnAddr = netAddrToProtoAddr(queryVpnAddr)
  913. }
  914. lhh.coalesceAnswers(useVersion, c, n)
  915. return n.MarshalTo(lhh.pb)
  916. })
  917. if !found {
  918. return
  919. }
  920. if err != nil {
  921. lhh.l.WithError(err).WithField("vpnAddrs", fromVpnAddrs).Error("Failed to marshal lighthouse host query reply")
  922. return
  923. }
  924. lhh.lh.metricTx(NebulaMeta_HostQueryReply, 1)
  925. w.SendMessageToVpnAddr(header.LightHouse, 0, fromVpnAddrs[0], lhh.pb[:ln], lhh.nb, lhh.out[:0])
  926. lhh.sendHostPunchNotification(n, fromVpnAddrs, queryVpnAddr, w)
  927. }
  928. // sendHostPunchNotification signals the other side to punch some zero byte udp packets
  929. func (lhh *LightHouseHandler) sendHostPunchNotification(n *NebulaMeta, fromVpnAddrs []netip.Addr, punchNotifDest netip.Addr, w EncWriter) {
  930. whereToPunch := fromVpnAddrs[0]
  931. found, ln, err := lhh.lh.queryAndPrepMessage(whereToPunch, func(c *cache) (int, error) {
  932. n = lhh.resetMeta()
  933. n.Type = NebulaMeta_HostPunchNotification
  934. targetHI := lhh.lh.ifce.GetHostInfo(punchNotifDest)
  935. var useVersion cert.Version
  936. if targetHI == nil {
  937. useVersion = lhh.lh.ifce.GetCertState().initiatingVersion
  938. } else {
  939. crt := targetHI.GetCert().Certificate
  940. useVersion = crt.Version()
  941. // we can only retarget if we have a hostinfo
  942. newDest, ok := findNetworkUnion(crt.Networks(), fromVpnAddrs)
  943. if ok {
  944. whereToPunch = newDest
  945. } else {
  946. //TODO: CERT-V2 this means the destination will have no addresses in common with the punch-ee
  947. //choosing to do nothing for now, but maybe we return an error?
  948. }
  949. }
  950. if useVersion == cert.Version1 {
  951. if !whereToPunch.Is4() {
  952. return 0, fmt.Errorf("invalid vpn addr for v1 handleHostQuery")
  953. }
  954. b := whereToPunch.As4()
  955. n.Details.OldVpnAddr = binary.BigEndian.Uint32(b[:])
  956. } else if useVersion == cert.Version2 {
  957. n.Details.VpnAddr = netAddrToProtoAddr(whereToPunch)
  958. } else {
  959. return 0, errors.New("unsupported version")
  960. }
  961. lhh.coalesceAnswers(useVersion, c, n)
  962. return n.MarshalTo(lhh.pb)
  963. })
  964. if !found {
  965. return
  966. }
  967. if err != nil {
  968. lhh.l.WithError(err).WithField("vpnAddrs", fromVpnAddrs).Error("Failed to marshal lighthouse host was queried for")
  969. return
  970. }
  971. lhh.lh.metricTx(NebulaMeta_HostPunchNotification, 1)
  972. w.SendMessageToVpnAddr(header.LightHouse, 0, punchNotifDest, lhh.pb[:ln], lhh.nb, lhh.out[:0])
  973. }
  974. func (lhh *LightHouseHandler) coalesceAnswers(v cert.Version, c *cache, n *NebulaMeta) {
  975. if c.v4 != nil {
  976. if c.v4.learned != nil {
  977. n.Details.V4AddrPorts = append(n.Details.V4AddrPorts, c.v4.learned)
  978. }
  979. if len(c.v4.reported) > 0 {
  980. n.Details.V4AddrPorts = append(n.Details.V4AddrPorts, c.v4.reported...)
  981. }
  982. }
  983. if c.v6 != nil {
  984. if c.v6.learned != nil {
  985. n.Details.V6AddrPorts = append(n.Details.V6AddrPorts, c.v6.learned)
  986. }
  987. if len(c.v6.reported) > 0 {
  988. n.Details.V6AddrPorts = append(n.Details.V6AddrPorts, c.v6.reported...)
  989. }
  990. }
  991. if c.relay != nil {
  992. if v == cert.Version1 {
  993. b := [4]byte{}
  994. for _, r := range c.relay.relay {
  995. if !r.Is4() {
  996. continue
  997. }
  998. b = r.As4()
  999. n.Details.OldRelayVpnAddrs = append(n.Details.OldRelayVpnAddrs, binary.BigEndian.Uint32(b[:]))
  1000. }
  1001. } else if v == cert.Version2 {
  1002. for _, r := range c.relay.relay {
  1003. n.Details.RelayVpnAddrs = append(n.Details.RelayVpnAddrs, netAddrToProtoAddr(r))
  1004. }
  1005. } else {
  1006. //TODO: CERT-V2 don't panic
  1007. panic("unsupported version")
  1008. }
  1009. }
  1010. }
  1011. func (lhh *LightHouseHandler) handleHostQueryReply(n *NebulaMeta, fromVpnAddrs []netip.Addr) {
  1012. if !lhh.lh.IsAnyLighthouseAddr(fromVpnAddrs) {
  1013. return
  1014. }
  1015. lhh.lh.Lock()
  1016. var certVpnAddr netip.Addr
  1017. if n.Details.OldVpnAddr != 0 {
  1018. b := [4]byte{}
  1019. binary.BigEndian.PutUint32(b[:], n.Details.OldVpnAddr)
  1020. certVpnAddr = netip.AddrFrom4(b)
  1021. } else if n.Details.VpnAddr != nil {
  1022. certVpnAddr = protoAddrToNetAddr(n.Details.VpnAddr)
  1023. }
  1024. relays := n.Details.GetRelays()
  1025. am := lhh.lh.unlockedGetRemoteList([]netip.Addr{certVpnAddr})
  1026. am.Lock()
  1027. lhh.lh.Unlock()
  1028. am.unlockedSetV4(fromVpnAddrs[0], certVpnAddr, n.Details.V4AddrPorts, lhh.lh.unlockedShouldAddV4)
  1029. am.unlockedSetV6(fromVpnAddrs[0], certVpnAddr, n.Details.V6AddrPorts, lhh.lh.unlockedShouldAddV6)
  1030. am.unlockedSetRelay(fromVpnAddrs[0], relays)
  1031. am.Unlock()
  1032. // Non-blocking attempt to trigger, skip if it would block
  1033. select {
  1034. case lhh.lh.handshakeTrigger <- certVpnAddr:
  1035. default:
  1036. }
  1037. }
  1038. func (lhh *LightHouseHandler) handleHostUpdateNotification(n *NebulaMeta, fromVpnAddrs []netip.Addr, w EncWriter) {
  1039. if !lhh.lh.amLighthouse {
  1040. if lhh.l.Level >= logrus.DebugLevel {
  1041. lhh.l.Debugln("I am not a lighthouse, do not take host updates: ", fromVpnAddrs)
  1042. }
  1043. return
  1044. }
  1045. var detailsVpnAddr netip.Addr
  1046. useVersion := cert.Version1
  1047. if n.Details.OldVpnAddr != 0 {
  1048. b := [4]byte{}
  1049. binary.BigEndian.PutUint32(b[:], n.Details.OldVpnAddr)
  1050. detailsVpnAddr = netip.AddrFrom4(b)
  1051. useVersion = cert.Version1
  1052. } else if n.Details.VpnAddr != nil {
  1053. detailsVpnAddr = protoAddrToNetAddr(n.Details.VpnAddr)
  1054. useVersion = cert.Version2
  1055. } else {
  1056. if lhh.l.Level >= logrus.DebugLevel {
  1057. lhh.l.WithField("details", n.Details).Debugf("dropping invalid HostUpdateNotification")
  1058. }
  1059. return
  1060. }
  1061. //TODO: CERT-V2 hosts with only v2 certs cannot provide their ipv6 addr when contacting the lighthouse via v4?
  1062. //TODO: CERT-V2 why do we care about the vpnAddr in the packet? We know where it came from, right?
  1063. //Simple check that the host sent this not someone else
  1064. if !slices.Contains(fromVpnAddrs, detailsVpnAddr) {
  1065. if lhh.l.Level >= logrus.DebugLevel {
  1066. lhh.l.WithField("vpnAddrs", fromVpnAddrs).WithField("answer", detailsVpnAddr).Debugln("Host sent invalid update")
  1067. }
  1068. return
  1069. }
  1070. relays := n.Details.GetRelays()
  1071. lhh.lh.Lock()
  1072. am := lhh.lh.unlockedGetRemoteList(fromVpnAddrs)
  1073. am.Lock()
  1074. lhh.lh.Unlock()
  1075. am.unlockedSetV4(fromVpnAddrs[0], detailsVpnAddr, n.Details.V4AddrPorts, lhh.lh.unlockedShouldAddV4)
  1076. am.unlockedSetV6(fromVpnAddrs[0], detailsVpnAddr, n.Details.V6AddrPorts, lhh.lh.unlockedShouldAddV6)
  1077. am.unlockedSetRelay(fromVpnAddrs[0], relays)
  1078. am.Unlock()
  1079. n = lhh.resetMeta()
  1080. n.Type = NebulaMeta_HostUpdateNotificationAck
  1081. if useVersion == cert.Version1 {
  1082. if !fromVpnAddrs[0].Is4() {
  1083. lhh.l.WithField("vpnAddrs", fromVpnAddrs).Error("Can not send HostUpdateNotificationAck for a ipv6 vpn ip in a v1 message")
  1084. return
  1085. }
  1086. vpnAddrB := fromVpnAddrs[0].As4()
  1087. n.Details.OldVpnAddr = binary.BigEndian.Uint32(vpnAddrB[:])
  1088. } else if useVersion == cert.Version2 {
  1089. n.Details.VpnAddr = netAddrToProtoAddr(fromVpnAddrs[0])
  1090. } else {
  1091. lhh.l.WithField("useVersion", useVersion).Error("invalid protocol version")
  1092. return
  1093. }
  1094. ln, err := n.MarshalTo(lhh.pb)
  1095. if err != nil {
  1096. lhh.l.WithError(err).WithField("vpnAddrs", fromVpnAddrs).Error("Failed to marshal lighthouse host update ack")
  1097. return
  1098. }
  1099. lhh.lh.metricTx(NebulaMeta_HostUpdateNotificationAck, 1)
  1100. w.SendMessageToVpnAddr(header.LightHouse, 0, fromVpnAddrs[0], lhh.pb[:ln], lhh.nb, lhh.out[:0])
  1101. }
  1102. func (lhh *LightHouseHandler) handleHostPunchNotification(n *NebulaMeta, fromVpnAddrs []netip.Addr, w EncWriter) {
  1103. //It's possible the lighthouse is communicating with us using a non primary vpn addr,
  1104. //which means we need to compare all fromVpnAddrs against all configured lighthouse vpn addrs.
  1105. //maybe one day we'll have a better idea, if it matters.
  1106. if !lhh.lh.IsAnyLighthouseAddr(fromVpnAddrs) {
  1107. return
  1108. }
  1109. empty := []byte{0}
  1110. punch := func(vpnPeer netip.AddrPort) {
  1111. if !vpnPeer.IsValid() {
  1112. return
  1113. }
  1114. go func() {
  1115. time.Sleep(lhh.lh.punchy.GetDelay())
  1116. lhh.lh.metricHolepunchTx.Inc(1)
  1117. lhh.lh.punchConn.WriteTo(empty, vpnPeer)
  1118. }()
  1119. if lhh.l.Level >= logrus.DebugLevel {
  1120. var logVpnAddr netip.Addr
  1121. if n.Details.OldVpnAddr != 0 {
  1122. b := [4]byte{}
  1123. binary.BigEndian.PutUint32(b[:], n.Details.OldVpnAddr)
  1124. logVpnAddr = netip.AddrFrom4(b)
  1125. } else if n.Details.VpnAddr != nil {
  1126. logVpnAddr = protoAddrToNetAddr(n.Details.VpnAddr)
  1127. }
  1128. lhh.l.Debugf("Punching on %v for %v", vpnPeer, logVpnAddr)
  1129. }
  1130. }
  1131. for _, a := range n.Details.V4AddrPorts {
  1132. punch(protoV4AddrPortToNetAddrPort(a))
  1133. }
  1134. for _, a := range n.Details.V6AddrPorts {
  1135. punch(protoV6AddrPortToNetAddrPort(a))
  1136. }
  1137. // This sends a nebula test packet to the host trying to contact us. In the case
  1138. // of a double nat or other difficult scenario, this may help establish
  1139. // a tunnel.
  1140. if lhh.lh.punchy.GetRespond() {
  1141. var queryVpnAddr netip.Addr
  1142. if n.Details.OldVpnAddr != 0 {
  1143. b := [4]byte{}
  1144. binary.BigEndian.PutUint32(b[:], n.Details.OldVpnAddr)
  1145. queryVpnAddr = netip.AddrFrom4(b)
  1146. } else if n.Details.VpnAddr != nil {
  1147. queryVpnAddr = protoAddrToNetAddr(n.Details.VpnAddr)
  1148. }
  1149. go func() {
  1150. time.Sleep(lhh.lh.punchy.GetRespondDelay())
  1151. if lhh.l.Level >= logrus.DebugLevel {
  1152. lhh.l.Debugf("Sending a nebula test packet to vpn addr %s", queryVpnAddr)
  1153. }
  1154. //NOTE: we have to allocate a new output buffer here since we are spawning a new goroutine
  1155. // for each punchBack packet. We should move this into a timerwheel or a single goroutine
  1156. // managed by a channel.
  1157. w.SendMessageToVpnAddr(header.Test, header.TestRequest, queryVpnAddr, []byte(""), make([]byte, 12), make([]byte, mtu))
  1158. }()
  1159. }
  1160. }
  1161. func protoAddrToNetAddr(addr *Addr) netip.Addr {
  1162. b := [16]byte{}
  1163. binary.BigEndian.PutUint64(b[:8], addr.Hi)
  1164. binary.BigEndian.PutUint64(b[8:], addr.Lo)
  1165. return netip.AddrFrom16(b).Unmap()
  1166. }
  1167. func protoV4AddrPortToNetAddrPort(ap *V4AddrPort) netip.AddrPort {
  1168. b := [4]byte{}
  1169. binary.BigEndian.PutUint32(b[:], ap.Addr)
  1170. return netip.AddrPortFrom(netip.AddrFrom4(b), uint16(ap.Port))
  1171. }
  1172. func protoV6AddrPortToNetAddrPort(ap *V6AddrPort) netip.AddrPort {
  1173. b := [16]byte{}
  1174. binary.BigEndian.PutUint64(b[:8], ap.Hi)
  1175. binary.BigEndian.PutUint64(b[8:], ap.Lo)
  1176. return netip.AddrPortFrom(netip.AddrFrom16(b), uint16(ap.Port))
  1177. }
  1178. func netAddrToProtoAddr(addr netip.Addr) *Addr {
  1179. b := addr.As16()
  1180. return &Addr{
  1181. Hi: binary.BigEndian.Uint64(b[:8]),
  1182. Lo: binary.BigEndian.Uint64(b[8:]),
  1183. }
  1184. }
  1185. func netAddrToProtoV4AddrPort(addr netip.Addr, port uint16) *V4AddrPort {
  1186. v4Addr := addr.As4()
  1187. return &V4AddrPort{
  1188. Addr: binary.BigEndian.Uint32(v4Addr[:]),
  1189. Port: uint32(port),
  1190. }
  1191. }
  1192. func netAddrToProtoV6AddrPort(addr netip.Addr, port uint16) *V6AddrPort {
  1193. v6Addr := addr.As16()
  1194. return &V6AddrPort{
  1195. Hi: binary.BigEndian.Uint64(v6Addr[:8]),
  1196. Lo: binary.BigEndian.Uint64(v6Addr[8:]),
  1197. Port: uint32(port),
  1198. }
  1199. }
  1200. func (d *NebulaMetaDetails) GetRelays() []netip.Addr {
  1201. var relays []netip.Addr
  1202. if len(d.OldRelayVpnAddrs) > 0 {
  1203. b := [4]byte{}
  1204. for _, r := range d.OldRelayVpnAddrs {
  1205. binary.BigEndian.PutUint32(b[:], r)
  1206. relays = append(relays, netip.AddrFrom4(b))
  1207. }
  1208. }
  1209. if len(d.RelayVpnAddrs) > 0 {
  1210. for _, r := range d.RelayVpnAddrs {
  1211. relays = append(relays, protoAddrToNetAddr(r))
  1212. }
  1213. }
  1214. return relays
  1215. }
  1216. // FindNetworkUnion returns the first netip.Addr contained in the list of provided netip.Prefix, if able
  1217. func findNetworkUnion(prefixes []netip.Prefix, addrs []netip.Addr) (netip.Addr, bool) {
  1218. for i := range prefixes {
  1219. for j := range addrs {
  1220. if prefixes[i].Contains(addrs[j]) {
  1221. return addrs[j], true
  1222. }
  1223. }
  1224. }
  1225. return netip.Addr{}, false
  1226. }