Improve card layouts and colors

o Change default Frens group to 3/6
o Add card size selection radio buttons

Author: pjkundert

GNUmakefile

@@ -58,7 +58,7 @@ dist/slip39-$(VERSION)-py3-none-any.whl: build-check FORCE
 
 # Install from wheel, including all optional extra dependencies
 install:	dist/slip39-$(VERSION)-py3-none-any.whl FORCE
-	$(PY3) -m pip install --force-reinstall $^[gui,serial,json]
+	$(PY3) -m pip install --force-reinstall $<[gui,serial,json]
 
 # Generate, Sign and Zip the macOS SLIP39.app GUI package
 app:		dist/SLIP39.app-$(VERSION).zip

README.org

@@ -247,14 +247,16 @@ def mnemonics(
     master_secret: Union[str,bytes] = None,
     passphrase: bytes		= b"",
     iteration_exponent: int	= 1,
+    strength: int		= 128,
 ) -> List[List[str]]:
     """Generate SLIP39 mnemonics for the supplied group_threshold of the given groups.  Will generate a
      random master_secret, if necessary.
 
     """
     if master_secret is None:
-        master_secret		= random_secret()
-    if len( master_secret ) not in (16, 32, 64):
+        assert strength in BITS, f"Invalid {strength}-bit secret length specified"
+        master_secret		= random_secret( strength // 8 )
+    if len( master_secret ) * 8 not in BITS:
         raise ValueError(
             f"Only 128-, 256- and 512bit seeds supported; {len(master_secret)*8}-bit master_secret supplied" )
     return generate_mnemonics(

README.pdf

@@ -81,14 +81,14 @@ def test_passphrase():
             ]
         ),
         "Frens": (
-            2,
+            3,
             [
-                "academic acid decision roster alto density aircraft wavy pistol capacity receiver username dismiss famous walnut lunch acquire counter fused step",
-                "academic acid decision scared bike sunlight explain render emphasis activity exotic verdict machine enforce facility grasp husband warmth famous club",
-                "academic acid decision shadow deadline wildlife warmth smell device clogs craft volume cargo item scramble easy grumpy budget easy forward",
-                "academic acid decision sister dragon belong python marathon stay dismiss snapshot victim process holiday hesitate presence both sidewalk exclude petition",
-                "academic acid decision smug beard resident modify much minister hesitate memory expand depend alarm unwrap analysis envelope pickup raspy lunar",
-                "academic acid decision spew aircraft false stilt stadium lawsuit idle intend example library bike energy ticket discuss island resident jerky"
+                "academic acid decision round academic academic academic academic academic academic academic academic academic academic academic academic academic ranked flame amount",
+                "academic acid decision scatter biology trial escape element unfair cage wavy afraid provide blind pitch ultimate hybrid gravity formal voting",
+                "academic acid decision shaft crunch glance exclude stilt grill numb smug stick obtain raisin force theater duke taught license scramble",
+                "academic acid decision skin disaster mama alive nylon mansion listen cowboy suitable crisis pancake velvet aviation exhaust decent medal dominant",
+                "academic acid decision snake aunt frozen flip crystal crystal observe equip maximum maiden dragon wine crazy nervous crystal profile fiction",
+                "academic acid decision spider bulge receiver behavior humidity ruler luck public math distance cylinder fantasy seafood training withdraw payment playoff"
             ]
         )
     }
@@ -101,7 +101,7 @@ def test_passphrase():
 
     # Ensure we can recover it w/ no passphrase
     assert recover(
-        details_nonpass.groups['Fam'][1][:2] + details_nonpass.groups['Frens'][1][:2],
+        details_nonpass.groups['Fam'][1][:2] + details_nonpass.groups['Frens'][1][:-3],
     ) == SEED_FF
 
     # Now, ensure that we see a different set of Mnemonics w/ a SLIP39 passphrase.
@@ -116,7 +116,7 @@ def test_passphrase():
     badpass			= "password".encode( 'UTF-8' )
 
     assert recover(
-        details_nonpass.groups['Fam'][1][:2] + details_nonpass.groups['Frens'][1][:2],
+        details_nonpass.groups['Fam'][1][:2] + details_nonpass.groups['Frens'][1][:-3],
         passphrase	= badpass,
     ) != SEED_FF
 
@@ -151,14 +151,14 @@ def test_passphrase():
             ]
         ),
         "Frens": (
-            2,
+            3,
             [
-                "academic acid decision roster alien carbon machine home valuable parking soul ounce disaster smart much hour prisoner script alpha extend",
-                "academic acid decision scared both episode phantom award pacific spirit clock index memory evaluate mule epidemic very eraser evaluate lying",
-                "academic acid decision shadow closet prospect result primary hawk equation fawn thorn soldier taste welcome mild blimp blue glad crush",
-                "academic acid decision sister desert tracks metric sister again drink peaceful analysis grin forecast webcam reaction entrance oasis damage victim",
-                "academic acid decision smug alarm focus medical treat season harvest style silver hobo ultimate exercise deal garbage harvest paper junior",
-                "academic acid decision spew boundary auction peanut luxury platform carbon cultural cluster sugar hamster exclude bracelet adequate ting uncover party"
+                "academic acid decision round academic academic academic academic academic academic academic academic academic academic academic academic academic ranked flame amount",
+                "academic acid decision scatter become flavor crystal genuine hour infant voice unfair recall living afraid company froth distance bundle soldier",
+                "academic acid decision shaft display headset level prevent verdict genius preach glad makeup element twin scene hunting smoking rival mortgage",
+                "academic acid decision skin course dress prisoner skunk ordinary blind freshman member drink scroll traffic thank deliver frequent velvet evoke",
+                "academic acid decision snake burden unknown guard peaceful artwork snapshot teaspoon literary move spray saver voice august maximum hazard negative",
+                "academic acid decision spider ancestor regular evaluate salon glasses penalty blue guitar check extra roster snapshot fantasy adjust coastal eclipse"
             ]
         )
     }
@@ -169,22 +169,22 @@ def test_passphrase():
     # design -- you can supply an attacker with a "duress" seed passphrase leading to wallet(s) with
     # a small sacrificial amount of funds.
     assert recover(
-        details_badpass.groups['Fam'][1][:2] + details_badpass.groups['Frens'][1][:2],
+        details_badpass.groups['Fam'][1][:2] + details_badpass.groups['Frens'][1][:3],
     ) != SEED_FF
     assert recover(
-        details_badpass.groups['Fam'][1][:2] + details_badpass.groups['Frens'][1][:2],
+        details_badpass.groups['Fam'][1][:2] + details_badpass.groups['Frens'][1][:3],
         passphrase	= badpass,
     ) == SEED_FF
 
     # Mixing SLIP39 recovery groups should fail to recover, both without and with the password,
     # since SLIP39 confirms the digest of the recovered "encrypted" seed, before decryption.
     with pytest.raises( shamir_mnemonic.utils.MnemonicError ):
         assert recover(
-            details_nonpass.groups['Fam'][1][:2] + details_badpass.groups['Frens'][1][:2],
+            details_nonpass.groups['Fam'][1][:2] + details_badpass.groups['Frens'][1][:3],
         ) != SEED_FF
     with pytest.raises( shamir_mnemonic.utils.MnemonicError ):
         assert recover(
-            details_nonpass.groups['Fam'][1][:2] + details_badpass.groups['Frens'][1][:2],
+            details_nonpass.groups['Fam'][1][:2] + details_badpass.groups['Frens'][1][:3],
             passphrase	= badpass,
         ) != SEED_FF
 

README.txt

@@ -32,7 +32,7 @@
     "First1",
     "Second(1/1)",
     "Fam(4)",
-    "Frens2/6"
+    "Frens3/6"
 ]
 
 FONTS				= dict(
@@ -48,8 +48,8 @@
 
 CARD				= 'index'
 CARD_SIZES			= dict(
-    credit	= CREDIT_CARD,
     index	= INDEX_CARD,
+    credit	= CREDIT_CARD,
     business	= BUSINESS_CARD,
     half	= HALF_LETTER,
 )

slip39/api.py

@@ -12,7 +12,7 @@
 from ..recovery		import recover, recover_bip39
 from ..util		import log_level, log_cfg
 from ..layout		import write_pdfs
-from ..defaults		import GROUPS, GROUP_THRESHOLD_RATIO, CRYPTO_PATHS
+from ..defaults		import GROUPS, GROUP_THRESHOLD_RATIO, CRYPTO_PATHS, CARD, CARD_SIZES
 
 log				= logging.getLogger( __package__ )
 
@@ -48,7 +48,7 @@ def groups_layout( names, group_threshold, groups, passphrase=None ):
             ], key='-GROUP-NUMBER-' ) ]], **F_kwds
         ),
         sg.Frame(
-            'Group Recovery', [[ sg.Column( [
+            'Recovery Group', [[ sg.Column( [
                 [ sg.Input( f'{g_name}', key=f'-G-NAME-{g}', **I_kwds ) ]
                 for g,(g_name,(g_need,g_size)) in enumerate( groups.items() )
             ], key='-GROUP-NAMES-' ) ]], **F_kwds
@@ -79,17 +79,20 @@ def groups_layout( names, group_threshold, groups, passphrase=None ):
                 ],
                 [
                     sg.Text( "Seed Name(s): ",                                  size=prefix,    **T_kwds ),
-                    sg.Input( f"{', '.join( names )}",          key='-NAMES-',  size=inputs,    **I_kwds ),
+                    sg.Input( f"{', '.join( names )}",  key='-NAMES-',          size=inputs,    **I_kwds ),
                     sg.Text( "(default is 'SLIP39...'; comma-separated)",                       **T_kwds ),
                 ],
                 [
-                    sg.Button( 'Save', **B_kwds ), sg.Button( 'Exit', **B_kwds ),
+                    sg.Text( "Card size: ",                                     size=prefix,    **T_kwds ),
+                ] + [
+                    sg.Radio( f"{card}", "CS",          key=f"-CS-{card}", default=(card == CARD), **B_kwds )
+                    for card in CARD_SIZES
                 ],
             ],                                                  key='-OUTPUT-F-',               **F_kwds ),
         ],
     ] + [
         [
-            sg.Frame( 'Seed Data Source', [
+            sg.Frame( 'Seed Data Source (256-bit seeds produce more Mnemonic words to type into your Trezor; 512-bit seeds aren\'t Trezor compatible)', [
                 [
                     sg.Radio( "128-bit Random", "SD",   key='-SD-128-RND-',     default=True,   **B_kwds ),
                     sg.Radio( "256-bit Random", "SD",   key='-SD-256-RND-',     default=False,  **B_kwds ),
@@ -101,7 +104,7 @@ def groups_layout( names, group_threshold, groups, passphrase=None ):
                     sg.Radio( "512-bit Fixed ", "SD",   key='-SD-512-FIX-',     default=False,  **B_kwds ),
                 ],
                 [
-                    sg.Radio( "BIP-39",         "SD",   key='-SD-BIP-',         default=False,  **B_kwds ),
+                    sg.Radio( "512-bit BIP-39", "SD",   key='-SD-BIP-',         default=False,  **B_kwds ),
                     sg.Radio( "SLIP-39",        "SD",   key='-SD-SLIP-',        default=False,  **B_kwds ),
                 ],
                 [
@@ -113,11 +116,10 @@ def groups_layout( names, group_threshold, groups, passphrase=None ):
                     ],                                  key='-SD-DATA-F-',      visible=False,  **F_kwds ),
                 ],
                 [
-                    sg.Frame( 'Passphrase (optional, if provided when Mnemonic was created)', [
+                    sg.Frame( 'Passphrase (if provided when Mnemonic was created)', [
                         [
                             sg.Text( "Passphrase (decrypt): ",                  size=prefix,    **T_kwds ),
                             sg.Input( "",               key='-SD-PASS-',        size=inputs,    **I_kwds ),
-                            sg.Text( "(NOT Trezor compatible)",                                 **T_kwds ),
                         ],
                     ],                                  key='-SD-PASS-F-',      visible=False,  **F_kwds ),
                 ],
@@ -170,10 +172,10 @@ def groups_layout( names, group_threshold, groups, passphrase=None ):
                                                         key='-PASSPHRASE-',     size=inputs,    **I_kwds ),  # noqa: E127
                             sg.Text( "(NOT Trezor compatible, and must be saved separately!!)", **T_kwds ),
                         ],
-                        group_body,
                         [
                             sg.Button( '+', **B_kwds ),
                         ],
+                        group_body,
                     ] ),
                 ],
             ],                                          key='-GROUPS-F-',                       **F_kwds ),
@@ -186,6 +188,9 @@ def groups_layout( names, group_threshold, groups, passphrase=None ):
                 ]
             ],                                          key='-SUMMARY-F-',                      **F_kwds ),
         ],
+        [
+            sg.Button( 'Save', **B_kwds ), sg.Button( 'Exit', **B_kwds ),
+        ],
         [
             sg.Frame( 'Status', [
                 [
@@ -443,10 +448,10 @@ def app(
         if not values or event in events_termination:
             continue
 
-        if event == '+':
-            # Add a SLIP39 Groups row
-            g			= len(groups)
-            name		= f"Group {g+1}"
+        if event == '+' and len( groups ) < 16:
+            # Add a SLIP39 Groups row (if not already at limit)
+            g			= len( groups )
+            name		= f"Group{g+1}"
             needs		= (2,3)
             groups[name] 	= needs
             values[f"-G-NAME-{g}"] = name
@@ -567,8 +572,10 @@ def app(
         # details is now { "<filename>": <details> })
         if event == 'Save':
             try:
+                card		= next( c for c in CARD_SIZES if values[f"-CS-{c}"] )
                 details		= write_pdfs(
                     names	= details,
+                    card	= card,	
                 )
             except Exception as exc:
                 status		= f"Error saving PDF(s): {exc}"
@@ -611,7 +618,8 @@ def main( argv=None ):
                      help="A group name[[<require>/]<size>] (default: <size> = 1, <require> = half of <size>, rounded up, eg. 'Frens(3/5)' )." )
     ap.add_argument( '-c', '--cryptocurrency', action='append',
                      default=[],
-                     help=f"A crypto name and optional derivation path ('../<range>/<range>' allowed); defaults: {', '.join( f'{c}:{Account.path_default(c)}' for c in Account.CRYPTOCURRENCIES)}" )
+                     help="A crypto name and optional derivation path ('../<range>/<range>' allowed); defaults:" \
+                     f" {', '.join( f'{c}:{Account.path_default(c)}' for c in Account.CRYPTOCURRENCIES)}" )
     ap.add_argument( '--passphrase',
                      default=None,
                      help="Encrypt the master secret w/ this passphrase, '-' reads it from stdin (default: None/'')" )

slip39/api_passphrase_test.py

@@ -171,28 +171,28 @@ def layout_card(
         f = "FF"
         color			= [
             # Primary
-            f"0x{f}{o}{o}",  # Red
-            f"0x{o}{f}{o}",  # Green
             f"0x{o}{o}{f}",  # Blue
+            f"0x{o}{f}{o}",  # Green
+            f"0x{f}{o}{o}",  # Red
             # Secondary
             f"0x{o}{f}{f}",  # Cyan,
             f"0x{f}{o}{f}",  # Magenta
             f"0x{f}{f}{o}",  # Yellow
             # Tertiary
-            f"0x{f}{h}{o}",  # Orange
-            f"0x{h}{f}{o}",  # Lime
-            f"0x{h}{o}{f}",  # Violet
-            f"0x{f}{o}{h}",  # Red-Magenta
             f"0x{o}{h}{f}",  # Ocean
             f"0x{o}{f}{h}",  # Turquoise
+            f"0x{f}{o}{h}",  # Red-Magenta
+            f"0x{h}{o}{f}",  # Violet
+            f"0x{h}{f}{o}",  # Lime
+            f"0x{f}{h}{o}",  # Orange
             # Other
             f"0x{o}{h}{h}",  # Light Cyan
             f"0x{h}{o}{h}",  # Light Magenta
             f"0x{h}{h}{o}",  # Light Yellow
             f"0x{h}{h}{h}",  # Light grey,
         ]
         card_interior.add_region_proportional(
-            Text( f'card-g{g_n}', x1=1/8, y1=-1/8, x2=7/8, y2=3/8, foreground=int( color[g_n], 16 ), rotate=-45 )
+            Text( f'card-g{g_n}', x1=1/8, y1=-1/16, x2=7/8, y2=5/16, foreground=int( color[g_n], 16 ), rotate=-45 )
         )
     card_top			= card_interior.add_region_proportional(
         Region( 'card-top', x1=0, y1=0, x2=1, y2=1/4 )
@@ -359,7 +359,7 @@ def output_pdf(
             if len( accounts[0] ) > 1:
                 tpl['card-crypto2'] = f"{accounts[0][1].crypto} {accounts[0][1].path}: {accounts[0][1].address}"
                 tpl['card-qr2']	= qr[1].get_image()
-            tpl[f'card-g{g_n}']	= f"{g_name:5.5}..{mn_n+1}" if len(g_name) > 6 else f"{g_name} {mn_n+1}"
+            tpl[f'card-g{g_n}']	= f"{g_name:6.6}..{mn_n+1}" if len(g_name) > 7 else f"{g_name} {mn_n+1}"
 
             for n,m in enumerate_mnemonic( mnem ).items():
                 tpl[f"mnem-{n}"] = m

slip39/defaults.py

@@ -29,7 +29,7 @@ def main( argv=None ):
                      help="Reduce logging output." )
     ap.add_argument( '-o', '--output',
                      default=FILENAME_FORMAT,
-                     help="Output PDF to file or '-' (stdout); formatting w/ {', '.join( FILENAME_KEYWORDS )} allowed" )
+                     help=f"Output PDF to file or '-' (stdout); formatting w/ {', '.join( FILENAME_KEYWORDS )} allowed" )
     ap.add_argument( '-t', '--threshold',
                      default=None,
                      help="Number of groups required for recovery (default: half of groups, rounded up)" )