2018-08-30 14:25:33 +00:00
|
|
|
package main
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
2018-10-29 23:17:24 +00:00
|
|
|
"gopkg.in/yaml.v2"
|
2018-08-30 14:25:33 +00:00
|
|
|
"io/ioutil"
|
|
|
|
"log"
|
|
|
|
"os"
|
|
|
|
"path/filepath"
|
|
|
|
"regexp"
|
|
|
|
"sync"
|
|
|
|
"text/template"
|
|
|
|
"time"
|
|
|
|
)
|
|
|
|
|
2018-10-29 23:17:24 +00:00
|
|
|
// Current schema version. We compare it with the value from
|
|
|
|
// the configuration file and perform necessary upgrade operations if needed
|
|
|
|
const SchemaVersion = 1
|
|
|
|
|
|
|
|
// Directory where we'll store all downloaded filters contents
|
|
|
|
const FiltersDir = "filters"
|
|
|
|
|
2018-10-30 09:24:59 +00:00
|
|
|
// Just a counter that we use for incrementing the filter ID
|
|
|
|
var NextFilterId int
|
|
|
|
|
2018-08-30 14:25:33 +00:00
|
|
|
// configuration is loaded from YAML
|
|
|
|
type configuration struct {
|
2018-10-30 09:24:59 +00:00
|
|
|
// Config filename (can be overriden via the command line arguments)
|
2018-08-30 14:25:33 +00:00
|
|
|
ourConfigFilename string
|
2018-10-30 09:24:59 +00:00
|
|
|
// Basically, this is our working directory
|
|
|
|
ourBinaryDir string
|
2018-10-29 23:17:24 +00:00
|
|
|
// Directory to store data (i.e. filters contents)
|
|
|
|
ourDataDir string
|
2018-08-30 14:25:33 +00:00
|
|
|
|
2018-10-29 23:17:24 +00:00
|
|
|
// Schema version of the config file. This value is used when performing the app updates.
|
|
|
|
SchemaVersion int `yaml:"schema_version"`
|
|
|
|
BindHost string `yaml:"bind_host"`
|
|
|
|
BindPort int `yaml:"bind_port"`
|
|
|
|
AuthName string `yaml:"auth_name"`
|
|
|
|
AuthPass string `yaml:"auth_pass"`
|
|
|
|
CoreDNS coreDNSConfig `yaml:"coredns"`
|
|
|
|
Filters []filter `yaml:"filters"`
|
|
|
|
UserRules []string `yaml:"user_rules"`
|
2018-08-30 14:25:33 +00:00
|
|
|
|
2018-10-06 21:58:59 +00:00
|
|
|
sync.RWMutex `yaml:"-"`
|
2018-08-30 14:25:33 +00:00
|
|
|
}
|
|
|
|
|
2018-10-29 23:17:24 +00:00
|
|
|
type coreDnsFilter struct {
|
|
|
|
ID int `yaml:"-"`
|
|
|
|
Path string `yaml:"-"`
|
|
|
|
}
|
|
|
|
|
2018-08-30 14:25:33 +00:00
|
|
|
type coreDNSConfig struct {
|
|
|
|
binaryFile string
|
|
|
|
coreFile string
|
2018-10-29 23:17:24 +00:00
|
|
|
Filters []coreDnsFilter `yaml:"-"`
|
|
|
|
Port int `yaml:"port"`
|
|
|
|
ProtectionEnabled bool `yaml:"protection_enabled"`
|
|
|
|
FilteringEnabled bool `yaml:"filtering_enabled"`
|
|
|
|
SafeBrowsingEnabled bool `yaml:"safebrowsing_enabled"`
|
|
|
|
SafeSearchEnabled bool `yaml:"safesearch_enabled"`
|
|
|
|
ParentalEnabled bool `yaml:"parental_enabled"`
|
|
|
|
ParentalSensitivity int `yaml:"parental_sensitivity"`
|
|
|
|
BlockedResponseTTL int `yaml:"blocked_response_ttl"`
|
|
|
|
QueryLogEnabled bool `yaml:"querylog_enabled"`
|
|
|
|
Pprof string `yaml:"-"`
|
|
|
|
Cache string `yaml:"-"`
|
|
|
|
Prometheus string `yaml:"-"`
|
|
|
|
UpstreamDNS []string `yaml:"upstream_dns"`
|
2018-08-30 14:25:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
type filter struct {
|
2018-10-30 09:24:59 +00:00
|
|
|
ID int `json:"id" yaml:"id"` // auto-assigned when filter is added (see NextFilterId)
|
2018-08-30 14:25:33 +00:00
|
|
|
URL string `json:"url"`
|
2018-10-10 16:49:18 +00:00
|
|
|
Name string `json:"name" yaml:"name"`
|
2018-09-19 12:51:44 +00:00
|
|
|
Enabled bool `json:"enabled"`
|
2018-10-30 09:24:59 +00:00
|
|
|
RulesCount int `json:"rulesCount" yaml:"-"`
|
2018-08-30 14:25:33 +00:00
|
|
|
contents []byte
|
2018-10-30 09:24:59 +00:00
|
|
|
LastUpdated time.Time `json:"lastUpdated" yaml:"last_updated"`
|
2018-08-30 14:25:33 +00:00
|
|
|
}
|
|
|
|
|
2018-09-26 14:47:23 +00:00
|
|
|
var defaultDNS = []string{"tls://1.1.1.1", "tls://1.0.0.1"}
|
2018-08-30 14:25:33 +00:00
|
|
|
|
|
|
|
// initialize to default values, will be changed later when reading config or parsing command line
|
|
|
|
var config = configuration{
|
2018-10-15 13:02:19 +00:00
|
|
|
ourConfigFilename: "AdGuardHome.yaml",
|
2018-10-29 23:17:24 +00:00
|
|
|
ourDataDir: "data",
|
2018-08-30 14:25:33 +00:00
|
|
|
BindPort: 3000,
|
|
|
|
BindHost: "127.0.0.1",
|
|
|
|
CoreDNS: coreDNSConfig{
|
|
|
|
Port: 53,
|
2018-10-29 23:17:24 +00:00
|
|
|
binaryFile: "coredns", // only filename, no path
|
|
|
|
coreFile: "Corefile", // only filename, no path
|
2018-10-10 17:13:03 +00:00
|
|
|
ProtectionEnabled: true,
|
2018-08-30 14:25:33 +00:00
|
|
|
FilteringEnabled: true,
|
2018-09-26 15:41:45 +00:00
|
|
|
SafeBrowsingEnabled: false,
|
2018-10-11 10:24:06 +00:00
|
|
|
BlockedResponseTTL: 10, // in seconds
|
2018-08-30 14:25:33 +00:00
|
|
|
QueryLogEnabled: true,
|
|
|
|
UpstreamDNS: defaultDNS,
|
|
|
|
Cache: "cache",
|
|
|
|
Prometheus: "prometheus :9153",
|
|
|
|
},
|
|
|
|
Filters: []filter{
|
2018-10-29 23:17:24 +00:00
|
|
|
{ID: 1, Enabled: true, URL: "https://adguardteam.github.io/AdGuardSDNSFilter/Filters/filter.txt", Name: "AdGuard Simplified Domain Names filter"},
|
|
|
|
{ID: 2, Enabled: false, URL: "https://adaway.org/hosts.txt", Name: "AdAway"},
|
|
|
|
{ID: 3, Enabled: false, URL: "https://hosts-file.net/ad_servers.txt", Name: "hpHosts - Ad and Tracking servers only"},
|
|
|
|
{ID: 4, Enabled: false, URL: "http://www.malwaredomainlist.com/hostslist/hosts.txt", Name: "MalwareDomainList.com Hosts List"},
|
2018-08-30 14:25:33 +00:00
|
|
|
},
|
|
|
|
}
|
|
|
|
|
2018-10-29 23:17:24 +00:00
|
|
|
// Creates a helper object for working with the user rules
|
|
|
|
func getUserFilter() filter {
|
|
|
|
|
|
|
|
// TODO: This should be calculated when UserRules are set
|
2018-10-30 09:24:59 +00:00
|
|
|
var contents []byte
|
2018-10-29 23:17:24 +00:00
|
|
|
for _, rule := range config.UserRules {
|
|
|
|
contents = append(contents, []byte(rule)...)
|
|
|
|
contents = append(contents, '\n')
|
|
|
|
}
|
|
|
|
|
|
|
|
userFilter := filter{
|
|
|
|
// User filter always has ID=0
|
|
|
|
ID: 0,
|
|
|
|
contents: contents,
|
|
|
|
Enabled: true,
|
|
|
|
}
|
|
|
|
|
|
|
|
return userFilter
|
|
|
|
}
|
|
|
|
|
2018-10-30 09:24:59 +00:00
|
|
|
// Loads configuration from the YAML file
|
2018-08-30 14:25:33 +00:00
|
|
|
func parseConfig() error {
|
2018-10-30 09:24:59 +00:00
|
|
|
configFile := filepath.Join(config.ourBinaryDir, config.ourConfigFilename)
|
|
|
|
log.Printf("Reading YAML file: %s", configFile)
|
|
|
|
if _, err := os.Stat(configFile); os.IsNotExist(err) {
|
2018-08-30 14:25:33 +00:00
|
|
|
// do nothing, file doesn't exist
|
2018-10-30 09:24:59 +00:00
|
|
|
log.Printf("YAML file doesn't exist, skipping: %s", configFile)
|
2018-08-30 14:25:33 +00:00
|
|
|
return nil
|
|
|
|
}
|
2018-10-30 09:24:59 +00:00
|
|
|
yamlFile, err := ioutil.ReadFile(configFile)
|
2018-08-30 14:25:33 +00:00
|
|
|
if err != nil {
|
|
|
|
log.Printf("Couldn't read config file: %s", err)
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
err = yaml.Unmarshal(yamlFile, &config)
|
|
|
|
if err != nil {
|
|
|
|
log.Printf("Couldn't parse config file: %s", err)
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-10-30 09:24:59 +00:00
|
|
|
// Deduplicate filters
|
|
|
|
{
|
|
|
|
i := 0 // output index, used for deletion later
|
|
|
|
urls := map[string]bool{}
|
|
|
|
for _, filter := range config.Filters {
|
|
|
|
if _, ok := urls[filter.URL]; !ok {
|
|
|
|
// we didn't see it before, keep it
|
|
|
|
urls[filter.URL] = true // remember the URL
|
|
|
|
config.Filters[i] = filter
|
|
|
|
i++
|
|
|
|
}
|
|
|
|
}
|
|
|
|
// all entries we want to keep are at front, delete the rest
|
|
|
|
config.Filters = config.Filters[:i]
|
|
|
|
}
|
|
|
|
|
|
|
|
// Set the next filter ID to max(filter.ID) + 1
|
|
|
|
for i := range config.Filters {
|
|
|
|
if NextFilterId < config.Filters[i].ID {
|
|
|
|
NextFilterId = config.Filters[i].ID + 1
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-08-30 14:25:33 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-10-30 09:24:59 +00:00
|
|
|
// Saves configuration to the YAML file and also saves the user filter contents to a file
|
2018-08-30 14:25:33 +00:00
|
|
|
func writeConfig() error {
|
2018-10-30 09:24:59 +00:00
|
|
|
configFile := filepath.Join(config.ourBinaryDir, config.ourConfigFilename)
|
|
|
|
log.Printf("Writing YAML file: %s", configFile)
|
2018-08-30 14:25:33 +00:00
|
|
|
yamlText, err := yaml.Marshal(&config)
|
|
|
|
if err != nil {
|
|
|
|
log.Printf("Couldn't generate YAML file: %s", err)
|
|
|
|
return err
|
|
|
|
}
|
2018-10-30 09:24:59 +00:00
|
|
|
err = writeFileSafe(configFile, yamlText)
|
2018-08-30 14:25:33 +00:00
|
|
|
if err != nil {
|
2018-10-29 23:17:24 +00:00
|
|
|
log.Printf("Couldn't save YAML config: %s", err)
|
2018-08-30 14:25:33 +00:00
|
|
|
return err
|
|
|
|
}
|
2018-10-29 23:17:24 +00:00
|
|
|
|
|
|
|
userFilter := getUserFilter()
|
|
|
|
err = userFilter.save()
|
2018-09-05 23:03:03 +00:00
|
|
|
if err != nil {
|
2018-10-29 23:17:24 +00:00
|
|
|
log.Printf("Couldn't save the user filter: %s", err)
|
2018-09-05 23:03:03 +00:00
|
|
|
return err
|
|
|
|
}
|
2018-10-29 23:17:24 +00:00
|
|
|
|
2018-08-30 14:25:33 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// --------------
|
|
|
|
// coredns config
|
|
|
|
// --------------
|
|
|
|
func writeCoreDNSConfig() error {
|
2018-10-30 09:24:59 +00:00
|
|
|
coreFile := filepath.Join(config.ourBinaryDir, config.CoreDNS.coreFile)
|
|
|
|
log.Printf("Writing DNS config: %s", coreFile)
|
|
|
|
configText, err := generateCoreDNSConfigText()
|
2018-08-30 14:25:33 +00:00
|
|
|
if err != nil {
|
|
|
|
log.Printf("Couldn't generate DNS config: %s", err)
|
|
|
|
return err
|
|
|
|
}
|
2018-10-30 09:24:59 +00:00
|
|
|
err = writeFileSafe(coreFile, []byte(configText))
|
2018-08-30 14:25:33 +00:00
|
|
|
if err != nil {
|
2018-10-29 23:17:24 +00:00
|
|
|
log.Printf("Couldn't save DNS config: %s", err)
|
|
|
|
return err
|
2018-09-05 23:03:03 +00:00
|
|
|
}
|
2018-10-29 23:17:24 +00:00
|
|
|
return nil
|
2018-08-30 14:25:33 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func writeAllConfigs() error {
|
|
|
|
err := writeConfig()
|
|
|
|
if err != nil {
|
|
|
|
log.Printf("Couldn't write our config: %s", err)
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
err = writeCoreDNSConfig()
|
|
|
|
if err != nil {
|
|
|
|
log.Printf("Couldn't write DNS config: %s", err)
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2018-10-11 17:52:23 +00:00
|
|
|
const coreDNSConfigTemplate = `.:{{.Port}} {
|
2018-10-29 23:17:24 +00:00
|
|
|
{{if .ProtectionEnabled}}dnsfilter {
|
2018-08-30 14:25:33 +00:00
|
|
|
{{if .SafeBrowsingEnabled}}safebrowsing{{end}}
|
|
|
|
{{if .ParentalEnabled}}parental {{.ParentalSensitivity}}{{end}}
|
|
|
|
{{if .SafeSearchEnabled}}safesearch{{end}}
|
|
|
|
{{if .QueryLogEnabled}}querylog{{end}}
|
2018-09-26 15:29:05 +00:00
|
|
|
blocked_ttl {{.BlockedResponseTTL}}
|
2018-10-29 23:17:24 +00:00
|
|
|
{{if .FilteringEnabled}}
|
|
|
|
{{range .Filters}}
|
|
|
|
filter {{.ID}} "{{.Path}}"
|
|
|
|
{{end}}
|
|
|
|
{{end}}
|
2018-10-10 17:13:03 +00:00
|
|
|
}{{end}}
|
2018-08-30 14:25:33 +00:00
|
|
|
{{.Pprof}}
|
2018-09-25 16:26:26 +00:00
|
|
|
hosts {
|
|
|
|
fallthrough
|
|
|
|
}
|
2018-08-30 14:25:33 +00:00
|
|
|
{{if .UpstreamDNS}}forward . {{range .UpstreamDNS}}{{.}} {{end}}{{end}}
|
|
|
|
{{.Cache}}
|
|
|
|
{{.Prometheus}}
|
|
|
|
}
|
|
|
|
`
|
|
|
|
|
|
|
|
var removeEmptyLines = regexp.MustCompile("([\t ]*\n)+")
|
|
|
|
|
2018-10-30 09:24:59 +00:00
|
|
|
// generate CoreDNS config text
|
2018-08-30 14:25:33 +00:00
|
|
|
func generateCoreDNSConfigText() (string, error) {
|
|
|
|
t, err := template.New("config").Parse(coreDNSConfigTemplate)
|
|
|
|
if err != nil {
|
|
|
|
log.Printf("Couldn't generate DNS config: %s", err)
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
|
|
|
|
var configBytes bytes.Buffer
|
2018-10-17 17:43:26 +00:00
|
|
|
temporaryConfig := config.CoreDNS
|
2018-10-29 23:17:24 +00:00
|
|
|
|
|
|
|
// fill the list of filters
|
|
|
|
filters := make([]coreDnsFilter, 0)
|
|
|
|
|
|
|
|
// first of all, append the user filter
|
|
|
|
userFilter := getUserFilter()
|
|
|
|
|
2018-10-30 08:01:09 +00:00
|
|
|
if len(userFilter.contents) > 0 {
|
|
|
|
filters = append(filters, coreDnsFilter{ID: userFilter.ID, Path: userFilter.getFilterFilePath()})
|
|
|
|
}
|
2018-10-29 23:17:24 +00:00
|
|
|
|
|
|
|
// then go through other filters
|
|
|
|
for i := range config.Filters {
|
|
|
|
filter := &config.Filters[i]
|
|
|
|
|
|
|
|
if filter.Enabled && len(filter.contents) > 0 {
|
|
|
|
filters = append(filters, coreDnsFilter{ID: filter.ID, Path: filter.getFilterFilePath()})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
temporaryConfig.Filters = filters
|
|
|
|
|
2018-08-30 14:25:33 +00:00
|
|
|
// run the template
|
2018-10-17 17:43:26 +00:00
|
|
|
err = t.Execute(&configBytes, &temporaryConfig)
|
2018-08-30 14:25:33 +00:00
|
|
|
if err != nil {
|
|
|
|
log.Printf("Couldn't generate DNS config: %s", err)
|
|
|
|
return "", err
|
|
|
|
}
|
2018-10-30 09:24:59 +00:00
|
|
|
configText := configBytes.String()
|
2018-08-30 14:25:33 +00:00
|
|
|
|
|
|
|
// remove empty lines from generated config
|
2018-10-30 09:24:59 +00:00
|
|
|
configText = removeEmptyLines.ReplaceAllString(configText, "\n")
|
|
|
|
return configText, nil
|
2018-08-30 14:25:33 +00:00
|
|
|
}
|