Translate Keystore Exit Program
Required Parameter Group:
| 1 | Translate keystore key exit information | Input | Char(*) |
| 2 | Action | Input | Char(1) |
| 3 | Translate status | Output | Char(*) |
QSYSINC Member Name: ETRNKSF
Exit Point Name: QIBM_QC3_TRN_KSF
Exit Point Format Name: TRNK0100
The Translate Keystore exit program is called when the Translate Keystore File (TRNCKMKSF) CL command, the Qc3TranslateKeyStore API, or the Translate Key Store dialog in System i® Navigator is being used. The exit program is called for each keystore that is translated.
The operating system calls the user-written exit programs through the registration facility for each keystore file.
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
- Translate keystore exit information
- INPUT; CHAR(*)
Information that is needed by the exit program for notification of a keystore that is to be translated. For details, see Format of Translate Keystore 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 keystore file is translated. The exit program should determine if the keystore file can be translated and perform any necessary pre-processing actions. The exit program should set the Translate status value appropriately. 2 Execute The exit program is being called after a keystore file has been translated 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 Translate status indicating the keystore file is not eligible to be translated. You may need to back out pre-processing actions. - Translate 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 Translate Keystore Exit Information
The following table shows the structure of the translate keystore exit information. For a description of the fields in this format, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Binary(4) | Translate keystore exit information length |
| 4 | 4 | Binary(4) | To master key ID |
| 8 | 8 | Char(20) | Qualified keystore file name |
Format of Status Information
The following table shows the structure of the translate status information. For a description of the fields in this format, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Binary(4) | Translate keystore status information length |
| 4 | 4 | Char(1) | Translate keystore status |
Field Descriptions
Qualified keystore file name. The file name of the keystore to be translated. The following table shows the structure of this field:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Char(10) | Library name |
| 10 | A | Char(10) | File name |
To master key ID. The ID of the master key that will be used to encrypt the keystore after the keystore is translated. The possible values are:
| ID | This is a value in the range of 1 - 8 and corresponds to the general purpose master key ID. |
Translate keystore exit information length. The length in bytes of all data passed to the translate keystore exit program.
Translate keystore status. The status value that indicates whether the exit program considers the keystore eligible to be translated. The possible values are:
| 0 | The keystore is not eligible to be translated. Therefore, the translate keystore command or translate keystore API will skip this keystore, and the keystore will not be translated. |
| 1 | The keystore is eligible to be translated. |
Note: If any other value is specified for this field, the keystore will not be eligible to be translated.
Translate keystore status length. The length in bytes of the translate status information.
Exit program introduced: V6R1
[ Back to top | Cryptographic Services APIs | APIs by category ]