ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/XSYUPDCU.htm

303 lines
8.4 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 Usage 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 ========================================== -->
<!-- Sec SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!--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 Usage Exit Program</h2>
<div class="box" style="width: 65%;">
<br>
&nbsp;&nbsp;Required Parameter:<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 usage exit
information</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
</table>
<br>
<pre>
QSYSINC Member Name: ESYUPDCU
Exit Point Name: QIBM_QSY_CERT_APPS
Exit Point Format Name: CERT0100
</pre>
</div>
<p>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).</p>
<p>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 the Register Application for Certificate Use (QSYRGAP,
QsyRegisterAppForCertUse) API.</p>
<p><strong>Note:</strong> The Update Certificate Usage exit point 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 usage exit information</strong></dt>
<dd>INPUT; CHAR(*)
<p>Information needed by the exit program for notification of any certificate
changes for the application. For details, see <a href="#HDRUPDFMT">Format of
Update Certificate Usage Exit Information</a>.</p>
</dd>
</dl>
<br>
<h3><a name="HDRUPDFMT">Format of Update Certificate Usage Exit
Information</a></h3>
<p>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 <a href="#HDRUPDI">Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="top" colspan="2">Offset</th>
<th align="left" valign="top" rowspan="2">Type</th>
<th align="left" valign="top" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="top">Dec</th>
<th align="center" valign="top">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">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 certificate store</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 certificate store</td>
</tr>
<tr>
<td align="center" valign="top">140</td>
<td align="center" valign="top">8C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to certificate ID</td>
</tr>
<tr>
<td align="center" valign="top">144</td>
<td align="center" valign="top">90</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of certificate ID</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Certificate store</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Certificate ID</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRUPDI">Field Descriptions</a></h3>
<p><strong>Action.</strong> The action being performed on the 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 certificate is being added to the
application.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em> </td>
<td align="left" valign="top">The certificate is being changed for the
application.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em> </td>
<td align="left" valign="top">The certificate is being removed from the
application.</td>
</tr>
</table>
<p><strong>Application ID.</strong> The ID of the application.</p>
<p><strong>Certificate ID.</strong> The ID for the updated certificate.</p>
<p><strong>Certificate ID type.</strong> The type of the 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">A certificate ID is the label for the
certificate.</td>
</tr>
</table>
<p><strong>Certificate store.</strong> 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:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SYSTEM</em> </td>
<td align="left" valign="top">The certificate is stored in the system
certificate store.</td>
</tr>
</table>
<p><strong>Exit point format name.</strong> The format name for the Update
Certificate Usage exit program. The possible format name is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>CERT0100</em> </td>
<td align="left" valign="top">The format name that is used after a certificate
is updated 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 certificate ID.</strong> The length of the certificate
ID.</p>
<p><strong>Length of certificate store.</strong> The length of the certificate
store.</p>
<p><strong>Offset to certificate ID.</strong> The offset to the start of the
certificate ID.</p>
<p><strong>Offset to certificate store.</strong> The offset to the start of the
certificate store.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<br>
<hr>
Exit program introduced: V4R4
<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>