Simplify versioning system for user guides
This new approach doesn't require version numbers and make easier for contributors to understand the status
of the document. There are only 3 states:
- Outdated: The page is outdated and might not work as expected
- Untranslated: The page needs to be translated
- Translation outdated: The page is translated, but the original (English) document has been updated
To mark a guide as outdated, we change the boolean of the front matter entry 'outdated' in /resources/user-guides/GUIDE.
If 'False', the guide is updated. If 'True' all versions of the guide (English included) will show a warning at the bottom
of the page.
The other 2 states are related to the status of the translated pages and we control them from the language-specific
user guides: /_i18n/LANG/resources/user-guides/GUIDE. At the top of the page a snippet will include 2 parameters:
- translated: "yes" if the page is translated, "no" if it's not.
- translationOutdated: "yes" if the translation is outdated, "no" if it's not
This new system aims to be simpler than the precedent, avoiding to compare versioning numbers and using a higher level
system instead (yes, no, True, False). I also removed the middle way status 'only minor changes', because if there are
only minor changes that don't affect the usability of the guide, we don't need to point it out.
The old system was complex and people didn't use it. These changes will hopefully make things easier for translators and
other contributors.
2020-05-03 13:38:01 +00:00
|
|
|
{% include disclaimer.html translated="no" translationOutdated="no" %}
|
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
Verification of the Monero binary files should be done prior to extracting,
|
|
|
|
installing, or using the Monero software. This is the only way to ensure
|
|
|
|
that you are using the official Monero software. If you receive a fake
|
|
|
|
Monero binary (eg. phishing, MITM, etc.), following this guide will protect
|
|
|
|
you from being tricked into using it.
|
|
|
|
|
|
|
|
To protect the integrity of the binaries the Monero team provides a
|
|
|
|
cryptographically signed list of all the
|
|
|
|
[SHA256](https://en.wikipedia.org/wiki/SHA-2) hashes. If your downloaded
|
|
|
|
binary has been tampered with it will be produce a [different
|
|
|
|
hash](https://en.wikipedia.org/wiki/File_verification) than the one in the
|
|
|
|
file.
|
|
|
|
|
|
|
|
This is an advanced guide for Linux, Mac, or Windows operating systems and
|
|
|
|
will make use of the command line. It will walk you through the process of
|
|
|
|
installing the required software, importing the signing key, downloading the
|
|
|
|
necessary files, and finally verifying that your binary is authentic.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
## Table of Contents:
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
### - [Install GnuPG](#installing-gnupg)
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
### - [Verify & Import Signing Key](#verify-and-import-signing-key)
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
### - [Download & Verify Hash File](#download-and-verify-hash-file)
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
### - [Download & Verify Binary](#download-and-verify-binary)
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
## Installing GnuPG
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
+ On Windows, go to the [Gpg4win download
|
|
|
|
page](https://gpg4win.org/download.html) and follow the instructions for
|
|
|
|
installation.
|
|
|
|
|
|
|
|
+ On Mac, go to the [Gpgtools download page](https://gpgtools.org/) and
|
|
|
|
follow the instructions for installation.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
|
|
|
+ On Linux, GnuPG is installed by default.
|
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
## Verify and Import Signing Key
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
This section will cover getting the Monero signing key, making sure it is
|
|
|
|
correct, and importing the key to GnuPG.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
### Get Signing Key
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
On Windows or Mac, go to [binaryFate's GPG
|
|
|
|
key](https://raw.githubusercontent.com/monero-project/monero/master/utils/gpg_keys/binaryfate.asc),
|
|
|
|
which he uses to sign the Monero binaries, and save the page as
|
|
|
|
`binaryfate.asc` to your home directory.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
On Linux, you can download binaryFate's signing key by issuing the following
|
|
|
|
command:
|
2019-04-24 15:04:56 +00:00
|
|
|
|
|
|
|
```
|
2021-05-22 12:52:40 +00:00
|
|
|
wget -O binaryfate.asc
|
|
|
|
https://raw.githubusercontent.com/monero-project/monero/master/utils/gpg_keys/binaryfate.asc
|
2019-04-24 15:04:56 +00:00
|
|
|
```
|
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
### Verify Signing Key
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
On all operating systems, check the fingerprint of `binaryfate.asc` by
|
|
|
|
issuing the following command in a terminal:
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
``` gpg --keyid-format long --with-fingerprint binaryfate.asc ```
|
2019-04-24 15:04:56 +00:00
|
|
|
|
|
|
|
|
|
|
|
Verify the fingerprint matches:
|
|
|
|
|
|
|
|
```
|
2020-04-17 09:46:11 +00:00
|
|
|
pub rsa4096/F0AF4D462A0BDF92 2019-12-12 [SCEA]
|
|
|
|
Key fingerprint = 81AC 591F E9C4 B65C 5806 AFC3 F0AF 4D46 2A0B DF92
|
|
|
|
uid binaryFate <binaryfate@getmonero.org>
|
2019-04-24 15:04:56 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
If the fingerprint **DOES** match, then you may proceed.
|
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
If the fingerprint **DOES NOT** match, **DO NOT CONTINUE.** Instead delete
|
|
|
|
the file `binaryfate.asc` and go back to [section 2.1](#21-get-signing-key).
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
### Import Signing Key
|
2019-04-24 15:04:56 +00:00
|
|
|
|
|
|
|
From a terminal, import the signing key:
|
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
``` gpg --import binaryfate.asc ```
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
If this is the first time you have imported the key, the output will look
|
|
|
|
like this:
|
2019-04-24 15:04:56 +00:00
|
|
|
|
|
|
|
```
|
2020-04-17 09:46:11 +00:00
|
|
|
gpg: key F0AF4D462A0BDF92: 2 signatures not checked due to missing keys
|
|
|
|
gpg: key F0AF4D462A0BDF92: public key "binaryFate <binaryfate@getmonero.org>" imported
|
2019-04-24 15:04:56 +00:00
|
|
|
gpg: Total number processed: 1
|
|
|
|
gpg: imported: 1
|
2020-04-17 09:46:11 +00:00
|
|
|
gpg: marginals needed: 3 completes needed: 1 trust model: pgp
|
2019-04-24 15:04:56 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
If you have imported the key previously, the output will look like this:
|
|
|
|
|
|
|
|
```
|
2020-04-17 09:46:11 +00:00
|
|
|
gpg: key F0AF4D462A0BDF92: "binaryFate <binaryfate@getmonero.org>" not changed
|
2019-04-24 15:04:56 +00:00
|
|
|
gpg: Total number processed: 1
|
|
|
|
gpg: unchanged: 1
|
|
|
|
```
|
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
## Download and Verify Hash File
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
This section will cover downloading the hash file and verifying its
|
|
|
|
authenticity.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
### Get Hash File
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
On Windows or Mac, go to the [hashes file on getmonero.org]({{
|
|
|
|
site.baseurl_root }}/downloads/hashes.txt) and save the page as `hashes.txt`
|
|
|
|
to your home directory.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
On Linux, you can download the signed hashes file by issuing the following
|
|
|
|
command:
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
``` wget -O hashes.txt https://www.getmonero.org/downloads/hashes.txt ```
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
### Verify Hash File
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
The hash file is signed with key `81AC 591F E9C4 B65C 5806 AFC3 F0AF 4D46
|
|
|
|
2A0B DF92`, as reflected in the output below.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
On all operating systems, verify the signature of the hash file by issuing
|
|
|
|
the following command in a terminal:
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
``` gpg --verify hashes.txt ```
|
2019-04-24 15:04:56 +00:00
|
|
|
|
|
|
|
If the file is authentic, the output will look like this:
|
|
|
|
|
|
|
|
```
|
2020-04-17 09:46:11 +00:00
|
|
|
gpg: using RSA key 81AC591FE9C4B65C5806AFC3F0AF4D462A0BDF92
|
|
|
|
gpg: Good signature from "binaryFate <binaryfate@getmonero.org>" [unknown]
|
2019-04-24 15:04:56 +00:00
|
|
|
gpg: WARNING: This key is not certified with a trusted signature!
|
|
|
|
gpg: There is no indication that the signature belongs to the owner.
|
2020-04-17 09:46:11 +00:00
|
|
|
Primary key fingerprint: 81AC 591F E9C4 B65C 5806 AFC3 F0AF 4D46 2A0B DF92
|
2019-04-24 15:04:56 +00:00
|
|
|
```
|
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
If your output shows **Good signature**, as in the example, then you may
|
|
|
|
proceed.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
If you see **BAD signature** in the output, **DO NOT CONTINUE.** Instead
|
|
|
|
delete the file `hashes.txt` and go back to [section
|
|
|
|
3.1](#31-get-hash-file).
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
## Download and Verify Binary
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
This section will cover downloading the Monero binary for your operating
|
|
|
|
system, getting the `SHA256` hash of your download, and verifying that it is
|
|
|
|
correct.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
### Get Monero binary
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
On Windows or Mac, go to [getmonero.org]({{ site.baseurl_root }}/downloads/)
|
|
|
|
and download the correct file for your operating system. Save the file to
|
|
|
|
your home directory. **Do not extract the files yet.**
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
On Linux, you can download the command line tools by issuing the following
|
|
|
|
command:
|
2019-04-24 15:04:56 +00:00
|
|
|
|
|
|
|
```
|
2020-04-17 09:46:11 +00:00
|
|
|
wget -O monero-linux-x64-v0.15.0.1.tar.bz2 https://downloads.getmonero.org/cli/linux64
|
2019-04-24 15:04:56 +00:00
|
|
|
```
|
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
### Binary Verification on Linux or Mac
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
The steps for both Linux and Mac are the same. From a terminal, get the
|
|
|
|
`SHA256` hash of your downloaded Monero binary. As an example this guide
|
|
|
|
will use the `Linux, 64bit` GUI binary. Substitute
|
|
|
|
`monero-gui-linux-x64-v0.15.0.1.tar.bz2` with the name of the binary that
|
|
|
|
you downloaded in [section 4.1](#41-get-monero-binary).
|
2019-04-24 15:04:56 +00:00
|
|
|
|
|
|
|
```
|
2020-04-17 09:46:11 +00:00
|
|
|
shasum -a 256 monero-linux-x64-v0.15.0.1.tar.bz2
|
2019-04-24 15:04:56 +00:00
|
|
|
```
|
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
The output will look like this, but will be different for each binary
|
|
|
|
file. Your `SHA256` hash should match the one listed in the `hashes.txt`
|
|
|
|
file for your binary file.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
|
|
|
```
|
2021-05-22 12:52:40 +00:00
|
|
|
8d61f992a7e2dbc3d753470b4928b5bb9134ea14cf6f2973ba11d1600c0ce9ad
|
|
|
|
monero-linux-x64-v0.15.0.1.tar.bz2
|
2019-04-24 15:04:56 +00:00
|
|
|
```
|
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
If your hash **DOES** match, then you are finished with the guide! You can
|
|
|
|
extract the files and install.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
If your hash **DOES NOT** match, **DO NOT CONTINUE.** Instead delete the
|
|
|
|
binary you downloaded and go back to [section 4.1](#41-get-monero-binary).
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
### Binary Verification on Windows
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
From a terminal, get the `SHA256` hash of your downloaded Monero binary. As
|
|
|
|
an example this guide will use the `Windows, 64bit` GUI binary. Substitute
|
|
|
|
`monero-gui-win-x64-v0.15.0.1.zip` with the name of the binary that you
|
|
|
|
downloaded in [section 4.1](#41-get-monero-binary).
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
``` certUtil -hashfile monero-gui-win-x64-v0.15.0.1.zip SHA256 ```
|
2021-03-31 09:02:42 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
The output will look like this, but will be different for each binary
|
|
|
|
file. Your `SHA256` hash should match the one listed in the `hashes.txt`
|
|
|
|
file for your binary file.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
|
|
|
```
|
2021-05-22 12:52:40 +00:00
|
|
|
SHA256 hash of file monero-gui-win-x64-v0.12.0.0.zip: 4b 9f 31 68 6e ca
|
|
|
|
ad 97 cd b1 75 e6 57 4b f3 07 f8 d1 c4 10 42 78 25 f4 30 4c 21 da 8a ac 18
|
|
|
|
64 CertUtil: -hashfile command completed successfully.
|
2019-04-24 15:04:56 +00:00
|
|
|
```
|
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
If your hash **DOES** match, then you are finished with the guide! You can
|
|
|
|
extract the files and install.
|
2019-04-24 15:04:56 +00:00
|
|
|
|
2021-05-22 12:52:40 +00:00
|
|
|
If your hash **DOES NOT** match, **DO NOT CONTINUE.** Instead delete the
|
|
|
|
binary you downloaded and go back to [section 4.1](#41-get-monero-binary).
|