sha256.h 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  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: Apache-2.0
  8. *
  9. * Licensed under the Apache License, Version 2.0 (the "License"); you may
  10. * not use this file except in compliance with the License.
  11. * You may obtain a copy of the License at
  12. *
  13. * http://www.apache.org/licenses/LICENSE-2.0
  14. *
  15. * Unless required by applicable law or agreed to in writing, software
  16. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  17. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18. * See the License for the specific language governing permissions and
  19. * limitations under the License.
  20. *
  21. * This file is part of mbed TLS (https://tls.mbed.org)
  22. */
  23. #ifndef MBEDTLS_SHA256_H
  24. #define MBEDTLS_SHA256_H
  25. #if !defined(MBEDTLS_CONFIG_FILE)
  26. #include "config.h"
  27. #else
  28. #include MBEDTLS_CONFIG_FILE
  29. #endif
  30. #include <stddef.h>
  31. #include <stdint.h>
  32. #if !defined(MBEDTLS_SHA256_ALT)
  33. // Regular implementation
  34. //
  35. #ifdef __cplusplus
  36. extern "C" {
  37. #endif
  38. /**
  39. * \brief SHA-256 context structure
  40. */
  41. typedef struct
  42. {
  43. uint32_t total[2]; /*!< number of bytes processed */
  44. uint32_t state[8]; /*!< intermediate digest state */
  45. unsigned char buffer[64]; /*!< data block being processed */
  46. int is224; /*!< 0 => SHA-256, else SHA-224 */
  47. }
  48. mbedtls_sha256_context;
  49. /**
  50. * \brief Initialize SHA-256 context
  51. *
  52. * \param ctx SHA-256 context to be initialized
  53. */
  54. void mbedtls_sha256_init( mbedtls_sha256_context *ctx );
  55. /**
  56. * \brief Clear SHA-256 context
  57. *
  58. * \param ctx SHA-256 context to be cleared
  59. */
  60. void mbedtls_sha256_free( mbedtls_sha256_context *ctx );
  61. /**
  62. * \brief Clone (the state of) a SHA-256 context
  63. *
  64. * \param dst The destination context
  65. * \param src The context to be cloned
  66. */
  67. void mbedtls_sha256_clone( mbedtls_sha256_context *dst,
  68. const mbedtls_sha256_context *src );
  69. /**
  70. * \brief SHA-256 context setup
  71. *
  72. * \param ctx context to be initialized
  73. * \param is224 0 = use SHA256, 1 = use SHA224
  74. */
  75. void mbedtls_sha256_starts( mbedtls_sha256_context *ctx, int is224 );
  76. /**
  77. * \brief SHA-256 process buffer
  78. *
  79. * \param ctx SHA-256 context
  80. * \param input buffer holding the data
  81. * \param ilen length of the input data
  82. */
  83. void mbedtls_sha256_update( mbedtls_sha256_context *ctx, const unsigned char *input,
  84. size_t ilen );
  85. /**
  86. * \brief SHA-256 final digest
  87. *
  88. * \param ctx SHA-256 context
  89. * \param output SHA-224/256 checksum result
  90. */
  91. void mbedtls_sha256_finish( mbedtls_sha256_context *ctx, unsigned char output[32] );
  92. /* Internal use */
  93. void mbedtls_sha256_process( mbedtls_sha256_context *ctx, const unsigned char data[64] );
  94. #ifdef __cplusplus
  95. }
  96. #endif
  97. #else /* MBEDTLS_SHA256_ALT */
  98. #include "sha256_alt.h"
  99. #endif /* MBEDTLS_SHA256_ALT */
  100. #ifdef __cplusplus
  101. extern "C" {
  102. #endif
  103. /**
  104. * \brief Output = SHA-256( input buffer )
  105. *
  106. * \param input buffer holding the data
  107. * \param ilen length of the input data
  108. * \param output SHA-224/256 checksum result
  109. * \param is224 0 = use SHA256, 1 = use SHA224
  110. */
  111. void mbedtls_sha256( const unsigned char *input, size_t ilen,
  112. unsigned char output[32], int is224 );
  113. /**
  114. * \brief Checkup routine
  115. *
  116. * \return 0 if successful, or 1 if the test failed
  117. */
  118. int mbedtls_sha256_self_test( int verbose );
  119. #ifdef __cplusplus
  120. }
  121. #endif
  122. #endif /* mbedtls_sha256.h */