share/man/man3c/crypt.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T.
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  45 .\" Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH CRYPT 3C "Sep 28, 2004"
  48 .SH NAME
  49 crypt \- string encoding function
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <crypt.h>
  54
  55 \fBchar *\fR\fBcrypt\fR(\fBconst char *\fR\fIkey\fR, \fBconst char *\fR\fIsalt\fR);
  56 .fi
  57
  58 .SS "Standard conforming"
  59 .LP
  60 .nf
  61 #include <unistd.h>
  62
  63 \fBchar *\fR\fBcrypt\fR(\fBconst char *\fR\fIkey\fR, \fBconst char *\fR\fIsalt\fR);
  64 .fi
  65
  66 .SH DESCRIPTION
  67 .sp
  68 .LP
  69 The \fBcrypt()\fR function encodes strings suitable for secure storage as
  70 passwords. It generates the password hash given the \fIkey\fR and \fIsalt\fR.
  71 .sp
  72 .LP
  73 The \fIkey\fR argument is the plain text password to be encrypted.
  74 .sp
  75 .LP
  76 If the first character of \fIsalt\fR is "$", \fBcrypt()\fR uses
  77 \fBcrypt.conf\fR(4) to determine which shared module to load for the encryption
  78 algorithm.  The algorithm name \fBcrypt()\fR uses to search in \fBcrypt.conf\fR
  79 is the string between the first and second "$", or between the first "$" and
  80 first "," if a "," comes before the second "$".
  81 .sp
  82 .LP
  83 If the first character of \fIsalt\fR is not "$", the algorithm described on
  84 \fBcrypt_unix\fR(5) is used.
  85 .SH RETURN VALUES
  86 .sp
  87 .LP
  88 Upon successful completion, \fBcrypt()\fR returns a pointer to the encoded
  89 string. Otherwise it returns a null pointer and sets \fBerrno\fR to indicate
  90 the error.
  91 .sp
  92 .LP
  93 The return value points to static data that is overwritten by each call.
  94 .SH ERRORS
  95 .sp
  96 .LP
  97 The \fBcrypt()\fR function will fail if:
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBEINVAL\fR\fR
 102 .ad
 103 .RS 11n
 104 An entry in \fBcrypt.conf\fR is invalid.
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fBELIBACC\fR\fR
 111 .ad
 112 .RS 11n
 113 The required shared library was not found.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBENOMEM\fR\fR
 120 .ad
 121 .RS 11n
 122 There is insufficient memory to generate the hash.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBENOSYS\fR\fR
 129 .ad
 130 .RS 11n
 131 The functionality is not supported on this system.
 132 .RE
 133
 134 .SH USAGE
 135 .sp
 136 .LP
 137 The values returned by this function might not be portable among
 138 standard-conforming systems. See \fBstandards\fR(5).
 139 .sp
 140 .LP
 141 Applications should not use \fBcrypt()\fR to store or verify user passwords but
 142 should use the functions described on \fBpam\fR(3PAM) instead.
 143 .SH ATTRIBUTES
 144 .sp
 145 .LP
 146 See \fBattributes\fR(5) for descriptions of the following attributes:
 147 .sp
 148
 149 .sp
 150 .TS
 151 box;
 152 c | c
 153 l | l .
 154 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 155 _
 156 Interface Stability     Standard
 157 _
 158 MT-Level        MT-Safe
 159 .TE
 160
 161 .SH SEE ALSO
 162 .sp
 163 .LP
 164 \fBpasswd\fR(1), \fBcrypt_genhash_impl\fR(3C), \fBcrypt_gensalt\fR(3C),
 165 \fBcrypt_gensalt_impl\fR(3C), \fBgetpassphrase\fR(3C), \fBpam\fR(3PAM),
 166 \fBpasswd\fR(4), \fBpolicy.conf\fR(4), \fBattributes\fR(5),
 167 \fBcrypt_unix\fR(5), \fBstandards\fR(5)