xref: /freebsd/crypto/heimdal/doc/doxyout/hcrypto/html/group__hcrypto__misc.html (revision 38f1b189cd839bd8aa122ae06cc084810ca1e395)
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>Heimdal crypto library: hcrypto miscellaneous functions</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<p>
8<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
9</p>
10<!-- end of header marker -->
11<!-- Generated by Doxygen 1.5.6 -->
12<div class="navigation" id="top">
13  <div class="tabs">
14    <ul>
15      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
16      <li><a href="modules.html"><span>Modules</span></a></li>
17      <li><a href="examples.html"><span>Examples</span></a></li>
18    </ul>
19  </div>
20</div>
21<div class="contents">
22<h1>hcrypto miscellaneous functions</h1><table border="0" cellpadding="0" cellspacing="0">
23<tr><td></td></tr>
24<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
25<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hcrypto__misc.html#gece1627cc5535ef7b5e86e2f5a3eec04">PKCS5_PBKDF2_HMAC_SHA1</a> (const void *password, size_t password_len, const void *salt, size_t salt_len, unsigned long iter, size_t keylen, void *key)</td></tr>
26
27</table>
28<hr><a name="_details"></a><h2>Detailed Description</h2>
29<hr><h2>Function Documentation</h2>
30<a class="anchor" name="gece1627cc5535ef7b5e86e2f5a3eec04"></a><!-- doxytag: member="pkcs5.c::PKCS5_PBKDF2_HMAC_SHA1" ref="gece1627cc5535ef7b5e86e2f5a3eec04" args="(const void *password, size_t password_len, const void *salt, size_t salt_len, unsigned long iter, size_t keylen, void *key)" -->
31<div class="memitem">
32<div class="memproto">
33      <table class="memname">
34        <tr>
35          <td class="memname">int PKCS5_PBKDF2_HMAC_SHA1           </td>
36          <td>(</td>
37          <td class="paramtype">const void *&nbsp;</td>
38          <td class="paramname"> <em>password</em>, </td>
39        </tr>
40        <tr>
41          <td class="paramkey"></td>
42          <td></td>
43          <td class="paramtype">size_t&nbsp;</td>
44          <td class="paramname"> <em>password_len</em>, </td>
45        </tr>
46        <tr>
47          <td class="paramkey"></td>
48          <td></td>
49          <td class="paramtype">const void *&nbsp;</td>
50          <td class="paramname"> <em>salt</em>, </td>
51        </tr>
52        <tr>
53          <td class="paramkey"></td>
54          <td></td>
55          <td class="paramtype">size_t&nbsp;</td>
56          <td class="paramname"> <em>salt_len</em>, </td>
57        </tr>
58        <tr>
59          <td class="paramkey"></td>
60          <td></td>
61          <td class="paramtype">unsigned long&nbsp;</td>
62          <td class="paramname"> <em>iter</em>, </td>
63        </tr>
64        <tr>
65          <td class="paramkey"></td>
66          <td></td>
67          <td class="paramtype">size_t&nbsp;</td>
68          <td class="paramname"> <em>keylen</em>, </td>
69        </tr>
70        <tr>
71          <td class="paramkey"></td>
72          <td></td>
73          <td class="paramtype">void *&nbsp;</td>
74          <td class="paramname"> <em>key</em></td><td>&nbsp;</td>
75        </tr>
76        <tr>
77          <td></td>
78          <td>)</td>
79          <td></td><td></td><td></td>
80        </tr>
81      </table>
82</div>
83<div class="memdoc">
84
85<p>
86As descriped in PKCS5, convert a password, salt, and iteration counter into a crypto key.<p>
87<dl compact><dt><b>Parameters:</b></dt><dd>
88  <table border="0" cellspacing="2" cellpadding="0">
89    <tr><td valign="top"></td><td valign="top"><em>password</em>&nbsp;</td><td>Password. </td></tr>
90    <tr><td valign="top"></td><td valign="top"><em>password_len</em>&nbsp;</td><td>Length of password. </td></tr>
91    <tr><td valign="top"></td><td valign="top"><em>salt</em>&nbsp;</td><td>Salt </td></tr>
92    <tr><td valign="top"></td><td valign="top"><em>salt_len</em>&nbsp;</td><td>Length of salt. </td></tr>
93    <tr><td valign="top"></td><td valign="top"><em>iter</em>&nbsp;</td><td>iteration counter. </td></tr>
94    <tr><td valign="top"></td><td valign="top"><em>keylen</em>&nbsp;</td><td>the output key length. </td></tr>
95    <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>the output key.</td></tr>
96  </table>
97</dl>
98<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success, non 1 on failure. </dd></dl>
99
100</div>
101</div><p>
102</div>
103<hr size="1"><address style="text-align: right;"><small>
104Generated on Wed Jan 11 14:07:38 2012 for Heimdal crypto library by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6</small></address>
105</body>
106</html>
107