lgamma.3: Fix some whitespace issues and remove refs to non-existing funcs.
[dragonfly.git] / lib / libmd / sha384.3
1 .\"
2 .\" ----------------------------------------------------------------------------
3 .\" "THE BEER-WARE LICENSE" (Revision 42):
4 .\" <phk@FreeBSD.org> wrote this file.  As long as you retain this notice you
5 .\" can do whatever you want with this stuff. If we meet some day, and you think
6 .\" this stuff is worth it, you can buy me a beer in return.   Poul-Henning Kamp
7 .\" ----------------------------------------------------------------------------
8 .\"
9 .\"     From: Id: mdX.3,v 1.14 1999/02/11 20:31:49 wollman Exp
10 .\" $FreeBSD: src/lib/libmd/sha512.3,v 1.4 2005/11/17 13:00:00 ru Exp $
11 .\"
12 .Dd July 4, 2010
13 .Dt SHA384 3
14 .Os
15 .Sh NAME
16 .Nm SHA384_Init ,
17 .Nm SHA384_Update ,
18 .Nm SHA384_Final
19 .Nd calculate the FIPS 180-2 ``SHA-384'' message digest
20 .Sh LIBRARY
21 .Lb libmd
22 .Sh SYNOPSIS
23 .In sys/types.h
24 .In sha512.h
25 .Ft void
26 .Fn SHA384_Init "SHA384_CTX *context"
27 .Ft void
28 .Fn SHA384_Update "SHA384_CTX *context" "const u_int8_t *data" "size_t len"
29 .Ft void
30 .Fn SHA384_Final "u_int8_t digest[48]" "SHA384_CTX *context"
31 .Sh DESCRIPTION
32 The
33 .Li SHA384_
34 functions calculate a 384-bit cryptographic checksum (digest)
35 for any number of input bytes.
36 A cryptographic checksum is a one-way
37 hash function; that is, it is computationally impractical to find
38 the input corresponding to a particular output.
39 This net result is
40 a
41 .Dq fingerprint
42 of the input-data, which does not disclose the actual input.
43 .Pp
44 The
45 .Fn SHA384_Init ,
46 .Fn SHA384_Update ,
47 and
48 .Fn SHA384_Final
49 functions are the core functions.
50 Allocate an
51 .Vt SHA384_CTX ,
52 initialize it with
53 .Fn SHA384_Init ,
54 run over the data with
55 .Fn SHA384_Update ,
56 and finally extract the result using
57 .Fn SHA384_Final .
58 .Sh SEE ALSO
59 .Xr md2 3 ,
60 .Xr md4 3 ,
61 .Xr md5 3 ,
62 .Xr ripemd 3 ,
63 .Xr sha 3
64 .Sh HISTORY
65 These functions appeared in
66 .Dx 2.9 .
67 .Sh AUTHORS
68 The core hash routines were implemented by Colin Percival based on
69 the published
70 .Tn FIPS 180-2
71 standard.
72 .Sh BUGS
73 No method is known to exist which finds two files having the same hash value,
74 nor to find a file with a specific hash value.
75 There is on the other hand no guarantee that such a method does not exist.