xref: /illumos-gate/usr/src/man/man3ext/ecb_crypt.3ext (revision 4f364e7c95ee7fd9d5bbeddc1940e92405bb0e72)
te
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
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]
ECB_CRYPT 3EXT "Mar 3, 2008"
NAME
ecb_crypt, cbc_crypt, des_setparity, DES_FAILED - fast DES encryption
SYNOPSIS

#include <rpc/des_crypt.h>

int ecb_crypt(char *key, char *data, unsigned datalen,
 unsigned mode);

int cbc_crypt(char *key, char *data, unsigned datalen,
 unsigned mode, char *ivec);

void des_setparity(char *key);

int DES_FAILED(int stat);
DESCRIPTION

ecb_crypt() and cbc_crypt() implement the NBS DES (Data Encryption Standard). These routines are faster and more general purpose than crypt(3C). They also are able to utilize DES hardware if it is available. ecb_crypt() encrypts in ECB (Electronic Code Book) mode, which encrypts blocks of data independently. cbc_crypt() encrypts in CBC (Cipher Block Chaining) mode, which chains together successive blocks. CBC mode protects against insertions, deletions, and substitutions of blocks. Also, regularities in the clear text will not appear in the cipher text.

The first parameter, key, is the 8-byte encryption key with parity. To set the key's parity, which for DES is in the low bit of each byte, use des_setparity(). The second parameter, data, contains the data to be encrypted or decrypted. The third parameter, datalen, is the length in bytes of data, which must be a multiple of 8. The fourth parameter, mode, is formed by OR'ing together the DES_ENCRYPT or DES_DECRYPT to specify the encryption direction and DES_HW or DES_SW to specify software or hardware encryption. If DES_HW is specified, and there is no hardware, then the encryption is performed in software and the routine returns DESERR_NOHWDEVICE.

For cbc_crypt(), the parameter ivec is the 8-byte initialization vector for the chaining. It is updated to the next initialization vector upon successful return.

RETURN VALUES

Given a result status stat, the macro DES_FAILED is false only for the first two statuses. DESERR_NONE

No error.

DESERR_NOHWDEVICE

Encryption succeeded, but done in software instead of the requested hardware.

DESERR_HWERROR

An error occurred in the hardware or driver.

DESERR_BADPARAM

Bad parameter to routine.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level MT-Safe
SEE ALSO

crypt(3C), attributes(5)

NOTES

When compiling multi-thread applications, the _REENTRANT flag must be defined on the compile line. This flag should only be used in multi-thread applications.