lighthouse.go 40 KB

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