477 lines
14 KiB
HTML
477 lines
14 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>Check System (QYDOCHKS, QydoCheckSystem) API</title>
|
|
<!-- Begin Header Records -->
|
|
<!-- 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. -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- QYDOVFYO SCR510 A converted by B2H R4.1 (346) (CMS) by V2CDIJAB -->
|
|
<!-- at RCHVMW2 on 17 Oct 2000 at 12:59:06 -->
|
|
<!-- 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>Check System (QYDOCHKS, QydoCheckSystem) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
Optional 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%">Results path name</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">Length of results path name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Format of results path name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Format of content of results file</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char (8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Service Program Name: QYDOCHK1<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Check System (OPM, QYDOCHKS; ILE, QydoCheckSystem) API checks to see if any key operating system object has changed since it was signed. If any of these objects is unsigned, it is reported as an error. Only signatures from a system trusted source are valid.<br>
|
|
Note: This API can take several hours to complete.
|
|
</p>
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>Authority Required</em></dt>
|
|
|
|
<dd>*AUDIT special authority is required.
|
|
<p>See <a href="open.htm">open()</a> API for the authority needed to the
|
|
results path name. The file is open for append and is created if it does not
|
|
already exist.</p>
|
|
</dd>
|
|
|
|
<dt><em>Locks</em></dt>
|
|
|
|
<dd>Object will be locked shared allow read.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Optional Parameter Group</h3>
|
|
|
|
<dl>
|
|
|
|
<dt><strong>Results path name.</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The path name of the object you want to contain the results on this call. This object may not be in a library (that is, may not be under the /QSYS.LIB directory). The name may be relative to the current directory or may specify the entire path name. For example, to store results in a file called SIGNED.LST in the MYDIR directory, the results path name would be '/MYDIR/SIGNED.LST'. If you are using format OBJN0100, this parameter is assumed to be represented in the coded character set identifier (CCSID) currently in effect for the job. If the CCSID of the job is 65535, this parameter is assumed to be represented in the default CCSID of the job.</p>
|
|
|
|
<p>If this is an existing file, results will be appended to the end of the file. Otherwise, a new file will be created.</p>
|
|
|
|
<p>The default is not to have a results file.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of results path name.</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the results path name. A 0 (zero) length means no results files are used, and the results path name and format of results path name parameter values are not used. If the format of the results path name is OBJN0200, this field must include the QLG path name structure in addition to the path name itself. If the format of the results path name is OBJN0100, only the path name itself is included.</p>
|
|
</dd>
|
|
<dt><strong>Format of results path name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>Format of the results path name</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>OBJN0100</em></td>
|
|
<td align="left" valign="top">The results path name is a simple path name.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>OBJN0200</em></td>
|
|
<td align="left" valign="top">The results path name is an LG-type path
|
|
name.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
<dt><strong>Format of content of results path name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the contents of the file containing the results of this call.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>RSLT0100</em></td>
|
|
<td align="left" valign="top">The basic information is returned for each object
|
|
specified by the object path name parameter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
|
|
<dd>I/O; CHAR(*)
|
|
|
|
<p>The structure in which to return error information. For the format of the
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
<h3><a name="HDRLOBJA1A">RSLT0100 format</a></h3>
|
|
|
|
<p>The following table describes the order and format of the data returned in
|
|
the RSLT0100 format. This data is repeated for each object that was attempted
|
|
to be verified. For detailed descriptions of the fields in the tables, see <a
|
|
href="#HDRRSLTA2">Field Descriptions</a>.</p>
|
|
|
|
<p><strong>Note:</strong>All data in this file will be in CCSID 1200. New
|
|
files will be created in this CCSID. If an existing file is named that has a
|
|
different CCSID, an error will be reported.</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(7)</td>
|
|
<td align="left" valign="top" width="60%">Message identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">CHAR(9)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">Date</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Operation type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">33</td>
|
|
<td align="center" valign="top">21</td>
|
|
<td align="left" valign="top">CHAR(15)</td>
|
|
<td align="left" valign="top">Operation type description</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">56</td>
|
|
<td align="center" valign="top">38</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Fully qualified object name</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRRSLTA2">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Date.</strong> The date the operation took place. The format will be
|
|
YYYYMMDD. For example, June 30, 2002 will be 20020630.</p>
|
|
|
|
<p><strong>Fully qualified object name.</strong> The simple path name from the
|
|
root to the object whose signature is being verified. The field will be
|
|
terminated with a new line character.</p>
|
|
|
|
<p><strong>Message identifier.</strong> The error message used to report
|
|
failure. This field is blank if no error was detected for this object.</p>
|
|
|
|
<p><strong>Operation type.</strong> The operation that was attempted.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Signing operation</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Verifying operation</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Checking operation</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Operation type description.</strong> Short word description of the
|
|
operation that was attempted.</p>
|
|
|
|
<p><strong>Reserved.</strong> This field currently is not used. It is filled
|
|
with blanks.</p>
|
|
|
|
<br>
|
|
|
|
|
|
|
|
<h3><a name="usage_notes">Usage Notes</a></h3>
|
|
|
|
<p>The following messages can be sent to the joblog and added to records in the Results Path Name.</p>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPFB722 D</td>
|
|
<td width="85%" valign="top">Object not signed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPFB723 D</td>
|
|
<td width="85%" valign="top">Object signed, but signature is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPFB72A D</td>
|
|
<td width="85%" valign="top">The object had no trusted signatures on the
|
|
object.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPFB72B D</td>
|
|
<td width="85%" valign="top">Object not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPFB72C D</td>
|
|
<td width="85%" valign="top">The object cannot currently be signed or
|
|
verified.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF222E E</td>
|
|
<td width="85%" valign="top">&1 special authority is required.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF9872 E</td>
|
|
<td width="85%" valign="top">Program or service program &1 in library &2 ended. Reason code &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF9EA6 E</td>
|
|
<td width="85%" valign="top">QVFYOBJRST system value does not verify object
|
|
signatures during restore at its current setting.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA08D E</td>
|
|
<td align="left" valign="top">Request information value is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA0A4 E</td>
|
|
<td align="left" valign="top">Too many open files for process.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA0AA E</td>
|
|
<td align="left" valign="top">Error occurred while attempting to obtain
|
|
space.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA0D4 E</td>
|
|
<td align="left" valign="top">File system error occurred.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB735 E</td>
|
|
<td align="left" valign="top">The digital signature API parameter &1 is not
|
|
large enough.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB736 E</td>
|
|
<td align="left" valign="top">The digital signature API parameter &1 is not
|
|
small enough.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB737 E</td>
|
|
<td align="left" valign="top">The digital signature API parameter &1 is a null pointer.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB738 E</td>
|
|
<td align="left" valign="top">The digital signature API parameter &1 is not a
|
|
valid format type.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB739 E</td>
|
|
<td align="left" valign="top">The digital signature API parameter &1 is out
|
|
of range.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB740 E</td>
|
|
<td align="left" valign="top">The format name for the pathname is not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB741 E</td>
|
|
<td align="left" valign="top">The length of the path name parameter is not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB744 E</td>
|
|
<td align="left" valign="top">The format of the results file for the digital
|
|
signing API is an incorrect value.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB745 E</td>
|
|
<td align="left" valign="top">The format name for the results file path name is
|
|
not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB746 E</td>
|
|
<td align="left" valign="top">The results file path name length is not large
|
|
enough.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB749 E</td>
|
|
<td align="left" valign="top">Object signature operation ended abnormally.
|
|
&1 objects attempted, &2 objects successfully processed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB74D E</td>
|
|
<td align="left" valign="top">Results file could not be used.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V5R3
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<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>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|