mirror of
https://github.com/torvalds/linux.git
synced 2024-11-23 20:51:44 +00:00
8d23da22ac
Add the KPP API documentation to the kernel crypto API Sphinx documentation. This addition includes the documentation of the ECDH and DH helpers which are needed to create the approrpiate input data for the crypto_kpp_set_secret function. Signed-off-by: Stephan Mueller <smueller@chronox.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
26 lines
725 B
ReStructuredText
26 lines
725 B
ReStructuredText
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
|