Parameters

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

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, 2, or 3.

rule_array

Direction:	Input
Type:	String array

Zero or one keyword that supplies control information to the verb. The keyword must be in eight bytes of contiguous storage, left-aligned and padded on the right with blanks. The rule_array keywords are described in Table 1.

Table 1. Keywords for Multiple Clear Key Import control information

Keywords for Multiple Clear Key Import control information

Keyword	Description
Algorithm (One, optional)
AES	The key should be enciphered under the master key as an AES key.
DES	The key should be enciphered under the master key as a DES key. This is the default.
Key-wrapping method (One, optional)
USECONFG	This is the default. Specifies to wrap the key using the configuration setting for the default wrapping method. The default wrapping method configuration setting may be changed using the TKE. This keyword is ignored for AES keys.
WRAP-ENH	Specifies to wrap the key using the legacy wrapping method. This keyword is ignored for AES keys.
WRAP-ECB	Specifies to wrap the key using the enhanced wrapping method. Valid only for DES keys.
WRAPENH2	Specifies to wrap the key using the enhanced wrapping method and SHA-256. Valid only for TRIPLE or TRIPLE-O. This method requires CV bit 56 = B’1’ (ENH-ONLY). This is the default for TRIPLE and TRIPLE-O.
WRAPENH3	Specifies to wrap the key using the enhanced wrapping method with TDES-CMAC and the SHA-256 hashing algorithm. This keyword sets CV bit 56 = B’1’ (ENH-ONLY), which is required for the WRAPENH3 wrapping method.
Translation control (Optional). This is valid only with key-wrapping method WRAP-ENH or with USECONFG when the default wrapping method is WRAP-ENH. This option cannot be used on a key with a control vector valued to binary zeros.
ENH-ONLY	Specifies to restrict the key from being wrapped with the legacy wrapping method after it has been wrapped with the enhanced wrapping method. Sets bit 56 (ENH-ONLY) of the control vector to B'1'.

clear_key_length

Direction:	Input
Type:	Integer

The clear_key_length parameter specifies the length of the clear key value to import. This length must be 8, 16, or 24.

clear_key

Direction:	Input
Type:	String

The clear_key parameter specifies the clear key value to import.

target_key_identifier

Direction:	Output
Type:	String

A 64-byte string that is to receive the internal key token. Key token formats describes the key tokens.