// automerge: package is depracated and unused. Please refer to crdt // for crdt operations in the mesh package automerge import ( "errors" "fmt" "net" "slices" "strings" "time" "github.com/automerge/automerge-go" "github.com/tim-beatham/smegmesh/pkg/conf" "github.com/tim-beatham/smegmesh/pkg/lib" logging "github.com/tim-beatham/smegmesh/pkg/log" "github.com/tim-beatham/smegmesh/pkg/mesh" "golang.zx2c4.com/wireguard/wgctrl" "golang.zx2c4.com/wireguard/wgctrl/wgtypes" ) // CrdtMeshManager manage the CRDT datastore type CrdtMeshManager struct { // MeshID of the mesh the datastore represents MeshId string // IfName: corresponding ifName IfName string // Client: corresponding wireguard control client Client *wgctrl.Client // doc: autommerge document doc *automerge.Doc // LastHash: last hash that the changes were made to LastHash automerge.ChangeHash // conf: WireGuard configuration conf *conf.WgConfiguration // cache: stored cache of the list automerge document // so that the store does not have to be repopulated each time cache *MeshCrdt // lastCachehash: hash of when the document was last changed lastCacheHash automerge.ChangeHash } // AddNode as a node to the datastore func (c *CrdtMeshManager) AddNode(node mesh.MeshNode) { crdt, ok := node.(*MeshNodeCrdt) if !ok { panic("node must be of type *MeshNodeCrdt") } crdt.Routes = make(map[string]Route) crdt.Services = make(map[string]string) crdt.Timestamp = time.Now().Unix() err := c.doc.Path("nodes").Map().Set(crdt.PublicKey, crdt) if err != nil { logging.Log.WriteInfof("error") } } // isPeer: returns true if the given node has type peer func (c *CrdtMeshManager) isPeer(nodeId string) bool { node, err := c.doc.Path("nodes").Map().Get(nodeId) if err != nil || node.Kind() != automerge.KindMap { return false } nodeType, err := node.Map().Get("type") if err != nil || nodeType.Kind() != automerge.KindStr { return false } return nodeType.Str() == string(conf.PEER_ROLE) } // isAlive: checks that the node's configuration has been updated // since the rquired keep alive time. Depracated no longer works // due to changes in approach func (c *CrdtMeshManager) isAlive(nodeId string) bool { node, err := c.doc.Path("nodes").Map().Get(nodeId) if err != nil || node.Kind() != automerge.KindMap { return false } timestamp, err := node.Map().Get("timestamp") if err != nil || timestamp.Kind() != automerge.KindInt64 { return false } // return (time.Now().Unix() - keepAliveTime) < int64(c.conf.DeadTime) return true } // GetPeers: get all the peers in the mesh func (c *CrdtMeshManager) GetPeers() []string { keys, _ := c.doc.Path("nodes").Map().Keys() keys = lib.Filter(keys, func(publicKey string) bool { return c.isPeer(publicKey) && c.isAlive(publicKey) }) return keys } // GetMesh: Converts the document into a mesh network func (c *CrdtMeshManager) GetMesh() (mesh.MeshSnapshot, error) { changes, err := c.doc.Changes(c.lastCacheHash) if err != nil { return nil, err } if c.cache == nil || len(changes) > 0 { c.lastCacheHash = c.LastHash cache, err := automerge.As[*MeshCrdt](c.doc.Root()) if err != nil { return nil, err } c.cache = cache } return c.cache, nil } // GetMeshId: returns the meshid of the mesh func (c *CrdtMeshManager) GetMeshId() string { return c.MeshId } // Save: Save an entire mesh network func (c *CrdtMeshManager) Save() []byte { return c.doc.Save() } // Load: Load an entire mesh network func (c *CrdtMeshManager) Load(bytes []byte) error { doc, err := automerge.Load(bytes) if err != nil { return err } c.doc = doc return nil } // NewCrdtNodeManagerParams: params to instantiate a new automerge // datastore type NewCrdtNodeMangerParams struct { MeshId string DevName string Port int Conf *conf.WgConfiguration Client *wgctrl.Client } // NewCrdtNodeManager: Create a new automerge crdt data store func NewCrdtNodeManager(params *NewCrdtNodeMangerParams) (*CrdtMeshManager, error) { var manager CrdtMeshManager manager.MeshId = params.MeshId manager.doc = automerge.New() manager.IfName = params.DevName manager.Client = params.Client manager.conf = params.Conf manager.cache = nil return &manager, nil } // NodeExists: returns true if the node exists other returns false func (m *CrdtMeshManager) NodeExists(key string) bool { node, err := m.doc.Path("nodes").Map().Get(key) return node.Kind() == automerge.KindMap && err == nil } // GetNode: gets a node from the mesh network. func (m *CrdtMeshManager) GetNode(endpoint string) (mesh.MeshNode, error) { node, err := m.doc.Path("nodes").Map().Get(endpoint) if node.Kind() != automerge.KindMap { return nil, fmt.Errorf("getnode: node is not a map") } if err != nil { return nil, err } meshNode, err := automerge.As[*MeshNodeCrdt](node) if err != nil { return nil, err } return meshNode, nil } // Length: returns the number of nodes in the store func (m *CrdtMeshManager) Length() int { return m.doc.Path("nodes").Map().Len() } // GetDevice: get the underlying WireGuard device func (m *CrdtMeshManager) GetDevice() (*wgtypes.Device, error) { dev, err := m.Client.Device(m.IfName) if err != nil { return nil, err } return dev, nil } // HasChanges: returns true if there are changes since last time synchronised func (m *CrdtMeshManager) HasChanges() bool { changes, err := m.doc.Changes(m.LastHash) logging.Log.WriteInfof("Changes %s", m.LastHash.String()) if err != nil { return false } logging.Log.WriteInfof("Changes length %d", len(changes)) return len(changes) > 0 } // SaveChanges: save changes to the datastore func (m *CrdtMeshManager) SaveChanges() { hashes := m.doc.Heads() hash := hashes[len(hashes)-1] logging.Log.WriteInfof("Saved Hash %s", hash.String()) m.LastHash = hash } // UpdateTimeStamp: updates the timestamp of the document func (m *CrdtMeshManager) UpdateTimeStamp(nodeId string) error { node, err := m.doc.Path("nodes").Map().Get(nodeId) if err != nil { return err } if node.Kind() != automerge.KindMap { return errors.New("node is not a map") } err = node.Map().Set("timestamp", time.Now().Unix()) if err == nil { logging.Log.WriteInfof("Timestamp Updated for %s", nodeId) } return err } // SetDescription: set the description of the given node func (m *CrdtMeshManager) SetDescription(nodeId string, description string) error { node, err := m.doc.Path("nodes").Map().Get(nodeId) if err != nil { return err } if node.Kind() != automerge.KindMap { return fmt.Errorf("%s does not exist", nodeId) } err = node.Map().Set("description", description) if err == nil { logging.Log.WriteInfof("Description Updated for %s", nodeId) } return err } // SetAlias: set the alias of the given node func (m *CrdtMeshManager) SetAlias(nodeId string, alias string) error { node, err := m.doc.Path("nodes").Map().Get(nodeId) if err != nil { return err } if node.Kind() != automerge.KindMap { return fmt.Errorf("%s does not exist", nodeId) } err = node.Map().Set("alias", alias) if err == nil { logging.Log.WriteInfof("Updated Alias for %s to %s", nodeId, alias) } return err } // AddService: add a service to the given node func (m *CrdtMeshManager) AddService(nodeId, key, value string) error { node, err := m.doc.Path("nodes").Map().Get(nodeId) if err != nil || node.Kind() != automerge.KindMap { return fmt.Errorf("AddService: node %s does not exist", nodeId) } service, err := node.Map().Get("services") if err != nil { return err } if service.Kind() != automerge.KindMap { return fmt.Errorf("AddService: services property does not exist in node") } err = service.Map().Set(key, value) return err } // RemoveService: remove a service from a node func (m *CrdtMeshManager) RemoveService(nodeId, key string) error { node, err := m.doc.Path("nodes").Map().Get(nodeId) if err != nil || node.Kind() != automerge.KindMap { return fmt.Errorf("RemoveService: node %s does not exist", nodeId) } service, err := node.Map().Get("services") if err != nil { return err } if service.Kind() != automerge.KindMap { return fmt.Errorf("services property does not exist") } err = service.Map().Delete(key) if err != nil { return fmt.Errorf("service %s does not exist", key) } return nil } // AddRoutes: adds routes to the specific nodeId func (m *CrdtMeshManager) AddRoutes(nodeId string, routes ...mesh.Route) error { nodeVal, err := m.doc.Path("nodes").Map().Get(nodeId) logging.Log.WriteInfof("Adding route to %s", nodeId) if err != nil { return err } if nodeVal.Kind() != automerge.KindMap { return fmt.Errorf("node does not exist") } routeMap, err := nodeVal.Map().Get("routes") if err != nil { return err } for _, route := range routes { prevRoute, err := routeMap.Map().Get(route.GetDestination().String()) if prevRoute.Kind() == automerge.KindVoid && err != nil { path, err := prevRoute.Map().Get("path") if err != nil { return err } if path.Kind() != automerge.KindList { return fmt.Errorf("path is not a list") } pathStr, err := automerge.As[[]string](path) if err != nil { return err } slices.Equal(route.GetPath(), pathStr) } err = routeMap.Map().Set(route.GetDestination().String(), Route{ Destination: route.GetDestination().String(), Path: route.GetPath(), }) if err != nil { return err } } return nil } // getRoutes: get the routes that the given node is directly advertising func (m *CrdtMeshManager) getRoutes(nodeId string) ([]Route, error) { nodeVal, err := m.doc.Path("nodes").Map().Get(nodeId) if err != nil { return nil, err } if nodeVal.Kind() != automerge.KindMap { return nil, fmt.Errorf("node does not exist") } routeMap, err := nodeVal.Map().Get("routes") if err != nil { return nil, err } if routeMap.Kind() != automerge.KindMap { return nil, fmt.Errorf("node %s is not a map", nodeId) } routes, err := automerge.As[map[string]Route](routeMap) return lib.MapValues(routes), err } // GetRoutes: get all the routes that the node can see. The routes that the node // can say may not be direct but cann also be indirect func (m *CrdtMeshManager) GetRoutes(targetNode string) (map[string]mesh.Route, error) { node, err := m.GetNode(targetNode) if err != nil { return nil, err } routes := make(map[string]mesh.Route) // Add routes that the node directly has for _, route := range node.GetRoutes() { routes[route.GetDestination().String()] = route } // Work out the other routes in the mesh for _, node := range m.GetPeers() { nodeRoutes, err := m.getRoutes(node) if err != nil { return nil, err } for _, route := range nodeRoutes { otherRoute, ok := routes[route.GetDestination().String()] hopCount := route.GetHopCount() if node != targetNode { hopCount += 1 } if !ok || route.GetHopCount()+1 < otherRoute.GetHopCount() { routes[route.GetDestination().String()] = &Route{ Destination: route.GetDestination().String(), Path: append(route.Path, m.GetMeshId()), } } } } return routes, nil } // RemoveNode: removes a node from the datastore func (m *CrdtMeshManager) RemoveNode(nodeId string) error { err := m.doc.Path("nodes").Map().Delete(nodeId) return err } // RemoveRoutes: withdraw all the routes the nodeID is advertising func (m *CrdtMeshManager) RemoveRoutes(nodeId string, routes ...mesh.Route) error { nodeVal, err := m.doc.Path("nodes").Map().Get(nodeId) if err != nil { return err } if nodeVal.Kind() != automerge.KindMap { return fmt.Errorf("node is not a map") } routeMap, err := nodeVal.Map().Get("routes") if err != nil { return err } for _, route := range routes { err = routeMap.Map().Delete(route.GetDestination().String()) } return err } // GetConfiguration: gets the configuration for this mesh network func (m *CrdtMeshManager) GetConfiguration() *conf.WgConfiguration { return m.conf } // Mark: mark the node as locally dead func (m *CrdtMeshManager) Mark(nodeId string) { } // GetSyncer: get the bi-directionally syncer to synchronise the document func (m *CrdtMeshManager) GetSyncer() mesh.MeshSyncer { return NewAutomergeSync(m) } // Prune: prune all dead nodes func (m *CrdtMeshManager) Prune() error { return nil } // Compare: compare two mesh node for equality func (m1 *MeshNodeCrdt) Compare(m2 *MeshNodeCrdt) int { return strings.Compare(m1.PublicKey, m2.PublicKey) } // GetHostEndpoint: get the ctrl endpoint of the host func (m *MeshNodeCrdt) GetHostEndpoint() string { return m.HostEndpoint } // GetPublicKey: get the public key of the node func (m *MeshNodeCrdt) GetPublicKey() (wgtypes.Key, error) { return wgtypes.ParseKey(m.PublicKey) } // GetWgEndpoint: get the outer WireGuard endpoint func (m *MeshNodeCrdt) GetWgEndpoint() string { return m.WgEndpoint } // GetWgHost: get the WireGuard IP address of the host func (m *MeshNodeCrdt) GetWgHost() *net.IPNet { _, ipnet, err := net.ParseCIDR(m.WgHost) if err != nil { return nil } return ipnet } // GetTimeStamp: get timestamp if when the node was last updated func (m *MeshNodeCrdt) GetTimeStamp() int64 { return m.Timestamp } // GetRoutes: get all the routes advertised by the node func (m *MeshNodeCrdt) GetRoutes() []mesh.Route { return lib.Map(lib.MapValues(m.Routes), func(r Route) mesh.Route { return &Route{ Destination: r.Destination, Path: r.Path, } }) } // GetDescription: get the description of the node func (m *MeshNodeCrdt) GetDescription() string { return m.Description } // GetIdentifier: get the iderntifier section of the ipv6 address func (m *MeshNodeCrdt) GetIdentifier() string { ipv6 := m.WgHost[:len(m.WgHost)-4] constituents := strings.Split(ipv6, ":") constituents = constituents[4:] return strings.Join(constituents, ":") } // GetAlias: get the alias of the node func (m *MeshNodeCrdt) GetAlias() string { return m.Alias } // GetServices: get all the services the node is advertising func (m *MeshNodeCrdt) GetServices() map[string]string { services := make(map[string]string) for key, service := range m.Services { services[key] = service } return services } // GetType refers to the type of the node. Peer means that the node is globally accessible // Client means the node is only accessible through another peer func (n *MeshNodeCrdt) GetType() conf.NodeType { return conf.NodeType(n.Type) } // GetNodes: get all the nodes in the network func (m *MeshCrdt) GetNodes() map[string]mesh.MeshNode { nodes := make(map[string]mesh.MeshNode) for _, node := range m.Nodes { nodes[node.HostEndpoint] = &MeshNodeCrdt{ HostEndpoint: node.HostEndpoint, WgEndpoint: node.WgEndpoint, PublicKey: node.PublicKey, WgHost: node.WgHost, Timestamp: node.Timestamp, Routes: node.Routes, Description: node.Description, Alias: node.Alias, Services: node.GetServices(), Type: node.Type, } } return nodes } // GetDestination: get destination of the route func (r *Route) GetDestination() *net.IPNet { _, ipnet, _ := net.ParseCIDR(r.Destination) return ipnet } // GetHopCount: get the number of hops to the destination func (r *Route) GetHopCount() int { return len(r.Path) } // GetPath: get the total path which includes the number of hops func (r *Route) GetPath() []string { return r.Path }