]>
git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blob - include/crypto/ecdh.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * ECDH params to be used with kpp API
5 * Copyright (c) 2016, Intel Corporation
6 * Authors: Salvatore Benedetto <salvatore.benedetto@intel.com>
12 * DOC: ECDH Helper Functions
14 * To use ECDH with the KPP cipher API, the following data structure and
15 * functions should be used.
17 * The ECC curves known to the ECDH implementation are specified in this
20 * To use ECDH with KPP, the following functions should be used to operate on
21 * an ECDH private key. The packet private key that can be set with
22 * the KPP API function call of crypto_kpp_set_secret.
26 #define ECC_CURVE_NIST_P192 0x0001
27 #define ECC_CURVE_NIST_P256 0x0002
30 * struct ecdh - define an ECDH private key
32 * @curve_id: ECC curve the key is based on.
33 * @key: Private ECDH key
34 * @key_size: Size of the private ECDH key
37 unsigned short curve_id
;
39 unsigned short key_size
;
43 * crypto_ecdh_key_len() - Obtain the size of the private ECDH key
44 * @params: private ECDH key
46 * This function returns the packet ECDH key size. A caller can use that
47 * with the provided ECDH private key reference to obtain the required
48 * memory size to hold a packet key.
50 * Return: size of the key in bytes
52 unsigned int crypto_ecdh_key_len(const struct ecdh
*params
);
55 * crypto_ecdh_encode_key() - encode the private key
56 * @buf: Buffer allocated by the caller to hold the packet ECDH
57 * private key. The buffer should be at least crypto_ecdh_key_len
59 * @len: Length of the packet private key buffer
60 * @p: Buffer with the caller-specified private key
62 * The ECDH implementations operate on a packet representation of the private
65 * Return: -EINVAL if buffer has insufficient size, 0 on success
67 int crypto_ecdh_encode_key(char *buf
, unsigned int len
, const struct ecdh
*p
);
70 * crypto_ecdh_decode_key() - decode a private key
71 * @buf: Buffer holding a packet key that should be decoded
72 * @len: Length of the packet private key buffer
73 * @p: Buffer allocated by the caller that is filled with the
74 * unpacked ECDH private key.
76 * The unpacking obtains the private key by pointing @p to the correct location
77 * in @buf. Thus, both pointers refer to the same memory.
79 * Return: -EINVAL if buffer has insufficient size, 0 on success
81 int crypto_ecdh_decode_key(const char *buf
, unsigned int len
, struct ecdh
*p
);