JN.IpFilter 1.0.1


     Simple IP Filter for ASP.NET Core.

     Provides an IP Filter for paths exposed by the application using a list of valid (allowed) IP addresses for each path.

Install-Package JN.IpFilter -Version 1.0.1
dotnet add package JN.IpFilter --version 1.0.1
<PackageReference Include="JN.IpFilter" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add JN.IpFilter --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

JN.IpFilter

Simple IP Filter for ASP.NET Core.

Provides an IP Filter for paths exposed by the application using list of valid (allowed) IP addresses for each path.

If access is not allowed, an HTTP Forbidden (403) status code is returned, but this can be overridden (in options object - ResponseHttpStatusCode field).

More details available on the project website

Install

Download the package from NuGet:

Install-Package JN.IpFilter -Version [version number]

Usage

Use the UseIpFilter extension method to add the middleware inside the Configure method on the Startup class.

The UseIpFilter extension method needs a list of filters and an options object that can be read from configuration.

Example

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{

    // (...)

    var filters = Configuration.GetIpFilters("IpFilters");
    var options = Configuration.GetIpFilterOptions("IpFilterMiddlewareOptions");

    app.UseIpFilter(filters, options);

    //(...)
}

filters and options can be read from configuration:

{

  "IpFilterMiddlewareOptions": {
    "ExactPathMatch": false,
    "LogRequests": true,
    "ApplyOnlyToHttpMethod": "", 
    "ResponseHttpStatusCode": 401
  },

  "IpFilters": [
    {
      "Path": "/MyController",
      "IpList": "1.1.1.1;::1"
    },
    {
      "Path": "/MyController2",
      "IpList": "*"
    },
    {
      "Path": "/MyController3",
      "IpList": "2.2.2.2"
    }
  ],
}

JN.IpFilter

Simple IP Filter for ASP.NET Core.

Provides an IP Filter for paths exposed by the application using list of valid (allowed) IP addresses for each path.

If access is not allowed, an HTTP Forbidden (403) status code is returned, but this can be overridden (in options object - ResponseHttpStatusCode field).

More details available on the project website

Install

Download the package from NuGet:

Install-Package JN.IpFilter -Version [version number]

Usage

Use the UseIpFilter extension method to add the middleware inside the Configure method on the Startup class.

The UseIpFilter extension method needs a list of filters and an options object that can be read from configuration.

Example

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{

    // (...)

    var filters = Configuration.GetIpFilters("IpFilters");
    var options = Configuration.GetIpFilterOptions("IpFilterMiddlewareOptions");

    app.UseIpFilter(filters, options);

    //(...)
}

filters and options can be read from configuration:

{

  "IpFilterMiddlewareOptions": {
    "ExactPathMatch": false,
    "LogRequests": true,
    "ApplyOnlyToHttpMethod": "", 
    "ResponseHttpStatusCode": 401
  },

  "IpFilters": [
    {
      "Path": "/MyController",
      "IpList": "1.1.1.1;::1"
    },
    {
      "Path": "/MyController2",
      "IpList": "*"
    },
    {
      "Path": "/MyController3",
      "IpList": "2.2.2.2"
    }
  ],
}

Release Notes


- Changed default return HTTP status code to Forbidden (403)
- Added override option to return HTTP status code

GitHub repositories (0)

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.0.1 34 6/15/2020
1.0.0 32 6/5/2020