TheCloud/anubis
1
0
Fork 0
mirror of https://github.com/TecharoHQ/anubis.git synced 2025-08-03 09:48:08 -04:00
Code Issues Packages Projects Releases Wiki Activity

chore: move checker package to top level

Browse Source 
Signed-off-by: Xe Iaso <me@xeiaso.net>
This commit is contained in:
Xe Iaso 2025-07-01 23:58:42 +00:00
parent dc0dde3053
commit 208ceca723
No known key found for this signature in database
16 changed files with 114 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
internal/thoth/asnchecker.go
View File

@ -10,7 +10,7 @@ import (
"time"
"github.com/TecharoHQ/anubis/internal"
"github.com/TecharoHQ/anubis/lib/policy/checker"
"github.com/TecharoHQ/anubis/lib/checker"
iptoasnv1 "github.com/TecharoHQ/thoth-proto/gen/techaro/thoth/iptoasn/v1"
)

2
internal/thoth/asnchecker_test.go
View File

@ -6,7 +6,7 @@ import (
"testing"
"github.com/TecharoHQ/anubis/internal/thoth"
"github.com/TecharoHQ/anubis/lib/policy/checker"
"github.com/TecharoHQ/anubis/lib/checker"
iptoasnv1 "github.com/TecharoHQ/thoth-proto/gen/techaro/thoth/iptoasn/v1"
)

2
internal/thoth/geoipchecker.go
View File

@ -9,7 +9,7 @@ import (
"strings"
"time"
"github.com/TecharoHQ/anubis/lib/policy/checker"
"github.com/TecharoHQ/anubis/lib/checker"
iptoasnv1 "github.com/TecharoHQ/thoth-proto/gen/techaro/thoth/iptoasn/v1"
)

2
internal/thoth/geoipchecker_test.go
View File

@ -6,7 +6,7 @@ import (
"testing"
"github.com/TecharoHQ/anubis/internal/thoth"
"github.com/TecharoHQ/anubis/lib/policy/checker"
"github.com/TecharoHQ/anubis/lib/checker"
)
var _ checker.Impl = &thoth.GeoIPChecker{}

5
lib/anubis.go
View File

@ -26,14 +26,17 @@ import (
"github.com/TecharoHQ/anubis/internal/dnsbl"
"github.com/TecharoHQ/anubis/internal/ogtags"
"github.com/TecharoHQ/anubis/lib/challenge"
"github.com/TecharoHQ/anubis/lib/checker"
"github.com/TecharoHQ/anubis/lib/localization"
"github.com/TecharoHQ/anubis/lib/policy"
"github.com/TecharoHQ/anubis/lib/policy/checker"
"github.com/TecharoHQ/anubis/lib/policy/config"
// challenge implementations
_ "github.com/TecharoHQ/anubis/lib/challenge/metarefresh"
_ "github.com/TecharoHQ/anubis/lib/challenge/proofofwork"
// checker implementations
_ "github.com/TecharoHQ/anubis/lib/checker/remoteaddress"
)
var (

0
lib/policy/checker/checker.go → lib/checker/checker.go
View File

0
lib/policy/checker/registry.go → lib/checker/registry.go
View File

14
lib/policy/checker/remoteaddress/remoteaddress.go → lib/checker/remoteaddress/remoteaddress.go
View File

@ -8,8 +8,8 @@ import (
"net/netip"
"github.com/TecharoHQ/anubis/internal"
"github.com/TecharoHQ/anubis/lib/checker"
"github.com/TecharoHQ/anubis/lib/policy"
"github.com/TecharoHQ/anubis/lib/policy/checker"
"github.com/TecharoHQ/anubis/lib/policy/config"
"github.com/gaissmai/bart"
)
@ -18,7 +18,9 @@ var (
ErrNoRemoteAddresses = errors.New("remoteaddress: no remote addresses defined")
)
func init() {}
func init() {
checker.Register("remote_address", Factory{})
}
type Factory struct{}
@ -50,7 +52,7 @@ func (Factory) Create(inp json.RawMessage) (checker.Impl, error) {
table.Insert(cidr)
}
return &RemoteAddrChecker{
return &Impl{
prefixTable: table,
hash: internal.FastHash(string(inp)),
}, nil
@ -80,12 +82,12 @@ func (fc fileConfig) Valid() error {
return nil
}
type RemoteAddrChecker struct {
type Impl struct {
prefixTable *bart.Lite
hash string
}
func (rac *RemoteAddrChecker) Check(r *http.Request) (bool, error) {
func (rac *Impl) Check(r *http.Request) (bool, error) {
host := r.Header.Get("X-Real-Ip")
if host == "" {
return false, fmt.Errorf("%w: header X-Real-Ip is not set", policy.ErrMisconfiguration)
@ -99,6 +101,6 @@ func (rac *RemoteAddrChecker) Check(r *http.Request) (bool, error) {
return rac.prefixTable.Contains(addr), nil
}
func (rac *RemoteAddrChecker) Hash() string {
func (rac *Impl) Hash() string {
return rac.hash
}

168
lib/policy/checker/remoteaddress/remoteaddress_test.go → lib/checker/remoteaddress/remoteaddress_test.go
View File

@ -5,10 +5,15 @@ import (
"encoding/json"
"errors"
"net/http"
"net/netip"
"strings"
"testing"
"github.com/TecharoHQ/anubis/lib/policy/checker"
"github.com/TecharoHQ/anubis/internal"
"github.com/TecharoHQ/anubis/lib/checker"
"github.com/TecharoHQ/anubis/lib/policy"
"github.com/TecharoHQ/anubis/lib/policy/config"
"github.com/gaissmai/bart"
)
func TestFactoryIsCheckerFactory(t *testing.T) {
@ -137,80 +142,97 @@ func TestFactoryCreate(t *testing.T) {
}
}
// func TestRemoteAddrChecker(t *testing.T) {
// for _, tt := range []struct {
// err error
// name string
// ip string
// cidrs []string
// ok bool
// }{
// {
// name: "match_ipv4",
// cidrs: []string{"0.0.0.0/0"},
// ip: "1.1.1.1",
// ok: true,
// err: nil,
// },
// {
// name: "match_ipv6",
// cidrs: []string{"::/0"},
// ip: "cafe:babe::",
// ok: true,
// err: nil,
// },
// {
// name: "not_match_ipv4",
// cidrs: []string{"1.1.1.1/32"},
// ip: "1.1.1.2",
// ok: false,
// err: nil,
// },
// {
// name: "not_match_ipv6",
// cidrs: []string{"cafe:babe::/128"},
// ip: "cafe:babe:4::/128",
// ok: false,
// err: nil,
// },
// {
// name: "no_ip_set",
// cidrs: []string{"::/0"},
// ok: false,
// err: policy.ErrMisconfiguration,
// },
// {
// name: "invalid_ip",
// cidrs: []string{"::/0"},
// ip: "According to all natural laws of aviation",
// ok: false,
// err: policy.ErrMisconfiguration,
// },
// } {
// t.Run(tt.name, func(t *testing.T) {
// rac, err := NewRemoteAddrChecker(tt.cidrs)
// if err != nil && !errors.Is(err, tt.err) {
// t.Fatalf("creating RemoteAddrChecker failed: %v", err)
// }
func racFromCidrs(t *testing.T, inp []string) *Impl {
t.Helper()
// r, err := http.NewRequest(http.MethodGet, "/", nil)
// if err != nil {
// t.Fatalf("can't make request: %v", err)
// }
var result Impl
result.prefixTable = new(bart.Lite)
result.hash = internal.FastHash(strings.Join(inp, ","))
// if tt.ip != "" {
// r.Header.Add("X-Real-Ip", tt.ip)
// }
for _, cidr := range inp {
pfx, err := netip.ParsePrefix(cidr)
if err != nil {
t.Errorf("prefix %q is invalid: %v", cidr, err)
continue
}
// ok, err := rac.Check(r)
result.prefixTable.Insert(pfx)
}
// if tt.ok != ok {
// t.Errorf("ok: %v, wanted: %v", ok, tt.ok)
// }
return &result
}
// if err != nil && tt.err != nil && !errors.Is(err, tt.err) {
// t.Errorf("err: %v, wanted: %v", err, tt.err)
// }
// })
// }
// }
func TestRemoteAddrChecker(t *testing.T) {
for _, tt := range []struct {
err error
name string
ip string
cidrs []string
ok bool
}{
{
name: "match_ipv4",
cidrs: []string{"0.0.0.0/0"},
ip: "1.1.1.1",
ok: true,
err: nil,
},
{
name: "match_ipv6",
cidrs: []string{"::/0"},
ip: "cafe:babe::",
ok: true,
err: nil,
},
{
name: "not_match_ipv4",
cidrs: []string{"1.1.1.1/32"},
ip: "1.1.1.2",
ok: false,
err: nil,
},
{
name: "not_match_ipv6",
cidrs: []string{"cafe:babe::/128"},
ip: "cafe:babe:4::/128",
ok: false,
err: nil,
},
{
name: "no_ip_set",
cidrs: []string{"::/0"},
ok: false,
err: policy.ErrMisconfiguration,
},
{
name: "invalid_ip",
cidrs: []string{"::/0"},
ip: "According to all natural laws of aviation",
ok: false,
err: policy.ErrMisconfiguration,
},
} {
t.Run(tt.name, func(t *testing.T) {
rac := racFromCidrs(t, tt.cidrs)
r, err := http.NewRequest(http.MethodGet, "/", nil)
if err != nil {
t.Fatalf("can't make request: %v", err)
}
if tt.ip != "" {
r.Header.Add("X-Real-Ip", tt.ip)
}
ok, err := rac.Check(r)
if tt.ok != ok {
t.Errorf("ok: %v, wanted: %v", ok, tt.ok)
}
if err != nil && tt.err != nil && !errors.Is(err, tt.err) {
t.Errorf("err: %v, wanted: %v", err, tt.err)
}
})
}
}

2
lib/policy/bot.go
View File

@ -4,7 +4,7 @@ import (
"fmt"
"github.com/TecharoHQ/anubis/internal"
"github.com/TecharoHQ/anubis/lib/policy/checker"
"github.com/TecharoHQ/anubis/lib/checker"
"github.com/TecharoHQ/anubis/lib/policy/config"
)

2
lib/policy/checker.go
View File

@ -9,7 +9,7 @@ import (
"strings"
"github.com/TecharoHQ/anubis/internal"
"github.com/TecharoHQ/anubis/lib/policy/checker"
"github.com/TecharoHQ/anubis/lib/checker"
"github.com/gaissmai/bart"
)

5
lib/policy/checker/remoteaddress/testdata/invalid_bad_cidr.json vendored
View File

@ -1,5 +0,0 @@
{
"remote_addresses": [
"according to all laws of aviation"
]
}

3
lib/policy/checker/remoteaddress/testdata/invalid_no_cidr.json vendored
View File

@ -1,3 +0,0 @@
{
"remote_addresses": []
}

1
lib/policy/checker/remoteaddress/testdata/invalid_not_json.json vendored
View File

@ -1 +0,0 @@
]

5
lib/policy/checker/remoteaddress/testdata/valid_addresses.json vendored
View File

@ -1,5 +0,0 @@
{
"remote_addresses": [
"1.1.1.1/32"
]
}

2
lib/policy/policy.go
View File

@ -9,7 +9,7 @@ import (
"sync/atomic"
"github.com/TecharoHQ/anubis/internal/thoth"
"github.com/TecharoHQ/anubis/lib/policy/checker"
"github.com/TecharoHQ/anubis/lib/checker"
"github.com/TecharoHQ/anubis/lib/policy/config"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"