hmac.h 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. /*
  2. * Copyright (C) 2012 Martin Storsjo
  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. #ifndef AVUTIL_HMAC_H
  21. #define AVUTIL_HMAC_H
  22. #include <stdint.h>
  23. /**
  24. * @defgroup lavu_hmac HMAC
  25. * @ingroup lavu_crypto
  26. * @{
  27. */
  28. enum AVHMACType {
  29. AV_HMAC_MD5,
  30. AV_HMAC_SHA1,
  31. AV_HMAC_SHA224 = 10,
  32. AV_HMAC_SHA256,
  33. AV_HMAC_SHA384,
  34. AV_HMAC_SHA512,
  35. };
  36. typedef struct AVHMAC AVHMAC;
  37. /**
  38. * Allocate an AVHMAC context.
  39. * @param type The hash function used for the HMAC.
  40. */
  41. AVHMAC *av_hmac_alloc(enum AVHMACType type);
  42. /**
  43. * Free an AVHMAC context.
  44. * @param ctx The context to free, may be NULL
  45. */
  46. void av_hmac_free(AVHMAC *ctx);
  47. /**
  48. * Initialize an AVHMAC context with an authentication key.
  49. * @param ctx The HMAC context
  50. * @param key The authentication key
  51. * @param keylen The length of the key, in bytes
  52. */
  53. void av_hmac_init(AVHMAC *ctx, const uint8_t *key, unsigned int keylen);
  54. /**
  55. * Hash data with the HMAC.
  56. * @param ctx The HMAC context
  57. * @param data The data to hash
  58. * @param len The length of the data, in bytes
  59. */
  60. void av_hmac_update(AVHMAC *ctx, const uint8_t *data, unsigned int len);
  61. /**
  62. * Finish hashing and output the HMAC digest.
  63. * @param ctx The HMAC context
  64. * @param out The output buffer to write the digest into
  65. * @param outlen The length of the out buffer, in bytes
  66. * @return The number of bytes written to out, or a negative error code.
  67. */
  68. int av_hmac_final(AVHMAC *ctx, uint8_t *out, unsigned int outlen);
  69. /**
  70. * Hash an array of data with a key.
  71. * @param ctx The HMAC context
  72. * @param data The data to hash
  73. * @param len The length of the data, in bytes
  74. * @param key The authentication key
  75. * @param keylen The length of the key, in bytes
  76. * @param out The output buffer to write the digest into
  77. * @param outlen The length of the out buffer, in bytes
  78. * @return The number of bytes written to out, or a negative error code.
  79. */
  80. int av_hmac_calc(AVHMAC *ctx, const uint8_t *data, unsigned int len,
  81. const uint8_t *key, unsigned int keylen,
  82. uint8_t *out, unsigned int outlen);
  83. /**
  84. * @}
  85. */
  86. #endif /* AVUTIL_HMAC_H */