Print this page
9842 man page typos and spelling
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man3c/crypt_genhash_impl.3c
+++ new/usr/src/man/man3c/crypt_genhash_impl.3c
1 1 '\" te
2 2 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
3 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 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 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 6 .TH CRYPT_GENHASH_IMPL 3C "Jun 10, 2002"
7 7 .SH NAME
8 8 crypt_genhash_impl \- generate encrypted password
↓ open down ↓ |
8 lines elided |
↑ open up ↑ |
9 9 .SH SYNOPSIS
10 10 .LP
11 11 .nf
12 12 #include <crypt.h>
13 13
14 14 \fBchar *\fR\fBcrypt_genhash_impl\fR(\fBchar *\fR\fIctbuffer\fR, \fBsize_t\fR \fIctbufflen\fR,
15 15 \fBconst char *\fR\fIplaintext\fR, \fBconst char *\fR\fIsalt\fR, \fBconst char **\fR\fIparams\fR);
16 16 .fi
17 17
18 18 .SH DESCRIPTION
19 -.sp
20 19 .LP
21 20 The \fBcrypt_genhash_impl()\fR function is called by \fBcrypt\fR(3C) to
22 21 generate the encrypted password \fIplaintext\fR.
23 22 .sp
24 23 .LP
25 24 The \fIctbuffer\fR argument is a pointer to an MT-safe buffer of
26 25 \fIctbufflen\fR size that is used to return the result.
27 26 .sp
28 27 .LP
29 28 The \fIsalt\fR argument is the salt used in encoding.
30 29 .sp
31 30 .LP
32 31 The \fIparams\fR argument is an \fIargv\fR-like null-terminated vector of type
33 32 \fBchar *\fR. The first element of \fIparams\fR represents the mechanism token
34 33 name from \fBcrypt.conf\fR(4). The remaining elements of \fIparams\fR represent
35 34 strings of the form <\fBparameter\fR>[=<\fBvalue\fR>] to allow passing in
36 -additional information from the \fBcrypt.conf\fR entry, such as specifing
35 +additional information from the \fBcrypt.conf\fR entry, such as specifying
37 36 rounds information "\fBrounds=4096\fR".
38 37 .sp
39 38 .LP
40 39 The \fBcrypt_genhash_impl()\fR function must not \fBfree\fR(3C) \fIctbufflen\fR
41 40 on error.
42 41 .SH RETURN VALUES
43 -.sp
44 42 .LP
45 43 Upon successful completion, \fBcrypt_genhash_impl()\fR returns a pointer to the
46 44 encoded version of \fIplaintext\fR. Otherwise a null pointer is returned and
47 45 \fBerrno\fR is set to indicate the error.
48 46 .SH ERRORS
49 -.sp
50 47 .LP
51 48 The \fBcrypt_genhash_impl()\fR function will fail if:
52 49 .sp
53 50 .ne 2
54 51 .na
55 52 \fB\fBEINVAL\fR\fR
56 53 .ad
57 54 .RS 11n
58 55 The configuration file \fBcrypt.conf\fR contains an invalid entry.
59 56 .RE
60 57
61 58 .sp
62 59 .ne 2
63 60 .na
64 61 \fB\fBELIBACC\fR\fR
65 62 .ad
66 63 .RS 11n
67 64 The required shared library was not found.
68 65 .RE
69 66
↓ open down ↓ |
10 lines elided |
↑ open up ↑ |
70 67 .sp
71 68 .ne 2
72 69 .na
73 70 \fB\fBENOMEM\fR\fR
74 71 .ad
75 72 .RS 11n
76 73 There is insufficient memory to perform hashing.
77 74 .RE
78 75
79 76 .SH ATTRIBUTES
80 -.sp
81 77 .LP
82 78 See \fBattributes\fR(5) for descriptions of the following attributes:
83 79 .sp
84 80
85 81 .sp
86 82 .TS
87 83 box;
88 84 c | c
89 85 l | l .
90 86 ATTRIBUTE TYPE ATTRIBUTE VALUE
91 87 _
92 88 Interface Stability Evolving
93 89 _
94 90 MT-Level MT-Safe
95 91 .TE
96 92
97 93 .SH SEE ALSO
98 -.sp
99 94 .LP
100 95 \fBpasswd\fR(1), \fBcrypt\fR(3C), \fBcrypt_gensalt_impl\fR(3C), \fBfree\fR(3C),
101 96 \fBgetpassphrase\fR(3C), \fBcrypt.conf\fR(4), \fBpasswd\fR(4),
102 97 \fBattributes\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX