System.Text.Encodings.Web 9.0.0-rc.1.24431.7

Prefix Reserved
This is a prerelease version of System.Text.Encodings.Web.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package System.Text.Encodings.Web --version 9.0.0-rc.1.24431.7                
NuGet\Install-Package System.Text.Encodings.Web -Version 9.0.0-rc.1.24431.7                
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="System.Text.Encodings.Web" Version="9.0.0-rc.1.24431.7" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add System.Text.Encodings.Web --version 9.0.0-rc.1.24431.7                
#r "nuget: System.Text.Encodings.Web, 9.0.0-rc.1.24431.7"                
#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 System.Text.Encodings.Web as a Cake Addin
#addin nuget:?package=System.Text.Encodings.Web&version=9.0.0-rc.1.24431.7&prerelease

// Install System.Text.Encodings.Web as a Cake Tool
#tool nuget:?package=System.Text.Encodings.Web&version=9.0.0-rc.1.24431.7&prerelease                

About

Provides types for encoding and escaping strings for use in JavaScript, HTML, and URLs.

This package is essential for protecting web applications against cross-site scripting (XSS) attacks by safely encoding text, and it offers extensive support for Unicode, allowing fine-grained control over which characters are encoded and which are left unescaped.

Key Features

  • Safe encoders for HTML, JavaScript, and URL strings.
  • Extensible to support custom encoding scenarios, including the ability to specify Unicode ranges.
  • Helps prevent cross-site scripting (XSS) vulnerabilities.
  • Flexible Unicode encoding with support for specifying individual or predefined ranges to cover broader sets of characters, including options to avoid escaping specific language character sets.

How to Use

Encoding HTML, JavaScript, and URLs

using System.Text.Encodings.Web;

string unsafeString = "<script>alert('XSS Attack!');</script>";

// HTML encode the string to safely display it on a web page.
string safeHtml = HtmlEncoder.Default.Encode(unsafeString);
Console.WriteLine(safeHtml);
// &lt;script&gt;alert(&#x27;XSS Attack!&#x27;);&lt;/script&gt;

// JavaScript encode the string to safely include it in a JavaScript context.
string safeJavaScript = JavaScriptEncoder.Default.Encode(unsafeString);
Console.WriteLine(safeJavaScript);
// \u003Cscript\u003Ealert(\u0027XSS Attack!\u0027);\u003C/script\u003E

string urlPart = "user input with spaces and & symbols";

// URL encode the string to safely include it in a URL.
string encodedUrlPart = UrlEncoder.Default.Encode(urlPart);
Console.WriteLine(encodedUrlPart);
// user%20input%20with%20spaces%20and%20%26%20symbols

Custom Encoding Scenario with Specific Unicode Ranges

using System.Text.Encodings.Web;
using System.Text.Unicode;

TextEncoderSettings customEncoderSettings = new TextEncoderSettings();
customEncoderSettings.AllowCharacters('!', '*', '-', '.', '_', '~'); // RFC 3986 unreserved characters
customEncoderSettings.AllowRange(new UnicodeRange('a', 26));
customEncoderSettings.AllowRange(new UnicodeRange('A', 26));
customEncoderSettings.AllowRange(new UnicodeRange('0', 10));

// Create a URL encoder with the custom settings
UrlEncoder customUrlEncoder = UrlEncoder.Create(customEncoderSettings);

string customUrlPart = "custom data: (@123!)";

// By default, the symbols '(', ')', and '@' are not encoded
string defaultEncoded = UrlEncoder.Default.Encode(customUrlPart);
Console.WriteLine(defaultEncoded);
// custom%20data%3A%20(@123!)

// Now, the symbols '(', ')', and '@' are also encoded
string customEncoded = customUrlEncoder.Encode(customUrlPart);
Console.WriteLine(customEncoded);
// custom%20data%3A%20%28%40123!%29

Serialization with Specific Unicode Character Sets

By default Cyrillic characters are encoded as Unicode escape sequences in JSON.

{
  "Date": "2019-08-01T00:00:00-07:00",
  "TemperatureCelsius": 25,
  "Summary": "\u0436\u0430\u0440\u043A\u043E"
}

This can be customized by providing a custom JavaScriptEncoder to JsonSerializerOptions:

JsonSerializerOptions options = new JsonSerializerOptions
{
    Encoder = JavaScriptEncoder.Create(UnicodeRanges.BasicLatin, UnicodeRanges.Cyrillic),
    WriteIndented = true
};
jsonString = JsonSerializer.Serialize(weatherForecast, options1);
{
  "Date": "2019-08-01T00:00:00-07:00",
  "TemperatureCelsius": 25,
  "Summary": "жарко"
}

More information about this can be found in the How to customize character encoding with System.Text.Json article.

Main Types

The main types provided by this library are:

  • System.Text.Encodings.Web.HtmlEncoder
  • System.Text.Encodings.Web.JavaScriptEncoder
  • System.Text.Encodings.Web.UrlEncoder
  • System.Text.Encodings.Web.TextEncoder
  • System.Text.Encodings.Web.TextEncoderSettings
  • System.Text.Unicode.UnicodeRange
  • System.Text.Unicode.UnicodeRanges

Additional Documentation

Feedback & Contributing

System.Text.Encodings.Web is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Product 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 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. 
.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 is compatible.  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.

NuGet packages (1.3K)

Showing the top 5 NuGet packages that depend on System.Text.Encodings.Web:

Package Downloads
System.Text.Json

Provides high-performance and low-allocating types that serialize objects to JavaScript Object Notation (JSON) text and deserialize JSON text to objects, with UTF-8 support built-in. Also provides types to read and write JSON text encoded as UTF-8, and to create an in-memory document object model (DOM), that is read-only, for random access of the JSON elements within a structured view of the data. The System.Text.Json library is built-in as part of the shared framework in .NET Runtime. The package can be installed when you need to use it in other target frameworks.

Microsoft.Extensions.DependencyModel

Provides abstractions for reading `.deps` files. When a .NET application is compiled, the SDK generates a JSON manifest file (`<ApplicationName>.deps.json`) that contains information about application dependencies. You can use `Microsoft.Extensions.DependencyModel` to read information from this manifest at run time. This is useful when you want to dynamically compile code (for example, using Roslyn Emit API) referencing the same dependencies as your main application. By default, the dependency manifest contains information about the application's target framework and runtime dependencies. Set the PreserveCompilationContext project property to `true` to additionally include information about reference assemblies used during compilation.

Microsoft.AspNetCore.Http.Abstractions

ASP.NET Core HTTP object model for HTTP requests and responses and also common extension methods for registering middleware in an IApplicationBuilder. Commonly used types: Microsoft.AspNetCore.Builder.IApplicationBuilder Microsoft.AspNetCore.Http.HttpContext Microsoft.AspNetCore.Http.HttpRequest Microsoft.AspNetCore.Http.HttpResponse This package was built from the source code at https://github.com/aspnet/HttpAbstractions/tree/91db78cf926939821bc96e8e60616cf5dde0b489

Azure.Core

This is the implementation of the Azure Client Pipeline

Microsoft.Data.SqlClient

The current data provider for SQL Server and Azure SQL databases. This has replaced System.Data.SqlClient. These classes provide access to SQL and encapsulate database-specific protocols, including tabular data stream (TDS). Commonly Used Types: Microsoft.Data.SqlClient.SqlConnection Microsoft.Data.SqlClient.SqlException Microsoft.Data.SqlClient.SqlParameter Microsoft.Data.SqlClient.SqlDataReader Microsoft.Data.SqlClient.SqlCommand Microsoft.Data.SqlClient.SqlTransaction Microsoft.Data.SqlClient.SqlParameterCollection Microsoft.Data.SqlClient.SqlClientFactory When using NuGet 3.x this package requires at least version 3.4.

GitHub repositories (250)

Showing the top 5 popular GitHub repositories that depend on System.Text.Encodings.Web:

Repository Stars
PowerShell/PowerShell
PowerShell for every system!
dotnet/aspnetcore
ASP.NET Core is a cross-platform .NET framework for building modern cloud-based web applications on Windows, Mac, or Linux.
abpframework/abp
Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation.
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
chocolatey/choco
Chocolatey - the package manager for Windows
Version Downloads Last updated
9.0.0-rc.2.24473.5 9,576 10/8/2024
9.0.0-rc.1.24431.7 58,797 9/10/2024
9.0.0-preview.7.24405.7 72,547 8/13/2024
9.0.0-preview.6.24327.7 117,859 7/9/2024
9.0.0-preview.5.24306.7 96,641 6/11/2024
9.0.0-preview.4.24266.19 73,905 5/21/2024
9.0.0-preview.3.24172.9 190,614 4/11/2024
9.0.0-preview.2.24128.5 87,310 3/12/2024
9.0.0-preview.1.24080.9 119,135 2/13/2024
8.0.0 143,225,386 11/14/2023
8.0.0-rc.2.23479.6 1,494,832 10/10/2023
8.0.0-rc.1.23419.4 413,070 9/12/2023
8.0.0-preview.7.23375.6 432,670 8/8/2023
8.0.0-preview.6.23329.7 302,697 7/11/2023
8.0.0-preview.5.23280.8 220,422 6/13/2023
8.0.0-preview.4.23259.5 399,198 5/16/2023
8.0.0-preview.3.23174.8 421,437 4/11/2023
8.0.0-preview.2.23128.3 406,002 3/14/2023
8.0.0-preview.1.23110.8 232,698 2/21/2023
7.0.0 251,735,767 11/7/2022
7.0.0-rc.2.22472.3 321,481 10/11/2022
7.0.0-rc.1.22426.10 302,203 9/14/2022
7.0.0-preview.7.22375.6 293,492 8/9/2022
7.0.0-preview.6.22324.4 152,582 7/12/2022
7.0.0-preview.5.22301.12 101,086 6/14/2022
7.0.0-preview.4.22229.4 148,027 5/10/2022
7.0.0-preview.3.22175.4 122,885 4/13/2022
7.0.0-preview.2.22152.2 95,978 3/14/2022
7.0.0-preview.1.22076.8 91,087 2/17/2022
6.0.0 523,700,819 11/8/2021
6.0.0-rc.2.21480.5 612,358 10/12/2021
6.0.0-rc.1.21451.13 446,136 9/14/2021
6.0.0-preview.7.21377.19 131,626 8/10/2021
6.0.0-preview.6.21352.12 101,778 7/14/2021
6.0.0-preview.5.21301.5 127,372 6/15/2021
6.0.0-preview.4.21253.7 103,561 5/24/2021
6.0.0-preview.3.21201.4 317,751 4/8/2021
6.0.0-preview.2.21154.6 177,675 3/11/2021
6.0.0-preview.1.21102.12 97,287 2/12/2021
5.0.1 128,252,344 3/9/2021 5.0.1 is deprecated because it is no longer maintained.
5.0.0 69,695,080 11/9/2020 5.0.0 is deprecated because it is no longer maintained; 5.0.0 has at least one vulnerability with critical severity.
5.0.0-rc.2.20475.5 117,697 10/13/2020
5.0.0-rc.1.20451.14 204,741 9/14/2020
5.0.0-preview.8.20407.11 98,836 8/25/2020
5.0.0-preview.7.20364.11 179,932 7/21/2020
5.0.0-preview.6.20305.6 78,910 6/25/2020
5.0.0-preview.5.20278.1 85,911 6/10/2020
5.0.0-preview.4.20251.6 159,827 5/18/2020
5.0.0-preview.3.20214.6 302,966 4/23/2020
5.0.0-preview.2.20160.6 162,019 4/2/2020
5.0.0-preview.1.20120.5 93,491 3/16/2020
4.7.2 476,112,872 3/9/2021
4.7.1 76,905,832 5/12/2020 4.7.1 has at least one vulnerability with critical severity.
4.7.0 76,483,983 12/3/2019 4.7.0 has at least one vulnerability with critical severity.
4.7.0-preview3.19551.4 305,044 11/13/2019 4.7.0-preview3.19551.4 has at least one vulnerability with critical severity.
4.7.0-preview2.19523.17 56,987 11/1/2019 4.7.0-preview2.19523.17 has at least one vulnerability with critical severity.
4.7.0-preview1.19504.10 93,469 10/15/2019 4.7.0-preview1.19504.10 has at least one vulnerability with critical severity.
4.6.0 96,942,207 9/23/2019 4.6.0 has at least one vulnerability with critical severity.
4.6.0-rc1.19456.4 80,593 9/16/2019
4.6.0-preview9.19421.4 154,034 9/4/2019
4.6.0-preview9.19416.11 1,724 9/4/2019
4.6.0-preview8.19405.3 104,028 8/13/2019
4.6.0-preview7.19362.9 4,765 7/23/2019
4.6.0-preview6.19303.8 6,374 6/12/2019
4.6.0-preview6.19264.9 1,801 9/4/2019
4.6.0-preview5.19224.8 2,653 5/6/2019
4.6.0-preview4.19212.13 1,975 4/18/2019
4.6.0-preview3.19128.7 10,501 3/6/2019
4.6.0-preview.19073.11 8,977 1/29/2019
4.6.0-preview.18571.3 7,912 12/3/2018
4.5.1 94,318,388 3/9/2021
4.5.0 739,476,354 5/29/2018 4.5.0 has at least one vulnerability with critical severity.
4.5.0-rc1 498,763 5/6/2018 4.5.0-rc1 has at least one vulnerability with critical severity.
4.5.0-preview2-26406-04 694,499 4/10/2018 4.5.0-preview2-26406-04 has at least one vulnerability with critical severity.
4.5.0-preview1-26216-02 610,278 2/26/2018 4.5.0-preview1-26216-02 has at least one vulnerability with critical severity.
4.4.0 232,966,619 8/11/2017 4.4.0 has at least one vulnerability with critical severity.
4.4.0-preview2-25405-01 196,708 6/27/2017 4.4.0-preview2-25405-01 has at least one vulnerability with critical severity.
4.4.0-preview1-25305-02 10,571 5/9/2017 4.4.0-preview1-25305-02 has at least one vulnerability with critical severity.
4.3.1 71,114,459 5/9/2017 4.3.1 has at least one vulnerability with critical severity.
4.3.0 28,433,378 11/15/2016 4.3.0 has at least one vulnerability with critical severity.
4.3.0-preview1-24530-04 206,135 10/24/2016 4.3.0-preview1-24530-04 has at least one vulnerability with critical severity.
4.0.1 46,825,646 5/9/2017 4.0.1 has at least one vulnerability with critical severity.
4.0.0 73,422,596 6/27/2016 4.0.0 has at least one vulnerability with critical severity.
4.0.0-rc2-24027 2,146,951 5/16/2016
4.0.0-beta-23516 6,307 11/18/2015
4.0.0-beta-23409 5,472 10/15/2015