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

The rule_array_count parameter is a pointer to an integer variable containing the number of elements in the rule_array variable. The value must be 0, 1, or 2.

rule_array

Direction:	Input
Type:	String

The rule_array parameter is a pointer to a string variable containing an array of keywords that provide control information to the verb. The keywords are 8 bytes in length and must be left-aligned and padded on the right with space characters. All keywords must be in contiguous storage. When writing a key record with a null key token, the algorithm type must be specified in the rule_array. When writing a record with an internal or external key token, the algorithm type is derived from the token. Therefore, the algorithm type in the rule_array is optional. The Processing Option defaults to CHECK if no option is provided. The rule_array keywords are described in Table 1.

Table 1. Keywords for Combined Key Record Write control information

Keywords for Combined Key Record Write control information

Keyword	Description
Key Block Algorithm (one required it a null token is provided, otherwise opional).
AES	Specifies that the key token denoted by the key_label parameter is an AES key token (external, internal, and null AES and HMAC key tokens).
DES	Specifies that the key token denoted by the key_label parameter is a DES key token (external, internal, and null DES key tokens).
PKA	Specifies that the key token denoted by the key_label parameter is a PKA (ECC, QSA, or RSA) key token. This record can be an external, internal, or null PKA key token.
Processing Option (one optional).
CHECK	Specifies that the record is written only if a record of the same label in any key storage contains a null key token. This is the default behavior.
OVERLAY	Specifies that the record is overwritten regardless of the current content of the record in any key storage.

key_label

Direction:	Input
Type:	String

A pointer to a string variable containing the key label of a key token that, along with the rule array Key Block Algorithm, identifies the record in key storage where the token is to be written.

key_token_length

Direction:	Input
Type:	Integer

A pointer to an integer variable containing the number of bytes of data in the key token variable. The maximum length is 9992 bytes.

key_token

Direction:	Input
Type:	String

A pointer to a string variable containing the key token to be written to the key storage.