Skip to content

feat(txt-registry): add apex record delegation check #5864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
+761 −123
Open

feat(txt-registry): add apex record delegation check #5864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3b1b264
refactor: extract normalizeDNSName to idna package for reuse
u-kai Sep 21, 2025
d185f0a
feat(registry): add apex record delegation check
u-kai Sep 21, 2025
7b6992f
refactor(registry): improve apex record blocking with clearer naming …
u-kai Sep 23, 2025
65c153d
feat(registry): fix apex record blocking for nested zones and add com…
u-kai Sep 23, 2025
563dad0
test(registry): test backward compatibility with pre-existing apex re…
u-kai Sep 24, 2025
f82362c
Merge branch 'master' of https://github.com/kubernetes-sigs/external-…
u-kai Sep 30, 2025
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
16 changes: 16 additions & 0 deletions internal/idna/idna.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ limitations under the License.
package idna

import (
"strings"

log "github.com/sirupsen/logrus"
"golang.org/x/net/idna"
)

Expand All @@ -27,3 +30,16 @@ var (
idna.StrictDomainName(false),
)
)

// normalizeDNSName converts a DNS name to a canonical form, so that we can use string equality
Copy link
Contributor

@szuecs szuecs Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

godoc: NormalizeDNSName

// it: removes space, get ASCII version of dnsName complient with Section 5 of RFC 5891, ensures there is a trailing dot
func NormalizeDNSName(dnsName string) string {
s, err := Profile.ToASCII(strings.TrimSpace(dnsName))
if err != nil {
log.Warnf(`Got error while parsing DNSName %s: %v`, dnsName, err)
Copy link
Contributor

@szuecs szuecs Oct 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

log.Warnf(`Failed to parse DNSName %s: %v`, dnsName, err)

}
if !strings.HasSuffix(s, ".") {
s += "."
}
return s
}
98 changes: 98 additions & 0 deletions internal/idna/idna_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,101 @@ func TestProfileWithDefault(t *testing.T) {
})
}
}

func TestNormalizeDNSName(tt *testing.T) {
records := []struct {
dnsName string
expect string
}{
{
"3AAAA.FOO.BAR.COM ",
"3aaaa.foo.bar.com.",
},
{
" example.foo.com.",
"example.foo.com.",
},
{
"example123.foo.com ",
"example123.foo.com.",
},
{
"foo",
"foo.",
},
{
"123foo.bar",
"123foo.bar.",
},
{
"foo.com",
"foo.com.",
},
{
"foo.com.",
"foo.com.",
},
{
"_foo.com.",
"_foo.com.",
},
{
"\u005Ffoo.com.",
"_foo.com.",
},
{
".foo.com.",
".foo.com.",
},
{
"foo123.COM",
"foo123.com.",
},
{
"my-exaMple3.FOO.BAR.COM",
"my-example3.foo.bar.com.",
},
{
" my-example1214.FOO-1235.BAR-foo.COM ",
"my-example1214.foo-1235.bar-foo.com.",
},
{
"my-example-my-example-1214.FOO-1235.BAR-foo.COM",
"my-example-my-example-1214.foo-1235.bar-foo.com.",
},
{
"點看.org.",
"xn--c1yn36f.org.",
},
{
"nordic-ø.xn--kitty-點看pd34d.com",
"xn--nordic--w1a.xn--xn--kitty-pd34d-hn01b3542b.com.",
},
{
"nordic-ø.kitty😸.com.",
"xn--nordic--w1a.xn--kitty-pd34d.com.",
},
{
" nordic-ø.kitty😸.COM",
"xn--nordic--w1a.xn--kitty-pd34d.com.",
},
{
"xn--nordic--w1a.kitty😸.com.",
"xn--nordic--w1a.xn--kitty-pd34d.com.",
},
{
"*.example.com.",
"*.example.com.",
},
{
"*.example.com",
"*.example.com.",
},
}
for _, r := range records {
tt.Run(r.dnsName, func(t *testing.T) {
gotName := NormalizeDNSName(r.dnsName)
assert.Equal(t, r.expect, gotName)
})
}
}
16 changes: 1 addition & 15 deletions plan/plan.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ package plan
import (
"fmt"
"slices"
"strings"

"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
Expand Down Expand Up @@ -142,7 +141,7 @@ func (t *planTable) addCandidate(e *endpoint.Endpoint) {

func (t *planTable) newPlanKey(e *endpoint.Endpoint) planKey {
key := planKey{
dnsName: normalizeDNSName(e.DNSName),
dnsName: idna.NormalizeDNSName(e.DNSName),
setIdentifier: e.SetIdentifier,
}

Expand Down Expand Up @@ -348,19 +347,6 @@ func filterRecordsForPlan(records []*endpoint.Endpoint, domainFilter endpoint.Ma
return filtered
}

// normalizeDNSName converts a DNS name to a canonical form, so that we can use string equality
// it: removes space, get ASCII version of dnsName complient with Section 5 of RFC 5891, ensures there is a trailing dot
func normalizeDNSName(dnsName string) string {
s, err := idna.Profile.ToASCII(strings.TrimSpace(dnsName))
if err != nil {
log.Warnf(`Got error while parsing DNSName %s: %v`, dnsName, err)
}
if !strings.HasSuffix(s, ".") {
s += "."
}
return s
}

func IsManagedRecord(record string, managedRecords, excludeRecords []string) bool {
if slices.Contains(excludeRecords, record) {
return false
Expand Down
98 changes: 0 additions & 98 deletions plan/plan_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1054,104 +1054,6 @@ func validateEntries(t *testing.T, entries, expected []*endpoint.Endpoint) {
}
}

func TestNormalizeDNSName(tt *testing.T) {
records := []struct {
dnsName string
expect string
}{
{
"3AAAA.FOO.BAR.COM ",
"3aaaa.foo.bar.com.",
},
{
" example.foo.com.",
"example.foo.com.",
},
{
"example123.foo.com ",
"example123.foo.com.",
},
{
"foo",
"foo.",
},
{
"123foo.bar",
"123foo.bar.",
},
{
"foo.com",
"foo.com.",
},
{
"foo.com.",
"foo.com.",
},
{
"_foo.com.",
"_foo.com.",
},
{
"\u005Ffoo.com.",
"_foo.com.",
},
{
".foo.com.",
".foo.com.",
},
{
"foo123.COM",
"foo123.com.",
},
{
"my-exaMple3.FOO.BAR.COM",
"my-example3.foo.bar.com.",
},
{
" my-example1214.FOO-1235.BAR-foo.COM ",
"my-example1214.foo-1235.bar-foo.com.",
},
{
"my-example-my-example-1214.FOO-1235.BAR-foo.COM",
"my-example-my-example-1214.foo-1235.bar-foo.com.",
},
{
"點看.org.",
"xn--c1yn36f.org.",
},
{
"nordic-ø.xn--kitty-點看pd34d.com",
"xn--nordic--w1a.xn--xn--kitty-pd34d-hn01b3542b.com.",
},
{
"nordic-ø.kitty😸.com.",
"xn--nordic--w1a.xn--kitty-pd34d.com.",
},
{
" nordic-ø.kitty😸.COM",
"xn--nordic--w1a.xn--kitty-pd34d.com.",
},
{
"xn--nordic--w1a.kitty😸.com.",
"xn--nordic--w1a.xn--kitty-pd34d.com.",
},
{
"*.example.com.",
"*.example.com.",
},
{
"*.example.com",
"*.example.com.",
},
}
for _, r := range records {
tt.Run(r.dnsName, func(t *testing.T) {
gotName := normalizeDNSName(r.dnsName)
assert.Equal(t, r.expect, gotName)
})
}
}

func TestShouldUpdateProviderSpecific(tt *testing.T) {
for _, test := range []struct {
name string
Expand Down
Loading
Loading