Clear Master Key Exit Program


  Required Parameter Group:

1 Clear master key exit information Input Char(*)
2 Action Input Char(1)
3 Clear status Output Char(*)

  QSYSINC Member Name: ECLRMST

  Exit Point Name: QIBM_QC3_CLR_MSTKEY

  Exit Point Format Name: CLMK0100

The Clear Master Key exit program is called when the Clear Master Key (CLRMSTKEY) CL command, the Qc3ClearMasterKey API, or the Clear Master Key dialog 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

Clear master key exit information
INPUT; CHAR(*)

Information that is needed by the exit program for notification of any master key that is to be cleared. For details, see Format of Clear 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 cleared. The exit program should determine if the master key can be cleared and perform any necessary pre-processing actions. The exit program should set the Clear master key status value appropriately.
2 Execute The exit program is being called after a master key has been cleared 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 Clear status indicating the master key is not eligible to be cleared. You may need to back out pre-processing actions.
Clear 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 Clear Master Key Exit Information

The following table shows the structure of the clear 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) Clear master key exit information length
4 4 Binary(4) Master key ID
8 8 Char(1) Master key version


Format of Status Information

The following table shows the structure of the clear status information. For a description of the fields in this format, see Field Descriptions.

Offset Type Field
Dec Hex
0 0 Binary(4) Clear master key status information length
4 4 Char(1) Clear master key status


Field Descriptions

Clear master key exit information length. The length in bytes of all data passed to the clear master key exit program.

Clear master key status. The status value that indicates whether the exit program considers the master key eligible to be cleared. The possible values are:

0 The master key is not eligible to be cleared. Therefore, the clear master key command or clear master key API will be ended, and the master key will not be cleared.
1 The master key is eligible to be cleared.

Clear master key status length. The length in bytes of the clear status information.

Master key ID. The ID of the master key that is being cleared. The possible values are:

ID This is a value in the range of 1 - 8 and corresponds to the corresponding general purpose master key ID.
-1 ASP master key
-2 Save/restore master key

Master key version.The version of the master key that is being cleared. The possible values are:

0 New version.
1 Current version
2 Old version
3 Pending version

Exit program introduced: V6R1

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