AdGuardHome/internal/filtering
Ainar Garipov 2eb3bf6ea5 Pull request 1793: upd-all
Merge in DNS/adguard-home from upd-all to master

Squashed commit of the following:

commit 19535409f54360618e1239bddd7ce495d19e0ca4
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Mar 30 16:06:49 2023 +0300

    all: upd deps, i18n, filters, services, tools
2023-03-30 16:13:19 +03:00
..
rewrite Pull request: 2499 rewrite: storage vol.2 2022-12-05 14:46:51 +03:00
safesearch Pull request 1163 safesearch package vol.1 2023-03-07 17:52:03 +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: 1163 safesearch vol.2 2023-03-15 14:31:07 +03:00
filtering_test.go Pull request: 1163 safesearch vol.2 2023-03-15 14:31:07 +03:00
http.go Pull request 1790: 5624-fix-filter-add 2023-03-29 19:09:54 +03:00
http_test.go Pull request: 5258-good-old-filters 2022-12-20 16:40:42 +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
safebrowsing.go Pull request 1743: upd-sorting 2023-02-21 16:38:22 +03:00
safebrowsing_test.go Pull request: 4871 imp filtering 2022-09-23 13:23:35 +03:00
safesearch.go Pull request: 1163 safesearch http api vol.3 2023-03-23 15:25:58 +03:00
safesearchhttp.go Pull request: 1163 safesearch http api vol.3 2023-03-23 15:25:58 +03:00
servicelist.go Pull request 1793: upd-all 2023-03-30 16:13: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)
    }
}