333 lines
7.9 KiB
HTML
333 lines
7.9 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 V5R4 by beth hagemeister 7/14/04 -->
|
||
|
|
<!-- Change history: -->
|
||
|
|
<!-- end header records -->
|
||
|
|
<title>Translate Key Store (QC3TRNKS, Qc3TranslateKeyStore)</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><img src="delta.gif" alt="Start of change">Translate Key Store
|
||
|
|
(QC3TRNKS, Qc3TranslateKeyStore)</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<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="60%">Key store file list</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%">Master key ID</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%">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: QC3KSTRN<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Translate Key Store (OPM, QC3TRNKS; ILE,
|
||
|
|
Qc3TranslateKeyStore) API translates keys stored in the specified
|
||
|
|
key store files to another master key, or if the same master key is specified,
|
||
|
|
to the current version of the master key.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
If an error occurs, processing halts immediately.
|
||
|
|
</p>
|
||
|
|
<p>For more information about cryptographic services key store, refer to
|
||
|
|
<a href="qc3KeyStore.htm">Cryptographic Services Key Store</a>.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt><strong>Required file authority</strong></dt>
|
||
|
|
|
||
|
|
<dd>*OBJOPR, *READ, *UPD<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt><strong>Key store file list</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The list of key store files to re-encrypt. This parameter has the
|
||
|
|
following structure.</p>
|
||
|
|
|
||
|
|
<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="left" valign="bottom">Dec</th>
|
||
|
|
<th align="left" 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="66%">Number of key store files</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="9%" colspan="2">This field repeats.</td>
|
||
|
|
<td align="left" valign="top" width="19%">CHAR(20)</td>
|
||
|
|
<td align="left" valign="top" width="66%">Qualified key store file name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Number of key store files</strong></dt>
|
||
|
|
|
||
|
|
<dd>The number of qualified key store file names specified in this
|
||
|
|
structure.
|
||
|
|
<br><br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Qualified key store file name</strong></dt>
|
||
|
|
|
||
|
|
<dd>The name of a key store file to re-encrypt. 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.
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
<dt><strong>Master key ID</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The master key under which the keys will be re-encrypted.
|
||
|
|
</p>
|
||
|
|
<table width="95%">
|
||
|
|
<!-- cols="5 95" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="15%"><strong>1</strong></td>
|
||
|
|
<td align="left" valign="top">Master key 1</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="15%"><strong>2</strong></td>
|
||
|
|
<td align="left" valign="top">Master key 2</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="15%"><strong>3</strong></td>
|
||
|
|
<td align="left" valign="top">Master key 3</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="15%"><strong>4</strong></td>
|
||
|
|
<td align="left" valign="top">Master key 4</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="15%"><strong>5</strong></td>
|
||
|
|
<td align="left" valign="top">Master key 5</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="15%"><strong>6</strong></td>
|
||
|
|
<td align="left" valign="top">Master key 6</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="15%"><strong>7</strong></td>
|
||
|
|
<td align="left" valign="top">Master key 7</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="15%"><strong>8</strong></td>
|
||
|
|
<td align="left" valign="top">Master key 8</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>Error Messages</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 width="15%" valign="top">CPF24B4 E</td>
|
||
|
|
<td width="85%" valign="top">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 align="left">CPF3CF2 E</td>
|
||
|
|
<td align="left">Error(s) occurred during running of &1
|
||
|
|
API.</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">CPF9D96 E</td>
|
||
|
|
<td valign="top">Key store file requires recovery.</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">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">CPF9DAB E</td>
|
||
|
|
<td valign="top">A key can not be decrypted.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DAD E</td>
|
||
|
|
<td valign="top">The master key ID is not valid.</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">CPF9DB7 E</td>
|
||
|
|
<td valign="top">Error occured writing to key store.</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">CPF9DC1 E</td>
|
||
|
|
<td valign="top">Number of key store files not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9DDA E</td>
|
||
|
|
<td valign="top">Unexpected return code &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<img src="deltaend.gif" alt="End of change"><br>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R4
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|