From 9875f5b875479d88a17a2d657e3f84d904364314 Mon Sep 17 00:00:00 2001 From: Oran Juice Date: Tue, 7 Oct 2014 12:49:36 +0530 Subject: [PATCH] Variable unique prefix lengths for seed --- src/mnemonics/electrum-words.cpp | 80 +++++++++++++++----------------- src/mnemonics/english.h | 1 + src/mnemonics/japanese.h | 1 + src/mnemonics/language_base.h | 8 ++-- src/mnemonics/old_english.h | 1 + src/mnemonics/portuguese.h | 1 + src/mnemonics/spanish.h | 1 + 7 files changed, 46 insertions(+), 47 deletions(-) diff --git a/src/mnemonics/electrum-words.cpp b/src/mnemonics/electrum-words.cpp index b204e81c..937f7bfd 100644 --- a/src/mnemonics/electrum-words.cpp +++ b/src/mnemonics/electrum-words.cpp @@ -59,6 +59,8 @@ #include "language_base.h" #include "singleton.h" +#include + namespace { const int seed_length = 24; @@ -69,11 +71,11 @@ namespace * \param seed List of words to match. * \param has_checksum If word list passed checksum test, we need to only do a prefix check. * \param matched_indices The indices where the seed words were found are added to this. + * \param language Language instance pointer to write to after it is found. * \return true if all the words were present in some language false if not. */ bool find_seed_language(const std::vector &seed, - bool has_checksum, std::vector &matched_indices, uint32_t &word_list_length, - std::string &language_name) + bool has_checksum, std::vector &matched_indices, Language::Base **language) { // If there's a new language added, add an instance of it here. std::vector language_instances({ @@ -83,18 +85,6 @@ namespace Language::Singleton::instance(), Language::Singleton::instance() }); - // To hold trimmed seed words in case of a checksum being present. - std::vector trimmed_seed; - if (has_checksum) - { - // If it had a checksum, we'll just compare the unique prefix - // So we create a list of trimmed seed words - for (std::vector::const_iterator it = seed.begin(); it != seed.end(); it++) - { - trimmed_seed.push_back(it->length() > Language::unique_prefix_length ? - it->substr(0, Language::unique_prefix_length) : *it); - } - } // Iterate through all the languages and find a match for (std::vector::iterator it1 = language_instances.begin(); @@ -104,23 +94,22 @@ namespace const std::unordered_map &trimmed_word_map = (*it1)->get_trimmed_word_map(); // To iterate through seed words std::vector::const_iterator it2; - // To iterate through trimmed seed words - std::vector::iterator it3; bool full_match = true; + std::string trimmed_word; // Iterate through all the words and see if they're all present - for (it2 = seed.begin(), it3 = trimmed_seed.begin(); - it2 != seed.end(); it2++, it3++) + for (it2 = seed.begin(); it2 != seed.end(); it2++) { if (has_checksum) { + trimmed_word = it2->substr(0, (*it1)->get_unique_prefix_length()); // Use the trimmed words and map - if (trimmed_word_map.count(*it3) == 0) + if (trimmed_word_map.count(trimmed_word) == 0) { full_match = false; break; } - matched_indices.push_back(trimmed_word_map.at(*it3)); + matched_indices.push_back(trimmed_word_map.at(trimmed_word)); } else { @@ -134,8 +123,7 @@ namespace } if (full_match) { - word_list_length = (*it1)->get_word_list().size(); - language_name = (*it1)->get_language_name(); + *language = *it1; return true; } // Some didn't match. Clear the index array. @@ -146,18 +134,20 @@ namespace /*! * \brief Creates a checksum index in the word list array on the list of words. - * \param word_list Vector of words - * \return Checksum index + * \param word_list Vector of words + * \param unique_prefix_length the prefix length of each word to use for checksum + * \return Checksum index */ - uint32_t create_checksum_index(const std::vector &word_list) + uint32_t create_checksum_index(const std::vector &word_list, + uint32_t unique_prefix_length) { std::string trimmed_words = ""; for (std::vector::const_iterator it = word_list.begin(); it != word_list.end(); it++) { - if (it->length() > 4) + if (it->length() > unique_prefix_length) { - trimmed_words += it->substr(0, Language::unique_prefix_length); + trimmed_words += it->substr(0, unique_prefix_length); } else { @@ -171,20 +161,21 @@ namespace /*! * \brief Does the checksum test on the seed passed. - * \param seed Vector of seed words - * \return True if the test passed false if not. + * \param seed Vector of seed words + * \param unique_prefix_length the prefix length of each word to use for checksum + * \return True if the test passed false if not. */ - bool checksum_test(std::vector seed) + bool checksum_test(std::vector seed, uint32_t unique_prefix_length) { // The last word is the checksum. std::string last_word = seed.back(); seed.pop_back(); - std::string checksum = seed[create_checksum_index(seed)]; + std::string checksum = seed[create_checksum_index(seed, unique_prefix_length)]; - std::string trimmed_checksum = checksum.length() > 4 ? checksum.substr(0, Language::unique_prefix_length) : + std::string trimmed_checksum = checksum.length() > unique_prefix_length ? checksum.substr(0, unique_prefix_length) : checksum; - std::string trimmed_last_word = checksum.length() > 4 ? last_word.substr(0, Language::unique_prefix_length) : + std::string trimmed_last_word = last_word.length() > unique_prefix_length ? last_word.substr(0, unique_prefix_length) : last_word; return trimmed_checksum == trimmed_last_word; } @@ -227,22 +218,25 @@ namespace crypto // If it is seed with a checksum. bool has_checksum = seed.size() == (seed_length + 1); + + std::vector matched_indices; + Language::Base *language; + if (!find_seed_language(seed, has_checksum, matched_indices, &language)) + { + return false; + } + language_name = language->get_language_name(); + uint32_t word_list_length = language->get_word_list().size(); + if (has_checksum) { - if (!checksum_test(seed)) + if (!checksum_test(seed, language->get_unique_prefix_length())) { // Checksum fail return false; } seed.pop_back(); - } - - std::vector matched_indices; - uint32_t word_list_length = 0; - if (!find_seed_language(seed, has_checksum, matched_indices, word_list_length, language_name)) - { - return false; - } + } for (unsigned int i=0; i < seed.size() / 3; i++) { @@ -335,7 +329,7 @@ namespace crypto } words.pop_back(); - words += (' ' + words_store[create_checksum_index(words_store)]); + words += (' ' + words_store[create_checksum_index(words_store, language->get_unique_prefix_length())]); return false; } diff --git a/src/mnemonics/english.h b/src/mnemonics/english.h index ae39d44f..8ca0a3fe 100644 --- a/src/mnemonics/english.h +++ b/src/mnemonics/english.h @@ -1681,6 +1681,7 @@ namespace Language "zones", "zoom" }); + unique_prefix_length = 3; word_map = new std::unordered_map; trimmed_word_map = new std::unordered_map; language_name = "English"; diff --git a/src/mnemonics/japanese.h b/src/mnemonics/japanese.h index 22c7a53b..fc3d1ee7 100644 --- a/src/mnemonics/japanese.h +++ b/src/mnemonics/japanese.h @@ -1681,6 +1681,7 @@ namespace Language "びじゅつかん", "ひしょ" }); + unique_prefix_length = 4; word_map = new std::unordered_map; trimmed_word_map = new std::unordered_map; language_name = "Japanese"; diff --git a/src/mnemonics/language_base.h b/src/mnemonics/language_base.h index 0f1062b0..06815e39 100644 --- a/src/mnemonics/language_base.h +++ b/src/mnemonics/language_base.h @@ -45,7 +45,6 @@ */ namespace Language { - const int unique_prefix_length = 4; /*!< Length of the prefix of all words guaranteed to be unique */ /*! * \class Base * \brief A base language class which all languages have to inherit from for @@ -58,7 +57,7 @@ namespace Language std::unordered_map *word_map; /*!< hash table to find word's index */ std::unordered_map *trimmed_word_map; /*!< hash table to find word's trimmed index */ std::string language_name; /*!< Name of language */ - int trim_length; /*!< Number of unique starting characters to trim the wordlist to when matching */ + uint32_t unique_prefix_length; /*!< Number of unique starting characters to trim the wordlist to when matching */ /*! * \brief Populates the word maps after the list is ready. */ @@ -85,6 +84,7 @@ namespace Language word_list = new std::vector; word_map = new std::unordered_map; trimmed_word_map = new std::unordered_map; + unique_prefix_length = 4; } /*! * \brief Returns a pointer to the word list. @@ -122,9 +122,9 @@ namespace Language * \brief Returns the number of unique starting characters to be used for matching. * \return Number of unique starting characters. */ - int get_trim_length() const + uint32_t get_unique_prefix_length() const { - return trim_length; + return unique_prefix_length; } }; } diff --git a/src/mnemonics/old_english.h b/src/mnemonics/old_english.h index 09ac37e6..b91a593b 100644 --- a/src/mnemonics/old_english.h +++ b/src/mnemonics/old_english.h @@ -1681,6 +1681,7 @@ namespace Language "weapon", "weary" }); + unique_prefix_length = 4; word_map = new std::unordered_map; trimmed_word_map = new std::unordered_map; language_name = "OldEnglish"; diff --git a/src/mnemonics/portuguese.h b/src/mnemonics/portuguese.h index c040a041..6a90659e 100644 --- a/src/mnemonics/portuguese.h +++ b/src/mnemonics/portuguese.h @@ -1679,6 +1679,7 @@ namespace Language "zenite", "zumbi" }); + unique_prefix_length = 4; word_map = new std::unordered_map; trimmed_word_map = new std::unordered_map; language_name = "Portuguese"; diff --git a/src/mnemonics/spanish.h b/src/mnemonics/spanish.h index 8d695a4b..f7162708 100644 --- a/src/mnemonics/spanish.h +++ b/src/mnemonics/spanish.h @@ -1681,6 +1681,7 @@ namespace Language "ritmo", "rito" }); + unique_prefix_length = 4; word_map = new std::unordered_map; trimmed_word_map = new std::unordered_map; language_name = "Spanish";