Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 20 additions & 38 deletions cmd/client/config.go
Original file line number Diff line number Diff line change
@@ -1,38 +1,32 @@
package main

import (
"context"
"net/url"
"regexp"

validation "github.com/go-ozzo/ozzo-validation/v4"
"github.com/go-ozzo/ozzo-validation/v4/is"
"github.com/nt0xa/sonar/pkg/valid"
)

func init() {
validation.ErrorTag = "mapstructure"
}

type Config struct {
Context Context `mapstructure:"context"`
Servers map[string]Server `mapstructure:"servers"`
}

type serversKey struct{}

func (c Config) ValidateWithContext(ctx context.Context) error {
servers := make([]any, 0)

for s := range c.Servers {
servers = append(servers, s)
func (c Config) Validate() valid.Problems {
servers := make([]string, 0, len(c.Servers))
for name := range c.Servers {
servers = append(servers, name)
}

ctx = context.WithValue(ctx, serversKey{}, servers)
fields := []valid.Validatable{
valid.Slice("servers", servers, valid.NotEmpty),
valid.String("context.server", c.Context.Server, valid.Required, valid.In(servers...)),
}
for name, srv := range c.Servers {
fields = append(fields, valid.Struct("servers."+name, srv))
}

return validation.ValidateStructWithContext(ctx, &c,
validation.Field(&c.Context),
validation.Field(&c.Servers, validation.Length(1, 0)),
)
return valid.Validate(fields...)
}

func (c *Config) Server() *Server {
Expand All @@ -47,32 +41,20 @@ type Context struct {
Server string `mapstructure:"server"`
}

func (c Context) ValidateWithContext(ctx context.Context) error {
servers, ok := ctx.Value(serversKey{}).([]any)
if !ok {
panic(`fail to find "servers" key in context`)
}

return validation.ValidateStructWithContext(ctx, &c,
validation.Field(&c.Server, validation.Required, validation.In(servers...)),
)
}

type Server struct {
Token string `mapstructure:"token"`
URL string `mapstructure:"url"`
Proxy *string `mapstructure:"proxy"`
Insecure bool `mapstructure:"insecure"`
}

func (c Server) ValidateWithContext(ctx context.Context) error {
return validation.ValidateStructWithContext(ctx, &c,
validation.Field(&c.Token,
validation.Required,
validation.Match(regexp.MustCompile("[a-f0-9]{32}")),
),
validation.Field(&c.URL, validation.Required, is.URL),
validation.Field(&c.Proxy, is.URL),
var tokenRe = regexp.MustCompile("[a-f0-9]{32}")

func (c Server) Validate() valid.Problems {
return valid.Validate(
valid.String("token", c.Token, valid.Required, valid.Match(tokenRe, "invalid token")),
valid.String("url", c.URL, valid.Required, valid.URL),
valid.OptionalString("proxy", c.Proxy, valid.URL),
)
}

Expand Down
9 changes: 2 additions & 7 deletions cmd/client/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import (
"strings"

"github.com/adrg/xdg"
validation "github.com/go-ozzo/ozzo-validation/v4"
"github.com/gookit/color"
"github.com/spf13/cobra"
"github.com/spf13/viper"
Expand All @@ -33,10 +32,6 @@ type lazyService struct {
service.Service
}

func init() {
validation.ErrorTag = "err"
}

func main() {
var (
cfg Config
Expand Down Expand Up @@ -175,8 +170,8 @@ func initConfig(cfgFile string, cfg *Config) error {
return err
}

if err := cfg.ValidateWithContext(context.Background()); err != nil {
return err
if p := cfg.Validate(); !p.Ok() {
return fmt.Errorf("config validation failed: %w", p)
}

return nil
Expand Down
2 changes: 0 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ require (
github.com/fsnotify/fsnotify v1.9.0
github.com/go-acme/lego/v3 v3.9.0
github.com/go-chi/chi/v5 v5.2.2
github.com/go-ozzo/ozzo-validation/v4 v4.3.0
github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1
github.com/go-testfixtures/testfixtures/v3 v3.9.0
github.com/golang-migrate/migrate/v4 v4.18.3
Expand Down Expand Up @@ -58,7 +57,6 @@ require (
github.com/Masterminds/goutils v1.1.1 // indirect
github.com/Masterminds/semver/v3 v3.4.0 // indirect
github.com/andybalholm/brotli v1.0.5 // indirect
github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 // indirect
github.com/cenkalti/backoff/v4 v4.3.0 // indirect
github.com/cenkalti/backoff/v5 v5.0.3 // indirect
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
Expand Down
5 changes: 0 additions & 5 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,6 @@ github.com/aliyun/alibaba-cloud-sdk-go v1.61.112/go.mod h1:pUKYbK5JQ+1Dfxk80P0qx
github.com/andybalholm/brotli v1.0.5 h1:8uQZIdzKmjc/iuPu7O2ioW48L81FgatrcpfFmiq/cCs=
github.com/andybalholm/brotli v1.0.5/go.mod h1:fO7iG3H7G2nSZ7m0zPUDn85XEX2GTukHGRSepvi9Eig=
github.com/apache/thrift v0.12.0/go.mod h1:cp2SuWMxlEZw2r+iP2GNCdIi4C1qmUzdZFSVb+bacwQ=
github.com/asaskevich/govalidator v0.0.0-20200108200545-475eaeb16496/go.mod h1:oGkLhpf+kjZl6xBf758TQhh5XrAeiJv/7FRz/2spLIg=
github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 h1:DklsrG3dyBCFEj5IhUbnKptjxatkF07cF2ak3yi77so=
github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw=
github.com/aws/aws-sdk-go v1.30.20/go.mod h1:5zCpMtNQVjRREroY7sYe8lOMRSxkhG6MZveU8YkpAk0=
github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=
github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
Expand Down Expand Up @@ -146,8 +143,6 @@ github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=
github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
github.com/go-ozzo/ozzo-validation/v4 v4.3.0 h1:byhDUpfEwjsVQb1vBunvIjh2BHQ9ead57VkAEY4V+Es=
github.com/go-ozzo/ozzo-validation/v4 v4.3.0/go.mod h1:2NKgrcHl3z6cJs+3Oo940FPRiTzuqKbvfrL2RxCj6Ew=
github.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg=
github.com/go-sql-driver/mysql v1.8.1 h1:LedoTUt/eveggdHS9qUFC1EFSa8bU2+1pZjSRpvNJ1Y=
github.com/go-sql-driver/mysql v1.8.1/go.mod h1:wEBSXgmK//2ZFJyE+qWnIsVGmvmEKlqwuVSjsCm7DZg=
Expand Down
92 changes: 37 additions & 55 deletions internal/cmd/server/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,13 @@ import (
"os"
"strings"

validation "github.com/go-ozzo/ozzo-validation/v4"
"github.com/go-ozzo/ozzo-validation/v4/is"
"github.com/knadh/koanf/parsers/toml"
"github.com/knadh/koanf/providers/confmap"
"github.com/knadh/koanf/providers/env/v2"
fsprov "github.com/knadh/koanf/providers/fs"
"github.com/knadh/koanf/v2"
"github.com/nt0xa/sonar/internal/utils"
"github.com/nt0xa/sonar/internal/utils/valid"
"github.com/nt0xa/sonar/pkg/valid"
)

var ConfigDefaults = map[string]any{
Expand Down Expand Up @@ -77,8 +75,8 @@ func LoadConfig(
return nil, fmt.Errorf("unmarshal failed: %w", err)
}

if err := cfg.Validate(); err != nil {
return nil, fmt.Errorf("validation failed: %w", err)
if p := cfg.Validate(); !p.Ok() {
return nil, fmt.Errorf("validation failed: %w", p)
}

return &cfg, nil
Expand All @@ -96,29 +94,21 @@ type Config struct {
Modules ModulesConfig
}

func (c Config) Validate() error {
return validation.ValidateStruct(&c,
validation.Field(&c.Domain, validation.Required, is.Domain),
validation.Field(&c.IP, validation.Required, is.IP),
validation.Field(&c.DB, validation.Required),
validation.Field(&c.Audit),
validation.Field(&c.GeoIP),
validation.Field(&c.DNS),
validation.Field(&c.TLS),
validation.Field(&c.Modules),
func (c Config) Validate() valid.Problems {
return valid.Validate(
valid.String("domain", c.Domain, valid.Required, valid.Domain),
valid.String("ip", c.IP, valid.Required, valid.IP),
valid.Struct("db", c.DB),
valid.Struct("geoip", c.GeoIP),
valid.Struct("tls", c.TLS),
valid.Struct("modules", c.Modules),
)
}

type AuditConfig struct {
Enabled bool
}

func (c AuditConfig) Validate() error {
return validation.ValidateStruct(&c,
validation.Field(&c.Enabled),
)
}

//
// Telemetry
//
Expand All @@ -127,12 +117,6 @@ type TelemetryConfig struct {
Enabled bool
}

func (c TelemetryConfig) Validate() error {
return validation.ValidateStruct(&c,
validation.Field(&c.Enabled),
)
}

//
// DB
//
Expand All @@ -141,9 +125,10 @@ type DBConfig struct {
DSN string
}

func (c DBConfig) Validate() error {
return validation.ValidateStruct(&c,
validation.Field(&c.DSN, validation.Required))
func (c DBConfig) Validate() valid.Problems {
return valid.Validate(
valid.String("dsn", c.DSN, valid.Required),
)
}

//
Expand All @@ -154,10 +139,6 @@ type DNSConfig struct {
Zone string
}

func (c DNSConfig) Validate() error {
return validation.ValidateStruct(&c)
}

//
// TLS
//
Expand All @@ -168,20 +149,19 @@ type TLSConfig struct {
LetsEncrypt TLSLetsEncryptConfig
}

func (c TLSConfig) Validate() error {
rules := make([]*validation.FieldRules, 0)

rules = append(rules,
validation.Field(&c.Type, validation.Required, validation.In("custom", "letsencrypt")))
func (c TLSConfig) Validate() valid.Problems {
fields := []valid.Validatable{
valid.String("type", c.Type, valid.Required, valid.In("custom", "letsencrypt")),
}

switch c.Type {
case "custom":
rules = append(rules, validation.Field(&c.Custom))
fields = append(fields, valid.Struct("custom", c.Custom))
case "letsencrypt":
rules = append(rules, validation.Field(&c.LetsEncrypt))
fields = append(fields, valid.Struct("letsencrypt", c.LetsEncrypt))
}

return validation.ValidateStruct(&c, rules...)
return valid.Validate(fields...)
}

// Custom
Expand All @@ -191,10 +171,10 @@ type TLSCustomConfig struct {
Cert string
}

func (c TLSCustomConfig) Validate() error {
return validation.ValidateStruct(&c,
validation.Field(&c.Key, validation.Required, validation.By(valid.File)),
validation.Field(&c.Cert, validation.Required, validation.By(valid.File)),
func (c TLSCustomConfig) Validate() valid.Problems {
return valid.Validate(
valid.String("key", c.Key, valid.Required, file),
valid.String("cert", c.Cert, valid.Required, file),
)
}

Expand All @@ -207,10 +187,10 @@ type TLSLetsEncryptConfig struct {
CAInsecure bool `koanf:"ca_insecure"`
}

func (c TLSLetsEncryptConfig) Validate() error {
return validation.ValidateStruct(&c,
validation.Field(&c.Email, validation.Required),
validation.Field(&c.Directory, validation.Required, validation.By(valid.Directory)),
func (c TLSLetsEncryptConfig) Validate() valid.Problems {
return valid.Validate(
valid.String("email", c.Email, valid.Required),
valid.String("directory", c.Directory, valid.Required, directory),
)
}

Expand All @@ -224,10 +204,12 @@ type GeoIPConfig struct {
ASN string
}

func (c GeoIPConfig) Validate() error {
return validation.ValidateStruct(&c,
validation.Field(&c.Enabled),
validation.Field(&c.City, validation.When(c.Enabled, validation.Required, validation.By(valid.File))),
validation.Field(&c.ASN, validation.When(c.Enabled, validation.Required, validation.By(valid.File))),
func (c GeoIPConfig) Validate() valid.Problems {
if !c.Enabled {
return nil
}
return valid.Validate(
valid.String("city", c.City, valid.Required, file),
valid.String("asn", c.ASN, valid.Required, file),
)
}
22 changes: 12 additions & 10 deletions internal/cmd/server/modules.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,14 @@ import (
"fmt"
"log/slog"

validation "github.com/go-ozzo/ozzo-validation/v4"

"github.com/nt0xa/sonar/internal/modules"
"github.com/nt0xa/sonar/internal/modules/api"
"github.com/nt0xa/sonar/internal/modules/lark"
"github.com/nt0xa/sonar/internal/modules/slack"
"github.com/nt0xa/sonar/internal/modules/telegram"
"github.com/nt0xa/sonar/internal/service"
"github.com/nt0xa/sonar/pkg/telemetry"
"github.com/nt0xa/sonar/pkg/valid"
)

type Controller interface {
Expand All @@ -31,27 +30,30 @@ type ModulesConfig struct {
Slack slack.Config
}

func (c ModulesConfig) Validate() error {
rules := make([]*validation.FieldRules, 0)
rules = append(rules, validation.Field(&c.Enabled,
validation.Each(validation.In("telegram", "api", "lark", "slack"))))
func (c ModulesConfig) Validate() valid.Problems {
fields := []valid.Validatable{
valid.Slice("enabled", c.Enabled, valid.Each(valid.In("telegram", "api", "lark", "slack"))),
}

// TODO: dynamic modules registration. Something like sql drivers
for _, name := range c.Enabled {
switch name {

case "telegram":
rules = append(rules, validation.Field(&c.Telegram))
fields = append(fields, valid.Struct("telegram", c.Telegram))

case "api":
rules = append(rules, validation.Field(&c.API))
fields = append(fields, valid.Struct("api", c.API))

case "lark":
rules = append(rules, validation.Field(&c.Lark))
fields = append(fields, valid.Struct("lark", c.Lark))

case "slack":
fields = append(fields, valid.Struct("slack", c.Slack))
}
}

return validation.ValidateStruct(&c, rules...)
return valid.Validate(fields...)
}

func Modules(
Expand Down
Loading
Loading