AdGuardHome/internal/filtering
Stanislav Chzhen db52f7a3ac Pull request 1841: AG-21462-safebrowsing-parental-http-tests
Merge in DNS/adguard-home from AG-21462-safebrowsing-parental-http-tests to master

Squashed commit of the following:

commit 22a83ebad08a27939a443530137a7c195f512ee4
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Wed May 3 17:39:46 2023 +0300

    filtering: fix test

commit c3ca8b4987245cdd552f6f09759804e716bcae80
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Wed May 3 16:43:35 2023 +0300

    filtering: imp tests even more

commit 7643bfae350373b5b6dfb61b64e57da66c6ab952
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Wed May 3 16:17:42 2023 +0300

    filtering: imp tests more

commit 399c05ee4d479a727b61378b7a07158a568d0181
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Wed May 3 14:45:41 2023 +0300

    filtering: imp tests

commit f361df39e784ec9c5191666736a6c64b332928e8
Author: Stanislav Chzhen <s.chzhen@adguard.com>
Date:   Tue May 2 12:49:26 2023 +0300

    filtering: add tests
2023-05-03 19:52:06 +03:00
..
hashprefix Pull request 1837: AG-21462-imp-safebrowsing-parental 2023-04-27 16:39:35 +03:00
rewrite Pull request: 2499 rewrite: storage vol.2 2022-12-05 14:46:51 +03:00
safesearch Pull request 1803: 5685-fix-safe-search 2023-04-06 14:12:50 +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: 3972-hostlists-services 2022-10-27 15:46:25 +03:00
dnsrewrite.go Pull request: 4865-refactor-dns-handlers 2022-09-02 14:52:19 +03:00
dnsrewrite_test.go Pull request: 4871 imp filtering 2022-09-23 13:23:35 +03:00
filter.go Pull request 1790: 5624-fix-filter-add 2023-03-29 19:09:54 +03:00
filter_test.go Pull request: 5258-good-old-filters 2022-12-20 16:40:42 +03:00
filtering.go Pull request 1841: AG-21462-safebrowsing-parental-http-tests 2023-05-03 19:52:06 +03:00
filtering_test.go Pull request 1837: AG-21462-imp-safebrowsing-parental 2023-04-27 16:39:35 +03:00
http.go Pull request 1841: AG-21462-safebrowsing-parental-http-tests 2023-05-03 19:52:06 +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: 2499 rewrite: storage vol.2 2022-12-05 14:46:51 +03:00
rewrites.go Pull request 1743: upd-sorting 2023-02-21 16:38:22 +03:00
rewrites_test.go Pull request: 2499 rewrite: storage vol.2 2022-12-05 14:46:51 +03:00
safesearch.go Pull request 1803: 5685-fix-safe-search 2023-04-06 14:12:50 +03:00
safesearchhttp.go Pull request 1803: 5685-fix-safe-search 2023-04-06 14:12:50 +03:00
servicelist.go Pull request 1833: upd-all 2023-04-18 15:49:03 +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)
    }
}