449 lines
12 KiB
HTML
449 lines
12 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>Export Certificate Store (QYKMEXPK, QykmExportKeyStore)</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 -->
|
||
|
|
<!-- created by Jim Coon for V5R3 -->
|
||
|
|
<!-- 021015 JETAYLOR html and formatting cleanup -->
|
||
|
|
<!-- 041117 JCOON password of certificate store description chg'd -->
|
||
|
|
<!-- 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>Export Certificate Store (QYKMEXPK, QykmExportKeyStore)</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="50%">Certificate store path and file
|
||
|
|
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 certificate store path and file
|
||
|
|
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 certificate store path and file
|
||
|
|
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">Certificate store password</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="left" valign="top">Length of certificate store password</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</td>
|
||
|
|
<td align="left" valign="top">CCSID of certificate store password</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">7</td>
|
||
|
|
<td align="left" valign="top">Export path and file name</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">Length of export path and file name</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">9</td>
|
||
|
|
<td align="left" valign="top">Format of export path and file name</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">10</td>
|
||
|
|
<td align="left" valign="top">Version of export file</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">11</td>
|
||
|
|
<td align="left" valign="top">Export file password</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">12</td>
|
||
|
|
<td align="left" valign="top">Length of export file password</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">13</td>
|
||
|
|
<td align="left" valign="top">CCSID of export file password</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">14</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: QYKMSYNC<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Export Certificate Store API (OPM, QYKMEXPK; ILE, QykmEportKeyStore)
|
||
|
|
allows a user to export an entire certificate store to a PKCS12 version 3
|
||
|
|
standard file. This allows for the export of private keys as well as record
|
||
|
|
labels. <b>Note:</b> Option 34, Digital Certificate Manager, must be installed
|
||
|
|
in order to use this API.</p>
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Authority Required</em></dt>
|
||
|
|
|
||
|
|
<dd>
|
||
|
|
<p>To use this API, option 34 must be installed. You must also know the
|
||
|
|
<img src="delta.gif" alt="Start of change"> password of the certificate
|
||
|
|
store if you want to export private keys. Additionally, you must
|
||
|
|
<img src="deltaend.gif" alt="End of change">
|
||
|
|
provide a password for the export file
|
||
|
|
which gets created as a result of calling this API.</p>
|
||
|
|
|
||
|
|
<p>For the file objects:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>*R authority to the certificate store.</li>
|
||
|
|
|
||
|
|
<li>*RW authority to the export file.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
<p>For the directories:</p>
|
||
|
|
<ul>
|
||
|
|
<li>*WX authority to the directory containing the export file.</li>
|
||
|
|
|
||
|
|
<li>*X authority to each directory in the paths to both the certificate store and export files.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>Also, see the <a href="open.htm">open()</a> API for the authority needed to the
|
||
|
|
certificate store. The export file must not exist prior to calling this
|
||
|
|
API. The export file gets created as a result of calling this API.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>Locks</em></dt>
|
||
|
|
|
||
|
|
<dd>Object will be locked
|
||
|
|
<img src="delta.gif" alt="Start of change">shared<img src="deltaend.gif" alt="End of change">
|
||
|
|
read.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Certificate store path and file name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; Char(*)
|
||
|
|
|
||
|
|
<p>The path name of the certificate store (kdb) you want to export. This path
|
||
|
|
and file name may be absolute (i.e., entire path name) or relative to the current
|
||
|
|
directory. If you are using format OBJN0100
|
||
|
|
(see below), 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>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of certificate store path and file name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; Binary(4)
|
||
|
|
|
||
|
|
<p>The length of the certificate store path and file name. If the format
|
||
|
|
specified is OBJN0200 (see below), this field must include the QLG path name
|
||
|
|
structure length in addition to the length of the path name itself. If the
|
||
|
|
format specified is OBJN0100 (see below), only the length of the path name
|
||
|
|
itself is included.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format of certificate store path and file name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the certificate store path and file name parameter.</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>OBJN0100</em></td>
|
||
|
|
<td align="left" valign="top">The certificate store path and file name is a
|
||
|
|
simple path name.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>OBJN0200</em></td>
|
||
|
|
<td align="left" valign="top">The certificate path and file name is an LG-type
|
||
|
|
path name.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Certificate store password</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The password of the certificate store whose certificates will be exported to
|
||
|
|
the given export file.
|
||
|
|
<img src="delta.gif" alt="Start of change">
|
||
|
|
If the password parameter is null, private keys will not be exported.
|
||
|
|
<img src="deltaend.gif" alt="End of change"> </p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of certificate store password</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; Binary(4)
|
||
|
|
|
||
|
|
<p>The length of the password of the certificate store whose certificates will
|
||
|
|
be exported to the given export file.
|
||
|
|
<img src="delta.gif" alt="Start of change">
|
||
|
|
If the length of the password is 0, private keys will not be exported.
|
||
|
|
<img src="deltaend.gif" alt="End of change">
|
||
|
|
</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>CCSID of certificate store password</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; Binary(4)
|
||
|
|
|
||
|
|
<p>This parameter is the CCSID of the certificate store password. If the value
|
||
|
|
is 0, the default CCSID of the job will be used.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Export path and file name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The path (including the name) of the export file into which all of the
|
||
|
|
certificates in the certificate store will be exported in the format
|
||
|
|
indicated by the version of the export file parameter. This path and file
|
||
|
|
name may be absolute (i.e., entire path name) or relative to the current
|
||
|
|
directory. If you are using
|
||
|
|
format OBJN0100 (see below), 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>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of export path and file name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; Binary(4)
|
||
|
|
|
||
|
|
<p>The length of the export path and file name. If the format specified is
|
||
|
|
OBJN0200 (see below), this field must include the QLG path name structure
|
||
|
|
length in addition to the length of the path name itself. If the format
|
||
|
|
specified is OBJN0100 (see below), only the length of the path name itself is
|
||
|
|
included.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format of export path and file name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the export path and file name parameter.</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>OBJN0100</em></td>
|
||
|
|
<td align="left" valign="top">The export path and file name is a simple path
|
||
|
|
name.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>OBJN0200</em></td>
|
||
|
|
<td align="left" valign="top">The export path and file name is an LG-type path
|
||
|
|
name.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Version of export file</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; Char(10)
|
||
|
|
|
||
|
|
<p>Currently, the only value supported here is *PKCS12V3 to indicate that
|
||
|
|
only PKCS12 version 3 files will be used for importing and exporting
|
||
|
|
entire certificate stores.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Export file password</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The password of the export file.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of export file password</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; Binary(4)
|
||
|
|
|
||
|
|
<p>The length of the password of the export file.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>CCSID of export file password</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; Binary(4)
|
||
|
|
|
||
|
|
<p>This parameter is the CCSID of the export file password. If the value is 0,
|
||
|
|
the default CCSID of the job will be used.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Error code</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; 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%" 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">CPFB001 E</td>
|
||
|
|
<td width="85%" valign="top">One or more input parameters is NULL or
|
||
|
|
missing.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFB002 E</td>
|
||
|
|
<td valign="top">Certificate store does not exist.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFB003 E</td>
|
||
|
|
<td valign="top">Certificate store password is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFB004 E</td>
|
||
|
|
<td valign="top">User not authorized to certificate store.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFB005 E</td>
|
||
|
|
<td valign="top">Export file already exists.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFB006 E</td>
|
||
|
|
<td valign="top">An error occurred. The error code is &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFB007 E</td>
|
||
|
|
<td valign="top">User not authorized to directory or file.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFB008 E</td>
|
||
|
|
<td valign="top">The format name for the certificate store is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFB009 E</td>
|
||
|
|
<td valign="top">The format name for the export or import file is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFB00A E</td>
|
||
|
|
<td valign="top">Option &2 of the operating system is required to work with certificates.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<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>
|
||
|
|
|