Translate Key Store (QC3TRNKS, Qc3TranslateKeyStore)

Required Parameter Group:

1	Key store 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 Key Store (OPM, QC3TRNKS; ILE, Qc3TranslateKeyStore) API translates keys stored in the specified key store 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 key store, refer to Cryptographic Services Key Store.

Authorities and Locks

Required file authority

*OBJOPR, *READ, *UPD

Required Parameter Group

Key store file list

INPUT; CHAR(*)

The list of key store files to re-encrypt. This parameter has the following structure.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	BINARY(4)	Number of key store files
This field repeats.		CHAR(20)	Qualified key store file name

Number of key store files: The number of qualified key store file names specified in this structure.
Qualified key store file name: The name of a key store file to re-encrypt. The first 10 characters contain the file name. The second 10 characters contain the name of the library where the key store file is located.

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.
CPF9D96 E	Key store file requires recovery.
CPF9D9F E	Not authorized to key store file.
CPF9DA0 E	Error occured opening key store file.
CPF9DA5 E	Key store file not found.
CPF9DA6 E	The key store file is not available.
CPF9DA7 E	File is corrupt or not a valid key store file.
CPF9DAB E	A key can not be decrypted.
CPF9DAD E	The master key ID is not valid.
CPF9DB3 E	Qualified key store file name not valid.
CPF9DB7 E	Error occured writing to key store.
CPF9DB8 E	Error occured retrieving key record from key store.
CPF9DC1 E	Number of key store files not valid.
CPF9DDA E	Unexpected return code &1.

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.

CPF9D96 E

Key store file requires recovery.

CPF9D9F E

Not authorized to key store file.

CPF9DA0 E

Error occured opening key store file.

CPF9DA5 E

Key store file not found.

CPF9DA6 E

The key store file is not available.

CPF9DA7 E

File is corrupt or not a valid key store file.

CPF9DAB E

A key can not be decrypted.

CPF9DAD E

The master key ID is not valid.

CPF9DB3 E

Qualified key store file name not valid.

CPF9DB7 E

Error occured writing to key store.

CPF9DB8 E

Error occured retrieving key record from key store.

CPF9DC1 E

Number of key store files not valid.

CPF9DDA E

Unexpected return code &1.