1 /* SPDX-License-Identifier: GPL-2.0-or-later * << 2 /* 1 /* 3 * Diffie-Hellman secret to be used with kpp A 2 * Diffie-Hellman secret to be used with kpp API along with helper functions 4 * 3 * 5 * Copyright (c) 2016, Intel Corporation 4 * Copyright (c) 2016, Intel Corporation 6 * Authors: Salvatore Benedetto <salvatore.ben 5 * Authors: Salvatore Benedetto <salvatore.benedetto@intel.com> >> 6 * >> 7 * This program is free software; you can redistribute it and/or modify it >> 8 * under the terms of the GNU General Public License as published by the Free >> 9 * Software Foundation; either version 2 of the License, or (at your option) >> 10 * any later version. >> 11 * 7 */ 12 */ 8 #ifndef _CRYPTO_DH_ 13 #ifndef _CRYPTO_DH_ 9 #define _CRYPTO_DH_ 14 #define _CRYPTO_DH_ 10 15 11 /** 16 /** 12 * DOC: DH Helper Functions 17 * DOC: DH Helper Functions 13 * 18 * 14 * To use DH with the KPP cipher API, the foll 19 * To use DH with the KPP cipher API, the following data structure and 15 * functions should be used. 20 * functions should be used. 16 * 21 * 17 * To use DH with KPP, the following functions 22 * To use DH with KPP, the following functions should be used to operate on 18 * a DH private key. The packet private key th 23 * a DH private key. The packet private key that can be set with 19 * the KPP API function call of crypto_kpp_set 24 * the KPP API function call of crypto_kpp_set_secret. 20 */ 25 */ 21 26 22 /** 27 /** 23 * struct dh - define a DH private key 28 * struct dh - define a DH private key 24 * 29 * 25 * @key: Private DH key 30 * @key: Private DH key 26 * @p: Diffie-Hellman parameter P 31 * @p: Diffie-Hellman parameter P >> 32 * @q: Diffie-Hellman parameter Q 27 * @g: Diffie-Hellman generator G 33 * @g: Diffie-Hellman generator G 28 * @key_size: Size of the private DH key 34 * @key_size: Size of the private DH key 29 * @p_size: Size of DH parameter P 35 * @p_size: Size of DH parameter P >> 36 * @q_size: Size of DH parameter Q 30 * @g_size: Size of DH generator G 37 * @g_size: Size of DH generator G 31 */ 38 */ 32 struct dh { 39 struct dh { 33 const void *key; !! 40 void *key; 34 const void *p; !! 41 void *p; 35 const void *g; !! 42 void *q; >> 43 void *g; 36 unsigned int key_size; 44 unsigned int key_size; 37 unsigned int p_size; 45 unsigned int p_size; >> 46 unsigned int q_size; 38 unsigned int g_size; 47 unsigned int g_size; 39 }; 48 }; 40 49 41 /** 50 /** 42 * crypto_dh_key_len() - Obtain the size of th 51 * crypto_dh_key_len() - Obtain the size of the private DH key 43 * @params: private DH key 52 * @params: private DH key 44 * 53 * 45 * This function returns the packet DH key siz 54 * This function returns the packet DH key size. A caller can use that 46 * with the provided DH private key reference 55 * with the provided DH private key reference to obtain the required 47 * memory size to hold a packet key. 56 * memory size to hold a packet key. 48 * 57 * 49 * Return: size of the key in bytes 58 * Return: size of the key in bytes 50 */ 59 */ 51 unsigned int crypto_dh_key_len(const struct dh 60 unsigned int crypto_dh_key_len(const struct dh *params); 52 61 53 /** 62 /** 54 * crypto_dh_encode_key() - encode the private 63 * crypto_dh_encode_key() - encode the private key 55 * @buf: Buffer allocated by the caller 64 * @buf: Buffer allocated by the caller to hold the packet DH 56 * private key. The buffer should 65 * private key. The buffer should be at least crypto_dh_key_len 57 * bytes in size. 66 * bytes in size. 58 * @len: Length of the packet private k 67 * @len: Length of the packet private key buffer 59 * @params: Buffer with the caller-specifi 68 * @params: Buffer with the caller-specified private key 60 * 69 * 61 * The DH implementations operate on a packet 70 * The DH implementations operate on a packet representation of the private 62 * key. 71 * key. 63 * 72 * 64 * Return: -EINVAL if buffer has insuffic 73 * Return: -EINVAL if buffer has insufficient size, 0 on success 65 */ 74 */ 66 int crypto_dh_encode_key(char *buf, unsigned i 75 int crypto_dh_encode_key(char *buf, unsigned int len, const struct dh *params); 67 76 68 /** 77 /** 69 * crypto_dh_decode_key() - decode a private k 78 * crypto_dh_decode_key() - decode a private key 70 * @buf: Buffer holding a packet key th 79 * @buf: Buffer holding a packet key that should be decoded 71 * @len: Length of the packet private k 80 * @len: Length of the packet private key buffer 72 * @params: Buffer allocated by the caller 81 * @params: Buffer allocated by the caller that is filled with the 73 * unpacked DH private key. 82 * unpacked DH private key. 74 * 83 * 75 * The unpacking obtains the private key by po 84 * The unpacking obtains the private key by pointing @p to the correct location 76 * in @buf. Thus, both pointers refer to the s 85 * in @buf. Thus, both pointers refer to the same memory. 77 * 86 * 78 * Return: -EINVAL if buffer has insuffic 87 * Return: -EINVAL if buffer has insufficient size, 0 on success 79 */ 88 */ 80 int crypto_dh_decode_key(const char *buf, unsi 89 int crypto_dh_decode_key(const char *buf, unsigned int len, struct dh *params); 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 90 98 #endif 91 #endif 99 92
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.