Sidio.Web.Security.AspNetCore 1.1.0

Prefix Reserved
dotnet add package Sidio.Web.Security.AspNetCore --version 1.1.0                
NuGet\Install-Package Sidio.Web.Security.AspNetCore -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.
<PackageReference Include="Sidio.Web.Security.AspNetCore" Version="1.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Sidio.Web.Security.AspNetCore --version 1.1.0                
#r "nuget: Sidio.Web.Security.AspNetCore, 1.1.0"                
#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 Sidio.Web.Security.AspNetCore as a Cake Addin
#addin nuget:?package=Sidio.Web.Security.AspNetCore&version=1.1.0

// Install Sidio.Web.Security.AspNetCore as a Cake Tool
#tool nuget:?package=Sidio.Web.Security.AspNetCore&version=1.1.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.

Note:

The packages are currently in preview and is not yet ready for production use. During the preview phase, breaking changes may be introduced. Extensive documentation is also still being worked on.

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.

build NuGet Version

Sidio.Web.Security.Testing

Sidio.Web.Security.Testing provides testing functionality that can be used to verify that the security headers are set correctly.

build NuGet Version

.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.

build NuGet Version

Code quality

Quality Gate Status Coverage

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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
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 76 8/29/2024
1.0.0 114 8/24/2024