all: imp naming

heyxkhoa · May 26, 2021 · 9a69183 · 9a69183
1 parent 771b7a3
commit 9a69183
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 47 deletions.
diff --git a/internal/dnsforward/http.go b/internal/dnsforward/http.go
@@ -28,21 +28,21 @@ type dnsConfig struct {
 	UpstreamsFile *string   `json:"upstream_dns_file"`
 	Bootstraps    *[]string `json:"bootstrap_dns"`
 
-	ProtectionEnabled   *bool     `json:"protection_enabled"`
-	RateLimit           *uint32   `json:"ratelimit"`
-	BlockingMode        *string   `json:"blocking_mode"`
-	BlockingIPv4        net.IP    `json:"blocking_ipv4"`
-	BlockingIPv6        net.IP    `json:"blocking_ipv6"`
-	EDNSCSEnabled       *bool     `json:"edns_cs_enabled"`
-	DNSSECEnabled       *bool     `json:"dnssec_enabled"`
-	DisableIPv6         *bool     `json:"disable_ipv6"`
-	UpstreamMode        *string   `json:"upstream_mode"`
-	CacheSize           *uint32   `json:"cache_size"`
-	CacheMinTTL         *uint32   `json:"cache_ttl_min"`
-	CacheMaxTTL         *uint32   `json:"cache_ttl_max"`
-	ResolveClients      *bool     `json:"resolve_clients"`
-	UsePrivateResolvers *bool     `json:"local_ips_rdns"`
-	LocalPTRUpstreams   *[]string `json:"local_ptr_upstreams"`
+	ProtectionEnabled *bool     `json:"protection_enabled"`
+	RateLimit         *uint32   `json:"ratelimit"`
+	BlockingMode      *string   `json:"blocking_mode"`
+	BlockingIPv4      net.IP    `json:"blocking_ipv4"`
+	BlockingIPv6      net.IP    `json:"blocking_ipv6"`
+	EDNSCSEnabled     *bool     `json:"edns_cs_enabled"`
+	DNSSECEnabled     *bool     `json:"dnssec_enabled"`
+	DisableIPv6       *bool     `json:"disable_ipv6"`
+	UpstreamMode      *string   `json:"upstream_mode"`
+	CacheSize         *uint32   `json:"cache_size"`
+	CacheMinTTL       *uint32   `json:"cache_ttl_min"`
+	CacheMaxTTL       *uint32   `json:"cache_ttl_max"`
+	ResolveClients    *bool     `json:"resolve_clients"`
+	LocalIPsRDNS      *bool     `json:"local_ips_rdns"`
+	LocalPTRUpstreams *[]string `json:"local_ptr_upstreams"`
 }
 
 func (s *Server) getDNSConfig() dnsConfig {
@@ -64,7 +64,7 @@ func (s *Server) getDNSConfig() dnsConfig {
 	cacheMinTTL := s.conf.CacheMinTTL
 	cacheMaxTTL := s.conf.CacheMaxTTL
 	resolveClients := s.conf.ResolveClients
-	usePrivateResolvers := s.conf.UsePrivateResolvers
+	localIPsRDNS := s.conf.UsePrivateResolvers
 	localPTRUpstreams := aghstrings.CloneSliceOrEmpty(s.conf.LocalPTRResolvers)
 	var upstreamMode string
 	if s.conf.FastestAddr {
@@ -74,24 +74,24 @@ func (s *Server) getDNSConfig() dnsConfig {
 	}
 
 	return dnsConfig{
-		Upstreams:           &upstreams,
-		UpstreamsFile:       &upstreamFile,
-		Bootstraps:          &bootstraps,
-		ProtectionEnabled:   &protectionEnabled,
-		BlockingMode:        &blockingMode,
-		BlockingIPv4:        blockingIPv4,
-		BlockingIPv6:        blockingIPv6,
-		RateLimit:           &ratelimit,
-		EDNSCSEnabled:       &enableEDNSClientSubnet,
-		DNSSECEnabled:       &enableDNSSEC,
-		DisableIPv6:         &aaaaDisabled,
-		CacheSize:           &cacheSize,
-		CacheMinTTL:         &cacheMinTTL,
-		CacheMaxTTL:         &cacheMaxTTL,
-		UpstreamMode:        &upstreamMode,
-		ResolveClients:      &resolveClients,
-		UsePrivateResolvers: &usePrivateResolvers,
-		LocalPTRUpstreams:   &localPTRUpstreams,
+		Upstreams:         &upstreams,
+		UpstreamsFile:     &upstreamFile,
+		Bootstraps:        &bootstraps,
+		ProtectionEnabled: &protectionEnabled,
+		BlockingMode:      &blockingMode,
+		BlockingIPv4:      blockingIPv4,
+		BlockingIPv6:      blockingIPv6,
+		RateLimit:         &ratelimit,
+		EDNSCSEnabled:     &enableEDNSClientSubnet,
+		DNSSECEnabled:     &enableDNSSEC,
+		DisableIPv6:       &aaaaDisabled,
+		CacheSize:         &cacheSize,
+		CacheMinTTL:       &cacheMinTTL,
+		CacheMaxTTL:       &cacheMaxTTL,
+		UpstreamMode:      &upstreamMode,
+		ResolveClients:    &resolveClients,
+		LocalIPsRDNS:      &localIPsRDNS,
+		LocalPTRUpstreams: &localPTRUpstreams,
 	}
 }
 
@@ -315,8 +315,8 @@ func (s *Server) setConfig(dc dnsConfig) (restart bool) {
 		s.conf.ResolveClients = *dc.ResolveClients
 	}
 
-	if dc.UsePrivateResolvers != nil {
-		s.conf.UsePrivateResolvers = *dc.UsePrivateResolvers
+	if dc.LocalIPsRDNS != nil {
+		s.conf.UsePrivateResolvers = *dc.LocalIPsRDNS
 	}
 
 	return s.setConfigRestartable(dc)

diff --git a/internal/home/config.go b/internal/home/config.go
@@ -108,10 +108,9 @@ type dnsConfig struct {
 	// ResolveClients enables and disables resolving clients with RDNS.
 	ResolveClients bool `yaml:"resolve_clients"`
 
-	// UsePrivateResolvers defines if the PTR requests for unknown addresses
-	// from locally-served networks should be resolved via private PTR
-	// resolvers.
-	UsePrivateResolvers bool `yaml:"use_private_ptr_resolvers"`
+	// UsePrivateRDNS defines if the PTR requests for unknown addresses from
+	// locally-served networks should be resolved via private PTR resolvers.
+	UsePrivateRDNS bool `yaml:"use_private_ptr_resolvers"`
 
 	// LocalPTRResolvers is the slice of addresses to be used as upstreams
 	// for PTR queries for locally-served networks.
@@ -171,7 +170,7 @@ var config = configuration{
 		FiltersUpdateIntervalHours: 24,
 		LocalDomainName:            "lan",
 		ResolveClients:             true,
-		UsePrivateResolvers:        true,
+		UsePrivateRDNS:             true,
 	},
 	TLS: tlsConfigSettings{
 		PortHTTPS:       443,
@@ -324,7 +323,7 @@ func (c *configuration) write() error {
 		dns.FilteringConfig = c
 		dns.LocalPTRResolvers,
 			dns.ResolveClients,
-			dns.UsePrivateResolvers = s.RDNSSettings()
+			dns.UsePrivateRDNS = s.RDNSSettings()
 	}
 
 	if Context.dhcpServer != nil {

diff --git a/internal/home/dns.go b/internal/home/dns.go
@@ -94,7 +94,7 @@ func initDNSServer() error {
 		return fmt.Errorf("dnsServer.Prepare: %w", err)
 	}
 
-	Context.rdns = NewRDNS(Context.dnsServer, &Context.clients, config.DNS.UsePrivateResolvers)
+	Context.rdns = NewRDNS(Context.dnsServer, &Context.clients, config.DNS.UsePrivateRDNS)
 	Context.whois = initWhois(&Context.clients)
 
 	Context.filters.Init()
@@ -200,7 +200,7 @@ func generateServerConfig() (newConf dnsforward.ServerConfig, err error) {
 	newConf.GetCustomUpstreamByClient = Context.clients.FindUpstreams
 
 	newConf.ResolveClients = dnsConf.ResolveClients
-	newConf.UsePrivateResolvers = dnsConf.UsePrivateResolvers
+	newConf.UsePrivateResolvers = 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 `"use_private_ptr_resolvers"` in DNS configuration
+### The field `"local_ips_rdns"` in DNS configuration
 
-* The new optional field  `"use_private_ptr_resolvers"` of `"DNSConfig"`
-  specifies if the DNS server should use `"local_ptr_upstreams"` at all.
+* The new optional field  `"local_ips_rdns"` of `"DNSConfig"` specifies if the
+  DNS server should use `"local_ptr_upstreams"` at all.
 
 ## v0.106: API changes