package nebula import ( "net" "os" "os/signal" "sync/atomic" "syscall" "github.com/sirupsen/logrus" "github.com/slackhq/nebula/cert" ) // Every interaction here needs to take extra care to copy memory and not return or use arguments "as is" when touching // core. This means copying IP objects, slices, de-referencing pointers and taking the actual value, etc type Control struct { f *Interface l *logrus.Logger } type ControlHostInfo struct { VpnIP net.IP `json:"vpnIp"` LocalIndex uint32 `json:"localIndex"` RemoteIndex uint32 `json:"remoteIndex"` RemoteAddrs []*udpAddr `json:"remoteAddrs"` CachedPackets int `json:"cachedPackets"` Cert *cert.NebulaCertificate `json:"cert"` MessageCounter uint64 `json:"messageCounter"` CurrentRemote *udpAddr `json:"currentRemote"` } // Start actually runs nebula, this is a nonblocking call. To block use Control.ShutdownBlock() func (c *Control) Start() { c.f.run() } // Stop signals nebula to shutdown, returns after the shutdown is complete func (c *Control) Stop() { //TODO: stop tun and udp routines, the lock on hostMap effectively does that though c.CloseAllTunnels(false) c.l.Info("Goodbye") } // ShutdownBlock will listen for and block on term and interrupt signals, calling Control.Stop() once signalled func (c *Control) ShutdownBlock() { sigChan := make(chan os.Signal) signal.Notify(sigChan, syscall.SIGTERM) signal.Notify(sigChan, syscall.SIGINT) rawSig := <-sigChan sig := rawSig.String() c.l.WithField("signal", sig).Info("Caught signal, shutting down") c.Stop() } // RebindUDPServer asks the UDP listener to rebind it's listener. Mainly used on mobile clients when interfaces change func (c *Control) RebindUDPServer() { _ = c.f.outside.Rebind() // Trigger a lighthouse update, useful for mobile clients that should have an update interval of 0 c.f.lightHouse.SendUpdate(c.f) // Let the main interface know that we rebound so that underlying tunnels know to trigger punches from their remotes c.f.rebindCount++ } // ListHostmap returns details about the actual or pending (handshaking) hostmap func (c *Control) ListHostmap(pendingMap bool) []ControlHostInfo { var hm *HostMap if pendingMap { hm = c.f.handshakeManager.pendingHostMap } else { hm = c.f.hostMap } hm.RLock() hosts := make([]ControlHostInfo, len(hm.Hosts)) i := 0 for _, v := range hm.Hosts { hosts[i] = copyHostInfo(v) i++ } hm.RUnlock() return hosts } // GetHostInfoByVpnIP returns a single tunnels hostInfo, or nil if not found func (c *Control) GetHostInfoByVpnIP(vpnIP uint32, pending bool) *ControlHostInfo { var hm *HostMap if pending { hm = c.f.handshakeManager.pendingHostMap } else { hm = c.f.hostMap } h, err := hm.QueryVpnIP(vpnIP) if err != nil { return nil } ch := copyHostInfo(h) return &ch } // SetRemoteForTunnel forces a tunnel to use a specific remote func (c *Control) SetRemoteForTunnel(vpnIP uint32, addr udpAddr) *ControlHostInfo { hostInfo, err := c.f.hostMap.QueryVpnIP(vpnIP) if err != nil { return nil } hostInfo.SetRemote(addr.Copy()) ch := copyHostInfo(hostInfo) return &ch } // CloseTunnel closes a fully established tunnel. If localOnly is false it will notify the remote end as well. func (c *Control) CloseTunnel(vpnIP uint32, localOnly bool) bool { hostInfo, err := c.f.hostMap.QueryVpnIP(vpnIP) if err != nil { return false } if !localOnly { c.f.send( closeTunnel, 0, hostInfo.ConnectionState, hostInfo, hostInfo.remote, []byte{}, make([]byte, 12, 12), make([]byte, mtu), ) } c.f.closeTunnel(hostInfo) return true } // CloseAllTunnels is just like CloseTunnel except it goes through and shuts them all down, optionally you can avoid shutting down lighthouse tunnels // the int returned is a count of tunnels closed func (c *Control) CloseAllTunnels(excludeLighthouses bool) (closed int) { //TODO: this is probably better as a function in ConnectionManager or HostMap directly c.f.hostMap.Lock() for _, h := range c.f.hostMap.Hosts { if excludeLighthouses { if _, ok := c.f.lightHouse.lighthouses[h.hostId]; ok { continue } } if h.ConnectionState.ready { c.f.send(closeTunnel, 0, h.ConnectionState, h, h.remote, []byte{}, make([]byte, 12, 12), make([]byte, mtu)) c.l.WithField("vpnIp", IntIp(h.hostId)).WithField("udpAddr", h.remote). Debug("Sending close tunnel message") closed++ } } c.f.hostMap.Unlock() return } func copyHostInfo(h *HostInfo) ControlHostInfo { chi := ControlHostInfo{ VpnIP: int2ip(h.hostId), LocalIndex: h.localIndexId, RemoteIndex: h.remoteIndexId, RemoteAddrs: h.CopyRemotes(), CachedPackets: len(h.packetStore), MessageCounter: atomic.LoadUint64(&h.ConnectionState.atomicMessageCounter), } if c := h.GetCert(); c != nil { chi.Cert = c.Copy() } if h.remote != nil { chi.CurrentRemote = h.remote.Copy() } return chi }