// DNS Rewrites package filtering import ( "encoding/json" "net" "net/http" "sort" "strings" "github.com/AdguardTeam/AdGuardHome/internal/aghhttp" "github.com/AdguardTeam/golibs/log" "github.com/miekg/dns" ) // RewriteEntry is a rewrite array element type RewriteEntry struct { // Domain is the domain for which this rewrite should work. Domain string `yaml:"domain"` // Answer is the IP address, canonical name, or one of the special // values: "A" or "AAAA". Answer string `yaml:"answer"` // IP is the IP address that should be used in the response if Type is // A or AAAA. IP net.IP `yaml:"-"` // Type is the DNS record type: A, AAAA, or CNAME. Type uint16 `yaml:"-"` } // equal returns true if the entry is considered equal to the other. func (e *RewriteEntry) equal(other RewriteEntry) (ok bool) { return e.Domain == other.Domain && e.Answer == other.Answer } // matchesQType returns true if the entry matched qtype. func (e *RewriteEntry) matchesQType(qtype uint16) (ok bool) { // Add CNAMEs, since they match for all types requests. if e.Type == dns.TypeCNAME { return true } // Reject types other than A and AAAA. if qtype != dns.TypeA && qtype != dns.TypeAAAA { return false } // If the types match or the entry is set to allow only the other type, // include them. return e.Type == qtype || e.IP == nil } // normalize makes sure that the a new or decoded entry is normalized with // regards to domain name case, IP length, and so on. func (e *RewriteEntry) normalize() { // TODO(a.garipov): Write a case-agnostic version of strings.HasSuffix // and use it in matchDomainWildcard instead of using strings.ToLower // everywhere. e.Domain = strings.ToLower(e.Domain) switch e.Answer { case "AAAA": e.IP = nil e.Type = dns.TypeAAAA return case "A": e.IP = nil e.Type = dns.TypeA return default: // Go on. } ip := net.ParseIP(e.Answer) if ip == nil { e.Type = dns.TypeCNAME return } ip4 := ip.To4() if ip4 != nil { e.IP = ip4 e.Type = dns.TypeA } else { e.IP = ip e.Type = dns.TypeAAAA } } func isWildcard(host string) bool { return len(host) > 1 && host[0] == '*' && host[1] == '.' } // matchDomainWildcard returns true if host matches the wildcard pattern. func matchDomainWildcard(host, wildcard string) (ok bool) { return isWildcard(wildcard) && strings.HasSuffix(host, wildcard[1:]) } // rewritesSorted is a slice of legacy rewrites for sorting. // // The sorting priority: // // A and AAAA > CNAME // wildcard > exact // lower level wildcard > higher level wildcard // type rewritesSorted []RewriteEntry // Len implements the sort.Interface interface for legacyRewritesSorted. func (a rewritesSorted) Len() int { return len(a) } // Swap implements the sort.Interface interface for legacyRewritesSorted. func (a rewritesSorted) Swap(i, j int) { a[i], a[j] = a[j], a[i] } // Less implements the sort.Interface interface for legacyRewritesSorted. func (a rewritesSorted) Less(i, j int) bool { if a[i].Type == dns.TypeCNAME && a[j].Type != dns.TypeCNAME { return true } else if a[i].Type != dns.TypeCNAME && a[j].Type == dns.TypeCNAME { return false } if isWildcard(a[i].Domain) { if !isWildcard(a[j].Domain) { return false } } else { if isWildcard(a[j].Domain) { return true } } // both are wildcards return len(a[i].Domain) > len(a[j].Domain) } func (d *DNSFilter) prepareRewrites() { for i := range d.Rewrites { d.Rewrites[i].normalize() } } // findRewrites returns the list of matched rewrite entries. If rewrites are // empty, but matched is true, the domain is found among the rewrite rules but // not for this question type. // // The result priority is: CNAME, then A and AAAA; exact, then wildcard. If the // host is matched exactly, wildcard entries aren't returned. If the host // matched by wildcards, return the most specific for the question type. func findRewrites( entries []RewriteEntry, host string, qtype uint16, ) (rewrites []RewriteEntry, matched bool) { for _, e := range entries { if e.Domain != host && !matchDomainWildcard(host, e.Domain) { continue } matched = true if e.matchesQType(qtype) { rewrites = append(rewrites, e) } } if len(rewrites) == 0 { return nil, matched } sort.Sort(rewritesSorted(rewrites)) for i, r := range rewrites { if isWildcard(r.Domain) { // Don't use rewrites[:0], because we need to return at least one // item here. rewrites = rewrites[:max(1, i)] break } } return rewrites, matched } func max(a, b int) int { if a > b { return a } return b } type rewriteEntryJSON struct { Domain string `json:"domain"` Answer string `json:"answer"` } func (d *DNSFilter) handleRewriteList(w http.ResponseWriter, r *http.Request) { arr := []*rewriteEntryJSON{} d.confLock.Lock() for _, ent := range d.Config.Rewrites { jsent := rewriteEntryJSON{ Domain: ent.Domain, Answer: ent.Answer, } arr = append(arr, &jsent) } d.confLock.Unlock() w.Header().Set("Content-Type", "application/json") err := json.NewEncoder(w).Encode(arr) if err != nil { aghhttp.Error(r, w, http.StatusInternalServerError, "json.Encode: %s", err) return } } func (d *DNSFilter) handleRewriteAdd(w http.ResponseWriter, r *http.Request) { jsent := rewriteEntryJSON{} err := json.NewDecoder(r.Body).Decode(&jsent) if err != nil { aghhttp.Error(r, w, http.StatusBadRequest, "json.Decode: %s", err) return } ent := RewriteEntry{ Domain: jsent.Domain, Answer: jsent.Answer, } ent.normalize() d.confLock.Lock() d.Config.Rewrites = append(d.Config.Rewrites, ent) d.confLock.Unlock() log.Debug("rewrite: added element: %s -> %s [%d]", ent.Domain, ent.Answer, len(d.Config.Rewrites)) d.Config.ConfigModified() } func (d *DNSFilter) handleRewriteDelete(w http.ResponseWriter, r *http.Request) { jsent := rewriteEntryJSON{} err := json.NewDecoder(r.Body).Decode(&jsent) if err != nil { aghhttp.Error(r, w, http.StatusBadRequest, "json.Decode: %s", err) return } entDel := RewriteEntry{ Domain: jsent.Domain, Answer: jsent.Answer, } arr := []RewriteEntry{} d.confLock.Lock() for _, ent := range d.Config.Rewrites { if ent.equal(entDel) { log.Debug("rewrite: removed element: %s -> %s", ent.Domain, ent.Answer) continue } arr = append(arr, ent) } d.Config.Rewrites = arr d.confLock.Unlock() d.Config.ConfigModified() } func (d *DNSFilter) registerRewritesHandlers() { d.Config.HTTPRegister(http.MethodGet, "/control/rewrite/list", d.handleRewriteList) d.Config.HTTPRegister(http.MethodPost, "/control/rewrite/add", d.handleRewriteAdd) d.Config.HTTPRegister(http.MethodPost, "/control/rewrite/delete", d.handleRewriteDelete) }