]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - Documentation/crypto/api-kpp.rst
crypto: doc - add KPP documentation
[mirror_ubuntu-zesty-kernel.git] / Documentation / crypto / api-kpp.rst
CommitLineData
8d23da22
SM
1Key-agreement Protocol Primitives (KPP) Cipher Algorithm Definitions
2--------------------------------------------------------------------
3
4.. kernel-doc:: include/crypto/kpp.h
5 :functions: kpp_request
6
7.. kernel-doc:: include/crypto/kpp.h
8 :functions: crypto_kpp
9
10.. kernel-doc:: include/crypto/kpp.h
11 :functions: kpp_alg
12
13.. kernel-doc:: include/crypto/kpp.h
14 :functions: kpp_secret
15
16Key-agreement Protocol Primitives (KPP) Cipher API
17--------------------------------------------------
18
19.. kernel-doc:: include/crypto/kpp.h
20 :doc: Generic Key-agreement Protocol Primitives API
21
22.. kernel-doc:: include/crypto/kpp.h
23 :functions: crypto_alloc_kpp
24
25.. kernel-doc:: include/crypto/kpp.h
26 :functions: crypto_free_kpp
27
28.. kernel-doc:: include/crypto/kpp.h
29 :functions: crypto_kpp_set_secret
30
31.. kernel-doc:: include/crypto/kpp.h
32 :functions: crypto_kpp_generate_public_key
33
34.. kernel-doc:: include/crypto/kpp.h
35 :functions: crypto_kpp_compute_shared_secret
36
37.. kernel-doc:: include/crypto/kpp.h
38 :functions: crypto_kpp_maxsize
39
40Key-agreement Protocol Primitives (KPP) Cipher Request Handle
41-------------------------------------------------------------
42
43.. kernel-doc:: include/crypto/kpp.h
44 :functions: kpp_request_alloc
45
46.. kernel-doc:: include/crypto/kpp.h
47 :functions: kpp_request_free
48
49.. kernel-doc:: include/crypto/kpp.h
50 :functions: kpp_request_set_callback
51
52.. kernel-doc:: include/crypto/kpp.h
53 :functions: kpp_request_set_input
54
55.. kernel-doc:: include/crypto/kpp.h
56 :functions: kpp_request_set_output
57
58ECDH Helper Functions
59---------------------
60
61.. kernel-doc:: include/crypto/ecdh.h
62 :doc: ECDH Helper Functions
63
64.. kernel-doc:: include/crypto/ecdh.h
65 :functions: ecdh
66
67.. kernel-doc:: include/crypto/ecdh.h
68 :functions: crypto_ecdh_key_len
69
70.. kernel-doc:: include/crypto/ecdh.h
71 :functions: crypto_ecdh_encode_key
72
73.. kernel-doc:: include/crypto/ecdh.h
74 :functions: crypto_ecdh_decode_key
75
76DH Helper Functions
77-------------------
78
79.. kernel-doc:: include/crypto/dh.h
80 :doc: DH Helper Functions
81
82.. kernel-doc:: include/crypto/dh.h
83 :functions: dh
84
85.. kernel-doc:: include/crypto/dh.h
86 :functions: crypto_dh_key_len
87
88.. kernel-doc:: include/crypto/dh.h
89 :functions: crypto_dh_encode_key
90
91.. kernel-doc:: include/crypto/dh.h
92 :functions: crypto_dh_decode_key