ocrypto_aes_ccm.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  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_aes_ccm AES CCM APIs
  42. * @ingroup nrf_oberon_aes
  43. * @{
  44. * @brief Type definitions and APIS for AES CCM (AES counter mode with CBC-MAC)
  45. *
  46. * AES (advanced encryption standard) is a symmetric encryption algorithm standardized by NIST.
  47. * AES transfers a 128-bit block of data into an encrypted block of the same size.
  48. *
  49. * AES-CCM (AES counter mode with CBC-MAC) is an AES mode which effectively turns the block
  50. * cipher into a stream cipher. The AES block cipher primitive is used in CTR mode for
  51. * encryption and decryption. In addition an AES CBC-MAC is used for authentication.
  52. */
  53. #ifndef OCRYPTO_AES_CCM_H
  54. #define OCRYPTO_AES_CCM_H
  55. #include <stddef.h>
  56. #include <stdint.h>
  57. #ifdef __cplusplus
  58. extern "C" {
  59. #endif
  60. /**
  61. * AES-CCM encryption.
  62. *
  63. * @param[out] ct Cyphertext.
  64. * @param[out] tag Authentication tag.
  65. * @param tag_len Tag length (4, 6, 8, 10, 12, 14, or 16).
  66. * @param pt Plaintext.
  67. * @param pt_len Plaintext length, 0 <= @p pt_len < 2^(8*(15-n_len)).
  68. * @param key AES key.
  69. * @param size Key size (16, 24, or 32).
  70. * @param nonce Nonce.
  71. * @param n_len Nonce length, 7 <= @p n_len <= 13.
  72. * @param aa Additional authentication data.
  73. * @param aa_len Additional authentication data length.
  74. *
  75. * @remark @p ct may be same as @p pt.
  76. */
  77. void ocrypto_aes_ccm_encrypt (
  78. uint8_t *ct,
  79. uint8_t *tag, size_t tag_len,
  80. const uint8_t *pt, size_t pt_len,
  81. const uint8_t *key, size_t size,
  82. const uint8_t *nonce, size_t n_len,
  83. const uint8_t *aa, size_t aa_len);
  84. /**
  85. * AES-CCM decryption.
  86. *
  87. * @param[out] pt Plaintext.
  88. * @param tag Authentication tag.
  89. * @param tag_len Tag length (4, 6, 8, 10, 12, 14, or 16).
  90. * @param ct Cyphertext.
  91. * @param ct_len Cyphertext length, 0 <= @p ct_len < 2^(8*(15-n_len)).
  92. * @param key AES key.
  93. * @param size Key size (16, 24, or 32).
  94. * @param nonce Nonce.
  95. * @param n_len Nonce length, 7 <= @p n_len <= 13.
  96. * @param aa Additional authentication data.
  97. * @param aa_len Additional authentication data length.
  98. *
  99. * @retval 0 If @p tag is valid.
  100. * @retval -1 Otherwise.
  101. *
  102. * @remark @p ct may be same as @p pt.
  103. */
  104. int ocrypto_aes_ccm_decrypt (
  105. uint8_t *pt,
  106. const uint8_t *tag, size_t tag_len,
  107. const uint8_t *ct, size_t ct_len,
  108. const uint8_t *key, size_t size,
  109. const uint8_t *nonce, size_t n_len,
  110. const uint8_t *aa, size_t aa_len);
  111. #ifdef __cplusplus
  112. }
  113. #endif
  114. #endif /* #ifndef OCRYPTO_AES_CCM_H */
  115. /** @} */