Check for "known" seed entropy, and add watermark to SLIP-39 output

o Start by reorganizing, and add tests for some known entropy
o Begin to add copyright headers

Author: pjkundert

GNUmakefile

@@ -41,7 +41,7 @@ else
 endif
 
 # To see all pytest output, uncomment --capture=no
-PYTESTOPTS	= -vv --doctest-modules --capture=no --log-cli-level=INFO
+PYTESTOPTS	= -vv --doctest-modules --capture=no # --log-cli-level=INFO
 
 PY3TEST		= $(PY3) -m pytest $(PYTESTOPTS)
 

slip39/__init__.py

@@ -1,3 +1,20 @@
+
+#
+# Python-slip39 -- Ethereum SLIP-39 Account Generation and Recovery
+#
+# Copyright (c) 2022, Dominion Research & Development Corp.
+#
+# Python-slip39 is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.  It is also available under alternative (eg. Commercial) licenses, at
+# your option.  See the LICENSE file at the top of the source tree.
+#
+# Python-slip39 is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+
 from .version	import __version__, __version_info__	# noqa F401
 from .api	import *				# noqa F403
 from .layout	import *				# noqa F403

slip39/api.py

@@ -1,3 +1,20 @@
+
+#
+# Python-slip39 -- Ethereum SLIP-39 Account Generation and Recovery
+#
+# Copyright (c) 2022, Dominion Research & Development Corp.
+#
+# Python-slip39 is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.  It is also available under alternative (eg. Commercial) licenses, at
+# your option.  See the LICENSE file at the top of the source tree.
+#
+# Python-slip39 is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+
 import base58
 import codecs
 import hashlib
@@ -226,7 +243,7 @@ def p2pkh_address( self ):
 
 class Account:
     """A Cryptocurrency "Account" / Wallet, based on a variety of underlying Python crypto-asset
-    support modules.  Presently, only meherett/python-hdwallet is used
+    support modules.  Presently, only meherett/python-hdwallet is used.
 
     An appropriate hdwallet-like wrapper is built, for any crypto-asset supported using another
     module.  The required hdwallet API calls are:
@@ -441,11 +458,15 @@ def from_path( self, path: str = None ) -> "Account":
 
     @property
     def address( self ):
-        if self.format == "legacy":
+        """Returns the 1..., 3... or bc1... address, depending on whether format is legacy, segwit or bech32"""
+        return self.formatted_address()
+
+    def formatted_address( self, format=None ):
+        if ( format or self.format or '' ).lower() == "legacy":
             return self.legacy_address()
-        elif self.format == "segwit":
+        elif ( format or self.format or '' ).lower() == "segwit":
             return self.segwit_address()
-        elif self.format == "bech32":
+        elif ( format or self.format or '' ).lower() == "bech32":
             return self.bech32_address()
         raise ValueError( f"Unknown addresses semantic: {self.format}" )
 
@@ -495,10 +516,19 @@ def path( self ):
     def key( self ):
         return self.hdwallet.private_key()
 
+    @property
+    def xkey( self ):
+        return self.hdwallet.xprivate_key()
+
     @property
     def pubkey( self ):
         return self.hdwallet.public_key()
 
+    @property
+    def xpubkey( self ):
+        """Returns the xpub, ypub or zpub, depending on whether format is legacy, segwit or bech32"""
+        return self.hdwallet.xpublic_key()
+
     def from_private_key( self, private_key ):
         self.hdwallet.from_private_key( private_key )
         return self
@@ -976,8 +1006,8 @@ def accountgroups(
     yield from zip( *[
         accounts(
             master_secret	= master_secret,
-            paths		= paths,
             crypto		= crypto,
+            paths		= paths,
             allow_unbounded	= allow_unbounded,
         )
         for crypto,paths in cryptopaths_parser( cryptopaths )

slip39/defaults.py

@@ -2,18 +2,24 @@
 #
 # Python-slip39 -- Ethereum SLIP-39 Account Generation and Recovery
 #
-# Copyright (c) 2021, Dominion Research & Development Corp.
+# Copyright (c) 2022, Dominion Research & Development Corp.
 #
 # Python-slip39 is free software: you can redistribute it and/or modify it under
 # the terms of the GNU General Public License as published by the Free Software
 # Foundation, either version 3 of the License, or (at your option) any later
-# version. See the LICENSE file at the top of the source tree.
+# version.  It is also available under alternative (eg. Commercial) licenses, at
+# your option.  See the LICENSE file at the top of the source tree.
 #
 # Python-slip39 is distributed in the hope that it will be useful, but WITHOUT
 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 #
 
+__author__                      = "Perry Kundert"
+__email__                       = "[email protected]"
+__copyright__                   = "Copyright (c) 2022 Dominion Research & Development Corp."
+__license__                     = "Dual License: GPLv3 (or later) and Commercial (see LICENSE)"
+
 #
 # HD Wallet Derivation Paths (Standard BIP-44 / Trezor)
 #
@@ -122,6 +128,8 @@
 # Default Crypto accounts (and optional paths) to generate
 CRYPTO_PATHS			= ('ETH', 'BTC')
 
+__d				= "55"
+__m				= "88"
 __o				= "BB"
 __h				= "DD"
 __f				= "FF"
@@ -145,5 +153,20 @@
     f"0x{__o}{__h}{__h}",  # Light Cyan
     f"0x{__h}{__o}{__h}",  # Light Magenta
     f"0x{__h}{__h}{__o}",  # Light Yellow
+    # Greys
     f"0x{__h}{__h}{__h}",  # Light grey,
+    f"0x{__m}{__m}{__m}",  # Medium grey,
+    f"0x{__d}{__d}{__d}",  # Dark grey,
+]
+
+# Include any known seed bit sequences here; any seed containing any of these
+# segments will be printed with a "watermark" indicating that the seed is
+# invalid, indicating that it should probably not be used!  These are clearly
+# non-random sequences of bits, or sequences known to be part of publicly
+# disclosed test sequences.  The probability of these sequences showing up in a
+# legitimate, random seed is about 1 in 2^40 =~= 1 Trillion.
+KNOWN_SEQUENCES			= [
+    40 * "1",
+    40 * "0",
+    20 * "01",
 ]

slip39/generator_test.py

@@ -125,17 +125,3 @@ def read( self, size=1 ):
         file		= ser
     ):
         logging.info( f"Receive: {group}" )
-
-
-# def transmitter():
-
-
-#     yield from addresses(
-#         master_secret			= b"\xFF" * 16,
-#         paths
-
-
-# def test_serial_xonxoff():
-#     """Ensure that flow-control works.  The idealy secure solution is to use hardware RTS/CTS flow
-#     control, with no tx circuit.  However, even a regular serial link with software XON/XOFF flow
-#     control is much more secure than a network-connected peer."""

slip39/known/__init__.py

@@ -0,0 +1,22 @@
+
+#
+# Python-slip39 -- Ethereum SLIP-39 Account Generation and Recovery
+#
+# Copyright (c) 2022, Dominion Research & Development Corp.
+#
+# Python-slip39 is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.  It is also available under alternative (eg. Commercial) licenses, at
+# your option.  See the LICENSE file at the top of the source tree.
+#
+# Python-slip39 is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+
+import sys
+
+from .main	import main
+
+sys.exit( main() )

slip39/known/__main__.py

@@ -0,0 +1,4 @@
+
+
+if __name__ == "__main__":
+    sys.exit( main() )

slip39/known/generator.py

@@ -0,0 +1,14 @@
+
+from ..recovery.main	import main as recovery_main
+
+def main( argv=None ):
+    """Produce all "known" seeds, both in raw and BIP-39 encoded form (w/ no password).  We'll get
+    these from BIP-39 and SLIP-39 test vectors.
+
+    Finds all .bip39 and .slip39 files
+    
+    """
+
+    #for bip39 in 
+    
+    return 0