/usr/share/doc/libkcapi/html/API-kcapi-pbkdf.html is in libkcapi-doc 1.0.3-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>kcapi_pbkdf</title><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Linux Kernel Crypto API User Space Interface Library"><link rel="up" href="ch03s24.html" title="Key Derivation Functions"><link rel="prev" href="API-kcapi-kdf-ctr.html" title="kcapi_kdf_ctr"><link rel="next" href="API-kcapi-pbkdf-iteration-count.html" title="kcapi_pbkdf_iteration_count"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="phrase">kcapi_pbkdf</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-kcapi-kdf-ctr.html">Prev</a> </td><th width="60%" align="center">Key Derivation Functions</th><td width="20%" align="right"> <a accesskey="n" href="API-kcapi-pbkdf-iteration-count.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-kcapi-pbkdf"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>kcapi_pbkdf —
Password-based Key Derivation Function
</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int32_t <b class="fsfunc">kcapi_pbkdf </b>(</code></td><td>const char * <var class="pdparam">hashname</var>, </td></tr><tr><td> </td><td>const uint8_t * <var class="pdparam">pw</var>, </td></tr><tr><td> </td><td>uint32_t <var class="pdparam">pwlen</var>, </td></tr><tr><td> </td><td>const uint8_t * <var class="pdparam">salt</var>, </td></tr><tr><td> </td><td>uint32_t <var class="pdparam">saltlen</var>, </td></tr><tr><td> </td><td>uint32_t <var class="pdparam">count</var>, </td></tr><tr><td> </td><td>uint8_t * <var class="pdparam">key</var>, </td></tr><tr><td> </td><td>uint32_t <var class="pdparam">keylen</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a name="idm5868"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>hashname</code></em></span></dt><dd><p>
[in] kernel crypto API name of a keyed hash (e.g. hmac(sha1))
</p></dd><dt><span class="term"><em class="parameter"><code>pw</code></em></span></dt><dd><p>
[in] Password a key shall be derived from
</p></dd><dt><span class="term"><em class="parameter"><code>pwlen</code></em></span></dt><dd><p>
[in] Length of password string
</p></dd><dt><span class="term"><em class="parameter"><code>salt</code></em></span></dt><dd><p>
[in] Salt as defined in SP800-132
</p></dd><dt><span class="term"><em class="parameter"><code>saltlen</code></em></span></dt><dd><p>
[in] Length of salt buffer
</p></dd><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p>
[in] Numbers of iterations to be performed for the PBKDF
</p></dd><dt><span class="term"><em class="parameter"><code>key</code></em></span></dt><dd><p>
[out] Buffer to store the generated key in
</p></dd><dt><span class="term"><em class="parameter"><code>keylen</code></em></span></dt><dd><p>
[in] Size of the key to be generated (i.e. length of the key buffer)
</p></dd></dl></div></div><div class="refsect1"><a name="idm5911"></a><h2>Description</h2><p>
This function is an implementation of the PBKDF as defined in SP800-132.
</p><p>
<em class="parameter"><code>return</code></em> 0 upon success;
a negative errno-style error code if an error occurred
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-kcapi-kdf-ctr.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch03s24.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="API-kcapi-pbkdf-iteration-count.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">kcapi_kdf_ctr</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span class="phrase">kcapi_pbkdf_iteration_count</span></td></tr></table></div></body></html>
|