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 indicates 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 valid values are 0 and 1.

rule_array
Direction: InputType: Character String

Keywords that provides control information to the callable service. The processing method is the encryption mode used to encrypt the message.

Table 206. Rule Array Keywords for Secure Messaging for Keys
KeywordMeaning
Enciphering mode (optional)
TDES-CBCUse CBC mode to encipher the message (default).
TDES-ECBUse EBC mode to encipher the message.
input_key_identifier
Direction: Input/OutputType: String

The internal token, external token, or key label of an internal token of a double length DES key. The key is recovered in the clear and placed in the text to be encrypted. The control vector of the DES key must not prohibit export.

key_encrypting_key_identifier
Direction: Input/OutputType: String

If the input_key_identifier is an external token, then this parameter is the internal token or the key label of the internal token of IMPORTER or EXPORTER. If it is not, it is a null token. If a key label is specified, the key label must be unique.

secmsg_key_identifier
Direction: Input/OutputType: String

The internal token or key label of a secure message key for encrypting keys. This key is used to encrypt the updated clear_text containing the recovered DES key.

text_length
Direction: InputType: Integer

The length of the clear_text parameter that follows. Length must be a multiple of eight. Maximum length is 4K.

clear_text
Direction: InputType: String

Clear text that contains the recovered DES key at the offset specified and is then encrypted. Any padding or formatting of the message must be done by the caller on input.

initialization_vector
Direction: InputType: String

The 8-byte supplied string for the TDES-CBC mode of encryption. The initialization_vector is XORed with the first 8 bytes of clear_text prior to encryption. This field is ignored for TDES-ECB mode.

key_offset
Direction: InputType: Integer

The offset within the clear_text parameter at key_offset where the recovered clear input_key_identifier value is to be placed. The first byte of the clear_text field is offset 0.

key_offset_field_length
Direction: InputType: Integer

The length of the field within clear_text parameter at key_offset where the recovered clear input_key_identifier value is to be placed. Length must be a multiple of eight and is equal to the key length of the recovered key. The key must fit entirely within the clear_text.

enciphered_text
Direction: OutputType: String

The field where the enciphered text is returned. The length of this field must be at least as long as the clear_text field.

output_chaining_vector
Direction: OutputType: String

This field contains the last 8 bytes of enciphered text and is used as the initialization_vector for the next encryption call if data needs to be chained for TDES-CBC mode. No data is returned for TDES-ECB.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014