feat(proxy): config for ForwardedHeadersOptions

GZTimeWalker · Aug 7, 2023 · 31413cf · 31413cf
1 parent f456012
commit 31413cf
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 13 deletions.
diff --git a/docs/pages/config/appsettings.zh.mdx b/docs/pages/config/appsettings.zh.mdx
@@ -76,6 +76,7 @@ import { Callout } from "nextra-theme-docs";
     "RecaptchaThreshold": "0.5"
   },
   "ForwardedHeadersOptions": {
+    "ForwardedHeaders": 5, // a flag enum, see following link
     "ForwardLimit": 1,
     "ForwardedForHeaderName": "X-Forwarded-For"
   }
@@ -187,6 +188,7 @@ GZCTF 仅支持 PostgreSQL 作为数据库，不支持 MySQL 等其他数据库
 
 此处配置反向代理的相关信息，用于获取真实 IP 地址，可选项。
 
+- **ForwardedHeaders:** 反向代理转发的标头枚举，默认请使用 `5`，详情请见 [ForwardedHeaders 枚举](https://learn.microsoft.com/zh-cn/dotnet/api/microsoft.aspnetcore.httpoverrides.forwardedheaders?view=aspnetcore-7.0)
 - **ForwardLimit:** 反向代理层数限制
 - **ForwardedForHeaderName:** 反向代理 IP 地址头名称
 

diff --git a/src/GZCTF/Program.cs b/src/GZCTF/Program.cs
@@ -240,18 +240,6 @@
 
 Log.Logger = LogHelper.GetLogger(app.Configuration, app.Services);
 
-if (app.Environment.IsDevelopment())
-{
-    app.UseDeveloperExceptionPage();
-    app.UseOpenApi(options => options.PostProcess += (document, _) => document.Servers.Clear());
-    app.UseSwaggerUi3();
-}
-else
-{
-    app.UseExceptionHandler("/Error");
-    app.UseHsts();
-}
-
 await app.RunPrelaunchWork();
 
 app.UseResponseCompression();
@@ -267,6 +255,18 @@
 
 app.UseForwardedHeaders();
 
+if (app.Environment.IsDevelopment())
+{
+    app.UseDeveloperExceptionPage();
+    app.UseOpenApi(options => options.PostProcess += (document, _) => document.Servers.Clear());
+    app.UseSwaggerUi3();
+}
+else
+{
+    app.UseExceptionHandler("/Error");
+    app.UseHsts();
+}
+
 app.UseRouting();
 
 app.UseAuthentication();

diff --git a/src/GZCTF/Utils/LogHelper.cs b/src/GZCTF/Utils/LogHelper.cs
@@ -84,10 +84,14 @@ public static void UseRequestLogging(this WebApplication app)
     {
         app.UseSerilogRequestLogging(options =>
         {
-            options.MessageTemplate = "[{StatusCode}] @{Elapsed,8:####0.00}ms HTTP {RequestMethod,-6} {RequestPath}";
+            options.MessageTemplate = "[{StatusCode}] @{Elapsed,8:####0.00}ms HTTP {RequestMethod,-6} {RequestPath} From {RemoteIP}";
             options.GetLevel = (context, time, ex) =>
                 time > 10000 && context.Response.StatusCode != 101 ? LogEventLevel.Warning :
                 (context.Response.StatusCode > 499 || ex is not null) ? LogEventLevel.Error : LogEventLevel.Debug;
+            options.EnrichDiagnosticContext = (diagnosticContext, httpContext) =>
+            {
+                diagnosticContext.Set("RemoteIP", httpContext.Connection.RemoteIpAddress);
+            };
         });
     }