/usr/share/doc/libkcapi/html/API-kcapi-kpp-setkey.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 30 31 32 33 34 35 36 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>kcapi_kpp_setkey</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="ch03s21.html" title="Key Protocol Primitives API - Generic"><link rel="prev" href="API-kcapi-kpp-ecdh-setcurve.html" title="kcapi_kpp_ecdh_setcurve"><link rel="next" href="ch03s22.html" title="Synchronous 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_setkey</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-kcapi-kpp-ecdh-setcurve.html">Prev</a> </td><th width="60%" align="center">Key Protocol Primitives API - Generic</th><td width="20%" align="right"> <a accesskey="n" href="ch03s22.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-kcapi-kpp-setkey"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>kcapi_kpp_setkey —
set the private key of the DH / ECDH operation
</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_kpp_setkey </b>(</code></td><td>struct kcapi_handle * <var class="pdparam">handle</var>, </td></tr><tr><td> </td><td>const 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="idm5362"></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>key</code></em></span></dt><dd><p>
[in] key buffer
</p></dd><dt><span class="term"><em class="parameter"><code>keylen</code></em></span></dt><dd><p>
[in] length of key buffer
</p></dd></dl></div></div><div class="refsect1"><a name="idm5380"></a><h2>Description</h2><p>
With this function, the caller sets the key for subsequent DH / ECDH
public key generation or shared secret generation operations.
</p><p>
If the key / keylen is zero, the kernel tries to generate the private key
itself and retains it internally. This is useful if the DH / ECDH operation
shall be performed on ephemeral keys where the caller is only interested
in eventually obtain the shared secret.
</p><p>
After the caller provided the key, the caller may securely destroy the key
as it is now maintained by the kernel.
</p><p>
Note, the key can only be set after the DH parameters or the ECC curve
has been set.
</p><p>
<em class="parameter"><code>return</code></em> in case of success a positive integer is returned that denominates
the maximum output size of the cryptographic operation -- this value
must be used as the size of the output buffer for one cryptographic
operation);
a negative errno-style error code if an error occurred -- the error
-EOPNOTSUPP is returned in case a kernel-triggered private
key generation is requested, but the underlying cipher implementation
does not support this operation.
</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-ecdh-setcurve.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch03s21.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch03s22.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">kcapi_kpp_ecdh_setcurve</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Synchronous Key Protocol Primitives API - One Shot</td></tr></table></div></body></html>
|