sha256.h 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. /**
  2. * \file sha256.h
  3. *
  4. * \brief SHA-224 and SHA-256 cryptographic hash function
  5. *
  6. * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
  7. * SPDX-License-Identifier: GPL-2.0
  8. *
  9. * This program is free software; you can redistribute it and/or modify
  10. * it under the terms of the GNU General Public License as published by
  11. * the Free Software Foundation; either version 2 of the License, or
  12. * (at your option) any later version.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU General Public License along
  20. * with this program; if not, write to the Free Software Foundation, Inc.,
  21. * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22. *
  23. * This file is part of mbed TLS (https://tls.mbed.org)
  24. */
  25. #ifndef MBEDTLS_SHA256_H
  26. #define MBEDTLS_SHA256_H
  27. #if !defined(MBEDTLS_CONFIG_FILE)
  28. #include "config.h"
  29. #else
  30. #include MBEDTLS_CONFIG_FILE
  31. #endif
  32. #include <stddef.h>
  33. #include <stdint.h>
  34. #if !defined(MBEDTLS_SHA256_ALT)
  35. // Regular implementation
  36. //
  37. #ifdef __cplusplus
  38. extern "C" {
  39. #endif
  40. /**
  41. * \brief SHA-256 context structure
  42. */
  43. typedef struct
  44. {
  45. uint32_t total[2]; /*!< number of bytes processed */
  46. uint32_t state[8]; /*!< intermediate digest state */
  47. unsigned char buffer[64]; /*!< data block being processed */
  48. int is224; /*!< 0 => SHA-256, else SHA-224 */
  49. }
  50. mbedtls_sha256_context;
  51. /**
  52. * \brief Initialize SHA-256 context
  53. *
  54. * \param ctx SHA-256 context to be initialized
  55. */
  56. void mbedtls_sha256_init( mbedtls_sha256_context *ctx );
  57. /**
  58. * \brief Clear SHA-256 context
  59. *
  60. * \param ctx SHA-256 context to be cleared
  61. */
  62. void mbedtls_sha256_free( mbedtls_sha256_context *ctx );
  63. /**
  64. * \brief Clone (the state of) a SHA-256 context
  65. *
  66. * \param dst The destination context
  67. * \param src The context to be cloned
  68. */
  69. void mbedtls_sha256_clone( mbedtls_sha256_context *dst,
  70. const mbedtls_sha256_context *src );
  71. /**
  72. * \brief SHA-256 context setup
  73. *
  74. * \param ctx context to be initialized
  75. * \param is224 0 = use SHA256, 1 = use SHA224
  76. */
  77. void mbedtls_sha256_starts( mbedtls_sha256_context *ctx, int is224 );
  78. /**
  79. * \brief SHA-256 process buffer
  80. *
  81. * \param ctx SHA-256 context
  82. * \param input buffer holding the data
  83. * \param ilen length of the input data
  84. */
  85. void mbedtls_sha256_update( mbedtls_sha256_context *ctx, const unsigned char *input,
  86. size_t ilen );
  87. /**
  88. * \brief SHA-256 final digest
  89. *
  90. * \param ctx SHA-256 context
  91. * \param output SHA-224/256 checksum result
  92. */
  93. void mbedtls_sha256_finish( mbedtls_sha256_context *ctx, unsigned char output[32] );
  94. /* Internal use */
  95. void mbedtls_sha256_process( mbedtls_sha256_context *ctx, const unsigned char data[64] );
  96. #ifdef __cplusplus
  97. }
  98. #endif
  99. #else /* MBEDTLS_SHA256_ALT */
  100. #include "sha256_alt.h"
  101. #endif /* MBEDTLS_SHA256_ALT */
  102. #ifdef __cplusplus
  103. extern "C" {
  104. #endif
  105. /**
  106. * \brief Output = SHA-256( input buffer )
  107. *
  108. * \param input buffer holding the data
  109. * \param ilen length of the input data
  110. * \param output SHA-224/256 checksum result
  111. * \param is224 0 = use SHA256, 1 = use SHA224
  112. */
  113. void mbedtls_sha256( const unsigned char *input, size_t ilen,
  114. unsigned char output[32], int is224 );
  115. /**
  116. * \brief Checkup routine
  117. *
  118. * \return 0 if successful, or 1 if the test failed
  119. */
  120. int mbedtls_sha256_self_test( int verbose );
  121. #ifdef __cplusplus
  122. }
  123. #endif
  124. #endif /* mbedtls_sha256.h */