Skip to content

Commit eb89528

Browse files
buyaa-nViktorHoferstephentoub
authored
Add Base64Url support for netstandard 2.0 (#103617)
* Base64Url netstandard support package * Enable compiler doc generation and simplify forwards * Add supression for [ClsCompliant(false)] attribute * Remove ClsComplaint attribute and diff suppression * Use char type direcly instead of ushort, as we are not using vectorization * Fix bug in char overload and other small updates * Apply suggestions from code review Co-authored-by: Stephen Toub <stoub@microsoft.com> * Update src/libraries/Microsoft.Bcl.Memory/src/System/Buffers/Text/Base64UrlDecoder.cs Co-authored-by: Stephen Toub <stoub@microsoft.com> * Use instance methods, share netstandard and .NET 9 code * Apply feedbacks --------- Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com> Co-authored-by: Stephen Toub <stoub@microsoft.com>
1 parent 95964c1 commit eb89528

22 files changed

+3174
-2605
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
2+
Microsoft Visual Studio Solution File, Format Version 12.00
3+
# Visual Studio Version 17
4+
VisualStudioVersion = 17.10.35004.147
5+
MinimumVisualStudioVersion = 10.0.40219.1
6+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Bcl.Memory", "ref\Microsoft.Bcl.Memory.csproj", "{97D0AA68-5D2E-4E18-9651-19D0143EA98A}"
7+
EndProject
8+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Bcl.Memory", "src\Microsoft.Bcl.Memory.csproj", "{D4D9D9AC-E482-457A-8047-5267BDF2C2EE}"
9+
EndProject
10+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.Bcl.Memory.Tests", "tests\Microsoft.Bcl.Memory.Tests.csproj", "{6916DB98-2958-498D-83E7-90080BEA9D39}"
11+
EndProject
12+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{76C22FE9-D65E-40C3-BE2D-98BD628779EC}"
13+
EndProject
14+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ref", "ref", "{76EDDEA8-0E0E-4A94-9D8F-F4DB250E8EB8}"
15+
EndProject
16+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{E78D7A3F-384B-4AA3-ABF1-C4464BE9237C}"
17+
EndProject
18+
Global
19+
GlobalSection(SolutionConfigurationPlatforms) = preSolution
20+
Debug|Any CPU = Debug|Any CPU
21+
Release|Any CPU = Release|Any CPU
22+
EndGlobalSection
23+
GlobalSection(ProjectConfigurationPlatforms) = postSolution
24+
{D4D9D9AC-E482-457A-8047-5267BDF2C2EE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
25+
{D4D9D9AC-E482-457A-8047-5267BDF2C2EE}.Debug|Any CPU.Build.0 = Debug|Any CPU
26+
{D4D9D9AC-E482-457A-8047-5267BDF2C2EE}.Release|Any CPU.ActiveCfg = Release|Any CPU
27+
{D4D9D9AC-E482-457A-8047-5267BDF2C2EE}.Release|Any CPU.Build.0 = Release|Any CPU
28+
{97D0AA68-5D2E-4E18-9651-19D0143EA98A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
29+
{97D0AA68-5D2E-4E18-9651-19D0143EA98A}.Debug|Any CPU.Build.0 = Debug|Any CPU
30+
{97D0AA68-5D2E-4E18-9651-19D0143EA98A}.Release|Any CPU.ActiveCfg = Release|Any CPU
31+
{97D0AA68-5D2E-4E18-9651-19D0143EA98A}.Release|Any CPU.Build.0 = Release|Any CPU
32+
{6916DB98-2958-498D-83E7-90080BEA9D39}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
33+
{6916DB98-2958-498D-83E7-90080BEA9D39}.Debug|Any CPU.Build.0 = Debug|Any CPU
34+
{6916DB98-2958-498D-83E7-90080BEA9D39}.Release|Any CPU.ActiveCfg = Release|Any CPU
35+
{6916DB98-2958-498D-83E7-90080BEA9D39}.Release|Any CPU.Build.0 = Release|Any CPU
36+
EndGlobalSection
37+
GlobalSection(SolutionProperties) = preSolution
38+
HideSolutionNode = FALSE
39+
EndGlobalSection
40+
GlobalSection(NestedProjects) = preSolution
41+
{D4D9D9AC-E482-457A-8047-5267BDF2C2EE} = {76C22FE9-D65E-40C3-BE2D-98BD628779EC}
42+
{97D0AA68-5D2E-4E18-9651-19D0143EA98A} = {76EDDEA8-0E0E-4A94-9D8F-F4DB250E8EB8}
43+
{6916DB98-2958-498D-83E7-90080BEA9D39} = {E78D7A3F-384B-4AA3-ABF1-C4464BE9237C}
44+
EndGlobalSection
45+
GlobalSection(ExtensibilityGlobals) = postSolution
46+
SolutionGuid = {CB4D3234-B365-4A38-B9C6-47B72CE8BC85}
47+
EndGlobalSection
48+
EndGlobal
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the MIT license.
3+
4+
[assembly: System.Runtime.CompilerServices.TypeForwardedTo(typeof(System.Buffers.Text.Base64Url))]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the MIT license.
3+
4+
namespace System.Buffers.Text
5+
{
6+
public static class Base64Url
7+
{
8+
public static byte[] DecodeFromChars(System.ReadOnlySpan<char> source) { throw null; }
9+
public static int DecodeFromChars(System.ReadOnlySpan<char> source, System.Span<byte> destination) { throw null; }
10+
public static System.Buffers.OperationStatus DecodeFromChars(System.ReadOnlySpan<char> source, System.Span<byte> destination, out int charsConsumed, out int bytesWritten, bool isFinalBlock = true) { throw null; }
11+
public static byte[] DecodeFromUtf8(System.ReadOnlySpan<byte> source) { throw null; }
12+
public static int DecodeFromUtf8(System.ReadOnlySpan<byte> source, System.Span<byte> destination) { throw null; }
13+
public static System.Buffers.OperationStatus DecodeFromUtf8(System.ReadOnlySpan<byte> source, System.Span<byte> destination, out int bytesConsumed, out int bytesWritten, bool isFinalBlock = true) { throw null; }
14+
public static int DecodeFromUtf8InPlace(System.Span<byte> buffer) { throw null; }
15+
public static char[] EncodeToChars(System.ReadOnlySpan<byte> source) { throw null; }
16+
public static int EncodeToChars(System.ReadOnlySpan<byte> source, System.Span<char> destination) { throw null; }
17+
public static System.Buffers.OperationStatus EncodeToChars(System.ReadOnlySpan<byte> source, System.Span<char> destination, out int bytesConsumed, out int charsWritten, bool isFinalBlock = true) { throw null; }
18+
public static string EncodeToString(System.ReadOnlySpan<byte> source) { throw null; }
19+
public static byte[] EncodeToUtf8(System.ReadOnlySpan<byte> source) { throw null; }
20+
public static int EncodeToUtf8(System.ReadOnlySpan<byte> source, System.Span<byte> destination) { throw null; }
21+
public static System.Buffers.OperationStatus EncodeToUtf8(System.ReadOnlySpan<byte> source, System.Span<byte> destination, out int bytesConsumed, out int bytesWritten, bool isFinalBlock = true) { throw null; }
22+
public static int GetEncodedLength(int bytesLength) { throw null; }
23+
public static int GetMaxDecodedLength(int base64Length) { throw null; }
24+
public static bool IsValid(System.ReadOnlySpan<char> base64UrlText) { throw null; }
25+
public static bool IsValid(System.ReadOnlySpan<char> base64UrlText, out int decodedLength) { throw null; }
26+
public static bool IsValid(System.ReadOnlySpan<byte> utf8Base64UrlText) { throw null; }
27+
public static bool IsValid(System.ReadOnlySpan<byte> utf8Base64UrlText, out int decodedLength) { throw null; }
28+
public static bool TryDecodeFromChars(System.ReadOnlySpan<char> source, System.Span<byte> destination, out int bytesWritten) { throw null; }
29+
public static bool TryDecodeFromUtf8(System.ReadOnlySpan<byte> source, System.Span<byte> destination, out int bytesWritten) { throw null; }
30+
public static bool TryEncodeToChars(System.ReadOnlySpan<byte> source, System.Span<char> destination, out int charsWritten) { throw null; }
31+
public static bool TryEncodeToUtf8(System.ReadOnlySpan<byte> source, System.Span<byte> destination, out int bytesWritten) { throw null; }
32+
public static bool TryEncodeToUtf8InPlace(System.Span<byte> buffer, int dataLength, out int bytesWritten) { throw null; }
33+
}
34+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFrameworks>netstandard2.0;$(NetFrameworkMinimum);$(NetCoreAppCurrent)</TargetFrameworks>
5+
</PropertyGroup>
6+
7+
<ItemGroup Condition="'$(TargetFrameworkIdentifier)' != '.NETCoreApp'">
8+
<Compile Include="Microsoft.Bcl.Memory.cs" />
9+
</ItemGroup>
10+
11+
<ItemGroup Condition="'$(TargetFrameworkIdentifier)' == '.NETCoreApp'">
12+
<Compile Include="Microsoft.Bcl.Memory.Forwards.cs" />
13+
</ItemGroup>
14+
15+
<ItemGroup Condition="'$(TargetFrameworkIdentifier)' != '.NETCoreApp'">
16+
<PackageReference Include="System.Memory" Version="$(SystemMemoryVersion)" />
17+
</ItemGroup>
18+
19+
</Project>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFrameworks>netstandard2.0;$(NetFrameworkMinimum);$(NetCoreAppCurrent)</TargetFrameworks>
5+
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
6+
<IsPackable>true</IsPackable>
7+
<!-- Disabling baseline validation since this is a brand new package.
8+
Once this package has shipped a stable version, the following line
9+
should be removed in order to re-enable validation. -->
10+
<DisablePackageBaselineValidation>true</DisablePackageBaselineValidation>
11+
<PackageDescription>
12+
Provides Base64Url encoding, decoding and validation APIs support for .NET Framework and .NET Standard.
13+
14+
Commonly Used Types:
15+
System.Buffers.Text.Base64Url
16+
</PackageDescription>
17+
</PropertyGroup>
18+
19+
<!-- DesignTimeBuild requires all the TargetFramework Derived Properties to not be present in the first property group. -->
20+
<PropertyGroup>
21+
<OmitResources Condition="$([MSBuild]::GetTargetFrameworkIdentifier('$(TargetFramework)')) == '.NETCoreApp'">true</OmitResources>
22+
</PropertyGroup>
23+
24+
<ItemGroup Condition="'$(TargetFrameworkIdentifier)' == '.NETCoreApp'">
25+
<Compile Include="..\ref\Microsoft.Bcl.Memory.Forwards.cs" />
26+
</ItemGroup>
27+
28+
<ItemGroup Condition="'$(TargetFrameworkIdentifier)' != '.NETCoreApp'">
29+
<Compile Include="..\..\System.Private.CoreLib\src\System\Buffers\Text\Base64Helper\Base64Helper.cs">
30+
<Link>System\Buffers\Text\Base64Helper\Base64Helper.cs</Link>
31+
</Compile>
32+
<Compile Include="..\..\System.Private.CoreLib\src\System\Buffers\Text\Base64Helper\Base64DecoderHelper.cs">
33+
<Link>System\Buffers\Text\Base64Helper\Base64DecoderHelper.cs</Link>
34+
</Compile>
35+
<Compile Include="..\..\System.Private.CoreLib\src\System\Buffers\Text\Base64Helper\Base64EncoderHelper.cs">
36+
<Link>System\Buffers\Text\Base64Helper\Base64EncoderHelper.cs</Link>
37+
</Compile>
38+
<Compile Include="..\..\System.Private.CoreLib\src\System\Buffers\Text\Base64Helper\Base64ValidatorHelper.cs">
39+
<Link>System\Buffers\Text\Base64Helper\Base64ValidatorHelper.cs</Link>
40+
</Compile>
41+
<Compile Include="..\..\System.Private.CoreLib\src\System\Buffers\Text\Base64Url\Base64UrlDecoder.cs">
42+
<Link>System\Buffers\Text\Base64Url\Base64UrlDecoder.cs</Link>
43+
</Compile>
44+
<Compile Include="..\..\System.Private.CoreLib\src\System\Buffers\Text\Base64Url\Base64UrlEncoder.cs">
45+
<Link>System\Buffers\Text\Base64Url\Base64UrlEncoder.cs</Link>
46+
</Compile>
47+
<Compile Include="..\..\System.Private.CoreLib\src\System\Buffers\Text\Base64Url\Base64UrlValidator.cs">
48+
<Link>System\Buffers\Text\Base64Url\Base64UrlValidator.cs</Link>
49+
</Compile>
50+
</ItemGroup>
51+
52+
<ItemGroup Condition="'$(TargetFrameworkIdentifier)' != '.NETCoreApp'">
53+
<PackageReference Include="System.Memory" Version="$(SystemMemoryVersion)" />
54+
</ItemGroup>
55+
56+
</Project>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="Argument_DestinationTooShort" xml:space="preserve">
121+
<value>Destination is too short.</value>
122+
</data>
123+
<data name="Format_BadBase64Char" xml:space="preserve">
124+
<value>The input is not a valid Base64Url string as it contains a non-Base64Url character, more than two padding characters, or an illegal character among the padding characters.</value>
125+
</data>
126+
</root>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFrameworks>$(NetFrameworkMinimum);$(NetCoreAppCurrent);</TargetFrameworks>
5+
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
6+
</PropertyGroup>
7+
8+
<ItemGroup>
9+
<Compile Include="..\..\System.Memory\tests\AllocationHelper.cs">
10+
<Link>System\Memory\AllocationHelper.cs</Link>
11+
</Compile>
12+
<Compile Include="..\..\System.Memory\tests\Base64\Base64TestBase.cs">
13+
<Link>System\Memory\Base64\Base64TestBase.cs</Link>
14+
</Compile>
15+
<Compile Include="..\..\System.Memory\tests\Base64\Base64TestHelper.cs">
16+
<Link>System\Memory\Base64\Base64TestHelper.cs</Link>
17+
</Compile>
18+
<Compile Include="..\..\System.Memory\tests\Base64Url\Base64UrlDecoderUnitTests.cs">
19+
<Link>System\Memory\Base64Url\Base64UrlDecoderUnitTests.cs</Link>
20+
</Compile>
21+
<Compile Include="..\..\System.Memory\tests\Base64Url\Base64UrlEncoderUnitTests.cs">
22+
<Link>System\Memory\Base64Url\Base64UrlEncoderUnitTests.cs</Link>
23+
</Compile>
24+
<Compile Include="..\..\System.Memory\tests\Base64Url\Base64UrlValidationUnitTests.cs">
25+
<Link>System\Memory\Base64Url\Base64UrlValidationUnitTests.cs</Link>
26+
</Compile>
27+
</ItemGroup>
28+
29+
<ItemGroup Condition="'$(TargetFrameworkIdentifier)' != '.NETCoreApp'">
30+
<ProjectReference Include="..\src\Microsoft.Bcl.Memory.csproj" />
31+
</ItemGroup>
32+
33+
</Project>

src/libraries/System.Memory/tests/Base64/Base64TestBase.cs

+23-1
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,35 @@ public static IEnumerable<object[]> BasicDecodingWithExtraWhitespaceShouldBeCoun
113113
var r = new Random(42);
114114
for (int i = 0; i < 5; i++)
115115
{
116-
yield return new object[] { "AQ==" + new string(r.GetItems<char>(" \n\t\r", i)), 4 + i, 1 };
116+
yield return new object[] { "AQ==" + new string(GetChars(r, i)), 4 + i, 1 };
117117
}
118118

119119
foreach (string s in new[] { "MTIz", "M TIz", "MT Iz", "MTI z", "MTIz ", "M TI z", "M T I Z " })
120120
{
121121
yield return new object[] { s + s + s + s, s.Length * 4, 12 };
122122
}
123123
}
124+
125+
private static char[] GetChars(Random r, int i)
126+
{
127+
#if NETCOREAPP
128+
return r.GetItems<char>(" \n\t\r", i);
129+
#else
130+
byte[] bytes = new byte[i];
131+
char[] chars = new char[i];
132+
r.NextBytes(bytes);
133+
for (int j = 0; j < bytes.Length; j++)
134+
{
135+
switch (bytes[j] % 4)
136+
{
137+
case 0: chars[j] = ' '; break;
138+
case 1: chars[j] = '\n'; break;
139+
case 2: chars[j] = '\t'; break;
140+
case 3: chars[j] = '\r'; break;
141+
}
142+
}
143+
return chars;
144+
#endif
145+
}
124146
}
125147
}

0 commit comments

Comments
 (0)