To configure an instance of IEncryptionService that can be used throughout your project, call AddEncryption when registering services:
// program.cs
var builder = WebApplication.CreateBuilder(args);
builder.Services
.AddEncryption()
.AddScheme<TContentEncryptionOptions, TContentHander, TKeyEncryptionOptions, TKeyHandler>("<scheme_name>",
contentEncrptionOptions => { ... },
keyEncryptionOptions => { ... }
); // calls can be chained to .AddScheme<> to register more encryption schemes!
To inject an instance of IEncryptionHandler into your class for data encryption and/or decryption,
add a constructor dependency for IEncryptionService.
To automatically encrypt and decrypt a property when utilizing Entity Framework Core, you may optionally annotate your data models with the Encrypted attribute:
public class Bank
{
public int Id { get; set; }
[Encrypted] // Utilizes registered DefaultScheme
public string RoutingNumber { get; set; }
[Encrypted("AccountNumber")] // Utilizes registered AccountNumber scheme
public string AccountNumber { get; set; }
}
You can then register the encryption service with your Entity Framework DbContext:
public class DatabaseContext : DbContext
{
private readonly IEncryptionService _encryptionService;
public DbSet<Bank> Banks { get; set; }
public DatabaseContext(DbContextOptions options, IEncryptionService encryptionService)
: base(options)
{
_encryptionService = encryptionService;
}
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.UseEncryption(_encryptionService);
}
}
Development
The provided scripts with the SDK will check for all dependencies, start docker, build the solution, and run all tests.
