wireguard: make PrivateKey and PublicKey two distinct types

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

pkg/wireguard/config.go

@@ -31,13 +31,13 @@ func (f *Config) Peers() int {
 // InterfaceConfig represents the [Interface] section
 type InterfaceConfig struct {
 	Address    netip.Addr
-	PrivateKey BinaryKey
+	PrivateKey PrivateKey
 	ListenPort uint16
 }
 
 // PeerConfig represents a [Peer] section
 type PeerConfig struct {
-	PublicKey  BinaryKey
+	PublicKey  PublicKey
 	Endpoint   EndpointAddress
 	AllowedIPs []netip.Prefix
 }
@@ -135,7 +135,7 @@ func (p interfaceConfig) Export() (InterfaceConfig, error) {
 		ListenPort: p.ListenPort,
 	}
 
-	out.PrivateKey, err = BinaryKeyFromBase64(p.PrivateKey)
+	out.PrivateKey, err = PrivateKeyFromBase64(p.PrivateKey)
 	if err != nil {
 		err = core.Wrap(err, "PrivateKey")
 		return InterfaceConfig{}, err
@@ -162,7 +162,7 @@ func (v *intermediateConfig) ExportPeer(i int) (PeerConfig, error) {
 	}
 
 	// PublicKey
-	out.PublicKey, err = BinaryKeyFromBase64(v.Peer.PublicKey[i])
+	out.PublicKey, err = PublicKeyFromBase64(v.Peer.PublicKey[i])
 	if err != nil {
 		err = core.Wrap(err, "PublicKey")
 		return out, err

pkg/wireguard/keys.go

@@ -3,34 +3,94 @@ package wireguard
 import (
 	"bytes"
 	"encoding/base64"
+	"errors"
 )
 
-// BinaryKey is a binary blob
+const (
-type BinaryKey []byte
+	// PrivateKeySize is the length in bytes of a Wireguard Private Key
+	PrivateKeySize = 32
+	// PublicKeySize is the length in bytes of a Wireguard Public Key
+	PublicKeySize = 32
+)
 
-func (k BinaryKey) String() string {
+var (
-	return base64.StdEncoding.EncodeToString(k)
+	// ErrInvalidKeySize indicates the key size is wrong
+	ErrInvalidKeySize = errors.New("invalid key size")
+)
+
+type (
+	// PrivateKey is a binary Wireguard Private Key
+	PrivateKey []byte
+	// PublicKey is a binary Wireguard Public Key
+	PublicKey []byte
+)
+
+func (key PrivateKey) String() string {
+	return encodeKey(key)
+}
+
+func (pub PublicKey) String() string {
+	return encodeKey(pub)
 }
 
 // IsZero tells if the key hasn't been set
-func (k BinaryKey) IsZero() bool {
+func (key PrivateKey) IsZero() bool {
-	return len(k) == 0
+	return len(key) == 0
 }
 
-// Equal checks if two keys are identical
+// IsZero tells if the key hasn't been set
-func (k BinaryKey) Equal(alter BinaryKey) bool {
+func (pub PublicKey) IsZero() bool {
-	return bytes.Equal(k, alter)
+	return len(pub) == 0
 }
 
-// BinaryKeyFromBase64 decodes a base64-based string into
+// Equal checks if two private keys are identical
-// a [BinaryKey]
+func (key PrivateKey) Equal(alter PrivateKey) bool {
-func BinaryKeyFromBase64(data string) (BinaryKey, error) {
+	return bytes.Equal(key, alter)
+}
+
+// Equal checks if two public keys are identical
+func (pub PublicKey) Equal(alter PublicKey) bool {
+	return bytes.Equal(pub, alter)
+}
+
+// PrivateKeyFromBase64 decodes a base64-based string into
+// a [PrivateKey]
+func PrivateKeyFromBase64(data string) (PrivateKey, error) {
+	b, err := decodeKey(data, PrivateKeySize)
+	return b, err
+}
+
+// PublicKeyFromBase64 decodes a base64-based string into
+// a [PublicKey]
+func PublicKeyFromBase64(data string) (PublicKey, error) {
+	b, err := decodeKey(data, PublicKeySize)
+	return b, err
+}
+
+func encodeKey(b []byte) string {
+	switch {
+	case len(b) == 0:
+		return ""
+	default:
+		return base64.StdEncoding.EncodeToString(b)
+	}
+}
+
+func decodeKey(data string, size int) ([]byte, error) {
 	b, err := base64.StdEncoding.DecodeString(data)
-	return BinaryKey(b), err
+	switch {
+	case err != nil:
+		return []byte{}, err
+	case len(b) != size:
+		err = ErrInvalidKeySize
+		return []byte{}, err
+	default:
+		return b, nil
+	}
 }
 
 // KeyPair holds a Key pair
 type KeyPair struct {
-	PrivateKey BinaryKey
+	PrivateKey PrivateKey
-	PublicKey  BinaryKey
+	PublicKey  PublicKey
 }

pkg/zones/env.go

@@ -88,7 +88,7 @@ func getRingZeroGatewayID(z *Zone) int {
 			firstNodeID = nodeID
 		}
 
-		if p.Gateway() {
+		if _, found := p.getRingInfo(0); found {
 			gatewayID = nodeID
 		}
 

pkg/zones/machine.go

@@ -47,34 +47,6 @@ func (m *Machine) ID() int {
 	return m.id
 }
 
-// Gateway tells if the Machine is a ring0 gateway
-func (m *Machine) Gateway() bool {
-	m.mu.Lock()
-	defer m.mu.Unlock()
-
-	if ri, found := m.getRingInfo(0); found {
-		return ri.Enabled
-	}
-
-	return false
-}
-
-func (m *Machine) SetGateway(enable bool) error {
-	m.mu.Lock()
-	defer m.mu.Unlock()
-
-	ri, found := m.getRingInfo(0)
-	switch {
-	case !found && !enable:
-		return nil
-	case !found:
-		return m.createRingInfo(0, true)
-	default:
-		ri.Enabled = enable
-		return nil
-	}
-}
-
 // FullName returns the Name of the machine including domain name
 func (m *Machine) FullName() string {
 	if domain := m.zone.zones.domain; domain != "" {

pkg/zones/machine_rings.go

@@ -134,18 +134,3 @@ func (m *Machine) applyZoneNodeID(zoneID, nodeID int) error {
 
 	return nil
 }
-
-func (m *Machine) createRingInfo(ring int, enabled bool) error {
-	keys, err := wireguard.NewKeyPair()
-	if err != nil {
-		return err
-	}
-
-	ri := &RingInfo{
-		Ring:    ring,
-		Enabled: enabled,
-		Keys:    keys,
-	}
-
-	return m.applyRingInfo(ring, ri)
-}