SecretSharingDotNet 0.12.0
dotnet add package SecretSharingDotNet --version 0.12.0
NuGet\Install-Package SecretSharingDotNet -Version 0.12.0
<PackageReference Include="SecretSharingDotNet" Version="0.12.0" />
paket add SecretSharingDotNet --version 0.12.0
#r "nuget: SecretSharingDotNet, 0.12.0"
// Install SecretSharingDotNet as a Cake Addin #addin nuget:?package=SecretSharingDotNet&version=0.12.0 // Install SecretSharingDotNet as a Cake Tool #tool nuget:?package=SecretSharingDotNet&version=0.12.0
Setup
Install SecretSharingDotNet package
Open a console and switch to the directory, containing your project file.
Use the following command to install version 0.12.0 of the SecretSharingDotNet package:
dotnet add package SecretSharingDotNet -v 0.12.0 -f <FRAMEWORK>
After the completion of the command, look at the project file to make sure that the package is successfully installed.
You can open the
.csproj
file to see the added package reference:<ItemGroup> <PackageReference Include="SecretSharingDotNet" Version="0.12.0" /> </ItemGroup>
Remove SecretSharingDotNet package
Open a console and switch to the directory, containing your project file.
Use the following command to remove the SecretSharingDotNet package:
dotnet remove package SecretSharingDotNet
After the completion of the command, look at the project file to make sure that the package is successfully removed.
You can open the
.csproj
file to check the deleted package reference.
Usage
Basics
Use the function MakeShares
to generate the shares, based on a random or pre-defined secret.
Afterwards, use the function Reconstruction
to re-construct the original secret.
The length of the shares is based on the security level. It is possible to pre-define a security level by ctor
or the SecurityLevel
property. The pre-defined security level will be overriden, if the secret size is greater than the Mersenne prime, which is calculated by means of the security level. It is not necessary to define a security level for a re-construction.
Using the SecretSharingDotNet library with DI in a .NET project.
This guide will demonstrate how to use the SecretSharingDotNet library with Dependency Injection (DI) in a .NET project.
Firstly, add the following dependencies:
using Microsoft.Extensions.DependencyInjection;
using SecretSharingDotNet.Cryptography;
using SecretSharingDotNet.Math;
using System.Numerics;
Next, initialize a ServiceCollection
instance and add dependencies to the DI container:
var serviceCollection = new ServiceCollection();
serviceCollection.AddSingleton<IExtendedGcdAlgorithm<BigInteger>, ExtendedEuclideanAlgorithm<BigInteger>>();
serviceCollection.AddSingleton<IMakeSharesUseCase<BigInteger>, ShamirsSecretSharing<BigInteger>>();
serviceCollection.AddSingleton<IReconstructionUseCase<BigInteger>, ShamirsSecretSharing<BigInteger>>();
using var serviceProvider = serviceCollection.BuildServiceProvider();
In the code above, the ServiceCollection
registers an implementation for each of the main components of the SecretSharingDotNet library.
Next, create an instance of the IMakeSharesUseCase<BigInteger>
:
var makeSharesUseCase = serviceProvider.GetRequiredService<IMakeSharesUseCase<BigInteger>>();
Using this instance, it is possible to create shares from a secret:
var shares = makeSharesUseCase.MakeShares(3, 7, "Hello!");
Console.WriteLine(shares);
Similarly, an instance of IReconstructionUseCase<BigInteger>
can be created to rebuild the original secret:
var reconstructionUseCase = serviceProvider.GetRequiredService<IReconstructionUseCase<BigInteger>>();
var reconstruction = reconstructionUseCase.Reconstruction(shares.Where(p => p.X.IsEven).ToArray());
Console.WriteLine(reconstruction);
The code above reconstructs the original secret from the shares, and then outputs it.
Random secret
Create a random secret in conjunction with the generation of shares. The length of the generated shares and of the secret are based on the security level. Here is an example with a pre-defined security level of 127:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Numerics;
using SecretSharingDotNet.Cryptography;
using SecretSharingDotNet.Math;
namespace Example1
{
public class Program
{
public static void Main(string[] args)
{
var gcd = new ExtendedEuclideanAlgorithm<BigInteger>();
//// Create Shamir's Secret Sharing instance with BigInteger
var split = new ShamirsSecretSharing<BigInteger>(gcd);
//// Minimum number of shared secrets for reconstruction: 3
//// Maximum number of shared secrets: 7
//// Security level: 127 (Mersenne prime exponent)
var shares = split.MakeShares(3, 7, 127);
//// The property 'shares.OriginalSecret' represents the random secret
var secret = shares.OriginalSecret;
//// Secret as big integer number
Console.WriteLine((BigInteger)secret);
//// Secret as base64 string
Console.WriteLine(secret.ToBase64());
//// The 'shares' instance contains the shared secrets
var combine = new ShamirsSecretSharing<BigInteger>(gcd);
var subSet1 = shares.Where(p => p.X.IsEven).ToList();
var recoveredSecret1 = combine.Reconstruction(subSet1.ToArray());
var subSet2 = shares.Where(p => !p.X.IsEven).ToList();
var recoveredSecret2 = combine.Reconstruction(subSet2.ToArray());
//// String representation of all shares
Console.WriteLine(shares);
//// 1st recovered secret as big integer number
Console.WriteLine((BigInteger)recoveredSecret1);
//// 2nd recovered secret as big integer number
Console.WriteLine((BigInteger)recoveredSecret2);
//// 1st recovered secret as base64 string
Console.WriteLine(recoveredSecret1.ToBase64());
//// 2nd recovered secret as base64 string
Console.WriteLine(recoveredSecret2.ToBase64());
}
}
}
Pre-defined secret: text
Use a text as secret, which can be divided into shares. The length of the generated shares is based on the security level. Here is an example with auto-detected security level:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Numerics;
using SecretSharingDotNet.Cryptography;
using SecretSharingDotNet.Math;
namespace Example2
{
public class Program
{
public static void Main(string[] args)
{
var gcd = new ExtendedEuclideanAlgorithm<BigInteger>();
//// Create Shamir's Secret Sharing instance with BigInteger
var split = new ShamirsSecretSharing<BigInteger>(gcd);
string password = "Hello World!!";
//// Minimum number of shared secrets for reconstruction: 3
//// Maximum number of shared secrets: 7
//// Attention: The password length can change the security level set by the ctor
//// or SecurityLevel property.
var shares = split.MakeShares(3, 7, password);
//// The property 'shares.OriginalSecret' represents the original password
var secret = shares.OriginalSecret;
//// The 'shares' instance contains the shared secrets
var combine = new ShamirsSecretSharing<BigInteger>(gcd);
var subSet1 = shares.Where(p => p.X.IsEven).ToList();
var recoveredSecret1 = combine.Reconstruction(subSet1.ToArray());
var subSet2 = shares.Where(p => !p.X.IsEven).ToList();
var recoveredSecret2 = combine.Reconstruction(subSet2.ToArray());
//// String representation of all shares
Console.WriteLine(shares);
//// 1st recovered secret as string (not base64!)
Console.WriteLine(recoveredSecret1);
//// 2nd recovered secret as string (not base64!)
Console.WriteLine(recoveredSecret2);
}
}
}
Pre-defined secret: number
Use an integer number as secret, which can be divided into shares. The length of the generated shares is based on the security level. Here is an example with a pre-defined security level of 521:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Numerics;
using SecretSharingDotNet.Cryptography;
using SecretSharingDotNet.Math;
namespace Example3
{
public class Program
{
public static void Main(string[] args)
{
var gcd = new ExtendedEuclideanAlgorithm<BigInteger>();
//// Create Shamir's Secret Sharing instance with BigInteger
//// and
var split = new ShamirsSecretSharing<BigInteger>(gcd);
BigInteger number = 20000;
//// Minimum number of shared secrets for reconstruction: 3
//// Maximum number of shared secrets: 7
//// Security level: 521 (Mersenne prime exponent)
//// Attention: The size of the number can change the security level set by the ctor
//// or SecurityLevel property.
var shares = split.MakeShares (3, 7, number, 521);
//// The property 'shares.OriginalSecret' represents the number (original secret)
var secret = shares.OriginalSecret;
//// The 'shares' instance contains the shared secrets
var combine = new ShamirsSecretSharing<BigInteger>(gcd);
var subSet1 = shares.Where(p => p.X.IsEven).ToList();
var recoveredSecret1 = combine.Reconstruction(subSet1.ToArray());
var subSet2 = shares.Where(p => !p.X.IsEven).ToList();
var recoveredSecret2 = combine.Reconstruction(subSet2.ToArray());
//// String representation of all shares
Console.WriteLine(shares);
//// 1st recovered secret as big integer number
Console.WriteLine((BigInteger)recoveredSecret1);
//// 2nd recovered secret as big integer number
Console.WriteLine((BigInteger)recoveredSecret2);
}
}
}
Pre-defined secret: byte array
Use a byte array as secret, which can be divided into shares. The length of the generated shares is based on the security level. Here is an example with auto-detected security level:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Numerics;
using SecretSharingDotNet.Cryptography;
using SecretSharingDotNet.Math;
namespace Example4
{
public class Program
{
public static void Main(string[] args)
{
var gcd = new ExtendedEuclideanAlgorithm<BigInteger>();
//// Create Shamir's Secret Sharing instance with BigInteger
var split = new ShamirsSecretSharing<BigInteger>(gcd);
byte[] bytes = { 0x1D, 0x2E, 0x3F };
//// Minimum number of shared secrets for reconstruction: 4
//// Maximum number of shared secrets: 10
//// Attention: The password length changes the security level set by the ctor
var shares = split.MakeShares(4, 10, bytes);
//// The 'shares' instance contains the shared secrets
var combine = new ShamirsSecretSharing<BigInteger>(gcd);
var subSet = shares.Where(p => p.X.IsEven).ToList();
var recoveredSecret = combine.Reconstruction(subSet.ToArray()).ToByteArray();
//// String representation of all shares
Console.WriteLine(shares);
//// The secret bytes.
Console.WriteLine($"{recoveredSecret[0]:X2}, {recoveredSecret[1]:X2}, {recoveredSecret[2]:X2}");
}
}
}
Shares
The following example shows three ways to use shares to reconstruct a secret:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Numerics;
using SecretSharingDotNet.Cryptography;
using SecretSharingDotNet.Math;
namespace Example5
{
public class Program
{
public static void Main(string[] args)
{
var gcd = new ExtendedEuclideanAlgorithm<BigInteger>();
//// One way to use shares
string shares1 = "02-665C74ED38FDFF095B2FC9319A272A75" + Environment.NewLine +
"05-CDECB88126DBC04D753E0C2D83D7B55D" + Environment.NewLine +
"07-54A83E34AB0310A7F5D80F2A68FD4F33";
//// A 2nd way to use shares
string[] shares2 = {"02-665C74ED38FDFF095B2FC9319A272A75",
"07-54A83E34AB0310A7F5D80F2A68FD4F33",
"05-CDECB88126DBC04D753E0C2D83D7B55D"};
//// Another way to use shares
var fp1 = new FinitePoint<BigInteger>("05-CDECB88126DBC04D753E0C2D83D7B55D");
var fp2 = new FinitePoint<BigInteger>("07-54A83E34AB0310A7F5D80F2A68FD4F33");
var fp3 = new FinitePoint<BigInteger>("02-665C74ED38FDFF095B2FC9319A272A75");
var combine = new ShamirsSecretSharing<BigInteger>(gcd);
var recoveredSecret1 = combine.Reconstruction(shares1);
//// Output should be 52199147989510990914370102003412153
Console.WriteLine((BigInteger)recoveredSecret1);
var recoveredSecret2 = combine.Reconstruction(shares2);
//// Output should be 52199147989510990914370102003412153
Console.WriteLine((BigInteger)recoveredSecret2);
//// Output should be 52199147989510990914370102003412153
var recoveredSecret3 = combine.Reconstruction(fp1, fp2, fp3);
Console.WriteLine((BigInteger)recoveredSecret3);
}
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net461 was computed. net462 is compatible. net463 was computed. net47 is compatible. net471 is compatible. net472 is compatible. net48 is compatible. net481 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.6.2
- No dependencies.
-
.NETFramework 4.7
- No dependencies.
-
.NETFramework 4.7.1
- No dependencies.
-
.NETFramework 4.7.2
- No dependencies.
-
.NETFramework 4.8
- No dependencies.
-
.NETFramework 4.8.1
- No dependencies.
-
.NETStandard 2.0
- No dependencies.
-
.NETStandard 2.1
- No dependencies.
-
net8.0
- No dependencies.
-
net9.0
- No dependencies.
NuGet packages (1)
Showing the top 1 NuGet packages that depend on SecretSharingDotNet:
Package | Downloads |
---|---|
Leosac.KeyManager.Library.KeyGen
Key Generation Library for Leosac Key Manager development |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
0.12.0 | 79 | 11/17/2024 |
0.11.0 | 9,941 | 12/30/2023 |
0.10.2 | 1,811 | 9/16/2023 |
0.10.1 | 2,063 | 5/8/2023 |
0.10.0 | 9,233 | 12/24/2022 |
0.9.0 | 1,076 | 10/9/2022 |
0.8.0 | 2,377 | 7/5/2022 |
0.7.0 | 5,160 | 2/8/2022 |
0.6.0 | 9,252 | 11/25/2021 |
0.5.0 | 458 | 10/7/2021 |
0.4.2 | 2,861 | 12/18/2020 |
0.3.0 | 642 | 4/19/2020 |
0.2.0 | 532 | 4/12/2020 |
0.1.1 | 570 | 4/10/2020 |