summaryrefslogtreecommitdiff
path: root/Documentation/crypto/api.rst
diff options
context:
space:
mode:
authorStephan Mueller <smueller@chronox.de>2016-10-21 05:54:22 +0300
committerJonathan Corbet <corbet@lwn.net>2016-12-14 02:37:54 +0300
commit3b72c814a8e8cd638e1ba0da4dfce501e9dff5af (patch)
treea79b261dd9f10bd3525ed97d1bb54058fc6d9a1e /Documentation/crypto/api.rst
parent868c97a846a73e937d835b09b8c885a69df50ec8 (diff)
downloadlinux-3b72c814a8e8cd638e1ba0da4dfce501e9dff5af.tar.xz
crypto: doc - convert crypto API documentation to Sphinx
With the conversion of the kernel crypto API DocBook to Sphinx, the monolithic document is broken up into individual documents. The documentation is unchanged with the exception of a slight reordering to keep the individual document parts self-contained. Signed-off-by: Stephan Mueller <smueller@chronox.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/crypto/api.rst')
-rw-r--r--Documentation/crypto/api.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/Documentation/crypto/api.rst b/Documentation/crypto/api.rst
new file mode 100644
index 000000000000..f2bbeb0fe9aa
--- /dev/null
+++ b/Documentation/crypto/api.rst
@@ -0,0 +1,24 @@
+Programming Interface
+=====================
+
+Please note that the kernel crypto API contains the AEAD givcrypt API
+(crypto_aead_giv\* and aead_givcrypt\* function calls in
+include/crypto/aead.h). This API is obsolete and will be removed in the
+future. To obtain the functionality of an AEAD cipher with internal IV
+generation, use the IV generator as a regular cipher. For example,
+rfc4106(gcm(aes)) is the AEAD cipher with external IV generation and
+seqniv(rfc4106(gcm(aes))) implies that the kernel crypto API generates
+the IV. Different IV generators are available.
+
+.. class:: toc-title
+
+ Table of contents
+
+.. toctree::
+ :maxdepth: 2
+
+ api-skcipher
+ api-aead
+ api-digest
+ api-rng
+ api-akcipher