Skip to content

Commit 71d3e0f

Browse files
MrMatthewLaytonMrMatthewLayton
authored
feature/crypto-named-primitives (#70)
* Added `NamedPrivateKey`, `NamedPublicKey`, and `DigitalSignatureAndPublicKey`. * Updated library versions.
1 parent df1cb7c commit 71d3e0f

9 files changed

+198
-8
lines changed

‎OnixLabs.Core/OnixLabs.Core.csproj

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
<Title>OnixLabs.Core</Title>
88
<Authors>ONIXLabs</Authors>
99
<Description>ONIXLabs Core API for .NET</Description>
10-
<AssemblyVersion>8.12.0</AssemblyVersion>
10+
<AssemblyVersion>8.13.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.12.0</PackageVersion>
14+
<PackageVersion>8.13.0</PackageVersion>
1515
</PropertyGroup>
1616
<PropertyGroup>
1717
<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>

‎OnixLabs.Numerics/OnixLabs.Numerics.csproj

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
<Title>OnixLabs.Numerics</Title>
55
<Authors>ONIXLabs</Authors>
66
<Description>ONIXLabs Numerics API for .NET</Description>
7-
<AssemblyVersion>8.12.0</AssemblyVersion>
7+
<AssemblyVersion>8.13.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.12.0</PackageVersion>
13+
<PackageVersion>8.13.0</PackageVersion>
1414
<LangVersion>12</LangVersion>
1515
</PropertyGroup>
1616
<PropertyGroup>

‎OnixLabs.Security.Cryptography/DigitalSignatureAndPublicKey.cs

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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+
namespace OnixLabs.Security.Cryptography;
16+
17+
/// <summary>
18+
/// Represents a pair of a cryptography digital signature, and a named cryptographic public key.
19+
/// </summary>
20+
/// <param name="Signature">The underlying cryptographic digital signature.</param>
21+
/// <param name="Key">The underlying named cryptographic public key.</param>
22+
public readonly record struct DigitalSignatureAndPublicKey(DigitalSignature Signature, NamedPublicKey Key);

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

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
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 record struct NamedPrivateKey
21+
{
22+
/// <summary>
23+
/// Gets the underlying <see cref="T:Byte[]"/> representation of the underlying <see cref="NamedPrivateKey"/> instance.
24+
/// </summary>
25+
/// <returns>Return the underlying <see cref="T:Byte[]"/> representation of the underlying <see cref="NamedPrivateKey"/> instance.</returns>
26+
public byte[] ToByteArray() => PrivateKey.ToByteArray();
27+
28+
/// <summary>
29+
/// Returns a <see cref="string"/> that represents the current object.
30+
/// </summary>
31+
/// <param name="provider">The format provider that will be used to determine the format of the string.</param>
32+
/// <returns>Returns a <see cref="string"/> that represents the current object.</returns>
33+
public string ToString(IFormatProvider provider) => $"{AlgorithmName}:{IBaseCodec.GetString(ToByteArray(), provider)}";
34+
35+
/// <summary>
36+
/// Returns a <see cref="string"/> that represents the current object.
37+
/// </summary>
38+
/// <returns>Returns a <see cref="string"/> that represents the current object.</returns>
39+
public override string ToString() => ToString(Base16FormatProvider.Invariant);
40+
}

‎OnixLabs.Security.Cryptography/NamedPrivateKey.cs

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
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+
namespace OnixLabs.Security.Cryptography;
16+
17+
/// <summary>
18+
/// Represents a named cryptographic private key.
19+
/// </summary>
20+
public readonly partial record struct NamedPrivateKey : ICryptoPrimitive<NamedPrivateKey>
21+
{
22+
private const string KeyAlgorithmNameNullOrWhiteSpace = "Key algorithm name must not be null or whitespace.";
23+
24+
/// <summary>
25+
/// Initializes a new instance of the <see cref="NamedPrivateKey"/> struct.
26+
/// </summary>
27+
/// <param name="privateKey">The underlying private key value.</param>
28+
/// <param name="algorithmName">The name of the key algorithm that was used to produce the associated private key.</param>
29+
public NamedPrivateKey(PrivateKey privateKey, string algorithmName)
30+
{
31+
PrivateKey = privateKey;
32+
AlgorithmName = RequireNotNullOrWhiteSpace(algorithmName, KeyAlgorithmNameNullOrWhiteSpace);
33+
}
34+
35+
/// <summary>
36+
/// Gets the underlying private key value.
37+
/// </summary>
38+
public PrivateKey PrivateKey { get; }
39+
40+
/// <summary>
41+
/// Gets the name of the key algorithm that was used to produce the associated private key.
42+
/// </summary>
43+
public string AlgorithmName { get; }
44+
}

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

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
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 record struct NamedPublicKey
21+
{
22+
/// <summary>
23+
/// Gets the underlying <see cref="T:Byte[]"/> representation of the underlying <see cref="NamedPublicKey"/> instance.
24+
/// </summary>
25+
/// <returns>Return the underlying <see cref="T:Byte[]"/> representation of the underlying <see cref="NamedPublicKey"/> instance.</returns>
26+
public byte[] ToByteArray() => PublicKey.ToByteArray();
27+
28+
/// <summary>
29+
/// Returns a <see cref="string"/> that represents the current object.
30+
/// </summary>
31+
/// <param name="provider">The format provider that will be used to determine the format of the string.</param>
32+
/// <returns>Returns a <see cref="string"/> that represents the current object.</returns>
33+
public string ToString(IFormatProvider provider) => $"{AlgorithmName}:{IBaseCodec.GetString(ToByteArray(), provider)}";
34+
35+
/// <summary>
36+
/// Returns a <see cref="string"/> that represents the current object.
37+
/// </summary>
38+
/// <returns>Returns a <see cref="string"/> that represents the current object.</returns>
39+
public override string ToString() => ToString(Base16FormatProvider.Invariant);
40+
}

‎OnixLabs.Security.Cryptography/NamedPublicKey.cs

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
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+
namespace OnixLabs.Security.Cryptography;
16+
17+
/// <summary>
18+
/// Represents a named cryptographic public key.
19+
/// </summary>
20+
public readonly partial record struct NamedPublicKey : ICryptoPrimitive<NamedPublicKey>
21+
{
22+
private const string KeyAlgorithmNameNullOrWhiteSpace = "Key algorithm name must not be null or whitespace.";
23+
24+
/// <summary>
25+
/// Initializes a new instance of the <see cref="NamedPublicKey"/> struct.
26+
/// </summary>
27+
/// <param name="publicKey">The underlying public key value.</param>
28+
/// <param name="algorithmName">The name of the key algorithm that was used to produce the associated public key.</param>
29+
public NamedPublicKey(PublicKey publicKey, string algorithmName)
30+
{
31+
PublicKey = publicKey;
32+
AlgorithmName = RequireNotNullOrWhiteSpace(algorithmName, KeyAlgorithmNameNullOrWhiteSpace);
33+
}
34+
35+
/// <summary>
36+
/// Gets the underlying public key value.
37+
/// </summary>
38+
public PublicKey PublicKey { get; }
39+
40+
/// <summary>
41+
/// Gets the name of the key algorithm that was used to produce the associated public key.
42+
/// </summary>
43+
public string AlgorithmName { get; }
44+
}

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
<Title>OnixLabs.Security.Cryptography</Title>
55
<Authors>ONIXLabs</Authors>
66
<Description>ONIXLabs Cryptography API for .NET</Description>
7-
<AssemblyVersion>8.12.0</AssemblyVersion>
7+
<AssemblyVersion>8.13.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.12.0</PackageVersion>
13+
<PackageVersion>8.13.0</PackageVersion>
1414
<LangVersion>12</LangVersion>
1515
</PropertyGroup>
1616
<PropertyGroup>

‎OnixLabs.Security/OnixLabs.Security.csproj

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
<Title>OnixLabs.Security</Title>
55
<Authors>ONIXLabs</Authors>
66
<Description>ONIXLabs Security API for .NET</Description>
7-
<AssemblyVersion>8.12.0</AssemblyVersion>
7+
<AssemblyVersion>8.13.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.12.0</PackageVersion>
13+
<PackageVersion>8.13.0</PackageVersion>
1414
<LangVersion>12</LangVersion>
1515
</PropertyGroup>
1616
<PropertyGroup>

0 commit comments

Comments
 (0)