Initial commit

dnsfilter/README.md

@@ -0,0 +1,70 @@
+# AdGuard DNS Go library
+
+Example use:
+```bash
+[ -z "$GOPATH" ] && export GOPATH=$HOME/go
+go get -d github.com/AdguardTeam/AdguardDNS/dnsfilter
+```
+
+Create file filter.go
+```filter.go
+package main
+
+import (
+    "github.com/AdguardTeam/AdguardDNS/dnsfilter"
+    "log"
+)
+
+func main() {
+    filter := dnsfilter.New()
+    filter.AddRule("||dou*ck.net^")
+    host := "www.doubleclick.net"
+    res, err := filter.CheckHost(host)
+    if err != nil {
+        // temporary failure
+        log.Fatalf("Failed to check host '%s': %s", host, err)
+    }
+    if res.IsFiltered {
+        log.Printf("Host %s is filtered, reason - '%s', matched rule: '%s'", host, res.Reason, res.Rule)
+    } else {
+        log.Printf("Host %s is not filtered, reason - '%s'", host, res.Reason)
+    }
+}
+```
+
+And then run it:
+```bash
+go run filter.go
+```
+
+You will get:
+```
+2000/01/01 00:00:00 Host www.doubleclick.net is filtered, reason - 'FilteredBlackList', matched rule: '||dou*ck.net^'
+```
+
+You can also enable checking against AdGuard's SafeBrowsing:
+
+```go
+package main
+
+import (
+    "github.com/AdguardTeam/AdguardDNS/dnsfilter"
+    "log"
+)
+
+func main() {
+    filter := dnsfilter.New()
+    filter.EnableSafeBrowsing()
+    host := "wmconvirus.narod.ru" // hostname for testing safebrowsing
+    res, err := filter.CheckHost(host)
+    if err != nil {
+        // temporary failure
+        log.Fatalf("Failed to check host '%s': %s", host, err)
+    }
+    if res.IsFiltered {
+        log.Printf("Host %s is filtered, reason - '%s', matched rule: '%s'", host, res.Reason, res.Rule)
+    } else {
+        log.Printf("Host %s is not filtered, reason - '%s'", host, res.Reason)
+    }
+}
+```