xref: /freebsd/lib/libc/rpc/des_crypt.3 (revision a79b71281cd63ad7a6cc43a6d5673a2510b51630)
@(#)des_crypt.3 2.1 88/08/11 4.0 RPCSRC; from 1.16 88/03/02 SMI;
$FreeBSD$

DES_CRYPT 3 "6 October 1987"
NAME
des_crypt, ecb_crypt, cbc_crypt, des_setparity - fast DES encryption
SYNOPSIS
 #include <des_crypt.h> 

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

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

void des_setparity(key) char *key;

DESCRIPTION
encryption cbc_crypt "" \fLcbc_crypt "des encryption" cbc_crypt "DES encryption" \fLcbc_crypt encryption des_setparity "" \fLdes_setparity "des encryption" des_setparity "DES encryption" \fLdes_setparity ecb_crypt(\|) and cbc_crypt(\|) implement the NBS DES (Data Encryption Standard). These routines are faster and more general purpose than crypt (3). 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.

Here is how to use these routines. 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\s0'ing together some things. For the encryption direction 'or' in either DES_ENCRYPT or DES_DECRYPT\s0. For software versus hardware encryption, 'or' in either DES_HW or DES_SW\s0. If DES_HW is specified, and there is no hardware, then the encryption is performed in software and the routine returns DESERR_NOHWDEVICE\s0. For cbc_crypt , the parameter ivec is the the 8-byte initialization vector for the chaining. It is updated to the next initialization vector upon return.

"SEE ALSO"
des (1), crypt (3)
DIAGNOSTICS

0

20 DESERR_NONE No error.

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

DESERR_HWERR An error occurred in the hardware or driver.

DESERR_BADPARAM Bad parameter to routine.

Given a result status stat , the macro DES_FAILED\c ( stat ) is false only for the first two statuses.

RESTRICTIONS
These routines are not available in RPCSRC 4.0. This information is provided to describe the DES interface expected by Secure RPC.