feat: 新增日志脱敏功能

ruoyi-fastapi-backend/.env.dev

@@ -78,6 +78,21 @@ REDIS_PASSWORD = ''
 REDIS_DATABASE = 2
 
 # -------- 日志配置 --------
+# 是否启用日志脱敏
+LOG_MASK_ENABLED = false
+# 日志脱敏占位符
+LOG_MASK_PLACEHOLDER = '******'
+# 以下三项为互补关系（非互斥）：
+# 1) LOG_MASK_FIELDS：命中后执行全量脱敏
+# 2) LOG_PARTIAL_MASK_FIELDS：命中后执行部分脱敏
+# 3) LOG_CONFIG_SECRET_PATTERNS：按 configKey 关键词决定是否脱敏 configValue
+# 全量脱敏字段，多个值使用逗号分隔
+LOG_MASK_FIELDS = 'password,old_password,new_password,confirm_password,api_key,token,access_token,refresh_token,authorization,client_secret,secret,secret_key,private_key,private_key_pem,credential,credentials,sms_code,captcha_code,system_prompt'
+# 部分脱敏字段，多个值使用逗号分隔
+# 当前默认不对IP脱敏；如后期需要开启，可直接追加 ip,ipaddr,oper_ip,login_ip 并重启服务
+LOG_PARTIAL_MASK_FIELDS = 'phonenumber,phone,mobile,email'
+# 按配置键名识别敏感配置的关键词，多个值使用逗号分隔
+LOG_CONFIG_SECRET_PATTERNS = 'password,token,secret,key,private,credential,access,jwt,captcha,sms'
 # Redis Stream Key
 LOG_STREAM_KEY = 'log:stream'
 # Redis Stream 消费组名称

ruoyi-fastapi-backend/.env.dockermy

@@ -78,6 +78,21 @@ REDIS_PASSWORD = ''
 REDIS_DATABASE = 2
 
 # -------- 日志配置 --------
+# 是否启用日志脱敏
+LOG_MASK_ENABLED = true
+# 日志脱敏占位符
+LOG_MASK_PLACEHOLDER = '******'
+# 以下三项为互补关系（非互斥）：
+# 1) LOG_MASK_FIELDS：命中后执行全量脱敏
+# 2) LOG_PARTIAL_MASK_FIELDS：命中后执行部分脱敏
+# 3) LOG_CONFIG_SECRET_PATTERNS：按 configKey 关键词决定是否脱敏 configValue
+# 全量脱敏字段，多个值使用逗号分隔
+LOG_MASK_FIELDS = 'password,old_password,new_password,confirm_password,api_key,token,access_token,refresh_token,authorization,client_secret,secret,secret_key,private_key,private_key_pem,credential,credentials,sms_code,captcha_code,system_prompt'
+# 部分脱敏字段，多个值使用逗号分隔
+# 当前默认不对IP脱敏；如后期需要开启，可直接追加 ip,ipaddr,oper_ip,login_ip 并重启服务
+LOG_PARTIAL_MASK_FIELDS = 'phonenumber,phone,mobile,email'
+# 按配置键名识别敏感配置的关键词，多个值使用逗号分隔
+LOG_CONFIG_SECRET_PATTERNS = 'password,token,secret,key,private,credential,access,jwt,captcha,sms'
 # Redis Stream Key
 LOG_STREAM_KEY = 'log:stream'
 # Redis Stream 消费组名称

ruoyi-fastapi-backend/.env.dockerpg

@@ -78,6 +78,21 @@ REDIS_PASSWORD = ''
 REDIS_DATABASE = 2
 
 # -------- 日志配置 --------
+# 是否启用日志脱敏
+LOG_MASK_ENABLED = true
+# 日志脱敏占位符
+LOG_MASK_PLACEHOLDER = '******'
+# 以下三项为互补关系（非互斥）：
+# 1) LOG_MASK_FIELDS：命中后执行全量脱敏
+# 2) LOG_PARTIAL_MASK_FIELDS：命中后执行部分脱敏
+# 3) LOG_CONFIG_SECRET_PATTERNS：按 configKey 关键词决定是否脱敏 configValue
+# 全量脱敏字段，多个值使用逗号分隔
+LOG_MASK_FIELDS = 'password,old_password,new_password,confirm_password,api_key,token,access_token,refresh_token,authorization,client_secret,secret,secret_key,private_key,private_key_pem,credential,credentials,sms_code,captcha_code,system_prompt'
+# 部分脱敏字段，多个值使用逗号分隔
+# 当前默认不对IP脱敏；如后期需要开启，可直接追加 ip,ipaddr,oper_ip,login_ip 并重启服务
+LOG_PARTIAL_MASK_FIELDS = 'phonenumber,phone,mobile,email'
+# 按配置键名识别敏感配置的关键词，多个值使用逗号分隔
+LOG_CONFIG_SECRET_PATTERNS = 'password,token,secret,key,private,credential,access,jwt,captcha,sms'
 # Redis Stream Key
 LOG_STREAM_KEY = 'log:stream'
 # Redis Stream 消费组名称

ruoyi-fastapi-backend/.env.prod

@@ -78,6 +78,21 @@ REDIS_PASSWORD = ''
 REDIS_DATABASE = 2
 
 # -------- 日志配置 --------
+# 是否启用日志脱敏
+LOG_MASK_ENABLED = true
+# 日志脱敏占位符
+LOG_MASK_PLACEHOLDER = '******'
+# 以下三项为互补关系（非互斥）：
+# 1) LOG_MASK_FIELDS：命中后执行全量脱敏
+# 2) LOG_PARTIAL_MASK_FIELDS：命中后执行部分脱敏
+# 3) LOG_CONFIG_SECRET_PATTERNS：按 configKey 关键词决定是否脱敏 configValue
+# 全量脱敏字段，多个值使用逗号分隔
+LOG_MASK_FIELDS = 'password,old_password,new_password,confirm_password,api_key,token,access_token,refresh_token,authorization,client_secret,secret,secret_key,private_key,private_key_pem,credential,credentials,sms_code,captcha_code,system_prompt'
+# 部分脱敏字段，多个值使用逗号分隔
+# 当前默认不对IP脱敏；如后期需要开启，可直接追加 ip,ipaddr,oper_ip,login_ip 并重启服务
+LOG_PARTIAL_MASK_FIELDS = 'phonenumber,phone,mobile,email'
+# 按配置键名识别敏感配置的关键词，多个值使用逗号分隔
+LOG_CONFIG_SECRET_PATTERNS = 'password,token,secret,key,private,credential,access,jwt,captcha,sms'
 # Redis Stream Key
 LOG_STREAM_KEY = 'log:stream'
 # Redis Stream 消费组名称