crys_chacha_poly.h 5.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. /**************************************************************************************
  2. * Copyright (c) 2016-2017, ARM Limited or its affiliates. All rights reserved *
  3. * *
  4. * This file and the related binary are licensed under the following license: *
  5. * *
  6. * ARM Object Code and Header Files License, v1.0 Redistribution. *
  7. * *
  8. * Redistribution and use of object code, header files, and documentation, without *
  9. * modification, are permitted provided that the following conditions are met: *
  10. * *
  11. * 1) Redistributions must reproduce the above copyright notice and the *
  12. * following disclaimer in the documentation and/or other materials *
  13. * provided with the distribution. *
  14. * *
  15. * 2) Unless to the extent explicitly permitted by law, no reverse *
  16. * engineering, decompilation, or disassembly of is permitted. *
  17. * *
  18. * 3) Redistribution and use is permitted solely for the purpose of *
  19. * developing or executing applications that are targeted for use *
  20. * on an ARM-based product. *
  21. * *
  22. * DISCLAIMER. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND *
  23. * CONTRIBUTORS "AS IS." ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT *
  24. * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, *
  25. * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE *
  26. * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, *
  27. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED *
  28. * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
  29. * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
  30. * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
  31. * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
  32. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
  33. **************************************************************************************/
  34. /*!
  35. @file
  36. @brief This file contains all of the enums and definitions that are used for the
  37. CRYS CHACHA-POLY APIs, as well as the APIs themselves.
  38. @defgroup crys_chacha_poly CryptoCell CHACHA-POLY APIs
  39. @{
  40. @ingroup cryptocell_api
  41. */
  42. #ifndef CRYS_CHACHA_POLY_H
  43. #define CRYS_CHACHA_POLY_H
  44. #include "ssi_pal_types.h"
  45. #include "crys_error.h"
  46. #include "crys_chacha.h"
  47. #include "crys_poly.h"
  48. #ifdef __cplusplus
  49. extern "C"
  50. {
  51. #endif
  52. /*!
  53. @brief This function is used to perform the CHACHA-POLY encryption and authentication operation.
  54. @return CRYS_OK on success.
  55. @return A non-zero value on failure as defined crys_chacha_poly_error.h.
  56. */
  57. CIMPORT_C CRYSError_t CRYS_CHACHA_POLY(
  58. CRYS_CHACHA_Nonce_t pNonce, /*!< [in] A pointer to a buffer containing the nonce value. */
  59. CRYS_CHACHA_Key_t pKey, /*!< [in] A pointer to the user's key buffer. */
  60. CRYS_CHACHA_EncryptMode_t encryptDecryptFlag, /*!< [in] A flag specifying whether the CHACHA-POLY should perform an Encrypt or
  61. Decrypt operation. */
  62. uint8_t *pAddData, /*!< [in] A pointer to the buffer of the additional data to the POLY.
  63. The pointer does not need to be aligned. must not be null. */
  64. size_t addDataSize, /*!< [in] The size of the input data. must not be 0. */
  65. uint8_t *pDataIn, /*!< [in] A pointer to the buffer of the input data to the CHACHA.
  66. The pointer does not need to be aligned. must not be null. */
  67. size_t dataInSize, /*!< [in] The size of the input data. must not be 0. */
  68. uint8_t *pDataOut, /*!< [out] A pointer to the buffer of the output data from the CHACHA.
  69. must not be null. */
  70. CRYS_POLY_Mac_t macRes /*!< [in/out] Pointer to the MAC result buffer.*/
  71. );
  72. #ifdef __cplusplus
  73. }
  74. #endif
  75. /**
  76. @}
  77. */
  78. #endif /* #ifndef CRYS_CHACHA_POLY_H */