linux-brain/Documentation/crypto/api-skcipher.rst
Stephan Mueller 3b72c814a8 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>
2016-12-13 16:37:54 -07:00

204 lines
5.2 KiB
ReStructuredText

Block Cipher Algorithm Definitions
----------------------------------
.. kernel-doc:: include/linux/crypto.h
:doc: Block Cipher Algorithm Definitions
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_alg
.. kernel-doc:: include/linux/crypto.h
:functions: ablkcipher_alg
.. kernel-doc:: include/linux/crypto.h
:functions: blkcipher_alg
.. kernel-doc:: include/linux/crypto.h
:functions: cipher_alg
Symmetric Key Cipher API
------------------------
.. kernel-doc:: include/crypto/skcipher.h
:doc: Symmetric Key Cipher API
.. kernel-doc:: include/crypto/skcipher.h
:functions: crypto_alloc_skcipher
.. kernel-doc:: include/crypto/skcipher.h
:functions: crypto_free_skcipher
.. kernel-doc:: include/crypto/skcipher.h
:functions: crypto_has_skcipher
.. kernel-doc:: include/crypto/skcipher.h
:functions: crypto_skcipher_ivsize
.. kernel-doc:: include/crypto/skcipher.h
:functions: crypto_skcipher_blocksize
.. kernel-doc:: include/crypto/skcipher.h
:functions: crypto_skcipher_setkey
.. kernel-doc:: include/crypto/skcipher.h
:functions: crypto_skcipher_reqtfm
.. kernel-doc:: include/crypto/skcipher.h
:functions: crypto_skcipher_encrypt
.. kernel-doc:: include/crypto/skcipher.h
:functions: crypto_skcipher_decrypt
Symmetric Key Cipher Request Handle
-----------------------------------
.. kernel-doc:: include/crypto/skcipher.h
:doc: Symmetric Key Cipher Request Handle
.. kernel-doc:: include/crypto/skcipher.h
:functions: crypto_skcipher_reqsize
.. kernel-doc:: include/crypto/skcipher.h
:functions: skcipher_request_set_tfm
.. kernel-doc:: include/crypto/skcipher.h
:functions: skcipher_request_alloc
.. kernel-doc:: include/crypto/skcipher.h
:functions: skcipher_request_free
.. kernel-doc:: include/crypto/skcipher.h
:functions: skcipher_request_set_callback
.. kernel-doc:: include/crypto/skcipher.h
:functions: skcipher_request_set_crypt
Single Block Cipher API
-----------------------
.. kernel-doc:: include/linux/crypto.h
:doc: Single Block Cipher API
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_alloc_cipher
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_free_cipher
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_has_cipher
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_cipher_blocksize
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_cipher_setkey
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_cipher_encrypt_one
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_cipher_decrypt_one
Asynchronous Block Cipher API - Deprecated
------------------------------------------
.. kernel-doc:: include/linux/crypto.h
:doc: Asynchronous Block Cipher API
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_alloc_ablkcipher
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_free_ablkcipher
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_has_ablkcipher
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_ablkcipher_ivsize
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_ablkcipher_blocksize
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_ablkcipher_setkey
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_ablkcipher_reqtfm
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_ablkcipher_encrypt
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_ablkcipher_decrypt
Asynchronous Cipher Request Handle - Deprecated
-----------------------------------------------
.. kernel-doc:: include/linux/crypto.h
:doc: Asynchronous Cipher Request Handle
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_ablkcipher_reqsize
.. kernel-doc:: include/linux/crypto.h
:functions: ablkcipher_request_set_tfm
.. kernel-doc:: include/linux/crypto.h
:functions: ablkcipher_request_alloc
.. kernel-doc:: include/linux/crypto.h
:functions: ablkcipher_request_free
.. kernel-doc:: include/linux/crypto.h
:functions: ablkcipher_request_set_callback
.. kernel-doc:: include/linux/crypto.h
:functions: ablkcipher_request_set_crypt
Synchronous Block Cipher API - Deprecated
-----------------------------------------
.. kernel-doc:: include/linux/crypto.h
:doc: Synchronous Block Cipher API
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_alloc_blkcipher
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_free_blkcipher
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_has_blkcipher
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_blkcipher_name
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_blkcipher_ivsize
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_blkcipher_blocksize
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_blkcipher_setkey
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_blkcipher_encrypt
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_blkcipher_encrypt_iv
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_blkcipher_decrypt
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_blkcipher_decrypt_iv
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_blkcipher_set_iv
.. kernel-doc:: include/linux/crypto.h
:functions: crypto_blkcipher_get_iv