From nobody Wed Oct 05 14:25:26 2022 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4MjH0k5Fz0z4fKdk for ; Wed, 5 Oct 2022 14:25:26 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4MjH0k4jFpz3ZN7; Wed, 5 Oct 2022 14:25:26 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1664979926; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=TH73omTJZDXXjMLgP8T8VPu9hp+KdH3Zx3XiJK0yj/g=; b=uTvpr25LI59MHL+29zDJc+FueOE3ecn0JRs1I9wdEYsSvVrY+xALGW6C5+Y+VDgtBMx6hN cdLDpRkJ6ZmoVcmUvQ0sVTjRORUN/pGIZgFg7pSctckAW8tA5jKcB/JU6BK2YyiARk8ggp 5lTdrPjQp6ijZlsjTNFpzYa+hq/4eDkK5hY+61cZizyHL3lSNthTfFMbxyKJMkmhNSOcee W5SSiEO88fRvxN0d7IQL5QE6FuBTX6EOYv2UvrkeOanQ1kMoKAnxXytwp9ioQGDEd247zG enZRmV6lmgLWd4bXfDZLOEJ0PYSnL33Wa+kGLDakujkVKEi1fiULAWsVXY1kMg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4MjH0k3kp7zwMb; Wed, 5 Oct 2022 14:25:26 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 295EPQeF090975; Wed, 5 Oct 2022 14:25:26 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 295EPQoW090974; Wed, 5 Oct 2022 14:25:26 GMT (envelope-from git) Date: Wed, 5 Oct 2022 14:25:26 GMT Message-Id: <202210051425.295EPQoW090974@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Benedict Reuschling Subject: git: b76576673c - main - Fix checksum file names and verification instructions List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: bcr X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: b76576673c76dfc9c2b4a098bb6651b37e97fdf6 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1664979926; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=TH73omTJZDXXjMLgP8T8VPu9hp+KdH3Zx3XiJK0yj/g=; b=Cz2XL/MVpuu76Trmpn9XBIbCcdAm/mwIQigyOBSnphE46Jo6OHRaU8KyqZO2P2sy1c3PW+ V60Xzp23GYObecdRE6m2qkWyeh2R9twVzeYbv0teq/hQ+fU1Zex7+om2/4OdSkIh/XyLG5 zYRyvTThOkkMz1p+3wbiaUJhxwU8xS9ZhnytaykRCZvRRRo4Lf3YIhQt0JIzTNtoIxnfE8 Z90/9Sd8JL233H9A/Jrd4EmopImTreLMS3YN0H8tbbMuN3AtyAT9fLyjVKSI/vIQ+7hBnF Npm2OsUBowxo+p4GseG4QTKEQ4sQmnBaxXdqkGQ5DQLJTUyewt+wPR1ASW7w2A== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1664979926; a=rsa-sha256; cv=none; b=lBkMatejKayJxKuIaQm3l9t4+yh71tFBdGib0VaNSQydd/7HCLdGsFxKSs9q4ZtyCgHx/A WaSggKVh3PIm4PPb1XR/20EifcDvkDu06WZ4EByl3qKfF3vOyESha1tiopclPhWvZu0B1w 5yon3eHgGPLtwfEwOgo6n32bfDAiXt5zADGlEDOHfYHJJvP6cozHfgywlDqUcPqrS2UYzy xX9SASGCJLGlZtIIp9Ae5m51ZjWLTw9zHz3yHSsOgVfjbx308C0P1MfnnqqYO1Z+ztBcBB /haBcxf6BA8xSdyNqqAfotFIfJrJM/IMbkEMrWNk7u5GPgiQ5bfP5kGFTdiupA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by bcr: URL: https://cgit.FreeBSD.org/doc/commit/?id=b76576673c76dfc9c2b4a098bb6651b37e97fdf6 commit b76576673c76dfc9c2b4a098bb6651b37e97fdf6 Author: Benedict Reuschling AuthorDate: 2022-10-05 14:16:21 +0000 Commit: Benedict Reuschling 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 <>. -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.