1 /* SPDX-License-Identifier: GPL-2.0-or-later * 1
2 /*
3 * Diffie-Hellman secret to be used with kpp A
4 *
5 * Copyright (c) 2016, Intel Corporation
6 * Authors: Salvatore Benedetto <salvatore.ben
7 */
8 #ifndef _CRYPTO_DH_
9 #define _CRYPTO_DH_
10
11 /**
12 * DOC: DH Helper Functions
13 *
14 * To use DH with the KPP cipher API, the foll
15 * functions should be used.
16 *
17 * To use DH with KPP, the following functions
18 * a DH private key. The packet private key th
19 * the KPP API function call of crypto_kpp_set
20 */
21
22 /**
23 * struct dh - define a DH private key
24 *
25 * @key: Private DH key
26 * @p: Diffie-Hellman parameter P
27 * @g: Diffie-Hellman generator G
28 * @key_size: Size of the private DH key
29 * @p_size: Size of DH parameter P
30 * @g_size: Size of DH generator G
31 */
32 struct dh {
33 const void *key;
34 const void *p;
35 const void *g;
36 unsigned int key_size;
37 unsigned int p_size;
38 unsigned int g_size;
39 };
40
41 /**
42 * crypto_dh_key_len() - Obtain the size of th
43 * @params: private DH key
44 *
45 * This function returns the packet DH key siz
46 * with the provided DH private key reference
47 * memory size to hold a packet key.
48 *
49 * Return: size of the key in bytes
50 */
51 unsigned int crypto_dh_key_len(const struct dh
52
53 /**
54 * crypto_dh_encode_key() - encode the private
55 * @buf: Buffer allocated by the caller
56 * private key. The buffer should
57 * bytes in size.
58 * @len: Length of the packet private k
59 * @params: Buffer with the caller-specifi
60 *
61 * The DH implementations operate on a packet
62 * key.
63 *
64 * Return: -EINVAL if buffer has insuffic
65 */
66 int crypto_dh_encode_key(char *buf, unsigned i
67
68 /**
69 * crypto_dh_decode_key() - decode a private k
70 * @buf: Buffer holding a packet key th
71 * @len: Length of the packet private k
72 * @params: Buffer allocated by the caller
73 * unpacked DH private key.
74 *
75 * The unpacking obtains the private key by po
76 * in @buf. Thus, both pointers refer to the s
77 *
78 * Return: -EINVAL if buffer has insuffic
79 */
80 int crypto_dh_decode_key(const char *buf, unsi
81
82 /**
83 * __crypto_dh_decode_key() - decode a private
84 * @buf: Buffer holding a packet key th
85 * @len: Length of the packet private k
86 * @params: Buffer allocated by the caller
87 * unpacked DH private key.
88 *
89 * Internal function providing the same servic
90 * crypto_dh_decode_key(), but without any of
91 * checks conducted by the latter.
92 *
93 * Return: -EINVAL if buffer has insuffic
94 */
95 int __crypto_dh_decode_key(const char *buf, un
96 struct dh *params);
97
98 #endif
99
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.