Fix issue with encrypted db and Clone()

softlion · softlion · commit f579e11e4801 · 2022-04-26T19:42:17.000+02:00
diff --git a/README.md b/README.md
@@ -171,8 +171,19 @@ The T in `db.Query<T>` specifies the object to create for each row. It can be a
 
 ## Using an encrypted database file
 
-Add the nuget [SQLitePCLRaw.bundle_e_sqlcipher](https://www.nuget.org/packages/SQLitePCLRaw.bundle_e_sqlcipher) to your common project.  
-Then add this code right after opening or creating the db, and before any other db call:
+Add the nuget [SQLitePCLRaw.bundle_e_sqlcipher](https://www.nuget.org/packages/SQLitePCLRaw.bundle_e_sqlcipher) to your common project.
+
+### Option 1 (preferred)
+
+Use the `encryptionKey` parameter in the constructor of `SQLiteConnection`.
+
+Then use the db as usual.
+
+With this option, the encryption key is kept in memory. That should not be an issue.
+
+
+### Option 2 (roots)
+Add this code right after opening or creating the db, and before any other db call:
 
 ```c#
 string key = "yourCryptingKey";
@@ -182,8 +193,12 @@ if(ok != "ok")
    throw new Exception("Bad key");
 ```
 
+If you will use `InsertAll(), InsertOrUpdateAll(), ReplaceAll()` you must create a new class deriving from `SQLiteConnection` and override `Clone()` so it sets the encryption key after cloning.
+
 Then use the db as usual.
 
+### Final Thoughts
+
 You can read the version of the cypher lib using the code. Check the [Zenetik](//https://www.zetetic.net/sqlcipher/sqlcipher-api/#cipher_version) website for more information.
 
 ```c#
diff --git a/SQLite.Net.Tests/BlobSerializationTest.cs b/SQLite.Net.Tests/BlobSerializationTest.cs
@@ -16,7 +16,7 @@ public abstract class BlobSerializationTest : BaseTest
         public class BlobDatabase : SQLiteConnection
         {
             public BlobDatabase(IBlobSerializer serializer) :
-                base(TestPath.CreateTemporaryDatabase(), false, serializer)
+                base(TestPath.CreateTemporaryDatabase(), storeDateTimeAsTicks: false,  serializer: serializer)
             {
                 DropTable<ComplexOrder>();
             }
diff --git a/SQLite.Net.Tests/TestDb.cs b/SQLite.Net.Tests/TestDb.cs
@@ -106,13 +106,10 @@ public enum OrderLineStatus
     public class TestDb : SQLiteConnection
     {
         public TestDb(bool storeDateTimeAsTicks = true, IContractResolver resolver = null)
-            : base(
-                TestPath.CreateTemporaryDatabase(), storeDateTimeAsTicks, null,
-                extraTypeMappings: null,
-                resolver: resolver)
-		{
+            : base(TestPath.CreateTemporaryDatabase(), storeDateTimeAsTicks: storeDateTimeAsTicks, resolver: resolver)
+        {
             TraceListener = DebugTraceListener.Instance;
-		}
+        }
     }
 
     public class TestPath
diff --git a/nuget/pack.ps1 b/nuget/pack.ps1
@@ -7,7 +7,7 @@ if ($IsMacOS) {
     $msbuild = join-path $msbuild 'MSBuild\Current\Bin\MSBuild.exe'
 }
 $version="2.1.0"
-$versionSuffix="-pre2"
+$versionSuffix="-pre3"
 
 #####################
 #Build release config
diff --git a/src/SQLite.Net/SQLiteConnection.cs b/src/SQLite.Net/SQLiteConnection.cs
@@ -1,29 +1,22 @@
 //
-// Copyright (c) 2012 Krueger Systems, Inc.
-// Copyright (c) 2013 Øystein Krog (oystein.krog@gmail.com)
-// Copyright (c) 2014 Benjamin Mayrargue (softlion@softlion.com)
+// Copyright (c) 2014-2022 Benjamin Mayrargue (benjamin@vapolia.fr)
 //   - Support for multi-columns primary keys (create table / get / find / delete)
 //   - ExecuteSimpleQuery
-//   - Fix disposing bug
+//   - Fix disposing issues
+//   - Remove locks
+//   - Fix transaction issues
+// Copyright (c) 2013 Øystein Krog (oystein.krog@gmail.com)
+// Copyright (c) 2012 Krueger Systems, Inc.
 //
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 // 
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 // 
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
-//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 using System;
 using System.Collections;
@@ -40,7 +33,7 @@
 namespace SQLite.Net2
 {
     /// <summary>
-    ///     Represents an open connection to a SQLite database.
+    /// Represents an open connection to a SQLite database.
     /// </summary>
     public class SQLiteConnection : IDisposable
     {
@@ -64,6 +57,7 @@ public class SQLiteConnection : IDisposable
         private bool _open;
         private Stopwatch? _sw;
         private readonly SQLiteOpenFlags databaseOpenFlags;
+        private readonly string encryptionKey;
 
         public IBlobSerializer? Serializer { get; }
         public string DatabasePath { get;}
@@ -84,82 +78,40 @@ static SQLiteConnection()
             }
         }
 
-        /// <summary>
-        ///     Constructs a new SQLiteConnection and opens a SQLite database specified by databasePath.
-        /// </summary>
-        /// <param name="sqlitePlatform"></param>
-        /// <param name="databasePath">
-        ///     Specifies the path to the database file.
-        /// </param>
-        /// <param name="storeDateTimeAsTicks">
-        ///     Specifies whether to store DateTime properties as ticks (true) or strings (false). You
-        ///     absolutely do want to store them as Ticks in all new projects. The option to set false is
-        ///     only here for backwards compatibility. There is a *significant* speed advantage, with no
-        ///     down sides, when setting storeDateTimeAsTicks = true.
-        /// </param>
-        /// <param name="serializer">
-        ///     Blob serializer to use for storing undefined and complex data structures. If left null
-        ///     these types will thrown an exception as usual.
-        /// </param>
-        /// <param name="tableMappings">
-        ///     Exisiting table mapping that the connection can use. If its null, it creates the mappings,
-        ///     if and when required. The mappings are also created when an unknown type is used for the first
-        ///     time.
-        /// </param>
-        /// <param name="extraTypeMappings">
-        ///     Any extra type mappings that you wish to use for overriding the default for creating
-        ///     column definitions for SQLite DDL in the class Orm (snake in Swedish).
-        /// </param>
-        /// <param name="resolver">
-        ///     A contract resovler for resolving interfaces to concreate types during object creation
-        /// </param>
-
-        public SQLiteConnection(string databasePath, bool storeDateTimeAsTicks = true,  IBlobSerializer? serializer = null,  IDictionary<string, TableMapping>? tableMappings = null, IDictionary<Type, string>? extraTypeMappings = null,  IContractResolver? resolver = null)
-            : this(databasePath, SQLiteOpenFlags.ReadWrite | SQLiteOpenFlags.Create, storeDateTimeAsTicks, serializer, tableMappings, extraTypeMappings, resolver)
-        {
-        }
-
         /// <summary>
         /// Create a new connection to the same database.
         /// </summary>
         /// <remarks>
         /// This support scenarios where a code needs to create a transaction, while leaving the current connection transactionless (ie: sharable with other codes), as a transaction creates a state in this object.
+        ///
+        /// This is used by *All() methods.
+        ///
+        /// Override it if you have not called the constructor with an encryption key and you database is encrypted.
         /// </remarks>
-        public SQLiteConnection Clone() 
-            => new (DatabasePath, databaseOpenFlags, StoreDateTimeAsTicks, Serializer, _tableMappings, ExtraTypeMappings, Resolver);
+        public virtual SQLiteConnection Clone() 
+            => new (DatabasePath, databaseOpenFlags, StoreDateTimeAsTicks, Serializer, _tableMappings, ExtraTypeMappings, Resolver, encryptionKey);
 
         /// <summary>
-        ///     Constructs a new SQLiteConnection and opens a SQLite database specified by databasePath.
+        /// Constructs a new SQLiteConnection and opens a SQLite database specified by databasePath.
         /// </summary>
-        /// <param name="sqlitePlatform"></param>
-        /// <param name="databasePath">
-        ///     Specifies the path to the database file.
-        /// </param>
+        /// <param name="databasePath">Specifies the path to the database file. </param>
         /// <param name="openFlags"></param>
         /// <param name="storeDateTimeAsTicks">
-        ///     Specifies whether to store DateTime properties as ticks (true) or strings (false). You
-        ///     absolutely do want to store them as Ticks in all new projects. The option to set false is
-        ///     only here for backwards compatibility. There is a *significant* speed advantage, with no
-        ///     down sides, when setting storeDateTimeAsTicks = true.
-        /// </param>
-        /// <param name="serializer">
-        ///     Blob serializer to use for storing undefined and complex data structures. If left null
-        ///     these types will thrown an exception as usual.
+        /// Specifies whether to store DateTime properties as ticks (true) or strings (false). You
+        /// absolutely do want to store them as Ticks in all new projects. The option to set false is
+        /// only here for backwards compatibility. There is a *significant* speed advantage, with no
+        /// down sides, when setting storeDateTimeAsTicks = true.
         /// </param>
+        /// <param name="serializer">Blob serializer to use for storing undefined and complex data structures. If left null these types will thrown an exception as usual.</param>
         /// <param name="tableMappings">
-        ///     Exisiting table mapping that the connection can use. If its null, it creates the mappings,
-        ///     if and when required. The mappings are also created when an unknown type is used for the first
-        ///     time.
-        /// </param>
-        /// <param name="extraTypeMappings">
-        ///     Any extra type mappings that you wish to use for overriding the default for creating
-        ///     column definitions for SQLite DDL in the class Orm (snake in Swedish).
-        /// </param>
-        /// <param name="resolver">
-        ///     A contract resovler for resolving interfaces to concreate types during object creation
-        /// </param>
-        public SQLiteConnection(string databasePath, SQLiteOpenFlags openFlags, bool storeDateTimeAsTicks = true,  IBlobSerializer? serializer = null,  IDictionary<string, TableMapping>? tableMappings = null,
-             IDictionary<Type, string>? extraTypeMappings = null, IContractResolver? resolver = null)
+        /// Existing table mapping that the connection can use. If its null, it creates the mappings,
+        /// if and when required. The mappings are also created when an unknown type is used for the first time.
+        /// </param>
+        /// <param name="extraTypeMappings">Any extra type mappings that you wish to use for overriding the default for creating column definitions for SQLite DDL in the class Orm (snake in Swedish).</param>
+        /// <param name="resolver">A contract resovler for resolving interfaces to concreate types during object creation</param>
+        /// <param name="encryptionKey">When using SQL CIPHER, automatically sets the key (you won't need to override Clone() in this case)</param>
+        public SQLiteConnection(string databasePath, SQLiteOpenFlags openFlags = SQLiteOpenFlags.ReadWrite | SQLiteOpenFlags.Create, bool storeDateTimeAsTicks = true,  IBlobSerializer? serializer = null,  IDictionary<string, TableMapping>? tableMappings = null,
+             IDictionary<Type, string>? extraTypeMappings = null, IContractResolver? resolver = null, string? encryptionKey = null)
         {
             if (string.IsNullOrEmpty(databasePath))
                 throw new ArgumentException("Must be specified", nameof(databasePath));
@@ -172,6 +124,18 @@ public SQLiteConnection(string databasePath, SQLiteOpenFlags openFlags, bool sto
             Handle = handle ?? throw new NullReferenceException("Database handle is null");
             _open = true;
             databaseOpenFlags = openFlags;
+            
+            if (!string.IsNullOrWhiteSpace(encryptionKey))
+            {
+                this.encryptionKey = encryptionKey!;
+                var cipherVer = ExecuteScalar<string>("PRAGMA cipher_version");
+                if (string.IsNullOrWhiteSpace(cipherVer))
+                    throw new Exception("This build is not using SQL CIPHER. See https://github.com/softlion/SQLite.Net-PCL2 for doc on how to setup SQL CIPHER.");
+
+                var o = ExecuteScalar<string>($"PRAGMA key = '{encryptionKey}';");
+                if(o != "ok")
+                    throw new Exception("Invalid cipher key");
+            }
 
             BusyTimeout = TimeSpan.FromSeconds(0.1);
             Serializer = serializer;

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public abstract class BlobSerializationTest : BaseTest`
`16`	`16`	`public class BlobDatabase : SQLiteConnection`
`17`	`17`	`{`
`18`	`18`	`public BlobDatabase(IBlobSerializer serializer) :`
`19`		`- base(TestPath.CreateTemporaryDatabase(), false, serializer)`
	`19`	`+ base(TestPath.CreateTemporaryDatabase(), storeDateTimeAsTicks: false, serializer: serializer)`
`20`	`20`	`{`
`21`	`21`	`DropTable<ComplexOrder>();`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ if ($IsMacOS) {`
`7`	`7`	`$msbuild = join-path $msbuild 'MSBuild\Current\Bin\MSBuild.exe'`
`8`	`8`	`}`
`9`	`9`	`$version="2.1.0"`
`10`		`-$versionSuffix="-pre2"`
	`10`	`+$versionSuffix="-pre3"`
`11`	`11`
`12`	`12`	`#####################`
`13`	`13`	`#Build release config`