Merge pull request #15 from shugaoye/master

passxyz · web-flow · commit aa75776d6272 · 2021-10-04T10:22:30.000+08:00
Release 1.3.6
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 ## Change log
 
+### Release 1.3.6
+**PassXYZLib**
+ - Added LogFilePath
+ - Added `ChangeMasterPassword()`
+ - Improved `SearchEntries()`
+
 ### Release 1.3.5
 **KPCLib**
  - Added `Exists()` in `ProtectedBinaryDictionary`
diff --git a/KPCLib.nuspec b/KPCLib.nuspec
@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
     <metadata>
         <id>KPCLib</id>
-        <version>1.3.5.0</version>
+        <version>1.3.6.0</version>
         <authors>Roger Ye</authors>
 		<owners>Roger Ye</owners>
 		<requireLicenseAcceptance>false</requireLicenseAcceptance>
diff --git a/KPCLib.xunit/PxDatabaseTests.cs b/KPCLib.xunit/PxDatabaseTests.cs
@@ -68,7 +68,6 @@ public void ListGroupsTests()
             }
         }
 
-
         [Fact]
         public void ListEntriesTests()
         {
@@ -381,7 +380,24 @@ public void EntrySearchTests(string keyword)
             var entries = passxyz.PxDb.SearchEntries(keyword);
             Assert.True(entries.Any());
         }
-
+        
+        [Fact]
+        public void GetAllEntriesByLastModificationTimeTest() 
+        {
+            var entries = passxyz.PxDb.GetAllEntries();
+            // descending or ascending
+            IEnumerable<PwEntry> entriesByDate =
+                from e in entries
+                orderby e.LastModificationTime descending
+                select e;
+
+            Debug.WriteLine($"Found {entriesByDate.Count()} entries.");
+            foreach (var entry in entriesByDate) 
+            {
+                Debug.WriteLine($"{entry.Name} {entry.LastModificationTime}");
+            }
+        }
+        // Add new test cases here
     }
 
 
@@ -391,7 +407,7 @@ public class PxLibInfoTests
         public void PxLibVersion() 
         {
             Debug.WriteLine($"{PxLibInfo.Version}");
-            Assert.Equal(PxLibInfo.Version, new System.Version("1.3.5.0"));
+            Assert.Equal(PxLibInfo.Version, new System.Version("1.3.6.0"));
         }
 
         [Fact]
diff --git a/KPCLib/KPCLib.csproj b/KPCLib/KPCLib.csproj
@@ -6,7 +6,7 @@
     <OutputType>Library</OutputType>
     <StartupObject />
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <Version>1.3.5</Version>
+    <Version>1.3.6</Version>
     <PackageProjectUrl>https://github.com/passxyz/KPCLib</PackageProjectUrl>
     <RepositoryUrl>https://github.com/passxyz/KPCLib</RepositoryUrl>
     <Description>This is the build of KeePassLib in Xamarin Portable Class Library. Three platforms, UWP, Android and iOS, are supported and tested.</Description>
@@ -15,8 +15,8 @@
     <Company>PassXYZ Inc.</Company>
     <PackageReleaseNotes></PackageReleaseNotes>
     <NeutralLanguage>en-US</NeutralLanguage>
-    <AssemblyVersion>1.3.5.0</AssemblyVersion>
-    <FileVersion>1.3.5.0</FileVersion>
+    <AssemblyVersion>1.3.6.0</AssemblyVersion>
+    <FileVersion>1.3.6.0</FileVersion>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
diff --git a/KPCLib/Native/NativeMethods.cs b/KPCLib/Native/NativeMethods.cs
@@ -164,7 +164,7 @@ internal static extern bool GetVolumeInformation(string lpRootPathName,
 		[return: MarshalAs(UnmanagedType.Bool)]
 		internal static extern bool MoveFileEx(string lpExistingFileName,
 			string lpNewFileName, UInt32 dwFlags);
-
+#if !KPCLib
 		[DllImport("KtmW32.dll", CharSet = CharSet.Unicode, ExactSpelling = true,
 			SetLastError = true)]
 		internal static extern IntPtr CreateTransaction(IntPtr lpTransactionAttributes,
@@ -174,7 +174,7 @@ internal static extern IntPtr CreateTransaction(IntPtr lpTransactionAttributes,
 		[DllImport("KtmW32.dll", SetLastError = true)]
 		[return: MarshalAs(UnmanagedType.Bool)]
 		internal static extern bool CommitTransaction(IntPtr hTransaction);
-
+#endif // KPCLib
 		[DllImport("Kernel32.dll", CharSet = CharSet.Auto, ExactSpelling = false,
 			SetLastError = true)]
 		[return: MarshalAs(UnmanagedType.Bool)]
@@ -186,7 +186,7 @@ internal static extern bool MoveFileTransacted(string lpExistingFileName,
 		private static extern int SHGetKnownFolderPath(ref Guid rfid, uint dwFlags,
 			IntPtr hToken, out IntPtr ppszPath);
 
-#if (!KeePassLibSD && !KeePassUAP)
+#if (!KeePassLibSD && !KeePassUAP && !KPCLib)
 		[DllImport("ShlWApi.dll", CharSet = CharSet.Auto)]
 		[return: MarshalAs(UnmanagedType.Bool)]
 		internal static extern bool PathRelativePathTo([Out] StringBuilder pszPath,
diff --git a/KPCLib/PassXYZLib/Item.cs b/KPCLib/PassXYZLib/Item.cs
@@ -15,6 +15,8 @@ public abstract class Item : INotifyPropertyChanged
     {
         private PwUuid m_uuid = PwUuid.Zero;
 
+        public abstract DateTime LastModificationTime { get; set; }
+
         public abstract string Name { get; set; }
 
         public abstract string Description { get;}
diff --git a/KPCLib/PwEntry.cs b/KPCLib/PwEntry.cs
@@ -206,7 +206,7 @@ public DateTime CreationTime
 		/// <summary>
 		/// The date/time when this entry was last modified.
 		/// </summary>
-		public DateTime LastModificationTime
+		public override DateTime LastModificationTime
 		{
 			get { return m_tLastMod; }
 			set { m_tLastMod = value; }
diff --git a/KPCLib/PwGroup.cs b/KPCLib/PwGroup.cs
@@ -207,7 +207,7 @@ public DateTime CreationTime
 		/// <summary>
 		/// The date/time when this group was last modified.
 		/// </summary>
-		public DateTime LastModificationTime
+		public override DateTime LastModificationTime
 		{
 			get { return m_tLastMod; }
 			set { m_tLastMod = value; }
diff --git a/PassXYZLib.nuspec b/PassXYZLib.nuspec
@@ -2,15 +2,16 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
     <metadata>
         <id>PassXYZLib</id>
-        <version>1.3.5.0</version>
+        <version>1.3.6.0</version>
         <authors>Roger Ye</authors>
 		<owners>Roger Ye</owners>
 		<requireLicenseAcceptance>false</requireLicenseAcceptance>
 		<license type="expression">LGPL-3.0-or-later</license>
 		<projectUrl>https://github.com/passxyz/KPCLib</projectUrl>
 		<description>This is an extension of KPCLib.</description>
 		<releaseNotes>
-      Added SearchEntries()
+      - Improved SearchEntries()
+      - Added ChangeMasterPassword()
     </releaseNotes>
 		<copyright>Roger Ye</copyright>
 		<repository url="https://github.com/passxyz/KPCLib" />
diff --git a/PassXYZLib/PassXYZLib.csproj b/PassXYZLib/PassXYZLib.csproj
@@ -2,9 +2,9 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <Version>1.3.5</Version>
-    <AssemblyVersion>1.3.5.0</AssemblyVersion>
-    <FileVersion>1.3.5.0</FileVersion>
+    <Version>1.3.6</Version>
+    <AssemblyVersion>1.3.6.0</AssemblyVersion>
+    <FileVersion>1.3.6.0</FileVersion>
     <Company>PassXYZ Inc.</Company>
     <Authors>Roger Ye</Authors>
     <Copyright>Roger Ye</Copyright>
diff --git a/PassXYZLib/PxDatabase.cs b/PassXYZLib/PxDatabase.cs
@@ -3,6 +3,7 @@
 using System.IO;
 using System.Diagnostics;
 using System.Drawing;
+using System.Linq;
 using System.Text.RegularExpressions;
 
 using SkiaSharp;
@@ -338,6 +339,73 @@ public void Open(PassXYZLib.User user)
 			Open(ioc, cmpKey, logger);
 		}
 
+		public string GetDeviceLockData(PassXYZLib.User user)
+        {
+			if (user.IsDeviceLockEnabled)
+			{
+				try
+				{
+					PassXYZ.Utils.Settings.DefaultFolder = PxDataFile.KeyFilePath;
+					var pxKeyProvider = new PassXYZ.Services.PxKeyProvider(user.Username, false);
+					if (pxKeyProvider.IsInitialized)
+					{
+						return PassXYZ.Services.PxKeyData.ToBase64String(pxKeyProvider.KeyData);
+					}
+				}
+				catch (PassXYZ.Services.InvalidDeviceLockException ex)
+				{
+					Debug.WriteLine($"{ex}");
+					return string.Empty;
+				}
+			}
+			return string.Empty;
+		}
+
+		/// <summary>
+		/// Change master password
+		/// </summary>
+		/// <param name="newPassword">new master password</param>
+		/// <param name="user">the current user</param>
+		/// <returns>true - changed successfully, false - failed to change</returns>
+		public bool ChangeMasterPassword(string newPassword, PassXYZLib.User user)
+		{
+			CompositeKey cmpKey = new CompositeKey();
+
+			cmpKey.AddUserKey(new KcpPassword(newPassword));
+
+			if (user.IsDeviceLockEnabled)
+			{
+				try
+				{
+					PassXYZ.Utils.Settings.DefaultFolder = PxDataFile.KeyFilePath;
+					var pxKeyProvider = new PassXYZ.Services.PxKeyProvider(user.Username, false);
+					if (pxKeyProvider.IsInitialized)
+					{
+						KeyProviderQueryContext ctxKP = new KeyProviderQueryContext(new IOConnectionInfo(), false, false);
+						byte[] pbProvKey = pxKeyProvider.GetKey(ctxKP);
+						cmpKey.AddUserKey(new KcpCustomKey(pxKeyProvider.Name, pbProvKey, true));
+					}
+					else
+					{
+						throw new KeePassLib.Keys.InvalidCompositeKeyException();
+					}
+				}
+				catch (PassXYZ.Services.InvalidDeviceLockException ex)
+				{
+					try { cmpKey.AddUserKey(new KcpKeyFile(user.KeFilePath)); }
+					catch (Exception exFile)
+					{
+						Debug.Write($"{exFile} in {ex}");
+						return false;
+					}
+				}
+			}
+			MasterKey = cmpKey;
+			MasterKeyChanged = DateTime.UtcNow;
+
+			return true;
+		}
+
 		/// <summary>
 		/// Create a database with user information.
 		/// If the device lock is enabled, we need to set DefaultFolder first.
@@ -406,6 +474,37 @@ private bool CreateKeyFile(PassXYZLib.User user, PassXYZ.Services.PxKeyProvider
 			}
 		}
 
+		/// <summary>
+		/// Recreate a key file from a PxKeyData
+		/// </summary>
+		/// <param name="data">PxKeyData source</param>
+		/// <param name="username">username inside PxKeyData source</param>
+		/// <returns>true - created key file, false - failed to create key file.</returns>
+		public bool CreateKeyFile(string data, string username)
+		{
+			if (data.StartsWith(PxDefs.PxKeyFile))
+			{
+				PassXYZ.Utils.Settings.DefaultFolder = PxDataFile.KeyFilePath;
+				PassXYZ.Utils.Settings.User.Username = username;
+
+				var msg = data.Substring(PxDefs.PxKeyFile.Length);
+				PassXYZ.Services.PxKeyData keyData = PassXYZ.Services.PxKeyData.FromBase64String(msg);
+				if (keyData != null)
+				{
+					PassXYZ.Services.PxKeyProvider pxKeyProvider = new PassXYZ.Services.PxKeyProvider(keyData);
+					if (pxKeyProvider.KeyData.Username == username)
+					{
+						if (pxKeyProvider.CreateKeyFile(false))
+						{
+							return true;
+						}
+					}
+				}
+			}
+
+			return false;
+		}
+
 		private void EnsureRecycleBin(ref PwGroup pgRecycleBin)
 		{
 			if (pgRecycleBin == this.RootGroup)
@@ -790,13 +889,25 @@ public IEnumerable<PwEntry> GetAllEntries()
 		}
 
 		/// <summary>
-		/// Search entries using a keyword
+		/// Search entries using a keyword. If the keyword is null or empty, 
+		/// a list of entries by LastModificationTime will be returned.
 		/// </summary>
 		/// <param name="strSearch">string to be searched</param>
 		/// <param name="itemGroup">within this group to be searched</param>
 		/// <returns>list of result</returns>
 		public IEnumerable<Item> SearchEntries(string strSearch, Item itemGroup = null)
 		{
+			if (string.IsNullOrEmpty(strSearch)) 
+			{
+				var entries = GetAllEntries();
+				// descending or ascending
+				IEnumerable<PwEntry> entriesByLastModificationTime =
+					from e in entries
+					orderby e.LastModificationTime descending
+					select e;
+				return entriesByLastModificationTime;
+			}
+
 			List<Item> resultsList = new List<Item>();
 			string strGroupName = " (\"" + strSearch + "\") ";
             PwGroup pg = new PwGroup(true, true, strGroupName, PwIcon.EMailSearch)
@@ -889,6 +1000,7 @@ public PwCustomIcon GetPwCustomIcon(PwUuid pwIconId)
 
 		public enum PxCustomIconSize
 		{
+			Size = 32,
 			Min = 96,
 			Max = 216
 		}
@@ -925,20 +1037,20 @@ public PwUuid SaveCustomIcon(SKBitmap img, string name = "")
 
 			if (img == null) { return PwUuid.Zero; }
 
-			if ((img.Width != img.Height) || (img.Width < (int)PxCustomIconSize.Min))
+			if ((img.Width != img.Height) || (img.Width < (int)PxCustomIconSize.Size))
 			{
 				return PwUuid.Zero;
 			}
 
 			// If the image is not at PxCustomIconSize.Min, we need to resize it.
-			if (img.Width != (int)PxCustomIconSize.Min)
-			{
-				SKImageInfo resizeInfo = new SKImageInfo((int)PxCustomIconSize.Min, (int)PxCustomIconSize.Min);
-				using (SKBitmap resizedSKBitmap = img.Resize(resizeInfo, SKFilterQuality.High))
-				{
-					img = resizedSKBitmap;
-				}
-			}
+			//if (img.Width != (int)PxCustomIconSize.Min)
+			//{
+			//	SKImageInfo resizeInfo = new SKImageInfo((int)PxCustomIconSize.Min, (int)PxCustomIconSize.Min);
+			//	using (SKBitmap resizedSKBitmap = img.Resize(resizeInfo, SKFilterQuality.Medium))
+			//	{
+			//		img = resizedSKBitmap;
+			//	}
+			//}
 
 			using (var image = SKImage.FromBitmap(img))
 			{
diff --git a/PassXYZLib/User.cs b/PassXYZLib/User.cs
@@ -7,6 +7,25 @@ namespace PassXYZLib
 {
     public static class PxDataFile
     {
+        private static string _logFilePath = string.Empty;
+        /// <summary>
+        /// The default log file path uses the stardard .NET setting. The default log file path is a readonly item.
+        /// </summary>
+        public static string LogFilePath
+        {
+            get
+            {
+                if (!string.IsNullOrEmpty(_logFilePath))
+                {
+                    return _logFilePath;
+                }
+                else
+                {
+                    return Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "passxyz_log.txt");
+                }
+            }
+        }
+
         private static string _dataFilePath = string.Empty;
         /// <summary>
         /// The default data file path uses the stardard .NET setting. The default data file path doesn't need to be set.

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,6 @@ public void ListGroupsTests()`
`68`	`68`	`}`
`69`	`69`	`}`
`70`	`70`
`71`		`-`
`72`	`71`	`[Fact]`
`73`	`72`	`public void ListEntriesTests()`
`74`	`73`	`{`
`@@ -381,7 +380,24 @@ public void EntrySearchTests(string keyword)`
`381`	`380`	`var entries = passxyz.PxDb.SearchEntries(keyword);`
`382`	`381`	`Assert.True(entries.Any());`
`383`	`382`	`}`
`384`		`-`
	`383`	`+`
	`384`	`+ [Fact]`
	`385`	`+ public void GetAllEntriesByLastModificationTimeTest()`
	`386`	`+ {`
	`387`	`+ var entries = passxyz.PxDb.GetAllEntries();`
	`388`	`+ // descending or ascending`
	`389`	`+ IEnumerable<PwEntry> entriesByDate =`
	`390`	`+ from e in entries`
	`391`	`+ orderby e.LastModificationTime descending`
	`392`	`+ select e;`
	`393`	`+`
	`394`	`+ Debug.WriteLine($"Found {entriesByDate.Count()} entries.");`
	`395`	`+ foreach (var entry in entriesByDate)`
	`396`	`+ {`
	`397`	`+ Debug.WriteLine($"{entry.Name} {entry.LastModificationTime}");`
	`398`	`+ }`
	`399`	`+ }`
	`400`	`+ // Add new test cases here`
`385`	`401`	`}`
`386`	`402`
`387`	`403`
`@@ -391,7 +407,7 @@ public class PxLibInfoTests`
`391`	`407`	`public void PxLibVersion()`
`392`	`408`	`{`
`393`	`409`	`Debug.WriteLine($"{PxLibInfo.Version}");`
`394`		`- Assert.Equal(PxLibInfo.Version, new System.Version("1.3.5.0"));`
	`410`	`+ Assert.Equal(PxLibInfo.Version, new System.Version("1.3.6.0"));`
`395`	`411`	`}`
`396`	`412`
`397`	`413`	`[Fact]`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@ public abstract class Item : INotifyPropertyChanged`
`15`	`15`	`{`
`16`	`16`	`private PwUuid m_uuid = PwUuid.Zero;`
`17`	`17`
	`18`	`+ public abstract DateTime LastModificationTime { get; set; }`
	`19`	`+`
`18`	`20`	`public abstract string Name { get; set; }`
`19`	`21`
`20`	`22`	`public abstract string Description { get;}`
Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ public DateTime CreationTime`
`206`	`206`	`/// <summary>`
`207`	`207`	`/// The date/time when this entry was last modified.`
`208`	`208`	`/// </summary>`
`209`		`- public DateTime LastModificationTime`
	`209`	`+ public override DateTime LastModificationTime`
`210`	`210`	`{`
`211`	`211`	`get { return m_tLastMod; }`
`212`	`212`	`set { m_tLastMod = value; }`
Original file line number	Diff line number	Diff line change
`@@ -207,7 +207,7 @@ public DateTime CreationTime`
`207`	`207`	`/// <summary>`
`208`	`208`	`/// The date/time when this group was last modified.`
`209`	`209`	`/// </summary>`
`210`		`- public DateTime LastModificationTime`
	`210`	`+ public override DateTime LastModificationTime`
`211`	`211`	`{`
`212`	`212`	`get { return m_tLastMod; }`
`213`	`213`	`set { m_tLastMod = value; }`