c0c7cd1af15606ba27703b79a59d3c541289996c
[ffmpeg.git] / 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 <stddef.h>
25 #include <stdint.h>
26
27 #include "attributes.h"
28 #include "version.h"
29
30 /**
31  * @defgroup lavu_sha SHA
32  * @ingroup lavu_crypto
33  * @{
34  */
35
36 struct AVSHA;
37
38 /**
39  * Allocate an AVSHA context.
40  */
41 struct AVSHA *av_sha_alloc(void);
42
43 /**
44  * Initialize SHA-1 or SHA-2 hashing.
45  *
46  * @param context pointer to the function context (of size av_sha_size)
47  * @param bits    number of bits in digest (SHA-1 - 160 bits, SHA-2 224 or 256 bits)
48  * @return        zero if initialization succeeded, -1 otherwise
49  */
50 int av_sha_init(struct AVSHA* context, int bits);
51
52 /**
53  * Update hash value.
54  *
55  * @param ctx     hash function context
56  * @param data    input data to update hash with
57  * @param len     input data length
58  */
59 #if FF_API_CRYPTO_SIZE_T
60 void av_sha_update(struct AVSHA *ctx, const uint8_t *data, unsigned int len);
61 #else
62 void av_sha_update(struct AVSHA *ctx, const uint8_t *data, size_t len);
63 #endif
64
65 /**
66  * Finish hashing and output digest value.
67  *
68  * @param context hash function context
69  * @param digest  buffer where output digest value is stored
70  */
71 void av_sha_final(struct AVSHA* context, uint8_t *digest);
72
73 /**
74  * @}
75  */
76
77 #endif /* AVUTIL_SHA_H */