Skip to content

Commit 196edd3

Browse files
MVrachevgcmurphy
authored andcommitted
Add checksum clarification in README
Currently, if you download the gosec binary using the commands suggested in the README and you decide to check the checksum of the binary, you just downloaded then your checksum check will fail. As a result, the user can think that your binary is corrupted. The reason for that failure is that the checksums are for the tar.gz files provided in the release notes. This should be documented to avoid future unclarities. Signed-off-by: Martin Vrachev <[email protected]>
1 parent 0ebfa2f commit 196edd3

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ curl -sfL https://raw.githubusercontent.com/securego/gosec/master/install.sh | s
3636
# In alpine linux (as it does not come with curl by default)
3737
wget -O - -q https://raw.githubusercontent.com/securego/gosec/master/install.sh | sh -s vX.Y.Z
3838

39+
# If you want to use the checksums provided on the "Releases" page
40+
# then you will have to download a tar.gz file for your operating system instead of a binary file
41+
wget https://github.com/securego/gosec/releases/download/vX.Y.Z/gosec_vX.Y.Z_OS.tar.gz
42+
43+
# The file will be in the current folder where you run the command
44+
# and you can check the checksum like this
45+
echo "<check sum from the check sum file> gosec_vX.Y.Z_OS.tar.gz" | sha256sum -c -
46+
3947
gosec --help
4048
```
4149

0 commit comments

Comments
 (0)