summaryrefslogtreecommitdiff
path: root/lib/libc/md
diff options
context:
space:
mode:
authorTodd C. Miller <millert@cvs.openbsd.org>1996-10-15 22:00:13 +0000
committerTodd C. Miller <millert@cvs.openbsd.org>1996-10-15 22:00:13 +0000
commit0f4176157d484642580d0ba171b644a515f92626 (patch)
treed6aa914d34bda17580b9205fbba9f59d15dfa8d6 /lib/libc/md
parenta647884242b85b8eaaa87bbf01a015f782710b58 (diff)
Minor doc fixups from FreeBSD.
Diffstat (limited to 'lib/libc/md')
-rw-r--r--lib/libc/md/md4.copyright8
-rw-r--r--lib/libc/md/md5.copyright10
-rw-r--r--lib/libc/md/mdX.391
3 files changed, 60 insertions, 49 deletions
diff --git a/lib/libc/md/md4.copyright b/lib/libc/md/md4.copyright
index 3d0af815ecd..7623cfa54d0 100644
--- a/lib/libc/md/md4.copyright
+++ b/lib/libc/md/md4.copyright
@@ -1,7 +1,7 @@
-.\" $OpenBSD: md4.copyright,v 1.1 1996/06/03 22:20:41 niklas Exp $
+.\" $OpenBSD: md4.copyright,v 1.2 1996/10/15 22:00:10 millert Exp $
Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All
rights reserved.
-
+.Pp
License to copy and use this software is granted provided that it
is identified as the "RSA Data Security, Inc. MD4 Message-Digest
Algorithm" in all material mentioning or referencing this software
@@ -10,11 +10,11 @@ License is also granted to make and use derivative works provided
that such works are identified as "derived from the RSA Data
Security, Inc. MD4 Message-Digest Algorithm" in all material
mentioning or referencing the derived work.
-
+.Pp
RSA Data Security, Inc. makes no representations concerning either
the merchantability of this software or the suitability of this
software for any particular purpose. It is provided "as is"
without express or implied warranty of any kind.
-
+.Pp
These notices must be retained in any copies of any part of this
documentation and/or software.
diff --git a/lib/libc/md/md5.copyright b/lib/libc/md/md5.copyright
index b892ff0b707..9b7d08bf52b 100644
--- a/lib/libc/md/md5.copyright
+++ b/lib/libc/md/md5.copyright
@@ -1,21 +1,21 @@
-.\" $OpenBSD: md5.copyright,v 1.1 1996/06/03 22:20:42 niklas Exp $
+.\" $OpenBSD: md5.copyright,v 1.2 1996/10/15 22:00:11 millert Exp $
Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All
rights reserved.
-
+.Pp
License to copy and use this software is granted provided that it
is identified as the "RSA Data Security, Inc. MD5 Message-Digest
Algorithm" in all material mentioning or referencing this software
or this function.
-
+.Pp
License is also granted to make and use derivative works provided
that such works are identified as "derived from the RSA Data
Security, Inc. MD5 Message-Digest Algorithm" in all material
mentioning or referencing the derived work.
-
+.Pp
RSA Data Security, Inc. makes no representations concerning either
the merchantability of this software or the suitability of this
software for any particular purpose. It is provided "as is"
without express or implied warranty of any kind.
-
+.Pp
These notices must be retained in any copies of any part of this
documentation and/or software.
diff --git a/lib/libc/md/mdX.3 b/lib/libc/md/mdX.3
index 48c643b9cd4..f659eab3de2 100644
--- a/lib/libc/md/mdX.3
+++ b/lib/libc/md/mdX.3
@@ -6,9 +6,9 @@
.\" this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp
.\" ----------------------------------------------------------------------------
.\"
-.\" $OpenBSD: mdX.3,v 1.3 1996/10/08 01:20:08 michaels Exp $
+.\" $OpenBSD: mdX.3,v 1.4 1996/10/15 22:00:12 millert Exp $
.\"
-.Dd July 14, 1994
+.Dd October 9, 1996
.Dt MDX 3
.Os
.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,86 +40,97 @@ 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 too 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
-.Em FreeBSD-2.0
+.Em FreeBSD-2.0 .
.Sh BUGS
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