379 lines
11 KiB
HTML
379 lines
11 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Register Application for Certificate Use Exit Program</title>
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Begin Header Records -->
|
||
|
|
<!-- XSYRGAP SCR A converted by B2H R4.1 (346) (CMS) by V2CDIJAB at -->
|
||
|
|
<!-- RCHVMW2 on 30 Aug 2000 at 18:52:07 -->
|
||
|
|
<!--End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
<!-- Java sync-link -->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<h2>Register Application for Certificate Use Exit Program</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<br>
|
||
|
|
Required Parameter Group:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">1</td>
|
||
|
|
<td align="left" valign="top" width="50%">Register application exit
|
||
|
|
information</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Register indicator</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(1)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
QSYSINC Member Name: ESYRGAPP<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Exit Point Name: QIBM_QSY_CERT_APPS<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Exit Point Format Name: RGAP0100<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>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.</p>
|
||
|
|
|
||
|
|
<p>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 <a href="qsyrgap.htm">Register Application for
|
||
|
|
Certificate Use</a> (QSYRGAP, QsyRegisterAppForCertUse) API.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> 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.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Authority to Exit Program Library</em></dt>
|
||
|
|
|
||
|
|
<dd>*EXECUTE<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>Authority to Exit Program</em></dt>
|
||
|
|
|
||
|
|
<dd>*USE</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Register application exit information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>Information needed by the exit program for notification of any changes to a
|
||
|
|
registered application. For details, see <a href="#HDRUPDFMT">Format of
|
||
|
|
Register Application Exit Information</a>.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Register indicator</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(1)
|
||
|
|
|
||
|
|
<p>An indicator set by the exit program as to whether the change of the
|
||
|
|
application information is allowed. The possible values follow:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">The application information will not be
|
||
|
|
changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The application information will be changed.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRUPDFMT">Format of Register Application Exit
|
||
|
|
Information</a></h3>
|
||
|
|
|
||
|
|
<p>The following table shows the structure of the register application
|
||
|
|
information for format RGAP0100. For a description of the fields in this
|
||
|
|
format, see <a href="#HDRRGAPI">"Field Descriptions"</a>.</p>
|
||
|
|
|
||
|
|
<table border width="80%">
|
||
|
|
<tr>
|
||
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="center" valign="bottom">Dec</th>
|
||
|
|
<th align="center" valign="bottom">Hex</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="left" valign="top" width="20%">CHAR(20)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Exit point name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">20</td>
|
||
|
|
<td align="center" valign="top">14</td>
|
||
|
|
<td align="left" valign="top">CHAR(8)</td>
|
||
|
|
<td align="left" valign="top">Exit point format name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">28</td>
|
||
|
|
<td align="center" valign="top">1C</td>
|
||
|
|
<td align="left" valign="top">CHAR(100)</td>
|
||
|
|
<td align="left" valign="top">Application ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">128</td>
|
||
|
|
<td align="center" valign="top">80</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Current client authentication required value</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">129</td>
|
||
|
|
<td align="center" valign="top">81</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">New client authentication required value</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">130</td>
|
||
|
|
<td align="center" valign="top">82</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Current client authentication supported
|
||
|
|
value</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">131</td>
|
||
|
|
<td align="center" valign="top">83</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">New client authentication supported value</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">132</td>
|
||
|
|
<td align="center" valign="top">84</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Current limit CA certificates trusted value</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">133</td>
|
||
|
|
<td align="center" valign="top">85</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">New limit CA certificates trusted value</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRRGAPI">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<strong>Application ID.</strong>
|
||
|
|
|
||
|
|
<p>The ID of the application.</p>
|
||
|
|
|
||
|
|
<p><strong>Current client authentication required value.</strong> The current
|
||
|
|
value for the client authentication required indicator. The possible values
|
||
|
|
follow:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Client authentication is not required.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Client authentication is required.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Current client authentication supported value.</strong> The current
|
||
|
|
value for the client authentication supported indicator. The possible values
|
||
|
|
follow:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Client authentication is not supported by this
|
||
|
|
application.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Client authentication is supported by this
|
||
|
|
application.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Current limit CA certificates trusted value.</strong> The current
|
||
|
|
value for the limit Certificate Authority (CA) certificates trusted indicator.
|
||
|
|
The possible values follow:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Application trusts all CA certificates that are
|
||
|
|
trusted in the *SYSTEM certificate store.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Application trusts a subset of the CA
|
||
|
|
certificates that are trusted in the *SYSTEM certificate store.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Exit point format name.</strong> The format name for the Register
|
||
|
|
Application for Certificate Use exit program. The possible format name is:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>RGAP0100</em></td>
|
||
|
|
<td align="left" valign="top">The format name that is used after application
|
||
|
|
information is changed.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Exit point name.</strong> The name of the exit point that calls the
|
||
|
|
exit program.</p>
|
||
|
|
|
||
|
|
<p><strong>New client authentication required value.</strong> The new value for
|
||
|
|
the client authentication required indicator. The possible values follow:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Client authentication is not required.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Client authentication is required.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>New client authentication supported value.</strong> The new value
|
||
|
|
for the client authentication supported indicator. The possible values
|
||
|
|
follow:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">Client authentication is not supported by this
|
||
|
|
application.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">Client authentication is supported by this
|
||
|
|
application.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>New limit CA certificates trusted value.</strong> The new value for
|
||
|
|
the limit Certificate Authority (CA) certificates trusted indicator. The
|
||
|
|
possible values follow:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">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.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">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).</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> 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.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
Exit program introduced: V5R1
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<table cellpadding="2" cellspacing="2" align="center">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"sec.htm">Security APIs</a> | <a href="aplist.htm">APIs by category</a> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|