usr/src/man/man3c/crypt.3c

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