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 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.

text_length
Direction: InputType: Integer

The length of the text you supply in the text parameter. The maximum length of text is 214783647 bytes.

Note:
The MAXLEN value may still be specified in the options data set, but only the maximum value limit will be enforced (2147483647).

Additional restrictions on length of the text depend on whether padding of the text is requested, and on the segmenting control used.

  • When padding is requested (by specifying a process rule of PADMDC-2 or PADMDC-4 in the rule_array parameter), a text length of 0 is valid for any segment control specified in the rule_array parameter (FIRST, MIDDLE, LAST, or ONLY). When LAST or ONLY is specified, the supplied text will be padded with X'FF's and a padding count in the last byte to bring the total text length to the next multiple of 8 that is greater than or equal to 16,
  • When no padding is requested (by specifying a process rule of MDC-2 or MDC-4), the total length of the text provided (over a single or segmented calls) must be at least 16 bytes, and a multiple of 8.

    For segmented calls with no padding, text length of 0 is valid on any of the calls provided the total length over the segmented calls is at least 16 and a multiple of 8.

    For a single call (that is, segment control is ONLY) with no padding, the length the text provided must be at least 16, and a multiple of 8.

text
Direction: InputType: String

The application-supplied text for which the MDC is generated.

rule_array_count
Direction: InputType: Integer

The number of keywords specified in the rule_array parameter. This value must be 2.

rule_array
Direction: InputType: Character string

The two keywords that provide control information to the callable service are shown in Table 153. The two keywords must be in 16 bytes of contiguous storage with each of the two keywords left-justified in its own 8-byte location and padded on the right with blanks. For example,

'MDC-2   FIRST   '

Choose one of the MDC process rule control keywords and one of the segmenting control keywords from the following table.

Table 153. Keywords for MDC Generate Control Information
KeywordMeaning
MDC Process Rules (required)
MDC-2MDC-2 specifies two encipherments per 8 bytes of input text and no padding of the input text.
MDC-4MDC-4 specifies four encipherments per 8 bytes of input text and no padding of the input text.
PADMDC-2PADMDC-2 specifies two encipherments per 8 bytes of input text and padding of the input text.

When the segment rule specifies ONLY or LAST, the input text is padded with X'FF's and a padding count in the last byte to bring the total text length to the next even multiple of 8 that is greater than, or equal to, 16.

PADMDC-4PADMDC-4 specifies four encipherments per 8 bytes of input text and padding of the input text.

When the segment rule specifies ONLY or LAST, the input text is padded with X'FF's and a padding count in the last byte to bring the total text length to the next even multiple of 8 that is greater than, or equal to, 16.

Segmenting Control (required)
FIRSTFirst call; this is the first segment of data from the application program.
LASTLast call; this is the last data segment.
MIDDLEMiddle call; this is an intermediate data segment.
ONLYOnly call; segmenting is not employed by the application program.
chaining_vector
Direction: Input/OutputType: String

An 18-byte string that ICSF uses as a system work area. Your application program must not change the data in this string. The chaining vector permits data to be chained from one invocation call to another.

On the first call, initialize this parameter as binary zeros.

mdc
Direction: Input/OutputType: String
A 16-byte field in which the callable service returns the MDC value when the segmenting rule is ONLY or LAST. When the segmenting rule is FIRST or MIDDLE, the value returned in this field is an intermediate MDC value that will be used as input for a subsequent call and must not be changed by the application program.
text_id_in
Direction: InputType: Integer
For CSNBMDG1/CSNEMDG1 only, the ALET for the data space containing the text for which the MDC is to be generated.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014