Skip to content

Commit

Permalink
Docs tools text changes + descriptor addresses img
Browse files Browse the repository at this point in the history
  • Loading branch information
tadeubas committed Dec 24, 2024
1 parent a49f7d0 commit 37de82f
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 15 deletions.
28 changes: 13 additions & 15 deletions docs/getting-started/features/tools.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,40 +27,37 @@ Enter text to create, print or transcribe a QR code that can later be used as an

<div style="clear: both"></div>

### Descriptor Addresses
### Descriptor Addresses (Wallet Sans Key)
<img src="../../../img/maixpy_m5stickv/descriptor-addresses-125.png" align="right">
<img src="../../../img/maixpy_amigo/descriptor-addresses-150.png" align="right">

Verify if an address or list of addresses belong to a wallet without needing to load private keys. Simply load a trusted wallet descriptor from a QR code or SD card.

<div style="clear: both"></div>

### Flash Tools
Tools to inspect the content of device's flash memory and clear user's area

<img src="../../../img/maixpy_m5stickv/flash-tools-125.png" align="right">
<img src="../../../img/maixpy_amigo/flash-tools-150.png" align="right">

Tools to inspect the content of device's flash memory and clear user's area.

<div style="clear: both"></div>

#### Flash Map
<img src="../../../img/maixpy_m5stickv/flash-map-125.png" align="right">
<img src="../../../img/maixpy_amigo/flash-map-150.png" align="right">

Flash map indicates which memory blocks (4086 Bytes each) are empty. Memory is separated in two regions: Firmware and User's Data. White or colored blocks contain data, while grey blocks are empty.

This is an interesting tool to visualize the effects of filling the memory with ramdom entropy, what is done during the setup of a new `TC Code`, used with `TC Flash Hash` tool, described below.

<img src="../../../img/maixpy_m5stickv/flash-map-125.png" align="right">
<img src="../../../img/maixpy_amigo/flash-map-150.png" align="right">

<div style="clear: both"></div>

#### TC Flash Hash
*Tamper Check Flash Hash* is a tamper detection mechanism that enables you to verify if the flash memory content has been altered. To use it first, need to create a `TC Code` on `Settings -> Security -> Tamper Check Code`.
*TC Flash Hash* will hash this code, K210 chip's unique ID and the content of the whole flash memory together and produce an image.
The tool generates a unique image and four tamper detection words based on a hash of your *TC Code*, the device's UID, and the flash content. The flash memory is divided into two regions:

- **Firmware Region:** Generates the image and the first two words.
*Tamper Check (TC) Flash Hash* is a tamper detection mechanism that enables you to verify if the flash memory content has been altered. To use it first, need to create a *Tamper Check (TC) Code* on `Settings -> Security -> Tamper Check Code`.
*TC Flash Hash* will hash *TC Code*, K210 chip's unique ID and the content of the whole internal flash creating a tamper indicator that is unique to each device, represented by a memorable image and two sets of two words.

- **User's Region:** Generates the last two words.

Learn more about *Tamper Check Flash Hash* on [Tamper Detection](tamper-detection.md)
More information on [Tamper Detection page](tamper-detection.md).

#### Erase User's Data
<img src="../../../img/maixpy_m5stickv/erase-data-125.png" align="right">
Expand All @@ -70,7 +67,6 @@ This option permanently removes all stored encrypted mnemonics, settings and `TC

<div style="clear: both"></div>


### Remove Mnemonic
<img src="../../../img/maixpy_m5stickv/load-mnemonic-storage-options-125.png" align="right">
<img src="../../../img/maixpy_amigo/load-mnemonic-storage-options-150.png" align="right">
Expand All @@ -80,3 +76,5 @@ This option allows you to remove any stored encrypted mnemonic from the device's
When mnemonics are removed from the device's flash memory, Krux will no longer be able to access them. However, as with most operating systems, the data may still be recoverable using specialized tools. If you stored any important keys with a [weak encryption key](https://www.hivesystems.com/blog/are-your-passwords-in-the-green), it is recommended to use the "Wipe Device" feature below to ensure that the data is irrecoverable.

When mnemonics are removed from an SD card, Krux will overwrite the region where the encrypted mnemonic was stored with empty data. This makes it more secure to delete mnemonics from SD cards using Krux rather than a PC or another device. However, Krux does not have a "Wipe" feature for SD cards; you can find this feature in third-party applications.

<div style="clear: both"></div>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions simulator/generate-device-screenshots.sh
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ poetry run poe simulator --sequence sequences/tools-check-sd.txt --sd --device
poetry run poe simulator --sequence sequences/tools-create-QR.txt --sd --device $device
poetry run poe simulator --sequence sequences/tools-mnemonic.txt --sd --device $device
poetry run poe simulator --sequence sequences/tools-print-test-qr.txt --sd --device $device
poetry run poe simulator --sequence sequences/tools-descriptor-addresses.txt --sd --device $device
poetry run poe simulator --sequence sequences/tools-flash.txt --sd --device $device

# Settings
Expand Down
11 changes: 11 additions & 0 deletions simulator/sequences/tools-descriptor-addresses.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
include _wait-for-logo.txt

# Navigate to Tools
x3 press BUTTON_B
press BUTTON_A

# Descriptor Addresses
x3 press BUTTON_B
press BUTTON_A

screenshot descriptor-addresses.png

0 comments on commit 37de82f

Please sign in to comment.