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

175 lines
6.4 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>Generate MAC (GENMAC)</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="GENMAC.Top_Of_Page"></a>
<h2>Generate MAC (GENMAC)</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="#GENMAC.PARAMETERS.TABLE">Parameters</a><br>
<a href="#GENMAC.COMMAND.EXAMPLES">Examples</a><br>
<a href="#GENMAC.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="GENMAC"></a>
<p>The Generate Message Authentication Code (GENMAC) command encrypts a variable length of data using cipher block chaining and returns the last 8 bytes to be used as a message authentication code.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENMAC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="GENMAC.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="#GENMAC.DATA"><b>DATA</b></a></td>
<td valign="top">Input data</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#GENMAC.DTALEN"><b>DTALEN</b></a></td>
<td valign="top">Input data length</td>
<td valign="top">1-32759</td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#GENMAC.CPHK"><b>CPHK</b></a></td>
<td valign="top">Cipher key</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#GENMAC.ICV"><b>ICV</b></a></td>
<td valign="top">Initial chaining value</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#GENMAC.RTNVAR"><b>RTNVAR</b></a></td>
<td valign="top">CL var for returned value</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 5</td>
</tr>
<tr>
<td valign="top"><a href="#GENMAC.PAD"><b>PAD</b></a></td>
<td valign="top">Pad option</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional, Positional 6</td>
</tr>
<tr>
<td valign="top"><a href="#GENMAC.PADCHAR"><b>PADCHAR</b></a></td>
<td valign="top">Pad character</td>
<td valign="top"><i>Character value</i>, <b><u>X'00'</u></b></td>
<td valign="top">Optional, Positional 7</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#GENMAC.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="GENMAC.DATA"></a>
<h3>Input data (DATA)</h3>
<p>Specifies the data, or a variable containing the data, to be encrypted. The data must be at least as long as the length specified in the <b>Input data length</b> prompt (DTALEN parameter). This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENMAC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENMAC.DTALEN"></a>
<h3>Input data length (DTALEN)</h3>
<p>Specifies the length, or a variable containing the length, of the data to be encrypted. The length must be less than 32,760. This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENMAC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENMAC.CPHK"></a>
<h3>Cipher key (CPHK)</h3>
<p>Specifies an 8-byte value, or a variable containing an 8-byte value, to be used as the key for the data encryption algorithm. This value must be the value of the key encrypted under the host master key. There are no restrictions on the value of this parameter. This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENMAC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENMAC.ICV"></a>
<h3>Initial chaining value (ICV)</h3>
<p>Specifies an 8-byte value, or a variable containing an 8-byte value, to be used as the initial chaining value when performing cipher block chaining. There are no restrictions on the value of this parameter. This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENMAC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENMAC.RTNVAR"></a>
<h3>CL var for returned value (RTNVAR)</h3>
<p>Specifies a variable to receive the 8-byte message authentication code. This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENMAC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENMAC.PAD"></a>
<h3>Pad option (PAD)</h3>
<p>Specifies whether padding is to be performed.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>Padding will not be performed.
</dd>
<dt><b>*YES</b></dt>
<dd>Before encrypting, the data is padded out to the next 8-byte multiple using the pad character specified in the <b>Pad character</b> prompt (PADCHAR parameter). The last byte is then replaced with a count of the number of pad characters.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENMAC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENMAC.PADCHAR"></a>
<h3>Pad character (PADCHAR)</h3>
<p>Specifies a 1-byte value, or a variable containing a 1-byte value, to be used as the pad character when *YES is specified for the <b>Pad option</b> prompt (PAD parameter). The default (1-byte pad character) is hex 00.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENMAC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="GENMAC.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#GENMAC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="GENMAC.ERROR.MESSAGES">Error messages</a></h3>Unknown
</div>
<table width="100%">
<tr><td align="right"><a href="#GENMAC.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>