z/OS Cryptographic Services ICSF Application Programmer's Guide
Previous topic | Next topic | Contents | Index | Contact z/OS | Library | PDF


Usage Notes

z/OS Cryptographic Services ICSF Application Programmer's Guide
SA22-7522-16

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.

If an RSA public key is specified as the transporter_key_identifier, the hardware configuration sets the limit on the modulus size of keys for key management; thus, this service will fail if the RSA key modulus bit length exceeds this limit.

The strength of the exporter key expected by Symmetric Key Export depends on the attributes of the key being exported. The resulting return code and reason code when using an exporter KEK that is weaker depends on the “Variable-length Symmetric Token - disallow weak wrap" and “Variable-length Symmetric Token - warn when weak wrap" access control points:

  • If the “Variable-length Symmetric Token - disallow weak wrap" access control point is disabled (the default), the key strength requirement will not be enforced. Using a weaker key will result in return code 0 with a non-zero reason code if the “Variable-length Symmetric Token - warn when weak wrap" access control point is enabled. Otherwise, a reason code of zero will be returned.
  • If the “disallow" access control point is enabled (using TKE), the key strength requirement will be enforced, and attempting to use a weaker key will result in return code 8.

For AES DATA and AES CIPHER keys, the AES EXPORTER key must be at least as long as the key being exported to be considered sufficient strength.

For HMAC keys, the AES EXPORTER must be sufficient strength as described in the following table.

Table 96. AES EXPORTER strength required for exporting an HMAC key under an AES EXPORTER
Key-usage field 2 in the HMAC key contains:Minimum strength of AES EXPORTER to adequately protect the HMAC key:
SHA-256, SHA-384, SHA-512256 bits
SHA-224192 bits
SHA-1128 bits

If an RSA public key is specified as the transporter_key_identifier, the RSA key used must have a modulus size greater than or equal to the total PKOAEP2 message bit length (key size + total overhead):

Table 97. Minimum RSA modulus strength required to contain a PKOAEP2 block when exporting an AES key
AES key sizeTotal message sizes (and therefore minimum RSA key size) when the Hash Method is:
SHA-1SHA-256SHA-384SHA-512
128 bits736 bits928 bits1184 bits1440 bits
192 bits800 bits992 bits1248 bits1504 bits
256 bits800 bits1056 bits1312 bits1568 bits
Table 98. Minimum RSA modulus length to adequately protect an AES key
AES key to be exported:Minimum strength of RSA wrapping key to adequately protect the AES key:
AES 1283072
AES 1927860
AES 25615360

Note that wrapping an AES 192-bit key or an AES 256-bit key with any RSA key will always be considered a weak wrap.

The following table shows the access control points in the ICSF role that control the function of this service.

Table 99. Required access control points for Symmetric Key Export
Key formatting methodAlgorithmAccess control point
PKCSOAEPAESSymmetric Key Export - AES, PKCSOAEP, PKCS-1.2
DESSymmetric Key Export - DES, PKCS-1.2
PKCS-1.2AESSymmetric Key Export - AES, PKCSOAEP, PKCS-1.2
DESSymmetric Key Export - DES, PKCS-1.2
ZERO-PADAESSymmetric Key Export - AES, ZERO-PAD
DESSymmetric Key Export - DES, ZERO-PAD
PKOAEP2HMACSymmetric Key Export - HMAC, PKOAEP2
AESSymmetric Key Export - AES, PKOAEP2
AESKWAES or HMACSymmetric Key Export - AESKW
Restricted operationAccess control point
Prohibit wrapping a key with a weaker keyVariable-length Symmetric Token - disallow weak wrap
Issue a non-zero reason code when using a weak wrapping keyVariable-length Symmetric Token - warn when weak wrap

Note that both the “Variable-length Symmetric Token - disallow weak wrap" and “Variable-length Symmetric Token - warn when weak wrap" access control points are disabled in the default role.

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

Table 100. Symmetric key export required hardware
ServerRequired cryptographic hardwareRestrictions

IBM eServer zSeries 900

Cryptographic Coprocessor Feature

RSA keys with moduli greater than 1024-bit length are not supported.

Encrypted AES keys are not supported.

The DES, HMAC, and PKOAEP2 keywords are not supported.

PCI Cryptographic CoprocessorICSF routes this service to a PCI Cryptographic Coprocessor if one is available on your server. This service will not be routed to a PCI Cryptographic Coprocessor if the modulus bit length of the RSA public key is less than 512 bits.

Use of keyword PKCSOAEP requires the PCI Cryptographic Coprocessor and uses the SHA-1 hash method. The SHA-256 keyword is not supported for PKCSOAEP.

RSA keys with moduli greater than 2048-bit length are not supported.

Encrypted AES keys are not supported.

The DES, AESKW, HMAC, and PKOAEP2 keywords are not supported.

IBM eServer zSeries 990

IBM eServer zSeries 890

PCI X Cryptographic Coprocessor

Crypto Express2 Coprocessor

RSA keys with moduli greater than 2048-bit length are not supported.

Encrypted AES keys are not supported.

The AESKW, HMAC, and PKOAEP2 keywords are not supported.

The SHA-256 keyword is not supported for PKCSOAEP.

IBM System z9 EC

IBM System z9 BC

Crypto Express2 Coprocessor

RSA key support with moduli within the range 2048-bit to 4096-bit requires the Nov. 2007 or later licensed internal code (LIC).

Encrypted AES key support requires the Nov. 2008 or later licensed internal code (LIC).

The AESKW, HMAC, and PKOAEP2 keywords are not supported.

The SHA-256 keyword is not supported for PKCSOAEP.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014