Skip to content

Commit 1778ba8

Browse files
MrMatthewLaytonMrMatthewLayton
committed
Merge branch 'refs/heads/main' into release
2 parents 047e5e6 + 4f3e8c6 commit 1778ba8

40 files changed

+1032
-57
lines changed

‎OnixLabs.Core/OnixLabs.Core.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<NeutralLanguage>en</NeutralLanguage>
1212
<Copyright>Copyright © ONIXLabs 2020</Copyright>
1313
<RepositoryUrl>https://github.com/onix-labs/onixlabs-dotnet</RepositoryUrl>
14-
<PackageVersion>8.3.0</PackageVersion>
14+
<PackageVersion>8.4.0</PackageVersion>
1515
<PackageLicenseUrl></PackageLicenseUrl>
1616
</PropertyGroup>
1717
<PropertyGroup>

‎OnixLabs.Core/Text/Base64FormatProvider.cs

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
// Copyright 2020 ONIXLabs
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
using System;
16+
17+
namespace OnixLabs.Core.Text;
18+
19+
/// <summary>
20+
/// Represents a Base-64 format provider.
21+
/// </summary>
22+
public sealed class Base64FormatProvider : Enumeration<Base64FormatProvider>, IFormatProvider
23+
{
24+
/// <summary>
25+
/// Gets the RFC 4648 Base-64 format provider.
26+
/// </summary>
27+
public static readonly Base64FormatProvider Rfc4648 = new(0, nameof(Rfc4648), "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=");
28+
29+
/// <summary>
30+
/// Initializes a new instance of the <see cref="Base64FormatProvider"/> class.
31+
/// </summary>
32+
/// <param name="value">The value of the enumeration entry.</param>
33+
/// <param name="name">The name of the enumeration entry.</param>
34+
/// <param name="alphabet">The alphabet of the format provider.</param>
35+
private Base64FormatProvider(int value, string name, string alphabet) : base(value, name)
36+
{
37+
Alphabet = alphabet;
38+
}
39+
40+
/// <summary>
41+
/// Gets the alphabet of the current <see cref="Base64FormatProvider"/> instance.
42+
/// </summary>
43+
public string Alphabet { get; }
44+
45+
/// <summary>Gets an object that provides formatting services for the specified type.</summary>
46+
/// <param name="formatType">An object that specifies the type of format object to return.</param>
47+
/// <returns>
48+
/// Returns an instance of the object specified by <paramref name="formatType"/>,
49+
/// if the <see cref="T:IFormatProvider"/> implementation can supply that type of object; otherwise, <see langword="null"/>.
50+
/// </returns>
51+
public object? GetFormat(Type? formatType) => formatType == typeof(Base64FormatProvider) ? this : null;
52+
}

‎OnixLabs.Core/Text/Extensions.cs

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
// Copyright 2020 ONIXLabs
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
using System;
16+
using System.ComponentModel;
17+
18+
namespace OnixLabs.Core.Text;
19+
20+
/// <summary>
21+
/// Provides extension methods for read-only spans.
22+
/// </summary>
23+
// ReSharper disable UnusedMethodReturnValue.Global
24+
[EditorBrowsable(EditorBrowsableState.Never)]
25+
public static class Extensions
26+
{
27+
/// <summary>
28+
/// Converts the current <see cref="T:Byte[]"/> into a new <see cref="Base16"/> instance.
29+
/// </summary>
30+
/// <param name="value">The <see cref="T:Byte[]"/> value to convert.</param>
31+
/// <returns>Returns a new <see cref="Base16"/> instance.</returns>
32+
public static Base16 ToBase16(this byte[] value) => new(value);
33+
34+
/// <summary>
35+
/// Converts the current <see cref="T:Byte[]"/> into a new <see cref="Base32"/> instance.
36+
/// </summary>
37+
/// <param name="value">The <see cref="T:Byte[]"/> value to convert.</param>
38+
/// <returns>Returns a new <see cref="Base32"/> instance.</returns>
39+
public static Base32 ToBase32(this byte[] value) => new(value);
40+
41+
/// <summary>
42+
/// Converts the current <see cref="T:Byte[]"/> into a new <see cref="Base58"/> instance.
43+
/// </summary>
44+
/// <param name="value">The <see cref="T:Byte[]"/> value to convert.</param>
45+
/// <returns>Returns a new <see cref="Base58"/> instance.</returns>
46+
public static Base58 ToBase58(this byte[] value) => new(value);
47+
48+
/// <summary>
49+
/// Converts the current <see cref="T:Byte[]"/> into a new <see cref="Base64"/> instance.
50+
/// </summary>
51+
/// <param name="value">The <see cref="T:Byte[]"/> value to convert.</param>
52+
/// <returns>Returns a new <see cref="Base64"/> instance.</returns>
53+
public static Base64 ToBase64(this byte[] value) => new(value);
54+
55+
/// <summary>
56+
/// Converts the current <see cref="ReadOnlySpan{Byte}"/> into a new <see cref="Base16"/> instance.
57+
/// </summary>
58+
/// <param name="value">The <see cref="ReadOnlySpan{Byte}"/> value to convert.</param>
59+
/// <returns>Returns a new <see cref="Base16"/> instance.</returns>
60+
public static Base16 ToBase16(this ReadOnlySpan<byte> value) => new(value);
61+
62+
/// <summary>
63+
/// Converts the current <see cref="ReadOnlySpan{Byte}"/> into a new <see cref="Base32"/> instance.
64+
/// </summary>
65+
/// <param name="value">The <see cref="ReadOnlySpan{Byte}"/> value to convert.</param>
66+
/// <returns>Returns a new <see cref="Base32"/> instance.</returns>
67+
public static Base32 ToBase32(this ReadOnlySpan<byte> value) => new(value);
68+
69+
/// <summary>
70+
/// Converts the current <see cref="ReadOnlySpan{Byte}"/> into a new <see cref="Base58"/> instance.
71+
/// </summary>
72+
/// <param name="value">The <see cref="ReadOnlySpan{Byte}"/> value to convert.</param>
73+
/// <returns>Returns a new <see cref="Base58"/> instance.</returns>
74+
public static Base58 ToBase58(this ReadOnlySpan<byte> value) => new(value);
75+
76+
/// <summary>
77+
/// Converts the current <see cref="ReadOnlySpan{Byte}"/> into a new <see cref="Base64"/> instance.
78+
/// </summary>
79+
/// <param name="value">The <see cref="ReadOnlySpan{Byte}"/> value to convert.</param>
80+
/// <returns>Returns a new <see cref="Base64"/> instance.</returns>
81+
public static Base64 ToBase64(this ReadOnlySpan<byte> value) => new(value);
82+
}

‎OnixLabs.Core/Text/IBaseCodec.cs

+80
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,86 @@ public interface IBaseCodec
5151
/// </summary>
5252
public static Base64Codec Base64 => new();
5353

54+
/// <summary>
55+
/// Obtains a base <see cref="string"/> representation of the specified <see cref="ReadOnlySpan{Byte}"/> value.
56+
/// </summary>
57+
/// <param name="value">The value to convert.</param>
58+
/// <param name="provider">
59+
/// The <see cref="IFormatProvider"/> which will be used to obtain the base representation.
60+
/// <remarks> Allowed values for this parameter are <see cref="Base16FormatProvider"/>, <see cref="Base32FormatProvider"/>, <see cref="Base58FormatProvider"/>, and <see cref="Base64FormatProvider"/>.</remarks>
61+
/// </param>
62+
/// <returns>Returns a base <see cref="string"/> representation of the specified <see cref="ReadOnlySpan{Byte}"/> value.</returns>
63+
/// <exception cref="FormatException">If the specified <see cref="ReadOnlySpan{Byte}"/> value cannot be converted.</exception>
64+
public static string GetString(ReadOnlySpan<byte> value, IFormatProvider provider)
65+
{
66+
if (TryGetString(value, provider, out string result)) return result;
67+
throw new FormatException(EncodingFormatException);
68+
}
69+
70+
/// <summary>
71+
/// Obtains a new <see cref="T:byte[]"/> array by converting the specified <see cref="ReadOnlySpan{Char}"/> value.
72+
/// </summary>
73+
/// <param name="value">The value to convert.</param>
74+
/// <param name="provider">
75+
/// The <see cref="IFormatProvider"/> which will be used to convert the specified <see cref="ReadOnlySpan{Char}"/> value.
76+
/// <remarks> Allowed values for this parameter are <see cref="Base16FormatProvider"/>, <see cref="Base32FormatProvider"/>, <see cref="Base58FormatProvider"/>, and <see cref="Base64FormatProvider"/>.</remarks>
77+
/// </param>
78+
/// <returns>Returns a new <see cref="T:byte[]"/> array by converting the specified <see cref="ReadOnlySpan{Char}"/> value.</returns>
79+
/// <exception cref="FormatException">If the specified <see cref="ReadOnlySpan{Char}"/> value cannot be converted.</exception>
80+
public static byte[] GetBytes(ReadOnlySpan<char> value, IFormatProvider provider)
81+
{
82+
if (TryGetBytes(value, provider, out byte[] result)) return result;
83+
throw new FormatException(DecodingFormatException);
84+
}
85+
86+
/// <summary>
87+
/// Tries to obtain a base <see cref="string"/> representation of the specified <see cref="ReadOnlySpan{Byte}"/> value.
88+
/// </summary>
89+
/// <param name="value">The value to convert.</param>
90+
/// <param name="provider">
91+
/// The <see cref="IFormatProvider"/> which will be used to obtain the base representation.
92+
/// <remarks> Allowed values for this parameter are <see cref="Base16FormatProvider"/>, <see cref="Base32FormatProvider"/>, <see cref="Base58FormatProvider"/>, and <see cref="Base64FormatProvider"/>.</remarks>
93+
/// </param>
94+
/// <param name="result"> A base <see cref="string"/> representation of the specified <see cref="ReadOnlySpan{Byte}"/> value, or an empty string if the value cannot be converted.</param>
95+
/// <returns>Returns <see langword="true"/> if the conversion was successful; otherwise, <see langword="false"/>.</returns>
96+
public static bool TryGetString(ReadOnlySpan<byte> value, IFormatProvider provider, out string result)
97+
{
98+
result = string.Empty;
99+
100+
return provider switch
101+
{
102+
Base16FormatProvider => Base16.TryEncode(value, provider, out result),
103+
Base32FormatProvider => Base32.TryEncode(value, provider, out result),
104+
Base58FormatProvider => Base58.TryEncode(value, provider, out result),
105+
Base64FormatProvider => Base64.TryEncode(value, provider, out result),
106+
_ => false
107+
};
108+
}
109+
110+
/// <summary>
111+
/// Tries to obtain a new <see cref="T:byte[]"/> array by converting the specified <see cref="ReadOnlySpan{Char}"/> value.
112+
/// </summary>
113+
/// <param name="value">The value to convert.</param>
114+
/// <param name="provider">
115+
/// The <see cref="IFormatProvider"/> which will be used to convert the specified <see cref="ReadOnlySpan{Char}"/> value.
116+
/// <remarks> Allowed values for this parameter are <see cref="Base16FormatProvider"/>, <see cref="Base32FormatProvider"/>, <see cref="Base58FormatProvider"/>, and <see cref="Base64FormatProvider"/>.</remarks>
117+
/// </param>
118+
/// <param name="result">A new <see cref="T:byte[]"/> array by converting the specified <see cref="ReadOnlySpan{Char}"/> value, or an empty <see cref="T:byte[]"/> array if the value cannot be converted.</param>
119+
/// <returns>Returns <see langword="true"/> if the conversion was successful; otherwise, <see langword="false"/>.</returns>
120+
public static bool TryGetBytes(ReadOnlySpan<char> value, IFormatProvider provider, out byte[] result)
121+
{
122+
result = [];
123+
124+
return provider switch
125+
{
126+
Base16FormatProvider => Base16.TryDecode(value, provider, out result),
127+
Base32FormatProvider => Base32.TryDecode(value, provider, out result),
128+
Base58FormatProvider => Base58.TryDecode(value, provider, out result),
129+
Base64FormatProvider => Base64.TryDecode(value, provider, out result),
130+
_ => false
131+
};
132+
}
133+
54134
/// <summary>
55135
/// Encodes the specified <see cref="ReadOnlySpan{T}"/> value into a Base-N <see cref="String"/> representation.
56136
/// </summary>

‎OnixLabs.Numerics/OnixLabs.Numerics.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
1111
<Copyright>Copyright © ONIXLabs 2020</Copyright>
1212
<RepositoryUrl>https://github.com/onix-labs/onixlabs-dotnet</RepositoryUrl>
13-
<PackageVersion>8.3.0</PackageVersion>
13+
<PackageVersion>8.4.0</PackageVersion>
1414
<LangVersion>12</LangVersion>
1515
<PackageLicenseUrl></PackageLicenseUrl>
1616
</PropertyGroup>

‎OnixLabs.Security.Cryptography/DigitalSignature.Parse.cs

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
// Copyright 2020 ONIXLabs
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
using System;
16+
using OnixLabs.Core.Text;
17+
18+
namespace OnixLabs.Security.Cryptography;
19+
20+
public readonly partial struct DigitalSignature
21+
{
22+
/// <summary>
23+
/// Parses the specified <see cref="String"/> value into a <see cref="DigitalSignature"/> value.
24+
/// </summary>
25+
/// <param name="value">The value to parse.</param>
26+
/// <param name="provider">The format provider that will be used to decode the specified value.</param>
27+
/// <returns>Returns a new <see cref="DigitalSignature"/> instance, parsed from the specified <see cref="String"/> value.</returns>
28+
public static DigitalSignature Parse(string value, IFormatProvider? provider = null) => Parse(value.AsSpan(), provider);
29+
30+
/// <summary>
31+
/// Parses the specified <see cref="ReadOnlySpan{Char}"/> value into a <see cref="DigitalSignature"/> value.
32+
/// </summary>
33+
/// <param name="value">The value to parse.</param>
34+
/// <param name="provider">The format provider that will be used to decode the specified value.</param>
35+
/// <returns>Returns a new <see cref="DigitalSignature"/> instance, parsed from the specified <see cref="ReadOnlySpan{Char}"/> value.</returns>
36+
public static DigitalSignature Parse(ReadOnlySpan<char> value, IFormatProvider? provider = null)
37+
{
38+
if (TryParse(value, provider, out DigitalSignature result)) return result;
39+
throw new FormatException($"The input string '{value}' was not in a correct format.");
40+
}
41+
42+
/// <summary>
43+
/// Tries to parse the specified <see cref="String"/> value into a <see cref="DigitalSignature"/> value.
44+
/// </summary>
45+
/// <param name="value">The value to parse.</param>
46+
/// <param name="provider">The format provider that will be used to decode the specified value.</param>
47+
/// <param name="result">
48+
/// A new <see cref="DigitalSignature"/> instance, parsed from the specified <see cref="String"/> value, or the default
49+
/// <see cref="DigitalSignature"/> value if the specified <see cref="String"/> could not be parsed.
50+
/// </param>
51+
/// <returns>Returns <see langword="true"/> if the specified value was decoded successfully; otherwise, <see langword="false"/>.</returns>
52+
public static bool TryParse(string? value, IFormatProvider? provider, out DigitalSignature result) => TryParse(value.AsSpan(), provider, out result);
53+
54+
/// <summary>
55+
/// Tries to parse the specified <see cref="ReadOnlySpan{Char}"/> value into a <see cref="DigitalSignature"/> value.
56+
/// </summary>
57+
/// <param name="value">The value to parse.</param>
58+
/// <param name="provider">The format provider that will be used to decode the specified value.</param>
59+
/// <param name="result">
60+
/// A new <see cref="DigitalSignature"/> instance, parsed from the specified <see cref="ReadOnlySpan{Char}"/> value, or the default
61+
/// <see cref="DigitalSignature"/> value if the specified <see cref="ReadOnlySpan{Char}"/> could not be parsed.
62+
/// </param>
63+
/// <returns>Returns <see langword="true"/> if the specified value was decoded successfully; otherwise, <see langword="false"/>.</returns>
64+
public static bool TryParse(ReadOnlySpan<char> value, IFormatProvider? provider, out DigitalSignature result)
65+
{
66+
bool isDecoded = IBaseCodec.TryGetBytes(value, provider ?? Base16FormatProvider.Invariant, out byte[] bytes);
67+
result = new DigitalSignature(bytes);
68+
return isDecoded;
69+
}
70+
}

‎OnixLabs.Security.Cryptography/DigitalSignature.To.cs

+12-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
// limitations under the License.
1414

1515
using System;
16+
using System.Text;
1617
using OnixLabs.Core;
18+
using OnixLabs.Core.Text;
1719

1820
namespace OnixLabs.Security.Cryptography;
1921

@@ -26,8 +28,15 @@ public readonly partial struct DigitalSignature
2628
public byte[] ToByteArray() => value.Copy();
2729

2830
/// <summary>
29-
/// Returns a <see cref="String"/> that represents the current object.
31+
/// Returns a <see cref="string"/> that represents the current object.
3032
/// </summary>
31-
/// <returns>Returns a <see cref="String"/> that represents the current object.</returns>
32-
public override string ToString() => Convert.ToHexString(value).ToLower();
33+
/// <param name="provider">The format provider that will be used to determine the format of the string.</param>
34+
/// <returns>Returns a <see cref="string"/> that represents the current object.</returns>
35+
public string ToString(IFormatProvider provider) => IBaseCodec.GetString(ToByteArray(), provider);
36+
37+
/// <summary>
38+
/// Returns a <see cref="string"/> that represents the current object.
39+
/// </summary>
40+
/// <returns>Returns a <see cref="string"/> that represents the current object.</returns>
41+
public override string ToString() => ToString(Base16FormatProvider.Invariant);
3342
}

‎OnixLabs.Security.Cryptography/DigitalSignature.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ namespace OnixLabs.Security.Cryptography;
2020
/// Represents a cryptographic digital signature.
2121
/// </summary>
2222
/// <param name="value">The underlying value of the cryptographic digital signature.</param>
23-
public readonly partial struct DigitalSignature(ReadOnlySpan<byte> value) : ICryptoPrimitive<DigitalSignature>
23+
public readonly partial struct DigitalSignature(ReadOnlySpan<byte> value) : ICryptoPrimitive<DigitalSignature>, ISpanParsable<DigitalSignature>
2424
{
2525
private readonly byte[] value = value.ToArray();
2626
}

0 commit comments

Comments
 (0)