AdGuardHome/internal/filtering
Dimitry Kolyshev f84ff2bd05 Pull request: AG-25263 dns config
Merge in DNS/adguard-home from AG-25263-dns-config to master

Squashed commit of the following:

commit 478b607526391af65de67d6d7f1d904198610cdf
Merge: b944d12fa 51340adb3
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Mon Sep 4 18:04:56 2023 +0400

    Merge remote-tracking branch 'origin/master' into AG-25263-dns-config

commit b944d12fa812b05b9d9f22d2287425ca36630329
Merge: b474f712f 0182b9ec1
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Fri Sep 1 09:13:36 2023 +0400

    Merge remote-tracking branch 'origin/master' into AG-25263-dns-config

    # Conflicts:
    #	internal/dnsforward/dnsforward.go

commit b474f712f64daa1a7d7e32d89edc901d2f273c9a
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Fri Sep 1 09:11:17 2023 +0400

    all: imp code

commit 635a316b8244f13d90a8fe2209f1673c0765aaa9
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Wed Aug 30 16:18:25 2023 +0300

    all: dnsfilter rm config embed

commit 5aa6212e89bc38e3d283b8d6b1a78726d10b3f3a
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date:   Wed Aug 30 12:45:01 2023 +0300

    all: dnsfilter rm config embed
2023-09-04 17:18:43 +03:00
..
hashprefix Pull request 1955: Upd libraries 2023-08-10 20:00:17 +03:00
rewrite Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
rulelist Pull request 1933: upd-golibs 2023-07-20 14:26:35 +03:00
safesearch Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
tests Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +03:00
README.md Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +03:00
blocked.go Pull request: AG-25263 dns config 2023-09-04 17:18:43 +03:00
dnsrewrite.go Pull request 1973: 6132 fix hosts stratup 2023-08-23 18:57:24 +03:00
dnsrewrite_test.go Pull request 1973: 6132 fix hosts stratup 2023-08-23 18:57:24 +03:00
filter.go Pull request: AG-25263 dns config 2023-09-04 17:18:43 +03:00
filter_test.go Pull request: AG-25263 dns config 2023-09-04 17:18:43 +03:00
filtering.go Pull request: AG-25263 dns config 2023-09-04 17:18:43 +03:00
filtering_test.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
http.go Pull request: AG-25263 dns config 2023-09-04 17:18:43 +03:00
http_test.go Pull request 1841: AG-21462-safebrowsing-parental-http-tests 2023-05-03 19:52:06 +03:00
rewritehttp.go Pull request: AG-25263 dns config 2023-09-04 17:18:43 +03:00
rewritehttp_test.go Pull request: 1577: rewrite edit http api 2023-05-12 13:04:19 +03:00
rewrites.go Pull request: AG-25263 dns config 2023-09-04 17:18:43 +03:00
rewrites_test.go Pull request: AG-25263 dns config 2023-09-04 17:18:43 +03:00
safesearch.go Pull request 1803: 5685-fix-safe-search 2023-04-06 14:12:50 +03:00
safesearchhttp.go Pull request: AG-25263 dns config 2023-09-04 17:18:43 +03:00
servicelist.go Pull request 1976: upd-all 2023-08-24 14:30:19 +03:00

README.md

AdGuard Home's DNS filtering go library

Example use:

[ -z "$GOPATH" ] && export GOPATH=$HOME/go
go get -d github.com/AdguardTeam/AdGuardHome/filtering

Create file filter.go

package main

import (
    "github.com/AdguardTeam/AdGuardHome/filtering"
    "log"
)

func main() {
    filter := filtering.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 %q: %s", host, err)
    }
    if res.IsFiltered {
        log.Printf("Host %s is filtered, reason - %q, matched rule: %q", host, res.Reason, res.Rule)
    } else {
        log.Printf("Host %s is not filtered, reason - %q", host, res.Reason)
    }
}

And then run it:

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:

package main

import (
    "github.com/AdguardTeam/AdGuardHome/filtering"
    "log"
)

func main() {
    filter := filtering.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 %q: %s", host, err)
    }
    if res.IsFiltered {
        log.Printf("Host %s is filtered, reason - %q, matched rule: %q", host, res.Reason, res.Rule)
    } else {
        log.Printf("Host %s is not filtered, reason - %q", host, res.Reason)
    }
}