all: rename dns config field

heyxkhoa · May 26, 2021 · b78ac2e · b78ac2e
1 parent 3651213
commit b78ac2e
Show file tree

Hide file tree

Showing 15 changed files with 52 additions and 49 deletions.
diff --git a/client/src/__locales/en.json b/client/src/__locales/en.json
@@ -13,8 +13,8 @@
     "local_ptr_placeholder": "Enter one server address per line",
     "resolve_clients_title": "Enable reverse resolving of clients' IP addresses",
     "resolve_clients_desc": "If enabled, AdGuard Home will attempt to reversely resolve clients' IP addresses into their hostnames by sending PTR queries to corresponding resolvers (private DNS servers for local clients, upstream server for clients with public IP addresses).",
-    "local_ips_rdns_title": "Use private rDNS resolvers",
-    "local_ips_rdns_desc": "Perform reverse DNS lookups for locally-served addresses using these upstream servers. If disabled, AdGuard Home responds with NXDOMAIN to all such PTR requests except for clients known from DHCP, /etc/hosts, and so on.",
+    "use_private_ptr_resolvers_title": "Use private rDNS resolvers",
+    "use_private_ptr_resolvers_desc": "Perform reverse DNS lookups for locally-served addresses using these upstream servers. If disabled, AdGuard Home responds with NXDOMAIN to all such PTR requests except for clients known from DHCP, /etc/hosts, and so on.",
     "check_dhcp_servers": "Check for DHCP servers",
     "save_config": "Save configuration",
     "enabled_dhcp": "DHCP server enabled",

diff --git a/client/src/components/Settings/Dns/Upstream/Form.js b/client/src/components/Settings/Dns/Upstream/Form.js
@@ -224,11 +224,11 @@ const Form = ({
                 />
                 <div className="mt-4">
                     <Field
-                        name="local_ips_rdns"
+                        name="use_private_ptr_resolvers"
                         type="checkbox"
                         component={CheckboxField}
-                        placeholder={t('local_ips_rdns_title')}
-                        subtitle={t('local_ips_rdns_desc')}
+                        placeholder={t('use_private_ptr_resolvers_title')}
+                        subtitle={t('use_private_ptr_resolvers_desc')}
                         disabled={processingSetConfig}
                     />
                 </div>

diff --git a/client/src/components/Settings/Dns/Upstream/index.js b/client/src/components/Settings/Dns/Upstream/index.js
@@ -14,7 +14,7 @@ const Upstream = () => {
         upstream_mode,
         resolve_clients,
         local_ptr_upstreams,
-        local_ips_rdns,
+        use_private_ptr_resolvers,
     } = useSelector((state) => state.dnsConfig, shallowEqual);
 
     const upstream_dns_file = useSelector((state) => state.dnsConfig.upstream_dns_file);
@@ -26,15 +26,15 @@ const Upstream = () => {
             upstream_mode,
             resolve_clients,
             local_ptr_upstreams,
-            local_ips_rdns,
+            use_private_ptr_resolvers,
         } = values;
 
         const dnsConfig = {
             bootstrap_dns,
             upstream_mode,
             resolve_clients,
             local_ptr_upstreams,
-            local_ips_rdns,
+            use_private_ptr_resolvers,
             ...(upstream_dns_file ? null : { upstream_dns }),
         };
 
@@ -56,7 +56,7 @@ const Upstream = () => {
                         upstream_mode,
                         resolve_clients,
                         local_ptr_upstreams,
-                        local_ips_rdns,
+                        use_private_ptr_resolvers,
                     }}
                     onSubmit={handleSubmit}
                 />

diff --git a/internal/dnsforward/config.go b/internal/dnsforward/config.go
@@ -153,9 +153,9 @@ type ServerConfig struct {
 	// ResolveClients signals if the RDNS should resolve clients' addresses.
 	ResolveClients bool
 
-	// UsePrivateResolvers defines if the PTR requests for addresses from
-	// locally-served networks should be handled.
-	UsePrivateResolvers bool
+	// UsePrivateRDNS defines if the PTR requests for unknown addresses from
+	// locally-served networks should be resolved via private PTR resolvers.
+	UsePrivateRDNS bool
 
 	// LocalPTRResolvers is a slice of addresses to be used as upstreams for
 	// resolving PTR queries for local addresses.

diff --git a/internal/dnsforward/dns.go b/internal/dnsforward/dns.go
@@ -421,7 +421,7 @@ func (s *Server) processLocalPTR(ctx *dnsContext) (rc resultCode) {
 		return resultCodeSuccess
 	}
 
-	if s.conf.UsePrivateResolvers {
+	if s.conf.UsePrivateRDNS {
 		if err := s.localResolvers.Resolve(d); err != nil {
 			ctx.err = err
 
@@ -432,6 +432,7 @@ func (s *Server) processLocalPTR(ctx *dnsContext) (rc resultCode) {
 	if d.Res == nil {
 		d.Res = s.genNXDomain(d.Req)
 
+		// Do not even put into query log.
 		return resultCodeFinish
 	}
 

diff --git a/internal/dnsforward/dns_test.go b/internal/dnsforward/dns_test.go
@@ -358,7 +358,7 @@ func TestServer_ProcessLocalPTR_usingResolvers(t *testing.T) {
 			proxyCtx:        proxyCtx,
 			unreversedReqIP: net.IP{192, 168, 1, 1},
 		}
-		s.conf.UsePrivateResolvers = use
+		s.conf.UsePrivateRDNS = use
 	}
 
 	t.Run("enabled", func(t *testing.T) {

diff --git a/internal/dnsforward/dnsforward.go b/internal/dnsforward/dnsforward.go
@@ -210,7 +210,7 @@ func (s *Server) RDNSSettings() (localPTRResolvers []string, resolveClients, res
 
 	return aghstrings.CloneSlice(s.conf.LocalPTRResolvers),
 		s.conf.ResolveClients,
-		s.conf.UsePrivateResolvers
+		s.conf.UsePrivateRDNS
 }
 
 // Resolve - get IP addresses by host name from an upstream server.
@@ -256,7 +256,7 @@ func (s *Server) Exchange(ip net.IP) (host string, err error) {
 	var resolver *proxy.Proxy = s.localResolvers
 	if !s.subnetDetector.IsLocallyServedNetwork(ip) {
 		resolver = s.internalProxy
-	} else if !s.conf.UsePrivateResolvers {
+	} else if !s.conf.UsePrivateRDNS {
 		return "", nil
 	}
 
@@ -303,7 +303,7 @@ func (s *Server) ResolvesPrivatePTR() (ok bool) {
 	s.serverLock.RLock()
 	defer s.serverLock.RUnlock()
 
-	return s.conf.UsePrivateResolvers
+	return s.conf.UsePrivateRDNS
 }
 
 // Start starts the DNS server.

diff --git a/internal/dnsforward/dnsforward_test.go b/internal/dnsforward/dnsforward_test.go
@@ -91,7 +91,7 @@ func createTestServer(
 
 	if localUps != nil {
 		s.localResolvers.Config.UpstreamConfig.Upstreams = []upstream.Upstream{localUps}
-		s.conf.UsePrivateResolvers = true
+		s.conf.UsePrivateRDNS = true
 	}
 
 	return s
@@ -1216,7 +1216,7 @@ func TestServer_Exchange(t *testing.T) {
 		},
 	})
 	srv.conf.ResolveClients = true
-	srv.conf.UsePrivateResolvers = true
+	srv.conf.UsePrivateRDNS = true
 
 	var err error
 	srv.subnetDetector, err = aghnet.NewSubnetDetector()
@@ -1280,7 +1280,7 @@ func TestServer_Exchange(t *testing.T) {
 	}
 
 	t.Run("resolving_disabled", func(t *testing.T) {
-		srv.conf.UsePrivateResolvers = false
+		srv.conf.UsePrivateRDNS = false
 
 		host, eerr := srv.Exchange(localIP)
 

diff --git a/internal/dnsforward/http.go b/internal/dnsforward/http.go
@@ -41,7 +41,7 @@ type dnsConfig struct {
 	CacheMinTTL       *uint32   `json:"cache_ttl_min"`
 	CacheMaxTTL       *uint32   `json:"cache_ttl_max"`
 	ResolveClients    *bool     `json:"resolve_clients"`
-	LocalIPsRDNS      *bool     `json:"local_ips_rdns"`
+	UsePrivateRDNS    *bool     `json:"use_private_ptr_resolvers"`
 	LocalPTRUpstreams *[]string `json:"local_ptr_upstreams"`
 }
 
@@ -64,7 +64,7 @@ func (s *Server) getDNSConfig() dnsConfig {
 	cacheMinTTL := s.conf.CacheMinTTL
 	cacheMaxTTL := s.conf.CacheMaxTTL
 	resolveClients := s.conf.ResolveClients
-	localIPsRDNS := s.conf.UsePrivateResolvers
+	usePrivateRDNS := s.conf.UsePrivateRDNS
 	localPTRUpstreams := aghstrings.CloneSliceOrEmpty(s.conf.LocalPTRResolvers)
 	var upstreamMode string
 	if s.conf.FastestAddr {
@@ -90,7 +90,7 @@ func (s *Server) getDNSConfig() dnsConfig {
 		CacheMaxTTL:       &cacheMaxTTL,
 		UpstreamMode:      &upstreamMode,
 		ResolveClients:    &resolveClients,
-		LocalIPsRDNS:      &localIPsRDNS,
+		UsePrivateRDNS:    &usePrivateRDNS,
 		LocalPTRUpstreams: &localPTRUpstreams,
 	}
 }
@@ -315,8 +315,8 @@ func (s *Server) setConfig(dc dnsConfig) (restart bool) {
 		s.conf.ResolveClients = *dc.ResolveClients
 	}
 
-	if dc.LocalIPsRDNS != nil {
-		s.conf.UsePrivateResolvers = *dc.LocalIPsRDNS
+	if dc.UsePrivateRDNS != nil {
+		s.conf.UsePrivateRDNS = *dc.UsePrivateRDNS
 	}
 
 	return s.setConfigRestartable(dc)

diff --git a/internal/dnsforward/testdata/TestDNSForwardHTTTP_handleGetConfig.json b/internal/dnsforward/testdata/TestDNSForwardHTTTP_handleGetConfig.json
@@ -24,7 +24,7 @@
     "cache_ttl_min": 0,
     "cache_ttl_max": 0,
     "resolve_clients": false,
-    "local_ips_rdns": false,
+    "use_private_ptr_resolvers": false,
     "local_ptr_upstreams": []
   },
   "fastest_addr": {
@@ -52,7 +52,7 @@
     "cache_ttl_min": 0,
     "cache_ttl_max": 0,
     "resolve_clients": false,
-    "local_ips_rdns": false,
+    "use_private_ptr_resolvers": false,
     "local_ptr_upstreams": []
   },
   "parallel": {
@@ -80,7 +80,7 @@
     "cache_ttl_min": 0,
     "cache_ttl_max": 0,
     "resolve_clients": false,
-    "local_ips_rdns": false,
+    "use_private_ptr_resolvers": false,
     "local_ptr_upstreams": []
   }
 }
diff --git a/internal/dnsforward/testdata/TestDNSForwardHTTTP_handleSetConfig.json b/internal/dnsforward/testdata/TestDNSForwardHTTTP_handleSetConfig.json
@@ -31,7 +31,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -63,7 +63,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -96,7 +96,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -129,7 +129,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -162,7 +162,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -195,7 +195,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -228,7 +228,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -261,7 +261,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -294,7 +294,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -327,7 +327,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -362,7 +362,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -397,7 +397,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -431,7 +431,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -464,7 +464,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   },
@@ -499,7 +499,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": [
         "123.123.123.123"
       ]
@@ -534,7 +534,7 @@
       "cache_ttl_min": 0,
       "cache_ttl_max": 0,
       "resolve_clients": false,
-      "local_ips_rdns": false,
+      "use_private_ptr_resolvers": false,
       "local_ptr_upstreams": []
     }
   }

diff --git a/internal/home/clients.go b/internal/home/clients.go
@@ -53,6 +53,8 @@ type Client struct {
 type clientSource uint
 
 // Client sources.  The order determines the priority.
+//
+// TODO(e.burkov): Is ARP a higher priority source than DHCP?
 const (
 	ClientSourceWHOIS clientSource = iota
 	ClientSourceRDNS

diff --git a/internal/home/dns.go b/internal/home/dns.go
@@ -200,7 +200,7 @@ func generateServerConfig() (newConf dnsforward.ServerConfig, err error) {
 	newConf.GetCustomUpstreamByClient = Context.clients.FindUpstreams
 
 	newConf.ResolveClients = dnsConf.ResolveClients
-	newConf.UsePrivateResolvers = dnsConf.UsePrivateRDNS
+	newConf.UsePrivateRDNS = dnsConf.UsePrivateRDNS
 	newConf.LocalPTRResolvers = dnsConf.LocalPTRResolvers
 
 	return newConf, nil

diff --git a/openapi/CHANGELOG.md b/openapi/CHANGELOG.md
@@ -4,10 +4,10 @@
 
 ## v0.107: API changes
 
-### The field `"local_ips_rdns"` in DNS configuration
+### The field `"use_private_ptr_resolvers"` in DNS configuration
 
-* The new optional field  `"local_ips_rdns"` of `"DNSConfig"` specifies if the
-  DNS server should use `"local_ptr_upstreams"` at all.
+* The new optional field  `"use_private_ptr_resolvers"` of `"DNSConfig"`
+  specifies if the DNS server should use `"local_ptr_upstreams"` at all.
 
 ## v0.106: API changes