/usr/share/doc/libkcapi/html/API-kcapi-pad-iv.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_pad_iv</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="API.html#idm178" title="Common API"><link rel="prev" href="API-kcapi-version.html" title="kcapi_version"><link rel="next" href="API-kcapi-memset-secure.html" title="kcapi_memset_secure"></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_pad_iv</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-kcapi-version.html">Prev</a> </td><th width="60%" align="center">Common API</th><td width="20%" align="right"> <a accesskey="n" href="API-kcapi-memset-secure.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-kcapi-pad-iv"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>kcapi_pad_iv —
realign the IV as necessary for cipher
</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">int <b class="fsfunc">kcapi_pad_iv </b>(</code></td><td>struct kcapi_handle * <var class="pdparam">handle</var>, </td></tr><tr><td> </td><td>const uint8_t * <var class="pdparam">iv</var>, </td></tr><tr><td> </td><td>uint32_t <var class="pdparam">ivlen</var>, </td></tr><tr><td> </td><td>uint8_t ** <var class="pdparam">newiv</var>, </td></tr><tr><td> </td><td>uint32_t * <var class="pdparam">newivlen</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a name="idm324"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>handle</code></em></span></dt><dd><p>
[in] cipher handle
</p></dd><dt><span class="term"><em class="parameter"><code>iv</code></em></span></dt><dd><p>
[in] current IV buffer
</p></dd><dt><span class="term"><em class="parameter"><code>ivlen</code></em></span></dt><dd><p>
[in] length of IV buffer
</p></dd><dt><span class="term"><em class="parameter"><code>newiv</code></em></span></dt><dd><p>
[out] buffer of aligned IV
</p></dd><dt><span class="term"><em class="parameter"><code>newivlen</code></em></span></dt><dd><p>
[out] length of newly aligned IV
</p></dd></dl></div></div><div class="refsect1"><a name="idm352"></a><h2>Description</h2><p>
The function pads the least significant bits of the provided IV up to the
block size of the cipher with zeros. In case the provided IV is longer than
the block size, the least significant bits are truncated to the block size.
</p><p>
The function allocates memory for newiv in case the return code indicates
success. The consumer must free the memory after use.
</p><p>
<em class="parameter"><code>return</code></em> 0 for 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-version.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="API.html#idm178">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="API-kcapi-memset-secure.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">kcapi_version</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_memset_secure</span></td></tr></table></div></body></html>
|