Prohibit Export (CSNBPEX and CSNEPEX)

Use this service to modify an exportable internal DES key token so that it cannot be exported.

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

Format

CALL CSNBPEX(
              return_code,
              reason_code,
              exit_data_length,
              exit_data,
              key_identifier)

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

key_identifier
Direction Type
Input/Output String

A 64-byte string variable containing the internal key token to be modified. The returned key_identifier will be encrypted under the current master key.

ICSF supports two methods of wrapping the key value in a symmetric key token: the original ECB wrapping and an enhanced CBC wrapping method which is ANSI X9.24 compliant. The output key_identifier will be wrapped in the same manner as the input key_identifier.

Usage notes

SAF may be invoked to verify the caller is authorized to use this callable service, the key label, or internal secure key tokens that are stored in the CKDS or PKDS.

Access control point

The Prohibit Export access control point controls the function of this service.

Required hardware

This table lists the required cryptographic hardware for each server type and describes restrictions for this callable service.

Table 1. Prohibit export required hardware
Server Required cryptographic hardware Restrictions

IBM eServer zSeries 990
IBM eServer zSeries 890

PCI X Cryptographic Coprocessor

Crypto Express2 Coprocessor

DATA keys are not supported. Old, internal DATAM and DATAMV keys are not supported.

IBM System z9 EC
IBM System z9 BC

Crypto Express2 Coprocessor DATA keys are not supported. Old, internal DATAM and DATAMV keys are not supported.

IBM System z10 EC
IBM System z10 BC

Crypto Express2 Coprocessor

Crypto Express3 Coprocessor

DATA keys are not supported. Old, internal DATAM and DATAMV keys are not supported.

IBM zEnterprise 196
IBM zEnterprise 114

Crypto Express3 Coprocessor DATA keys are not supported. Old, internal DATAM and DATAMV keys are not supported.

IBM zEnterprise EC12
IBM zEnterprise BC12

Crypto Express3 Coprocessor

Crypto Express4 CCA Coprocessor

DATA keys are not supported. Old, internal DATAM and DATAMV keys are not supported.

IBM z13

Crypto Express5 CCA Coprocessor DATA keys are not supported. Old, internal DATAM and DATAMV keys are not supported.