* Replace DragonFly with Dx.
[dragonfly.git] / share / man / man9 / MD5.9
1 .\"     $OpenBSD: md5.9,v 1.1 1996/04/17 21:40:14 mickey Exp $
2 .\"
3 .\" Copyright (c) 1996  Michael Shalayeff
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgement:
16 .\"      This product includes software developed by Michael Shalayeff
17 .\" 3. The name of the author may not be used to endorse or promote products
18 .\"    derived from this software without specific prior written permission
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 .\"
31 .\" $FreeBSD: src/share/man/man9/MD5.9,v 1.5.2.3 2001/12/17 11:30:18 ru Exp $
32 .\" $DragonFly: src/share/man/man9/MD5.9,v 1.2 2003/06/17 04:37:01 dillon Exp $
33 .\"
34 .Dd April 17, 1996
35 .Dt MD5 9
36 .Os
37 .Sh NAME
38 .Nm MD5 ,
39 .Nm MD5Init ,
40 .Nm MD5Transform
41 .Nd message digest routines
42 .Sh SYNOPSIS
43 .In sys/types.h
44 .In sys/md5.h
45 .Ft void
46 .Fn MD5Init "MD5_CTX *buf"
47 .Ft void
48 .Fn MD5Transform "u_int32_t buf[4]" "const unsigned char block[64]"
49 .Sh DESCRIPTION
50 The
51 .Nm
52 module implements the RSA Data Security, Inc. MD5 Message-Digest Algorithm
53 (MD5). It produces 128-bit MD5 Digest of data.
54 .Pp
55 .Bl -hang -width MD5Transformxxx
56 .It Pa MD5Init
57 must be called just before
58 .Fn MD5Transform
59 will be used to produce a digest.
60 The
61 .Fa buf
62 argument is the storage for the digest being produced on subsequent
63 calls to the
64 .Fn MD5Transform
65 routine.
66 .It Pa MD5Transform
67 is the core of the MD5 algorithm, this alters an existing MD5 hash
68 kept in
69 .Fa buf
70 to reflect the addition of 64 characters
71 of new data passed in
72 .Fa block
73 argument.
74 .El
75 .Sh COPYRIGHTS
76 The code for MD5 transform was taken from Colin Plumb's
77 implementation, which has been placed in the public domain.  The
78 MD5 cryptographic checksum was devised by Ronald Rivest, and is
79 documented in RFC 1321, "The MD5 Message Digest Algorithm".