Skip to content

Commit

Permalink
Added doc on download verification
Browse files Browse the repository at this point in the history
  • Loading branch information
JanMosigItemis committed Jul 4, 2019
1 parent 0fcf249 commit 84543f9
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 2 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ The scripts do also feature a fully automatic heuristic for finding and setting
* [Linux](#linux)
* [Mac](#mac)
- [Download](#download)
* [Verifying The Download](#verifying-the-download)
- [Usage](#usage)
* [Windows](#windows-1)
+ [Start here: Key generation & Yubikey setup (all in one script)](#start-here-key-generation--yubikey-setup-all-in-one-script)
Expand Down Expand Up @@ -64,6 +65,35 @@ Use the *GnuPG* package provided with your distribution or follow the instructio
# Download
[https://github.com/JanMosigItemis/yubiset/releases](https://github.com/JanMosigItemis/yubiset/releases)

## Verifying The Download
Every release comes as a zip file of the form `yubiset_[TAG].[TIMESTAMP].zip`.

The file is accompanied by the [SHA-512](https://en.wikipedia.org/wiki/SHA-2) hash code of the zip stored into `[ZIP_FILE_NAME].sha512`. You may verify the hash code of your download like this:
```
# This makes sure, you downloaded an exact copy of the release from GitHub.
sha512sum -c yubiset_vt.t.t.test.201907042021.sha512
yubiset_vt.t.t.test.201907042021.zip: OK # This is the supposed output.
```

There is a third file called `[ZIP_FILE_NAME].sha512.gpg`. This can be used to verify that the hash code has not been tempered with. The verification is done via [GPG](https://en.wikipedia.org/wiki/GNU_Privacy_Guard) like this:
```
gpg --verify yubiset_vt.t.t.test.201907042021.sha512.gpg
gpg: Signature made 07/04/19 20:21:11 W. Europe Daylight Time
gpg: using RSA key 0xE9EC6651133A788F
gpg: Good signature from "Jan Mosig itemis GitHub Signing Key (Signing key for GitHub release artifacts of JanMosigItemis) <ja
[email protected]>" [ultimate]
Primary key fingerprint: DFC5 B2E2 74B5 A83E DC56 2A48 3622 572E E5F1 E2D4
Subkey fingerprint: BE63 6888 FDA6 4B7C E7F7 1BF7 E9EC 6651 133A 788F
```

If you perform both steps, there is a very high chance that your download is legit.

In case you are missing my public GitHub signing key, you can download it here: https://gist.github.com/JanMosigItemis/ce1ffd36a4ab860962009f7a9a6ff2ec. Unzip the file and import the key like this:
```
gpg --import JanMosigItemisGitHub.asc
```

# Usage

## Windows
Expand Down
2 changes: 1 addition & 1 deletion unix/bash/lib/bootstrap.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ end_with_error()
exit 1
}

if [[ -z "${yubiset_version}" ]] ; then declare -r yubiset_version="0.3.0" ; fi
if [[ -z "${yubiset_version}" ]] ; then declare -r yubiset_version="0.3.1" ; fi
if [[ -z "${me}" ]] ; then declare -r me="$(basename $0)" ; fi

# https://stackoverflow.com/questions/630372/determine-the-path-of-the-executing-bash-script
Expand Down
2 changes: 1 addition & 1 deletion windows/batch/lib/bootstrap.bat
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ REM Arg 1: Full path to caller script
REM Arg 2: Full path to yubiset windows script folder
REM

set yubiset_version=0.4.1
set yubiset_version=0.4.2
set me=%~1
set root_folder=%~2..\..
set error_prefix=ERROR
Expand Down

0 comments on commit 84543f9

Please sign in to comment.