Skip to content

Commit f17597c

Browse files
MrMatthewLaytonMrMatthewLayton
authored
feature/security-token (#64)
Added `OnixLabs.Security` package, including security token and security token builder implementations.
1 parent c8e4edd commit f17597c

18 files changed

+1283
-11
lines changed

‎OnixLabs.Core.UnitTests/StringExtensionTests.cs

+16
Original file line numberDiff line numberDiff line change
@@ -199,4 +199,20 @@ public void WrapShouldProduceExpectedResult(string before, string value, string
199199
// Then
200200
Assert.Equal(expected, actual);
201201
}
202+
203+
[Theory(DisplayName = "String.ToEscapedString should produce the expected result")]
204+
[InlineData("\n", @"\n")]
205+
[InlineData("\r", @"\r")]
206+
[InlineData("\t", @"\t")]
207+
[InlineData("\"", @"\""")]
208+
[InlineData("\'", @"\'")]
209+
[InlineData("\\", @"\\")]
210+
public void ToEscapedStringShouldProduceExpectedResult(string value, string expected)
211+
{
212+
// When
213+
string actual = value.ToEscapedString();
214+
215+
// Then
216+
Assert.Equal(expected, actual);
217+
}
202218
}

‎OnixLabs.Core/Extensions.String.cs

+42
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
using System.Globalization;
1818
using System.Linq;
1919
using System.Text;
20+
using OnixLabs.Core.Text;
2021

2122
namespace OnixLabs.Core;
2223

@@ -308,4 +309,45 @@ public static bool TryCopyTo(this string value, Span<char> destination, out int
308309
/// <param name="after">The <see cref="String"/> that should succeed the current <see cref="String"/> instance.</param>
309310
/// <returns>Returns a new <see cref="String"/> instance representing the current <see cref="String"/> instance, wrapped between the specified before and after <see cref="String"/> instances.</returns>
310311
public static string Wrap(this string value, string before, string after) => $"{before}{value}{after}";
312+
313+
/// <summary>
314+
/// Returns a <see cref="string"/> with all escape characters formatted as escape character literals.
315+
/// </summary>
316+
/// <param name="value">The current <see cref="String"/> value.</param>
317+
/// <returns>Returns a <see cref="string"/> with all escape characters formatted as escape character literals.</returns>
318+
public static string ToEscapedString(this string value)
319+
{
320+
StringBuilder result = new();
321+
322+
foreach (char c in value)
323+
{
324+
switch (c)
325+
{
326+
case '\n':
327+
result.AppendEscaped('n');
328+
break;
329+
case '\r':
330+
result.AppendEscaped('r');
331+
break;
332+
case '\t':
333+
result.AppendEscaped('t');
334+
break;
335+
case '\"':
336+
result.AppendEscaped('"');
337+
break;
338+
case '\'':
339+
result.AppendEscaped('\'');
340+
break;
341+
case '\\':
342+
result.AppendEscaped('\\');
343+
break;
344+
default:
345+
if (char.IsControl(c)) result.Append($"\\u{(int)c:X4}");
346+
else result.Append(c);
347+
break;
348+
}
349+
}
350+
351+
return result.ToString();
352+
}
311353
}

‎OnixLabs.Core/OnixLabs.Core.csproj

+5-3
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,11 @@
77
<Title>OnixLabs.Core</Title>
88
<Authors>ONIXLabs</Authors>
99
<Description>ONIXLabs Core API for .NET</Description>
10-
<AssemblyVersion>8.0.0</AssemblyVersion>
10+
<AssemblyVersion>8.9.0</AssemblyVersion>
1111
<NeutralLanguage>en</NeutralLanguage>
1212
<Copyright>Copyright © ONIXLabs 2020</Copyright>
1313
<RepositoryUrl>https://github.com/onix-labs/onixlabs-dotnet</RepositoryUrl>
14-
<PackageVersion>8.8.0</PackageVersion>
15-
<PackageLicenseUrl></PackageLicenseUrl>
14+
<PackageVersion>8.9.0</PackageVersion>
1615
</PropertyGroup>
1716
<PropertyGroup>
1817
<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
@@ -31,6 +30,9 @@
3130
<PropertyGroup Condition="'$(CI)' == 'true'">
3231
<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
3332
</PropertyGroup>
33+
<PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
34+
<DebugSymbols>true</DebugSymbols>
35+
</PropertyGroup>
3436
<ItemGroup>
3537
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0">
3638
<PrivateAssets>all</PrivateAssets>

‎OnixLabs.Core/Text/Extensions.StringBuilder.cs

+12-2
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,30 @@ namespace OnixLabs.Core.Text;
2525
[EditorBrowsable(EditorBrowsableState.Never)]
2626
public static class StringBuilderExtensions
2727
{
28+
private const char EscapeSequence = '\\';
29+
2830
/// <summary>
2931
/// Appends the specified values to the current <see cref="StringBuilder"/>.
3032
/// </summary>
3133
/// <param name="builder">The <see cref="StringBuilder"/> to append to.</param>
3234
/// <param name="values">The values to append.</param>
33-
/// <returns>Returns the current <see cref="StringBuilder"/> with the specified items appended.</returns>
35+
/// <returns>Returns the current <see cref="StringBuilder"/> with the specified values appended.</returns>
3436
public static StringBuilder Append(this StringBuilder builder, params object[] values) => builder.Append(values.JoinToString(string.Empty));
3537

38+
/// <summary>
39+
/// Appends the specified value, prefixed with the escape sequence to the current <see cref="StringBuilder"/>.
40+
/// </summary>
41+
/// <param name="builder">The <see cref="StringBuilder"/> to append to.</param>
42+
/// <param name="value">The value to append.</param>
43+
/// <returns>Returns the current <see cref="StringBuilder"/> with the escape sequence and specified value appended.</returns>
44+
internal static StringBuilder AppendEscaped(this StringBuilder builder, char value) => builder.Append(EscapeSequence).Append(value);
45+
3646
/// <summary>
3747
/// Prepends the specified values to the current <see cref="StringBuilder"/>.
3848
/// </summary>
3949
/// <param name="builder">The <see cref="StringBuilder"/> to prepend to.</param>
4050
/// <param name="values">The values to prepend.</param>
41-
/// <returns>Returns the current <see cref="StringBuilder"/> with the specified items prepended.</returns>
51+
/// <returns>Returns the current <see cref="StringBuilder"/> with the specified values prepended.</returns>
4252
public static StringBuilder Prepend(this StringBuilder builder, params object[] values) => builder.Insert(0, values.JoinToString(string.Empty));
4353

4454
/// <summary>

‎OnixLabs.Numerics/OnixLabs.Numerics.csproj

+5-3
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@
44
<Title>OnixLabs.Numerics</Title>
55
<Authors>ONIXLabs</Authors>
66
<Description>ONIXLabs Numerics API for .NET</Description>
7-
<AssemblyVersion>8.0.0</AssemblyVersion>
7+
<AssemblyVersion>8.9.0</AssemblyVersion>
88
<NeutralLanguage>en</NeutralLanguage>
99
<Nullable>enable</Nullable>
1010
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
1111
<Copyright>Copyright © ONIXLabs 2020</Copyright>
1212
<RepositoryUrl>https://github.com/onix-labs/onixlabs-dotnet</RepositoryUrl>
13-
<PackageVersion>8.8.0</PackageVersion>
13+
<PackageVersion>8.9.0</PackageVersion>
1414
<LangVersion>12</LangVersion>
15-
<PackageLicenseUrl></PackageLicenseUrl>
1615
</PropertyGroup>
1716
<PropertyGroup>
1817
<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
@@ -31,6 +30,9 @@
3130
<PropertyGroup Condition="'$(CI)' == 'true'">
3231
<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
3332
</PropertyGroup>
33+
<PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
34+
<DebugSymbols>true</DebugSymbols>
35+
</PropertyGroup>
3436
<ItemGroup>
3537
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0">
3638
<PrivateAssets>all</PrivateAssets>

‎OnixLabs.Playground/OnixLabs.Playground.csproj

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
<ProjectReference Include="..\OnixLabs.Core\OnixLabs.Core.csproj"/>
1414
<ProjectReference Include="..\OnixLabs.Numerics\OnixLabs.Numerics.csproj"/>
1515
<ProjectReference Include="..\OnixLabs.Security.Cryptography\OnixLabs.Security.Cryptography.csproj"/>
16+
<ProjectReference Include="..\OnixLabs.Security\OnixLabs.Security.csproj" />
1617
</ItemGroup>
1718
<ItemGroup>
1819
<Using Include="OnixLabs.Core.Preconditions" Static="True"/>

‎OnixLabs.Playground/Program.cs

+22
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,33 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
using System;
16+
using OnixLabs.Core;
17+
using OnixLabs.Security;
18+
1519
namespace OnixLabs.Playground;
1620

1721
internal static class Program
1822
{
1923
private static void Main()
2024
{
25+
int[] lengths = [1, 2, 4, 8, 16, 32, 64, 128];
26+
int[] seeds = [0, 4, 7, 9, 123, 256, 721, 999];
27+
28+
foreach (int length in lengths)
29+
{
30+
foreach (int seed in seeds)
31+
{
32+
string token = SecurityTokenBuilder
33+
.CreatePseudoRandom(length, seed)
34+
.UseAlphaNumericCharacters()
35+
.UseExtendedSpecialCharacters()
36+
.ToSecurityToken()
37+
.ToString()
38+
.ToEscapedString();
39+
40+
Console.WriteLine($"[InlineData({length}, {seed}, \"{token}\")]");
41+
}
42+
}
2143
}
2244
}

‎OnixLabs.Security.Cryptography/OnixLabs.Security.Cryptography.csproj

+5-3
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@
44
<Title>OnixLabs.Security.Cryptography</Title>
55
<Authors>ONIXLabs</Authors>
66
<Description>ONIXLabs Cryptography API for .NET</Description>
7-
<AssemblyVersion>8.0.0</AssemblyVersion>
7+
<AssemblyVersion>8.9.0</AssemblyVersion>
88
<NeutralLanguage>en</NeutralLanguage>
99
<Nullable>enable</Nullable>
1010
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
1111
<Copyright>Copyright © ONIXLabs 2020</Copyright>
1212
<RepositoryUrl>https://github.com/onix-labs/onixlabs-dotnet</RepositoryUrl>
13-
<PackageVersion>8.8.0</PackageVersion>
13+
<PackageVersion>8.9.0</PackageVersion>
1414
<LangVersion>12</LangVersion>
15-
<PackageLicenseUrl></PackageLicenseUrl>
1615
</PropertyGroup>
1716
<PropertyGroup>
1817
<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
@@ -31,6 +30,9 @@
3130
<PropertyGroup Condition="'$(CI)' == 'true'">
3231
<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
3332
</PropertyGroup>
33+
<PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
34+
<DebugSymbols>true</DebugSymbols>
35+
</PropertyGroup>
3436
<ItemGroup>
3537
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0">
3638
<PrivateAssets>all</PrivateAssets>

‎OnixLabs.Security.UnitTests/OnixLabs.Security.UnitTests.csproj

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFramework>net8.0</TargetFramework>
5+
<ImplicitUsings>enable</ImplicitUsings>
6+
<Nullable>enable</Nullable>
7+
8+
<IsPackable>false</IsPackable>
9+
<IsTestProject>true</IsTestProject>
10+
</PropertyGroup>
11+
12+
<ItemGroup>
13+
<PackageReference Include="coverlet.collector" Version="6.0.0"/>
14+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0"/>
15+
<PackageReference Include="xunit" Version="2.5.3"/>
16+
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.3"/>
17+
</ItemGroup>
18+
19+
<ItemGroup>
20+
<Using Include="Xunit"/>
21+
</ItemGroup>
22+
23+
<ItemGroup>
24+
<ProjectReference Include="..\OnixLabs.Security\OnixLabs.Security.csproj" />
25+
</ItemGroup>
26+
27+
</Project>

0 commit comments

Comments
 (0)