ToB企服应用市场:ToB评测及商务社交产业平台

标题: C#进阶-基于.NET Framework 4.x框架实现ASP.NET WebForms项目IP拦截器 [打印本页]
作者: 祗疼妳一个    时间: 2024-7-19 07:08
标题: C#进阶-基于.NET Framework 4.x框架实现ASP.NET WebForms项目IP拦截器
在这篇文章中，我们将探究如何在 ASP.NET WebForms 中实现IP拦截器，以便在 ASMX Web 服务方法 和 HTTP 请求 中根据IP地址举行访问控制。我们将使用自界说的 SoapExtension 和 IHttpModule 来实现这一功能，并根据常用的两种文本传输协议：SOAP协议 和 HTTP协议举行分别讲解。
一、创建ASMX接口文件

首先，我们创建一个 ASP.NET WebForms 项目，创建 TestAsmxProject.Asmx 文件，并界说内里的 WebService 服务。
如果不会创建 ASMX 文件，可以参考我的上一篇文章：C#进阶-ASP.NET WebForms调用ASMX的WebService接口。
TestAsmxProject.Asmx 代码如下：
  1. using System.Web.Services;
  3. namespace TestAsmxProject.Asmx
  4. {
  5.     /// <summary>
  6.     /// Test 的摘要说明
  7.     /// </summary>
  8.     [WebService(Namespace = "http://tempuri.org/")]
  9.     [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
  10.     [System.ComponentModel.ToolboxItem(false)]
  11.     // 若要允许使用 ASP.NET AJAX 从脚本中调用此 Web 服务，请取消注释以下行。
  12.     [System.Web.Script.Services.ScriptService]
  13.     public class Test : System.Web.Services.WebService
  14.     {
  16.         [WebMethod]
  17.         public string HelloWorld()
  18.         {
  19.             return "Hello World";
  20.         }
  22.         [WebMethod(Description = "计算两个数的和")]
  23.         public int Add(int a, int b)
  24.         {
  25.             return a + b;
  26.         }
  28.     }
  29. }
复制代码
从这个类我们可以看到，目前是有两个 WebService 方法：HelloWorld 方法和 Add方法。调用 HelloWorld 方法会返回 "Hello World" 字符串；用 Add 方法，必要传入 a 和 b 两个参数，会返回 a 和 b 相加的和。
二、基于SOAP协议的拦截器实现

创建一个自界说的 SoapExtension 来实现IP拦截。我们还必要一个自界说属性来指定允许的IP地址。
1. 创建IpFilterAttribute类

新建 Filter 文件夹，再在 Filter 文件夹里新建 SOAP 文件夹。

在 SOAP 文件夹里创建 IpFilterAttribute 类。


IpFilterAttribute.cs 代码如下：
  1. using System;
  2. using System.Web.Services.Protocols;
  4. namespace TestAsmxProject.Filter.SOAP
  5. {
  6.     [AttributeUsage(AttributeTargets.Method)]
  7.     public class IpFilterAttribute : SoapExtensionAttribute
  8.     {
  9.         public override Type ExtensionType => typeof(IpFilter);
  11.         public override int Priority { get; set; }
  13.         public string[] AllowedIps { get; private set; }
  15.         public IpFilterAttribute(params string[] ips)
  16.         {
  17.             AllowedIps = ips.Length > 0 ? ips : null;
  18.             Priority = 1;
  19.         }
  20.     }
  21. }
复制代码

2. 创建基于SoapExtension的IpFilter注解类

创建 IpFilter.cs，继承 SoapExtension。

IpFilter.cs 代码如下：
  1. using System;
  2. using System.Configuration;
  3. using System.Linq;
  4. using System.Web;
  5. using System.Web.Services.Protocols;
  7. namespace TestAsmxProject.Filter.SOAP
  8. {
  9.     public class IpFilter : SoapExtension
  10.     {
  11.         private string[] allowedIps;
  13.         public override object GetInitializer(LogicalMethodInfo methodInfo, SoapExtensionAttribute attribute)
  14.         {
  15.             var ipFilterAttribute = attribute as IpFilterAttribute;
  16.             return ipFilterAttribute?.AllowedIps;
  17.         }
  19.         public override object GetInitializer(Type serviceType)
  20.         {
  21.             return null;
  22.         }
  24.         public override void Initialize(object initializer)
  25.         {
  26.             allowedIps = initializer as string[];
  27.         }
  29.         public override void ProcessMessage(SoapMessage message)
  30.         {
  31.             switch (message.Stage)
  32.             {
  33.                 case SoapMessageStage.BeforeSerialize:
  34.                     break;
  35.                 case SoapMessageStage.AfterSerialize:
  36.                     break;
  37.                 case SoapMessageStage.BeforeDeserialize:
  38.                     CheckIpValidation(message);
  39.                     break;
  40.                 case SoapMessageStage.AfterDeserialize:
  41.                     break;
  42.             }
  43.         }
  45.         private void CheckIpValidation(SoapMessage message)
  46.         {
  47.             try
  48.             {
  49.                 string clientIp = HttpContext.Current.Request.ServerVariables["HTTP_X_FORWARDED_FOR"];
  50.                 if (string.IsNullOrEmpty(clientIp))
  51.                 {
  52.                     clientIp = HttpContext.Current.Request.ServerVariables["REMOTE_ADDR"];
  53.                 }
  54.                 if (!IsValidIp(clientIp))
  55.                 {
  56.                     HttpContext.Current.Response.Clear();
  57.                     HttpContext.Current.Response.StatusCode = 403;
  58.                     HttpContext.Current.Response.ContentType = "text/plain";
  59.                     HttpContext.Current.Response.Write("Access denied: Your IP address is not allowed.");
  60.                     HttpContext.Current.Response.End();
  61.                 }
  62.             }
  63.             catch (Exception ex)
  64.             {
  65.                 throw;
  66.             }
  67.         }
  69.         private bool IsValidIp(string ip)
  70.         {
  71.             string configIps = ConfigurationManager.AppSettings["IpWhiteList"];
  72.             string[] configAllowedIps = !string.IsNullOrWhiteSpace(configIps)
  73.                 ? configIps.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries)
  74.                 : new string[] { };
  75.             var allAllowedIps = (allowedIps == null ? new string[] { } : allowedIps).Concat(configAllowedIps).ToArray();
  76.             return allAllowedIps.Any(allowIp => ip == allowIp);
  77.         }
  78.     }
  79. }
复制代码

3. 设置web.config中IP白名单

在 web.config 文件中设置白名单IP列表，在 IpFilter.cs 里我们已经写过该逻辑，web.config 文件中白名单内的 IpWhiteList 里的IP是全局白名单，无论 WebService服务方法 上是否有 [IpFilter] 注解。
  1. <configuration>
  2.   <appSettings>
  3.     <add key="IpWhiteList" value="127.0.0.1,192.168.1.1" />
  4.   </appSettings>
  5. </configuration>
复制代码
4. 在WebService方法上添加注解

在 WebService服务方法 上使用 [IpFilter] 注解，可以界说该方法的专属IP白名单（包含 web.config 中的全局白名单），如果不设定，则仅使用 web.config 中的白名单。
加了 [IpFilter] 注解后的 TestAsmxProject.Asmx 代码如下：
  1. using System.Web.Services;
  2. using TestAsmxProject.Filter.SOAP;
  4. namespace TestAsmxProject.Asmx
  5. {
  6.     /// <summary>
  7.     /// Test 的摘要说明
  8.     /// </summary>
  9.     [WebService(Namespace = "http://tempuri.org/")]
  10.     [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
  11.     [System.ComponentModel.ToolboxItem(false)]
  12.     // 若要允许使用 ASP.NET AJAX 从脚本中调用此 Web 服务，请取消注释以下行。
  13.     [System.Web.Script.Services.ScriptService]
  14.     public class Test : System.Web.Services.WebService
  15.     {
  17.         [WebMethod]
  18.         [IpFilter] // 不传入指定IP，使用web.config中的白名单
  19.         public string HelloWorld()
  20.         {
  21.             return "Hello World";
  22.         }
  24.         [WebMethod(Description = "计算两个数的和")]
  25.         [IpFilter("127.0.0.1", "192.168.1.1")] // 此处为该方法的IP白名单，加上web.config中的白名单共同生效
  26.         public int Add(int a, int b)
  27.         {
  28.             return a + b;
  29.         }
  31.     }
  32. }
复制代码

三、基于HTTP协议的拦截器实现

接下来，我们创建一个基于HTTP协议的拦截器来实现IP拦截。同样，我们必要一个自界说属性来指定允许的IP地址。
1. 创建IpFilterAttribute类

新建 Filter 文件夹，再在 Filter 文件夹里新建 HTTP 文件夹。

在 SOAP 文件夹里创建 IpFilterAttribute 类。


IpFilterAttribute.cs 代码如下：
  1. using System;
  2. using System.Configuration;
  4. namespace TestAsmxProject.Filter.HTTP
  5. {
  6.     [AttributeUsage(AttributeTargets.Method, Inherited = true, AllowMultiple = false)]
  7.     public sealed class IpFilterAttribute : Attribute
  8.     {
  9.         public string[] AllowedIps { get; private set; }
  11.         public IpFilterAttribute(params string[] ips)
  12.         {
  13.             string configIps = ConfigurationManager.AppSettings["IpWhiteList"];
  14.             var configAllowedIps = !string.IsNullOrEmpty(configIps)
  15.                 ? configIps.Split(new[] { ',' }, StringSplitOptions.RemoveEmptyEntries)
  16.                 : new string[] { };
  17.             AllowedIps = new string[ips.Length + configAllowedIps.Length];
  18.             ips.CopyTo(AllowedIps, 0);
  19.             configAllowedIps.CopyTo(AllowedIps, ips.Length);
  20.         }
  22.         public bool IsAllowedIp(string userIp)
  23.         {
  24.             return AllowedIps.Any(ip => userIp == ip);
  25.         }
  26.     }
  27. }
复制代码
2. 创建基于IHttpModule的IpFilter注解类

创建 IpFilter.cs，继承 IHttpModule。

IpFilter.cs 代码如下：
  1. using System;
  2. using System.Linq;
  3. using System.Reflection;
  4. using System.Web;
  6. namespace TestAsmxProject.Filter.HTTP
  7. {
  8.     public class IpFilter : IHttpModule
  9.     {
  10.         public void Init(HttpApplication context)
  11.         {
  12.             context.PreRequestHandlerExecute += new EventHandler(OnPreRequestHandlerExecute);
  13.         }
  15.         private void OnPreRequestHandlerExecute(object sender, EventArgs e)
  16.         {
  17.             HttpApplication application = (HttpApplication)sender;
  18.             HttpContext context = application.Context;
  19.             if (context.Request.Path.Contains(".asmx"))
  20.             {
  21.                 string userIp = context.Request.UserHostAddress;
  22.                 string methodName = context.Request.PathInfo.Replace("/", "");
  24.                 Type webServiceType = GetWebServiceType(context.Request.Path);
  25.                 if (webServiceType != null)
  26.                 {
  27.                     MethodInfo methodInfo = webServiceType.GetMethod(methodName);
  28.                     if (methodInfo != null)
  29.                     {
  30.                         var attribute = methodInfo.GetCustomAttribute<IpFilterAttribute>();
  31.                         if (attribute != null && !attribute.IsAllowedIp(userIp))
  32.                         {
  33.                             context.Response.StatusCode = 403;
  34.                             context.Response.ContentType = "text/plain";
  35.                             context.Response.Write("Access denied: Your IP address is not allowed.");
  36.                             context.Response.End();
  37.                         }
  38.                     }
  39.                 }
  40.             }
  41.         }
  43.         private Type GetWebServiceType(string path)
  44.         {
  45.             string serviceName = path.Split('/')[2].Split('.').First();
  46.             string namespacePrefix = "WebForms.CAS";
  47.             string typeName = $"{namespacePrefix}.{serviceName}";
  48.             Type serviceType = Type.GetType(typeName);
  49.             if (serviceType == null)
  50.             {
  51.                 var assemblies = AppDomain.CurrentDomain.GetAssemblies();
  52.                 foreach (var assembly in assemblies)
  53.                 {
  54.                     serviceType = assembly.GetType(typeName);
  55.                     if (serviceType != null)
  56.                     {
  57.                         break;
  58.                     }
  59.                 }
  60.             }
  61.             return serviceType;
  62.         }
  64.         public void Dispose() { }
  65.     }
  66. }
复制代码
3. 设置web.config中白名单和模块

在 web.config 文件中设置白名单IP列表，在 IpFilter.cs 里我们已经写过该逻辑，web.config 文件中白名单内的 IpWhiteList 里的IP是全局白名单，无论 WebService服务方法 上是否有 [IpFilter] 注解。
  1. <configuration>
  2.   <appSettings>
  3.     <add key="IpWhiteList" value="127.0.0.1,192.168.1.1" />
  4.   </appSettings>
  5.   <system.web>
  6.     <httpModules>
  7.       <add name="IpFilter" type="TestAsmxProject.Filter.HTTP.IpFilter"/>
  8.     </httpModules>
  9.   </system.web>
  10.   <system.webServer>
  11.     <validation validateIntegratedModeConfiguration="false" />
  12.     <modules runAllManagedModulesForAllRequests="true">
  13.       <add name="IpFilter" type="TestAsmxProject.Filter.HTTP.IpFilter"/>
  14.     </modules>
  15.   </system.webServer>
  16. </configuration>
复制代码
4. 在WebService方法上添加注解

在 WebService服务方法 上使用 [IpFilter] 注解，可以界说该方法的专属IP白名单（包含 web.config 中的全局白名单），如果不设定，则仅使用 web.config 中的白名单。
加了 [IpFilter] 注解后的 TestAsmxProject.Asmx 代码如下：
  1. using System.Web.Services;
  2. using TestAsmxProject.Filter.HTTP;
  4. namespace TestAsmxProject.Asmx
  5. {
  6.     /// <summary>
  7.     /// Test 的摘要说明
  8.     /// </summary>
  9.     [WebService(Namespace = "http://tempuri.org/")]
  10.     [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
  11.     [System.ComponentModel.ToolboxItem(false)]
  12.     // 若要允许使用 ASP.NET AJAX 从脚本中调用此 Web 服务，请取消注释以下行。
  13.     [System.Web.Script.Services.ScriptService]
  14.     public class Test : System.Web.Services.WebService
  15.     {
  17.         [WebMethod]
  18.         [IpFilter] // 不传入指定IP，使用web.config中的白名单
  19.         public string HelloWorld()
  20.         {
  21.             return "Hello World";
  22.         }
  24.         [WebMethod(Description = "计算两个数的和")]
  25.         [IpFilter("127.0.0.1", "192.168.1.1")] // 此处为该方法的IP白名单，加上web.config中的白名单共同生效
  26.         public int Add(int a, int b)
  27.         {
  28.             return a + b;
  29.         }
  31.     }
  32. }
复制代码

四、IP拦截器实现总结

通过上述步骤，我们乐成实现了在 ASP.NET WebForms 中基于IP地址的访问控制。我们分别使用自界说的 SoapExtension 和 IHttpModule，实现了对ASMX Web服务方法和HTTP请求的IP拦截。
1. 自界说 SoapExtension

自界说的 SoapExtension 通过重载 ProcessMessage 方法，在SOAP消息处理的不同阶段举行IP地址的验证。通过检查请求的IP地址并与允许的IP列表举行比力，我们可以在消息反序列化之前制止不符合条件的请求，从而有效地控制对Web服务方法的访问。这种方法特别适用于基于SOAP的Web服务，能够在服务方法调用之前举行精致的访问控制。
2. 自界说 IHttpModule

自界说的 IHttpModule 通过实现 Init 方法并注册 PreRequestHandlerExecute 事故，在每个HTTP请求处理之前执行IP地址验证。通过反射获取请求对应的方法，并检查方法上的自界说属性 IpFilterAttribute，我们可以动态地对特定方法应用IP过滤规则。联合 web.config 中设置的白名单IP地址，这种方法能够机动地扩展和维护IP访问控制规则，适用于一般的HTTP请求拦截需求。
3. 本文提供方法的实现优势

这种IP拦截器的实现方法不但增强了应用程序的安全性，还具有良好的扩展性和可维护性。开辟者可以根据详细需求，通过设置文件或代码注解机动地管理允许的IP地址。通过将安全控制逻辑封装在自界说模块和扩展中，可以保持业务代码的简洁和可读性。
希望这篇文章对你在ASP.NET WebForms应用中的IP访问控制有所资助。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4