checker: add dname_coexistence rule and refactor sibling probing
Extract querySiblings from observeCoexistence so both CNAME and DNAME coexistence checks share the same parallel RRset scan. Add observeDNAMECoexistence (called from Collect) that populates AliasData.DNAMECoexistence for each DNAME node in DNAMESubstitutions. Add the dname_coexistence rule (RFC 6672 §2.3) that flags any sibling RRsets at a DNAME owner as CRIT, with matching tests.
This commit is contained in:
parent
1493ef4d3f
commit
c5c13960d5
5 changed files with 112 additions and 12 deletions
|
|
@ -49,6 +49,7 @@ func (p *aliasProvider) Collect(ctx context.Context, opts sdk.CheckerOptions) (a
|
||||||
}
|
}
|
||||||
|
|
||||||
observeCoexistence(ctx, data, servers, owner)
|
observeCoexistence(ctx, data, servers, owner)
|
||||||
|
observeDNAMECoexistence(ctx, data, servers)
|
||||||
observeDNSSEC(ctx, data, servers, apex, owner)
|
observeDNSSEC(ctx, data, servers, apex, owner)
|
||||||
|
|
||||||
return data, nil
|
return data, nil
|
||||||
|
|
@ -403,20 +404,18 @@ func observeApex(ctx context.Context, data *AliasData, servers []string, apex st
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func observeCoexistence(ctx context.Context, data *AliasData, servers []string, owner string) {
|
// querySiblings returns RRsets of common types that sit alongside a CNAME or DNAME at owner.
|
||||||
if !data.OwnerHasCNAME {
|
// Filter on owner+type: a DNAME-synthesized CNAME would otherwise count as a sibling.
|
||||||
return
|
func querySiblings(ctx context.Context, servers []string, owner string) []CoexistingRRset {
|
||||||
}
|
candidates := []uint16{
|
||||||
|
|
||||||
siblings := []uint16{
|
|
||||||
dns.TypeA, dns.TypeAAAA, dns.TypeMX, dns.TypeTXT,
|
dns.TypeA, dns.TypeAAAA, dns.TypeMX, dns.TypeTXT,
|
||||||
dns.TypeNS, dns.TypeSRV, dns.TypeCAA,
|
dns.TypeNS, dns.TypeSRV, dns.TypeCAA,
|
||||||
}
|
}
|
||||||
seen := map[string]uint32{}
|
seen := map[string]uint32{}
|
||||||
var mu sync.Mutex
|
var mu sync.Mutex
|
||||||
var wg sync.WaitGroup
|
var wg sync.WaitGroup
|
||||||
wg.Add(len(siblings))
|
wg.Add(len(candidates))
|
||||||
for _, qt := range siblings {
|
for _, qt := range candidates {
|
||||||
go func() {
|
go func() {
|
||||||
defer wg.Done()
|
defer wg.Done()
|
||||||
q := dns.Question{Name: owner, Qtype: qt, Qclass: dns.ClassINET}
|
q := dns.Question{Name: owner, Qtype: qt, Qclass: dns.ClassINET}
|
||||||
|
|
@ -424,8 +423,6 @@ func observeCoexistence(ctx context.Context, data *AliasData, servers []string,
|
||||||
if err != nil || r == nil {
|
if err != nil || r == nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
// Filter on owner+type because a DNAME-synthesized CNAME would
|
|
||||||
// otherwise count as a sibling of every queried type.
|
|
||||||
for _, rr := range r.Answer {
|
for _, rr := range r.Answer {
|
||||||
if rr.Header().Rrtype != qt {
|
if rr.Header().Rrtype != qt {
|
||||||
continue
|
continue
|
||||||
|
|
@ -441,9 +438,42 @@ func observeCoexistence(ctx context.Context, data *AliasData, servers []string,
|
||||||
}()
|
}()
|
||||||
}
|
}
|
||||||
wg.Wait()
|
wg.Wait()
|
||||||
|
var out []CoexistingRRset
|
||||||
for t, ttl := range seen {
|
for t, ttl := range seen {
|
||||||
data.Coexisting = append(data.Coexisting, CoexistingRRset{Type: t, TTL: ttl})
|
out = append(out, CoexistingRRset{Type: t, TTL: ttl})
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func observeCoexistence(ctx context.Context, data *AliasData, servers []string, owner string) {
|
||||||
|
if !data.OwnerHasCNAME {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
data.Coexisting = querySiblings(ctx, servers, owner)
|
||||||
|
}
|
||||||
|
|
||||||
|
func observeDNAMECoexistence(ctx context.Context, data *AliasData, servers []string) {
|
||||||
|
if len(data.DNAMESubstitutions) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
results := make(map[string][]CoexistingRRset, len(data.DNAMESubstitutions))
|
||||||
|
var mu sync.Mutex
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(len(data.DNAMESubstitutions))
|
||||||
|
for _, hop := range data.DNAMESubstitutions {
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
siblings := querySiblings(ctx, servers, hop.Owner)
|
||||||
|
if len(siblings) > 0 {
|
||||||
|
mu.Lock()
|
||||||
|
results[hop.Owner] = siblings
|
||||||
|
mu.Unlock()
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
wg.Wait()
|
||||||
|
if len(results) > 0 {
|
||||||
|
data.DNAMECoexistence = results
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -80,6 +80,7 @@ func Definition() *sdk.CheckerDefinition {
|
||||||
cnameAtApexRule{},
|
cnameAtApexRule{},
|
||||||
apexFlatteningRule{},
|
apexFlatteningRule{},
|
||||||
cnameCoexistenceRule{},
|
cnameCoexistenceRule{},
|
||||||
|
dnameCoexistenceRule{},
|
||||||
cnameDnssecRule{},
|
cnameDnssecRule{},
|
||||||
targetResolvableRule{},
|
targetResolvableRule{},
|
||||||
multipleRecordsRule{},
|
multipleRecordsRule{},
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,41 @@ import (
|
||||||
sdk "git.happydns.org/checker-sdk-go/checker"
|
sdk "git.happydns.org/checker-sdk-go/checker"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
type dnameCoexistenceRule struct{}
|
||||||
|
|
||||||
|
func (dnameCoexistenceRule) Name() string { return "dname_coexistence" }
|
||||||
|
func (dnameCoexistenceRule) Description() string {
|
||||||
|
return "Flags RRsets that sit at the same owner as a DNAME (RFC 6672 §2.3)."
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dnameCoexistenceRule) Evaluate(ctx context.Context, obs sdk.ObservationGetter, _ sdk.CheckerOptions) []sdk.CheckState {
|
||||||
|
data, errState := loadAlias(ctx, obs)
|
||||||
|
if errState != nil {
|
||||||
|
return errState
|
||||||
|
}
|
||||||
|
if !apexKnown(data) {
|
||||||
|
return skipped("apex lookup failed")
|
||||||
|
}
|
||||||
|
if len(data.DNAMESubstitutions) == 0 {
|
||||||
|
return skipped("no DNAME in chain")
|
||||||
|
}
|
||||||
|
if len(data.DNAMECoexistence) == 0 {
|
||||||
|
return okState(data.Owner, "all DNAME nodes have no sibling records")
|
||||||
|
}
|
||||||
|
var out []sdk.CheckState
|
||||||
|
for owner, coexisting := range data.DNAMECoexistence {
|
||||||
|
for _, rr := range coexisting {
|
||||||
|
out = append(out, withHint(sdk.CheckState{
|
||||||
|
Status: sdk.StatusCrit,
|
||||||
|
Subject: owner,
|
||||||
|
Message: fmt.Sprintf("%s and DNAME both exist at %s (RFC 6672 §2.3)", rr.Type, owner),
|
||||||
|
Code: rr.Type,
|
||||||
|
}, "Remove the sibling record or move it under a different label; a DNAME owner must not carry other data."))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
type cnameCoexistenceRule struct{}
|
type cnameCoexistenceRule struct{}
|
||||||
|
|
||||||
func (cnameCoexistenceRule) Name() string { return "cname_coexistence" }
|
func (cnameCoexistenceRule) Name() string { return "cname_coexistence" }
|
||||||
|
|
|
||||||
|
|
@ -266,6 +266,38 @@ func TestCnameCoexistenceRule(t *testing.T) {
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestDnameCoexistenceRule(t *testing.T) {
|
||||||
|
t.Run("skip when no DNAME in chain", func(t *testing.T) {
|
||||||
|
d := apexKnownData()
|
||||||
|
assertSkipped(t, run(dnameCoexistenceRule{}, d, nil), "no DNAME in chain")
|
||||||
|
})
|
||||||
|
t.Run("ok when DNAME has no siblings", func(t *testing.T) {
|
||||||
|
d := apexKnownData()
|
||||||
|
d.DNAMESubstitutions = []ChainHop{{Owner: "old.example.com.", Kind: KindDNAME, Target: "new.example.com."}}
|
||||||
|
assertSingle(t, run(dnameCoexistenceRule{}, d, nil), sdk.StatusOK)
|
||||||
|
})
|
||||||
|
t.Run("crit when DNAME has siblings", func(t *testing.T) {
|
||||||
|
d := apexKnownData()
|
||||||
|
d.DNAMESubstitutions = []ChainHop{{Owner: "old.example.com.", Kind: KindDNAME, Target: "new.example.com."}}
|
||||||
|
d.DNAMECoexistence = map[string][]CoexistingRRset{
|
||||||
|
"old.example.com.": {{Type: "MX"}, {Type: "A"}},
|
||||||
|
}
|
||||||
|
states := run(dnameCoexistenceRule{}, d, nil)
|
||||||
|
if len(states) != 2 {
|
||||||
|
t.Fatalf("want 2 states, got %d: %+v", len(states), states)
|
||||||
|
}
|
||||||
|
for _, s := range states {
|
||||||
|
if s.Status != sdk.StatusCrit {
|
||||||
|
t.Fatalf("want CRIT, got %v", s.Status)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
t.Run("skip when apex unknown", func(t *testing.T) {
|
||||||
|
d := &AliasData{Owner: "x.", ApexLookupError: "boom"}
|
||||||
|
assertSkipped(t, run(dnameCoexistenceRule{}, d, nil), "apex")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
func TestCnameDnssecRule(t *testing.T) {
|
func TestCnameDnssecRule(t *testing.T) {
|
||||||
t.Run("skip unsigned zone", func(t *testing.T) {
|
t.Run("skip unsigned zone", func(t *testing.T) {
|
||||||
d := apexKnownData()
|
d := apexKnownData()
|
||||||
|
|
|
||||||
|
|
@ -70,6 +70,8 @@ type AliasData struct {
|
||||||
|
|
||||||
// Coexisting is populated only when Owner has a CNAME.
|
// Coexisting is populated only when Owner has a CNAME.
|
||||||
Coexisting []CoexistingRRset `json:"coexisting,omitempty"`
|
Coexisting []CoexistingRRset `json:"coexisting,omitempty"`
|
||||||
|
// DNAMECoexistence maps each DNAME owner (from DNAMESubstitutions) to its sibling RRsets.
|
||||||
|
DNAMECoexistence map[string][]CoexistingRRset `json:"dname_coexistence,omitempty"`
|
||||||
|
|
||||||
OwnerIsApex bool `json:"owner_is_apex,omitempty"`
|
OwnerIsApex bool `json:"owner_is_apex,omitempty"`
|
||||||
OwnerHasCNAME bool `json:"owner_has_cname,omitempty"`
|
OwnerHasCNAME bool `json:"owner_has_cname,omitempty"`
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue