Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme file - Update file verification section (to use keybase.io), clarify the download section, and other minor edits #285

Merged
merged 30 commits into from
Feb 27, 2023
Merged
Changes from 24 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
fa64a98
Update ReadmeFile - with initial small changes
Marc-Gee Dec 7, 2022
86a5d1f
A Heading change
Marc-Gee Dec 7, 2022
5a1bb41
minor spelling fixes
Marc-Gee Dec 7, 2022
4f910cf
Rewrite the software Download, & Verify sections
Marc-Gee Dec 7, 2022
69dc06c
Minor edits to download and veryify sections.
Marc-Gee Dec 7, 2022
1175ec4
Various Minor Language edits
Marc-Gee Dec 10, 2022
d57ea8c
Add sample images to PubKey verification section
Marc-Gee Dec 11, 2022
85fae7b
Formatting changes and updated verify Screenshots
Marc-Gee Dec 11, 2022
47fb9fe
Edits to the shasum command description
Marc-Gee Dec 12, 2022
b9649cb
Minor Edits
Marc-Gee Dec 12, 2022
76875f6
Minor edits and clarifications.
Marc-Gee Dec 12, 2022
d2a657f
Various edits B4 upstream submission
Marc-Gee Dec 12, 2022
923ce08
Various edits B4 Upstream commit
Marc-Gee Dec 12, 2022
fa8573c
Merge pull request #6 from Marc-Gee/dev
mauriciozuardi Dec 14, 2022
2318372
Update README.md
Marc-Gee Jan 9, 2023
3c43ea3
Updates to shorten the verification instructions
Marc-Gee Jan 29, 2023
7216a8d
Insert smaller (80pct sized) screenshots
Marc-Gee Jan 29, 2023
6154607
Improved Screenshots
Marc-Gee Jan 29, 2023
b04383d
Verification: Shortening, reordering & clarify
Marc-Gee Jan 29, 2023
a136a86
Fix Spelling, grammar and shasum command
Marc-Gee Jan 30, 2023
e1090ba
Fix SHASUM option flag typo --check
Marc-Gee Jan 31, 2023
d8de405
Inserted instructions on MicroSD writing.
Marc-Gee Feb 3, 2023
8575e4d
Micro SD Instructions
Marc-Gee Feb 16, 2023
50cf8dd
Inserted a table format for the different binaries
Marc-Gee Feb 17, 2023
081d24f
updated download table layout to 2 columns
Marc-Gee Feb 25, 2023
594751b
changes to file names in scripts/commands
Marc-Gee Feb 25, 2023
e225e05
Fixed TitleCase issues throughout document
Marc-Gee Feb 25, 2023
ac8ba47
Instructions added if: wifi component was physically removed
Marc-Gee Feb 25, 2023
6d535e9
Titlecase corrections to prior commit
Marc-Gee Feb 27, 2023
4fae69e
reorder download table and add tooltips
Marc-Gee Feb 27, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
171 changes: 143 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ If you have specific questions about the project, our [Telegram Group](https://t
### Considerations:
* Built for compatibility with Specter Desktop, Sparrow, and BlueWallet Vaults
* Device takes up to 60 seconds to boot before menu appears (be patient!)
* Always test your setup before transfering larger amounts of bitcoin (try testnet first!)
* Always test your setup before transferring larger amounts of bitcoin (try Testnet first!)
* Taproot not quite yet supported
* Slightly rotating the screen clockwise or counter-clockwise should resolve lighting/glare issues
* If you think SeedSigner adds value to the Bitcoin ecosystem, please help us spread the word! (tweets, pics, videos, etc.)
Expand Down Expand Up @@ -77,60 +77,175 @@ Notes:

# Software Installation

## Special Note on Minimizing Trust
## A Special Note On Minimizing Trust
As is the nature of pre-packaged software downloads, downloading and using the prepared SeedSigner release images means implicitly placing trust in the individual preparing those images; in our project the release images are prepared and signed by the eponymous creator of the project, SeedSigner "the person". That individual is additionally the only person in possession of the PGP keys that are used to sign the release images.
Copy link

@jdlcdl jdlcdl Dec 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"eponymous" becomes "anonymous"

" That individual is additionally" becomes " That individual is also" or " Additionally, that individual is"

Is it 'SeedSigner "the person"', or is it 'SeedSigner "the man"' ???


However, one of the many advantages of the open source software model is that the need for this kind of trust can be negated by our users' ability to (1) review the project's source code and (2) assemble the operating image necessary to use the software themselves. From our project's inception, instructions to build a SeedSigner operating image (using precisely the same process that is used to create the prepared release images) have been made availabile. We have put a lot of thought and work into making these instructions easy to understand and follow, even for less technical users. These instructions can be found [here](docs/manual_installation.md).

## Downloading the Software

The quickest and easiest way to install the software is to download the most recent "seedsigner_X_X_X.zip" file in the [software releases](https://github.com/SeedSigner/seedsigner/releases) section of this repository.

Download the current Version (0.6.0) software image that is compatible with your Raspberry Pi Hardware:
| Raspberry Pi Hardware | Source |
|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
| Pi Zero v1.3 or Pi Zero (W or WH) | [SeedSigner for R-Pi Zero V1.3](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/SeedSigner_OS.0.6.0.pi0.img) |
| Pi Zero **2** W | [SeedSigner for R-Pi Zero 2 W](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/SeedSigner_OS.0.6.0.pi02w.img) |
| Pi 2 (not a Pi *Zero* 2) | [SeedSigner for R-Pi 2](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/SeedSigner_OS.0.6.0.pi2.img) |
| Pi 3 | [SeedSigner for R-Pi 3](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/SeedSigner_OS.0.6.0.pi02w.img) |
Copy link

@jdlcdl jdlcdl Feb 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Im not sure that a binary for pi3 is planned. I've since learned via DT that pi02 and pi3 are same architecture.

| Pi 4 | [SeedSigner for R-Pi 4](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/SeedSigner_OS.0.6.0.pi04.img) |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this file will end in ".pi4.img", and I'm not at all certain about caps at all in the file's basename.


After downloading the .zip file, extract the seedsigner .img file, and write it to a MicroSD card (at least 4GB in size or larger). Then install the MicroSD in the assembled hardware and off you go.
**and also download** these 2 signature verification files
[Plaintext Manifest File](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/seedsigner_0_6_0.img.sha256)
[Signed Mainifest File](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/seedsigner_0_6_0.img.sha256.sig)

## Verifying the Software
You can verify the data integrity and authenticity of the latest release with as little as three commands. This process assumes that you know [how to navigate on a terminal](https://terminalcheatsheet.com/guides/navigate-terminal) and have navigated to the folder where you have these four relevant files present: (This will most likely be your Downloads folder.)
**Note:** The version numbers of the latest files will be higher than this example, but the naming format will be the same.
Once the files have all finished downloading, follow the steps below to verify the download before continuing on to write the software onto a MicroSD card. Next, insert the MicroSD into your assembled hardware and connect the USB power. Allow about 45 seconds for our logo to appear, and then you can begin using your Seedsigner!

* seedsigner_pubkey.gpg (from the main folder of this repo)
* seedsigner_0_4_6.img.zip (from the software release)
* seedsigner_0_4_6.img.zip.sha256 (from the software release)
* seedsigner_0_4_6.img.zip.sha256.sig (from the software release)
Previous software versions are available [here](https://github.com/SeedSigner/seedsigner/releases). Choose a specific version and the expand the *Assets* sub-heading to download the .img file binary and also the 2 associated signature files .

**Note:** The specific version number of the files in your folder might not match the above exactly, but their overall format and amount should be the same.

This process also assumes you are running the commands from a system where both [GPG](https://gnupg.org/download/index.html) and [shasum](https://command-not-found.com/shasum) are installed and working.
## Verifying that the downloaded files are authentic (optional but highly recommended!)

You can quickly verify that the software you just downloaded is both authentic and unaltered, by following these instructions.
We assume you are running the commands from a computer where both [GPG](https://gnupg.org/download/index.html) and [shasum](https://command-not-found.com/shasum) are already installed, and that you also know [how to navigate on a terminal](https://terminalcheatsheet.com/guides/navigate-terminal).


### Step 1. Verify that the signature (.sig) file is genuine:

Run GPG's *fetch-keys* command to import the SeedSigner projects public key from the popular online keyserver called *Keybase.io*, into your computers *keychain*.


First make sure that the public key is present in your keychain:
```
gpg --import seedsigner_pubkey.gpg
```
This command will import the public key, or return:
```
key <...> not changed
gpg --fetch-keys https://keybase.io/SeedSigner/pgp_keys.asc
```
The result should confirm that 1 key was *either* imported or updated. *Ignore* any key ID's or email addresses shown.

![SS - Keybase PubKey import with Fingerprint shown (New import or update of the key)](https://user-images.githubusercontent.com/91296549/174248861-7961c038-1fbf-47a1-a110-146cb218b1c8.jpg)

Now you can verify the authenticity of the small text file containing the release's SHA256 hash with the command:
Next, you will run the *verify* command on the signature (.sig) file. (*Verify* must be run from inside the same folder that you downloaded the files into earlier. The `*`'s in this command will auto-fill the version from your current folder, so it should be copied and pasted as-is.)
```
gpg --verify seedsigner_0_*_*.img.zip.sha256.sig
```
**Note:** The `*`s in the command above allow the terminal to auto-populate the command with the version number you have in the folder you are in. It should be copied and pasted as is.

The reponse to this command should include the text:
When the verify command completes successfully, it should display output like this:
<BR>
![SS - Verify Command - GPG on Linux - Masked_v3-80pct](https://user-images.githubusercontent.com/91296549/215339119-5326e814-1d60-47bb-980c-1498a2f30baf.jpg)
The result must display "**Good signature**". Ignore any email addresses - *only* matching Key fingerprints count here. Stop immediately if it displays "*Bad signature*"!
<BR>

On the *last* output line, look at your *rightmost* 16 characters (the 4 blocks of 4).
**Crucially, we must now check WHO that Primary key fingerprint /ID belongs to.** We will start by looking at Keybase.io to see if it is the *Seedsigner project* 's public key or not.

<details><summary> About the warning message:</summary>
<p> Since you are about to match the outputted fingerprint/ID against the proofs at Keybase.io/seedsigner, and thereby confirm who the pubkey really belongs to-, you can safely ignore this warning message:

```
Good signature from "seedsigner <btc.hardware.solutions@gmail.com>" [unknown]
> WARNING: This key is not certified with a trusted signature!
> There is no indication that the signature belongs to the owner.
```
</p>
</details>
<br>

<details><summary> More about how the verify command works:</summary>
<p>
The verify command will attempt to decrypt the signature file (sha256.sig) by trying each public key already imported into your computer. If the public key we just imported (via fetch-keys), manages to: (a) successfully decrypt the .sig file , and (b), that result matches exactly to the clear-text equivalent (.sha256) of the .sig file, then its "a good signature"!

Crucially, we must still manually check who *exactly* owns the Key ID which gave us that "Good signature". Thats what the warning message means- Who does the matching key really belong to? We will start by looking at keybase.io to see if it is "The Seedsigner project"'s public Key or not.
Note that it is the file hashes of .sig and .sha256 that *verify* compares, not their raw contents.

</p>
</details>
<br>

Now to determine ***who*** the Public key ID belongs to: Goto [Keybase.io/seedsigner](www.keybase.io/seedsigner)
<BR>
![SS - Keybase Website PubKey visual matching1_Cropped-80pct](https://user-images.githubusercontent.com/91296549/215326193-97c84e35-5570-4e52-bf3f-e86d367c8908.jpg)



**You must now *manually* compare: The 16 character fingerprint ID (as circled in red above) to, those *rightmost* 16 characters from your *verify* command.**

**If they match exactly, then you have successfully confirmed that your .sig file is authentically from the Seedsigner Project!**
<BR>

<details><summary>Learn more about how keybase.io helps you check that someone (online) is who they say they are:</summary>
<p>
Keybase.io allows you to independently verify that the public key saved on Keybase.io, is both authentic and that it belongs to the organization it claims to represent.
Keybase has already checked the three pubkey file locations cryptographically when they were saved there. You can further verify the key publications if you would like:

- *via Keybase*: By clicking on any of the three blue badges to see that the "proof" was published at that location. (The blue badge marked as tweet, is in the most human-readable form and it is also a bi-directional link on Twitter)
or,
- *without keybase (out-of-band)*: By using these 3 links directly: [Twitter](https://twitter.com/seedsigner/status/1530555252373704707), [Github](https://gist.github.com/SeedSigner/5936fa1219b07e28a3672385b605b5d2) and [Seedsigner.com](https://seedsigner.com/keybase.txt). This method can be used if you would like to make an even deeper, independent inspection without relying on Keybase at all, or if the Keybase.io site is no longer valid or it is removed entirely.

Once you have used one of these methods, you will know if the Public Key stored on Keybase, is genuinely from the SeedSinger Project or not.
</p>
</details>
<br>

If the two ID's do *not* match, then you must stop here immediately. Do not continue. Contact us for assistance in the Telegram group address above.

<br>

### Step 2. Verifying that the *software images/binaries* are genuine

Now that you have confirmed that you do have the real Seedsigner Project's Public Key (ie the 16 characters match) - you can return to your terminal window. Running the the *shasum* command, is the final verification step and will confirm (via file hashing) that the software code/image files (ie the binary files inside the zip file), were also not altered since publication, or even during your download process.

**On Linux or OSX:** Run this command
```
shasum -a 256 --ignore-missing --check seedsigner_0_*_*.img.zip.sha256
```
The previous command validates that aforementioned small text file was signed using the private key that matches the published public key associated with the project (an early timestamped record of this public/private key's creation can be found in this [tweet](https://twitter.com/SeedSigner/status/1389617642286329856?s=20)).

The last step is to make sure the .zip file that you've downloaded, and that contains the released software, is a perfect match to the software that was published by the holder of the private key in the last step. The command for this step is:
**On Windows (inside Powershell):** Run this command
```
shasum -a 256 -c seedsigner_0_*_*.img.zip.sha256
CertUtil -hashfile seedsigner_0_*_*.img.zip SHA256 | findstr /v "hash"
```
The reponse to this command should include the text:
On Windows, you must manually compare the above resulting hash value to the corresponding hash value shown inside the .SHA256 cleartext file.
<BR>

Wait about 30 seconds for the command to complete, and it should display:
```
seedsigner_0_4_6.img.zip: OK
seedsigner_0_5_x.img.zip: OK
shasum: WARNING: 4 Lines are improperly formatted
```
**If you receive the "OK" message** for your **seedsigner_[x.x.x.VersionNumber].img.zip file**, as shown above, then your verification is fully complete!
**All of your downloaded files have now been confirmed as both authentic and unaltered!** You can proceed to create/write your MicroSD card😄😄 !!

The warning message describing '4 lines being improperly formatted' can be safely ignored.
If your file result shows "FAILED", then you must stop here immediately. Do not continue. Contact us for assistance at the Telegram group address above.

<BR>

Please recognize that this process can only validate the software to the extent that the entity that first published the key is an honest actor, and their private key is not compromised or somehow being used by a malicious actor.
<BR>
<BR>


## Writing the software onto your MicroSD card

To write the SeedSigner software onto your MicroSD card, there are a few options available:
| Application | Description | Platform and official Source |
|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
| Balena Etcher | The application is called Etcher, and the company that wrote it is called Balena. Hence *Etcher by Balena* or *Balena Etcher* | [Available for Windows, Mac and Linux](https://www.balena.io/etcher#download-etcher) |
| Raspberry Pi Imager | Produced by the Raspberry Pi organization. | [Available for Windows, Mac and Linux](https://www.raspberrypi.com/software/) |
| DD Command Line Utility | Built-in to Linux and MacOS, the DD (Data Duplicator) is a tool for advanced users. If not used carefully it can accidentally format the incorrect disk! | Built-in to Linux and MacOS |

Be sure to download the software from the genuine publisher.
Either of the Etcher or Pi Imager software is recommended. Some seedsigner users have reported a better experience with one or the other. So, if the one application doesn’t work well for your particular machine, then please try the other one.
<BR>
### **General Considerations:**
Make sure to set any write-protection physical slider on the MicroSD Card Adapter to UN-locked.
You *dont* need to unzip the .zip file beforehand. You also don’t need to pre-format the MicroSD beforehand.
Current Etcher and Pi Imager software will perform a verify action (by default) to make sure the card was written successfully! Watching for that verify step to complete successfully can save you a lot of headaches if you later need to troubleshoot issues where your seedsigner device doesn’t boot up at power on.
Writing the MicroSd card is also known as flashing.
It will overwrite everything on the MicroSD card.
If the one application fails for you, then please try again using our other recommended application.
Advanced users may want to try the Linux/MacOS *DD* command instead of using Etcher or Pi Imager, however, a reminder is given that DD can overwrite the wrong disk if you are not careful !
#### **Specific considerations for Windows users:**
Windows can sometimes flag the writing of a MicroSD as risky behaviour and hence it may prevent this activity. If this happens, your writing/flashing will fail, hang or wont even begin, in which case you should to try to run the Etcher/Pi-Imager app "As administrator", (right-click and choose that option). It can also be blocked by windows security in some cases, so If you have the (non-default) *Controlled Folder Access* option set to active, try turning that *off* temporarily.



There are other steps you can take to verify the software, including examining the hash value in the .sha256 text file, but this one has been documented here because it seems the simplest for most people to follow. Please recognize that this process can only validate the software to the extent that the entity that first published the key is an honest actor, and assumes the private key has remained uncompromised and is not being used by a malicious actor.

---------------

Expand Down