friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
0332907f0f
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QSYPARSC.htm

1017 lines
31 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!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>Parse Certificate (QSYPARSC, QsyParseCertificate) 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. -->
<!-- Sec SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Edited by Kersten Jan 02 -->
<!--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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Parse Certificate (QSYPARSC, QsyParseCertificate) API</h2>
<div class="box" style="width: 65%;">
<br>
&nbsp;&nbsp;<img src="delta.gif" alt="Start of change">Required Parameter Group for QSYPARSC:<br><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</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">Type</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">Length of certificate</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Format</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">Receiver variable</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Length of receiver variable</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">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<br>
<div class="box" style="width: 65%;">
<br>
&nbsp;&nbsp;Syntax for QsyParseCertificate:<br>
<pre>
#include &lt;qsydigid.h&gt;
void QsyParseCertificate(
char *<em>Certificate</em>,
int <em>Type</em>,
int <em>Length_of_certificate</em>,
char *<em>Format_name</em>,
char *<em>Receiver_variable</em>,
int <em>Length_of_receiver_variable</em>,
void *<em>Error_code</em>
);
</pre>
&nbsp;&nbsp;Service Program: QSYDIGID<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<img src="deltaend.gif" alt="End of change"><br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Parse Certificate (OPM, QSYPARSC; ILE, QsyParseCertificate) API parses a
certificate and returns the results to the caller.</p>
<br>
<h3>Authorities and Locks</h3>
<p>None</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Certificate</strong></dt>
<dd>INPUT; CHAR(*)
<p>The entire certificate encoded in Abstract Syntax Notation 1 Distinguished
Encoding Rules (ASN.1 DER) format. This is not a text string.</p>
</dd>
<dt><strong>Type</strong></dt>
<dd>INPUT; BINARY(4)
<p>The type or format of the certificate.</p>
<p>The possible types are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Entire X.509 public key certificate in ASN.1 DER
encoding.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Base 64 encoded version of the entire X.509
public key certificate in ASN.1 DER encoding. Note that the characters of
the Base 64 encoding are the
ASCII representation and not the EBCDIC representation.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Length of certificate</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the certificate.</p>
</dd>
<dt><strong>Format</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the parsed certificate.</p>
<p>The possible types are:</p>
<table cellpadding="5">
<!-- cols="35 65" -->
<tr>
<td align="left" valign="top"><em><a href="qsylstuc.htm#HDRCERT200">CERT0200</a></em></td>
<td align="left" valign="top">All text fields available.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRCERT021">CERT0210</a></em></td>
<td align="left" valign="top">All text fields available. None of the fields are
translated from the ASCII format that they had in the certificate into the job
CCSID.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The storage that is provided by the user to hold the certificate text. For
more information, see <a href="#HDRPRSRCV1">Format of Receiver Variable</a>.
</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the storage that is provided by the user.</p>
</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>
<br>
<h3>Usage Notes</h3>
<p>If format CERT0200 is specified, the Offset to EIM identifier, Length of EIM
identifier, Offset to EIM local registry name, Length of EIM local registry name,
Offset to user name, and Length of user name fields will be 0.
<h3><a name="HDRPRSRCV1">Format of Receiver Variable</a></h3>
<p>For details about the format that is returned in the receiver variable, for
Format CERT0200 see <a href="qsylstuc.htm#HDRCERT200">Certificate Format
CERT0200 (Plain Text)</a>.</p>
<p>The following tables describe the order and format of the data returned in
the receiver variable for Format CERT0210. For detailed descriptions of the
fields in the tables, see <a href="#HDRCINPRM1">Field Descriptions</a>.</p>
<p><strong>Note:</strong> A distinguished name (DN) consists of the following
fields in the order presented:</p>
<ul compact>
<li>Common name</li>
<li>Organizational unit</li>
<li>Organization</li>
<li>Locality</li>
<li>State</li>
<li>Postal code</li>
<li>Country or region</li>
</ul>
<br>
<h3><a name="HDRCERT021">Certificate Format CERT0210</a></h3>
<p>The CERT0210 format consists of a certificate handle and some of the
sections of the certificate parsed into a more readable format. If the length
of a field is 0 or the offset to a field is 0, then the field does not contain
any information. Either the field is empty, it is not used in the certificate,
or it is not recognized. The fields specified by the offsets and lengths in
this format are either text or hexadecimal bytes as indicated in the field
descriptions.</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%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Returned length of this certificate
and format information</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">Available length of this certificate and format
information</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">Offset to certificate handle</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of certificate handle</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to version</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of version</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to serial number</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of serial number</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to issuer's common name</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of issuer's common name</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to issuer's country or region</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of issuer's country or region</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to issuer's state or province</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of issuer's state or province</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to issuer's locality</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of issuer's locality</td>
</tr>
<tr>
<td align="center" valign="top">64</td>
<td align="center" valign="top">40</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to issuer's organization</td>
</tr>
<tr>
<td align="center" valign="top">68</td>
<td align="center" valign="top">44</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of issuer's organization</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to issuer's organizational unit</td>
</tr>
<tr>
<td align="center" valign="top">76</td>
<td align="center" valign="top">4C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of issuer's organizational unit</td>
</tr>
<tr>
<td align="center" valign="top">80</td>
<td align="center" valign="top">50</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to issuer's postal code</td>
</tr>
<tr>
<td align="center" valign="top">84</td>
<td align="center" valign="top">54</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of issuer's postal code</td>
</tr>
<tr>
<td align="center" valign="top">88</td>
<td align="center" valign="top">58</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to validity period start</td>
</tr>
<tr>
<td align="center" valign="top">92</td>
<td align="center" valign="top">5C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of validity period start</td>
</tr>
<tr>
<td align="center" valign="top">96</td>
<td align="center" valign="top">60</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to validity period end</td>
</tr>
<tr>
<td align="center" valign="top">100</td>
<td align="center" valign="top">64</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of validity period end</td>
</tr>
<tr>
<td align="center" valign="top">104</td>
<td align="center" valign="top">68</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to subject's common name</td>
</tr>
<tr>
<td align="center" valign="top">108</td>
<td align="center" valign="top">6C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of subject's common name</td>
</tr>
<tr>
<td align="center" valign="top">112</td>
<td align="center" valign="top">70</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to subject's country or region</td>
</tr>
<tr>
<td align="center" valign="top">116</td>
<td align="center" valign="top">74</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of subject's country or region</td>
</tr>
<tr>
<td align="center" valign="top">120</td>
<td align="center" valign="top">78</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to subject's state or province</td>
</tr>
<tr>
<td align="center" valign="top">124</td>
<td align="center" valign="top">7C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of subject's state or province</td>
</tr>
<tr>
<td align="center" valign="top">128</td>
<td align="center" valign="top">80</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to subject's locality</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">Length of subject's locality</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">Offset to subject's organization</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">Length of subject's organization</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">Offset to subject's organizational unit</td>
</tr>
<tr>
<td align="center" valign="top">148</td>
<td align="center" valign="top">94</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of subject's organizational unit</td>
</tr>
<tr>
<td align="center" valign="top">152</td>
<td align="center" valign="top">98</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to subject's postal code</td>
</tr>
<tr>
<td align="center" valign="top">156</td>
<td align="center" valign="top">9C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of subject's postal code</td>
</tr>
<tr>
<td align="center" valign="top">160</td>
<td align="center" valign="top">A0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to subject's public key algorithm</td>
</tr>
<tr>
<td align="center" valign="top">164</td>
<td align="center" valign="top">A4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of subject's public key algorithm</td>
</tr>
<tr>
<td align="center" valign="top">168</td>
<td align="center" valign="top">A8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to issuer's unique ID (Version 2)</td>
</tr>
<tr>
<td align="center" valign="top">172</td>
<td align="center" valign="top">AC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of issuer's unique ID (Version 2)</td>
</tr>
<tr>
<td align="center" valign="top">176</td>
<td align="center" valign="top">B0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to subject's unique ID (Version 2)</td>
</tr>
<tr>
<td align="center" valign="top">180</td>
<td align="center" valign="top">B4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of subject's unique ID (Version 2)</td>
</tr>
<tr>
<td align="center" valign="top">184</td>
<td align="center" valign="top">B8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to issuer's email address</td>
</tr>
<tr>
<td align="center" valign="top">188</td>
<td align="center" valign="top">BC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of issuer's email address</td>
</tr>
<tr>
<td align="center" valign="top">192</td>
<td align="center" valign="top">C0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to subject's email address</td>
</tr>
<tr>
<td align="center" valign="top">196</td>
<td align="center" valign="top">C4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of subject's email address</td>
</tr>
<tr>
<td align="center" valign="top">216</td>
<td align="center" valign="top">D8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to issuer's distinguished name (DN) in DER
representation</td>
</tr>
<tr>
<td align="center" valign="top">220</td>
<td align="center" valign="top">DC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of issuer's distinguished name (DN) in DER
representation</td>
</tr>
<tr>
<td align="center" valign="top">224</td>
<td align="center" valign="top">E0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to subject's distinguished name (DN) in
DER representation</td>
</tr>
<tr>
<td align="center" valign="top">228</td>
<td align="center" valign="top">E4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of subject's distinguished name (DN) in
DER representation</td>
</tr>
<tr>
<td align="center" valign="top">232</td>
<td align="center" valign="top">E8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to certificate public key in DER representation</td>
</tr>
<tr>
<td align="center" valign="top">236</td>
<td align="center" valign="top">EC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of certificate public key in DER representation</td>
</tr>
<tr>
<td align="center" valign="top"></td>
<td align="center" valign="top"></td>
<td align="left" valign="top">ARRAY(*) of CHAR</td>
<td align="left" valign="top">Certificate information</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCINPRM1">Field Descriptions</a></h3>
<p><strong>Available length of this certificate and format
information.</strong> The available length of this certificate and format
information. If this length is more than the returned length of this
certificate and format information field, then not all of the fields were
returned.</p>
<p><strong>Fields specified by their offsets and lengths above.</strong> The
fields that were specified by their offsets and lengths prior to this
field.</p>
<p><strong>Certificate information.</strong> The actual data in the
certificate. Specific fields can be accessed by using the offset to the
specific field.</p>
<p><strong>Format name.</strong> The format of the returned output.</p>
<p><strong>Length of ASN.1 format certificate.</strong> The length of the ASN.1
DER format certificate. This length refers to a field of hexadecimal bytes.</p>
<p><strong>Length of certificate handle.</strong> The length of the certificate
handle. This length refers to a field of hexadecimal bytes.</p>
<p><strong>Length of certificate public key in DER representation.</strong>
The length of the certificate
public key. This length refers to a field of hexadecimal bytes.</p>
<p><strong>Length of issuer's common name.</strong> The length of the field
that indicates the issuer's common name.</p>
<p><strong>Length of issuer's country or region.</strong> The length of the
field that indicates the issuer's country or region.</p>
<p><strong>Length of issuer's distinguished name (DN) in DER
representation.</strong> The length of the field that indicates the issuer's DN
in DER representation.</p>
<p><strong>Length of issuer's email address.</strong> The length of the field
that indicates the issuer's email address.</p>
<p><strong>Length of issuer's locality.</strong> The length of the field that
indicates the issuer's locality.</p>
<p><strong>Length of issuer's organization.</strong> The length of the field
that indicates the issuer's organization.</p>
<p><strong>Length of issuer's organizational unit.</strong> The length of the
field that indicates the issuer's organizational unit.</p>
<p><strong>Length of issuer's postal code.</strong> The length of the field
that indicates the issuer's postal code.</p>
<p><strong>Length of issuer's state or province.</strong> The length of the
field that indicates the issuer's state or province.</p>
<p><strong>Length of issuer's unique ID (Version 2).</strong> The length of the
field that indicates the issuer's unique ID (Version 2). This length refers to
a field of hexadecimal bytes.</p>
<p><strong>Length of serial number.</strong> The length of the field that
indicates the serial number.</p>
<p><strong>Length of subject's common name.</strong> The length of the field
that indicates the subject's common name.</p>
<p><strong>Length of subject's country or region.</strong> The length of the
field that indicates the subject's country or region.</p>
<p><strong>Length of subject's distinguished name (DN) in DER
representation.</strong> The length of the field that indicates the subject's
DN in DER representation.</p>
<p><strong>Length of subject's email address.</strong> The length of the field
that indicates the subject's email address.</p>
<p><strong>Length of subject's locality.</strong> The length of the field that
indicates the subject's locality.</p>
<p><strong>Length of subject's organization.</strong> The length of the field
that indicates the subject's organization.</p>
<p><strong>Length of subject's organizational unit.</strong> The length of the
field that indicates the subject's organizational unit.</p>
<p><strong>Length of subject's postal code.</strong> The length of the field
that indicates the subject's postal code.</p>
<p><strong>Length of subject's public key algorithm.</strong> The length of the
field that indicates the subject's public key algorithm.</p>
<p><strong>Length of subject's state or province.</strong> The length of the
field that indicates the subject's state or province.</p>
<p><strong>Length of subject's unique ID (Version 2).</strong> The length of
the field that indicates the subject's unique ID (Version 2). This length
refers to a field of hexadecimal bytes.</p>
<p><strong>Length of validity period start.</strong> The length of the field
that indicates the beginning date of the validity period. The first 8
characters consist of 4 characters for the year, 2 characters for the
month, and 2 characters for the day.
The last 6 characters consist of 2 characters for the hours, 2 characters
for the minutes, and 2 characters for the seconds.
<p><strong>Length of validity period end.</strong> The length of the field that
indicates the ending date of the validity period. The first 8 characters
consist of 4 characters for the year, 2 characters for the month,
and 2 characters for the day.
The last 6 characters consist of 2 characters for the hours, 2 characters
for the minutes, and 2 characters for the seconds.
<p><strong>Length of version.</strong> The length of the field that indicates
the version. This length refers to a field of hexadecimal bytes.</p>
<p><strong>Offset to ASN.1 format certificate.</strong> The offset to the ASN.1
DER format certificate. This offset refers to a field of hexadecimal bytes.</p>
<p><strong>Offset to certificate handle.</strong> The offset to the certificate
handle. This offset refers to a field of hexadecimal bytes.</p>
<p><strong>Offset to certificate public key in DER representation.</strong>
The offset to the certificate
public key. This offset refers to a field of hexadecimal bytes.</p>
<p><strong>Offset to issuer's common name.</strong> The offset to the field
that indicates the issuer's common name.</p>
<p><strong>Offset to issuer's country or region.</strong> The offset to the
field that indicates the issuer's country or region.</p>
<p><strong>Offset to issuer's distinguished name (DN) in DER
representation.</strong> The offset to the field that indicates the issuer's DN
in DER representation.</p>
<p><strong>Offset to issuer's email address.</strong> The offset to the field
that indicates the issuer's email address.</p>
<p><strong>Offset to issuer's locality.</strong> The offset to the field that
indicates the issuer's locality.</p>
<p><strong>Offset to issuer's organization.</strong> The offset to the field
that indicates the issuer's organization.</p>
<p><strong>Offset to issuer's organizational unit.</strong> The offset to the
field that indicates the issuer's organizational unit.</p>
<p><strong>Offset to issuer's postal code.</strong> The offset to the field
that indicates the issuer's postal code.</p>
<p><strong>Offset to issuer's state or province.</strong> The offset to the
field that indicates the issuer's state or province.</p>
<p><strong>Offset to issuer's unique ID (Version 2).</strong> The offset to the
field that indicates the issuer's unique ID (Version 2). This offset refers to
a field of hexadecimal bytes.</p>
<p><strong>Offset to serial number.</strong> The offset to the field that
indicates the serial number.</p>
<p><strong>Offset to subject's common name.</strong> The offset to the field
that indicates the subject's common name.</p>
<p><strong>Offset to subject's country or region.</strong> The offset to the
field that indicates the subject's country or region.</p>
<p><strong>Offset to subject's distinguished name (DN) in DER
representation.</strong> The offset to the field that indicates the subject's
DN in DER representation.</p>
<p><strong>Offset to subject's email address.</strong> The offset to the field
that indicates the subject's email address.</p>
<p><strong>Offset to subject's locality.</strong> The offset to the field that
indicates the subject's locality.</p>
<p><strong>Offset to subject's organization.</strong> The offset to the field
that indicates the subject's organization.</p>
<p><strong>Offset to subject's organizational unit.</strong> The offset to the
field that indicates the subject's organizational unit.</p>
<p><strong>Offset to subject's postal code.</strong> The offset to the field
that indicates the subject's postal code.</p>
<p><strong>Offset to subject's public key algorithm.</strong> The offset to the
field that indicates the subject's public key algorithm.</p>
<p><strong>Offset to subject's state or province.</strong> The offset to the
field that indicates the subject's state or province.</p>
<p><strong>Offset to subject's unique ID (Version 2).</strong> The offset to
the field that indicates the subject's unique ID (Version 2). This offset
refers to a field of hexadecimal bytes.</p>
<p><strong>Offset to validity period start.</strong> The offset to the field
that indicates the beginning date of the validity period.</p>
<p><strong>Offset to validity period end.</strong> The offset to the field that
indicates the ending date of the validity period.</p>
<p><strong>Offset to version.</strong> The offset to the field that indicates
the version. This offset refers to a field of hexadecimal bytes.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Returned length of this certificate and format information.</strong>
The total length of this certificate and format information that was returned.
This length is for one certificate and can be used to access the next
certificate in the list.</p>
<p><strong>User name.</strong> The name of the user profile that is specified
in the call to the API.</p>
<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 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">CPF1F41 E</td>
<td align="left" valign="top">Severe error occurred while addressing parameter
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF227A E</td>
<td align="left" valign="top">Certificate type is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF227B E</td>
<td align="left" valign="top">Certificate is not correct for the specified
type.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3BFF E</td>
<td align="left" valign="top">Required option &amp;1 is not available.
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running of &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1D E</td>
<td align="left" valign="top">Length specified in parameter &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1E E</td>
<td align="left" valign="top">Required parameter &amp;1 omitted.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &amp;1, entered for this
API was not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R2
<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>
Reference in New Issue Copy Permalink