git.sesse.net Git - ffmpeg/blob - libavutil/sha.h

   1 /*
   2  * Copyright (C) 2007 Michael Niedermayer <michaelni@gmx.at>
   3  *
   4  * This file is part of Libav.
   5  *
   6  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef AVUTIL_SHA_H
  22 #define AVUTIL_SHA_H
  23
  24 #include <stdint.h>
  25
  26 #include "attributes.h"
  27 #include "version.h"
  28
  29 /**
  30  * @defgroup lavu_sha SHA
  31  * @ingroup lavu_crypto
  32  * @{
  33  */
  34
  35 #if FF_API_CONTEXT_SIZE
  36 extern attribute_deprecated const int av_sha_size;
  37 #endif
  38
  39 struct AVSHA;
  40
  41 /**
  42  * Allocate an AVSHA context.
  43  */
  44 struct AVSHA *av_sha_alloc(void);
  45
  46 /**
  47  * Initialize SHA-1 or SHA-2 hashing.
  48  *
  49  * @param context pointer to the function context (of size av_sha_size)
  50  * @param bits    number of bits in digest (SHA-1 - 160 bits, SHA-2 224 or 256 bits)
  51  * @return        zero if initialization succeeded, -1 otherwise
  52  */
  53 int av_sha_init(struct AVSHA* context, int bits);
  54
  55 /**
  56  * Update hash value.
  57  *
  58  * @param context hash function context
  59  * @param data    input data to update hash with
  60  * @param len     input data length
  61  */
  62 void av_sha_update(struct AVSHA* context, const uint8_t* data, unsigned int len);
  63
  64 /**
  65  * Finish hashing and output digest value.
  66  *
  67  * @param context hash function context
  68  * @param digest  buffer where output digest value is stored
  69  */
  70 void av_sha_final(struct AVSHA* context, uint8_t *digest);
  71
  72 /**
  73  * @}
  74  */
  75
  76 #endif /* AVUTIL_SHA_H */