ByteDev.Crypto 5.0.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package ByteDev.Crypto --version 5.0.2
NuGet\Install-Package ByteDev.Crypto -Version 5.0.2
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="ByteDev.Crypto" Version="5.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ByteDev.Crypto --version 5.0.2
#r "nuget: ByteDev.Crypto, 5.0.2"
#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 ByteDev.Crypto as a Cake Addin
#addin nuget:?package=ByteDev.Crypto&version=5.0.2

// Install ByteDev.Crypto as a Cake Tool
#tool nuget:?package=ByteDev.Crypto&version=5.0.2

ByteDev.Crypto

Provides simple cryptographic related classes for hashing/verifying data, encrypting/decrypting data and creating crypto random data in .NET.

Installation

ByteDev.Crypto has been written as a .NET Standard 2.0 library, so you can consume it from a .NET Core or .NET Framework 4.6.1 (or greater) application.

ByteDev.Crypto is hosted as a package on nuget.org. To install from the Package Manager Console in Visual Studio run:

Install-Package ByteDev.Crypto

Further details can be found on the nuget page.

Release Notes

Releases follow semantic versioning.

Full details of the release notes can be viewed on GitHub.

Usage

The library's main classes:

  • HashingService
  • EncryptionService
  • CryptoRandom

Hashing

Use namespace ByteDev.Crypto.Hashing.

HashService class methods:

  • Hash
  • Verify
  • CalcFileChecksum

Hash some clear text (returned as base 64 encoded string) and verify a guess is equal:

IHashService service = new HashService(new Md5Algorithm(), EncodingType.Base64);

string hash = service.Hash(new ClearPhrase("Password1"));

bool isLoginSuccessful = service.Verify(new ClearPhrase("passwordGuess"), hash);

Calculate a checksum for a file (returned as hex encoded string):

IHashService service = new HashService(new Md5Algorithm(), EncodingType.Hex);

string checksum = service.CalcFileChecksum(@"C:\somefile.txt");

Encryption

Use namespace ByteDev.Crypto.Encryption.

EncryptionService class methods:

  • Encrypt
  • Decrypt
  • EncryptProperties
  • DecryptProperties

Initialize EncryptionService:

IEncryptionAlgorithm algo = new RijndaelAlgorithm();

IEncryptionKeyIvFactory keyFactory = new EncryptionKeyIvFactory(algo);
EncryptionKeyIv keyIv = keyFactory.Create("Password1", Encoding.UTF8.GetBytes("someSalt"));

IEncryptionService service = new EncryptionService(algo, keyIv);

Encrypt a secret with a key and then decrypt it:

byte[] cipher = service.Encrypt("mySecret");

string clearText = service.Decrypt(cipher);	 

// clearText == "mySecret"

Once a byte array cipher has been created the ByteDev.Encoding.Encoder class can be used for any required encoding:

byte[] cipher = service.Encrypt("mySecret", keyIv);

Encoder encoder = new Encoder(EncodingType.Hex);

string hex = encoder.Encode(cipher);

The EncryptionService class also supports encrypting/decrypting an object's public string properties that use EncryptAttribute through the EncryptProperties and DecryptProperties methods.

public class MyInfo
{
    [Encrypt]
    public string Secrets { get; set; }
}

var info = new MyInfo { Secrets = "Some secrets" };

service.EncryptProperties(info, EncodingType.Hex);

// info.Secrets is now encrypted and encoded as hex

service.DecryptProperties(info, EncodingType.Hex);

// info.Secrets == "Some secrets"

Random

Use namespace ByteDev.Crypto.Random.

CryptoRandom class methods:

  • GenerateString
  • GenerateArray

Generate a random string of a specified length using only the character set specified:

const int length = 5;

using (var r = new CryptoRandom(CharacterSets.AlphaNumeric))
{
    string randomString = r.GenerateString(length);
}

You can also call GenerateString with a min and max length.

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 (2)

Showing the top 2 NuGet packages that depend on ByteDev.Crypto:

Package Downloads
ByteDev.Testing.NUnit

.NET Standard library that provides some extra NUnit functionality.

ByteDev.AirVpn.IpLeak

.NET Standard library to help communicate with the IP Leak API.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.0.0 16,155 10/14/2021
7.0.0 566 5/31/2021
6.1.0 368 5/24/2021
6.0.0 389 1/20/2021
5.1.1 383 1/18/2021
5.1.0 437 12/18/2020
5.0.2 1,083 7/2/2020
5.0.1 523 7/2/2020
5.0.0 472 6/8/2020
4.0.0 544 4/29/2020
3.3.0 467 4/25/2020
3.2.0 588 3/28/2020
3.1.0 523 3/25/2020
3.0.3 491 2/28/2020
3.0.1 523 11/8/2019
3.0.0 576 4/10/2019
2.1.0 601 3/7/2019
2.0.0 660 2/12/2019
1.2.0 672 12/17/2018
1.1.0 771 9/24/2018
1.0.0 835 8/17/2018