Merge pull request 'zones: warn but not fail when scanning finds unknown monitors' (#13)

Reviewed-on: #13

.vscode/settings.json

@@ -1,12 +1,9 @@
 {
     "cSpell.words": [
-        "asciigoat",
         "ceph",
-        "cyclomatic",
         "darvaza",
         "gofrs",
         "jpictl",
-        "Wrapf",
         "zerolog"
     ]
 }

cmd/jpictl/dump.go

@@ -52,8 +52,9 @@ const encoding = YAMLEncoding
 
 // Command
 var dumpCmd = &cobra.Command{
-	Use:   "dump",
-	Short: "generates a text representation of the config",
+	Use:    "dump",
+	Short:  "generates a text representation of the config",
+	PreRun: setVerbosity,
 	RunE: func(_ *cobra.Command, _ []string) error {
 		var buf bytes.Buffer
 		var enc Encoder

cmd/jpictl/env.go

@@ -8,8 +8,9 @@ import (
 
 // Command
 var envCmd = &cobra.Command{
-	Use:   "env",
-	Short: "generates environment variables for shell scripts",
+	Use:    "env",
+	Short:  "generates environment variables for shell scripts",
+	PreRun: setVerbosity,
 	RunE: func(_ *cobra.Command, _ []string) error {
 		m, err := cfg.LoadZones(false)
 		if err != nil {

cmd/jpictl/gateway.go

@@ -19,8 +19,9 @@ var gatewayCmd = &cobra.Command{
 
 // gateway set
 var gatewaySetCmd = &cobra.Command{
-	Use:   "set",
-	Short: "gateway set sets machines as gateways",
+	Use:    "set",
+	Short:  "gateway set sets machines as gateways",
+	PreRun: setVerbosity,
 	RunE: func(_ *cobra.Command, args []string) error {
 		m, err := cfg.LoadZones(false)
 		if err != nil {

cmd/jpictl/log.go

@@ -3,15 +3,9 @@ package main
 import (
 	"fmt"
 
-	"darvaza.org/sidecar/pkg/logger/zerolog"
 	"darvaza.org/slog"
 )
 
-// TODO: make log level configurable via flags
-var (
-	log = zerolog.New(nil, slog.Debug)
-)
-
 // fatal is a convenience wrapper for slog.Logger.Fatal().Print()
 func fatal(err error, msg string, args ...any) {
 	l := log.Fatal()

cmd/jpictl/main.go

@@ -2,6 +2,8 @@
 package main
 
 import (
+	"darvaza.org/sidecar/pkg/logger/zerolog"
+	"darvaza.org/slog"
 	"github.com/spf13/cobra"
 )
 
@@ -10,13 +12,29 @@ const (
 	CmdName = "jpictl"
 )
 
-var rootCmd = &cobra.Command{
-	Use:   CmdName,
-	Short: "control tool for jpi.cloud",
-}
+var (
+	log       = zerolog.New(nil, slog.Error)
+	verbosity int
+	rootCmd   = &cobra.Command{
+		Use:   CmdName,
+		Short: "control tool for jpi.cloud",
+	}
+)
 
 func main() {
 	if err := rootCmd.Execute(); err != nil {
 		fatal(err, "")
 	}
 }
+
+func init() {
+	rootCmd.PersistentFlags().CountVarP(&verbosity, "verbosity", "v", "increase the verbosity level to Warn, Info or Debug")
+}
+
+func setVerbosity(_ *cobra.Command, _ []string) {
+	desired := int8(slog.Error) + int8(verbosity)
+	if desired > 6 {
+		desired = 6
+	}
+	log = log.WithLevel(slog.LogLevel(desired))
+}

cmd/jpictl/write.go

@@ -6,8 +6,9 @@ import (
 
 // Command
 var writeCmd = &cobra.Command{
-	Use:   "write",
-	Short: "rewrites all config files",
+	Use:    "write",
+	Short:  "rewrites all config files",
+	PreRun: setVerbosity,
 	RunE: func(_ *cobra.Command, _ []string) error {
 		m, err := cfg.LoadZones(false)
 		if err != nil {

go.mod

@@ -2,8 +2,6 @@ module git.jpi.io/amery/jpictl
 
 go 1.19
 
-replace asciigoat.org/ini => ../../../asciigoat.org/ini
-
 require (
 	asciigoat.org/ini v0.2.5
 	darvaza.org/core v0.9.8
@@ -17,6 +15,7 @@ require (
 	github.com/mgechev/revive v1.3.3
 	github.com/spf13/cobra v1.7.0
 	golang.org/x/crypto v0.12.0
+	gopkg.in/gcfg.v1 v1.2.3
 	gopkg.in/yaml.v3 v3.0.1
 )
 
@@ -45,4 +44,5 @@ require (
 	golang.org/x/sys v0.12.0 // indirect
 	golang.org/x/text v0.13.0 // indirect
 	golang.org/x/tools v0.12.0 // indirect
+	gopkg.in/warnings.v0 v0.1.2 // indirect
 )

go.sum

@@ -1,5 +1,7 @@
 asciigoat.org/core v0.3.9 h1:hgDDz4ecm3ZvehX++m8A/IzAt+B5oDPiRtxatzfUHPQ=
 asciigoat.org/core v0.3.9/go.mod h1:CAaHwyw8MpAq4a1MYtN2dxJrsK+hmIdW50OndaQZYPI=
+asciigoat.org/ini v0.2.5 h1:4gRIp9rU+XQt8+HMqZO5R7GavMv9Yl2+N+je6djDIAE=
+asciigoat.org/ini v0.2.5/go.mod h1:gmXzJ9XFqf1NLk5nQkj04USQ4tMtdRJHNQX6vp3DzjU=
 darvaza.org/core v0.9.8 h1:luLxgfUc2pzuusYPo/Z/dC/qr9XZPKpSQw8/kS7zNUM=
 darvaza.org/core v0.9.8/go.mod h1:Dbme64naxeshQfxcVJX9ZT7AiGyIY8kldfuELVtf8mw=
 darvaza.org/resolver v0.5.4 h1:dlSBNV14yYsp7Kg7ipwYOMNsLbrpeXa8Z0HBTa0Ryxs=
@@ -98,6 +100,10 @@ golang.org/x/tools v0.12.0 h1:YW6HUoUmYBpwSgyaGaZq1fHjrBjX1rlpZ54T6mu2kss=
 golang.org/x/tools v0.12.0/go.mod h1:Sc0INKfu04TlqNoRA1hgpFZbhYXHPr4V5DzpSBTPqQM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/gcfg.v1 v1.2.3 h1:m8OOJ4ccYHnx2f4gQwpno8nAX5OGOh7RLaaz0pj3Ogs=
+gopkg.in/gcfg.v1 v1.2.3/go.mod h1:yesOnuUOFQAhST5vPY4nbZsb/huCgGGXlipJsBn0b3o=
+gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME=
+gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

pkg/wireguard/config.go

@@ -2,6 +2,7 @@ package wireguard
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"io"
 	"net/netip"
@@ -9,8 +10,8 @@ import (
 	"strings"
 	"text/template"
 
-	"asciigoat.org/ini/basic"
 	"darvaza.org/core"
+	"gopkg.in/gcfg.v1"
 )
 
 var configTemplate = template.Must(template.New("config").Funcs(template.FuncMap{
@@ -106,11 +107,6 @@ func (ep EndpointAddress) String() string {
 	}
 }
 
-// UnmarshalText loads an endpoint address from text data
-func (ep *EndpointAddress) UnmarshalText(b []byte) error {
-	return ep.FromString(string(b))
-}
-
 // FromString sets the EndpointAddress from a given "[host]:port"
 func (ep *EndpointAddress) FromString(s string) error {
 	host, port, err := core.SplitHostPort(s)
@@ -131,6 +127,98 @@ func (ep *EndpointAddress) FromString(s string) error {
 	return nil
 }
 
+type intermediateConfig struct {
+	Interface interfaceConfig
+	Peer      peersConfig
+}
+
+func (v *intermediateConfig) Export() (*Config, error) {
+	var out Config
+	var err error
+
+	// Interface
+	out.Interface, err = v.Interface.Export()
+	if err != nil {
+		return nil, err
+	}
+
+	// Peers
+	peers, ok := v.PeersCount()
+	if !ok {
+		return nil, errors.New("inconsistent Peer data")
+	}
+
+	for i := 0; i < peers; i++ {
+		p, err := v.ExportPeer(i)
+		if err != nil {
+			err = core.Wrapf(err, "Peer[%v]:", i)
+			return nil, err
+		}
+
+		out.Peer = append(out.Peer, p)
+	}
+
+	return &out, nil
+}
+
+type interfaceConfig struct {
+	Address    netip.Addr
+	PrivateKey string
+	ListenPort uint16
+}
+
+func (p interfaceConfig) Export() (InterfaceConfig, error) {
+	var err error
+
+	out := InterfaceConfig{
+		Address:    p.Address,
+		ListenPort: p.ListenPort,
+	}
+
+	out.PrivateKey, err = PrivateKeyFromBase64(p.PrivateKey)
+	if err != nil {
+		err = core.Wrap(err, "PrivateKey")
+		return InterfaceConfig{}, err
+	}
+
+	return out, nil
+}
+
+type peersConfig struct {
+	PublicKey  []string
+	Endpoint   []string
+	AllowedIPs []string
+}
+
+func (v *intermediateConfig) ExportPeer(i int) (PeerConfig, error) {
+	var out PeerConfig
+
+	// Endpoint
+	s := v.Peer.Endpoint[i]
+	err := out.Endpoint.FromString(s)
+	if err != nil {
+		err = core.Wrap(err, "Endpoint")
+		return out, err
+	}
+
+	// PublicKey
+	out.PublicKey, err = PublicKeyFromBase64(v.Peer.PublicKey[i])
+	if err != nil {
+		err = core.Wrap(err, "PublicKey")
+		return out, err
+	}
+
+	// AllowedIPs
+	s = v.Peer.AllowedIPs[i]
+	out.AllowedIPs, err = parseAllowedIPs(s)
+	if err != nil {
+		err = core.Wrap(err, "AllowedIPs")
+		return out, err
+	}
+
+	return out, nil
+}
+
 func parseAllowedIPs(data string) ([]netip.Prefix, error) {
 	var out []netip.Prefix
 
@@ -147,17 +235,25 @@ func parseAllowedIPs(data string) ([]netip.Prefix, error) {
 	return out, nil
 }
 
+func (v *intermediateConfig) PeersCount() (int, bool) {
+	c0 := len(v.Peer.Endpoint)
+	c1 := len(v.Peer.PublicKey)
+	c2 := len(v.Peer.AllowedIPs)
+
+	if c0 != c1 || c1 != c2 {
+		return 0, false
+	}
+
+	return c0, true
+}
+
 // NewConfigFromReader parses a wgN.conf file
 func NewConfigFromReader(r io.Reader) (*Config, error) {
-	doc, err := basic.Decode(r)
-	if err != nil {
+	temp := &intermediateConfig{}
+
+	if err := gcfg.ReadInto(temp, r); err != nil {
 		return nil, err
 	}
 
-	cfg, err := newConfigFromDocument(doc)
-	if err != nil {
-		return nil, err
-	}
-
-	return cfg, nil
+	return temp.Export()
 }

pkg/wireguard/config_parser.go

@@ -1,169 +0,0 @@
-package wireguard
-
-import (
-	"io/fs"
-	"strconv"
-
-	"asciigoat.org/ini/basic"
-	"darvaza.org/core"
-)
-
-type sectionHandler func(*Config, *basic.Section) error
-
-var sectionMap = map[string]func(*Config, *basic.Section) error{
-	"Interface": loadInterfaceConfSection,
-	"Peer":      loadPeerConfSection,
-}
-
-func loadConfSection(out *Config, src *basic.Section) error {
-	h, ok := sectionMap[src.Key]
-	if !ok {
-		return core.Wrapf(fs.ErrInvalid, "unknown section %q", src.Key)
-	}
-
-	return h(out, src)
-}
-
-func loadInterfaceConfSection(out *Config, src *basic.Section) error {
-	var cfg InterfaceConfig
-
-	for _, field := range src.Fields {
-		if err := loadInterfaceConfField(&cfg, field); err != nil {
-			return core.Wrap(err, "Interface")
-		}
-	}
-
-	out.Interface = cfg
-	return nil
-}
-
-func loadPeerConfSection(out *Config, src *basic.Section) error {
-	var cfg PeerConfig
-
-	for _, field := range src.Fields {
-		if err := loadPeerConfField(&cfg, field); err != nil {
-			return core.Wrapf(err, "Peer[%v]", len(out.Peer))
-		}
-	}
-
-	out.Peer = append(out.Peer, cfg)
-	return nil
-}
-
-// revive:disable:cyclomatic
-// revive:disable:cognitive-complexity
-
-func loadInterfaceConfField(cfg *InterfaceConfig, field basic.Field) error {
-	// revive:enable:cyclomatic
-	// revive:enable:cognitive-complexity
-
-	// TODO: refactor when asciigoat's ini parser learns to do reflection
-	switch field.Key {
-	case "Address":
-		if !core.IsZero(cfg.Address) {
-			return core.Wrapf(fs.ErrInvalid, "duplicate field %q", field.Key)
-		}
-
-		err := cfg.Address.UnmarshalText([]byte(field.Value))
-		switch {
-		case err != nil:
-			return core.Wrap(err, field.Key)
-		default:
-			return nil
-		}
-	case "PrivateKey":
-		if !core.IsZero(cfg.PrivateKey) {
-			return core.Wrapf(fs.ErrInvalid, "duplicate field %q", field.Key)
-		}
-
-		err := cfg.PrivateKey.UnmarshalText([]byte(field.Value))
-		switch {
-		case err != nil:
-			return core.Wrap(err, field.Key)
-		default:
-			return nil
-		}
-	case "ListenPort":
-		if cfg.ListenPort > 0 {
-			return core.Wrapf(fs.ErrInvalid, "duplicate field %q", field.Key)
-		}
-
-		u64, err := strconv.ParseUint(field.Value, 10, 16)
-		switch {
-		case err != nil:
-			return core.Wrap(err, field.Key)
-		case u64 == 0:
-			return core.Wrapf(fs.ErrInvalid, "invalid %q value", field.Key)
-		default:
-			cfg.ListenPort = uint16(u64)
-			return nil
-		}
-	default:
-		return core.Wrapf(fs.ErrInvalid, "unknown field %q", field.Key)
-	}
-}
-
-// revive:disable:cyclomatic
-// revive:disable:cognitive-complexity
-
-func loadPeerConfField(cfg *PeerConfig, field basic.Field) error {
-	// revive:enable:cyclomatic
-	// revive:enable:cognitive-complexity
-
-	switch field.Key {
-	case "PublicKey":
-		if !core.IsZero(cfg.PublicKey) {
-			return core.Wrapf(fs.ErrInvalid, "duplicate field %q", field.Key)
-		}
-
-		err := cfg.PublicKey.UnmarshalText([]byte(field.Value))
-		switch {
-		case err != nil:
-			return core.Wrap(err, field.Key)
-		default:
-			return nil
-		}
-	case "Endpoint":
-		if cfg.Endpoint.String() != "" {
-			return core.Wrapf(fs.ErrInvalid, "duplicate field %q", field.Key)
-		}
-
-		err := cfg.Endpoint.UnmarshalText([]byte(field.Value))
-		switch {
-		case err != nil:
-			return core.Wrap(err, field.Key)
-		default:
-			return nil
-		}
-	case "AllowedIPs":
-		s, err := parseAllowedIPs(field.Value)
-		switch {
-		case err != nil:
-			return core.Wrap(err, field.Key)
-		case len(s) > 0:
-			cfg.AllowedIPs = append(cfg.AllowedIPs, s...)
-			return nil
-		}
-	default:
-		return core.Wrapf(fs.ErrInvalid, "unknown field %q", field.Key)
-	}
-	return nil
-}
-
-func newConfigFromDocument(doc *basic.Document) (*Config, error) {
-	var out Config
-
-	if len(doc.Global) > 0 {
-		err := core.Wrap(fs.ErrInvalid, "fields before the first section")
-		return nil, err
-	}
-
-	for i := range doc.Sections {
-		src := &doc.Sections[i]
-		if err := loadConfSection(&out, src); err != nil {
-			return nil, err
-		}
-	}
-
-	return &out, nil
-}

pkg/wireguard/keys.go

@@ -51,30 +51,6 @@ func (pub PublicKey) String() string {
 	}
 }
 
-// UnmarshalText loads the value from base64
-func (key *PrivateKey) UnmarshalText(b []byte) error {
-	v, err := PrivateKeyFromBase64(string(b))
-	switch {
-	case err != nil:
-		return err
-	default:
-		*key = v
-		return nil
-	}
-}
-
-// UnmarshalText loads the value from base64
-func (pub *PublicKey) UnmarshalText(b []byte) error {
-	v, err := PublicKeyFromBase64(string(b))
-	switch {
-	case err != nil:
-		return err
-	default:
-		*pub = v
-		return nil
-	}
-}
-
 // MarshalJSON encodes the key for JSON, omitting empty.
 func (key PrivateKey) MarshalJSON() ([]byte, error) {
 	return encodeKeyJSON(key.String())