<!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"/>
<title>Crypto++: SimpleKeyingInterface Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crypto++</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">SimpleKeyingInterface Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="SimpleKeyingInterface" -->
<p>keying interface for crypto algorithms that take byte strings as keys
<a href="class_simple_keying_interface.html#details">More...</a></p>
<p><code>#include <<a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for SimpleKeyingInterface:</div>
<div class="dyncontent">
<div class="center">
<img src="class_simple_keying_interface.png" usemap="#SimpleKeyingInterface_map" alt=""/>
<map id="SimpleKeyingInterface_map" name="SimpleKeyingInterface_map">
<area href="class_block_cipher.html" title="interface for one direction (encryption or decryption) of a block cipher" alt="BlockCipher" shape="rect" coords="0,56,489,80"/>
<area href="class_message_authentication_code.html" title="interface for message authentication codes" alt="MessageAuthenticationCode" shape="rect" coords="998,56,1487,80"/>
<area href="class_symmetric_cipher.html" title="interface for one direction (encryption or decryption) of a stream cipher or cipher mode..." alt="SymmetricCipher" shape="rect" coords="1996,56,2485,80"/>
<area href="class_s_a_f_e_r_1_1_base.html" alt="SAFER::Base" shape="rect" coords="499,112,988,136"/>
<area href="class_simple_keying_interface_impl.html" alt="SimpleKeyingInterfaceImpl< BlockCipher, BTEA_Info >" shape="rect" coords="499,168,988,192"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, Blowfish_Info >" shape="rect" coords="499,224,988,248"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, Camellia_Info >" shape="rect" coords="499,280,988,304"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, CAST128_Info >" shape="rect" coords="499,336,988,360"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, CAST256_Info >" shape="rect" coords="499,392,988,416"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, DES_EDE2_Info >" shape="rect" coords="499,448,988,472"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, DES_EDE3_Info >" shape="rect" coords="499,504,988,528"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, DES_Info >" shape="rect" coords="499,560,988,584"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, DES_XEX3_Info >" shape="rect" coords="499,616,988,640"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, GOST_Info >" shape="rect" coords="499,672,988,696"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, IDEA_Info >" shape="rect" coords="499,728,988,752"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, LR_Info< T > >" shape="rect" coords="499,784,988,808"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, MARS_Info >" shape="rect" coords="499,840,988,864"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, MDC_Info< T > >" shape="rect" coords="499,896,988,920"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, RC2_Info >" shape="rect" coords="499,952,988,976"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, RC5_Info >" shape="rect" coords="499,1008,988,1032"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, RC6_Info >" shape="rect" coords="499,1064,988,1088"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, Rijndael_Info >" shape="rect" coords="499,1120,988,1144"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, SEED_Info >" shape="rect" coords="499,1176,988,1200"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, Serpent_Info >" shape="rect" coords="499,1232,988,1256"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, SHACAL2_Info >" shape="rect" coords="499,1288,988,1312"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, SHARK_Info >" shape="rect" coords="499,1344,988,1368"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, SKIPJACK_Info >" shape="rect" coords="499,1400,988,1424"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, Square_Info >" shape="rect" coords="499,1456,988,1480"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, TEA_Info >" shape="rect" coords="499,1512,988,1536"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, ThreeWay_Info >" shape="rect" coords="499,1568,988,1592"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, Twofish_Info >" shape="rect" coords="499,1624,988,1648"/>
<area href="class_two_bases.html" alt="TwoBases< BlockCipher, XTEA_Info >" shape="rect" coords="499,1680,988,1704"/>
<area href="class_authenticated_symmetric_cipher.html" title="interface for for one direction (encryption or decryption) of a stream cipher or block cipher mode wi..." alt="AuthenticatedSymmetricCipher" shape="rect" coords="1497,112,1986,136"/>
<area href="class_c_b_c___m_a_c___base.html" title="_" alt="CBC_MAC_Base" shape="rect" coords="1497,168,1986,192"/>
<area href="class_c_m_a_c___base.html" title="_" alt="CMAC_Base" shape="rect" coords="1497,224,1986,248"/>
<area href="class_d_m_a_c___base.html" title="_" alt="DMAC_Base< T >" shape="rect" coords="1497,280,1986,304"/>
<area href="class_h_m_a_c___base.html" title="_" alt="HMAC_Base" shape="rect" coords="1497,336,1986,360"/>
<area href="class_iterated_hash_base.html" alt="IteratedHashBase< word32, MessageAuthenticationCode >" shape="rect" coords="1497,392,1986,416"/>
<area href="class_iterated_hash_base.html" alt="IteratedHashBase< word64, MessageAuthenticationCode >" shape="rect" coords="1497,448,1986,472"/>
<area href="class_two_bases.html" alt="TwoBases< MessageAuthenticationCode, VariableKeyLength< 32, 0, INT_MAX > >" shape="rect" coords="1497,504,1986,528"/>
<area href="class_cipher_mode_base.html" alt="CipherModeBase" shape="rect" coords="2495,112,2984,136"/>
<area href="class_weak1_1_1_a_r_c4___base.html" title="_" alt="Weak1::ARC4_Base" shape="rect" coords="2495,168,2984,192"/>
</map>
</div></div>
<p><a href="class_simple_keying_interface-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>IV_Requirement</b> { <br/>
  <b>UNIQUE_IV</b> = 0,
<b>RANDOM_IV</b>,
<b>UNPREDICTABLE_RANDOM_IV</b>,
<b>INTERNALLY_GENERATED_IV</b>,
<br/>
  <b>NOT_RESYNCHRONIZABLE</b>
<br/>
}</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2631c49dac4d5ec055c5dc88c6243578"></a><!-- doxytag: member="SimpleKeyingInterface::MinKeyLength" ref="a2631c49dac4d5ec055c5dc88c6243578" args="() const =0" -->
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a2631c49dac4d5ec055c5dc88c6243578">MinKeyLength</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns smallest valid key length in bytes */ <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae02fcb4e1f6141e728ae37612cde6fff"></a><!-- doxytag: member="SimpleKeyingInterface::MaxKeyLength" ref="ae02fcb4e1f6141e728ae37612cde6fff" args="() const =0" -->
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#ae02fcb4e1f6141e728ae37612cde6fff">MaxKeyLength</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns largest valid key length in bytes */ <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae90dfc0bdfd13e214fd46e357ef64e98"></a><!-- doxytag: member="SimpleKeyingInterface::DefaultKeyLength" ref="ae90dfc0bdfd13e214fd46e357ef64e98" args="() const =0" -->
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#ae90dfc0bdfd13e214fd46e357ef64e98">DefaultKeyLength</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns default (recommended) key length in bytes */ <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8810586aaa034729b6db24e593a0ade"></a><!-- doxytag: member="SimpleKeyingInterface::GetValidKeyLength" ref="ad8810586aaa034729b6db24e593a0ade" args="(size_t n) const =0" -->
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#ad8810586aaa034729b6db24e593a0ade">GetValidKeyLength</a> (size_t n) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the smallest valid key length in bytes that is >= min(n, GetMaxKeyLength()) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a024f23c0a094ee46094f69ffefb91d17"></a><!-- doxytag: member="SimpleKeyingInterface::IsValidKeyLength" ref="a024f23c0a094ee46094f69ffefb91d17" args="(size_t n) const " -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a024f23c0a094ee46094f69ffefb91d17">IsValidKeyLength</a> (size_t n) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether n is a valid key length <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#adf3c29b3ef3af74788a58c7c49887fd7">SetKey</a> (const byte *key, size_t length, const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &params=<a class="el" href="cryptlib_8h.html#aa9048ef24353685fd0dcc4180c6884c2">g_nullNameValuePairs</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set or reset the key of this object <a href="#adf3c29b3ef3af74788a58c7c49887fd7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0401f9c67930805180964bc02ae0ac1c"></a><!-- doxytag: member="SimpleKeyingInterface::SetKeyWithRounds" ref="a0401f9c67930805180964bc02ae0ac1c" args="(const byte *key, size_t length, int rounds)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a0401f9c67930805180964bc02ae0ac1c">SetKeyWithRounds</a> (const byte *key, size_t length, int rounds)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">calls <a class="el" href="class_simple_keying_interface.html#adf3c29b3ef3af74788a58c7c49887fd7" title="set or reset the key of this object">SetKey()</a> with an <a class="el" href="class_name_value_pairs.html" title="interface for retrieving values given their names">NameValuePairs</a> object that just specifies "Rounds" <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b4e358c514fd743840967bc595a34c2"></a><!-- doxytag: member="SimpleKeyingInterface::SetKeyWithIV" ref="a5b4e358c514fd743840967bc595a34c2" args="(const byte *key, size_t length, const byte *iv, size_t ivLength)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a5b4e358c514fd743840967bc595a34c2">SetKeyWithIV</a> (const byte *key, size_t length, const byte *iv, size_t ivLength)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">calls <a class="el" href="class_simple_keying_interface.html#adf3c29b3ef3af74788a58c7c49887fd7" title="set or reset the key of this object">SetKey()</a> with an <a class="el" href="class_name_value_pairs.html" title="interface for retrieving values given their names">NameValuePairs</a> object that just specifies "IV" <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac25e27eaeae2e909741c07de93caef49"></a><!-- doxytag: member="SimpleKeyingInterface::SetKeyWithIV" ref="ac25e27eaeae2e909741c07de93caef49" args="(const byte *key, size_t length, const byte *iv)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#ac25e27eaeae2e909741c07de93caef49">SetKeyWithIV</a> (const byte *key, size_t length, const byte *iv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">calls <a class="el" href="class_simple_keying_interface.html#adf3c29b3ef3af74788a58c7c49887fd7" title="set or reset the key of this object">SetKey()</a> with an <a class="el" href="class_name_value_pairs.html" title="interface for retrieving values given their names">NameValuePairs</a> object that just specifies "IV" <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a867b535e5c4a11704d0645272e8b03f9"></a><!-- doxytag: member="SimpleKeyingInterface::IVRequirement" ref="a867b535e5c4a11704d0645272e8b03f9" args="() const =0" -->
virtual IV_Requirement </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a867b535e5c4a11704d0645272e8b03f9">IVRequirement</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the minimal requirement for secure IVs <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#ad263f4a96fa8b4e7d01fea8ccaae9d3b">IsResynchronizable</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this object can be resynchronized (i.e. supports initialization vectors) <a href="#ad263f4a96fa8b4e7d01fea8ccaae9d3b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26680fc02b91534a522b5754cdcdcb46"></a><!-- doxytag: member="SimpleKeyingInterface::CanUseRandomIVs" ref="a26680fc02b91534a522b5754cdcdcb46" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a26680fc02b91534a522b5754cdcdcb46">CanUseRandomIVs</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this object can use random IVs (in addition to ones returned by GetNextIV) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a307463503d7a4400ffafe03a683e1dbb"></a><!-- doxytag: member="SimpleKeyingInterface::CanUsePredictableIVs" ref="a307463503d7a4400ffafe03a683e1dbb" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a307463503d7a4400ffafe03a683e1dbb">CanUsePredictableIVs</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this object can use random but possibly predictable IVs (in addition to ones returned by GetNextIV) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c47590ef06335b34bdaf272fd37ef4d"></a><!-- doxytag: member="SimpleKeyingInterface::CanUseStructuredIVs" ref="a9c47590ef06335b34bdaf272fd37ef4d" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a9c47590ef06335b34bdaf272fd37ef4d">CanUseStructuredIVs</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this object can use structured IVs, for example a counter (in addition to ones returned by GetNextIV) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1b39967f6fac32188f9eeea81896c0c"></a><!-- doxytag: member="SimpleKeyingInterface::IVSize" ref="ac1b39967f6fac32188f9eeea81896c0c" args="() const " -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><b>IVSize</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b2090b3c27540aa3db0281406fedb38"></a><!-- doxytag: member="SimpleKeyingInterface::DefaultIVLength" ref="a5b2090b3c27540aa3db0281406fedb38" args="() const " -->
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a5b2090b3c27540aa3db0281406fedb38">DefaultIVLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns default length of IVs accepted by this object <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4450efa449a2e04a31b6371821e650f9"></a><!-- doxytag: member="SimpleKeyingInterface::MinIVLength" ref="a4450efa449a2e04a31b6371821e650f9" args="() const " -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a4450efa449a2e04a31b6371821e650f9">MinIVLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns minimal length of IVs accepted by this object <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a308799c135440e57a583defe3860f02e"></a><!-- doxytag: member="SimpleKeyingInterface::MaxIVLength" ref="a308799c135440e57a583defe3860f02e" args="() const " -->
virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a308799c135440e57a583defe3860f02e">MaxIVLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns maximal length of IVs accepted by this object <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae576137a46ca56005e82f1505cf3cccc"></a><!-- doxytag: member="SimpleKeyingInterface::Resynchronize" ref="ae576137a46ca56005e82f1505cf3cccc" args="(const byte *iv, int ivLength=-1)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#ae576137a46ca56005e82f1505cf3cccc">Resynchronize</a> (const byte *iv, int ivLength=-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">resynchronize with an IV. ivLength=-1 means use IVSize() <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a917224bb6df7431d6469e7a10feac5fa">GetNextIV</a> (<a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, byte *IV)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get a secure IV for the next message <a href="#a917224bb6df7431d6469e7a10feac5fa"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8cd0ad8e10108ec8b7cf8896fb047b18"></a><!-- doxytag: member="SimpleKeyingInterface::GetAlgorithm" ref="a8cd0ad8e10108ec8b7cf8896fb047b18" args="() const =0" -->
virtual const <a class="el" href="class_algorithm.html">Algorithm</a> & </td><td class="memItemRight" valign="bottom"><b>GetAlgorithm</b> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a911df1b09f35e18a19e474942971947b"></a><!-- doxytag: member="SimpleKeyingInterface::UncheckedSetKey" ref="a911df1b09f35e18a19e474942971947b" args="(const byte *key, unsigned int length, const NameValuePairs &params)=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>UncheckedSetKey</b> (const byte *key, unsigned int length, const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &params)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32b2095542b18025814118734bf34da2"></a><!-- doxytag: member="SimpleKeyingInterface::ThrowIfInvalidKeyLength" ref="a32b2095542b18025814118734bf34da2" args="(size_t length)" -->
void </td><td class="memItemRight" valign="bottom"><b>ThrowIfInvalidKeyLength</b> (size_t length)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae60d9774af66fc673fe6139f5880c477"></a><!-- doxytag: member="SimpleKeyingInterface::ThrowIfResynchronizable" ref="ae60d9774af66fc673fe6139f5880c477" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>ThrowIfResynchronizable</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac687add7d0a09c626d85b77714bbd114"></a><!-- doxytag: member="SimpleKeyingInterface::ThrowIfInvalidIV" ref="ac687add7d0a09c626d85b77714bbd114" args="(const byte *iv)" -->
void </td><td class="memItemRight" valign="bottom"><b>ThrowIfInvalidIV</b> (const byte *iv)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaae6c529f861c47193f3498719e2dc48"></a><!-- doxytag: member="SimpleKeyingInterface::ThrowIfInvalidIVLength" ref="aaae6c529f861c47193f3498719e2dc48" args="(int size)" -->
size_t </td><td class="memItemRight" valign="bottom"><b>ThrowIfInvalidIVLength</b> (int size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66ce967c9b8717baa10b4bdb2312d08d"></a><!-- doxytag: member="SimpleKeyingInterface::GetIVAndThrowIfInvalid" ref="a66ce967c9b8717baa10b4bdb2312d08d" args="(const NameValuePairs &params, size_t &size)" -->
const byte * </td><td class="memItemRight" valign="bottom"><b>GetIVAndThrowIfInvalid</b> (const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &params, size_t &size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a719efcf12f0de461b951830b8131b36a"></a><!-- doxytag: member="SimpleKeyingInterface::AssertValidKeyLength" ref="a719efcf12f0de461b951830b8131b36a" args="(size_t length) const " -->
void </td><td class="memItemRight" valign="bottom"><b>AssertValidKeyLength</b> (size_t length) const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>keying interface for crypto algorithms that take byte strings as keys </p>
<p>Definition at line <a class="el" href="cryptlib_8h_source.html#l00347">347</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adf3c29b3ef3af74788a58c7c49887fd7"></a><!-- doxytag: member="SimpleKeyingInterface::SetKey" ref="adf3c29b3ef3af74788a58c7c49887fd7" args="(const byte *key, size_t length, const NameValuePairs &params=g_nullNameValuePairs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SimpleKeyingInterface::SetKey </td>
<td>(</td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> & </td>
<td class="paramname"><em>params</em> = <code><a class="el" href="cryptlib_8h.html#aa9048ef24353685fd0dcc4180c6884c2">g_nullNameValuePairs</a></code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>set or reset the key of this object </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">params</td><td>is used to specify Rounds, BlockSize, etc. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="class_authenticated_symmetric_cipher_base.html#aea1353c1d0a94c3f81ebcf53f6b7ea57">AuthenticatedSymmetricCipherBase</a>, and <a class="el" href="class_e_c_b___one_way.html#aea389c964114b73390dd81d836124461">ECB_OneWay</a>.</p>
<p>Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00060">60</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a>.</p>
<p>Referenced by <a class="el" href="cryptlib_8cpp_source.html#l00071">SetKeyWithIV()</a>, and <a class="el" href="cryptlib_8cpp_source.html#l00066">SetKeyWithRounds()</a>.</p>
</div>
</div>
<a class="anchor" id="ad263f4a96fa8b4e7d01fea8ccaae9d3b"></a><!-- doxytag: member="SimpleKeyingInterface::IsResynchronizable" ref="ad263f4a96fa8b4e7d01fea8ccaae9d3b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SimpleKeyingInterface::IsResynchronizable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns whether this object can be resynchronized (i.e. supports initialization vectors) </p>
<p>If this function returns true, and no IV is passed to <a class="el" href="class_simple_keying_interface.html#adf3c29b3ef3af74788a58c7c49887fd7" title="set or reset the key of this object">SetKey()</a> and <a class="el" href="class_simple_keying_interface.html#a9c47590ef06335b34bdaf272fd37ef4d" title="returns whether this object can use structured IVs, for example a counter (in addition to ones return...">CanUseStructuredIVs()</a>==true, an IV of all 0's will be assumed. </p>
<p>Definition at line <a class="el" href="cryptlib_8h_source.html#l00386">386</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div>
</div>
<a class="anchor" id="a917224bb6df7431d6469e7a10feac5fa"></a><!-- doxytag: member="SimpleKeyingInterface::GetNextIV" ref="a917224bb6df7431d6469e7a10feac5fa" args="(RandomNumberGenerator &rng, byte *IV)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SimpleKeyingInterface::GetNextIV </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_random_number_generator.html">RandomNumberGenerator</a> & </td>
<td class="paramname"><em>rng</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>IV</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get a secure IV for the next message </p>
<p>This method should be called after you finish encrypting one message and are ready to start the next one. After calling it, you must call <a class="el" href="class_simple_keying_interface.html#adf3c29b3ef3af74788a58c7c49887fd7" title="set or reset the key of this object">SetKey()</a> or <a class="el" href="class_simple_keying_interface.html#ae576137a46ca56005e82f1505cf3cccc" title="resynchronize with an IV. ivLength=-1 means use IVSize()">Resynchronize()</a> before using this object again. This method is not implemented on decryption objects. </p>
<p>Reimplemented in <a class="el" href="class_v_m_a_c___base.html#abd5685ab3eaf6ec272f7e062c3194c6c">VMAC_Base</a>.</p>
<p>Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00136">136</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a>.</p>
<p>References <a class="el" href="cryptlib_8cpp_source.html#l00264">RandomNumberGenerator::GenerateBlock()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="cryptlib_8h_source.html">cryptlib.h</a></li>
<li><a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Oct 16 2011 for Crypto++ by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
