sha.h 2.4 KB

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