Improve & Add WebUI & Add BTN (Not yet tested)

Author: Simple-Tracker

BTN.go

@@ -0,0 +1,88 @@
+package main
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+)
+
+func TestGetTorrentIdentifierIsStableAndCaseInsensitive(t *testing.T) {
+	id1 := GetTorrentIdentifier("ABCDEF0123456789")
+	id2 := GetTorrentIdentifier("abcdef0123456789")
+
+	if id1 != id2 {
+		t.Fatalf("GetTorrentIdentifier should be case-insensitive: %q != %q", id1, id2)
+	}
+	if len(id1) != 64 {
+		t.Fatalf("identifier length=%d, want 64", len(id1))
+	}
+	if id1 == "abcdef0123456789" {
+		t.Fatal("identifier should not equal the raw torrent hash")
+	}
+}
+
+func TestBTNGetConfigLoadsConfiguration(t *testing.T) {
+	oldClientExternal := httpClientExternal
+	oldConfig := config
+	oldBtnConfig := btnConfig
+	oldLastGetConfig := btn_lastGetConfig
+	oldCurrentTimestamp := currentTimestamp
+	oldIsGetting := btn_isGettingConfig.Load()
+	defer func() {
+		httpClientExternal = oldClientExternal
+		config = oldConfig
+		btnConfig = oldBtnConfig
+		btn_lastGetConfig = oldLastGetConfig
+		currentTimestamp = oldCurrentTimestamp
+		btn_isGettingConfig.Store(oldIsGetting)
+	}()
+
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if got := r.Header.Get("Authorization"); got != "Bearer app-a@secret-a" {
+			t.Fatalf("Authorization=%q, want Bearer app-a@secret-a", got)
+		}
+		w.Header().Set("Content-Type", "application/json")
+		_, _ = w.Write([]byte(`{
+			"min_protocol_version": 1,
+			"max_protocol_version": 3,
+			"ability": {
+				"submit_peers": {
+					"interval": 10,
+					"endpoint": "https://btn.example/submit_peers",
+					"random_initial_delay": 0,
+					"version": "v1"
+				}
+			}
+		}`))
+	}))
+	defer server.Close()
+
+	httpClientExternal = *server.Client()
+	config = oldConfig
+	config.BTNConfigureURL = server.URL
+	config.BTNAppID = "app-a"
+	config.BTNAppSecret = "secret-a"
+	btnConfig = nil
+	btn_lastGetConfig = 0
+	currentTimestamp = 100
+	btn_isGettingConfig.Store(false)
+
+	BTN_GetConfig()
+
+	if btnConfig == nil {
+		t.Fatal("BTN_GetConfig should populate btnConfig")
+	}
+	if btnConfig.MinMainVersion != 1 || btnConfig.MaxMainVersion != 3 {
+		t.Fatalf("unexpected protocol range: min=%d max=%d", btnConfig.MinMainVersion, btnConfig.MaxMainVersion)
+	}
+	ability, ok := btnConfig.Ability["submit_peers"]
+	if !ok {
+		t.Fatal("submit_peers ability should exist")
+	}
+	if ability.Endpoint != "https://btn.example/submit_peers" {
+		t.Fatalf("Endpoint=%q, want https://btn.example/submit_peers", ability.Endpoint)
+	}
+	if btn_lastGetConfig != 100 {
+		t.Fatalf("btn_lastGetConfig=%d, want 100", btn_lastGetConfig)
+	}
+}

BTN_test.go

@@ -155,6 +155,10 @@ Docker version is configured through the same name variable configuration, which
 | logToFile | bool | true | Log general information to file. If enabled, it can be used for general analysis and statistical purposes |
 | logDebug | bool | false | Log debug information to file (Must enable debug and logToFile). If enabled, it can be used for advanced analysis and statistical purposes, but the amount of information is large |
 | listen | string | 127.0.0.1:26262 | Listen port. Used to provide BlockPeerList to some client (Transmission). For non-localhost, you can change to ```<Host>:<Port>``` |
+| webUI | bool | false | Enable the built-in WebUI. It exposes runtime status, recent blocks, and recent logs on a separate listener |
+| webUIListen | string | 127.0.0.1:7222 | WebUI listening address. If you expose it outside localhost, it is recommended to set ```webUIUsername``` and ```webUIPassword``` |
+| webUIUsername | string | Empty | WebUI Basic Auth username. When this field is empty, WebUI auth is disabled and ```webUIPassword``` is ignored |
+| webUIPassword | string | Empty | WebUI Basic Auth password. Only HTTP Basic Auth is provided; HTTPS is not included |
 | clientType | string | Empty | Client type. Available Web API or RPC address. Prerequisite for using blocker, if client config file cannot be automatically detect, must be filled in correctly. Currently support ```qBittorrent```/```Transmission```/```BitComet``` |
 | clientURL | string | Empty | Client address. Prerequisite for using blocker, if client config file cannot be automatically read, must be filled in correctly. Prefix must specify http or https protocol, such as ```http://127.0.0.1:990``` or ```http://127.0.0.1:9091/transmission/rpc``` |
 | clientUsername | string | Empty | Client username. Leaving it blank will skip authentication. If you enable client "Skip local client authentication", you can leave it blank by default, because the client config file can be automatically read and set |
@@ -166,10 +170,17 @@ Docker version is configured through the same name variable configuration, which
 | execCommand_FetchFailed | string | Empty | Execute external command (FetchFailed). First parameter is regarded as an external program path, execute the command when number of fetch failures exceeds set threshold |
 | execCommand_Run | string | Empty | Execute external command (Run). First parameter is regarded as an external program path, execute the command when program starts |
 | execCommand_Ban | string | Empty | Execute external command (Ban). First parameter is regarded as an external program path, and each parameter should be separated by ```\|```, command can use ```{peerIP}```/```{peerPort}```/```{torrentInfoHash}``` to use related info (peerPort=-1 means ban all port) |
-| execCommand_Ban | string | Empty | Execute external command (Ban). First parameter is regarded as an external program path, and each parameter should be separated by ```\|```, command can use ```{peerIP}```/```{peerPort}```/```{torrentInfoHash}``` to use related info (peerPort=-1 means ban all port) |
 | execCommand_Unban | string | Empty | Execute external command (Unban). First parameter is regarded as an external program path, and each parameter should be separated by ```\|```, command can use ```{peerIP}```/```{peerPort}```/```{torrentInfoHash}``` to use related info (peerPort=-1 means ban all port) |
 | syncServerURL | string | Empty | Sync server URL. Sync server will submit TorrentMap to server and receive BlockIPCIDR from server |
 | syncServerToken | string | Empty | Sync server Token. Some sync server may require authentication |
+| btnConfigureURL | string | Empty | BTN server URL. Currently not available, [What is BTN?](https://docs.pbh-btn.com/en/docs/btn/intro/) |
+| btnAppID | string | Empty | BTN AppID. Some BTN servers may require authentication |
+| btnAppSecret | string | Empty | BTN AppSecret. Some BTN servers may require authentication |
+| btnSyncRules | bool | true (Enable) | Sync BTN server cloud ban rules |
+| btnSyncException | bool | true (Enable) | Sync BTN server cloud exception rules (whitelist) |
+| btnSubmitPeers | bool | false (Disable) | Submit Peer snapshots to BTN server |
+| btnSubmitBans | bool | false (Disable) | Submit local ban records to BTN server |
+| btnSubmitHistories | bool | false (Disable) | Submit Peer traffic delta history snapshots to BTN server |
 | blockList | []string | Empty (Included in config.json) | Block client list. Judge PeerID or ClientName at the same time, case-insensitive, support regular expression |
 | blockListURL | []string | Empty | Block client list URL. Support format is same as blockList, one rule per line |
 | blockListFile | []string | Empty | Block client list File. Support format is same as blockList, one rule per line |

README.en.md

@@ -155,6 +155,10 @@ Docker 版本通过相同名称的环境变量配置, 通过自动转换环境
 | logToFile | bool | true (启用) | 记录普通信息到日志. 启用后可用于一般的分析及统计用途 |
 | logDebug | bool | false (禁用) | 记录调试信息到日志 (须先启用 debug 及 logToFile). 启用后可用于进阶的分析及统计用途, 但信息量较大 |
 | listen | string | 127.0.0.1:26262 | 监听端口. 用于向部分客户端 (Transmission) 提供 BlockPeerList. 非本机使用可改为 ```<Host>:<Port>``` |
+| webUI | bool | false (禁用) | 启用内置 WebUI. 可查看运行状态及最近日志 |
+| webUIListen | string | 127.0.0.1:7222 | WebUI 监听地址. 若暴露到非本机网络, 建议配合 ```webUIUsername```/```webUIPassword``` 使用 |
+| webUIUsername | string | 空 | WebUI Basic Auth 用户名. 留空时, WebUI 不启用认证 |
+| webUIPassword | string | 空 | WebUI Basic Auth 密码 |
 | clientType | string | 空 | 客户端类型. 使用客户端屏蔽器的前提条件, 若未能自动检测客户端类型, 则须正确填入. 目前支持 ```qBittorrent```/```Transmission```/```BitComet``` |
 | clientURL | string | 空 | 客户端地址. 可用 Web API 或 RPC 地址. 使用客户端屏蔽器的前提条件, 若未能自动读取客户端配置文件, 则须正确填入. 前缀必须指定 http 或 https 协议, 如 ```http://127.0.0.1:990/api``` 或 ```http://127.0.0.1:9091/transmission/rpc``` |
 | clientUsername | string | 空 | 客户端账号. 留空会跳过认证. 若启用客户端内 "跳过本机客户端认证" 可默认留空, 因可自动读取客户端配置文件并设置 |
@@ -169,6 +173,14 @@ Docker 版本通过相同名称的环境变量配置, 通过自动转换环境
 | execCommand_Unban | string | 空 | 执行外部命令 (Unban). 首个参数被视作外部程序路径, 各参数均应使用 ```\|``` 分割, 命令可以使用 ```{peerIP}```/```{peerPort}```/```{torrentInfoHash}``` 来使用相关信息 (peerPort=-1 意味着全端口封禁) |
 | syncServerURL | string | 空 | 同步服务器 URL. 同步服务器会将 TorrentMap 提交至服务器, 并从服务器接收屏蔽 IPCIDR 列表 |
 | syncServerToken | string | 空 | 同步服务器 Token. 部分同步服务器可能需要认证 |
+| btnConfigureURL | string | 空 | BTN 服务器 URL. 目前尚不可用, [什么是 BTN?](https://docs.pbh-btn.com/docs/btn/intro/) |
+| btnAppID | string | 空 | BTN AppID. 部分 BTN 服务器可能需要认证 |
+| btnAppSecret | string | 空 | BTN AppSecret. 部分 BTN 服务器可能需要认证 |
+| btnSyncRules | bool | true (启用) | 同步 BTN 服务器的云端封禁规则 |
+| btnSyncException | bool | true (启用) | 同步 BTN 服务器的云端例外规则 (白名单) |
+| btnSubmitPeers | bool | false (禁用) | 上报 Peer 快照至 BTN 服务器 |
+| btnSubmitBans | bool | false (禁用) | 上报本地封禁记录至 BTN 服务器 |
+| btnSubmitHistories | bool | false (禁用) | 上报 Peer 流量增量历史至 BTN 服务器 |
 | blockList | []string | 空 (于 config.json 附带) | 屏蔽客户端列表. 同时判断 PeerID 及 ClientName, 不区分大小写, 支持正则表达式 |
 | blockListURL | []string | 空 | 屏蔽客户端列表 URL. 支持格式同 blockList, 一行一条 |
 | blockListFile | []string | 空 | 屏蔽客户端列表文件. 支持格式同 blockList, 一行一条 |

README.md

@@ -4,6 +4,8 @@ import (
 	"encoding/json"
 	"github.com/tidwall/jsonc"
 	"net"
+	"sync"
+	"sync/atomic"
 )
 
 type SyncServer_ConfigStruct struct {
@@ -18,17 +20,25 @@ type SyncServer_SubmitStruct struct {
 	TorrentMap map[string]TorrentInfoStruct `json:"torrentMap"`
 }
 
-var syncServer_isSubmiting bool = false
+type SyncServer_RuleStruct struct {
+	Net    *net.IPNet
+	Reason string
+}
+
+var syncServer_isSubmiting atomic.Bool
 var syncServer_lastSync int64 = 0
 var syncServer_syncConfig = SyncServer_ConfigStruct{
 	Interval:    60,
 	Status:      "",
 	BlockIPRule: make(map[string][]string),
 }
-var ipBlockCIDRMapFromSyncServerCompiled = make(map[string]*net.IPNet)
+var syncServer_CompiledRules []SyncServer_RuleStruct
+var ipBlockCIDRMapMutex sync.RWMutex
 
 func SyncWithServer_PrepareJSON(torrentMap map[string]TorrentInfoStruct) (bool, string) {
-	syncJSON, err := json.Marshal(SyncServer_SubmitStruct{Version: 1, Timestamp: currentTimestamp, Token: config.SyncServerToken, TorrentMap: torrentMap})
+	torrentMapMutex.RLock()
+	syncJSON, err := json.Marshal(SyncServer_SubmitStruct{Version: 1, Timestamp: atomic.LoadInt64(&currentTimestamp), Token: config.SyncServerToken, TorrentMap: torrentMap})
+	torrentMapMutex.RUnlock()
 	if err != nil {
 		Log("SyncWithServer_PrepareJSON", GetLangText("Error-GenJSON"), true, err.Error())
 		return false, ""
@@ -38,13 +48,12 @@ func SyncWithServer_PrepareJSON(torrentMap map[string]TorrentInfoStruct) (bool,
 }
 func SyncWithServer_Submit(syncJSON string) bool {
 	_, _, syncServerContent := Submit(config.SyncServerURL, syncJSON, false, false, nil)
-	syncServer_isSubmiting = false
 	if syncServerContent == nil {
 		Log("SyncWithServer", GetLangText("Error-FetchResponse2"), true)
 		return false
 	}
 
-	// Max 8MB.
+	// 最大 8MB.
 	if len(syncServerContent) > 8388608 {
 		Log("SyncWithServer", GetLangText("Error-LargeFile"), true)
 		return false
@@ -60,7 +69,7 @@ func SyncWithServer_Submit(syncJSON string) bool {
 		return false
 	}
 
-	tmpIPBlockCIDRMapFromSyncServerCompiled := make(map[string]*net.IPNet)
+	var tmpSyncServerCompiledRules []SyncServer_RuleStruct
 
 	for reason, ipArr := range syncServer_syncConfig.BlockIPRule {
 		logReason := false
@@ -72,11 +81,6 @@ func SyncWithServer_Submit(syncJSON string) bool {
 				continue
 			}
 
-			if cidr, exists := ipBlockCIDRMapFromSyncServerCompiled[ipBlockListLine]; exists {
-				tmpIPBlockCIDRMapFromSyncServerCompiled[ipBlockListLine] = cidr
-				continue
-			}
-
 			Log("Debug-SyncWithServer_Compile", ":%d %s", false, ipBlockListLineNum, ipBlockListLine)
 			cidr := ParseIPCIDR(ipBlockListLine)
 			if cidr == nil {
@@ -89,25 +93,43 @@ func SyncWithServer_Submit(syncJSON string) bool {
 				Log("SyncWithServer", GetLangText("SyncWithServer_Compile-BlockByReason"), true, reason)
 			}
 
-			tmpIPBlockCIDRMapFromSyncServerCompiled[ipBlockListLine] = cidr
+			tmpSyncServerCompiledRules = append(tmpSyncServerCompiledRules, SyncServer_RuleStruct{Net: cidr, Reason: reason})
 			Log("SyncWithServer_BlockCIDR", ":%d %s", false, ipBlockListLineNum, ipBlockListLine)
 		}
 	}
 
-	ipBlockCIDRMapFromSyncServerCompiled = tmpIPBlockCIDRMapFromSyncServerCompiled
+	ipBlockCIDRMapMutex.Lock()
+	syncServer_CompiledRules = tmpSyncServerCompiledRules
+	ipBlockCIDRMapMutex.Unlock()
 
-	Log("Debug-SyncWithServer", GetLangText("Success-SyncWithServer"), true, len(ipBlockCIDRMapFromSyncServerCompiled))
+	Log("Debug-SyncWithServer", GetLangText("Success-SyncWithServer"), true, len(syncServer_CompiledRules))
 	return true
 }
+
+func SyncServer_CheckPeer(ipObj net.IP) (bool, string) {
+	if ipObj == nil {
+		return false, ""
+	}
+
+	ipBlockCIDRMapMutex.RLock()
+	defer ipBlockCIDRMapMutex.RUnlock()
+
+	for _, rule := range syncServer_CompiledRules {
+		if rule.Net != nil && rule.Net.Contains(ipObj) {
+			return true, "Bad-IP_FromSyncServer (" + rule.Reason + ")"
+		}
+	}
+
+	return false, ""
+}
 func SyncWithServer_FullSubmit(syncJSON string) bool {
-	syncServer_isSubmiting = true
 	syncStatus := SyncWithServer_Submit(syncJSON)
-	syncServer_isSubmiting = false
+	syncServer_isSubmiting.Store(false)
 
 	return syncStatus
 }
 func SyncWithServer() bool {
-	if config.SyncServerURL == "" || (syncServer_lastSync+int64(syncServer_syncConfig.Interval)) > currentTimestamp || syncServer_isSubmiting {
+	if config.SyncServerURL == "" || (atomic.LoadInt64(&syncServer_lastSync)+int64(syncServer_syncConfig.Interval)) > atomic.LoadInt64(&currentTimestamp) || syncServer_isSubmiting.Load() {
 		return true
 	}
 
@@ -118,9 +140,13 @@ func SyncWithServer() bool {
 		return false
 	}
 
-	syncServer_lastSync = currentTimestamp
+	atomic.StoreInt64(&syncServer_lastSync, atomic.LoadInt64(&currentTimestamp))
 
-	go SyncWithServer_FullSubmit(syncJSON)
+	if syncServer_isSubmiting.CompareAndSwap(false, true) {
+		GoWithCrashLog("SyncWithServer_FullSubmit", func() {
+			SyncWithServer_FullSubmit(syncJSON)
+		})
+	}
 
 	return true
 }