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

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]


Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved.

ENCRYPT 3C "May 2, 2001"
NAME
encrypt - encoding function
SYNOPSIS

#include <crypt.h>

void encrypt(char block[64], int edflag);
"Standard conforming"

#include <unistd.h>

void encrypt(char block[64], int edflag);
DESCRIPTION

The encrypt() function provides (rather primitive) access to the hashing algorithm employed by the crypt(3C) function. The key generated by setkey(3C) is used to encrypt the string block with encrypt().

The block argument to encrypt() is an array of length 64 bytes containing only the bytes with numerical value of 0 and 1. The array is modified in place to a similar array using the key set by setkey(3C). If edflag is 0, the argument is encoded. If edflag is 1, the argument may be decoded (see the USAGE section below); if the argument is not decoded, errno will be set to ENOSYS.

RETURN VALUES

The encrypt() function returns no value.

ERRORS

The encrypt() function will fail if: ENOSYS

The functionality is not supported on this implementation.

USAGE

In some environments, decoding may not be implemented. This is related to U.S. Government restrictions on encryption and decryption routines: the DES decryption algorithm cannot be exported outside the U.S.A. Historical practice has been to ship a different version of the encryption library without the decryption feature in the routines supplied. Thus the exported version of encrypt() does encoding but not decoding.

Because encrypt() does not return a value, applications wishing to check for errors should set errno to 0, call encrypt(), then test errno and, if it is non-zero, assume an error has occurred.

ATTRIBUTES

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

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

crypt (3C), setkey (3C), attributes (7)