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: IgnoredType: Integer

This field is ignored. It is recommended to specify 0 for this parameter.

exit_data
Direction: IgnoredType: String

This field is ignored.

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 because no keywords are currently defined for this callable service.

rule_array
Direction: InputType: String

A rule_array contains keywords that provide control information to the callable service. No rule array keywords are currently defined for this callable service.

TR31_key_block_length
Direction: InputType: Integer

This parameter specifies the length of the TR31_key_block parameter, in bytes. The parameter may specify a length that is greater than the size of the key block (however it can never be greater than the size of the buffer where the key block resides). This value must be between 16 and 9992 inclusive.

TR31_key_block
Direction: InputType: String

This parameter contains the TR-31 key block that is to be parsed.

key_block_version
Direction: OutputType: String

This parameter contains a one-byte character value that indicates the version of the TR-31 key block, parsed from the block itself. CCA only supports versions "A", "B", and "C" key blocks.

key_block_length
Direction: OutputType: Integer

This parameter contains the length of the key block as obtained from the TR-31 key block header. Note that this may be different from the input value in parameter TR31_key_block_length, if the application program specifies a length that is greater than the actual length of the key block.

key_usage
Direction: OutputType: String

This parameter contains a 2-byte string value indicating the TR-31 key usage value for the key contained in the block. The value is obtained from the TR-31 key block header. The usage defines the type of function this key can be used with, such as data encryption, PIN encryption, or key wrapping.

algorithm
Direction: OutputType: String

This parameter contains a one-byte string identifying the cryptographic algorithm the wrapped key is to be used with. The value is read from the TR-31 key block header. CCA only supports "D" for a Single-DES key and "T" for a Triple-DES key.

mode
Direction: OutputType: String

This parameter contains a one-byte string indicating the TR-31 mode of use for the key contained in the block. The value is obtained from the TR-31 key block header. The mode of use describes what operations the key can perform, within the limitations specified with the key usage value. For example, a key with usage for data encryption can have a mode to indicate it may be used for encryption only, decryption only, or both encryption and decryption.

key_version_number
Direction: OutputType: String

This parameter contains a two-byte string obtained from the TR-31 key block header which represents versioning information about the key contained in the block.

exportability
Direction: OutputType: String

This parameter contains a one-byte string indicating the key exportability value from the TR-31 key block header. This value indicates whether the key can be exported from this system, and if so it specifies conditions under which export is permitted.

num_opt_blocks
Direction: OutputType: Integer

This parameter contains the number of optional blocks that are part of the TR-31 key block.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014