Custom wordlist (#34)

Truly, @SecurityCze has gone above and beyond by implementing what has to be the most desired feature request!

This closes #1.

Author: SecurityCze

Diceware.cs

@@ -21,9 +21,7 @@ You should have received a copy of the GNU Affero General Public License
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
-using System.IO;
 using System.Linq;
-using System.Reflection;
 using System.Text;
 
 using KeePassLib.Cryptography;
@@ -33,9 +31,6 @@ namespace KeePassDiceware
 {
 	public class Diceware
 	{
-
-		private const string WordListFileExtension = ".txt";
-
 		private static readonly char[] LookalikeCharacters = "I|1lO0".ToCharArray();
 
 		// Copyright (C) 2014-2021 Mark McGuill. All rights reserved.
@@ -84,8 +79,6 @@ public class Diceware
 			{ 'Z', "2" },
 		};
 
-		private static readonly Dictionary<WordLists, string[]> LoadedLists = new();
-
 		public static string Generate(Options options, PwProfile profile, CryptoRandomStream random)
 		{
 			Debug.Assert(options != null);
@@ -355,58 +348,16 @@ select saltOptions.SelectRandom(random))
 			return result?.ToString() ?? string.Empty;
 		}
 
-		public static IEnumerable<string> GetWordList(WordLists lists)
-		{
-			var selectedWordlists = new List<string[]>();
-
-			foreach (WordLists list in lists.GetFlags())
-			{
-				// none isn't a real list.
-				if (list == WordLists.None)
-				{
-					continue;
-				}
-
-				if (LoadedLists.ContainsKey(list))
-				{
-					selectedWordlists.Add(LoadedLists[list]);
-				}
-				else
-				{
-					string[] loadedList = ReadEmbeddedResource($"{list}{WordListFileExtension}").ToArray();
-					LoadedLists.Add(list, loadedList);
-
-					// cache it for re-use.
-					selectedWordlists.Add(loadedList);
-				}
-			}
-
-			return selectedWordlists.SelectMany(s => s);
-		}
-
-		// via: https://stackoverflow.com/a/3314213/944605
-		public static IEnumerable<string> ReadEmbeddedResource(string resourceName, Encoding encoding = null)
+		public static IEnumerable<string> GetWordList(List<WordList> lists)
 		{
-			encoding ??= Encoding.UTF8;
-
-			var assembly = Assembly.GetAssembly(typeof(Diceware));
-			string resourcePath = resourceName;
+			HashSet<string> joinedWordList = new HashSet<string>();
 
-			// Format: "{Namespace}.{Folder}.{Filename}.{Extension}"
-			if (!resourceName.StartsWith(nameof(KeePassDiceware)))
+			foreach (WordList list in lists.Where(wl => wl.Enabled))
 			{
-				string[] manifestResourceNames = assembly.GetManifestResourceNames();
-				resourcePath = manifestResourceNames.Single(str => str.EndsWith(resourceName));
+				joinedWordList.UnionWith(list.Get());
 			}
 
-			using Stream stream = assembly.GetManifestResourceStream(resourcePath);
-			using var reader = new StreamReader(stream, encoding);
-			string line;
-
-			while ((line = reader.ReadLine()) != null)
-			{
-				yield return line;
-			}
+			return joinedWordList;
 		}
 	}
 }

DicewareOptionsForm.Designer.cs

@@ -22,6 +22,11 @@ public Options Options
 
 		private List<SaltSource> _saltSources = new();
 
+		private List<WordList> _wordLists = new();
+		private readonly ListViewGroup[] _wordListCategories = Enum.GetNames(typeof(WordList.CategoryEnum))
+			.Select(wl => new ListViewGroup(wl, wl)).ToArray();
+
+
 		public DicewareOptionsForm()
 		{
 			InitializeComponent();
@@ -49,24 +54,11 @@ private void InitializeEnumOptions()
 			saltComboBox.SelectedIndex = 0;
 
 			_saltSources.Clear();
-			activeSaltSourcesLabel.Text = string.Empty;
-
-			wordListsListView.Columns.Add("Word List");
-
-			ListViewGroup[] wordListCategories = EnumTools.GetCategories<WordLists>()
-				.Select(c => new ListViewGroup(c, c))
-				.ToArray();
+			activeSaltSourcesListView.Columns.Add("Salt sources");
 
-			wordListsListView.Groups.AddRange(wordListCategories);
-
-			ListViewItem[] wordLists = EnumTools.GetDisplays<WordLists>()
-				.Select(v =>
-					new ListViewItem($"{v}", wordListCategories.First(c => c.Name == v.Category)))
-				.ToArray();
-
-			wordListsListView.Items.AddRange(wordLists);
-
-			wordListsListView.Columns[0].AutoResize(ColumnHeaderAutoResizeStyle.ColumnContent);
+			_wordLists.Clear();
+			activeWordListsListView.Columns.Add("Word List");
+			activeWordListsListView.Groups.AddRange(_wordListCategories);
 		}
 
 		protected override void OnLoad(EventArgs e)
@@ -90,31 +82,40 @@ private void PopulateInterface()
 			l33tSpeakComboBox.SelectedIndex = l33tSpeakComboBox.FindStringExact(Options.L33tSpeak.GetDescription());
 			saltComboBox.SelectedIndex = saltComboBox.FindStringExact(Options.Salt.GetDescription());
 			_saltSources = new(Options.SaltSources);
-			UpdateSaltSourcesLabel();
-			UpdateListView(wordListsListView, Options.WordLists);
+			_wordLists = new(Options.WordLists);
+			UpdateSaltSourcesListView();
+			UpdateWordListsListView();
 		}
 
-		private void UpdateSaltSourcesLabel()
+		private void UpdateSaltSourcesListView()
 		{
-			IEnumerable<string> sources = _saltSources.Where(ss => ss.Enabled)
+			string[] sources = _saltSources.Where(ss => ss.Enabled)
 				.Select(ss => $"{ss.Name} "
 					+ (ss.MinimumAmount == ss.MaximumAmount
 						? $"({ss.MinimumAmount})"
 						: $"({ss.MinimumAmount}-{ss.MaximumAmount})")
-					);
+				).ToArray();
 
-			activeSaltSourcesLabel.Text = string.Join(", ", sources);
+			activeSaltSourcesListView.Items.Clear();
+			foreach (string rowString in sources)
+			{
+				ListViewItem rowItem = new ListViewItem(rowString);
+				activeSaltSourcesListView.Items.Add(rowItem);
+			}
+			activeSaltSourcesListView.AutoResizeColumns(ColumnHeaderAutoResizeStyle.ColumnContent);
 		}
 
-		private void UpdateListView<T>(ListView view, T flags) where T : Enum
+		private void UpdateWordListsListView()
 		{
-			foreach (ListViewItem i in view.Items)
-			{
-				T flag = EnumTools.FromDescription<T>(i.Text);
-				i.Checked = flags.HasFlag(flag);
-			}
+			ListViewItem[] lists = _wordLists.Where(wl => wl.Enabled)
+				.Select(wl => new ListViewItem(wl.Name,
+				_wordListCategories.First(g => g.Name == Enum.GetName(typeof(WordList.CategoryEnum), wl.Category))))
+				.ToArray();
+
+			activeWordListsListView.Items.Clear();
+			activeWordListsListView.Items.AddRange(lists);
 
-			view.Refresh();
+			activeWordListsListView.AutoResizeColumns(ColumnHeaderAutoResizeStyle.ColumnContent);
 		}
 
 		private Options GetOptions()
@@ -128,32 +129,15 @@ private Options GetOptions()
 				AdvancedStrategy = EnumTools.FromDescription<AdvancedStrategy>(advancedStrategyComboBox.SelectedItem.ToString()),
 				Salt = EnumTools.FromDescription<SaltType>(saltComboBox.SelectedItem.ToString()),
 				SaltSources = new(_saltSources),
-				WordLists = GetListViewFlags<WordLists>(wordListsListView)
+				WordLists = new(_wordLists)
 			};
 		}
 
-		private T GetListViewFlags<T>(ListView view) where T : Enum
-		{
-			int result = 0;
-			foreach (ListViewItem i in view.Items)
-			{
-				T flagEnum = EnumTools.FromDescription<T>(i.Text);
-				int flag = (int)Convert.ChangeType(flagEnum, typeof(int));
-
-				if (i.Checked)
-				{
-					result |= flag;
-				}
-			}
-
-			return (T)Enum.ToObject(typeof(T), result);
-		}
-
 		private void OkButton_Click(object sender, System.EventArgs e)
 		{
 			Options = GetOptions();
 
-			if (Options.WordLists == WordLists.None)
+			if (Options.WordLists.Count() == 0)
 			{
 				MessageBox.Show(this, $"No word lists were selected. This will prevent the plugin from generating passwords. Please select at least one list.", "Options Validation Failure", MessageBoxButtons.OK, MessageBoxIcon.Error);
 				DialogResult = DialogResult.Cancel;
@@ -196,7 +180,30 @@ private void EditSaltSourcesButton_Click(object sender, EventArgs e)
 			}
 
 			_saltSources = ssf.Result;
-			UpdateSaltSourcesLabel();
+			UpdateSaltSourcesListView();
+		}
+
+		private void EditWordListsButton_Click(object sender, EventArgs e)
+		{
+			WordListsForm wlf = new(_wordLists);
+
+			if (wlf.ShowDialog(this) == DialogResult.Cancel)
+			{
+				return;
+			}
+
+			_wordLists = wlf.Result;
+			UpdateWordListsListView();
+		}
+
+		private void ActiveSaltSourcesListView_SelectedIndexChanged(object sender, EventArgs e)
+		{
+			((ListView)sender).SelectedItems.Clear();
+		}
+
+		private void WordListsListView_SelectedIndexChanged(object sender, EventArgs e)
+		{
+			((ListView)sender).SelectedItems.Clear();
 		}
 	}
 }

DicewareOptionsForm.cs

@@ -117,8 +117,4 @@
   <resheader name="writer">
     <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
   </resheader>
-  <data name="activeSaltSourcesLabel.Text" xml:space="preserve">
-    <value>&lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; &lt;active salts&gt; 
-</value>
-  </data>
 </root>

DicewareOptionsForm.resx

@@ -10,7 +10,7 @@ internal static class Extensions
 		/// <summary>
 		/// Generates a pseudorandom value in range [0, <paramref name="maxInclusive"/>] (both ends are inclusive).
 		/// </summary>
-		/// <param name="maxInclusive"> maximal value (inclusive) of random number.</param>
+		/// <param name="maxInclusive">maximal value (inclusive) of random number.</param>
 		/// <returns>
 		/// Pseudorandom value from [0, <paramref name="maxInclusive"/>] range.
 		/// </returns>
@@ -37,7 +37,7 @@ public static ulong AtMost(this CryptoRandomStream random, ulong maxInclusive)
 		/// <summary>
 		/// Generates a pseudorandom value in range [0, <paramref name="maxInclusive"/>] (both ends are inclusive).
 		/// </summary>
-		/// <param name="maxInclusive"> maximal value (inclusive) of random number.</param>
+		/// <param name="maxInclusive">maximal value (inclusive) of random number.</param>
 		/// <returns>
 		/// Pseudorandom value from [0, <paramref name="maxInclusive"/>] range.
 		/// </returns>
@@ -56,8 +56,8 @@ public static int AtMost(this CryptoRandomStream random, int maxInclusive)
 		/// <summary>
 		/// Generates a pseudorandom value in range [<paramref name="minInclusive"/>, <paramref name="maxInclusive"/>] (both ends are inclusive).
 		/// </summary>
-		/// <param name="minInclusive"> minimal value (inclusive) of random number.</param>
-		/// <param name="maxInclusive"> maximal value (inclusive) of random number.</param>
+		/// <param name="minInclusive">minimal value (inclusive) of random number.</param>
+		/// <param name="maxInclusive">maximal value (inclusive) of random number.</param>
 		/// <returns>
 		/// Pseudorandom value from [<paramref name="minInclusive"/>, <paramref name="maxInclusive"/>] range.
 		/// </returns>
@@ -79,7 +79,7 @@ public static int Range(this CryptoRandomStream random, int minInclusive, int ma
 		/// <summary>
 		/// Selects a pseudorandom element from <paramref name="array"/>.
 		/// </summary>
-		/// <param name="array"> array from which to select the random element.</param>
+		/// <param name="array">array from which to select the random element.</param>
 		/// <returns>
 		/// A pseudorandom element from <paramref name="array"/>.
 		/// </returns>

Extensions.cs

@@ -35,10 +35,7 @@ public class Options
 		public L33tSpeakType L33tSpeak { get; set; } = L33tSpeakType.None;
 		public SaltType Salt { get; set; } = SaltType.None;
 		public List<SaltSource> SaltSources { get; set; } = new();
-		public WordLists WordLists { get; set; } =
-			WordLists.Diceware
-			| WordLists.EffLarge
-			| WordLists.Google;
+		public List<WordList> WordLists { get; set; } = new();
 		public AdvancedStrategy AdvancedStrategy { get; set; } = AdvancedStrategy.Drop;
 
 		public Options() { }
@@ -47,7 +44,8 @@ public static Options Default()
 		{
 			return new()
 			{
-				SaltSources = SaltSource.DefaultSources,
+				SaltSources = SaltSource.Default,
+				WordLists = WordListEmbeded.Default,
 			};
 		}
 
@@ -58,9 +56,49 @@ internal static Options Deserialize(string serialized)
 			XmlSerializer xml = new(typeof(Options));
 			xml.UnknownElement += Xml_UnknownElement;
 			Options result = xml.Deserialize(reader) as Options;
+			MigrateWordListsIfNeeded(serialized, ref result);
 			return result;
 		}
 
+		/// <summary>
+		/// Handles migration of WordList storage on versions <= 1.6.0. If a wordlists were set, it is replaced by the same configuration in the new system
+		/// </summary>
+		/// <param name="serialized">The serialized XML configuration</param>
+		/// <param name="result">The resulting Options</param>
+		private static void MigrateWordListsIfNeeded(string serialized, ref Options result)
+		{
+			using StringReader stream = new(serialized.Trim());
+			using var reader = XmlReader.Create(stream);
+
+			// migrate from <= v1.6.0 word lists
+			reader.ReadToDescendant("WordLists");
+
+			// They do not start as objects - it is simply a string stream
+			if (reader.Read() && !reader.Value.StartsWith("<"))
+			{
+				// Start with a default wordlist with all disabled
+				List<WordList> newWordLists = WordListEmbeded.Default;
+				newWordLists.ForEach(wl => wl.Enabled = false);
+
+				string[] oldWordListNames = reader.Value.Split(new char[] { ' ' });
+
+				foreach (var currentWordListName in oldWordListNames)
+				{
+					int index = newWordLists.FindIndex(wl => ((WordListEmbeded)wl).GetBareFilename() == currentWordListName);
+
+					// If unexpected value (e.g. nonexistent wordlist) is found -> discard all changes
+					if (index == -1)
+					{
+						return;
+					}
+
+					newWordLists.ElementAt(index).Enabled = true;
+				}
+
+				result.WordLists = newWordLists;
+			}
+		}
+
 		private static void Xml_UnknownElement(object sender, XmlElementEventArgs e)
 		{
 			if (e.ObjectBeingDeserialized is not Options opts)
@@ -74,7 +112,7 @@ private static void Xml_UnknownElement(object sender, XmlElementEventArgs e)
 				string[] saltSourceNames = e.Element.InnerText.Split(new char[] { ' ' });
 
 				// start from the defaults
-				opts.SaltSources = SaltSource.DefaultSources;
+				opts.SaltSources = SaltSource.Default;
 
 				foreach (SaltSource ss in opts.SaltSources)
 				{

Options.cs

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+    This file is automatically generated by Visual Studio .Net. It is 
+    used to store generic object data source configuration information.  
+    Renaming the file extension or editing the content of this file may   
+    cause the file to be unrecognizable by the program.
+-->
+<GenericObjectDataSource DisplayName="WordList" Version="1.0" xmlns="urn:schemas-microsoft-com:xml-msdatasource">
+   <TypeInfo>KeePassDiceware.WordList, KeePassDiceware, Version=1.6.0.0, Culture=neutral, PublicKeyToken=null</TypeInfo>
+</GenericObjectDataSource>