299 lines
10 KiB
Go
299 lines
10 KiB
Go
package home
|
|
|
|
import (
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/AdguardTeam/AdGuardHome/dhcpd"
|
|
"github.com/AdguardTeam/AdGuardHome/dnsfilter"
|
|
"github.com/AdguardTeam/AdGuardHome/dnsforward"
|
|
"github.com/AdguardTeam/AdGuardHome/querylog"
|
|
"github.com/AdguardTeam/AdGuardHome/stats"
|
|
"github.com/AdguardTeam/golibs/file"
|
|
"github.com/AdguardTeam/golibs/log"
|
|
yaml "gopkg.in/yaml.v2"
|
|
)
|
|
|
|
const (
|
|
dataDir = "data" // data storage
|
|
filterDir = "filters" // cache location for downloaded filters, it's under DataDir
|
|
)
|
|
|
|
// logSettings
|
|
type logSettings struct {
|
|
LogCompress bool `yaml:"log_compress"` // Compress determines if the rotated log files should be compressed using gzip (default: false)
|
|
LogLocalTime bool `yaml:"log_localtime"` // If the time used for formatting the timestamps in is the computer's local time (default: false [UTC])
|
|
LogMaxBackups int `yaml:"log_max_backups"` // Maximum number of old log files to retain (MaxAge may still cause them to get deleted)
|
|
LogMaxSize int `yaml:"log_max_size"` // Maximum size in megabytes of the log file before it gets rotated (default 100 MB)
|
|
LogMaxAge int `yaml:"log_max_age"` // MaxAge is the maximum number of days to retain old log files
|
|
LogFile string `yaml:"log_file"` // Path to the log file. If empty, write to stdout. If "syslog", writes to syslog
|
|
Verbose bool `yaml:"verbose"` // If true, verbose logging is enabled
|
|
}
|
|
|
|
// configuration is loaded from YAML
|
|
// field ordering is important -- yaml fields will mirror ordering from here
|
|
type configuration struct {
|
|
// Raw file data to avoid re-reading of configuration file
|
|
// It's reset after config is parsed
|
|
fileData []byte
|
|
|
|
// cached version.json to avoid hammering github.io for each page reload
|
|
versionCheckJSON []byte
|
|
versionCheckLastTime time.Time
|
|
|
|
BindHost string `yaml:"bind_host"` // BindHost is the IP address of the HTTP server to bind to
|
|
BindPort int `yaml:"bind_port"` // BindPort is the port the HTTP server
|
|
Users []User `yaml:"users"` // Users that can access HTTP server
|
|
ProxyURL string `yaml:"http_proxy"` // Proxy address for our HTTP client
|
|
Language string `yaml:"language"` // two-letter ISO 639-1 language code
|
|
RlimitNoFile uint `yaml:"rlimit_nofile"` // Maximum number of opened fd's per process (0: default)
|
|
DebugPProf bool `yaml:"debug_pprof"` // Enable pprof HTTP server on port 6060
|
|
|
|
// TTL for a web session (in hours)
|
|
// An active session is automatically refreshed once a day.
|
|
WebSessionTTLHours uint32 `yaml:"web_session_ttl"`
|
|
|
|
DNS dnsConfig `yaml:"dns"`
|
|
TLS tlsConfigSettings `yaml:"tls"`
|
|
|
|
Filters []filter `yaml:"filters"`
|
|
WhitelistFilters []filter `yaml:"whitelist_filters"`
|
|
UserRules []string `yaml:"user_rules"`
|
|
|
|
DHCP dhcpd.ServerConfig `yaml:"dhcp"`
|
|
|
|
// Note: this array is filled only before file read/write and then it's cleared
|
|
Clients []clientObject `yaml:"clients"`
|
|
|
|
logSettings `yaml:",inline"`
|
|
|
|
sync.RWMutex `yaml:"-"`
|
|
|
|
SchemaVersion int `yaml:"schema_version"` // keeping last so that users will be less tempted to change it -- used when upgrading between versions
|
|
}
|
|
|
|
// field ordering is important -- yaml fields will mirror ordering from here
|
|
type dnsConfig struct {
|
|
BindHost string `yaml:"bind_host"`
|
|
Port int `yaml:"port"`
|
|
|
|
// time interval for statistics (in days)
|
|
StatsInterval uint32 `yaml:"statistics_interval"`
|
|
|
|
QueryLogEnabled bool `yaml:"querylog_enabled"` // if true, query log is enabled
|
|
QueryLogFileEnabled bool `yaml:"querylog_file_enabled"` // if true, query log will be written to a file
|
|
QueryLogInterval uint32 `yaml:"querylog_interval"` // time interval for query log (in days)
|
|
QueryLogMemSize uint32 `yaml:"querylog_size_memory"` // number of entries kept in memory before they are flushed to disk
|
|
AnonymizeClientIP bool `yaml:"anonymize_client_ip"` // anonymize clients' IP addresses in logs and stats
|
|
|
|
dnsforward.FilteringConfig `yaml:",inline"`
|
|
|
|
FilteringEnabled bool `yaml:"filtering_enabled"` // whether or not use filter lists
|
|
FiltersUpdateIntervalHours uint32 `yaml:"filters_update_interval"` // time period to update filters (in hours)
|
|
DnsfilterConf dnsfilter.Config `yaml:",inline"`
|
|
}
|
|
|
|
type tlsConfigSettings struct {
|
|
Enabled bool `yaml:"enabled" json:"enabled"` // Enabled is the encryption (DOT/DOH/HTTPS) status
|
|
ServerName string `yaml:"server_name" json:"server_name,omitempty"` // ServerName is the hostname of your HTTPS/TLS server
|
|
ForceHTTPS bool `yaml:"force_https" json:"force_https,omitempty"` // ForceHTTPS: if true, forces HTTP->HTTPS redirect
|
|
PortHTTPS int `yaml:"port_https" json:"port_https,omitempty"` // HTTPS port. If 0, HTTPS will be disabled
|
|
PortDNSOverTLS int `yaml:"port_dns_over_tls" json:"port_dns_over_tls,omitempty"` // DNS-over-TLS port. If 0, DOT will be disabled
|
|
|
|
// Allow DOH queries via unencrypted HTTP (e.g. for reverse proxying)
|
|
AllowUnencryptedDOH bool `yaml:"allow_unencrypted_doh" json:"allow_unencrypted_doh"`
|
|
|
|
dnsforward.TLSConfig `yaml:",inline" json:",inline"`
|
|
}
|
|
|
|
// initialize to default values, will be changed later when reading config or parsing command line
|
|
var config = configuration{
|
|
BindPort: 3000,
|
|
BindHost: "0.0.0.0",
|
|
DNS: dnsConfig{
|
|
BindHost: "0.0.0.0",
|
|
Port: 53,
|
|
StatsInterval: 1,
|
|
FilteringConfig: dnsforward.FilteringConfig{
|
|
ProtectionEnabled: true, // whether or not use any of dnsfilter features
|
|
BlockingMode: "default", // mode how to answer filtered requests
|
|
BlockedResponseTTL: 10, // in seconds
|
|
Ratelimit: 20,
|
|
RefuseAny: true,
|
|
AllServers: false,
|
|
},
|
|
FilteringEnabled: true, // whether or not use filter lists
|
|
FiltersUpdateIntervalHours: 24,
|
|
},
|
|
TLS: tlsConfigSettings{
|
|
PortHTTPS: 443,
|
|
PortDNSOverTLS: 853, // needs to be passed through to dnsproxy
|
|
},
|
|
DHCP: dhcpd.ServerConfig{
|
|
LeaseDuration: 86400,
|
|
ICMPTimeout: 1000,
|
|
},
|
|
logSettings: logSettings{
|
|
LogCompress: false,
|
|
LogLocalTime: false,
|
|
LogMaxBackups: 0,
|
|
LogMaxSize: 100,
|
|
LogMaxAge: 0,
|
|
},
|
|
SchemaVersion: currentSchemaVersion,
|
|
}
|
|
|
|
// initConfig initializes default configuration for the current OS&ARCH
|
|
func initConfig() {
|
|
config.WebSessionTTLHours = 30 * 24
|
|
|
|
config.DNS.QueryLogEnabled = true
|
|
config.DNS.QueryLogFileEnabled = true
|
|
config.DNS.QueryLogInterval = 90
|
|
config.DNS.QueryLogMemSize = 1000
|
|
|
|
config.DNS.CacheSize = 4 * 1024 * 1024
|
|
config.DNS.DnsfilterConf.SafeBrowsingCacheSize = 1 * 1024 * 1024
|
|
config.DNS.DnsfilterConf.SafeSearchCacheSize = 1 * 1024 * 1024
|
|
config.DNS.DnsfilterConf.ParentalCacheSize = 1 * 1024 * 1024
|
|
config.DNS.DnsfilterConf.CacheTime = 30
|
|
config.Filters = defaultFilters()
|
|
}
|
|
|
|
// getConfigFilename returns path to the current config file
|
|
func (c *configuration) getConfigFilename() string {
|
|
configFile, err := filepath.EvalSymlinks(Context.configFilename)
|
|
if err != nil {
|
|
if !os.IsNotExist(err) {
|
|
log.Error("unexpected error while config file path evaluation: %s", err)
|
|
}
|
|
configFile = Context.configFilename
|
|
}
|
|
if !filepath.IsAbs(configFile) {
|
|
configFile = filepath.Join(Context.workDir, configFile)
|
|
}
|
|
return configFile
|
|
}
|
|
|
|
// getLogSettings reads logging settings from the config file.
|
|
// we do it in a separate method in order to configure logger before the actual configuration is parsed and applied.
|
|
func getLogSettings() logSettings {
|
|
l := logSettings{}
|
|
yamlFile, err := readConfigFile()
|
|
if err != nil {
|
|
return l
|
|
}
|
|
err = yaml.Unmarshal(yamlFile, &l)
|
|
if err != nil {
|
|
log.Error("Couldn't get logging settings from the configuration: %s", err)
|
|
}
|
|
return l
|
|
}
|
|
|
|
// parseConfig loads configuration from the YAML file
|
|
func parseConfig() error {
|
|
configFile := config.getConfigFilename()
|
|
log.Debug("Reading config file: %s", configFile)
|
|
yamlFile, err := readConfigFile()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
config.fileData = nil
|
|
err = yaml.Unmarshal(yamlFile, &config)
|
|
if err != nil {
|
|
log.Error("Couldn't parse config file: %s", err)
|
|
return err
|
|
}
|
|
|
|
if !checkFiltersUpdateIntervalHours(config.DNS.FiltersUpdateIntervalHours) {
|
|
config.DNS.FiltersUpdateIntervalHours = 24
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// readConfigFile reads config file contents if it exists
|
|
func readConfigFile() ([]byte, error) {
|
|
if len(config.fileData) != 0 {
|
|
return config.fileData, nil
|
|
}
|
|
|
|
configFile := config.getConfigFilename()
|
|
d, err := ioutil.ReadFile(configFile)
|
|
if err != nil {
|
|
log.Error("Couldn't read config file %s: %s", configFile, err)
|
|
return nil, err
|
|
}
|
|
return d, nil
|
|
}
|
|
|
|
// Saves configuration to the YAML file and also saves the user filter contents to a file
|
|
func (c *configuration) write() error {
|
|
c.Lock()
|
|
defer c.Unlock()
|
|
|
|
Context.clients.WriteDiskConfig(&config.Clients)
|
|
|
|
if Context.auth != nil {
|
|
config.Users = Context.auth.GetUsers()
|
|
}
|
|
if Context.tls != nil {
|
|
tlsConf := tlsConfigSettings{}
|
|
Context.tls.WriteDiskConfig(&tlsConf)
|
|
config.TLS = tlsConf
|
|
}
|
|
|
|
if Context.stats != nil {
|
|
sdc := stats.DiskConfig{}
|
|
Context.stats.WriteDiskConfig(&sdc)
|
|
config.DNS.StatsInterval = sdc.Interval
|
|
}
|
|
|
|
if Context.queryLog != nil {
|
|
dc := querylog.Config{}
|
|
Context.queryLog.WriteDiskConfig(&dc)
|
|
config.DNS.QueryLogEnabled = dc.Enabled
|
|
config.DNS.QueryLogFileEnabled = dc.FileEnabled
|
|
config.DNS.QueryLogInterval = dc.Interval
|
|
config.DNS.QueryLogMemSize = dc.MemSize
|
|
config.DNS.AnonymizeClientIP = dc.AnonymizeClientIP
|
|
}
|
|
|
|
if Context.dnsFilter != nil {
|
|
c := dnsfilter.Config{}
|
|
Context.dnsFilter.WriteDiskConfig(&c)
|
|
config.DNS.DnsfilterConf = c
|
|
}
|
|
|
|
if Context.dnsServer != nil {
|
|
c := dnsforward.FilteringConfig{}
|
|
Context.dnsServer.WriteDiskConfig(&c)
|
|
config.DNS.FilteringConfig = c
|
|
}
|
|
|
|
if Context.dhcpServer != nil {
|
|
c := dhcpd.ServerConfig{}
|
|
Context.dhcpServer.WriteDiskConfig(&c)
|
|
config.DHCP = c
|
|
}
|
|
|
|
configFile := config.getConfigFilename()
|
|
log.Debug("Writing YAML file: %s", configFile)
|
|
yamlText, err := yaml.Marshal(&config)
|
|
config.Clients = nil
|
|
if err != nil {
|
|
log.Error("Couldn't generate YAML file: %s", err)
|
|
return err
|
|
}
|
|
err = file.SafeWrite(configFile, yamlText)
|
|
if err != nil {
|
|
log.Error("Couldn't save YAML config: %s", err)
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|