AdGuardHome/internal/filtering
Ainar Garipov b22b16d98c all: sync with master; upd chlog 2023-07-03 14:10:40 +03:00
..
hashprefix all: sync with master; upd chlog 2023-06-07 20:04:01 +03:00
rewrite all: sync with master; upd chlog 2023-07-03 14:10:40 +03:00
safesearch all: sync with master; upd chlog 2023-07-03 14:10:40 +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 all: sync with master; upd chlog 2023-07-03 14:10:40 +03:00
dnsrewrite.go all: sync with master 2022-09-07 18:03:18 +03:00
dnsrewrite_test.go all: sync with master 2022-09-29 17:36:01 +03:00
filter.go all: sync with master; upd chlog 2023-04-12 14:48:42 +03:00
filter_test.go all: sync with master; upd chlog 2023-01-19 15:04:46 +03:00
filtering.go all: sync with master; upd chlog 2023-07-03 14:10:40 +03:00
filtering_test.go all: sync with master; upd chlog 2023-06-07 20:04:01 +03:00
http.go all: sync with master; upd chlog 2023-07-03 14:10:40 +03:00
http_test.go all: sync with master; upd chlog 2023-06-07 20:04:01 +03:00
rewritehttp.go all: sync with master; upd chlog 2023-07-03 14:10:40 +03:00
rewritehttp_test.go all: sync with master; upd chlog 2023-07-03 14:10:40 +03:00
rewrites.go all: sync with master; upd chlog 2023-03-09 15:39:35 +03:00
rewrites_test.go all: sync with master 2022-09-29 17:36:01 +03:00
safesearch.go all: sync with master; upd chlog 2023-04-12 14:48:42 +03:00
safesearchhttp.go all: sync with master; upd chlog 2023-04-12 14:48:42 +03:00
servicelist.go all: sync with master; upd chlog 2023-07-03 14:10:40 +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)
    }
}