Parameters

z/OS Cryptographic Services ICSF Application Programmer's Guide

Parameters

z/OS Cryptographic Services ICSF Application Programmer's Guide
SA22-7522-16

return_code

Direction: Output

Type: Integer

The return code specifies the general result of the callable service. Appendix A. ICSF and TSS Return and Reason Codes lists the return codes.

reason_code

Direction: Output

Type: Integer

The reason code specifies the result of the callable service that is returned to the application program. Each return code has different reason codes assigned to it that indicate specific processing problems. Appendix A. ICSF and TSS Return and Reason Codes lists the reason codes.

exit_data_length

Direction: Input/Output

Type: Integer

The length of the data that is passed to the installation exit. The length can be from X'00000000' to X'7FFFFFFF' (2 gigabytes). The data is identified in the exit_data parameter.

exit_data

Direction: Input/Output

Type: String

The data that is passed to the installation exit.

rule_array_count

Direction: Input

Type: Integer

The number of keywords you supplied in the rule_array parameter. The value can be 2, 3 or 4.

rule_array

Direction: Input

Type: String

Keywords provide control information to the callable service. Table 52 lists the keywords. The keywords must be in contiguous storage with each of the keywords left-justified in its own 8-byte location and padded on the right with blanks.

Table 52. Keywords for Key Test Control Information
Keyword	Meaning
Key or key part rule (one keyword required)
CLR-A128	Process a 128–bit AES clear key.
CLR-A192	Process a 192–bit AES clear key.
CLR-A256	Process a 256–bit AES clear key.
KEY-CLR	Specifies the key supplied in `key_identifier` is a single-length clear key.
KEY-CLRD	Specifies the key supplied in `key_identifier` is a double-length clear key.
KEY-ENC	Specifies the key supplied in `key_identifier` is a single-length encrypted key.
KEY-ENCD	Specifies the key supplied in `key_identifier` is a double-length encrypted key.
TOKEN	Process an AES clear or encrypted key token.
Process Rule (one keyword required)
GENERATE	Generate a verification pattern for the key supplied in `key_identifier`.
VERIFY	Verify a verification pattern for the key supplied in `key_identifier`.
Parity Adjustment - can not be specified with any of the AES keywords (optional)
ADJUST	Adjust the parity of test key to odd prior to generating or verifying the verification pattern. The `key_identifier` field itself is not adjusted.
NOADJUST	Do not adjust the parity of test key to odd prior to generating or verifying the verification pattern. This is the default.
Verification Process Rule (optional)
ENC-ZERO	ENC-ZERO can be used with any of the rules. It is not supported on systems with CCFs.
SHA-256	Use the 'SHA-256' method. Use with CLR-A128, CLR-A192, CLR-A256, and TOKEN. SHA-256 is also the default for the AES rules.

key_identifier

Direction: Input/Output

Type: String

The key for which to generate or verify the verification pattern. The parameter is a 64-byte string of an internal token, key label, or a clear key value left-justified.

Note:

If you supply a key label for this parameter, it must be unique on the CKDS.

random_number

Direction: Input/Output

Type: String

This is an 8-byte field that contains a random number supplied as input for the test pattern verification process and returned as output with the test pattern generation process. random_number is only used with the default algorithm for DES operational keys.

verification_pattern

Direction: Input/Output

Type: String

This is an 8-byte field that contains a verification pattern supplied as input for the test pattern verification process and returned as output with the test pattern generation process.

Notices | Terms of use | Support | Contact z/OS | zFavorites