274 lines
8.0 KiB
HTML
274 lines
8.0 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>Update Certificate Authority (CA) Trust 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 -->
|
||
|
|
<!-- XSYUPDCA SCR A converted by B2H R4.1 (346) (CMS) by V2CDIJAB at -->
|
||
|
|
<!-- RCHVMW2 on 30 Aug 2000 at 18:51:25 -->
|
||
|
|
<!--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>Update Certificate Authority (CA) Trust 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%">Update Certificate Authority<br>
|
||
|
|
(CA) trust exit information</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
QSYSINC Member Name: ESYUPDCA<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Exit Point Name: QIBM_QSY_CERT_APPS<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Exit Point Format Name: CATR0100<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Update Certificate Authority (CA) Trust exit program is called when a CA
|
||
|
|
certificate is added to or removed from the list of trusted CA certificates for
|
||
|
|
an application using Digital Certificate Manager (DCM).</p>
|
||
|
|
|
||
|
|
<p>When the trust status of a CA 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 the <a href="qsyrgap.htm">Register Application for
|
||
|
|
Certificate Use</a> QSYRGAP, QsyRegisterAppForCertUse) API.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> The Update Certificate Authority (CA) Trust exit
|
||
|
|
program is not be called if the Limit CA certificates trusted indicator for the
|
||
|
|
application is set to 0 (the application trusts all CA certificates that are
|
||
|
|
trusted in the *SYSTEM certificate store) and the trust status for one of the
|
||
|
|
CA certificates in the *SYSTEM certificate store is changed.</p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> The Update Certificate Authority (CA) Trust exit
|
||
|
|
program ignores any return codes or error messages that are sent from the exit
|
||
|
|
program.</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>Update Certificate Authority (CA) trust exit
|
||
|
|
information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>Information needed by the exit program for notification of any CA
|
||
|
|
certificate trust changes for the application. For details, see <a href=
|
||
|
|
"#HDRUPDCAFM">"Format of Update Certificate Authority (CA) Trust Exit
|
||
|
|
Information"</a>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRUPDCAFM">Format of Update Certificate Authority (CA) Trust Exit
|
||
|
|
Information</a></h3>
|
||
|
|
|
||
|
|
<p>The following table shows the structure of the update CA trust information
|
||
|
|
for format CATR0100. For a description of the fields in this format, see <a
|
||
|
|
href="#HDRUPDCATR">"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">Action</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">Trusted CA certificate ID type</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">130</td>
|
||
|
|
<td align="center" valign="top">82</td>
|
||
|
|
<td align="left" valign="top">CHAR(2)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">132</td>
|
||
|
|
<td align="center" valign="top">84</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Offset to trusted CA certificate ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">136</td>
|
||
|
|
<td align="center" valign="top">88</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of trusted CA certificate ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top"> </td>
|
||
|
|
<td align="center" valign="top"> </td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Trusted CA certificate ID</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRUPDCATR">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<strong>Action.</strong>
|
||
|
|
|
||
|
|
<p>The action being performed on the trusted CA certificate. 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 trusted CA certificate is being added to the
|
||
|
|
list of trusted CA certificates for the application.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The trusted CA certificate is being removed from
|
||
|
|
the list of trusted CA certificates for the application.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Application ID.</strong> The ID of the application.</p>
|
||
|
|
|
||
|
|
<p><strong>Trusted CA certificate ID.</strong> The ID for the trusted CA
|
||
|
|
certificate being added or removed.</p>
|
||
|
|
|
||
|
|
<p><strong>Trusted CA certificate ID type.</strong> The type of the trusted CA
|
||
|
|
certificate ID. The possible value follows:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The trusted CA certificate ID is the label for
|
||
|
|
the certificate.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Exit point format name.</strong> The format name for the Update
|
||
|
|
Certificate Authority (CA) trust exit program. The possible format name is:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>CATR0100</em></td>
|
||
|
|
<td align="left" valign="top">The format name that is used after a CA
|
||
|
|
certificate is added or removed from the trust list for an application.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Exit point name.</strong> The name of the exit point that calls the
|
||
|
|
exit program.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of trusted CA certificate ID.</strong> The length of the
|
||
|
|
trusted CA certificate ID.</p>
|
||
|
|
|
||
|
|
<p><strong>Offset to trusted CA certificate ID.</strong> The offset to the
|
||
|
|
start of the trusted CA certificate ID.</p>
|
||
|
|
|
||
|
|
<p><strong>Reserved.</strong> An ignored field.</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>
|
||
|
|
|