InputSanitizer 0.0.4
dotnet add package InputSanitizer --version 0.0.4
NuGet\Install-Package InputSanitizer -Version 0.0.4
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.
<PackageReference Include="InputSanitizer" Version="0.0.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add InputSanitizer --version 0.0.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: InputSanitizer, 0.0.4"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install InputSanitizer as a Cake Addin #addin nuget:?package=InputSanitizer&version=0.0.4 // Install InputSanitizer as a Cake Tool #tool nuget:?package=InputSanitizer&version=0.0.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
InputSanitizer
InputSanitizer is a filter used to clear all illegal strings from the data received by the API or MVC Controller.
It is based on HtmlSanitizer as an HTML-related cleaner, and also adds Regex pattern matching cleanup.
It supports data model binding in DTO mode and also supports dynamic types based on Json.
How To Use
Add InputSanitize to ServiceCollection with policy in Program.cs
var policy = new InputSanitizerPolicy()
{
Name = "Default",
AllowedTags = new HashSet<string>(HtmlSanitizerDefaults.AllowedTags, StringComparer.OrdinalIgnoreCase),
AllowedSchemes = new HashSet<string>(HtmlSanitizerDefaults.AllowedSchemes, StringComparer.OrdinalIgnoreCase),
AllowedAttributes = new HashSet<string>(HtmlSanitizerDefaults.AllowedAttributes, StringComparer.OrdinalIgnoreCase),
UriAttributes = new HashSet<string>(HtmlSanitizerDefaults.UriAttributes, StringComparer.OrdinalIgnoreCase),
AllowedCssProperties = new HashSet<string>(HtmlSanitizerDefaults.AllowedCssProperties, StringComparer.OrdinalIgnoreCase),
AllowedAtRules = new HashSet<CssRuleType>(HtmlSanitizerDefaults.AllowedAtRules),
AllowedCssClasses = new HashSet<string>(HtmlSanitizerDefaults.AllowedClasses),
ExceptionMessage = "What are you doing?",
InvalidInputBehaviour = InvalidInputBehaviour.SetModelState
}
builder.Services.AddInputSanitizer(InputSanitizerPolicies.Policies);
Add To the Controller
[ApiController]
[Route("[controller]")]
[SanitizeAllInputFilter(PolicyName = "Default")] // this line HERE
public class WeatherForecastController : ControllerBase
{
private readonly ILogger<WeatherForecastController> _logger;
public WeatherForecastController(ILogger<WeatherForecastController> logger)
{
_logger = logger;
}
[HttpPost(Name = "PostWeatherForecast")]
public IActionResult Post(DTOModel data) // OR public IActionResult Post(dynamic data)
{
if (!ModelState.IsValid)
{
return UnprocessableEntity(ModelState);
}
return Ok(data);
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- HtmlSanitizer (>= 8.0.601)
- Microsoft.AspNetCore.Http.Abstractions (>= 2.2.0)
- Microsoft.AspNetCore.Mvc.Abstractions (>= 2.2.0)
- Microsoft.AspNetCore.Mvc.Core (>= 2.2.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 6.0.0)
- System.Text.Json (>= 7.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.