/usr/share/doc/libkcapi/html/API-kcapi-cipher-dec-aes-ctr.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 37 38 39 40 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>kcapi_cipher_dec_aes_ctr</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="ch03s04.html" title="Symmetric Cipher API - Convenience"><link rel="prev" href="API-kcapi-cipher-enc-aes-ctr.html" title="kcapi_cipher_enc_aes_ctr"><link rel="next" href="ch03s05.html" title="Asynchronous Symmetric 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_cipher_dec_aes_ctr</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-kcapi-cipher-enc-aes-ctr.html">Prev</a> </td><th width="60%" align="center">Symmetric Cipher API - Convenience</th><td width="20%" align="right"> <a accesskey="n" href="ch03s05.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-kcapi-cipher-dec-aes-ctr"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>kcapi_cipher_dec_aes_ctr —
Convenience function for AES CTR decryption
</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_cipher_dec_aes_ctr </b>(</code></td><td>const uint8_t * <var class="pdparam">key</var>, </td></tr><tr><td> </td><td>uint32_t <var class="pdparam">keylen</var>, </td></tr><tr><td> </td><td>const uint8_t * <var class="pdparam">in</var>, </td></tr><tr><td> </td><td>uint32_t <var class="pdparam">inlen</var>, </td></tr><tr><td> </td><td>const uint8_t * <var class="pdparam">ctr</var>, </td></tr><tr><td> </td><td>uint8_t * <var class="pdparam">out</var>, </td></tr><tr><td> </td><td>uint32_t <var class="pdparam">outlen</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a name="idm1038"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><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><dt><span class="term"><em class="parameter"><code>in</code></em></span></dt><dd><p>
[in] ciphertext data buffer
</p></dd><dt><span class="term"><em class="parameter"><code>inlen</code></em></span></dt><dd><p>
[in] length of in buffer
</p></dd><dt><span class="term"><em class="parameter"><code>ctr</code></em></span></dt><dd><p>
[in] start counter value to be used for cipher operation
</p></dd><dt><span class="term"><em class="parameter"><code>out</code></em></span></dt><dd><p>
[out] plaintext data buffer
</p></dd><dt><span class="term"><em class="parameter"><code>outlen</code></em></span></dt><dd><p>
[in] length of out buffer
</p></dd></dl></div></div><div class="refsect1"><a name="idm1076"></a><h2>Description</h2><p>
The convenience function performs an AES counter mode encryption operation
using the provided key, the given input buffer and the given IV.
The output is stored in the out buffer.
</p><p>
The input buffer can be of arbitrary length.
</p><p>
The output buffer must be at least as large as the input buffer.
</p><p>
The start counter can contain all zeros (not a NULL buffer!) and must be
exactly 16 bytes in size.
</p><p>
The AES type (AES-128, AES-192 or AES-256) is determined by the size
of the given key. If the key is 16 bytes long, AES-128 is used. A 24 byte
key implies AES-192 and a 32 byte key implies AES-256.
</p><p>
<em class="parameter"><code>return</code></em> number of bytes generated 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-cipher-enc-aes-ctr.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch03s04.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch03s05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">kcapi_cipher_enc_aes_ctr</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Asynchronous Symmetric Cipher API - One Shot</td></tr></table></div></body></html>
|