forked from torvalds/linux
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
- Loading branch information
1 parent
c30c98d
commit 8d23da2
Showing
6 changed files
with
227 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
Key-agreement Protocol Primitives (KPP) Cipher Algorithm Definitions | ||
-------------------------------------------------------------------- | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: kpp_request | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: crypto_kpp | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: kpp_alg | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: kpp_secret | ||
|
||
Key-agreement Protocol Primitives (KPP) Cipher API | ||
-------------------------------------------------- | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:doc: Generic Key-agreement Protocol Primitives API | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: crypto_alloc_kpp | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: crypto_free_kpp | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: crypto_kpp_set_secret | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: crypto_kpp_generate_public_key | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: crypto_kpp_compute_shared_secret | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: crypto_kpp_maxsize | ||
|
||
Key-agreement Protocol Primitives (KPP) Cipher Request Handle | ||
------------------------------------------------------------- | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: kpp_request_alloc | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: kpp_request_free | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: kpp_request_set_callback | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: kpp_request_set_input | ||
|
||
.. kernel-doc:: include/crypto/kpp.h | ||
:functions: kpp_request_set_output | ||
|
||
ECDH Helper Functions | ||
--------------------- | ||
|
||
.. kernel-doc:: include/crypto/ecdh.h | ||
:doc: ECDH Helper Functions | ||
|
||
.. kernel-doc:: include/crypto/ecdh.h | ||
:functions: ecdh | ||
|
||
.. kernel-doc:: include/crypto/ecdh.h | ||
:functions: crypto_ecdh_key_len | ||
|
||
.. kernel-doc:: include/crypto/ecdh.h | ||
:functions: crypto_ecdh_encode_key | ||
|
||
.. kernel-doc:: include/crypto/ecdh.h | ||
:functions: crypto_ecdh_decode_key | ||
|
||
DH Helper Functions | ||
------------------- | ||
|
||
.. kernel-doc:: include/crypto/dh.h | ||
:doc: DH Helper Functions | ||
|
||
.. kernel-doc:: include/crypto/dh.h | ||
:functions: dh | ||
|
||
.. kernel-doc:: include/crypto/dh.h | ||
:functions: crypto_dh_key_len | ||
|
||
.. kernel-doc:: include/crypto/dh.h | ||
:functions: crypto_dh_encode_key | ||
|
||
.. kernel-doc:: include/crypto/dh.h | ||
:functions: crypto_dh_decode_key |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,3 +22,4 @@ the IV. Different IV generators are available. | |
api-digest | ||
api-rng | ||
api-akcipher | ||
api-kpp |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters