xref: /illumos-gate/usr/src/man/man3c/crypt.3c (revision dd72704bd9e794056c558153663c739e2012d721)

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
http://www.opengroup.org/bookstore/.

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 SunOS 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.

This notice shall appear on any product containing this material.

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.

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.

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]


Copyright 1989 AT&T.
Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.

CRYPT 3C "Sep 28, 2004"
NAME
crypt - string encoding function
SYNOPSIS

#include <crypt.h>

char *crypt(const char *key, const char *salt);
"Standard conforming"

#include <unistd.h>

char *crypt(const char *key, const char *salt);
DESCRIPTION

The crypt() function encodes strings suitable for secure storage as passwords. It generates the password hash given the key and salt.

The key argument is the plain text password to be encrypted.

If the first character of salt is "$", crypt() uses crypt.conf(5) to determine which shared module to load for the encryption algorithm. The algorithm name crypt() uses to search in crypt.conf is the string between the first and second "$", or between the first "$" and first "," if a "," comes before the second "$".

If the first character of salt is not "$", the algorithm described on crypt_unix(7) is used.

RETURN VALUES

Upon successful completion, crypt() returns a pointer to the encoded string. Otherwise it returns a null pointer and sets errno to indicate the error.

The return value points to static data that is overwritten by each call.

ERRORS

The crypt() function will fail if: EINVAL

An entry in crypt.conf is invalid.

ELIBACC

The required shared library was not found.

ENOMEM

There is insufficient memory to generate the hash.

ENOSYS

The functionality is not supported on this system.

USAGE

The values returned by this function might not be portable among standard-conforming systems. See standards(7).

Applications should not use crypt() to store or verify user passwords but should use the functions described on pam(3PAM) instead.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

passwd (1), crypt_genhash_impl (3C), crypt_gensalt (3C), crypt_gensalt_impl (3C), getpassphrase (3C), pam (3PAM), passwd (5), policy.conf (5), attributes (7), crypt_unix (7), standards (7)