From dc2af37d961f722d07a89e658782e15a977e5549 Mon Sep 17 00:00:00 2001 From: Hiten Pandya Date: Thu, 9 Oct 2003 23:06:06 +0000 Subject: [PATCH] Assorted mdoc(7) fixes: - fix hard sentence breaks - sprinkle a few .Vt's where neccessary - remove incorrect use of `\-' - proper quoting using .Dq, instead of manual ``...'' Approved by: des@ (mentor) Reviewed by: ru@ --- lib/libmd/mdX.3 | 23 ++++++++++++++++------- lib/libmd/ripemd.3 | 15 ++++++++++----- lib/libmd/sha.3 | 23 +++++++++++++++-------- 3 files changed, 41 insertions(+), 20 deletions(-) diff --git a/lib/libmd/mdX.3 b/lib/libmd/mdX.3 index 9e171ba1254b..2d879bca517c 100644 --- a/lib/libmd/mdX.3 +++ b/lib/libmd/mdX.3 @@ -44,19 +44,25 @@ .Fn MDXData "const unsigned char *data" "unsigned int len" "char *buf" .Sh DESCRIPTION The MDX functions calculate a 128-bit cryptographic checksum (digest) -for any number of input bytes. A cryptographic checksum is a one-way +for any number of input bytes. +A cryptographic checksum is a one-way hash-function, that is, you cannot find (except by exhaustive search) -the input corresponding to a particular output. This net result is -a ``fingerprint'' of the input-data, which doesn't disclose the actual -input. +the input corresponding to a particular output. +This net result is a +.Dq fingerprint +of the input-data, which doesn't disclose the actual input. .Pp MD2 is the slowest, MD4 is the fastest and MD5 is somewhere in the middle. MD2 can only be used for Privacy-Enhanced Mail. MD4 has now been broken; it should only be used where necessary for backward compatibility. MD5 has not yet (1999-02-11) been broken, but sufficient attacks have been -made that its security is in some doubt. The attacks on both MD4 and MD5 -are both in the nature of finding ``collisions'' \- that is, multiple +made that its security is in some doubt. +The attacks on both MD4 and MD5 +are both in the nature of finding +.Dq collisions +\[en] +that is, multiple inputs which hash to the same value; it is still unlikely for an attacker to be able to determine the exact original input given a hash value. .Pp @@ -65,7 +71,10 @@ The .Fn MDXUpdate , and .Fn MDXFinal -functions are the core functions. Allocate an MDX_CTX, initialize it with +functions are the core functions. +Allocate an +.Vt MDX_CTX , +initialize it with .Fn MDXInit , run over the data with .Fn MDXUpdate , diff --git a/lib/libmd/ripemd.3 b/lib/libmd/ripemd.3 index e86d6d1be6f4..87bb2424c0bb 100644 --- a/lib/libmd/ripemd.3 +++ b/lib/libmd/ripemd.3 @@ -44,18 +44,23 @@ The .Li RIPEMD160_ functions calculate a 160-bit cryptographic checksum (digest) -for any number of input bytes. A cryptographic checksum is a one-way +for any number of input bytes. +A cryptographic checksum is a one-way hash function; that is, it is computationally impractical to find -the input corresponding to a particular output. This net result is -a ``fingerprint'' of the input-data, which doesn't disclose the actual -input. +the input corresponding to a particular output. +This net result is a +.Dq fingerprint +of the input-data, which doesn't disclose the actual input. .Pp The .Fn RIPEMD160_Init , .Fn RIPEMD160_Update , and .Fn RIPEMD160_Final -functions are the core functions. Allocate an RIPEMD160_CTX, initialize it with +functions are the core functions. +Allocate an +.Vt RIPEMD160_CTX , +initialize it with .Fn RIPEMD160_Init , run over the data with .Fn RIPEMD160_Update , diff --git a/lib/libmd/sha.3 b/lib/libmd/sha.3 index a319dbcdab89..d8401cd9a70b 100644 --- a/lib/libmd/sha.3 +++ b/lib/libmd/sha.3 @@ -67,18 +67,22 @@ The and .Li SHA1_ functions calculate a 160-bit cryptographic checksum (digest) -for any number of input bytes. A cryptographic checksum is a one-way +for any number of input bytes. +A cryptographic checksum is a one-way hash function; that is, it is computationally impractical to find -the input corresponding to a particular output. This net result is -a ``fingerprint'' of the input-data, which doesn't disclose the actual -input. +the input corresponding to a particular output. +This net result is +a +.Dq fingerprint +of the input-data, which doesn't disclose the actual input. .Pp .Tn SHA (or .Tn SHA-0 ) is the original Secure Hash Algorithm specified in .Tn FIPS -160. It was quickly proven insecure, and has been superseded by +160. +It was quickly proven insecure, and has been superseded by .Tn SHA-1 . .Tn SHA-0 is included for compatibility purposes only. @@ -88,7 +92,10 @@ The .Fn SHA1_Update , and .Fn SHA1_Final -functions are the core functions. Allocate an SHA_CTX, initialize it with +functions are the core functions. +Allocate an +.Vt SHA_CTX , +initialize it with .Fn SHA1_Init , run over the data with .Fn SHA1_Update , @@ -170,8 +177,8 @@ The .Tn SHA-1 makes heavy use of the .Ql bswapl -instruction, which is not present on the original 80386. Attempts -to use +instruction, which is not present on the original 80386. +Attempts to use .Tn SHA-1 on those processors will cause an illegal instruction trap. (Arguably, the kernel should simply emulate this instruction.)