lighthouse.go 41 KB

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