Translate Keystore (QC3TRNKS, Qc3TranslateKeyStore) API
Required Parameter Group:
| 1 | Keystore file list | Input | Char(*) |
| 2 | Master key ID | Input | Binary(4) |
| 3 | Error code | I/O | Char(*) |
Service Program Name: QC3KSTRN
Default Public Authority: *USE
Threadsafe: Yes
The Translate Keystore (OPM, QC3TRNKS; ILE, Qc3TranslateKeyStore) API translates keys stored in the specified keystore files to another master key, or if the same master key is specified, to the current version of the master key.
If an error occurs, processing halts immediately.
For more information about cryptographic services keystore, see Cryptographic Services Key Management.
Authorities and Locks
- Required file authority
- *OBJOPR, *READ, *UPD
Required Parameter Group
- Keystore file list
- INPUT; CHAR(*)
The list of keystore files to re-encrypt. This parameter has the following structure.
Offset Type Field Dec Hex 0 0 BINARY(4) Number of keystore files This field repeats. CHAR(20) Qualified keystore file name
- Number of keystore files
- The number of qualified keystore file names specified in this
structure.
- Qualified keystore file name
- The name of a keystore file to re-encrypt. The first 10 characters
contain the file name. The second 10 characters contain the name of the library
where the keystore file is located.
You can use the following special values for the library name.*CURLIB The job's current library is used to locate the keystore file. If no library is specified as the current library for the job, the QGPL library is used. *LIBL The job's library list is searched for the first occurence of the specified file name.
- Master key ID
- INPUT; BINARY(4)
The master key under which the keys will be re-encrypted.
1 Master key 1 2 Master key 2 3 Master key 3 4 Master key 4 5 Master key 5 6 Master key 6 7 Master key 7 8 Master key 8
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPF9D88 E | An error occurred during exit program post-processing. |
| CPF9D89 E | An error occurred during exit program pre-processing. |
| CPF9D8E E | Keystore &1 in library &2 not translated due to exit program cancel. |
| CPF9D94 E | A pending value exists for a master key. |
| CPF9D96 E | Keystore file requires recovery. |
| CPF9D9F E | Not authorized to keystore file. |
| CPF9DA0 E | Error occured opening keystore file. |
| CPF9DA5 E | Keystore file not found. |
| CPF9DA6 E | The keystore file is not available. |
| CPF9DA7 E | File is corrupt or not a valid keystore file. |
| CPF9DAB E | A key can not be decrypted. |
| CPF9DAD E | The master key ID is not valid. |
| CPF9DB3 E | Qualified keystore file name not valid. |
| CPF9DB7 E | Error occured writing to keystore. |
| CPF9DB8 E | Error occured retrieving key record from keystore. |
| CPF9DC1 E | Number of keystore files not valid. |
| CPF9DDA E | Unexpected return code &1. |
API introduced: V5R4
[ Back to top | Cryptographic Services APIs | APIs by category ]