<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: VariableKeyLength< D, N, M, Q, IV_REQ, IV_L > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Crypto++
 <span id="projectnumber">7.0</span>
</div>
<div id="projectbrief">Free C++ class library of cryptographic schemes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="class_variable_key_length-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">VariableKeyLength< D, N, M, Q, IV_REQ, IV_L > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Inherited by keyed algorithms with variable key length.
<a href="class_variable_key_length.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ae8e35290e09097d8afb9a19386a5f109"><td class="memItemLeft" align="right" valign="top">static size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_variable_key_length.html#ae8e35290e09097d8afb9a19386a5f109">StaticGetValidKeyLength</a> (size_t keylength)</td></tr>
<tr class="memdesc:ae8e35290e09097d8afb9a19386a5f109"><td class="mdescLeft"> </td><td class="mdescRight">Provides a valid key length for the algorithm provided by a static function. <a href="#ae8e35290e09097d8afb9a19386a5f109">More...</a><br /></td></tr>
<tr class="separator:ae8e35290e09097d8afb9a19386a5f109"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:aff5e41e92f02a8bb6a976b748e4e2ec9"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_variable_key_length.html#aff5e41e92f02a8bb6a976b748e4e2ec9">MIN_KEYLENGTH</a> =N</td></tr>
<tr class="memdesc:aff5e41e92f02a8bb6a976b748e4e2ec9"><td class="mdescLeft"> </td><td class="mdescRight">The minimum key length used by the algorithm provided as a constant. <a href="#aff5e41e92f02a8bb6a976b748e4e2ec9">More...</a><br /></td></tr>
<tr class="separator:aff5e41e92f02a8bb6a976b748e4e2ec9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26f33392d61edcaa678ae65002842d36"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_variable_key_length.html#a26f33392d61edcaa678ae65002842d36">MAX_KEYLENGTH</a> =M</td></tr>
<tr class="memdesc:a26f33392d61edcaa678ae65002842d36"><td class="mdescLeft"> </td><td class="mdescRight">The maximum key length used by the algorithm provided as a constant. <a href="#a26f33392d61edcaa678ae65002842d36">More...</a><br /></td></tr>
<tr class="separator:a26f33392d61edcaa678ae65002842d36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3788ee30b190bdc0c0e89d2721162614"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_variable_key_length.html#a3788ee30b190bdc0c0e89d2721162614">DEFAULT_KEYLENGTH</a> =D</td></tr>
<tr class="memdesc:a3788ee30b190bdc0c0e89d2721162614"><td class="mdescLeft"> </td><td class="mdescRight">The default key length used by the algorithm provided as a constant. <a href="#a3788ee30b190bdc0c0e89d2721162614">More...</a><br /></td></tr>
<tr class="separator:a3788ee30b190bdc0c0e89d2721162614"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acaa6d8918bbd17c2da84e752df7bd285"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_variable_key_length.html#acaa6d8918bbd17c2da84e752df7bd285">KEYLENGTH_MULTIPLE</a> =Q</td></tr>
<tr class="memdesc:acaa6d8918bbd17c2da84e752df7bd285"><td class="mdescLeft"> </td><td class="mdescRight">The key length multiple used by the algorithm provided as a constant. <a href="#acaa6d8918bbd17c2da84e752df7bd285">More...</a><br /></td></tr>
<tr class="separator:acaa6d8918bbd17c2da84e752df7bd285"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aefee62ae9b6dd90ede7211844235fc7b"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_variable_key_length.html#aefee62ae9b6dd90ede7211844235fc7b">IV_REQUIREMENT</a> =IV_REQ</td></tr>
<tr class="memdesc:aefee62ae9b6dd90ede7211844235fc7b"><td class="mdescLeft"> </td><td class="mdescRight">The default IV requirements for the algorithm provided as a constant. <a href="#aefee62ae9b6dd90ede7211844235fc7b">More...</a><br /></td></tr>
<tr class="separator:aefee62ae9b6dd90ede7211844235fc7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5687e4a40c5289764feac86eed81cc2"><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_variable_key_length.html#ae5687e4a40c5289764feac86eed81cc2">IV_LENGTH</a> =IV_L</td></tr>
<tr class="memdesc:ae5687e4a40c5289764feac86eed81cc2"><td class="mdescLeft"> </td><td class="mdescRight">The default initialization vector length for the algorithm provided as a constant. <a href="#ae5687e4a40c5289764feac86eed81cc2">More...</a><br /></td></tr>
<tr class="separator:ae5687e4a40c5289764feac86eed81cc2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<unsigned int D, unsigned int N, unsigned int M, unsigned int Q = 1, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0><br />
class VariableKeyLength< D, N, M, Q, IV_REQ, IV_L ></h3>
<p>Inherited by keyed algorithms with variable key length. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">D</td><td>Default key length, in bytes </td></tr>
<tr><td class="paramname">N</td><td>Minimum key length, in bytes </td></tr>
<tr><td class="paramname">M</td><td>Maximum key length, in bytes </td></tr>
<tr><td class="paramname">Q</td><td>Default key length multiple, in bytes. The default multiple is 1. </td></tr>
<tr><td class="paramname">IV_REQ</td><td>the <a class="el" href="class_simple_keying_interface.html#a88201c180fbfaa9fef2715252546ad6e">IV requirements</a> </td></tr>
<tr><td class="paramname">IV_L</td><td>default IV length, in bytes. The default length is 0. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_simple_keying_interface.html" title="Interface for algorithms that take byte strings as keys. ">SimpleKeyingInterface</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="seckey_8h_source.html#l00188">188</a> of file <a class="el" href="seckey_8h_source.html">seckey.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae8e35290e09097d8afb9a19386a5f109"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8e35290e09097d8afb9a19386a5f109">◆ </a></span>StaticGetValidKeyLength()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int D, unsigned int N, unsigned int M, unsigned int Q = 1, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static size_t <a class="el" href="class_variable_key_length.html">VariableKeyLength</a>< D, N, M, Q, IV_REQ, IV_L >::StaticGetValidKeyLength </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>keylength</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides a valid key length for the algorithm provided by a static function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keylength</td><td>the size of the key, in bytes</td></tr>
</table>
</dd>
</dl>
<p>If keylength is less than MIN_KEYLENGTH, then the function returns MIN_KEYLENGTH. If keylength is greater than MAX_KEYLENGTH, then the function returns MAX_KEYLENGTH. If keylength is a multiple of KEYLENGTH_MULTIPLE, then keylength is returned. Otherwise, the function returns keylength rounded <em>down</em> to the next smaller multiple of KEYLENGTH_MULTIPLE.</p>
<p>keylength is provided in bytes, not bits. </p>
<p class="definition">Definition at line <a class="el" href="seckey_8h_source.html#l00226">226</a> of file <a class="el" href="seckey_8h_source.html">seckey.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aff5e41e92f02a8bb6a976b748e4e2ec9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff5e41e92f02a8bb6a976b748e4e2ec9">◆ </a></span>MIN_KEYLENGTH</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int D, unsigned int N, unsigned int M, unsigned int Q = 1, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="class_variable_key_length.html">VariableKeyLength</a>< D, N, M, Q, IV_REQ, IV_L >::MIN_KEYLENGTH =N</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The minimum key length used by the algorithm provided as a constant. </p>
<p>MIN_KEYLENGTH is provided in bytes, not bits </p>
<p class="definition">Definition at line <a class="el" href="seckey_8h_source.html#l00201">201</a> of file <a class="el" href="seckey_8h_source.html">seckey.h</a>.</p>
</div>
</div>
<a id="a26f33392d61edcaa678ae65002842d36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26f33392d61edcaa678ae65002842d36">◆ </a></span>MAX_KEYLENGTH</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int D, unsigned int N, unsigned int M, unsigned int Q = 1, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="class_variable_key_length.html">VariableKeyLength</a>< D, N, M, Q, IV_REQ, IV_L >::MAX_KEYLENGTH =M</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum key length used by the algorithm provided as a constant. </p>
<p>MAX_KEYLENGTH is provided in bytes, not bits </p>
<p class="definition">Definition at line <a class="el" href="seckey_8h_source.html#l00204">204</a> of file <a class="el" href="seckey_8h_source.html">seckey.h</a>.</p>
</div>
</div>
<a id="a3788ee30b190bdc0c0e89d2721162614"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3788ee30b190bdc0c0e89d2721162614">◆ </a></span>DEFAULT_KEYLENGTH</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int D, unsigned int N, unsigned int M, unsigned int Q = 1, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="class_variable_key_length.html">VariableKeyLength</a>< D, N, M, Q, IV_REQ, IV_L >::DEFAULT_KEYLENGTH =D</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The default key length used by the algorithm provided as a constant. </p>
<p>DEFAULT_KEYLENGTH is provided in bytes, not bits </p>
<p class="definition">Definition at line <a class="el" href="seckey_8h_source.html#l00207">207</a> of file <a class="el" href="seckey_8h_source.html">seckey.h</a>.</p>
</div>
</div>
<a id="acaa6d8918bbd17c2da84e752df7bd285"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acaa6d8918bbd17c2da84e752df7bd285">◆ </a></span>KEYLENGTH_MULTIPLE</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int D, unsigned int N, unsigned int M, unsigned int Q = 1, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="class_variable_key_length.html">VariableKeyLength</a>< D, N, M, Q, IV_REQ, IV_L >::KEYLENGTH_MULTIPLE =Q</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The key length multiple used by the algorithm provided as a constant. </p>
<p>MAX_KEYLENGTH is provided in bytes, not bits </p>
<p class="definition">Definition at line <a class="el" href="seckey_8h_source.html#l00210">210</a> of file <a class="el" href="seckey_8h_source.html">seckey.h</a>.</p>
</div>
</div>
<a id="aefee62ae9b6dd90ede7211844235fc7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefee62ae9b6dd90ede7211844235fc7b">◆ </a></span>IV_REQUIREMENT</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int D, unsigned int N, unsigned int M, unsigned int Q = 1, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="class_variable_key_length.html">VariableKeyLength</a>< D, N, M, Q, IV_REQ, IV_L >::IV_REQUIREMENT =IV_REQ</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The default IV requirements for the algorithm provided as a constant. </p>
<p>The default value is NOT_RESYNCHRONIZABLE. See IV_Requirement in <a class="el" href="cryptlib_8h.html" title="Abstract base classes that provide a uniform interface to this library. ">cryptlib.h</a> for allowed values. </p>
<p class="definition">Definition at line <a class="el" href="seckey_8h_source.html#l00214">214</a> of file <a class="el" href="seckey_8h_source.html">seckey.h</a>.</p>
</div>
</div>
<a id="ae5687e4a40c5289764feac86eed81cc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5687e4a40c5289764feac86eed81cc2">◆ </a></span>IV_LENGTH</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned int D, unsigned int N, unsigned int M, unsigned int Q = 1, unsigned int IV_REQ = SimpleKeyingInterface::NOT_RESYNCHRONIZABLE, unsigned int IV_L = 0> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="class_variable_key_length.html">VariableKeyLength</a>< D, N, M, Q, IV_REQ, IV_L >::IV_LENGTH =IV_L</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The default initialization vector length for the algorithm provided as a constant. </p>
<p>IV_LENGTH is provided in bytes, not bits. The default implementation uses 0. </p>
<p class="definition">Definition at line <a class="el" href="seckey_8h_source.html#l00217">217</a> of file <a class="el" href="seckey_8h_source.html">seckey.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="seckey_8h_source.html">seckey.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:59:06 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
0a67b807a02637f2cae68649d519a89d
>
files
>
2037
