/usr/share/doc/libkcapi/html/API-kcapi-kpp-ssgen-aio.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 26 27 28 29 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>kcapi_kpp_ssgen_aio</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="ch03s23.html" title="Asynchronous Key Protocol Primitives API - One Shot"><link rel="prev" href="API-kcapi-kpp-keygen-aio.html" title="kcapi_kpp_keygen_aio"><link rel="next" href="ch03s24.html" title="Key Derivation Functions"></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_kpp_ssgen_aio</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-kcapi-kpp-keygen-aio.html">Prev</a> </td><th width="60%" align="center">Asynchronous Key Protocol Primitives API - One Shot</th><td width="20%" align="right"> <a accesskey="n" href="ch03s24.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-kcapi-kpp-ssgen-aio"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>kcapi_kpp_ssgen_aio —
generate a shared secret (asynchronous one shot)
</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_kpp_ssgen_aio </b>(</code></td><td>struct kcapi_handle * <var class="pdparam">handle</var>, </td></tr><tr><td> </td><td>struct iovec * <var class="pdparam">iniov</var>, </td></tr><tr><td> </td><td>struct iovec * <var class="pdparam">outiov</var>, </td></tr><tr><td> </td><td>uint32_t <var class="pdparam">iovlen</var>, </td></tr><tr><td> </td><td>int <var class="pdparam">access</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a name="idm5599"></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>iniov</code></em></span></dt><dd><p>
[in] head of scatter-gather list of the source buffers with the
public keys of the peer
</p></dd><dt><span class="term"><em class="parameter"><code>outiov</code></em></span></dt><dd><p>
[out] head of scatter-gather list of the destination buffers filled
with the generated shared secret
</p></dd><dt><span class="term"><em class="parameter"><code>iovlen</code></em></span></dt><dd><p>
[in] number of scatter-gather list entries
</p></dd><dt><span class="term"><em class="parameter"><code>access</code></em></span></dt><dd><p>
[in] kernel access type (KCAPI_ACCESS_HEURISTIC - use internal
heuristic for fastest kernel access; KCAPI_ACCESS_VMSPLICE - use
vmsplice access; KCAPI_ACCESS_SENDMSG - sendmsg access)
</p></dd></dl></div></div><div class="refsect1"><a name="idm5627"></a><h2>Description</h2><p>
The individual scatter-gather list entries are processed with
separate invocations of the the given cipher.
</p><p>
The memory should be aligned at the page boundary using
posix_memalign(sysconf(_SC_PAGESIZE)), If it is not aligned at the page
boundary, the vmsplice call may not send all data to the kernel.
</p><p>
<em class="parameter"><code>return</code></em> number of bytes verify 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-kpp-keygen-aio.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch03s23.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch03s24.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">kcapi_kpp_keygen_aio</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Key Derivation Functions</td></tr></table></div></body></html>
|