update log-format, add option to log in JSON-format

Author: superstes

LICENSE

@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    <program>  Copyright (C) <year>  <name of author>
+    DNS-BL Server  Copyright (C) 2025 OXL IT Services / Rath Pascal
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

README.md

@@ -28,17 +28,33 @@ Users can query the DNS-BL as configured in your config-file through:
 * `d.<DOMAIN>` => for Domain-Lookups
 
 ```bash
-dnsbl-server -domain test.at -config ./config.yml -port 10000
+rath@gate:~ dnsbl-server -help
+> Usage of dnsbl-server:
+>   -config string
+>         Path to the config file (in YAML format) (required)
+>   -domain string
+>         Domain to serve for (required)
+>   -log-json
+>         Log in JSON-format (defaut false)
+>   -no-log
+>         Disable request logging (defaut false)
+>   -no-log-time
+>         Disable log timestamp (defaut false)
+>   -port int
+>         Port to listen on (default 5353)
+
+rath@gate:~ dnsbl-server -domain test.at -config ./config.yml -port 10000
+
 2025/07/24 21:46:12 DNS-BL server listening on 10000
  > IP Lookup: ip.test.at.
  > Domain Lookup: d.test.at.
-# <time> [<client-IP>] => <IP/DOMAIN>: <request> <= response-code
+# <time> [<client-IP>] => <IP/DOMAIN>: <request> <= <status> <response>
 #   200 = found, 400 = bad request, 404 = not found
-2025/07/24 21:46:16 [127.0.0.1] => IP: 192.0.2.88 <= 200
-2025/07/24 21:46:18 [127.0.0.1] => IP: 192.0.2.130 <= 200
+2025/07/24 21:46:16 [127.0.0.1] => IP: 192.0.2.88 <= 200 127.0.0.2
+2025/07/24 21:46:18 [127.0.0.1] => IP: 192.0.2.130 <= 200 127.0.0.2
 2025/07/24 21:46:23 [127.0.0.1] => IP: 1.1.1.1 <= 404
-2025/07/24 21:46:53 [127.0.0.1] => IP: fe80::9fe:dc1c:42f0:6e60 <= 200
-2025/07/24 21:48:08 [127.0.0.1] => Domain: malicious.risk.oxl.app <= 200
+2025/07/24 21:46:53 [127.0.0.1] => IP: fe80::9fe:dc1c:42f0:6e60 <= 200 127.0.0.2
+2025/07/24 21:48:08 [127.0.0.1] => Domain: malicious.risk.oxl.app <= 200 127.0.0.2
 2025/07/24 21:47:42 [127.0.0.1] => Domain: good.oxl.app <= 404
 
 # examples of bad requests

scripts/build.sh

@@ -1,15 +1,34 @@
 #!/usr/bin/env bash
 
-set -e
+set -eo pipefail
+
+if [ -z "$GO_BIN" ]
+then
+  GO_BIN='go'
+fi
+
+if [ -z "$GOOS" ]
+then
+  GOOS='linux'
+fi
+
+if [ -z "$GOARCH" ]
+then
+  GOARCH='amd64'
+fi
+
+cgo=''
+if [ -n "$CGO_ENABLED" ]
+then
+  cgo="-CGO${CGO_ENABLED}"
+fi
 
 cd "$(dirname "$0")/.."
 
 PATH_OUT="$(pwd)/build"
-FILE_OUT="${PATH_OUT}/dnsbl-server"
+FILE_OUT="${PATH_OUT}/dnsbl-server-${GOOS}-${GOARCH}${cgo}"
 mkdir -p "$PATH_OUT"
 
-cd src/cmd/
-
-go build -o "$FILE_OUT"
+go build -o "$FILE_OUT" ./src/cmd/
 
 echo "DONE: ${FILE_OUT}"

scripts/build_all_bin.sh

@@ -0,0 +1,52 @@
+#!/bin/bash
+
+set -euo pipefail
+
+cd "$(dirname "$0")"
+
+PATH_SCRIPT="$(pwd)"
+PATH_REPO="${PATH_SCRIPT}/.."
+PATH_BUILD="${PATH_REPO}/build"
+FILE_BEG="dnsbl-server-"
+
+cd "$PATH_REPO"
+mkdir -p "$PATH_BUILD"
+rm -f "$PATH_BUILD"/*
+
+
+function compile() {
+    os="$1" arch="$2"
+    echo ''
+    echo ''
+    echo "# COMPILING BINARIES FOR ${os}-${arch} #"
+    echo ''
+
+    GOOS="$os" GOARCH="$arch" bash "${PATH_SCRIPT}/build.sh"
+    echo ''
+    GOOS="$os" GOARCH="$arch" CGO_ENABLED=0 bash "${PATH_SCRIPT}/build.sh"
+
+    echo ''
+    echo '### COMPRESSING ###'
+    file="${FILE_BEG}${os}-${arch}"
+    cd "$PATH_BUILD"
+    tar -czf "${file}.tar.gz" "$file"
+    tar -czf "${file}-CGO0.tar.gz" "${file}-CGO0"
+}
+
+compile "linux" "amd64"
+
+# untested
+compile "linux" "386"
+compile "linux" "arm"
+compile "linux" "arm64"
+
+compile "freebsd" "386"
+compile "freebsd" "amd64"
+compile "freebsd" "arm"
+
+compile "openbsd" "386"
+compile "openbsd" "amd64"
+compile "openbsd" "arm"
+
+compile "darwin" "amd64"
+compile "darwin" "arm64"

src/cmd/main.go

@@ -13,28 +13,34 @@ import (
 	"github.com/miekg/dns"
 )
 
+const VERSION = "1.0.0"
+
 func main() {
 	var domain string
 	var configFile string
 	var port int
 	var noLog bool
 	var noLogTime bool
+	var logJSON bool
 
 	flag.StringVar(&domain, "domain", "", "Domain to serve for")
 	flag.StringVar(&configFile, "config", "", "Path to the config file (in YAML format)")
 	flag.IntVar(&port, "port", 5353, "Port to listen on")
 	flag.BoolVar(&noLog, "no-log", false, "Disable request logging")
 	flag.BoolVar(&noLogTime, "no-log-time", false, "Disable log timestamp")
+	flag.BoolVar(&logJSON, "log-json", false, "Log in JSON-format")
 	flag.Parse()
 
+	fmt.Printf("DNS-BL Server v%v\n  © OXL IT Service\n  License: GPLv3\n\n", VERSION)
+
 	if domain == "" || configFile == "" {
-		fmt.Println("Domain and config-file need to be provided!")
+		fmt.Println("ERROR: Domain and config-file need to be provided!")
 		os.Exit(1)
 	}
 
 	validDomain, _ := regexp.MatchString(internal.REGEX_DOMAIN, domain)
 	if !validDomain {
-		fmt.Println("Invalid domain provided! Example: 'dnsbl.risk.oxl.app'")
+		fmt.Println("ERROR: Invalid domain provided! Example: 'dnsbl.risk.oxl.app'")
 		os.Exit(1)
 	}
 	if !strings.HasSuffix(domain, ".") {
@@ -47,6 +53,7 @@ func main() {
 		BL:         internal.DNSBLConfigFlat{},
 		Log:        !noLog,
 		LogTime:    !noLogTime,
+		LogJSON:    logJSON,
 		BaseIP:     fmt.Sprintf(".%v", baseIP),
 		BaseDomain: fmt.Sprintf(".%v", baseDomain),
 	}

src/internal/config.go

@@ -35,6 +35,7 @@ type DNSBLRunningConfig struct {
 	BaseDomain string
 	Log        bool
 	LogTime    bool
+	LogJSON    bool
 }
 
 func (config *DNSBLRunningConfig) LookupIP(w dns.ResponseWriter, r *dns.Msg) {

src/internal/logger.go

@@ -0,0 +1,72 @@
+package internal
+
+import (
+	"encoding/json"
+	"fmt"
+	"log"
+	"time"
+)
+
+type requestLog struct {
+	Client   string `json:"cli"`
+	Type     string `json:"type"`
+	Request  string `json:"req"`
+	Status   int    `json:"status"`
+	Response string `json:"res"`
+}
+
+type requestLogTime struct {
+	Time     string `json:"time"`
+	Client   string `json:"cli"`
+	Type     string `json:"type"`
+	Request  string `json:"req"`
+	Status   int    `json:"status"`
+	Response string `json:"res"`
+}
+
+func logRequest(q string, s int, cli string, c *DNSBLRunningConfig, t int, res string) {
+	if !c.Log {
+		return
+	}
+	ts := "IP"
+	if t == LOOKUP_DOMAIN {
+		ts = "Domain"
+	}
+
+	if c.LogJSON {
+		var err error
+		var l []byte
+		if c.LogTime {
+			l, err = json.Marshal(requestLogTime{
+				Time:     time.Now().Format(time.RFC3339),
+				Client:   cli,
+				Type:     ts,
+				Request:  q,
+				Status:   s,
+				Response: res,
+			})
+		} else {
+			l, err = json.Marshal(requestLog{
+				Client:   cli,
+				Type:     ts,
+				Request:  q,
+				Status:   s,
+				Response: res,
+			})
+		}
+
+		if err != nil {
+			fmt.Printf("ERROR: Unable to log in JSON-format - %v", err)
+			return
+		}
+		fmt.Println(string(l))
+
+	} else {
+		l := fmt.Sprintf("[%s] => %s: %s <= %d %s", cli, ts, q, s, res)
+		if c.LogTime {
+			log.Println(l)
+		} else {
+			fmt.Println(l)
+		}
+	}
+}

src/internal/server.go

@@ -2,7 +2,6 @@ package internal
 
 import (
 	"fmt"
-	"log"
 	"net/netip"
 	"regexp"
 	"slices"
@@ -15,22 +14,6 @@ const RES_RATE = "127.255.255.255"
 const BAD_REQ = "-"
 const REGEX_DOMAIN = "^[a-z0-9\\-\\.]{1,253}\\.[a-z0-9\\-]{2,63}(\\.?)$"
 
-func logRequest(q string, res string, cli string, c *DNSBLRunningConfig, t int) {
-	if !c.Log {
-		return
-	}
-	ts := "IP"
-	if t == LOOKUP_DOMAIN {
-		ts = "Domain"
-	}
-	l := fmt.Sprintf("[%s] => %s: %s <= %s", cli, ts, q, res)
-	if c.LogTime {
-		log.Println(l)
-	} else {
-		fmt.Println(l)
-	}
-}
-
 func checkIP(q dns.Question, c *DNSBLRunningConfig) (string, string) {
 	req := strings.Replace(q.Name, c.BaseIP, "", 1)
 	parts := strings.Split(req, ".")
@@ -105,17 +88,17 @@ func parseQuery(m *dns.Msg, w dns.ResponseWriter, c *DNSBLRunningConfig, t int)
 			}
 
 			if res == BAD_REQ {
-				logRequest(query, "400", cli, c, t)
+				logRequest(query, 400, cli, c, t, "")
 
 			} else if res != "" {
-				logRequest(query, "200", cli, c, t)
+				logRequest(query, 200, cli, c, t, res)
 				rr, err := dns.NewRR(fmt.Sprintf("%s A %s", q.Name, res))
 				if err == nil {
 					m.Answer = append(m.Answer, rr)
 				}
 
 			} else {
-				logRequest(query, "404", cli, c, t)
+				logRequest(query, 404, cli, c, t, "")
 			}
 		}
 	}