Bug 188043 - [patch] man page for md5/sha1/sha256/sha412/rmd-160 cleanup
Summary: [patch] man page for md5/sha1/sha256/sha412/rmd-160 cleanup
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: Benjamin Kaduk
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-03-29 10:10 UTC by Jamie Landeg-Jones
Modified: 2018-08-05 06:23 UTC (History)
1 user (show)

See Also:


Attachments
patch-md5.1 (980 bytes, text/plain)
2014-03-29 10:10 UTC, Jamie Landeg-Jones
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Jamie Landeg-Jones 2014-03-29 10:10:00 UTC
man page shows for -c option: "Compare files to this md5 string."

This is misleading - the string needs to be in the same format as the digest command being used.

I suggest something like:

"Compare the files message digest to this string."

Also, suggest updating the date relating to known exploits.

Fix: Apply attached patch suggestion

	
How-To-Repeat: 
man sha1
man sha256
man sha512
man rmd-160
Comment 1 Benjamin Kaduk freebsd_committer freebsd_triage 2014-05-17 05:13:58 UTC
Responsible Changed
From-To: freebsd-doc->bjk

take
Comment 2 dfilter service freebsd_committer freebsd_triage 2014-05-18 22:17:03 UTC
Author: bjk (doc committer)
Date: Sun May 18 21:16:59 2014
New Revision: 266417
URL: http://svnweb.freebsd.org/changeset/base/266417

Log:
  Assorted updates to md5.1
  
  Note that the -c argument's parameter is compared against the digest of
  the file, not the file. [1]
  
  Update the "current time" parentheticals for notes about reversing
  and colliding the hash functions. [1]
  
  Some general mdoc updates.
  
  PR:		docs/188043 [1]
  Submitted by:	Jamie Landeg-Jones [1]
  Approved by:	hrs (mentor)
  MFC after:	1 week

Modified:
  head/sbin/md5/md5.1

Modified: head/sbin/md5/md5.1
==============================================================================
--- head/sbin/md5/md5.1	Sun May 18 21:05:54 2014	(r266416)
+++ head/sbin/md5/md5.1	Sun May 18 21:16:59 2014	(r266417)
@@ -1,5 +1,5 @@
 .\" $FreeBSD$
-.Dd July 31, 2012
+.Dd May 17, 2014
 .Dt MD5 1
 .Os
 .Sh NAME
@@ -63,12 +63,12 @@ concerned, and should not be relied upon
 This also means that
 .Tn MD5
 should not be used as part of a cryptographic signature scheme.
-At the current time (2009-01-06) there is no publicly known method to
+At the current time (2014-05-17) there is no publicly known method to
 .Dq reverse
 MD5, i.e., to find an input given a hash value.
 .Pp
 .Tn SHA-1
-currently (2009-01-06) has no known collisions, but an attack has been
+currently (2014-05-17) has no known collisions, but an attack has been
 found which is faster than a brute-force search, placing the security of
 .Tn SHA-1
 in doubt.
@@ -83,15 +83,15 @@ The hexadecimal checksum of each file li
 after the options are processed.
 .Bl -tag -width indent
 .It Fl c Ar string
-Compare files to this md5 string.
-(Note that this option is not yet useful if multiple files are specified.)
+Compare the digest of the file against this string.
+.Pq Note that this option is not yet useful if multiple files are specified.
 .It Fl s Ar string
 Print a checksum of the given
 .Ar string .
 .It Fl p
 Echo stdin to stdout and append the checksum to stdout.
 .It Fl q
-Quiet mode - only the checksum is printed out.
+Quiet mode \(em only the checksum is printed out.
 Overrides the
 .Fl r
 option.
@@ -114,7 +114,9 @@ and
 .Nm rmd160
 utilities exit 0 on success,
 1 if at least one of the input files could not be read,
-and 2 if at least one file does not have the same hash as the -c option.
+and 2 if at least one file does not have the same hash as the
+.Fl c
+option.
 .Sh SEE ALSO
 .Xr cksum 1 ,
 .Xr md5 3 ,
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 3 commit-hook freebsd_committer freebsd_triage 2015-04-14 00:28:31 UTC
A commit references this bug:

Author: delphij
Date: Tue Apr 14 00:27:55 UTC 2015
New revision: 281512
URL: https://svnweb.freebsd.org/changeset/base/281512

Log:
  MFC r266417 (bjk):

  Assorted updates to md5.1

  Note that the -c argument's parameter is compared against the digest of
  the file, not the file. [1]

  Update the "current time" parentheticals for notes about reversing
  and colliding the hash functions. [1]

  Some general mdoc updates.

  PR:		docs/188043 [1]
  Submitted by:	Jamie Landeg-Jones [1]

Changes:
_U  stable/10/
  stable/10/sbin/md5/md5.1
Comment 4 Mark Linimon freebsd_committer freebsd_triage 2018-08-05 06:23:16 UTC
Committed as r266417.