<!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++: PasswordBasedKeyDerivationFunction Struct 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="struct_password_based_key_derivation_function-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">PasswordBasedKeyDerivationFunction Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>Interface for password based key derivation functions. <a href="struct_password_based_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 PasswordBasedKeyDerivationFunction:</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="struct_password_based_key_derivation_function.png" usemap="#PasswordBasedKeyDerivationFunction_map" alt=""/> <map id="PasswordBasedKeyDerivationFunction_map" name="PasswordBasedKeyDerivationFunction_map"> <area href="class_key_derivation_function.html" title="Interface for key derivation functions. " alt="KeyDerivationFunction" shape="rect" coords="241,112,472,136"/> <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_p_k_c_s12___p_b_k_d_f.html" title="PBKDF from PKCS #12, appendix B. " alt="PKCS12_PBKDF< T >" 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< T >" 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< T >" shape="rect" coords="482,224,713,248"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> Additional Inherited Members</h2></td></tr> <tr class="inherit_header pub_methods_class_key_derivation_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_key_derivation_function')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_key_derivation_function.html">KeyDerivationFunction</a></td></tr> <tr class="memitem:ad82f2d983ca8d389346357b378fa969e inherit pub_methods_class_key_derivation_function"><td class="memItemLeft" align="right" valign="top">virtual std::string </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 inherit pub_methods_class_key_derivation_function"><td class="mdescLeft"> </td><td class="mdescRight">Provides the name of this algorithm. <a href="class_key_derivation_function.html#ad82f2d983ca8d389346357b378fa969e">More...</a><br /></td></tr> <tr class="separator:ad82f2d983ca8d389346357b378fa969e inherit pub_methods_class_key_derivation_function"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7a78c05721ca33d0aaa6a33a5d7e78e4 inherit pub_methods_class_key_derivation_function"><td class="memItemLeft" align="right" valign="top">virtual size_t </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 inherit pub_methods_class_key_derivation_function"><td class="mdescLeft"> </td><td class="mdescRight">Determine minimum number of bytes. <a href="class_key_derivation_function.html#a7a78c05721ca33d0aaa6a33a5d7e78e4">More...</a><br /></td></tr> <tr class="separator:a7a78c05721ca33d0aaa6a33a5d7e78e4 inherit pub_methods_class_key_derivation_function"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a009b339865543eb62af91240ac099a8f inherit pub_methods_class_key_derivation_function"><td class="memItemLeft" align="right" valign="top">virtual size_t </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 inherit pub_methods_class_key_derivation_function"><td class="mdescLeft"> </td><td class="mdescRight">Determine maximum number of bytes. <a href="class_key_derivation_function.html#a009b339865543eb62af91240ac099a8f">More...</a><br /></td></tr> <tr class="separator:a009b339865543eb62af91240ac099a8f inherit pub_methods_class_key_derivation_function"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac0f7e2658135a0df411aa619c7fcac90 inherit pub_methods_class_key_derivation_function"><td class="memItemLeft" align="right" valign="top">virtual size_t </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 inherit pub_methods_class_key_derivation_function"><td class="mdescLeft"> </td><td class="mdescRight">Returns a valid key length for the derivation function. <a href="class_key_derivation_function.html#ac0f7e2658135a0df411aa619c7fcac90">More...</a><br /></td></tr> <tr class="separator:ac0f7e2658135a0df411aa619c7fcac90 inherit pub_methods_class_key_derivation_function"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abe22587a8e66ee7e8de494edb1b3f6f9 inherit pub_methods_class_key_derivation_function"><td class="memItemLeft" align="right" valign="top">virtual bool </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 inherit pub_methods_class_key_derivation_function"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether keylength is a valid key length. <a href="class_key_derivation_function.html#abe22587a8e66ee7e8de494edb1b3f6f9">More...</a><br /></td></tr> <tr class="separator:abe22587a8e66ee7e8de494edb1b3f6f9 inherit pub_methods_class_key_derivation_function"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a97cb4cd409b17220063c891e80acdf8d inherit pub_methods_class_key_derivation_function"><td class="memItemLeft" align="right" valign="top">virtual size_t </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> &params=<a class="el" href="cryptlib_8h.html#a04be65ada92ccb1e6aac0d94b4cc394b">g_nullNameValuePairs</a>) const =0</td></tr> <tr class="memdesc:a97cb4cd409b17220063c891e80acdf8d inherit pub_methods_class_key_derivation_function"><td class="mdescLeft"> </td><td class="mdescRight">Derive a key from a seed. <a href="class_key_derivation_function.html#a97cb4cd409b17220063c891e80acdf8d">More...</a><br /></td></tr> <tr class="separator:a97cb4cd409b17220063c891e80acdf8d inherit pub_methods_class_key_derivation_function"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4e86125e9ca40e3aac741ef240016087 inherit pub_methods_class_key_derivation_function"><td class="memItemLeft" align="right" valign="top">virtual void </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> &params)</td></tr> <tr class="memdesc:a4e86125e9ca40e3aac741ef240016087 inherit pub_methods_class_key_derivation_function"><td class="mdescLeft"> </td><td class="mdescRight">Set or change parameters. <a href="class_key_derivation_function.html#a4e86125e9ca40e3aac741ef240016087">More...</a><br /></td></tr> <tr class="separator:a4e86125e9ca40e3aac741ef240016087 inherit pub_methods_class_key_derivation_function"><td class="memSeparator" colspan="2"> </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="-"/> 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"> </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"> </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"> </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="-"/> 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> * </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"> </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"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Interface for password based 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#l01480">1480</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p> </div><hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="cryptlib_8h_source.html">cryptlib.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sun Sep 16 2018 07:58:47 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>