| 1 | Register application exit information | Input | Char(*) |
| 2 | Register indicator | Output | Char(1) |
The Register Application for Certificate Use exit program is called when the registration information for an application is changed using the Register Application for Certificate Use (QSYRGAP, QsyRegisterAppForCertUse) API, the Add Exit Program (QUSADDEP, QusAddExitProgram) API, or the Add Exit Program (ADDEXITPGM) command.
When the information for a registered application is being 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 the Register Application for Certificate Use (QSYRGAP, QsyRegisterAppForCertUse) API.
Note: The Register Application For Certificate Use exit point does not change the application information if the user-written exit program indicates that the change operation is not allowed. If the exit program does not exist or cannot be called because of the multithreaded job action value, then the application information is changed.
Information needed by the exit program for notification of any changes to a registered application. For details, see Format of Register Application Exit Information.
An indicator set by the exit program as to whether the change of the application information is allowed. The possible values follow:
| 0 | The application information will not be changed. |
| 1 | The application information will be changed. |
The following table shows the structure of the register application information for format RGAP0100. 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) | Current client authentication required value |
| 129 | 81 | CHAR(1) | New client authentication required value |
| 130 | 82 | CHAR(1) | Current client authentication supported value |
| 131 | 83 | CHAR(1) | New client authentication supported value |
| 132 | 84 | CHAR(1) | Current limit CA certificates trusted value |
| 133 | 85 | CHAR(1) | New limit CA certificates trusted value |
The ID of the application.
Current client authentication required value. The current value for the client authentication required indicator. The possible values follow:
| 0 | Client authentication is not required. |
| 1 | Client authentication is required. |
Current client authentication supported value. The current value for the client authentication supported indicator. The possible values follow:
| 0 | Client authentication is not supported by this application. |
| 1 | Client authentication is supported by this application. |
Current limit CA certificates trusted value. The current value for the limit Certificate Authority (CA) certificates trusted indicator. The possible values follow:
| 0 | Application trusts all CA certificates that are trusted in the *SYSTEM certificate store. |
| 1 | Application trusts a subset of the CA certificates that are trusted in the *SYSTEM certificate store. |
Exit point format name. The format name for the Register Application for Certificate Use exit program. The possible format name is:
| RGAP0100 | The format name that is used after application information is changed. |
Exit point name. The name of the exit point that calls the exit program.
New client authentication required value. The new value for the client authentication required indicator. The possible values follow:
| 0 | Client authentication is not required. |
| 1 | Client authentication is required. |
New client authentication supported value. The new value for the client authentication supported indicator. The possible values follow:
| 0 | Client authentication is not supported by this application. |
| 1 | Client authentication is supported by this application. |
New limit CA certificates trusted value. The new value for the limit Certificate Authority (CA) certificates trusted indicator. The possible values follow:
| 0 | Application trusts all CA certificates that are trusted in the *SYSTEM certificate store. If the current limit CA certificates trusted value is 1, then any CA certificates that are in the list of trusted CA certificates for the application will be removed. |
| 1 | Application trusts a subset of the CA certificates that are trusted in the *SYSTEM certificate store. If the current limit CA certificates trusted value is 0, then the application will not trust any of the CA certificates that are trusted in the *SYSTEM certificate store until they are added to the list of trusted CA certificates for the application using Digital Certificate Manager (DCM). |
Note: The Update Certificate Authority (CA) Trust exit program will not be called for the CA certificates that are removed from the list of trusted CA certificates for the application because of a change to this value.
| Top | Security APIs | APIs by category |