Merge tag 'media/v4.10-3' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab...
[sfrench/cifs-2.6.git] / Documentation / crypto / api.rst
1 Programming Interface
2 =====================
3
4 Please note that the kernel crypto API contains the AEAD givcrypt API
5 (crypto_aead_giv\* and aead_givcrypt\* function calls in
6 include/crypto/aead.h). This API is obsolete and will be removed in the
7 future. To obtain the functionality of an AEAD cipher with internal IV
8 generation, use the IV generator as a regular cipher. For example,
9 rfc4106(gcm(aes)) is the AEAD cipher with external IV generation and
10 seqniv(rfc4106(gcm(aes))) implies that the kernel crypto API generates
11 the IV. Different IV generators are available.
12
13 .. class:: toc-title
14
15            Table of contents
16
17 .. toctree::
18    :maxdepth: 2
19
20    api-skcipher
21    api-aead
22    api-digest
23    api-rng
24    api-akcipher
25    api-kpp