diff options
| author | Linus Torvalds <torvalds@linux-foundation.org> | 2016-12-17 16:00:34 -0800 |
|---|---|---|
| committer | Linus Torvalds <torvalds@linux-foundation.org> | 2016-12-17 16:00:34 -0800 |
| commit | 0aaf2146ecf00f7932f472ec5aa30d999c89530c (patch) | |
| tree | 690dd244437f1974b8132fcb1e360213f827bf94 /Documentation/crypto/api.rst | |
| parent | 59331c215daf600a650e281b6e8ef3e1ed1174c2 (diff) | |
| parent | 3fa71d0f58a9b9df84e8e79196f961bcfbf01b2e (diff) | |
| download | linux-0aaf2146ecf00f7932f472ec5aa30d999c89530c.tar.bz2 | |
Merge tag 'docs-4.10-2' of git://git.lwn.net/linux
Pull more documentation updates from Jonathan Corbet:
"This converts the crypto DocBook to Sphinx"
* tag 'docs-4.10-2' of git://git.lwn.net/linux:
crypto: doc - optimize compilation
crypto: doc - clarify AEAD memory structure
crypto: doc - remove crypto_alloc_ablkcipher
crypto: doc - add KPP documentation
crypto: doc - fix separation of cipher / req API
crypto: doc - fix source comments for Sphinx
crypto: doc - remove crypto API DocBook
crypto: doc - convert crypto API documentation to Sphinx
Diffstat (limited to 'Documentation/crypto/api.rst')
| -rw-r--r-- | Documentation/crypto/api.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/Documentation/crypto/api.rst b/Documentation/crypto/api.rst new file mode 100644 index 000000000000..2e519193ab4a --- /dev/null +++ b/Documentation/crypto/api.rst @@ -0,0 +1,25 @@ +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 + api-kpp |