AdGuardHome/internal/filtering
Ainar Garipov 47dfa44cf6 Pull request 2297: AG-20945-filter-storage
Squashed commit of the following:

commit 2611fd5781
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Nov 1 16:29:06 2024 +0300

    dnsforward: imp test

commit 5efcfda937
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Nov 1 15:54:18 2024 +0300

    rulelist: imp docs, tests

commit 7a759c4699
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Nov 1 14:36:08 2024 +0300

    all: add filtering storage; upd golibs
2024-11-05 12:25:39 +03:00
..
hashprefix Pull request 2269: ADG-8932 Upd all 2024-08-20 18:38:04 +03:00
rewrite Pull request 2187: upd-golibs 2024-04-03 13:44:51 +03:00
rulelist Pull request 2297: AG-20945-filter-storage 2024-11-05 12:25:39 +03:00
safesearch Pull request 2286: AGDNS-2374-slog-safesearch 2024-10-09 16:31:03 +03:00
tests Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +03:00
blocked.go Pull request 2176: AG-20945-rule-list-engine 2024-03-15 17:23:36 +03:00
dnsrewrite.go Pull request 2182: AG-20945-rule-list-id 2024-03-21 18:45:34 +03:00
dnsrewrite_test.go Pull request 2108: 6541 hosts nodata 2023-12-18 14:43:08 +03:00
filter.go Pull request 2284: AG-32257-file-permission-mitigation 2024-10-02 21:00:15 +03:00
filter_test.go Pull request 2297: AG-20945-filter-storage 2024-11-05 12:25:39 +03:00
filtering.go Pull request 2294: AGDNS-2455 Windows permissions 2024-10-29 14:28:59 +03:00
filtering_test.go Pull request 2195: upd-go-code 2024-04-04 15:52:39 +03:00
hosts.go Pull request 2176: AG-20945-rule-list-engine 2024-03-15 17:23:36 +03:00
hosts_test.go Pull request 2176: AG-20945-rule-list-engine 2024-03-15 17:23:36 +03:00
http.go Pull request 2297: AG-20945-filter-storage 2024-11-05 12:25:39 +03:00
http_test.go Pull request 1841: AG-21462-safebrowsing-parental-http-tests 2023-05-03 19:52:06 +03:00
idgenerator.go Pull request 2187: upd-golibs 2024-04-03 13:44:51 +03:00
idgenerator_internal_test.go Pull request 2195: upd-go-code 2024-04-04 15:52:39 +03:00
path.go Pull request 2284: AG-32257-file-permission-mitigation 2024-10-02 21:00:15 +03:00
path_unix_internal_test.go Pull request 2284: AG-32257-file-permission-mitigation 2024-10-02 21:00:15 +03:00
path_windows_internal_test.go Pull request 2284: AG-32257-file-permission-mitigation 2024-10-02 21:00:15 +03:00
README.md Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +03:00
rewritehttp.go Pull request 2147: all: upd deps, go, scripts 2024-02-08 20:39:18 +03:00
rewritehttp_test.go Pull request: 1577: rewrite edit http api 2023-05-12 13:04:19 +03:00
rewrites.go Pull request 2149: 6711 watch hosts 2024-02-13 13:19:22 +03:00
rewrites_test.go Pull request 2017: 6226 legacy rewrite sort 2023-09-19 17:58:37 +03:00
safesearch.go Pull request 2286: AGDNS-2374-slog-safesearch 2024-10-09 16:31:03 +03:00
safesearchhttp.go Pull request 2286: AGDNS-2374-slog-safesearch 2024-10-09 16:31:03 +03:00
servicelist.go Pull request 2295: upd-all 2024-10-29 14:49:25 +03:00

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)
    }
}