AdGuardHome/internal/filtering
Eugene Burkov 2b9019313b Pull request 1973: 6132 fix hosts stratup
Merge in DNS/adguard-home from 6132-fix-hosts-startup to master

Updates #6132.

Squashed commit of the following:

commit 7495e62531f7c0bd775969195da1cbd446f018f7
Merge: c5d99bcef 4b04c620f
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Aug 23 18:50:14 2023 +0300

    Merge branch 'master' into 6132-fix-hosts-startup

commit c5d99bcefa870ba0d2543158e97b3001f65be459
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Aug 23 18:01:17 2023 +0300

    filtering: fix hosts results

commit b7acf266ad73520a0b795c495c8fc75c547ed993
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Aug 23 17:34:43 2023 +0300

    all: revert changes of log of changes

commit 293240d5b1277cebd26732c535ad004af76df532
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Aug 23 17:30:07 2023 +0300

    aghnet: imp logs

commit d1f7d73477a1a8fed5b1fb8b7f42d1c92acd919c
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Aug 23 17:19:54 2023 +0300

    aghnet: impl handle set

commit b643793c537fcdd4ba00bae4d7207cb4f1d60d80
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date:   Wed Aug 23 17:00:05 2023 +0300

    aghnet: fix initial refresh
2023-08-23 18:57:24 +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 1883: 951-blocked-services-client-schedule 2023-06-27 18:03:07 +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: 6020-rulelist-name 2023-08-11 13:55:49 +03:00
filter_test.go Pull request: 6020-rulelist-name 2023-08-11 13:55:49 +03:00
filtering.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
filtering_test.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
http.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +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: 1577: rewrite edit http api 2023-05-12 13:04:19 +03:00
rewritehttp_test.go Pull request: 1577: rewrite edit http api 2023-05-12 13:04:19 +03:00
rewrites.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +03:00
rewrites_test.go Pull request 1966: 6050 upd urlfilter 2023-08-23 16:58:24 +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 1950: upd-all 2023-08-02 15:58:05 +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)
    }
}