Load Master Key Part (QC3LDMKP, Qc3LoadMasterKeyPart) API
Required Parameter Group:
| 1 | Master key ID | Input | Binary(4) |
| 2 | Passphrase | Input | Char(*) |
| 3 | Length of passphrase | Input | Binary(4) |
| 4 | CCSID of passphrase | Input | Binary(4) |
| 5 | Error code | I/O | Char(*) |
Service Program Name: QC3MKPLD
Default Public Authority: *EXCLUDE
Threadsafe: Yes
The Load Master Key Part (OPM, QC3LDMKP; ILE, Qc3LoadMasterKeyPart) API loads a key part for the specified master key by hashing the specified passphrase and adding it into the new master key version.
For more information about master keys, see Cryptographic services key management.
Authorities and Locks
- Required special authority
- *ALLOBJ and *SECADM
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
- Passphrase
- INPUT; CHAR(*)
A text string.
- Length of passphrase
- INPUT; BINARY(4)
The length of text specified in the passphrase parameter. The length must be in the range of 1 to 256.
- CCSID of passphrase
- INPUT; BINARY(4)
The CCSID of the passphrase. The passphrase will be converted from the specified CCSID to Unicode before creating the key part.
0 The CCSID of the job is used to determine the CCSID of the data to be converted. If the job CCSID is 65535, the CCSID from the default CCSID (DFTCCSID) job attribute is used. 1-65533 A valid CCSID in this range is used. For a list of valid CCSIDs, see the i5/OS globalization topic collection.
- 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 |
|---|---|
| CPF222E E | &1 special authority is required. |
| 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. |
| CPF9DB1 E | The CCSID is not valid. |
| CPF9DB2 E | The length of passphrase is not valid. |
| CPF9DDA E | Unexpected return code &1. |
API introduced: V5R4
[ Back to top | Cryptographic Services APIs | APIs by category ]