ocrypto_hkdf_sha1.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. /**
  2. * Copyright (c) 2019 - 2020, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. /**@file
  41. * @defgroup nrf_oberon_hkdf_1 HKDF APIs using SHA-1
  42. * @ingroup nrf_oberon_hkdf
  43. * @{
  44. * @brief Type declaration and APIs for the HKDF-SHA1 algorithm.
  45. *
  46. * HKDF-SHA1 is a key derivation function based on HMAC-SHA1.
  47. *
  48. * @see [RFC 5869 - HMAC-based Extract-and-Expand Key Derivation Function (HKDF)](http://tools.ietf.org/html/rfc5869)
  49. */
  50. #ifndef OCRYPTO_HKDF_SHA1_H
  51. #define OCRYPTO_HKDF_SHA1_H
  52. #include <stddef.h>
  53. #include <stdint.h>
  54. #ifdef __cplusplus
  55. extern "C" {
  56. #endif
  57. /**
  58. * Maximum length of a derived key.
  59. */
  60. #define ocrypto_hkdf_sha1_LENGTH_MAX (20)
  61. /**
  62. * Maximum salt length.
  63. */
  64. #define ocrypto_hkdf_sha1_SALT_LENGTH_MAX (40)
  65. /**
  66. * HKDF-SHA1 algorithm.
  67. *
  68. * A new pseudo-random key of length @p r_len is derived from an input key
  69. * @p key, a salt @p salt and additional information @p info. The new key is put
  70. * into @p r.
  71. *
  72. * @param[out] r Output key.
  73. * @param r_len Length of @p r, 0 < @p r_len <= @c ocrypto_hkdf_sha1_LENGTH_MAX.
  74. * @param key Input key.
  75. * @param key_len Length of @p key.
  76. * @param salt Salt.
  77. * @param salt_len Length of salt @p salt. 0 <= @p salt_len <= @c ocrypto_hkdf_sha1_SALT_LENGTH_MAX.
  78. * @param info Additional information.
  79. * @param info_len Length of @p info.
  80. */
  81. void ocrypto_hkdf_sha1(
  82. uint8_t* r, size_t r_len,
  83. const uint8_t* key, size_t key_len,
  84. const uint8_t* salt, size_t salt_len,
  85. const uint8_t* info, size_t info_len);
  86. #ifdef __cplusplus
  87. }
  88. #endif
  89. #endif /* #ifndef OCRYPTO_HKDF_SHA1_H */
  90. /** @} */