<!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++: PasswordBasedKeyDerivationFunction 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.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<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="contents">
<h1>PasswordBasedKeyDerivationFunction Class Reference</h1><!-- doxytag: class="PasswordBasedKeyDerivationFunction" -->
<p>abstract base class for password based key derivation function
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="pwdbased_8h_source.html">pwdbased.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for PasswordBasedKeyDerivationFunction:</div>
<div class="dynsection">
<div class="center">
<img src="class_password_based_key_derivation_function.gif" usemap="#PasswordBasedKeyDerivationFunction_map" alt=""/>
<map id="PasswordBasedKeyDerivationFunction_map" name="PasswordBasedKeyDerivationFunction_map">
<area href="class_p_k_c_s12___p_b_k_d_f.html" alt="PKCS12_PBKDF< T >" shape="rect" coords="0,56,231,80"/>
<area href="class_p_k_c_s5___p_b_k_d_f1.html" alt="PKCS5_PBKDF1< T >" shape="rect" coords="241,56,472,80"/>
<area href="class_p_k_c_s5___p_b_k_d_f2___h_m_a_c.html" alt="PKCS5_PBKDF2_HMAC< T >" shape="rect" coords="482,56,713,80"/>
</map>
</div>
</div>
<p><a href="class_password_based_key_derivation_function-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e1d7d36079b2f75a3a2cd464387d62e"></a><!-- doxytag: member="PasswordBasedKeyDerivationFunction::MaxDerivedKeyLength" ref="a2e1d7d36079b2f75a3a2cd464387d62e" args="() const =0" -->
virtual size_t </td><td class="memItemRight" valign="bottom"><b>MaxDerivedKeyLength</b> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a443b6b4666c00eaed6e24e998072a778"></a><!-- doxytag: member="PasswordBasedKeyDerivationFunction::UsesPurposeByte" ref="a443b6b4666c00eaed6e24e998072a778" args="() const =0" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>UsesPurposeByte</b> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_password_based_key_derivation_function.html#aeaff60e52adddbaf6abd9ff2b64f5356">DeriveKey</a> (byte *derived, size_t derivedLen, byte purpose, const byte *password, size_t passwordLen, const byte *salt, size_t saltLen, unsigned int iterations, double timeInSeconds=0) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">derive key from password <a href="#aeaff60e52adddbaf6abd9ff2b64f5356"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>abstract base class for password based key derivation function </p>
<p>Definition at line <a class="el" href="pwdbased_8h_source.html#l00013">13</a> of file <a class="el" href="pwdbased_8h_source.html">pwdbased.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aeaff60e52adddbaf6abd9ff2b64f5356"></a><!-- doxytag: member="PasswordBasedKeyDerivationFunction::DeriveKey" ref="aeaff60e52adddbaf6abd9ff2b64f5356" args="(byte *derived, size_t derivedLen, byte purpose, const byte *password, size_t passwordLen, const byte *salt, size_t saltLen, unsigned int iterations, double timeInSeconds=0) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int PasswordBasedKeyDerivationFunction::DeriveKey </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"> <em>derived</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>derivedLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">byte </td>
<td class="paramname"> <em>purpose</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"> <em>password</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>passwordLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const byte * </td>
<td class="paramname"> <em>salt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>saltLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>iterations</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>timeInSeconds</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>derive key from password </p>
<p>If timeInSeconds != 0, will iterate until time elapsed, as measured by <a class="el" href="class_thread_user_timer.html" title="measure CPU time spent executing instructions of this thread (if supported by OS)...">ThreadUserTimer</a> Returns actual iteration count, which is equal to iterations if timeInSeconds == 0, and not less than iterations otherwise. </p>
<p>Implemented in <a class="el" href="class_p_k_c_s5___p_b_k_d_f1.html#ae0d2eab2aaf14d0478d1bbd72e5f3e5a">PKCS5_PBKDF1< T ></a>, <a class="el" href="class_p_k_c_s5___p_b_k_d_f2___h_m_a_c.html#a570d711d2a840cdcca4b574b6c20f368">PKCS5_PBKDF2_HMAC< T ></a>, and <a class="el" href="class_p_k_c_s12___p_b_k_d_f.html#a10da705e5b49d3777e244bac6ae0182b">PKCS12_PBKDF< T ></a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pwdbased_8h_source.html">pwdbased.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 9 Dec 2009 for Crypto++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
07dfcfe50d66c9a48a3c5e6c1693f12a
>
files
>
1149
