NetKeystore 1.0.0

dotnet add package NetKeystore --version 1.0.0
NuGet\Install-Package NetKeystore -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NetKeystore" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NetKeystore --version 1.0.0
#r "nuget: NetKeystore, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install NetKeystore as a Cake Addin
#addin nuget:?package=NetKeystore&version=1.0.0

// Install NetKeystore as a Cake Tool
#tool nuget:?package=NetKeystore&version=1.0.0

NetKeystore

The library is available as a NuGet package here.

Introduction

This is a light-weight library that's only responsible for dealing with Ethereum keystore files written in C#.

Using the Package

Adding to your project

Add the package by using the following command:

$ dotnet add package NetKeystore

Using it in your code

First, obtain a KeystoreReader instance from a Keystore object, a string containing the JSON content or a file name:

var reader = KeystoreReader.FromFile("/path/to/keystore");

Then, use the TryDecrypt function to decrypt the keystore file:

reader.TryDecrypt("ASDF12345", out var privateKey);

The function returns false if the passphase provided is incorrect, or throws an exception if the cipher or kdf is not supported (yet).

Limitations

Currently the functionality of the library is quite limited with the following known limitations:

  • Can only decrypt keystore files; no way to creat one
  • Only supports scrypt as the key derivation function

I will try to perfect the library in the future, or you can help me do it together 😉

Contribution

Contributions are welcomed! You may post issues on GitHub, or better, post pull requests for this project.

You can also contribute test data as part of the unit test!

Product 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 was computed.  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. 
.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 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 1,112 4/26/2018