Sophie

Sophie

distrib > Fedora > 13 > i386 > media > os > by-pkgid > 07dfcfe50d66c9a48a3c5e6c1693f12a > files > 1115

cryptopp-doc-5.6.1-0.1.svn479.fc13.i686.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"/>
<title>Crypto++: PKCS5_PBKDF1&lt; T &gt; Class Template 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>PKCS5_PBKDF1&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="PKCS5_PBKDF1" --><!-- doxytag: inherits="PasswordBasedKeyDerivationFunction" -->
<p>PBKDF1 from PKCS #5, T should be a <a class="el" href="class_hash_transformation.html" title="interface for hash functions and data processing part of MACs">HashTransformation</a> class.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="pwdbased_8h_source.html">pwdbased.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PKCS5_PBKDF1&lt; T &gt;:</div>
<div class="dynsection">
 <div class="center">
  <img src="class_p_k_c_s5___p_b_k_d_f1.gif" usemap="#PKCS5_PBKDF1&lt; T &gt;_map" alt=""/>
  <map id="PKCS5_PBKDF1&lt; T &gt;_map" name="PKCS5_PBKDF1&lt; T &gt;_map">
<area href="class_password_based_key_derivation_function.html" alt="PasswordBasedKeyDerivationFunction" shape="rect" coords="0,0,231,24"/>
</map>
 </div>
</div>

<p><a href="class_p_k_c_s5___p_b_k_d_f1-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="a60f240c7d927ad3650555b99afffbea3"></a><!-- doxytag: member="PKCS5_PBKDF1::MaxDerivedKeyLength" ref="a60f240c7d927ad3650555b99afffbea3" args="() const " -->
size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>MaxDerivedKeyLength</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab09e6c536fc1d7c54de6556ef81e750d"></a><!-- doxytag: member="PKCS5_PBKDF1::UsesPurposeByte" ref="ab09e6c536fc1d7c54de6556ef81e750d" args="() const " -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>UsesPurposeByte</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_k_c_s5___p_b_k_d_f1.html#ae0d2eab2aaf14d0478d1bbd72e5f3e5a">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 </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">derive key from password  <a href="#ae0d2eab2aaf14d0478d1bbd72e5f3e5a"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T&gt;<br/>
 class PKCS5_PBKDF1&lt; T &gt;</h3>

<p>PBKDF1 from PKCS #5, T should be a <a class="el" href="class_hash_transformation.html" title="interface for hash functions and data processing part of MACs">HashTransformation</a> class. </p>

<p>Definition at line <a class="el" href="pwdbased_8h_source.html#l00026">26</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="ae0d2eab2aaf14d0478d1bbd72e5f3e5a"></a><!-- doxytag: member="PKCS5_PBKDF1::DeriveKey" ref="ae0d2eab2aaf14d0478d1bbd72e5f3e5a" 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 " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">unsigned int <a class="el" href="class_p_k_c_s5___p_b_k_d_f1.html">PKCS5_PBKDF1</a>&lt; T &gt;::DeriveKey </td>
          <td>(</td>
          <td class="paramtype">byte *&nbsp;</td>
          <td class="paramname"> <em>derived</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>derivedLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">byte&nbsp;</td>
          <td class="paramname"> <em>purpose</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const byte *&nbsp;</td>
          <td class="paramname"> <em>password</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>passwordLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const byte *&nbsp;</td>
          <td class="paramname"> <em>salt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>saltLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>iterations</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>timeInSeconds</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [inline, 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>Implements <a class="el" href="class_password_based_key_derivation_function.html#aeaff60e52adddbaf6abd9ff2b64f5356">PasswordBasedKeyDerivationFunction</a>.</p>

<p>Definition at line <a class="el" href="pwdbased_8h_source.html#l00056">56</a> of file <a class="el" href="pwdbased_8h_source.html">pwdbased.h</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&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>