Parameters

For the definitions of the return_code, reason_code, exit_data_length, and exit_data parameters, see Parameters common to all verbs.

kek_key_identifier

Direction:	Input
Type:	String

A pointer to a string variable containing an operational key-token or the key label of an operational key-token record containing the key-encrypting key. The control vector in the key token must specify the key type IMPORTER, EXPORTER, IKEYXLAT, or OKEYXLAT.

source_key_token

Direction:	Input
Type:	String

A pointer to a string variable containing the external DES key-token with the key and control vector to be processed.

array_key_left_identifier

Direction:	Input
Type:	String

A pointer to a string variable containing an operational DES key-token or a key label of an operational DES key-token record that deciphers the left mask-array. The key token must contain a control vector specifying a CVARXCVL key-type. The CVARXCVL key must be single length.

mask_array_left

Direction:	Input
Type:	String

A pointer to a string variable containing the mask array enciphered under the left-array key.

array_key_right_identifier

Direction:	Input
Type:	String

A pointer to a string variable containing an operational DES key-token or the key label of an operational DES key-token record that deciphers the right mask-array. The key token must contain a control vector specifying a CVARXCVR key-type. The CVARXCVR key must be single length.

mask_array_right

Direction:	Input
Type:	String

A pointer to a string variable containing the mask array enciphered under the right-array key.

rule_array_count

Direction:	Input
Type:	Integer

A pointer to an integer variable containing the number of elements in the rule_array variable. This value must be 0, 1, or 2.

rule_array

Direction:	Input
Type:	String array

A pointer to a string variable containing an array of keywords. The keywords are eight bytes in length and must be left-aligned and padded on the right with space characters. The rule_array keywords are described in Table 1.

Table 1. Keywords for Control Vector Translate control information

Keyword	Description
Parity adjustment (One, optional)
ADJUST	Ensures that all target-key bytes have odd parity. This is the default.
NOADJUST	Prevents the parity of the target key from being altered.
Key half processing mode (One, optional)
LEFT	Causes an 8-byte source key, or the left half of a 16-byte source key, to be processed with the result placed into both halves of the target key. This is the default.
RIGHT	Causes the right half of a 16-byte source key to be processed with the result placed into only the right half of the target key. The left half of the target key is unchanged.
BOTH	Causes both halves of a 16-byte source key to be processed with the result placed into corresponding halves of the target key. When you use the BOTH keyword, the mask array must be able to validate the translation of both halves.
SINGLE	Causes the left half of the source key to be processed with the result placed into only the left half of the target. The right half of the target key is unchanged.

target_key_token

Direction:	Input/Output
Type:	String

A pointer to a string variable containing an external DES key-token with the new control vector. This key token contains the key halves with the new control vector.