1290 lines
34 KiB
HTML
1290 lines
34 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">
|
||
|
|
<!-- 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. -->
|
||
|
|
<!-- Created for V5R3 by beth hagemeister 6/11/02 -->
|
||
|
|
<!-- Change history: -->
|
||
|
|
<!-- 030211 JETAYLOR html cleanup -->
|
||
|
|
<!-- 031020 BILLINGS Review 3 updates -->
|
||
|
|
<!-- 040719 BILLINGS V5R4 changes -->
|
||
|
|
<!-- 050420 BILLINGS Message updates -->
|
||
|
|
<!-- end header records -->
|
||
|
|
<title>Calculate Signature (QC3CALSG, Qc3CalculateSignature)</title>
|
||
|
|
<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>Calculate Signature (QC3CALSG, Qc3CalculateSignature)</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<br>
|
||
|
|
Required Parameter Group:<br>
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">1</td>
|
||
|
|
<td align="left" valign="top" width="60%">Input data</td>
|
||
|
|
<td align="left" valign="top" width="15%">Input</td>
|
||
|
|
<td align="left" valign="top" width="15%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">2</td>
|
||
|
|
<td align="left" valign="top" width="60%">Length of input data</td>
|
||
|
|
<td align="left" valign="top" width="15%">Input</td>
|
||
|
|
<td align="left" valign="top" width="15%">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">3</td>
|
||
|
|
<td align="left" valign="top" width="60%">Input data format name</td>
|
||
|
|
<td align="left" valign="top" width="15%">Input</td>
|
||
|
|
<td align="left" valign="top" width="15%">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">4</td>
|
||
|
|
<td align="left" valign="top" width="60%">Algorithm description</td>
|
||
|
|
<td align="left" valign="top" width="15%">Input</td>
|
||
|
|
<td align="left" valign="top" width="15%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">5</td>
|
||
|
|
<td align="left" valign="top" width="60%">Algorithm description format
|
||
|
|
name</td>
|
||
|
|
<td align="left" valign="top" width="15%">Input</td>
|
||
|
|
<td align="left" valign="top" width="15%">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">6</td>
|
||
|
|
<td align="left" valign="top" width="60%">Key description</td>
|
||
|
|
<td align="left" valign="top" width="15%">Input</td>
|
||
|
|
<td align="left" valign="top" width="15%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">7</td>
|
||
|
|
<td align="left" valign="top" width="60%">Key description format name</td>
|
||
|
|
<td align="left" valign="top" width="15%">Input</td>
|
||
|
|
<td align="left" valign="top" width="15%">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">8</td>
|
||
|
|
<td align="left" valign="top" width="60%">Cryptographic service provider</td>
|
||
|
|
<td align="left" valign="top" width="15%">Input</td>
|
||
|
|
<td align="left" valign="top" width="15%">Char(1)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">9</td>
|
||
|
|
<td align="left" valign="top" width="60%">Cryptographic device name</td>
|
||
|
|
<td align="left" valign="top" width="15%">Input</td>
|
||
|
|
<td align="left" valign="top" width="15%">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">10</td>
|
||
|
|
<td align="left" valign="top" width="60%">Signature</td>
|
||
|
|
<td align="left" valign="top" width="15%">Output</td>
|
||
|
|
<td align="left" valign="top" width="15%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">11</td>
|
||
|
|
<td align="left" valign="top" width="60%">Length of area provided for
|
||
|
|
signature</td>
|
||
|
|
<td align="left" valign="top" width="15%">Input</td>
|
||
|
|
<td align="left" valign="top" width="15%">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">12</td>
|
||
|
|
<td align="left" valign="top" width="60%">Length of signature returned</td>
|
||
|
|
<td align="left" valign="top" width="15%">Output</td>
|
||
|
|
<td align="left" valign="top" width="15%">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">13</td>
|
||
|
|
<td align="left" valign="top" width="60%">Error code</td>
|
||
|
|
<td align="left" valign="top" width="15%">I/O</td>
|
||
|
|
<td align="left" valign="top" width="15%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Service Program Name: QC3SIGCL<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Calculate Signature (OPM, QC3CALSG; ILE, Qc3CalculateSignature)
|
||
|
|
API produces a digital signature by hashing the input data and
|
||
|
|
encrypting the hash value using a public key algorithm (PKA). To verify the
|
||
|
|
signature, use the <a href="qc3vfysg.htm">Verify Signature (OPM, QC3VFYSG; ILE,
|
||
|
|
Qc3VerifySig) API</a>.</p>
|
||
|
|
|
||
|
|
<p>Information on cryptographic standards can be found in the <a href=
|
||
|
|
"qc3crtax.htm">Create Algorithm Context (OPM, QC3CRTAX; ILE,
|
||
|
|
Qc3CreateAlgorithmContext) API</a> documentation.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt><strong>Required device description authority</strong></dt>
|
||
|
|
|
||
|
|
<dd>*USE<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><img src="delta.gif" alt="Start of change"></dt>
|
||
|
|
|
||
|
|
<dt><strong>Required file authority</strong></dt>
|
||
|
|
|
||
|
|
<dd>*OBJOPR, *READ<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><img src="delta.gif" alt="Start of change"></dt>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Input data</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The data to sign.<br>
|
||
|
|
The format of the input data is specified in the input data format name
|
||
|
|
parameter</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of input data</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>For input data format DATA0100, this is the length of the data to sign.<br>
|
||
|
|
For input data format DATA0200, this is the number of entries in the array.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Input data format name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the input data parameter.<br>
|
||
|
|
The possible format names follow.</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>DATA0100</strong></dt>
|
||
|
|
|
||
|
|
<dd>The input data parameter contains the data to sign.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><a href="#data0200">DATA0200</a></strong></dt>
|
||
|
|
|
||
|
|
<dd>The input data parameter contains an array of pointers and lengths to the
|
||
|
|
data to sign.<br>
|
||
|
|
See <a href="#inputdata">Input Data Formats</a> for a description of this
|
||
|
|
format.</dd>
|
||
|
|
</dl>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Algorithm description</strong><br>
|
||
|
|
</dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The algorithm and associated parameters for signing the data.<br>
|
||
|
|
The format of the algorithm description is specified in the algorithm
|
||
|
|
description format name parameter.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Algorithm description format name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the algorithm description.<br>
|
||
|
|
The possible format names follow.</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong><a href="#algd0100">ALGD0100</a></strong></dt>
|
||
|
|
|
||
|
|
<dd>The token for an algorithm context. This format must be used when
|
||
|
|
performing the sign operation over multiple calls. After the last call (when
|
||
|
|
the final operation flag is on), the context will reset to its initial state
|
||
|
|
and can be used in another API.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><a href="#algd0400">ALGD0400</a></strong></dt>
|
||
|
|
|
||
|
|
<dd>Parameters for a sign operation.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p>See <a href="#algs">Algorithm Description Formats</a> for a description of
|
||
|
|
these formats.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Key description</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The key and associated parameters for signing the data.<br>
|
||
|
|
The format of the key description is specified in the key description format
|
||
|
|
name parameter.<br>
|
||
|
|
If the sign operation extends over multiple calls (see ALGD0100 description above), only the key description from the first call will be used. Therefore, on subsequent calls, you may set the pointer to this parameter to NULL.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Key description format name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the key description.<br>
|
||
|
|
If the pointer to the key description parameter is NULL, this parameter will be ignored.<br>
|
||
|
|
The possible format names follow.</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong><a href="#keyd0100">KEYD0100</a></strong></dt>
|
||
|
|
|
||
|
|
<dd>The token for a key context. This format identifies a key context. A key
|
||
|
|
context is used to store a key value so it need not be recreated or retrieved
|
||
|
|
every time it is used. To create a key context, use the
|
||
|
|
<a href="qc3crtkx.htm">Create Key Context (OPM, QC3CRTKX;
|
||
|
|
ILE, Qc3CreateKeyContext)</a> API.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><a href="#keyd0200">KEYD0200</a></strong></dt>
|
||
|
|
|
||
|
|
<dd>Key parameters.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><img src="delta.gif" alt="Start of change"></dt>
|
||
|
|
|
||
|
|
<dt><strong><a href="#keyd0400">KEYD0400</a></strong></dt>
|
||
|
|
<dd>Key store label. This format identifies a key from key store.
|
||
|
|
For more information on cryptographic services key store, refer to the
|
||
|
|
<a href="qc3KeyStore.htm">Cryptographic Services Key Store</a> article.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><a href="#keyd0900">KEYD0900</a></strong></dt>
|
||
|
|
<dd>Application identifier. This format uses the private PKA key identified by
|
||
|
|
an application identifier. The application identifier must be assigned to a
|
||
|
|
valid certificate label in object signing certificate key store
|
||
|
|
(*OBJECTSIGNING).<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><img src="deltaend.gif" alt="End of change"></dt>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p>See <a href="#keys">Key Description Formats</a> for a description of these
|
||
|
|
formats.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Cryptographic service provider</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(1)
|
||
|
|
|
||
|
|
<p>The cryptographic service provider (CSP) that will perform the sign
|
||
|
|
operation.</p>
|
||
|
|
|
||
|
|
<table width="95%">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="5%"><strong>0</strong></td>
|
||
|
|
<td align="left" valign="top" width="95%">Any CSP.<br>
|
||
|
|
The system will choose an appropriate CSP to perform the sign operation.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><strong>1</strong></td>
|
||
|
|
<td align="left" valign="top">Software CSP.<br>
|
||
|
|
The system will perform the sign operation using software. If the requested
|
||
|
|
algorithm is not available in software, an error is returned.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><strong>2</strong></td>
|
||
|
|
<td align="left" valign="top">Hardware CSP.<br>
|
||
|
|
The system will perform the sign operation using cryptographic hardware. If the
|
||
|
|
requested algorithm is not available in hardware, an error is returned. A
|
||
|
|
specific cryptographic device can be specified using the cryptographic device
|
||
|
|
name parameter. If the cryptographic device is not specified, the system will
|
||
|
|
choose an appropriate one.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Cryptographic device name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>The name of a cryptographic device description.<br>
|
||
|
|
This parameter is valid when the cryptographic service provider parameter
|
||
|
|
specifies 2 (hardware CSP). Otherwise, this parameter must be blanks or
|
||
|
|
the pointer to this parameter set to NULL.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Signature</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The area to store the signature.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of area provided for signature</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the signature parameter in bytes. The length of the signature will equal the key size. (See <a href="qc3genpk.htm">Generate PKA Key Pair (OPM, QC3GENPK; ILE,
|
||
|
|
Qc3GenPKAKeyPair) API</a>.) Because key size is normally specified in bits, divide that value by 8 and round up to obtain the length of area needed for the signature.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of signature returned</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the signature returned in the signature parameter.<br>
|
||
|
|
If the length of area provided for the signature is too small, an error will be
|
||
|
|
generated and no data will be returned in the signature parameter.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Error code</strong></dt>
|
||
|
|
|
||
|
|
<dd>I/O; CHAR(*)
|
||
|
|
|
||
|
|
<p>The structure in which to return error information.<br>
|
||
|
|
For the format of the structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code
|
||
|
|
Parameter</a>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="inputdata">Input Data Formats</a></h3>
|
||
|
|
|
||
|
|
For detailed descriptions of the table fields, see <a href="#inputfield">Input
|
||
|
|
Data Formats Field Descriptions</a>.
|
||
|
|
|
||
|
|
<h4><a name="data0200">DATA0200 format</a></h4>
|
||
|
|
|
||
|
|
<table border width="70%">
|
||
|
|
<!-- cols="9 9 19 63" -->
|
||
|
|
<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="left" valign="top" rowspan="3" colspan="2" width="18%">These fields repeat.</td>
|
||
|
|
<td align="left" valign="top" width="19%">PTR(SPP)</td>
|
||
|
|
<td align="left" valign="top" width="63%">Input data pointer</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Input data length</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CHAR(12)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h4><a name="inputfield"><strong>Input Data Formats Field
|
||
|
|
Descriptions</strong></a></h4>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Input data length</strong></dt>
|
||
|
|
|
||
|
|
<dd>The length of data to sign.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Input data pointer</strong></dt>
|
||
|
|
|
||
|
|
<dd>A space pointer to the data to sign.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Reserved</strong></dt>
|
||
|
|
|
||
|
|
<dd>Must be null (binary 0s).</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="algs">Algorithm Description Formats</a></h3>
|
||
|
|
|
||
|
|
For detailed descriptions of the table fields, see <a href="#algfield">
|
||
|
|
Algorithm Description Formats Field Descriptions</a>. <br>
|
||
|
|
<h4><a name="algd0100">ALGD0100 format</a></h4>
|
||
|
|
|
||
|
|
<table border width="70%">
|
||
|
|
<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="9%">0</td>
|
||
|
|
<td align="center" valign="top" width="9%">0</td>
|
||
|
|
<td align="left" valign="top" width="19%">CHAR(8)</td>
|
||
|
|
<td align="left" valign="top" width="63%">Algorithm context token</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Final operation flag</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h4><a name="algd0400">ALGD0400 format</a></h4>
|
||
|
|
|
||
|
|
<table border width="70%">
|
||
|
|
<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="9%">0</td>
|
||
|
|
<td align="center" valign="top" width="9%">0</td>
|
||
|
|
<td align="left" valign="top" width="19%">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top" width="63%">Public key cipher algorithm</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">PKA block format</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="left" valign="top">CHAR(3)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Signing hash algorithm</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h4><a name="algfield"><strong>Algorithm Description Formats Field
|
||
|
|
Descriptions</strong></a></h4>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Algorithm context token</strong></dt>
|
||
|
|
|
||
|
|
<dd>A token for an algorithm context. The algorithm context is created using
|
||
|
|
the <a href="qc3crtax.htm">Create Algorithm Context (OPM, QC3CRTAX; ILE,
|
||
|
|
Qc3CreateAlgorithmContext) API</a>.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Final operation flag</strong></dt>
|
||
|
|
|
||
|
|
<dd>The final processing indicator.<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<table width="95%">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="5%"><strong>0</strong></td>
|
||
|
|
<td align="left" valign="top" width="95%">Continue.<br>
|
||
|
|
The system will not perform final processing and the algorithm context will
|
||
|
|
maintain the state of the operation. The algorithm context can be used on
|
||
|
|
future calls to this API to continue the sign operation. The signature will not
|
||
|
|
be returned until the final operation flag is set on. The pointer to the
|
||
|
|
signature parameter may be set to NULL because the signature will not be
|
||
|
|
returned until the final operation flag is set on.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><strong>1</strong></td>
|
||
|
|
<td align="left" valign="top">Final.<br>
|
||
|
|
The system will perform final processing. The signature will be returned and
|
||
|
|
the algorithm context will reset to its initial state. The algorithm context
|
||
|
|
can then be used to begin a new cryptographic operation. When performing a
|
||
|
|
final operation, the pointer to the input data parameter may be set to NULL.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>PKA block format</strong></dt>
|
||
|
|
|
||
|
|
<dd>The public key algorithm block format. Following are the valid values.
|
||
|
|
|
||
|
|
<table width="95%">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="5%"><strong>0</strong></td>
|
||
|
|
<td align="left" valign="top" width="95%">PKCS #1 block type 00</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="5%"><strong>1</strong></td>
|
||
|
|
<td align="left" valign="top" width="95%">PKCS #1 block type 01</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="5%"><strong>3</strong></td>
|
||
|
|
<td align="left" valign="top" width="95%">ISO 9796-1<br>
|
||
|
|
Because of security weaknesses, this format should be used for compatibility
|
||
|
|
purposes only.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="5%"><strong>5</strong></td>
|
||
|
|
<td align="left" valign="top" width="95%">ANSI X9.31<br>
|
||
|
|
This format is only valid with signing hash algorithm 2 (SHA-1).</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Public key cipher algorithm</strong></dt>
|
||
|
|
|
||
|
|
<dd>The encryption algorithm. Following are the valid public key cipher
|
||
|
|
algorithms.
|
||
|
|
|
||
|
|
<table width="95%">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="5%"><strong>50</strong></td>
|
||
|
|
<td align="left" valign="top" width="95%">RSA</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Reserved</strong></dt>
|
||
|
|
|
||
|
|
<dd>Must be null (binary 0s).<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Signing hash algorithm</strong></dt>
|
||
|
|
|
||
|
|
<dd>The hash algorithm. Following are the valid values for the signing hash
|
||
|
|
algorithm.
|
||
|
|
|
||
|
|
<table width="95%">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="5%"><strong>1</strong></td>
|
||
|
|
<td align="left" valign="top" width="95%">MD5</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="5%"><strong>2</strong></td>
|
||
|
|
<td align="left" valign="top" width="95%">SHA-1</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="keys">Key Description Formats</a></h3>
|
||
|
|
|
||
|
|
For detailed descriptions of the table fields, see <a href="#keyfield">Key
|
||
|
|
Description Formats Field Descriptions</a>. <br>
|
||
|
|
<h4><a name="keyd0100">KEYD0100 format</a></h4>
|
||
|
|
|
||
|
|
<table border width="70%">
|
||
|
|
<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="9%">0</td>
|
||
|
|
<td align="center" valign="top" width="9%">0</td>
|
||
|
|
<td align="left" valign="top" width="19%">CHAR(8)</td>
|
||
|
|
<td align="left" valign="top" width="63%">Key context token</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h4><a name="keyd0200">KEYD0200 format</a></h4>
|
||
|
|
|
||
|
|
<table border width="70%">
|
||
|
|
<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="9%">0</td>
|
||
|
|
<td align="center" valign="top" width="9%">0</td>
|
||
|
|
<td align="left" valign="top" width="19%">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top" width="63%">Key type</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Key string length</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Key format</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">9</td>
|
||
|
|
<td align="center" valign="top">9</td>
|
||
|
|
<td align="left" valign="top">CHAR(3)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="center" valign="top">C</td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Key string</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<img src="delta.gif" alt="Start of change">
|
||
|
|
|
||
|
|
<h4><a name="keyd0400">KEYD0400 format</a></h4>
|
||
|
|
|
||
|
|
<table border width="70%">
|
||
|
|
<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="9%">0</td>
|
||
|
|
<td align="center" valign="top" width="9%">0</td>
|
||
|
|
<td align="left" valign="top" width="19%">CHAR(20)</td>
|
||
|
|
<td align="left" valign="top" width="63%">Qualified key store file name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="9%">20</td>
|
||
|
|
<td align="center" valign="top" width="9%">14</td>
|
||
|
|
<td align="left" valign="top" width="19%">CHAR(32)</td>
|
||
|
|
<td align="left" valign="top" width="63%">Record label</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="9%">52</td>
|
||
|
|
<td align="center" valign="top" width="9%">34</td>
|
||
|
|
<td align="left" valign="top" width="19%">CHAR(4)</td>
|
||
|
|
<td align="left" valign="top" width="63%">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h4><a name="keyd0900">KEYD0900 format</a></h4>
|
||
|
|
|
||
|
|
<table border width="70%">
|
||
|
|
<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="9%">0</td>
|
||
|
|
<td align="center" valign="top" width="9%">0</td>
|
||
|
|
<td align="left" valign="top" width="19%">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top" width="63%">Application identifier length</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="9%">4</td>
|
||
|
|
<td align="center" valign="top" width="9%">4</td>
|
||
|
|
<td align="left" valign="top" width="19%">CHAR(4)</td>
|
||
|
|
<td align="left" valign="top" width="63%">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="9%">8</td>
|
||
|
|
<td align="center" valign="top" width="9%">8</td>
|
||
|
|
<td align="left" valign="top" width="19%">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top" width="63%">Application identifier</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<img src="deltaend.gif" alt="End of change">
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h4><a name="keyfield"><strong>Key Description Formats Field
|
||
|
|
Descriptions</strong></a></h4>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt><img src="delta.gif" alt="Start of change">
|
||
|
|
</dt>
|
||
|
|
|
||
|
|
<dt><strong>Application identifer</strong></dt>
|
||
|
|
|
||
|
|
<dd>The application ID assigned to a certificate with a private key in object
|
||
|
|
signing certificate key store (*OBJECTSIGNING).
|
||
|
|
<br><br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Application identifier length</strong></dt>
|
||
|
|
|
||
|
|
<dd>The length of the application ID. The length can not be greater than 32.
|
||
|
|
<br><br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>File name</strong></dt>
|
||
|
|
<dd>The name of a key store file. Key store files are created using the
|
||
|
|
<a href="qc3crtks.htm">Create Key Store (OPM, QC3CRTKS;
|
||
|
|
ILE, Qc3CreateKeyStore)</a> API.
|
||
|
|
<br><br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><img src="deltaend.gif" alt="End of change">
|
||
|
|
</dt>
|
||
|
|
|
||
|
|
<dt><strong>Key context token</strong></dt>
|
||
|
|
|
||
|
|
<dd>A token for a key context. The key context is created using the <a href=
|
||
|
|
"qc3crtkx.htm">Create Key Context (OPM, QC3CRTKX; ILE, Qc3CreateKeyContext)
|
||
|
|
API</a>.
|
||
|
|
<br><br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Key format</strong></dt>
|
||
|
|
|
||
|
|
<dd>The format of the key string field. Following are the valid values.
|
||
|
|
|
||
|
|
<table width="95%">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="5%"><strong>1</strong></td>
|
||
|
|
<td align="left" valign="top" width="95%">BER string<br>
|
||
|
|
The key is specified in BER encoded PKCS #8 format. For specifications of this
|
||
|
|
format, refer to RSA Security Inc. Public-Key Cryptography Standards. To
|
||
|
|
generate a PKA key pair in this format, use the <a href="qc3genpk.htm">Generate
|
||
|
|
PKA Key Pair (OPM, QC3GENPK; ILE, Qc3GenPKAKeyPair) API</a>.</td>
|
||
|
|
</tr>
|
||
|
|
</table><br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Key string</strong></dt>
|
||
|
|
|
||
|
|
<dd>The key to use in the sign operation.<br><br></dd>
|
||
|
|
|
||
|
|
<dt><strong>Key string length</strong></dt>
|
||
|
|
|
||
|
|
<dd>Length of the key string specified in the key string field.<br><br></dd>
|
||
|
|
|
||
|
|
<dt><strong>Key type</strong></dt>
|
||
|
|
|
||
|
|
<dd>The type of key. Following are the valid values.
|
||
|
|
|
||
|
|
<table width="95%">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="5%"><strong>51</strong></td>
|
||
|
|
<td align="left" valign="top" width="95%">RSA private</td>
|
||
|
|
</tr>
|
||
|
|
</table><br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><img src="delta.gif" alt="Start of change"></dt>
|
||
|
|
|
||
|
|
<dt><strong>Qualified key store file name</strong></dt>
|
||
|
|
|
||
|
|
<dd>The key store file where the key is stored. Key store files are created
|
||
|
|
using the <a href="qc3crtks.htm">Create Key Store (OPM, QC3CRTKS;
|
||
|
|
ILE, Qc3CreateKeyStore)</a> API. The first 10 characters contain the file name.
|
||
|
|
The second 10 characters contain the name of the library
|
||
|
|
where the key store file is located. You can use the following special values
|
||
|
|
for the library name.
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><strong>*CURLIB</strong></td>
|
||
|
|
<td valign="top">The job's current library is used to locate the
|
||
|
|
key store file. If no library is specified as the current library for the
|
||
|
|
job, the QGPL library is used.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><strong>*LIBL</strong></td>
|
||
|
|
<td align="left" valign="top">The job's library list is searched for the first
|
||
|
|
occurence of the specified file name.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong> Record label</strong></dt>
|
||
|
|
<dd>The label of a key record in a key store file.
|
||
|
|
The label will be converted from the job CCSID, or if 65535, the job default
|
||
|
|
CCSID (DFTCCSID) job attribute to CCSID 1200 (Unicode UTF-16).
|
||
|
|
Key records are created
|
||
|
|
using the <a href="qc3wrtkr.htm">Write Key Record (OPM, QC3WRTKR;
|
||
|
|
ILE, Qc3WriteKeyRecord)</a> or <a href="qc3genkr.htm">Generate Key
|
||
|
|
Record (OPM, QC3GENKR; ILE, Qc3GenKeyRecord)</a> API.
|
||
|
|
<br><br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><img src="deltaend.gif" alt="End of change">
|
||
|
|
</dt>
|
||
|
|
|
||
|
|
<dt><strong>Reserved</strong></dt>
|
||
|
|
|
||
|
|
<dd>Must be null (binary 0s).<br><br>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="header_9">Error Messages</a></h3>
|
||
|
|
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top" width="15%">CPF24B4 E</td>
|
||
|
|
<td valign="top" width="85%">Severe error while addressing parameter list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C1E E</td>
|
||
|
|
<td valign="top">Required parameter &1 omitted.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF1 E</td>
|
||
|
|
<td valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9872 E</td>
|
||
|
|
<td valign="top">Program or service program &1 in library &2 ended. Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><img src="delta.gif" alt="Start of change"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9D99 E</td>
|
||
|
|
<td valign="top">Error openning certificate store.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9D9C E</td>
|
||
|
|
<td valign="top">Function is disallowed with specified key context.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9D9F E</td>
|
||
|
|
<td valign="top">Not authorized to key store file.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DA0 E</td>
|
||
|
|
<td valign="top">Error occured opening key store file.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DA1 E</td>
|
||
|
|
<td valign="top">Key record not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DA2 E</td>
|
||
|
|
<td valign="top">Option 34 is not installed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DA3 E</td>
|
||
|
|
<td valign="top">Not authorized to use APPIDs.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DA4 E</td>
|
||
|
|
<td valign="top">RSA key identifier was not found in system certificate store.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DA5 E</td>
|
||
|
|
<td valign="top">Key store file not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DA6 E</td>
|
||
|
|
<td valign="top">The key store file is not available.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DA7 E</td>
|
||
|
|
<td valign="top">File is corrupt or not a valid key store file.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DA8 D</td>
|
||
|
|
<td valign="top">The application identifier length is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DAA D</td>
|
||
|
|
<td valign="top">A key requires translation.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DAB E</td>
|
||
|
|
<td valign="top">A key can not be decrypted.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DB3 E</td>
|
||
|
|
<td valign="top">Qualified key store file name not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DB6 E</td>
|
||
|
|
<td valign="top">Record label not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DB8 E</td>
|
||
|
|
<td valign="top">Error occured retrieving key record from key store.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><img src="deltaend.gif" alt="End of change"></td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DC2 E</td>
|
||
|
|
<td valign="top">Key-encrypting algorithm context not compatible with key-encrypting key context.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DC3 E</td>
|
||
|
|
<td valign="top">Unable to decrypt data or key.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DC6 E</td>
|
||
|
|
<td valign="top">Algorithm not valid for encrypting or decrypting a key.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DC7 E</td>
|
||
|
|
<td valign="top">The output data parameter specifies a NULL pointer.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DC8 E</td>
|
||
|
|
<td valign="top">The input data parameter specifies a NULL pointer.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DC9 E</td>
|
||
|
|
<td valign="top">The total length of data in the input data array is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DCC E</td>
|
||
|
|
<td valign="top">The length of area provided for signature is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DCE E</td>
|
||
|
|
<td valign="top">A data length is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DCF E</td>
|
||
|
|
<td valign="top">A data pointer is null.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DD0 E</td>
|
||
|
|
<td valign="top">Clear data format name not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DD2 E</td>
|
||
|
|
<td valign="top">Algorithm description format name not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DD3 E</td>
|
||
|
|
<td valign="top">Key description format name not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DD5 E</td>
|
||
|
|
<td valign="top">Length of input data not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DD6 E</td>
|
||
|
|
<td valign="top">Length of area provided for output data is too small.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DD7 E</td>
|
||
|
|
<td valign="top">The key-encrypting key context for the specified key is not valid or was previously destroyed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DD8 E</td>
|
||
|
|
<td valign="top">The key-encrypting algorithm context for the specified key is not valid or was previously destroyed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DDA E</td>
|
||
|
|
<td valign="top">Unexpected return code &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DDB E</td>
|
||
|
|
<td valign="top">The key string or Diffie-Hellman parameter string is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DDD E</td>
|
||
|
|
<td valign="top">The key string length is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DE0 E</td>
|
||
|
|
<td valign="top">Hash algorithm not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DE3 E</td>
|
||
|
|
<td valign="top">Mode not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DE5 E</td>
|
||
|
|
<td valign="top">PKA (public key algorithm) block format not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DE6 E</td>
|
||
|
|
<td valign="top">Public key algorithm not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DE7 E</td>
|
||
|
|
<td valign="top">Key type not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DE9 E</td>
|
||
|
|
<td valign="top">Key format not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DEC E</td>
|
||
|
|
<td valign="top">Cryptographic service provider not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DED E</td>
|
||
|
|
<td valign="top">Final operation flag not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DEE E</td>
|
||
|
|
<td valign="top">Reserved field not null.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DF0 E</td>
|
||
|
|
<td valign="top">Operation, algorithm, or mode not available on the requested CSP (cryptographic service provider).</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DF1 E</td>
|
||
|
|
<td valign="top">The algorithm context token does not reference a valid algorithm context.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DF2 E</td>
|
||
|
|
<td valign="top">The algorithm context is not found or was previously destroyed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DF3 E</td>
|
||
|
|
<td valign="top">Algorithm in algorithm context not valid for requested operation.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DF4 E</td>
|
||
|
|
<td valign="top">The key context token does not reference a valid key context.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DF5 E</td>
|
||
|
|
<td valign="top">The key context is not found or was previously destroyed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DF7 E</td>
|
||
|
|
<td valign="top">Algorithm context not compatible with key context.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DF8 E</td>
|
||
|
|
<td valign="top">Cryptographic device name not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DF9 E</td>
|
||
|
|
<td valign="top">Cryptographic device not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DFB E</td>
|
||
|
|
<td valign="top">Cryptographic service provider conflicts with the key context CSP.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DFD E</td>
|
||
|
|
<td valign="top">Not authorized to device.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DFE E</td>
|
||
|
|
<td valign="top">Cryptographic device not available.</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=
|
||
|
|
"catcrypt.htm">Cryptographic Services APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|