package multicast import ( "context" "fmt" "net" "regexp" "time" "github.com/Arceliar/phony" "github.com/gologme/log" "github.com/yggdrasil-network/yggdrasil-go/src/config" "github.com/yggdrasil-network/yggdrasil-go/src/yggdrasil" "golang.org/x/net/ipv6" ) // Multicast represents the multicast advertisement and discovery mechanism used // by Yggdrasil to find peers on the same subnet. When a beacon is received on a // configured multicast interface, Yggdrasil will attempt to peer with that node // automatically. type Multicast struct { phony.Inbox core *yggdrasil.Core config *config.NodeState log *log.Logger sock *ipv6.PacketConn groupAddr string listeners map[string]*listenerInfo listenPort uint16 isOpen bool announcer *time.Timer platformhandler *time.Timer } type listenerInfo struct { listener *yggdrasil.TcpListener time time.Time interval time.Duration } // Init prepares the multicast interface for use. func (m *Multicast) Init(core *yggdrasil.Core, state *config.NodeState, log *log.Logger, options interface{}) error { m.core = core m.config = state m.log = log m.listeners = make(map[string]*listenerInfo) current := m.config.GetCurrent() m.listenPort = current.LinkLocalTCPPort m.groupAddr = "[ff02::114]:9001" return nil } // Start starts the multicast interface. This launches goroutines which will // listen for multicast beacons from other hosts and will advertise multicast // beacons out to the network. func (m *Multicast) Start() error { var err error phony.Block(m, func() { err = m._start() }) m.log.Debugln("Started multicast module") return err } func (m *Multicast) _start() error { if m.isOpen { return fmt.Errorf("multicast module is already started") } if len(m.config.GetCurrent().MulticastInterfaces) == 0 { return nil } m.log.Infoln("Starting multicast module") addr, err := net.ResolveUDPAddr("udp", m.groupAddr) if err != nil { return err } listenString := fmt.Sprintf("[::]:%v", addr.Port) lc := net.ListenConfig{ Control: m.multicastReuse, } conn, err := lc.ListenPacket(context.Background(), "udp6", listenString) if err != nil { return err } m.sock = ipv6.NewPacketConn(conn) if err = m.sock.SetControlMessage(ipv6.FlagDst, true); err != nil { // Windows can't set this flag, so we need to handle it in other ways } m.isOpen = true go m.listen() m.Act(m, m.multicastStarted) m.Act(m, m.announce) return nil } // IsStarted returns true if the module has been started. func (m *Multicast) IsStarted() bool { var isOpen bool phony.Block(m, func() { isOpen = m.isOpen }) return isOpen } // Stop stops the multicast module. func (m *Multicast) Stop() error { var err error phony.Block(m, func() { err = m._stop() }) m.log.Debugln("Stopped multicast module") return nil } func (m *Multicast) _stop() error { m.log.Infoln("Stopping multicast module") m.isOpen = false if m.announcer != nil { m.announcer.Stop() } if m.platformhandler != nil { m.platformhandler.Stop() } if m.sock != nil { m.sock.Close() } return nil } // UpdateConfig updates the multicast module with the provided config.NodeConfig // and then signals the various module goroutines to reconfigure themselves if // needed. func (m *Multicast) UpdateConfig(config *config.NodeConfig) { m.Act(m, func() { m._updateConfig(config) }) } func (m *Multicast) _updateConfig(config *config.NodeConfig) { m.log.Infoln("Reloading multicast configuration...") if m.isOpen { if len(config.MulticastInterfaces) == 0 || config.LinkLocalTCPPort != m.listenPort { if err := m._stop(); err != nil { m.log.Errorln("Error stopping multicast module:", err) } } } m.config.Replace(*config) m.listenPort = config.LinkLocalTCPPort if !m.isOpen && len(config.MulticastInterfaces) > 0 { if err := m._start(); err != nil { m.log.Errorln("Error starting multicast module:", err) } } m.log.Debugln("Reloaded multicast configuration successfully") } // GetInterfaces returns the currently known/enabled multicast interfaces. It is // expected that UpdateInterfaces has been called at least once before calling // this method. func (m *Multicast) Interfaces() map[string]net.Interface { interfaces := make(map[string]net.Interface) // Get interface expressions from config current := m.config.GetCurrent() exprs := current.MulticastInterfaces // Ask the system for network interfaces allifaces, err := net.Interfaces() if err != nil { panic(err) } // Work out which interfaces to announce on for _, iface := range allifaces { if iface.Flags&net.FlagUp == 0 { // Ignore interfaces that are down continue } if iface.Flags&net.FlagMulticast == 0 { // Ignore non-multicast interfaces continue } if iface.Flags&net.FlagPointToPoint != 0 { // Ignore point-to-point interfaces continue } for _, expr := range exprs { // Compile each regular expression e, err := regexp.Compile(expr) if err != nil { panic(err) } // Does the interface match the regular expression? Store it if so if e.MatchString(iface.Name) { interfaces[iface.Name] = iface } } } return interfaces } func (m *Multicast) announce() { groupAddr, err := net.ResolveUDPAddr("udp6", m.groupAddr) if err != nil { panic(err) } destAddr, err := net.ResolveUDPAddr("udp6", m.groupAddr) if err != nil { panic(err) } interfaces := m.Interfaces() // There might be interfaces that we configured listeners for but are no // longer up - if that's the case then we should stop the listeners for name, info := range m.listeners { // Prepare our stop function! stop := func() { info.listener.Stop() delete(m.listeners, name) m.log.Debugln("No longer multicasting on", name) } // If the interface is no longer visible on the system then stop the // listener, as another one will be started further down if _, ok := interfaces[name]; !ok { stop() continue } // It's possible that the link-local listener address has changed so if // that is the case then we should clean up the interface listener found := false listenaddr, err := net.ResolveTCPAddr("tcp6", info.listener.Listener.Addr().String()) if err != nil { stop() continue } // Find the interface that matches the listener if intf, err := net.InterfaceByName(name); err == nil { if addrs, err := intf.Addrs(); err == nil { // Loop through the addresses attached to that listener and see if any // of them match the current address of the listener for _, addr := range addrs { if ip, _, err := net.ParseCIDR(addr.String()); err == nil { // Does the interface address match our listener address? if ip.Equal(listenaddr.IP) { found = true break } } } } } // If the address has not been found on the adapter then we should stop // and clean up the TCP listener. A new one will be created below if a // suitable link-local address is found if !found { stop() } } // Now that we have a list of valid interfaces from the operating system, // we can start checking if we can send multicasts on them for _, iface := range interfaces { // Find interface addresses addrs, err := iface.Addrs() if err != nil { panic(err) } for _, addr := range addrs { addrIP, _, _ := net.ParseCIDR(addr.String()) // Ignore IPv4 addresses if addrIP.To4() != nil { continue } // Ignore non-link-local addresses if !addrIP.IsLinkLocalUnicast() { continue } // Join the multicast group m.sock.JoinGroup(&iface, groupAddr) // Try and see if we already have a TCP listener for this interface var info *listenerInfo if nfo, ok := m.listeners[iface.Name]; !ok || nfo.listener.Listener == nil { // No listener was found - let's create one listenaddr := fmt.Sprintf("[%s%%%s]:%d", addrIP, iface.Name, m.listenPort) if li, err := m.core.ListenTCP(listenaddr); err == nil { m.log.Debugln("Started multicasting on", iface.Name) // Store the listener so that we can stop it later if needed info = &listenerInfo{listener: li, time: time.Now()} m.listeners[iface.Name] = info } else { m.log.Warnln("Not multicasting on", iface.Name, "due to error:", err) } } else { // An existing listener was found info = m.listeners[iface.Name] } // Make sure nothing above failed for some reason if info == nil { continue } if time.Since(info.time) < info.interval { continue } // Get the listener details and construct the multicast beacon lladdr := info.listener.Listener.Addr().String() if a, err := net.ResolveTCPAddr("tcp6", lladdr); err == nil { a.Zone = "" destAddr.Zone = iface.Name msg := []byte(a.String()) m.sock.WriteTo(msg, nil, destAddr) } if info.interval.Seconds() < 15 { info.interval += time.Second } break } } m.announcer = time.AfterFunc(time.Second, func() { m.Act(m, m.announce) }) } func (m *Multicast) listen() { groupAddr, err := net.ResolveUDPAddr("udp6", m.groupAddr) if err != nil { panic(err) } bs := make([]byte, 2048) for { nBytes, rcm, fromAddr, err := m.sock.ReadFrom(bs) if err != nil { if !m.IsStarted() { return } panic(err) } if rcm != nil { // Windows can't set the flag needed to return a non-nil value here // So only make these checks if we get something useful back // TODO? Skip them always, I'm not sure if they're really needed... if !rcm.Dst.IsLinkLocalMulticast() { continue } if !rcm.Dst.Equal(groupAddr.IP) { continue } } anAddr := string(bs[:nBytes]) addr, err := net.ResolveTCPAddr("tcp6", anAddr) if err != nil { continue } from := fromAddr.(*net.UDPAddr) if addr.IP.String() != from.IP.String() { continue } if _, ok := m.Interfaces()[from.Zone]; ok { addr.Zone = "" if err := m.core.CallPeer("tcp://"+addr.String(), from.Zone); err != nil { m.log.Debugln("Call from multicast failed:", err) } } } }