mirror of
https://github.com/AuxXxilium/linux_dsm_epyc7002.git
synced 2024-12-22 21:47:04 +07:00
8d23da22ac
Add the KPP API documentation to the kernel crypto API Sphinx documentation. This addition includes the documentation of the ECDH and DH helpers which are needed to create the approrpiate input data for the crypto_kpp_set_secret function. Signed-off-by: Stephan Mueller <smueller@chronox.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
88 lines
2.6 KiB
C
88 lines
2.6 KiB
C
/*
|
|
* Diffie-Hellman secret to be used with kpp API along with helper functions
|
|
*
|
|
* Copyright (c) 2016, Intel Corporation
|
|
* Authors: Salvatore Benedetto <salvatore.benedetto@intel.com>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the Free
|
|
* Software Foundation; either version 2 of the License, or (at your option)
|
|
* any later version.
|
|
*
|
|
*/
|
|
#ifndef _CRYPTO_DH_
|
|
#define _CRYPTO_DH_
|
|
|
|
/**
|
|
* DOC: DH Helper Functions
|
|
*
|
|
* To use DH with the KPP cipher API, the following data structure and
|
|
* functions should be used.
|
|
*
|
|
* To use DH with KPP, the following functions should be used to operate on
|
|
* a DH private key. The packet private key that can be set with
|
|
* the KPP API function call of crypto_kpp_set_secret.
|
|
*/
|
|
|
|
/**
|
|
* struct dh - define a DH private key
|
|
*
|
|
* @key: Private DH key
|
|
* @p: Diffie-Hellman parameter P
|
|
* @g: Diffie-Hellman generator G
|
|
* @key_size: Size of the private DH key
|
|
* @p_size: Size of DH parameter P
|
|
* @g_size: Size of DH generator G
|
|
*/
|
|
struct dh {
|
|
void *key;
|
|
void *p;
|
|
void *g;
|
|
unsigned int key_size;
|
|
unsigned int p_size;
|
|
unsigned int g_size;
|
|
};
|
|
|
|
/**
|
|
* crypto_dh_key_len() - Obtain the size of the private DH key
|
|
* @params: private DH key
|
|
*
|
|
* This function returns the packet DH key size. A caller can use that
|
|
* with the provided DH private key reference to obtain the required
|
|
* memory size to hold a packet key.
|
|
*
|
|
* Return: size of the key in bytes
|
|
*/
|
|
int crypto_dh_key_len(const struct dh *params);
|
|
|
|
/**
|
|
* crypto_dh_encode_key() - encode the private key
|
|
* @buf: Buffer allocated by the caller to hold the packet DH
|
|
* private key. The buffer should be at least crypto_dh_key_len
|
|
* bytes in size.
|
|
* @len: Length of the packet private key buffer
|
|
* @params: Buffer with the caller-specified private key
|
|
*
|
|
* The DH implementations operate on a packet representation of the private
|
|
* key.
|
|
*
|
|
* Return: -EINVAL if buffer has insufficient size, 0 on success
|
|
*/
|
|
int crypto_dh_encode_key(char *buf, unsigned int len, const struct dh *params);
|
|
|
|
/**
|
|
* crypto_dh_decode_key() - decode a private key
|
|
* @buf: Buffer holding a packet key that should be decoded
|
|
* @len: Lenth of the packet private key buffer
|
|
* @params: Buffer allocated by the caller that is filled with the
|
|
* unpacket DH private key.
|
|
*
|
|
* The unpacking obtains the private key by pointing @p to the correct location
|
|
* in @buf. Thus, both pointers refer to the same memory.
|
|
*
|
|
* Return: -EINVAL if buffer has insufficient size, 0 on success
|
|
*/
|
|
int crypto_dh_decode_key(const char *buf, unsigned int len, struct dh *params);
|
|
|
|
#endif
|