Retrieve Key Record Attributes (QC3RTVKA, Qc3RetrieveKeyRecordAtr)

The Retrieve Key Record Attributes (OPM, QC3RTVKA; ILE, Qc3RetrieveKeyRecordAtr) API returns the key type and key size of a key stored in a key store file. It also identifies the master key under which the stored key is encrypted and the master key's KVV.

For more information about cryptographic services key store, refer to Cryptographic Services Key Store.

Authorities and Locks

Required file authority

*OBJOPR, *READ

Required Parameter Group

Qualified key store file name

INPUT; CHAR(20)

The key store file where the key is stored. 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.

You can use the following special values for the library name.

*CURLIB	The job's current library is used to locate the key store 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.

Record label

INPUT; CHAR(32)

The label of the key record. The label will be converted from the job CCSID, or if 65535, the job default CCSID (DFTCCSID) job attribute to CCSID 1200 (Unicode UTF-16).

Key type

OUTPUT; BINARY(4)

The type of key.
The output values have the following meanings.

1	MD5
2	SHA-1
3	SHA-256
4	SHA-384
5	SHA-512
20	DES
21	Triple DES
22	AES
23	RC2
30	RC4-compatible
50	RSA public
51	RSA public and private

Key size

OUTPUT; BINARY(4)

Key size in bits.

Master key ID

OUTPUT; BINARY(4)

The master key IDs are

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

Master key verification value

OUTPUT; CHAR(20)

The KVV for the master key at the time the key was encrypted. This can be compared with the current master key KVV to determine if the key must be re-encrypted.

Disallowed function

OUTPUT; BINARY(4)

The functions that cannot be used with this key. The values listed below can be added together to disallow multiple functions. For example, a key that disallows everything but MACing would have a value of 11.

0	No functions are disallowed.
1	Encryption is disallowed.
2	Decryption is disallowed.
4	MACing is disallowed.
8	Signing is disallowed.

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