git: b76576673c - main - Fix checksum file names and verification instructions
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Wed, 05 Oct 2022 14:25:26 UTC
The branch main has been updated by bcr:
URL: https://cgit.FreeBSD.org/doc/commit/?id=b76576673c76dfc9c2b4a098bb6651b37e97fdf6
commit b76576673c76dfc9c2b4a098bb6651b37e97fdf6
Author: Benedict Reuschling <bcr@FreeBSD.org>
AuthorDate: 2022-10-05 14:16:21 +0000
Commit: Benedict Reuschling <bcr@FreeBSD.org>
CommitDate: 2022-10-05 14:16:21 +0000
Fix checksum file names and verification instructions
Explain how to find and verify the checksum algorithms provided with
each release. Also mention the use of shasum tools and give a small
usage example.
I slighly modified the original submission to use FreeBSD 13.1 in the
example. In other instances, simplify wording a bit to not repeat words
too often within a sentence.
PR: 266692
Event: Aberdeen Hackathon 2022
---
.../content/en/books/handbook/bsdinstall/_index.adoc | 19 +++++++++++++++----
1 file changed, 15 insertions(+), 4 deletions(-)
diff --git a/documentation/content/en/books/handbook/bsdinstall/_index.adoc b/documentation/content/en/books/handbook/bsdinstall/_index.adoc
index 1d484132d7..07416739ea 100644
--- a/documentation/content/en/books/handbook/bsdinstall/_index.adoc
+++ b/documentation/content/en/books/handbook/bsdinstall/_index.adoc
@@ -222,12 +222,23 @@ File types:
* `-memstick.img`: This file contains all of the files needed to install FreeBSD, its source, and the Ports Collection. It should be burned to a USB stick using the instructions below.
* `-mini-memstick.img`: Like `-bootonly.iso`, does not include installation files, but downloads them as needed. A working internet connection is required during installation. Write this file to a USB stick as shown in <<bsdinstall-usb>>.
-After downloading the image file, download [.filename]#CHECKSUM.SHA256# from the same directory.
-Calculate a _checksum_ for the image file.
-FreeBSD provides man:sha256[1] for this, used as `sha256 _imagefilename_`.
+After downloading the image file, download at least one _checksum_ file from the same directory.
+There are two _checksum_ files available, named after the release number and the architecture name.
+For example: [.filename]#CHECKSUM.SHA256-FreeBSD-13.1-RELEASE-amd64# and [.filename]#CHECKSUM.SHA512-FreeBSD-13.1-RELEASE-amd64#.
+
+After downloading one of the files (or both), calculate the _checksum_ for the image file and compare it with the one shown in the _checksum_ file.
+Note that you need to compare the calculated _checksum_ against the correct file, as they correspond to two different algorithms: SHA256 and SHA512.
+FreeBSD provides man:sha256[1] and man:sha512[1] that can be used for calculating the _checksum_.
Other operating systems have similar programs.
-Compare the calculated checksum with the one shown in [.filename]#CHECKSUM.SHA256#.
+Verifying the _checksum_ in FreeBSD can be done automatically using man:sha256sum[1] (and man:sha512sum[1]) by executing:
+
+[source,shell]
+....
+% sha256sum -c CHECKSUM.SHA256-FreeBSD-13.1-RELEASE-amd64
+FreeBSD-13.1-RELEASE-amd64-dvd1.iso
+FreeBSD-13.1-RELEASE-amd64-dvd1.iso: OK
+....
The checksums must match exactly.
If the checksums do not match, the image file is corrupt and must be downloaded again.