Merge branch 'dev' into seedsigner-icons-v2

docs/dice_verification.md

@@ -1,40 +1,207 @@
-## Verifying dice seed generation 
+# Verifying dice seed generation 
 
-It is possible to do a 'dry run' to verify that seed generation has not been tempered.
-This will ensure that the derivation algorithm has not been tempered and is still same as well known algorithm used bu coldcard and ian coleman bip39 webpage.
-For example an 'evil maid' attack would be someone accesing your sdcard and change the code to only take in account 5 or 6 dice, so the 24 words would still feel random but the attacker will need to brute force only 5 or 6 dice (very easy).
-This is part of the "do not trust, verify" crypto mottos.
+The intention of this documentation is to describe how to verify the seed generation code used in SeedSigner against other independent tools, to prove that they all generate the same results, despite them using different programming languages and code libraries.<br><br>
+As it is an important step to verify all software releases being used to ensure that the installation files downloaded have not been compromised, the same is true especially for the seed generation procedure which unknowingly might not work as expected due to bugs or even on purpose.<br><br>
+This guide describes how this can be achieved.<br><br>
+As usual: Don't Trust, Verify!<br>
+<br><br>
+**Note:**<br>
+**Do NOT use this with any seed you want to use later with real funds. This exercise is only for checking that the independent codebases get to the same end result!**<br>
+**However, if you do want to check your real seedphrases you should download the Iancoleman and/or Bitcoiner.Guide tools onto an airgapped, ephemeral computer (e.g. using tails-OS) and perform these tests on there. Destroy/abandon the TailsOS afterwards.**<br>
+**Never input seed phrases that you intend to use to store real funds onto an internet-connected computer!!!**
+<br><br><br>
 
-### Verifying with Ian coleman webpage
+## 99 Dice Rolls / 24 Seed Words Example
 
-Go to https://iancoleman.io/bip39 and check show entropy detail:
-<img src="img/dice_entr.png">
+The following 99 dice roll results are used in the verification steps as an example for a 24 words seed:<br>
+> 655152231316521321611331544441236164664431121534415633526456254462245546236542364246312613322234612
 
-And then make sure to check 'Hex' or 'base 10' (1) and 24 words as mnemonic length (2).
-Do not use 'dice' format because dice 6 will be replaced by 0.
-And then enter the 99 dices numbers in (3) :
-<img src="img/dice_type.png">
+The corresponding 24 seed words are:<br>
+> eyebrow obvious such suggest poet seven breeze blame virtual frown dynamic donor harsh pigeon express broccoli easy apology scatter force recipe shadow claim radio
 
-When the 99 dice number has been entered in the seedsigner and ian coleman page, you will be able to verify that the 24 words are the same.
+(Scroll down near the end to see result values for a 50 dice rolls / 12 seed words example)
+<br><br><br>
 
+## Creating seed via Dice rolls in SeedSigner (here v0.6.0)
 
-#### Here in real life:
+First we create a new seed based on dice rolls in SeedSigner:<br><br>
+Power on your SeedSigner, go to the 'Tools' menu and select 'New Seed' (with the dice symbols):<br>
+<img src="img/dicedoc/sesi_tools_dice_seed.png" width="600">
 
-We start with first 3 roll, it is important to always read dice roll from left to right to avoid human bias:
-<img src="img/dice_pic1.png">
+Select '24 words (99 rolls)' and on the next screen enter the dice numbers one after another:<br>
+<img src="img/dicedoc/sesi_dice_1.png" width="600">
 
-Then we arrive at the 99th dice:
-<img src="img/dice_pic2.png">
+Go on until the end (99 dice roll numbers):<br>
+<img src="img/dicedoc/sesi_dice_2.png" width="600">
 
-Then same 24 words! :
-<img src="img/dice_pic3.png">
+After that the 24 seed words are shown (in 6 screens of 4 words each):<br>
+<img src="img/dicedoc/sesi_seed_1.png" width="600">
+<br>**.....**<br>
+<img src="img/dicedoc/sesi_seed_2.png" width="600">
 
-Now we are sure that the dice derivation is correct and we can unplug everything and do a new dice roll only on the seedsigner.
+The fingerprint for this seed is:<br>
+<img src="img/dicedoc/sesi_finger_print.png" width="600">
+<br><br><br>
+Having now created a dice-based seed in the SeedSigner, we will go on to compare those details to what appears in the:
+* Sparrow desktop wallet software
+* Ian Coleman's Mnemonic Code Converter website
+* Seed Tool website
 
-### Verifying with Coldcard
+We will create a wallet to have the complete zpub and receive/change addresses to check against the two web pages.<br>
+SeedSigner currently supports BlueWallet, Nunchuk, Sparrow and Specter Desktop. Here we will use Sparrow wallet as an example.<br>
 
-There is nothing specific, the algorithm are completely the same. Coldcard has a verification script in python and all explanations here:
-https://coldcard.com/docs/verifying-dice-roll-math
+Keep the SeedSigner open and the newly created seed still loaded as we will need it in the next step.
+<br><br><br>
+
+## Create new wallet from seed in Sparrow Wallet to see xpub/zpub and addresses
+
+Go to https://www.sparrowwallet.com/download/ and download the release version supported by your operating system.<br><br>
+Open Sparrow Wallet, go to 'File' menu and select 'New Wallet'. Enter a name (e.g. test), and click 'Create Wallet'.<br><br>
+Click 'Airgapped Hardware Wallet' (1) and click on the 'Scan' button in the SeedSigner entry (2) which will open the camera scan screen:<br>
+<kbd><img src="img/dicedoc/sparrow_wallet_1.png"></kbd>
+
+On SeedSigner go to the seed just created and click 'Export Xpub':<br>
+<img src="img/dicedoc/sesi_export_xpub_1.png" width="600">
+
+Follow these menu entries in SeedSigner:<br>
+> Export Xpub --> Single Sig --> Native Segwit --> Sparrow<br>
+
+<img src="img/dicedoc/sesi_export_xpub_2.png" width="600">
+
+Click 'Export Xpub' and SeedSigner will show an animated QR code to be scanned in Sparrow Wallet (where we are still in the wallet creation).<br>
+Scan the QR code SeedSigner is showing in Sparrow Wallet.<br><br>
+The wallet has now been created in Sparrow. Click 'Apply' button to finalize. The wallet's settings screen now looks like this:<br>
+<kbd><img src="img/dicedoc/sparrow_wallet_2.png"></kbd>
+
+We will later use this to verify: (1) fingerprint, (2) zpub (click this button to switch between xpub and zpub!) and (3) addresses on the 'Addresses' tab.
+<br><br><br>
+
+## Verifying with Ian Coleman BIP39 website
+
+Go to https://iancoleman.io/bip39 and check 'Show entropy details' (1):<br>
+<kbd><img src="img/dicedoc/coleman_entropy.png"></kbd>
+
+<br>
+Make sure to check (1) 'Hex' and (2) '24 Words' as 'Mnemonic Length'.<br>
+(Do not use 'dice' format because dice 6 will be replaced by 0).<br>
+Then enter the 99 dices numbers in (3). The corresponding seed words are shown in (4):<br>
+<kbd><img src="img/dicedoc/coleman_verify.png"></kbd>
+<br><br>
+The 24 seed words are the same in SeedSigner and the Ian Coleman tool.
+<br><br>
+
+### Verification of (1) fingerprint, (2) zpub and (3) generated addresses
+**Fingerprint:**<br>
+Fingerprint is not shown in the Ian Coleman tool (so cannot be verified here)
+<br><br>
+**Zpub:**<br>
+Scroll down to the 'Derivation Path' section, click on the 'BIP84' tab (1) and find the zpub in (2):
+<kbd><img src="img/dicedoc/coleman_zpub.png"></kbd><br><br>
+Compare to zpub in Sparrow:<br>
+<kbd><img src="img/dicedoc/sparrow_zpub.png"></kbd>
+<br>
+
+Zpub is the same as shown in SeedSigner and Sparrow wallet.
+<br><br>
+**Addresses:**<br>
+Scroll down to the 'Derived Addresses' section and compare the receive addresses to the ones generated in Sparrow ('Addresses' tab of the wallet):
+<kbd><img src="img/dicedoc/coleman_addresses.png"></kbd>
+<br>
+
+Check that the receive addresses all match.<br><br>
+To verify the change addresses, change 'External / Internal' to 1 (1):
+<kbd><img src="img/dicedoc/coleman_change_addresses_1.png"></kbd><br><br>
+Compare the change addresses to the ones generated in Sparrow ('Addresses' tab of the wallet):
+<kbd><img src="img/dicedoc/coleman_change_addresses_2.png"></kbd>
+<br>
+
+Check that the change addresses all match.
+<br><br><br>
+
+## Verifying with Seed Tool website
+
+Go to https://bitcoiner.guide/seed/ and click on 'Seed Generation Input' (1):<br>
+<kbd><img src="img/dicedoc/seedtool_1.png"></kbd>
+
+Then click on the 'Show the Entropy Section' tab (1):<br>
+<kbd><img src="img/dicedoc/seedtool_2.png"></kbd>
+
+Enter the 99 dice numbers in (1), in (2) change back to 'Hex', check that (3) is still '24 Words' and the calculated seed words are shown in (4):<br>
+<kbd><img src="img/dicedoc/seedtool_3.png"></kbd>
+
+Seed words shown are the same as in SeedSigner and the Ian Coleman web tool seen before.
+<br><br>
+
+### Verification of (1) fingerprint, (2) zpub and (3) generated addresses
+
+**Fingerprint:**<br>
+Fingerprint can be seen here (1): <br>
+<kbd><img src="img/dicedoc/seedtool_fingerprint.png"></kbd><br><br>
+**Zpub:**<br>
+Scroll down to the 'Derived Addresses' section (1), click on it, make sure that '84' is selected for 'Purpose' (2) and check the zpub at (3):<br>
+<kbd><img src="img/dicedoc/seedtool_zpub.png"></kbd><br><br>
+Compare to zpub in Sparrow:<br>
+<kbd><img src="img/dicedoc/sparrow_zpub.png"></kbd>
+<br>
+
+Zpub is the same as shown in SeedSigner, Sparrow and Ian Colemand tool.
+<br><br>
+**Addresses:**<br>
+Scroll down a little bit where the receive addresses are shown and compare to the ones generated in Sparrow ('Addresses' tab of the wallet):<br>
+<kbd><img src="img/dicedoc/seedtool_addresses.png"></kbd>
+<br>
+
+Check that the receive addresses all match.<br><br>
+To verify the change addresses, change the 'Receive/Change' dropdown box to '1 (Change)' (1):
+<kbd><img src="img/dicedoc/seedtool_change_addresses_1.png"></kbd><br><br>
+Compare the change addresses to the ones generated in Sparrow ('Addresses' tab of the wallet):
+<kbd><img src="img/dicedoc/seedtool_change_addresses_2.png"></kbd>
+<br>
+
+Check that the change addresses all match.
+<br><br><br>
+
+## 50 Dice Rolls / 12 Seed Words Example
+
+SeedSigner supports the creation of mnenomic seeds both with 12 or 24 seed words corresponding to 50 or 99 dice rolls. Below are some example result values for using 50 dice rolls only.<br><br>
+All the steps shown can be executed the same way, just select the '12 words (50 rolls)' option in SeedSigner and change the 'Mnenomic Length' dropdown boxes in both web tools to '12 Words'.<br><br>
+
+50 dice roll results as an example for a 12 words seed:<br>
+> 65515223131652132161133154444123616466443112153441
+
+The corresponding 12 seed words are:<br>
+> hole luggage safe present express tragic orbit shed switch metal identify path
+
+Fingerprint:<br>
+> 8d9cced8
+
+Zpub:<br>
+> zpub6qf9ziL759pzyhKMWaPfNSiCETkoA6oq3fbCDvXqcURiMtPnkEg3nH93W5mrSkvGPoJC9xTYZheYDsYoiYc5AkSk9iY3DkCJHkFgHMdijW6
+
+Addresses:<br>
+Receive:<br>
+> bc1q00lln3r4mt4uwvg7mxv96xgpewauwmggkex2ff<br>
+> bc1q0jj2cv965f3642mv4lgq5za80jtfpkd0jhjefr<br>
+> bc1qpecssejm2678v0rknk9tsxd5fsshezfr0vr5m5<br>
+> bc1qcsl37xn5rkfz8qhcfwq5u52acxecyyfz0kv4gh<br>
+> bc1q8ehx53re0wck4m9tzek8mlnctp2ztm7jq94zm4<br>
+> ...<br>
+
+Change:<br>
+> bc1qz0ckhg3m349qpmweyn5v6r6tvx2wfw4nv8h75q<br>
+> bc1qme5tu2t424ws3z69u445q0yw88vpc7fwygra4r<br>
+> bc1qznuyuc087ky7fhv4nvlmll4p586ks4ggcyt36d<br>
+> bc1qjcqxv22j0g00pehruwwh34sw5znu6vp3myaspy<br>
+> bc1q6dpfl7czd22wt0max6p09vr6lvvpag7xw9u8lc<br>
+> ...
+
+<br><br>
+## Conclusion
+
+What did we achieve now?<br>
+
+We created a dice-based seed in SeedSigner and set up a wallet using this seed in Sparrow wallet (as this is what a seed is used for).<br><br>
+We double-checked in two different web tools implementing different methods for seed creation that what SeedSigner generates perfectly matches up with what the other tools calculate based on the same dice entropy used.<br>
+
+So congratulations if the fingerprints, zpubs and addresses all match up in your example so you can be much more confident that nothing is wrong with your generated seed.
 
-### Epilogue
-You can use these methods to do dry run time to time to verify that no one has changed the micro sdcard. But do not use the generated 24 words as a valid wallet, they need to be generated alone, only on the seedsigner!

docs/manual_installation.md

@@ -215,6 +215,13 @@ workon seedsigner-env
 pwd
 ```
 
+### Optional: increase spidev buffer size
+This allows `ST7789.py` to update the LCD without performing multiple write operations because the default buffer size is 4096 bytes. The default can be changed via the  `/boot/cmdline.txt` file. You will need to add `spidev.bufsiz=131072` to the end of this single lined file command.
+
+Example `cmdline.txt` contents:
+```
+console=serial0,115200 console=tty1 root=PARTUUID=2fa4ba7e-02 rootfstype=ext4 elevator=deadline fsck.repair=yes rootwait modules-load=dwc2,g_ether spidev.bufsiz=131072
+```
 
 ### Configure `systemd` to run SeedSigner at boot:
 

src/seedsigner/gui/screens/scan_screens.py

@@ -44,7 +44,7 @@ class ScanScreen(BaseScreen):
     decoder: DecodeQR = None
     instructions_text: str = "< back  |  Scan a QR code"
     resolution: tuple[int,int] = (480, 480)
-    framerate: int = 5  # TODO: alternate optimization for Pi Zero 2W?
+    framerate: int = 6  # TODO: alternate optimization for Pi Zero 2W?
     render_rect: tuple[int,int,int,int] = None
 
 

src/seedsigner/hardware/ST7789.py

@@ -159,13 +159,11 @@ class ST7789(object):
         pix = arr.tobytes()
         self.SetWindows ( 0, 0, self.width, self.height)
         GPIO.output(self._dc,GPIO.HIGH)
-        for i in range(0,len(pix),4096):
-            self._spi.writebytes(pix[i:i+4096])		
+        self._spi.writebytes2(pix)	
         
     def clear(self):
         """Clear contents of image buffer"""
         _buffer = [0xff]*(self.width * self.height * 2)
         self.SetWindows ( 0, 0, self.width, self.height)
         GPIO.output(self._dc,GPIO.HIGH)
-        for i in range(0,len(_buffer),4096):
-            self._spi.writebytes(_buffer[i:i+4096])		
+        self._spi.writebytes2(_buffer)	

src/seedsigner/views/psbt_views.py

@@ -74,9 +74,9 @@ class PSBTSelectSeedView(View):
             from seedsigner.views.scan_views import ScanView
             return Destination(ScanView)
 
-        elif button_data[selected_menu_num] in [self.TYPE_12WORD, self.TYPE_24WORD]:
+        elif self.button_data[selected_menu_num] in [self.TYPE_12WORD, self.TYPE_24WORD]:
             from seedsigner.views.seed_views import SeedMnemonicEntryView
-            if button_data[selected_menu_num] == self.TYPE_12WORD:
+            if self.button_data[selected_menu_num] == self.TYPE_12WORD:
                 self.controller.storage.init_pending_mnemonic(num_words=12)
             else:
                 self.controller.storage.init_pending_mnemonic(num_words=24)