mirror of
https://github.com/torvalds/linux.git
synced 2026-05-25 15:41:52 +02:00
e9af4f47d4
Add a documentation file Documentation/crypto/libcrypto.rst which provides a high-level overview of lib/crypto/. Also add several sub-pages which include the kernel-doc for the algorithms that have it. This makes the existing, quite extensive kernel-doc start being included in the HTML and PDF documentation. Note that the intent is very much *not* that everyone has to read these Documentation/ files. The library is intended to be straightforward and use familiar conventions; generally it should be possible to dive right into the kernel-doc. You shouldn't need to read a lot of documentation to just call `sha256()`, for example, or to run the unit tests if you're already familiar with KUnit. (This differs from the traditional crypto API which has a larger barrier to entry.) Nevertheless, this seems worth adding. Hopefully it is useful and makes LWN no longer consider the library to be "meticulously undocumented". Reviewed-by: Ard Biesheuvel <ardb@kernel.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20260418192138.15556-3-ebiggers@kernel.org Signed-off-by: Eric Biggers <ebiggers@kernel.org>
31 lines
558 B
ReStructuredText
31 lines
558 B
ReStructuredText
==========
|
|
Crypto API
|
|
==========
|
|
|
|
:Author: Stephan Mueller
|
|
:Author: Marek Vasut
|
|
|
|
This documentation outlines the Linux kernel crypto API with its
|
|
concepts, details about developing cipher implementations, employment of the API
|
|
for cryptographic use cases, as well as programming examples.
|
|
|
|
.. toctree::
|
|
:caption: Table of contents
|
|
:maxdepth: 2
|
|
|
|
libcrypto
|
|
intro
|
|
api-intro
|
|
architecture
|
|
|
|
async-tx-api
|
|
asymmetric-keys
|
|
devel-algos
|
|
userspace-if
|
|
crypto_engine
|
|
api
|
|
api-samples
|
|
descore-readme
|
|
device_drivers/index
|
|
krb5
|