Update Certificate Usage Exit Program
Required Parameter:
| 1 | Update certificate usage exit information | Input | Char(*) |
QSYSINC Member Name: ESYUPDCU Exit Point Name: QIBM_QSY_CERT_APPS Exit Point Format Name: CERT0100
The Update Certificate Usage exit program is called when a certificate is updated for an application or removed from an application using Digital Certificate Manager (DCM).
When a certificate for an application is changed, the user-written exit program associated with the registered application is called. The exit point supports an unlimited number of applications, but only one exit program for each application. (For information about registering an application that uses certificates, see Register Application for Certificate Use (QSYRGAP, QsyRegisterAppForCertUse) API.)
Note: The Update Certificate Usage exit point ignores any return codes or error messages that are sent from the exit program.
Authorities and Locks
- Authority to Exit Program Library
- *EXECUTE
- Authority to Exit Program
- *USE
Required Parameter
- Update certificate usage exit information
- INPUT; CHAR(*)
Information needed by the exit program for notification of any certificate changes for the application. For details, see Format of Update Certificate Usage Exit Information.
Format of Update Certificate Usage Exit Information
The following table shows the structure of the update certificate usage information for format CERT0100. For a description of the fields in this format, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(20) | Exit point name |
| 20 | 14 | CHAR(8) | Exit point format name |
| 28 | 1C | CHAR(100) | Application ID |
| 128 | 80 | CHAR(1) | Action |
| 129 | 81 | CHAR(1) | Certificate ID type |
| 130 | 82 | CHAR(2) | Reserved |
| 132 | 84 | BINARY(4) | Offset to certificate store |
| 136 | 88 | BINARY(4) | Length of certificate store |
| 140 | 8C | BINARY(4) | Offset to certificate ID |
| 144 | 90 | BINARY(4) | Length of certificate ID |
| CHAR(*) | Certificate store | ||
| CHAR(*) | Certificate ID | ||
Field Descriptions
Action. The action being performed on the certificate. The possible values follow:
| 0 | The certificate is being added to the application. |
| 1 | The certificate is being changed for the application. |
| 2 | The certificate is being removed from the application. |
Application ID. The ID of the application.
Certificate ID. The ID for the updated certificate.
Certificate ID type. The type of the certificate ID. The possible value follows:
| 1 | A certificate ID is the label for the certificate. |
Certificate store. The path name where the certificate is stored. The path name will be specified in the coded character set ID (CCSID) of the job. The following special value may be specified:
| *SYSTEM | The certificate is stored in the system certificate store. |
Exit point format name. The format name for the Update Certificate Usage exit program. The possible format name is:
| CERT0100 | The format name that is used after a certificate is updated for an application. |
Exit point name. The name of the exit point that calls the exit program.
Length of certificate ID. The length of the certificate ID.
Length of certificate store. The length of the certificate store.
Offset to certificate ID. The offset to the start of the certificate ID.
Offset to certificate store. The offset to the start of the certificate store.
Reserved. An ignored field.
Exit program introduced: V4R4
[ Back to top | Security APIs | APIs by category ]