Sidio.Web.Security.AspNetCore
1.2.0
Prefix Reserved
dotnet add package Sidio.Web.Security.AspNetCore --version 1.2.0
NuGet\Install-Package Sidio.Web.Security.AspNetCore -Version 1.2.0
<PackageReference Include="Sidio.Web.Security.AspNetCore" Version="1.2.0" />
paket add Sidio.Web.Security.AspNetCore --version 1.2.0
#r "nuget: Sidio.Web.Security.AspNetCore, 1.2.0"
// Install Sidio.Web.Security.AspNetCore as a Cake Addin #addin nuget:?package=Sidio.Web.Security.AspNetCore&version=1.2.0 // Install Sidio.Web.Security.AspNetCore as a Cake Tool #tool nuget:?package=Sidio.Web.Security.AspNetCore&version=1.2.0
ASP.NET Core web security
Goal of this project
The goal of this project is to provide a set of services, helper functions and middleware that can be used to secure an ASP.NET Core application. All features are based on the Mozilla Web Security Guidelines.
Packages
Sidio.Web.Security.AspNetCore
Sidio.Web.Security.AspNetCore provides the ASP.NET Core services and middleware. The project targets .NET 8.0 and higher.
Sidio.Web.Security.Testing
Sidio.Web.Security.Testing provides testing functionality that can be used to verify that the security headers are set correctly.
.NET Framework support: Sidio.Web.Security
Sidio.Web.Security provides the core functionality. Can be used in projects targeting .NET Standard 2.0. It is useful to use this package if .NET Framework is still in use. Otherwise, use Sidio.Web.Security.AspNetCore. Note that this package does not contain the middleware and services that are provided by the ASP.NET Core package. Feel free to make a contribution to this project or a fork targeting .NET Framework.
Code quality
Documentation
See the wiki docs.
Features
HTTP headers
- Content-Security-Policy: docs
- Referrer-Policy: docs
- Report-To: docs
- Strict-Transport-Security (HSTS): docs
- X-Content-Type-Options: docs
- X-Frame-Options: docs
Read more in the wiki docs.
Example
builder.Services
.AddContentSecurityPolicy();
app.UseXFrameOptions();
app.UseXContentTypeOptions();
app.UseStrictTransportSecurity();
app.UseContentSecurityPolicy(
(services, b) =>
{
b.AddDefaultSrc(x => x.AllowSelf());
b.AddScriptSrc(x => x.AddNonce(services).AllowUnsafeInline().AllowUrl("https://cdn.example.com"));
b.AddStyleSrc(x => x.AddNonce(services));
});
See getting started and the recommended ASP.NET Core configuration.
Reporting API
The reporting API can be used to report violations of the Content Security Policy. Read more in the wiki docs.
Default policies
Testing
The package Sidio.Web.Security.Testing provides a set of functions that can be used to test the security configuration of an ASP.Net Core application. Read more.
Contributions
Contributions are welcome! Feel free to create a pull request or an issue.
License
This project is licensed under the MIT License.
Texts used in this project (including this readme, the code documentation and wiki pages) may come from, or be based on, the MDN Web Doc's. Documentation by Mozilla Contributors is licensed under CC-BY-SA 2.5.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. 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. net9.0 is compatible. |
-
net8.0
- Sidio.Web.Security (>= 1.2.0)
-
net9.0
- Sidio.Web.Security (>= 1.2.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.