Issue 122905 - Checksum page has several mistakes
Summary: Checksum page has several mistakes
Status: CLOSED FIXED
Alias: None
Product: Infrastructure
Classification: Infrastructure
Component: Downloads (show other issues)
Version: current
Hardware: All All
: P3 Normal (vote)
Target Milestone: ---
Assignee: Marcus
QA Contact:
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-07-31 01:17 UTC by sebb
Modified: 2013-08-23 21:44 UTC (History)
1 user (show)

See Also:
Issue Type: DEFECT
Latest Confirmation in: ---
Developer Difficulty: ---


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description sebb 2013-07-31 01:17:12 UTC
The page http://www.openoffice.org/download/checksums.html has the title:

"How to verify downloads with checksum files?"

This is not strictly correct; .asc files are not checksums, they are (detached) signatures.
In fact nor are MD5 and SHA1 - they are hashes.

It would be better to call the page

"How to verify downloads"

The page also says:

gpg.exe --import openoffice.asc

That is wrong; it is the KEYS file that needs to be imported.

gpg.exe --verify <ASC file>.asc <AOO file>.exe

is also wrong; gpg automatically strips the .asc to determine which file to check.

It might be better to link to the ASF page at:

http://www.apache.org/dyn/closer.cgi#verify
Comment 1 Marcus 2013-07-31 22:46:49 UTC
taking over
Comment 2 SVN Robot 2013-08-01 21:23:58 UTC
"marcus" committed SVN revision 1509433 
#122905# Updated text
Comment 3 SVN Robot 2013-08-01 21:46:54 UTC
"marcus" committed SVN revision 1509437 
#122905# Updated text
Comment 4 SVN Robot 2013-08-01 21:48:55 UTC
"marcus" committed SVN revision 1509443 
#122905# Updated text
Comment 5 Marcus 2013-08-01 21:59:29 UTC
Thanks for looking at the text, I've fixed the mistakes.
Comment 6 sebb 2013-08-01 23:06:28 UTC
Thanks, however there are still some problems:

The following statement is not strictly true:

"A hash value processed on the downloaded file is a way to make sure that the content is authentic and was not manipulated by an unauthorized third party"

Hashes should only be used to check that a download has completed OK.
They are not suitable for content authentication.

The following sentence does not read well:
>>When both signatures match it is indicated with an "Good signature from <Person who has created the signature> statement.<<.

There is only one signature; "both" does not make sense here. It should probably read something like:

>>If the signature matches the file this is show by the message "Good signature from <Person who has created the signature>."<<

It is wrong to insist that Windows users download a specific hashing tool; there are lots of other tools that are suitable.

"Please try again a download to get a valid file." - should read:
"Please try the download again, and recheck. If the check still fails, try another browser if possible. Check also that the file size is correct."

"Please consult the respective help " => "Please consult the relevant help "

"Be aware that all mails do not go to a single person but a so-called mailing list." =>  "Please note that all mails go to a public mailing list, not an individual."

It would be helpful if the following text were actually a link:

http://www.apache.org/dist/openoffice/KEYS
Comment 7 SVN Robot 2013-08-02 19:10:40 UTC
"marcus" committed SVN revision 1509822 
#122905# Improved wording, suggested by sebb
Comment 8 Marcus 2013-08-02 19:15:38 UTC
> It is wrong to insist that Windows users download a specific hashing tool;
> there are lots of other tools that are suitable.

Yes, and for Linux/Mac there might be also other tools. But I think it's better to give an example than just to point to Google for searching them.

> "Please try again a download to get a valid file." - should read:
> "Please try the download again, and recheck. If the check still fails, try
> another browser if possible. Check also that the file size is correct."

Checking the file size is indeed a good thing. However, we don't provide one  yet (*), so this hint doesn't help and IMHO it's better not to mention this for now.

> It would be helpful if the following text were actually a link:
> 
> http://www.apache.org/dist/openoffice/KEYS

Hm, must a relict from a former text. And I've no Windows. Linux, *and* Mac to check all instructions. ;-)

So, thanks for finding the last bad parts and improving the English text.

(*) It a todo to get this and offer to the user. Once it's existing, I'll update this text.
Comment 9 sebb 2013-08-02 22:11:48 UTC
(In reply to Marcus from comment #8)
> > It is wrong to insist that Windows users download a specific hashing tool;
> > there are lots of other tools that are suitable.
> 
> Yes, and for Linux/Mac there might be also other tools. But I think it's
> better to give an example than just to point to Google for searching them.

The ASF should not promote one tool over another, so at the very least the page should mention other tools. For example, some are mentioned on the main ASF page.

There's also HashTab and lots of others.

The way the page is worded, it seems like the user has to install a specific tool.
Comment 10 SVN Robot 2013-08-02 23:22:39 UTC
"marcus" committed SVN revision 1509910 
#122905# Added tools as examples, to not prefer any specific one, suggested b...
Comment 11 Marcus 2013-08-02 23:26:17 UTC
I've added a list of tools and a message that we don't prefer any specific tool for every of the 3 verification methods.

Does it fit?
Comment 12 sebb 2013-08-03 11:37:41 UTC
Where is the page with the updates? AFAICT the public page still has all the problems.
Comment 13 Marcus 2013-08-03 11:44:16 UTC
It's not yet published but only in the staging area:

http://ooo-site.staging.apache.org/download/checksums.html
Comment 14 sebb 2013-08-03 12:22:16 UTC
It's a lot better, but there are still some minor issues.

>>Open a terminal and change to the directory with the downloaded AOO, KEYS and PGP/ASC file.<<

However the instructions then download the KEYS file.
That's inconsistent.

Same applies to Mac section.

===

The page is very long; I think you could combine the MD5/SHA256 sections, as the instructions are very similar.

The page should also state that there is no need to check the hashes if the signature is valid. Also use the SHA256 hash in preference to MD5, but either will do to check if the download was corrupted. The user does not need to check both MD5 and SHA256.

===

Does the Mac not have sha256sum and md5sum?
They are easier to use.
Comment 15 SVN Robot 2013-08-03 13:45:24 UTC
"marcus" committed SVN revision 1509988 
#122905# Updated text, suggested by sebb
Comment 16 Marcus 2013-08-03 15:24:22 UTC
1)
Inconsistency with the KEYS file.
--> Fixed

2)
The page is very long.

Right, I've looked from the technical way and tried to make it complete. Of course, it can be combined when mentioning that it's very similar.
I've also re-arranged the texts now in way that the Windows, Linux and Mac things are together.
--> Fixed.

3)
No need for all. SHA256 before MD5.
--> I've added a text at the beginning below of the TOC.

4)
Does the Mac not have sha256sum and md5sum?

Mac OS seems to use different tools with different names. I've found this in the Apple support knowledge DB:

http://support.apple.com/kb/HT1652

When they write to use "openssl", then IMHO it should be OK.
--> I'll keep it as is it.

Please check on the staging page:
http://ooo-site.staging.apache.org/download/checksums.html
Comment 17 sebb 2013-08-05 20:38:48 UTC
Getting better, but the sentences don't read well.

>>There is no need to do all verifications. It is sufficient to verify the signature, SHA256 or MD5 hash. However, it is recommended to prefer the SHA256 method than MD5.<<

Would be better as

>>There is no need to do all the verifications. The best is to check the GPG signature (.ASC) file. Failing that, use the SHA256 hash, otherwise use the MD5 hash.<<

===

>>When both SHA256 / MD5 hash values match it is indicated with an "<AOO file>.tar.gz: OK" statement.<<

would be better as:

>>If the hash matches this is indicated by "<AOO file>.tar.gz: OK".<<

===

>>Now compare both SHA256 / MD5 hash values.<<

should be

>>Now compare the hash generated by Openssl with the value in the file<<
Comment 18 Marcus 2013-08-05 22:16:06 UTC
Thanks for the corrections. I've upated the text.
Comment 19 SVN Robot 2013-08-05 22:16:06 UTC
"marcus" committed SVN revision 1510782 
#122905# Corrected English language, suggested by sebb