[mirror_ubuntu-zesty-kernel.git] / Documentation / crypto / api.rst

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
Commit	Line	Data
3b72c814 SM	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
8d23da22	25	api-kpp