/usr/share/doc/libkcapi/html/API-kcapi-kpp-ssgen.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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>kcapi_kpp_ssgen</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="ch03s22.html" title="Synchronous Key Protocol Primitives API - One Shot"><link rel="prev" href="API-kcapi-kpp-keygen.html" title="kcapi_kpp_keygen"><link rel="next" href="ch03s23.html" title="Asynchronous Key Protocol Primitives API - One Shot"></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</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-kcapi-kpp-keygen.html">Prev</a> </td><th width="60%" align="center">Synchronous Key Protocol Primitives API - One Shot</th><td width="20%" align="right"> <a accesskey="n" href="ch03s23.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-kcapi-kpp-ssgen"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>kcapi_kpp_ssgen —
generate a shared secret
</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 </b>(</code></td><td>struct kcapi_handle * <var class="pdparam">handle</var>, </td></tr><tr><td> </td><td>const uint8_t * <var class="pdparam">pubkey</var>, </td></tr><tr><td> </td><td>uint32_t <var class="pdparam">pubkeylen</var>, </td></tr><tr><td> </td><td>uint8_t * <var class="pdparam">ss</var>, </td></tr><tr><td> </td><td>uint32_t <var class="pdparam">sslen</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="idm5475"></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>pubkey</code></em></span></dt><dd><p>
[in] public key of peer that shall be used to generate the shared
secret with
</p></dd><dt><span class="term"><em class="parameter"><code>pubkeylen</code></em></span></dt><dd><p>
[in] length of the public key buffer
</p></dd><dt><span class="term"><em class="parameter"><code>ss</code></em></span></dt><dd><p>
[out] generated shared secret
</p></dd><dt><span class="term"><em class="parameter"><code>sslen</code></em></span></dt><dd><p>
[in] length of key buffer
</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="idm5508"></a><h2>Description</h2><p>
<em class="parameter"><code>return</code></em> number of bytes returned by the shared secret generation operation
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.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch03s22.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch03s23.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">kcapi_kpp_keygen</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Asynchronous Key Protocol Primitives API - One Shot</td></tr></table></div></body></html>
|