5479 Need missing *at family manual pages
[illumos-gate.git] / usr / src / man / man3lib / libmd.3lib
blobd442d1fd36d4d7c12469cf67b28c8c34f4b8289d
1 '\" te
2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH LIBMD 3LIB "Jun 16, 2008"
7 .SH NAME
8 libmd \- Message Digest library
9 .SH SYNOPSIS
10 .LP
11 .nf
12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lmd\fR [ \fIlibrary\fR... ]
13 #include <\fBmd4.h\fR>
14 #include <\fBmd5.h\fR>
15 #include <\fBsha1.h\fR>
16 #include <\fBsha2.h\fR>
17 .fi
19 .SH DESCRIPTION
20 .sp
21 .LP
22 Functions in this library provide hashing routines for \fBMD4 (RFC1320)\fR,
23 \fBMD5 (RFC1321)\fR, \fBSHA1 (RFC3174)\fR, \fBSHA256 (FIPS 180-2)\fR, \fBSHA384
24 (FIPS 180-2)\fR, \fBSHA512 (FIPS 180-2)\fR.
25 .SH INTERFACES
26 .sp
27 .LP
28 The shared object \fBlibmd.so.1\fR provides the public interfaces defined
29 below. See \fBIntro\fR(3) for additional information on shared object
30 interfaces.
31 .sp
33 .sp
34 .TS
35 l l
36 l l .
37 \fBMD4Final\fR  \fBMD4Init\fR
38 \fBMD4Update\fR \fBmd5_calc\fR
39 \fBMD5Final\fR  \fBMD5Init\fR
40 \fBMD5Update\fR \fBSHA1Final\fR
41 \fBSHA1Init\fR  \fBSHA1Update\fR
42 \fBSHA2Final\fR \fBSHA2Init\fR
43 \fBSHA2Update\fR        
44 .TE
46 .SH SECURITY
47 .sp
48 .LP
49 The \fBMD4\fR and \fBMD5\fR algorithms are currently considered weak for
50 cryptographic use. The algorithms should be used only for compatibility with
51 legacy systems or protocols.
52 .sp
53 .LP
54 The \fBSHA1\fR algorithm is also believed to have some weaknesses. Migration to
55 one of the \fBSHA2\fR algorithms-including \fBSHA256\fR, \fBSHA386\fR or
56 \fBSHA512\fR-is highly recommended when compatibility with data formats and on
57 wire protocols is permitted.
58 .SH FILES
59 .sp
60 .ne 2
61 .na
62 \fB\fB/lib/libmd.so.1\fR\fR
63 .ad
64 .RS 22n
65 shared object
66 .RE
68 .sp
69 .ne 2
70 .na
71 \fB\fB/lib/64/libmd.so.1\fR\fR
72 .ad
73 .RS 22n
74 64-bit shared object
75 .RE
77 .SH ATTRIBUTES
78 .sp
79 .LP
80 See \fBattributes\fR(5) for descriptions of the following attributes:
81 .sp
83 .sp
84 .TS
85 box;
86 c | c
87 l | l .
88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
90 Interface Stability     Committed
92 MT-Level        MT-Safe
93 .TE