diff --git a/src/WebEncoders/src/EncoderServiceCollectionExtensions.cs b/src/WebEncoders/src/EncoderServiceCollectionExtensions.cs
new file mode 100644
index 0000000000..72f5e369a1
--- /dev/null
+++ b/src/WebEncoders/src/EncoderServiceCollectionExtensions.cs
@@ -0,0 +1,83 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Text.Encodings.Web;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Options;
+using Microsoft.Extensions.WebEncoders;
+
+namespace Microsoft.Extensions.DependencyInjection
+{
+ ///
+ /// Extension methods for setting up web encoding services in an .
+ ///
+ public static class EncoderServiceCollectionExtensions
+ {
+ ///
+ /// Adds , and
+ /// to the specified .
+ ///
+ /// The .
+ /// The so that additional calls can be chained.
+ public static IServiceCollection AddWebEncoders(this IServiceCollection services)
+ {
+ if (services == null)
+ {
+ throw new ArgumentNullException(nameof(services));
+ }
+
+ services.AddOptions();
+
+ // Register the default encoders
+ // We want to call the 'Default' property getters lazily since they perform static caching
+ services.TryAddSingleton(
+ CreateFactory(() => HtmlEncoder.Default, settings => HtmlEncoder.Create(settings)));
+ services.TryAddSingleton(
+ CreateFactory(() => JavaScriptEncoder.Default, settings => JavaScriptEncoder.Create(settings)));
+ services.TryAddSingleton(
+ CreateFactory(() => UrlEncoder.Default, settings => UrlEncoder.Create(settings)));
+
+ return services;
+ }
+
+ ///
+ /// Adds , and
+ /// to the specified .
+ ///
+ /// The .
+ /// An to configure the provided .
+ /// The so that additional calls can be chained.
+ public static IServiceCollection AddWebEncoders(this IServiceCollection services, Action setupAction)
+ {
+ if (services == null)
+ {
+ throw new ArgumentNullException(nameof(services));
+ }
+
+ if (setupAction == null)
+ {
+ throw new ArgumentNullException(nameof(setupAction));
+ }
+
+ services.AddWebEncoders();
+ services.Configure(setupAction);
+
+ return services;
+ }
+
+ private static Func CreateFactory(
+ Func defaultFactory,
+ Func customSettingsFactory)
+ {
+ return serviceProvider =>
+ {
+ var settings = serviceProvider
+ ?.GetService>()
+ ?.Value
+ ?.TextEncoderSettings;
+ return (settings != null) ? customSettingsFactory(settings) : defaultFactory();
+ };
+ }
+ }
+}
diff --git a/src/WebEncoders/src/Microsoft.Extensions.WebEncoders.csproj b/src/WebEncoders/src/Microsoft.Extensions.WebEncoders.csproj
new file mode 100644
index 0000000000..18f96d9412
--- /dev/null
+++ b/src/WebEncoders/src/Microsoft.Extensions.WebEncoders.csproj
@@ -0,0 +1,18 @@
+
+
+
+ Contains registration and configuration APIs to add the core framework encoders to a dependency injection container.
+ netstandard2.0
+ $(NoWarn);CS1591
+ true
+ true
+ aspnetcore
+
+
+
+
+
+
+
+
+
diff --git a/src/WebEncoders/src/Testing/HtmlTestEncoder.cs b/src/WebEncoders/src/Testing/HtmlTestEncoder.cs
new file mode 100644
index 0000000000..162ce4f6c1
--- /dev/null
+++ b/src/WebEncoders/src/Testing/HtmlTestEncoder.cs
@@ -0,0 +1,104 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.IO;
+using System.Text.Encodings.Web;
+
+namespace Microsoft.Extensions.WebEncoders.Testing
+{
+ ///
+ /// Encoder used for unit testing.
+ ///
+ public sealed class HtmlTestEncoder : HtmlEncoder
+ {
+ public override int MaxOutputCharactersPerInputCharacter
+ {
+ get { return 1; }
+ }
+
+ public override string Encode(string value)
+ {
+ if (value == null)
+ {
+ throw new ArgumentNullException(nameof(value));
+ }
+
+ if (value.Length == 0)
+ {
+ return string.Empty;
+ }
+
+ return $"HtmlEncode[[{value}]]";
+ }
+
+ public override void Encode(TextWriter output, char[] value, int startIndex, int characterCount)
+ {
+ if (output == null)
+ {
+ throw new ArgumentNullException(nameof(output));
+ }
+
+ if (value == null)
+ {
+ throw new ArgumentNullException(nameof(value));
+ }
+
+ if (characterCount == 0)
+ {
+ return;
+ }
+
+ output.Write("HtmlEncode[[");
+ output.Write(value, startIndex, characterCount);
+ output.Write("]]");
+ }
+
+ public override void Encode(TextWriter output, string value, int startIndex, int characterCount)
+ {
+ if (output == null)
+ {
+ throw new ArgumentNullException(nameof(output));
+ }
+
+ if (value == null)
+ {
+ throw new ArgumentNullException(nameof(value));
+ }
+
+ if (characterCount == 0)
+ {
+ return;
+ }
+
+ output.Write("HtmlEncode[[");
+ output.Write(value.Substring(startIndex, characterCount));
+ output.Write("]]");
+ }
+
+ public override bool WillEncode(int unicodeScalar)
+ {
+ return false;
+ }
+
+ public override unsafe int FindFirstCharacterToEncode(char* text, int textLength)
+ {
+ return -1;
+ }
+
+ public override unsafe bool TryEncodeUnicodeScalar(
+ int unicodeScalar,
+ char* buffer,
+ int bufferLength,
+ out int numberOfCharactersWritten)
+ {
+ if (buffer == null)
+ {
+ throw new ArgumentNullException(nameof(buffer));
+ }
+
+ numberOfCharactersWritten = 0;
+ return false;
+ }
+ }
+}
\ No newline at end of file
diff --git a/src/WebEncoders/src/Testing/JavaScriptTestEncoder.cs b/src/WebEncoders/src/Testing/JavaScriptTestEncoder.cs
new file mode 100644
index 0000000000..bef4461676
--- /dev/null
+++ b/src/WebEncoders/src/Testing/JavaScriptTestEncoder.cs
@@ -0,0 +1,104 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.IO;
+using System.Text.Encodings.Web;
+
+namespace Microsoft.Extensions.WebEncoders.Testing
+{
+ ///
+ /// Encoder used for unit testing.
+ ///
+ public class JavaScriptTestEncoder : JavaScriptEncoder
+ {
+ public override int MaxOutputCharactersPerInputCharacter
+ {
+ get { return 1; }
+ }
+
+ public override string Encode(string value)
+ {
+ if (value == null)
+ {
+ throw new ArgumentNullException(nameof(value));
+ }
+
+ if (value.Length == 0)
+ {
+ return string.Empty;
+ }
+
+ return $"JavaScriptEncode[[{value}]]";
+ }
+
+ public override void Encode(TextWriter output, char[] value, int startIndex, int characterCount)
+ {
+ if (output == null)
+ {
+ throw new ArgumentNullException(nameof(output));
+ }
+
+ if (value == null)
+ {
+ throw new ArgumentNullException(nameof(value));
+ }
+
+ if (characterCount == 0)
+ {
+ return;
+ }
+
+ output.Write("JavaScriptEncode[[");
+ output.Write(value, startIndex, characterCount);
+ output.Write("]]");
+ }
+
+ public override void Encode(TextWriter output, string value, int startIndex, int characterCount)
+ {
+ if (output == null)
+ {
+ throw new ArgumentNullException(nameof(output));
+ }
+
+ if (value == null)
+ {
+ throw new ArgumentNullException(nameof(value));
+ }
+
+ if (characterCount == 0)
+ {
+ return;
+ }
+
+ output.Write("JavaScriptEncode[[");
+ output.Write(value.Substring(startIndex, characterCount));
+ output.Write("]]");
+ }
+
+ public override bool WillEncode(int unicodeScalar)
+ {
+ return false;
+ }
+
+ public override unsafe int FindFirstCharacterToEncode(char* text, int textLength)
+ {
+ return -1;
+ }
+
+ public override unsafe bool TryEncodeUnicodeScalar(
+ int unicodeScalar,
+ char* buffer,
+ int bufferLength,
+ out int numberOfCharactersWritten)
+ {
+ if (buffer == null)
+ {
+ throw new ArgumentNullException(nameof(buffer));
+ }
+
+ numberOfCharactersWritten = 0;
+ return false;
+ }
+ }
+}
\ No newline at end of file
diff --git a/src/WebEncoders/src/Testing/UrlTestEncoder.cs b/src/WebEncoders/src/Testing/UrlTestEncoder.cs
new file mode 100644
index 0000000000..295bda63e8
--- /dev/null
+++ b/src/WebEncoders/src/Testing/UrlTestEncoder.cs
@@ -0,0 +1,104 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.IO;
+using System.Text.Encodings.Web;
+
+namespace Microsoft.Extensions.WebEncoders.Testing
+{
+ ///
+ /// Encoder used for unit testing.
+ ///
+ public class UrlTestEncoder : UrlEncoder
+ {
+ public override int MaxOutputCharactersPerInputCharacter
+ {
+ get { return 1; }
+ }
+
+ public override string Encode(string value)
+ {
+ if (value == null)
+ {
+ throw new ArgumentNullException(nameof(value));
+ }
+
+ if (value.Length == 0)
+ {
+ return string.Empty;
+ }
+
+ return $"UrlEncode[[{value}]]";
+ }
+
+ public override void Encode(TextWriter output, char[] value, int startIndex, int characterCount)
+ {
+ if (output == null)
+ {
+ throw new ArgumentNullException(nameof(output));
+ }
+
+ if (value == null)
+ {
+ throw new ArgumentNullException(nameof(value));
+ }
+
+ if (characterCount == 0)
+ {
+ return;
+ }
+
+ output.Write("UrlEncode[[");
+ output.Write(value, startIndex, characterCount);
+ output.Write("]]");
+ }
+
+ public override void Encode(TextWriter output, string value, int startIndex, int characterCount)
+ {
+ if (output == null)
+ {
+ throw new ArgumentNullException(nameof(output));
+ }
+
+ if (value == null)
+ {
+ throw new ArgumentNullException(nameof(value));
+ }
+
+ if (characterCount == 0)
+ {
+ return;
+ }
+
+ output.Write("UrlEncode[[");
+ output.Write(value.Substring(startIndex, characterCount));
+ output.Write("]]");
+ }
+
+ public override bool WillEncode(int unicodeScalar)
+ {
+ return false;
+ }
+
+ public override unsafe int FindFirstCharacterToEncode(char* text, int textLength)
+ {
+ return -1;
+ }
+
+ public override unsafe bool TryEncodeUnicodeScalar(
+ int unicodeScalar,
+ char* buffer,
+ int bufferLength,
+ out int numberOfCharactersWritten)
+ {
+ if (buffer == null)
+ {
+ throw new ArgumentNullException(nameof(buffer));
+ }
+
+ numberOfCharactersWritten = 0;
+ return false;
+ }
+ }
+}
\ No newline at end of file
diff --git a/src/WebEncoders/src/WebEncoderOptions.cs b/src/WebEncoders/src/WebEncoderOptions.cs
new file mode 100644
index 0000000000..2f5e770a0c
--- /dev/null
+++ b/src/WebEncoders/src/WebEncoderOptions.cs
@@ -0,0 +1,21 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Text.Encodings.Web;
+
+namespace Microsoft.Extensions.WebEncoders
+{
+ ///
+ /// Specifies options common to all three encoders (HtmlEncode, JavaScriptEncode, UrlEncode).
+ ///
+ public sealed class WebEncoderOptions
+ {
+ ///
+ /// Specifies which code points are allowed to be represented unescaped by the encoders.
+ ///
+ ///
+ /// If this property is null, then the encoders will use their default allow lists.
+ ///
+ public TextEncoderSettings TextEncoderSettings { get; set; }
+ }
+}
diff --git a/src/WebEncoders/src/baseline.netcore.json b/src/WebEncoders/src/baseline.netcore.json
new file mode 100644
index 0000000000..6da0ae0754
--- /dev/null
+++ b/src/WebEncoders/src/baseline.netcore.json
@@ -0,0 +1,564 @@
+{
+ "AssemblyIdentity": "Microsoft.Extensions.WebEncoders, Version=2.1.1.0, Culture=neutral, PublicKeyToken=adb9793829ddae60",
+ "Types": [
+ {
+ "Name": "Microsoft.Extensions.WebEncoders.WebEncoderOptions",
+ "Visibility": "Public",
+ "Kind": "Class",
+ "Sealed": true,
+ "ImplementedInterfaces": [],
+ "Members": [
+ {
+ "Kind": "Method",
+ "Name": "get_TextEncoderSettings",
+ "Parameters": [],
+ "ReturnType": "System.Text.Encodings.Web.TextEncoderSettings",
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "set_TextEncoderSettings",
+ "Parameters": [
+ {
+ "Name": "value",
+ "Type": "System.Text.Encodings.Web.TextEncoderSettings"
+ }
+ ],
+ "ReturnType": "System.Void",
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Constructor",
+ "Name": ".ctor",
+ "Parameters": [],
+ "Visibility": "Public",
+ "GenericParameter": []
+ }
+ ],
+ "GenericParameters": []
+ },
+ {
+ "Name": "Microsoft.Extensions.WebEncoders.Testing.HtmlTestEncoder",
+ "Visibility": "Public",
+ "Kind": "Class",
+ "Sealed": true,
+ "BaseType": "System.Text.Encodings.Web.HtmlEncoder",
+ "ImplementedInterfaces": [],
+ "Members": [
+ {
+ "Kind": "Method",
+ "Name": "get_MaxOutputCharactersPerInputCharacter",
+ "Parameters": [],
+ "ReturnType": "System.Int32",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "Encode",
+ "Parameters": [
+ {
+ "Name": "value",
+ "Type": "System.String"
+ }
+ ],
+ "ReturnType": "System.String",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "Encode",
+ "Parameters": [
+ {
+ "Name": "output",
+ "Type": "System.IO.TextWriter"
+ },
+ {
+ "Name": "value",
+ "Type": "System.Char[]"
+ },
+ {
+ "Name": "startIndex",
+ "Type": "System.Int32"
+ },
+ {
+ "Name": "characterCount",
+ "Type": "System.Int32"
+ }
+ ],
+ "ReturnType": "System.Void",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "Encode",
+ "Parameters": [
+ {
+ "Name": "output",
+ "Type": "System.IO.TextWriter"
+ },
+ {
+ "Name": "value",
+ "Type": "System.String"
+ },
+ {
+ "Name": "startIndex",
+ "Type": "System.Int32"
+ },
+ {
+ "Name": "characterCount",
+ "Type": "System.Int32"
+ }
+ ],
+ "ReturnType": "System.Void",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "WillEncode",
+ "Parameters": [
+ {
+ "Name": "unicodeScalar",
+ "Type": "System.Int32"
+ }
+ ],
+ "ReturnType": "System.Boolean",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "FindFirstCharacterToEncode",
+ "Parameters": [
+ {
+ "Name": "text",
+ "Type": "System.Char*"
+ },
+ {
+ "Name": "textLength",
+ "Type": "System.Int32"
+ }
+ ],
+ "ReturnType": "System.Int32",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "TryEncodeUnicodeScalar",
+ "Parameters": [
+ {
+ "Name": "unicodeScalar",
+ "Type": "System.Int32"
+ },
+ {
+ "Name": "buffer",
+ "Type": "System.Char*"
+ },
+ {
+ "Name": "bufferLength",
+ "Type": "System.Int32"
+ },
+ {
+ "Name": "numberOfCharactersWritten",
+ "Type": "System.Int32",
+ "Direction": "Out"
+ }
+ ],
+ "ReturnType": "System.Boolean",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Constructor",
+ "Name": ".ctor",
+ "Parameters": [],
+ "Visibility": "Public",
+ "GenericParameter": []
+ }
+ ],
+ "GenericParameters": []
+ },
+ {
+ "Name": "Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder",
+ "Visibility": "Public",
+ "Kind": "Class",
+ "BaseType": "System.Text.Encodings.Web.JavaScriptEncoder",
+ "ImplementedInterfaces": [],
+ "Members": [
+ {
+ "Kind": "Method",
+ "Name": "get_MaxOutputCharactersPerInputCharacter",
+ "Parameters": [],
+ "ReturnType": "System.Int32",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "Encode",
+ "Parameters": [
+ {
+ "Name": "value",
+ "Type": "System.String"
+ }
+ ],
+ "ReturnType": "System.String",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "Encode",
+ "Parameters": [
+ {
+ "Name": "output",
+ "Type": "System.IO.TextWriter"
+ },
+ {
+ "Name": "value",
+ "Type": "System.Char[]"
+ },
+ {
+ "Name": "startIndex",
+ "Type": "System.Int32"
+ },
+ {
+ "Name": "characterCount",
+ "Type": "System.Int32"
+ }
+ ],
+ "ReturnType": "System.Void",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "Encode",
+ "Parameters": [
+ {
+ "Name": "output",
+ "Type": "System.IO.TextWriter"
+ },
+ {
+ "Name": "value",
+ "Type": "System.String"
+ },
+ {
+ "Name": "startIndex",
+ "Type": "System.Int32"
+ },
+ {
+ "Name": "characterCount",
+ "Type": "System.Int32"
+ }
+ ],
+ "ReturnType": "System.Void",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "WillEncode",
+ "Parameters": [
+ {
+ "Name": "unicodeScalar",
+ "Type": "System.Int32"
+ }
+ ],
+ "ReturnType": "System.Boolean",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "FindFirstCharacterToEncode",
+ "Parameters": [
+ {
+ "Name": "text",
+ "Type": "System.Char*"
+ },
+ {
+ "Name": "textLength",
+ "Type": "System.Int32"
+ }
+ ],
+ "ReturnType": "System.Int32",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "TryEncodeUnicodeScalar",
+ "Parameters": [
+ {
+ "Name": "unicodeScalar",
+ "Type": "System.Int32"
+ },
+ {
+ "Name": "buffer",
+ "Type": "System.Char*"
+ },
+ {
+ "Name": "bufferLength",
+ "Type": "System.Int32"
+ },
+ {
+ "Name": "numberOfCharactersWritten",
+ "Type": "System.Int32",
+ "Direction": "Out"
+ }
+ ],
+ "ReturnType": "System.Boolean",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Constructor",
+ "Name": ".ctor",
+ "Parameters": [],
+ "Visibility": "Public",
+ "GenericParameter": []
+ }
+ ],
+ "GenericParameters": []
+ },
+ {
+ "Name": "Microsoft.Extensions.WebEncoders.Testing.UrlTestEncoder",
+ "Visibility": "Public",
+ "Kind": "Class",
+ "BaseType": "System.Text.Encodings.Web.UrlEncoder",
+ "ImplementedInterfaces": [],
+ "Members": [
+ {
+ "Kind": "Method",
+ "Name": "get_MaxOutputCharactersPerInputCharacter",
+ "Parameters": [],
+ "ReturnType": "System.Int32",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "Encode",
+ "Parameters": [
+ {
+ "Name": "value",
+ "Type": "System.String"
+ }
+ ],
+ "ReturnType": "System.String",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "Encode",
+ "Parameters": [
+ {
+ "Name": "output",
+ "Type": "System.IO.TextWriter"
+ },
+ {
+ "Name": "value",
+ "Type": "System.Char[]"
+ },
+ {
+ "Name": "startIndex",
+ "Type": "System.Int32"
+ },
+ {
+ "Name": "characterCount",
+ "Type": "System.Int32"
+ }
+ ],
+ "ReturnType": "System.Void",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "Encode",
+ "Parameters": [
+ {
+ "Name": "output",
+ "Type": "System.IO.TextWriter"
+ },
+ {
+ "Name": "value",
+ "Type": "System.String"
+ },
+ {
+ "Name": "startIndex",
+ "Type": "System.Int32"
+ },
+ {
+ "Name": "characterCount",
+ "Type": "System.Int32"
+ }
+ ],
+ "ReturnType": "System.Void",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "WillEncode",
+ "Parameters": [
+ {
+ "Name": "unicodeScalar",
+ "Type": "System.Int32"
+ }
+ ],
+ "ReturnType": "System.Boolean",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "FindFirstCharacterToEncode",
+ "Parameters": [
+ {
+ "Name": "text",
+ "Type": "System.Char*"
+ },
+ {
+ "Name": "textLength",
+ "Type": "System.Int32"
+ }
+ ],
+ "ReturnType": "System.Int32",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "TryEncodeUnicodeScalar",
+ "Parameters": [
+ {
+ "Name": "unicodeScalar",
+ "Type": "System.Int32"
+ },
+ {
+ "Name": "buffer",
+ "Type": "System.Char*"
+ },
+ {
+ "Name": "bufferLength",
+ "Type": "System.Int32"
+ },
+ {
+ "Name": "numberOfCharactersWritten",
+ "Type": "System.Int32",
+ "Direction": "Out"
+ }
+ ],
+ "ReturnType": "System.Boolean",
+ "Virtual": true,
+ "Override": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Constructor",
+ "Name": ".ctor",
+ "Parameters": [],
+ "Visibility": "Public",
+ "GenericParameter": []
+ }
+ ],
+ "GenericParameters": []
+ },
+ {
+ "Name": "Microsoft.Extensions.DependencyInjection.EncoderServiceCollectionExtensions",
+ "Visibility": "Public",
+ "Kind": "Class",
+ "Abstract": true,
+ "Static": true,
+ "Sealed": true,
+ "ImplementedInterfaces": [],
+ "Members": [
+ {
+ "Kind": "Method",
+ "Name": "AddWebEncoders",
+ "Parameters": [
+ {
+ "Name": "services",
+ "Type": "Microsoft.Extensions.DependencyInjection.IServiceCollection"
+ }
+ ],
+ "ReturnType": "Microsoft.Extensions.DependencyInjection.IServiceCollection",
+ "Static": true,
+ "Extension": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ },
+ {
+ "Kind": "Method",
+ "Name": "AddWebEncoders",
+ "Parameters": [
+ {
+ "Name": "services",
+ "Type": "Microsoft.Extensions.DependencyInjection.IServiceCollection"
+ },
+ {
+ "Name": "setupAction",
+ "Type": "System.Action"
+ }
+ ],
+ "ReturnType": "Microsoft.Extensions.DependencyInjection.IServiceCollection",
+ "Static": true,
+ "Extension": true,
+ "Visibility": "Public",
+ "GenericParameter": []
+ }
+ ],
+ "GenericParameters": []
+ }
+ ]
+}
\ No newline at end of file
diff --git a/src/WebEncoders/test/EncoderServiceCollectionExtensionsTests.cs b/src/WebEncoders/test/EncoderServiceCollectionExtensionsTests.cs
new file mode 100644
index 0000000000..0178bba2d5
--- /dev/null
+++ b/src/WebEncoders/test/EncoderServiceCollectionExtensionsTests.cs
@@ -0,0 +1,90 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Text.Encodings.Web;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.WebEncoders.Testing;
+using Xunit;
+
+namespace Microsoft.Extensions.WebEncoders
+{
+ public class EncoderServiceCollectionExtensionsTests
+ {
+ [Fact]
+ public void AddWebEncoders_WithoutOptions_RegistersDefaultEncoders()
+ {
+ // Arrange
+ var serviceCollection = new ServiceCollection();
+
+ // Act
+ serviceCollection.AddWebEncoders();
+
+ // Assert
+ var serviceProvider = serviceCollection.BuildServiceProvider();
+ Assert.Same(HtmlEncoder.Default, serviceProvider.GetRequiredService()); // default encoder
+ Assert.Same(HtmlEncoder.Default, serviceProvider.GetRequiredService()); // as singleton instance
+ Assert.Same(JavaScriptEncoder.Default, serviceProvider.GetRequiredService()); // default encoder
+ Assert.Same(JavaScriptEncoder.Default, serviceProvider.GetRequiredService()); // as singleton instance
+ Assert.Same(UrlEncoder.Default, serviceProvider.GetRequiredService()); // default encoder
+ Assert.Same(UrlEncoder.Default, serviceProvider.GetRequiredService()); // as singleton instance
+ }
+
+ [Fact]
+ public void AddWebEncoders_WithOptions_RegistersEncodersWithCustomCodeFilter()
+ {
+ // Arrange
+ var serviceCollection = new ServiceCollection();
+
+ // Act
+ serviceCollection.AddWebEncoders(options =>
+ {
+ options.TextEncoderSettings = new TextEncoderSettings();
+ options.TextEncoderSettings.AllowCharacters("ace".ToCharArray()); // only these three chars are allowed
+ });
+
+ // Assert
+ var serviceProvider = serviceCollection.BuildServiceProvider();
+
+ var htmlEncoder = serviceProvider.GetRequiredService();
+ Assert.Equal("abcde", htmlEncoder.Encode("abcde"));
+ Assert.Same(htmlEncoder, serviceProvider.GetRequiredService()); // as singleton instance
+
+ var javaScriptEncoder = serviceProvider.GetRequiredService();
+ Assert.Equal(@"a\u0062c\u0064e", javaScriptEncoder.Encode("abcde"));
+ Assert.Same(javaScriptEncoder, serviceProvider.GetRequiredService()); // as singleton instance
+
+ var urlEncoder = serviceProvider.GetRequiredService();
+ Assert.Equal("a%62c%64e", urlEncoder.Encode("abcde"));
+ Assert.Same(urlEncoder, serviceProvider.GetRequiredService()); // as singleton instance
+ }
+
+ [Fact]
+ public void AddWebEncoders_DoesNotOverrideExistingRegisteredEncoders()
+ {
+ // Arrange
+ var serviceCollection = new ServiceCollection();
+
+ // Act
+ serviceCollection.AddSingleton();
+ serviceCollection.AddSingleton();
+ // we don't register an existing URL encoder
+ serviceCollection.AddWebEncoders(options =>
+ {
+ options.TextEncoderSettings = new TextEncoderSettings();
+ options.TextEncoderSettings.AllowCharacters("ace".ToCharArray()); // only these three chars are allowed
+ });
+
+ // Assert
+ var serviceProvider = serviceCollection.BuildServiceProvider();
+
+ var htmlEncoder = serviceProvider.GetRequiredService();
+ Assert.Equal("HtmlEncode[[abcde]]", htmlEncoder.Encode("abcde"));
+
+ var javaScriptEncoder = serviceProvider.GetRequiredService();
+ Assert.Equal("JavaScriptEncode[[abcde]]", javaScriptEncoder.Encode("abcde"));
+
+ var urlEncoder = serviceProvider.GetRequiredService();
+ Assert.Equal("a%62c%64e", urlEncoder.Encode("abcde"));
+ }
+ }
+}
diff --git a/src/WebEncoders/test/HtmlTestEncoderTest.cs b/src/WebEncoders/test/HtmlTestEncoderTest.cs
new file mode 100644
index 0000000000..baafedc4de
--- /dev/null
+++ b/src/WebEncoders/test/HtmlTestEncoderTest.cs
@@ -0,0 +1,26 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using Xunit;
+
+namespace Microsoft.Extensions.WebEncoders.Testing
+{
+ public class HtmlTestEncoderTest
+ {
+ [Theory]
+ [InlineData("", "")]
+ [InlineData("abcd", "HtmlEncode[[abcd]]")]
+ [InlineData("<<''\"\">>", "HtmlEncode[[<<''\"\">>]]")]
+ public void StringEncode_EncodesAsExpected(string input, string expectedOutput)
+ {
+ // Arrange
+ var encoder = new HtmlTestEncoder();
+
+ // Act
+ var output = encoder.Encode(input);
+
+ // Assert
+ Assert.Equal(expectedOutput, output);
+ }
+ }
+}
diff --git a/src/WebEncoders/test/Microsoft.Extensions.WebEncoders.Tests.csproj b/src/WebEncoders/test/Microsoft.Extensions.WebEncoders.Tests.csproj
new file mode 100755
index 0000000000..729dc5c61a
--- /dev/null
+++ b/src/WebEncoders/test/Microsoft.Extensions.WebEncoders.Tests.csproj
@@ -0,0 +1,12 @@
+
+
+
+ $(StandardTestTfms)
+
+
+
+
+
+
+
+