/usr/share/doc/libkcapi/html/API-kcapi-aead-getdata-output.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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>kcapi_aead_getdata_output</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="ch03s07.html" title="AEAD Cipher API - Generic"><link rel="prev" href="API-kcapi-aead-getdata-input.html" title="kcapi_aead_getdata_input"><link rel="next" href="ch03s08.html" title="Synchronous AEAD Cipher 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_aead_getdata_output</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-kcapi-aead-getdata-input.html">Prev</a> </td><th width="60%" align="center">AEAD Cipher API - Generic</th><td width="20%" align="right"> <a accesskey="n" href="ch03s08.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-kcapi-aead-getdata-output"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>kcapi_aead_getdata_output —
get the pointers into output buffer
</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">void <b class="fsfunc">kcapi_aead_getdata_output </b>(</code></td><td>struct kcapi_handle * <var class="pdparam">handle</var>, </td></tr><tr><td> </td><td>uint8_t * <var class="pdparam">encdata</var>, </td></tr><tr><td> </td><td>uint32_t <var class="pdparam">encdatalen</var>, </td></tr><tr><td> </td><td>int <var class="pdparam">enc</var>, </td></tr><tr><td> </td><td>uint8_t ** <var class="pdparam">aad</var>, </td></tr><tr><td> </td><td>uint32_t * <var class="pdparam">aadlen</var>, </td></tr><tr><td> </td><td>uint8_t ** <var class="pdparam">data</var>, </td></tr><tr><td> </td><td>uint32_t * <var class="pdparam">datalen</var>, </td></tr><tr><td> </td><td>uint8_t ** <var class="pdparam">tag</var>, </td></tr><tr><td> </td><td>uint32_t * <var class="pdparam">taglen</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a name="idm2204"></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>encdata</code></em></span></dt><dd><p>
[in] data buffer returned by the encryption operation
</p></dd><dt><span class="term"><em class="parameter"><code>encdatalen</code></em></span></dt><dd><p>
[in] size of the encryption data buffer
</p></dd><dt><span class="term"><em class="parameter"><code>enc</code></em></span></dt><dd><p>
[in] does output buffer hold encryption or decryption result?
</p></dd><dt><span class="term"><em class="parameter"><code>aad</code></em></span></dt><dd><p>
[out] AD buffer pointer; when set to NULL, no data pointer is
returned; returned pointer may also be NULL
</p></dd><dt><span class="term"><em class="parameter"><code>aadlen</code></em></span></dt><dd><p>
[out] length of AD; when aad was set to NULL, no information is
returned
</p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p>
[out] pointer to output buffer from AEAD encryption operation
when set to NULL, no data pointer is returned
</p></dd><dt><span class="term"><em class="parameter"><code>datalen</code></em></span></dt><dd><p>
[out] length of data buffer; when data was set to NULL, no
information is returned
</p></dd><dt><span class="term"><em class="parameter"><code>tag</code></em></span></dt><dd><p>
[out] tag buffer pointer; when set to NULL, no data pointer is
returned; returned pointer may also be NULL
</p></dd><dt><span class="term"><em class="parameter"><code>taglen</code></em></span></dt><dd><p>
[out] length of tag; when tag was set to NULL, no information
is returned
</p></dd></dl></div></div><div class="refsect1"><a name="idm2257"></a><h2>Description</h2><p>
This function is a service function to the consumer to locate the right
ciphertext buffer offset holding the authentication tag. In addition, it
provides the consumer with the length of the tag and the length of the
ciphertext.
</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-aead-getdata-input.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch03s07.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch03s08.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">kcapi_aead_getdata_input</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Synchronous AEAD Cipher API - One Shot</td></tr></table></div></body></html>
|