Skip to content

Commit

Permalink
Merge pull request #3724 from Sewci0/fix/to-endpoint-name
Browse files Browse the repository at this point in the history 
[TXT Registry] Fix handling of records produced by `toNewTXTName` in `toEndpoint`
  • Loading branch information
@k8s-ci-robot
k8s-ci-robot committed Aug 10, 2023
2 parents cf1b30f + 1ffcc5d commit 380e8b6
Show file tree
Hide file tree
Showing 2 changed files with 217 additions and 54 deletions.
99 changes: 64 additions & 35 deletions registry/txt.go
View file
Expand Up @@ -19,7 +19,6 @@ package registry
import (
"context"
"errors"
"fmt"
"strings"
"time"

Expand All @@ -35,6 +34,12 @@ const (
providerSpecificForceUpdate = "txt/force-update"
)

type endpointKey struct {
DNSName string
RecordType string
SetIdentifier string
}

// TXTRegistry implements registry interface with ownership implemented via associated TXT records
type TXTRegistry struct {
provider provider.Provider
Expand All @@ -58,8 +63,6 @@ type TXTRegistry struct {
txtEncryptAESKey []byte
}

const keySuffixAAAA = ":AAAA"

// NewTXTRegistry returns new TXTRegistry object
func NewTXTRegistry(provider provider.Provider, txtPrefix, txtSuffix, ownerID string, cacheInterval time.Duration, txtWildcardReplacement string, managedRecordTypes []string, txtEncryptEnabled bool, txtEncryptAESKey []byte) (*TXTRegistry, error) {
if ownerID == "" {
Expand Down Expand Up @@ -118,7 +121,7 @@ func (im *TXTRegistry) Records(ctx context.Context) ([]*endpoint.Endpoint, error

endpoints := []*endpoint.Endpoint{}

labelMap := map[string]endpoint.Labels{}
labelMap := map[endpointKey]endpoint.Labels{}
txtRecordsMap := map[string]struct{}{}

for _, record := range records {
Expand All @@ -138,10 +141,12 @@ func (im *TXTRegistry) Records(ctx context.Context) ([]*endpoint.Endpoint, error
if err != nil {
return nil, err
}
endpointName, isAAAA := im.mapper.toEndpointName(record.DNSName)
key := fmt.Sprintf("%s::%s", endpointName, record.SetIdentifier)
if isAAAA {
key += keySuffixAAAA

endpointName, recordType := im.mapper.toEndpointName(record.DNSName)
key := endpointKey{
DNSName: endpointName,
RecordType: recordType,
SetIdentifier: record.SetIdentifier,
}
labelMap[key] = labels
txtRecordsMap[record.DNSName] = struct{}{}
Expand All @@ -157,11 +162,19 @@ func (im *TXTRegistry) Records(ctx context.Context) ([]*endpoint.Endpoint, error
dnsNameSplit[0] = im.wildcardReplacement
}
dnsName := strings.Join(dnsNameSplit, ".")
key := fmt.Sprintf("%s::%s", dnsName, ep.SetIdentifier)
if ep.RecordType == endpoint.RecordTypeAAAA {
key += keySuffixAAAA
key := endpointKey{
DNSName: dnsName,
RecordType: ep.RecordType,
SetIdentifier: ep.SetIdentifier,
}

// Handle both new and old registry format with the preference for the new one
labels, labelsExist := labelMap[key]
if !labelsExist && ep.RecordType != endpoint.RecordTypeAAAA {
key.RecordType = ""
labels, labelsExist = labelMap[key]
}
if labels, ok := labelMap[key]; ok {
if labelsExist {
for k, v := range labels {
ep.Labels[k] = v
}
Expand Down Expand Up @@ -202,7 +215,7 @@ func (im *TXTRegistry) generateTXTRecord(r *endpoint.Endpoint) []*endpoint.Endpo

endpoints := make([]*endpoint.Endpoint, 0)

if r.RecordType != endpoint.RecordTypeAAAA {
if !im.mapper.recordTypeInAffix() && r.RecordType != endpoint.RecordTypeAAAA {
// old TXT record format
txt := endpoint.NewEndpoint(im.mapper.toTXTName(r.DNSName), endpoint.RecordTypeTXT, r.Labels.Serialize(true, im.txtEncryptEnabled, im.txtEncryptAESKey))
if txt != nil {
Expand Down Expand Up @@ -300,9 +313,10 @@ func (im *TXTRegistry) AdjustEndpoints(endpoints []*endpoint.Endpoint) []*endpoi
*/

type nameMapper interface {
toEndpointName(string) (endpointName string, isAAAA bool)
toEndpointName(string) (endpointName string, recordType string)
toTXTName(string) string
toNewTXTName(string, string) string
recordTypeInAffix() bool
}

type affixNameMapper struct {
Expand All @@ -317,7 +331,9 @@ func newaffixNameMapper(prefix, suffix, wildcardReplacement string) affixNameMap
return affixNameMapper{prefix: strings.ToLower(prefix), suffix: strings.ToLower(suffix), wildcardReplacement: strings.ToLower(wildcardReplacement)}
}

func extractRecordType(name string) (baseName, recordType string) {
// extractRecordTypeDefaultPosition extracts record type from the default position
// when not using '%{record_type}' in the prefix/suffix
func extractRecordTypeDefaultPosition(name string) (baseName, recordType string) {
nameS := strings.Split(name, "-")
for _, t := range getSupportedTypes() {
if nameS[0] == strings.ToLower(t) {
Expand All @@ -327,32 +343,41 @@ func extractRecordType(name string) (baseName, recordType string) {
return name, ""
}

// dropAffix strips TXT record to find an endpoint name it manages
// It takes into consideration a fact that it could contain record type
// So it gets stripped first
func (pr affixNameMapper) dropAffix(name string) string {
// dropAffixExtractType strips TXT record to find an endpoint name it manages
// it also returns the record type
func (pr affixNameMapper) dropAffixExtractType(name string) (baseName, recordType string) {
prefix := pr.prefix
suffix := pr.suffix

if pr.recordTypeInAffix() {
for _, t := range getSupportedTypes() {
t = strings.ToLower(t)
iPrefix := strings.ReplaceAll(pr.prefix, recordTemplate, t)
iSuffix := strings.ReplaceAll(pr.suffix, recordTemplate, t)
iPrefix := strings.ReplaceAll(prefix, recordTemplate, t)
iSuffix := strings.ReplaceAll(suffix, recordTemplate, t)

if pr.isPrefix() && strings.HasPrefix(name, iPrefix) {
return strings.TrimPrefix(name, iPrefix)
return strings.TrimPrefix(name, iPrefix), t
}

if pr.isSuffix() && strings.HasSuffix(name, iSuffix) {
return strings.TrimSuffix(name, iSuffix)
return strings.TrimSuffix(name, iSuffix), t
}
}

// handle old TXT records
prefix = pr.dropAffixTemplate(prefix)
suffix = pr.dropAffixTemplate(suffix)
}
if strings.HasPrefix(name, pr.prefix) && pr.isPrefix() {
return strings.TrimPrefix(name, pr.prefix)

if pr.isPrefix() && strings.HasPrefix(name, prefix) {
return extractRecordTypeDefaultPosition(strings.TrimPrefix(name, prefix))
}

if strings.HasSuffix(name, pr.suffix) && pr.isSuffix() {
return strings.TrimSuffix(name, pr.suffix)
if pr.isSuffix() && strings.HasSuffix(name, suffix) {
return extractRecordTypeDefaultPosition(strings.TrimSuffix(name, suffix))
}
return ""

return "", ""
}

func (pr affixNameMapper) dropAffixTemplate(name string) string {
Expand All @@ -367,20 +392,24 @@ func (pr affixNameMapper) isSuffix() bool {
return len(pr.prefix) == 0 && len(pr.suffix) > 0
}

func (pr affixNameMapper) toEndpointName(txtDNSName string) (endpointName string, isAAAA bool) {
lowerDNSName, recordType := extractRecordType(strings.ToLower(txtDNSName))
func (pr affixNameMapper) toEndpointName(txtDNSName string) (endpointName string, recordType string) {
lowerDNSName := strings.ToLower(txtDNSName)

// drop prefix
if strings.HasPrefix(lowerDNSName, pr.prefix) && pr.isPrefix() {
return pr.dropAffix(lowerDNSName), recordType == endpoint.RecordTypeAAAA
if pr.isPrefix() {
return pr.dropAffixExtractType(lowerDNSName)
}

// drop suffix
if pr.isSuffix() {
DNSName := strings.SplitN(lowerDNSName, ".", 2)
return pr.dropAffix(DNSName[0]) + "." + DNSName[1], recordType == endpoint.RecordTypeAAAA
dc := strings.Count(pr.suffix, ".")
DNSName := strings.SplitN(lowerDNSName, ".", 2+dc)
domainWithSuffix := strings.Join(DNSName[:1+dc], ".")

r, rType := pr.dropAffixExtractType(domainWithSuffix)
return r + "." + DNSName[1+dc], rType
}
return "", false
return "", ""
}

func (pr affixNameMapper) toTXTName(endpointDNSName string) string {
Expand Down

0 comments on commit 380e8b6

Please sign in to comment.