lighthouse.go 40 KB

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