ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/vfypin.htm

213 lines
8.8 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">
<title>Verify PIN (VFYPIN)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="VFYPIN.Top_Of_Page"></a>
<h2>Verify PIN (VFYPIN)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>
<ul><li>Batch program (*BPGM)</li>
<li>Interactive program (*IPGM)</li>
</ul><b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#VFYPIN.PARAMETERS.TABLE">Parameters</a><br>
<a href="#VFYPIN.COMMAND.EXAMPLES">Examples</a><br>
<a href="#VFYPIN.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="VFYPIN"></a>
<p>The Verify Personal Identification Number (VFYPIN) command determines if the customer's personal identification number is algorithmically related to the customer's validation data. The result of the test is returned in a 1-byte variable.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="VFYPIN.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#VFYPIN.INPINPTCK"><b>INPINPTCK</b></a></td>
<td valign="top">Input protection key name</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#VFYPIN.ENCPIN"><b>ENCPIN</b></a></td>
<td valign="top">Enciphered PIN</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#VFYPIN.PINVLDK"><b>PINVLDK</b></a></td>
<td valign="top">PIN validation key name</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Required, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#VFYPIN.DECTBL"><b>DECTBL</b></a></td>
<td valign="top">Decimalization table</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#VFYPIN.VLDDTA"><b>VLDDTA</b></a></td>
<td valign="top">PIN validation data</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 5</td>
</tr>
<tr>
<td valign="top"><a href="#VFYPIN.PINCHKLEN"><b>PINCHKLEN</b></a></td>
<td valign="top">PIN check length</td>
<td valign="top">1-16</td>
<td valign="top">Required, Positional 6</td>
</tr>
<tr>
<td valign="top"><a href="#VFYPIN.RTNVAR"><b>RTNVAR</b></a></td>
<td valign="top">Return variable</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 7</td>
</tr>
<tr>
<td valign="top"><a href="#VFYPIN.PINPADCHAR"><b>PINPADCHAR</b></a></td>
<td valign="top">PIN pad character</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional, Positional 8</td>
</tr>
<tr>
<td valign="top"><a href="#VFYPIN.OFFSET"><b>OFFSET</b></a></td>
<td valign="top">PIN offset data</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional, Positional 9</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="VFYPIN.INPINPTCK"></a>
<h3>Input protection key name (INPINPTCK)</h3>
<p>Specifies the name, or a variable containing the name, of the input PIN protection key that the personal identification number is enciphered under. This key must exist in the cross-domain key table and be defined with a key use of personal identification number (*PIN specified on the <b>Key use</b> prompt (KUSE parameter) on the Generate Cross-Domain Key (GENCRSDMNK) or Add Cross-Domain Key (ADDCRSDMNK) command). This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYPIN.ENCPIN"></a>
<h3>Enciphered PIN (ENCPIN)</h3>
<p>Specifies 16 hexadecimal characters, or a character variable containing 16 hexadecimal characters, representing a personal identification number in 3624 format enciphered under the input PIN protection key. This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYPIN.PINVLDK"></a>
<h3>PIN validation key name (PINVLDK)</h3>
<p>Specifies the name, or a variable containing the name, of a validation key that is to be used to encrypt the validation data. This key must exist in the cross-domain key table and be defined with a key use of personal identification number (*PIN specified on the <b>Key use</b> prompt (KUSE parameter) on the Generate Cross-Domain Key (GENCRSDMNK) or Add Cross-Domain Key (ADDCRSDMNK) command). This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYPIN.DECTBL"></a>
<h3>Decimalization table (DECTBL)</h3>
<p>Specifies 16 numeric digits (0-9), or a character variable containing 16 numeric digits, to be used as the table for conversion to decimal when verifying the personal identification number. This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYPIN.VLDDTA"></a>
<h3>PIN validation data (VLDDTA)</h3>
<p>Specifies 16 hexadecimal characters, or a character variable containing 16 hexadecimal characters, representing the 8 bytes of validation data to be used for verifying the personal identification number. This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYPIN.PINCHKLEN"></a>
<h3>PIN check length (PINCHKLEN)</h3>
<p>Specifies the number, or a variable containing the number, of digits of the personal identification number to be verified.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYPIN.RTNVAR"></a>
<h3>Return variable (RTNVAR)</h3>
<p>Specifies a variable to receive the 1-byte verification status. If the personal identification number is valid, the status is set to 0. If the personal identification number is not valid, the status is set to 1.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYPIN.PINPADCHAR"></a>
<h3>PIN pad character (PINPADCHAR)</h3>
<p>Specifies the hexadecimal character that was used to pad the personal identification number before being encrypted. It is removed from the end of the personal identification number before verification.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The personal identification number was not padded before being encrypted.
</dd>
<dt><b><i>PIN-pad-character</i></b></dt>
<dd>Specify 1 hexadecimal character, or a variable containing 1 hexadecimal character, representing the value that was used to pad the personal identification number before it was encrypted
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYPIN.OFFSET"></a>
<h3>PIN offset data (OFFSET)</h3>
<p>Specifies a numeric value to be added to the intermediate personal identification number obtained from the validation data before comparing it with the supplied personal identification number.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No offset value should be added to the intermediate personal identification number before the comparison. Specifying *NONE for this parameter is equivalent to entering a value of zero for the parameter.
</dd>
<dt><b><i>offset-data</i></b></dt>
<dd>Specify 16 numeric digits (0-9), or a character variable containing 16 numeric digits, representing the value to be added to the intermediate personal identification number before the comparison.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="VFYPIN.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="VFYPIN.ERROR.MESSAGES">Error messages</a></h3>Unknown
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYPIN.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>