Parameters

Edit online

The parameter definitions for CSUACRD.

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
A pointer to an integer variable containing the number of elements in the rule_array variable. This value must be 1.
rule_array
The rule_array parameter is 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 keyword is described in Table 1.
Table 1. Keywords for Cryptographic Resource Deallocate control information
Keyword Description
Cryptographic resource (Required)
DEVICE Specifies a CEX*C coprocessor by resource number. The resource_name variable must point to a buffer containing "CRPxx" (length of 5) where 'xx' is the decimal number of the resource in the range '01' to '65'. Note that the panel.exe utility shows the card numbers starting from 0, and the resource number is obtained by adding '1' to the card number.

Example: To specify card number 5 as identified by panel.exe -x, use resource number 6. The user of CSUACRD:"DEVICE" will set resource_name to "CRP06", and resource_name_length to 5.
SERIAL Specifies a CEX*C coprocessor by serial number. The resource_name variable must point to a buffer containing "xxxxxxxx", the 8 character serial number as shown by the panel.exe utility or returned by the CSUACFQ verb. Note that the panel.exe -x command shows the card serial number in this format: 'SER [xxxxxxxx]', along with other output.
Example: The serial number is shown by the command panel.exe -x to be xx1234xx, as part of this output: 
CARD [0: CEX5C] SER [xx1234xx] CCA Vers:Date ....
The user of CSUACRD:"SERIAL " will set resource_name to xx1234xx, and resource_name_length to 8.
DEV-ANY Specifies to disable the AUTOSELECT option. Verbs will now all use the default adapter or a previously configured "selected" adapter as chosen via CSUACRA. See Multi-coprocessor selection capabilities for more information.
HCPUACLR Specifies the use of host CPU assist for clear keys. This keyword enables clear key use of the CPACF, for clear key AES encryption and decryption with hash algorithms: SHA-1, SHA-224, SHA-256, SHA-384, and SHA-512. This is the default state at the time of the first use of the CCA library by a PID or TID.
HCPUAPRT Specifies the use of host CPU assist for protected keys. This keyword disables protected key use of the CPACF for protected key AES and DES, TDES, and MAC. This is the default state at the time of the first use of the CCA library by a PID or TID.
Domain selection (One, optional)
DOMN-DEF This keyword specifies to return to using the domain value from other sources for the card specified with this process. The CCA library returns to using the domain specified in the environment variable CSU_DEFAULT_DOMAIN, or if none is specified, then the domain used is the domain given by the ap device driver. This keyword may be combined with keywords SERIAL or DEVICE.

There is an environment variable that also impacts the default card: CSU_DEFAULT_ADAPTER (see Multi-coprocessor selection capabilities). There are also environment variables that influence CPACF support (see Environment variables that affect CPACF usage).

The actual hardware configuration determines what features are available, and CCA uses what exists if the user sets these values as desired, with respect to appropriate defaults.

resource_name_length
The resource_name_length parameter is a pointer to an integer variable containing the number of bytes of data in the resource_name variable. The length must be 1 - 64.
resource_name
The resource_name parameter is a pointer to a string variable containing the name of the coprocessor to be deallocated.