/* Copyright 2017 The Kubernetes Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package rfc2136 import ( "context" "crypto/tls" "fmt" "net" "sort" "strconv" "strings" "time" "github.com/bodgit/tsig" "github.com/bodgit/tsig/gss" "github.com/miekg/dns" "github.com/pkg/errors" log "github.com/sirupsen/logrus" "sigs.k8s.io/external-dns/endpoint" "sigs.k8s.io/external-dns/pkg/tlsutils" "sigs.k8s.io/external-dns/plan" "sigs.k8s.io/external-dns/provider" ) const ( // maximum time DNS client can be off from server for an update to succeed clockSkew = 300 ) // rfc2136 provider type type rfc2136Provider struct { provider.BaseProvider nameserver string zoneNames []string tsigKeyName string tsigSecret string tsigSecretAlg string insecure bool axfr bool minTTL time.Duration batchChangeSize int tlsConfig TLSConfig createPTR bool // options specific to rfc3645 gss-tsig support gssTsig bool krb5Username string krb5Password string krb5Realm string // only consider hosted zones managing domains ending in this suffix domainFilter endpoint.DomainFilter dryRun bool actions rfc2136Actions } // TLSConfig is comprised of the TLS-related fields necessary if we are using DNS over TLS type TLSConfig struct { UseTLS bool SkipTLSVerify bool CAFilePath string ClientCertFilePath string ClientCertKeyFilePath string ServerName string } // Map of supported TSIG algorithms var tsigAlgs = map[string]string{ "hmac-sha1": dns.HmacSHA1, "hmac-sha224": dns.HmacSHA224, "hmac-sha256": dns.HmacSHA256, "hmac-sha384": dns.HmacSHA384, "hmac-sha512": dns.HmacSHA512, } type rfc2136Actions interface { SendMessage(msg *dns.Msg) error IncomeTransfer(m *dns.Msg, a string) (env chan *dns.Envelope, err error) } // NewRfc2136Provider is a factory function for OpenStack rfc2136 providers func NewRfc2136Provider(host string, port int, zoneNames []string, insecure bool, keyName string, secret string, secretAlg string, axfr bool, domainFilter endpoint.DomainFilter, dryRun bool, minTTL time.Duration, createPTR bool, gssTsig bool, krb5Username string, krb5Password string, krb5Realm string, batchChangeSize int, tlsConfig TLSConfig, actions rfc2136Actions) (provider.Provider, error) { secretAlgChecked, ok := tsigAlgs[secretAlg] if !ok && !insecure && !gssTsig { return nil, errors.Errorf("%s is not supported TSIG algorithm", secretAlg) } // Set zone to root if no set if len(zoneNames) == 0 { zoneNames = append(zoneNames, ".") } // Sort zones sort.Slice(zoneNames, func(i, j int) bool { return len(strings.Split(zoneNames[i], ".")) > len(strings.Split(zoneNames[j], ".")) }) if tlsConfig.UseTLS { tlsConfig.ServerName = host } r := &rfc2136Provider{ nameserver: net.JoinHostPort(host, strconv.Itoa(port)), zoneNames: zoneNames, insecure: insecure, gssTsig: gssTsig, createPTR: createPTR, krb5Username: krb5Username, krb5Password: krb5Password, krb5Realm: strings.ToUpper(krb5Realm), domainFilter: domainFilter, dryRun: dryRun, axfr: axfr, minTTL: minTTL, batchChangeSize: batchChangeSize, tlsConfig: tlsConfig, } if actions != nil { r.actions = actions } else { r.actions = r } if !insecure { r.tsigKeyName = dns.Fqdn(keyName) r.tsigSecret = secret r.tsigSecretAlg = secretAlgChecked } log.Infof("Configured RFC2136 with zone '%s' and nameserver '%s'", r.zoneNames, r.nameserver) return r, nil } // KeyName will return TKEY name and TSIG handle to use for followon actions with a secure connection func (r rfc2136Provider) KeyData() (keyName string, handle *gss.Client, err error) { handle, err = gss.NewClient(new(dns.Client)) if err != nil { return keyName, handle, err } keyName, _, err = handle.NegotiateContextWithCredentials(r.nameserver, r.krb5Realm, r.krb5Username, r.krb5Password) return keyName, handle, err } // Records returns the list of records. func (r rfc2136Provider) Records(ctx context.Context) ([]*endpoint.Endpoint, error) { rrs, err := r.List() if err != nil { return nil, err } var eps []*endpoint.Endpoint OuterLoop: for _, rr := range rrs { log.Debugf("Record=%s", rr) if rr.Header().Class != dns.ClassINET { continue } rrFqdn := rr.Header().Name rrTTL := endpoint.TTL(rr.Header().Ttl) var rrType string var rrValues []string switch rr.Header().Rrtype { case dns.TypeCNAME: rrValues = []string{rr.(*dns.CNAME).Target} rrType = "CNAME" case dns.TypeA: rrValues = []string{rr.(*dns.A).A.String()} rrType = "A" case dns.TypeAAAA: rrValues = []string{rr.(*dns.AAAA).AAAA.String()} rrType = "AAAA" case dns.TypeTXT: rrValues = (rr.(*dns.TXT).Txt) rrType = "TXT" case dns.TypeNS: rrValues = []string{rr.(*dns.NS).Ns} rrType = "NS" case dns.TypePTR: rrValues = []string{rr.(*dns.PTR).Ptr} rrType = "PTR" default: continue // Unhandled record type } for idx, existingEndpoint := range eps { if existingEndpoint.DNSName == strings.TrimSuffix(rrFqdn, ".") && existingEndpoint.RecordType == rrType { eps[idx].Targets = append(eps[idx].Targets, rrValues...) continue OuterLoop } } ep := endpoint.NewEndpointWithTTL( rrFqdn, rrType, rrTTL, rrValues..., ) eps = append(eps, ep) } return eps, nil } func (r rfc2136Provider) IncomeTransfer(m *dns.Msg, a string) (env chan *dns.Envelope, err error) { t := new(dns.Transfer) if !r.insecure && !r.gssTsig { t.TsigSecret = map[string]string{r.tsigKeyName: r.tsigSecret} } c, err := makeClient(r) if err != nil { return nil, fmt.Errorf("error setting up TLS: %w", err) } conn, err := c.Dial(a) if err != nil { return nil, fmt.Errorf("failed to connect for transfer: %w", err) } t.Conn = conn return t.In(m, r.nameserver) } func (r rfc2136Provider) List() ([]dns.RR, error) { if !r.axfr { log.Debug("axfr is disabled") return make([]dns.RR, 0), nil } records := make([]dns.RR, 0) for _, zone := range r.zoneNames { log.Debugf("Fetching records for '%q'", zone) m := new(dns.Msg) m.SetAxfr(dns.Fqdn(zone)) if !r.insecure && !r.gssTsig { m.SetTsig(r.tsigKeyName, r.tsigSecretAlg, clockSkew, time.Now().Unix()) } env, err := r.actions.IncomeTransfer(m, r.nameserver) if err != nil { return nil, fmt.Errorf("failed to fetch records via AXFR: %w", err) } for e := range env { if e.Error != nil { if e.Error == dns.ErrSoa { log.Error("AXFR error: unexpected response received from the server") } else { log.Errorf("AXFR error: %v", e.Error) } continue } records = append(records, e.RR...) } } return records, nil } func (r rfc2136Provider) AddReverseRecord(ip string, hostname string) error { changes := r.GenerateReverseRecord(ip, hostname) return r.ApplyChanges(context.Background(), &plan.Changes{Create: changes}) } func (r rfc2136Provider) RemoveReverseRecord(ip string, hostname string) error { changes := r.GenerateReverseRecord(ip, hostname) return r.ApplyChanges(context.Background(), &plan.Changes{Delete: changes}) } func (r rfc2136Provider) GenerateReverseRecord(ip string, hostname string) []*endpoint.Endpoint { // Find the zone for the PTR record // zone := findMsgZone(&endpoint.Endpoint{DNSName: ip}, p.ptrZoneNames) // Generate PTR notation record starting from the IP address var records []*endpoint.Endpoint log.Debugf("Reverse zone is: %s %s", ip, dns.Fqdn(ip)) reverseAddress, _ := dns.ReverseAddr(ip) // PTR records = append(records, &endpoint.Endpoint{ DNSName: reverseAddress[:len(reverseAddress)-1], RecordType: "PTR", Targets: endpoint.Targets{hostname}, }) return records } // ApplyChanges applies a given set of changes in a given zone. func (r rfc2136Provider) ApplyChanges(ctx context.Context, changes *plan.Changes) error { log.Debugf("ApplyChanges (Create: %d, UpdateOld: %d, UpdateNew: %d, Delete: %d)", len(changes.Create), len(changes.UpdateOld), len(changes.UpdateNew), len(changes.Delete)) var errors []error for c, chunk := range chunkBy(changes.Create, r.batchChangeSize) { log.Debugf("Processing batch %d of create changes", c) m := make(map[string]*dns.Msg) m["."] = new(dns.Msg) // Add the root zone for _, z := range r.zoneNames { z = dns.Fqdn(z) m[z] = new(dns.Msg) } for _, ep := range chunk { if !r.domainFilter.Match(ep.DNSName) { log.Debugf("Skipping record %s because it was filtered out by the specified --domain-filter", ep.DNSName) continue } zone := findMsgZone(ep, r.zoneNames) r.krb5Realm = strings.ToUpper(zone) m[zone].SetUpdate(zone) r.AddRecord(m[zone], ep) if r.createPTR && (ep.RecordType == "A" || ep.RecordType == "AAAA") { r.AddReverseRecord(ep.Targets[0], ep.DNSName) } } // only send if there are records available for _, z := range m { if len(z.Ns) > 0 { if err := r.actions.SendMessage(z); err != nil { log.Errorf("RFC2136 create record failed: %v", err) errors = append(errors, err) continue } } } } for c, chunk := range chunkBy(changes.UpdateNew, r.batchChangeSize) { log.Debugf("Processing batch %d of update changes", c) m := make(map[string]*dns.Msg) m["."] = new(dns.Msg) // Add the root zone for _, z := range r.zoneNames { z = dns.Fqdn(z) m[z] = new(dns.Msg) } for i, ep := range chunk { if !r.domainFilter.Match(ep.DNSName) { log.Debugf("Skipping record %s because it was filtered out by the specified --domain-filter", ep.DNSName) continue } zone := findMsgZone(ep, r.zoneNames) r.krb5Realm = strings.ToUpper(zone) m[zone].SetUpdate(zone) r.UpdateRecord(m[zone], changes.UpdateOld[i], ep) if r.createPTR && (ep.RecordType == "A" || ep.RecordType == "AAAA") { r.RemoveReverseRecord(changes.UpdateOld[i].Targets[0], ep.DNSName) r.AddReverseRecord(ep.Targets[0], ep.DNSName) } } // only send if there are records available for _, z := range m { if len(z.Ns) > 0 { if err := r.actions.SendMessage(z); err != nil { log.Errorf("RFC2136 update record failed: %v", err) errors = append(errors, err) continue } } } } for c, chunk := range chunkBy(changes.Delete, r.batchChangeSize) { log.Debugf("Processing batch %d of delete changes", c) m := make(map[string]*dns.Msg) m["."] = new(dns.Msg) // Add the root zone for _, z := range r.zoneNames { z = dns.Fqdn(z) m[z] = new(dns.Msg) } for _, ep := range chunk { if !r.domainFilter.Match(ep.DNSName) { log.Debugf("Skipping record %s because it was filtered out by the specified --domain-filter", ep.DNSName) continue } zone := findMsgZone(ep, r.zoneNames) r.krb5Realm = strings.ToUpper(zone) m[zone].SetUpdate(zone) r.RemoveRecord(m[zone], ep) if r.createPTR && (ep.RecordType == "A" || ep.RecordType == "AAAA") { r.RemoveReverseRecord(ep.Targets[0], ep.DNSName) } } // only send if there are records available for _, z := range m { if len(z.Ns) > 0 { if err := r.actions.SendMessage(z); err != nil { log.Errorf("RFC2136 delete record failed: %v", err) errors = append(errors, err) continue } } } } if len(errors) > 0 { return fmt.Errorf("RFC2136 had errors in one or more of its batches: %v", errors) } return nil } func (r rfc2136Provider) UpdateRecord(m *dns.Msg, oldEp *endpoint.Endpoint, newEp *endpoint.Endpoint) error { err := r.RemoveRecord(m, oldEp) if err != nil { return err } return r.AddRecord(m, newEp) } func (r rfc2136Provider) AddRecord(m *dns.Msg, ep *endpoint.Endpoint) error { log.Debugf("AddRecord.ep=%s", ep) ttl := int64(r.minTTL.Seconds()) if ep.RecordTTL.IsConfigured() && int64(ep.RecordTTL) > ttl { ttl = int64(ep.RecordTTL) } for _, target := range ep.Targets { newRR := fmt.Sprintf("%s %d %s %s", ep.DNSName, ttl, ep.RecordType, target) log.Infof("Adding RR: %s", newRR) rr, err := dns.NewRR(newRR) if err != nil { return fmt.Errorf("failed to build RR: %v", err) } m.Insert([]dns.RR{rr}) } return nil } func (r rfc2136Provider) RemoveRecord(m *dns.Msg, ep *endpoint.Endpoint) error { log.Debugf("RemoveRecord.ep=%s", ep) for _, target := range ep.Targets { newRR := fmt.Sprintf("%s %d %s %s", ep.DNSName, ep.RecordTTL, ep.RecordType, target) log.Infof("Removing RR: %s", newRR) rr, err := dns.NewRR(newRR) if err != nil { return fmt.Errorf("failed to build RR: %v", err) } m.Remove([]dns.RR{rr}) } return nil } func (r rfc2136Provider) SendMessage(msg *dns.Msg) error { if r.dryRun { log.Debugf("SendMessage.skipped") return nil } log.Debugf("SendMessage") c, err := makeClient(r) if err != nil { return fmt.Errorf("error setting up TLS: %w", err) } if !r.insecure { if r.gssTsig { keyName, handle, err := r.KeyData() if err != nil { return err } defer handle.Close() defer handle.DeleteContext(keyName) c.TsigProvider = handle msg.SetTsig(keyName, tsig.GSS, clockSkew, time.Now().Unix()) } else { c.TsigProvider = tsig.HMAC{r.tsigKeyName: r.tsigSecret} msg.SetTsig(r.tsigKeyName, r.tsigSecretAlg, clockSkew, time.Now().Unix()) } } resp, _, err := c.Exchange(msg, r.nameserver) if err != nil { if resp != nil && resp.Rcode != dns.RcodeSuccess { log.Infof("error in dns.Client.Exchange: %s", err) return err } log.Warnf("warn in dns.Client.Exchange: %s", err) } if resp != nil && resp.Rcode != dns.RcodeSuccess { log.Infof("Bad dns.Client.Exchange response: %s", resp) return fmt.Errorf("bad return code: %s", dns.RcodeToString[resp.Rcode]) } log.Debugf("SendMessage.success") return nil } func chunkBy(slice []*endpoint.Endpoint, chunkSize int) [][]*endpoint.Endpoint { var chunks [][]*endpoint.Endpoint for i := 0; i < len(slice); i += chunkSize { end := i + chunkSize if end > len(slice) { end = len(slice) } chunks = append(chunks, slice[i:end]) } return chunks } func findMsgZone(ep *endpoint.Endpoint, zoneNames []string) string { for _, zone := range zoneNames { if strings.HasSuffix(ep.DNSName, zone) { return dns.Fqdn(zone) } } log.Warnf("No available zone found for %s, set it to 'root'", ep.DNSName) return dns.Fqdn(".") } func makeClient(r rfc2136Provider) (result *dns.Client, err error) { c := new(dns.Client) if r.tlsConfig.UseTLS { log.Debug("RFC2136 Connecting via TLS") c.Net = "tcp-tls" tlsConfig, err := tlsutils.NewTLSConfig( r.tlsConfig.ClientCertFilePath, r.tlsConfig.ClientCertKeyFilePath, r.tlsConfig.CAFilePath, r.tlsConfig.ServerName, r.tlsConfig.SkipTLSVerify, // Per RFC9103 tls.VersionTLS13, ) if err != nil { return nil, err } if tlsConfig.NextProtos == nil { // Per RFC9103 tlsConfig.NextProtos = []string{"dot"} } c.TLSConfig = tlsConfig } else { c.Net = "tcp" } return c, nil }