summaryrefslogtreecommitdiffstats
path: root/lib/libmd/mdX.3
diff options
context:
space:
mode:
authorwollman <wollman@FreeBSD.org>1996-10-09 21:00:48 +0000
committerwollman <wollman@FreeBSD.org>1996-10-09 21:00:48 +0000
commit130a49f9b81084ee94f9cf5c2122e5b4a7d1bde9 (patch)
tree3e0d7a7cf7fec1c787ab1af4311190835d9a90de /lib/libmd/mdX.3
parent485f23347f6a88a019c837affa44a2f08e2c7162 (diff)
downloadFreeBSD-src-130a49f9b81084ee94f9cf5c2122e5b4a7d1bde9.zip
FreeBSD-src-130a49f9b81084ee94f9cf5c2122e5b4a7d1bde9.tar.gz
Use -mdoc macros properly.
Translate from Danglish into English. Refer to the alogrithms as ``RSA Data Security MDX message digest'' as required by the license.
Diffstat (limited to 'lib/libmd/mdX.3')
-rw-r--r--lib/libmd/mdX.389
1 files changed, 50 insertions, 39 deletions
diff --git a/lib/libmd/mdX.3 b/lib/libmd/mdX.3
index f589042..d10a3c2 100644
--- a/lib/libmd/mdX.3
+++ b/lib/libmd/mdX.3
@@ -6,9 +6,9 @@
.\" this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp
.\" ----------------------------------------------------------------------------
.\"
-.\" $FreeBSD$
+.\" $Id$
.\"
-.Dd July 14, 1994
+.Dd October 9, 1996
.Dt MDX 3
.Os FreeBSD 2
.Sh NAME
@@ -18,7 +18,7 @@
.Nm MDXEnd ,
.Nm MDXFile ,
.Nm MDXData
-.Nd calculate ``MDX'' cryptographic checksum
+.Nd calculate the RSA Data Security, Inc., ``MDX'' message digest
.Sh SYNOPSIS
.Fd #include <mdX.h>
.Ft void
@@ -40,77 +40,88 @@ 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.
-
+.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 been critizised for being to weak, and MD5 was developed as a
-response to this as ``MD4 with safety-belts''. If in doubt, use MD5.
-
+MD4 has been criticized for being too weak, so MD5 was developed in
+response as ``MD4 with safety-belts''. When in doubt, use MD5.
+.Pp
The
.Fn MDXInit ,
-.Fn MDXUpdate
+.Fn MDXUpdate ,
and
.Fn MDXFinal
-functions are the core functions. Allocate a MDX_CTX, initialize it with
-.Fn MDXInit
+functions are the core functions. Allocate an MDX_CTX, initialize it with
+.Fn MDXInit ,
run over the data with
-.Fn MDXUpdate
+.Fn MDXUpdate ,
and finally extract the result using
.Fn MDXFinal .
-
+.Pp
.Fn MDXEnd
is a wrapper for
-.Fn MDXFinal ,
-which converts the return value to a 33 character (incl terminating NULL)
-ascii string which represents the 128 bits in hexadecimal.
-
+.Fn MDXFinal
+which converts the return value to a 33-character
+(including the terminating '\e0')
+.Tn ASCII
+string which represents the 128 bits in hexadecimal.
+.Pp
.Fn MDXFile
calculates the digest of a file, and uses
.Fn MDXEnd
to return the result.
-In case the file cannot be opened, NULL is returned.
-
+If the file cannot be opened, a null pointer is returned.
.Fn MDXData
calculates the digest of a chunk of data in memory, and uses
.Fn MDXEnd
to return the result.
-
+.Pp
When using
.Fn MDXEnd ,
-.Fn MDXFile
+.Fn MDXFile ,
or
.Fn MDXData ,
the
.Ar buf
-argument can be NULL, in which case the returned string is allocated with
+argument can be a null pointer, in which case the returned string
+is allocated with
.Xr malloc 3
and subsequently must be explicitly deallocated using
.Xr free 3
after use.
If the
.Ar buf
-argument isn't NULL it must point to at least 33 characters of buffer space.
+argument is non-null it must point to at least 33 characters of buffer space.
.Sh SEE ALSO
.Xr md2 3 ,
.Xr md4 3 ,
.Xr md5 3
-.Pp
-ISOC
-Internet Request For Comments
-.%T RFC1319 ,
-.%T RFC1320
-and
-.%T RFC1321 .
-.Pp
-RSA Laboratories
-.%T Frequently Asked Questions About today's Cryptography .
+.Rs
+.%A B. Kaliski
+.%T The MD2 Message-Digest Algorithm
+.%O RFC 1319
+.Re
+.Rs
+.%A R. Rivest
+.%T The MD4 Message-Digest Algorithm
+.%O RFC 1186
+.Re
+.Rs
+.%A R. Rivest
+.%T The MD5 Message-Digest Algorithm
+.%O RFC 1321
+.Re
+.Rs
+.%A RSA Laboratories
+.%T Frequently Asked Questions About today's Cryptography
+.Re
.Sh AUTHOR
-The MD2, MD4 and MD5 is designed and written by Ron Rivest and published in
-the above RFC's, including a reference implementation of each algorithm.
-
+The original MDX routines were developed by
+.Tn RSA
+Data Security, Inc., and published in the above references.
This code is derived directly from these implementations by Poul-Henning Kamp
-<phk@login.dkuug.dk>
-
+.Aq Li phk@login.dkuug.dk
+.Pp
Phk ristede runen.
.Sh HISTORY
These functions appeared in
@@ -119,7 +130,7 @@ These functions appeared in
No method is known to exist which finds two files having the same hash value,
nor to find a file with a specific hash value.
There is on the other hand no guarantee that such a method doesn't exist.
-
-MD2 has only been released for use in Privacy Enhanced eMail.
+.Pp
+MD2 has only been licensed for use in Privacy Enhanced Mail.
Use MD4 or MD5 if that isn't what you're doing.
.Sh COPYRIGHT
OpenPOWER on IntegriCloud