Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-release > by-pkgid > 0a67b807a02637f2cae68649d519a89d > files > 1180

libcryptopp-devel-7.0.0-1.mga7.armv7hl.rpm

<!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++: KeyDerivationFunction Class 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++
   &#160;<span id="projectnumber">7.0</span>
   </div>
   <div id="projectbrief">Free&nbsp;C&#43;&#43;&nbsp;class&nbsp;library&nbsp;of&nbsp;cryptographic&nbsp;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&amp;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-methods">Public Member Functions</a> &#124;
<a href="class_key_derivation_function-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">KeyDerivationFunction Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Interface for key derivation functions.  
 <a href="class_key_derivation_function.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for KeyDerivationFunction:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 <div class="center">
  <img src="class_key_derivation_function.png" usemap="#KeyDerivationFunction_map" alt=""/>
  <map id="KeyDerivationFunction_map" name="KeyDerivationFunction_map">
<area href="class_algorithm.html" title="Interface for all crypto algorithms. " alt="Algorithm" shape="rect" coords="241,56,472,80"/>
<area href="class_clonable.html" title="Interface for cloning objects. " alt="Clonable" shape="rect" coords="241,0,472,24"/>
<area href="class_h_k_d_f.html" title="Extract-and-Expand Key Derivation Function (HKDF) " alt="HKDF&lt; T &gt;" shape="rect" coords="0,168,231,192"/>
<area href="struct_password_based_key_derivation_function.html" title="Interface for password based key derivation functions. " alt="PasswordBasedKeyDerivationFunction" shape="rect" coords="241,168,472,192"/>
<area href="class_scrypt.html" title="Scrypt key derivation function. " alt="Scrypt" shape="rect" coords="482,168,713,192"/>
<area href="class_p_k_c_s12___p_b_k_d_f.html" title="PBKDF from PKCS #12, appendix B. " alt="PKCS12_PBKDF&lt; T &gt;" shape="rect" coords="0,224,231,248"/>
<area href="class_p_k_c_s5___p_b_k_d_f1.html" title="PBKDF1 from PKCS #5. " alt="PKCS5_PBKDF1&lt; T &gt;" shape="rect" coords="241,224,472,248"/>
<area href="class_p_k_c_s5___p_b_k_d_f2___h_m_a_c.html" title="PBKDF2 from PKCS #5. " alt="PKCS5_PBKDF2_HMAC&lt; T &gt;" shape="rect" coords="482,224,713,248"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad82f2d983ca8d389346357b378fa969e"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_key_derivation_function.html#ad82f2d983ca8d389346357b378fa969e">AlgorithmName</a> () const =0</td></tr>
<tr class="memdesc:ad82f2d983ca8d389346357b378fa969e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the name of this algorithm.  <a href="#ad82f2d983ca8d389346357b378fa969e">More...</a><br /></td></tr>
<tr class="separator:ad82f2d983ca8d389346357b378fa969e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a78c05721ca33d0aaa6a33a5d7e78e4"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_key_derivation_function.html#a7a78c05721ca33d0aaa6a33a5d7e78e4">MinDerivedLength</a> () const</td></tr>
<tr class="memdesc:a7a78c05721ca33d0aaa6a33a5d7e78e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine minimum number of bytes.  <a href="#a7a78c05721ca33d0aaa6a33a5d7e78e4">More...</a><br /></td></tr>
<tr class="separator:a7a78c05721ca33d0aaa6a33a5d7e78e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a009b339865543eb62af91240ac099a8f"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_key_derivation_function.html#a009b339865543eb62af91240ac099a8f">MaxDerivedLength</a> () const</td></tr>
<tr class="memdesc:a009b339865543eb62af91240ac099a8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine maximum number of bytes.  <a href="#a009b339865543eb62af91240ac099a8f">More...</a><br /></td></tr>
<tr class="separator:a009b339865543eb62af91240ac099a8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0f7e2658135a0df411aa619c7fcac90"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_key_derivation_function.html#ac0f7e2658135a0df411aa619c7fcac90">GetValidDerivedLength</a> (size_t keylength) const =0</td></tr>
<tr class="memdesc:ac0f7e2658135a0df411aa619c7fcac90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a valid key length for the derivation function.  <a href="#ac0f7e2658135a0df411aa619c7fcac90">More...</a><br /></td></tr>
<tr class="separator:ac0f7e2658135a0df411aa619c7fcac90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe22587a8e66ee7e8de494edb1b3f6f9"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_key_derivation_function.html#abe22587a8e66ee7e8de494edb1b3f6f9">IsValidDerivedLength</a> (size_t keylength) const</td></tr>
<tr class="memdesc:abe22587a8e66ee7e8de494edb1b3f6f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether keylength is a valid key length.  <a href="#abe22587a8e66ee7e8de494edb1b3f6f9">More...</a><br /></td></tr>
<tr class="separator:abe22587a8e66ee7e8de494edb1b3f6f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97cb4cd409b17220063c891e80acdf8d"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_key_derivation_function.html#a97cb4cd409b17220063c891e80acdf8d">DeriveKey</a> (byte *derived, size_t derivedLen, const byte *secret, size_t secretLen, const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &amp;params=<a class="el" href="cryptlib_8h.html#a04be65ada92ccb1e6aac0d94b4cc394b">g_nullNameValuePairs</a>) const =0</td></tr>
<tr class="memdesc:a97cb4cd409b17220063c891e80acdf8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Derive a key from a seed.  <a href="#a97cb4cd409b17220063c891e80acdf8d">More...</a><br /></td></tr>
<tr class="separator:a97cb4cd409b17220063c891e80acdf8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e86125e9ca40e3aac741ef240016087"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_key_derivation_function.html#a4e86125e9ca40e3aac741ef240016087">SetParameters</a> (const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &amp;params)</td></tr>
<tr class="memdesc:a4e86125e9ca40e3aac741ef240016087"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set or change parameters.  <a href="#a4e86125e9ca40e3aac741ef240016087">More...</a><br /></td></tr>
<tr class="separator:a4e86125e9ca40e3aac741ef240016087"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_algorithm"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_algorithm')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_algorithm.html">Algorithm</a></td></tr>
<tr class="memitem:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#a1c77f5117ca2cd881baf26a364cfc606">Algorithm</a> (bool checkSelfTestStatus=true)</td></tr>
<tr class="memdesc:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface for all crypto algorithms.  <a href="class_algorithm.html#a1c77f5117ca2cd881baf26a364cfc606">More...</a><br /></td></tr>
<tr class="separator:a1c77f5117ca2cd881baf26a364cfc606 inherit pub_methods_class_algorithm"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_clonable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_clonable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_clonable.html">Clonable</a></td></tr>
<tr class="memitem:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_clonable.html">Clonable</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_clonable.html#ad0016ba2d505c23aa85aad49e6c19bb7">Clone</a> () const</td></tr>
<tr class="memdesc:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies this object.  <a href="class_clonable.html#ad0016ba2d505c23aa85aad49e6c19bb7">More...</a><br /></td></tr>
<tr class="separator:ad0016ba2d505c23aa85aad49e6c19bb7 inherit pub_methods_class_clonable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface for key derivation functions. </p>
<dl class="section since"><dt>Since</dt><dd>Crypto++ 6.2 </dd></dl>

<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l01416">1416</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad82f2d983ca8d389346357b378fa969e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad82f2d983ca8d389346357b378fa969e">&#9670;&nbsp;</a></span>AlgorithmName()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string KeyDerivationFunction::AlgorithmName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Provides the name of this algorithm. </p>
<dl class="section return"><dt>Returns</dt><dd>the standard algorithm name </dd></dl>

<p>Reimplemented from <a class="el" href="class_algorithm.html#a4f31510a192d1121856efe8ad0a9b844">Algorithm</a>.</p>

<p>Implemented in <a class="el" href="class_p_k_c_s12___p_b_k_d_f.html#a8abd0e12203a88a4251cef342e952fc6">PKCS12_PBKDF&lt; T &gt;</a>, <a class="el" href="class_p_k_c_s5___p_b_k_d_f2___h_m_a_c.html#a3cbe4a7c550a8ba3a8366bea30eac557">PKCS5_PBKDF2_HMAC&lt; T &gt;</a>, <a class="el" href="class_scrypt.html#a102cc305016c030ad04a9ca3fa80bee2">Scrypt</a>, <a class="el" href="class_h_k_d_f.html#a673b012e36cc09c69c5c5b810068d676">HKDF&lt; T &gt;</a>, and <a class="el" href="class_p_k_c_s5___p_b_k_d_f1.html#a7a12ab74625092343b438cf38c63928c">PKCS5_PBKDF1&lt; T &gt;</a>.</p>

</div>
</div>
<a id="a7a78c05721ca33d0aaa6a33a5d7e78e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a78c05721ca33d0aaa6a33a5d7e78e4">&#9670;&nbsp;</a></span>MinDerivedLength()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">size_t KeyDerivationFunction::MinDerivedLength </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Determine minimum number of bytes. </p>
<dl class="section return"><dt>Returns</dt><dd>Minimum number of bytes which can be derived </dd></dl>

<p class="definition">Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00342">342</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a>.</p>

</div>
</div>
<a id="a009b339865543eb62af91240ac099a8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a009b339865543eb62af91240ac099a8f">&#9670;&nbsp;</a></span>MaxDerivedLength()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">size_t KeyDerivationFunction::MaxDerivedLength </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Determine maximum number of bytes. </p>
<dl class="section return"><dt>Returns</dt><dd>Maximum number of bytes which can be derived </dd></dl>

<p>Reimplemented in <a class="el" href="class_scrypt.html#ab3b23597d8bcb9af8d55bc8aa57bf709">Scrypt</a>, and <a class="el" href="class_h_k_d_f.html#aa7a98f9e475ba73484f5e63299e3623b">HKDF&lt; T &gt;</a>.</p>

<p class="definition">Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00347">347</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a>.</p>

</div>
</div>
<a id="ac0f7e2658135a0df411aa619c7fcac90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0f7e2658135a0df411aa619c7fcac90">&#9670;&nbsp;</a></span>GetValidDerivedLength()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual size_t KeyDerivationFunction::GetValidDerivedLength </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>keylength</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a valid key length for the derivation function. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">keylength</td><td>the size of the derived key, in bytes </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the valid key length, in bytes </dd></dl>

<p>Implemented in <a class="el" href="class_p_k_c_s12___p_b_k_d_f.html#a964aa86a640bea9809b15d8b7f33e026">PKCS12_PBKDF&lt; T &gt;</a>, <a class="el" href="class_p_k_c_s5___p_b_k_d_f2___h_m_a_c.html#a476cf0b4f00f590343d4db018039c57c">PKCS5_PBKDF2_HMAC&lt; T &gt;</a>, <a class="el" href="class_scrypt.html#a6faaa4a7749a950e1e7d74bbb734ce12">Scrypt</a>, <a class="el" href="class_h_k_d_f.html#a23f6fd8ea5d27c37b18bef25a2f50012">HKDF&lt; T &gt;</a>, and <a class="el" href="class_p_k_c_s5___p_b_k_d_f1.html#ac5ef9f47a5dcd83c686581ac1a18cff4">PKCS5_PBKDF1&lt; T &gt;</a>.</p>

</div>
</div>
<a id="abe22587a8e66ee7e8de494edb1b3f6f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe22587a8e66ee7e8de494edb1b3f6f9">&#9670;&nbsp;</a></span>IsValidDerivedLength()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool KeyDerivationFunction::IsValidDerivedLength </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>keylength</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns whether keylength is a valid key length. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">keylength</td><td>the requested keylength </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the derived keylength is valid, false otherwise</dd></dl>
<p>Internally the function calls GetValidKeyLength() </p>

<p class="definition">Definition at line <a class="el" href="cryptlib_8h_source.html#l01442">1442</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p>

</div>
</div>
<a id="a97cb4cd409b17220063c891e80acdf8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97cb4cd409b17220063c891e80acdf8d">&#9670;&nbsp;</a></span>DeriveKey()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual size_t KeyDerivationFunction::DeriveKey </td>
          <td>(</td>
          <td class="paramtype">byte *&#160;</td>
          <td class="paramname"><em>derived</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>derivedLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const byte *&#160;</td>
          <td class="paramname"><em>secret</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>secretLen</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> &amp;&#160;</td>
          <td class="paramname"><em>params</em> = <code><a class="el" href="cryptlib_8h.html#a04be65ada92ccb1e6aac0d94b4cc394b">g_nullNameValuePairs</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Derive a key from a seed. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">derived</td><td>the derived output buffer </td></tr>
    <tr><td class="paramname">derivedLen</td><td>the size of the derived buffer, in bytes </td></tr>
    <tr><td class="paramname">secret</td><td>the seed input buffer </td></tr>
    <tr><td class="paramname">secretLen</td><td>the size of the secret buffer, in bytes </td></tr>
    <tr><td class="paramname">params</td><td>additional initialization parameters to configure this object </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of iterations performed </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="class_invalid_derived_length.html" title="Exception thrown when an invalid derived key length is encountered. ">InvalidDerivedLength</a></td><td>if <code>derivedLen</code> is invalid for the scheme</td></tr>
  </table>
  </dd>
</dl>
<p><a class="el" href="class_key_derivation_function.html#a97cb4cd409b17220063c891e80acdf8d" title="Derive a key from a seed. ">DeriveKey()</a> provides a standard interface to derive a key from a secret seed and other parameters. Each class that derives from <a class="el" href="class_key_derivation_function.html" title="Interface for key derivation functions. ">KeyDerivationFunction</a> provides an overload that accepts most parameters used by the derivation function.</p>
<p>the number of iterations performed by <a class="el" href="class_key_derivation_function.html#a97cb4cd409b17220063c891e80acdf8d" title="Derive a key from a seed. ">DeriveKey()</a> may be 1. For example, a scheme like <a class="el" href="class_h_k_d_f.html" title="Extract-and-Expand Key Derivation Function (HKDF) ">HKDF</a> does not use the iteration count so it returns 1. </p>

<p>Implemented in <a class="el" href="class_p_k_c_s12___p_b_k_d_f.html#a4adf0129a1902740714d35706e4fda44">PKCS12_PBKDF&lt; T &gt;</a>, <a class="el" href="class_p_k_c_s5___p_b_k_d_f2___h_m_a_c.html#ac3b81a978c1d59da9a2d21535e7d5b36">PKCS5_PBKDF2_HMAC&lt; T &gt;</a>, <a class="el" href="class_scrypt.html#acb52a9def0feda98787bd82fe8bfeded">Scrypt</a>, <a class="el" href="class_h_k_d_f.html#a164b826bcba31d1033a0c62f0162efe3">HKDF&lt; T &gt;</a>, and <a class="el" href="class_p_k_c_s5___p_b_k_d_f1.html#a0a68829c5fa0558aa6f2484492923e66">PKCS5_PBKDF1&lt; T &gt;</a>.</p>

</div>
</div>
<a id="a4e86125e9ca40e3aac741ef240016087"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e86125e9ca40e3aac741ef240016087">&#9670;&nbsp;</a></span>SetParameters()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void KeyDerivationFunction::SetParameters </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &amp;&#160;</td>
          <td class="paramname"><em>params</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set or change parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">params</td><td>additional initialization parameters to configure this object</td></tr>
  </table>
  </dd>
</dl>
<p><a class="el" href="class_key_derivation_function.html#a4e86125e9ca40e3aac741ef240016087" title="Set or change parameters. ">SetParameters()</a> is useful for setting common parameters when an object is reused. Some derivation function classes may choose to implement it. </p>

<p class="definition">Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00358">358</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</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><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:58:41 for Crypto++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>