z/OS Cryptographic Services ICSF Application Programmer's Guide
Previous topic | Next topic | Contents | Index | Contact z/OS | Library | PDF


Parameters

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

return_code
Direction: OutputType: 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: OutputType: 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/OutputType: 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/OutputType: String

The data that is passed to the installation exit.

rule_array_count
Direction: InputType: Integer

The number of keywords you are supplying in the rule_array parameter. The rule_array_count parameter must be 0, 1, or 2.

rule_array
Direction: InputType: String

The rule_array contains keywords that provide control information to the callable service. The keywords are 8 bytes in length and must be left-aligned and padded on the right with space characters. The rule_array keywords for this callable service are shown in the following table.

Table 183. Keywords for CVV Key Combine Rule Array Control Information
KeywordMeaning
Key Wrapping Method (One Optional)
USECONFGSpecifies that the configuration setting for the default wrapping method is to be used to wrap the key. This is the default.
WRAP-ENHSpecifies that the new enhanced wrapping method is to be used to wrap the key.
WRAP-ECBSpecifies that the original wrapping method is to be used.
Translation Control (One Optional)
ENH-ONLYSpecify this keyword to indicate that the key once wrapped with the enhanced method cannot be wrapped with the original method. This restricts translation to the original method. If the keyword is not specified translation to the original method will be allowed. This turns on bit 56 in the control vector. This keyword is not valid if processing a zero CV data key.
Note:
If the default wrapping method is ECB mode, but the enhanced mode and the ENH-ONLY restriction are desired for a particular key token, combine the ENH-ONLY keyword with the WRAP-ENH keyword. If this is not done, then an error will be returned because ENH-ONLY will conflict with the default wrapping mode if the default wrapping method is ECB mode.
key_a_identifier_length
Direction: InputType: Integer
This parameter specifies the length of the key_a_identifier parameter, in bytes. The value must be 64.
key_a_identifier
Direction: InputType: String
This parameter contains a 64-byte internal key token or a label of a single-length zero CV DATA key, a DATA key with the MAC gen and/or verify bits on, or a CVVKEY-A key. The internal key token contains the key-A key that encrypts information in the CVV process.
key_b_identifier_length
Direction: InputType: Integer
This parameter specifies the length of the key_b_identifier parameter, in bytes. The value in this parameter must be 64.
key_b_identifier
Direction: InputType: String
This parameter contains a 64-byte internal key token or a label of a single-length zero CV DATA key, a DATA key with the MAC gen and/or verify bits on, or a CVVKEY-B key. The internal key token contains the key-B key that decrypts information in the CVV process.
output_key_identifier_length
Direction: InputType: Integer
This parameter specifies the length of the output_key_identifier parameter, in bytes. The value in this parameter must be 64.
output_key_identifier
Direction: OutputType: String
This parameter contains the output key token. It is either a double-length DATA key or a MAC key with CV bits 0-3 set to 0010 to indicate a CVVKEY-A key.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014