mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-12-16 20:24:15 +03:00
16e5e09c2e
Merge in DNS/adguard-home from 3013-idna to master Closes #3013. Squashed commit of the following: commit 567d4c3beef3cf3ee995ad9d8c3aba6616c74c6c Author: Eugene Burkov <e.burkov@adguard.com> Date: Tue Jun 29 13:11:10 2021 +0300 client: mv punycode label commit 6585dcaece9f590d7f02afb5aa25953ab0c2555b Author: Ildar Kamalov <ik@adguard.com> Date: Tue Jun 29 12:32:40 2021 +0300 client: handle unicode name commit c0f61bfbb9bdf919be7b07c112c4b7a52f3ad6a1 Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon Jun 28 20:00:57 2021 +0300 all: imp log of changes commit 41388abc8770ce164bcba327fcf0013133b5e6f7 Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon Jun 28 19:52:23 2021 +0300 scripts: imp hooks commit 9c4ba933fbd9340e1de061d4f451218238650c0f Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon Jun 28 19:47:27 2021 +0300 all: imp code, docs commit 61bd6d6f926480cb8c2f9bd3cd2b61e1532f71cf Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon Jun 28 16:09:25 2021 +0300 querylog: add ascii hostname, convert to unicode
214 lines
5.1 KiB
Go
214 lines
5.1 KiB
Go
package querylog
|
|
|
|
import (
|
|
"fmt"
|
|
"net"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/AdguardTeam/AdGuardHome/internal/filtering"
|
|
"github.com/AdguardTeam/golibs/log"
|
|
"github.com/miekg/dns"
|
|
"golang.org/x/net/idna"
|
|
)
|
|
|
|
// 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
|
|
}
|
|
}
|
|
|
|
hostname := entry.QHost
|
|
question := jobject{
|
|
"type": entry.QType,
|
|
"class": entry.QClass,
|
|
"name": hostname,
|
|
}
|
|
if qhost, err := idna.ToUnicode(hostname); err == nil {
|
|
if qhost != hostname && qhost != "" {
|
|
question["unicode_name"] = qhost
|
|
}
|
|
} else {
|
|
log.Debug("translating %q into unicode: %s", hostname, err)
|
|
}
|
|
|
|
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": question,
|
|
}
|
|
|
|
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 []*filtering.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
|
|
}
|