PKDS Key Record Read (CSNDKRR and CSNFKRR)

Reads a record from the PKDS and returns the content of the record. This is true even when the record contains a null PKA token.

The callable service name for AMODE(64) invocation is CSNFKRR.

Format

CALL CSNDKRR(
             return_code,
             reason_code,
             exit_data_length,
             exit_data,
             rule_array_count,
             rule_array,
             label,
             token_length,
             token)

Parameters

return_code

Direction	Type
Output	Integer

The return code specifies the general result of the callable service. ICSF and cryptographic coprocessor return and reason codes lists the return codes.

reason_code

Direction	Type
Output	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. ICSF and cryptographic coprocessor return and reason codes lists the reason codes.

exit_data_length

Direction	Type
Input/Output	Integer

The length of the data that is passed to the installation exit. The data is identified in the exit_data parameter.

exit_data

Direction	Type
Input/Output	String

The data that is passed to the installation exit.

rule_array_count

Direction	Type
Input	Integer

The number of keywords you are supplying in the rule_array parameter. This parameter is ignored by ICSF.

rule_array

Direction	Type
Input	String

This parameter is ignored by ICSF.

label

Direction	Type
Input	String

The label of the record to be read. A 64 byte character string.

token_length

Direction	Type
Input/Output	Integer

The length of the area to which the record is to be returned. On successful completion of this service, token_length will contain the actual length of the record returned.

token

Direction	Type
Output	String

Area into which the returned record will be written. The area should be at least as long as the record.

Usage notes

To use this service, PKA callable services must be enabled for all RSA and DSS token types. For systems with CEX3C or later coprocessors, there is no PKA callable services control. The RSA master key must be valid to use this service.

While DSS tokens can be processed by this service, they are not useable by any other callable services.

To use this service for clear key ECC tokens, a current ECC master key is not required.

To use this service for encrypted key ECC tokens, the ECC master key must be valid.

Required hardware

No cryptographic hardware is required by this callable service.