System.Text.Encodings.Web 9.0.23

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.

Showing the top 20 packages that depend on System.Text.Encodings.Web.

Packages 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. Commonly Used Types: System.Text.Json.JsonSerializer System.Text.Json.JsonDocument System.Text.Json.JsonElement System.Text.Json.Utf8JsonWriter System.Text.Json.Utf8JsonReader When using NuGet 3.x this package requires at least version 3.4.
38
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.
37
Microsoft.AspNetCore.SignalR.Common
Common serialiation primitives for SignalR Clients Servers This package was built from the source code at https://github.com/aspnet/AspNetCore/tree/4d0b3722384bfec7d4c210674df9b7bf1e59da90
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/ae2eabad0e49302d0632a7dde917fdc68d960dc4
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/68bb6fb08f8f85bb3cf08953a0d2f4a254eaccff
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/67acc3d331454956fc06d6de2218a625e3e596f8
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/371a26f07b23ad77c636332c2dfc0cbd1d8137ba
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container.
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/4442a188f9200a57635373dcd640893c0e8dcc78
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/f9ae0f5d30be2de3c0de61b5673bd8873231d70a
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/3dfc6fda80a10797b8c8fda1970e7b377fd8ed8d
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/8e941eb42f819adb116b881195158b3887a70a1c
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/e5f183b656a0e8bc087108130a5a9b54ae94494e
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/773e8cc3fbdc2c4ffbd57c1f53f21649ef94c35c
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/8486d31e24f30e3fa1809a95699a0adc16f448d7
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/c911002ab43b7b989ed67090f2a48d9073d5118d
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/704f7cb1d2cea33afb00c2097731216f121c2c73
37
Microsoft.Extensions.WebEncoders
Contains registration and configuration APIs to add the core framework encoders to a dependency injection container. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/3c37ef8f5358abb303c05d299f029fca7d867d56
37

https://go.microsoft.com/fwlink/?LinkID=799421

.NET Framework 4.6.2

.NET 8.0

  • No dependencies.

.NET 9.0

  • No dependencies.

.NET Standard 2.0

Version Downloads Last updated
11.0.0 4 11/14/2026
11.0.0-rc.3.26522.148 3 10/31/2026
11.0.0-rc.2.26504.105 4 10/23/2026
11.0.0-rc.1.26425.128 3 10/29/2026
11.0.0-preview.7.26381.103 3 11/02/2026
11.0.0-preview.6.26359.118 6 07/19/2026
11.0.0-preview.5.26302.115 9 06/12/2026
11.0.0-preview.4.26230.115 10 05/16/2026
11.0.0-preview.3.26207.106 13 04/24/2026
11.0.0-preview.2.26159.112 15 03/13/2026
11.0.0-preview.1.26104.118 17 02/19/2026
10.0.15 3 11/14/2026
10.0.14 3 11/03/2026
10.0.13 2 10/31/2026
10.0.12 4 11/03/2026
10.0.11 4 08/14/2026
10.0.10 6 07/19/2026
10.0.9 9 06/12/2026
10.0.8 9 05/16/2026
10.0.7 12 04/24/2026
10.0.6 12 04/24/2026
10.0.5 16 03/13/2026
10.0.4 15 03/13/2026
10.0.3 15 02/19/2026
10.0.2 15 01/21/2026
10.0.1 18 12/10/2025
10.0.0 20 12/08/2025
10.0.0-rc.2.25502.107 24 10/27/2025
10.0.0-rc.1.25451.107 25 09/11/2025
10.0.0-preview.7.25380.108 26 09/05/2025
10.0.0-preview.6.25358.103 26 07/30/2025
10.0.0-preview.5.25277.114 27 07/30/2025
10.0.0-preview.4.25258.110 28 05/23/2025
10.0.0-preview.3.25171.5 28 05/23/2025
10.0.0-preview.2.25163.2 28 05/23/2025
10.0.0-preview.1.25080.5 29 02/27/2025
9.0.23 2 11/14/2026
9.0.22 3 11/03/2026
9.0.21 3 10/25/2026
9.0.20 3 11/13/2026
9.0.19 3 11/02/2026
9.0.18 7 07/19/2026
9.0.17 10 06/12/2026
9.0.16 10 05/16/2026
9.0.15 12 04/24/2026
9.0.14 15 03/13/2026
9.0.13 15 02/19/2026
9.0.12 17 01/21/2026
9.0.11 20 12/09/2025
9.0.10 25 10/27/2025
9.0.9 28 09/10/2025
9.0.8 27 09/05/2025
9.0.7 28 07/30/2025
9.0.6 28 07/30/2025
9.0.5 29 05/22/2025
9.0.4 29 05/22/2025
9.0.3 29 05/22/2025
9.0.2 30 02/18/2025
9.0.1 31 02/18/2025
9.0.0 33 11/18/2024
9.0.0-rc.2.24473.5 27 05/23/2025
9.0.0-rc.1.24431.7 27 05/23/2025
9.0.0-preview.7.24405.7 27 05/23/2025
9.0.0-preview.6.24327.7 28 05/23/2025
9.0.0-preview.5.24306.7 27 05/23/2025
9.0.0-preview.4.24266.19 27 05/23/2025
9.0.0-preview.3.24172.9 28 05/23/2025
9.0.0-preview.2.24128.5 28 05/23/2025
9.0.0-preview.1.24080.9 29 05/23/2025
8.0.0 32 02/18/2025
8.0.0-rc.2.23479.6 28 05/23/2025
8.0.0-rc.1.23419.4 27 02/27/2025
8.0.0-preview.7.23375.6 29 02/27/2025
8.0.0-preview.6.23329.7 27 05/23/2025
8.0.0-preview.5.23280.8 30 05/23/2025
8.0.0-preview.4.23259.5 28 05/23/2025
8.0.0-preview.3.23174.8 27 05/23/2025
8.0.0-preview.2.23128.3 28 05/23/2025
8.0.0-preview.1.23110.8 28 05/23/2025
7.0.0 32 02/18/2025
7.0.0-rc.2.22472.3 28 05/23/2025
7.0.0-rc.1.22426.10 29 05/23/2025
7.0.0-preview.7.22375.6 29 05/23/2025
7.0.0-preview.6.22324.4 29 05/23/2025
7.0.0-preview.5.22301.12 28 05/23/2025
7.0.0-preview.4.22229.4 28 05/23/2025
7.0.0-preview.3.22175.4 27 02/27/2025
7.0.0-preview.2.22152.2 29 05/23/2025
7.0.0-preview.1.22076.8 27 05/23/2025
6.0.1 30 02/18/2025
6.0.0 33 02/18/2025
6.0.0-rc.2.21480.5 28 02/27/2025
6.0.0-rc.1.21451.13 28 05/23/2025
6.0.0-preview.7.21377.19 27 05/23/2025
6.0.0-preview.6.21352.12 28 05/23/2025
6.0.0-preview.5.21301.5 28 05/23/2025
6.0.0-preview.4.21253.7 26 05/23/2025
6.0.0-preview.3.21201.4 29 05/23/2025
6.0.0-preview.2.21154.6 28 05/23/2025
6.0.0-preview.1.21102.12 28 05/23/2025
5.0.1 31 02/18/2025
5.0.0 31 02/18/2025
5.0.0-rc.2.20475.5 29 05/23/2025
5.0.0-rc.1.20451.14 28 05/23/2025
5.0.0-preview.8.20407.11 29 02/27/2025
5.0.0-preview.7.20364.11 27 05/23/2025
5.0.0-preview.6.20305.6 28 05/23/2025
5.0.0-preview.5.20278.1 27 05/23/2025
5.0.0-preview.4.20251.6 27 05/23/2025
5.0.0-preview.3.20214.6 28 05/23/2025
5.0.0-preview.2.20160.6 28 05/23/2025
5.0.0-preview.1.20120.5 28 05/23/2025
4.7.2 31 02/18/2025
4.7.1 31 02/18/2025
4.7.0 31 02/18/2025
4.7.0-preview3.19551.4 27 05/23/2025
4.7.0-preview2.19523.17 27 05/23/2025
4.7.0-preview1.19504.10 29 05/23/2025
4.6.0 33 02/18/2025
4.6.0-rc1.19456.4 28 05/23/2025
4.6.0-preview9.19421.4 27 05/23/2025
4.6.0-preview9.19416.11 29 05/23/2025
4.6.0-preview8.19405.3 28 05/23/2025
4.6.0-preview7.19362.9 29 05/23/2025
4.6.0-preview6.19303.8 28 05/23/2025
4.6.0-preview6.19264.9 29 05/23/2025
4.6.0-preview5.19224.8 28 05/23/2025
4.6.0-preview4.19212.13 27 05/23/2025
4.6.0-preview3.19128.7 27 05/23/2025
4.6.0-preview.19073.11 29 02/27/2025
4.6.0-preview.18571.3 28 05/23/2025
4.5.1 31 02/18/2025
4.5.0 31 02/18/2025
4.5.0-rc1 31 02/18/2025
4.5.0-preview2-26406-04 28 05/23/2025
4.5.0-preview1-26216-02 29 02/27/2025
4.4.0 30 02/18/2025
4.4.0-preview2-25405-01 28 05/23/2025
4.4.0-preview1-25305-02 27 05/23/2025
4.3.1 31 02/18/2025
4.3.0 31 02/18/2025
4.3.0-preview1-24530-04 27 05/23/2025
4.0.1 31 02/18/2025
4.0.0 31 02/18/2025
4.0.0-rc2-24027 28 05/23/2025
4.0.0-beta-23516 30 02/18/2025
4.0.0-beta-23409 28 05/23/2025