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