zones: introduce Wireguard Ring Config factory

Signed-off-by: Alejandro Mery <amery@jpi.io>

pkg/zones/env.go

@@ -32,14 +32,11 @@ func (m *Zones) writeEnvZone(w io.Writer, z *Zone) {
 
 	// ZONE{zoneID}_GW
 	gatewayID := getRingZeroGatewayID(z)
-	if gatewayID > 0 {
+	m.writeEnvVar(w, fmt.Sprintf("%v", gatewayID), "ZONE%v_%s", zoneID, "GW")
-		m.writeEnvVar(w, fmt.Sprintf("%v", gatewayID), "ZONE%v_%s", zoneID, "GW")
 
-		// ZONE{zoneID}_IP
+	// ZONE{zoneID}_IP
-		if ip, ok := RingZeroAddress(zoneID, gatewayID); ok {
+	ip, _ := RingZeroAddress(zoneID, gatewayID)
-			m.writeEnvVar(w, ip.String(), "ZONE%v_%s", zoneID, "IP")
+	m.writeEnvVar(w, ip.String(), "ZONE%v_%s", zoneID, "IP")
-		}
-	}
 }
 
 func (m *Zones) writeEnvVarFn(w io.Writer, fn func(*Zones) string, name string, args ...any) {
@@ -82,9 +79,13 @@ func genEnvZoneNodes(z *Zone) string {
 }
 
 func getRingZeroGatewayID(z *Zone) int {
-	var gatewayID int
+	var firstNodeID, gatewayID int
 
 	z.ForEachMachine(func(p *Machine) bool {
+		if firstNodeID == 0 {
+			firstNodeID = p.ID
+		}
+
 		if p.IsGateway() {
 			gatewayID = p.ID
 		}
@@ -92,5 +93,10 @@ func getRingZeroGatewayID(z *Zone) int {
 		return gatewayID != 0
 	})
 
-	return gatewayID
+	switch {
+	case gatewayID == 0:
+		return firstNodeID
+	default:
+		return gatewayID
+	}
 }

pkg/zones/machine.go

@@ -43,24 +43,6 @@ func (m *Machine) IsGateway() bool {
 	return ok
 }
 
-// SetGateway enables/disables a Machine ring0 integration
-func (m *Machine) SetGateway(enabled bool) error {
-	ri, found := m.getRingInfo(0)
-	switch {
-	case !found && !enabled:
-		return nil
-	case !found:
-		var err error
-
-		if ri, err = m.createRingInfo(0, false); err != nil {
-			return err
-		}
-	}
-
-	ri.Enabled = enabled
-	return m.SyncWireguardConfig(0)
-}
-
 // Zone indicates the [Zone] this machine belongs to
 func (m *Machine) Zone() int {
 	return m.zone.ID

pkg/zones/machine_rings.go

@@ -261,55 +261,3 @@ func (m *Machine) RemoveWireguardConfig(ring int) error {
 
 	return err
 }
-
-// SyncWireguardConfig updates all wgN.conf files for the specified
-// ring
-func (m *Machine) SyncWireguardConfig(ring int) error {
-	return m.zone.SyncWireguardConfig(ring)
-}
-
-// WriteWireguardConfig ...
-func (m *Machine) WriteWireguardConfig(ring int) error {
-	r, err := NewRing(m.zone, ring)
-	if err != nil {
-		return err
-	}
-
-	return m.writeWireguardRingConfig(r)
-}
-
-func (m *Machine) writeWireguardRingConfig(r *Ring) error {
-	wg, err := r.ExportConfig(m)
-	if err != nil {
-		return nil
-	}
-
-	f, err := m.CreateTruncFile("wg%v.conf", r.ID)
-	if err != nil {
-		return err
-	}
-	defer f.Close()
-
-	_, err = wg.WriteTo(f)
-	return err
-}
-
-func (m *Machine) createRingInfo(ring int, enabled bool) (*RingInfo, error) {
-	keys, err := wireguard.NewKeyPair()
-	if err != nil {
-		return nil, err
-	}
-
-	ri := &RingInfo{
-		Ring:    ring,
-		Enabled: enabled,
-		Keys:    keys,
-	}
-
-	err = m.applyRingInfo(ring, ri)
-	if err != nil {
-		return nil, err
-	}
-
-	return ri, nil
-}

pkg/zones/rings.go

@@ -183,32 +183,26 @@ func RingOneAddress(zoneID, nodeID int) (netip.Addr, bool) {
 
 var (
 	_ MachineIterator = (*Ring)(nil)
+	_ ZoneIterator    = (*Ring)(nil)
 )
 
 // A Ring describes all peers on a ring
 type Ring struct {
 	RingAddressEncoder
+	ZoneIterator
 
 	Peers []*RingPeer
 }
 
 // AddPeer adds a [Machine] to the ring
 func (r *Ring) AddPeer(p *Machine) bool {
-	_, ok := p.getRingInfo(r.ID)
+	ri, ok := p.getRingInfo(r.ID)
 	if !ok {
 		return false
 	}
 
-	rp := r.newPeer(p)
-	r.Peers = append(r.Peers, rp)
-	return true
-}
-
-func (r *Ring) newPeer(p *Machine) *RingPeer {
 	nodeID := p.ID
 	zoneID := p.Zone()
-
-	ri, _ := p.getRingInfo(r.ID)
 	addr, _ := r.Encode(zoneID, nodeID)
 
 	rp := &RingPeer{
@@ -224,20 +218,61 @@ func (r *Ring) newPeer(p *Machine) *RingPeer {
 		},
 	}
 
-	if r.ID == 0 {
+	switch {
-		rp.AllowRingOneNetwork(zoneID)
+	case r.ID == 0:
-		rp.AllowIP(addr)
+		r.setRingZeroAllowedIPs(rp)
-	} else {
+	case p.IsGateway():
-		rp.AllowIP(addr)
+		r.setRingOneGatewayAllowedIPs(rp)
-
+	default:
-		if p.IsGateway() {
+		r.setRingOneNodeAllowedIPs(rp)
-			zones := p.zone.zones
-			rp.AllowOtherRingOneNetworks(zones, zoneID)
-			rp.AllowRingZeroGateways(zones)
-		}
 	}
 
-	return rp
+	r.Peers = append(r.Peers, rp)
+	return true
+}
+
+func (r *Ring) setRingZeroAllowedIPs(rp *RingPeer) {
+	zoneID, _, _ := r.Decode(rp.Address)
+
+	// everyone on ring0 is a gateway to ring1
+	addr, _ := RingOneAddress(zoneID, 0)
+	rp.AllowCIDR(addr, 12)
+
+	// peer
+	rp.AllowCIDR(rp.Address, 32)
+}
+
+func (r *Ring) setRingOneGatewayAllowedIPs(rp *RingPeer) {
+	zoneID, _, _ := r.Decode(rp.Address)
+
+	// peer
+	rp.AllowCIDR(rp.Address, 32)
+
+	// ring1 gateways connect to all other ring1 networks
+	r.ForEachZone(func(z *Zone) bool {
+		if z.ID != zoneID {
+			addr, _ := r.Encode(z.ID, 0)
+			rp.AllowCIDR(addr, 12)
+		}
+		return false
+	})
+
+	// ring1 gateways also connect to all ring0 addresses
+	r.ForEachZone(func(z *Zone) bool {
+		z.ForEachMachine(func(p *Machine) bool {
+			if p.IsGateway() {
+				addr, _ := RingZeroAddress(z.ID, p.ID)
+				rp.AllowCIDR(addr, 32)
+			}
+			return false
+		})
+		return false
+	})
+}
+
+func (*Ring) setRingOneNodeAllowedIPs(rp *RingPeer) {
+	// only to the peer itself
+	rp.AllowCIDR(rp.Address, 32)
 }
 
 // ForEachMachine calls a function for each Machine in the ring
@@ -250,38 +285,35 @@ func (r *Ring) ForEachMachine(fn func(*Machine) bool) {
 	}
 }
 
-// ExportConfig ...
+// ExportConfig builds a wgN.conf for the specified machine on the ring
 func (r *Ring) ExportConfig(p *Machine) (*wireguard.Config, error) {
-	cur, ok := r.getMachine(p)
+	var found bool
-	if !ok {
-		return nil, fs.ErrNotExist
-	}
 
 	out := &wireguard.Config{
 		Interface: wireguard.InterfaceConfig{
-			Address:    cur.Address,
-			PrivateKey: cur.PrivateKey,
 			ListenPort: r.Port,
 		},
 	}
 
 	for _, pp := range r.Peers {
-		if pp.Node != p {
+		switch {
+		case pp.Node == p:
+			// current
+			found = true
+			out.Interface.Address = pp.Address
+			out.Interface.PrivateKey = pp.PrivateKey
+		default:
+			// peer
 			pc := pp.PeerConfig
 			out.Peer = append(out.Peer, pc)
 		}
 	}
-	return out, nil
-}
 
-func (r *Ring) getMachine(p *Machine) (*RingPeer, bool) {
+	if !found {
-	for _, pp := range r.Peers {
+		return nil, fs.ErrNotExist
-		if pp.Node == p {
-			return pp, true
-		}
 	}
 
-	return nil, false
+	return out, nil
 }
 
 // A RingPeer is a node on a [Ring]
@@ -293,55 +325,17 @@ type RingPeer struct {
 	PeerConfig wireguard.PeerConfig
 }
 
-// AllowIP ...
+// AllowCIDR allows an IP range via this peer
-func (rp *RingPeer) AllowIP(addr netip.Addr) {
+func (rp *RingPeer) AllowCIDR(addr netip.Addr, bits int) {
-	rp.PeerConfig.AllowedIPs = append(rp.PeerConfig.AllowedIPs,
+	cidr := netip.PrefixFrom(addr, bits)
-		netip.PrefixFrom(addr, 32),
+	rp.PeerConfig.AllowedIPs = append(rp.PeerConfig.AllowedIPs, cidr)
-	)
 }
 
-// AllowNetwork ...
+// NewRing composes a new Ring for Wireguard setup
-func (rp *RingPeer) AllowNetwork(addr netip.Addr, bits int) {
+func NewRing(z ZoneIterator, m MachineIterator, ring int) (*Ring, error) {
-	rp.PeerConfig.AllowedIPs = append(rp.PeerConfig.AllowedIPs,
-		netip.PrefixFrom(addr, bits),
-	)
-}
-
-// AllowRingOneNetwork ...
-func (rp *RingPeer) AllowRingOneNetwork(zoneID int) {
-	addr, _ := RingOneAddress(zoneID, 0)
-	rp.AllowNetwork(addr, 12)
-}
-
-// AllowOtherRingOneNetworks ...
-func (rp *RingPeer) AllowOtherRingOneNetworks(m *Zones, zoneID int) {
-	m.ForEachZone(func(z *Zone) bool {
-		if z.ID != zoneID {
-			addr, _ := RingOneAddress(z.ID, 0)
-			rp.AllowNetwork(addr, 12)
-		}
-		return false
-	})
-}
-
-// AllowRingZeroGateways ...
-func (rp *RingPeer) AllowRingZeroGateways(m *Zones) {
-	m.ForEachMachine(func(p *Machine) bool {
-		switch {
-		case !p.IsGateway():
-			// skip regular nodes
-		default:
-			addr, _ := RingZeroAddress(p.Zone(), p.ID)
-			rp.AllowIP(addr)
-		}
-		return false
-	})
-}
-
-// NewRing ...
-func NewRing(m MachineIterator, ring int) (*Ring, error) {
 	r := &Ring{
 		RingAddressEncoder: Rings[ring],
+		ZoneIterator:       z,
 	}
 
 	m.ForEachMachine(func(p *Machine) bool {

pkg/zones/scan.go

@@ -11,7 +11,6 @@ func (m *Zones) scan() error {
 		m.scanMachines,
 		m.scanZoneIDs,
 		m.scanSort,
-		m.scanGateways,
 	} {
 		if err := fn(); err != nil {
 			return err
@@ -116,16 +115,6 @@ func (m *Zones) scanSort() error {
 	return nil
 }
 
-func (m *Zones) scanGateways() error {
-	var err error
-
-	m.ForEachZone(func(z *Zone) bool {
-		_, _, err = z.GetGateway()
-		return err != nil
-	})
-	return err
-}
-
 func (z *Zone) scan() error {
 	// each directory is a machine
 	entries, err := fs.ReadDir(z.zones.dir, z.Name)
@@ -150,41 +139,3 @@ func (z *Zone) scan() error {
 
 	return nil
 }
-
-// GetGateway returns the first gateway found, if none
-// files will be created to enable the first [Machine] to
-// be one
-func (z *Zone) GetGateway() (*Machine, bool, error) {
-	var first *Machine
-	var gateway *Machine
-
-	z.zones.ForEachMachine(func(p *Machine) bool {
-		switch {
-		case p.IsGateway():
-			// found
-			gateway = p
-		case first == nil:
-			// remember
-			first = p
-		default:
-			// keep looking
-		}
-
-		return gateway != nil
-	})
-
-	switch {
-	case gateway != nil:
-		// found one
-		return gateway, false, nil
-	case first != nil:
-		// make one
-		if err := first.SetGateway(true); err != nil {
-			return first, false, err
-		}
-		return first, true, nil
-	default:
-		// Zone without nodes?
-		panic("unreachable")
-	}
-}

pkg/zones/sync.go

@@ -18,12 +18,12 @@ func (m *Zones) SyncAllWireguard() error {
 	var err error
 
 	for ring := 0; ring < RingsCount; ring++ {
-		err = m.WriteWireguardKeys(ring)
+		err = m.PruneWireguardConfig(ring)
 		if err != nil {
 			return err
 		}
 
-		err = m.SyncWireguardConfig(ring)
+		err = m.WriteWireguardKeys(ring)
 		if err != nil {
 			return err
 		}

pkg/zones/zone_rings.go

@@ -1,33 +1,6 @@
 package zones
 
-import (
+import "os"
-	"io/fs"
-	"os"
-)
-
-var (
-	_ machineRinger = (*Zone)(nil)
-	_ machineRinger = (*Zones)(nil)
-)
-
-type machineRinger interface {
-	MachineIterator
-
-	PruneWireguardConfig(ring int) error
-}
-
-// SyncWireguardConfig updates all wgN.conf files for the specified
-// ring
-func (z *Zone) SyncWireguardConfig(ring int) error {
-	switch ring {
-	case 0:
-		return syncWireguardConfig(z.zones, ring)
-	case 1:
-		return syncWireguardConfig(z, ring)
-	default:
-		return fs.ErrInvalid
-	}
-}
 
 // PruneWireguardConfig removes wgN.conf files of machines with
 // the corresponding ring disabled.
@@ -40,24 +13,6 @@ func (z *Zone) WriteWireguardKeys(ring int) error {
 	return writeWireguardKeys(z, ring)
 }
 
-// SyncWireguardConfig updates all wgN.conf files for the specified
-// ring
-func (m *Zones) SyncWireguardConfig(ring int) error {
-	switch ring {
-	case 0:
-		return syncWireguardConfig(m, ring)
-	case 1:
-		var err error
-		m.ForEachZone(func(z *Zone) bool {
-			err = syncWireguardConfig(z, ring)
-			return err != nil
-		})
-		return err
-	default:
-		return fs.ErrInvalid
-	}
-}
-
 // PruneWireguardConfig removes wgN.conf files of machines with
 // the corresponding ring disabled on all zones
 func (m *Zones) PruneWireguardConfig(ring int) error {
@@ -69,27 +24,6 @@ func (m *Zones) WriteWireguardKeys(ring int) error {
 	return writeWireguardKeys(m, ring)
 }
 
-func syncWireguardConfig(m machineRinger, ring int) error {
-	err := m.PruneWireguardConfig(ring)
-	if err != nil {
-		return err
-	}
-
-	r, err := NewRing(m, ring)
-	if err != nil {
-		return err
-	}
-
-	m.ForEachMachine(func(p *Machine) bool {
-		if _, ok := p.getRingInfo(ring); ok {
-			err = p.writeWireguardRingConfig(r)
-		}
-		return err != nil
-	})
-
-	return err
-}
-
 func pruneWireguardConfig(m MachineIterator, ring int) error {
 	var err error
 

pkg/zones/zones.go

@@ -13,6 +13,7 @@ import (
 var (
 	_ MachineIterator = (*Zone)(nil)
 	_ MachineIterator = (*Zones)(nil)
+	_ ZoneIterator    = (*Zones)(nil)
 )
 
 // A MachineIterator is a set of Machines we can iterate on
@@ -20,6 +21,11 @@ type MachineIterator interface {
 	ForEachMachine(func(*Machine) bool)
 }
 
+// A ZoneIterator is a set of Zones we can iterate on
+type ZoneIterator interface {
+	ForEachZone(func(*Zone) bool)
+}
+
 // Zone represents one zone in a cluster
 type Zone struct {
 	zones *Zones
@@ -44,31 +50,6 @@ func (z *Zone) ForEachMachine(fn func(*Machine) bool) {
 	}
 }
 
-// SetGateway configures a machine to be the zone's ring0 gateway
-func (z *Zone) SetGateway(gatewayID int, enabled bool) error {
-	var err error
-	var found bool
-
-	z.ForEachMachine(func(p *Machine) bool {
-		if p.ID == gatewayID {
-			found = true
-			err = p.SetGateway(enabled)
-
-			return true
-		}
-		return false
-	})
-
-	switch {
-	case err != nil:
-		return err
-	case !found:
-		return fs.ErrNotExist
-	default:
-		return nil
-	}
-}
-
 // Zones represents all zones in a cluster
 type Zones struct {
 	dir      fs.FS