sha1.h 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. /**
  2. * \file sha1.h
  3. *
  4. * \brief SHA-1 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_SHA1_H
  26. #define MBEDTLS_SHA1_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_SHA1_ALT)
  35. // Regular implementation
  36. //
  37. #ifdef __cplusplus
  38. extern "C" {
  39. #endif
  40. /**
  41. * \brief SHA-1 context structure
  42. */
  43. typedef struct
  44. {
  45. uint32_t total[2]; /*!< number of bytes processed */
  46. uint32_t state[5]; /*!< intermediate digest state */
  47. unsigned char buffer[64]; /*!< data block being processed */
  48. }
  49. mbedtls_sha1_context;
  50. /**
  51. * \brief Initialize SHA-1 context
  52. *
  53. * \param ctx SHA-1 context to be initialized
  54. */
  55. void mbedtls_sha1_init( mbedtls_sha1_context *ctx );
  56. /**
  57. * \brief Clear SHA-1 context
  58. *
  59. * \param ctx SHA-1 context to be cleared
  60. */
  61. void mbedtls_sha1_free( mbedtls_sha1_context *ctx );
  62. /**
  63. * \brief Clone (the state of) a SHA-1 context
  64. *
  65. * \param dst The destination context
  66. * \param src The context to be cloned
  67. */
  68. void mbedtls_sha1_clone( mbedtls_sha1_context *dst,
  69. const mbedtls_sha1_context *src );
  70. /**
  71. * \brief SHA-1 context setup
  72. *
  73. * \param ctx context to be initialized
  74. */
  75. void mbedtls_sha1_starts( mbedtls_sha1_context *ctx );
  76. /**
  77. * \brief SHA-1 process buffer
  78. *
  79. * \param ctx SHA-1 context
  80. * \param input buffer holding the data
  81. * \param ilen length of the input data
  82. */
  83. void mbedtls_sha1_update( mbedtls_sha1_context *ctx, const unsigned char *input, size_t ilen );
  84. /**
  85. * \brief SHA-1 final digest
  86. *
  87. * \param ctx SHA-1 context
  88. * \param output SHA-1 checksum result
  89. */
  90. void mbedtls_sha1_finish( mbedtls_sha1_context *ctx, unsigned char output[20] );
  91. /* Internal use */
  92. void mbedtls_sha1_process( mbedtls_sha1_context *ctx, const unsigned char data[64] );
  93. #ifdef __cplusplus
  94. }
  95. #endif
  96. #else /* MBEDTLS_SHA1_ALT */
  97. #include "sha1_alt.h"
  98. #endif /* MBEDTLS_SHA1_ALT */
  99. #ifdef __cplusplus
  100. extern "C" {
  101. #endif
  102. /**
  103. * \brief Output = SHA-1( input buffer )
  104. *
  105. * \param input buffer holding the data
  106. * \param ilen length of the input data
  107. * \param output SHA-1 checksum result
  108. */
  109. void mbedtls_sha1( const unsigned char *input, size_t ilen, unsigned char output[20] );
  110. /**
  111. * \brief Checkup routine
  112. *
  113. * \return 0 if successful, or 1 if the test failed
  114. */
  115. int mbedtls_sha1_self_test( int verbose );
  116. #ifdef __cplusplus
  117. }
  118. #endif
  119. #endif /* mbedtls_sha1.h */