readme.source.md

Newtonsoft.Json.Encryption

Leverages the Newtonsoft extension API to encrypt/decrypt specific nodes at serialization time. So only the nodes that require encryption are touched, the remaining content is still human readable. This approach provides an compromise between readability/debugabaility and security.

Already a Patron? skip past this section

Community backed

It is expected that all developers either become a Patron to use NServiceBusExtensions. Go to licensing FAQ

Sponsors

Support this project by becoming a Sponsor. The company avatar will show up here with a website link. The avatar will also be added to all GitHub repositories under the NServiceBusExtensions organization.

Patrons

Thanks to all the backing developers. Support this project by becoming a patron.

toc

NuGet packages

• https://nuget.org/packages/Newtonsoft.Json.Encryption/
• https://nuget.org/packages/Rebus.Newtonsoft.Encryption/
• https://nuget.org/packages/NServiceBus.Newtonsoft.Encryption/

Encryption Algorithms

Any implementation of SymmetricAlgorithm is supported.

Decorating properties

public class ClassToSerialize
{
    [Encrypt]
    public string Property { get; set; }
}

Serialized

{
    "Property":"wSayABpFI3g7a/D6gGTq5g=="
}

Supported property types

• string
• byte[]
• Guid
• IDictionary<T, string>
• IDictionary<T, byte[]>
• IDictionary<T, Guid>
• IEnumerable<string>
• IEnumerable<byte[]>
• IEnumerable<Guid>

Note that only the values in a IDictionary are encrypted.

Usage

The full serialize and deserialization workflow: snippet: Workflow

Breakdown

Key

See SymmetricAlgorithm.Key.

Example Key used for RijndaelManaged algorithm in the below sample code:

var key = Encoding.UTF8.GetBytes("gdDbqRpqdRbTs3mhdZh9qCaDaxJXl+e6");

A new valid key can be generated by instanitiating a SymmetricAlgorithm and accessing SymmetricAlgorithm.Key.

EncryptionFactory and JsonSerializer

Generally a single instance of EncryptionFactory will exist per AppDomain.

A single instance of EncryptionFactory is safe to be used for multiple instances of JsonSerializer.

var factory = new EncryptionFactory();

var serializer = new JsonSerializer
{
    ContractResolver = factory.GetContractResolver()
};

Serialization

A single encrypt session is used per serialization instance.

On instantiation the SymmetricAlgorithm will generate a valid IV. This is generally a good value to use for serialization and then stored for deserialization.

snippet: serialize

Deserialization

A single decrypt session is used per serialization instance.

• key must be the same as the one use for serialization.
• initVector must be the same as the one use for serialization. It is safe to be transferred with the serialized text.

snippet: deserialize

Rebus

snippet: RebugsUsage

NServiceBus

snippet: NsbUsage

Icon

Lock designed by Mourad Mokrane from The Noun Project.