JN.IpFilter 1.1.0

.NET Standard 2.0
NuGet\Install-Package JN.IpFilter -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
dotnet add package JN.IpFilter --version 1.1.0
<PackageReference Include="JN.IpFilter" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add JN.IpFilter --version 1.1.0
#r "nuget: JN.IpFilter, 1.1.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install JN.IpFilter as a Cake Addin
#addin nuget:?package=JN.IpFilter&version=1.1.0

// Install JN.IpFilter as a Cake Tool
#tool nuget:?package=JN.IpFilter&version=1.1.0

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"
    }
  ],
}
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 145 4/21/2022
1.0.1 299 6/15/2020
1.0.0 275 6/5/2020



Release Notes for current version (1.1.0):

- Update target framework to netstandard2.0

Release Notes for version 1.0.1:

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