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 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'7FFFFFFFFF' (2 gigabytes). The data is defined in the exit_data parameter.

exit_data

Direction: Input/Output

Type: String

The data that is passed to the installation exit.

PIN_generating_key_identifier

Direction: Input/Output

Type: Character string

The 64-byte key label or internal key token that identifies the PIN generation (PINGEN) key. If the PIN_generating_key_identifier identifies a key which does not have the default PIN generation key control vector, the request will be routed to a PCI Cryptographic Coprocessor.

rule_array_count

Direction: Input

Type: Integer

The number of process rules specified in the rule_array parameter. The value must be 1.

rule_array

Direction: Input

Type: Character string

The process rule provides control information to the callable service. Specify one of the values in Table 171. The keyword is left-justified in an 8-byte field, and padded on the right with blanks.

Table 171. Process Rules for the Clear PIN Generate Callable Service
Process Rule	Description
GBP-PIN	The IBM German Bank Pool PIN, which uses the institution PINGEN key to generate an institution PIN (IPIN).
GBP-PINO	The IBM German Bank Pool PIN offset, which uses the pool PINGEN key to generate a pool PIN (PPIN). It uses the institution PIN (IPIN) as input and calculates the PIN offset, which is the output. GBP-PINO is not supported on an IBM zSeries 990 and subsequent releases.
IBM-PIN	The IBM 3624 PIN, which is an institution-assigned PIN. It does not calculate the PIN offset.
IBM-PINO	The IBM 3624 PIN offset, which is a customer-selected PIN and calculates the PIN offset (the output).
INBK-PIN	The Interbank PIN is generated.
VISA-PVV	The VISA PIN validation value. Input is the customer PIN.

PIN_length

Direction: Input

Type: Integer

The length of the PIN used for the IBM algorithms only, IBM-PIN or IBM-PINO. Otherwise, this parameter is ignored. Specify an integer from 4 through 16. If the length is greater than 12, the request will be routed to the PCI Cryptographic Coprocessor.

PIN_check_length

Direction: Input

Type: Integer

The length of the PIN offset used for the IBM-PINO process rule only. Otherwise, this parameter is ignored. Specify an integer from 4 through 16.

Note:

The PIN check length must be less than or equal to the integer specified in the PIN_length parameter.

data_array

Direction: Input

Type: String

Three 16-byte data elements required by the corresponding rule_array parameter. The data array consists of three 16-byte fields or elements whose specification depends on the process rule. If a process rule only requires one or two 16-byte fields, then the rest of the data array is ignored by the callable service. Table 172 describes the array elements.

Table 172. Array Elements for the Clear PIN Generate Callable Service
Array Element	Description
Clear_PIN	Clear user selected PIN of 4 to 12 digits of 0 through 9. Left-justified and padded with spaces. For IBM-PINO, this is the clear customer PIN (CSPIN). For GBP-PINO, this is the institution PIN. For IBM-PIN and GBP-PIN, this field is ignored.
Decimalization_table	Decimalization table for IBM and GBP only. Sixteen digits of 0 through 9. Note: If the ANSI X9.8 PIN - Use stored decimalization tables only access control point is enabled in the ICSF role, this table must match one of the active decimalization tables in the coprocessors.
Trans_sec_parm	For VISA only, the leftmost sixteen digits. Eleven digits of the personal account number (PAN). One digit key index. Four digits of customer selected PIN. For Interbank only, sixteen digits. Eleven right-most digits of the personal account number (PAN). A constant of 6. One digit key selector index. Three digits of PIN validation data.
Validation_data	Validation data for IBM and IBM German Bank Pool padded to 16 bytes. One to sixteen characters of hexadecimal account data left-justified and padded on the right with blanks.

Table 173 lists the data array elements required by the process rule (rule_array parameter). The numbers refer to the process rule’s position within the array.

Table 173. Array Elements Required by the Process Rule
Process Rule	IBM-PIN	IBM-PINO	GBP-PIN	GBP-PINO	VISA-PVV	INBK-PIN
Decimalization_table	1	1	1	1
Validation_data	2	2	2	2
Clear_PIN		3		3
Trans_sec_parm					1	1

Note:

Generate offset for GBP algorithm is equivalent to IBM offset generation with PIN_check_length of 4 and PIN_length of 6.

returned_result

Direction: Output

Type: Character string

The 16-byte generated output, left-justified and padded on the right with blanks.

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