mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-12-17 05:01:35 +03:00
7c35d208b1
Updates #1273. Squashed commit of the following: commit 55b78153b1b775c855e759011141bbbe6d4b962c Author: Artem Baskal <a.baskal@adguard.com> Date: Fri Apr 2 16:55:39 2021 +0300 Update client_info in case of null commit 5c80c1438ed9d961af11617831b704d6ae15cc34 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Apr 2 16:24:14 2021 +0300 querylog: always set client_info commit b48efd64d757cc0bcf5b34de22fdd0b0464d98a6 Merge: 4ed7eab523c9f528
Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Apr 2 16:22:08 2021 +0300 Merge branch 'master' into 1273-querylog-client-name commit 4ed7eab52b6b5b0c0ddb5aa5a3225a62d1f9265b Merge: dbf990eb70d4c70e
Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Apr 2 12:57:17 2021 +0300 Merge branch 'master' into 1273-querylog-client-name commit dbf990eb881116754554270e7b691b5db8e9ee34 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Apr 2 12:56:13 2021 +0300 home: imp names commit c2cfdef494ca26fff62b9fa008f1b389d9d4d46b Author: Artem Baskal <a.baskal@adguard.com> Date: Thu Apr 1 19:26:04 2021 +0300 Rename to whois commit e3cc4a68ee576770b1922680155308e33bed31e8 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Apr 1 19:03:42 2021 +0300 home: imp whois more commit 3b8ef8691c298aff35946b35923ef2e5b1f9bbbe Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Apr 1 18:51:14 2021 +0300 home: imp whois resp commit fb97e0d74976723a512d6ff4c69e830fe59c8df8 Author: Artem Baskal <a.baskal@adguard.com> Date: Thu Apr 1 18:00:03 2021 +0300 Fix client_info ids prop types commit 298005189e372651ceff453e88aca19ee925a138 Author: Artem Baskal <a.baskal@adguard.com> Date: Thu Apr 1 17:58:14 2021 +0300 Adapt changes on client commit aa1769f64197d865478a66271da483babfc5dfd0 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Apr 1 17:18:36 2021 +0300 all: add more fields to querylog client commit 4b2a2dbd380ec410f3068d15ea16430912e03e33 Merge: cda92c3f2e4e2f62
Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Apr 1 16:57:26 2021 +0300 Merge branch 'master' into 1273-querylog-client-name commit cda92c3f0331cbac252f3163d31457f716bc7f2c Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Mon Mar 29 18:03:51 2021 +0300 querylog: fix windows tests commit 5a56f0a32608869ed93a38f18f63ea3a20f7bde2 Merge: 627e4958e710ce11
Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Mon Mar 29 17:45:53 2021 +0300 Merge branch 'master' into 1273-querylog-client-name commit 627e495828e82d44cc77aa393536479f23cc68b7 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Mon Mar 29 17:44:49 2021 +0300 querylog: add tests, imp code, docs commit 6dec468a2f0c29357875ff99458e0e8f8e580e6d Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Mar 26 16:10:47 2021 +0300 querylog: search clients by name, enrich http resp
203 lines
4.9 KiB
Go
203 lines
4.9 KiB
Go
package querylog
|
|
|
|
import (
|
|
"fmt"
|
|
"net"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/AdguardTeam/AdGuardHome/internal/dnsfilter"
|
|
"github.com/AdguardTeam/golibs/log"
|
|
"github.com/miekg/dns"
|
|
)
|
|
|
|
// TODO(a.garipov): Use a proper structured approach here.
|
|
|
|
// Get Client IP address
|
|
func (l *queryLog) getClientIP(ip net.IP) (clientIP net.IP) {
|
|
if l.conf.AnonymizeClientIP && ip != nil {
|
|
const AnonymizeClientIPv4Mask = 16
|
|
const AnonymizeClientIPv6Mask = 112
|
|
|
|
if ip.To4() != nil {
|
|
return ip.Mask(net.CIDRMask(AnonymizeClientIPv4Mask, 32))
|
|
}
|
|
|
|
return ip.Mask(net.CIDRMask(AnonymizeClientIPv6Mask, 128))
|
|
}
|
|
|
|
return ip
|
|
}
|
|
|
|
// jobject is a JSON object alias.
|
|
type jobject = map[string]interface{}
|
|
|
|
// entriesToJSON converts query log entries to JSON.
|
|
func (l *queryLog) entriesToJSON(entries []*logEntry, oldest time.Time) (res jobject) {
|
|
data := []jobject{}
|
|
|
|
// the elements order is already reversed (from newer to older)
|
|
for i := 0; i < len(entries); i++ {
|
|
entry := entries[i]
|
|
jsonEntry := l.logEntryToJSONEntry(entry)
|
|
data = append(data, jsonEntry)
|
|
}
|
|
|
|
res = jobject{
|
|
"data": data,
|
|
"oldest": "",
|
|
}
|
|
if !oldest.IsZero() {
|
|
res["oldest"] = oldest.Format(time.RFC3339Nano)
|
|
}
|
|
|
|
return res
|
|
}
|
|
|
|
func (l *queryLog) logEntryToJSONEntry(entry *logEntry) (jsonEntry jobject) {
|
|
var msg *dns.Msg
|
|
|
|
if len(entry.Answer) > 0 {
|
|
msg = new(dns.Msg)
|
|
if err := msg.Unpack(entry.Answer); err != nil {
|
|
log.Debug("Failed to unpack dns message answer: %s: %s", err, string(entry.Answer))
|
|
msg = nil
|
|
}
|
|
}
|
|
|
|
jsonEntry = jobject{
|
|
"reason": entry.Result.Reason.String(),
|
|
"elapsedMs": strconv.FormatFloat(entry.Elapsed.Seconds()*1000, 'f', -1, 64),
|
|
"time": entry.Time.Format(time.RFC3339Nano),
|
|
"client": l.getClientIP(entry.IP),
|
|
"client_info": entry.client,
|
|
"client_proto": entry.ClientProto,
|
|
"upstream": entry.Upstream,
|
|
"question": jobject{
|
|
"host": entry.QHost,
|
|
"type": entry.QType,
|
|
"class": entry.QClass,
|
|
},
|
|
}
|
|
|
|
if entry.ClientID != "" {
|
|
jsonEntry["client_id"] = entry.ClientID
|
|
}
|
|
|
|
if msg != nil {
|
|
jsonEntry["status"] = dns.RcodeToString[msg.Rcode]
|
|
|
|
opt := msg.IsEdns0()
|
|
dnssecOk := false
|
|
if opt != nil {
|
|
dnssecOk = opt.Do()
|
|
}
|
|
|
|
jsonEntry["answer_dnssec"] = dnssecOk
|
|
}
|
|
|
|
jsonEntry["rules"] = resultRulesToJSONRules(entry.Result.Rules)
|
|
|
|
if len(entry.Result.Rules) > 0 && len(entry.Result.Rules[0].Text) > 0 {
|
|
jsonEntry["rule"] = entry.Result.Rules[0].Text
|
|
jsonEntry["filterId"] = entry.Result.Rules[0].FilterListID
|
|
}
|
|
|
|
if len(entry.Result.ServiceName) != 0 {
|
|
jsonEntry["service_name"] = entry.Result.ServiceName
|
|
}
|
|
|
|
answers := answerToMap(msg)
|
|
if answers != nil {
|
|
jsonEntry["answer"] = answers
|
|
}
|
|
|
|
if len(entry.OrigAnswer) != 0 {
|
|
a := new(dns.Msg)
|
|
err := a.Unpack(entry.OrigAnswer)
|
|
if err == nil {
|
|
answers = answerToMap(a)
|
|
if answers != nil {
|
|
jsonEntry["original_answer"] = answers
|
|
}
|
|
} else {
|
|
log.Debug("Querylog: msg.Unpack(entry.OrigAnswer): %s: %s", err, string(entry.OrigAnswer))
|
|
}
|
|
}
|
|
|
|
return jsonEntry
|
|
}
|
|
|
|
func resultRulesToJSONRules(rules []*dnsfilter.ResultRule) (jsonRules []jobject) {
|
|
jsonRules = make([]jobject, len(rules))
|
|
for i, r := range rules {
|
|
jsonRules[i] = jobject{
|
|
"filter_list_id": r.FilterListID,
|
|
"text": r.Text,
|
|
}
|
|
}
|
|
|
|
return jsonRules
|
|
}
|
|
|
|
type dnsAnswer struct {
|
|
Type string `json:"type"`
|
|
Value string `json:"value"`
|
|
TTL uint32 `json:"ttl"`
|
|
}
|
|
|
|
func answerToMap(a *dns.Msg) (answers []*dnsAnswer) {
|
|
if a == nil || len(a.Answer) == 0 {
|
|
return nil
|
|
}
|
|
|
|
answers = make([]*dnsAnswer, 0, len(a.Answer))
|
|
for _, k := range a.Answer {
|
|
header := k.Header()
|
|
answer := &dnsAnswer{
|
|
Type: dns.TypeToString[header.Rrtype],
|
|
TTL: header.Ttl,
|
|
}
|
|
|
|
// Some special treatment for some well-known types.
|
|
//
|
|
// TODO(a.garipov): Consider just calling String() for everyone
|
|
// instead.
|
|
switch v := k.(type) {
|
|
case nil:
|
|
// Probably unlikely, but go on.
|
|
case *dns.A:
|
|
answer.Value = v.A.String()
|
|
case *dns.AAAA:
|
|
answer.Value = v.AAAA.String()
|
|
case *dns.MX:
|
|
answer.Value = fmt.Sprintf("%v %v", v.Preference, v.Mx)
|
|
case *dns.CNAME:
|
|
answer.Value = v.Target
|
|
case *dns.NS:
|
|
answer.Value = v.Ns
|
|
case *dns.SPF:
|
|
answer.Value = strings.Join(v.Txt, "\n")
|
|
case *dns.TXT:
|
|
answer.Value = strings.Join(v.Txt, "\n")
|
|
case *dns.PTR:
|
|
answer.Value = v.Ptr
|
|
case *dns.SOA:
|
|
answer.Value = fmt.Sprintf("%v %v %v %v %v %v %v", v.Ns, v.Mbox, v.Serial, v.Refresh, v.Retry, v.Expire, v.Minttl)
|
|
case *dns.CAA:
|
|
answer.Value = fmt.Sprintf("%v %v \"%v\"", v.Flag, v.Tag, v.Value)
|
|
case *dns.HINFO:
|
|
answer.Value = fmt.Sprintf("\"%v\" \"%v\"", v.Cpu, v.Os)
|
|
case *dns.RRSIG:
|
|
answer.Value = fmt.Sprintf("%v %v %v %v %v %v %v %v %v", dns.TypeToString[v.TypeCovered], v.Algorithm, v.Labels, v.OrigTtl, v.Expiration, v.Inception, v.KeyTag, v.SignerName, v.Signature)
|
|
default:
|
|
answer.Value = v.String()
|
|
}
|
|
|
|
answers = append(answers, answer)
|
|
}
|
|
|
|
return answers
|
|
}
|