Merge pull request 'zones: fix PruneWireguardConfig recursion' (#1)

Reviewed-on: #1

pkg/wireguard/config.go

@@ -23,12 +23,16 @@ var configTemplate = template.Must(template.New("config").Funcs(template.FuncMap
 		return strings.Join(s, sep)
 	},
 }).Parse(`[Interface]
+{{if .Interface.Name}}# Name: {{.Interface.Name}}
+{{end -}}
 Address = {{.Interface.Address}}
 PrivateKey = {{.Interface.PrivateKey}}
 ListenPort = {{.Interface.ListenPort}}
 {{- range .Peer }}
 
 [Peer]
+{{if .Name}}# Name: {{.Name}}
+{{end -}}
 PublicKey = {{.PublicKey}}
 Endpoint = {{.Endpoint}}
 AllowedIPs = {{ PrefixJoin .AllowedIPs ", "}}
@@ -64,6 +68,7 @@ func (f *Config) WriteTo(w io.Writer) (int64, error) {
 
 // InterfaceConfig represents the [Interface] section
 type InterfaceConfig struct {
+	Name       string
 	Address    netip.Addr
 	PrivateKey PrivateKey
 	ListenPort uint16
@@ -71,6 +76,7 @@ type InterfaceConfig struct {
 
 // PeerConfig represents a [Peer] section
 type PeerConfig struct {
+	Name       string
 	PublicKey  PublicKey
 	Endpoint   EndpointAddress
 	AllowedIPs []netip.Prefix

pkg/wireguard/keys.go

@@ -51,12 +51,12 @@ func (pub PublicKey) String() string {
 	}
 }
 
-// MarshalJSON encodes the key for JSON, omiting empty.
+// MarshalJSON encodes the key for JSON, omitting empty.
 func (key PrivateKey) MarshalJSON() ([]byte, error) {
 	return encodeKeyJSON(key.String())
 }
 
-// MarshalJSON encodes the key for JSON, omiting empty.
+// MarshalJSON encodes the key for JSON, omitting empty.
 func (pub PublicKey) MarshalJSON() ([]byte, error) {
 	return encodeKeyJSON(pub.String())
 }
@@ -70,12 +70,12 @@ func encodeKeyJSON(s string) ([]byte, error) {
 	return out, nil
 }
 
-// MarshalYAML encodes the key for YAML, omiting empty.
+// MarshalYAML encodes the key for YAML, omitting empty.
 func (key PrivateKey) MarshalYAML() (any, error) {
 	return encodeKeyYAML(key.String())
 }
 
-// MarshalYAML encodes the key for YAML, omiting empty.
+// MarshalYAML encodes the key for YAML, omitting empty.
 func (pub PublicKey) MarshalYAML() (any, error) {
 	return encodeKeyYAML(pub.String())
 }

pkg/zones/machine_rings.go

@@ -3,7 +3,6 @@ package zones
 import (
 	"bytes"
 	"fmt"
-	"io/fs"
 	"os"
 
 	"darvaza.org/core"
@@ -73,38 +72,6 @@ func (m *Machine) tryReadWireguardKeys(ring int) error {
 	}
 }
 
-// WriteWireguardKeys writes the wgN.key/wgN.pub files
-func (m *Machine) WriteWireguardKeys(ring int) error {
-	var err error
-	var key, pub string
-	var ri *RingInfo
-
-	ri, _ = m.getRingInfo(ring)
-	if ri != nil {
-		key = ri.Keys.PrivateKey.String()
-		pub = ri.Keys.PublicKey.String()
-	}
-
-	switch {
-	case key == "":
-		return fs.ErrNotExist
-	case pub == "":
-		pub = ri.Keys.PrivateKey.Public().String()
-	}
-
-	err = m.WriteStringFile(key+"\n", "wg%v.key", ring)
-	if err != nil {
-		return err
-	}
-
-	err = m.WriteStringFile(pub+"\n", "wg%v.pub", ring)
-	if err != nil {
-		return err
-	}
-
-	return nil
-}
-
 // RemoveWireguardKeys deletes wgN.key and wgN.pub from
 // the machine's config directory
 func (m *Machine) RemoveWireguardKeys(ring int) error {
@@ -262,38 +229,6 @@ 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.zones, 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 {

pkg/zones/rings.go

@@ -210,6 +210,7 @@ func (r *Ring) AddPeer(p *Machine) bool {
 		Address:    addr,
 		PrivateKey: ri.Keys.PrivateKey,
 		PeerConfig: wireguard.PeerConfig{
+			Name:      fmt.Sprintf("%s-%v", p.Name, r.ID),
 			PublicKey: ri.Keys.PublicKey,
 			Endpoint: wireguard.EndpointAddress{
 				Host: p.FullName(),
@@ -300,6 +301,7 @@ func (r *Ring) ExportConfig(p *Machine) (*wireguard.Config, error) {
 		case pp.Node == p:
 			// current
 			found = true
+			out.Interface.Name = pp.PeerConfig.Name
 			out.Interface.Address = pp.Address
 			out.Interface.PrivateKey = pp.PrivateKey
 		default:

pkg/zones/wireguard.go

@@ -0,0 +1,272 @@
+package zones
+
+import (
+	"io/fs"
+	"os"
+)
+
+var (
+	_ WireguardConfigPruner = (*Zones)(nil)
+	_ WireguardConfigPruner = (*Zone)(nil)
+	_ WireguardConfigPruner = (*Machine)(nil)
+
+	_ WireguardConfigWriter = (*Zones)(nil)
+	_ WireguardConfigWriter = (*Zone)(nil)
+	_ WireguardConfigWriter = (*Machine)(nil)
+
+	_ WireguardConfigSyncer = (*Zones)(nil)
+	_ WireguardConfigSyncer = (*Zone)(nil)
+	_ WireguardConfigSyncer = (*Machine)(nil)
+
+	_ WireguardKeysWriter = (*Zones)(nil)
+	_ WireguardKeysWriter = (*Zone)(nil)
+	_ WireguardKeysWriter = (*Machine)(nil)
+)
+
+// A WireguardConfigPruner deletes wgN.conf on all machines under
+// its scope with the specified ring disabled
+type WireguardConfigPruner interface {
+	PruneWireguardConfig(ring int) error
+}
+
+// PruneWireguardConfig removes wgN.conf files of machines with
+// the corresponding ring disabled on all zones
+func (m *Zones) PruneWireguardConfig(ring int) error {
+	return pruneWireguardConfig(m, ring)
+}
+
+// PruneWireguardConfig removes wgN.conf files of machines with
+// the corresponding ring disabled.
+func (z *Zone) PruneWireguardConfig(ring int) error {
+	return pruneWireguardConfig(z, ring)
+}
+
+func pruneWireguardConfig(m MachineIterator, ring int) error {
+	var err error
+
+	m.ForEachMachine(func(p *Machine) bool {
+		err = p.PruneWireguardConfig(ring)
+		if os.IsNotExist(err) {
+			// ignore
+			err = nil
+		}
+
+		return err != nil
+	})
+
+	return err
+}
+
+// PruneWireguardConfig deletes the wgN.conf file if its
+// presence on the ring is disabled
+func (m *Machine) PruneWireguardConfig(ring int) error {
+	_, ok := m.getRingInfo(ring)
+	if !ok {
+		return m.RemoveWireguardConfig(ring)
+	}
+
+	return nil
+}
+
+// A WireguardConfigWriter rewrites all wgN.conf on all machines under
+// its scope attached to that ring
+type WireguardConfigWriter interface {
+	WriteWireguardConfig(ring int) error
+}
+
+// WriteWireguardConfig rewrites all wgN.conf on all machines
+// attached to that ring
+func (m *Zones) WriteWireguardConfig(ring int) error {
+	switch ring {
+	case 0:
+		return writeWireguardConfig(m, m, ring)
+	case 1:
+		var err error
+		m.ForEachZone(func(z *Zone) bool {
+			err = writeWireguardConfig(m, z, ring)
+			return err != nil
+		})
+		return err
+	default:
+		return fs.ErrInvalid
+	}
+}
+
+// WriteWireguardConfig rewrites all wgN.conf on all machines
+// on the Zone attached to that ring
+func (z *Zone) WriteWireguardConfig(ring int) error {
+	switch ring {
+	case 0:
+		return writeWireguardConfig(z.zones, z.zones, ring)
+	case 1:
+		return writeWireguardConfig(z.zones, z, ring)
+	default:
+		return fs.ErrInvalid
+	}
+}
+
+func writeWireguardConfig(z ZoneIterator, m MachineIterator, ring int) error {
+	r, err := NewRing(z, m, ring)
+	if err != nil {
+		return err
+	}
+
+	r.ForEachMachine(func(p *Machine) bool {
+		err = p.writeWireguardRingConfig(r)
+		return err != nil
+	})
+
+	return err
+}
+
+// WriteWireguardConfig rewrites the wgN.conf file of this Machine
+// if enabled
+func (m *Machine) WriteWireguardConfig(ring int) error {
+	r, err := NewRing(m.zone.zones, 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
+}
+
+// A WireguardConfigSyncer updates all wgN.conf on all machines under
+// its scope reflecting the state of the ring
+type WireguardConfigSyncer interface {
+	SyncWireguardConfig(ring int) error
+}
+
+// SyncWireguardConfig updates all wgN.conf files for the specified
+// ring
+func (m *Zones) SyncWireguardConfig(ring int) error {
+	switch ring {
+	case 0:
+		return syncWireguardConfig(m, m, ring)
+	case 1:
+		var err error
+		m.ForEachZone(func(z *Zone) bool {
+			err = syncWireguardConfig(m, z, ring)
+			return err != nil
+		})
+		return err
+	default:
+		return fs.ErrInvalid
+	}
+}
+
+// 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, z.zones, ring)
+	case 1:
+		return syncWireguardConfig(z.zones, z, ring)
+	default:
+		return fs.ErrInvalid
+	}
+}
+
+func syncWireguardConfig(z ZoneIterator, m MachineIterator, ring int) error {
+	r, err := NewRing(z, m, ring)
+	if err != nil {
+		return err
+	}
+
+	r.ForEachMachine(func(p *Machine) bool {
+		if _, ok := p.getRingInfo(ring); ok {
+			err = p.writeWireguardRingConfig(r)
+		} else {
+			err = p.RemoveWireguardConfig(ring)
+		}
+		return err != nil
+	})
+
+	return err
+}
+
+// SyncWireguardConfig updates all wgN.conf files for the specified
+// ring
+func (m *Machine) SyncWireguardConfig(ring int) error {
+	return m.zone.SyncWireguardConfig(ring)
+}
+
+// A WireguardKeysWriter writes the Wireguard Keys for all machines
+// under its scope for the specified ring
+type WireguardKeysWriter interface {
+	WriteWireguardKeys(ring int) error
+}
+
+// WriteWireguardKeys rewrites all wgN.{key,pub} files
+func (m *Zones) WriteWireguardKeys(ring int) error {
+	return writeWireguardKeys(m, ring)
+}
+
+// WriteWireguardKeys rewrites all wgN.{key,pub} files on this zone
+func (z *Zone) WriteWireguardKeys(ring int) error {
+	return writeWireguardKeys(z, ring)
+}
+
+func writeWireguardKeys(m MachineIterator, ring int) error {
+	var err error
+
+	m.ForEachMachine(func(p *Machine) bool {
+		err = p.WriteWireguardKeys(ring)
+		if os.IsNotExist(err) {
+			// ignore
+			err = nil
+		}
+
+		return err != nil
+	})
+
+	return err
+}
+
+// WriteWireguardKeys writes the wgN.key/wgN.pub files
+func (m *Machine) WriteWireguardKeys(ring int) error {
+	var err error
+	var key, pub string
+	var ri *RingInfo
+
+	ri, _ = m.getRingInfo(ring)
+	if ri != nil {
+		key = ri.Keys.PrivateKey.String()
+		pub = ri.Keys.PublicKey.String()
+	}
+
+	switch {
+	case key == "":
+		return fs.ErrNotExist
+	case pub == "":
+		pub = ri.Keys.PrivateKey.Public().String()
+	}
+
+	err = m.WriteStringFile(key+"\n", "wg%v.key", ring)
+	if err != nil {
+		return err
+	}
+
+	err = m.WriteStringFile(pub+"\n", "wg%v.pub", ring)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

pkg/zones/zone_rings.go

@@ -1,121 +0,0 @@
-package zones
-
-import (
-	"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, z.zones, ring)
-	case 1:
-		return syncWireguardConfig(z.zones, z, ring)
-	default:
-		return fs.ErrInvalid
-	}
-}
-
-// PruneWireguardConfig removes wgN.conf files of machines with
-// the corresponding ring disabled.
-func (z *Zone) PruneWireguardConfig(ring int) error {
-	return pruneWireguardConfig(z, ring)
-}
-
-// WriteWireguardKeys rewrites all wgN.{key,pub} files on this zone
-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, m, ring)
-	case 1:
-		var err error
-		m.ForEachZone(func(z *Zone) bool {
-			err = syncWireguardConfig(m, 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 {
-	return pruneWireguardConfig(m, ring)
-}
-
-// WriteWireguardKeys rewrites all wgN.{key,pub} files
-func (m *Zones) WriteWireguardKeys(ring int) error {
-	return writeWireguardKeys(m, ring)
-}
-
-func syncWireguardConfig(z ZoneIterator, m machineRinger, ring int) error {
-	err := m.PruneWireguardConfig(ring)
-	if err != nil {
-		return err
-	}
-
-	r, err := NewRing(z, 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
-
-	m.ForEachMachine(func(p *Machine) bool {
-		_, ok := p.getRingInfo(ring)
-		if !ok {
-			err = p.RemoveWireguardConfig(ring)
-		}
-		return err != nil
-	})
-
-	return err
-}
-
-func writeWireguardKeys(m MachineIterator, ring int) error {
-	var err error
-
-	m.ForEachMachine(func(p *Machine) bool {
-		err = p.WriteWireguardKeys(ring)
-		if os.IsNotExist(err) {
-			// ignore
-			err = nil
-		}
-
-		return err != nil
-	})
-
-	return err
-}