WIP: Version 4 rework

Author: Eastrall

.editorconfig

@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 16
-VisualStudioVersion = 16.0.30804.86
+# Visual Studio Version 17
+VisualStudioVersion = 17.3.32901.215
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{3EC10767-1816-46B2-A78E-9856071CCFDB}"
 EndProject
@@ -22,15 +22,11 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{64C3
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AesSample", "samples\AesSample\AesSample.csproj", "{8AA1E576-4016-4623-96C8-90330F05F9A8}"
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".azure", ".azure", "{073FEA06-67CF-47F8-8CE4-2B153A7D8443}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".github", ".github", "{EEF46CDC-C438-48FC-BEF7-83AEE26C63F7}"
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "pipelines", "pipelines", "{68558245-F605-413F-A1D9-A4F60D489D68}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{4F549FEF-C57B-4A34-A2C7-8A632762DF85}"
 	ProjectSection(SolutionItems) = preProject
-		.azure\pipelines\azure-pipelines.yml = .azure\pipelines\azure-pipelines.yml
-	EndProjectSection
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{5EE4E8BE-6B15-49DB-A4A8-D2CD63D5E90C}"
-	ProjectSection(SolutionItems) = preProject
-		.editorconfig = .editorconfig
+		.github\workflows\build.yml = .github\workflows\build.yml
 	EndProjectSection
 EndProject
 Global
@@ -59,8 +55,8 @@ Global
 		{D037F8D0-E606-4C5A-8669-DB6AAE7B056B} = {3EC10767-1816-46B2-A78E-9856071CCFDB}
 		{5E023B6A-0B47-4EC2-90B9-2DF998E58ADB} = {E4089551-AF4E-41B3-A6F8-2501A3BE0E0C}
 		{8AA1E576-4016-4623-96C8-90330F05F9A8} = {64C3D7D1-67B8-4070-AE67-C71B761535CC}
-		{073FEA06-67CF-47F8-8CE4-2B153A7D8443} = {3A8D800E-77BD-44EF-82DB-C672281ECAAA}
-		{68558245-F605-413F-A1D9-A4F60D489D68} = {073FEA06-67CF-47F8-8CE4-2B153A7D8443}
+		{EEF46CDC-C438-48FC-BEF7-83AEE26C63F7} = {3A8D800E-77BD-44EF-82DB-C672281ECAAA}
+		{4F549FEF-C57B-4A34-A2C7-8A632762DF85} = {EEF46CDC-C438-48FC-BEF7-83AEE26C63F7}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {4997BAE9-29BF-4D79-AE5E-5605E7A0F049}

EntityFrameworkCore.DataEncryption.sln

@@ -3,6 +3,7 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFrameworks>net5.0;net6.0</TargetFrameworks>
+	  <LangVersion>10</LangVersion>
   </PropertyGroup>
 
 	<ItemGroup Condition="('$(TargetFramework)' == 'net5.0')">

samples/AesSample/AesSample.csproj

@@ -1,25 +1,24 @@
 using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.DataEncryption;
 
-namespace AesSample
+namespace AesSample;
+
+public class DatabaseContext : DbContext
 {
-    public class DatabaseContext : DbContext
-    {
-        private readonly IEncryptionProvider _encryptionProvider;
+    private readonly IEncryptionProvider _encryptionProvider;
 
-        public DbSet<UserEntity> Users { get; set; }
+    public DbSet<UserEntity> Users { get; set; }
 
-        public DatabaseContext(DbContextOptions<DatabaseContext> options, IEncryptionProvider encryptionProvider)
-            : base(options)
-        {
-            _encryptionProvider = encryptionProvider;
-        }
+    public DatabaseContext(DbContextOptions<DatabaseContext> options, IEncryptionProvider encryptionProvider)
+        : base(options)
+    {
+        _encryptionProvider = encryptionProvider;
+    }
 
-        protected override void OnModelCreating(ModelBuilder modelBuilder)
-        {
-            modelBuilder.UseEncryption(_encryptionProvider);
+    protected override void OnModelCreating(ModelBuilder modelBuilder)
+    {
+        modelBuilder.UseEncryption(_encryptionProvider);
 
-            base.OnModelCreating(modelBuilder);
-        }
+        base.OnModelCreating(modelBuilder);
     }
 }

samples/AesSample/DatabaseContext.cs

@@ -4,53 +4,54 @@
 using System.Linq;
 using System.Security;
 
-namespace AesSample
+namespace AesSample;
+
+static class Program
 {
-    static class Program
+    static void Main()
     {
-        static void Main()
-        {
-            var options = new DbContextOptionsBuilder<DatabaseContext>()
-                .UseInMemoryDatabase(databaseName: "MyInMemoryDatabase")
-                .Options;
+        var options = new DbContextOptionsBuilder<DatabaseContext>()
+            .UseInMemoryDatabase(databaseName: "MyInMemoryDatabase")
+            .Options;
 
-            // AES key randomly generated at each run.
-            byte[] encryptionKey = AesProvider.GenerateKey(AesKeySize.AES256Bits).Key;
-            var encryptionProvider = new AesProvider(encryptionKey);
+        // AES key randomly generated at each run.
+        AesKeyInfo keyInfo = AesProvider.GenerateKey(AesKeySize.AES256Bits);
+        byte[] encryptionKey = keyInfo.Key;
+        byte[] encryptionIV = keyInfo.IV;
+        var encryptionProvider = new AesProvider(encryptionKey, encryptionIV);
 
-            using var context = new DatabaseContext(options, encryptionProvider);
+        using var context = new DatabaseContext(options, encryptionProvider);
 
-            var user = new UserEntity
-            {
-                FirstName = "John",
-                LastName = "Doe",
-                Email = "[email protected]",
-                Password = BuildPassword(),
-            };
+        var user = new UserEntity
+        {
+            FirstName = "John",
+            LastName = "Doe",
+            Email = "[email protected]",
+            //Password = BuildPassword(),
+        };
 
-            context.Users.Add(user);
-            context.SaveChanges();
+        context.Users.Add(user);
+        context.SaveChanges();
 
-            Console.WriteLine($"Users count: {context.Users.Count()}");
+        Console.WriteLine($"Users count: {context.Users.Count()}");
 
-            user = context.Users.First();
+        user = context.Users.First();
 
-            Console.WriteLine($"User: {user.FirstName} {user.LastName} - {user.Email} ({user.Password.Length})");
-        }
+        Console.WriteLine($"User: {user.FirstName} {user.LastName} - {user.Email}");
+    }
 
-        static SecureString BuildPassword()
-        {
-            SecureString result = new();
-            result.AppendChar('L');
-            result.AppendChar('e');
-            result.AppendChar('t');
-            result.AppendChar('M');
-            result.AppendChar('e');
-            result.AppendChar('I');
-            result.AppendChar('n');
-            result.AppendChar('!');
-            result.MakeReadOnly();
-            return result;
-        }
+    static SecureString BuildPassword()
+    {
+        SecureString result = new();
+        result.AppendChar('L');
+        result.AppendChar('e');
+        result.AppendChar('t');
+        result.AppendChar('M');
+        result.AppendChar('e');
+        result.AppendChar('I');
+        result.AppendChar('n');
+        result.AppendChar('!');
+        result.MakeReadOnly();
+        return result;
     }
 }

samples/AesSample/Program.cs

@@ -3,24 +3,23 @@
 using System.ComponentModel.DataAnnotations.Schema;
 using System.Security;
 
-namespace AesSample
+namespace AesSample;
+
+public class UserEntity
 {
-    public class UserEntity
-    {
-        [Key]
-        [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
-        public Guid Id { get; set; }
+    [Key]
+    [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
+    public Guid Id { get; set; }
 
-        [Required]
-        public string FirstName { get; set; }
+    [Required]
+    public string FirstName { get; set; }
 
-        [Required]
-        public string LastName { get; set; }
+    [Required]
+    public string LastName { get; set; }
 
-        [Required]
-        [Encrypted]
-        public string Email { get; set; }
+    [Required]
+    [Encrypted]
+    public string Email { get; set; }
 
-        public SecureString Password { get; set; }
-    }
+    //public SecureString Password { get; set; }
 }

samples/AesSample/UserEntity.cs

@@ -1,32 +1,32 @@
-namespace System.ComponentModel.DataAnnotations
+namespace System.ComponentModel.DataAnnotations;
+
+/// <summary>
+/// Specifies that the data field value should be encrypted.
+/// </summary>
+[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
+public sealed class EncryptedAttribute : Attribute
 {
     /// <summary>
-    /// Specifies that the data field value should be encrypted.
+    /// Returns the storage format for the database value.
     /// </summary>
-    [AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
-    public sealed class EncryptedAttribute : Attribute
-    {
-        /// <summary>
-        /// Initializes a new instance of the <see cref="EncryptedAttribute"/> class.
-        /// </summary>
-        /// <param name="format">
-        /// The storage format.
-        /// </param>
-        public EncryptedAttribute(StorageFormat format)
-        {
-            Format = format;
-        }
+    public StorageFormat Format { get; }
 
-        /// <summary>
-        /// Initializes a new instance of the <see cref="EncryptedAttribute"/> class.
-        /// </summary>
-        public EncryptedAttribute() : this(StorageFormat.Default)
-        {
-        }
+    /// <summary>
+    /// Initializes a new instance of the <see cref="EncryptedAttribute"/> class.
+    /// </summary>
+    /// <param name="format">
+    /// The storage format.
+    /// </param>
+    public EncryptedAttribute(StorageFormat format)
+    {
+        Format = format;
+    }
 
-        /// <summary>
-        /// Returns the storage format for the database value.
-        /// </summary>
-        public StorageFormat Format { get; }
+    /// <summary>
+    /// Initializes a new instance of the <see cref="EncryptedAttribute"/> class.
+    /// </summary>
+    public EncryptedAttribute() 
+        : this(StorageFormat.Default)
+    {
     }
 }

src/EntityFrameworkCore.DataEncryption/Attributes/EncryptedAttribute.cs

@@ -1,26 +1,27 @@
-namespace System.ComponentModel.DataAnnotations
+namespace System.ComponentModel.DataAnnotations;
+
+/// <summary>
+/// Represents the storage format for an encrypted value.
+/// </summary>
+public enum StorageFormat
 {
     /// <summary>
-    /// Represents the storage format for an encrypted value.
+    /// The format is determined by the model data type.
     /// </summary>
-    public enum StorageFormat
-    {
-        /// <summary>
-        /// The format is determined by the model data type.
-        /// </summary>
-        Default,
-        /// <summary>
-        /// The value is stored in binary.
-        /// </summary>
-        Binary,
-        /// <summary>
-        /// The value is stored in a Base64-encoded string.
-        /// </summary>
-        /// <remarks>
-        /// <b>NB:</b> If the source property is a <see cref="string"/>,
-        /// and no encryption provider is configured,
-        /// the string will not be modified.
-        /// </remarks>
-        Base64,
-    }
+    Default,
+
+    /// <summary>
+    /// The value is stored in binary.
+    /// </summary>
+    Binary,
+
+    /// <summary>
+    /// The value is stored in a Base64-encoded string.
+    /// </summary>
+    /// <remarks>
+    /// <b>NB:</b> If the source property is a <see cref="string"/>,
+    /// and no encryption provider is configured,
+    /// the string will not be modified.
+    /// </remarks>
+    Base64,
 }