libavutil/sha.h
451ae257
 /*
  * Copyright (C) 2007 Michael Niedermayer <michaelni@gmx.at>
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
19d7098c
 /**
  * @file
  * @ingroup lavu_sha
  * Public header for SHA-1 & SHA-256 hash function implementations.
  */
 
451ae257
 #ifndef AVUTIL_SHA_H
 #define AVUTIL_SHA_H
 
e435beb1
 #include <stddef.h>
451ae257
 #include <stdint.h>
 
9a92aea2
 #include "attributes.h"
 #include "version.h"
 
757cd8d8
 /**
  * @defgroup lavu_sha SHA
19d7098c
  * @ingroup lavu_hash
  * SHA-1 and SHA-256 (Secure Hash Algorithm) hash function implementations.
  *
0a7a4e33
  * This module supports the following SHA hash functions:
  *
  * - SHA-1: 160 bits
  * - SHA-224: 224 bits, as a variant of SHA-2
  * - SHA-256: 256 bits, as a variant of SHA-2
  *
  * @see For SHA-384, SHA-512, and variants thereof, see @ref lavu_sha512.
  *
757cd8d8
  * @{
  */
 
ac090fa6
 extern const int av_sha_size;
451ae257
 
 struct AVSHA;
 
 /**
9a92aea2
  * Allocate an AVSHA context.
  */
 struct AVSHA *av_sha_alloc(void);
 
 /**
49bd8e4b
  * Initialize SHA-1 or SHA-2 hashing.
451ae257
  *
  * @param context pointer to the function context (of size av_sha_size)
  * @param bits    number of bits in digest (SHA-1 - 160 bits, SHA-2 224 or 256 bits)
  * @return        zero if initialization succeeded, -1 otherwise
  */
 int av_sha_init(struct AVSHA* context, int bits);
 
 /**
49bd8e4b
  * Update hash value.
451ae257
  *
e435beb1
  * @param ctx     hash function context
451ae257
  * @param data    input data to update hash with
  * @param len     input data length
  */
e435beb1
 #if FF_API_CRYPTO_SIZE_T
 void av_sha_update(struct AVSHA *ctx, const uint8_t *data, unsigned int len);
 #else
 void av_sha_update(struct AVSHA *ctx, const uint8_t *data, size_t len);
 #endif
451ae257
 
 /**
49bd8e4b
  * Finish hashing and output digest value.
451ae257
  *
  * @param context hash function context
  * @param digest  buffer where output digest value is stored
  */
 void av_sha_final(struct AVSHA* context, uint8_t *digest);
 
757cd8d8
 /**
  * @}
  */
 
451ae257
 #endif /* AVUTIL_SHA_H */