sha512.h 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. /*
  2. * Copyright (C) 2007 Michael Niedermayer <michaelni@gmx.at>
  3. * Copyright (C) 2013 James Almer <jamrial@gmail.com>
  4. *
  5. * This file is part of FFmpeg.
  6. *
  7. * FFmpeg is free software; you can redistribute it and/or
  8. * modify it under the terms of the GNU Lesser General Public
  9. * License as published by the Free Software Foundation; either
  10. * version 2.1 of the License, or (at your option) any later version.
  11. *
  12. * FFmpeg is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * Lesser General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Lesser General Public
  18. * License along with FFmpeg; if not, write to the Free Software
  19. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20. */
  21. /**
  22. * @file
  23. * @ingroup lavu_sha512
  24. * Public header for SHA-512 implementation.
  25. */
  26. #ifndef AVUTIL_SHA512_H
  27. #define AVUTIL_SHA512_H
  28. #include <stddef.h>
  29. #include <stdint.h>
  30. #include "attributes.h"
  31. #include "version.h"
  32. /**
  33. * @defgroup lavu_sha512 SHA-512
  34. * @ingroup lavu_hash
  35. * SHA-512 (Secure Hash Algorithm) hash function implementations.
  36. *
  37. * This module supports the following SHA-2 hash functions:
  38. *
  39. * - SHA-512/224: 224 bits
  40. * - SHA-512/256: 256 bits
  41. * - SHA-384: 384 bits
  42. * - SHA-512: 512 bits
  43. *
  44. * @see For SHA-1, SHA-256, and variants thereof, see @ref lavu_sha.
  45. *
  46. * @{
  47. */
  48. extern const int av_sha512_size;
  49. struct AVSHA512;
  50. /**
  51. * Allocate an AVSHA512 context.
  52. */
  53. struct AVSHA512 *av_sha512_alloc(void);
  54. /**
  55. * Initialize SHA-2 512 hashing.
  56. *
  57. * @param context pointer to the function context (of size av_sha512_size)
  58. * @param bits number of bits in digest (224, 256, 384 or 512 bits)
  59. * @return zero if initialization succeeded, -1 otherwise
  60. */
  61. int av_sha512_init(struct AVSHA512* context, int bits);
  62. /**
  63. * Update hash value.
  64. *
  65. * @param context hash function context
  66. * @param data input data to update hash with
  67. * @param len input data length
  68. */
  69. #if FF_API_CRYPTO_SIZE_T
  70. void av_sha512_update(struct AVSHA512* context, const uint8_t* data, unsigned int len);
  71. #else
  72. void av_sha512_update(struct AVSHA512* context, const uint8_t* data, size_t len);
  73. #endif
  74. /**
  75. * Finish hashing and output digest value.
  76. *
  77. * @param context hash function context
  78. * @param digest buffer where output digest value is stored
  79. */
  80. void av_sha512_final(struct AVSHA512* context, uint8_t *digest);
  81. /**
  82. * @}
  83. */
  84. #endif /* AVUTIL_SHA512_H */