AdGuardHome/internal/filtering
Ainar Garipov bf1263628a Pull request: filtering: fix special values in legacy rewrites
Updates #3616.

Squashed commit of the following:

commit 06a65c3fe754f8f849f5e1648cc3d94d564bfa16
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Sep 17 14:31:06 2021 +0300

    filtering: imp docs

commit 9b6788453622ee19b0b383833e734d25e03a4d55
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Fri Sep 17 14:22:56 2021 +0300

    filtering: fix special values in legacy rewrites
2021-09-17 14:37:55 +03:00
..
tests Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +03:00
blocked_test.go Pull request: all: imp build tags 2021-06-15 19:42:41 +03:00
blocked.go Pull request: 3564 9gag 2021-09-08 12:24:12 +03:00
dnsrewrite_test.go Pull request: filtering: fix fqdn support in ptr dnsrewrite 2021-06-11 14:40:22 +03:00
dnsrewrite.go Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +03:00
filtering_test.go Pull request: all: sup many ips in host rules 2021-06-17 14:09:16 +03:00
filtering.go Pull request: filtering: fix special values in legacy rewrites 2021-09-17 14:37:55 +03:00
README.md Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +03:00
rewrites_test.go Pull request: filtering: fix special values in legacy rewrites 2021-09-17 14:37:55 +03:00
rewrites.go Pull request: filtering: fix special values in legacy rewrites 2021-09-17 14:37:55 +03:00
safebrowsing_test.go Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +03:00
safebrowsing.go Pull request: all: replace aghstrings with stringutil 2021-07-29 17:40:31 +03:00
safesearch.go Pull request: all: less annoying pkg names 2021-05-21 16:15:47 +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)
    }
}