Set Master Key Exit Program
Required Parameter Group:
| 1 | Set master key exit information | Input | Char(*) |
| 2 | Action | Input | Char(1) |
| 3 | Set status | Output | Char(*) |
QSYSINC Member Name: ESETMST
Exit Point Name: QIBM_QC3_SET_MSTKEY
Exit Point Format Name: STMK0100
The Set Master Key exit program is called when the Set Master Key (SETMSTKEY) CL command, the Qc3SetMasterKey API, or the set action of the Manage Master Keys panel in System i® Navigator is being used.
The operating system calls the user-written exit programs through the registration facility.
The exit point supports an unlimited number of exit programs. For information about adding an exit program to an exit point, see the Registration Facility.
Authorities and Locks
None.
Required Parameter Group
- Set master key exit information
- INPUT; CHAR(*)
Information that is needed by the exit program for notification of any master key that has been set. For details, see Format of Set Master Key Exit Information.
- Action
- INPUT; CHAR(1)
The type of exit program call being made. The following actions may be requested:
1 Check The exit program is being called before the master key is set. The exit program should determine if the master key can be set and perform any necessary pre-processing actions. The exit program should set the Set master key status value appropriately. 2 Execute The exit program is being called after a master key has been set successfully. The exit program should perform any necessary post-processing actions. 3 Cancel The exit program is being called because another exit program has returned a Set status indicating the master key is not eligible to be set. You may need to back out pre-processing actions. - Set status
- OUTPUT; CHAR(*)
Information that is returned by the exit program. For details, see Format of Status Information.
Note: The information returned is ignored when the action parameter is set to 2 or 3.
Format of Set Master Key Exit Information
The following table shows the structure of the set master key exit information. For a description of the fields in this format, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Binary(4) | Set master key exit information length |
| 4 | 4 | Binary(4) | Master key ID |
| 8 | 8 | Char(20) | Master key verification value |
Format of Status Information
The following table shows the structure of the set status information. For a description of the fields in this format, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Binary(4) | Set master key status information length |
| 4 | 4 | Char(1) | Set master key status |
Field Descriptions
Master key ID. The ID of the master key that is being set. The possible values are:
| ID | This is a value in the range of 1 - 8 and corresponds to the general purpose master key ID. |
| -1 | ASP master key |
| -2 | Save/restore master key |
Master key verification value. When the action parameter is set to 2, this will contain the key verification value of the master key that was just previously set. Otherwise it will be set to zeros.
Set master key exit information length. The length in bytes of all data passed to the set master key exit program.
Set master key status. The status value that indicates whether the exit program considers the master key eligible to be set. The possible values are:
| 0 | The master key is not eligible to be set. Therefore, the set master key command or set master key API will be ended, and the master key will not be set. |
| 1 | The master key is eligible to be set. |
Set master key status length. The length in bytes of the set status information.
Exit program introduced: V6R1
[ Back to top | Cryptographic Services APIs | APIs by category ]