Add support for 24 word electrumv1 seeds (#571)

Author: 3rdIteration

btcrecover/btcrseed.py

@@ -581,7 +581,7 @@ def create_from_params(cls, mpk = None, addresses = None, address_limit = None,
     # Performs basic checks so that clearly invalid mnemonic_ids can be completely skipped
     @staticmethod
     def verify_mnemonic_syntax(mnemonic_ids):
-        return len(mnemonic_ids) == 12 and None not in mnemonic_ids
+        return len(mnemonic_ids) in [12,24] and None not in mnemonic_ids
 
     # This is the time-consuming function executed by worker thread(s). It returns a tuple: if a mnemonic
     # is correct return it, else return False for item 0; return a count of mnemonics checked for item 1
@@ -602,7 +602,7 @@ def return_verified_password_or_false(self, mnemonic_ids_list):
 
             # Compute the binary seed from the word list the Electrum1 way
             seed = ""
-            for i in range(0, 12, 3):
+            for i in range(0, len(mnemonic_ids), 3):
                 seed += "{:08x}".format( mnemonic_ids[i    ]
                      + num_words  * (   (mnemonic_ids[i + 1] - mnemonic_ids[i    ]) % num_words )
                      + num_words2 * (   (mnemonic_ids[i + 2] - mnemonic_ids[i + 1]) % num_words ))
@@ -657,7 +657,11 @@ def return_verified_password_or_false(self, mnemonic_ids_list):
     # Configures the values of four globals used later in config_btcrecover():
     # mnemonic_ids_guess, close_mnemonic_ids, num_inserts, and num_deletes
     @classmethod
-    def config_mnemonic(cls, mnemonic_guess = None, closematch_cutoff = 0.65):
+    def config_mnemonic(cls, mnemonic_guess = None, closematch_cutoff = 0.65, expected_len = None):
+        if expected_len:
+            if expected_len not in [12,24]:
+                raise ValueError("Electrum1 mnemoincs can only be 12 or 24 words lon")
+
         # If a mnemonic guess wasn't provided, prompt the user for one
         if not mnemonic_guess:
             init_gui()
@@ -694,9 +698,24 @@ def config_mnemonic(cls, mnemonic_guess = None, closematch_cutoff = 0.65):
                           "    trying all possible seed words here instead.".format(word))
                 mnemonic_ids_guess += None,
 
+        guess_len = len(mnemonic_ids_guess)
+        if not expected_len:
+            if guess_len < 12:
+                expected_len = 12
+            elif guess_len > 24:
+                expected_len = 24
+            else:
+                off_by = guess_len % 3
+                if off_by == 0: # If the supplied guess is a valid length, assume that all words have been supplied
+                    expected_len = guess_len
+                else: # If less words have been supplied, round up to the nearest valid seed length (Assume words are missing by default)
+                    expected_len = guess_len + 3 - off_by
+
+            print("Assuming a", expected_len, "word mnemonic. (This can be overridden with --mnemonic-length)")
+
         global num_inserts, num_deletes
-        num_inserts = max(12 - len(mnemonic_ids_guess), 0)
-        num_deletes = max(len(mnemonic_ids_guess) - 12, 0)
+        num_inserts = max(expected_len - len(mnemonic_ids_guess), 0)
+        num_deletes = max(len(mnemonic_ids_guess) - expected_len, 0)
         if num_inserts:
             print("Seed sentence was too short, inserting {} word{} into each guess."
                   .format(num_inserts, "s" if num_inserts > 1 else ""))
@@ -3741,7 +3760,6 @@ def main(argv):
                 phase["passwordlist"] = args.seedlist
 
             if args.wallet_type == "electrum1":
-                args.mnemonic_length = None
                 args.language = None
 
         if args.language:

btcrecover/test/test_seeds.py

@@ -564,10 +564,14 @@ def test_cardano_icarus_24word_baseaddress_opencl(self):
         self.address_tester_cardano_opencl("addr1qx3f4r3qqvynsnvhxrkkycp83v93jg2fqkn7scxnvpe6t99f4evt0tdad8cvsdvenma8t68gfdkyvf3efjzslcn7r4ys72w3qh",
                                     "wood blame garbage one federal jaguar slogan movie thunder seed apology trigger spoon depth basket fine culture boil render special enforce dish middle antique")
 
-    def test_electrum1_addr_legacy_BTC(self):
+    def test_electrum1_addr_legacy_12word_BTC(self):
         self.address_tester(btcrseed.WalletElectrum1, "12zAz6pAB6LhzGSZFCc6g9uBSWzwESEsPT", 3,
                             "straight subject wild ask clean possible age hurt squeeze cost stuck softly")
 
+    def test_electrum1_addr_legacy_24_word_BTC(self):
+        self.address_tester(btcrseed.WalletElectrum1, "1MFu6Wyp6Gy3PDpz2PtoNVdiFWDHR8TMuS", 3,
+                            "bowl especially tomorrow fan sail defeat scary knock ripple third cheek blind join mark rock scratch truth interest bone perfection curve milk taint terror")
+
     def test_electrum2_addr_legacy_BTC(self):
         self.address_tester(btcrseed.WalletElectrum2, "14dpd9nayyoyCTNki5UUsm1KnAZ1x7o83E", 5,
                             "eagle pair eager human cage forget pony fall robot vague later bright acid",

docs/Usage_Examples/basic_seed_recoveries.md

@@ -116,4 +116,10 @@ python seedrecover.py --wallet-type tron --addrs TLxkYzNpMCEz5KThVuZzoyjde1UfsJK
 One missing word, address generation limit of 2. (So address needs to be in the first account)
 ```
 python seedrecover.py --wallet-type elrond --addrs erd16jn439kmwgqj9j0xjnwk2swg0p7j2jrnvpp4p7htc7wypnx27ttqe9l98m --mnemonic "agree process hard hello artefact govern obtain wedding become robust fish bar alcohol about speak unveil mind bike shift latin pole base ugly artefact" --addr-limit 2
+```
+
+### Basic Electrum Legacy Recoveries
+One wrong word, address generation limit of 2. (So address needs to be in the first account)
+```
+python seedrecover.py --wallet-type electrum1 --addrs 1Pw1yjF5smzg6eWbE2LbFm7fr1zq7WUYc7 --mnemonic "milk hungry group sound Lift Connect throw rabbit gift leg new lady pie government swear flat dove imagination sometime prepare lot trembl alone bus" --addr-limit 2
 ```