ecdh.h 2.7 KB

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