^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-or-later */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * ECDH params to be used with kpp API
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (c) 2016, Intel Corporation
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Authors: Salvatore Benedetto <salvatore.benedetto@intel.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #ifndef _CRYPTO_ECDH_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #define _CRYPTO_ECDH_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) * DOC: ECDH Helper Functions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) * To use ECDH with the KPP cipher API, the following data structure and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) * functions should be used.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) * The ECC curves known to the ECDH implementation are specified in this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) * header file.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) * To use ECDH with KPP, the following functions should be used to operate on
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) * an ECDH private key. The packet private key that can be set with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) * the KPP API function call of crypto_kpp_set_secret.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) /* Curves IDs */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #define ECC_CURVE_NIST_P192 0x0001
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) #define ECC_CURVE_NIST_P256 0x0002
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) * struct ecdh - define an ECDH private key
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) * @curve_id: ECC curve the key is based on.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) * @key: Private ECDH key
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) * @key_size: Size of the private ECDH key
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) struct ecdh {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) unsigned short curve_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) char *key;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) unsigned short key_size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) * crypto_ecdh_key_len() - Obtain the size of the private ECDH key
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) * @params: private ECDH key
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) * This function returns the packet ECDH key size. A caller can use that
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) * with the provided ECDH private key reference to obtain the required
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) * memory size to hold a packet key.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) * Return: size of the key in bytes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) unsigned int crypto_ecdh_key_len(const struct ecdh *params);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) * crypto_ecdh_encode_key() - encode the private key
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) * @buf: Buffer allocated by the caller to hold the packet ECDH
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) * private key. The buffer should be at least crypto_ecdh_key_len
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) * bytes in size.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) * @len: Length of the packet private key buffer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) * @p: Buffer with the caller-specified private key
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) * The ECDH implementations operate on a packet representation of the private
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) * key.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) * Return: -EINVAL if buffer has insufficient size, 0 on success
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) int crypto_ecdh_encode_key(char *buf, unsigned int len, const struct ecdh *p);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) * crypto_ecdh_decode_key() - decode a private key
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) * @buf: Buffer holding a packet key that should be decoded
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) * @len: Length of the packet private key buffer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) * @p: Buffer allocated by the caller that is filled with the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) * unpacked ECDH private key.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) * The unpacking obtains the private key by pointing @p to the correct location
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) * in @buf. Thus, both pointers refer to the same memory.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) * Return: -EINVAL if buffer has insufficient size, 0 on success
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) int crypto_ecdh_decode_key(const char *buf, unsigned int len, struct ecdh *p);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) #endif