diff options
| author | Stephan Mueller | 2016-10-21 04:54:22 +0200 |
|---|---|---|
| committer | Jonathan Corbet | 2016-12-14 00:37:54 +0100 |
| commit | 3b72c814a8e8cd638e1ba0da4dfce501e9dff5af (patch) | |
| tree | a79b261dd9f10bd3525ed97d1bb54058fc6d9a1e /Documentation/crypto/api.rst | |
| parent | dma-buf: Extract dma-buf.rst (diff) | |
| download | kernel-qcow2-linux-3b72c814a8e8cd638e1ba0da4dfce501e9dff5af.tar.gz kernel-qcow2-linux-3b72c814a8e8cd638e1ba0da4dfce501e9dff5af.tar.xz kernel-qcow2-linux-3b72c814a8e8cd638e1ba0da4dfce501e9dff5af.zip | |
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.rst | 24 |
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 |