1.4.0

CHANGELOG.md

@@ -1,5 +1,28 @@
 # 更新日志
 
+v1.4.0
+---
+- CHANGE: 优化代码结构,提升性能
+- ADD: 新增auth子模块whitelist.go,支持白名单功能
+- ADD: 新增whitelist.json文件,用于配置白名单
+- CHANGE&ADD: 在config.yaml文件中新增白名单配置块
+- FIX: 由于临时加入且未在原开发路线上计划的白名单功能,导致函数命名冲突,在此修复blacklist.go的函数命名问题
+- FIX: 修复黑/白名单是否生效相关问题
+
+24w11b
+---
+- PRE-RELEASE: 此版本是v1.4.0的预发布版本,请勿在生产环境中使用
+- FIX: 修复黑/白名单是否生效相关问题
+
+24w11a
+---
+- PRE-RELEASE: 此版本是v1.4.0的预发布版本,请勿在生产环境中使用
+- **ANNOUNCE**: 自此版本起,DEV版本号格式进行修改,小版本号不再仅限于a/b,而是采用字母表顺序进行排列,此修改将带来一个重要改变,正式版前的预发布版本的数字版本号将会统一，以便于版本管理与发布管理
+- CHANGE: 优化代码结构,提升性能
+- ADD: 新增auth子模块whitelist.go,支持白名单功能
+- ADD: 新增whitelist.json文件,用于配置白名单
+- FIX: 由于临时加入且未在原开发路线上计划的白名单功能,导致函数命名冲突,在此修复blacklist.go的函数命名问题
+
 v1.3.1
 ---
 - CHANGE: 优化代码结构,提升性能
@@ -8,6 +31,7 @@ v1.3.1
 
 24w10a
 ---
+- PRE-RELEASE: 此版本是v1.3.1的预发布版本,请勿在生产环境中使用
 - CHANGE: 优化代码结构,提升性能
 - CHANGE: 剃刀计划,减少多余日志输出
 - CHANGE: 调整缓存参数
@@ -24,12 +48,14 @@ v1.3.0
 
 24w09b
 ---
+- PRE-RELEASE: 此版本是v1.3.0的预发布版本,请勿在生产环境中使用
 - CHANGE: 优化代码结构,提升性能
 - CHANGE: 修正配置,提升稳定性
 - WARNING: 此版本配置文件重构,此版本不再向前兼容,请注意备份文件并重新部署
 
 24w09a
 ---
+- PRE-RELEASE: 此版本是v1.3.0的预发布版本,请勿在生产环境中使用
 - CHANGE: 优化代码结构,提升性能
 - CHANGE: 优化黑名单功能,提升稳定性
 - CHANGE&ADD: 新增auth子模块blacklist.go
@@ -38,6 +64,7 @@ v1.3.0
 
 24w08b
 ---
+- PRE-RELEASE: 此版本是v1.3.0的预发布版本,请勿在生产环境中使用
 - CHANGE: 优化代码结构,提升性能
 - ADD & CHANGE: 新增仓库黑名单功能,改进Auth模块
 - ADD: 新增blacklist.yaml文件,用于配置仓库黑名单
@@ -54,6 +81,7 @@ v1.2.0
 
 24w08a
 ---
+- PRE-RELEASE: 此版本是v1.2.0的预发布版本,请勿在生产环境中使用
 - CHANGE: 同步更新logger模块，与golang-temp项目定义的开发规范保持一致
 - ADD: 新增日志翻转功能
 
@@ -65,12 +93,14 @@ v1.1.1
 
 24w07b
 ---
+- PRE-RELEASE: 此版本是v1.1.1的预发布版本,请勿在生产环境中使用
 - CHANGE: 修改部分代码，与golang-temp项目定义的开发规范保持一致
 - CHANGE: 更新Go版本至v1.23.2
 - CHANGE: 跟随Caddy更新,修改Caddyfile配置
 
 24w07a
 ---
+- PRE-RELEASE: 此版本是v1.1.1的预发布版本,请勿在生产环境中使用
 - CHANGE: 修改部分代码，与golang-temp项目定义的开发规范保持一致
 - CHANGE: 更新Go版本至v1.23.2
 
@@ -85,6 +115,7 @@ v1.1.0
 
 24w06b
 ---
+- PRE-RELEASE: 此版本是v1.1.0的预发布版本,请勿在生产环境中使用
 - CHANGE: 优化代码结构,对main函数进行模块化,提升可读性
 - CHANGE: Docker代理功能移至DEV版本内,保证稳定性
 - ADD&CHANGE: 增加Auth(用户鉴权)模块,并改进其的错误处理与日志记录
@@ -94,6 +125,7 @@ v1.1.0
 
 v1.0.0
 ---
+- **ANNOUNCE**: 项目正式发布, 并迁移至[WJQSERVER-STUDIO/ghproxy](https://github.com/WJQSERVER-STUDIO/ghproxy)，由Apache License Version 2.0转为WJQserver Studio License 请注意相关条例变更
 - CHANGE: 项目正式发布, 并迁移至[WJQSERVER-STUDIO/ghproxy](https://github.com/WJQSERVER-STUDIO/ghproxy)
 - CHANGE: 再次重构代码,优化性能,提升稳定性
 - CHANGE: 使用golang-temp项目作为底层构建,标准化日志与配置模块
@@ -101,6 +133,7 @@ v1.0.0
   
 24w06a
 ---
+- PRE-RELEASE: 此版本是v1.0.0的预发布版本,请勿在生产环境中使用
 - CHANGE: 与v1.0.0版本同步
 
 v0.2.0
@@ -112,21 +145,25 @@ v0.2.0
 
 24w05b
 ---
+- PRE-RELEASE: 此版本是v0.2.0的预发布版本,请勿在生产环境中使用
 - CHANGE: 重命名proxychrome函数
 - ADD: 增加多处日志记录,便于审计与排障
 
 24w05a
 ---
+- PRE-RELEASE: 此版本是v0.2.0的预发布版本,请勿在生产环境中使用
 - FIX： 修正上一版本的req请求未继承请求方式的问题
 - CHANGE: 优化代码结构,进一步模块化,同时提升性能
 
 24w04b
 ---
+- PRE-RELEASE: 此版本是v0.2.0的预发布版本,请勿在生产环境中使用
 - CHANGE: 更换Docker基础镜像为daily版本
 - ADD： 新增使用req库实现代理请求,使用chrome TLS指纹发起请求
 
 24w04a
 ---
+- PRE-RELEASE: 此版本是v0.2.0的预发布版本,请勿在生产环境中使用
 - CHANGE: 调整程序结构,使用init函数初始化配置,并优化代码结构
 
 v0.1.7
@@ -135,6 +172,7 @@ v0.1.7
 
 24w03b
 ---
+- PRE-RELEASE: 此版本是v0.1.7的预发布版本,请勿在生产环境中使用
 - CHANGE: 合入上游(wjqserver/caddy:latest)安全更新, 增强镜像安全性
 
 v0.1.6
@@ -144,6 +182,7 @@ v0.1.6
 
 24w03a
 ---
+- PRE-RELEASE: 此版本是v0.1.6的预发布版本,请勿在生产环境中使用
 - CHANGE: 改进Docker代理相关Caddy配置
 - ADD: 新增跨域配置选项
 
@@ -154,16 +193,17 @@ v0.1.5
 
 24w02b
 ---
+- PRE-RELEASE: 此版本是v0.1.5的预发布版本,请勿在生产环境中使用
 - ADD: 新增Docker代理 (未并入正式版)
 
 24w02a
 ---
+- PRE-RELEASE: 此版本是v0.1.5的预发布版本,请勿在生产环境中使用
 - CHANGE: 更新Go版本至v1.23.1
 - CHANGE: 优化代码行为
 
 v0.1.4
 ---
-正式版24w01b内容更新
 - ADD: 新增外部文件配置功能
 - ADD: 新增日志功能
 - CHANGE: 优化代码结构,提升性能
@@ -171,7 +211,7 @@ v0.1.4
 
 24w01b
 ---
-标志着项目正式进入自主开发阶段
+- PRE-RELEASE: 此版本是v0.1.4的预发布版本,请勿在生产环境中使用
 - ADD: 新增外部文件配置功能
 - ADD: 新增日志功能
 - CHANGE: 优化代码结构,提升性能
@@ -179,12 +219,13 @@ v0.1.4
 
 v0.1.3
 ---
-开始自行维护项目,脱离上游更新
+- **ANNOUNCE**: 开始自行维护项目,脱离上游更新
 - CHANGE: 改进已有实现,增强程序稳定性
 
 24w01a
 ---
-首个DEV版本
+- PRE-RELEASE: 此版本是v0.1.3的预发布版本,请勿在生产环境中使用
+- **ANNOUNCE**: 首个DEV版本发布
 - CHANGE: 同步更新
 
 v0.1.2

DEV-VERSION

@@ -1 +1 @@
-24w10a
+24w11b

README.md

@@ -51,7 +51,7 @@ git clone https://ghproxy.1888866.xyz/github.com/WJQSERVER-STUDIO/ghproxy.git
 - Docker-cli
 
 ```
-docker run -p 7210:80 -v ./ghproxy/log/run:/data/ghproxy/log -v ./ghproxy/log/caddy:/data/caddy/log --restart always wjqserver/ghproxy
+docker run -p 7210:80 -v ./ghproxy/log/run:/data/ghproxy/log -v ./ghproxy/log/caddy:/data/caddy/log -v ./ghproxy/config:/data/ghproxy/config  --restart always wjqserver/ghproxy
 ```
 
 - Docker-Compose
@@ -86,9 +86,14 @@ auth:
 
 # 黑名单配置
 blacklist:
-  enabled: true
+  enabled: true  # 是否开启黑名单
   blacklistfile: "/data/ghproxy/config/blacklist.json"
 
+# 白名单配置
+whitelist:
+  enabled: false  # 是否开启白名单
+  whitelistfile: "/data/ghproxy/config/whitelist.json"
+
 ```
 
 ### 黑名单配置
@@ -103,7 +108,21 @@ blacklist:
       "another/repo3"
     ]
   }
-```  
+```
+
+### 白名单配置
+
+白名单配置位于config/whitelist.json,格式如下:
+
+```json
+{
+    "whitelist": [
+      "test/test1",
+      "example/repo2",
+      "another/repo3"
+    ]
+  }
+```
 
 ### Caddy反代配置
 
@@ -128,6 +147,7 @@ example.com {
 - [x] 改进程序效率
 - [x] 用户鉴权
 - [x] 仓库黑名单
+- [x] 仓库白名单
 
 ### DEV
 

SECURITY.MD

@@ -7,15 +7,9 @@
 | 版本 | 是否支持 |
 | --- | --- |
 | v1.x.x | :white_check_mark: |
-| **w**a/b | :warning: 这是测试版本,用于开发测试,可能存在未知的安全隐患 |
+| **w**a/b/c... | :warning: 此为PRE-RELEASE版本,用于开发与测试,可能存在未知的问题 |
 | v0.x.x | :x: 这些版本不再受支持 |
 
-### 版本说明
-
-- **v1.0.0**: 这是正式发布的版本
-- **xx W xx A/B***: 这是开发测试版本,可能存在未知的安全隐患。不推荐在生产环境中使用。
-- **v0.x.x**: 这些早期版本不再受支持,建议尽快升级到 v1.0.0 或更高版本。
-
 ### 用户须知
 
 本项目为开源项目,开发者不对使用本项目造成的任何损失或问题承担责任。用户需自行评估并承担使用本项目的风险。

VERSION

@@ -1 +1 @@
-1.3.1
+1.4.0

auth/blacklist.go

@@ -6,19 +6,19 @@ import (
 	"os"
 )
 
-type Config struct {
+type BlacklistConfig struct {
 	Blacklist []string `json:"blacklist"`
 }
 
 var (
 	cfg           *config.Config
 	blacklistfile = "/data/ghproxy/config/blacklist.json"
-	blacklist     *Config
+	blacklist     *BlacklistConfig
 )
 
 func LoadBlacklist(cfg *config.Config) {
 	blacklistfile = cfg.Blacklist.BlacklistFile
-	blacklist = &Config{}
+	blacklist = &BlacklistConfig{}
 
 	data, err := os.ReadFile(blacklistfile)
 	if err != nil {
@@ -32,10 +32,10 @@ func LoadBlacklist(cfg *config.Config) {
 }
 
 func CheckBlacklist(fullrepo string) bool {
-	return forRangeCheck(blacklist.Blacklist, fullrepo)
+	return forRangeCheckBlacklist(blacklist.Blacklist, fullrepo)
 }
 
-func forRangeCheck(blist []string, fullrepo string) bool {
+func forRangeCheckBlacklist(blist []string, fullrepo string) bool {
 	for _, blocked := range blist {
 		if blocked == fullrepo {
 			return true

auth/whitelist.go

@@ -0,0 +1,44 @@
+package auth
+
+import (
+	"encoding/json"
+	"ghproxy/config"
+	"os"
+)
+
+type WhitelistConfig struct {
+	Whitelist []string `json:"whitelist"`
+}
+
+var (
+	whitelistfile = "/data/ghproxy/config/whitelist.json"
+	whitelist     *WhitelistConfig
+)
+
+func LoadWhitelist(cfg *config.Config) {
+	whitelistfile = cfg.Whitelist.WhitelistFile
+	whitelist = &WhitelistConfig{}
+
+	data, err := os.ReadFile(whitelistfile)
+	if err != nil {
+		logw("Failed to read whitelist file: %v", err)
+	}
+
+	err = json.Unmarshal(data, whitelist)
+	if err != nil {
+		logw("Failed to unmarshal whitelist JSON: %v", err)
+	}
+}
+
+func CheckWhitelist(fullrepo string) bool {
+	return forRangeCheckWhitelist(whitelist.Whitelist, fullrepo)
+}
+
+func forRangeCheckWhitelist(blist []string, fullrepo string) bool {
+	for _, blocked := range blist {
+		if blocked == fullrepo {
+			return true
+		}
+	}
+	return false
+}

caddyfile/dev/Caddyfile

@@ -76,6 +76,8 @@
     import error_page  
     import encode
     import rate_limit 60 
+    header Age 10
+    header Cache-Control "max-age=300"
     route / {
         root /data/www
         file_server

config/blacklist.json

@@ -1,8 +1,8 @@
 {
     "blacklist": [
+      "black/list",
       "test/test1",
-      "example/repo2",
-      "another/repo3"
+      "example/repo2"
     ]
   }
   

config/config.go

@@ -31,6 +31,11 @@ type Config struct {
 		Enabled       bool   `yaml:"enabled"`
 		BlacklistFile string `yaml:"blacklistfile"`
 	} `yaml:"blacklist"`
+
+	Whitelist struct {
+		Enabled       bool   `yaml:"enabled"`
+		WhitelistFile string `yaml:"whitelistfile"`
+	} `yaml:"whitelist"`
 }
 
 // LoadConfig 从 YAML 配置文件加载配置

config/config.yaml

@@ -20,5 +20,10 @@ auth:
 
 # Blacklist Configuration
 blacklist:
-  enabled: true
+  enabled: false
   blacklistfile: "/data/ghproxy/config/blacklist.json"
+
+# Whitelist Configuration
+whitelist:
+  enabled: false
+  whitelistfile: "/data/ghproxy/config/whitelist.json"

config/whitelist.json

@@ -0,0 +1,8 @@
+{
+    "whitelist": [
+      "white/list",
+      "white/test1",
+      "example/white"
+    ]
+  }
+  

docker/dockerfile/dev/Dockerfile

@@ -14,6 +14,7 @@ RUN VERSION=$(curl -s https://raw.githubusercontent.com/${USER}/${REPO}/main/DEV
     wget -O /data/${APPLICATION}/${APPLICATION} https://github.com/${USER}/${REPO}/releases/download/$VERSION/${APPLICATION}
 RUN wget -O /data/${APPLICATION}/config.yaml https://raw.githubusercontent.com/${USER}/${REPO}/main/config/config.yaml
 RUN wget -O /data/${APPLICATION}/blacklist.json https://raw.githubusercontent.com/${USER}/${REPO}/main/config/blacklist.json
+RUN wget -O /data/${APPLICATION}/whitelist.json https://raw.githubusercontent.com/${USER}/${REPO}/main/config/whitelist.json
 RUN wget -O /usr/local/bin/init.sh https://raw.githubusercontent.com/${USER}/${REPO}/main/init.sh
 RUN chmod +x /data/${APPLICATION}/${APPLICATION}
 RUN chmod +x /usr/local/bin/init.sh

docker/dockerfile/release/Dockerfile

@@ -14,6 +14,7 @@ RUN VERSION=$(curl -s https://raw.githubusercontent.com/${USER}/${REPO}/main/VER
     wget -O /data/${APPLICATION}/${APPLICATION} https://github.com/${USER}/${REPO}/releases/download/$VERSION/${APPLICATION}
 RUN wget -O /data/${APPLICATION}/config.yaml https://raw.githubusercontent.com/${USER}/${REPO}/main/config/config.yaml
 RUN wget -O /data/${APPLICATION}/blacklist.json https://raw.githubusercontent.com/${USER}/${REPO}/main/config/blacklist.json
+RUN wget -O /data/${APPLICATION}/whitelist.json https://raw.githubusercontent.com/${USER}/${REPO}/main/config/whitelist.json
 RUN wget -O /usr/local/bin/init.sh https://raw.githubusercontent.com/${USER}/${REPO}/main/init.sh
 RUN chmod +x /data/${APPLICATION}/${APPLICATION}
 RUN chmod +x /usr/local/bin/init.sh

init.sh

@@ -10,6 +10,10 @@ if [ ! -f /data/${APPLICATON}/config/blacklist.json ]; then
     cp /data/${APPLICATON}/blacklist.json /data/${APPLICATON}/config/blacklist.json
 fi
 
+if [ ! -f /data/${APPLICATON}/config/whitelist.json ]; then
+    cp /data/${APPLICATON}/whitelist.json /data/${APPLICATON}/config/whitelist.json
+fi
+
 if [ ! -f /data/${APPLICATON}/config/config.yaml ]; then
     cp /data/${APPLICATON}/config.yaml /data/${APPLICATON}/config/config.yaml
 fi

main.go

@@ -53,14 +53,15 @@ func setupLogger() {
 	logw("Init Completed")
 }
 
-func LoadBlacklist(cfg *config.Config) {
+func Loadlist(cfg *config.Config) {
 	auth.LoadBlacklist(cfg)
+	auth.LoadWhitelist(cfg)
 }
 
 func init() {
 	loadConfig()
 	setupLogger()
-	LoadBlacklist(cfg)
+	Loadlist(cfg)
 
 	// 设置 Gin 模式
 	gin.SetMode(gin.ReleaseMode)

proxy/proxy.go

@@ -55,13 +55,26 @@ func NoRouteHandler(cfg *config.Config) gin.HandlerFunc {
 		logw("Blacklist Check > Username: %s, Repo: %s", username, repo)
 		fullrepo := fmt.Sprintf("%s/%s", username, repo)
 
+		// 白名单检查
+		if cfg.Whitelist.Enabled {
+			whitelistpass := auth.CheckWhitelist(fullrepo)
+			if !whitelistpass {
+				errMsg := fmt.Sprintf("Whitelist Blocked repo: %s", fullrepo)
+				c.JSON(http.StatusForbidden, gin.H{"error": errMsg})
+				logw(errMsg)
+				return
+			}
+		}
+
 		// 黑名单检查
-		blacklistpass := auth.CheckBlacklist(fullrepo)
-		if blacklistpass {
-			errMsg := fmt.Sprintf("Blacklist Blocked repo: %s", fullrepo)
-			c.JSON(http.StatusForbidden, gin.H{"error": errMsg})
-			logw(errMsg)
-			return
+		if cfg.Blacklist.Enabled {
+			blacklistpass := auth.CheckBlacklist(fullrepo)
+			if blacklistpass {
+				errMsg := fmt.Sprintf("Blacklist Blocked repo: %s", fullrepo)
+				c.JSON(http.StatusForbidden, gin.H{"error": errMsg})
+				logw(errMsg)
+				return
+			}
 		}
 
 		matches = CheckURL(rawPath)
@@ -196,6 +209,9 @@ func CopyResponseHeaders(resp *req.Response, c *gin.Context, cfg *config.Config)
 	if cfg.CORS.Enabled {
 		c.Header("Access-Control-Allow-Origin", "*")
 	}
+
+	c.Header("Age", "10")
+	c.Header("Cache-Control", "max-age=300")
 }
 
 func HandleError(c *gin.Context, message string) {