kernel/linux.git/Documentation/crypto/api-akcipher.rst, branch v6.18.22

crypto: doc - Add explicit title heading to API docs

2025-09-28T03:54:48+00:00

Documentation for crypto programming interfaces lack explicit title. As such, all its sections become entries in the toctree index. Add the title heading to tidy up toctree. Signed-off-by: Bagas Sanjaya Reviewed-by: Randy Dunlap Tested-by: Randy Dunlap Signed-off-by: Herbert Xu

crypto: doc - Fix akcipher title reference

2024-10-10T09:08:02+00:00

Stephen reports a documentation build warning for "make htmldocs" introduced by recent commit 6b34562f0cfe ("crypto: akcipher - Drop sign/verify operations"). The commit renamed a paragraph title in a header file, but neglected to amend the title reference in the API documentation. Fix it. Fixes: 6b34562f0cfe ("crypto: akcipher - Drop sign/verify operations") Reported-by: Stephen Rothwell Closes: https://lore.kernel.org/all/20241008172926.0b995ea7@canb.auug.org.au/ Signed-off-by: Lukas Wunner Signed-off-by: Herbert Xu

crypto: akcipher - Drop sign/verify operations

2024-10-05T05:22:04+00:00

A sig_alg backend has just been introduced and all asymmetric sign/verify algorithms have been migrated to it. The sign/verify operations can thus be dropped from akcipher_alg. It is now purely for asymmetric encrypt/decrypt. Move struct crypto_akcipher_sync_data from internal.h to akcipher.c and unexport crypto_akcipher_sync_{prep,post}(): They're no longer used by sig.c but only locally in akcipher.c. In crypto_akcipher_sync_{prep,post}(), drop various NULL pointer checks for data->dst as they were only necessary for the verify operation. In the crypto_sig_*() API calls, remove the forks that were necessary while algorithms were converted from crypto_akcipher to crypto_sig one by one. In struct akcipher_testvec, remove the "params", "param_len" and "algo" elements as they were only needed for the ecrdsa verify operation. Remove corresponding dead code from test_akcipher_one() as well. Signed-off-by: Lukas Wunner Signed-off-by: Herbert Xu

crypto: doc - optimize compilation

2016-12-13T23:38:07+00:00

The :functions: definition allows the specification of multiple function references which prevents parsing the header file multiple times. Reported-by: Jani Nikula Signed-off-by: Stephan Mueller Signed-off-by: Jonathan Corbet

crypto: doc - fix separation of cipher / req API

2016-12-13T23:38:05+00:00

Keep the cipher API and the request API function documentation in separate sections. Signed-off-by: Stephan Mueller Signed-off-by: Jonathan Corbet

crypto: doc - convert crypto API documentation to Sphinx

2016-12-13T23:37:54+00:00

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 Signed-off-by: Jonathan Corbet