Test Master Key (QC3TSTMK, Qc3TestMasterKey) API


  Required Parameter Group:

1 Master key ID Input Binary(4)
2 Master key version Input Char(1)
3 Key verification value Output Char(20)
4 Error code I/O Char(*)

 Service Program Name: QC3MKTST

 Default Public Authority: *EXCLUDE

 Threadsafe: Yes

The Test Master Key (OPM, QC3TSTMK; ILE, Qc3TestMasterKey) API returns the key verification value for the specified master key.

For more information about master keys, see Cryptographic Services Key Management.


Authorities and Locks

No special authorities required.


Required Parameter Group

Master key ID
INPUT; 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
-1 ASP master key
-2 Save/restore master key
If the returned KVV value is hexadecimal '16C1D3E3C073E77DB28F33E81EC165313318CE54', the Save/Restore Master Key is set to its default value. The default value is not a secure setting for saving the master keys (via a SAVSYS operation). To properly secure your master keys on the next SAVSYS operation, set the Save/Restore Master Key by using the Load Master Key Part (OPM, QC3LDMKP; ILE, Qc3LoadMasterKeyPart) API and the Set Master Key (OPM, QC3SETMK; ILE, QcSetMasterKey) API.

Master key version
INPUT; CHAR(1)

The old or current version of the master key

0 New version
1 Current version
2 Old version
3 Pending version
Not valid for *SAVRST Master Key.

Key Verification Value
OUTPUT; CHAR(20)

The key verification value can be used to determine if the master key has changed.

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.
CPF9DAD E The master key ID is not valid.
CPF9DAE E The master key version is not valid.
CPF9DAF E Version &2 of master key &1 is not set.
CPF9DDA E Unexpected return code &1.


API introduced: V5R4

[ Back to top | Cryptographic Services APIs | APIs by category ]